1 /****************************************************************************
2 * Driver for Solarflare network controllers and boards
3 * Copyright 2008-2013 Solarflare Communications Inc.
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 /**
14 * enum efx_mcdi_state - MCDI request handling state
15 * @MCDI_STATE_QUIESCENT: No pending MCDI requests. If the caller holds the
16 * mcdi @iface_lock then they are able to move to %MCDI_STATE_RUNNING
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.
20 * @MCDI_STATE_PROXY_WAIT: An MCDI request has completed with a response that
21 * indicates we must wait for a proxy try again message.
22 * @MCDI_STATE_COMPLETED: An MCDI request has completed, but the owning thread
23 * has not yet consumed the result. For all other threads, equivalent to
24 * %MCDI_STATE_RUNNING.
25 */
26 enum efx_mcdi_state {
27 MCDI_STATE_QUIESCENT,
28 MCDI_STATE_RUNNING_SYNC,
29 MCDI_STATE_RUNNING_ASYNC,
30 MCDI_STATE_PROXY_WAIT,
31 MCDI_STATE_COMPLETED,
32 };
33
34 /**
35 * enum efx_mcdi_mode - MCDI transaction mode
36 * @MCDI_MODE_POLL: poll for MCDI completion, until timeout
37 * @MCDI_MODE_EVENTS: wait for an mcdi_event. On timeout, poll once
38 * @MCDI_MODE_FAIL: we think MCDI is dead, so fail-fast all calls
39 */
40 enum efx_mcdi_mode {
41 MCDI_MODE_POLL,
42 MCDI_MODE_EVENTS,
43 MCDI_MODE_FAIL,
44 };
45
46 /**
47 * struct efx_mcdi_iface - MCDI protocol context
48 * @efx: The associated NIC.
49 * @state: Request handling state. Waited for by @wq.
50 * @mode: Poll for mcdi completion, or wait for an mcdi_event.
51 * @wq: Wait queue for threads waiting for @state != %MCDI_STATE_RUNNING
52 * @new_epoch: Indicates start of day or start of MC reboot recovery
53 * @iface_lock: Serialises access to @seqno, @credits and response metadata
54 * @seqno: The next sequence number to use for mcdi requests.
55 * @credits: Number of spurious MCDI completion events allowed before we
56 * trigger a fatal error
57 * @resprc: Response error/success code (Linux numbering)
58 * @resp_hdr_len: Response header length
59 * @resp_data_len: Response data (SDU or error) length
60 * @async_lock: Serialises access to @async_list while event processing is
61 * enabled
62 * @async_list: Queue of asynchronous requests
63 * @async_timer: Timer for asynchronous request timeout
64 * @logging_buffer: buffer that may be used to build MCDI tracing messages
65 * @logging_enabled: whether to trace MCDI
66 * @proxy_rx_handle: Most recently received proxy authorisation handle
67 * @proxy_rx_status: Status of most recent proxy authorisation
68 * @proxy_rx_wq: Wait queue for updates to proxy_rx_handle
69 */
70 struct efx_mcdi_iface {
71 struct efx_nic *efx;
72 enum efx_mcdi_state state;
73 enum efx_mcdi_mode mode;
74 wait_queue_head_t wq;
75 spinlock_t iface_lock;
76 bool new_epoch;
77 unsigned int credits;
78 unsigned int seqno;
79 int resprc;
80 int resprc_raw;
81 size_t resp_hdr_len;
82 size_t resp_data_len;
83 spinlock_t async_lock;
84 struct list_head async_list;
85 struct timer_list async_timer;
86 #ifdef CONFIG_SFC_MCDI_LOGGING
87 char *logging_buffer;
88 bool logging_enabled;
89 #endif
90 unsigned int proxy_rx_handle;
91 int proxy_rx_status;
92 wait_queue_head_t proxy_rx_wq;
93 };
94
95 struct efx_mcdi_mon {
96 struct efx_buffer dma_buf;
97 struct mutex update_lock;
98 unsigned long last_update;
99 struct device *device;
100 struct efx_mcdi_mon_attribute *attrs;
101 struct attribute_group group;
102 const struct attribute_group *groups[2];
103 unsigned int n_attrs;
104 };
105
106 struct efx_mcdi_mtd_partition {
107 struct efx_mtd_partition common;
108 bool updating;
109 u16 nvram_type;
110 u16 fw_subtype;
111 };
112
113 #define to_efx_mcdi_mtd_partition(mtd) \
114 container_of(mtd, struct efx_mcdi_mtd_partition, common.mtd)
115
116 /**
117 * struct efx_mcdi_data - extra state for NICs that implement MCDI
118 * @iface: Interface/protocol state
119 * @hwmon: Hardware monitor state
120 * @fn_flags: Flags for this function, as returned by %MC_CMD_DRV_ATTACH.
121 */
122 struct efx_mcdi_data {
123 struct efx_mcdi_iface iface;
124 #ifdef CONFIG_SFC_MCDI_MON
125 struct efx_mcdi_mon hwmon;
126 #endif
127 u32 fn_flags;
128 };
129
efx_mcdi(struct efx_nic * efx)130 static inline struct efx_mcdi_iface *efx_mcdi(struct efx_nic *efx)
131 {
132 EFX_WARN_ON_PARANOID(!efx->mcdi);
133 return &efx->mcdi->iface;
134 }
135
136 #ifdef CONFIG_SFC_MCDI_MON
efx_mcdi_mon(struct efx_nic * efx)137 static inline struct efx_mcdi_mon *efx_mcdi_mon(struct efx_nic *efx)
138 {
139 EFX_WARN_ON_PARANOID(!efx->mcdi);
140 return &efx->mcdi->hwmon;
141 }
142 #endif
143
144 int efx_mcdi_init(struct efx_nic *efx);
145 void efx_mcdi_detach(struct efx_nic *efx);
146 void efx_mcdi_fini(struct efx_nic *efx);
147
148 int efx_mcdi_rpc(struct efx_nic *efx, unsigned cmd, const efx_dword_t *inbuf,
149 size_t inlen, efx_dword_t *outbuf, size_t outlen,
150 size_t *outlen_actual);
151 int efx_mcdi_rpc_quiet(struct efx_nic *efx, unsigned cmd,
152 const efx_dword_t *inbuf, size_t inlen,
153 efx_dword_t *outbuf, size_t outlen,
154 size_t *outlen_actual);
155
156 int efx_mcdi_rpc_start(struct efx_nic *efx, unsigned cmd,
157 const efx_dword_t *inbuf, size_t inlen);
158 int efx_mcdi_rpc_finish(struct efx_nic *efx, unsigned cmd, size_t inlen,
159 efx_dword_t *outbuf, size_t outlen,
160 size_t *outlen_actual);
161 int efx_mcdi_rpc_finish_quiet(struct efx_nic *efx, unsigned cmd,
162 size_t inlen, efx_dword_t *outbuf,
163 size_t outlen, size_t *outlen_actual);
164
165 typedef void efx_mcdi_async_completer(struct efx_nic *efx,
166 unsigned long cookie, int rc,
167 efx_dword_t *outbuf,
168 size_t outlen_actual);
169 int efx_mcdi_rpc_async(struct efx_nic *efx, unsigned int cmd,
170 const efx_dword_t *inbuf, size_t inlen, size_t outlen,
171 efx_mcdi_async_completer *complete,
172 unsigned long cookie);
173 int efx_mcdi_rpc_async_quiet(struct efx_nic *efx, unsigned int cmd,
174 const efx_dword_t *inbuf, size_t inlen,
175 size_t outlen,
176 efx_mcdi_async_completer *complete,
177 unsigned long cookie);
178
179 void efx_mcdi_display_error(struct efx_nic *efx, unsigned cmd,
180 size_t inlen, efx_dword_t *outbuf,
181 size_t outlen, int rc);
182
183 int efx_mcdi_poll_reboot(struct efx_nic *efx);
184 void efx_mcdi_mode_poll(struct efx_nic *efx);
185 void efx_mcdi_mode_event(struct efx_nic *efx);
186 void efx_mcdi_flush_async(struct efx_nic *efx);
187
188 void efx_mcdi_process_event(struct efx_channel *channel, efx_qword_t *event);
189 void efx_mcdi_sensor_event(struct efx_nic *efx, efx_qword_t *ev);
190
191 /* We expect that 16- and 32-bit fields in MCDI requests and responses
192 * are appropriately aligned, but 64-bit fields are only
193 * 32-bit-aligned. Also, on Siena we must copy to the MC shared
194 * memory strictly 32 bits at a time, so add any necessary padding.
195 */
196 #define _MCDI_DECLARE_BUF(_name, _len) \
197 efx_dword_t _name[DIV_ROUND_UP(_len, 4)]
198 #define MCDI_DECLARE_BUF(_name, _len) \
199 _MCDI_DECLARE_BUF(_name, _len) = {{{0}}}
200 #define MCDI_DECLARE_BUF_ERR(_name) \
201 MCDI_DECLARE_BUF(_name, 8)
202 #define _MCDI_PTR(_buf, _offset) \
203 ((u8 *)(_buf) + (_offset))
204 #define MCDI_PTR(_buf, _field) \
205 _MCDI_PTR(_buf, MC_CMD_ ## _field ## _OFST)
206 #define _MCDI_CHECK_ALIGN(_ofst, _align) \
207 ((_ofst) + BUILD_BUG_ON_ZERO((_ofst) & (_align - 1)))
208 #define _MCDI_DWORD(_buf, _field) \
209 ((_buf) + (_MCDI_CHECK_ALIGN(MC_CMD_ ## _field ## _OFST, 4) >> 2))
210
211 #define MCDI_BYTE(_buf, _field) \
212 ((void)BUILD_BUG_ON_ZERO(MC_CMD_ ## _field ## _LEN != 1), \
213 *MCDI_PTR(_buf, _field))
214 #define MCDI_WORD(_buf, _field) \
215 ((u16)BUILD_BUG_ON_ZERO(MC_CMD_ ## _field ## _LEN != 2) + \
216 le16_to_cpu(*(__force const __le16 *)MCDI_PTR(_buf, _field)))
217 #define MCDI_SET_DWORD(_buf, _field, _value) \
218 EFX_POPULATE_DWORD_1(*_MCDI_DWORD(_buf, _field), EFX_DWORD_0, _value)
219 #define MCDI_DWORD(_buf, _field) \
220 EFX_DWORD_FIELD(*_MCDI_DWORD(_buf, _field), EFX_DWORD_0)
221 #define MCDI_POPULATE_DWORD_1(_buf, _field, _name1, _value1) \
222 EFX_POPULATE_DWORD_1(*_MCDI_DWORD(_buf, _field), \
223 MC_CMD_ ## _name1, _value1)
224 #define MCDI_POPULATE_DWORD_2(_buf, _field, _name1, _value1, \
225 _name2, _value2) \
226 EFX_POPULATE_DWORD_2(*_MCDI_DWORD(_buf, _field), \
227 MC_CMD_ ## _name1, _value1, \
228 MC_CMD_ ## _name2, _value2)
229 #define MCDI_POPULATE_DWORD_3(_buf, _field, _name1, _value1, \
230 _name2, _value2, _name3, _value3) \
231 EFX_POPULATE_DWORD_3(*_MCDI_DWORD(_buf, _field), \
232 MC_CMD_ ## _name1, _value1, \
233 MC_CMD_ ## _name2, _value2, \
234 MC_CMD_ ## _name3, _value3)
235 #define MCDI_POPULATE_DWORD_4(_buf, _field, _name1, _value1, \
236 _name2, _value2, _name3, _value3, \
237 _name4, _value4) \
238 EFX_POPULATE_DWORD_4(*_MCDI_DWORD(_buf, _field), \
239 MC_CMD_ ## _name1, _value1, \
240 MC_CMD_ ## _name2, _value2, \
241 MC_CMD_ ## _name3, _value3, \
242 MC_CMD_ ## _name4, _value4)
243 #define MCDI_POPULATE_DWORD_5(_buf, _field, _name1, _value1, \
244 _name2, _value2, _name3, _value3, \
245 _name4, _value4, _name5, _value5) \
246 EFX_POPULATE_DWORD_5(*_MCDI_DWORD(_buf, _field), \
247 MC_CMD_ ## _name1, _value1, \
248 MC_CMD_ ## _name2, _value2, \
249 MC_CMD_ ## _name3, _value3, \
250 MC_CMD_ ## _name4, _value4, \
251 MC_CMD_ ## _name5, _value5)
252 #define MCDI_POPULATE_DWORD_6(_buf, _field, _name1, _value1, \
253 _name2, _value2, _name3, _value3, \
254 _name4, _value4, _name5, _value5, \
255 _name6, _value6) \
256 EFX_POPULATE_DWORD_6(*_MCDI_DWORD(_buf, _field), \
257 MC_CMD_ ## _name1, _value1, \
258 MC_CMD_ ## _name2, _value2, \
259 MC_CMD_ ## _name3, _value3, \
260 MC_CMD_ ## _name4, _value4, \
261 MC_CMD_ ## _name5, _value5, \
262 MC_CMD_ ## _name6, _value6)
263 #define MCDI_POPULATE_DWORD_7(_buf, _field, _name1, _value1, \
264 _name2, _value2, _name3, _value3, \
265 _name4, _value4, _name5, _value5, \
266 _name6, _value6, _name7, _value7) \
267 EFX_POPULATE_DWORD_7(*_MCDI_DWORD(_buf, _field), \
268 MC_CMD_ ## _name1, _value1, \
269 MC_CMD_ ## _name2, _value2, \
270 MC_CMD_ ## _name3, _value3, \
271 MC_CMD_ ## _name4, _value4, \
272 MC_CMD_ ## _name5, _value5, \
273 MC_CMD_ ## _name6, _value6, \
274 MC_CMD_ ## _name7, _value7)
275 #define MCDI_SET_QWORD(_buf, _field, _value) \
276 do { \
277 EFX_POPULATE_DWORD_1(_MCDI_DWORD(_buf, _field)[0], \
278 EFX_DWORD_0, (u32)(_value)); \
279 EFX_POPULATE_DWORD_1(_MCDI_DWORD(_buf, _field)[1], \
280 EFX_DWORD_0, (u64)(_value) >> 32); \
281 } while (0)
282 #define MCDI_QWORD(_buf, _field) \
283 (EFX_DWORD_FIELD(_MCDI_DWORD(_buf, _field)[0], EFX_DWORD_0) | \
284 (u64)EFX_DWORD_FIELD(_MCDI_DWORD(_buf, _field)[1], EFX_DWORD_0) << 32)
285 #define MCDI_FIELD(_ptr, _type, _field) \
286 EFX_EXTRACT_DWORD( \
287 *(efx_dword_t *) \
288 _MCDI_PTR(_ptr, MC_CMD_ ## _type ## _ ## _field ## _OFST & ~3),\
289 MC_CMD_ ## _type ## _ ## _field ## _LBN & 0x1f, \
290 (MC_CMD_ ## _type ## _ ## _field ## _LBN & 0x1f) + \
291 MC_CMD_ ## _type ## _ ## _field ## _WIDTH - 1)
292
293 #define _MCDI_ARRAY_PTR(_buf, _field, _index, _align) \
294 (_MCDI_PTR(_buf, _MCDI_CHECK_ALIGN(MC_CMD_ ## _field ## _OFST, _align))\
295 + (_index) * _MCDI_CHECK_ALIGN(MC_CMD_ ## _field ## _LEN, _align))
296 #define MCDI_DECLARE_STRUCT_PTR(_name) \
297 efx_dword_t *_name
298 #define MCDI_ARRAY_STRUCT_PTR(_buf, _field, _index) \
299 ((efx_dword_t *)_MCDI_ARRAY_PTR(_buf, _field, _index, 4))
300 #define MCDI_VAR_ARRAY_LEN(_len, _field) \
301 min_t(size_t, MC_CMD_ ## _field ## _MAXNUM, \
302 ((_len) - MC_CMD_ ## _field ## _OFST) / MC_CMD_ ## _field ## _LEN)
303 #define MCDI_ARRAY_WORD(_buf, _field, _index) \
304 (BUILD_BUG_ON_ZERO(MC_CMD_ ## _field ## _LEN != 2) + \
305 le16_to_cpu(*(__force const __le16 *) \
306 _MCDI_ARRAY_PTR(_buf, _field, _index, 2)))
307 #define _MCDI_ARRAY_DWORD(_buf, _field, _index) \
308 (BUILD_BUG_ON_ZERO(MC_CMD_ ## _field ## _LEN != 4) + \
309 (efx_dword_t *)_MCDI_ARRAY_PTR(_buf, _field, _index, 4))
310 #define MCDI_SET_ARRAY_DWORD(_buf, _field, _index, _value) \
311 EFX_SET_DWORD_FIELD(*_MCDI_ARRAY_DWORD(_buf, _field, _index), \
312 EFX_DWORD_0, _value)
313 #define MCDI_ARRAY_DWORD(_buf, _field, _index) \
314 EFX_DWORD_FIELD(*_MCDI_ARRAY_DWORD(_buf, _field, _index), EFX_DWORD_0)
315 #define _MCDI_ARRAY_QWORD(_buf, _field, _index) \
316 (BUILD_BUG_ON_ZERO(MC_CMD_ ## _field ## _LEN != 8) + \
317 (efx_dword_t *)_MCDI_ARRAY_PTR(_buf, _field, _index, 4))
318 #define MCDI_SET_ARRAY_QWORD(_buf, _field, _index, _value) \
319 do { \
320 EFX_SET_DWORD_FIELD(_MCDI_ARRAY_QWORD(_buf, _field, _index)[0],\
321 EFX_DWORD_0, (u32)(_value)); \
322 EFX_SET_DWORD_FIELD(_MCDI_ARRAY_QWORD(_buf, _field, _index)[1],\
323 EFX_DWORD_0, (u64)(_value) >> 32); \
324 } while (0)
325 #define MCDI_ARRAY_FIELD(_buf, _field1, _type, _index, _field2) \
326 MCDI_FIELD(MCDI_ARRAY_STRUCT_PTR(_buf, _field1, _index), \
327 _type ## _TYPEDEF, _field2)
328
329 #define MCDI_EVENT_FIELD(_ev, _field) \
330 EFX_QWORD_FIELD(_ev, MCDI_EVENT_ ## _field)
331
332 void efx_mcdi_print_fwver(struct efx_nic *efx, char *buf, size_t len);
333 int efx_mcdi_get_board_cfg(struct efx_nic *efx, u8 *mac_address,
334 u16 *fw_subtype_list, u32 *capabilities);
335 int efx_mcdi_log_ctrl(struct efx_nic *efx, bool evq, bool uart, u32 dest_evq);
336 int efx_mcdi_nvram_types(struct efx_nic *efx, u32 *nvram_types_out);
337 int efx_mcdi_nvram_info(struct efx_nic *efx, unsigned int type,
338 size_t *size_out, size_t *erase_size_out,
339 bool *protected_out);
340 int efx_mcdi_nvram_test_all(struct efx_nic *efx);
341 int efx_mcdi_handle_assertion(struct efx_nic *efx);
342 void efx_mcdi_set_id_led(struct efx_nic *efx, enum efx_led_mode mode);
343 int efx_mcdi_wol_filter_set_magic(struct efx_nic *efx, const u8 *mac,
344 int *id_out);
345 int efx_mcdi_wol_filter_get_magic(struct efx_nic *efx, int *id_out);
346 int efx_mcdi_wol_filter_remove(struct efx_nic *efx, int id);
347 int efx_mcdi_wol_filter_reset(struct efx_nic *efx);
348 int efx_mcdi_flush_rxqs(struct efx_nic *efx);
349 int efx_mcdi_port_probe(struct efx_nic *efx);
350 void efx_mcdi_port_remove(struct efx_nic *efx);
351 int efx_mcdi_port_reconfigure(struct efx_nic *efx);
352 int efx_mcdi_port_get_number(struct efx_nic *efx);
353 u32 efx_mcdi_phy_get_caps(struct efx_nic *efx);
354 void efx_mcdi_process_link_change(struct efx_nic *efx, efx_qword_t *ev);
355 int efx_mcdi_set_mac(struct efx_nic *efx);
356 #define EFX_MC_STATS_GENERATION_INVALID ((__force __le64)(-1))
357 void efx_mcdi_mac_start_stats(struct efx_nic *efx);
358 void efx_mcdi_mac_stop_stats(struct efx_nic *efx);
359 void efx_mcdi_mac_pull_stats(struct efx_nic *efx);
360 bool efx_mcdi_mac_check_fault(struct efx_nic *efx);
361 enum reset_type efx_mcdi_map_reset_reason(enum reset_type reason);
362 int efx_mcdi_reset(struct efx_nic *efx, enum reset_type method);
363 int efx_mcdi_set_workaround(struct efx_nic *efx, u32 type, bool enabled,
364 unsigned int *flags);
365 int efx_mcdi_get_workarounds(struct efx_nic *efx, unsigned int *impl_out,
366 unsigned int *enabled_out);
367
368 #ifdef CONFIG_SFC_MCDI_MON
369 int efx_mcdi_mon_probe(struct efx_nic *efx);
370 void efx_mcdi_mon_remove(struct efx_nic *efx);
371 #else
efx_mcdi_mon_probe(struct efx_nic * efx)372 static inline int efx_mcdi_mon_probe(struct efx_nic *efx) { return 0; }
efx_mcdi_mon_remove(struct efx_nic * efx)373 static inline void efx_mcdi_mon_remove(struct efx_nic *efx) {}
374 #endif
375
376 #ifdef CONFIG_SFC_MTD
377 int efx_mcdi_mtd_read(struct mtd_info *mtd, loff_t start, size_t len,
378 size_t *retlen, u8 *buffer);
379 int efx_mcdi_mtd_erase(struct mtd_info *mtd, loff_t start, size_t len);
380 int efx_mcdi_mtd_write(struct mtd_info *mtd, loff_t start, size_t len,
381 size_t *retlen, const u8 *buffer);
382 int efx_mcdi_mtd_sync(struct mtd_info *mtd);
383 void efx_mcdi_mtd_rename(struct efx_mtd_partition *part);
384 #endif
385
386 #endif /* EFX_MCDI_H */
387
