blob: cd1773d0e08f07247a42788a035a0355da113493 [file] [log] [blame]
Greg Kroah-Hartmanb2441312017-11-01 15:07:57 +01001/* SPDX-License-Identifier: GPL-2.0 */
Takashi Iwaie3d280f2015-02-17 21:46:37 +01002/*
3 * HD-audio core stuff
4 */
5
6#ifndef __SOUND_HDAUDIO_H
7#define __SOUND_HDAUDIO_H
8
9#include <linux/device.h>
Takashi Iwai14752412015-04-14 12:15:47 +020010#include <linux/interrupt.h>
Takashi Iwaifeb20fa2018-06-27 09:03:51 +020011#include <linux/pm_runtime.h>
Takashi Iwai14752412015-04-14 12:15:47 +020012#include <linux/timecounter.h>
13#include <sound/core.h>
Takashi Iwaia6ea5fe2018-07-25 23:19:36 +020014#include <sound/pcm.h>
Takashi Iwai14752412015-04-14 12:15:47 +020015#include <sound/memalloc.h>
Takashi Iwaid068ebc2015-03-02 23:22:59 +010016#include <sound/hda_verbs.h>
Mengdong Lin98d8fc62015-05-19 22:29:30 +080017#include <drm/i915_component.h>
Takashi Iwaid068ebc2015-03-02 23:22:59 +010018
Takashi Iwai7639a062015-03-03 10:07:24 +010019/* codec node id */
20typedef u16 hda_nid_t;
21
Takashi Iwaid068ebc2015-03-02 23:22:59 +010022struct hdac_bus;
Takashi Iwai14752412015-04-14 12:15:47 +020023struct hdac_stream;
Takashi Iwaid068ebc2015-03-02 23:22:59 +010024struct hdac_device;
25struct hdac_driver;
Takashi Iwai3256be62015-02-24 14:59:42 +010026struct hdac_widget_tree;
Subhransu S. Prustyda23ac12015-09-29 13:56:10 +053027struct hda_device_id;
Takashi Iwaie3d280f2015-02-17 21:46:37 +010028
29/*
30 * exported bus type
31 */
32extern struct bus_type snd_hda_bus_type;
33
34/*
Takashi Iwai71fc4c72015-03-03 17:33:10 +010035 * generic arrays
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/*
Takashi Iwaie3d280f2015-02-17 21:46:37 +010046 * HD-audio codec base device
47 */
48struct hdac_device {
49 struct device dev;
50 int type;
Takashi Iwaid068ebc2015-03-02 23:22:59 +010051 struct hdac_bus *bus;
52 unsigned int addr; /* codec address */
53 struct list_head list; /* list point for bus codec_list */
Takashi Iwai7639a062015-03-03 10:07:24 +010054
55 hda_nid_t afg; /* AFG node id */
56 hda_nid_t mfg; /* MFG node id */
57
58 /* ids */
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; /* FG power caps */
68
69 const char *vendor_name; /* codec vendor name */
70 const char *chip_name; /* codec chip name */
71
Takashi Iwai05852442015-03-03 15:40:08 +010072 /* verb exec op override */
73 int (*exec_verb)(struct hdac_device *dev, unsigned int cmd,
74 unsigned int flags, unsigned int *res);
75
Takashi Iwai7639a062015-03-03 10:07:24 +010076 /* widgets */
77 unsigned int num_nodes;
78 hda_nid_t start_nid, end_nid;
79
80 /* misc flags */
81 atomic_t in_pm; /* suspend/resume being performed */
Mengdong Lina5e7e072015-04-29 17:43:20 +080082 bool link_power_control:1;
Takashi Iwai3256be62015-02-24 14:59:42 +010083
84 /* sysfs */
85 struct hdac_widget_tree *widgets;
Takashi Iwai4d75faa02015-02-25 14:42:38 +010086
87 /* regmap */
88 struct regmap *regmap;
Takashi Iwai5e56bce2015-02-26 12:29:03 +010089 struct snd_array vendor_verbs;
Takashi Iwai4d75faa02015-02-25 14:42:38 +010090 bool lazy_cache:1; /* don't wake up for writes */
Takashi Iwaifaa75f82015-02-26 08:54:56 +010091 bool caps_overwriting:1; /* caps overwrite being in process */
Takashi Iwai40ba66a2015-03-13 15:56:25 +010092 bool cache_coef:1; /* cache COEF read/write too */
Takashi Iwaie3d280f2015-02-17 21:46:37 +010093};
94
95/* device/driver type used for matching */
96enum {
97 HDA_DEV_CORE,
98 HDA_DEV_LEGACY,
Ramesh Babuc1cc18b2015-04-17 17:58:57 +053099 HDA_DEV_ASOC,
Takashi Iwaie3d280f2015-02-17 21:46:37 +0100100};
101
Takashi Iwai7639a062015-03-03 10:07:24 +0100102/* direction */
103enum {
104 HDA_INPUT, HDA_OUTPUT
105};
106
Takashi Iwaie3d280f2015-02-17 21:46:37 +0100107#define dev_to_hdac_dev(_dev) container_of(_dev, struct hdac_device, dev)
108
Takashi Iwai7639a062015-03-03 10:07:24 +0100109int 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);
Takashi Iwai3256be62015-02-24 14:59:42 +0100112int snd_hdac_device_register(struct hdac_device *codec);
113void snd_hdac_device_unregister(struct hdac_device *codec);
Takashi Iwaided255b2015-10-01 17:59:43 +0200114int snd_hdac_device_set_chip_name(struct hdac_device *codec, const char *name);
Takashi Iwai4f9e0c32015-10-16 11:35:49 +0200115int snd_hdac_codec_modalias(struct hdac_device *hdac, char *buf, size_t size);
Takashi Iwai7639a062015-03-03 10:07:24 +0100116
Takashi Iwai9780ded2017-10-18 15:51:59 +0200117int snd_hdac_refresh_widgets(struct hdac_device *codec, bool sysfs);
Takashi Iwai7639a062015-03-03 10:07:24 +0100118
119unsigned int snd_hdac_make_cmd(struct hdac_device *codec, hda_nid_t nid,
120 unsigned int verb, unsigned int parm);
Takashi Iwai05852442015-03-03 15:40:08 +0100121int snd_hdac_exec_verb(struct hdac_device *codec, unsigned int cmd,
122 unsigned int flags, unsigned int *res);
Takashi Iwai7639a062015-03-03 10:07:24 +0100123int snd_hdac_read(struct hdac_device *codec, hda_nid_t nid,
124 unsigned int verb, unsigned int parm, unsigned int *res);
Takashi Iwai01ed3c02015-02-26 13:57:47 +0100125int _snd_hdac_read_parm(struct hdac_device *codec, hda_nid_t nid, int parm,
126 unsigned int *res);
Takashi Iwai9ba17b42015-03-03 23:29:47 +0100127int snd_hdac_read_parm_uncached(struct hdac_device *codec, hda_nid_t nid,
128 int parm);
Takashi Iwaifaa75f82015-02-26 08:54:56 +0100129int snd_hdac_override_parm(struct hdac_device *codec, hda_nid_t nid,
130 unsigned int parm, unsigned int val);
Takashi Iwai7639a062015-03-03 10:07:24 +0100131int 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);
Takashi Iwaib7d023e2015-04-16 08:19:06 +0200135unsigned int snd_hdac_calc_stream_format(unsigned int rate,
136 unsigned int channels,
Takashi Iwaia6ea5fe2018-07-25 23:19:36 +0200137 snd_pcm_format_t format,
Takashi Iwaib7d023e2015-04-16 08:19:06 +0200138 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);
Takashi Iwai7639a062015-03-03 10:07:24 +0100144
Subhransu S. Prusty1b5e6162015-10-08 09:48:05 +0100145int 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);
Abhijeet Kumar09787492018-01-23 23:00:51 +0530151unsigned int snd_hdac_sync_power_state(struct hdac_device *hdac,
152 hda_nid_t nid, unsigned int target_state);
Takashi Iwai01ed3c02015-02-26 13:57:47 +0100153/**
154 * snd_hdac_read_parm - read a codec parameter
155 * @codec: the codec object
156 * @nid: NID to read a parameter
157 * @parm: parameter to read
158 *
159 * Returns -1 for error. If you need to distinguish the error more
160 * strictly, use _snd_hdac_read_parm() directly.
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
Takashi Iwai7639a062015-03-03 10:07:24 +0100170#ifdef CONFIG_PM
Takashi Iwaifbce23a2015-07-17 16:27:33 +0200171int 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);
Takashi Iwaifc4f0002016-03-04 11:34:18 +0100175int snd_hdac_keep_power_up(struct hdac_device *codec);
Takashi Iwaifeb20fa2018-06-27 09:03:51 +0200176
177/* call this at entering into suspend/resume callbacks in codec driver */
178static inline void snd_hdac_enter_pm(struct hdac_device *codec)
179{
180 atomic_inc(&codec->in_pm);
181}
182
183/* call this at leaving from suspend/resume callbacks in codec driver */
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}
Takashi Iwai7639a062015-03-03 10:07:24 +0100198#else
Takashi Iwaifbce23a2015-07-17 16:27:33 +0200199static 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; }
Takashi Iwaifc4f0002016-03-04 11:34:18 +0100203static inline int snd_hdac_keep_power_up(struct hdac_device *codec) { return 0; }
Takashi Iwaifeb20fa2018-06-27 09:03:51 +0200204static 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; }
Takashi Iwai7639a062015-03-03 10:07:24 +0100208#endif
209
Takashi Iwaie3d280f2015-02-17 21:46:37 +0100210/*
211 * HD-audio codec base driver
212 */
213struct hdac_driver {
214 struct device_driver driver;
215 int type;
Vinod Koulec71efc2015-06-03 12:24:31 +0530216 const struct hda_device_id *id_table;
Takashi Iwaie3d280f2015-02-17 21:46:37 +0100217 int (*match)(struct hdac_device *dev, struct hdac_driver *drv);
Takashi Iwaid068ebc2015-03-02 23:22:59 +0100218 void (*unsol_event)(struct hdac_device *dev, unsigned int event);
Rakesh Ughrejae1df9312018-06-01 22:53:51 -0500219
220 /* fields used by ext bus APIs */
221 int (*probe)(struct hdac_device *dev);
222 int (*remove)(struct hdac_device *dev);
223 void (*shutdown)(struct hdac_device *dev);
Takashi Iwaie3d280f2015-02-17 21:46:37 +0100224};
225
226#define drv_to_hdac_driver(_drv) container_of(_drv, struct hdac_driver, driver)
227
Vinod Koulec71efc2015-06-03 12:24:31 +0530228const struct hda_device_id *
229hdac_get_device_id(struct hdac_device *hdev, struct hdac_driver *drv);
230
Takashi Iwaid068ebc2015-03-02 23:22:59 +0100231/*
Takashi Iwai14752412015-04-14 12:15:47 +0200232 * Bus verb operators
Takashi Iwaid068ebc2015-03-02 23:22:59 +0100233 */
234struct hdac_bus_ops {
235 /* send a single command */
236 int (*command)(struct hdac_bus *bus, unsigned int cmd);
237 /* get a response from the last command */
238 int (*get_response)(struct hdac_bus *bus, unsigned int addr,
239 unsigned int *res);
Mengdong Lina5e7e072015-04-29 17:43:20 +0800240 /* control the link power */
241 int (*link_power)(struct hdac_bus *bus, bool enable);
Takashi Iwaid068ebc2015-03-02 23:22:59 +0100242};
243
Takashi Iwai14752412015-04-14 12:15:47 +0200244/*
Rakesh Ughrejacb04ba32018-06-01 22:53:58 -0500245 * ops used for ASoC HDA codec drivers
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/*
Takashi Iwai14752412015-04-14 12:15:47 +0200253 * Lowlevel I/O operators
254 */
255struct hdac_io_ops {
256 /* mapped register accesses */
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);
Takashi Iwai8f3f6002015-04-14 12:53:28 +0200263 /* Allocation ops */
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);
Takashi Iwai14752412015-04-14 12:15:47 +0200268};
Takashi Iwaid068ebc2015-03-02 23:22:59 +0100269
Takashi Iwai14752412015-04-14 12:15:47 +0200270#define HDA_UNSOL_QUEUE_SIZE 64
271#define HDA_MAX_CODECS 8 /* limit by controller side */
272
Takashi Iwai14752412015-04-14 12:15:47 +0200273/*
274 * CORB/RIRB
275 *
276 * Each CORB entry is 4byte, RIRB is 8byte
277 */
278struct hdac_rb {
279 __le32 *buf; /* virtual address of CORB/RIRB buffer */
280 dma_addr_t addr; /* physical address of CORB/RIRB buffer */
281 unsigned short rp, wp; /* RIRB read/write pointers */
282 int cmds[HDA_MAX_CODECS]; /* number of pending requests */
283 u32 res[HDA_MAX_CODECS]; /* last read value */
284};
285
286/*
287 * HD-audio bus base driver
Vinod Koul6720b382016-08-04 15:46:00 +0530288 *
289 * @ppcap: pp capabilities pointer
290 * @spbcap: SPIB capabilities pointer
291 * @mlcap: MultiLink capabilities pointer
292 * @gtscap: gts capabilities pointer
293 * @drsmcap: dma resume capabilities pointer
Rakesh Ughreja76f56fa2018-06-01 22:53:50 -0500294 * @num_streams: streams supported
295 * @idx: HDA link index
296 * @hlink_list: link list of HDA links
297 * @lock: lock for link mgmt
298 * @cmd_dma_state: state of cmd DMAs: CORB and RIRB
Takashi Iwai14752412015-04-14 12:15:47 +0200299 */
Takashi Iwaid068ebc2015-03-02 23:22:59 +0100300struct hdac_bus {
301 struct device *dev;
302 const struct hdac_bus_ops *ops;
Takashi Iwai14752412015-04-14 12:15:47 +0200303 const struct hdac_io_ops *io_ops;
Rakesh Ughrejacb04ba32018-06-01 22:53:58 -0500304 const struct hdac_ext_bus_ops *ext_ops;
Takashi Iwai14752412015-04-14 12:15:47 +0200305
306 /* h/w resources */
307 unsigned long addr;
308 void __iomem *remap_addr;
309 int irq;
Takashi Iwaid068ebc2015-03-02 23:22:59 +0100310
Vinod Koul6720b382016-08-04 15:46:00 +0530311 void __iomem *ppcap;
312 void __iomem *spbcap;
313 void __iomem *mlcap;
314 void __iomem *gtscap;
315 void __iomem *drsmcap;
316
Takashi Iwaid068ebc2015-03-02 23:22:59 +0100317 /* codec linked list */
318 struct list_head codec_list;
319 unsigned int num_codecs;
320
321 /* link caddr -> codec */
322 struct hdac_device *caddr_tbl[HDA_MAX_CODEC_ADDRESS + 1];
323
324 /* unsolicited event queue */
325 u32 unsol_queue[HDA_UNSOL_QUEUE_SIZE * 2]; /* ring buffer */
326 unsigned int unsol_rp, unsol_wp;
327 struct work_struct unsol_work;
328
Takashi Iwai14752412015-04-14 12:15:47 +0200329 /* bit flags of detected codecs */
330 unsigned long codec_mask;
331
Takashi Iwaid068ebc2015-03-02 23:22:59 +0100332 /* bit flags of powered codecs */
333 unsigned long codec_powered;
334
Takashi Iwai14752412015-04-14 12:15:47 +0200335 /* CORB/RIRB */
336 struct hdac_rb corb;
337 struct hdac_rb rirb;
338 unsigned int last_cmd[HDA_MAX_CODECS]; /* last sent command */
339
340 /* CORB/RIRB and position buffers */
341 struct snd_dma_buffer rb;
342 struct snd_dma_buffer posbuf;
343
344 /* hdac_stream linked list */
345 struct list_head stream_list;
346
347 /* operation state */
348 bool chip_init:1; /* h/w initialized */
349
350 /* behavior flags */
Takashi Iwaid068ebc2015-03-02 23:22:59 +0100351 bool sync_write:1; /* sync after verb write */
Takashi Iwai14752412015-04-14 12:15:47 +0200352 bool use_posbuf:1; /* use position buffer */
353 bool snoop:1; /* enable snooping */
354 bool align_bdle_4k:1; /* BDLE align 4K boundary */
355 bool reverse_assign:1; /* assign devices in reverse order */
356 bool corbrp_self_clear:1; /* CORBRP clears itself after reset */
357
358 int bdl_pos_adj; /* BDL position adjustment */
Takashi Iwaid068ebc2015-03-02 23:22:59 +0100359
360 /* locks */
Takashi Iwai14752412015-04-14 12:15:47 +0200361 spinlock_t reg_lock;
Takashi Iwaid068ebc2015-03-02 23:22:59 +0100362 struct mutex cmd_mutex;
Mengdong Lin98d8fc62015-05-19 22:29:30 +0800363
Takashi Iwaiae891ab2018-07-11 15:17:22 +0200364 /* DRM component interface */
365 struct drm_audio_component *audio_component;
366 int drm_power_refcount;
Rakesh Ughreja76f56fa2018-06-01 22:53:50 -0500367
368 /* parameters required for enhanced capabilities */
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
Takashi Iwaid068ebc2015-03-02 23:22:59 +0100377};
378
379int snd_hdac_bus_init(struct hdac_bus *bus, struct device *dev,
Takashi Iwai14752412015-04-14 12:15:47 +0200380 const struct hdac_bus_ops *ops,
381 const struct hdac_io_ops *io_ops);
Takashi Iwaid068ebc2015-03-02 23:22:59 +0100382void 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
Takashi Iwai7639a062015-03-03 10:07:24 +0100393static 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
Takashi Iwai14752412015-04-14 12:15:47 +0200403int 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);
Vinod Koul6720b382016-08-04 15:46:00 +0530406int snd_hdac_bus_parse_capabilities(struct hdac_bus *bus);
Mengdong Lina5e7e072015-04-29 17:43:20 +0800407int snd_hdac_link_power(struct hdac_device *codec, bool enable);
Takashi Iwai14752412015-04-14 12:15:47 +0200408
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);
Yu Zhao75383f82018-09-11 15:15:16 -0600415int snd_hdac_bus_reset_link(struct hdac_bus *bus, bool full_reset);
Takashi Iwai14752412015-04-14 12:15:47 +0200416
417void snd_hdac_bus_update_rirb(struct hdac_bus *bus);
Takashi Iwai473f4142016-02-23 15:54:47 +0100418int snd_hdac_bus_handle_stream_irq(struct hdac_bus *bus, unsigned int status,
Takashi Iwai14752412015-04-14 12:15:47 +0200419 void (*ack)(struct hdac_bus *,
420 struct hdac_stream *));
421
Jeeja KP304dad32015-04-12 18:06:13 +0530422int snd_hdac_bus_alloc_stream_pages(struct hdac_bus *bus);
423void snd_hdac_bus_free_stream_pages(struct hdac_bus *bus);
424
Takashi Iwai14752412015-04-14 12:15:47 +0200425/*
426 * macros for easy use
427 */
Takashi Iwai2c1f8132017-03-29 08:27:15 +0200428#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)))
Takashi Iwai14752412015-04-14 12:15:47 +0200440
441/* read/write a register, pass without AZX_REG_ prefix */
442#define snd_hdac_chip_writel(chip, reg, value) \
Takashi Iwai2c1f8132017-03-29 08:27:15 +0200443 _snd_hdac_chip_writel(chip, AZX_REG_ ## reg, value)
Takashi Iwai14752412015-04-14 12:15:47 +0200444#define snd_hdac_chip_writew(chip, reg, value) \
Takashi Iwai2c1f8132017-03-29 08:27:15 +0200445 _snd_hdac_chip_writew(chip, AZX_REG_ ## reg, value)
Takashi Iwai14752412015-04-14 12:15:47 +0200446#define snd_hdac_chip_writeb(chip, reg, value) \
Takashi Iwai2c1f8132017-03-29 08:27:15 +0200447 _snd_hdac_chip_writeb(chip, AZX_REG_ ## reg, value)
Takashi Iwai14752412015-04-14 12:15:47 +0200448#define snd_hdac_chip_readl(chip, reg) \
Takashi Iwai2c1f8132017-03-29 08:27:15 +0200449 _snd_hdac_chip_readl(chip, AZX_REG_ ## reg)
Takashi Iwai14752412015-04-14 12:15:47 +0200450#define snd_hdac_chip_readw(chip, reg) \
Takashi Iwai2c1f8132017-03-29 08:27:15 +0200451 _snd_hdac_chip_readw(chip, AZX_REG_ ## reg)
Takashi Iwai14752412015-04-14 12:15:47 +0200452#define snd_hdac_chip_readb(chip, reg) \
Takashi Iwai2c1f8132017-03-29 08:27:15 +0200453 _snd_hdac_chip_readb(chip, AZX_REG_ ## reg)
Takashi Iwai14752412015-04-14 12:15:47 +0200454
455/* update a register, pass without AZX_REG_ prefix */
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 * HD-audio stream
468 */
469struct hdac_stream {
470 struct hdac_bus *bus;
471 struct snd_dma_buffer bdl; /* BDL buffer */
472 __le32 *posbuf; /* position buffer pointer */
473 int direction; /* playback / capture (SNDRV_PCM_STREAM_*) */
474
475 unsigned int bufsize; /* size of the play buffer in bytes */
476 unsigned int period_bytes; /* size of the period in bytes */
477 unsigned int frags; /* number for period in the play buffer */
478 unsigned int fifo_size; /* FIFO size */
479
480 void __iomem *sd_addr; /* stream descriptor pointer */
481
482 u32 sd_int_sta_mask; /* stream int status mask */
483
484 /* pcm support */
485 struct snd_pcm_substream *substream; /* assigned substream,
486 * set in PCM open
487 */
488 unsigned int format_val; /* format value to be set in the
489 * controller and the codec
490 */
491 unsigned char stream_tag; /* assigned stream */
492 unsigned char index; /* stream index */
493 int assigned_key; /* last device# key assigned to */
494
495 bool opened:1;
496 bool running:1;
Takashi Iwai6d23c8f2015-04-17 13:34:30 +0200497 bool prepared:1;
Takashi Iwai14752412015-04-14 12:15:47 +0200498 bool no_period_wakeup:1;
Takashi Iwai8f3f6002015-04-14 12:53:28 +0200499 bool locked:1;
Takashi Iwai14752412015-04-14 12:15:47 +0200500
501 /* timestamp */
502 unsigned long start_wallclk; /* start + minimum wallclk */
503 unsigned long period_wallclk; /* wallclk for period */
504 struct timecounter tc;
505 struct cyclecounter cc;
506 int delay_negative_threshold;
507
508 struct list_head list;
Takashi Iwai8f3f6002015-04-14 12:53:28 +0200509#ifdef CONFIG_SND_HDA_DSP_LOADER
510 /* DSP access mutex */
511 struct mutex dsp_mutex;
512#endif
Takashi Iwai14752412015-04-14 12:15:47 +0200513};
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);
Jeeja KP4308c9b2015-08-23 11:52:51 +0530520struct hdac_stream *snd_hdac_get_stream(struct hdac_bus *bus,
521 int dir, int stream_tag);
Takashi Iwai14752412015-04-14 12:15:47 +0200522
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);
Jeeja KP86f65012015-04-17 17:58:58 +0530526int snd_hdac_stream_set_params(struct hdac_stream *azx_dev,
527 unsigned int format_val);
Takashi Iwai14752412015-04-14 12:15:47 +0200528void 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 * macros for easy use
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/* read/write a register, pass without AZX_REG_ prefix */
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/* update a register, pass without AZX_REG_ prefix */
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
Takashi Iwai8f3f6002015-04-14 12:53:28 +0200574#ifdef CONFIG_SND_HDA_DSP_LOADER
575/* DSP lock helpers */
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/* DSP loader helpers */
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 /* CONFIG_SND_HDA_DSP_LOADER */
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 /* CONFIG_SND_HDA_DSP_LOADER */
608
609
Takashi Iwai71fc4c72015-03-03 17:33:10 +0100610/*
611 * generic array helpers
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
Takashi Iwaia9c2dfc2018-04-23 17:24:56 +0200632/* a helper macro to iterate for each snd_array element */
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
Takashi Iwaie3d280f2015-02-17 21:46:37 +0100637#endif /* __SOUND_HDAUDIO_H */