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