[linux.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

#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

void sdw_extract_slave_id(struct sdw_bus *bus,
			u64 addr, struct sdw_slave_id *id);

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

extern int rows[SDW_FRAME_ROWS];
extern int cols[SDW_FRAME_COLS];

/**
 * 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,
				struct sdw_defer *defer);

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

/* Read-Modify-Write Slave register */
static inline int
sdw_update(struct sdw_slave *slave, u32 addr, u8 mask, u8 val)
{
	int tmp;

	tmp = sdw_read(slave, addr);
	if (tmp < 0)
		return tmp;

	tmp = (tmp & ~mask) | val;
	return sdw_write(slave, addr, tmp);
}

#endif /* __SDW_BUS_H */
Commit	Line	Data
7c3cd189 VK	1	// SPDX-License-Identifier: (GPL-2.0 OR BSD-3-Clause)
	2	// Copyright(c) 2015-17 Intel Corporation.
	3
	4	#ifndef __SDW_BUS_H
	5	#define __SDW_BUS_H
	6
ce6e74d0 SN	7	#define DEFAULT_BANK_SWITCH_TIMEOUT 3000
ce6e74d0 SN	8
7c3cd189 VK	9	#if IS_ENABLED(CONFIG_ACPI)
	10	int sdw_acpi_find_slaves(struct sdw_bus *bus);
	11	#else
	12	static inline int sdw_acpi_find_slaves(struct sdw_bus *bus)
	13	{
	14	return -ENOTSUPP;
	15	}
	16	#endif
	17
	18	void sdw_extract_slave_id(struct sdw_bus *bus,
	19	u64 addr, struct sdw_slave_id *id);
	20
9d715fa0 VK	21	enum {
	22	SDW_MSG_FLAG_READ = 0,
	23	SDW_MSG_FLAG_WRITE,
	24	};
	25
	26	/**
	27	* struct sdw_msg - Message structure
	28	* @addr: Register address accessed in the Slave
	29	* @len: number of messages
	30	* @dev_num: Slave device number
	31	* @addr_page1: SCP address page 1 Slave register
	32	* @addr_page2: SCP address page 2 Slave register
	33	* @flags: transfer flags, indicate if xfer is read or write
	34	* @buf: message data buffer
	35	* @ssp_sync: Send message at SSP (Stream Synchronization Point)
	36	* @page: address requires paging
	37	*/
	38	struct sdw_msg {
	39	u16 addr;
	40	u16 len;
	41	u8 dev_num;
	42	u8 addr_page1;
	43	u8 addr_page2;
	44	u8 flags;
	45	u8 *buf;
	46	bool ssp_sync;
	47	bool page;
	48	};
	49
99b8a5d6 SK	50	#define SDW_DOUBLE_RATE_FACTOR 2
	51
	52	extern int rows[SDW_FRAME_ROWS];
	53	extern int cols[SDW_FRAME_COLS];
	54
bbe7379d SK	55	/**
	56	* sdw_port_runtime: Runtime port parameters for Master or Slave
	57	*
	58	* @num: Port number. For audio streams, valid port number ranges from
	59	* [1,14]
	60	* @ch_mask: Channel mask
	61	* @transport_params: Transport parameters
	62	* @port_params: Port parameters
	63	* @port_node: List node for Master or Slave port_list
	64	*
	65	* SoundWire spec has no mention of ports for Master interface but the
	66	* concept is logically extended.
	67	*/
	68	struct sdw_port_runtime {
	69	int num;
	70	int ch_mask;
	71	struct sdw_transport_params transport_params;
	72	struct sdw_port_params port_params;
	73	struct list_head port_node;
	74	};
	75
89e59053 SK	76	/**
	77	* sdw_slave_runtime: Runtime Stream parameters for Slave
	78	*
	79	* @slave: Slave handle
	80	* @direction: Data direction for Slave
	81	* @ch_count: Number of channels handled by the Slave for
	82	* this stream
	83	* @m_rt_node: sdw_master_runtime list node
bbe7379d	84	* @port_list: List of Slave Ports configured for this stream
89e59053 SK	85	*/
	86	struct sdw_slave_runtime {
	87	struct sdw_slave *slave;
	88	enum sdw_data_direction direction;
	89	unsigned int ch_count;
	90	struct list_head m_rt_node;
bbe7379d	91	struct list_head port_list;
89e59053 SK	92	};
	93
	94	/**
	95	* sdw_master_runtime: Runtime stream parameters for Master
	96	*
	97	* @bus: Bus handle
	98	* @stream: Stream runtime handle
	99	* @direction: Data direction for Master
	100	* @ch_count: Number of channels handled by the Master for
	101	* this stream, can be zero.
	102	* @slave_rt_list: Slave runtime list
bbe7379d	103	* @port_list: List of Master Ports configured for this stream, can be zero.
0c4a1049	104	* @stream_node: sdw_stream_runtime master_list node
89e59053 SK	105	* @bus_node: sdw_bus m_rt_list node
	106	*/
	107	struct sdw_master_runtime {
	108	struct sdw_bus *bus;
	109	struct sdw_stream_runtime *stream;
	110	enum sdw_data_direction direction;
	111	unsigned int ch_count;
	112	struct list_head slave_rt_list;
bbe7379d	113	struct list_head port_list;
0c4a1049	114	struct list_head stream_node;
89e59053 SK	115	struct list_head bus_node;
	116	};
	117
f8101c74 SK	118	struct sdw_dpn_prop sdw_get_slave_dpn_prop(struct sdw_slave slave,
	119	enum sdw_data_direction direction,
	120	unsigned int port_num);
79df15b7 SK	121	int sdw_configure_dpn_intr(struct sdw_slave *slave, int port,
79df15b7 SK	122	bool enable, int mask);
f8101c74	123
9d715fa0 VK	124	int sdw_transfer(struct sdw_bus bus, struct sdw_msg msg);
	125	int sdw_transfer_defer(struct sdw_bus bus, struct sdw_msg msg,
	126	struct sdw_defer *defer);
	127
b0a9c37b VK	128	#define SDW_READ_INTR_CLEAR_RETRY 10
b0a9c37b VK	129
9d715fa0 VK	130	int sdw_fill_msg(struct sdw_msg msg, struct sdw_slave slave,
	131	u32 addr, size_t count, u16 dev_num, u8 flags, u8 *buf);
	132
d52d7a1b SK	133	/* Read-Modify-Write Slave register */
	134	static inline int
	135	sdw_update(struct sdw_slave *slave, u32 addr, u8 mask, u8 val)
	136	{
	137	int tmp;
	138
	139	tmp = sdw_read(slave, addr);
	140	if (tmp < 0)
	141	return tmp;
	142
	143	tmp = (tmp & ~mask) \| val;
	144	return sdw_write(slave, addr, tmp);
	145	}
	146
7c3cd189	147	#endif /* __SDW_BUS_H */