[linux-block.git] / include / sound / hdaudio_ext.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef __SOUND_HDAUDIO_EXT_H
#define __SOUND_HDAUDIO_EXT_H

#include <linux/io-64-nonatomic-lo-hi.h>
#include <linux/iopoll.h>
#include <sound/hdaudio.h>

int snd_hdac_ext_bus_init(struct hdac_bus *bus, struct device *dev,
		      const struct hdac_bus_ops *ops,
		      const struct hdac_ext_bus_ops *ext_ops);

void snd_hdac_ext_bus_exit(struct hdac_bus *bus);
int snd_hdac_ext_bus_device_init(struct hdac_bus *bus, int addr,
				struct hdac_device *hdev, int type);
void snd_hdac_ext_bus_device_exit(struct hdac_device *hdev);
void snd_hdac_ext_bus_device_remove(struct hdac_bus *bus);

#define HDA_CODEC_REV_EXT_ENTRY(_vid, _rev, _name, drv_data) \
	{ .vendor_id = (_vid), .rev_id = (_rev), .name = (_name), \
	  .api_version = HDA_DEV_ASOC, \
	  .driver_data = (unsigned long)(drv_data) }
#define HDA_CODEC_EXT_ENTRY(_vid, _revid, _name, _drv_data) \
	HDA_CODEC_REV_EXT_ENTRY(_vid, _revid, _name, _drv_data)

void snd_hdac_ext_bus_ppcap_enable(struct hdac_bus *chip, bool enable);
void snd_hdac_ext_bus_ppcap_int_enable(struct hdac_bus *chip, bool enable);

void snd_hdac_ext_stream_spbcap_enable(struct hdac_bus *chip,
				 bool enable, int index);

int snd_hdac_ext_bus_get_ml_capabilities(struct hdac_bus *bus);
struct hdac_ext_link *snd_hdac_ext_bus_link_at(struct hdac_bus *bus, int addr);
struct hdac_ext_link *snd_hdac_ext_bus_get_link(struct hdac_bus *bus,
						const char *codec_name);

enum hdac_ext_stream_type {
	HDAC_EXT_STREAM_TYPE_COUPLED = 0,
	HDAC_EXT_STREAM_TYPE_HOST,
	HDAC_EXT_STREAM_TYPE_LINK
};

/**
 * hdac_ext_stream: HDAC extended stream for extended HDA caps
 *
 * @hstream: hdac_stream
 * @pphc_addr: processing pipe host stream pointer
 * @pplc_addr: processing pipe link stream pointer
 * @spib_addr: software position in buffers stream pointer
 * @fifo_addr: software position Max fifos stream pointer
 * @dpibr_addr: DMA position in buffer resume pointer
 * @dpib: DMA position in buffer
 * @lpib: Linear position in buffer
 * @decoupled: stream host and link is decoupled
 * @link_locked: link is locked
 * @link_prepared: link is prepared
 * @link_substream: link substream
 */
struct hdac_ext_stream {
	struct hdac_stream hstream;

	void __iomem *pphc_addr;
	void __iomem *pplc_addr;

	void __iomem *spib_addr;
	void __iomem *fifo_addr;

	void __iomem *dpibr_addr;

	u32 dpib;
	u32 lpib;
	bool decoupled:1;
	bool link_locked:1;
	bool link_prepared;

	struct snd_pcm_substream *link_substream;
};

#define hdac_stream(s)		(&(s)->hstream)
#define stream_to_hdac_ext_stream(s) \
	container_of(s, struct hdac_ext_stream, hstream)

void snd_hdac_ext_stream_init(struct hdac_bus *bus,
			      struct hdac_ext_stream *hext_stream, int idx,
			      int direction, int tag);
int snd_hdac_ext_stream_init_all(struct hdac_bus *bus, int start_idx,
				 int num_stream, int dir);
void snd_hdac_stream_free_all(struct hdac_bus *bus);
void snd_hdac_link_free_all(struct hdac_bus *bus);
struct hdac_ext_stream *snd_hdac_ext_stream_assign(struct hdac_bus *bus,
					   struct snd_pcm_substream *substream,
					   int type);
