Commit | Line | Data |
---|---|---|
afd4aea0 | 1 | /**************************************************************************** |
f7a6d2c4 BH |
2 | * Driver for Solarflare network controllers and boards |
3 | * Copyright 2008-2013 Solarflare Communications Inc. | |
afd4aea0 BH |
4 | * |
5 | * This program is free software; you can redistribute it and/or modify it | |
6 | * under the terms of the GNU General Public License version 2 as published | |
7 | * by the Free Software Foundation, incorporated herein by reference. | |
8 | */ | |
9 | ||
10 | #ifndef EFX_MCDI_H | |
11 | #define EFX_MCDI_H | |
12 | ||
13 | /** | |
f76fe120 | 14 | * enum efx_mcdi_state - MCDI request handling state |
afd4aea0 | 15 | * @MCDI_STATE_QUIESCENT: No pending MCDI requests. If the caller holds the |
f76fe120 | 16 | * mcdi @iface_lock then they are able to move to %MCDI_STATE_RUNNING |
cade715f BH |
17 | * @MCDI_STATE_RUNNING_SYNC: There is a synchronous MCDI request pending. |
18 | * Only the thread that moved into this state is allowed to move out of it. | |
19 | * @MCDI_STATE_RUNNING_ASYNC: There is an asynchronous MCDI request pending. | |
afd4aea0 BH |
20 | * @MCDI_STATE_COMPLETED: An MCDI request has completed, but the owning thread |
21 | * has not yet consumed the result. For all other threads, equivalent to | |
f76fe120 | 22 | * %MCDI_STATE_RUNNING. |
afd4aea0 BH |
23 | */ |
24 | enum efx_mcdi_state { | |
25 | MCDI_STATE_QUIESCENT, | |
cade715f BH |
26 | MCDI_STATE_RUNNING_SYNC, |
27 | MCDI_STATE_RUNNING_ASYNC, | |
afd4aea0 BH |
28 | MCDI_STATE_COMPLETED, |
29 | }; | |
30 | ||
31 | enum efx_mcdi_mode { | |
32 | MCDI_MODE_POLL, | |
33 | MCDI_MODE_EVENTS, | |
34 | }; | |
35 | ||
36 | /** | |
f76fe120 | 37 | * struct efx_mcdi_iface - MCDI protocol context |
cade715f | 38 | * @efx: The associated NIC. |
f76fe120 | 39 | * @state: Request handling state. Waited for by @wq. |
afd4aea0 | 40 | * @mode: Poll for mcdi completion, or wait for an mcdi_event. |
f76fe120 | 41 | * @wq: Wait queue for threads waiting for @state != %MCDI_STATE_RUNNING |
d36a08b4 | 42 | * @new_epoch: Indicates start of day or start of MC reboot recovery |
cade715f | 43 | * @iface_lock: Serialises access to @seqno, @credits and response metadata |
afd4aea0 | 44 | * @seqno: The next sequence number to use for mcdi requests. |
afd4aea0 | 45 | * @credits: Number of spurious MCDI completion events allowed before we |
f76fe120 | 46 | * trigger a fatal error |
5bc283e5 | 47 | * @resprc: Response error/success code (Linux numbering) |
df2cd8af BH |
48 | * @resp_hdr_len: Response header length |
49 | * @resp_data_len: Response data (SDU or error) length | |
cade715f BH |
50 | * @async_lock: Serialises access to @async_list while event processing is |
51 | * enabled | |
52 | * @async_list: Queue of asynchronous requests | |
53 | * @async_timer: Timer for asynchronous request timeout | |
afd4aea0 BH |
54 | */ |
55 | struct efx_mcdi_iface { | |
cade715f | 56 | struct efx_nic *efx; |
251111d9 | 57 | enum efx_mcdi_state state; |
f76fe120 | 58 | enum efx_mcdi_mode mode; |
afd4aea0 BH |
59 | wait_queue_head_t wq; |
60 | spinlock_t iface_lock; | |
d36a08b4 | 61 | bool new_epoch; |
afd4aea0 BH |
62 | unsigned int credits; |
63 | unsigned int seqno; | |
5bc283e5 | 64 | int resprc; |
df2cd8af BH |
65 | size_t resp_hdr_len; |
66 | size_t resp_data_len; | |
cade715f BH |
67 | spinlock_t async_lock; |
68 | struct list_head async_list; | |
69 | struct timer_list async_timer; | |
afd4aea0 BH |
70 | }; |
71 | ||
55c5e0f8 BH |
72 | struct efx_mcdi_mon { |
73 | struct efx_buffer dma_buf; | |
74 | struct mutex update_lock; | |
75 | unsigned long last_update; | |
76 | struct device *device; | |
77 | struct efx_mcdi_mon_attribute *attrs; | |
85493e6d GR |
78 | struct attribute_group group; |
79 | const struct attribute_group *groups[2]; | |
55c5e0f8 BH |
80 | unsigned int n_attrs; |
81 | }; | |
82 | ||
45a3fd55 BH |
83 | struct efx_mcdi_mtd_partition { |
84 | struct efx_mtd_partition common; | |
85 | bool updating; | |
8127d661 | 86 | u16 nvram_type; |
45a3fd55 BH |
87 | u16 fw_subtype; |
88 | }; | |
89 | ||
90 | #define to_efx_mcdi_mtd_partition(mtd) \ | |
91 | container_of(mtd, struct efx_mcdi_mtd_partition, common.mtd) | |
92 | ||
f3ad5003 BH |
93 | /** |
94 | * struct efx_mcdi_data - extra state for NICs that implement MCDI | |
95 | * @iface: Interface/protocol state | |
96 | * @hwmon: Hardware monitor state | |
97 | */ | |
98 | struct efx_mcdi_data { | |
99 | struct efx_mcdi_iface iface; | |
100 | #ifdef CONFIG_SFC_MCDI_MON | |
101 | struct efx_mcdi_mon hwmon; | |
102 | #endif | |
103 | }; | |
104 | ||
105 | #ifdef CONFIG_SFC_MCDI_MON | |
106 | static inline struct efx_mcdi_mon *efx_mcdi_mon(struct efx_nic *efx) | |
107 | { | |
108 | EFX_BUG_ON_PARANOID(!efx->mcdi); | |
109 | return &efx->mcdi->hwmon; | |
110 | } | |
111 | #endif | |
112 | ||
00aef986 JP |
113 | int efx_mcdi_init(struct efx_nic *efx); |
114 | void efx_mcdi_fini(struct efx_nic *efx); | |
afd4aea0 | 115 | |
00aef986 JP |
116 | int efx_mcdi_rpc(struct efx_nic *efx, unsigned cmd, const efx_dword_t *inbuf, |
117 | size_t inlen, efx_dword_t *outbuf, size_t outlen, | |
118 | size_t *outlen_actual); | |
119 | ||
120 | int efx_mcdi_rpc_start(struct efx_nic *efx, unsigned cmd, | |
121 | const efx_dword_t *inbuf, size_t inlen); | |
122 | int efx_mcdi_rpc_finish(struct efx_nic *efx, unsigned cmd, size_t inlen, | |
9528b921 | 123 | efx_dword_t *outbuf, size_t outlen, |
afd4aea0 BH |
124 | size_t *outlen_actual); |
125 | ||
cade715f BH |
126 | typedef void efx_mcdi_async_completer(struct efx_nic *efx, |
127 | unsigned long cookie, int rc, | |
128 | efx_dword_t *outbuf, | |
129 | size_t outlen_actual); | |
00aef986 JP |
130 | int efx_mcdi_rpc_async(struct efx_nic *efx, unsigned int cmd, |
131 | const efx_dword_t *inbuf, size_t inlen, size_t outlen, | |
132 | efx_mcdi_async_completer *complete, | |
133 | unsigned long cookie); | |
9528b921 | 134 | |
00aef986 JP |
135 | int efx_mcdi_poll_reboot(struct efx_nic *efx); |
136 | void efx_mcdi_mode_poll(struct efx_nic *efx); | |
137 | void efx_mcdi_mode_event(struct efx_nic *efx); | |
138 | void efx_mcdi_flush_async(struct efx_nic *efx); | |
afd4aea0 | 139 | |
00aef986 JP |
140 | void efx_mcdi_process_event(struct efx_channel *channel, efx_qword_t *event); |
141 | void efx_mcdi_sensor_event(struct efx_nic *efx, efx_qword_t *ev); | |
afd4aea0 | 142 | |
9528b921 | 143 | /* We expect that 16- and 32-bit fields in MCDI requests and responses |
338f74df BH |
144 | * are appropriately aligned, but 64-bit fields are only |
145 | * 32-bit-aligned. Also, on Siena we must copy to the MC shared | |
146 | * memory strictly 32 bits at a time, so add any necessary padding. | |
9528b921 | 147 | */ |
59cfc479 | 148 | #define MCDI_DECLARE_BUF(_name, _len) \ |
9528b921 | 149 | efx_dword_t _name[DIV_ROUND_UP(_len, 4)] |
a649dfcb BH |
150 | #define _MCDI_PTR(_buf, _offset) \ |
151 | ((u8 *)(_buf) + (_offset)) | |
30af6910 | 152 | #define MCDI_PTR(_buf, _field) \ |
a649dfcb | 153 | _MCDI_PTR(_buf, MC_CMD_ ## _field ## _OFST) |
9528b921 BH |
154 | #define _MCDI_CHECK_ALIGN(_ofst, _align) \ |
155 | ((_ofst) + BUILD_BUG_ON_ZERO((_ofst) & (_align - 1))) | |
30af6910 | 156 | #define _MCDI_DWORD(_buf, _field) \ |
9528b921 | 157 | ((_buf) + (_MCDI_CHECK_ALIGN(MC_CMD_ ## _field ## _OFST, 4) >> 2)) |
59cfc479 | 158 | |
8127d661 BH |
159 | #define MCDI_WORD(_buf, _field) \ |
160 | ((u16)BUILD_BUG_ON_ZERO(MC_CMD_ ## _field ## _LEN != 2) + \ | |
161 | le16_to_cpu(*(__force const __le16 *)MCDI_PTR(_buf, _field))) | |
30af6910 BH |
162 | #define MCDI_SET_DWORD(_buf, _field, _value) \ |
163 | EFX_POPULATE_DWORD_1(*_MCDI_DWORD(_buf, _field), EFX_DWORD_0, _value) | |
164 | #define MCDI_DWORD(_buf, _field) \ | |
165 | EFX_DWORD_FIELD(*_MCDI_DWORD(_buf, _field), EFX_DWORD_0) | |
f5253d92 BH |
166 | #define MCDI_POPULATE_DWORD_1(_buf, _field, _name1, _value1) \ |
167 | EFX_POPULATE_DWORD_1(*_MCDI_DWORD(_buf, _field), \ | |
168 | MC_CMD_ ## _name1, _value1) | |
169 | #define MCDI_POPULATE_DWORD_2(_buf, _field, _name1, _value1, \ | |
170 | _name2, _value2) \ | |
171 | EFX_POPULATE_DWORD_2(*_MCDI_DWORD(_buf, _field), \ | |
172 | MC_CMD_ ## _name1, _value1, \ | |
173 | MC_CMD_ ## _name2, _value2) | |
174 | #define MCDI_POPULATE_DWORD_3(_buf, _field, _name1, _value1, \ | |
175 | _name2, _value2, _name3, _value3) \ | |
176 | EFX_POPULATE_DWORD_3(*_MCDI_DWORD(_buf, _field), \ | |
177 | MC_CMD_ ## _name1, _value1, \ | |
178 | MC_CMD_ ## _name2, _value2, \ | |
179 | MC_CMD_ ## _name3, _value3) | |
180 | #define MCDI_POPULATE_DWORD_4(_buf, _field, _name1, _value1, \ | |
181 | _name2, _value2, _name3, _value3, \ | |
182 | _name4, _value4) \ | |
183 | EFX_POPULATE_DWORD_4(*_MCDI_DWORD(_buf, _field), \ | |
184 | MC_CMD_ ## _name1, _value1, \ | |
185 | MC_CMD_ ## _name2, _value2, \ | |
186 | MC_CMD_ ## _name3, _value3, \ | |
187 | MC_CMD_ ## _name4, _value4) | |
188 | #define MCDI_POPULATE_DWORD_5(_buf, _field, _name1, _value1, \ | |
189 | _name2, _value2, _name3, _value3, \ | |
190 | _name4, _value4, _name5, _value5) \ | |
191 | EFX_POPULATE_DWORD_5(*_MCDI_DWORD(_buf, _field), \ | |
192 | MC_CMD_ ## _name1, _value1, \ | |
193 | MC_CMD_ ## _name2, _value2, \ | |
194 | MC_CMD_ ## _name3, _value3, \ | |
195 | MC_CMD_ ## _name4, _value4, \ | |
196 | MC_CMD_ ## _name5, _value5) | |
197 | #define MCDI_POPULATE_DWORD_6(_buf, _field, _name1, _value1, \ | |
198 | _name2, _value2, _name3, _value3, \ | |
199 | _name4, _value4, _name5, _value5, \ | |
200 | _name6, _value6) \ | |
201 | EFX_POPULATE_DWORD_6(*_MCDI_DWORD(_buf, _field), \ | |
202 | MC_CMD_ ## _name1, _value1, \ | |
203 | MC_CMD_ ## _name2, _value2, \ | |
204 | MC_CMD_ ## _name3, _value3, \ | |
205 | MC_CMD_ ## _name4, _value4, \ | |
206 | MC_CMD_ ## _name5, _value5, \ | |
207 | MC_CMD_ ## _name6, _value6) | |
208 | #define MCDI_POPULATE_DWORD_7(_buf, _field, _name1, _value1, \ | |
209 | _name2, _value2, _name3, _value3, \ | |
210 | _name4, _value4, _name5, _value5, \ | |
211 | _name6, _value6, _name7, _value7) \ | |
212 | EFX_POPULATE_DWORD_7(*_MCDI_DWORD(_buf, _field), \ | |
213 | MC_CMD_ ## _name1, _value1, \ | |
214 | MC_CMD_ ## _name2, _value2, \ | |
215 | MC_CMD_ ## _name3, _value3, \ | |
216 | MC_CMD_ ## _name4, _value4, \ | |
217 | MC_CMD_ ## _name5, _value5, \ | |
218 | MC_CMD_ ## _name6, _value6, \ | |
219 | MC_CMD_ ## _name7, _value7) | |
338f74df BH |
220 | #define MCDI_SET_QWORD(_buf, _field, _value) \ |
221 | do { \ | |
222 | EFX_POPULATE_DWORD_1(_MCDI_DWORD(_buf, _field)[0], \ | |
223 | EFX_DWORD_0, (u32)(_value)); \ | |
224 | EFX_POPULATE_DWORD_1(_MCDI_DWORD(_buf, _field)[1], \ | |
225 | EFX_DWORD_0, (u64)(_value) >> 32); \ | |
226 | } while (0) | |
30af6910 BH |
227 | #define MCDI_QWORD(_buf, _field) \ |
228 | (EFX_DWORD_FIELD(_MCDI_DWORD(_buf, _field)[0], EFX_DWORD_0) | \ | |
229 | (u64)EFX_DWORD_FIELD(_MCDI_DWORD(_buf, _field)[1], EFX_DWORD_0) << 32) | |
a649dfcb BH |
230 | #define MCDI_FIELD(_ptr, _type, _field) \ |
231 | EFX_EXTRACT_DWORD( \ | |
232 | *(efx_dword_t *) \ | |
233 | _MCDI_PTR(_ptr, MC_CMD_ ## _type ## _ ## _field ## _OFST & ~3),\ | |
234 | MC_CMD_ ## _type ## _ ## _field ## _LBN & 0x1f, \ | |
235 | (MC_CMD_ ## _type ## _ ## _field ## _LBN & 0x1f) + \ | |
236 | MC_CMD_ ## _type ## _ ## _field ## _WIDTH - 1) | |
30af6910 | 237 | |
9528b921 BH |
238 | #define _MCDI_ARRAY_PTR(_buf, _field, _index, _align) \ |
239 | (_MCDI_PTR(_buf, _MCDI_CHECK_ALIGN(MC_CMD_ ## _field ## _OFST, _align))\ | |
240 | + (_index) * _MCDI_CHECK_ALIGN(MC_CMD_ ## _field ## _LEN, _align)) | |
a649dfcb | 241 | #define MCDI_DECLARE_STRUCT_PTR(_name) \ |
9528b921 BH |
242 | efx_dword_t *_name |
243 | #define MCDI_ARRAY_STRUCT_PTR(_buf, _field, _index) \ | |
244 | ((efx_dword_t *)_MCDI_ARRAY_PTR(_buf, _field, _index, 4)) | |
a649dfcb BH |
245 | #define MCDI_VAR_ARRAY_LEN(_len, _field) \ |
246 | min_t(size_t, MC_CMD_ ## _field ## _MAXNUM, \ | |
247 | ((_len) - MC_CMD_ ## _field ## _OFST) / MC_CMD_ ## _field ## _LEN) | |
248 | #define MCDI_ARRAY_WORD(_buf, _field, _index) \ | |
249 | (BUILD_BUG_ON_ZERO(MC_CMD_ ## _field ## _LEN != 2) + \ | |
250 | le16_to_cpu(*(__force const __le16 *) \ | |
9528b921 | 251 | _MCDI_ARRAY_PTR(_buf, _field, _index, 2))) |
a649dfcb BH |
252 | #define _MCDI_ARRAY_DWORD(_buf, _field, _index) \ |
253 | (BUILD_BUG_ON_ZERO(MC_CMD_ ## _field ## _LEN != 4) + \ | |
9528b921 | 254 | (efx_dword_t *)_MCDI_ARRAY_PTR(_buf, _field, _index, 4)) |
a649dfcb BH |
255 | #define MCDI_SET_ARRAY_DWORD(_buf, _field, _index, _value) \ |
256 | EFX_SET_DWORD_FIELD(*_MCDI_ARRAY_DWORD(_buf, _field, _index), \ | |
257 | EFX_DWORD_0, _value) | |
258 | #define MCDI_ARRAY_DWORD(_buf, _field, _index) \ | |
259 | EFX_DWORD_FIELD(*_MCDI_ARRAY_DWORD(_buf, _field, _index), EFX_DWORD_0) | |
338f74df BH |
260 | #define _MCDI_ARRAY_QWORD(_buf, _field, _index) \ |
261 | (BUILD_BUG_ON_ZERO(MC_CMD_ ## _field ## _LEN != 8) + \ | |
262 | (efx_dword_t *)_MCDI_ARRAY_PTR(_buf, _field, _index, 4)) | |
263 | #define MCDI_SET_ARRAY_QWORD(_buf, _field, _index, _value) \ | |
264 | do { \ | |
265 | EFX_SET_DWORD_FIELD(_MCDI_ARRAY_QWORD(_buf, _field, _index)[0],\ | |
266 | EFX_DWORD_0, (u32)(_value)); \ | |
267 | EFX_SET_DWORD_FIELD(_MCDI_ARRAY_QWORD(_buf, _field, _index)[1],\ | |
268 | EFX_DWORD_0, (u64)(_value) >> 32); \ | |
269 | } while (0) | |
55c5e0f8 | 270 | #define MCDI_ARRAY_FIELD(_buf, _field1, _type, _index, _field2) \ |
a649dfcb BH |
271 | MCDI_FIELD(MCDI_ARRAY_STRUCT_PTR(_buf, _field1, _index), \ |
272 | _type ## _TYPEDEF, _field2) | |
afd4aea0 | 273 | |
30af6910 BH |
274 | #define MCDI_EVENT_FIELD(_ev, _field) \ |
275 | EFX_QWORD_FIELD(_ev, MCDI_EVENT_ ## _field) | |
276 | ||
00aef986 JP |
277 | void efx_mcdi_print_fwver(struct efx_nic *efx, char *buf, size_t len); |
278 | int efx_mcdi_get_board_cfg(struct efx_nic *efx, u8 *mac_address, | |
279 | u16 *fw_subtype_list, u32 *capabilities); | |
280 | int efx_mcdi_log_ctrl(struct efx_nic *efx, bool evq, bool uart, u32 dest_evq); | |
281 | int efx_mcdi_nvram_types(struct efx_nic *efx, u32 *nvram_types_out); | |
282 | int efx_mcdi_nvram_info(struct efx_nic *efx, unsigned int type, | |
283 | size_t *size_out, size_t *erase_size_out, | |
284 | bool *protected_out); | |
285 | int efx_mcdi_nvram_test_all(struct efx_nic *efx); | |
286 | int efx_mcdi_handle_assertion(struct efx_nic *efx); | |
287 | void efx_mcdi_set_id_led(struct efx_nic *efx, enum efx_led_mode mode); | |
288 | int efx_mcdi_wol_filter_set_magic(struct efx_nic *efx, const u8 *mac, | |
289 | int *id_out); | |
290 | int efx_mcdi_wol_filter_get_magic(struct efx_nic *efx, int *id_out); | |
291 | int efx_mcdi_wol_filter_remove(struct efx_nic *efx, int id); | |
292 | int efx_mcdi_wol_filter_reset(struct efx_nic *efx); | |
293 | int efx_mcdi_flush_rxqs(struct efx_nic *efx); | |
294 | int efx_mcdi_port_probe(struct efx_nic *efx); | |
295 | void efx_mcdi_port_remove(struct efx_nic *efx); | |
296 | int efx_mcdi_port_reconfigure(struct efx_nic *efx); | |
297 | int efx_mcdi_port_get_number(struct efx_nic *efx); | |
298 | u32 efx_mcdi_phy_get_caps(struct efx_nic *efx); | |
299 | void efx_mcdi_process_link_change(struct efx_nic *efx, efx_qword_t *ev); | |
300 | int efx_mcdi_set_mac(struct efx_nic *efx); | |
43f775b2 | 301 | #define EFX_MC_STATS_GENERATION_INVALID ((__force __le64)(-1)) |
00aef986 JP |
302 | void efx_mcdi_mac_start_stats(struct efx_nic *efx); |
303 | void efx_mcdi_mac_stop_stats(struct efx_nic *efx); | |
304 | bool efx_mcdi_mac_check_fault(struct efx_nic *efx); | |
305 | enum reset_type efx_mcdi_map_reset_reason(enum reset_type reason); | |
306 | int efx_mcdi_reset(struct efx_nic *efx, enum reset_type method); | |
307 | int efx_mcdi_set_workaround(struct efx_nic *efx, u32 type, bool enabled); | |
afd4aea0 | 308 | |
55c5e0f8 | 309 | #ifdef CONFIG_SFC_MCDI_MON |
00aef986 JP |
310 | int efx_mcdi_mon_probe(struct efx_nic *efx); |
311 | void efx_mcdi_mon_remove(struct efx_nic *efx); | |
55c5e0f8 BH |
312 | #else |
313 | static inline int efx_mcdi_mon_probe(struct efx_nic *efx) { return 0; } | |
314 | static inline void efx_mcdi_mon_remove(struct efx_nic *efx) {} | |
315 | #endif | |
316 | ||
45a3fd55 | 317 | #ifdef CONFIG_SFC_MTD |
00aef986 JP |
318 | int efx_mcdi_mtd_read(struct mtd_info *mtd, loff_t start, size_t len, |
319 | size_t *retlen, u8 *buffer); | |
320 | int efx_mcdi_mtd_erase(struct mtd_info *mtd, loff_t start, size_t len); | |
321 | int efx_mcdi_mtd_write(struct mtd_info *mtd, loff_t start, size_t len, | |
322 | size_t *retlen, const u8 *buffer); | |
323 | int efx_mcdi_mtd_sync(struct mtd_info *mtd); | |
324 | void efx_mcdi_mtd_rename(struct efx_mtd_partition *part); | |
45a3fd55 BH |
325 | #endif |
326 | ||
afd4aea0 | 327 | #endif /* EFX_MCDI_H */ |