[mirror_ubuntu-hirsute-kernel.git] / drivers / soundwire / cadence_master.h

/* SPDX-License-Identifier: (GPL-2.0 OR BSD-3-Clause) */
/* Copyright(c) 2015-17 Intel Corporation. */
#include <sound/soc.h>

#ifndef __SDW_CADENCE_H
#define __SDW_CADENCE_H

#define SDW_CADENCE_GSYNC_KHZ		4 /* 4 kHz */
#define SDW_CADENCE_GSYNC_HZ		(SDW_CADENCE_GSYNC_KHZ * 1000)

/**
 * struct sdw_cdns_pdi: PDI (Physical Data Interface) instance
 *
 * @num: pdi number
 * @intel_alh_id: link identifier
 * @l_ch_num: low channel for PDI
 * @h_ch_num: high channel for PDI
 * @ch_count: total channel count for PDI
 * @dir: data direction
 * @type: stream type, PDM or PCM
 */
struct sdw_cdns_pdi {
	int num;
	int intel_alh_id;
	int l_ch_num;
	int h_ch_num;
	int ch_count;
	enum sdw_data_direction dir;
	enum sdw_stream_type type;
};

/**
 * struct sdw_cdns_streams: Cadence stream data structure
 *
 * @num_bd: number of bidirectional streams
 * @num_in: number of input streams
 * @num_out: number of output streams
 * @num_ch_bd: number of bidirectional stream channels
 * @num_ch_bd: number of input stream channels
 * @num_ch_bd: number of output stream channels
 * @num_pdi: total number of PDIs
 * @bd: bidirectional streams
 * @in: input streams
 * @out: output streams
 */
struct sdw_cdns_streams {
	unsigned int num_bd;
	unsigned int num_in;
	unsigned int num_out;
	unsigned int num_ch_bd;
	unsigned int num_ch_in;
	unsigned int num_ch_out;
	unsigned int num_pdi;
	struct sdw_cdns_pdi *bd;
	struct sdw_cdns_pdi *in;
	struct sdw_cdns_pdi *out;
};

/**
 * struct sdw_cdns_stream_config: stream configuration
 *
 * @pcm_bd: number of bidirectional PCM streams supported
 * @pcm_in: number of input PCM streams supported
 * @pcm_out: number of output PCM streams supported
 * @pdm_bd: number of bidirectional PDM streams supported
 * @pdm_in: number of input PDM streams supported
 * @pdm_out: number of output PDM streams supported
 */
struct sdw_cdns_stream_config {
	unsigned int pcm_bd;
	unsigned int pcm_in;
	unsigned int pcm_out;
	unsigned int pdm_bd;
	unsigned int pdm_in;
	unsigned int pdm_out;
};

/**
 * struct sdw_cdns_dma_data: Cadence DMA data
 *
 * @name: SoundWire stream name
 * @stream: stream runtime
 * @pdi: PDI used for this dai
 * @bus: Bus handle
 * @stream_type: Stream type
 * @link_id: Master link id
 * @hw_params: hw_params to be applied in .prepare step
 * @suspended: status set when suspended, to be used in .prepare
 */
struct sdw_cdns_dma_data {
	char *name;
	struct sdw_stream_runtime *stream;
	struct sdw_cdns_pdi *pdi;
	struct sdw_bus *bus;
	enum sdw_stream_type stream_type;
	int link_id;
	struct snd_pcm_hw_params *hw_params;
	bool suspended;
};

/**
 * struct sdw_cdns - Cadence driver context
 * @dev: Linux device
 * @bus: Bus handle
 * @instance: instance number
 * @response_buf: SoundWire response buffer
 * @tx_complete: Tx completion
 * @defer: Defer pointer
 * @ports: Data ports
 * @num_ports: Total number of data ports
 * @pcm: PCM streams
 * @pdm: PDM streams
 * @registers: Cadence registers
 * @link_up: Link status
 * @msg_count: Messages sent on bus
 */
