[linux-block.git] / drivers / soundwire / bus.h

/* SPDX-License-Identifier: (GPL-2.0 OR BSD-3-Clause) */
/* Copyright(c) 2015-17 Intel Corporation. */

#ifndef __SDW_BUS_H
#define __SDW_BUS_H

#define DEFAULT_BANK_SWITCH_TIMEOUT 3000
#define DEFAULT_PROBE_TIMEOUT       2000

u64 sdw_dmi_override_adr(struct sdw_bus *bus, u64 addr);

#if IS_ENABLED(CONFIG_ACPI)
int sdw_acpi_find_slaves(struct sdw_bus *bus);
#else
static inline int sdw_acpi_find_slaves(struct sdw_bus *bus)
{
	return -ENOTSUPP;
}
#endif

int sdw_of_find_slaves(struct sdw_bus *bus);
void sdw_extract_slave_id(struct sdw_bus *bus,
			  u64 addr, struct sdw_slave_id *id);
int sdw_slave_add(struct sdw_bus *bus, struct sdw_slave_id *id,
		  struct fwnode_handle *fwnode);
int sdw_master_device_add(struct sdw_bus *bus, struct device *parent,
			  struct fwnode_handle *fwnode);
int sdw_master_device_del(struct sdw_bus *bus);

#ifdef CONFIG_DEBUG_FS
void sdw_bus_debugfs_init(struct sdw_bus *bus);
void sdw_bus_debugfs_exit(struct sdw_bus *bus);
void sdw_slave_debugfs_init(struct sdw_slave *slave);
void sdw_slave_debugfs_exit(struct sdw_slave *slave);
void sdw_debugfs_init(void);
void sdw_debugfs_exit(void);
#else
static inline void sdw_bus_debugfs_init(struct sdw_bus *bus) {}
static inline void sdw_bus_debugfs_exit(struct sdw_bus *bus) {}
static inline void sdw_slave_debugfs_init(struct sdw_slave *slave) {}
static inline void sdw_slave_debugfs_exit(struct sdw_slave *slave) {}
static inline void sdw_debugfs_init(void) {}
static inline void sdw_debugfs_exit(void) {}
#endif

enum {
	SDW_MSG_FLAG_READ = 0,
	SDW_MSG_FLAG_WRITE,
};

/**
 * struct sdw_msg - Message structure
 * @addr: Register address accessed in the Slave
 * @len: number of messages
 * @dev_num: Slave device number
 * @addr_page1: SCP address page 1 Slave register
 * @addr_page2: SCP address page 2 Slave register
 * @flags: transfer flags, indicate if xfer is read or write
 * @buf: message data buffer
 * @ssp_sync: Send message at SSP (Stream Synchronization Point)
 * @page: address requires paging
 */
struct sdw_msg {
	u16 addr;
	u16 len;
	u8 dev_num;
	u8 addr_page1;
	u8 addr_page2;
	u8 flags;
	u8 *buf;
	bool ssp_sync;
	bool page;
};

#define SDW_DOUBLE_RATE_FACTOR		2
#define SDW_STRM_RATE_GROUPING		1

extern int sdw_rows[SDW_FRAME_ROWS];
extern int sdw_cols[SDW_FRAME_COLS];

int sdw_find_row_index(int row);
int sdw_find_col_index(int col);

/**
 * sdw_port_runtime: Runtime port parameters for Master or Slave
 *
 * @num: Port number. For audio streams, valid port number ranges from
 * [1,14]
 * @ch_mask: Channel mask
 * @transport_params: Transport parameters
 * @port_params: Port parameters
 * @port_node: List node for Master or Slave port_list
 *
 * SoundWire spec has no mention of ports for Master interface but the
 * concept is logically extended.
 */
struct sdw_port_runtime {
	int num;
	int ch_mask;
	struct sdw_transport_params transport_params;
	struct sdw_port_params port_params;
	struct list_head port_node;
};

/**
 * sdw_slave_runtime: Runtime Stream parameters for Slave
 *
 * @slave: Slave handle
 * @direction: Data direction for Slave
 * @ch_count: Number of channels handled by the Slave for
 * this stream
 * @m_rt_node: sdw_master_runtime list node
 * @port_list: List of Slave Ports configured for this stream
 */
struct sdw_slave_runtime {
	struct sdw_slave *slave;
	enum sdw_data_direction direction;
	unsigned int ch_count;
	struct list_head m_rt_node;
	struct list_head port_list;
};

