5 #ifndef __SOUND_HDAUDIO_H
6 #define __SOUND_HDAUDIO_H
8 #include <linux/device.h>
9 #include <linux/interrupt.h>
10 #include <linux/timecounter.h>
11 #include <sound/core.h>
12 #include <sound/memalloc.h>
13 #include <sound/hda_verbs.h>
14 #include <drm/i915_component.h>
17 typedef u16 hda_nid_t;
23 struct hdac_widget_tree;
28 extern struct bus_type snd_hda_bus_type;
33 struct hda_device_id {
37 unsigned long driver_data;
46 unsigned int elem_size;
47 unsigned int alloc_align;
52 * HD-audio codec base device
58 unsigned int addr; /* codec address */
59 struct list_head list; /* list point for bus codec_list */
61 hda_nid_t afg; /* AFG node id */
62 hda_nid_t mfg; /* MFG node id */
65 unsigned int vendor_id;
66 unsigned int subsystem_id;
67 unsigned int revision_id;
68 unsigned int afg_function_id;
69 unsigned int mfg_function_id;
70 unsigned int afg_unsol:1;
71 unsigned int mfg_unsol:1;
73 unsigned int power_caps; /* FG power caps */
75 const char *vendor_name; /* codec vendor name */
76 const char *chip_name; /* codec chip name */
78 /* verb exec op override */
79 int (*exec_verb)(struct hdac_device *dev, unsigned int cmd,
80 unsigned int flags, unsigned int *res);
83 unsigned int num_nodes;
84 hda_nid_t start_nid, end_nid;
87 atomic_t in_pm; /* suspend/resume being performed */
88 bool link_power_control:1;
91 struct hdac_widget_tree *widgets;
94 struct regmap *regmap;
95 struct snd_array vendor_verbs;
96 bool lazy_cache:1; /* don't wake up for writes */
97 bool caps_overwriting:1; /* caps overwrite being in process */
98 bool cache_coef:1; /* cache COEF read/write too */
101 /* device/driver type used for matching */
110 HDA_INPUT, HDA_OUTPUT
113 #define dev_to_hdac_dev(_dev) container_of(_dev, struct hdac_device, dev)
115 int snd_hdac_device_init(struct hdac_device *dev, struct hdac_bus *bus,
116 const char *name, unsigned int addr);
117 void snd_hdac_device_exit(struct hdac_device *dev);
118 int snd_hdac_device_register(struct hdac_device *codec);
119 void snd_hdac_device_unregister(struct hdac_device *codec);
121 int snd_hdac_refresh_widgets(struct hdac_device *codec);
122 int snd_hdac_refresh_widget_sysfs(struct hdac_device *codec);
124 unsigned int snd_hdac_make_cmd(struct hdac_device *codec, hda_nid_t nid,
125 unsigned int verb, unsigned int parm);
126 int snd_hdac_exec_verb(struct hdac_device *codec, unsigned int cmd,
127 unsigned int flags, unsigned int *res);
128 int snd_hdac_read(struct hdac_device *codec, hda_nid_t nid,
129 unsigned int verb, unsigned int parm, unsigned int *res);
130 int _snd_hdac_read_parm(struct hdac_device *codec, hda_nid_t nid, int parm,
132 int snd_hdac_read_parm_uncached(struct hdac_device *codec, hda_nid_t nid,
134 int snd_hdac_override_parm(struct hdac_device *codec, hda_nid_t nid,
135 unsigned int parm, unsigned int val);
136 int snd_hdac_get_connections(struct hdac_device *codec, hda_nid_t nid,
137 hda_nid_t *conn_list, int max_conns);
138 int snd_hdac_get_sub_nodes(struct hdac_device *codec, hda_nid_t nid,
139 hda_nid_t *start_id);
140 unsigned int snd_hdac_calc_stream_format(unsigned int rate,
141 unsigned int channels,
144 unsigned short spdif_ctls);
145 int snd_hdac_query_supported_pcm(struct hdac_device *codec, hda_nid_t nid,
146 u32 *ratesp, u64 *formatsp, unsigned int *bpsp);
147 bool snd_hdac_is_supported_format(struct hdac_device *codec, hda_nid_t nid,
148 unsigned int format);
150 int snd_hdac_codec_read(struct hdac_device *hdac, hda_nid_t nid,
151 int flags, unsigned int verb, unsigned int parm);
152 int snd_hdac_codec_write(struct hdac_device *hdac, hda_nid_t nid,
153 int flags, unsigned int verb, unsigned int parm);
154 bool snd_hdac_check_power_state(struct hdac_device *hdac,
155 hda_nid_t nid, unsigned int target_state);
157 * snd_hdac_read_parm - read a codec parameter
158 * @codec: the codec object
159 * @nid: NID to read a parameter
160 * @parm: parameter to read
162 * Returns -1 for error. If you need to distinguish the error more
163 * strictly, use _snd_hdac_read_parm() directly.
165 static inline int snd_hdac_read_parm(struct hdac_device *codec, hda_nid_t nid,
170 return _snd_hdac_read_parm(codec, nid, parm, &val) < 0 ? -1 : val;
174 int snd_hdac_power_up(struct hdac_device *codec);
175 int snd_hdac_power_down(struct hdac_device *codec);
176 int snd_hdac_power_up_pm(struct hdac_device *codec);
177 int snd_hdac_power_down_pm(struct hdac_device *codec);
179 static inline int snd_hdac_power_up(struct hdac_device *codec) { return 0; }
180 static inline int snd_hdac_power_down(struct hdac_device *codec) { return 0; }
181 static inline int snd_hdac_power_up_pm(struct hdac_device *codec) { return 0; }
182 static inline int snd_hdac_power_down_pm(struct hdac_device *codec) { return 0; }
186 * HD-audio codec base driver
189 struct device_driver driver;
191 const struct hda_device_id *id_table;
192 int (*match)(struct hdac_device *dev, struct hdac_driver *drv);
193 void (*unsol_event)(struct hdac_device *dev, unsigned int event);
196 #define drv_to_hdac_driver(_drv) container_of(_drv, struct hdac_driver, driver)
198 const struct hda_device_id *
199 hdac_get_device_id(struct hdac_device *hdev, struct hdac_driver *drv);
204 struct hdac_bus_ops {
205 /* send a single command */
206 int (*command)(struct hdac_bus *bus, unsigned int cmd);
207 /* get a response from the last command */
208 int (*get_response)(struct hdac_bus *bus, unsigned int addr,
210 /* control the link power */
211 int (*link_power)(struct hdac_bus *bus, bool enable);
215 * Lowlevel I/O operators
218 /* mapped register accesses */
219 void (*reg_writel)(u32 value, u32 __iomem *addr);
220 u32 (*reg_readl)(u32 __iomem *addr);
221 void (*reg_writew)(u16 value, u16 __iomem *addr);
222 u16 (*reg_readw)(u16 __iomem *addr);
223 void (*reg_writeb)(u8 value, u8 __iomem *addr);
224 u8 (*reg_readb)(u8 __iomem *addr);
226 int (*dma_alloc_pages)(struct hdac_bus *bus, int type, size_t size,
227 struct snd_dma_buffer *buf);
228 void (*dma_free_pages)(struct hdac_bus *bus,
229 struct snd_dma_buffer *buf);
232 #define HDA_UNSOL_QUEUE_SIZE 64
233 #define HDA_MAX_CODECS 8 /* limit by controller side */
235 /* HD Audio class code */
236 #define PCI_CLASS_MULTIMEDIA_HD_AUDIO 0x0403
241 * Each CORB entry is 4byte, RIRB is 8byte
244 __le32 *buf; /* virtual address of CORB/RIRB buffer */
245 dma_addr_t addr; /* physical address of CORB/RIRB buffer */
246 unsigned short rp, wp; /* RIRB read/write pointers */
247 int cmds[HDA_MAX_CODECS]; /* number of pending requests */
248 u32 res[HDA_MAX_CODECS]; /* last read value */
252 * HD-audio bus base driver
256 const struct hdac_bus_ops *ops;
257 const struct hdac_io_ops *io_ops;
261 void __iomem *remap_addr;
264 /* codec linked list */
265 struct list_head codec_list;
266 unsigned int num_codecs;
268 /* link caddr -> codec */
269 struct hdac_device *caddr_tbl[HDA_MAX_CODEC_ADDRESS + 1];
271 /* unsolicited event queue */
272 u32 unsol_queue[HDA_UNSOL_QUEUE_SIZE * 2]; /* ring buffer */
273 unsigned int unsol_rp, unsol_wp;
274 struct work_struct unsol_work;
276 /* bit flags of detected codecs */
277 unsigned long codec_mask;
279 /* bit flags of powered codecs */
280 unsigned long codec_powered;
285 unsigned int last_cmd[HDA_MAX_CODECS]; /* last sent command */
287 /* CORB/RIRB and position buffers */
288 struct snd_dma_buffer rb;
289 struct snd_dma_buffer posbuf;
291 /* hdac_stream linked list */
292 struct list_head stream_list;
294 /* operation state */
295 bool chip_init:1; /* h/w initialized */
298 bool sync_write:1; /* sync after verb write */
299 bool use_posbuf:1; /* use position buffer */
300 bool snoop:1; /* enable snooping */
301 bool align_bdle_4k:1; /* BDLE align 4K boundary */
302 bool reverse_assign:1; /* assign devices in reverse order */
303 bool corbrp_self_clear:1; /* CORBRP clears itself after reset */
305 int bdl_pos_adj; /* BDL position adjustment */
309 struct mutex cmd_mutex;
311 /* i915 component interface */
312 struct i915_audio_component *audio_component;
313 int i915_power_refcount;
316 int snd_hdac_bus_init(struct hdac_bus *bus, struct device *dev,
317 const struct hdac_bus_ops *ops,
318 const struct hdac_io_ops *io_ops);
319 void snd_hdac_bus_exit(struct hdac_bus *bus);
320 int snd_hdac_bus_exec_verb(struct hdac_bus *bus, unsigned int addr,
321 unsigned int cmd, unsigned int *res);
322 int snd_hdac_bus_exec_verb_unlocked(struct hdac_bus *bus, unsigned int addr,
323 unsigned int cmd, unsigned int *res);
324 void snd_hdac_bus_queue_event(struct hdac_bus *bus, u32 res, u32 res_ex);
326 int snd_hdac_bus_add_device(struct hdac_bus *bus, struct hdac_device *codec);
327 void snd_hdac_bus_remove_device(struct hdac_bus *bus,
328 struct hdac_device *codec);
330 static inline void snd_hdac_codec_link_up(struct hdac_device *codec)
332 set_bit(codec->addr, &codec->bus->codec_powered);
335 static inline void snd_hdac_codec_link_down(struct hdac_device *codec)
337 clear_bit(codec->addr, &codec->bus->codec_powered);
340 int snd_hdac_bus_send_cmd(struct hdac_bus *bus, unsigned int val);
341 int snd_hdac_bus_get_response(struct hdac_bus *bus, unsigned int addr,
343 int snd_hdac_link_power(struct hdac_device *codec, bool enable);
345 bool snd_hdac_bus_init_chip(struct hdac_bus *bus, bool full_reset);
346 void snd_hdac_bus_stop_chip(struct hdac_bus *bus);
347 void snd_hdac_bus_init_cmd_io(struct hdac_bus *bus);
348 void snd_hdac_bus_stop_cmd_io(struct hdac_bus *bus);
349 void snd_hdac_bus_enter_link_reset(struct hdac_bus *bus);
350 void snd_hdac_bus_exit_link_reset(struct hdac_bus *bus);
352 void snd_hdac_bus_update_rirb(struct hdac_bus *bus);
353 void snd_hdac_bus_handle_stream_irq(struct hdac_bus *bus, unsigned int status,
354 void (*ack)(struct hdac_bus *,
355 struct hdac_stream *));
357 int snd_hdac_bus_alloc_stream_pages(struct hdac_bus *bus);
358 void snd_hdac_bus_free_stream_pages(struct hdac_bus *bus);
361 * macros for easy use
363 #define _snd_hdac_chip_write(type, chip, reg, value) \
364 ((chip)->io_ops->reg_write ## type(value, (chip)->remap_addr + (reg)))
365 #define _snd_hdac_chip_read(type, chip, reg) \
366 ((chip)->io_ops->reg_read ## type((chip)->remap_addr + (reg)))
368 /* read/write a register, pass without AZX_REG_ prefix */
369 #define snd_hdac_chip_writel(chip, reg, value) \
370 _snd_hdac_chip_write(l, chip, AZX_REG_ ## reg, value)
371 #define snd_hdac_chip_writew(chip, reg, value) \
372 _snd_hdac_chip_write(w, chip, AZX_REG_ ## reg, value)
373 #define snd_hdac_chip_writeb(chip, reg, value) \
374 _snd_hdac_chip_write(b, chip, AZX_REG_ ## reg, value)
375 #define snd_hdac_chip_readl(chip, reg) \
376 _snd_hdac_chip_read(l, chip, AZX_REG_ ## reg)
377 #define snd_hdac_chip_readw(chip, reg) \
378 _snd_hdac_chip_read(w, chip, AZX_REG_ ## reg)
379 #define snd_hdac_chip_readb(chip, reg) \
380 _snd_hdac_chip_read(b, chip, AZX_REG_ ## reg)
382 /* update a register, pass without AZX_REG_ prefix */
383 #define snd_hdac_chip_updatel(chip, reg, mask, val) \
384 snd_hdac_chip_writel(chip, reg, \
385 (snd_hdac_chip_readl(chip, reg) & ~(mask)) | (val))
386 #define snd_hdac_chip_updatew(chip, reg, mask, val) \
387 snd_hdac_chip_writew(chip, reg, \
388 (snd_hdac_chip_readw(chip, reg) & ~(mask)) | (val))
389 #define snd_hdac_chip_updateb(chip, reg, mask, val) \
390 snd_hdac_chip_writeb(chip, reg, \
391 (snd_hdac_chip_readb(chip, reg) & ~(mask)) | (val))
397 struct hdac_bus *bus;
398 struct snd_dma_buffer bdl; /* BDL buffer */
399 __le32 *posbuf; /* position buffer pointer */
400 int direction; /* playback / capture (SNDRV_PCM_STREAM_*) */
402 unsigned int bufsize; /* size of the play buffer in bytes */
403 unsigned int period_bytes; /* size of the period in bytes */
404 unsigned int frags; /* number for period in the play buffer */
405 unsigned int fifo_size; /* FIFO size */
407 void __iomem *sd_addr; /* stream descriptor pointer */
409 u32 sd_int_sta_mask; /* stream int status mask */
412 struct snd_pcm_substream *substream; /* assigned substream,
415 unsigned int format_val; /* format value to be set in the
416 * controller and the codec
418 unsigned char stream_tag; /* assigned stream */
419 unsigned char index; /* stream index */
420 int assigned_key; /* last device# key assigned to */
425 bool no_period_wakeup:1;
429 unsigned long start_wallclk; /* start + minimum wallclk */
430 unsigned long period_wallclk; /* wallclk for period */
431 struct timecounter tc;
432 struct cyclecounter cc;
433 int delay_negative_threshold;
435 struct list_head list;
436 #ifdef CONFIG_SND_HDA_DSP_LOADER
437 /* DSP access mutex */
438 struct mutex dsp_mutex;
442 void snd_hdac_stream_init(struct hdac_bus *bus, struct hdac_stream *azx_dev,
443 int idx, int direction, int tag);
444 struct hdac_stream *snd_hdac_stream_assign(struct hdac_bus *bus,
445 struct snd_pcm_substream *substream);
446 void snd_hdac_stream_release(struct hdac_stream *azx_dev);
447 struct hdac_stream *snd_hdac_get_stream(struct hdac_bus *bus,
448 int dir, int stream_tag);
450 int snd_hdac_stream_setup(struct hdac_stream *azx_dev);
451 void snd_hdac_stream_cleanup(struct hdac_stream *azx_dev);
452 int snd_hdac_stream_setup_periods(struct hdac_stream *azx_dev);
453 int snd_hdac_stream_set_params(struct hdac_stream *azx_dev,
454 unsigned int format_val);
455 void snd_hdac_stream_start(struct hdac_stream *azx_dev, bool fresh_start);
456 void snd_hdac_stream_clear(struct hdac_stream *azx_dev);
457 void snd_hdac_stream_stop(struct hdac_stream *azx_dev);
458 void snd_hdac_stream_reset(struct hdac_stream *azx_dev);
459 void snd_hdac_stream_sync_trigger(struct hdac_stream *azx_dev, bool set,
460 unsigned int streams, unsigned int reg);
461 void snd_hdac_stream_sync(struct hdac_stream *azx_dev, bool start,
462 unsigned int streams);
463 void snd_hdac_stream_timecounter_init(struct hdac_stream *azx_dev,
464 unsigned int streams);
466 * macros for easy use
468 #define _snd_hdac_stream_write(type, dev, reg, value) \
469 ((dev)->bus->io_ops->reg_write ## type(value, (dev)->sd_addr + (reg)))
470 #define _snd_hdac_stream_read(type, dev, reg) \
471 ((dev)->bus->io_ops->reg_read ## type((dev)->sd_addr + (reg)))
473 /* read/write a register, pass without AZX_REG_ prefix */
474 #define snd_hdac_stream_writel(dev, reg, value) \
475 _snd_hdac_stream_write(l, dev, AZX_REG_ ## reg, value)
476 #define snd_hdac_stream_writew(dev, reg, value) \
477 _snd_hdac_stream_write(w, dev, AZX_REG_ ## reg, value)
478 #define snd_hdac_stream_writeb(dev, reg, value) \
479 _snd_hdac_stream_write(b, dev, AZX_REG_ ## reg, value)
480 #define snd_hdac_stream_readl(dev, reg) \
481 _snd_hdac_stream_read(l, dev, AZX_REG_ ## reg)
482 #define snd_hdac_stream_readw(dev, reg) \
483 _snd_hdac_stream_read(w, dev, AZX_REG_ ## reg)
484 #define snd_hdac_stream_readb(dev, reg) \
485 _snd_hdac_stream_read(b, dev, AZX_REG_ ## reg)
487 /* update a register, pass without AZX_REG_ prefix */
488 #define snd_hdac_stream_updatel(dev, reg, mask, val) \
489 snd_hdac_stream_writel(dev, reg, \
490 (snd_hdac_stream_readl(dev, reg) & \
492 #define snd_hdac_stream_updatew(dev, reg, mask, val) \
493 snd_hdac_stream_writew(dev, reg, \
494 (snd_hdac_stream_readw(dev, reg) & \
496 #define snd_hdac_stream_updateb(dev, reg, mask, val) \
497 snd_hdac_stream_writeb(dev, reg, \
498 (snd_hdac_stream_readb(dev, reg) & \
501 #ifdef CONFIG_SND_HDA_DSP_LOADER
502 /* DSP lock helpers */
503 #define snd_hdac_dsp_lock_init(dev) mutex_init(&(dev)->dsp_mutex)
504 #define snd_hdac_dsp_lock(dev) mutex_lock(&(dev)->dsp_mutex)
505 #define snd_hdac_dsp_unlock(dev) mutex_unlock(&(dev)->dsp_mutex)
506 #define snd_hdac_stream_is_locked(dev) ((dev)->locked)
507 /* DSP loader helpers */
508 int snd_hdac_dsp_prepare(struct hdac_stream *azx_dev, unsigned int format,
509 unsigned int byte_size, struct snd_dma_buffer *bufp);
510 void snd_hdac_dsp_trigger(struct hdac_stream *azx_dev, bool start);
511 void snd_hdac_dsp_cleanup(struct hdac_stream *azx_dev,
512 struct snd_dma_buffer *dmab);
513 #else /* CONFIG_SND_HDA_DSP_LOADER */
514 #define snd_hdac_dsp_lock_init(dev) do {} while (0)
515 #define snd_hdac_dsp_lock(dev) do {} while (0)
516 #define snd_hdac_dsp_unlock(dev) do {} while (0)
517 #define snd_hdac_stream_is_locked(dev) 0
520 snd_hdac_dsp_prepare(struct hdac_stream *azx_dev, unsigned int format,
521 unsigned int byte_size, struct snd_dma_buffer *bufp)
526 static inline void snd_hdac_dsp_trigger(struct hdac_stream *azx_dev, bool start)
530 static inline void snd_hdac_dsp_cleanup(struct hdac_stream *azx_dev,
531 struct snd_dma_buffer *dmab)
534 #endif /* CONFIG_SND_HDA_DSP_LOADER */
538 * generic array helpers
540 void *snd_array_new(struct snd_array *array);
541 void snd_array_free(struct snd_array *array);
542 static inline void snd_array_init(struct snd_array *array, unsigned int size,
545 array->elem_size = size;
546 array->alloc_align = align;
549 static inline void *snd_array_elem(struct snd_array *array, unsigned int idx)
551 return array->list + idx * array->elem_size;
554 static inline unsigned int snd_array_index(struct snd_array *array, void *ptr)
556 return (unsigned long)(ptr - array->list) / array->elem_size;
559 #endif /* __SOUND_HDAUDIO_H */