void snd_hdac_ext_stream_release(struct hdac_ext_stream *hext_stream, int type);
void snd_hdac_ext_stream_decouple_locked(struct hdac_bus *bus,
					 struct hdac_ext_stream *hext_stream, bool decouple);
void snd_hdac_ext_stream_decouple(struct hdac_bus *bus,
				struct hdac_ext_stream *azx_dev, bool decouple);

int snd_hdac_ext_stream_set_spib(struct hdac_bus *bus,
				 struct hdac_ext_stream *hext_stream, u32 value);
int snd_hdac_ext_stream_get_spbmaxfifo(struct hdac_bus *bus,
				       struct hdac_ext_stream *hext_stream);
void snd_hdac_ext_stream_drsm_enable(struct hdac_bus *bus,
				bool enable, int index);
int snd_hdac_ext_stream_set_dpibr(struct hdac_bus *bus,
				struct hdac_ext_stream *hext_stream, u32 value);
int snd_hdac_ext_stream_set_lpib(struct hdac_ext_stream *hext_stream, u32 value);

void snd_hdac_ext_link_stream_start(struct hdac_ext_stream *hext_stream);
void snd_hdac_ext_link_stream_clear(struct hdac_ext_stream *hext_stream);
void snd_hdac_ext_link_stream_reset(struct hdac_ext_stream *hext_stream);
int snd_hdac_ext_link_stream_setup(struct hdac_ext_stream *hext_stream, int fmt);

struct hdac_ext_link {
	struct hdac_bus *bus;
	int index;
	void __iomem *ml_addr; /* link output stream reg pointer */
	u32 lcaps;   /* link capablities */
	u16 lsdiid;  /* link sdi identifier */

	int ref_count;

	struct list_head list;
};

int snd_hdac_ext_bus_link_power_up(struct hdac_ext_link *link);
int snd_hdac_ext_bus_link_power_down(struct hdac_ext_link *link);
int snd_hdac_ext_bus_link_power_up_all(struct hdac_bus *bus);
int snd_hdac_ext_bus_link_power_down_all(struct hdac_bus *bus);
void snd_hdac_ext_link_set_stream_id(struct hdac_ext_link *link,
				 int stream);
void snd_hdac_ext_link_clear_stream_id(struct hdac_ext_link *link,
				 int stream);

int snd_hdac_ext_bus_link_get(struct hdac_bus *bus, struct hdac_ext_link *link);
int snd_hdac_ext_bus_link_put(struct hdac_bus *bus, struct hdac_ext_link *link);

void snd_hdac_ext_bus_link_power(struct hdac_device *codec, bool enable);

/* update register macro */
#define snd_hdac_updatel(addr, reg, mask, val)		\
	writel(((readl(addr + reg) & ~(mask)) | (val)), \
		addr + reg)

#define snd_hdac_updatew(addr, reg, mask, val)		\
	writew(((readw(addr + reg) & ~(mask)) | (val)), \
		addr + reg)

#define snd_hdac_adsp_writeb(chip, reg, value) \
	snd_hdac_reg_writeb(chip, (chip)->dsp_ba + (reg), value)
#define snd_hdac_adsp_readb(chip, reg) \
	snd_hdac_reg_readb(chip, (chip)->dsp_ba + (reg))
#define snd_hdac_adsp_writew(chip, reg, value) \
	snd_hdac_reg_writew(chip, (chip)->dsp_ba + (reg), value)
#define snd_hdac_adsp_readw(chip, reg) \
	snd_hdac_reg_readw(chip, (chip)->dsp_ba + (reg))
#define snd_hdac_adsp_writel(chip, reg, value) \
	snd_hdac_reg_writel(chip, (chip)->dsp_ba + (reg), value)
#define snd_hdac_adsp_readl(chip, reg) \
	snd_hdac_reg_readl(chip, (chip)->dsp_ba + (reg))
#define snd_hdac_adsp_writeq(chip, reg, value) \
	snd_hdac_reg_writeq(chip, (chip)->dsp_ba + (reg), value)
#define snd_hdac_adsp_readq(chip, reg) \
	snd_hdac_reg_readq(chip, (chip)->dsp_ba + (reg))

#define snd_hdac_adsp_updateb(chip, reg, mask, val) \
	snd_hdac_adsp_writeb(chip, reg, \
			(snd_hdac_adsp_readb(chip, reg) & ~(mask)) | (val))
