[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);
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);

int snd_hdac_ext_bus_get_ml_capabilities(struct hdac_bus *bus);
struct hdac_ext_link *snd_hdac_ext_bus_get_hlink_by_addr(struct hdac_bus *bus, int addr);
struct hdac_ext_link *snd_hdac_ext_bus_get_hlink_by_name(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
 * @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;

	u32 pphcllpl;
	u32 pphcllpu;
	u32 pphcldpl;
	u32 pphcldpu;

	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)

int snd_hdac_ext_stream_init_all(struct hdac_bus *bus, int start_idx,
				 int num_stream, int dir);
void snd_hdac_ext_stream_free_all(struct hdac_bus *bus);
void snd_hdac_ext_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);
struct hdac_ext_stream *snd_hdac_ext_cstream_assign(struct hdac_bus *bus,
						    struct snd_compr_stream *cstream);
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);

void snd_hdac_ext_stream_start(struct hdac_ext_stream *hext_stream);
void snd_hdac_ext_stream_clear(struct hdac_ext_stream *hext_stream);
void snd_hdac_ext_stream_reset(struct hdac_ext_stream *hext_stream);
int snd_hdac_ext_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 *hlink);
int snd_hdac_ext_bus_link_power_down(struct hdac_ext_link *hlink);
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_bus_link_set_stream_id(struct hdac_ext_link *hlink,
					 int stream);
void snd_hdac_ext_bus_link_clear_stream_id(struct hdac_ext_link *hlink,
					   int stream);

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

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

#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)

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);
76f56fae	14	void snd_hdac_ext_bus_device_remove(struct hdac_bus *bus);
dfe66a18	15
b6e84c99 SP	16	#define HDA_CODEC_REV_EXT_ENTRY(_vid, _rev, _name, drv_data) \
	17	{ .vendor_id = (_vid), .rev_id = (_rev), .name = (_name), \
	18	.api_version = HDA_DEV_ASOC, \
	19	.driver_data = (unsigned long)(drv_data) }
	20	#define HDA_CODEC_EXT_ENTRY(_vid, _revid, _name, _drv_data) \
	21	HDA_CODEC_REV_EXT_ENTRY(_vid, _revid, _name, _drv_data)
	22
76f56fae RU	23	void snd_hdac_ext_bus_ppcap_enable(struct hdac_bus *chip, bool enable);
76f56fae RU	24	void snd_hdac_ext_bus_ppcap_int_enable(struct hdac_bus *chip, bool enable);
dfe66a18	25
76f56fae	26	int snd_hdac_ext_bus_get_ml_capabilities(struct hdac_bus *bus);
b0cd60f3 PLB	27	struct hdac_ext_link snd_hdac_ext_bus_get_hlink_by_addr(struct hdac_bus bus, int addr);
	28	struct hdac_ext_link snd_hdac_ext_bus_get_hlink_by_name(struct hdac_bus bus,
	29	const char *codec_name);
0b00a561 JK	30
	31	enum hdac_ext_stream_type {
	32	HDAC_EXT_STREAM_TYPE_COUPLED = 0,
	33	HDAC_EXT_STREAM_TYPE_HOST,
	34	HDAC_EXT_STREAM_TYPE_LINK
	35	};
	36
df203a4e JK	37	/**
	38	* hdac_ext_stream: HDAC extended stream for extended HDA caps
	39	*
	40	* @hstream: hdac_stream
	41	* @pphc_addr: processing pipe host stream pointer
	42	* @pplc_addr: processing pipe link stream pointer
	43	* @decoupled: stream host and link is decoupled
	44	* @link_locked: link is locked
	45	* @link_prepared: link is prepared
0c4aa677	46	* @link_substream: link substream
df203a4e JK	47	*/
	48	struct hdac_ext_stream {
	49	struct hdac_stream hstream;
	50
	51	void __iomem *pphc_addr;
	52	void __iomem *pplc_addr;
	53
2b9a50ea CR	54	u32 pphcllpl;
	55	u32 pphcllpu;
	56	u32 pphcldpl;
	57	u32 pphcldpu;
	58
df203a4e JK	59	bool decoupled:1;
	60	bool link_locked:1;
	61	bool link_prepared;
	62
	63	struct snd_pcm_substream *link_substream;
	64	};
	65
	66	#define hdac_stream(s) (&(s)->hstream)
	67	#define stream_to_hdac_ext_stream(s) \
	68	container_of(s, struct hdac_ext_stream, hstream)
	69
