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