include/sound/hdaudio.h

   1 /*
   2  * HD-audio core stuff
   3  */
   4
   5 #ifndef __SOUND_HDAUDIO_H
   6 #define __SOUND_HDAUDIO_H
   7
   8 #include <linux/device.h>
   9 #include <sound/hda_verbs.h>
  10
  11 /* codec node id */
  12 typedef u16 hda_nid_t;
  13
  14 struct hdac_bus;
  15 struct hdac_device;
  16 struct hdac_driver;
  17 struct hdac_widget_tree;
  18
  19 /*
  20  * exported bus type
  21  */
  22 extern struct bus_type snd_hda_bus_type;
  23
  24 /*
  25  * generic arrays
  26  */
  27 struct snd_array {
  28         unsigned int used;
  29         unsigned int alloced;
  30         unsigned int elem_size;
  31         unsigned int alloc_align;
  32         void *list;
  33 };
  34
  35 /*
  36  * HD-audio codec base device
  37  */
  38 struct hdac_device {
  39         struct device dev;
  40         int type;
  41         struct hdac_bus *bus;
  42         unsigned int addr;              /* codec address */
  43         struct list_head list;          /* list point for bus codec_list */
  44
  45         hda_nid_t afg;                  /* AFG node id */
  46         hda_nid_t mfg;                  /* MFG node id */
  47
  48         /* ids */
  49         unsigned int vendor_id;
  50         unsigned int subsystem_id;
  51         unsigned int revision_id;
  52         unsigned int afg_function_id;
  53         unsigned int mfg_function_id;
  54         unsigned int afg_unsol:1;
  55         unsigned int mfg_unsol:1;
  56
  57         unsigned int power_caps;        /* FG power caps */
  58
  59         const char *vendor_name;        /* codec vendor name */
  60         const char *chip_name;          /* codec chip name */
  61
  62         /* verb exec op override */
  63         int (*exec_verb)(struct hdac_device *dev, unsigned int cmd,
  64                          unsigned int flags, unsigned int *res);
  65
  66         /* widgets */
  67         unsigned int num_nodes;
  68         hda_nid_t start_nid, end_nid;
  69
  70         /* misc flags */
  71         atomic_t in_pm;         /* suspend/resume being performed */
  72
  73         /* sysfs */
  74         struct hdac_widget_tree *widgets;
  75
  76         /* regmap */
  77         struct regmap *regmap;
  78         bool lazy_cache:1;      /* don't wake up for writes */
  79         bool caps_overwriting:1; /* caps overwrite being in process */
  80 };
  81
  82 /* device/driver type used for matching */
  83 enum {
  84         HDA_DEV_CORE,
  85         HDA_DEV_LEGACY,
  86 };
  87
  88 /* direction */
  89 enum {
  90         HDA_INPUT, HDA_OUTPUT
  91 };
  92
  93 #define dev_to_hdac_dev(_dev)   container_of(_dev, struct hdac_device, dev)
  94
  95 int snd_hdac_device_init(struct hdac_device *dev, struct hdac_bus *bus,
  96                          const char *name, unsigned int addr);
  97 void snd_hdac_device_exit(struct hdac_device *dev);
  98 int snd_hdac_device_register(struct hdac_device *codec);
  99 void snd_hdac_device_unregister(struct hdac_device *codec);
 100
 101 int snd_hdac_refresh_widgets(struct hdac_device *codec);
 102
 103 unsigned int snd_hdac_make_cmd(struct hdac_device *codec, hda_nid_t nid,
 104                                unsigned int verb, unsigned int parm);
 105 int snd_hdac_exec_verb(struct hdac_device *codec, unsigned int cmd,
 106                        unsigned int flags, unsigned int *res);
 107 int snd_hdac_read(struct hdac_device *codec, hda_nid_t nid,
 108                   unsigned int verb, unsigned int parm, unsigned int *res);
 109 int _snd_hdac_read_parm(struct hdac_device *codec, hda_nid_t nid, int parm,
 110                         unsigned int *res);
 111 int snd_hdac_read_parm_uncached(struct hdac_device *codec, hda_nid_t nid,
 112                                 int parm);
 113 int snd_hdac_override_parm(struct hdac_device *codec, hda_nid_t nid,
 114                            unsigned int parm, unsigned int val);
 115 int snd_hdac_get_connections(struct hdac_device *codec, hda_nid_t nid,
 116                              hda_nid_t *conn_list, int max_conns);
 117 int snd_hdac_get_sub_nodes(struct hdac_device *codec, hda_nid_t nid,
 118                            hda_nid_t *start_id);
 119
 120 /**
 121  * snd_hdac_read_parm - read a codec parameter
 122  * @codec: the codec object
 123  * @nid: NID to read a parameter
 124  * @parm: parameter to read
 125  *
 126  * Returns -1 for error.  If you need to distinguish the error more
 127  * strictly, use _snd_hdac_read_parm() directly.
 128  */
 129 static inline int snd_hdac_read_parm(struct hdac_device *codec, hda_nid_t nid,
 130                                      int parm)
 131 {
 132         unsigned int val;
 133
 134         return _snd_hdac_read_parm(codec, nid, parm, &val) < 0 ? -1 : val;
 135 }
 136
 137 #ifdef CONFIG_PM
 138 void snd_hdac_power_up(struct hdac_device *codec);
 139 void snd_hdac_power_down(struct hdac_device *codec);
 140 #else
 141 static inline void snd_hdac_power_up(struct hdac_device *codec) {}
 142 static inline void snd_hdac_power_down(struct hdac_device *codec) {}
 143 #endif
 144
 145 /*
 146  * HD-audio codec base driver
 147  */
 148 struct hdac_driver {
 149         struct device_driver driver;
 150         int type;
 151         int (*match)(struct hdac_device *dev, struct hdac_driver *drv);
 152         void (*unsol_event)(struct hdac_device *dev, unsigned int event);
 153 };
 154
 155 #define drv_to_hdac_driver(_drv) container_of(_drv, struct hdac_driver, driver)
 156
 157 /*
 158  * HD-audio bus base driver
 159  */
 160 struct hdac_bus_ops {
 161         /* send a single command */
 162         int (*command)(struct hdac_bus *bus, unsigned int cmd);
 163         /* get a response from the last command */
 164         int (*get_response)(struct hdac_bus *bus, unsigned int addr,
 165                             unsigned int *res);
 166 };
 167
 168 #define HDA_UNSOL_QUEUE_SIZE    64
 169
 170 struct hdac_bus {
 171         struct device *dev;
 172         const struct hdac_bus_ops *ops;
 173
 174         /* codec linked list */
 175         struct list_head codec_list;
 176         unsigned int num_codecs;
 177
 178         /* link caddr -> codec */
 179         struct hdac_device *caddr_tbl[HDA_MAX_CODEC_ADDRESS + 1];
 180
 181         /* unsolicited event queue */
 182         u32 unsol_queue[HDA_UNSOL_QUEUE_SIZE * 2]; /* ring buffer */
 183         unsigned int unsol_rp, unsol_wp;
 184         struct work_struct unsol_work;
 185
 186         /* bit flags of powered codecs */
 187         unsigned long codec_powered;
 188
 189         /* flags */
 190         bool sync_write:1;              /* sync after verb write */
 191
 192         /* locks */
 193         struct mutex cmd_mutex;
 194 };
 195
 196 int snd_hdac_bus_init(struct hdac_bus *bus, struct device *dev,
 197                       const struct hdac_bus_ops *ops);
 198 void snd_hdac_bus_exit(struct hdac_bus *bus);
 199 int snd_hdac_bus_exec_verb(struct hdac_bus *bus, unsigned int addr,
 200                            unsigned int cmd, unsigned int *res);
 201 int snd_hdac_bus_exec_verb_unlocked(struct hdac_bus *bus, unsigned int addr,
 202                                     unsigned int cmd, unsigned int *res);
 203 void snd_hdac_bus_queue_event(struct hdac_bus *bus, u32 res, u32 res_ex);
 204
 205 int snd_hdac_bus_add_device(struct hdac_bus *bus, struct hdac_device *codec);
 206 void snd_hdac_bus_remove_device(struct hdac_bus *bus,
 207                                 struct hdac_device *codec);
 208
 209 static inline void snd_hdac_codec_link_up(struct hdac_device *codec)
 210 {
 211         set_bit(codec->addr, &codec->bus->codec_powered);
 212 }
 213
 214 static inline void snd_hdac_codec_link_down(struct hdac_device *codec)
 215 {
 216         clear_bit(codec->addr, &codec->bus->codec_powered);
 217 }
 218
 219 /*
 220  * generic array helpers
 221  */
 222 void *snd_array_new(struct snd_array *array);
 223 void snd_array_free(struct snd_array *array);
 224 static inline void snd_array_init(struct snd_array *array, unsigned int size,
 225                                   unsigned int align)
 226 {
 227         array->elem_size = size;
 228         array->alloc_align = align;
 229 }
 230
 231 static inline void *snd_array_elem(struct snd_array *array, unsigned int idx)
 232 {
 233         return array->list + idx * array->elem_size;
 234 }
 235
 236 static inline unsigned int snd_array_index(struct snd_array *array, void *ptr)
 237 {
 238         return (unsigned long)(ptr - array->list) / array->elem_size;
 239 }
 240
 241 #endif /* __SOUND_HDAUDIO_H */