LXR linux/drivers/net/ethernet/sfc/mcdi.h

   1/* SPDX-License-Identifier: GPL-2.0-only */
   2/****************************************************************************
   3 * Driver for Solarflare network controllers and boards
   4 * Copyright 2008-2013 Solarflare Communications Inc.
   5 */
   6
   7#ifndef EFX_MCDI_H
   8#define EFX_MCDI_H
   9
  10/**
  11 * enum efx_mcdi_state - MCDI request handling state
  12 * @MCDI_STATE_QUIESCENT: No pending MCDI requests. If the caller holds the
  13 *      mcdi @iface_lock then they are able to move to %MCDI_STATE_RUNNING
  14 * @MCDI_STATE_RUNNING_SYNC: There is a synchronous MCDI request pending.
  15 *      Only the thread that moved into this state is allowed to move out of it.
  16 * @MCDI_STATE_RUNNING_ASYNC: There is an asynchronous MCDI request pending.
  17 * @MCDI_STATE_PROXY_WAIT: An MCDI request has completed with a response that
  18 *      indicates we must wait for a proxy try again message.
  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_SYNC,
  26        MCDI_STATE_RUNNING_ASYNC,
  27        MCDI_STATE_PROXY_WAIT,
  28        MCDI_STATE_COMPLETED,
  29};
  30
  31/**
  32 * enum efx_mcdi_mode - MCDI transaction mode
  33 * @MCDI_MODE_POLL: poll for MCDI completion, until timeout
  34 * @MCDI_MODE_EVENTS: wait for an mcdi_event.  On timeout, poll once
  35 * @MCDI_MODE_FAIL: we think MCDI is dead, so fail-fast all calls
  36 */
  37enum efx_mcdi_mode {
  38        MCDI_MODE_POLL,
  39        MCDI_MODE_EVENTS,
  40        MCDI_MODE_FAIL,
  41};
  42
  43/**
  44 * struct efx_mcdi_iface - MCDI protocol context
  45 * @efx: The associated NIC.
  46 * @state: Request handling state. Waited for by @wq.
  47 * @mode: Poll for mcdi completion, or wait for an mcdi_event.
  48 * @wq: Wait queue for threads waiting for @state != %MCDI_STATE_RUNNING
  49 * @new_epoch: Indicates start of day or start of MC reboot recovery
  50 * @iface_lock: Serialises access to @seqno, @credits and response metadata
  51 * @seqno: The next sequence number to use for mcdi requests.
  52 * @credits: Number of spurious MCDI completion events allowed before we
  53 *     trigger a fatal error
  54 * @resprc: Response error/success code (Linux numbering)
  55 * @resp_hdr_len: Response header length
  56 * @resp_data_len: Response data (SDU or error) length
  57 * @async_lock: Serialises access to @async_list while event processing is
  58 *      enabled
  59 * @async_list: Queue of asynchronous requests
  60 * @async_timer: Timer for asynchronous request timeout
  61 * @logging_buffer: buffer that may be used to build MCDI tracing messages
  62 * @logging_enabled: whether to trace MCDI
  63 * @proxy_rx_handle: Most recently received proxy authorisation handle
  64 * @proxy_rx_status: Status of most recent proxy authorisation
  65 * @proxy_rx_wq: Wait queue for updates to proxy_rx_handle
  66 */
  67struct efx_mcdi_iface {
  68        struct efx_nic *efx;
  69        enum efx_mcdi_state state;
  70        enum efx_mcdi_mode mode;
  71        wait_queue_head_t wq;
  72        spinlock_t iface_lock;
  73        bool new_epoch;
  74        unsigned int credits;
  75        unsigned int seqno;
  76        int resprc;
  77        int resprc_raw;
  78        size_t resp_hdr_len;
  79        size_t resp_data_len;
  80        spinlock_t async_lock;
  81        struct list_head async_list;
  82        struct timer_list async_timer;
  83#ifdef CONFIG_SFC_MCDI_LOGGING
  84        char *logging_buffer;
  85        bool logging_enabled;
  86#endif
  87        unsigned int proxy_rx_handle;
  88        int proxy_rx_status;
  89        wait_queue_head_t proxy_rx_wq;
  90};
  91
  92struct efx_mcdi_mon {
  93        struct efx_buffer dma_buf;
  94        struct mutex update_lock;
  95        unsigned long last_update;
  96        struct device *device;
  97        struct efx_mcdi_mon_attribute *attrs;
  98        struct attribute_group group;
  99        const struct attribute_group *groups[2];
 100        unsigned int n_attrs;
 101};
 102
 103struct efx_mcdi_mtd_partition {
 104        struct efx_mtd_partition common;
 105        bool updating;
 106        u16 nvram_type;
 107        u16 fw_subtype;
 108};
 109
 110#define to_efx_mcdi_mtd_partition(mtd)                          \
 111        container_of(mtd, struct efx_mcdi_mtd_partition, common.mtd)
 112
 113/**
 114 * struct efx_mcdi_data - extra state for NICs that implement MCDI
 115 * @iface: Interface/protocol state
 116 * @hwmon: Hardware monitor state
 117 * @fn_flags: Flags for this function, as returned by %MC_CMD_DRV_ATTACH.
 118 */
 119struct efx_mcdi_data {
 120        struct efx_mcdi_iface iface;
 121#ifdef CONFIG_SFC_MCDI_MON
 122        struct efx_mcdi_mon hwmon;
 123#endif
 124        u32 fn_flags;
 125};
 126
 127static inline struct efx_mcdi_iface *efx_mcdi(struct efx_nic *efx)
 128{
 129        EFX_WARN_ON_PARANOID(!efx->mcdi);
 130        return &efx->mcdi->iface;
 131}
 132
 133#ifdef CONFIG_SFC_MCDI_MON
 134static inline struct efx_mcdi_mon *efx_mcdi_mon(struct efx_nic *efx)
 135{
 136        EFX_WARN_ON_PARANOID(!efx->mcdi);
 137        return &efx->mcdi->hwmon;
 138}
 139#endif
 140
 141int efx_mcdi_init(struct efx_nic *efx);
 142void efx_mcdi_detach(struct efx_nic *efx);
 143void efx_mcdi_fini(struct efx_nic *efx);
 144
 145int efx_mcdi_rpc(struct efx_nic *efx, unsigned cmd, const efx_dword_t *inbuf,
 146                 size_t inlen, efx_dword_t *outbuf, size_t outlen,
 147                 size_t *outlen_actual);
 148int efx_mcdi_rpc_quiet(struct efx_nic *efx, unsigned cmd,
 149                       const efx_dword_t *inbuf, size_t inlen,
 150                       efx_dword_t *outbuf, size_t outlen,
 151                       size_t *outlen_actual);
 152
 153int efx_mcdi_rpc_start(struct efx_nic *efx, unsigned cmd,
 154                       const efx_dword_t *inbuf, size_t inlen);
 155int efx_mcdi_rpc_finish(struct efx_nic *efx, unsigned cmd, size_t inlen,
 156                        efx_dword_t *outbuf, size_t outlen,
 157                        size_t *outlen_actual);
 158int efx_mcdi_rpc_finish_quiet(struct efx_nic *efx, unsigned cmd,
 159                              size_t inlen, efx_dword_t *outbuf,
 160                              size_t outlen, size_t *outlen_actual);
 161
 162typedef void efx_mcdi_async_completer(struct efx_nic *efx,
 163                                      unsigned long cookie, int rc,
 164                                      efx_dword_t *outbuf,
 165                                      size_t outlen_actual);
 166int efx_mcdi_rpc_async(struct efx_nic *efx, unsigned int cmd,
 167                       const efx_dword_t *inbuf, size_t inlen, size_t outlen,
 168                       efx_mcdi_async_completer *complete,
 169                       unsigned long cookie);
 170int efx_mcdi_rpc_async_quiet(struct efx_nic *efx, unsigned int cmd,
 171                             const efx_dword_t *inbuf, size_t inlen,
 172                             size_t outlen,
 173                             efx_mcdi_async_completer *complete,
 174                             unsigned long cookie);
 175
 176void efx_mcdi_display_error(struct efx_nic *efx, unsigned cmd,
 177                            size_t inlen, efx_dword_t *outbuf,
 178                            size_t outlen, int rc);
 179
 180int efx_mcdi_poll_reboot(struct efx_nic *efx);
 181void efx_mcdi_mode_poll(struct efx_nic *efx);
 182void efx_mcdi_mode_event(struct efx_nic *efx);
 183void efx_mcdi_flush_async(struct efx_nic *efx);
 184
 185void efx_mcdi_process_event(struct efx_channel *channel, efx_qword_t *event);
 186void efx_mcdi_sensor_event(struct efx_nic *efx, efx_qword_t *ev);
 187
 188/* We expect that 16- and 32-bit fields in MCDI requests and responses
 189 * are appropriately aligned, but 64-bit fields are only
 190 * 32-bit-aligned.  Also, on Siena we must copy to the MC shared
 191 * memory strictly 32 bits at a time, so add any necessary padding.
 192 */
 193#define MCDI_TX_BUF_LEN(_len) DIV_ROUND_UP((_len), 4)
 194#define _MCDI_DECLARE_BUF(_name, _len)                                  \
 195        efx_dword_t _name[DIV_ROUND_UP(_len, 4)]
 196#define MCDI_DECLARE_BUF(_name, _len)                                   \
 197        _MCDI_DECLARE_BUF(_name, _len) = {{{0}}}
 198#define MCDI_DECLARE_BUF_ERR(_name)                                     \
 199        MCDI_DECLARE_BUF(_name, 8)
 200#define _MCDI_PTR(_buf, _offset)                                        \
 201        ((u8 *)(_buf) + (_offset))
 202#define MCDI_PTR(_buf, _field)                                          \
 203        _MCDI_PTR(_buf, MC_CMD_ ## _field ## _OFST)
 204#define _MCDI_CHECK_ALIGN(_ofst, _align)                                \
 205        ((_ofst) + BUILD_BUG_ON_ZERO((_ofst) & (_align - 1)))
 206#define _MCDI_DWORD(_buf, _field)                                       \
 207        ((_buf) + (_MCDI_CHECK_ALIGN(MC_CMD_ ## _field ## _OFST, 4) >> 2))
 208
 209#define MCDI_BYTE(_buf, _field)                                         \
 210        ((void)BUILD_BUG_ON_ZERO(MC_CMD_ ## _field ## _LEN != 1),       \
 211         *MCDI_PTR(_buf, _field))
 212#define MCDI_WORD(_buf, _field)                                         \
 213        ((u16)BUILD_BUG_ON_ZERO(MC_CMD_ ## _field ## _LEN != 2) +       \
 214         le16_to_cpu(*(__force const __le16 *)MCDI_PTR(_buf, _field)))
 215#define MCDI_SET_DWORD(_buf, _field, _value)                            \
 216        EFX_POPULATE_DWORD_1(*_MCDI_DWORD(_buf, _field), EFX_DWORD_0, _value)
 217#define MCDI_DWORD(_buf, _field)                                        \
 218        EFX_DWORD_FIELD(*_MCDI_DWORD(_buf, _field), EFX_DWORD_0)
 219#define MCDI_POPULATE_DWORD_1(_buf, _field, _name1, _value1)            \
 220        EFX_POPULATE_DWORD_1(*_MCDI_DWORD(_buf, _field),                \
 221                             MC_CMD_ ## _name1, _value1)
 222#define MCDI_POPULATE_DWORD_2(_buf, _field, _name1, _value1,            \
 223                              _name2, _value2)                          \
 224        EFX_POPULATE_DWORD_2(*_MCDI_DWORD(_buf, _field),                \
 225                             MC_CMD_ ## _name1, _value1,                \
 226                             MC_CMD_ ## _name2, _value2)
 227#define MCDI_POPULATE_DWORD_3(_buf, _field, _name1, _value1,            \
 228                              _name2, _value2, _name3, _value3)         \
 229        EFX_POPULATE_DWORD_3(*_MCDI_DWORD(_buf, _field),                \
 230                             MC_CMD_ ## _name1, _value1,                \
 231                             MC_CMD_ ## _name2, _value2,                \
 232                             MC_CMD_ ## _name3, _value3)
 233#define MCDI_POPULATE_DWORD_4(_buf, _field, _name1, _value1,            \
 234                              _name2, _value2, _name3, _value3,         \
 235                              _name4, _value4)                          \
 236        EFX_POPULATE_DWORD_4(*_MCDI_DWORD(_buf, _field),                \
 237                             MC_CMD_ ## _name1, _value1,                \
 238                             MC_CMD_ ## _name2, _value2,                \
 239                             MC_CMD_ ## _name3, _value3,                \
 240                             MC_CMD_ ## _name4, _value4)
 241#define MCDI_POPULATE_DWORD_5(_buf, _field, _name1, _value1,            \
 242                              _name2, _value2, _name3, _value3,         \
 243                              _name4, _value4, _name5, _value5)         \
 244        EFX_POPULATE_DWORD_5(*_MCDI_DWORD(_buf, _field),                \
 245                             MC_CMD_ ## _name1, _value1,                \
 246                             MC_CMD_ ## _name2, _value2,                \
 247                             MC_CMD_ ## _name3, _value3,                \
 248                             MC_CMD_ ## _name4, _value4,                \
 249                             MC_CMD_ ## _name5, _value5)
 250#define MCDI_POPULATE_DWORD_6(_buf, _field, _name1, _value1,            \
 251                              _name2, _value2, _name3, _value3,         \
 252                              _name4, _value4, _name5, _value5,         \
 253                              _name6, _value6)                          \
 254        EFX_POPULATE_DWORD_6(*_MCDI_DWORD(_buf, _field),                \
 255                             MC_CMD_ ## _name1, _value1,                \
 256                             MC_CMD_ ## _name2, _value2,                \
 257                             MC_CMD_ ## _name3, _value3,                \
 258                             MC_CMD_ ## _name4, _value4,                \
 259                             MC_CMD_ ## _name5, _value5,                \
 260                             MC_CMD_ ## _name6, _value6)
 261#define MCDI_POPULATE_DWORD_7(_buf, _field, _name1, _value1,            \
 262                              _name2, _value2, _name3, _value3,         \
 263                              _name4, _value4, _name5, _value5,         \
 264                              _name6, _value6, _name7, _value7)         \
 265        EFX_POPULATE_DWORD_7(*_MCDI_DWORD(_buf, _field),                \
 266                             MC_CMD_ ## _name1, _value1,                \
 267                             MC_CMD_ ## _name2, _value2,                \
 268                             MC_CMD_ ## _name3, _value3,                \
 269                             MC_CMD_ ## _name4, _value4,                \
 270                             MC_CMD_ ## _name5, _value5,                \
 271                             MC_CMD_ ## _name6, _value6,                \
 272                             MC_CMD_ ## _name7, _value7)
 273#define MCDI_SET_QWORD(_buf, _field, _value)                            \
 274        do {                                                            \
 275                EFX_POPULATE_DWORD_1(_MCDI_DWORD(_buf, _field)[0],      \
 276                                     EFX_DWORD_0, (u32)(_value));       \
 277                EFX_POPULATE_DWORD_1(_MCDI_DWORD(_buf, _field)[1],      \
 278                                     EFX_DWORD_0, (u64)(_value) >> 32); \
 279        } while (0)
 280#define MCDI_QWORD(_buf, _field)                                        \
 281        (EFX_DWORD_FIELD(_MCDI_DWORD(_buf, _field)[0], EFX_DWORD_0) |   \
 282        (u64)EFX_DWORD_FIELD(_MCDI_DWORD(_buf, _field)[1], EFX_DWORD_0) << 32)
 283#define MCDI_FIELD(_ptr, _type, _field)                                 \
 284        EFX_EXTRACT_DWORD(                                              \
 285                *(efx_dword_t *)                                        \
 286                _MCDI_PTR(_ptr, MC_CMD_ ## _type ## _ ## _field ## _OFST & ~3),\
 287                MC_CMD_ ## _type ## _ ## _field ## _LBN & 0x1f, \
 288                (MC_CMD_ ## _type ## _ ## _field ## _LBN & 0x1f) +      \
 289                MC_CMD_ ## _type ## _ ## _field ## _WIDTH - 1)
 290
 291#define _MCDI_ARRAY_PTR(_buf, _field, _index, _align)                   \
 292        (_MCDI_PTR(_buf, _MCDI_CHECK_ALIGN(MC_CMD_ ## _field ## _OFST, _align))\
 293         + (_index) * _MCDI_CHECK_ALIGN(MC_CMD_ ## _field ## _LEN, _align))
 294#define MCDI_DECLARE_STRUCT_PTR(_name)                                  \
 295        efx_dword_t *_name
 296#define MCDI_ARRAY_STRUCT_PTR(_buf, _field, _index)                     \
 297        ((efx_dword_t *)_MCDI_ARRAY_PTR(_buf, _field, _index, 4))
 298#define MCDI_VAR_ARRAY_LEN(_len, _field)                                \
 299        min_t(size_t, MC_CMD_ ## _field ## _MAXNUM,                     \
 300              ((_len) - MC_CMD_ ## _field ## _OFST) / MC_CMD_ ## _field ## _LEN)
 301#define MCDI_ARRAY_WORD(_buf, _field, _index)                           \
 302        (BUILD_BUG_ON_ZERO(MC_CMD_ ## _field ## _LEN != 2) +            \
 303         le16_to_cpu(*(__force const __le16 *)                          \
 304                     _MCDI_ARRAY_PTR(_buf, _field, _index, 2)))
 305#define _MCDI_ARRAY_DWORD(_buf, _field, _index)                         \
 306        (BUILD_BUG_ON_ZERO(MC_CMD_ ## _field ## _LEN != 4) +            \
 307         (efx_dword_t *)_MCDI_ARRAY_PTR(_buf, _field, _index, 4))
 308#define MCDI_SET_ARRAY_DWORD(_buf, _field, _index, _value)              \
 309        EFX_SET_DWORD_FIELD(*_MCDI_ARRAY_DWORD(_buf, _field, _index),   \
 310                            EFX_DWORD_0, _value)
 311#define MCDI_ARRAY_DWORD(_buf, _field, _index)                          \
 312        EFX_DWORD_FIELD(*_MCDI_ARRAY_DWORD(_buf, _field, _index), EFX_DWORD_0)
 313#define _MCDI_ARRAY_QWORD(_buf, _field, _index)                         \
 314        (BUILD_BUG_ON_ZERO(MC_CMD_ ## _field ## _LEN != 8) +            \
 315         (efx_dword_t *)_MCDI_ARRAY_PTR(_buf, _field, _index, 4))
 316#define MCDI_SET_ARRAY_QWORD(_buf, _field, _index, _value)              \
 317        do {                                                            \
 318                EFX_SET_DWORD_FIELD(_MCDI_ARRAY_QWORD(_buf, _field, _index)[0],\
 319                                    EFX_DWORD_0, (u32)(_value));        \
 320                EFX_SET_DWORD_FIELD(_MCDI_ARRAY_QWORD(_buf, _field, _index)[1],\
 321                                    EFX_DWORD_0, (u64)(_value) >> 32);  \
 322        } while (0)
 323#define MCDI_ARRAY_FIELD(_buf, _field1, _type, _index, _field2)         \
 324        MCDI_FIELD(MCDI_ARRAY_STRUCT_PTR(_buf, _field1, _index),        \
 325                   _type ## _TYPEDEF, _field2)
 326
 327#define MCDI_EVENT_FIELD(_ev, _field)                   \
 328        EFX_QWORD_FIELD(_ev, MCDI_EVENT_ ## _field)
 329
 330#define MCDI_CAPABILITY(field)                                          \
 331        MC_CMD_GET_CAPABILITIES_V8_OUT_ ## field ## _LBN
 332
 333#define MCDI_CAPABILITY_OFST(field) \
 334        MC_CMD_GET_CAPABILITIES_V8_OUT_ ## field ## _OFST
 335
 336#define efx_has_cap(efx, field) \
 337        efx->type->check_caps(efx, \
 338                              MCDI_CAPABILITY(field), \
 339                              MCDI_CAPABILITY_OFST(field))
 340
 341void efx_mcdi_print_fwver(struct efx_nic *efx, char *buf, size_t len);
 342int efx_mcdi_get_board_cfg(struct efx_nic *efx, u8 *mac_address,
 343                           u16 *fw_subtype_list, u32 *capabilities);
 344int efx_mcdi_log_ctrl(struct efx_nic *efx, bool evq, bool uart, u32 dest_evq);
 345int efx_mcdi_nvram_types(struct efx_nic *efx, u32 *nvram_types_out);
 346int efx_mcdi_nvram_info(struct efx_nic *efx, unsigned int type,
 347                        size_t *size_out, size_t *erase_size_out,
 348                        bool *protected_out);
 349int efx_new_mcdi_nvram_test_all(struct efx_nic *efx);
 350int efx_mcdi_nvram_test_all(struct efx_nic *efx);
 351int efx_mcdi_handle_assertion(struct efx_nic *efx);
 352int efx_mcdi_set_id_led(struct efx_nic *efx, enum efx_led_mode mode);
 353int efx_mcdi_wol_filter_set_magic(struct efx_nic *efx, const u8 *mac,
 354                                  int *id_out);
 355int efx_mcdi_wol_filter_get_magic(struct efx_nic *efx, int *id_out);
 356int efx_mcdi_wol_filter_remove(struct efx_nic *efx, int id);
 357int efx_mcdi_wol_filter_reset(struct efx_nic *efx);
 358int efx_mcdi_flush_rxqs(struct efx_nic *efx);
 359void efx_mcdi_process_link_change(struct efx_nic *efx, efx_qword_t *ev);
 360void efx_mcdi_mac_start_stats(struct efx_nic *efx);
 361void efx_mcdi_mac_stop_stats(struct efx_nic *efx);
 362void efx_mcdi_mac_pull_stats(struct efx_nic *efx);
 363enum reset_type efx_mcdi_map_reset_reason(enum reset_type reason);
 364int efx_mcdi_reset(struct efx_nic *efx, enum reset_type method);
 365int efx_mcdi_set_workaround(struct efx_nic *efx, u32 type, bool enabled,
 366                            unsigned int *flags);
 367int efx_mcdi_get_workarounds(struct efx_nic *efx, unsigned int *impl_out,
 368                             unsigned int *enabled_out);
 369
 370#ifdef CONFIG_SFC_MCDI_MON
 371int efx_mcdi_mon_probe(struct efx_nic *efx);
 372void efx_mcdi_mon_remove(struct efx_nic *efx);
 373#else
 374static inline int efx_mcdi_mon_probe(struct efx_nic *efx) { return 0; }
 375static inline void efx_mcdi_mon_remove(struct efx_nic *efx) {}
 376#endif
 377
 378#ifdef CONFIG_SFC_MTD
 379int efx_mcdi_mtd_read(struct mtd_info *mtd, loff_t start, size_t len,
 380                      size_t *retlen, u8 *buffer);
 381int efx_mcdi_mtd_erase(struct mtd_info *mtd, loff_t start, size_t len);
 382int efx_mcdi_mtd_write(struct mtd_info *mtd, loff_t start, size_t len,
 383                       size_t *retlen, const u8 *buffer);
 384int efx_mcdi_mtd_sync(struct mtd_info *mtd);
 385void efx_mcdi_mtd_rename(struct efx_mtd_partition *part);
 386#endif
 387
 388#endif /* EFX_MCDI_H */
 389