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 #define DEFAULT_PROBE_TIMEOUT 2000 9 10 u64 sdw_dmi_override_adr(struct sdw_bus *bus, u64 addr); 11 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 21 int sdw_of_find_slaves(struct sdw_bus *bus); 22 void sdw_extract_slave_id(struct sdw_bus *bus, 23 u64 addr, struct sdw_slave_id *id); 24 int sdw_slave_add(struct sdw_bus *bus, struct sdw_slave_id *id, 25 struct fwnode_handle *fwnode); 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); 29 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 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 75 #define SDW_DOUBLE_RATE_FACTOR 2 76 #define SDW_STRM_RATE_GROUPING 1 77 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); 83 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 * @lane: Which lane is used 94 * 95 * SoundWire spec has no mention of ports for Master interface but the 96 * concept is logically extended. 97 */ 98 struct sdw_port_runtime { 99 int num; 100 int ch_mask; 101 struct sdw_transport_params transport_params; 102 struct sdw_port_params port_params; 103 struct list_head port_node; 104 unsigned int lane; 105 }; 106 107 /** 108 * sdw_slave_runtime: Runtime Stream parameters for Slave 109 * 110 * @slave: Slave handle 111 * @direction: Data direction for Slave 112 * @ch_count: Number of channels handled by the Slave for 113 * this stream 114 * @m_rt_node: sdw_master_runtime list node 115 * @port_list: List of Slave Ports configured for this stream 116 */ 117 struct sdw_slave_runtime { 118 struct sdw_slave *slave; 119 enum sdw_data_direction direction; 120 unsigned int ch_count; 121 struct list_head m_rt_node; 122 struct list_head port_list; 123 }; 124 125 /** 126 * sdw_master_runtime: Runtime stream parameters for Master 127 * 128 * @bus: Bus handle 129 * @stream: Stream runtime handle 130 * @direction: Data direction for Master 131 * @ch_count: Number of channels handled by the Master for 132 * this stream, can be zero. 133 * @slave_rt_list: Slave runtime list 134 * @port_list: List of Master Ports configured for this stream, can be zero. 135 * @stream_node: sdw_stream_runtime master_list node 136 * @bus_node: sdw_bus m_rt_list node 137 */ 138 struct sdw_master_runtime { 139 struct sdw_bus *bus; 140 struct sdw_stream_runtime *stream; 141 enum sdw_data_direction direction; 142 unsigned int ch_count; 143 struct list_head slave_rt_list; 144 struct list_head port_list; 145 struct list_head stream_node; 146 struct list_head bus_node; 147 }; 148 149 struct sdw_transport_data { 150 int hstart; 151 int hstop; 152 int block_offset; 153 int sub_block_offset; 154 unsigned int lane; 155 }; 156 157 struct sdw_dpn_prop *sdw_get_slave_dpn_prop(struct sdw_slave *slave, 158 enum sdw_data_direction direction, 159 unsigned int port_num); 160 int sdw_configure_dpn_intr(struct sdw_slave *slave, int port, 161 bool enable, int mask); 162 163 int sdw_transfer(struct sdw_bus *bus, struct sdw_msg *msg); 164 int sdw_transfer_defer(struct sdw_bus *bus, struct sdw_msg *msg); 165 166 #define SDW_READ_INTR_CLEAR_RETRY 10 167 168 int sdw_fill_msg(struct sdw_msg *msg, struct sdw_slave *slave, 169 u32 addr, size_t count, u16 dev_num, u8 flags, u8 *buf); 170 171 /* Fill transport parameter data structure */ 172 static inline void sdw_fill_xport_params(struct sdw_transport_params *params, 173 int port_num, bool grp_ctrl_valid, 174 int grp_ctrl, int sample_int, 175 int off1, int off2, 176 int hstart, int hstop, 177 int pack_mode, int lane_ctrl) 178 { 179 params->port_num = port_num; 180 params->blk_grp_ctrl_valid = grp_ctrl_valid; 181 params->blk_grp_ctrl = grp_ctrl; 182 params->sample_interval = sample_int; 183 params->offset1 = off1; 184 params->offset2 = off2; 185 params->hstart = hstart; 186 params->hstop = hstop; 187 params->blk_pkg_mode = pack_mode; 188 params->lane_ctrl = lane_ctrl; 189 } 190 191 /* Fill port parameter data structure */ 192 static inline void sdw_fill_port_params(struct sdw_port_params *params, 193 int port_num, int bps, 194 int flow_mode, int data_mode) 195 { 196 params->num = port_num; 197 params->bps = bps; 198 params->flow_mode = flow_mode; 199 params->data_mode = data_mode; 200 } 201 202 /* broadcast read/write for tests */ 203 int sdw_bread_no_pm_unlocked(struct sdw_bus *bus, u16 dev_num, u32 addr); 204 int sdw_bwrite_no_pm_unlocked(struct sdw_bus *bus, u16 dev_num, u32 addr, u8 value); 205 206 /* 207 * At the moment we only track Master-initiated hw_reset. 208 * Additional fields can be added as needed 209 */ 210 #define SDW_UNATTACH_REQUEST_MASTER_RESET BIT(0) 211 212 void sdw_clear_slave_status(struct sdw_bus *bus, u32 request); 213 int sdw_slave_modalias(const struct sdw_slave *slave, char *buf, size_t size); 214 void sdw_compute_slave_ports(struct sdw_master_runtime *m_rt, 215 struct sdw_transport_data *t_data); 216 217 #endif /* __SDW_BUS_H */ 218