struct sdw_cdns {
	struct device *dev;
	struct sdw_bus bus;
	unsigned int instance;

	u32 response_buf[0x80];
	struct completion tx_complete;
	struct sdw_defer *defer;

	struct sdw_cdns_port *ports;
	int num_ports;

	struct sdw_cdns_streams pcm;
	struct sdw_cdns_streams pdm;

	void __iomem *registers;

	bool link_up;
	unsigned int msg_count;
	bool interrupt_enabled;

	struct work_struct work;

	struct list_head list;
};

#define bus_to_cdns(_bus) container_of(_bus, struct sdw_cdns, bus)

/* Exported symbols */

int sdw_cdns_probe(struct sdw_cdns *cdns);
extern struct sdw_master_ops sdw_cdns_master_ops;

irqreturn_t sdw_cdns_irq(int irq, void *dev_id);
irqreturn_t sdw_cdns_thread(int irq, void *dev_id);

int sdw_cdns_init(struct sdw_cdns *cdns);
int sdw_cdns_pdi_init(struct sdw_cdns *cdns,
		      struct sdw_cdns_stream_config config);
int sdw_cdns_exit_reset(struct sdw_cdns *cdns);
int sdw_cdns_enable_interrupt(struct sdw_cdns *cdns, bool state);

bool sdw_cdns_is_clock_stop(struct sdw_cdns *cdns);
int sdw_cdns_clock_stop(struct sdw_cdns *cdns, bool block_wake);
int sdw_cdns_clock_restart(struct sdw_cdns *cdns, bool bus_reset);

#ifdef CONFIG_DEBUG_FS
void sdw_cdns_debugfs_init(struct sdw_cdns *cdns, struct dentry *root);
#endif

struct sdw_cdns_pdi *sdw_cdns_alloc_pdi(struct sdw_cdns *cdns,
					struct sdw_cdns_streams *stream,
					u32 ch, u32 dir, int dai_id);
void sdw_cdns_config_stream(struct sdw_cdns *cdns,
			    u32 ch, u32 dir, struct sdw_cdns_pdi *pdi);

enum sdw_command_response
cdns_reset_page_addr(struct sdw_bus *bus, unsigned int dev_num);

enum sdw_command_response
cdns_xfer_msg(struct sdw_bus *bus, struct sdw_msg *msg);

enum sdw_command_response
cdns_xfer_msg_defer(struct sdw_bus *bus,
		    struct sdw_msg *msg, struct sdw_defer *defer);

enum sdw_command_response
cdns_reset_page_addr(struct sdw_bus *bus, unsigned int dev_num);

int cdns_bus_conf(struct sdw_bus *bus, struct sdw_bus_params *params);

int cdns_set_sdw_stream(struct snd_soc_dai *dai,
			void *stream, bool pcm, int direction);
#endif /* __SDW_CADENCE_H */
Commit	Line	Data
23859465 PLB	1	/* SPDX-License-Identifier: (GPL-2.0 OR BSD-3-Clause) */
23859465 PLB	2	/* Copyright(c) 2015-17 Intel Corporation. */
5d6b3c8b	3	#include <sound/soc.h>
2f52a517 VK	4
	5	#ifndef __SDW_CADENCE_H
	6	#define __SDW_CADENCE_H
	7
1dd6a17f PLB	8	#define SDW_CADENCE_GSYNC_KHZ 4 /* 4 kHz */
	9	#define SDW_CADENCE_GSYNC_HZ (SDW_CADENCE_GSYNC_KHZ * 1000)
	10
07abeff1 VK	11	/**
	12	* struct sdw_cdns_pdi: PDI (Physical Data Interface) instance
	13	*
07abeff1 VK	14	* @num: pdi number
	15	* @intel_alh_id: link identifier
	16	* @l_ch_num: low channel for PDI
	17	* @h_ch_num: high channel for PDI
	18	* @ch_count: total channel count for PDI
	19	* @dir: data direction
	20	* @type: stream type, PDM or PCM
	21	*/
	22	struct sdw_cdns_pdi {
07abeff1 VK	23	int num;
	24	int intel_alh_id;
	25	int l_ch_num;
	26	int h_ch_num;
	27	int ch_count;
	28	enum sdw_data_direction dir;
	29	enum sdw_stream_type type;
	30	};
	31