#define snd_hdac_adsp_updatew(chip, reg, mask, val) \
	snd_hdac_adsp_writew(chip, reg, \
			(snd_hdac_adsp_readw(chip, reg) & ~(mask)) | (val))
#define snd_hdac_adsp_updatel(chip, reg, mask, val) \
	snd_hdac_adsp_writel(chip, reg, \
			(snd_hdac_adsp_readl(chip, reg) & ~(mask)) | (val))
#define snd_hdac_adsp_updateq(chip, reg, mask, val) \
	snd_hdac_adsp_writeq(chip, reg, \
			(snd_hdac_adsp_readq(chip, reg) & ~(mask)) | (val))

#define snd_hdac_adsp_readb_poll(chip, reg, val, cond, delay_us, timeout_us) \
	readb_poll_timeout((chip)->dsp_ba + (reg), val, cond, \
			   delay_us, timeout_us)
#define snd_hdac_adsp_readw_poll(chip, reg, val, cond, delay_us, timeout_us) \
	readw_poll_timeout((chip)->dsp_ba + (reg), val, cond, \
			   delay_us, timeout_us)
#define snd_hdac_adsp_readl_poll(chip, reg, val, cond, delay_us, timeout_us) \
	readl_poll_timeout((chip)->dsp_ba + (reg), val, cond, \
			   delay_us, timeout_us)
#define snd_hdac_adsp_readq_poll(chip, reg, val, cond, delay_us, timeout_us) \
	readq_poll_timeout((chip)->dsp_ba + (reg), val, cond, \
			   delay_us, timeout_us)
#define snd_hdac_stream_readb_poll(strm, reg, val, cond, delay_us, timeout_us) \
	readb_poll_timeout((strm)->sd_addr + AZX_REG_ ## reg, val, cond, \
			   delay_us, timeout_us)
#define snd_hdac_stream_readl_poll(strm, reg, val, cond, delay_us, timeout_us) \
	readl_poll_timeout((strm)->sd_addr + AZX_REG_ ## reg, val, cond, \
			   delay_us, timeout_us)

struct hdac_ext_device;

/* ops common to all codec drivers */
struct hdac_ext_codec_ops {
	int (*build_controls)(struct hdac_ext_device *dev);
	int (*init)(struct hdac_ext_device *dev);
	void (*free)(struct hdac_ext_device *dev);
};

struct hda_dai_map {
	char *dai_name;
	hda_nid_t nid;
	u32	maxbps;
};

struct hdac_ext_dma_params {
	u32 format;
	u8 stream_tag;
};

int snd_hda_ext_driver_register(struct hdac_driver *drv);
void snd_hda_ext_driver_unregister(struct hdac_driver *drv);

#endif /* __SOUND_HDAUDIO_EXT_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
dfe66a18 JK	2	#ifndef __SOUND_HDAUDIO_EXT_H
	3	#define __SOUND_HDAUDIO_EXT_H
	4
c19bd02e CR	5	#include <linux/io-64-nonatomic-lo-hi.h>
c19bd02e CR	6	#include <linux/iopoll.h>
dfe66a18 JK	7	#include <sound/hdaudio.h>
dfe66a18 JK	8
76f56fae	9	int snd_hdac_ext_bus_init(struct hdac_bus bus, struct device dev,
dfe66a18	10	const struct hdac_bus_ops *ops,
cb04ba33	11	const struct hdac_ext_bus_ops *ext_ops);
dfe66a18	12
76f56fae	13	void snd_hdac_ext_bus_exit(struct hdac_bus *bus);
6298542f	14	int snd_hdac_ext_bus_device_init(struct hdac_bus *bus, int addr,
163cd105	15	struct hdac_device *hdev, int type);
dfe66a18	16	void snd_hdac_ext_bus_device_exit(struct hdac_device *hdev);
76f56fae	17	void snd_hdac_ext_bus_device_remove(struct hdac_bus *bus);
dfe66a18	18
b6e84c99 SP	19	#define HDA_CODEC_REV_EXT_ENTRY(_vid, _rev, _name, drv_data) \
	20	{ .vendor_id = (_vid), .rev_id = (_rev), .name = (_name), \
	21	.api_version = HDA_DEV_ASOC, \
	22	.driver_data = (unsigned long)(drv_data) }
	23	#define HDA_CODEC_EXT_ENTRY(_vid, _revid, _name, _drv_data) \
	24	HDA_CODEC_REV_EXT_ENTRY(_vid, _revid, _name, _drv_data)
	25
