xref: /linux/include/sound/hdaudio.h (revision 81c29435073355b8194986a2193d3e7b9d449225)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * HD-audio core stuff
4  */
5 
6 #ifndef __SOUND_HDAUDIO_H
7 #define __SOUND_HDAUDIO_H
8 
9 #include <linux/device.h>
10 #include <linux/interrupt.h>
11 #include <linux/io.h>
12 #include <linux/io-64-nonatomic-lo-hi.h>
13 #include <linux/iopoll.h>
14 #include <linux/pm_runtime.h>
15 #include <linux/timecounter.h>
16 #include <sound/core.h>
17 #include <sound/pcm.h>
18 #include <sound/memalloc.h>
19 #include <sound/hda_verbs.h>
20 #include <drm/i915_component.h>
21 
22 /* codec node id */
23 typedef u16 hda_nid_t;
24 
25 struct hdac_bus;
26 struct hdac_stream;
27 struct hdac_device;
28 struct hdac_driver;
29 struct hdac_widget_tree;
30 struct hda_device_id;
31 
32 /*
33  * exported bus type
34  */
35 extern struct bus_type snd_hda_bus_type;
36 
37 /*
38  * generic arrays
39  */
40 struct snd_array {
41 	unsigned int used;
42 	unsigned int alloced;
43 	unsigned int elem_size;
44 	unsigned int alloc_align;
45 	void *list;
46 };
47 
48 /*
49  * HD-audio codec base device
50  */
51 struct hdac_device {
52 	struct device dev;
53 	int type;
54 	struct hdac_bus *bus;
55 	unsigned int addr;		/* codec address */
56 	struct list_head list;		/* list point for bus codec_list */
57 
58 	hda_nid_t afg;			/* AFG node id */
59 	hda_nid_t mfg;			/* MFG node id */
60 
61 	/* ids */
62 	unsigned int vendor_id;
63 	unsigned int subsystem_id;
64 	unsigned int revision_id;
65 	unsigned int afg_function_id;
66 	unsigned int mfg_function_id;
67 	unsigned int afg_unsol:1;
68 	unsigned int mfg_unsol:1;
69 
70 	unsigned int power_caps;	/* FG power caps */
71 
72 	const char *vendor_name;	/* codec vendor name */
73 	const char *chip_name;		/* codec chip name */
74 
75 	/* verb exec op override */
76 	int (*exec_verb)(struct hdac_device *dev, unsigned int cmd,
77 			 unsigned int flags, unsigned int *res);
78 
79 	/* widgets */
80 	unsigned int num_nodes;
81 	hda_nid_t start_nid, end_nid;
82 
83 	/* misc flags */
84 	atomic_t in_pm;		/* suspend/resume being performed */
85 
86 	/* sysfs */
87 	struct mutex widget_lock;
88 	struct hdac_widget_tree *widgets;
89 
90 	/* regmap */
91 	struct regmap *regmap;
92 	struct mutex regmap_lock;
93 	struct snd_array vendor_verbs;
94 	bool lazy_cache:1;	/* don't wake up for writes */
95 	bool caps_overwriting:1; /* caps overwrite being in process */
96 	bool cache_coef:1;	/* cache COEF read/write too */
97 	unsigned int registered:1; /* codec was registered */
98 };
99 
100 /* device/driver type used for matching */
101 enum {
102 	HDA_DEV_CORE,
103 	HDA_DEV_LEGACY,
104 	HDA_DEV_ASOC,
105 };
106 
107 enum {
108 	SND_SKL_PCI_BIND_AUTO,	/* automatic selection based on pci class */
109 	SND_SKL_PCI_BIND_LEGACY,/* bind only with legacy driver */
110 	SND_SKL_PCI_BIND_ASOC	/* bind only with ASoC driver */
111 };
112 
113 /* direction */
114 enum {
115 	HDA_INPUT, HDA_OUTPUT
116 };
117 
118 #define dev_to_hdac_dev(_dev)	container_of(_dev, struct hdac_device, dev)
119 
120 int snd_hdac_device_init(struct hdac_device *dev, struct hdac_bus *bus,
121 			 const char *name, unsigned int addr);
122 void snd_hdac_device_exit(struct hdac_device *dev);
123 int snd_hdac_device_register(struct hdac_device *codec);
124 void snd_hdac_device_unregister(struct hdac_device *codec);
125 int snd_hdac_device_set_chip_name(struct hdac_device *codec, const char *name);
126 int snd_hdac_codec_modalias(const struct hdac_device *hdac, char *buf, size_t size);
127 
128 int snd_hdac_refresh_widgets(struct hdac_device *codec);
129 
130 int snd_hdac_read(struct hdac_device *codec, hda_nid_t nid,
131 		  unsigned int verb, unsigned int parm, unsigned int *res);
132 int _snd_hdac_read_parm(struct hdac_device *codec, hda_nid_t nid, int parm,
133 			unsigned int *res);
134 int snd_hdac_read_parm_uncached(struct hdac_device *codec, hda_nid_t nid,
135 				int parm);
136 int snd_hdac_override_parm(struct hdac_device *codec, hda_nid_t nid,
137 			   unsigned int parm, unsigned int val);
138 int snd_hdac_get_connections(struct hdac_device *codec, hda_nid_t nid,
139 			     hda_nid_t *conn_list, int max_conns);
140 int snd_hdac_get_sub_nodes(struct hdac_device *codec, hda_nid_t nid,
141 			   hda_nid_t *start_id);
142 unsigned int snd_hdac_calc_stream_format(unsigned int rate,
143 					 unsigned int channels,
144 					 snd_pcm_format_t format,
145 					 unsigned int maxbps,
146 					 unsigned short spdif_ctls);
147 int snd_hdac_query_supported_pcm(struct hdac_device *codec, hda_nid_t nid,
148 				u32 *ratesp, u64 *formatsp, unsigned int *bpsp);
149 bool snd_hdac_is_supported_format(struct hdac_device *codec, hda_nid_t nid,
150 				  unsigned int format);
151 
152 int snd_hdac_codec_read(struct hdac_device *hdac, hda_nid_t nid,
153 			int flags, unsigned int verb, unsigned int parm);
154 int snd_hdac_codec_write(struct hdac_device *hdac, hda_nid_t nid,
155 			int flags, unsigned int verb, unsigned int parm);
156 bool snd_hdac_check_power_state(struct hdac_device *hdac,
157 		hda_nid_t nid, unsigned int target_state);
158 unsigned int snd_hdac_sync_power_state(struct hdac_device *hdac,
159 		      hda_nid_t nid, unsigned int target_state);
160 /**
161  * snd_hdac_read_parm - read a codec parameter
162  * @codec: the codec object
163  * @nid: NID to read a parameter
164  * @parm: parameter to read
165  *
166  * Returns -1 for error.  If you need to distinguish the error more
167  * strictly, use _snd_hdac_read_parm() directly.
168  */
169 static inline int snd_hdac_read_parm(struct hdac_device *codec, hda_nid_t nid,
170 				     int parm)
171 {
172 	unsigned int val;
173 
174 	return _snd_hdac_read_parm(codec, nid, parm, &val) < 0 ? -1 : val;
175 }
176 
177 #ifdef CONFIG_PM
178 int snd_hdac_power_up(struct hdac_device *codec);
179 int snd_hdac_power_down(struct hdac_device *codec);
180 int snd_hdac_power_up_pm(struct hdac_device *codec);
181 int snd_hdac_power_down_pm(struct hdac_device *codec);
182 int snd_hdac_keep_power_up(struct hdac_device *codec);
183 
184 /* call this at entering into suspend/resume callbacks in codec driver */
185 static inline void snd_hdac_enter_pm(struct hdac_device *codec)
186 {
187 	atomic_inc(&codec->in_pm);
188 }
189 
190 /* call this at leaving from suspend/resume callbacks in codec driver */
191 static inline void snd_hdac_leave_pm(struct hdac_device *codec)
192 {
193 	atomic_dec(&codec->in_pm);
194 }
195 
196 static inline bool snd_hdac_is_in_pm(struct hdac_device *codec)
197 {
198 	return atomic_read(&codec->in_pm);
199 }
200 
201 static inline bool snd_hdac_is_power_on(struct hdac_device *codec)
202 {
203 	return !pm_runtime_suspended(&codec->dev);
204 }
205 #else
206 static inline int snd_hdac_power_up(struct hdac_device *codec) { return 0; }
207 static inline int snd_hdac_power_down(struct hdac_device *codec) { return 0; }
208 static inline int snd_hdac_power_up_pm(struct hdac_device *codec) { return 0; }
209 static inline int snd_hdac_power_down_pm(struct hdac_device *codec) { return 0; }
210 static inline int snd_hdac_keep_power_up(struct hdac_device *codec) { return 0; }
211 static inline void snd_hdac_enter_pm(struct hdac_device *codec) {}
212 static inline void snd_hdac_leave_pm(struct hdac_device *codec) {}
213 static inline bool snd_hdac_is_in_pm(struct hdac_device *codec) { return false; }
214 static inline bool snd_hdac_is_power_on(struct hdac_device *codec) { return true; }
215 #endif
216 
217 /*
218  * HD-audio codec base driver
219  */
220 struct hdac_driver {
221 	struct device_driver driver;
222 	int type;
223 	const struct hda_device_id *id_table;
224 	int (*match)(struct hdac_device *dev, struct hdac_driver *drv);
225 	void (*unsol_event)(struct hdac_device *dev, unsigned int event);
226 
227 	/* fields used by ext bus APIs */
228 	int (*probe)(struct hdac_device *dev);
229 	int (*remove)(struct hdac_device *dev);
230 	void (*shutdown)(struct hdac_device *dev);
231 };
232 
233 #define drv_to_hdac_driver(_drv) container_of(_drv, struct hdac_driver, driver)
234 
235 const struct hda_device_id *
236 hdac_get_device_id(struct hdac_device *hdev, struct hdac_driver *drv);
237 
238 /*
239  * Bus verb operators
240  */
241 struct hdac_bus_ops {
242 	/* send a single command */
243 	int (*command)(struct hdac_bus *bus, unsigned int cmd);
244 	/* get a response from the last command */
245 	int (*get_response)(struct hdac_bus *bus, unsigned int addr,
246 			    unsigned int *res);
247 	/* notify of codec link power-up/down */
248 	void (*link_power)(struct hdac_device *hdev, bool enable);
249 };
250 
251 /*
252  * ops used for ASoC HDA codec drivers
253  */
254 struct hdac_ext_bus_ops {
255 	int (*hdev_attach)(struct hdac_device *hdev);
256 	int (*hdev_detach)(struct hdac_device *hdev);
257 };
258 
259 #define HDA_UNSOL_QUEUE_SIZE	64
260 #define HDA_MAX_CODECS		8	/* limit by controller side */
261 
262 /*
263  * CORB/RIRB
264  *
265  * Each CORB entry is 4byte, RIRB is 8byte
266  */
267 struct hdac_rb {
268 	__le32 *buf;		/* virtual address of CORB/RIRB buffer */
269 	dma_addr_t addr;	/* physical address of CORB/RIRB buffer */
270 	unsigned short rp, wp;	/* RIRB read/write pointers */
271 	int cmds[HDA_MAX_CODECS];	/* number of pending requests */
272 	u32 res[HDA_MAX_CODECS];	/* last read value */
273 };
274 
275 /*
276  * HD-audio bus base driver
277  *
278  * @ppcap: pp capabilities pointer
279  * @spbcap: SPIB capabilities pointer
280  * @mlcap: MultiLink capabilities pointer
281  * @gtscap: gts capabilities pointer
282  * @drsmcap: dma resume capabilities pointer
283  * @num_streams: streams supported
284  * @idx: HDA link index
285  * @hlink_list: link list of HDA links
286  * @lock: lock for link and display power mgmt
287  * @cmd_dma_state: state of cmd DMAs: CORB and RIRB
288  */
289 struct hdac_bus {
290 	struct device *dev;
291 	const struct hdac_bus_ops *ops;
292 	const struct hdac_ext_bus_ops *ext_ops;
293 
294 	/* h/w resources */
295 	unsigned long addr;
296 	void __iomem *remap_addr;
297 	int irq;
298 
299 	void __iomem *ppcap;
300 	void __iomem *spbcap;
301 	void __iomem *mlcap;
302 	void __iomem *gtscap;
303 	void __iomem *drsmcap;
304 
305 	/* codec linked list */
306 	struct list_head codec_list;
307 	unsigned int num_codecs;
308 
309 	/* link caddr -> codec */
310 	struct hdac_device *caddr_tbl[HDA_MAX_CODEC_ADDRESS + 1];
311 
312 	/* unsolicited event queue */
313 	u32 unsol_queue[HDA_UNSOL_QUEUE_SIZE * 2]; /* ring buffer */
314 	unsigned int unsol_rp, unsol_wp;
315 	struct work_struct unsol_work;
316 
317 	/* bit flags of detected codecs */
318 	unsigned long codec_mask;
319 
320 	/* bit flags of powered codecs */
321 	unsigned long codec_powered;
322 
323 	/* CORB/RIRB */
324 	struct hdac_rb corb;
325 	struct hdac_rb rirb;
326 	unsigned int last_cmd[HDA_MAX_CODECS];	/* last sent command */
327 	wait_queue_head_t rirb_wq;
328 
329 	/* CORB/RIRB and position buffers */
330 	struct snd_dma_buffer rb;
331 	struct snd_dma_buffer posbuf;
332 	int dma_type;			/* SNDRV_DMA_TYPE_XXX for CORB/RIRB */
333 
334 	/* hdac_stream linked list */
335 	struct list_head stream_list;
336 
337 	/* operation state */
338 	bool chip_init:1;		/* h/w initialized */
339 
340 	/* behavior flags */
341 	bool aligned_mmio:1;		/* aligned MMIO access */
342 	bool sync_write:1;		/* sync after verb write */
343 	bool use_posbuf:1;		/* use position buffer */
344 	bool snoop:1;			/* enable snooping */
345 	bool align_bdle_4k:1;		/* BDLE align 4K boundary */
346 	bool reverse_assign:1;		/* assign devices in reverse order */
347 	bool corbrp_self_clear:1;	/* CORBRP clears itself after reset */
348 	bool polling_mode:1;
349 	bool needs_damn_long_delay:1;
350 	bool not_use_interrupts:1;	/* prohibiting the RIRB IRQ */
351 	bool access_sdnctl_in_dword:1;	/* accessing the sdnctl register by dword */
352 
353 	int poll_count;
354 
355 	int bdl_pos_adj;		/* BDL position adjustment */
356 
357 	/* delay time in us for dma stop */
358 	unsigned int dma_stop_delay;
359 
360 	/* locks */
361 	spinlock_t reg_lock;
362 	struct mutex cmd_mutex;
363 	struct mutex lock;
364 
365 	/* DRM component interface */
366 	struct drm_audio_component *audio_component;
367 	long display_power_status;
368 	unsigned long display_power_active;
369 
370 	/* parameters required for enhanced capabilities */
371 	int num_streams;
372 	int idx;
373 
374 	/* link management */
375 	struct list_head hlink_list;
376 	bool cmd_dma_state;
377 
378 	/* factor used to derive STRIPE control value */
379 	unsigned int sdo_limit;
380 };
381 
382 int snd_hdac_bus_init(struct hdac_bus *bus, struct device *dev,
383 		      const struct hdac_bus_ops *ops);
384 void snd_hdac_bus_exit(struct hdac_bus *bus);
385 int snd_hdac_bus_exec_verb_unlocked(struct hdac_bus *bus, unsigned int addr,
386 				    unsigned int cmd, unsigned int *res);
387 
388 void snd_hdac_codec_link_up(struct hdac_device *codec);
389 void snd_hdac_codec_link_down(struct hdac_device *codec);
390 
391 int snd_hdac_bus_send_cmd(struct hdac_bus *bus, unsigned int val);
392 int snd_hdac_bus_get_response(struct hdac_bus *bus, unsigned int addr,
393 			      unsigned int *res);
394 int snd_hdac_bus_parse_capabilities(struct hdac_bus *bus);
395 
396 bool snd_hdac_bus_init_chip(struct hdac_bus *bus, bool full_reset);
397 void snd_hdac_bus_stop_chip(struct hdac_bus *bus);
398 void snd_hdac_bus_init_cmd_io(struct hdac_bus *bus);
399 void snd_hdac_bus_stop_cmd_io(struct hdac_bus *bus);
400 void snd_hdac_bus_enter_link_reset(struct hdac_bus *bus);
401 void snd_hdac_bus_exit_link_reset(struct hdac_bus *bus);
402 int snd_hdac_bus_reset_link(struct hdac_bus *bus, bool full_reset);
403 void snd_hdac_bus_link_power(struct hdac_device *hdev, bool enable);
404 
405 void snd_hdac_bus_update_rirb(struct hdac_bus *bus);
406 int snd_hdac_bus_handle_stream_irq(struct hdac_bus *bus, unsigned int status,
407 				    void (*ack)(struct hdac_bus *,
408 						struct hdac_stream *));
409 
410 int snd_hdac_bus_alloc_stream_pages(struct hdac_bus *bus);
411 void snd_hdac_bus_free_stream_pages(struct hdac_bus *bus);
412 
413 #ifdef CONFIG_SND_HDA_ALIGNED_MMIO
414 unsigned int snd_hdac_aligned_read(void __iomem *addr, unsigned int mask);
415 void snd_hdac_aligned_write(unsigned int val, void __iomem *addr,
416 			    unsigned int mask);
417 #define snd_hdac_aligned_mmio(bus)	(bus)->aligned_mmio
418 #else
419 #define snd_hdac_aligned_mmio(bus)	false
420 #define snd_hdac_aligned_read(addr, mask)	0
421 #define snd_hdac_aligned_write(val, addr, mask) do {} while (0)
422 #endif
423 
424 static inline void snd_hdac_reg_writeb(struct hdac_bus *bus, void __iomem *addr,
425 				       u8 val)
426 {
427 	if (snd_hdac_aligned_mmio(bus))
428 		snd_hdac_aligned_write(val, addr, 0xff);
429 	else
430 		writeb(val, addr);
431 }
432 
433 static inline void snd_hdac_reg_writew(struct hdac_bus *bus, void __iomem *addr,
434 				       u16 val)
435 {
436 	if (snd_hdac_aligned_mmio(bus))
437 		snd_hdac_aligned_write(val, addr, 0xffff);
438 	else
439 		writew(val, addr);
440 }
441 
442 static inline u8 snd_hdac_reg_readb(struct hdac_bus *bus, void __iomem *addr)
443 {
444 	return snd_hdac_aligned_mmio(bus) ?
445 		snd_hdac_aligned_read(addr, 0xff) : readb(addr);
446 }
447 
448 static inline u16 snd_hdac_reg_readw(struct hdac_bus *bus, void __iomem *addr)
449 {
450 	return snd_hdac_aligned_mmio(bus) ?
451 		snd_hdac_aligned_read(addr, 0xffff) : readw(addr);
452 }
453 
454 #define snd_hdac_reg_writel(bus, addr, val)	writel(val, addr)
455 #define snd_hdac_reg_readl(bus, addr)	readl(addr)
456 #define snd_hdac_reg_writeq(bus, addr, val)	writeq(val, addr)
457 #define snd_hdac_reg_readq(bus, addr)		readq(addr)
458 
459 /*
460  * macros for easy use
461  */
462 #define _snd_hdac_chip_writeb(chip, reg, value) \
463 	snd_hdac_reg_writeb(chip, (chip)->remap_addr + (reg), value)
464 #define _snd_hdac_chip_readb(chip, reg) \
465 	snd_hdac_reg_readb(chip, (chip)->remap_addr + (reg))
466 #define _snd_hdac_chip_writew(chip, reg, value) \
467 	snd_hdac_reg_writew(chip, (chip)->remap_addr + (reg), value)
468 #define _snd_hdac_chip_readw(chip, reg) \
469 	snd_hdac_reg_readw(chip, (chip)->remap_addr + (reg))
470 #define _snd_hdac_chip_writel(chip, reg, value) \
471 	snd_hdac_reg_writel(chip, (chip)->remap_addr + (reg), value)
472 #define _snd_hdac_chip_readl(chip, reg) \
473 	snd_hdac_reg_readl(chip, (chip)->remap_addr + (reg))
474 
475 /* read/write a register, pass without AZX_REG_ prefix */
476 #define snd_hdac_chip_writel(chip, reg, value) \
477 	_snd_hdac_chip_writel(chip, AZX_REG_ ## reg, value)
478 #define snd_hdac_chip_writew(chip, reg, value) \
479 	_snd_hdac_chip_writew(chip, AZX_REG_ ## reg, value)
480 #define snd_hdac_chip_writeb(chip, reg, value) \
481 	_snd_hdac_chip_writeb(chip, AZX_REG_ ## reg, value)
482 #define snd_hdac_chip_readl(chip, reg) \
483 	_snd_hdac_chip_readl(chip, AZX_REG_ ## reg)
484 #define snd_hdac_chip_readw(chip, reg) \
485 	_snd_hdac_chip_readw(chip, AZX_REG_ ## reg)
486 #define snd_hdac_chip_readb(chip, reg) \
487 	_snd_hdac_chip_readb(chip, AZX_REG_ ## reg)
488 
489 /* update a register, pass without AZX_REG_ prefix */
490 #define snd_hdac_chip_updatel(chip, reg, mask, val) \
491 	snd_hdac_chip_writel(chip, reg, \
492 			     (snd_hdac_chip_readl(chip, reg) & ~(mask)) | (val))
493 #define snd_hdac_chip_updatew(chip, reg, mask, val) \
494 	snd_hdac_chip_writew(chip, reg, \
495 			     (snd_hdac_chip_readw(chip, reg) & ~(mask)) | (val))
496 #define snd_hdac_chip_updateb(chip, reg, mask, val) \
497 	snd_hdac_chip_writeb(chip, reg, \
498 			     (snd_hdac_chip_readb(chip, reg) & ~(mask)) | (val))
499 
500 /* update register macro */
501 #define snd_hdac_updatel(addr, reg, mask, val)		\
502 	writel(((readl(addr + reg) & ~(mask)) | (val)), addr + reg)
503 
504 #define snd_hdac_updatew(addr, reg, mask, val)		\
505 	writew(((readw(addr + reg) & ~(mask)) | (val)), addr + reg)
506 
507 /*
508  * HD-audio stream
509  */
510 struct hdac_stream {
511 	struct hdac_bus *bus;
512 	struct snd_dma_buffer bdl; /* BDL buffer */
513 	__le32 *posbuf;		/* position buffer pointer */
514 	int direction;		/* playback / capture (SNDRV_PCM_STREAM_*) */
515 
516 	unsigned int bufsize;	/* size of the play buffer in bytes */
517 	unsigned int period_bytes; /* size of the period in bytes */
518 	unsigned int frags;	/* number for period in the play buffer */
519 	unsigned int fifo_size;	/* FIFO size */
520 
521 	void __iomem *sd_addr;	/* stream descriptor pointer */
522 
523 	void __iomem *spib_addr; /* software position in buffers stream pointer */
524 	void __iomem *fifo_addr; /* software position Max fifos stream pointer */
525 
526 	void __iomem *dpibr_addr; /* DMA position in buffer resume pointer */
527 	u32 dpib;		/* DMA position in buffer */
528 	u32 lpib;		/* Linear position in buffer */
529 
530 	u32 sd_int_sta_mask;	/* stream int status mask */
531 
532 	/* pcm support */
533 	struct snd_pcm_substream *substream;	/* assigned substream,
534 						 * set in PCM open
535 						 */
536 	struct snd_compr_stream *cstream;
537 	unsigned int format_val;	/* format value to be set in the
538 					 * controller and the codec
539 					 */
540 	unsigned char stream_tag;	/* assigned stream */
541 	unsigned char index;		/* stream index */
542 	int assigned_key;		/* last device# key assigned to */
543 
544 	bool opened:1;
545 	bool running:1;
546 	bool prepared:1;
547 	bool no_period_wakeup:1;
548 	bool locked:1;
549 	bool stripe:1;			/* apply stripe control */
550 
551 	u64 curr_pos;
552 	/* timestamp */
553 	unsigned long start_wallclk;	/* start + minimum wallclk */
554 	unsigned long period_wallclk;	/* wallclk for period */
555 	struct timecounter  tc;
556 	struct cyclecounter cc;
557 	int delay_negative_threshold;
558 
559 	struct list_head list;
560 #ifdef CONFIG_SND_HDA_DSP_LOADER
561 	/* DSP access mutex */
562 	struct mutex dsp_mutex;
563 #endif
564 };
565 
566 void snd_hdac_stream_init(struct hdac_bus *bus, struct hdac_stream *azx_dev,
567 			  int idx, int direction, int tag);
568 struct hdac_stream *snd_hdac_stream_assign(struct hdac_bus *bus,
569 					   struct snd_pcm_substream *substream);
570 void snd_hdac_stream_release_locked(struct hdac_stream *azx_dev);
571 void snd_hdac_stream_release(struct hdac_stream *azx_dev);
572 struct hdac_stream *snd_hdac_get_stream(struct hdac_bus *bus,
573 					int dir, int stream_tag);
574 
575 int snd_hdac_stream_setup(struct hdac_stream *azx_dev);
576 void snd_hdac_stream_cleanup(struct hdac_stream *azx_dev);
577 int snd_hdac_stream_setup_periods(struct hdac_stream *azx_dev);
578 int snd_hdac_stream_set_params(struct hdac_stream *azx_dev,
579 				unsigned int format_val);
580 void snd_hdac_stream_start(struct hdac_stream *azx_dev);
581 void snd_hdac_stream_stop(struct hdac_stream *azx_dev);
582 void snd_hdac_stop_streams(struct hdac_bus *bus);
583 void snd_hdac_stop_streams_and_chip(struct hdac_bus *bus);
584 void snd_hdac_stream_reset(struct hdac_stream *azx_dev);
585 void snd_hdac_stream_sync_trigger(struct hdac_stream *azx_dev, bool set,
586 				  unsigned int streams, unsigned int reg);
587 void snd_hdac_stream_sync(struct hdac_stream *azx_dev, bool start,
588 			  unsigned int streams);
589 void snd_hdac_stream_timecounter_init(struct hdac_stream *azx_dev,
590 				      unsigned int streams);
591 int snd_hdac_get_stream_stripe_ctl(struct hdac_bus *bus,
592 				struct snd_pcm_substream *substream);
593 
594 void snd_hdac_stream_spbcap_enable(struct hdac_bus *chip,
595 				   bool enable, int index);
596 int snd_hdac_stream_set_spib(struct hdac_bus *bus,
597 			     struct hdac_stream *azx_dev, u32 value);
598 int snd_hdac_stream_get_spbmaxfifo(struct hdac_bus *bus,
599 				   struct hdac_stream *azx_dev);
600 void snd_hdac_stream_drsm_enable(struct hdac_bus *bus,
601 				 bool enable, int index);
602 int snd_hdac_stream_wait_drsm(struct hdac_stream *azx_dev);
603 int snd_hdac_stream_set_dpibr(struct hdac_bus *bus,
604 			      struct hdac_stream *azx_dev, u32 value);
605 int snd_hdac_stream_set_lpib(struct hdac_stream *azx_dev, u32 value);
606 
607 /*
608  * macros for easy use
609  */
610 /* read/write a register, pass without AZX_REG_ prefix */
611 #define snd_hdac_stream_writel(dev, reg, value) \
612 	snd_hdac_reg_writel((dev)->bus, (dev)->sd_addr + AZX_REG_ ## reg, value)
613 #define snd_hdac_stream_writew(dev, reg, value) \
614 	snd_hdac_reg_writew((dev)->bus, (dev)->sd_addr + AZX_REG_ ## reg, value)
615 #define snd_hdac_stream_writeb(dev, reg, value) \
616 	snd_hdac_reg_writeb((dev)->bus, (dev)->sd_addr + AZX_REG_ ## reg, value)
617 #define snd_hdac_stream_readl(dev, reg) \
618 	snd_hdac_reg_readl((dev)->bus, (dev)->sd_addr + AZX_REG_ ## reg)
619 #define snd_hdac_stream_readw(dev, reg) \
620 	snd_hdac_reg_readw((dev)->bus, (dev)->sd_addr + AZX_REG_ ## reg)
621 #define snd_hdac_stream_readb(dev, reg) \
622 	snd_hdac_reg_readb((dev)->bus, (dev)->sd_addr + AZX_REG_ ## reg)
623 #define snd_hdac_stream_readb_poll(dev, reg, val, cond, delay_us, timeout_us) \
624 	read_poll_timeout_atomic(snd_hdac_reg_readb, val, cond, delay_us, timeout_us, \
625 				 false, (dev)->bus, (dev)->sd_addr + AZX_REG_ ## reg)
626 #define snd_hdac_stream_readl_poll(dev, reg, val, cond, delay_us, timeout_us) \
627 	read_poll_timeout_atomic(snd_hdac_reg_readl, val, cond, delay_us, timeout_us, \
628 				 false, (dev)->bus, (dev)->sd_addr + AZX_REG_ ## reg)
629 
630 /* update a register, pass without AZX_REG_ prefix */
631 #define snd_hdac_stream_updatel(dev, reg, mask, val) \
632 	snd_hdac_stream_writel(dev, reg, \
633 			       (snd_hdac_stream_readl(dev, reg) & \
634 				~(mask)) | (val))
635 #define snd_hdac_stream_updatew(dev, reg, mask, val) \
636 	snd_hdac_stream_writew(dev, reg, \
637 			       (snd_hdac_stream_readw(dev, reg) & \
638 				~(mask)) | (val))
639 #define snd_hdac_stream_updateb(dev, reg, mask, val) \
640 	snd_hdac_stream_writeb(dev, reg, \
641 			       (snd_hdac_stream_readb(dev, reg) & \
642 				~(mask)) | (val))
643 
644 #ifdef CONFIG_SND_HDA_DSP_LOADER
645 /* DSP lock helpers */
646 #define snd_hdac_dsp_lock_init(dev)	mutex_init(&(dev)->dsp_mutex)
647 #define snd_hdac_dsp_lock(dev)		mutex_lock(&(dev)->dsp_mutex)
648 #define snd_hdac_dsp_unlock(dev)	mutex_unlock(&(dev)->dsp_mutex)
649 #define snd_hdac_stream_is_locked(dev)	((dev)->locked)
650 /* DSP loader helpers */
651 int snd_hdac_dsp_prepare(struct hdac_stream *azx_dev, unsigned int format,
652 			 unsigned int byte_size, struct snd_dma_buffer *bufp);
653 void snd_hdac_dsp_trigger(struct hdac_stream *azx_dev, bool start);
654 void snd_hdac_dsp_cleanup(struct hdac_stream *azx_dev,
655 			  struct snd_dma_buffer *dmab);
656 #else /* CONFIG_SND_HDA_DSP_LOADER */
657 #define snd_hdac_dsp_lock_init(dev)	do {} while (0)
658 #define snd_hdac_dsp_lock(dev)		do {} while (0)
659 #define snd_hdac_dsp_unlock(dev)	do {} while (0)
660 #define snd_hdac_stream_is_locked(dev)	0
661 
662 static inline int
663 snd_hdac_dsp_prepare(struct hdac_stream *azx_dev, unsigned int format,
664 		     unsigned int byte_size, struct snd_dma_buffer *bufp)
665 {
666 	return 0;
667 }
668 
669 static inline void snd_hdac_dsp_trigger(struct hdac_stream *azx_dev, bool start)
670 {
671 }
672 
673 static inline void snd_hdac_dsp_cleanup(struct hdac_stream *azx_dev,
674 					struct snd_dma_buffer *dmab)
675 {
676 }
677 #endif /* CONFIG_SND_HDA_DSP_LOADER */
678 
679 
680 /*
681  * generic array helpers
682  */
683 void *snd_array_new(struct snd_array *array);
684 void snd_array_free(struct snd_array *array);
685 static inline void snd_array_init(struct snd_array *array, unsigned int size,
686 				  unsigned int align)
687 {
688 	array->elem_size = size;
689 	array->alloc_align = align;
690 }
691 
692 static inline void *snd_array_elem(struct snd_array *array, unsigned int idx)
693 {
694 	return array->list + idx * array->elem_size;
695 }
696 
697 static inline unsigned int snd_array_index(struct snd_array *array, void *ptr)
698 {
699 	return (unsigned long)(ptr - array->list) / array->elem_size;
700 }
701 
702 /* a helper macro to iterate for each snd_array element */
703 #define snd_array_for_each(array, idx, ptr) \
704 	for ((idx) = 0, (ptr) = (array)->list; (idx) < (array)->used; \
705 	     (ptr) = snd_array_elem(array, ++(idx)))
706 
707 #endif /* __SOUND_HDAUDIO_H */
708