sys/dev/ic/ac97var.h

   1 /*      $NetBSD: ac97var.h,v 1.20 2007/02/21 22:59:59 thorpej Exp $     */
   2 /*      $OpenBSD: ac97.h,v 1.4 2000/07/19 09:01:35 csapuntz Exp $       */
   3
   4 /*
   5  * Copyright (c) 1999 Constantine Sapuntzakis
   6  *
   7  * Author:        Constantine Sapuntzakis <csapuntz@stanford.edu>
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY CONSTANTINE SAPUNTZAKIS AND CONTRIBUTORS
  19  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  20  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  21  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS
  22  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28  * POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #ifndef _DEV_IC_AC97VAR_H_
  32 #define _DEV_IC_AC97VAR_H_
  33 #include <sys/types.h>
  34
  35 struct ac97_codec_if;
  36
  37 /*
  38  * This is the interface used to attach the AC97 compliant CODEC.
  39  */
  40 enum ac97_host_flags {
  41         AC97_HOST_DONT_READ = 0x1,
  42         AC97_HOST_SWAPPED_CHANNELS = 0x2,       /* l/r is reversed */
  43         AC97_HOST_SKIP_AUDIO = 0x4,
  44         AC97_HOST_SKIP_MODEM = 0x8,
  45         AC97_HOST_INVERTED_EAMP = 0x10
  46 };
  47
  48 struct ac97_host_if {
  49         void  *arg;
  50
  51         int (*attach)(void *, struct ac97_codec_if *);
  52         int (*read)(void *, uint8_t, uint16_t *);
  53         int (*write)(void *, uint8_t, uint16_t);
  54         int (*reset)(void *);
  55
  56         enum ac97_host_flags (*flags)(void *);
  57         void (*spdif_event)(void *, bool);
  58 };
  59
  60 /*
  61  * This is the interface exported by the AC97 compliant CODEC
  62  */
  63 struct ac97_codec_if_vtbl {
  64         int (*mixer_get_port)(struct ac97_codec_if *, mixer_ctrl_t *);
  65         int (*mixer_set_port)(struct ac97_codec_if *, mixer_ctrl_t *);
  66         int (*query_devinfo)(struct ac97_codec_if *, mixer_devinfo_t *);
  67         int (*get_portnum_by_name)(struct ac97_codec_if *, const char *,
  68             const char *, const char *);
  69         /*
  70          * The AC97 codec driver records the various port settings.  This
  71          * function can be used to restore the port settings, e.g. after
  72          * resume from a laptop suspend to disk.
  73          * Also restores AC97_POWER_REG.
  74          */
  75         void (*restore_ports)(struct ac97_codec_if *);
  76
  77         u_int16_t (*get_extcaps)(struct ac97_codec_if *);
  78         int (*set_rate)(struct ac97_codec_if *, int, u_int *);
  79         void (*set_clock)(struct ac97_codec_if *, unsigned int);
  80         void (*detach)(struct ac97_codec_if *);
  81         /**
  82          * To enable SPDIF,
  83          *  - call unlock() just after ac97_attach()
  84          *  - call lock() in audio_hw_if::open()
  85          *  - call unlock() in audio_hw_if::close()
  86          */
  87         void (*lock)(struct ac97_codec_if *);
  88         void (*unlock)(struct ac97_codec_if *);
  89 };
  90
  91 struct ac97_codec_if {
  92         struct ac97_codec_if_vtbl *vtbl;
  93 };
  94
  95 struct device;
  96 int ac97_attach_type(struct ac97_host_if *, device_t, int);
  97 int ac97_attach(struct ac97_host_if *, device_t);
  98
  99 #define AC97_IS_FIXED_RATE(codec)       \
 100         !((codec)->vtbl->get_extcaps(codec) & AC97_EXT_AUDIO_VRA)
 101 #define AC97_IS_4CH(codec)              \
 102         ((codec)->vtbl->get_extcaps(codec) & AC97_EXT_AUDIO_SDAC)
 103 #define AC97_IS_6CH(codec)              \
 104         (((codec)->vtbl->get_extcaps(codec) \
 105         & (AC97_EXT_AUDIO_SDAC | AC97_EXT_AUDIO_CDAC | AC97_EXT_AUDIO_LDAC)) \
 106         == (AC97_EXT_AUDIO_SDAC | AC97_EXT_AUDIO_CDAC | AC97_EXT_AUDIO_LDAC))
 107 #define AC97_HAS_SPDIF(codec)           \
 108          ((codec)->vtbl->get_extcaps(codec) & AC97_EXT_AUDIO_SPDIF)
 109
 110 #define AC97_CODEC_TYPE_AUDIO 1
 111 #define AC97_CODEC_TYPE_MODEM 2
 112
 113 #endif /* _DEV_IC_AC97VAR_H_ */