1 /****************************************************************************
2 * Driver for Solarflare network controllers and boards
3 * Copyright 2008-2013 Solarflare Communications Inc.
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.
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_COMPLETED: An MCDI request has completed, but the owning thread
21 * has not yet consumed the result. For all other threads, equivalent to
22 * %MCDI_STATE_RUNNING.
26 MCDI_STATE_RUNNING_SYNC,
27 MCDI_STATE_RUNNING_ASYNC,
37 * struct efx_mcdi_iface - MCDI protocol context
38 * @efx: The associated NIC.
39 * @state: Request handling state. Waited for by @wq.
40 * @mode: Poll for mcdi completion, or wait for an mcdi_event.
41 * @wq: Wait queue for threads waiting for @state != %MCDI_STATE_RUNNING
42 * @new_epoch: Indicates start of day or start of MC reboot recovery
43 * @iface_lock: Serialises access to @seqno, @credits and response metadata
44 * @seqno: The next sequence number to use for mcdi requests.
45 * @credits: Number of spurious MCDI completion events allowed before we
46 * trigger a fatal error
47 * @resprc: Response error/success code (Linux numbering)
48 * @resp_hdr_len: Response header length
49 * @resp_data_len: Response data (SDU or error) length
50 * @async_lock: Serialises access to @async_list while event processing is
52 * @async_list: Queue of asynchronous requests
53 * @async_timer: Timer for asynchronous request timeout
55 struct efx_mcdi_iface {
57 enum efx_mcdi_state state;
58 enum efx_mcdi_mode mode;
60 spinlock_t iface_lock;
67 spinlock_t async_lock;
68 struct list_head async_list;
69 struct timer_list async_timer;
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;
78 struct attribute_group group;
79 const struct attribute_group *groups[2];
83 struct efx_mcdi_mtd_partition {
84 struct efx_mtd_partition common;
90 #define to_efx_mcdi_mtd_partition(mtd) \
91 container_of(mtd, struct efx_mcdi_mtd_partition, common.mtd)
94 * struct efx_mcdi_data - extra state for NICs that implement MCDI
95 * @iface: Interface/protocol state
96 * @hwmon: Hardware monitor state
98 struct efx_mcdi_data {
99 struct efx_mcdi_iface iface;
100 #ifdef CONFIG_SFC_MCDI_MON
101 struct efx_mcdi_mon hwmon;
105 #ifdef CONFIG_SFC_MCDI_MON
106 static inline struct efx_mcdi_mon *efx_mcdi_mon(struct efx_nic *efx)
108 EFX_BUG_ON_PARANOID(!efx->mcdi);
109 return &efx->mcdi->hwmon;
113 int efx_mcdi_init(struct efx_nic *efx);
114 void efx_mcdi_fini(struct efx_nic *efx);
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);
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,
123 efx_dword_t *outbuf, size_t outlen,
124 size_t *outlen_actual);
126 typedef void efx_mcdi_async_completer(struct efx_nic *efx,
127 unsigned long cookie, int rc,
129 size_t outlen_actual);
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);
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);
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);
143 /* We expect that 16- and 32-bit fields in MCDI requests and responses
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.
148 #define MCDI_DECLARE_BUF(_name, _len) \
149 efx_dword_t _name[DIV_ROUND_UP(_len, 4)]
150 #define _MCDI_PTR(_buf, _offset) \
151 ((u8 *)(_buf) + (_offset))
152 #define MCDI_PTR(_buf, _field) \
153 _MCDI_PTR(_buf, MC_CMD_ ## _field ## _OFST)
154 #define _MCDI_CHECK_ALIGN(_ofst, _align) \
155 ((_ofst) + BUILD_BUG_ON_ZERO((_ofst) & (_align - 1)))
156 #define _MCDI_DWORD(_buf, _field) \
157 ((_buf) + (_MCDI_CHECK_ALIGN(MC_CMD_ ## _field ## _OFST, 4) >> 2))
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)))
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)
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, \
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, \
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, \
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)
220 #define MCDI_SET_QWORD(_buf, _field, _value) \
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); \
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)
230 #define MCDI_FIELD(_ptr, _type, _field) \
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)
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))
241 #define MCDI_DECLARE_STRUCT_PTR(_name) \
243 #define MCDI_ARRAY_STRUCT_PTR(_buf, _field, _index) \
244 ((efx_dword_t *)_MCDI_ARRAY_PTR(_buf, _field, _index, 4))
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 *) \
251 _MCDI_ARRAY_PTR(_buf, _field, _index, 2)))
252 #define _MCDI_ARRAY_DWORD(_buf, _field, _index) \
253 (BUILD_BUG_ON_ZERO(MC_CMD_ ## _field ## _LEN != 4) + \
254 (efx_dword_t *)_MCDI_ARRAY_PTR(_buf, _field, _index, 4))
255 #define MCDI_SET_ARRAY_DWORD(_buf, _field, _index, _value) \
256 EFX_SET_DWORD_FIELD(*_MCDI_ARRAY_DWORD(_buf, _field, _index), \
258 #define MCDI_ARRAY_DWORD(_buf, _field, _index) \
259 EFX_DWORD_FIELD(*_MCDI_ARRAY_DWORD(_buf, _field, _index), EFX_DWORD_0)
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) \
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); \
270 #define MCDI_ARRAY_FIELD(_buf, _field1, _type, _index, _field2) \
271 MCDI_FIELD(MCDI_ARRAY_STRUCT_PTR(_buf, _field1, _index), \
272 _type ## _TYPEDEF, _field2)
274 #define MCDI_EVENT_FIELD(_ev, _field) \
275 EFX_QWORD_FIELD(_ev, MCDI_EVENT_ ## _field)
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,
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);
301 #define EFX_MC_STATS_GENERATION_INVALID ((__force __le64)(-1))
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);
309 #ifdef CONFIG_SFC_MCDI_MON
310 int efx_mcdi_mon_probe(struct efx_nic *efx);
311 void efx_mcdi_mon_remove(struct efx_nic *efx);
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) {}
317 #ifdef CONFIG_SFC_MTD
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);
327 #endif /* EFX_MCDI_H */