76f56fae	70	int snd_hdac_ext_stream_init_all(struct hdac_bus *bus, int start_idx,
0f7e5ee6	71	int num_stream, int dir);
0839a04e	72	void snd_hdac_ext_stream_free_all(struct hdac_bus *bus);
7f05ca9a	73	void snd_hdac_ext_link_free_all(struct hdac_bus *bus);
76f56fae	74	struct hdac_ext_stream snd_hdac_ext_stream_assign(struct hdac_bus bus,
df203a4e JK	75	struct snd_pcm_substream *substream,
df203a4e JK	76	int type);
0f7e5ee6	77	void snd_hdac_ext_stream_release(struct hdac_ext_stream *hext_stream, int type);
97d73d97 CR	78	struct hdac_ext_stream snd_hdac_ext_cstream_assign(struct hdac_bus bus,
97d73d97 CR	79	struct snd_compr_stream *cstream);
868ddfce	80	void snd_hdac_ext_stream_decouple_locked(struct hdac_bus *bus,
0f7e5ee6	81	struct hdac_ext_stream *hext_stream, bool decouple);
76f56fae	82	void snd_hdac_ext_stream_decouple(struct hdac_bus *bus,
df203a4e	83	struct hdac_ext_stream *azx_dev, bool decouple);
df203a4e	84
00b6cd95 PLB	85	void snd_hdac_ext_stream_start(struct hdac_ext_stream *hext_stream);
	86	void snd_hdac_ext_stream_clear(struct hdac_ext_stream *hext_stream);
	87	void snd_hdac_ext_stream_reset(struct hdac_ext_stream *hext_stream);
	88	int snd_hdac_ext_stream_setup(struct hdac_ext_stream *hext_stream, int fmt);
df203a4e	89
0b00a561 JK	90	struct hdac_ext_link {
	91	struct hdac_bus *bus;
	92	int index;
	93	void __iomem ml_addr; / link output stream reg pointer */
	94	u32 lcaps; /* link capablities */
	95	u16 lsdiid; /* link sdi identifier */
4446085d VK	96
	97	int ref_count;
	98
0b00a561 JK	99	struct list_head list;
	100	};
	101
eebaa6b0 PLB	102	int snd_hdac_ext_bus_link_power_up(struct hdac_ext_link *hlink);
eebaa6b0 PLB	103	int snd_hdac_ext_bus_link_power_down(struct hdac_ext_link *hlink);
76f56fae RU	104	int snd_hdac_ext_bus_link_power_up_all(struct hdac_bus *bus);
76f56fae RU	105	int snd_hdac_ext_bus_link_power_down_all(struct hdac_bus *bus);
7fa403f2 PLB	106	void snd_hdac_ext_bus_link_set_stream_id(struct hdac_ext_link *hlink,
	107	int stream);
	108	void snd_hdac_ext_bus_link_clear_stream_id(struct hdac_ext_link *hlink,
	109	int stream);