/**
 * sdw_master_runtime: Runtime stream parameters for Master
 *
 * @bus: Bus handle
 * @stream: Stream runtime handle
 * @direction: Data direction for Master
 * @ch_count: Number of channels handled by the Master for
 * this stream, can be zero.
 * @slave_rt_list: Slave runtime list
 * @port_list: List of Master Ports configured for this stream, can be zero.
 * @stream_node: sdw_stream_runtime master_list node
 * @bus_node: sdw_bus m_rt_list node
 */
struct sdw_master_runtime {
	struct sdw_bus *bus;
	struct sdw_stream_runtime *stream;
	enum sdw_data_direction direction;
	unsigned int ch_count;
	struct list_head slave_rt_list;
	struct list_head port_list;
	struct list_head stream_node;
	struct list_head bus_node;
};

struct sdw_dpn_prop *sdw_get_slave_dpn_prop(struct sdw_slave *slave,
					    enum sdw_data_direction direction,
					    unsigned int port_num);
int sdw_configure_dpn_intr(struct sdw_slave *slave, int port,
			   bool enable, int mask);

int sdw_transfer(struct sdw_bus *bus, struct sdw_msg *msg);
int sdw_transfer_defer(struct sdw_bus *bus, struct sdw_msg *msg);

#define SDW_READ_INTR_CLEAR_RETRY	10

int sdw_fill_msg(struct sdw_msg *msg, struct sdw_slave *slave,
		 u32 addr, size_t count, u16 dev_num, u8 flags, u8 *buf);

/* Retrieve and return channel count from channel mask */
static inline int sdw_ch_mask_to_ch(int ch_mask)
{
	int c = 0;

	for (c = 0; ch_mask; ch_mask >>= 1)
		c += ch_mask & 1;

	return c;
}

/* Fill transport parameter data structure */
static inline void sdw_fill_xport_params(struct sdw_transport_params *params,
					 int port_num, bool grp_ctrl_valid,
					 int grp_ctrl, int sample_int,
					 int off1, int off2,
					 int hstart, int hstop,
					 int pack_mode, int lane_ctrl)
{
	params->port_num = port_num;
	params->blk_grp_ctrl_valid = grp_ctrl_valid;
	params->blk_grp_ctrl = grp_ctrl;
	params->sample_interval = sample_int;
	params->offset1 = off1;
	params->offset2 = off2;
	params->hstart = hstart;
	params->hstop = hstop;
	params->blk_pkg_mode = pack_mode;
	params->lane_ctrl = lane_ctrl;
}

/* Fill port parameter data structure */
static inline void sdw_fill_port_params(struct sdw_port_params *params,
					int port_num, int bps,
					int flow_mode, int data_mode)
{
	params->num = port_num;
	params->bps = bps;
	params->flow_mode = flow_mode;
	params->data_mode = data_mode;
}

/* broadcast read/write for tests */
int sdw_bread_no_pm_unlocked(struct sdw_bus *bus, u16 dev_num, u32 addr);
int sdw_bwrite_no_pm_unlocked(struct sdw_bus *bus, u16 dev_num, u32 addr, u8 value);

/*
 * At the moment we only track Master-initiated hw_reset.
 * Additional fields can be added as needed
 */
#define SDW_UNATTACH_REQUEST_MASTER_RESET	BIT(0)

void sdw_clear_slave_status(struct sdw_bus *bus, u32 request);
int sdw_slave_modalias(const struct sdw_slave *slave, char *buf, size_t size);

#endif /* __SDW_BUS_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. */
7c3cd189 VK	3
	4	#ifndef __SDW_BUS_H
	5	#define __SDW_BUS_H
	6
ce6e74d0	7	#define DEFAULT_BANK_SWITCH_TIMEOUT 3000
2140b66b	8	#define DEFAULT_PROBE_TIMEOUT 2000
ce6e74d0	9
f6594cdf PLB	10	u64 sdw_dmi_override_adr(struct sdw_bus *bus, u64 addr);
f6594cdf PLB	11
7c3cd189 VK	12	#if IS_ENABLED(CONFIG_ACPI)
	13	int sdw_acpi_find_slaves(struct sdw_bus *bus);
	14	#else
	15	static inline int sdw_acpi_find_slaves(struct sdw_bus *bus)
	16	{
	17	return -ENOTSUPP;
	18	}
	19	#endif
	20