76f56fae RU	26	void snd_hdac_ext_bus_ppcap_enable(struct hdac_bus *chip, bool enable);
76f56fae RU	27	void snd_hdac_ext_bus_ppcap_int_enable(struct hdac_bus *chip, bool enable);
dfe66a18	28
76f56fae	29	void snd_hdac_ext_stream_spbcap_enable(struct hdac_bus *chip,
0b00a561 JK	30	bool enable, int index);
0b00a561 JK	31
76f56fae	32	int snd_hdac_ext_bus_get_ml_capabilities(struct hdac_bus *bus);
fefee954	33	struct hdac_ext_link snd_hdac_ext_bus_link_at(struct hdac_bus bus, int addr);
76f56fae	34	struct hdac_ext_link snd_hdac_ext_bus_get_link(struct hdac_bus bus,
0b00a561 JK	35	const char *codec_name);
	36
	37	enum hdac_ext_stream_type {
	38	HDAC_EXT_STREAM_TYPE_COUPLED = 0,
	39	HDAC_EXT_STREAM_TYPE_HOST,
	40	HDAC_EXT_STREAM_TYPE_LINK
	41	};
	42
df203a4e JK	43	/**
	44	* hdac_ext_stream: HDAC extended stream for extended HDA caps
	45	*
	46	* @hstream: hdac_stream
	47	* @pphc_addr: processing pipe host stream pointer
	48	* @pplc_addr: processing pipe link stream pointer
ee8bc4df JK	49	* @spib_addr: software position in buffers stream pointer
ee8bc4df JK	50	* @fifo_addr: software position Max fifos stream pointer
a9c48f7f JK	51	* @dpibr_addr: DMA position in buffer resume pointer
	52	* @dpib: DMA position in buffer
	53	* @lpib: Linear position in buffer
df203a4e JK	54	* @decoupled: stream host and link is decoupled
	55	* @link_locked: link is locked
	56	* @link_prepared: link is prepared
0c4aa677	57	* @link_substream: link substream
df203a4e JK	58	*/
	59	struct hdac_ext_stream {
	60	struct hdac_stream hstream;
	61
	62	void __iomem *pphc_addr;
	63	void __iomem *pplc_addr;
	64
ee8bc4df JK	65	void __iomem *spib_addr;
	66	void __iomem *fifo_addr;
	67
a9c48f7f JK	68	void __iomem *dpibr_addr;
	69
	70	u32 dpib;
	71	u32 lpib;
df203a4e JK	72	bool decoupled:1;
	73	bool link_locked:1;
	74	bool link_prepared;
	75
	76	struct snd_pcm_substream *link_substream;
	77	};
	78
	79	#define hdac_stream(s) (&(s)->hstream)
	80	#define stream_to_hdac_ext_stream(s) \
	81	container_of(s, struct hdac_ext_stream, hstream)
	82