07abeff1 VK	32	/**
	33	* struct sdw_cdns_streams: Cadence stream data structure
	34	*
	35	* @num_bd: number of bidirectional streams
	36	* @num_in: number of input streams
	37	* @num_out: number of output streams
	38	* @num_ch_bd: number of bidirectional stream channels
	39	* @num_ch_bd: number of input stream channels
	40	* @num_ch_bd: number of output stream channels
	41	* @num_pdi: total number of PDIs
	42	* @bd: bidirectional streams
	43	* @in: input streams
	44	* @out: output streams
	45	*/
	46	struct sdw_cdns_streams {
	47	unsigned int num_bd;
	48	unsigned int num_in;
	49	unsigned int num_out;
	50	unsigned int num_ch_bd;
	51	unsigned int num_ch_in;
	52	unsigned int num_ch_out;
	53	unsigned int num_pdi;
	54	struct sdw_cdns_pdi *bd;
	55	struct sdw_cdns_pdi *in;
	56	struct sdw_cdns_pdi *out;
	57	};
	58
	59	/**
	60	* struct sdw_cdns_stream_config: stream configuration
	61	*
	62	* @pcm_bd: number of bidirectional PCM streams supported
	63	* @pcm_in: number of input PCM streams supported
	64	* @pcm_out: number of output PCM streams supported
	65	* @pdm_bd: number of bidirectional PDM streams supported
	66	* @pdm_in: number of input PDM streams supported
	67	* @pdm_out: number of output PDM streams supported
	68	*/
	69	struct sdw_cdns_stream_config {
	70	unsigned int pcm_bd;
	71	unsigned int pcm_in;
	72	unsigned int pcm_out;
	73	unsigned int pdm_bd;
	74	unsigned int pdm_in;
	75	unsigned int pdm_out;
	76	};
	77
5d6b3c8b VK	78	/**
	79	* struct sdw_cdns_dma_data: Cadence DMA data
	80	*
	81	* @name: SoundWire stream name
57a34790 PLB	82	* @stream: stream runtime
57a34790 PLB	83	* @pdi: PDI used for this dai
5d6b3c8b VK	84	* @bus: Bus handle
	85	* @stream_type: Stream type
	86	* @link_id: Master link id
a5a0239c BL	87	* @hw_params: hw_params to be applied in .prepare step
a5a0239c BL	88	* @suspended: status set when suspended, to be used in .prepare
5d6b3c8b VK	89	*/
	90	struct sdw_cdns_dma_data {
	91	char *name;
	92	struct sdw_stream_runtime *stream;
57a34790	93	struct sdw_cdns_pdi *pdi;
5d6b3c8b VK	94	struct sdw_bus *bus;
	95	enum sdw_stream_type stream_type;
	96	int link_id;
a5a0239c BL	97	struct snd_pcm_hw_params *hw_params;
a5a0239c BL	98	bool suspended;
5d6b3c8b VK	99	};
5d6b3c8b VK	100
2f52a517 VK	101	/**
	102	* struct sdw_cdns - Cadence driver context
	103	* @dev: Linux device
	104	* @bus: Bus handle
	105	* @instance: instance number
956baa19 SK	106	* @response_buf: SoundWire response buffer
	107	* @tx_complete: Tx completion
	108	* @defer: Defer pointer
07abeff1 VK	109	* @ports: Data ports
	110	* @num_ports: Total number of data ports
	111	* @pcm: PCM streams
	112	* @pdm: PDM streams
2f52a517 VK	113	* @registers: Cadence registers
2f52a517 VK	114	* @link_up: Link status
956baa19	115	* @msg_count: Messages sent on bus
2f52a517 VK	116	*/
	117	struct sdw_cdns {
	118	struct device *dev;
	119	struct sdw_bus bus;
	120	unsigned int instance;
	121
956baa19 SK	122	u32 response_buf[0x80];
	123	struct completion tx_complete;
	124	struct sdw_defer *defer;
	125
07abeff1 VK	126	struct sdw_cdns_port *ports;
	127	int num_ports;
	128
	129	struct sdw_cdns_streams pcm;
	130	struct sdw_cdns_streams pdm;
	131
2f52a517 VK	132	void __iomem *registers;
	133
	134	bool link_up;
956baa19	135	unsigned int msg_count;
d2068da5	136	bool interrupt_enabled;
4a98a6b2 BL	137
	138	struct work_struct work;
	139
	140	struct list_head list;
2f52a517 VK	141	};
	142
	143	#define bus_to_cdns(_bus) container_of(_bus, struct sdw_cdns, bus)
	144
	145	/* Exported symbols */
	146