a2e48458	21	int sdw_of_find_slaves(struct sdw_bus *bus);
7c3cd189	22	void sdw_extract_slave_id(struct sdw_bus *bus,
806a11f0	23	u64 addr, struct sdw_slave_id *id);
fcb9d730 SK	24	int sdw_slave_add(struct sdw_bus bus, struct sdw_slave_id id,
fcb9d730 SK	25	struct fwnode_handle *fwnode);
7ceaa40b PLB	26	int sdw_master_device_add(struct sdw_bus bus, struct device parent,
	27	struct fwnode_handle *fwnode);
	28	int sdw_master_device_del(struct sdw_bus *bus);
7c3cd189	29
bf03473d PLB	30	#ifdef CONFIG_DEBUG_FS
	31	void sdw_bus_debugfs_init(struct sdw_bus *bus);
	32	void sdw_bus_debugfs_exit(struct sdw_bus *bus);
	33	void sdw_slave_debugfs_init(struct sdw_slave *slave);
	34	void sdw_slave_debugfs_exit(struct sdw_slave *slave);
	35	void sdw_debugfs_init(void);
	36	void sdw_debugfs_exit(void);
	37	#else
	38	static inline void sdw_bus_debugfs_init(struct sdw_bus *bus) {}
	39	static inline void sdw_bus_debugfs_exit(struct sdw_bus *bus) {}
	40	static inline void sdw_slave_debugfs_init(struct sdw_slave *slave) {}
	41	static inline void sdw_slave_debugfs_exit(struct sdw_slave *slave) {}
	42	static inline void sdw_debugfs_init(void) {}
	43	static inline void sdw_debugfs_exit(void) {}
	44	#endif
	45
9d715fa0 VK	46	enum {
	47	SDW_MSG_FLAG_READ = 0,
	48	SDW_MSG_FLAG_WRITE,
	49	};
	50
	51	/**
	52	* struct sdw_msg - Message structure
	53	* @addr: Register address accessed in the Slave
	54	* @len: number of messages
	55	* @dev_num: Slave device number
	56	* @addr_page1: SCP address page 1 Slave register
	57	* @addr_page2: SCP address page 2 Slave register
	58	* @flags: transfer flags, indicate if xfer is read or write
	59	* @buf: message data buffer
	60	* @ssp_sync: Send message at SSP (Stream Synchronization Point)
	61	* @page: address requires paging
	62	*/
	63	struct sdw_msg {
	64	u16 addr;
	65	u16 len;
	66	u8 dev_num;
	67	u8 addr_page1;
	68	u8 addr_page2;
	69	u8 flags;
	70	u8 *buf;
	71	bool ssp_sync;
	72	bool page;
	73	};
	74
99b8a5d6	75	#define SDW_DOUBLE_RATE_FACTOR 2
9026118f	76	#define SDW_STRM_RATE_GROUPING 1
99b8a5d6	77
fe4b70f2 PLB	78	extern int sdw_rows[SDW_FRAME_ROWS];
	79	extern int sdw_cols[SDW_FRAME_COLS];
	80
	81	int sdw_find_row_index(int row);
	82	int sdw_find_col_index(int col);
99b8a5d6	83
bbe7379d SK	84	/**
	85	* sdw_port_runtime: Runtime port parameters for Master or Slave
	86	*
	87	* @num: Port number. For audio streams, valid port number ranges from
	88	* [1,14]
	89	* @ch_mask: Channel mask
	90	* @transport_params: Transport parameters
	91	* @port_params: Port parameters
	92	* @port_node: List node for Master or Slave port_list
	93	*
	94	* SoundWire spec has no mention of ports for Master interface but the
	95	* concept is logically extended.
	96	*/
	97	struct sdw_port_runtime {
	98	int num;
	99	int ch_mask;
	100	struct sdw_transport_params transport_params;
	101	struct sdw_port_params port_params;
	102	struct list_head port_node;
	103	};
	104