76f56fae	83	void snd_hdac_ext_stream_init(struct hdac_bus *bus,
0f7e5ee6 PLB	84	struct hdac_ext_stream *hext_stream, int idx,
0f7e5ee6 PLB	85	int direction, int tag);
76f56fae	86	int snd_hdac_ext_stream_init_all(struct hdac_bus *bus, int start_idx,
0f7e5ee6	87	int num_stream, int dir);
76f56fae RU	88	void snd_hdac_stream_free_all(struct hdac_bus *bus);
	89	void snd_hdac_link_free_all(struct hdac_bus *bus);
	90	struct hdac_ext_stream snd_hdac_ext_stream_assign(struct hdac_bus bus,
df203a4e JK	91	struct snd_pcm_substream *substream,
df203a4e JK	92	int type);
0f7e5ee6	93	void snd_hdac_ext_stream_release(struct hdac_ext_stream *hext_stream, int type);
868ddfce	94	void snd_hdac_ext_stream_decouple_locked(struct hdac_bus *bus,
0f7e5ee6	95	struct hdac_ext_stream *hext_stream, bool decouple);
76f56fae	96	void snd_hdac_ext_stream_decouple(struct hdac_bus *bus,
df203a4e	97	struct hdac_ext_stream *azx_dev, bool decouple);
df203a4e	98
76f56fae	99	int snd_hdac_ext_stream_set_spib(struct hdac_bus *bus,
0f7e5ee6	100	struct hdac_ext_stream *hext_stream, u32 value);
76f56fae	101	int snd_hdac_ext_stream_get_spbmaxfifo(struct hdac_bus *bus,
0f7e5ee6	102	struct hdac_ext_stream *hext_stream);
76f56fae	103	void snd_hdac_ext_stream_drsm_enable(struct hdac_bus *bus,
a9c48f7f	104	bool enable, int index);
76f56fae	105	int snd_hdac_ext_stream_set_dpibr(struct hdac_bus *bus,
0f7e5ee6 PLB	106	struct hdac_ext_stream *hext_stream, u32 value);
0f7e5ee6 PLB	107	int snd_hdac_ext_stream_set_lpib(struct hdac_ext_stream *hext_stream, u32 value);
ee8bc4df	108
0f7e5ee6 PLB	109	void snd_hdac_ext_link_stream_start(struct hdac_ext_stream *hext_stream);
	110	void snd_hdac_ext_link_stream_clear(struct hdac_ext_stream *hext_stream);
	111	void snd_hdac_ext_link_stream_reset(struct hdac_ext_stream *hext_stream);
	112	int snd_hdac_ext_link_stream_setup(struct hdac_ext_stream *hext_stream, int fmt);
df203a4e	113
0b00a561 JK	114	struct hdac_ext_link {
	115	struct hdac_bus *bus;
	116	int index;
	117	void __iomem ml_addr; / link output stream reg pointer */
	118	u32 lcaps; /* link capablities */
	119	u16 lsdiid; /* link sdi identifier */
4446085d VK	120
	121	int ref_count;
	122
0b00a561 JK	123	struct list_head list;
	124	};
	125
	126	int snd_hdac_ext_bus_link_power_up(struct hdac_ext_link *link);
	127	int snd_hdac_ext_bus_link_power_down(struct hdac_ext_link *link);
76f56fae RU	128	int snd_hdac_ext_bus_link_power_up_all(struct hdac_bus *bus);
76f56fae RU	129	int snd_hdac_ext_bus_link_power_down_all(struct hdac_bus *bus);
0b00a561 JK	130	void snd_hdac_ext_link_set_stream_id(struct hdac_ext_link *link,
	131	int stream);
	132	void snd_hdac_ext_link_clear_stream_id(struct hdac_ext_link *link,
	133	int stream);
	134
76f56fae RU	135	int snd_hdac_ext_bus_link_get(struct hdac_bus bus, struct hdac_ext_link link);
76f56fae RU	136	int snd_hdac_ext_bus_link_put(struct hdac_bus bus, struct hdac_ext_link link);
4446085d	137
f9e5fd1b KV	138	void snd_hdac_ext_bus_link_power(struct hdac_device *codec, bool enable);
f9e5fd1b KV	139
0b00a561 JK	140	/* update register macro */
	141	#define snd_hdac_updatel(addr, reg, mask, val) \
	142	writel(((readl(addr + reg) & ~(mask)) \| (val)), \
	143	addr + reg)
	144
df203a4e JK	145	#define snd_hdac_updatew(addr, reg, mask, val) \
	146	writew(((readw(addr + reg) & ~(mask)) \| (val)), \
	147	addr + reg)
	148