956baa19 SK	147	int sdw_cdns_probe(struct sdw_cdns *cdns);
	148	extern struct sdw_master_ops sdw_cdns_master_ops;
	149
2f52a517 VK	150	irqreturn_t sdw_cdns_irq(int irq, void *dev_id);
	151	irqreturn_t sdw_cdns_thread(int irq, void *dev_id);
	152
7b174f24	153	int sdw_cdns_init(struct sdw_cdns *cdns);
07abeff1	154	int sdw_cdns_pdi_init(struct sdw_cdns *cdns,
806a11f0	155	struct sdw_cdns_stream_config config);
49ea07d3	156	int sdw_cdns_exit_reset(struct sdw_cdns *cdns);
9e3d47fb	157	int sdw_cdns_enable_interrupt(struct sdw_cdns *cdns, bool state);
956baa19	158
5a885c52	159	bool sdw_cdns_is_clock_stop(struct sdw_cdns *cdns);
1032504f RW	160	int sdw_cdns_clock_stop(struct sdw_cdns *cdns, bool block_wake);
1032504f RW	161	int sdw_cdns_clock_restart(struct sdw_cdns *cdns, bool bus_reset);
5a885c52	162
aa85066e PLB	163	#ifdef CONFIG_DEBUG_FS
	164	void sdw_cdns_debugfs_init(struct sdw_cdns cdns, struct dentry root);
	165	#endif
	166
57a34790 PLB	167	struct sdw_cdns_pdi sdw_cdns_alloc_pdi(struct sdw_cdns cdns,
57a34790 PLB	168	struct sdw_cdns_streams *stream,
1b53385e	169	u32 ch, u32 dir, int dai_id);
57a34790	170	void sdw_cdns_config_stream(struct sdw_cdns *cdns,
806a11f0	171	u32 ch, u32 dir, struct sdw_cdns_pdi *pdi);
5d6b3c8b	172
5d6b3c8b VK	173	enum sdw_command_response
	174	cdns_reset_page_addr(struct sdw_bus *bus, unsigned int dev_num);
	175
c91605f4 SN	176	enum sdw_command_response
c91605f4 SN	177	cdns_xfer_msg(struct sdw_bus bus, struct sdw_msg msg);
2f52a517	178
c91605f4 SN	179	enum sdw_command_response
c91605f4 SN	180	cdns_xfer_msg_defer(struct sdw_bus *bus,
806a11f0	181	struct sdw_msg msg, struct sdw_defer defer);
c91605f4 SN	182
	183	enum sdw_command_response
	184	cdns_reset_page_addr(struct sdw_bus *bus, unsigned int dev_num);
07abeff1 VK	185
07abeff1 VK	186	int cdns_bus_conf(struct sdw_bus bus, struct sdw_bus_params params);
5d6b3c8b VK	187
5d6b3c8b VK	188	int cdns_set_sdw_stream(struct snd_soc_dai *dai,
806a11f0	189	void *stream, bool pcm, int direction);
2f52a517	190	#endif /* __SDW_CADENCE_H */