xref: /openbmc/linux/include/sound/hdaudio.h (revision 88452da9)
1b2441318SGreg Kroah-Hartman /* SPDX-License-Identifier: GPL-2.0 */
2e3d280fcSTakashi Iwai /*
3e3d280fcSTakashi Iwai  * HD-audio core stuff
4e3d280fcSTakashi Iwai  */
5e3d280fcSTakashi Iwai 
6e3d280fcSTakashi Iwai #ifndef __SOUND_HDAUDIO_H
7e3d280fcSTakashi Iwai #define __SOUND_HDAUDIO_H
8e3d280fcSTakashi Iwai 
9e3d280fcSTakashi Iwai #include <linux/device.h>
1014752412STakashi Iwai #include <linux/interrupt.h>
11feb20faeSTakashi Iwai #include <linux/pm_runtime.h>
1214752412STakashi Iwai #include <linux/timecounter.h>
1314752412STakashi Iwai #include <sound/core.h>
14a6ea5fe9STakashi Iwai #include <sound/pcm.h>
1514752412STakashi Iwai #include <sound/memalloc.h>
16d068ebc2STakashi Iwai #include <sound/hda_verbs.h>
1798d8fc6cSMengdong Lin #include <drm/i915_component.h>
18d068ebc2STakashi Iwai 
197639a06cSTakashi Iwai /* codec node id */
207639a06cSTakashi Iwai typedef u16 hda_nid_t;
217639a06cSTakashi Iwai 
22d068ebc2STakashi Iwai struct hdac_bus;
2314752412STakashi Iwai struct hdac_stream;
24d068ebc2STakashi Iwai struct hdac_device;
25d068ebc2STakashi Iwai struct hdac_driver;
263256be65STakashi Iwai struct hdac_widget_tree;
27da23ac1eSSubhransu S. Prusty struct hda_device_id;
28e3d280fcSTakashi Iwai 
29e3d280fcSTakashi Iwai /*
30e3d280fcSTakashi Iwai  * exported bus type
31e3d280fcSTakashi Iwai  */
32e3d280fcSTakashi Iwai extern struct bus_type snd_hda_bus_type;
33e3d280fcSTakashi Iwai 
34e3d280fcSTakashi Iwai /*
3571fc4c7eSTakashi Iwai  * generic arrays
3671fc4c7eSTakashi Iwai  */
3771fc4c7eSTakashi Iwai struct snd_array {
3871fc4c7eSTakashi Iwai 	unsigned int used;
3971fc4c7eSTakashi Iwai 	unsigned int alloced;
4071fc4c7eSTakashi Iwai 	unsigned int elem_size;
4171fc4c7eSTakashi Iwai 	unsigned int alloc_align;
4271fc4c7eSTakashi Iwai 	void *list;
4371fc4c7eSTakashi Iwai };
4471fc4c7eSTakashi Iwai 
4571fc4c7eSTakashi Iwai /*
46e3d280fcSTakashi Iwai  * HD-audio codec base device
47e3d280fcSTakashi Iwai  */
48e3d280fcSTakashi Iwai struct hdac_device {
49e3d280fcSTakashi Iwai 	struct device dev;
50e3d280fcSTakashi Iwai 	int type;
51d068ebc2STakashi Iwai 	struct hdac_bus *bus;
52d068ebc2STakashi Iwai 	unsigned int addr;		/* codec address */
53d068ebc2STakashi Iwai 	struct list_head list;		/* list point for bus codec_list */
547639a06cSTakashi Iwai 
557639a06cSTakashi Iwai 	hda_nid_t afg;			/* AFG node id */
567639a06cSTakashi Iwai 	hda_nid_t mfg;			/* MFG node id */
577639a06cSTakashi Iwai 
587639a06cSTakashi Iwai 	/* ids */
597639a06cSTakashi Iwai 	unsigned int vendor_id;
607639a06cSTakashi Iwai 	unsigned int subsystem_id;
617639a06cSTakashi Iwai 	unsigned int revision_id;
627639a06cSTakashi Iwai 	unsigned int afg_function_id;
637639a06cSTakashi Iwai 	unsigned int mfg_function_id;
647639a06cSTakashi Iwai 	unsigned int afg_unsol:1;
657639a06cSTakashi Iwai 	unsigned int mfg_unsol:1;
667639a06cSTakashi Iwai 
677639a06cSTakashi Iwai 	unsigned int power_caps;	/* FG power caps */
687639a06cSTakashi Iwai 
697639a06cSTakashi Iwai 	const char *vendor_name;	/* codec vendor name */
707639a06cSTakashi Iwai 	const char *chip_name;		/* codec chip name */
717639a06cSTakashi Iwai 
7205852448STakashi Iwai 	/* verb exec op override */
7305852448STakashi Iwai 	int (*exec_verb)(struct hdac_device *dev, unsigned int cmd,
7405852448STakashi Iwai 			 unsigned int flags, unsigned int *res);
7505852448STakashi Iwai 
767639a06cSTakashi Iwai 	/* widgets */
777639a06cSTakashi Iwai 	unsigned int num_nodes;
787639a06cSTakashi Iwai 	hda_nid_t start_nid, end_nid;
797639a06cSTakashi Iwai 
807639a06cSTakashi Iwai 	/* misc flags */
817639a06cSTakashi Iwai 	atomic_t in_pm;		/* suspend/resume being performed */
823256be65STakashi Iwai 
833256be65STakashi Iwai 	/* sysfs */
84ed180abbSAmadeusz Sławiński 	struct mutex widget_lock;
853256be65STakashi Iwai 	struct hdac_widget_tree *widgets;
864d75faa0STakashi Iwai 
874d75faa0STakashi Iwai 	/* regmap */
884d75faa0STakashi Iwai 	struct regmap *regmap;
895e56bceaSTakashi Iwai 	struct snd_array vendor_verbs;
904d75faa0STakashi Iwai 	bool lazy_cache:1;	/* don't wake up for writes */
91faa75f8aSTakashi Iwai 	bool caps_overwriting:1; /* caps overwrite being in process */
9240ba66a7STakashi Iwai 	bool cache_coef:1;	/* cache COEF read/write too */
93e3d280fcSTakashi Iwai };
94e3d280fcSTakashi Iwai 
95e3d280fcSTakashi Iwai /* device/driver type used for matching */
96e3d280fcSTakashi Iwai enum {
97e3d280fcSTakashi Iwai 	HDA_DEV_CORE,
98e3d280fcSTakashi Iwai 	HDA_DEV_LEGACY,
99c1cc18b1SRamesh Babu 	HDA_DEV_ASOC,
100e3d280fcSTakashi Iwai };
101e3d280fcSTakashi Iwai 
102d82b51c8SPierre-Louis Bossart enum {
103d82b51c8SPierre-Louis Bossart 	SND_SKL_PCI_BIND_AUTO,	/* automatic selection based on pci class */
104d82b51c8SPierre-Louis Bossart 	SND_SKL_PCI_BIND_LEGACY,/* bind only with legacy driver */
105d82b51c8SPierre-Louis Bossart 	SND_SKL_PCI_BIND_ASOC	/* bind only with ASoC driver */
106d82b51c8SPierre-Louis Bossart };
107d82b51c8SPierre-Louis Bossart 
1087639a06cSTakashi Iwai /* direction */
1097639a06cSTakashi Iwai enum {
1107639a06cSTakashi Iwai 	HDA_INPUT, HDA_OUTPUT
1117639a06cSTakashi Iwai };
1127639a06cSTakashi Iwai 
113e3d280fcSTakashi Iwai #define dev_to_hdac_dev(_dev)	container_of(_dev, struct hdac_device, dev)
114e3d280fcSTakashi Iwai 
1157639a06cSTakashi Iwai int snd_hdac_device_init(struct hdac_device *dev, struct hdac_bus *bus,
1167639a06cSTakashi Iwai 			 const char *name, unsigned int addr);
1177639a06cSTakashi Iwai void snd_hdac_device_exit(struct hdac_device *dev);
1183256be65STakashi Iwai int snd_hdac_device_register(struct hdac_device *codec);
1193256be65STakashi Iwai void snd_hdac_device_unregister(struct hdac_device *codec);
120ded255beSTakashi Iwai int snd_hdac_device_set_chip_name(struct hdac_device *codec, const char *name);
1214f9e0c38STakashi Iwai int snd_hdac_codec_modalias(struct hdac_device *hdac, char *buf, size_t size);
1227639a06cSTakashi Iwai 
123774a075aSTakashi Iwai int snd_hdac_refresh_widgets(struct hdac_device *codec);
1247639a06cSTakashi Iwai 
1257639a06cSTakashi Iwai int snd_hdac_read(struct hdac_device *codec, hda_nid_t nid,
1267639a06cSTakashi Iwai 		  unsigned int verb, unsigned int parm, unsigned int *res);
12701ed3c06STakashi Iwai int _snd_hdac_read_parm(struct hdac_device *codec, hda_nid_t nid, int parm,
12801ed3c06STakashi Iwai 			unsigned int *res);
1299ba17b4dSTakashi Iwai int snd_hdac_read_parm_uncached(struct hdac_device *codec, hda_nid_t nid,
1309ba17b4dSTakashi Iwai 				int parm);
131faa75f8aSTakashi Iwai int snd_hdac_override_parm(struct hdac_device *codec, hda_nid_t nid,
132faa75f8aSTakashi Iwai 			   unsigned int parm, unsigned int val);
1337639a06cSTakashi Iwai int snd_hdac_get_connections(struct hdac_device *codec, hda_nid_t nid,
1347639a06cSTakashi Iwai 			     hda_nid_t *conn_list, int max_conns);
1357639a06cSTakashi Iwai int snd_hdac_get_sub_nodes(struct hdac_device *codec, hda_nid_t nid,
1367639a06cSTakashi Iwai 			   hda_nid_t *start_id);
137b7d023e1STakashi Iwai unsigned int snd_hdac_calc_stream_format(unsigned int rate,
138b7d023e1STakashi Iwai 					 unsigned int channels,
139a6ea5fe9STakashi Iwai 					 snd_pcm_format_t format,
140b7d023e1STakashi Iwai 					 unsigned int maxbps,
141b7d023e1STakashi Iwai 					 unsigned short spdif_ctls);
142b7d023e1STakashi Iwai int snd_hdac_query_supported_pcm(struct hdac_device *codec, hda_nid_t nid,
143b7d023e1STakashi Iwai 				u32 *ratesp, u64 *formatsp, unsigned int *bpsp);
144b7d023e1STakashi Iwai bool snd_hdac_is_supported_format(struct hdac_device *codec, hda_nid_t nid,
145b7d023e1STakashi Iwai 				  unsigned int format);
1467639a06cSTakashi Iwai 
1471b5e6167SSubhransu S. Prusty int snd_hdac_codec_read(struct hdac_device *hdac, hda_nid_t nid,
1481b5e6167SSubhransu S. Prusty 			int flags, unsigned int verb, unsigned int parm);
1491b5e6167SSubhransu S. Prusty int snd_hdac_codec_write(struct hdac_device *hdac, hda_nid_t nid,
1501b5e6167SSubhransu S. Prusty 			int flags, unsigned int verb, unsigned int parm);
1511b5e6167SSubhransu S. Prusty bool snd_hdac_check_power_state(struct hdac_device *hdac,
1521b5e6167SSubhransu S. Prusty 		hda_nid_t nid, unsigned int target_state);
15309787492SAbhijeet Kumar unsigned int snd_hdac_sync_power_state(struct hdac_device *hdac,
15409787492SAbhijeet Kumar 		      hda_nid_t nid, unsigned int target_state);
15501ed3c06STakashi Iwai /**
15601ed3c06STakashi Iwai  * snd_hdac_read_parm - read a codec parameter
15701ed3c06STakashi Iwai  * @codec: the codec object
15801ed3c06STakashi Iwai  * @nid: NID to read a parameter
15901ed3c06STakashi Iwai  * @parm: parameter to read
16001ed3c06STakashi Iwai  *
16101ed3c06STakashi Iwai  * Returns -1 for error.  If you need to distinguish the error more
16201ed3c06STakashi Iwai  * strictly, use _snd_hdac_read_parm() directly.
16301ed3c06STakashi Iwai  */
16401ed3c06STakashi Iwai static inline int snd_hdac_read_parm(struct hdac_device *codec, hda_nid_t nid,
16501ed3c06STakashi Iwai 				     int parm)
16601ed3c06STakashi Iwai {
16701ed3c06STakashi Iwai 	unsigned int val;
16801ed3c06STakashi Iwai 
16901ed3c06STakashi Iwai 	return _snd_hdac_read_parm(codec, nid, parm, &val) < 0 ? -1 : val;
17001ed3c06STakashi Iwai }
17101ed3c06STakashi Iwai 
1727639a06cSTakashi Iwai #ifdef CONFIG_PM
173fbce23a0STakashi Iwai int snd_hdac_power_up(struct hdac_device *codec);
174fbce23a0STakashi Iwai int snd_hdac_power_down(struct hdac_device *codec);
175fbce23a0STakashi Iwai int snd_hdac_power_up_pm(struct hdac_device *codec);
176fbce23a0STakashi Iwai int snd_hdac_power_down_pm(struct hdac_device *codec);
177fc4f000bSTakashi Iwai int snd_hdac_keep_power_up(struct hdac_device *codec);
178feb20faeSTakashi Iwai 
179feb20faeSTakashi Iwai /* call this at entering into suspend/resume callbacks in codec driver */
180feb20faeSTakashi Iwai static inline void snd_hdac_enter_pm(struct hdac_device *codec)
181feb20faeSTakashi Iwai {
182feb20faeSTakashi Iwai 	atomic_inc(&codec->in_pm);
183feb20faeSTakashi Iwai }
184feb20faeSTakashi Iwai 
185feb20faeSTakashi Iwai /* call this at leaving from suspend/resume callbacks in codec driver */
186feb20faeSTakashi Iwai static inline void snd_hdac_leave_pm(struct hdac_device *codec)
187feb20faeSTakashi Iwai {
188feb20faeSTakashi Iwai 	atomic_dec(&codec->in_pm);
189feb20faeSTakashi Iwai }
190feb20faeSTakashi Iwai 
191feb20faeSTakashi Iwai static inline bool snd_hdac_is_in_pm(struct hdac_device *codec)
192feb20faeSTakashi Iwai {
193feb20faeSTakashi Iwai 	return atomic_read(&codec->in_pm);
194feb20faeSTakashi Iwai }
195feb20faeSTakashi Iwai 
196feb20faeSTakashi Iwai static inline bool snd_hdac_is_power_on(struct hdac_device *codec)
197feb20faeSTakashi Iwai {
198feb20faeSTakashi Iwai 	return !pm_runtime_suspended(&codec->dev);
199feb20faeSTakashi Iwai }
2007639a06cSTakashi Iwai #else
201fbce23a0STakashi Iwai static inline int snd_hdac_power_up(struct hdac_device *codec) { return 0; }
202fbce23a0STakashi Iwai static inline int snd_hdac_power_down(struct hdac_device *codec) { return 0; }
203fbce23a0STakashi Iwai static inline int snd_hdac_power_up_pm(struct hdac_device *codec) { return 0; }
204fbce23a0STakashi Iwai static inline int snd_hdac_power_down_pm(struct hdac_device *codec) { return 0; }
205fc4f000bSTakashi Iwai static inline int snd_hdac_keep_power_up(struct hdac_device *codec) { return 0; }
206feb20faeSTakashi Iwai static inline void snd_hdac_enter_pm(struct hdac_device *codec) {}
207feb20faeSTakashi Iwai static inline void snd_hdac_leave_pm(struct hdac_device *codec) {}
208feb20faeSTakashi Iwai static inline bool snd_hdac_is_in_pm(struct hdac_device *codec) { return 0; }
209feb20faeSTakashi Iwai static inline bool snd_hdac_is_power_on(struct hdac_device *codec) { return 1; }
2107639a06cSTakashi Iwai #endif
2117639a06cSTakashi Iwai 
212e3d280fcSTakashi Iwai /*
213e3d280fcSTakashi Iwai  * HD-audio codec base driver
214e3d280fcSTakashi Iwai  */
215e3d280fcSTakashi Iwai struct hdac_driver {
216e3d280fcSTakashi Iwai 	struct device_driver driver;
217e3d280fcSTakashi Iwai 	int type;
218ec71efc9SVinod Koul 	const struct hda_device_id *id_table;
219e3d280fcSTakashi Iwai 	int (*match)(struct hdac_device *dev, struct hdac_driver *drv);
220d068ebc2STakashi Iwai 	void (*unsol_event)(struct hdac_device *dev, unsigned int event);
221e1df9317SRakesh Ughreja 
222e1df9317SRakesh Ughreja 	/* fields used by ext bus APIs */
223e1df9317SRakesh Ughreja 	int (*probe)(struct hdac_device *dev);
224e1df9317SRakesh Ughreja 	int (*remove)(struct hdac_device *dev);
225e1df9317SRakesh Ughreja 	void (*shutdown)(struct hdac_device *dev);
226e3d280fcSTakashi Iwai };
227e3d280fcSTakashi Iwai 
228e3d280fcSTakashi Iwai #define drv_to_hdac_driver(_drv) container_of(_drv, struct hdac_driver, driver)
229e3d280fcSTakashi Iwai 
230ec71efc9SVinod Koul const struct hda_device_id *
231ec71efc9SVinod Koul hdac_get_device_id(struct hdac_device *hdev, struct hdac_driver *drv);
232ec71efc9SVinod Koul 
233d068ebc2STakashi Iwai /*
23414752412STakashi Iwai  * Bus verb operators
235d068ebc2STakashi Iwai  */
236d068ebc2STakashi Iwai struct hdac_bus_ops {
237d068ebc2STakashi Iwai 	/* send a single command */
238d068ebc2STakashi Iwai 	int (*command)(struct hdac_bus *bus, unsigned int cmd);
239d068ebc2STakashi Iwai 	/* get a response from the last command */
240d068ebc2STakashi Iwai 	int (*get_response)(struct hdac_bus *bus, unsigned int addr,
241d068ebc2STakashi Iwai 			    unsigned int *res);
242d068ebc2STakashi Iwai };
243d068ebc2STakashi Iwai 
24414752412STakashi Iwai /*
245cb04ba33SRakesh Ughreja  * ops used for ASoC HDA codec drivers
246cb04ba33SRakesh Ughreja  */
247cb04ba33SRakesh Ughreja struct hdac_ext_bus_ops {
248cb04ba33SRakesh Ughreja 	int (*hdev_attach)(struct hdac_device *hdev);
249cb04ba33SRakesh Ughreja 	int (*hdev_detach)(struct hdac_device *hdev);
250cb04ba33SRakesh Ughreja };
251cb04ba33SRakesh Ughreja 
25214752412STakashi Iwai #define HDA_UNSOL_QUEUE_SIZE	64
25314752412STakashi Iwai #define HDA_MAX_CODECS		8	/* limit by controller side */
25414752412STakashi Iwai 
25514752412STakashi Iwai /*
25614752412STakashi Iwai  * CORB/RIRB
25714752412STakashi Iwai  *
25814752412STakashi Iwai  * Each CORB entry is 4byte, RIRB is 8byte
25914752412STakashi Iwai  */
26014752412STakashi Iwai struct hdac_rb {
26114752412STakashi Iwai 	__le32 *buf;		/* virtual address of CORB/RIRB buffer */
26214752412STakashi Iwai 	dma_addr_t addr;	/* physical address of CORB/RIRB buffer */
26314752412STakashi Iwai 	unsigned short rp, wp;	/* RIRB read/write pointers */
26414752412STakashi Iwai 	int cmds[HDA_MAX_CODECS];	/* number of pending requests */
26514752412STakashi Iwai 	u32 res[HDA_MAX_CODECS];	/* last read value */
26614752412STakashi Iwai };
26714752412STakashi Iwai 
26814752412STakashi Iwai /*
26914752412STakashi Iwai  * HD-audio bus base driver
2706720b384SVinod Koul  *
2716720b384SVinod Koul  * @ppcap: pp capabilities pointer
2726720b384SVinod Koul  * @spbcap: SPIB capabilities pointer
2736720b384SVinod Koul  * @mlcap: MultiLink capabilities pointer
2746720b384SVinod Koul  * @gtscap: gts capabilities pointer
2756720b384SVinod Koul  * @drsmcap: dma resume capabilities pointer
27676f56faeSRakesh Ughreja  * @num_streams: streams supported
27776f56faeSRakesh Ughreja  * @idx: HDA link index
27876f56faeSRakesh Ughreja  * @hlink_list: link list of HDA links
279e61ab9f0STakashi Iwai  * @lock: lock for link and display power mgmt
28076f56faeSRakesh Ughreja  * @cmd_dma_state: state of cmd DMAs: CORB and RIRB
28114752412STakashi Iwai  */
282d068ebc2STakashi Iwai struct hdac_bus {
283d068ebc2STakashi Iwai 	struct device *dev;
284d068ebc2STakashi Iwai 	const struct hdac_bus_ops *ops;
285cb04ba33SRakesh Ughreja 	const struct hdac_ext_bus_ops *ext_ops;
28614752412STakashi Iwai 
28714752412STakashi Iwai 	/* h/w resources */
28814752412STakashi Iwai 	unsigned long addr;
28914752412STakashi Iwai 	void __iomem *remap_addr;
29014752412STakashi Iwai 	int irq;
291d068ebc2STakashi Iwai 
2926720b384SVinod Koul 	void __iomem *ppcap;
2936720b384SVinod Koul 	void __iomem *spbcap;
2946720b384SVinod Koul 	void __iomem *mlcap;
2956720b384SVinod Koul 	void __iomem *gtscap;
2966720b384SVinod Koul 	void __iomem *drsmcap;
2976720b384SVinod Koul 
298d068ebc2STakashi Iwai 	/* codec linked list */
299d068ebc2STakashi Iwai 	struct list_head codec_list;
300d068ebc2STakashi Iwai 	unsigned int num_codecs;
301d068ebc2STakashi Iwai 
302d068ebc2STakashi Iwai 	/* link caddr -> codec */
303d068ebc2STakashi Iwai 	struct hdac_device *caddr_tbl[HDA_MAX_CODEC_ADDRESS + 1];
304d068ebc2STakashi Iwai 
305d068ebc2STakashi Iwai 	/* unsolicited event queue */
306d068ebc2STakashi Iwai 	u32 unsol_queue[HDA_UNSOL_QUEUE_SIZE * 2]; /* ring buffer */
307d068ebc2STakashi Iwai 	unsigned int unsol_rp, unsol_wp;
308d068ebc2STakashi Iwai 	struct work_struct unsol_work;
309d068ebc2STakashi Iwai 
31014752412STakashi Iwai 	/* bit flags of detected codecs */
31114752412STakashi Iwai 	unsigned long codec_mask;
31214752412STakashi Iwai 
313d068ebc2STakashi Iwai 	/* bit flags of powered codecs */
314d068ebc2STakashi Iwai 	unsigned long codec_powered;
315d068ebc2STakashi Iwai 
31614752412STakashi Iwai 	/* CORB/RIRB */
31714752412STakashi Iwai 	struct hdac_rb corb;
31814752412STakashi Iwai 	struct hdac_rb rirb;
31914752412STakashi Iwai 	unsigned int last_cmd[HDA_MAX_CODECS];	/* last sent command */
32088452da9STakashi Iwai 	wait_queue_head_t rirb_wq;
32114752412STakashi Iwai 
32214752412STakashi Iwai 	/* CORB/RIRB and position buffers */
32314752412STakashi Iwai 	struct snd_dma_buffer rb;
32414752412STakashi Iwai 	struct snd_dma_buffer posbuf;
325619a1f19STakashi Iwai 	int dma_type;			/* SNDRV_DMA_TYPE_XXX for CORB/RIRB */
32614752412STakashi Iwai 
32714752412STakashi Iwai 	/* hdac_stream linked list */
32814752412STakashi Iwai 	struct list_head stream_list;
32914752412STakashi Iwai 
33014752412STakashi Iwai 	/* operation state */
33114752412STakashi Iwai 	bool chip_init:1;		/* h/w initialized */
33214752412STakashi Iwai 
33314752412STakashi Iwai 	/* behavior flags */
334d068ebc2STakashi Iwai 	bool sync_write:1;		/* sync after verb write */
33514752412STakashi Iwai 	bool use_posbuf:1;		/* use position buffer */
33614752412STakashi Iwai 	bool snoop:1;			/* enable snooping */
33714752412STakashi Iwai 	bool align_bdle_4k:1;		/* BDLE align 4K boundary */
33814752412STakashi Iwai 	bool reverse_assign:1;		/* assign devices in reverse order */
33914752412STakashi Iwai 	bool corbrp_self_clear:1;	/* CORBRP clears itself after reset */
3408af42130SBard Liao 	bool polling_mode:1;
3418af42130SBard Liao 
3428af42130SBard Liao 	int poll_count;
34314752412STakashi Iwai 
34414752412STakashi Iwai 	int bdl_pos_adj;		/* BDL position adjustment */
345d068ebc2STakashi Iwai 
346d068ebc2STakashi Iwai 	/* locks */
34714752412STakashi Iwai 	spinlock_t reg_lock;
348d068ebc2STakashi Iwai 	struct mutex cmd_mutex;
349e61ab9f0STakashi Iwai 	struct mutex lock;
35098d8fc6cSMengdong Lin 
351ae891abeSTakashi Iwai 	/* DRM component interface */
352ae891abeSTakashi Iwai 	struct drm_audio_component *audio_component;
353029d92c2STakashi Iwai 	long display_power_status;
354d31c85fcSChris Wilson 	unsigned long display_power_active;
35576f56faeSRakesh Ughreja 
35676f56faeSRakesh Ughreja 	/* parameters required for enhanced capabilities */
35776f56faeSRakesh Ughreja 	int num_streams;
35876f56faeSRakesh Ughreja 	int idx;
35976f56faeSRakesh Ughreja 
360e61ab9f0STakashi Iwai 	/* link management */
36176f56faeSRakesh Ughreja 	struct list_head hlink_list;
36276f56faeSRakesh Ughreja 	bool cmd_dma_state;
363d068ebc2STakashi Iwai };
364d068ebc2STakashi Iwai 
365d068ebc2STakashi Iwai int snd_hdac_bus_init(struct hdac_bus *bus, struct device *dev,
36619abfefdSTakashi Iwai 		      const struct hdac_bus_ops *ops);
367d068ebc2STakashi Iwai void snd_hdac_bus_exit(struct hdac_bus *bus);
368d068ebc2STakashi Iwai int snd_hdac_bus_exec_verb(struct hdac_bus *bus, unsigned int addr,
369d068ebc2STakashi Iwai 			   unsigned int cmd, unsigned int *res);
370d068ebc2STakashi Iwai int snd_hdac_bus_exec_verb_unlocked(struct hdac_bus *bus, unsigned int addr,
371d068ebc2STakashi Iwai 				    unsigned int cmd, unsigned int *res);
372d068ebc2STakashi Iwai void snd_hdac_bus_queue_event(struct hdac_bus *bus, u32 res, u32 res_ex);
373d068ebc2STakashi Iwai 
3747639a06cSTakashi Iwai static inline void snd_hdac_codec_link_up(struct hdac_device *codec)
3757639a06cSTakashi Iwai {
3767639a06cSTakashi Iwai 	set_bit(codec->addr, &codec->bus->codec_powered);
3777639a06cSTakashi Iwai }
3787639a06cSTakashi Iwai 
3797639a06cSTakashi Iwai static inline void snd_hdac_codec_link_down(struct hdac_device *codec)
3807639a06cSTakashi Iwai {
3817639a06cSTakashi Iwai 	clear_bit(codec->addr, &codec->bus->codec_powered);
3827639a06cSTakashi Iwai }
3837639a06cSTakashi Iwai 
38414752412STakashi Iwai int snd_hdac_bus_send_cmd(struct hdac_bus *bus, unsigned int val);
38514752412STakashi Iwai int snd_hdac_bus_get_response(struct hdac_bus *bus, unsigned int addr,
38614752412STakashi Iwai 			      unsigned int *res);
3876720b384SVinod Koul int snd_hdac_bus_parse_capabilities(struct hdac_bus *bus);
38814752412STakashi Iwai 
38914752412STakashi Iwai bool snd_hdac_bus_init_chip(struct hdac_bus *bus, bool full_reset);
39014752412STakashi Iwai void snd_hdac_bus_stop_chip(struct hdac_bus *bus);
39114752412STakashi Iwai void snd_hdac_bus_init_cmd_io(struct hdac_bus *bus);
39214752412STakashi Iwai void snd_hdac_bus_stop_cmd_io(struct hdac_bus *bus);
39314752412STakashi Iwai void snd_hdac_bus_enter_link_reset(struct hdac_bus *bus);
39414752412STakashi Iwai void snd_hdac_bus_exit_link_reset(struct hdac_bus *bus);
39575383f8dSYu Zhao int snd_hdac_bus_reset_link(struct hdac_bus *bus, bool full_reset);
39614752412STakashi Iwai 
39714752412STakashi Iwai void snd_hdac_bus_update_rirb(struct hdac_bus *bus);
398473f4145STakashi Iwai int snd_hdac_bus_handle_stream_irq(struct hdac_bus *bus, unsigned int status,
39914752412STakashi Iwai 				    void (*ack)(struct hdac_bus *,
40014752412STakashi Iwai 						struct hdac_stream *));
40114752412STakashi Iwai 
402304dad30SJeeja KP int snd_hdac_bus_alloc_stream_pages(struct hdac_bus *bus);
403304dad30SJeeja KP void snd_hdac_bus_free_stream_pages(struct hdac_bus *bus);
404304dad30SJeeja KP 
40519abfefdSTakashi Iwai #ifdef CONFIG_SND_HDA_ALIGNED_MMIO
40619abfefdSTakashi Iwai unsigned int snd_hdac_aligned_read(void __iomem *addr, unsigned int mask);
40719abfefdSTakashi Iwai void snd_hdac_aligned_write(unsigned int val, void __iomem *addr,
40819abfefdSTakashi Iwai 			    unsigned int mask);
40919abfefdSTakashi Iwai #define snd_hdac_reg_writeb(v, addr)	snd_hdac_aligned_write(v, addr, 0xff)
41019abfefdSTakashi Iwai #define snd_hdac_reg_writew(v, addr)	snd_hdac_aligned_write(v, addr, 0xffff)
41119abfefdSTakashi Iwai #define snd_hdac_reg_readb(addr)	snd_hdac_aligned_read(addr, 0xff)
41219abfefdSTakashi Iwai #define snd_hdac_reg_readw(addr)	snd_hdac_aligned_read(addr, 0xffff)
41319abfefdSTakashi Iwai #else /* CONFIG_SND_HDA_ALIGNED_MMIO */
41419abfefdSTakashi Iwai #define snd_hdac_reg_writeb(val, addr)	writeb(val, addr)
41519abfefdSTakashi Iwai #define snd_hdac_reg_writew(val, addr)	writew(val, addr)
41619abfefdSTakashi Iwai #define snd_hdac_reg_readb(addr)	readb(addr)
41719abfefdSTakashi Iwai #define snd_hdac_reg_readw(addr)	readw(addr)
41819abfefdSTakashi Iwai #endif /* CONFIG_SND_HDA_ALIGNED_MMIO */
41919abfefdSTakashi Iwai #define snd_hdac_reg_writel(val, addr)	writel(val, addr)
42019abfefdSTakashi Iwai #define snd_hdac_reg_readl(addr)	readl(addr)
42119abfefdSTakashi Iwai 
42214752412STakashi Iwai /*
42314752412STakashi Iwai  * macros for easy use
42414752412STakashi Iwai  */
4252c1f8138STakashi Iwai #define _snd_hdac_chip_writeb(chip, reg, value) \
42619abfefdSTakashi Iwai 	snd_hdac_reg_writeb(value, (chip)->remap_addr + (reg))
4272c1f8138STakashi Iwai #define _snd_hdac_chip_readb(chip, reg) \
42819abfefdSTakashi Iwai 	snd_hdac_reg_readb((chip)->remap_addr + (reg))
4292c1f8138STakashi Iwai #define _snd_hdac_chip_writew(chip, reg, value) \
43019abfefdSTakashi Iwai 	snd_hdac_reg_writew(value, (chip)->remap_addr + (reg))
4312c1f8138STakashi Iwai #define _snd_hdac_chip_readw(chip, reg) \
43219abfefdSTakashi Iwai 	snd_hdac_reg_readw((chip)->remap_addr + (reg))
4332c1f8138STakashi Iwai #define _snd_hdac_chip_writel(chip, reg, value) \
43419abfefdSTakashi Iwai 	snd_hdac_reg_writel(value, (chip)->remap_addr + (reg))
4352c1f8138STakashi Iwai #define _snd_hdac_chip_readl(chip, reg) \
43619abfefdSTakashi Iwai 	snd_hdac_reg_readl((chip)->remap_addr + (reg))
43714752412STakashi Iwai 
43814752412STakashi Iwai /* read/write a register, pass without AZX_REG_ prefix */
43914752412STakashi Iwai #define snd_hdac_chip_writel(chip, reg, value) \
4402c1f8138STakashi Iwai 	_snd_hdac_chip_writel(chip, AZX_REG_ ## reg, value)
44114752412STakashi Iwai #define snd_hdac_chip_writew(chip, reg, value) \
4422c1f8138STakashi Iwai 	_snd_hdac_chip_writew(chip, AZX_REG_ ## reg, value)
44314752412STakashi Iwai #define snd_hdac_chip_writeb(chip, reg, value) \
4442c1f8138STakashi Iwai 	_snd_hdac_chip_writeb(chip, AZX_REG_ ## reg, value)
44514752412STakashi Iwai #define snd_hdac_chip_readl(chip, reg) \
4462c1f8138STakashi Iwai 	_snd_hdac_chip_readl(chip, AZX_REG_ ## reg)
44714752412STakashi Iwai #define snd_hdac_chip_readw(chip, reg) \
4482c1f8138STakashi Iwai 	_snd_hdac_chip_readw(chip, AZX_REG_ ## reg)
44914752412STakashi Iwai #define snd_hdac_chip_readb(chip, reg) \
4502c1f8138STakashi Iwai 	_snd_hdac_chip_readb(chip, AZX_REG_ ## reg)
45114752412STakashi Iwai 
45214752412STakashi Iwai /* update a register, pass without AZX_REG_ prefix */
45314752412STakashi Iwai #define snd_hdac_chip_updatel(chip, reg, mask, val) \
45414752412STakashi Iwai 	snd_hdac_chip_writel(chip, reg, \
45514752412STakashi Iwai 			     (snd_hdac_chip_readl(chip, reg) & ~(mask)) | (val))
45614752412STakashi Iwai #define snd_hdac_chip_updatew(chip, reg, mask, val) \
45714752412STakashi Iwai 	snd_hdac_chip_writew(chip, reg, \
45814752412STakashi Iwai 			     (snd_hdac_chip_readw(chip, reg) & ~(mask)) | (val))
45914752412STakashi Iwai #define snd_hdac_chip_updateb(chip, reg, mask, val) \
46014752412STakashi Iwai 	snd_hdac_chip_writeb(chip, reg, \
46114752412STakashi Iwai 			     (snd_hdac_chip_readb(chip, reg) & ~(mask)) | (val))
46214752412STakashi Iwai 
46314752412STakashi Iwai /*
46414752412STakashi Iwai  * HD-audio stream
46514752412STakashi Iwai  */
46614752412STakashi Iwai struct hdac_stream {
46714752412STakashi Iwai 	struct hdac_bus *bus;
46814752412STakashi Iwai 	struct snd_dma_buffer bdl; /* BDL buffer */
46914752412STakashi Iwai 	__le32 *posbuf;		/* position buffer pointer */
47014752412STakashi Iwai 	int direction;		/* playback / capture (SNDRV_PCM_STREAM_*) */
47114752412STakashi Iwai 
47214752412STakashi Iwai 	unsigned int bufsize;	/* size of the play buffer in bytes */
47314752412STakashi Iwai 	unsigned int period_bytes; /* size of the period in bytes */
47414752412STakashi Iwai 	unsigned int frags;	/* number for period in the play buffer */
47514752412STakashi Iwai 	unsigned int fifo_size;	/* FIFO size */
47614752412STakashi Iwai 
47714752412STakashi Iwai 	void __iomem *sd_addr;	/* stream descriptor pointer */
47814752412STakashi Iwai 
47914752412STakashi Iwai 	u32 sd_int_sta_mask;	/* stream int status mask */
48014752412STakashi Iwai 
48114752412STakashi Iwai 	/* pcm support */
48214752412STakashi Iwai 	struct snd_pcm_substream *substream;	/* assigned substream,
48314752412STakashi Iwai 						 * set in PCM open
48414752412STakashi Iwai 						 */
48514752412STakashi Iwai 	unsigned int format_val;	/* format value to be set in the
48614752412STakashi Iwai 					 * controller and the codec
48714752412STakashi Iwai 					 */
48814752412STakashi Iwai 	unsigned char stream_tag;	/* assigned stream */
48914752412STakashi Iwai 	unsigned char index;		/* stream index */
49014752412STakashi Iwai 	int assigned_key;		/* last device# key assigned to */
49114752412STakashi Iwai 
49214752412STakashi Iwai 	bool opened:1;
49314752412STakashi Iwai 	bool running:1;
4946d23c8f5STakashi Iwai 	bool prepared:1;
49514752412STakashi Iwai 	bool no_period_wakeup:1;
4968f3f600bSTakashi Iwai 	bool locked:1;
497e38e486dSTakashi Iwai 	bool stripe:1;			/* apply stripe control */
49814752412STakashi Iwai 
49914752412STakashi Iwai 	/* timestamp */
50014752412STakashi Iwai 	unsigned long start_wallclk;	/* start + minimum wallclk */
50114752412STakashi Iwai 	unsigned long period_wallclk;	/* wallclk for period */
50214752412STakashi Iwai 	struct timecounter  tc;
50314752412STakashi Iwai 	struct cyclecounter cc;
50414752412STakashi Iwai 	int delay_negative_threshold;
50514752412STakashi Iwai 
50614752412STakashi Iwai 	struct list_head list;
5078f3f600bSTakashi Iwai #ifdef CONFIG_SND_HDA_DSP_LOADER
5088f3f600bSTakashi Iwai 	/* DSP access mutex */
5098f3f600bSTakashi Iwai 	struct mutex dsp_mutex;
5108f3f600bSTakashi Iwai #endif
51114752412STakashi Iwai };
51214752412STakashi Iwai 
51314752412STakashi Iwai void snd_hdac_stream_init(struct hdac_bus *bus, struct hdac_stream *azx_dev,
51414752412STakashi Iwai 			  int idx, int direction, int tag);
51514752412STakashi Iwai struct hdac_stream *snd_hdac_stream_assign(struct hdac_bus *bus,
51614752412STakashi Iwai 					   struct snd_pcm_substream *substream);
51714752412STakashi Iwai void snd_hdac_stream_release(struct hdac_stream *azx_dev);
5184308c9b0SJeeja KP struct hdac_stream *snd_hdac_get_stream(struct hdac_bus *bus,
5194308c9b0SJeeja KP 					int dir, int stream_tag);
52014752412STakashi Iwai 
52114752412STakashi Iwai int snd_hdac_stream_setup(struct hdac_stream *azx_dev);
52214752412STakashi Iwai void snd_hdac_stream_cleanup(struct hdac_stream *azx_dev);
52314752412STakashi Iwai int snd_hdac_stream_setup_periods(struct hdac_stream *azx_dev);
52486f6501bSJeeja KP int snd_hdac_stream_set_params(struct hdac_stream *azx_dev,
52586f6501bSJeeja KP 				unsigned int format_val);
52614752412STakashi Iwai void snd_hdac_stream_start(struct hdac_stream *azx_dev, bool fresh_start);
52714752412STakashi Iwai void snd_hdac_stream_clear(struct hdac_stream *azx_dev);
52814752412STakashi Iwai void snd_hdac_stream_stop(struct hdac_stream *azx_dev);
52914752412STakashi Iwai void snd_hdac_stream_reset(struct hdac_stream *azx_dev);
53014752412STakashi Iwai void snd_hdac_stream_sync_trigger(struct hdac_stream *azx_dev, bool set,
53114752412STakashi Iwai 				  unsigned int streams, unsigned int reg);
53214752412STakashi Iwai void snd_hdac_stream_sync(struct hdac_stream *azx_dev, bool start,
53314752412STakashi Iwai 			  unsigned int streams);
53414752412STakashi Iwai void snd_hdac_stream_timecounter_init(struct hdac_stream *azx_dev,
53514752412STakashi Iwai 				      unsigned int streams);
5365dd3d271SSameer Pujar int snd_hdac_get_stream_stripe_ctl(struct hdac_bus *bus,
5375dd3d271SSameer Pujar 				struct snd_pcm_substream *substream);
5385dd3d271SSameer Pujar 
53914752412STakashi Iwai /*
54014752412STakashi Iwai  * macros for easy use
54114752412STakashi Iwai  */
54214752412STakashi Iwai /* read/write a register, pass without AZX_REG_ prefix */
54314752412STakashi Iwai #define snd_hdac_stream_writel(dev, reg, value) \
54419abfefdSTakashi Iwai 	snd_hdac_reg_writel(value, (dev)->sd_addr + AZX_REG_ ## reg)
54514752412STakashi Iwai #define snd_hdac_stream_writew(dev, reg, value) \
54619abfefdSTakashi Iwai 	snd_hdac_reg_writew(value, (dev)->sd_addr + AZX_REG_ ## reg)
54714752412STakashi Iwai #define snd_hdac_stream_writeb(dev, reg, value) \
54819abfefdSTakashi Iwai 	snd_hdac_reg_writeb(value, (dev)->sd_addr + AZX_REG_ ## reg)
54914752412STakashi Iwai #define snd_hdac_stream_readl(dev, reg) \
55019abfefdSTakashi Iwai 	snd_hdac_reg_readl((dev)->sd_addr + AZX_REG_ ## reg)
55114752412STakashi Iwai #define snd_hdac_stream_readw(dev, reg) \
55219abfefdSTakashi Iwai 	snd_hdac_reg_readw((dev)->sd_addr + AZX_REG_ ## reg)
55314752412STakashi Iwai #define snd_hdac_stream_readb(dev, reg) \
55419abfefdSTakashi Iwai 	snd_hdac_reg_readb((dev)->sd_addr + AZX_REG_ ## reg)
55514752412STakashi Iwai 
55614752412STakashi Iwai /* update a register, pass without AZX_REG_ prefix */
55714752412STakashi Iwai #define snd_hdac_stream_updatel(dev, reg, mask, val) \
55814752412STakashi Iwai 	snd_hdac_stream_writel(dev, reg, \
55914752412STakashi Iwai 			       (snd_hdac_stream_readl(dev, reg) & \
56014752412STakashi Iwai 				~(mask)) | (val))
56114752412STakashi Iwai #define snd_hdac_stream_updatew(dev, reg, mask, val) \
56214752412STakashi Iwai 	snd_hdac_stream_writew(dev, reg, \
56314752412STakashi Iwai 			       (snd_hdac_stream_readw(dev, reg) & \
56414752412STakashi Iwai 				~(mask)) | (val))
56514752412STakashi Iwai #define snd_hdac_stream_updateb(dev, reg, mask, val) \
56614752412STakashi Iwai 	snd_hdac_stream_writeb(dev, reg, \
56714752412STakashi Iwai 			       (snd_hdac_stream_readb(dev, reg) & \
56814752412STakashi Iwai 				~(mask)) | (val))
56914752412STakashi Iwai 
5708f3f600bSTakashi Iwai #ifdef CONFIG_SND_HDA_DSP_LOADER
5718f3f600bSTakashi Iwai /* DSP lock helpers */
5728f3f600bSTakashi Iwai #define snd_hdac_dsp_lock_init(dev)	mutex_init(&(dev)->dsp_mutex)
5738f3f600bSTakashi Iwai #define snd_hdac_dsp_lock(dev)		mutex_lock(&(dev)->dsp_mutex)
5748f3f600bSTakashi Iwai #define snd_hdac_dsp_unlock(dev)	mutex_unlock(&(dev)->dsp_mutex)
5758f3f600bSTakashi Iwai #define snd_hdac_stream_is_locked(dev)	((dev)->locked)
5768f3f600bSTakashi Iwai /* DSP loader helpers */
5778f3f600bSTakashi Iwai int snd_hdac_dsp_prepare(struct hdac_stream *azx_dev, unsigned int format,
5788f3f600bSTakashi Iwai 			 unsigned int byte_size, struct snd_dma_buffer *bufp);
5798f3f600bSTakashi Iwai void snd_hdac_dsp_trigger(struct hdac_stream *azx_dev, bool start);
5808f3f600bSTakashi Iwai void snd_hdac_dsp_cleanup(struct hdac_stream *azx_dev,
5818f3f600bSTakashi Iwai 			  struct snd_dma_buffer *dmab);
5828f3f600bSTakashi Iwai #else /* CONFIG_SND_HDA_DSP_LOADER */
5838f3f600bSTakashi Iwai #define snd_hdac_dsp_lock_init(dev)	do {} while (0)
5848f3f600bSTakashi Iwai #define snd_hdac_dsp_lock(dev)		do {} while (0)
5858f3f600bSTakashi Iwai #define snd_hdac_dsp_unlock(dev)	do {} while (0)
5868f3f600bSTakashi Iwai #define snd_hdac_stream_is_locked(dev)	0
5878f3f600bSTakashi Iwai 
5888f3f600bSTakashi Iwai static inline int
5898f3f600bSTakashi Iwai snd_hdac_dsp_prepare(struct hdac_stream *azx_dev, unsigned int format,
5908f3f600bSTakashi Iwai 		     unsigned int byte_size, struct snd_dma_buffer *bufp)
5918f3f600bSTakashi Iwai {
5928f3f600bSTakashi Iwai 	return 0;
5938f3f600bSTakashi Iwai }
5948f3f600bSTakashi Iwai 
5958f3f600bSTakashi Iwai static inline void snd_hdac_dsp_trigger(struct hdac_stream *azx_dev, bool start)
5968f3f600bSTakashi Iwai {
5978f3f600bSTakashi Iwai }
5988f3f600bSTakashi Iwai 
5998f3f600bSTakashi Iwai static inline void snd_hdac_dsp_cleanup(struct hdac_stream *azx_dev,
6008f3f600bSTakashi Iwai 					struct snd_dma_buffer *dmab)
6018f3f600bSTakashi Iwai {
6028f3f600bSTakashi Iwai }
6038f3f600bSTakashi Iwai #endif /* CONFIG_SND_HDA_DSP_LOADER */
6048f3f600bSTakashi Iwai 
6058f3f600bSTakashi Iwai 
60671fc4c7eSTakashi Iwai /*
60771fc4c7eSTakashi Iwai  * generic array helpers
60871fc4c7eSTakashi Iwai  */
60971fc4c7eSTakashi Iwai void *snd_array_new(struct snd_array *array);
61071fc4c7eSTakashi Iwai void snd_array_free(struct snd_array *array);
61171fc4c7eSTakashi Iwai static inline void snd_array_init(struct snd_array *array, unsigned int size,
61271fc4c7eSTakashi Iwai 				  unsigned int align)
61371fc4c7eSTakashi Iwai {
61471fc4c7eSTakashi Iwai 	array->elem_size = size;
61571fc4c7eSTakashi Iwai 	array->alloc_align = align;
61671fc4c7eSTakashi Iwai }
61771fc4c7eSTakashi Iwai 
61871fc4c7eSTakashi Iwai static inline void *snd_array_elem(struct snd_array *array, unsigned int idx)
61971fc4c7eSTakashi Iwai {
62071fc4c7eSTakashi Iwai 	return array->list + idx * array->elem_size;
62171fc4c7eSTakashi Iwai }
62271fc4c7eSTakashi Iwai 
62371fc4c7eSTakashi Iwai static inline unsigned int snd_array_index(struct snd_array *array, void *ptr)
62471fc4c7eSTakashi Iwai {
62571fc4c7eSTakashi Iwai 	return (unsigned long)(ptr - array->list) / array->elem_size;
62671fc4c7eSTakashi Iwai }
62771fc4c7eSTakashi Iwai 
628a9c2dfc8STakashi Iwai /* a helper macro to iterate for each snd_array element */
629a9c2dfc8STakashi Iwai #define snd_array_for_each(array, idx, ptr) \
630a9c2dfc8STakashi Iwai 	for ((idx) = 0, (ptr) = (array)->list; (idx) < (array)->used; \
631a9c2dfc8STakashi Iwai 	     (ptr) = snd_array_elem(array, ++(idx)))
632a9c2dfc8STakashi Iwai 
633e3d280fcSTakashi Iwai #endif /* __SOUND_HDAUDIO_H */
634