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