drivers/net/ethernet/sfc/mcdi.h

   1 /****************************************************************************
   2  * Driver for Solarflare Solarstorm network controllers and boards
   3  * Copyright 2008-2010 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: 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  */
  23 enum efx_mcdi_state {
  24         MCDI_STATE_QUIESCENT,
  25         MCDI_STATE_RUNNING,
  26         MCDI_STATE_COMPLETED,
  27 };
  28
  29 enum efx_mcdi_mode {
  30         MCDI_MODE_POLL,
  31         MCDI_MODE_EVENTS,
  32 };
  33
  34 /**
  35  * struct efx_mcdi_iface - MCDI protocol context
  36  * @state: Request handling state. Waited for by @wq.
  37  * @mode: Poll for mcdi completion, or wait for an mcdi_event.
  38  * @wq: Wait queue for threads waiting for @state != %MCDI_STATE_RUNNING
  39  * @iface_lock: Serialises access to all the following fields
  40  * @seqno: The next sequence number to use for mcdi requests.
  41  * @credits: Number of spurious MCDI completion events allowed before we
  42  *     trigger a fatal error
  43  * @resprc: Response error/success code (Linux numbering)
  44  * @resp_hdr_len: Response header length
  45  * @resp_data_len: Response data (SDU or error) length
  46  */
  47 struct efx_mcdi_iface {
  48         atomic_t state;
  49         enum efx_mcdi_mode mode;
  50         wait_queue_head_t wq;
  51         spinlock_t iface_lock;
  52         unsigned int credits;
  53         unsigned int seqno;
  54         int resprc;
  55         size_t resp_hdr_len;
  56         size_t resp_data_len;
  57 };
  58
  59 struct 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
  68 /**
  69  * struct efx_mcdi_data - extra state for NICs that implement MCDI
  70  * @iface: Interface/protocol state
  71  * @hwmon: Hardware monitor state
  72  */
  73 struct 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
  81 static 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
  88 extern int efx_mcdi_init(struct efx_nic *efx);
  89 extern void efx_mcdi_fini(struct efx_nic *efx);
  90
  91 extern 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,
  94                         size_t *outlen_actual);
  95
  96 extern int efx_mcdi_rpc_start(struct efx_nic *efx, unsigned cmd,
  97                               const efx_dword_t *inbuf, size_t inlen);
  98 extern int efx_mcdi_rpc_finish(struct efx_nic *efx, unsigned cmd, size_t inlen,
  99                                efx_dword_t *outbuf, size_t outlen,
 100                                size_t *outlen_actual);
 101
 102
 103 extern int efx_mcdi_poll_reboot(struct efx_nic *efx);
 104 extern void efx_mcdi_mode_poll(struct efx_nic *efx);
 105 extern void efx_mcdi_mode_event(struct efx_nic *efx);
 106
 107 extern void efx_mcdi_process_event(struct efx_channel *channel,
 108                                    efx_qword_t *event);
 109 extern void efx_mcdi_sensor_event(struct efx_nic *efx, efx_qword_t *ev);
 110
 111 /* We expect that 16- and 32-bit fields in MCDI requests and responses
 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.
 115  */
 116 #define MCDI_DECLARE_BUF(_name, _len)                                   \
 117         efx_dword_t _name[DIV_ROUND_UP(_len, 4)]
 118 #define _MCDI_PTR(_buf, _offset)                                        \
 119         ((u8 *)(_buf) + (_offset))
 120 #define MCDI_PTR(_buf, _field)                                          \
 121         _MCDI_PTR(_buf, MC_CMD_ ## _field ## _OFST)
 122 #define _MCDI_CHECK_ALIGN(_ofst, _align)                                \
 123         ((_ofst) + BUILD_BUG_ON_ZERO((_ofst) & (_align - 1)))
 124 #define _MCDI_DWORD(_buf, _field)                                       \
 125         ((_buf) + (_MCDI_CHECK_ALIGN(MC_CMD_ ## _field ## _OFST, 4) >> 2))
 126
 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)
 131 #define MCDI_POPULATE_DWORD_1(_buf, _field, _name1, _value1)            \
 132         EFX_POPULATE_DWORD_1(*_MCDI_DWORD(_buf, _field),                \
 133                              MC_CMD_ ## _name1, _value1)
 134 #define MCDI_POPULATE_DWORD_2(_buf, _field, _name1, _value1,            \
 135                               _name2, _value2)                          \
 136         EFX_POPULATE_DWORD_2(*_MCDI_DWORD(_buf, _field),                \
 137                              MC_CMD_ ## _name1, _value1,                \
 138                              MC_CMD_ ## _name2, _value2)
 139 #define MCDI_POPULATE_DWORD_3(_buf, _field, _name1, _value1,            \
 140                               _name2, _value2, _name3, _value3)         \
 141         EFX_POPULATE_DWORD_3(*_MCDI_DWORD(_buf, _field),                \
 142                              MC_CMD_ ## _name1, _value1,                \
 143                              MC_CMD_ ## _name2, _value2,                \
 144                              MC_CMD_ ## _name3, _value3)
 145 #define MCDI_POPULATE_DWORD_4(_buf, _field, _name1, _value1,            \
 146                               _name2, _value2, _name3, _value3,         \
 147                               _name4, _value4)                          \
 148         EFX_POPULATE_DWORD_4(*_MCDI_DWORD(_buf, _field),                \
 149                              MC_CMD_ ## _name1, _value1,                \
 150                              MC_CMD_ ## _name2, _value2,                \
 151                              MC_CMD_ ## _name3, _value3,                \
 152                              MC_CMD_ ## _name4, _value4)
 153 #define MCDI_POPULATE_DWORD_5(_buf, _field, _name1, _value1,            \
 154                               _name2, _value2, _name3, _value3,         \
 155                               _name4, _value4, _name5, _value5)         \
 156         EFX_POPULATE_DWORD_5(*_MCDI_DWORD(_buf, _field),                \
 157                              MC_CMD_ ## _name1, _value1,                \
 158                              MC_CMD_ ## _name2, _value2,                \
 159                              MC_CMD_ ## _name3, _value3,                \
 160                              MC_CMD_ ## _name4, _value4,                \
 161                              MC_CMD_ ## _name5, _value5)
 162 #define MCDI_POPULATE_DWORD_6(_buf, _field, _name1, _value1,            \
 163                               _name2, _value2, _name3, _value3,         \
 164                               _name4, _value4, _name5, _value5,         \
 165                               _name6, _value6)                          \
 166         EFX_POPULATE_DWORD_6(*_MCDI_DWORD(_buf, _field),                \
 167                              MC_CMD_ ## _name1, _value1,                \
 168                              MC_CMD_ ## _name2, _value2,                \
 169                              MC_CMD_ ## _name3, _value3,                \
 170                              MC_CMD_ ## _name4, _value4,                \
 171                              MC_CMD_ ## _name5, _value5,                \
 172                              MC_CMD_ ## _name6, _value6)
 173 #define MCDI_POPULATE_DWORD_7(_buf, _field, _name1, _value1,            \
 174                               _name2, _value2, _name3, _value3,         \
 175                               _name4, _value4, _name5, _value5,         \
 176                               _name6, _value6, _name7, _value7)         \
 177         EFX_POPULATE_DWORD_7(*_MCDI_DWORD(_buf, _field),                \
 178                              MC_CMD_ ## _name1, _value1,                \
 179                              MC_CMD_ ## _name2, _value2,                \
 180                              MC_CMD_ ## _name3, _value3,                \
 181                              MC_CMD_ ## _name4, _value4,                \
 182                              MC_CMD_ ## _name5, _value5,                \
 183                              MC_CMD_ ## _name6, _value6,                \
 184                              MC_CMD_ ## _name7, _value7)
 185 #define MCDI_SET_QWORD(_buf, _field, _value)                            \
 186         do {                                                            \
 187                 EFX_POPULATE_DWORD_1(_MCDI_DWORD(_buf, _field)[0],      \
 188                                      EFX_DWORD_0, (u32)(_value));       \
 189                 EFX_POPULATE_DWORD_1(_MCDI_DWORD(_buf, _field)[1],      \
 190                                      EFX_DWORD_0, (u64)(_value) >> 32); \
 191         } while (0)
 192 #define MCDI_QWORD(_buf, _field)                                        \
 193         (EFX_DWORD_FIELD(_MCDI_DWORD(_buf, _field)[0], EFX_DWORD_0) |   \
 194         (u64)EFX_DWORD_FIELD(_MCDI_DWORD(_buf, _field)[1], EFX_DWORD_0) << 32)
 195 #define MCDI_FIELD(_ptr, _type, _field)                                 \
 196         EFX_EXTRACT_DWORD(                                              \
 197                 *(efx_dword_t *)                                        \
 198                 _MCDI_PTR(_ptr, MC_CMD_ ## _type ## _ ## _field ## _OFST & ~3),\
 199                 MC_CMD_ ## _type ## _ ## _field ## _LBN & 0x1f, \
 200                 (MC_CMD_ ## _type ## _ ## _field ## _LBN & 0x1f) +      \
 201                 MC_CMD_ ## _type ## _ ## _field ## _WIDTH - 1)
 202
 203 #define _MCDI_ARRAY_PTR(_buf, _field, _index, _align)                   \
 204         (_MCDI_PTR(_buf, _MCDI_CHECK_ALIGN(MC_CMD_ ## _field ## _OFST, _align))\
 205          + (_index) * _MCDI_CHECK_ALIGN(MC_CMD_ ## _field ## _LEN, _align))
 206 #define MCDI_DECLARE_STRUCT_PTR(_name)                                  \
 207         efx_dword_t *_name
 208 #define MCDI_ARRAY_STRUCT_PTR(_buf, _field, _index)                     \
 209         ((efx_dword_t *)_MCDI_ARRAY_PTR(_buf, _field, _index, 4))
 210 #define MCDI_VAR_ARRAY_LEN(_len, _field)                                \
 211         min_t(size_t, MC_CMD_ ## _field ## _MAXNUM,                     \
 212               ((_len) - MC_CMD_ ## _field ## _OFST) / MC_CMD_ ## _field ## _LEN)
 213 #define MCDI_ARRAY_WORD(_buf, _field, _index)                           \
 214         (BUILD_BUG_ON_ZERO(MC_CMD_ ## _field ## _LEN != 2) +            \
 215          le16_to_cpu(*(__force const __le16 *)                          \
 216                      _MCDI_ARRAY_PTR(_buf, _field, _index, 2)))
 217 #define _MCDI_ARRAY_DWORD(_buf, _field, _index)                         \
 218         (BUILD_BUG_ON_ZERO(MC_CMD_ ## _field ## _LEN != 4) +            \
 219          (efx_dword_t *)_MCDI_ARRAY_PTR(_buf, _field, _index, 4))
 220 #define MCDI_SET_ARRAY_DWORD(_buf, _field, _index, _value)              \
 221         EFX_SET_DWORD_FIELD(*_MCDI_ARRAY_DWORD(_buf, _field, _index),   \
 222                             EFX_DWORD_0, _value)
 223 #define MCDI_ARRAY_DWORD(_buf, _field, _index)                          \
 224         EFX_DWORD_FIELD(*_MCDI_ARRAY_DWORD(_buf, _field, _index), EFX_DWORD_0)
 225 #define _MCDI_ARRAY_QWORD(_buf, _field, _index)                         \
 226         (BUILD_BUG_ON_ZERO(MC_CMD_ ## _field ## _LEN != 8) +            \
 227          (efx_dword_t *)_MCDI_ARRAY_PTR(_buf, _field, _index, 4))
 228 #define MCDI_SET_ARRAY_QWORD(_buf, _field, _index, _value)              \
 229         do {                                                            \
 230                 EFX_SET_DWORD_FIELD(_MCDI_ARRAY_QWORD(_buf, _field, _index)[0],\
 231                                     EFX_DWORD_0, (u32)(_value));        \
 232                 EFX_SET_DWORD_FIELD(_MCDI_ARRAY_QWORD(_buf, _field, _index)[1],\
 233                                     EFX_DWORD_0, (u64)(_value) >> 32);  \
 234         } while (0)
 235 #define MCDI_ARRAY_FIELD(_buf, _field1, _type, _index, _field2)         \
 236         MCDI_FIELD(MCDI_ARRAY_STRUCT_PTR(_buf, _field1, _index),        \
 237                    _type ## _TYPEDEF, _field2)
 238
 239 #define MCDI_EVENT_FIELD(_ev, _field)                   \
 240         EFX_QWORD_FIELD(_ev, MCDI_EVENT_ ## _field)
 241
 242 extern void efx_mcdi_print_fwver(struct efx_nic *efx, char *buf, size_t len);
 243 extern int efx_mcdi_drv_attach(struct efx_nic *efx, bool driver_operating,
 244                                bool *was_attached_out);
 245 extern int efx_mcdi_get_board_cfg(struct efx_nic *efx, u8 *mac_address,
 246                                   u16 *fw_subtype_list, u32 *capabilities);
 247 extern int efx_mcdi_log_ctrl(struct efx_nic *efx, bool evq, bool uart,
 248                              u32 dest_evq);
 249 extern int efx_mcdi_nvram_types(struct efx_nic *efx, u32 *nvram_types_out);
 250 extern int efx_mcdi_nvram_info(struct efx_nic *efx, unsigned int type,
 251                                size_t *size_out, size_t *erase_size_out,
 252                                bool *protected_out);
 253 extern int efx_mcdi_nvram_update_start(struct efx_nic *efx,
 254                                        unsigned int type);
 255 extern int efx_mcdi_nvram_read(struct efx_nic *efx, unsigned int type,
 256                                loff_t offset, u8 *buffer, size_t length);
 257 extern int efx_mcdi_nvram_write(struct efx_nic *efx, unsigned int type,
 258                                 loff_t offset, const u8 *buffer,
 259                                 size_t length);
 260 #define EFX_MCDI_NVRAM_LEN_MAX 128
 261 extern int efx_mcdi_nvram_erase(struct efx_nic *efx, unsigned int type,
 262                                 loff_t offset, size_t length);
 263 extern int efx_mcdi_nvram_update_finish(struct efx_nic *efx,
 264                                         unsigned int type);
 265 extern int efx_mcdi_nvram_test_all(struct efx_nic *efx);
 266 extern int efx_mcdi_handle_assertion(struct efx_nic *efx);
 267 extern void efx_mcdi_set_id_led(struct efx_nic *efx, enum efx_led_mode mode);
 268 extern int efx_mcdi_wol_filter_set_magic(struct efx_nic *efx,
 269                                          const u8 *mac, int *id_out);
 270 extern int efx_mcdi_wol_filter_get_magic(struct efx_nic *efx, int *id_out);
 271 extern int efx_mcdi_wol_filter_remove(struct efx_nic *efx, int id);
 272 extern int efx_mcdi_wol_filter_reset(struct efx_nic *efx);
 273 extern int efx_mcdi_flush_rxqs(struct efx_nic *efx);
 274 extern int efx_mcdi_port_probe(struct efx_nic *efx);
 275 extern void efx_mcdi_port_remove(struct efx_nic *efx);
 276 extern int efx_mcdi_port_reconfigure(struct efx_nic *efx);
 277 extern void efx_mcdi_process_link_change(struct efx_nic *efx, efx_qword_t *ev);
 278 extern int efx_mcdi_set_mac(struct efx_nic *efx);
 279 #define EFX_MC_STATS_GENERATION_INVALID ((__force __le64)(-1))
 280 extern void efx_mcdi_mac_start_stats(struct efx_nic *efx);
 281 extern void efx_mcdi_mac_stop_stats(struct efx_nic *efx);
 282 extern bool efx_mcdi_mac_check_fault(struct efx_nic *efx);
 283 extern enum reset_type efx_mcdi_map_reset_reason(enum reset_type reason);
 284 extern int efx_mcdi_reset(struct efx_nic *efx, enum reset_type method);
 285
 286 #ifdef CONFIG_SFC_MCDI_MON
 287 extern int efx_mcdi_mon_probe(struct efx_nic *efx);
 288 extern void efx_mcdi_mon_remove(struct efx_nic *efx);
 289 #else
 290 static inline int efx_mcdi_mon_probe(struct efx_nic *efx) { return 0; }
 291 static inline void efx_mcdi_mon_remove(struct efx_nic *efx) {}
 292 #endif
 293
 294 #endif /* EFX_MCDI_H */