blob: 6eed61e6cf8accecfb12569455d8658f46532780 [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 Iwai4d024fe2020-01-20 11:41:27 +010011#include <linux/io.h>
Takashi Iwaifeb20fa2018-06-27 09:03:51 +020012#include <linux/pm_runtime.h>
Takashi Iwai14752412015-04-14 12:15:47 +020013#include <linux/timecounter.h>
14#include <sound/core.h>
Takashi Iwaia6ea5fe2018-07-25 23:19:36 +020015#include <sound/pcm.h>
Takashi Iwai14752412015-04-14 12:15:47 +020016#include <sound/memalloc.h>
Takashi Iwaid068ebc2015-03-02 23:22:59 +010017#include <sound/hda_verbs.h>
Mengdong Lin98d8fc62015-05-19 22:29:30 +080018#include <drm/i915_component.h>
Takashi Iwaid068ebc2015-03-02 23:22:59 +010019
Takashi Iwai7639a062015-03-03 10:07:24 +010020/* codec node id */
21typedef u16 hda_nid_t;
22
Takashi Iwaid068ebc2015-03-02 23:22:59 +010023struct hdac_bus;
Takashi Iwai14752412015-04-14 12:15:47 +020024struct hdac_stream;
Takashi Iwaid068ebc2015-03-02 23:22:59 +010025struct hdac_device;
26struct hdac_driver;
Takashi Iwai3256be62015-02-24 14:59:42 +010027struct hdac_widget_tree;
Subhransu S. Prustyda23ac12015-09-29 13:56:10 +053028struct hda_device_id;
Takashi Iwaie3d280f2015-02-17 21:46:37 +010029
30/*
31 * exported bus type
32 */
33extern struct bus_type snd_hda_bus_type;
34
35/*
Takashi Iwai71fc4c72015-03-03 17:33:10 +010036 * generic arrays
37 */
38struct snd_array {
39 unsigned int used;
40 unsigned int alloced;
41 unsigned int elem_size;
42 unsigned int alloc_align;
43 void *list;
44};
45
46/*
Takashi Iwaie3d280f2015-02-17 21:46:37 +010047 * HD-audio codec base device
48 */
49struct hdac_device {
50 struct device dev;
51 int type;
Takashi Iwaid068ebc2015-03-02 23:22:59 +010052 struct hdac_bus *bus;
53 unsigned int addr; /* codec address */
54 struct list_head list; /* list point for bus codec_list */
Takashi Iwai7639a062015-03-03 10:07:24 +010055
56 hda_nid_t afg; /* AFG node id */
57 hda_nid_t mfg; /* MFG node id */
58
59 /* ids */
60 unsigned int vendor_id;
61 unsigned int subsystem_id;
62 unsigned int revision_id;
63 unsigned int afg_function_id;
64 unsigned int mfg_function_id;
65 unsigned int afg_unsol:1;
66 unsigned int mfg_unsol:1;
67
68 unsigned int power_caps; /* FG power caps */
69
70 const char *vendor_name; /* codec vendor name */
71 const char *chip_name; /* codec chip name */
72
Takashi Iwai058524482015-03-03 15:40:08 +010073 /* verb exec op override */
74 int (*exec_verb)(struct hdac_device *dev, unsigned int cmd,
75 unsigned int flags, unsigned int *res);
76
Takashi Iwai7639a062015-03-03 10:07:24 +010077 /* widgets */
78 unsigned int num_nodes;
79 hda_nid_t start_nid, end_nid;
80
81 /* misc flags */
82 atomic_t in_pm; /* suspend/resume being performed */
Takashi Iwai3256be62015-02-24 14:59:42 +010083
84 /* sysfs */
Amadeusz Sławińskied180ab2019-05-13 11:18:01 +020085 struct mutex widget_lock;
Takashi Iwai3256be62015-02-24 14:59:42 +010086 struct hdac_widget_tree *widgets;
Takashi Iwai4d75faa02015-02-25 14:42:38 +010087
88 /* regmap */
89 struct regmap *regmap;
Takashi Iwai1a462be2020-01-09 10:01:04 +010090 struct mutex regmap_lock;
Takashi Iwai5e56bce2015-02-26 12:29:03 +010091 struct snd_array vendor_verbs;
Takashi Iwai4d75faa02015-02-25 14:42:38 +010092 bool lazy_cache:1; /* don't wake up for writes */
Takashi Iwaifaa75f82015-02-26 08:54:56 +010093 bool caps_overwriting:1; /* caps overwrite being in process */
Takashi Iwai40ba66a2015-03-13 15:56:25 +010094 bool cache_coef:1; /* cache COEF read/write too */
Takashi Iwaie3d280f2015-02-17 21:46:37 +010095};
96
97/* device/driver type used for matching */
98enum {
99 HDA_DEV_CORE,
100 HDA_DEV_LEGACY,
Ramesh Babuc1cc18b2015-04-17 17:58:57 +0530101 HDA_DEV_ASOC,
Takashi Iwaie3d280f2015-02-17 21:46:37 +0100102};
103
Pierre-Louis Bossartd82b51c2018-12-15 14:07:23 -0600104enum {
105 SND_SKL_PCI_BIND_AUTO, /* automatic selection based on pci class */
106 SND_SKL_PCI_BIND_LEGACY,/* bind only with legacy driver */
107 SND_SKL_PCI_BIND_ASOC /* bind only with ASoC driver */
108};
109
Takashi Iwai7639a062015-03-03 10:07:24 +0100110/* direction */
111enum {
112 HDA_INPUT, HDA_OUTPUT
113};
114
Takashi Iwaie3d280f2015-02-17 21:46:37 +0100115#define dev_to_hdac_dev(_dev) container_of(_dev, struct hdac_device, dev)
116
Takashi Iwai7639a062015-03-03 10:07:24 +0100117int snd_hdac_device_init(struct hdac_device *dev, struct hdac_bus *bus,
118 const char *name, unsigned int addr);
119void snd_hdac_device_exit(struct hdac_device *dev);
Takashi Iwai3256be62015-02-24 14:59:42 +0100120int snd_hdac_device_register(struct hdac_device *codec);
121void snd_hdac_device_unregister(struct hdac_device *codec);
Takashi Iwaided255b2015-10-01 17:59:43 +0200122int snd_hdac_device_set_chip_name(struct hdac_device *codec, const char *name);
Takashi Iwai4f9e0c32015-10-16 11:35:49 +0200123int snd_hdac_codec_modalias(struct hdac_device *hdac, char *buf, size_t size);
Takashi Iwai7639a062015-03-03 10:07:24 +0100124
Takashi Iwai774a0752019-07-03 14:35:12 +0200125int snd_hdac_refresh_widgets(struct hdac_device *codec);
Takashi Iwai7639a062015-03-03 10:07:24 +0100126
Takashi Iwai7639a062015-03-03 10:07:24 +0100127int snd_hdac_read(struct hdac_device *codec, hda_nid_t nid,
128 unsigned int verb, unsigned int parm, unsigned int *res);
Takashi Iwai01ed3c02015-02-26 13:57:47 +0100129int _snd_hdac_read_parm(struct hdac_device *codec, hda_nid_t nid, int parm,
130 unsigned int *res);
Takashi Iwai9ba17b42015-03-03 23:29:47 +0100131int snd_hdac_read_parm_uncached(struct hdac_device *codec, hda_nid_t nid,
132 int parm);
Takashi Iwaifaa75f82015-02-26 08:54:56 +0100133int snd_hdac_override_parm(struct hdac_device *codec, hda_nid_t nid,
134 unsigned int parm, unsigned int val);
Takashi Iwai7639a062015-03-03 10:07:24 +0100135int snd_hdac_get_connections(struct hdac_device *codec, hda_nid_t nid,
136 hda_nid_t *conn_list, int max_conns);
137int snd_hdac_get_sub_nodes(struct hdac_device *codec, hda_nid_t nid,
138 hda_nid_t *start_id);
Takashi Iwaib7d023e2015-04-16 08:19:06 +0200139unsigned int snd_hdac_calc_stream_format(unsigned int rate,
140 unsigned int channels,
Takashi Iwaia6ea5fe2018-07-25 23:19:36 +0200141 snd_pcm_format_t format,
Takashi Iwaib7d023e2015-04-16 08:19:06 +0200142 unsigned int maxbps,
143 unsigned short spdif_ctls);
144int snd_hdac_query_supported_pcm(struct hdac_device *codec, hda_nid_t nid,
145 u32 *ratesp, u64 *formatsp, unsigned int *bpsp);
146bool snd_hdac_is_supported_format(struct hdac_device *codec, hda_nid_t nid,
147 unsigned int format);
Takashi Iwai7639a062015-03-03 10:07:24 +0100148
Subhransu S. Prusty1b5e6162015-10-08 09:48:05 +0100149int snd_hdac_codec_read(struct hdac_device *hdac, hda_nid_t nid,
150 int flags, unsigned int verb, unsigned int parm);
151int snd_hdac_codec_write(struct hdac_device *hdac, hda_nid_t nid,
152 int flags, unsigned int verb, unsigned int parm);
153bool snd_hdac_check_power_state(struct hdac_device *hdac,
154 hda_nid_t nid, unsigned int target_state);
Abhijeet Kumar09787492018-01-23 23:00:51 +0530155unsigned int snd_hdac_sync_power_state(struct hdac_device *hdac,
156 hda_nid_t nid, unsigned int target_state);
Takashi Iwai01ed3c02015-02-26 13:57:47 +0100157/**
158 * snd_hdac_read_parm - read a codec parameter
159 * @codec: the codec object
160 * @nid: NID to read a parameter
161 * @parm: parameter to read
162 *
163 * Returns -1 for error. If you need to distinguish the error more
164 * strictly, use _snd_hdac_read_parm() directly.
165 */
166static inline int snd_hdac_read_parm(struct hdac_device *codec, hda_nid_t nid,
167 int parm)
168{
169 unsigned int val;
170
171 return _snd_hdac_read_parm(codec, nid, parm, &val) < 0 ? -1 : val;
172}
173
Takashi Iwai7639a062015-03-03 10:07:24 +0100174#ifdef CONFIG_PM
Takashi Iwaifbce23a02015-07-17 16:27:33 +0200175int snd_hdac_power_up(struct hdac_device *codec);
176int snd_hdac_power_down(struct hdac_device *codec);
177int snd_hdac_power_up_pm(struct hdac_device *codec);
178int snd_hdac_power_down_pm(struct hdac_device *codec);
Takashi Iwaifc4f0002016-03-04 11:34:18 +0100179int snd_hdac_keep_power_up(struct hdac_device *codec);
Takashi Iwaifeb20fa2018-06-27 09:03:51 +0200180
181/* call this at entering into suspend/resume callbacks in codec driver */
182static inline void snd_hdac_enter_pm(struct hdac_device *codec)
183{
184 atomic_inc(&codec->in_pm);
185}
186
187/* call this at leaving from suspend/resume callbacks in codec driver */
188static inline void snd_hdac_leave_pm(struct hdac_device *codec)
189{
190 atomic_dec(&codec->in_pm);
191}
192
193static inline bool snd_hdac_is_in_pm(struct hdac_device *codec)
194{
195 return atomic_read(&codec->in_pm);
196}
197
198static inline bool snd_hdac_is_power_on(struct hdac_device *codec)
199{
200 return !pm_runtime_suspended(&codec->dev);
201}
Takashi Iwai7639a062015-03-03 10:07:24 +0100202#else
Takashi Iwaifbce23a02015-07-17 16:27:33 +0200203static inline int snd_hdac_power_up(struct hdac_device *codec) { return 0; }
204static inline int snd_hdac_power_down(struct hdac_device *codec) { return 0; }
205static inline int snd_hdac_power_up_pm(struct hdac_device *codec) { return 0; }
206static inline int snd_hdac_power_down_pm(struct hdac_device *codec) { return 0; }
Takashi Iwaifc4f0002016-03-04 11:34:18 +0100207static inline int snd_hdac_keep_power_up(struct hdac_device *codec) { return 0; }
Takashi Iwaifeb20fa2018-06-27 09:03:51 +0200208static inline void snd_hdac_enter_pm(struct hdac_device *codec) {}
209static inline void snd_hdac_leave_pm(struct hdac_device *codec) {}
Jason Yan79263c32020-05-06 14:17:16 +0800210static inline bool snd_hdac_is_in_pm(struct hdac_device *codec) { return false; }
211static inline bool snd_hdac_is_power_on(struct hdac_device *codec) { return true; }
Takashi Iwai7639a062015-03-03 10:07:24 +0100212#endif
213
Takashi Iwaie3d280f2015-02-17 21:46:37 +0100214/*
215 * HD-audio codec base driver
216 */
217struct hdac_driver {
218 struct device_driver driver;
219 int type;
Vinod Koulec71efc2015-06-03 12:24:31 +0530220 const struct hda_device_id *id_table;
Takashi Iwaie3d280f2015-02-17 21:46:37 +0100221 int (*match)(struct hdac_device *dev, struct hdac_driver *drv);
Takashi Iwaid068ebc2015-03-02 23:22:59 +0100222 void (*unsol_event)(struct hdac_device *dev, unsigned int event);
Rakesh Ughrejae1df9312018-06-01 22:53:51 -0500223
224 /* fields used by ext bus APIs */
225 int (*probe)(struct hdac_device *dev);
226 int (*remove)(struct hdac_device *dev);
227 void (*shutdown)(struct hdac_device *dev);
Takashi Iwaie3d280f2015-02-17 21:46:37 +0100228};
229
230#define drv_to_hdac_driver(_drv) container_of(_drv, struct hdac_driver, driver)
231
Vinod Koulec71efc2015-06-03 12:24:31 +0530232const struct hda_device_id *
233hdac_get_device_id(struct hdac_device *hdev, struct hdac_driver *drv);
234
Takashi Iwaid068ebc2015-03-02 23:22:59 +0100235/*
Takashi Iwai14752412015-04-14 12:15:47 +0200236 * Bus verb operators
Takashi Iwaid068ebc2015-03-02 23:22:59 +0100237 */
238struct hdac_bus_ops {
239 /* send a single command */
240 int (*command)(struct hdac_bus *bus, unsigned int cmd);
241 /* get a response from the last command */
242 int (*get_response)(struct hdac_bus *bus, unsigned int addr,
243 unsigned int *res);
244};
245
Takashi Iwai14752412015-04-14 12:15:47 +0200246/*
Rakesh Ughrejacb04ba32018-06-01 22:53:58 -0500247 * ops used for ASoC HDA codec drivers
248 */
249struct hdac_ext_bus_ops {
250 int (*hdev_attach)(struct hdac_device *hdev);
251 int (*hdev_detach)(struct hdac_device *hdev);
252};
253
Takashi Iwai14752412015-04-14 12:15:47 +0200254#define HDA_UNSOL_QUEUE_SIZE 64
255#define HDA_MAX_CODECS 8 /* limit by controller side */
256
Takashi Iwai14752412015-04-14 12:15:47 +0200257/*
258 * CORB/RIRB
259 *
260 * Each CORB entry is 4byte, RIRB is 8byte
261 */
262struct hdac_rb {
263 __le32 *buf; /* virtual address of CORB/RIRB buffer */
264 dma_addr_t addr; /* physical address of CORB/RIRB buffer */
265 unsigned short rp, wp; /* RIRB read/write pointers */
266 int cmds[HDA_MAX_CODECS]; /* number of pending requests */
267 u32 res[HDA_MAX_CODECS]; /* last read value */
268};
269
270/*
271 * HD-audio bus base driver
Vinod Koul6720b382016-08-04 15:46:00 +0530272 *
273 * @ppcap: pp capabilities pointer
274 * @spbcap: SPIB capabilities pointer
275 * @mlcap: MultiLink capabilities pointer
276 * @gtscap: gts capabilities pointer
277 * @drsmcap: dma resume capabilities pointer
Rakesh Ughreja76f56fa2018-06-01 22:53:50 -0500278 * @num_streams: streams supported
279 * @idx: HDA link index
280 * @hlink_list: link list of HDA links
Takashi Iwaie61ab9f2019-04-10 16:00:54 +0200281 * @lock: lock for link and display power mgmt
Rakesh Ughreja76f56fa2018-06-01 22:53:50 -0500282 * @cmd_dma_state: state of cmd DMAs: CORB and RIRB
Takashi Iwai14752412015-04-14 12:15:47 +0200283 */
Takashi Iwaid068ebc2015-03-02 23:22:59 +0100284struct hdac_bus {
285 struct device *dev;
286 const struct hdac_bus_ops *ops;
Rakesh Ughrejacb04ba32018-06-01 22:53:58 -0500287 const struct hdac_ext_bus_ops *ext_ops;
Takashi Iwai14752412015-04-14 12:15:47 +0200288
289 /* h/w resources */
290 unsigned long addr;
291 void __iomem *remap_addr;
292 int irq;
Takashi Iwaid068ebc2015-03-02 23:22:59 +0100293
Vinod Koul6720b382016-08-04 15:46:00 +0530294 void __iomem *ppcap;
295 void __iomem *spbcap;
296 void __iomem *mlcap;
297 void __iomem *gtscap;
298 void __iomem *drsmcap;
299
Takashi Iwaid068ebc2015-03-02 23:22:59 +0100300 /* codec linked list */
301 struct list_head codec_list;
302 unsigned int num_codecs;
303
304 /* link caddr -> codec */
305 struct hdac_device *caddr_tbl[HDA_MAX_CODEC_ADDRESS + 1];
306
307 /* unsolicited event queue */
308 u32 unsol_queue[HDA_UNSOL_QUEUE_SIZE * 2]; /* ring buffer */
309 unsigned int unsol_rp, unsol_wp;
310 struct work_struct unsol_work;
311
Takashi Iwai14752412015-04-14 12:15:47 +0200312 /* bit flags of detected codecs */
313 unsigned long codec_mask;
314
Takashi Iwaid068ebc2015-03-02 23:22:59 +0100315 /* bit flags of powered codecs */
316 unsigned long codec_powered;
317
Takashi Iwai14752412015-04-14 12:15:47 +0200318 /* CORB/RIRB */
319 struct hdac_rb corb;
320 struct hdac_rb rirb;
321 unsigned int last_cmd[HDA_MAX_CODECS]; /* last sent command */
Takashi Iwai88452da2019-12-10 15:57:27 +0100322 wait_queue_head_t rirb_wq;
Takashi Iwai14752412015-04-14 12:15:47 +0200323
324 /* CORB/RIRB and position buffers */
325 struct snd_dma_buffer rb;
326 struct snd_dma_buffer posbuf;
Takashi Iwai619a1f12019-08-07 20:02:31 +0200327 int dma_type; /* SNDRV_DMA_TYPE_XXX for CORB/RIRB */
Takashi Iwai14752412015-04-14 12:15:47 +0200328
329 /* hdac_stream linked list */
330 struct list_head stream_list;
331
332 /* operation state */
333 bool chip_init:1; /* h/w initialized */
334
335 /* behavior flags */
Takashi Iwai4d024fe2020-01-20 11:41:27 +0100336 bool aligned_mmio:1; /* aligned MMIO access */
Takashi Iwaid068ebc2015-03-02 23:22:59 +0100337 bool sync_write:1; /* sync after verb write */
Takashi Iwai14752412015-04-14 12:15:47 +0200338 bool use_posbuf:1; /* use position buffer */
339 bool snoop:1; /* enable snooping */
340 bool align_bdle_4k:1; /* BDLE align 4K boundary */
341 bool reverse_assign:1; /* assign devices in reverse order */
342 bool corbrp_self_clear:1; /* CORBRP clears itself after reset */
Bard Liao8af42132019-05-27 00:58:34 +0800343 bool polling_mode:1;
Takashi Iwai5f2cb362019-12-12 20:11:01 +0100344 bool needs_damn_long_delay:1;
Bard Liao8af42132019-05-27 00:58:34 +0800345
346 int poll_count;
Takashi Iwai14752412015-04-14 12:15:47 +0200347
348 int bdl_pos_adj; /* BDL position adjustment */
Takashi Iwaid068ebc2015-03-02 23:22:59 +0100349
Mohan Kumar41068202020-08-05 15:22:20 +0530350 /* delay time in us for dma stop */
351 unsigned int dma_stop_delay;
352
Takashi Iwaid068ebc2015-03-02 23:22:59 +0100353 /* locks */
Takashi Iwai14752412015-04-14 12:15:47 +0200354 spinlock_t reg_lock;
Takashi Iwaid068ebc2015-03-02 23:22:59 +0100355 struct mutex cmd_mutex;
Takashi Iwaie61ab9f2019-04-10 16:00:54 +0200356 struct mutex lock;
Mengdong Lin98d8fc62015-05-19 22:29:30 +0800357
Takashi Iwaiae891ab2018-07-11 15:17:22 +0200358 /* DRM component interface */
359 struct drm_audio_component *audio_component;
Takashi Iwai029d92c2018-12-08 17:31:49 +0100360 long display_power_status;
Chris Wilsond31c85f2019-02-13 15:21:09 +0000361 unsigned long display_power_active;
Rakesh Ughreja76f56fa2018-06-01 22:53:50 -0500362
363 /* parameters required for enhanced capabilities */
364 int num_streams;
365 int idx;
366
Takashi Iwaie61ab9f2019-04-10 16:00:54 +0200367 /* link management */
Rakesh Ughreja76f56fa2018-06-01 22:53:50 -0500368 struct list_head hlink_list;
Rakesh Ughreja76f56fa2018-06-01 22:53:50 -0500369 bool cmd_dma_state;
Sameer Pujar67ae4822020-05-04 13:46:15 +0530370
371 /* factor used to derive STRIPE control value */
372 unsigned int sdo_limit;
Takashi Iwaid068ebc2015-03-02 23:22:59 +0100373};
374
375int snd_hdac_bus_init(struct hdac_bus *bus, struct device *dev,
Takashi Iwai19abfef2019-08-07 20:32:08 +0200376 const struct hdac_bus_ops *ops);
Takashi Iwaid068ebc2015-03-02 23:22:59 +0100377void snd_hdac_bus_exit(struct hdac_bus *bus);
Takashi Iwaid068ebc2015-03-02 23:22:59 +0100378int snd_hdac_bus_exec_verb_unlocked(struct hdac_bus *bus, unsigned int addr,
379 unsigned int cmd, unsigned int *res);
Takashi Iwaid068ebc2015-03-02 23:22:59 +0100380
Takashi Iwai7639a062015-03-03 10:07:24 +0100381static inline void snd_hdac_codec_link_up(struct hdac_device *codec)
382{
383 set_bit(codec->addr, &codec->bus->codec_powered);
384}
385
386static inline void snd_hdac_codec_link_down(struct hdac_device *codec)
387{
388 clear_bit(codec->addr, &codec->bus->codec_powered);
389}
390
Takashi Iwai14752412015-04-14 12:15:47 +0200391int snd_hdac_bus_send_cmd(struct hdac_bus *bus, unsigned int val);
392int snd_hdac_bus_get_response(struct hdac_bus *bus, unsigned int addr,
393 unsigned int *res);
Vinod Koul6720b382016-08-04 15:46:00 +0530394int snd_hdac_bus_parse_capabilities(struct hdac_bus *bus);
Takashi Iwai14752412015-04-14 12:15:47 +0200395
396bool snd_hdac_bus_init_chip(struct hdac_bus *bus, bool full_reset);
397void snd_hdac_bus_stop_chip(struct hdac_bus *bus);
398void snd_hdac_bus_init_cmd_io(struct hdac_bus *bus);
399void snd_hdac_bus_stop_cmd_io(struct hdac_bus *bus);
400void snd_hdac_bus_enter_link_reset(struct hdac_bus *bus);
401void snd_hdac_bus_exit_link_reset(struct hdac_bus *bus);
Yu Zhao75383f82018-09-11 15:15:16 -0600402int snd_hdac_bus_reset_link(struct hdac_bus *bus, bool full_reset);
Takashi Iwai14752412015-04-14 12:15:47 +0200403
404void snd_hdac_bus_update_rirb(struct hdac_bus *bus);
Takashi Iwai473f4142016-02-23 15:54:47 +0100405int snd_hdac_bus_handle_stream_irq(struct hdac_bus *bus, unsigned int status,
Takashi Iwai14752412015-04-14 12:15:47 +0200406 void (*ack)(struct hdac_bus *,
407 struct hdac_stream *));
408
Jeeja KP304dad32015-04-12 18:06:13 +0530409int snd_hdac_bus_alloc_stream_pages(struct hdac_bus *bus);
410void snd_hdac_bus_free_stream_pages(struct hdac_bus *bus);
411
Takashi Iwai19abfef2019-08-07 20:32:08 +0200412#ifdef CONFIG_SND_HDA_ALIGNED_MMIO
413unsigned int snd_hdac_aligned_read(void __iomem *addr, unsigned int mask);
414void snd_hdac_aligned_write(unsigned int val, void __iomem *addr,
415 unsigned int mask);
Takashi Iwai4d024fe2020-01-20 11:41:27 +0100416#define snd_hdac_aligned_mmio(bus) (bus)->aligned_mmio
417#else
418#define snd_hdac_aligned_mmio(bus) false
419#define snd_hdac_aligned_read(addr, mask) 0
420#define snd_hdac_aligned_write(val, addr, mask) do {} while (0)
421#endif
422
423static inline void snd_hdac_reg_writeb(struct hdac_bus *bus, void __iomem *addr,
424 u8 val)
425{
426 if (snd_hdac_aligned_mmio(bus))
427 snd_hdac_aligned_write(val, addr, 0xff);
428 else
429 writeb(val, addr);
430}
431
432static inline void snd_hdac_reg_writew(struct hdac_bus *bus, void __iomem *addr,
433 u16 val)
434{
435 if (snd_hdac_aligned_mmio(bus))
436 snd_hdac_aligned_write(val, addr, 0xffff);
437 else
438 writew(val, addr);
439}
440
441static inline u8 snd_hdac_reg_readb(struct hdac_bus *bus, void __iomem *addr)
442{
443 return snd_hdac_aligned_mmio(bus) ?
444 snd_hdac_aligned_read(addr, 0xff) : readb(addr);
445}
446
447static inline u16 snd_hdac_reg_readw(struct hdac_bus *bus, void __iomem *addr)
448{
449 return snd_hdac_aligned_mmio(bus) ?
450 snd_hdac_aligned_read(addr, 0xffff) : readw(addr);
451}
452
453#define snd_hdac_reg_writel(bus, addr, val) writel(val, addr)
454#define snd_hdac_reg_readl(bus, addr) readl(addr)
Takashi Iwai19abfef2019-08-07 20:32:08 +0200455
Takashi Iwai14752412015-04-14 12:15:47 +0200456/*
457 * macros for easy use
458 */
Takashi Iwai2c1f8132017-03-29 08:27:15 +0200459#define _snd_hdac_chip_writeb(chip, reg, value) \
Takashi Iwai4d024fe2020-01-20 11:41:27 +0100460 snd_hdac_reg_writeb(chip, (chip)->remap_addr + (reg), value)
Takashi Iwai2c1f8132017-03-29 08:27:15 +0200461#define _snd_hdac_chip_readb(chip, reg) \
Takashi Iwai4d024fe2020-01-20 11:41:27 +0100462 snd_hdac_reg_readb(chip, (chip)->remap_addr + (reg))
Takashi Iwai2c1f8132017-03-29 08:27:15 +0200463#define _snd_hdac_chip_writew(chip, reg, value) \
Takashi Iwai4d024fe2020-01-20 11:41:27 +0100464 snd_hdac_reg_writew(chip, (chip)->remap_addr + (reg), value)
Takashi Iwai2c1f8132017-03-29 08:27:15 +0200465#define _snd_hdac_chip_readw(chip, reg) \
Takashi Iwai4d024fe2020-01-20 11:41:27 +0100466 snd_hdac_reg_readw(chip, (chip)->remap_addr + (reg))
Takashi Iwai2c1f8132017-03-29 08:27:15 +0200467#define _snd_hdac_chip_writel(chip, reg, value) \
Takashi Iwai4d024fe2020-01-20 11:41:27 +0100468 snd_hdac_reg_writel(chip, (chip)->remap_addr + (reg), value)
Takashi Iwai2c1f8132017-03-29 08:27:15 +0200469#define _snd_hdac_chip_readl(chip, reg) \
Takashi Iwai4d024fe2020-01-20 11:41:27 +0100470 snd_hdac_reg_readl(chip, (chip)->remap_addr + (reg))
Takashi Iwai14752412015-04-14 12:15:47 +0200471
472/* read/write a register, pass without AZX_REG_ prefix */
473#define snd_hdac_chip_writel(chip, reg, value) \
Takashi Iwai2c1f8132017-03-29 08:27:15 +0200474 _snd_hdac_chip_writel(chip, AZX_REG_ ## reg, value)
Takashi Iwai14752412015-04-14 12:15:47 +0200475#define snd_hdac_chip_writew(chip, reg, value) \
Takashi Iwai2c1f8132017-03-29 08:27:15 +0200476 _snd_hdac_chip_writew(chip, AZX_REG_ ## reg, value)
Takashi Iwai14752412015-04-14 12:15:47 +0200477#define snd_hdac_chip_writeb(chip, reg, value) \
Takashi Iwai2c1f8132017-03-29 08:27:15 +0200478 _snd_hdac_chip_writeb(chip, AZX_REG_ ## reg, value)
Takashi Iwai14752412015-04-14 12:15:47 +0200479#define snd_hdac_chip_readl(chip, reg) \
Takashi Iwai2c1f8132017-03-29 08:27:15 +0200480 _snd_hdac_chip_readl(chip, AZX_REG_ ## reg)
Takashi Iwai14752412015-04-14 12:15:47 +0200481#define snd_hdac_chip_readw(chip, reg) \
Takashi Iwai2c1f8132017-03-29 08:27:15 +0200482 _snd_hdac_chip_readw(chip, AZX_REG_ ## reg)
Takashi Iwai14752412015-04-14 12:15:47 +0200483#define snd_hdac_chip_readb(chip, reg) \
Takashi Iwai2c1f8132017-03-29 08:27:15 +0200484 _snd_hdac_chip_readb(chip, AZX_REG_ ## reg)
Takashi Iwai14752412015-04-14 12:15:47 +0200485
486/* update a register, pass without AZX_REG_ prefix */
487#define snd_hdac_chip_updatel(chip, reg, mask, val) \
488 snd_hdac_chip_writel(chip, reg, \
489 (snd_hdac_chip_readl(chip, reg) & ~(mask)) | (val))
490#define snd_hdac_chip_updatew(chip, reg, mask, val) \
491 snd_hdac_chip_writew(chip, reg, \
492 (snd_hdac_chip_readw(chip, reg) & ~(mask)) | (val))
493#define snd_hdac_chip_updateb(chip, reg, mask, val) \
494 snd_hdac_chip_writeb(chip, reg, \
495 (snd_hdac_chip_readb(chip, reg) & ~(mask)) | (val))
496
497/*
498 * HD-audio stream
499 */
500struct hdac_stream {
501 struct hdac_bus *bus;
502 struct snd_dma_buffer bdl; /* BDL buffer */
503 __le32 *posbuf; /* position buffer pointer */
504 int direction; /* playback / capture (SNDRV_PCM_STREAM_*) */
505
506 unsigned int bufsize; /* size of the play buffer in bytes */
507 unsigned int period_bytes; /* size of the period in bytes */
508 unsigned int frags; /* number for period in the play buffer */
509 unsigned int fifo_size; /* FIFO size */
510
511 void __iomem *sd_addr; /* stream descriptor pointer */
512
513 u32 sd_int_sta_mask; /* stream int status mask */
514
515 /* pcm support */
516 struct snd_pcm_substream *substream; /* assigned substream,
517 * set in PCM open
518 */
Cezary Rojewski4a9ce6e2020-02-18 15:39:18 +0100519 struct snd_compr_stream *cstream;
Takashi Iwai14752412015-04-14 12:15:47 +0200520 unsigned int format_val; /* format value to be set in the
521 * controller and the codec
522 */
523 unsigned char stream_tag; /* assigned stream */
524 unsigned char index; /* stream index */
525 int assigned_key; /* last device# key assigned to */
526
527 bool opened:1;
528 bool running:1;
Takashi Iwai6d23c8f2015-04-17 13:34:30 +0200529 bool prepared:1;
Takashi Iwai14752412015-04-14 12:15:47 +0200530 bool no_period_wakeup:1;
Takashi Iwai8f3f6002015-04-14 12:53:28 +0200531 bool locked:1;
Takashi Iwaie38e4862019-12-02 08:49:47 +0100532 bool stripe:1; /* apply stripe control */
Takashi Iwai14752412015-04-14 12:15:47 +0200533
Cezary Rojewski4a9ce6e2020-02-18 15:39:18 +0100534 u64 curr_pos;
Takashi Iwai14752412015-04-14 12:15:47 +0200535 /* timestamp */
536 unsigned long start_wallclk; /* start + minimum wallclk */
537 unsigned long period_wallclk; /* wallclk for period */
538 struct timecounter tc;
539 struct cyclecounter cc;
540 int delay_negative_threshold;
541
542 struct list_head list;
Takashi Iwai8f3f6002015-04-14 12:53:28 +0200543#ifdef CONFIG_SND_HDA_DSP_LOADER
544 /* DSP access mutex */
545 struct mutex dsp_mutex;
546#endif
Takashi Iwai14752412015-04-14 12:15:47 +0200547};
548
549void snd_hdac_stream_init(struct hdac_bus *bus, struct hdac_stream *azx_dev,
550 int idx, int direction, int tag);
551struct hdac_stream *snd_hdac_stream_assign(struct hdac_bus *bus,
552 struct snd_pcm_substream *substream);
553void snd_hdac_stream_release(struct hdac_stream *azx_dev);
Jeeja KP4308c9b2015-08-23 11:52:51 +0530554struct hdac_stream *snd_hdac_get_stream(struct hdac_bus *bus,
555 int dir, int stream_tag);
Takashi Iwai14752412015-04-14 12:15:47 +0200556
557int snd_hdac_stream_setup(struct hdac_stream *azx_dev);
558void snd_hdac_stream_cleanup(struct hdac_stream *azx_dev);
559int snd_hdac_stream_setup_periods(struct hdac_stream *azx_dev);
Jeeja KP86f65012015-04-17 17:58:58 +0530560int snd_hdac_stream_set_params(struct hdac_stream *azx_dev,
561 unsigned int format_val);
Takashi Iwai14752412015-04-14 12:15:47 +0200562void snd_hdac_stream_start(struct hdac_stream *azx_dev, bool fresh_start);
563void snd_hdac_stream_clear(struct hdac_stream *azx_dev);
564void snd_hdac_stream_stop(struct hdac_stream *azx_dev);
565void snd_hdac_stream_reset(struct hdac_stream *azx_dev);
566void snd_hdac_stream_sync_trigger(struct hdac_stream *azx_dev, bool set,
567 unsigned int streams, unsigned int reg);
568void snd_hdac_stream_sync(struct hdac_stream *azx_dev, bool start,
569 unsigned int streams);
570void snd_hdac_stream_timecounter_init(struct hdac_stream *azx_dev,
571 unsigned int streams);
Sameer Pujar5dd3d272019-01-14 23:51:09 +0530572int snd_hdac_get_stream_stripe_ctl(struct hdac_bus *bus,
573 struct snd_pcm_substream *substream);
574
Takashi Iwai14752412015-04-14 12:15:47 +0200575/*
576 * macros for easy use
577 */
Takashi Iwai14752412015-04-14 12:15:47 +0200578/* read/write a register, pass without AZX_REG_ prefix */
579#define snd_hdac_stream_writel(dev, reg, value) \
Takashi Iwai4d024fe2020-01-20 11:41:27 +0100580 snd_hdac_reg_writel((dev)->bus, (dev)->sd_addr + AZX_REG_ ## reg, value)
Takashi Iwai14752412015-04-14 12:15:47 +0200581#define snd_hdac_stream_writew(dev, reg, value) \
Takashi Iwai4d024fe2020-01-20 11:41:27 +0100582 snd_hdac_reg_writew((dev)->bus, (dev)->sd_addr + AZX_REG_ ## reg, value)
Takashi Iwai14752412015-04-14 12:15:47 +0200583#define snd_hdac_stream_writeb(dev, reg, value) \
Takashi Iwai4d024fe2020-01-20 11:41:27 +0100584 snd_hdac_reg_writeb((dev)->bus, (dev)->sd_addr + AZX_REG_ ## reg, value)
Takashi Iwai14752412015-04-14 12:15:47 +0200585#define snd_hdac_stream_readl(dev, reg) \
Takashi Iwai4d024fe2020-01-20 11:41:27 +0100586 snd_hdac_reg_readl((dev)->bus, (dev)->sd_addr + AZX_REG_ ## reg)
Takashi Iwai14752412015-04-14 12:15:47 +0200587#define snd_hdac_stream_readw(dev, reg) \
Takashi Iwai4d024fe2020-01-20 11:41:27 +0100588 snd_hdac_reg_readw((dev)->bus, (dev)->sd_addr + AZX_REG_ ## reg)
Takashi Iwai14752412015-04-14 12:15:47 +0200589#define snd_hdac_stream_readb(dev, reg) \
Takashi Iwai4d024fe2020-01-20 11:41:27 +0100590 snd_hdac_reg_readb((dev)->bus, (dev)->sd_addr + AZX_REG_ ## reg)
Takashi Iwai14752412015-04-14 12:15:47 +0200591
592/* update a register, pass without AZX_REG_ prefix */
593#define snd_hdac_stream_updatel(dev, reg, mask, val) \
594 snd_hdac_stream_writel(dev, reg, \
595 (snd_hdac_stream_readl(dev, reg) & \
596 ~(mask)) | (val))
597#define snd_hdac_stream_updatew(dev, reg, mask, val) \
598 snd_hdac_stream_writew(dev, reg, \
599 (snd_hdac_stream_readw(dev, reg) & \
600 ~(mask)) | (val))
601#define snd_hdac_stream_updateb(dev, reg, mask, val) \
602 snd_hdac_stream_writeb(dev, reg, \
603 (snd_hdac_stream_readb(dev, reg) & \
604 ~(mask)) | (val))
605
Takashi Iwai8f3f6002015-04-14 12:53:28 +0200606#ifdef CONFIG_SND_HDA_DSP_LOADER
607/* DSP lock helpers */
608#define snd_hdac_dsp_lock_init(dev) mutex_init(&(dev)->dsp_mutex)
609#define snd_hdac_dsp_lock(dev) mutex_lock(&(dev)->dsp_mutex)
610#define snd_hdac_dsp_unlock(dev) mutex_unlock(&(dev)->dsp_mutex)
611#define snd_hdac_stream_is_locked(dev) ((dev)->locked)
612/* DSP loader helpers */
613int snd_hdac_dsp_prepare(struct hdac_stream *azx_dev, unsigned int format,
614 unsigned int byte_size, struct snd_dma_buffer *bufp);
615void snd_hdac_dsp_trigger(struct hdac_stream *azx_dev, bool start);
616void snd_hdac_dsp_cleanup(struct hdac_stream *azx_dev,
617 struct snd_dma_buffer *dmab);
618#else /* CONFIG_SND_HDA_DSP_LOADER */
619#define snd_hdac_dsp_lock_init(dev) do {} while (0)
620#define snd_hdac_dsp_lock(dev) do {} while (0)
621#define snd_hdac_dsp_unlock(dev) do {} while (0)
622#define snd_hdac_stream_is_locked(dev) 0
623
624static inline int
625snd_hdac_dsp_prepare(struct hdac_stream *azx_dev, unsigned int format,
626 unsigned int byte_size, struct snd_dma_buffer *bufp)
627{
628 return 0;
629}
630
631static inline void snd_hdac_dsp_trigger(struct hdac_stream *azx_dev, bool start)
632{
633}
634
635static inline void snd_hdac_dsp_cleanup(struct hdac_stream *azx_dev,
636 struct snd_dma_buffer *dmab)
637{
638}
639#endif /* CONFIG_SND_HDA_DSP_LOADER */
640
641
Takashi Iwai71fc4c72015-03-03 17:33:10 +0100642/*
643 * generic array helpers
644 */
645void *snd_array_new(struct snd_array *array);
646void snd_array_free(struct snd_array *array);
647static inline void snd_array_init(struct snd_array *array, unsigned int size,
648 unsigned int align)
649{
650 array->elem_size = size;
651 array->alloc_align = align;
652}
653
654static inline void *snd_array_elem(struct snd_array *array, unsigned int idx)
655{
656 return array->list + idx * array->elem_size;
657}
658
659static inline unsigned int snd_array_index(struct snd_array *array, void *ptr)
660{
661 return (unsigned long)(ptr - array->list) / array->elem_size;
662}
663
Takashi Iwaia9c2dfc2018-04-23 17:24:56 +0200664/* a helper macro to iterate for each snd_array element */
665#define snd_array_for_each(array, idx, ptr) \
666 for ((idx) = 0, (ptr) = (array)->list; (idx) < (array)->used; \
667 (ptr) = snd_array_elem(array, ++(idx)))
668
Takashi Iwaie3d280f2015-02-17 21:46:37 +0100669#endif /* __SOUND_HDAUDIO_H */