c19bd02e CR	149	#define snd_hdac_adsp_writeb(chip, reg, value) \
	150	snd_hdac_reg_writeb(chip, (chip)->dsp_ba + (reg), value)
	151	#define snd_hdac_adsp_readb(chip, reg) \
	152	snd_hdac_reg_readb(chip, (chip)->dsp_ba + (reg))
	153	#define snd_hdac_adsp_writew(chip, reg, value) \
	154	snd_hdac_reg_writew(chip, (chip)->dsp_ba + (reg), value)
	155	#define snd_hdac_adsp_readw(chip, reg) \
	156	snd_hdac_reg_readw(chip, (chip)->dsp_ba + (reg))
	157	#define snd_hdac_adsp_writel(chip, reg, value) \
	158	snd_hdac_reg_writel(chip, (chip)->dsp_ba + (reg), value)
	159	#define snd_hdac_adsp_readl(chip, reg) \
	160	snd_hdac_reg_readl(chip, (chip)->dsp_ba + (reg))
	161	#define snd_hdac_adsp_writeq(chip, reg, value) \
	162	snd_hdac_reg_writeq(chip, (chip)->dsp_ba + (reg), value)
	163	#define snd_hdac_adsp_readq(chip, reg) \
	164	snd_hdac_reg_readq(chip, (chip)->dsp_ba + (reg))
	165
	166	#define snd_hdac_adsp_updateb(chip, reg, mask, val) \
	167	snd_hdac_adsp_writeb(chip, reg, \
	168	(snd_hdac_adsp_readb(chip, reg) & ~(mask)) \| (val))
	169	#define snd_hdac_adsp_updatew(chip, reg, mask, val) \
	170	snd_hdac_adsp_writew(chip, reg, \
	171	(snd_hdac_adsp_readw(chip, reg) & ~(mask)) \| (val))
	172	#define snd_hdac_adsp_updatel(chip, reg, mask, val) \
	173	snd_hdac_adsp_writel(chip, reg, \
	174	(snd_hdac_adsp_readl(chip, reg) & ~(mask)) \| (val))
	175	#define snd_hdac_adsp_updateq(chip, reg, mask, val) \
	176	snd_hdac_adsp_writeq(chip, reg, \
	177	(snd_hdac_adsp_readq(chip, reg) & ~(mask)) \| (val))
	178
	179	#define snd_hdac_adsp_readb_poll(chip, reg, val, cond, delay_us, timeout_us) \
	180	readb_poll_timeout((chip)->dsp_ba + (reg), val, cond, \
	181	delay_us, timeout_us)
	182	#define snd_hdac_adsp_readw_poll(chip, reg, val, cond, delay_us, timeout_us) \
	183	readw_poll_timeout((chip)->dsp_ba + (reg), val, cond, \
	184	delay_us, timeout_us)
	185	#define snd_hdac_adsp_readl_poll(chip, reg, val, cond, delay_us, timeout_us) \
	186	readl_poll_timeout((chip)->dsp_ba + (reg), val, cond, \
	187	delay_us, timeout_us)
	188	#define snd_hdac_adsp_readq_poll(chip, reg, val, cond, delay_us, timeout_us) \
	189	readq_poll_timeout((chip)->dsp_ba + (reg), val, cond, \
	190	delay_us, timeout_us)
	191	#define snd_hdac_stream_readb_poll(strm, reg, val, cond, delay_us, timeout_us) \
	192	readb_poll_timeout((strm)->sd_addr + AZX_REG_ ## reg, val, cond, \
	193	delay_us, timeout_us)
	194	#define snd_hdac_stream_readl_poll(strm, reg, val, cond, delay_us, timeout_us) \
	195	readl_poll_timeout((strm)->sd_addr + AZX_REG_ ## reg, val, cond, \
	196	delay_us, timeout_us)
a512f561 VK	197
	198	struct hdac_ext_device;
	199
	200	/* ops common to all codec drivers */
	201	struct hdac_ext_codec_ops {
	202	int (build_controls)(struct hdac_ext_device dev);
	203	int (init)(struct hdac_ext_device dev);
	204	void (free)(struct hdac_ext_device dev);
	205	};
	206
	207	struct hda_dai_map {
	208	char *dai_name;
	209	hda_nid_t nid;
	210	u32 maxbps;
	211	};
	212
1e83b047 SP	213	struct hdac_ext_dma_params {
	214	u32 format;
	215	u8 stream_tag;
	216	};
3787a398	217
e1df9317 RU	218	int snd_hda_ext_driver_register(struct hdac_driver *drv);
e1df9317 RU	219	void snd_hda_ext_driver_unregister(struct hdac_driver *drv);
a512f561	220
dfe66a18	221	#endif /* __SOUND_HDAUDIO_EXT_H */