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