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);
120 int snd_hdac_device_set_chip_name(struct hdac_device *codec, const char *name);
122 int snd_hdac_refresh_widgets(struct hdac_device *codec);
123 int snd_hdac_refresh_widget_sysfs(struct hdac_device *codec);
125 unsigned int snd_hdac_make_cmd(struct hdac_device *codec, hda_nid_t nid,
126 unsigned int verb, unsigned int parm);
127 int snd_hdac_exec_verb(struct hdac_device *codec, unsigned int cmd,
128 unsigned int flags, unsigned int *res);
129 int snd_hdac_read(struct hdac_device *codec, hda_nid_t nid,
130 unsigned int verb, unsigned int parm, unsigned int *res);
131 int _snd_hdac_read_parm(struct hdac_device *codec, hda_nid_t nid, int parm,
133 int snd_hdac_read_parm_uncached(struct hdac_device *codec, hda_nid_t nid,
135 int snd_hdac_override_parm(struct hdac_device *codec, hda_nid_t nid,
136 unsigned int parm, unsigned int val);
137 int snd_hdac_get_connections(struct hdac_device *codec, hda_nid_t nid,
138 hda_nid_t *conn_list, int max_conns);
139 int snd_hdac_get_sub_nodes(struct hdac_device *codec, hda_nid_t nid,
140 hda_nid_t *start_id);
141 unsigned int snd_hdac_calc_stream_format(unsigned int rate,
142 unsigned int channels,
145 unsigned short spdif_ctls);
146 int snd_hdac_query_supported_pcm(struct hdac_device *codec, hda_nid_t nid,
147 u32 *ratesp, u64 *formatsp, unsigned int *bpsp);
148 bool snd_hdac_is_supported_format(struct hdac_device *codec, hda_nid_t nid,
149 unsigned int format);
151 int snd_hdac_codec_read(struct hdac_device *hdac, hda_nid_t nid,
152 int flags, unsigned int verb, unsigned int parm);
153 int snd_hdac_codec_write(struct hdac_device *hdac, hda_nid_t nid,
154 int flags, unsigned int verb, unsigned int parm);
155 bool snd_hdac_check_power_state(struct hdac_device *hdac,
156 hda_nid_t nid, unsigned int target_state);
158 * snd_hdac_read_parm - read a codec parameter
159 * @codec: the codec object
160 * @nid: NID to read a parameter
161 * @parm: parameter to read
163 * Returns -1 for error. If you need to distinguish the error more
164 * strictly, use _snd_hdac_read_parm() directly.
166 static inline int snd_hdac_read_parm(struct hdac_device *codec, hda_nid_t nid,
171 return _snd_hdac_read_parm(codec, nid, parm, &val) < 0 ? -1 : val;
175 int snd_hdac_power_up(struct hdac_device *codec);
176 int snd_hdac_power_down(struct hdac_device *codec);
177 int snd_hdac_power_up_pm(struct hdac_device *codec);
178 int snd_hdac_power_down_pm(struct hdac_device *codec);
180 static inline int snd_hdac_power_up(struct hdac_device *codec) { return 0; }
181 static inline int snd_hdac_power_down(struct hdac_device *codec) { return 0; }
182 static inline int snd_hdac_power_up_pm(struct hdac_device *codec) { return 0; }
183 static inline int snd_hdac_power_down_pm(struct hdac_device *codec) { return 0; }
187 * HD-audio codec base driver
190 struct device_driver driver;
192 const struct hda_device_id *id_table;
193 int (*match)(struct hdac_device *dev, struct hdac_driver *drv);
194 void (*unsol_event)(struct hdac_device *dev, unsigned int event);
197 #define drv_to_hdac_driver(_drv) container_of(_drv, struct hdac_driver, driver)
199 const struct hda_device_id *
200 hdac_get_device_id(struct hdac_device *hdev, struct hdac_driver *drv);
205 struct hdac_bus_ops {
206 /* send a single command */
207 int (*command)(struct hdac_bus *bus, unsigned int cmd);
208 /* get a response from the last command */
209 int (*get_response)(struct hdac_bus *bus, unsigned int addr,
211 /* control the link power */
212 int (*link_power)(struct hdac_bus *bus, bool enable);
216 * Lowlevel I/O operators
219 /* mapped register accesses */
220 void (*reg_writel)(u32 value, u32 __iomem *addr);
221 u32 (*reg_readl)(u32 __iomem *addr);
222 void (*reg_writew)(u16 value, u16 __iomem *addr);
223 u16 (*reg_readw)(u16 __iomem *addr);
224 void (*reg_writeb)(u8 value, u8 __iomem *addr);
225 u8 (*reg_readb)(u8 __iomem *addr);
227 int (*dma_alloc_pages)(struct hdac_bus *bus, int type, size_t size,
228 struct snd_dma_buffer *buf);
229 void (*dma_free_pages)(struct hdac_bus *bus,
230 struct snd_dma_buffer *buf);
233 #define HDA_UNSOL_QUEUE_SIZE 64
234 #define HDA_MAX_CODECS 8 /* limit by controller side */
236 /* HD Audio class code */
237 #define PCI_CLASS_MULTIMEDIA_HD_AUDIO 0x0403
242 * Each CORB entry is 4byte, RIRB is 8byte
245 __le32 *buf; /* virtual address of CORB/RIRB buffer */
246 dma_addr_t addr; /* physical address of CORB/RIRB buffer */
247 unsigned short rp, wp; /* RIRB read/write pointers */
248 int cmds[HDA_MAX_CODECS]; /* number of pending requests */
249 u32 res[HDA_MAX_CODECS]; /* last read value */
253 * HD-audio bus base driver
257 const struct hdac_bus_ops *ops;
258 const struct hdac_io_ops *io_ops;
262 void __iomem *remap_addr;
265 /* codec linked list */
266 struct list_head codec_list;
267 unsigned int num_codecs;
269 /* link caddr -> codec */
270 struct hdac_device *caddr_tbl[HDA_MAX_CODEC_ADDRESS + 1];
272 /* unsolicited event queue */
273 u32 unsol_queue[HDA_UNSOL_QUEUE_SIZE * 2]; /* ring buffer */
274 unsigned int unsol_rp, unsol_wp;
275 struct work_struct unsol_work;
277 /* bit flags of detected codecs */
278 unsigned long codec_mask;
280 /* bit flags of powered codecs */
281 unsigned long codec_powered;
286 unsigned int last_cmd[HDA_MAX_CODECS]; /* last sent command */
288 /* CORB/RIRB and position buffers */
289 struct snd_dma_buffer rb;
290 struct snd_dma_buffer posbuf;
292 /* hdac_stream linked list */
293 struct list_head stream_list;
295 /* operation state */
296 bool chip_init:1; /* h/w initialized */
299 bool sync_write:1; /* sync after verb write */
300 bool use_posbuf:1; /* use position buffer */
301 bool snoop:1; /* enable snooping */
302 bool align_bdle_4k:1; /* BDLE align 4K boundary */
303 bool reverse_assign:1; /* assign devices in reverse order */
304 bool corbrp_self_clear:1; /* CORBRP clears itself after reset */
306 int bdl_pos_adj; /* BDL position adjustment */
310 struct mutex cmd_mutex;
312 /* i915 component interface */
313 struct i915_audio_component *audio_component;
314 int i915_power_refcount;
317 int snd_hdac_bus_init(struct hdac_bus *bus, struct device *dev,
318 const struct hdac_bus_ops *ops,
319 const struct hdac_io_ops *io_ops);
320 void snd_hdac_bus_exit(struct hdac_bus *bus);
321 int snd_hdac_bus_exec_verb(struct hdac_bus *bus, unsigned int addr,
322 unsigned int cmd, unsigned int *res);
323 int snd_hdac_bus_exec_verb_unlocked(struct hdac_bus *bus, unsigned int addr,
324 unsigned int cmd, unsigned int *res);
325 void snd_hdac_bus_queue_event(struct hdac_bus *bus, u32 res, u32 res_ex);
327 int snd_hdac_bus_add_device(struct hdac_bus *bus, struct hdac_device *codec);
328 void snd_hdac_bus_remove_device(struct hdac_bus *bus,
329 struct hdac_device *codec);
331 static inline void snd_hdac_codec_link_up(struct hdac_device *codec)
333 set_bit(codec->addr, &codec->bus->codec_powered);
336 static inline void snd_hdac_codec_link_down(struct hdac_device *codec)
338 clear_bit(codec->addr, &codec->bus->codec_powered);
341 int snd_hdac_bus_send_cmd(struct hdac_bus *bus, unsigned int val);
342 int snd_hdac_bus_get_response(struct hdac_bus *bus, unsigned int addr,
344 int snd_hdac_link_power(struct hdac_device *codec, bool enable);
346 bool snd_hdac_bus_init_chip(struct hdac_bus *bus, bool full_reset);
347 void snd_hdac_bus_stop_chip(struct hdac_bus *bus);
348 void snd_hdac_bus_init_cmd_io(struct hdac_bus *bus);
349 void snd_hdac_bus_stop_cmd_io(struct hdac_bus *bus);
350 void snd_hdac_bus_enter_link_reset(struct hdac_bus *bus);
351 void snd_hdac_bus_exit_link_reset(struct hdac_bus *bus);
353 void snd_hdac_bus_update_rirb(struct hdac_bus *bus);
354 void snd_hdac_bus_handle_stream_irq(struct hdac_bus *bus, unsigned int status,
355 void (*ack)(struct hdac_bus *,
356 struct hdac_stream *));
358 int snd_hdac_bus_alloc_stream_pages(struct hdac_bus *bus);
359 void snd_hdac_bus_free_stream_pages(struct hdac_bus *bus);
362 * macros for easy use
364 #define _snd_hdac_chip_write(type, chip, reg, value) \
365 ((chip)->io_ops->reg_write ## type(value, (chip)->remap_addr + (reg)))
366 #define _snd_hdac_chip_read(type, chip, reg) \
367 ((chip)->io_ops->reg_read ## type((chip)->remap_addr + (reg)))
369 /* read/write a register, pass without AZX_REG_ prefix */
370 #define snd_hdac_chip_writel(chip, reg, value) \
371 _snd_hdac_chip_write(l, chip, AZX_REG_ ## reg, value)
372 #define snd_hdac_chip_writew(chip, reg, value) \
373 _snd_hdac_chip_write(w, chip, AZX_REG_ ## reg, value)
374 #define snd_hdac_chip_writeb(chip, reg, value) \
375 _snd_hdac_chip_write(b, chip, AZX_REG_ ## reg, value)
376 #define snd_hdac_chip_readl(chip, reg) \
377 _snd_hdac_chip_read(l, chip, AZX_REG_ ## reg)
378 #define snd_hdac_chip_readw(chip, reg) \
379 _snd_hdac_chip_read(w, chip, AZX_REG_ ## reg)
380 #define snd_hdac_chip_readb(chip, reg) \
381 _snd_hdac_chip_read(b, chip, AZX_REG_ ## reg)
383 /* update a register, pass without AZX_REG_ prefix */
384 #define snd_hdac_chip_updatel(chip, reg, mask, val) \
385 snd_hdac_chip_writel(chip, reg, \
386 (snd_hdac_chip_readl(chip, reg) & ~(mask)) | (val))
387 #define snd_hdac_chip_updatew(chip, reg, mask, val) \
388 snd_hdac_chip_writew(chip, reg, \
389 (snd_hdac_chip_readw(chip, reg) & ~(mask)) | (val))
390 #define snd_hdac_chip_updateb(chip, reg, mask, val) \
391 snd_hdac_chip_writeb(chip, reg, \
392 (snd_hdac_chip_readb(chip, reg) & ~(mask)) | (val))
398 struct hdac_bus *bus;
399 struct snd_dma_buffer bdl; /* BDL buffer */
400 __le32 *posbuf; /* position buffer pointer */
401 int direction; /* playback / capture (SNDRV_PCM_STREAM_*) */
403 unsigned int bufsize; /* size of the play buffer in bytes */
404 unsigned int period_bytes; /* size of the period in bytes */
405 unsigned int frags; /* number for period in the play buffer */
406 unsigned int fifo_size; /* FIFO size */
408 void __iomem *sd_addr; /* stream descriptor pointer */
410 u32 sd_int_sta_mask; /* stream int status mask */
413 struct snd_pcm_substream *substream; /* assigned substream,
416 unsigned int format_val; /* format value to be set in the
417 * controller and the codec
419 unsigned char stream_tag; /* assigned stream */
420 unsigned char index; /* stream index */
421 int assigned_key; /* last device# key assigned to */
426 bool no_period_wakeup:1;
430 unsigned long start_wallclk; /* start + minimum wallclk */
431 unsigned long period_wallclk; /* wallclk for period */
432 struct timecounter tc;
433 struct cyclecounter cc;
434 int delay_negative_threshold;
436 struct list_head list;
437 #ifdef CONFIG_SND_HDA_DSP_LOADER
438 /* DSP access mutex */
439 struct mutex dsp_mutex;
443 void snd_hdac_stream_init(struct hdac_bus *bus, struct hdac_stream *azx_dev,
444 int idx, int direction, int tag);
445 struct hdac_stream *snd_hdac_stream_assign(struct hdac_bus *bus,
446 struct snd_pcm_substream *substream);
447 void snd_hdac_stream_release(struct hdac_stream *azx_dev);
448 struct hdac_stream *snd_hdac_get_stream(struct hdac_bus *bus,
449 int dir, int stream_tag);
451 int snd_hdac_stream_setup(struct hdac_stream *azx_dev);
452 void snd_hdac_stream_cleanup(struct hdac_stream *azx_dev);
453 int snd_hdac_stream_setup_periods(struct hdac_stream *azx_dev);
454 int snd_hdac_stream_set_params(struct hdac_stream *azx_dev,
455 unsigned int format_val);
456 void snd_hdac_stream_start(struct hdac_stream *azx_dev, bool fresh_start);
457 void snd_hdac_stream_clear(struct hdac_stream *azx_dev);
458 void snd_hdac_stream_stop(struct hdac_stream *azx_dev);
459 void snd_hdac_stream_reset(struct hdac_stream *azx_dev);
460 void snd_hdac_stream_sync_trigger(struct hdac_stream *azx_dev, bool set,
461 unsigned int streams, unsigned int reg);
462 void snd_hdac_stream_sync(struct hdac_stream *azx_dev, bool start,
463 unsigned int streams);
464 void snd_hdac_stream_timecounter_init(struct hdac_stream *azx_dev,
465 unsigned int streams);
467 * macros for easy use
469 #define _snd_hdac_stream_write(type, dev, reg, value) \
470 ((dev)->bus->io_ops->reg_write ## type(value, (dev)->sd_addr + (reg)))
471 #define _snd_hdac_stream_read(type, dev, reg) \
472 ((dev)->bus->io_ops->reg_read ## type((dev)->sd_addr + (reg)))
474 /* read/write a register, pass without AZX_REG_ prefix */
475 #define snd_hdac_stream_writel(dev, reg, value) \
476 _snd_hdac_stream_write(l, dev, AZX_REG_ ## reg, value)
477 #define snd_hdac_stream_writew(dev, reg, value) \
478 _snd_hdac_stream_write(w, dev, AZX_REG_ ## reg, value)
479 #define snd_hdac_stream_writeb(dev, reg, value) \
480 _snd_hdac_stream_write(b, dev, AZX_REG_ ## reg, value)
481 #define snd_hdac_stream_readl(dev, reg) \
482 _snd_hdac_stream_read(l, dev, AZX_REG_ ## reg)
483 #define snd_hdac_stream_readw(dev, reg) \
484 _snd_hdac_stream_read(w, dev, AZX_REG_ ## reg)
485 #define snd_hdac_stream_readb(dev, reg) \
486 _snd_hdac_stream_read(b, dev, AZX_REG_ ## reg)
488 /* update a register, pass without AZX_REG_ prefix */
489 #define snd_hdac_stream_updatel(dev, reg, mask, val) \
490 snd_hdac_stream_writel(dev, reg, \
491 (snd_hdac_stream_readl(dev, reg) & \
493 #define snd_hdac_stream_updatew(dev, reg, mask, val) \
494 snd_hdac_stream_writew(dev, reg, \
495 (snd_hdac_stream_readw(dev, reg) & \
497 #define snd_hdac_stream_updateb(dev, reg, mask, val) \
498 snd_hdac_stream_writeb(dev, reg, \
499 (snd_hdac_stream_readb(dev, reg) & \
502 #ifdef CONFIG_SND_HDA_DSP_LOADER
503 /* DSP lock helpers */
504 #define snd_hdac_dsp_lock_init(dev) mutex_init(&(dev)->dsp_mutex)
505 #define snd_hdac_dsp_lock(dev) mutex_lock(&(dev)->dsp_mutex)
506 #define snd_hdac_dsp_unlock(dev) mutex_unlock(&(dev)->dsp_mutex)
507 #define snd_hdac_stream_is_locked(dev) ((dev)->locked)
508 /* DSP loader helpers */
509 int snd_hdac_dsp_prepare(struct hdac_stream *azx_dev, unsigned int format,
510 unsigned int byte_size, struct snd_dma_buffer *bufp);
511 void snd_hdac_dsp_trigger(struct hdac_stream *azx_dev, bool start);
512 void snd_hdac_dsp_cleanup(struct hdac_stream *azx_dev,
513 struct snd_dma_buffer *dmab);
514 #else /* CONFIG_SND_HDA_DSP_LOADER */
515 #define snd_hdac_dsp_lock_init(dev) do {} while (0)
516 #define snd_hdac_dsp_lock(dev) do {} while (0)
517 #define snd_hdac_dsp_unlock(dev) do {} while (0)
518 #define snd_hdac_stream_is_locked(dev) 0
521 snd_hdac_dsp_prepare(struct hdac_stream *azx_dev, unsigned int format,
522 unsigned int byte_size, struct snd_dma_buffer *bufp)
527 static inline void snd_hdac_dsp_trigger(struct hdac_stream *azx_dev, bool start)
531 static inline void snd_hdac_dsp_cleanup(struct hdac_stream *azx_dev,
532 struct snd_dma_buffer *dmab)
535 #endif /* CONFIG_SND_HDA_DSP_LOADER */
539 * generic array helpers
541 void *snd_array_new(struct snd_array *array);
542 void snd_array_free(struct snd_array *array);
543 static inline void snd_array_init(struct snd_array *array, unsigned int size,
546 array->elem_size = size;
547 array->alloc_align = align;
550 static inline void *snd_array_elem(struct snd_array *array, unsigned int idx)
552 return array->list + idx * array->elem_size;
555 static inline unsigned int snd_array_index(struct snd_array *array, void *ptr)
557 return (unsigned long)(ptr - array->list) / array->elem_size;
560 #endif /* __SOUND_HDAUDIO_H */