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