projects / deliverable / linux.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
sfc: Use proper macros to declare and access MCDI arrays
[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
afd4aea0
BH		 68extern void efx_mcdi_init(struct efx_nic *efx);
69
70extern int efx_mcdi_rpc(struct efx_nic *efx, unsigned cmd, const u8 *inbuf,
71 size_t inlen, u8 *outbuf, size_t outlen,
72 size_t *outlen_actual);
73
c3cba721
SH		 74extern void efx_mcdi_rpc_start(struct efx_nic *efx, unsigned cmd,
75 const u8 *inbuf, size_t inlen);
76extern int efx_mcdi_rpc_finish(struct efx_nic *efx, unsigned cmd, size_t inlen,
77 u8 *outbuf, size_t outlen,
78 size_t *outlen_actual);
79
afd4aea0
BH		 80extern int efx_mcdi_poll_reboot(struct efx_nic *efx);
81extern void efx_mcdi_mode_poll(struct efx_nic *efx);
82extern void efx_mcdi_mode_event(struct efx_nic *efx);
83
84extern void efx_mcdi_process_event(struct efx_channel *channel,
85 efx_qword_t *event);
55c5e0f8 86extern void efx_mcdi_sensor_event(struct efx_nic *efx, efx_qword_t *ev);
afd4aea0 87
59cfc479
BH		 88#define MCDI_DECLARE_BUF(_name, _len) \
89 u8 _name[ALIGN(_len, 4)]
a649dfcb
BH		 90#define _MCDI_PTR(_buf, _offset) \
91 ((u8 *)(_buf) + (_offset))
30af6910 92#define MCDI_PTR(_buf, _field) \
a649dfcb 93 _MCDI_PTR(_buf, MC_CMD_ ## _field ## _OFST)
30af6910
BH		 94#define _MCDI_DWORD(_buf, _field) \
95 ((efx_dword_t *)MCDI_PTR(_buf, _field))
59cfc479 96
30af6910
BH		 97#define MCDI_SET_DWORD(_buf, _field, _value) \
98 EFX_POPULATE_DWORD_1(*_MCDI_DWORD(_buf, _field), EFX_DWORD_0, _value)
99#define MCDI_DWORD(_buf, _field) \
100 EFX_DWORD_FIELD(*_MCDI_DWORD(_buf, _field), EFX_DWORD_0)
101#define MCDI_QWORD(_buf, _field) \
102 (EFX_DWORD_FIELD(_MCDI_DWORD(_buf, _field)[0], EFX_DWORD_0) | \
103 (u64)EFX_DWORD_FIELD(_MCDI_DWORD(_buf, _field)[1], EFX_DWORD_0) << 32)
a649dfcb
BH		 104#define MCDI_FIELD(_ptr, _type, _field) \
105 EFX_EXTRACT_DWORD( \
106 *(efx_dword_t *) \
107 _MCDI_PTR(_ptr, MC_CMD_ ## _type ## _ ## _field ## _OFST & ~3),\
108 MC_CMD_ ## _type ## _ ## _field ## _LBN & 0x1f, \
109 (MC_CMD_ ## _type ## _ ## _field ## _LBN & 0x1f) + \
110 MC_CMD_ ## _type ## _ ## _field ## _WIDTH - 1)
30af6910 111
a649dfcb 112#define _MCDI_ARRAY_PTR(_buf, _field, _index) \
30af6910 113 (MCDI_PTR(_buf, _field) + \
a649dfcb
BH		 114 (_index) * MC_CMD_ ## _field ## _LEN)
115#define MCDI_DECLARE_STRUCT_PTR(_name) \
116 u8 *_name
117#define MCDI_ARRAY_STRUCT_PTR _MCDI_ARRAY_PTR
118#define MCDI_VAR_ARRAY_LEN(_len, _field) \
119 min_t(size_t, MC_CMD_ ## _field ## _MAXNUM, \
120 ((_len) - MC_CMD_ ## _field ## _OFST) / MC_CMD_ ## _field ## _LEN)
121#define MCDI_ARRAY_WORD(_buf, _field, _index) \
122 (BUILD_BUG_ON_ZERO(MC_CMD_ ## _field ## _LEN != 2) + \
123 le16_to_cpu(*(__force const __le16 *) \
124 _MCDI_ARRAY_PTR(_buf, _field, _index)))
125#define _MCDI_ARRAY_DWORD(_buf, _field, _index) \
126 (BUILD_BUG_ON_ZERO(MC_CMD_ ## _field ## _LEN != 4) + \
127 (efx_dword_t *)_MCDI_ARRAY_PTR(_buf, _field, _index))
128#define MCDI_SET_ARRAY_DWORD(_buf, _field, _index, _value) \
129 EFX_SET_DWORD_FIELD(*_MCDI_ARRAY_DWORD(_buf, _field, _index), \
130 EFX_DWORD_0, _value)
131#define MCDI_ARRAY_DWORD(_buf, _field, _index) \
132 EFX_DWORD_FIELD(*_MCDI_ARRAY_DWORD(_buf, _field, _index), EFX_DWORD_0)
55c5e0f8 133#define MCDI_ARRAY_FIELD(_buf, _field1, _type, _index, _field2) \
a649dfcb
BH		 134 MCDI_FIELD(MCDI_ARRAY_STRUCT_PTR(_buf, _field1, _index), \
135 _type ## _TYPEDEF, _field2)
afd4aea0 136
30af6910
BH		 137#define MCDI_EVENT_FIELD(_ev, _field) \
138 EFX_QWORD_FIELD(_ev, MCDI_EVENT_ ## _field)
139
e5f0fd27 140extern void efx_mcdi_print_fwver(struct efx_nic *efx, char *buf, size_t len);
afd4aea0
BH		 141extern int efx_mcdi_drv_attach(struct efx_nic *efx, bool driver_operating,
142 bool *was_attached_out);
143extern int efx_mcdi_get_board_cfg(struct efx_nic *efx, u8 *mac_address,
6aa9c7f6 144 u16 *fw_subtype_list, u32 *capabilities);
afd4aea0
BH		 145extern int efx_mcdi_log_ctrl(struct efx_nic *efx, bool evq, bool uart,
146 u32 dest_evq);
147extern int efx_mcdi_nvram_types(struct efx_nic *efx, u32 *nvram_types_out);
148extern int efx_mcdi_nvram_info(struct efx_nic *efx, unsigned int type,
149 size_t *size_out, size_t *erase_size_out,
150 bool *protected_out);
151extern int efx_mcdi_nvram_update_start(struct efx_nic *efx,
152 unsigned int type);
153extern int efx_mcdi_nvram_read(struct efx_nic *efx, unsigned int type,
154 loff_t offset, u8 *buffer, size_t length);
155extern int efx_mcdi_nvram_write(struct efx_nic *efx, unsigned int type,
156 loff_t offset, const u8 *buffer,
157 size_t length);
5a27e86b 158#define EFX_MCDI_NVRAM_LEN_MAX 128
afd4aea0
BH		 159extern int efx_mcdi_nvram_erase(struct efx_nic *efx, unsigned int type,
160 loff_t offset, size_t length);
161extern int efx_mcdi_nvram_update_finish(struct efx_nic *efx,
162 unsigned int type);
2e803407 163extern int efx_mcdi_nvram_test_all(struct efx_nic *efx);
afd4aea0
BH		 164extern int efx_mcdi_handle_assertion(struct efx_nic *efx);
165extern void efx_mcdi_set_id_led(struct efx_nic *efx, enum efx_led_mode mode);
166extern int efx_mcdi_reset_port(struct efx_nic *efx);
167extern int efx_mcdi_reset_mc(struct efx_nic *efx);
afd4aea0
BH		 168extern int efx_mcdi_wol_filter_set_magic(struct efx_nic *efx,
169 const u8 *mac, int *id_out);
170extern int efx_mcdi_wol_filter_get_magic(struct efx_nic *efx, int *id_out);
171extern int efx_mcdi_wol_filter_remove(struct efx_nic *efx, int id);
172extern int efx_mcdi_wol_filter_reset(struct efx_nic *efx);
cd2d5b52
BH		 173extern int efx_mcdi_flush_rxqs(struct efx_nic *efx);
174extern int efx_mcdi_set_mac(struct efx_nic *efx);
710b208d
BH		 175extern int efx_mcdi_mac_stats(struct efx_nic *efx, dma_addr_t dma_addr,
176 u32 dma_len, int enable, int clear);
177extern int efx_mcdi_mac_reconfigure(struct efx_nic *efx);
178extern bool efx_mcdi_mac_check_fault(struct efx_nic *efx);
afd4aea0 179
55c5e0f8
BH		 180#ifdef CONFIG_SFC_MCDI_MON
181extern int efx_mcdi_mon_probe(struct efx_nic *efx);
182extern void efx_mcdi_mon_remove(struct efx_nic *efx);
183#else
184static inline int efx_mcdi_mon_probe(struct efx_nic *efx) { return 0; }
185static inline void efx_mcdi_mon_remove(struct efx_nic *efx) {}
186#endif
187
afd4aea0 188#endif /* EFX_MCDI_H */
Linux kernel - Deliverables
This page took 0.327745 seconds and 5 git commands to generate.