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  * @new_epoch: Indicates start of day or start of MC reboot recovery
  40  * @iface_lock: Serialises access to all the following fields
  41  * @seqno: The next sequence number to use for mcdi requests.
  42  * @credits: Number of spurious MCDI completion events allowed before we
  43  *     trigger a fatal error
  44  * @resprc: Response error/success code (Linux numbering)
  45  * @resp_hdr_len: Response header length
  46  * @resp_data_len: Response data (SDU or error) length
  47  */
  48 struct efx_mcdi_iface {
  49         enum efx_mcdi_state state;
  50         enum efx_mcdi_mode mode;
  51         wait_queue_head_t wq;
  52         spinlock_t iface_lock;
  53         bool new_epoch;
  54         unsigned int credits;
  55         unsigned int seqno;
  56         int resprc;
  57         size_t resp_hdr_len;
  58         size_t resp_data_len;
  59 };
  60
  61 struct efx_mcdi_mon {
  62         struct efx_buffer dma_buf;
  63         struct mutex update_lock;
  64         unsigned long last_update;
  65         struct device *device;
  66         struct efx_mcdi_mon_attribute *attrs;
  67         unsigned int n_attrs;
  68 };
  69
  70 struct efx_mcdi_mtd_partition {
  71         struct efx_mtd_partition common;
  72         bool updating;
  73         u8 nvram_type;
  74         u16 fw_subtype;
  75 };
  76
  77 #define to_efx_mcdi_mtd_partition(mtd)                          \
  78         container_of(mtd, struct efx_mcdi_mtd_partition, common.mtd)
  79
  80 /**
  81  * struct efx_mcdi_data - extra state for NICs that implement MCDI
  82  * @iface: Interface/protocol state
  83  * @hwmon: Hardware monitor state
  84  */
  85 struct efx_mcdi_data {
  86         struct efx_mcdi_iface iface;
  87 #ifdef CONFIG_SFC_MCDI_MON
  88         struct efx_mcdi_mon hwmon;
  89 #endif
  90 };
  91
  92 #ifdef CONFIG_SFC_MCDI_MON
  93 static inline struct efx_mcdi_mon *efx_mcdi_mon(struct efx_nic *efx)
  94 {
  95         EFX_BUG_ON_PARANOID(!efx->mcdi);
  96         return &efx->mcdi->hwmon;
  97 }
  98 #endif
  99
 100 extern int efx_mcdi_init(struct efx_nic *efx);
 101 extern void efx_mcdi_fini(struct efx_nic *efx);
 102
 103 extern int efx_mcdi_rpc(struct efx_nic *efx, unsigned cmd,
 104                         const efx_dword_t *inbuf, size_t inlen,
 105                         efx_dword_t *outbuf, size_t outlen,
 106                         size_t *outlen_actual);
 107
 108 extern int efx_mcdi_rpc_start(struct efx_nic *efx, unsigned cmd,
 109                               const efx_dword_t *inbuf, size_t inlen);
 110 extern int efx_mcdi_rpc_finish(struct efx_nic *efx, unsigned cmd, size_t inlen,
 111                                efx_dword_t *outbuf, size_t outlen,
 112                                size_t *outlen_actual);
 113
 114
 115 extern int efx_mcdi_poll_reboot(struct efx_nic *efx);
 116 extern void efx_mcdi_mode_poll(struct efx_nic *efx);
 117 extern void efx_mcdi_mode_event(struct efx_nic *efx);
 118
 119 extern void efx_mcdi_process_event(struct efx_channel *channel,
 120                                    efx_qword_t *event);
 121 extern void efx_mcdi_sensor_event(struct efx_nic *efx, efx_qword_t *ev);
 122
 123 /* We expect that 16- and 32-bit fields in MCDI requests and responses
 124  * are appropriately aligned, but 64-bit fields are only
 125  * 32-bit-aligned.  Also, on Siena we must copy to the MC shared
 126  * memory strictly 32 bits at a time, so add any necessary padding.
 127  */
 128 #define MCDI_DECLARE_BUF(_name, _len)                                   \
 129         efx_dword_t _name[DIV_ROUND_UP(_len, 4)]
 130 #define _MCDI_PTR(_buf, _offset)                                        \
 131         ((u8 *)(_buf) + (_offset))
 132 #define MCDI_PTR(_buf, _field)                                          \
 133         _MCDI_PTR(_buf, MC_CMD_ ## _field ## _OFST)
 134 #define _MCDI_CHECK_ALIGN(_ofst, _align)                                \
 135         ((_ofst) + BUILD_BUG_ON_ZERO((_ofst) & (_align - 1)))
 136 #define _MCDI_DWORD(_buf, _field)                                       \
 137         ((_buf) + (_MCDI_CHECK_ALIGN(MC_CMD_ ## _field ## _OFST, 4) >> 2))
 138
 139 #define MCDI_SET_DWORD(_buf, _field, _value)                            \
 140         EFX_POPULATE_DWORD_1(*_MCDI_DWORD(_buf, _field), EFX_DWORD_0, _value)
 141 #define MCDI_DWORD(_buf, _field)                                        \
 142         EFX_DWORD_FIELD(*_MCDI_DWORD(_buf, _field), EFX_DWORD_0)
 143 #define MCDI_POPULATE_DWORD_1(_buf, _field, _name1, _value1)            \
 144         EFX_POPULATE_DWORD_1(*_MCDI_DWORD(_buf, _field),                \
 145                              MC_CMD_ ## _name1, _value1)
 146 #define MCDI_POPULATE_DWORD_2(_buf, _field, _name1, _value1,            \
 147                               _name2, _value2)                          \
 148         EFX_POPULATE_DWORD_2(*_MCDI_DWORD(_buf, _field),                \
 149                              MC_CMD_ ## _name1, _value1,                \
 150                              MC_CMD_ ## _name2, _value2)
 151 #define MCDI_POPULATE_DWORD_3(_buf, _field, _name1, _value1,            \
 152                               _name2, _value2, _name3, _value3)         \
 153         EFX_POPULATE_DWORD_3(*_MCDI_DWORD(_buf, _field),                \
 154                              MC_CMD_ ## _name1, _value1,                \
 155                              MC_CMD_ ## _name2, _value2,                \
 156                              MC_CMD_ ## _name3, _value3)
 157 #define MCDI_POPULATE_DWORD_4(_buf, _field, _name1, _value1,            \
 158                               _name2, _value2, _name3, _value3,         \
 159                               _name4, _value4)                          \
 160         EFX_POPULATE_DWORD_4(*_MCDI_DWORD(_buf, _field),                \
 161                              MC_CMD_ ## _name1, _value1,                \
 162                              MC_CMD_ ## _name2, _value2,                \
 163                              MC_CMD_ ## _name3, _value3,                \
 164                              MC_CMD_ ## _name4, _value4)
 165 #define MCDI_POPULATE_DWORD_5(_buf, _field, _name1, _value1,            \
 166                               _name2, _value2, _name3, _value3,         \
 167                               _name4, _value4, _name5, _value5)         \
 168         EFX_POPULATE_DWORD_5(*_MCDI_DWORD(_buf, _field),                \
 169                              MC_CMD_ ## _name1, _value1,                \
 170                              MC_CMD_ ## _name2, _value2,                \
 171                              MC_CMD_ ## _name3, _value3,                \
 172                              MC_CMD_ ## _name4, _value4,                \
 173                              MC_CMD_ ## _name5, _value5)
 174 #define MCDI_POPULATE_DWORD_6(_buf, _field, _name1, _value1,            \
 175                               _name2, _value2, _name3, _value3,         \
 176                               _name4, _value4, _name5, _value5,         \
 177                               _name6, _value6)                          \
 178         EFX_POPULATE_DWORD_6(*_MCDI_DWORD(_buf, _field),                \
 179                              MC_CMD_ ## _name1, _value1,                \
 180                              MC_CMD_ ## _name2, _value2,                \
 181                              MC_CMD_ ## _name3, _value3,                \
 182                              MC_CMD_ ## _name4, _value4,                \
 183                              MC_CMD_ ## _name5, _value5,                \
 184                              MC_CMD_ ## _name6, _value6)
 185 #define MCDI_POPULATE_DWORD_7(_buf, _field, _name1, _value1,            \
 186                               _name2, _value2, _name3, _value3,         \
 187                               _name4, _value4, _name5, _value5,         \
 188                               _name6, _value6, _name7, _value7)         \
 189         EFX_POPULATE_DWORD_7(*_MCDI_DWORD(_buf, _field),                \
 190                              MC_CMD_ ## _name1, _value1,                \
 191                              MC_CMD_ ## _name2, _value2,                \
 192                              MC_CMD_ ## _name3, _value3,                \
 193                              MC_CMD_ ## _name4, _value4,                \
 194                              MC_CMD_ ## _name5, _value5,                \
 195                              MC_CMD_ ## _name6, _value6,                \
 196                              MC_CMD_ ## _name7, _value7)
 197 #define MCDI_SET_QWORD(_buf, _field, _value)                            \
 198         do {                                                            \
 199                 EFX_POPULATE_DWORD_1(_MCDI_DWORD(_buf, _field)[0],      \
 200                                      EFX_DWORD_0, (u32)(_value));       \
 201                 EFX_POPULATE_DWORD_1(_MCDI_DWORD(_buf, _field)[1],      \
 202                                      EFX_DWORD_0, (u64)(_value) >> 32); \
 203         } while (0)
 204 #define MCDI_QWORD(_buf, _field)                                        \
 205         (EFX_DWORD_FIELD(_MCDI_DWORD(_buf, _field)[0], EFX_DWORD_0) |   \
 206         (u64)EFX_DWORD_FIELD(_MCDI_DWORD(_buf, _field)[1], EFX_DWORD_0) << 32)
 207 #define MCDI_FIELD(_ptr, _type, _field)                                 \
 208         EFX_EXTRACT_DWORD(                                              \
 209                 *(efx_dword_t *)                                        \
 210                 _MCDI_PTR(_ptr, MC_CMD_ ## _type ## _ ## _field ## _OFST & ~3),\
 211                 MC_CMD_ ## _type ## _ ## _field ## _LBN & 0x1f, \
 212                 (MC_CMD_ ## _type ## _ ## _field ## _LBN & 0x1f) +      \
 213                 MC_CMD_ ## _type ## _ ## _field ## _WIDTH - 1)
 214
 215 #define _MCDI_ARRAY_PTR(_buf, _field, _index, _align)                   \
 216         (_MCDI_PTR(_buf, _MCDI_CHECK_ALIGN(MC_CMD_ ## _field ## _OFST, _align))\
 217          + (_index) * _MCDI_CHECK_ALIGN(MC_CMD_ ## _field ## _LEN, _align))
 218 #define MCDI_DECLARE_STRUCT_PTR(_name)                                  \
 219         efx_dword_t *_name
 220 #define MCDI_ARRAY_STRUCT_PTR(_buf, _field, _index)                     \
 221         ((efx_dword_t *)_MCDI_ARRAY_PTR(_buf, _field, _index, 4))
 222 #define MCDI_VAR_ARRAY_LEN(_len, _field)                                \
 223         min_t(size_t, MC_CMD_ ## _field ## _MAXNUM,                     \
 224               ((_len) - MC_CMD_ ## _field ## _OFST) / MC_CMD_ ## _field ## _LEN)
 225 #define MCDI_ARRAY_WORD(_buf, _field, _index)                           \
 226         (BUILD_BUG_ON_ZERO(MC_CMD_ ## _field ## _LEN != 2) +            \
 227          le16_to_cpu(*(__force const __le16 *)                          \
 228                      _MCDI_ARRAY_PTR(_buf, _field, _index, 2)))
 229 #define _MCDI_ARRAY_DWORD(_buf, _field, _index)                         \
 230         (BUILD_BUG_ON_ZERO(MC_CMD_ ## _field ## _LEN != 4) +            \
 231          (efx_dword_t *)_MCDI_ARRAY_PTR(_buf, _field, _index, 4))
 232 #define MCDI_SET_ARRAY_DWORD(_buf, _field, _index, _value)              \
 233         EFX_SET_DWORD_FIELD(*_MCDI_ARRAY_DWORD(_buf, _field, _index),   \
 234                             EFX_DWORD_0, _value)
 235 #define MCDI_ARRAY_DWORD(_buf, _field, _index)                          \
 236         EFX_DWORD_FIELD(*_MCDI_ARRAY_DWORD(_buf, _field, _index), EFX_DWORD_0)
 237 #define _MCDI_ARRAY_QWORD(_buf, _field, _index)                         \
 238         (BUILD_BUG_ON_ZERO(MC_CMD_ ## _field ## _LEN != 8) +            \
 239          (efx_dword_t *)_MCDI_ARRAY_PTR(_buf, _field, _index, 4))
 240 #define MCDI_SET_ARRAY_QWORD(_buf, _field, _index, _value)              \
 241         do {                                                            \
 242                 EFX_SET_DWORD_FIELD(_MCDI_ARRAY_QWORD(_buf, _field, _index)[0],\
 243                                     EFX_DWORD_0, (u32)(_value));        \
 244                 EFX_SET_DWORD_FIELD(_MCDI_ARRAY_QWORD(_buf, _field, _index)[1],\
 245                                     EFX_DWORD_0, (u64)(_value) >> 32);  \
 246         } while (0)
 247 #define MCDI_ARRAY_FIELD(_buf, _field1, _type, _index, _field2)         \
 248         MCDI_FIELD(MCDI_ARRAY_STRUCT_PTR(_buf, _field1, _index),        \
 249                    _type ## _TYPEDEF, _field2)
 250
 251 #define MCDI_EVENT_FIELD(_ev, _field)                   \
 252         EFX_QWORD_FIELD(_ev, MCDI_EVENT_ ## _field)
 253
 254 extern void efx_mcdi_print_fwver(struct efx_nic *efx, char *buf, size_t len);
 255 extern int efx_mcdi_drv_attach(struct efx_nic *efx, bool driver_operating,
 256                                bool *was_attached_out);
 257 extern int efx_mcdi_get_board_cfg(struct efx_nic *efx, u8 *mac_address,
 258                                   u16 *fw_subtype_list, u32 *capabilities);
 259 extern int efx_mcdi_log_ctrl(struct efx_nic *efx, bool evq, bool uart,
 260                              u32 dest_evq);
 261 extern int efx_mcdi_nvram_types(struct efx_nic *efx, u32 *nvram_types_out);
 262 extern int efx_mcdi_nvram_info(struct efx_nic *efx, unsigned int type,
 263                                size_t *size_out, size_t *erase_size_out,
 264                                bool *protected_out);
 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 #ifdef CONFIG_SFC_MTD
 295 extern int efx_mcdi_mtd_read(struct mtd_info *mtd, loff_t start,
 296                              size_t len, size_t *retlen, u8 *buffer);
 297 extern int efx_mcdi_mtd_erase(struct mtd_info *mtd, loff_t start, size_t len);
 298 extern int efx_mcdi_mtd_write(struct mtd_info *mtd, loff_t start,
 299                               size_t len, size_t *retlen, const u8 *buffer);
 300 extern int efx_mcdi_mtd_sync(struct mtd_info *mtd);
 301 extern void efx_mcdi_mtd_rename(struct efx_mtd_partition *part);
 302 #endif
 303
 304 #endif /* EFX_MCDI_H */