projects / deliverable / linux.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Merge tag 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/dledford/rdma
[deliverable/linux.git] / drivers / net / ethernet / sfc / mcdi.h
CommitLineData
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.
acd43a90
BK		 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.
afd4aea0
BH		 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
f76fe120 24 * %MCDI_STATE_RUNNING.
afd4aea0
BH		 25 */
26enum efx_mcdi_state {
27 MCDI_STATE_QUIESCENT,
cade715f
BH		 28 MCDI_STATE_RUNNING_SYNC,
29 MCDI_STATE_RUNNING_ASYNC,
acd43a90 30 MCDI_STATE_PROXY_WAIT,
afd4aea0
BH		 31 MCDI_STATE_COMPLETED,
32};
33
e283546c
EC		 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 */
afd4aea0
BH		 40enum efx_mcdi_mode {
41 MCDI_MODE_POLL,
42 MCDI_MODE_EVENTS,
e283546c 43 MCDI_MODE_FAIL,
afd4aea0
BH		 44};
45
46/**
f76fe120 47 * struct efx_mcdi_iface - MCDI protocol context
cade715f 48 * @efx: The associated NIC.
f76fe120 49 * @state: Request handling state. Waited for by @wq.
afd4aea0 50 * @mode: Poll for mcdi completion, or wait for an mcdi_event.
f76fe120 51 * @wq: Wait queue for threads waiting for @state != %MCDI_STATE_RUNNING
d36a08b4 52 * @new_epoch: Indicates start of day or start of MC reboot recovery
cade715f 53 * @iface_lock: Serialises access to @seqno, @credits and response metadata
afd4aea0 54 * @seqno: The next sequence number to use for mcdi requests.
afd4aea0 55 * @credits: Number of spurious MCDI completion events allowed before we
f76fe120 56 * trigger a fatal error
5bc283e5 57 * @resprc: Response error/success code (Linux numbering)
df2cd8af
BH		 58 * @resp_hdr_len: Response header length
59 * @resp_data_len: Response data (SDU or error) length
cade715f
BH		 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
75aba2a5 64 * @logging_buffer: buffer that may be used to build MCDI tracing messages
e7fef9b4 65 * @logging_enabled: whether to trace MCDI
acd43a90
BK		 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
afd4aea0
BH		 69 */
70struct efx_mcdi_iface {
cade715f 71 struct efx_nic *efx;
251111d9 72 enum efx_mcdi_state state;
f76fe120 73 enum efx_mcdi_mode mode;
afd4aea0
BH		 74 wait_queue_head_t wq;
75 spinlock_t iface_lock;
d36a08b4 76 bool new_epoch;
afd4aea0
BH		 77 unsigned int credits;
78 unsigned int seqno;
5bc283e5 79 int resprc;
ac28d179 80 int resprc_raw;
df2cd8af
BH		 81 size_t resp_hdr_len;
82 size_t resp_data_len;
cade715f
BH		 83 spinlock_t async_lock;
84 struct list_head async_list;
85 struct timer_list async_timer;
75aba2a5
EC		 86#ifdef CONFIG_SFC_MCDI_LOGGING
87 char *logging_buffer;
e7fef9b4 88 bool logging_enabled;
75aba2a5 89#endif
acd43a90
BK		 90 unsigned int proxy_rx_handle;
91 int proxy_rx_status;
92 wait_queue_head_t proxy_rx_wq;
afd4aea0
BH		 93};
94
55c5e0f8
BH		 95struct 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;
85493e6d
GR		 101 struct attribute_group group;
102 const struct attribute_group *groups[2];
55c5e0f8
BH		 103 unsigned int n_attrs;
104};
105
45a3fd55
BH		 106struct efx_mcdi_mtd_partition {
107 struct efx_mtd_partition common;
108 bool updating;
8127d661 109 u16 nvram_type;
45a3fd55
BH		 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
f3ad5003
BH		 116/**
117 * struct efx_mcdi_data - extra state for NICs that implement MCDI
118 * @iface: Interface/protocol state
119 * @hwmon: Hardware monitor state
8349f7f6 120 * @fn_flags: Flags for this function, as returned by %MC_CMD_DRV_ATTACH.
f3ad5003
BH		 121 */
122struct efx_mcdi_data {
123 struct efx_mcdi_iface iface;
124#ifdef CONFIG_SFC_MCDI_MON
125 struct efx_mcdi_mon hwmon;
126#endif
8349f7f6 127 u32 fn_flags;
f3ad5003
BH		 128};
129
e283546c
EC		 130static inline struct efx_mcdi_iface *efx_mcdi(struct efx_nic *efx)
131{
132 EFX_BUG_ON_PARANOID(!efx->mcdi);
133 return &efx->mcdi->iface;
134}
135
f3ad5003
BH		 136#ifdef CONFIG_SFC_MCDI_MON
137static inline struct efx_mcdi_mon *efx_mcdi_mon(struct efx_nic *efx)
138{
139 EFX_BUG_ON_PARANOID(!efx->mcdi);
140 return &efx->mcdi->hwmon;
141}
142#endif
143
00aef986
JP		 144int efx_mcdi_init(struct efx_nic *efx);
145void efx_mcdi_fini(struct efx_nic *efx);
afd4aea0 146
00aef986
JP		 147int efx_mcdi_rpc(struct efx_nic *efx, unsigned cmd, const efx_dword_t *inbuf,
148 size_t inlen, efx_dword_t *outbuf, size_t outlen,
149 size_t *outlen_actual);
1e0b8120
EC		 150int efx_mcdi_rpc_quiet(struct efx_nic *efx, unsigned cmd,
151 const efx_dword_t *inbuf, size_t inlen,
152 efx_dword_t *outbuf, size_t outlen,
153 size_t *outlen_actual);
00aef986
JP		 154
155int efx_mcdi_rpc_start(struct efx_nic *efx, unsigned cmd,
156 const efx_dword_t *inbuf, size_t inlen);
157int efx_mcdi_rpc_finish(struct efx_nic *efx, unsigned cmd, size_t inlen,
9528b921 158 efx_dword_t *outbuf, size_t outlen,
afd4aea0 159 size_t *outlen_actual);
1e0b8120
EC		 160int efx_mcdi_rpc_finish_quiet(struct efx_nic *efx, unsigned cmd,
161 size_t inlen, efx_dword_t *outbuf,
162 size_t outlen, size_t *outlen_actual);
afd4aea0 163
cade715f
BH		 164typedef void efx_mcdi_async_completer(struct efx_nic *efx,
165 unsigned long cookie, int rc,
166 efx_dword_t *outbuf,
167 size_t outlen_actual);
00aef986
JP		 168int efx_mcdi_rpc_async(struct efx_nic *efx, unsigned int cmd,
169 const efx_dword_t *inbuf, size_t inlen, size_t outlen,
170 efx_mcdi_async_completer *complete,
171 unsigned long cookie);
1e0b8120
EC		 172int efx_mcdi_rpc_async_quiet(struct efx_nic *efx, unsigned int cmd,
173 const efx_dword_t *inbuf, size_t inlen,
174 size_t outlen,
175 efx_mcdi_async_completer *complete,
176 unsigned long cookie);
177
178void efx_mcdi_display_error(struct efx_nic *efx, unsigned cmd,
179 size_t inlen, efx_dword_t *outbuf,
180 size_t outlen, int rc);
9528b921 181
00aef986
JP		 182int efx_mcdi_poll_reboot(struct efx_nic *efx);
183void efx_mcdi_mode_poll(struct efx_nic *efx);
184void efx_mcdi_mode_event(struct efx_nic *efx);
185void efx_mcdi_flush_async(struct efx_nic *efx);
afd4aea0 186
00aef986
JP		 187void efx_mcdi_process_event(struct efx_channel *channel, efx_qword_t *event);
188void efx_mcdi_sensor_event(struct efx_nic *efx, efx_qword_t *ev);
afd4aea0 189
9528b921 190/* We expect that 16- and 32-bit fields in MCDI requests and responses
338f74df
BH		 191 * are appropriately aligned, but 64-bit fields are only
192 * 32-bit-aligned. Also, on Siena we must copy to the MC shared
193 * memory strictly 32 bits at a time, so add any necessary padding.
9528b921 194 */
aa09a3da 195#define _MCDI_DECLARE_BUF(_name, _len) \
9528b921 196 efx_dword_t _name[DIV_ROUND_UP(_len, 4)]
aa09a3da
JC		 197#define MCDI_DECLARE_BUF(_name, _len) \
198 _MCDI_DECLARE_BUF(_name, _len) = {{{0}}}
199#define MCDI_DECLARE_BUF_ERR(_name) \
200 MCDI_DECLARE_BUF(_name, 8)
a649dfcb
BH		 201#define _MCDI_PTR(_buf, _offset) \
202 ((u8 *)(_buf) + (_offset))
30af6910 203#define MCDI_PTR(_buf, _field) \
a649dfcb 204 _MCDI_PTR(_buf, MC_CMD_ ## _field ## _OFST)
9528b921
BH		 205#define _MCDI_CHECK_ALIGN(_ofst, _align) \
206 ((_ofst) + BUILD_BUG_ON_ZERO((_ofst) & (_align - 1)))
30af6910 207#define _MCDI_DWORD(_buf, _field) \
9528b921 208 ((_buf) + (_MCDI_CHECK_ALIGN(MC_CMD_ ## _field ## _OFST, 4) >> 2))
59cfc479 209
8127d661
BH		 210#define MCDI_WORD(_buf, _field) \
211 ((u16)BUILD_BUG_ON_ZERO(MC_CMD_ ## _field ## _LEN != 2) + \
212 le16_to_cpu(*(__force const __le16 *)MCDI_PTR(_buf, _field)))
30af6910
BH		 213#define MCDI_SET_DWORD(_buf, _field, _value) \
214 EFX_POPULATE_DWORD_1(*_MCDI_DWORD(_buf, _field), EFX_DWORD_0, _value)
215#define MCDI_DWORD(_buf, _field) \
216 EFX_DWORD_FIELD(*_MCDI_DWORD(_buf, _field), EFX_DWORD_0)
f5253d92
BH		 217#define MCDI_POPULATE_DWORD_1(_buf, _field, _name1, _value1) \
218 EFX_POPULATE_DWORD_1(*_MCDI_DWORD(_buf, _field), \
219 MC_CMD_ ## _name1, _value1)
220#define MCDI_POPULATE_DWORD_2(_buf, _field, _name1, _value1, \
221 _name2, _value2) \
222 EFX_POPULATE_DWORD_2(*_MCDI_DWORD(_buf, _field), \
223 MC_CMD_ ## _name1, _value1, \
224 MC_CMD_ ## _name2, _value2)
225#define MCDI_POPULATE_DWORD_3(_buf, _field, _name1, _value1, \
226 _name2, _value2, _name3, _value3) \
227 EFX_POPULATE_DWORD_3(*_MCDI_DWORD(_buf, _field), \
228 MC_CMD_ ## _name1, _value1, \
229 MC_CMD_ ## _name2, _value2, \
230 MC_CMD_ ## _name3, _value3)
231#define MCDI_POPULATE_DWORD_4(_buf, _field, _name1, _value1, \
232 _name2, _value2, _name3, _value3, \
233 _name4, _value4) \
234 EFX_POPULATE_DWORD_4(*_MCDI_DWORD(_buf, _field), \
235 MC_CMD_ ## _name1, _value1, \
236 MC_CMD_ ## _name2, _value2, \
237 MC_CMD_ ## _name3, _value3, \
238 MC_CMD_ ## _name4, _value4)
239#define MCDI_POPULATE_DWORD_5(_buf, _field, _name1, _value1, \
240 _name2, _value2, _name3, _value3, \
241 _name4, _value4, _name5, _value5) \
242 EFX_POPULATE_DWORD_5(*_MCDI_DWORD(_buf, _field), \
243 MC_CMD_ ## _name1, _value1, \
244 MC_CMD_ ## _name2, _value2, \
245 MC_CMD_ ## _name3, _value3, \
246 MC_CMD_ ## _name4, _value4, \
247 MC_CMD_ ## _name5, _value5)
248#define MCDI_POPULATE_DWORD_6(_buf, _field, _name1, _value1, \
249 _name2, _value2, _name3, _value3, \
250 _name4, _value4, _name5, _value5, \
251 _name6, _value6) \
252 EFX_POPULATE_DWORD_6(*_MCDI_DWORD(_buf, _field), \
253 MC_CMD_ ## _name1, _value1, \
254 MC_CMD_ ## _name2, _value2, \
255 MC_CMD_ ## _name3, _value3, \
256 MC_CMD_ ## _name4, _value4, \
257 MC_CMD_ ## _name5, _value5, \
258 MC_CMD_ ## _name6, _value6)
259#define MCDI_POPULATE_DWORD_7(_buf, _field, _name1, _value1, \
260 _name2, _value2, _name3, _value3, \
261 _name4, _value4, _name5, _value5, \
262 _name6, _value6, _name7, _value7) \
263 EFX_POPULATE_DWORD_7(*_MCDI_DWORD(_buf, _field), \
264 MC_CMD_ ## _name1, _value1, \
265 MC_CMD_ ## _name2, _value2, \
266 MC_CMD_ ## _name3, _value3, \
267 MC_CMD_ ## _name4, _value4, \
268 MC_CMD_ ## _name5, _value5, \
269 MC_CMD_ ## _name6, _value6, \
270 MC_CMD_ ## _name7, _value7)
338f74df
BH		 271#define MCDI_SET_QWORD(_buf, _field, _value) \
272 do { \
273 EFX_POPULATE_DWORD_1(_MCDI_DWORD(_buf, _field)[0], \
274 EFX_DWORD_0, (u32)(_value)); \
275 EFX_POPULATE_DWORD_1(_MCDI_DWORD(_buf, _field)[1], \
276 EFX_DWORD_0, (u64)(_value) >> 32); \
277 } while (0)
30af6910
BH		 278#define MCDI_QWORD(_buf, _field) \
279 (EFX_DWORD_FIELD(_MCDI_DWORD(_buf, _field)[0], EFX_DWORD_0) | \
280 (u64)EFX_DWORD_FIELD(_MCDI_DWORD(_buf, _field)[1], EFX_DWORD_0) << 32)
a649dfcb
BH		 281#define MCDI_FIELD(_ptr, _type, _field) \
282 EFX_EXTRACT_DWORD( \
283 *(efx_dword_t *) \
284 _MCDI_PTR(_ptr, MC_CMD_ ## _type ## _ ## _field ## _OFST & ~3),\
285 MC_CMD_ ## _type ## _ ## _field ## _LBN & 0x1f, \
286 (MC_CMD_ ## _type ## _ ## _field ## _LBN & 0x1f) + \
287 MC_CMD_ ## _type ## _ ## _field ## _WIDTH - 1)
30af6910 288
9528b921
BH		 289#define _MCDI_ARRAY_PTR(_buf, _field, _index, _align) \
290 (_MCDI_PTR(_buf, _MCDI_CHECK_ALIGN(MC_CMD_ ## _field ## _OFST, _align))\
291 + (_index) * _MCDI_CHECK_ALIGN(MC_CMD_ ## _field ## _LEN, _align))
a649dfcb 292#define MCDI_DECLARE_STRUCT_PTR(_name) \
9528b921
BH		 293 efx_dword_t *_name
294#define MCDI_ARRAY_STRUCT_PTR(_buf, _field, _index) \
295 ((efx_dword_t *)_MCDI_ARRAY_PTR(_buf, _field, _index, 4))
a649dfcb
BH		 296#define MCDI_VAR_ARRAY_LEN(_len, _field) \
297 min_t(size_t, MC_CMD_ ## _field ## _MAXNUM, \
298 ((_len) - MC_CMD_ ## _field ## _OFST) / MC_CMD_ ## _field ## _LEN)
299#define MCDI_ARRAY_WORD(_buf, _field, _index) \
300 (BUILD_BUG_ON_ZERO(MC_CMD_ ## _field ## _LEN != 2) + \
301 le16_to_cpu(*(__force const __le16 *) \
9528b921 302 _MCDI_ARRAY_PTR(_buf, _field, _index, 2)))
a649dfcb
BH		 303#define _MCDI_ARRAY_DWORD(_buf, _field, _index) \
304 (BUILD_BUG_ON_ZERO(MC_CMD_ ## _field ## _LEN != 4) + \
9528b921 305 (efx_dword_t *)_MCDI_ARRAY_PTR(_buf, _field, _index, 4))
a649dfcb
BH		 306#define MCDI_SET_ARRAY_DWORD(_buf, _field, _index, _value) \
307 EFX_SET_DWORD_FIELD(*_MCDI_ARRAY_DWORD(_buf, _field, _index), \
308 EFX_DWORD_0, _value)
309#define MCDI_ARRAY_DWORD(_buf, _field, _index) \
310 EFX_DWORD_FIELD(*_MCDI_ARRAY_DWORD(_buf, _field, _index), EFX_DWORD_0)
338f74df
BH		 311#define _MCDI_ARRAY_QWORD(_buf, _field, _index) \
312 (BUILD_BUG_ON_ZERO(MC_CMD_ ## _field ## _LEN != 8) + \
313 (efx_dword_t *)_MCDI_ARRAY_PTR(_buf, _field, _index, 4))
314#define MCDI_SET_ARRAY_QWORD(_buf, _field, _index, _value) \
315 do { \
316 EFX_SET_DWORD_FIELD(_MCDI_ARRAY_QWORD(_buf, _field, _index)[0],\
317 EFX_DWORD_0, (u32)(_value)); \
318 EFX_SET_DWORD_FIELD(_MCDI_ARRAY_QWORD(_buf, _field, _index)[1],\
319 EFX_DWORD_0, (u64)(_value) >> 32); \
320 } while (0)
55c5e0f8 321#define MCDI_ARRAY_FIELD(_buf, _field1, _type, _index, _field2) \
a649dfcb
BH		 322 MCDI_FIELD(MCDI_ARRAY_STRUCT_PTR(_buf, _field1, _index), \
323 _type ## _TYPEDEF, _field2)
afd4aea0 324
30af6910
BH		 325#define MCDI_EVENT_FIELD(_ev, _field) \
326 EFX_QWORD_FIELD(_ev, MCDI_EVENT_ ## _field)
327
00aef986
JP		 328void efx_mcdi_print_fwver(struct efx_nic *efx, char *buf, size_t len);
329int efx_mcdi_get_board_cfg(struct efx_nic *efx, u8 *mac_address,
330 u16 *fw_subtype_list, u32 *capabilities);
331int efx_mcdi_log_ctrl(struct efx_nic *efx, bool evq, bool uart, u32 dest_evq);
332int efx_mcdi_nvram_types(struct efx_nic *efx, u32 *nvram_types_out);
333int efx_mcdi_nvram_info(struct efx_nic *efx, unsigned int type,
334 size_t *size_out, size_t *erase_size_out,
335 bool *protected_out);
336int efx_mcdi_nvram_test_all(struct efx_nic *efx);
337int efx_mcdi_handle_assertion(struct efx_nic *efx);
338void efx_mcdi_set_id_led(struct efx_nic *efx, enum efx_led_mode mode);
339int efx_mcdi_wol_filter_set_magic(struct efx_nic *efx, const u8 *mac,
340 int *id_out);
341int efx_mcdi_wol_filter_get_magic(struct efx_nic *efx, int *id_out);
342int efx_mcdi_wol_filter_remove(struct efx_nic *efx, int id);
343int efx_mcdi_wol_filter_reset(struct efx_nic *efx);
344int efx_mcdi_flush_rxqs(struct efx_nic *efx);
345int efx_mcdi_port_probe(struct efx_nic *efx);
346void efx_mcdi_port_remove(struct efx_nic *efx);
347int efx_mcdi_port_reconfigure(struct efx_nic *efx);
348int efx_mcdi_port_get_number(struct efx_nic *efx);
349u32 efx_mcdi_phy_get_caps(struct efx_nic *efx);
350void efx_mcdi_process_link_change(struct efx_nic *efx, efx_qword_t *ev);
351int efx_mcdi_set_mac(struct efx_nic *efx);
43f775b2 352#define EFX_MC_STATS_GENERATION_INVALID ((__force __le64)(-1))
00aef986
JP		 353void efx_mcdi_mac_start_stats(struct efx_nic *efx);
354void efx_mcdi_mac_stop_stats(struct efx_nic *efx);
f8f3b5ae 355void efx_mcdi_mac_pull_stats(struct efx_nic *efx);
00aef986
JP		 356bool efx_mcdi_mac_check_fault(struct efx_nic *efx);
357enum reset_type efx_mcdi_map_reset_reason(enum reset_type reason);
358int efx_mcdi_reset(struct efx_nic *efx, enum reset_type method);
34ccfe6f
DP		 359int efx_mcdi_set_workaround(struct efx_nic *efx, u32 type, bool enabled,
360 unsigned int *flags);
267d9d73
EC		 361int efx_mcdi_get_workarounds(struct efx_nic *efx, unsigned int *impl_out,
362 unsigned int *enabled_out);
afd4aea0 363
55c5e0f8 364#ifdef CONFIG_SFC_MCDI_MON
00aef986
JP		 365int efx_mcdi_mon_probe(struct efx_nic *efx);
366void efx_mcdi_mon_remove(struct efx_nic *efx);
55c5e0f8
BH		 367#else
368static inline int efx_mcdi_mon_probe(struct efx_nic *efx) { return 0; }
369static inline void efx_mcdi_mon_remove(struct efx_nic *efx) {}
370#endif
371
45a3fd55 372#ifdef CONFIG_SFC_MTD
00aef986
JP		 373int efx_mcdi_mtd_read(struct mtd_info *mtd, loff_t start, size_t len,
374 size_t *retlen, u8 *buffer);
375int efx_mcdi_mtd_erase(struct mtd_info *mtd, loff_t start, size_t len);
376int efx_mcdi_mtd_write(struct mtd_info *mtd, loff_t start, size_t len,
377 size_t *retlen, const u8 *buffer);
378int efx_mcdi_mtd_sync(struct mtd_info *mtd);
379void efx_mcdi_mtd_rename(struct efx_mtd_partition *part);
45a3fd55
BH		 380#endif
381
afd4aea0 382#endif /* EFX_MCDI_H */
Linux kernel - Deliverables
This page took 0.464119 seconds and 5 git commands to generate.