89e59053 SK	105	/**
	106	* sdw_slave_runtime: Runtime Stream parameters for Slave
	107	*
	108	* @slave: Slave handle
	109	* @direction: Data direction for Slave
	110	* @ch_count: Number of channels handled by the Slave for
	111	* this stream
	112	* @m_rt_node: sdw_master_runtime list node
bbe7379d	113	* @port_list: List of Slave Ports configured for this stream
89e59053 SK	114	*/
	115	struct sdw_slave_runtime {
	116	struct sdw_slave *slave;
	117	enum sdw_data_direction direction;
	118	unsigned int ch_count;
	119	struct list_head m_rt_node;
bbe7379d	120	struct list_head port_list;
89e59053 SK	121	};
	122
	123	/**
	124	* sdw_master_runtime: Runtime stream parameters for Master
	125	*
	126	* @bus: Bus handle
	127	* @stream: Stream runtime handle
	128	* @direction: Data direction for Master
	129	* @ch_count: Number of channels handled by the Master for
	130	* this stream, can be zero.
	131	* @slave_rt_list: Slave runtime list
bbe7379d	132	* @port_list: List of Master Ports configured for this stream, can be zero.
0c4a1049	133	* @stream_node: sdw_stream_runtime master_list node
89e59053 SK	134	* @bus_node: sdw_bus m_rt_list node
	135	*/
	136	struct sdw_master_runtime {
	137	struct sdw_bus *bus;
	138	struct sdw_stream_runtime *stream;
	139	enum sdw_data_direction direction;
	140	unsigned int ch_count;
	141	struct list_head slave_rt_list;
bbe7379d	142	struct list_head port_list;
0c4a1049	143	struct list_head stream_node;
89e59053 SK	144	struct list_head bus_node;
	145	};
	146
f8101c74	147	struct sdw_dpn_prop sdw_get_slave_dpn_prop(struct sdw_slave slave,
806a11f0 PLB	148	enum sdw_data_direction direction,
806a11f0 PLB	149	unsigned int port_num);
79df15b7	150	int sdw_configure_dpn_intr(struct sdw_slave *slave, int port,
806a11f0	151	bool enable, int mask);
f8101c74	152
9d715fa0	153	int sdw_transfer(struct sdw_bus bus, struct sdw_msg msg);
45cb70f9	154	int sdw_transfer_defer(struct sdw_bus bus, struct sdw_msg msg);
9d715fa0	155
b0a9c37b VK	156	#define SDW_READ_INTR_CLEAR_RETRY 10
b0a9c37b VK	157
9d715fa0	158	int sdw_fill_msg(struct sdw_msg msg, struct sdw_slave slave,
806a11f0	159	u32 addr, size_t count, u16 dev_num, u8 flags, u8 *buf);
9d715fa0	160
9026118f BL	161	/* Retrieve and return channel count from channel mask */
	162	static inline int sdw_ch_mask_to_ch(int ch_mask)
	163	{
	164	int c = 0;
	165
	166	for (c = 0; ch_mask; ch_mask >>= 1)
	167	c += ch_mask & 1;
	168
	169	return c;
	170	}
	171
	172	/* Fill transport parameter data structure */
	173	static inline void sdw_fill_xport_params(struct sdw_transport_params *params,
	174	int port_num, bool grp_ctrl_valid,
	175	int grp_ctrl, int sample_int,
	176	int off1, int off2,
	177	int hstart, int hstop,
	178	int pack_mode, int lane_ctrl)
	179	{
	180	params->port_num = port_num;
	181	params->blk_grp_ctrl_valid = grp_ctrl_valid;
	182	params->blk_grp_ctrl = grp_ctrl;
	183	params->sample_interval = sample_int;
	184	params->offset1 = off1;
	185	params->offset2 = off2;
	186	params->hstart = hstart;
	187	params->hstop = hstop;
	188	params->blk_pkg_mode = pack_mode;
	189	params->lane_ctrl = lane_ctrl;
	190	}
	191
	192	/* Fill port parameter data structure */
	193	static inline void sdw_fill_port_params(struct sdw_port_params *params,
	194	int port_num, int bps,
	195	int flow_mode, int data_mode)
	196	{
	197	params->num = port_num;
	198	params->bps = bps;
	199	params->flow_mode = flow_mode;
	200	params->data_mode = data_mode;
	201	}
	202
a350aff4 PLB	203	/* broadcast read/write for tests */
	204	int sdw_bread_no_pm_unlocked(struct sdw_bus *bus, u16 dev_num, u32 addr);
	205	int sdw_bwrite_no_pm_unlocked(struct sdw_bus *bus, u16 dev_num, u32 addr, u8 value);
	206
3ab2ca40 PLB	207	/*
	208	* At the moment we only track Master-initiated hw_reset.
	209	* Additional fields can be added as needed
	210	*/
	211	#define SDW_UNATTACH_REQUEST_MASTER_RESET BIT(0)
	212
	213	void sdw_clear_slave_status(struct sdw_bus *bus, u32 request);
bcac5902	214	int sdw_slave_modalias(const struct sdw_slave slave, char buf, size_t size);
3ab2ca40	215
7c3cd189	216	#endif /* __SDW_BUS_H */