projects / deliverable / linux.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
sfc: Move and rename Falcon/Siena common NIC operations
[deliverable/linux.git] / drivers / net / ethernet / sfc / mcdi.h
CommitLineData
afd4aea0
BH		 1/****************************************************************************
2 * Driver for Solarflare Solarstorm network controllers and boards
0a6f40c6 3 * Copyright 2008-2010 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/**
14 * enum efx_mcdi_state
15 * @MCDI_STATE_QUIESCENT: No pending MCDI requests. If the caller holds the
16 * mcdi_lock then they are able to move to MCDI_STATE_RUNNING
17 * @MCDI_STATE_RUNNING: There is an MCDI request pending. Only the thread that
18 * moved into this state is allowed to move out of it.
19 * @MCDI_STATE_COMPLETED: An MCDI request has completed, but the owning thread
20 * has not yet consumed the result. For all other threads, equivalent to
21 * MCDI_STATE_RUNNING.
22 */
23enum efx_mcdi_state {
24 MCDI_STATE_QUIESCENT,
25 MCDI_STATE_RUNNING,
26 MCDI_STATE_COMPLETED,
27};
28
29enum efx_mcdi_mode {
30 MCDI_MODE_POLL,
31 MCDI_MODE_EVENTS,
32};
33
34/**
35 * struct efx_mcdi_iface
36 * @state: Interface state. Waited for by mcdi_wq.
37 * @wq: Wait queue for threads waiting for state != STATE_RUNNING
38 * @iface_lock: Protects @credits, @seqno, @resprc, @resplen
39 * @mode: Poll for mcdi completion, or wait for an mcdi_event.
40 * Serialised by @lock
41 * @seqno: The next sequence number to use for mcdi requests.
42 * Serialised by @lock
43 * @credits: Number of spurious MCDI completion events allowed before we
44 * trigger a fatal error. Protected by @lock
45 * @resprc: Returned MCDI completion
46 * @resplen: Returned payload length
47 */
48struct efx_mcdi_iface {
49 atomic_t state;
50 wait_queue_head_t wq;
51 spinlock_t iface_lock;
52 enum efx_mcdi_mode mode;
53 unsigned int credits;
54 unsigned int seqno;
55 unsigned int resprc;
56 size_t resplen;
57};
58
55c5e0f8
BH		 59struct efx_mcdi_mon {
60 struct efx_buffer dma_buf;
61 struct mutex update_lock;
62 unsigned long last_update;
63 struct device *device;
64 struct efx_mcdi_mon_attribute *attrs;
65 unsigned int n_attrs;
66};
67
f3ad5003
BH		 68/**
69 * struct efx_mcdi_data - extra state for NICs that implement MCDI
70 * @iface: Interface/protocol state
71 * @hwmon: Hardware monitor state
72 */
73struct efx_mcdi_data {
74 struct efx_mcdi_iface iface;
75#ifdef CONFIG_SFC_MCDI_MON
76 struct efx_mcdi_mon hwmon;
77#endif
78};
79
80#ifdef CONFIG_SFC_MCDI_MON
81static inline struct efx_mcdi_mon *efx_mcdi_mon(struct efx_nic *efx)
82{
83 EFX_BUG_ON_PARANOID(!efx->mcdi);
84 return &efx->mcdi->hwmon;
85}
86#endif
87
f073dde0 88extern int efx_mcdi_init(struct efx_nic *efx);
f3ad5003 89extern void efx_mcdi_fini(struct efx_nic *efx);
afd4aea0 90
9528b921
BH		 91extern int efx_mcdi_rpc(struct efx_nic *efx, unsigned cmd,
92 const efx_dword_t *inbuf, size_t inlen,
93 efx_dword_t *outbuf, size_t outlen,
afd4aea0
BH		 94 size_t *outlen_actual);
95
c3cba721 96extern void efx_mcdi_rpc_start(struct efx_nic *efx, unsigned cmd,
9528b921 97 const efx_dword_t *inbuf, size_t inlen);
c3cba721 98extern int efx_mcdi_rpc_finish(struct efx_nic *efx, unsigned cmd, size_t inlen,
9528b921 99 efx_dword_t *outbuf, size_t outlen,
c3cba721
SH		 100 size_t *outlen_actual);
101
9528b921 102
afd4aea0
BH		 103extern int efx_mcdi_poll_reboot(struct efx_nic *efx);
104extern void efx_mcdi_mode_poll(struct efx_nic *efx);
105extern void efx_mcdi_mode_event(struct efx_nic *efx);
106
107extern void efx_mcdi_process_event(struct efx_channel *channel,
108 efx_qword_t *event);
55c5e0f8 109extern void efx_mcdi_sensor_event(struct efx_nic *efx, efx_qword_t *ev);
afd4aea0 110
9528b921 111/* We expect that 16- and 32-bit fields in MCDI requests and responses
338f74df
BH		 112 * are appropriately aligned, but 64-bit fields are only
113 * 32-bit-aligned. Also, on Siena we must copy to the MC shared
114 * memory strictly 32 bits at a time, so add any necessary padding.
9528b921 115 */
59cfc479 116#define MCDI_DECLARE_BUF(_name, _len) \
9528b921 117 efx_dword_t _name[DIV_ROUND_UP(_len, 4)]
a649dfcb
BH		 118#define _MCDI_PTR(_buf, _offset) \
119 ((u8 *)(_buf) + (_offset))
30af6910 120#define MCDI_PTR(_buf, _field) \
a649dfcb 121 _MCDI_PTR(_buf, MC_CMD_ ## _field ## _OFST)
9528b921
BH		 122#define _MCDI_CHECK_ALIGN(_ofst, _align) \
123 ((_ofst) + BUILD_BUG_ON_ZERO((_ofst) & (_align - 1)))
30af6910 124#define _MCDI_DWORD(_buf, _field) \
9528b921 125 ((_buf) + (_MCDI_CHECK_ALIGN(MC_CMD_ ## _field ## _OFST, 4) >> 2))
59cfc479 126
30af6910
BH		 127#define MCDI_SET_DWORD(_buf, _field, _value) \
128 EFX_POPULATE_DWORD_1(*_MCDI_DWORD(_buf, _field), EFX_DWORD_0, _value)
129#define MCDI_DWORD(_buf, _field) \
130 EFX_DWORD_FIELD(*_MCDI_DWORD(_buf, _field), EFX_DWORD_0)
338f74df
BH		 131#define MCDI_SET_QWORD(_buf, _field, _value) \
132 do { \
133 EFX_POPULATE_DWORD_1(_MCDI_DWORD(_buf, _field)[0], \
134 EFX_DWORD_0, (u32)(_value)); \
135 EFX_POPULATE_DWORD_1(_MCDI_DWORD(_buf, _field)[1], \
136 EFX_DWORD_0, (u64)(_value) >> 32); \
137 } while (0)
30af6910
BH		 138#define MCDI_QWORD(_buf, _field) \
139 (EFX_DWORD_FIELD(_MCDI_DWORD(_buf, _field)[0], EFX_DWORD_0) | \
140 (u64)EFX_DWORD_FIELD(_MCDI_DWORD(_buf, _field)[1], EFX_DWORD_0) << 32)
a649dfcb
BH		 141#define MCDI_FIELD(_ptr, _type, _field) \
142 EFX_EXTRACT_DWORD( \
143 *(efx_dword_t *) \
144 _MCDI_PTR(_ptr, MC_CMD_ ## _type ## _ ## _field ## _OFST & ~3),\
145 MC_CMD_ ## _type ## _ ## _field ## _LBN & 0x1f, \
146 (MC_CMD_ ## _type ## _ ## _field ## _LBN & 0x1f) + \
147 MC_CMD_ ## _type ## _ ## _field ## _WIDTH - 1)
30af6910 148
9528b921
BH		 149#define _MCDI_ARRAY_PTR(_buf, _field, _index, _align) \
150 (_MCDI_PTR(_buf, _MCDI_CHECK_ALIGN(MC_CMD_ ## _field ## _OFST, _align))\
151 + (_index) * _MCDI_CHECK_ALIGN(MC_CMD_ ## _field ## _LEN, _align))
a649dfcb 152#define MCDI_DECLARE_STRUCT_PTR(_name) \
9528b921
BH		 153 efx_dword_t *_name
154#define MCDI_ARRAY_STRUCT_PTR(_buf, _field, _index) \
155 ((efx_dword_t *)_MCDI_ARRAY_PTR(_buf, _field, _index, 4))
a649dfcb
BH		 156#define MCDI_VAR_ARRAY_LEN(_len, _field) \
157 min_t(size_t, MC_CMD_ ## _field ## _MAXNUM, \
158 ((_len) - MC_CMD_ ## _field ## _OFST) / MC_CMD_ ## _field ## _LEN)
159#define MCDI_ARRAY_WORD(_buf, _field, _index) \
160 (BUILD_BUG_ON_ZERO(MC_CMD_ ## _field ## _LEN != 2) + \
161 le16_to_cpu(*(__force const __le16 *) \
9528b921 162 _MCDI_ARRAY_PTR(_buf, _field, _index, 2)))
a649dfcb
BH		 163#define _MCDI_ARRAY_DWORD(_buf, _field, _index) \
164 (BUILD_BUG_ON_ZERO(MC_CMD_ ## _field ## _LEN != 4) + \
9528b921 165 (efx_dword_t *)_MCDI_ARRAY_PTR(_buf, _field, _index, 4))
a649dfcb
BH		 166#define MCDI_SET_ARRAY_DWORD(_buf, _field, _index, _value) \
167 EFX_SET_DWORD_FIELD(*_MCDI_ARRAY_DWORD(_buf, _field, _index), \
168 EFX_DWORD_0, _value)
169#define MCDI_ARRAY_DWORD(_buf, _field, _index) \
170 EFX_DWORD_FIELD(*_MCDI_ARRAY_DWORD(_buf, _field, _index), EFX_DWORD_0)
338f74df
BH		 171#define _MCDI_ARRAY_QWORD(_buf, _field, _index) \
172 (BUILD_BUG_ON_ZERO(MC_CMD_ ## _field ## _LEN != 8) + \
173 (efx_dword_t *)_MCDI_ARRAY_PTR(_buf, _field, _index, 4))
174#define MCDI_SET_ARRAY_QWORD(_buf, _field, _index, _value) \
175 do { \
176 EFX_SET_DWORD_FIELD(_MCDI_ARRAY_QWORD(_buf, _field, _index)[0],\
177 EFX_DWORD_0, (u32)(_value)); \
178 EFX_SET_DWORD_FIELD(_MCDI_ARRAY_QWORD(_buf, _field, _index)[1],\
179 EFX_DWORD_0, (u64)(_value) >> 32); \
180 } while (0)
55c5e0f8 181#define MCDI_ARRAY_FIELD(_buf, _field1, _type, _index, _field2) \
a649dfcb
BH		 182 MCDI_FIELD(MCDI_ARRAY_STRUCT_PTR(_buf, _field1, _index), \
183 _type ## _TYPEDEF, _field2)
afd4aea0 184
30af6910
BH		 185#define MCDI_EVENT_FIELD(_ev, _field) \
186 EFX_QWORD_FIELD(_ev, MCDI_EVENT_ ## _field)
187
e5f0fd27 188extern void efx_mcdi_print_fwver(struct efx_nic *efx, char *buf, size_t len);
afd4aea0
BH		 189extern int efx_mcdi_drv_attach(struct efx_nic *efx, bool driver_operating,
190 bool *was_attached_out);
191extern int efx_mcdi_get_board_cfg(struct efx_nic *efx, u8 *mac_address,
6aa9c7f6 192 u16 *fw_subtype_list, u32 *capabilities);
afd4aea0
BH		 193extern int efx_mcdi_log_ctrl(struct efx_nic *efx, bool evq, bool uart,
194 u32 dest_evq);
195extern int efx_mcdi_nvram_types(struct efx_nic *efx, u32 *nvram_types_out);
196extern int efx_mcdi_nvram_info(struct efx_nic *efx, unsigned int type,
197 size_t *size_out, size_t *erase_size_out,
198 bool *protected_out);
199extern int efx_mcdi_nvram_update_start(struct efx_nic *efx,
200 unsigned int type);
201extern int efx_mcdi_nvram_read(struct efx_nic *efx, unsigned int type,
202 loff_t offset, u8 *buffer, size_t length);
203extern int efx_mcdi_nvram_write(struct efx_nic *efx, unsigned int type,
204 loff_t offset, const u8 *buffer,
205 size_t length);
5a27e86b 206#define EFX_MCDI_NVRAM_LEN_MAX 128
afd4aea0
BH		 207extern int efx_mcdi_nvram_erase(struct efx_nic *efx, unsigned int type,
208 loff_t offset, size_t length);
209extern int efx_mcdi_nvram_update_finish(struct efx_nic *efx,
210 unsigned int type);
2e803407 211extern int efx_mcdi_nvram_test_all(struct efx_nic *efx);
afd4aea0
BH		 212extern int efx_mcdi_handle_assertion(struct efx_nic *efx);
213extern void efx_mcdi_set_id_led(struct efx_nic *efx, enum efx_led_mode mode);
afd4aea0
BH		 214extern int efx_mcdi_wol_filter_set_magic(struct efx_nic *efx,
215 const u8 *mac, int *id_out);
216extern int efx_mcdi_wol_filter_get_magic(struct efx_nic *efx, int *id_out);
217extern int efx_mcdi_wol_filter_remove(struct efx_nic *efx, int id);
218extern int efx_mcdi_wol_filter_reset(struct efx_nic *efx);
cd2d5b52 219extern int efx_mcdi_flush_rxqs(struct efx_nic *efx);
43f775b2
BH		 220extern int efx_mcdi_port_probe(struct efx_nic *efx);
221extern void efx_mcdi_port_remove(struct efx_nic *efx);
222extern int efx_mcdi_port_reconfigure(struct efx_nic *efx);
223extern void efx_mcdi_process_link_change(struct efx_nic *efx, efx_qword_t *ev);
cd2d5b52 224extern int efx_mcdi_set_mac(struct efx_nic *efx);
43f775b2
BH		 225#define EFX_MC_STATS_GENERATION_INVALID ((__force __le64)(-1))
226extern void efx_mcdi_mac_start_stats(struct efx_nic *efx);
227extern void efx_mcdi_mac_stop_stats(struct efx_nic *efx);
710b208d 228extern bool efx_mcdi_mac_check_fault(struct efx_nic *efx);
6bff861d
BH		 229extern enum reset_type efx_mcdi_map_reset_reason(enum reset_type reason);
230extern int efx_mcdi_reset(struct efx_nic *efx, enum reset_type method);
afd4aea0 231
55c5e0f8
BH		 232#ifdef CONFIG_SFC_MCDI_MON
233extern int efx_mcdi_mon_probe(struct efx_nic *efx);
234extern void efx_mcdi_mon_remove(struct efx_nic *efx);
235#else
236static inline int efx_mcdi_mon_probe(struct efx_nic *efx) { return 0; }
237static inline void efx_mcdi_mon_remove(struct efx_nic *efx) {}
238#endif
239
afd4aea0 240#endif /* EFX_MCDI_H */
Linux kernel - Deliverables
This page took 0.363413 seconds and 5 git commands to generate.