0b00a561	110
eebaa6b0 PLB	111	int snd_hdac_ext_bus_link_get(struct hdac_bus bus, struct hdac_ext_link hlink);
eebaa6b0 PLB	112	int snd_hdac_ext_bus_link_put(struct hdac_bus bus, struct hdac_ext_link hlink);
4446085d	113
f9e5fd1b KV	114	void snd_hdac_ext_bus_link_power(struct hdac_device *codec, bool enable);
f9e5fd1b KV	115
c19bd02e CR	116	#define snd_hdac_adsp_writeb(chip, reg, value) \
	117	snd_hdac_reg_writeb(chip, (chip)->dsp_ba + (reg), value)
	118	#define snd_hdac_adsp_readb(chip, reg) \
	119	snd_hdac_reg_readb(chip, (chip)->dsp_ba + (reg))
	120	#define snd_hdac_adsp_writew(chip, reg, value) \
	121	snd_hdac_reg_writew(chip, (chip)->dsp_ba + (reg), value)
	122	#define snd_hdac_adsp_readw(chip, reg) \
	123	snd_hdac_reg_readw(chip, (chip)->dsp_ba + (reg))
	124	#define snd_hdac_adsp_writel(chip, reg, value) \
	125	snd_hdac_reg_writel(chip, (chip)->dsp_ba + (reg), value)
	126	#define snd_hdac_adsp_readl(chip, reg) \
	127	snd_hdac_reg_readl(chip, (chip)->dsp_ba + (reg))
	128	#define snd_hdac_adsp_writeq(chip, reg, value) \
	129	snd_hdac_reg_writeq(chip, (chip)->dsp_ba + (reg), value)
	130	#define snd_hdac_adsp_readq(chip, reg) \
	131	snd_hdac_reg_readq(chip, (chip)->dsp_ba + (reg))
	132
	133	#define snd_hdac_adsp_updateb(chip, reg, mask, val) \
	134	snd_hdac_adsp_writeb(chip, reg, \
	135	(snd_hdac_adsp_readb(chip, reg) & ~(mask)) \| (val))
	136	#define snd_hdac_adsp_updatew(chip, reg, mask, val) \
	137	snd_hdac_adsp_writew(chip, reg, \
	138	(snd_hdac_adsp_readw(chip, reg) & ~(mask)) \| (val))
	139	#define snd_hdac_adsp_updatel(chip, reg, mask, val) \
	140	snd_hdac_adsp_writel(chip, reg, \
	141	(snd_hdac_adsp_readl(chip, reg) & ~(mask)) \| (val))
	142	#define snd_hdac_adsp_updateq(chip, reg, mask, val) \
	143	snd_hdac_adsp_writeq(chip, reg, \
	144	(snd_hdac_adsp_readq(chip, reg) & ~(mask)) \| (val))
	145
	146	#define snd_hdac_adsp_readb_poll(chip, reg, val, cond, delay_us, timeout_us) \
	147	readb_poll_timeout((chip)->dsp_ba + (reg), val, cond, \
	148	delay_us, timeout_us)
	149	#define snd_hdac_adsp_readw_poll(chip, reg, val, cond, delay_us, timeout_us) \
	150	readw_poll_timeout((chip)->dsp_ba + (reg), val, cond, \
	151	delay_us, timeout_us)
	152	#define snd_hdac_adsp_readl_poll(chip, reg, val, cond, delay_us, timeout_us) \
	153	readl_poll_timeout((chip)->dsp_ba + (reg), val, cond, \
	154	delay_us, timeout_us)
	155	#define snd_hdac_adsp_readq_poll(chip, reg, val, cond, delay_us, timeout_us) \
	156	readq_poll_timeout((chip)->dsp_ba + (reg), val, cond, \
	157	delay_us, timeout_us)
a512f561 VK	158
	159	struct hdac_ext_device;
	160
	161	/* ops common to all codec drivers */
	162	struct hdac_ext_codec_ops {
	163	int (build_controls)(struct hdac_ext_device dev);
	164	int (init)(struct hdac_ext_device dev);
	165	void (free)(struct hdac_ext_device dev);
	166	};
	167
	168	struct hda_dai_map {
	169	char *dai_name;
	170	hda_nid_t nid;
	171	u32 maxbps;
	172	};
	173
1e83b047 SP	174	struct hdac_ext_dma_params {
	175	u32 format;
	176	u8 stream_tag;
	177	};
3787a398	178
e1df9317 RU	179	int snd_hda_ext_driver_register(struct hdac_driver *drv);
e1df9317 RU	180	void snd_hda_ext_driver_unregister(struct hdac_driver *drv);
a512f561	181
dfe66a18	182	#endif /* __SOUND_HDAUDIO_EXT_H */