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);
150 * snd_hdac_read_parm - read a codec parameter
151 * @codec: the codec object
152 * @nid: NID to read a parameter
153 * @parm: parameter to read
155 * Returns -1 for error. If you need to distinguish the error more
156 * strictly, use _snd_hdac_read_parm() directly.
158 static inline int snd_hdac_read_parm(struct hdac_device *codec, hda_nid_t nid,
163 return _snd_hdac_read_parm(codec, nid, parm, &val) < 0 ? -1 : val;
167 int snd_hdac_power_up(struct hdac_device *codec);
168 int snd_hdac_power_down(struct hdac_device *codec);
169 int snd_hdac_power_up_pm(struct hdac_device *codec);
170 int snd_hdac_power_down_pm(struct hdac_device *codec);
171 int snd_hdac_keep_power_up(struct hdac_device *codec);
173 static inline int snd_hdac_power_up(struct hdac_device *codec) { return 0; }
174 static inline int snd_hdac_power_down(struct hdac_device *codec) { return 0; }
175 static inline int snd_hdac_power_up_pm(struct hdac_device *codec) { return 0; }
176 static inline int snd_hdac_power_down_pm(struct hdac_device *codec) { return 0; }
177 static inline int snd_hdac_keep_power_up(struct hdac_device *codec) { return 0; }
181 * HD-audio codec base driver
184 struct device_driver driver;
186 const struct hda_device_id *id_table;
187 int (*match)(struct hdac_device *dev, struct hdac_driver *drv);
188 void (*unsol_event)(struct hdac_device *dev, unsigned int event);
191 #define drv_to_hdac_driver(_drv) container_of(_drv, struct hdac_driver, driver)
193 const struct hda_device_id *
194 hdac_get_device_id(struct hdac_device *hdev, struct hdac_driver *drv);
199 struct hdac_bus_ops {
200 /* send a single command */
201 int (*command)(struct hdac_bus *bus, unsigned int cmd);
202 /* get a response from the last command */
203 int (*get_response)(struct hdac_bus *bus, unsigned int addr,
205 /* control the link power */
206 int (*link_power)(struct hdac_bus *bus, bool enable);
210 * Lowlevel I/O operators
213 /* mapped register accesses */
214 void (*reg_writel)(u32 value, u32 __iomem *addr);
215 u32 (*reg_readl)(u32 __iomem *addr);
216 void (*reg_writew)(u16 value, u16 __iomem *addr);
217 u16 (*reg_readw)(u16 __iomem *addr);
218 void (*reg_writeb)(u8 value, u8 __iomem *addr);
219 u8 (*reg_readb)(u8 __iomem *addr);
221 int (*dma_alloc_pages)(struct hdac_bus *bus, int type, size_t size,
222 struct snd_dma_buffer *buf);
223 void (*dma_free_pages)(struct hdac_bus *bus,
224 struct snd_dma_buffer *buf);
227 #define HDA_UNSOL_QUEUE_SIZE 64
228 #define HDA_MAX_CODECS 8 /* limit by controller side */
233 * Each CORB entry is 4byte, RIRB is 8byte
236 __le32 *buf; /* virtual address of CORB/RIRB buffer */
237 dma_addr_t addr; /* physical address of CORB/RIRB buffer */
238 unsigned short rp, wp; /* RIRB read/write pointers */
239 int cmds[HDA_MAX_CODECS]; /* number of pending requests */
240 u32 res[HDA_MAX_CODECS]; /* last read value */
244 * HD-audio bus base driver
246 * @ppcap: pp capabilities pointer
247 * @spbcap: SPIB capabilities pointer
248 * @mlcap: MultiLink capabilities pointer
249 * @gtscap: gts capabilities pointer
250 * @drsmcap: dma resume capabilities pointer
254 const struct hdac_bus_ops *ops;
255 const struct hdac_io_ops *io_ops;
259 void __iomem *remap_addr;
263 void __iomem *spbcap;
265 void __iomem *gtscap;
266 void __iomem *drsmcap;
268 /* codec linked list */
269 struct list_head codec_list;
270 unsigned int num_codecs;
272 /* link caddr -> codec */
273 struct hdac_device *caddr_tbl[HDA_MAX_CODEC_ADDRESS + 1];
275 /* unsolicited event queue */
276 u32 unsol_queue[HDA_UNSOL_QUEUE_SIZE * 2]; /* ring buffer */
277 unsigned int unsol_rp, unsol_wp;
278 struct work_struct unsol_work;
280 /* bit flags of detected codecs */
281 unsigned long codec_mask;
283 /* bit flags of powered codecs */
284 unsigned long codec_powered;
289 unsigned int last_cmd[HDA_MAX_CODECS]; /* last sent command */
291 /* CORB/RIRB and position buffers */
292 struct snd_dma_buffer rb;
293 struct snd_dma_buffer posbuf;
295 /* hdac_stream linked list */
296 struct list_head stream_list;
298 /* operation state */
299 bool chip_init:1; /* h/w initialized */
302 bool sync_write:1; /* sync after verb write */
303 bool use_posbuf:1; /* use position buffer */
304 bool snoop:1; /* enable snooping */
305 bool align_bdle_4k:1; /* BDLE align 4K boundary */
306 bool reverse_assign:1; /* assign devices in reverse order */
307 bool corbrp_self_clear:1; /* CORBRP clears itself after reset */
309 int bdl_pos_adj; /* BDL position adjustment */
313 struct mutex cmd_mutex;
315 /* i915 component interface */
316 struct i915_audio_component *audio_component;
317 int i915_power_refcount;
320 int snd_hdac_bus_init(struct hdac_bus *bus, struct device *dev,
321 const struct hdac_bus_ops *ops,
322 const struct hdac_io_ops *io_ops);
323 void snd_hdac_bus_exit(struct hdac_bus *bus);
324 int snd_hdac_bus_exec_verb(struct hdac_bus *bus, unsigned int addr,
325 unsigned int cmd, unsigned int *res);
326 int snd_hdac_bus_exec_verb_unlocked(struct hdac_bus *bus, unsigned int addr,
327 unsigned int cmd, unsigned int *res);
328 void snd_hdac_bus_queue_event(struct hdac_bus *bus, u32 res, u32 res_ex);
330 int snd_hdac_bus_add_device(struct hdac_bus *bus, struct hdac_device *codec);
331 void snd_hdac_bus_remove_device(struct hdac_bus *bus,
332 struct hdac_device *codec);
334 static inline void snd_hdac_codec_link_up(struct hdac_device *codec)
336 set_bit(codec->addr, &codec->bus->codec_powered);
339 static inline void snd_hdac_codec_link_down(struct hdac_device *codec)
341 clear_bit(codec->addr, &codec->bus->codec_powered);
344 int snd_hdac_bus_send_cmd(struct hdac_bus *bus, unsigned int val);
345 int snd_hdac_bus_get_response(struct hdac_bus *bus, unsigned int addr,
347 int snd_hdac_bus_parse_capabilities(struct hdac_bus *bus);
348 int snd_hdac_link_power(struct hdac_device *codec, bool enable);
350 bool snd_hdac_bus_init_chip(struct hdac_bus *bus, bool full_reset);
351 void snd_hdac_bus_stop_chip(struct hdac_bus *bus);
352 void snd_hdac_bus_init_cmd_io(struct hdac_bus *bus);
353 void snd_hdac_bus_stop_cmd_io(struct hdac_bus *bus);
354 void snd_hdac_bus_enter_link_reset(struct hdac_bus *bus);
355 void snd_hdac_bus_exit_link_reset(struct hdac_bus *bus);
357 void snd_hdac_bus_update_rirb(struct hdac_bus *bus);
358 int snd_hdac_bus_handle_stream_irq(struct hdac_bus *bus, unsigned int status,
359 void (*ack)(struct hdac_bus *,
360 struct hdac_stream *));
362 int snd_hdac_bus_alloc_stream_pages(struct hdac_bus *bus);
363 void snd_hdac_bus_free_stream_pages(struct hdac_bus *bus);
366 * macros for easy use
368 #define _snd_hdac_chip_writeb(chip, reg, value) \
369 ((chip)->io_ops->reg_writeb(value, (chip)->remap_addr + (reg)))
370 #define _snd_hdac_chip_readb(chip, reg) \
371 ((chip)->io_ops->reg_readb((chip)->remap_addr + (reg)))
372 #define _snd_hdac_chip_writew(chip, reg, value) \
373 ((chip)->io_ops->reg_writew(value, (chip)->remap_addr + (reg)))
374 #define _snd_hdac_chip_readw(chip, reg) \
375 ((chip)->io_ops->reg_readw((chip)->remap_addr + (reg)))
376 #define _snd_hdac_chip_writel(chip, reg, value) \
377 ((chip)->io_ops->reg_writel(value, (chip)->remap_addr + (reg)))
378 #define _snd_hdac_chip_readl(chip, reg) \
379 ((chip)->io_ops->reg_readl((chip)->remap_addr + (reg)))
381 /* read/write a register, pass without AZX_REG_ prefix */
382 #define snd_hdac_chip_writel(chip, reg, value) \
383 _snd_hdac_chip_writel(chip, AZX_REG_ ## reg, value)
384 #define snd_hdac_chip_writew(chip, reg, value) \
385 _snd_hdac_chip_writew(chip, AZX_REG_ ## reg, value)
386 #define snd_hdac_chip_writeb(chip, reg, value) \
387 _snd_hdac_chip_writeb(chip, AZX_REG_ ## reg, value)
388 #define snd_hdac_chip_readl(chip, reg) \
389 _snd_hdac_chip_readl(chip, AZX_REG_ ## reg)
390 #define snd_hdac_chip_readw(chip, reg) \
391 _snd_hdac_chip_readw(chip, AZX_REG_ ## reg)
392 #define snd_hdac_chip_readb(chip, reg) \
393 _snd_hdac_chip_readb(chip, AZX_REG_ ## reg)
395 /* update a register, pass without AZX_REG_ prefix */
396 #define snd_hdac_chip_updatel(chip, reg, mask, val) \
397 snd_hdac_chip_writel(chip, reg, \
398 (snd_hdac_chip_readl(chip, reg) & ~(mask)) | (val))
399 #define snd_hdac_chip_updatew(chip, reg, mask, val) \
400 snd_hdac_chip_writew(chip, reg, \
401 (snd_hdac_chip_readw(chip, reg) & ~(mask)) | (val))
402 #define snd_hdac_chip_updateb(chip, reg, mask, val) \
403 snd_hdac_chip_writeb(chip, reg, \
404 (snd_hdac_chip_readb(chip, reg) & ~(mask)) | (val))
410 struct hdac_bus *bus;
411 struct snd_dma_buffer bdl; /* BDL buffer */
412 __le32 *posbuf; /* position buffer pointer */
413 int direction; /* playback / capture (SNDRV_PCM_STREAM_*) */
415 unsigned int bufsize; /* size of the play buffer in bytes */
416 unsigned int period_bytes; /* size of the period in bytes */
417 unsigned int frags; /* number for period in the play buffer */
418 unsigned int fifo_size; /* FIFO size */
420 void __iomem *sd_addr; /* stream descriptor pointer */
422 u32 sd_int_sta_mask; /* stream int status mask */
425 struct snd_pcm_substream *substream; /* assigned substream,
428 unsigned int format_val; /* format value to be set in the
429 * controller and the codec
431 unsigned char stream_tag; /* assigned stream */
432 unsigned char index; /* stream index */
433 int assigned_key; /* last device# key assigned to */
438 bool no_period_wakeup:1;
442 unsigned long start_wallclk; /* start + minimum wallclk */
443 unsigned long period_wallclk; /* wallclk for period */
444 struct timecounter tc;
445 struct cyclecounter cc;
446 int delay_negative_threshold;
448 struct list_head list;
449 #ifdef CONFIG_SND_HDA_DSP_LOADER
450 /* DSP access mutex */
451 struct mutex dsp_mutex;
455 void snd_hdac_stream_init(struct hdac_bus *bus, struct hdac_stream *azx_dev,
456 int idx, int direction, int tag);
457 struct hdac_stream *snd_hdac_stream_assign(struct hdac_bus *bus,
458 struct snd_pcm_substream *substream);
459 void snd_hdac_stream_release(struct hdac_stream *azx_dev);
460 struct hdac_stream *snd_hdac_get_stream(struct hdac_bus *bus,
461 int dir, int stream_tag);
463 int snd_hdac_stream_setup(struct hdac_stream *azx_dev);
464 void snd_hdac_stream_cleanup(struct hdac_stream *azx_dev);
465 int snd_hdac_stream_setup_periods(struct hdac_stream *azx_dev);
466 int snd_hdac_stream_set_params(struct hdac_stream *azx_dev,
467 unsigned int format_val);
468 void snd_hdac_stream_start(struct hdac_stream *azx_dev, bool fresh_start);
469 void snd_hdac_stream_clear(struct hdac_stream *azx_dev);
470 void snd_hdac_stream_stop(struct hdac_stream *azx_dev);
471 void snd_hdac_stream_reset(struct hdac_stream *azx_dev);
472 void snd_hdac_stream_sync_trigger(struct hdac_stream *azx_dev, bool set,
473 unsigned int streams, unsigned int reg);
474 void snd_hdac_stream_sync(struct hdac_stream *azx_dev, bool start,
475 unsigned int streams);
476 void snd_hdac_stream_timecounter_init(struct hdac_stream *azx_dev,
477 unsigned int streams);
479 * macros for easy use
481 #define _snd_hdac_stream_write(type, dev, reg, value) \
482 ((dev)->bus->io_ops->reg_write ## type(value, (dev)->sd_addr + (reg)))
483 #define _snd_hdac_stream_read(type, dev, reg) \
484 ((dev)->bus->io_ops->reg_read ## type((dev)->sd_addr + (reg)))
486 /* read/write a register, pass without AZX_REG_ prefix */
487 #define snd_hdac_stream_writel(dev, reg, value) \
488 _snd_hdac_stream_write(l, dev, AZX_REG_ ## reg, value)
489 #define snd_hdac_stream_writew(dev, reg, value) \
490 _snd_hdac_stream_write(w, dev, AZX_REG_ ## reg, value)
491 #define snd_hdac_stream_writeb(dev, reg, value) \
492 _snd_hdac_stream_write(b, dev, AZX_REG_ ## reg, value)
493 #define snd_hdac_stream_readl(dev, reg) \
494 _snd_hdac_stream_read(l, dev, AZX_REG_ ## reg)
495 #define snd_hdac_stream_readw(dev, reg) \
496 _snd_hdac_stream_read(w, dev, AZX_REG_ ## reg)
497 #define snd_hdac_stream_readb(dev, reg) \
498 _snd_hdac_stream_read(b, dev, AZX_REG_ ## reg)
500 /* update a register, pass without AZX_REG_ prefix */
501 #define snd_hdac_stream_updatel(dev, reg, mask, val) \
502 snd_hdac_stream_writel(dev, reg, \
503 (snd_hdac_stream_readl(dev, reg) & \
505 #define snd_hdac_stream_updatew(dev, reg, mask, val) \
506 snd_hdac_stream_writew(dev, reg, \
507 (snd_hdac_stream_readw(dev, reg) & \
509 #define snd_hdac_stream_updateb(dev, reg, mask, val) \
510 snd_hdac_stream_writeb(dev, reg, \
511 (snd_hdac_stream_readb(dev, reg) & \
514 #ifdef CONFIG_SND_HDA_DSP_LOADER
515 /* DSP lock helpers */
516 #define snd_hdac_dsp_lock_init(dev) mutex_init(&(dev)->dsp_mutex)
517 #define snd_hdac_dsp_lock(dev) mutex_lock(&(dev)->dsp_mutex)
518 #define snd_hdac_dsp_unlock(dev) mutex_unlock(&(dev)->dsp_mutex)
519 #define snd_hdac_stream_is_locked(dev) ((dev)->locked)
520 /* DSP loader helpers */
521 int snd_hdac_dsp_prepare(struct hdac_stream *azx_dev, unsigned int format,
522 unsigned int byte_size, struct snd_dma_buffer *bufp);
523 void snd_hdac_dsp_trigger(struct hdac_stream *azx_dev, bool start);
524 void snd_hdac_dsp_cleanup(struct hdac_stream *azx_dev,
525 struct snd_dma_buffer *dmab);
526 #else /* CONFIG_SND_HDA_DSP_LOADER */
527 #define snd_hdac_dsp_lock_init(dev) do {} while (0)
528 #define snd_hdac_dsp_lock(dev) do {} while (0)
529 #define snd_hdac_dsp_unlock(dev) do {} while (0)
530 #define snd_hdac_stream_is_locked(dev) 0
533 snd_hdac_dsp_prepare(struct hdac_stream *azx_dev, unsigned int format,
534 unsigned int byte_size, struct snd_dma_buffer *bufp)
539 static inline void snd_hdac_dsp_trigger(struct hdac_stream *azx_dev, bool start)
543 static inline void snd_hdac_dsp_cleanup(struct hdac_stream *azx_dev,
544 struct snd_dma_buffer *dmab)
547 #endif /* CONFIG_SND_HDA_DSP_LOADER */
551 * generic array helpers
553 void *snd_array_new(struct snd_array *array);
554 void snd_array_free(struct snd_array *array);
555 static inline void snd_array_init(struct snd_array *array, unsigned int size,
558 array->elem_size = size;
559 array->alloc_align = align;
562 static inline void *snd_array_elem(struct snd_array *array, unsigned int idx)
564 return array->list + idx * array->elem_size;
567 static inline unsigned int snd_array_index(struct snd_array *array, void *ptr)
569 return (unsigned long)(ptr - array->list) / array->elem_size;
572 #endif /* __SOUND_HDAUDIO_H */