1 /* SPDX-License-Identifier: GPL-2.0 */
6 #ifndef __SOUND_HDAUDIO_H
7 #define __SOUND_HDAUDIO_H
9 #include <linux/device.h>
10 #include <linux/interrupt.h>
11 #include <linux/timecounter.h>
12 #include <sound/core.h>
13 #include <sound/memalloc.h>
14 #include <sound/hda_verbs.h>
15 #include <drm/i915_component.h>
18 typedef u16 hda_nid_t;
24 struct hdac_widget_tree;
30 extern struct bus_type snd_hda_bus_type;
38 unsigned int elem_size;
39 unsigned int alloc_align;
44 * HD-audio codec base device
50 unsigned int addr; /* codec address */
51 struct list_head list; /* list point for bus codec_list */
53 hda_nid_t afg; /* AFG node id */
54 hda_nid_t mfg; /* MFG node id */
57 unsigned int vendor_id;
58 unsigned int subsystem_id;
59 unsigned int revision_id;
60 unsigned int afg_function_id;
61 unsigned int mfg_function_id;
62 unsigned int afg_unsol:1;
63 unsigned int mfg_unsol:1;
65 unsigned int power_caps; /* FG power caps */
67 const char *vendor_name; /* codec vendor name */
68 const char *chip_name; /* codec chip name */
70 /* verb exec op override */
71 int (*exec_verb)(struct hdac_device *dev, unsigned int cmd,
72 unsigned int flags, unsigned int *res);
75 unsigned int num_nodes;
76 hda_nid_t start_nid, end_nid;
79 atomic_t in_pm; /* suspend/resume being performed */
80 bool link_power_control:1;
83 struct hdac_widget_tree *widgets;
86 struct regmap *regmap;
87 struct snd_array vendor_verbs;
88 bool lazy_cache:1; /* don't wake up for writes */
89 bool caps_overwriting:1; /* caps overwrite being in process */
90 bool cache_coef:1; /* cache COEF read/write too */
93 /* device/driver type used for matching */
102 HDA_INPUT, HDA_OUTPUT
105 #define dev_to_hdac_dev(_dev) container_of(_dev, struct hdac_device, dev)
107 int snd_hdac_device_init(struct hdac_device *dev, struct hdac_bus *bus,
108 const char *name, unsigned int addr);
109 void snd_hdac_device_exit(struct hdac_device *dev);
110 int snd_hdac_device_register(struct hdac_device *codec);
111 void snd_hdac_device_unregister(struct hdac_device *codec);
112 int snd_hdac_device_set_chip_name(struct hdac_device *codec, const char *name);
113 int snd_hdac_codec_modalias(struct hdac_device *hdac, char *buf, size_t size);
115 int snd_hdac_refresh_widgets(struct hdac_device *codec, bool sysfs);
117 unsigned int snd_hdac_make_cmd(struct hdac_device *codec, hda_nid_t nid,
118 unsigned int verb, unsigned int parm);
119 int snd_hdac_exec_verb(struct hdac_device *codec, unsigned int cmd,
120 unsigned int flags, unsigned int *res);
121 int snd_hdac_read(struct hdac_device *codec, hda_nid_t nid,
122 unsigned int verb, unsigned int parm, unsigned int *res);
123 int _snd_hdac_read_parm(struct hdac_device *codec, hda_nid_t nid, int parm,
125 int snd_hdac_read_parm_uncached(struct hdac_device *codec, hda_nid_t nid,
127 int snd_hdac_override_parm(struct hdac_device *codec, hda_nid_t nid,
128 unsigned int parm, unsigned int val);
129 int snd_hdac_get_connections(struct hdac_device *codec, hda_nid_t nid,
130 hda_nid_t *conn_list, int max_conns);
131 int snd_hdac_get_sub_nodes(struct hdac_device *codec, hda_nid_t nid,
132 hda_nid_t *start_id);
133 unsigned int snd_hdac_calc_stream_format(unsigned int rate,
134 unsigned int channels,
137 unsigned short spdif_ctls);
138 int snd_hdac_query_supported_pcm(struct hdac_device *codec, hda_nid_t nid,
139 u32 *ratesp, u64 *formatsp, unsigned int *bpsp);
140 bool snd_hdac_is_supported_format(struct hdac_device *codec, hda_nid_t nid,
141 unsigned int format);
143 int snd_hdac_codec_read(struct hdac_device *hdac, hda_nid_t nid,
144 int flags, unsigned int verb, unsigned int parm);
145 int snd_hdac_codec_write(struct hdac_device *hdac, hda_nid_t nid,
146 int flags, unsigned int verb, unsigned int parm);
147 bool snd_hdac_check_power_state(struct hdac_device *hdac,
148 hda_nid_t nid, unsigned int target_state);
149 unsigned int snd_hdac_sync_power_state(struct hdac_device *hdac,
150 hda_nid_t nid, unsigned int target_state);
152 * snd_hdac_read_parm - read a codec parameter
153 * @codec: the codec object
154 * @nid: NID to read a parameter
155 * @parm: parameter to read
157 * Returns -1 for error. If you need to distinguish the error more
158 * strictly, use _snd_hdac_read_parm() directly.
160 static inline int snd_hdac_read_parm(struct hdac_device *codec, hda_nid_t nid,
165 return _snd_hdac_read_parm(codec, nid, parm, &val) < 0 ? -1 : val;
169 int snd_hdac_power_up(struct hdac_device *codec);
170 int snd_hdac_power_down(struct hdac_device *codec);
171 int snd_hdac_power_up_pm(struct hdac_device *codec);
172 int snd_hdac_power_down_pm(struct hdac_device *codec);
173 int snd_hdac_keep_power_up(struct hdac_device *codec);
175 static inline int snd_hdac_power_up(struct hdac_device *codec) { return 0; }
176 static inline int snd_hdac_power_down(struct hdac_device *codec) { return 0; }
177 static inline int snd_hdac_power_up_pm(struct hdac_device *codec) { return 0; }
178 static inline int snd_hdac_power_down_pm(struct hdac_device *codec) { return 0; }
179 static inline int snd_hdac_keep_power_up(struct hdac_device *codec) { return 0; }
183 * HD-audio codec base driver
186 struct device_driver driver;
188 const struct hda_device_id *id_table;
189 int (*match)(struct hdac_device *dev, struct hdac_driver *drv);
190 void (*unsol_event)(struct hdac_device *dev, unsigned int event);
192 /* fields used by ext bus APIs */
193 int (*probe)(struct hdac_device *dev);
194 int (*remove)(struct hdac_device *dev);
195 void (*shutdown)(struct hdac_device *dev);
198 #define drv_to_hdac_driver(_drv) container_of(_drv, struct hdac_driver, driver)
200 const struct hda_device_id *
201 hdac_get_device_id(struct hdac_device *hdev, struct hdac_driver *drv);
206 struct hdac_bus_ops {
207 /* send a single command */
208 int (*command)(struct hdac_bus *bus, unsigned int cmd);
209 /* get a response from the last command */
210 int (*get_response)(struct hdac_bus *bus, unsigned int addr,
212 /* control the link power */
213 int (*link_power)(struct hdac_bus *bus, bool enable);
217 * ops used for ASoC HDA codec drivers
219 struct hdac_ext_bus_ops {
220 int (*hdev_attach)(struct hdac_device *hdev);
221 int (*hdev_detach)(struct hdac_device *hdev);
225 * Lowlevel I/O operators
228 /* mapped register accesses */
229 void (*reg_writel)(u32 value, u32 __iomem *addr);
230 u32 (*reg_readl)(u32 __iomem *addr);
231 void (*reg_writew)(u16 value, u16 __iomem *addr);
232 u16 (*reg_readw)(u16 __iomem *addr);
233 void (*reg_writeb)(u8 value, u8 __iomem *addr);
234 u8 (*reg_readb)(u8 __iomem *addr);
236 int (*dma_alloc_pages)(struct hdac_bus *bus, int type, size_t size,
237 struct snd_dma_buffer *buf);
238 void (*dma_free_pages)(struct hdac_bus *bus,
239 struct snd_dma_buffer *buf);
242 #define HDA_UNSOL_QUEUE_SIZE 64
243 #define HDA_MAX_CODECS 8 /* limit by controller side */
248 * Each CORB entry is 4byte, RIRB is 8byte
251 __le32 *buf; /* virtual address of CORB/RIRB buffer */
252 dma_addr_t addr; /* physical address of CORB/RIRB buffer */
253 unsigned short rp, wp; /* RIRB read/write pointers */
254 int cmds[HDA_MAX_CODECS]; /* number of pending requests */
255 u32 res[HDA_MAX_CODECS]; /* last read value */
259 * HD-audio bus base driver
261 * @ppcap: pp capabilities pointer
262 * @spbcap: SPIB capabilities pointer
263 * @mlcap: MultiLink capabilities pointer
264 * @gtscap: gts capabilities pointer
265 * @drsmcap: dma resume capabilities pointer
266 * @num_streams: streams supported
267 * @idx: HDA link index
268 * @hlink_list: link list of HDA links
269 * @lock: lock for link mgmt
270 * @cmd_dma_state: state of cmd DMAs: CORB and RIRB
274 const struct hdac_bus_ops *ops;
275 const struct hdac_io_ops *io_ops;
276 const struct hdac_ext_bus_ops *ext_ops;
280 void __iomem *remap_addr;
284 void __iomem *spbcap;
286 void __iomem *gtscap;
287 void __iomem *drsmcap;
289 /* codec linked list */
290 struct list_head codec_list;
291 unsigned int num_codecs;
293 /* link caddr -> codec */
294 struct hdac_device *caddr_tbl[HDA_MAX_CODEC_ADDRESS + 1];
296 /* unsolicited event queue */
297 u32 unsol_queue[HDA_UNSOL_QUEUE_SIZE * 2]; /* ring buffer */
298 unsigned int unsol_rp, unsol_wp;
299 struct work_struct unsol_work;
301 /* bit flags of detected codecs */
302 unsigned long codec_mask;
304 /* bit flags of powered codecs */
305 unsigned long codec_powered;
310 unsigned int last_cmd[HDA_MAX_CODECS]; /* last sent command */
312 /* CORB/RIRB and position buffers */
313 struct snd_dma_buffer rb;
314 struct snd_dma_buffer posbuf;
316 /* hdac_stream linked list */
317 struct list_head stream_list;
319 /* operation state */
320 bool chip_init:1; /* h/w initialized */
323 bool sync_write:1; /* sync after verb write */
324 bool use_posbuf:1; /* use position buffer */
325 bool snoop:1; /* enable snooping */
326 bool align_bdle_4k:1; /* BDLE align 4K boundary */
327 bool reverse_assign:1; /* assign devices in reverse order */
328 bool corbrp_self_clear:1; /* CORBRP clears itself after reset */
330 int bdl_pos_adj; /* BDL position adjustment */
334 struct mutex cmd_mutex;
336 /* DRM component interface */
337 struct drm_audio_component *audio_component;
338 int drm_power_refcount;
340 /* parameters required for enhanced capabilities */
344 struct list_head hlink_list;
351 int snd_hdac_bus_init(struct hdac_bus *bus, struct device *dev,
352 const struct hdac_bus_ops *ops,
353 const struct hdac_io_ops *io_ops);
354 void snd_hdac_bus_exit(struct hdac_bus *bus);
355 int snd_hdac_bus_exec_verb(struct hdac_bus *bus, unsigned int addr,
356 unsigned int cmd, unsigned int *res);
357 int snd_hdac_bus_exec_verb_unlocked(struct hdac_bus *bus, unsigned int addr,
358 unsigned int cmd, unsigned int *res);
359 void snd_hdac_bus_queue_event(struct hdac_bus *bus, u32 res, u32 res_ex);
361 int snd_hdac_bus_add_device(struct hdac_bus *bus, struct hdac_device *codec);
362 void snd_hdac_bus_remove_device(struct hdac_bus *bus,
363 struct hdac_device *codec);
365 static inline void snd_hdac_codec_link_up(struct hdac_device *codec)
367 set_bit(codec->addr, &codec->bus->codec_powered);
370 static inline void snd_hdac_codec_link_down(struct hdac_device *codec)
372 clear_bit(codec->addr, &codec->bus->codec_powered);
375 int snd_hdac_bus_send_cmd(struct hdac_bus *bus, unsigned int val);
376 int snd_hdac_bus_get_response(struct hdac_bus *bus, unsigned int addr,
378 int snd_hdac_bus_parse_capabilities(struct hdac_bus *bus);
379 int snd_hdac_link_power(struct hdac_device *codec, bool enable);
381 bool snd_hdac_bus_init_chip(struct hdac_bus *bus, bool full_reset);
382 void snd_hdac_bus_stop_chip(struct hdac_bus *bus);
383 void snd_hdac_bus_init_cmd_io(struct hdac_bus *bus);
384 void snd_hdac_bus_stop_cmd_io(struct hdac_bus *bus);
385 void snd_hdac_bus_enter_link_reset(struct hdac_bus *bus);
386 void snd_hdac_bus_exit_link_reset(struct hdac_bus *bus);
387 int snd_hdac_bus_reset_link(struct hdac_bus *bus, bool full_reset);
389 void snd_hdac_bus_update_rirb(struct hdac_bus *bus);
390 int snd_hdac_bus_handle_stream_irq(struct hdac_bus *bus, unsigned int status,
391 void (*ack)(struct hdac_bus *,
392 struct hdac_stream *));
394 int snd_hdac_bus_alloc_stream_pages(struct hdac_bus *bus);
395 void snd_hdac_bus_free_stream_pages(struct hdac_bus *bus);
398 * macros for easy use
400 #define _snd_hdac_chip_writeb(chip, reg, value) \
401 ((chip)->io_ops->reg_writeb(value, (chip)->remap_addr + (reg)))
402 #define _snd_hdac_chip_readb(chip, reg) \
403 ((chip)->io_ops->reg_readb((chip)->remap_addr + (reg)))
404 #define _snd_hdac_chip_writew(chip, reg, value) \
405 ((chip)->io_ops->reg_writew(value, (chip)->remap_addr + (reg)))
406 #define _snd_hdac_chip_readw(chip, reg) \
407 ((chip)->io_ops->reg_readw((chip)->remap_addr + (reg)))
408 #define _snd_hdac_chip_writel(chip, reg, value) \
409 ((chip)->io_ops->reg_writel(value, (chip)->remap_addr + (reg)))
410 #define _snd_hdac_chip_readl(chip, reg) \
411 ((chip)->io_ops->reg_readl((chip)->remap_addr + (reg)))
413 /* read/write a register, pass without AZX_REG_ prefix */
414 #define snd_hdac_chip_writel(chip, reg, value) \
415 _snd_hdac_chip_writel(chip, AZX_REG_ ## reg, value)
416 #define snd_hdac_chip_writew(chip, reg, value) \
417 _snd_hdac_chip_writew(chip, AZX_REG_ ## reg, value)
418 #define snd_hdac_chip_writeb(chip, reg, value) \
419 _snd_hdac_chip_writeb(chip, AZX_REG_ ## reg, value)
420 #define snd_hdac_chip_readl(chip, reg) \
421 _snd_hdac_chip_readl(chip, AZX_REG_ ## reg)
422 #define snd_hdac_chip_readw(chip, reg) \
423 _snd_hdac_chip_readw(chip, AZX_REG_ ## reg)
424 #define snd_hdac_chip_readb(chip, reg) \
425 _snd_hdac_chip_readb(chip, AZX_REG_ ## reg)
427 /* update a register, pass without AZX_REG_ prefix */
428 #define snd_hdac_chip_updatel(chip, reg, mask, val) \
429 snd_hdac_chip_writel(chip, reg, \
430 (snd_hdac_chip_readl(chip, reg) & ~(mask)) | (val))
431 #define snd_hdac_chip_updatew(chip, reg, mask, val) \
432 snd_hdac_chip_writew(chip, reg, \
433 (snd_hdac_chip_readw(chip, reg) & ~(mask)) | (val))
434 #define snd_hdac_chip_updateb(chip, reg, mask, val) \
435 snd_hdac_chip_writeb(chip, reg, \
436 (snd_hdac_chip_readb(chip, reg) & ~(mask)) | (val))
442 struct hdac_bus *bus;
443 struct snd_dma_buffer bdl; /* BDL buffer */
444 __le32 *posbuf; /* position buffer pointer */
445 int direction; /* playback / capture (SNDRV_PCM_STREAM_*) */
447 unsigned int bufsize; /* size of the play buffer in bytes */
448 unsigned int period_bytes; /* size of the period in bytes */
449 unsigned int frags; /* number for period in the play buffer */
450 unsigned int fifo_size; /* FIFO size */
452 void __iomem *sd_addr; /* stream descriptor pointer */
454 u32 sd_int_sta_mask; /* stream int status mask */
457 struct snd_pcm_substream *substream; /* assigned substream,
460 unsigned int format_val; /* format value to be set in the
461 * controller and the codec
463 unsigned char stream_tag; /* assigned stream */
464 unsigned char index; /* stream index */
465 int assigned_key; /* last device# key assigned to */
470 bool no_period_wakeup:1;
474 unsigned long start_wallclk; /* start + minimum wallclk */
475 unsigned long period_wallclk; /* wallclk for period */
476 struct timecounter tc;
477 struct cyclecounter cc;
478 int delay_negative_threshold;
480 struct list_head list;
481 #ifdef CONFIG_SND_HDA_DSP_LOADER
482 /* DSP access mutex */
483 struct mutex dsp_mutex;
487 void snd_hdac_stream_init(struct hdac_bus *bus, struct hdac_stream *azx_dev,
488 int idx, int direction, int tag);
489 struct hdac_stream *snd_hdac_stream_assign(struct hdac_bus *bus,
490 struct snd_pcm_substream *substream);
491 void snd_hdac_stream_release(struct hdac_stream *azx_dev);
492 struct hdac_stream *snd_hdac_get_stream(struct hdac_bus *bus,
493 int dir, int stream_tag);
495 int snd_hdac_stream_setup(struct hdac_stream *azx_dev);
496 void snd_hdac_stream_cleanup(struct hdac_stream *azx_dev);
497 int snd_hdac_stream_setup_periods(struct hdac_stream *azx_dev);
498 int snd_hdac_stream_set_params(struct hdac_stream *azx_dev,
499 unsigned int format_val);
500 void snd_hdac_stream_start(struct hdac_stream *azx_dev, bool fresh_start);
501 void snd_hdac_stream_clear(struct hdac_stream *azx_dev);
502 void snd_hdac_stream_stop(struct hdac_stream *azx_dev);
503 void snd_hdac_stream_reset(struct hdac_stream *azx_dev);
504 void snd_hdac_stream_sync_trigger(struct hdac_stream *azx_dev, bool set,
505 unsigned int streams, unsigned int reg);
506 void snd_hdac_stream_sync(struct hdac_stream *azx_dev, bool start,
507 unsigned int streams);
508 void snd_hdac_stream_timecounter_init(struct hdac_stream *azx_dev,
509 unsigned int streams);
511 * macros for easy use
513 #define _snd_hdac_stream_write(type, dev, reg, value) \
514 ((dev)->bus->io_ops->reg_write ## type(value, (dev)->sd_addr + (reg)))
515 #define _snd_hdac_stream_read(type, dev, reg) \
516 ((dev)->bus->io_ops->reg_read ## type((dev)->sd_addr + (reg)))
518 /* read/write a register, pass without AZX_REG_ prefix */
519 #define snd_hdac_stream_writel(dev, reg, value) \
520 _snd_hdac_stream_write(l, dev, AZX_REG_ ## reg, value)
521 #define snd_hdac_stream_writew(dev, reg, value) \
522 _snd_hdac_stream_write(w, dev, AZX_REG_ ## reg, value)
523 #define snd_hdac_stream_writeb(dev, reg, value) \
524 _snd_hdac_stream_write(b, dev, AZX_REG_ ## reg, value)
525 #define snd_hdac_stream_readl(dev, reg) \
526 _snd_hdac_stream_read(l, dev, AZX_REG_ ## reg)
527 #define snd_hdac_stream_readw(dev, reg) \
528 _snd_hdac_stream_read(w, dev, AZX_REG_ ## reg)
529 #define snd_hdac_stream_readb(dev, reg) \
530 _snd_hdac_stream_read(b, dev, AZX_REG_ ## reg)
532 /* update a register, pass without AZX_REG_ prefix */
533 #define snd_hdac_stream_updatel(dev, reg, mask, val) \
534 snd_hdac_stream_writel(dev, reg, \
535 (snd_hdac_stream_readl(dev, reg) & \
537 #define snd_hdac_stream_updatew(dev, reg, mask, val) \
538 snd_hdac_stream_writew(dev, reg, \
539 (snd_hdac_stream_readw(dev, reg) & \
541 #define snd_hdac_stream_updateb(dev, reg, mask, val) \
542 snd_hdac_stream_writeb(dev, reg, \
543 (snd_hdac_stream_readb(dev, reg) & \
546 #ifdef CONFIG_SND_HDA_DSP_LOADER
547 /* DSP lock helpers */
548 #define snd_hdac_dsp_lock_init(dev) mutex_init(&(dev)->dsp_mutex)
549 #define snd_hdac_dsp_lock(dev) mutex_lock(&(dev)->dsp_mutex)
550 #define snd_hdac_dsp_unlock(dev) mutex_unlock(&(dev)->dsp_mutex)
551 #define snd_hdac_stream_is_locked(dev) ((dev)->locked)
552 /* DSP loader helpers */
553 int snd_hdac_dsp_prepare(struct hdac_stream *azx_dev, unsigned int format,
554 unsigned int byte_size, struct snd_dma_buffer *bufp);
555 void snd_hdac_dsp_trigger(struct hdac_stream *azx_dev, bool start);
556 void snd_hdac_dsp_cleanup(struct hdac_stream *azx_dev,
557 struct snd_dma_buffer *dmab);
558 #else /* CONFIG_SND_HDA_DSP_LOADER */
559 #define snd_hdac_dsp_lock_init(dev) do {} while (0)
560 #define snd_hdac_dsp_lock(dev) do {} while (0)
561 #define snd_hdac_dsp_unlock(dev) do {} while (0)
562 #define snd_hdac_stream_is_locked(dev) 0
565 snd_hdac_dsp_prepare(struct hdac_stream *azx_dev, unsigned int format,
566 unsigned int byte_size, struct snd_dma_buffer *bufp)
571 static inline void snd_hdac_dsp_trigger(struct hdac_stream *azx_dev, bool start)
575 static inline void snd_hdac_dsp_cleanup(struct hdac_stream *azx_dev,
576 struct snd_dma_buffer *dmab)
579 #endif /* CONFIG_SND_HDA_DSP_LOADER */
583 * generic array helpers
585 void *snd_array_new(struct snd_array *array);
586 void snd_array_free(struct snd_array *array);
587 static inline void snd_array_init(struct snd_array *array, unsigned int size,
590 array->elem_size = size;
591 array->alloc_align = align;
594 static inline void *snd_array_elem(struct snd_array *array, unsigned int idx)
596 return array->list + idx * array->elem_size;
599 static inline unsigned int snd_array_index(struct snd_array *array, void *ptr)
601 return (unsigned long)(ptr - array->list) / array->elem_size;
604 /* a helper macro to iterate for each snd_array element */
605 #define snd_array_for_each(array, idx, ptr) \
606 for ((idx) = 0, (ptr) = (array)->list; (idx) < (array)->used; \
607 (ptr) = snd_array_elem(array, ++(idx)))
609 #endif /* __SOUND_HDAUDIO_H */