[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 <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_io_ops *io_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);
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_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 *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 *azx_dev, int type);
void snd_hdac_ext_stream_decouple(struct hdac_bus *bus,
				struct hdac_ext_stream *azx_dev, bool decouple);
void snd_hdac_ext_stop_streams(struct hdac_bus *bus);

int snd_hdac_ext_stream_set_spib(struct hdac_bus *bus,
				 struct hdac_ext_stream *stream, u32 value);
int snd_hdac_ext_stream_get_spbmaxfifo(struct hdac_bus *bus,
				 struct hdac_ext_stream *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 *stream, u32 value);
int snd_hdac_ext_stream_set_lpib(struct hdac_ext_stream *stream, u32 value);

void snd_hdac_ext_link_stream_start(struct hdac_ext_stream *hstream);
void snd_hdac_ext_link_stream_clear(struct hdac_ext_stream *hstream);
void snd_hdac_ext_link_stream_reset(struct hdac_ext_stream *hstream);
int snd_hdac_ext_link_stream_setup(struct hdac_ext_stream *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);

/* 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)


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
	1	/* SPDX-License-Identifier: GPL-2.0 */
	2	#ifndef __SOUND_HDAUDIO_EXT_H
	3	#define __SOUND_HDAUDIO_EXT_H
	4
	5	#include <sound/hdaudio.h>
	6
	7	int snd_hdac_ext_bus_init(struct hdac_bus bus, struct device dev,
	8	const struct hdac_bus_ops *ops,
	9	const struct hdac_io_ops *io_ops,
	10	const struct hdac_ext_bus_ops *ext_ops);
	11
	12	void snd_hdac_ext_bus_exit(struct hdac_bus *bus);
	13	int snd_hdac_ext_bus_device_init(struct hdac_bus *bus, int addr,
	14	struct hdac_device *hdev);
	15	void snd_hdac_ext_bus_device_exit(struct hdac_device *hdev);
	16	void snd_hdac_ext_bus_device_remove(struct hdac_bus *bus);
	17
	18	#define HDA_CODEC_REV_EXT_ENTRY(_vid, _rev, _name, drv_data) \
	19	{ .vendor_id = (_vid), .rev_id = (_rev), .name = (_name), \
	20	.api_version = HDA_DEV_ASOC, \
	21	.driver_data = (unsigned long)(drv_data) }
	22	#define HDA_CODEC_EXT_ENTRY(_vid, _revid, _name, _drv_data) \
	23	HDA_CODEC_REV_EXT_ENTRY(_vid, _revid, _name, _drv_data)
	24
	25	void snd_hdac_ext_bus_ppcap_enable(struct hdac_bus *chip, bool enable);
	26	void snd_hdac_ext_bus_ppcap_int_enable(struct hdac_bus *chip, bool enable);
	27
	28	void snd_hdac_ext_stream_spbcap_enable(struct hdac_bus *chip,
	29	bool enable, int index);
	30
	31	int snd_hdac_ext_bus_get_ml_capabilities(struct hdac_bus *bus);
	32	struct hdac_ext_link snd_hdac_ext_bus_get_link(struct hdac_bus bus,
	33	const char *codec_name);
	34
	35	enum hdac_ext_stream_type {
	36	HDAC_EXT_STREAM_TYPE_COUPLED = 0,
	37	HDAC_EXT_STREAM_TYPE_HOST,
	38	HDAC_EXT_STREAM_TYPE_LINK
	39	};
	40
	41	/**
	42	* hdac_ext_stream: HDAC extended stream for extended HDA caps
	43	*
	44	* @hstream: hdac_stream
	45	* @pphc_addr: processing pipe host stream pointer
	46	* @pplc_addr: processing pipe link stream pointer
	47	* @spib_addr: software position in buffers stream pointer
	48	* @fifo_addr: software position Max fifos stream pointer
	49	* @dpibr_addr: DMA position in buffer resume pointer
	50	* @dpib: DMA position in buffer
	51	* @lpib: Linear position in buffer
	52	* @decoupled: stream host and link is decoupled
	53	* @link_locked: link is locked
	54	* @link_prepared: link is prepared
	55	* link_substream: link substream
	56	*/
	57	struct hdac_ext_stream {
	58	struct hdac_stream hstream;
	59
	60	void __iomem *pphc_addr;
	61	void __iomem *pplc_addr;
	62
	63	void __iomem *spib_addr;
	64	void __iomem *fifo_addr;
	65
	66	void __iomem *dpibr_addr;
	67
	68	u32 dpib;
	69	u32 lpib;
	70	bool decoupled:1;
	71	bool link_locked:1;
	72	bool link_prepared;
	73
	74	struct snd_pcm_substream *link_substream;
	75	};
	76
	77	#define hdac_stream(s) (&(s)->hstream)
	78	#define stream_to_hdac_ext_stream(s) \
	79	container_of(s, struct hdac_ext_stream, hstream)
	80
	81	void snd_hdac_ext_stream_init(struct hdac_bus *bus,
	82	struct hdac_ext_stream *stream, int idx,
	83	int direction, int tag);
	84	int snd_hdac_ext_stream_init_all(struct hdac_bus *bus, int start_idx,
	85	int num_stream, int dir);
	86	void snd_hdac_stream_free_all(struct hdac_bus *bus);
	87	void snd_hdac_link_free_all(struct hdac_bus *bus);
	88	struct hdac_ext_stream snd_hdac_ext_stream_assign(struct hdac_bus bus,
	89	struct snd_pcm_substream *substream,
	90	int type);
	91	void snd_hdac_ext_stream_release(struct hdac_ext_stream *azx_dev, int type);
	92	void snd_hdac_ext_stream_decouple(struct hdac_bus *bus,
	93	struct hdac_ext_stream *azx_dev, bool decouple);
	94	void snd_hdac_ext_stop_streams(struct hdac_bus *bus);
	95
	96	int snd_hdac_ext_stream_set_spib(struct hdac_bus *bus,
	97	struct hdac_ext_stream *stream, u32 value);
	98	int snd_hdac_ext_stream_get_spbmaxfifo(struct hdac_bus *bus,
	99	struct hdac_ext_stream *stream);
	100	void snd_hdac_ext_stream_drsm_enable(struct hdac_bus *bus,
	101	bool enable, int index);
	102	int snd_hdac_ext_stream_set_dpibr(struct hdac_bus *bus,
	103	struct hdac_ext_stream *stream, u32 value);
	104	int snd_hdac_ext_stream_set_lpib(struct hdac_ext_stream *stream, u32 value);
	105
	106	void snd_hdac_ext_link_stream_start(struct hdac_ext_stream *hstream);
	107	void snd_hdac_ext_link_stream_clear(struct hdac_ext_stream *hstream);
	108	void snd_hdac_ext_link_stream_reset(struct hdac_ext_stream *hstream);
	109	int snd_hdac_ext_link_stream_setup(struct hdac_ext_stream *stream, int fmt);
	110
	111	struct hdac_ext_link {
	112	struct hdac_bus *bus;
	113	int index;
	114	void __iomem ml_addr; / link output stream reg pointer */
	115	u32 lcaps; /* link capablities */
	116	u16 lsdiid; /* link sdi identifier */
	117
	118	int ref_count;
	119
	120	struct list_head list;
	121	};
	122
	123	int snd_hdac_ext_bus_link_power_up(struct hdac_ext_link *link);
	124	int snd_hdac_ext_bus_link_power_down(struct hdac_ext_link *link);
	125	int snd_hdac_ext_bus_link_power_up_all(struct hdac_bus *bus);
	126	int snd_hdac_ext_bus_link_power_down_all(struct hdac_bus *bus);
	127	void snd_hdac_ext_link_set_stream_id(struct hdac_ext_link *link,
	128	int stream);
	129	void snd_hdac_ext_link_clear_stream_id(struct hdac_ext_link *link,
	130	int stream);
	131
	132	int snd_hdac_ext_bus_link_get(struct hdac_bus bus, struct hdac_ext_link link);
	133	int snd_hdac_ext_bus_link_put(struct hdac_bus bus, struct hdac_ext_link link);
	134
	135	/* update register macro */
	136	#define snd_hdac_updatel(addr, reg, mask, val) \
	137	writel(((readl(addr + reg) & ~(mask)) \| (val)), \
	138	addr + reg)
	139
	140	#define snd_hdac_updatew(addr, reg, mask, val) \
	141	writew(((readw(addr + reg) & ~(mask)) \| (val)), \
	142	addr + reg)
	143
	144
	145	struct hdac_ext_device;
	146
	147	/* ops common to all codec drivers */
	148	struct hdac_ext_codec_ops {
	149	int (build_controls)(struct hdac_ext_device dev);
	150	int (init)(struct hdac_ext_device dev);
	151	void (free)(struct hdac_ext_device dev);
	152	};
	153
	154	struct hda_dai_map {
	155	char *dai_name;
	156	hda_nid_t nid;
	157	u32 maxbps;
	158	};
	159
	160	struct hdac_ext_dma_params {
	161	u32 format;
	162	u8 stream_tag;
	163	};
	164
	165	int snd_hda_ext_driver_register(struct hdac_driver *drv);
	166	void snd_hda_ext_driver_unregister(struct hdac_driver *drv);
	167
	168	#endif /* __SOUND_HDAUDIO_EXT_H */