drivers/common/sfc_efx/base/efx_mcdi.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  *
   3  * Copyright(c) 2019-2020 Xilinx, Inc.
   4  * Copyright(c) 2009-2019 Solarflare Communications Inc.
   5  */
   6
   7 #ifndef _SYS_EFX_MCDI_H
   8 #define _SYS_EFX_MCDI_H
   9
  10 #include "efx.h"
  11 #include "efx_regs_mcdi.h"
  12
  13 #if EFSYS_OPT_NAMES
  14 #include "efx_regs_mcdi_strs.h"
  15 #endif /* EFSYS_OPT_NAMES */
  16
  17 #ifdef  __cplusplus
  18 extern "C" {
  19 #endif
  20
  21 /*
  22  * A reboot/assertion causes the MCDI status word to be set after the
  23  * command word is set or a REBOOT event is sent. If we notice a reboot
  24  * via these mechanisms then wait 10ms for the status word to be set.
  25  */
  26 #define EFX_MCDI_STATUS_SLEEP_US        10000
  27
  28 struct efx_mcdi_req_s {
  29         boolean_t       emr_quiet;
  30         /* Inputs: Command #, input buffer and length */
  31         unsigned int    emr_cmd;
  32         uint8_t         *emr_in_buf;
  33         size_t          emr_in_length;
  34         /* Outputs: retcode, buffer, length and length used */
  35         efx_rc_t        emr_rc;
  36         uint8_t         *emr_out_buf;
  37         size_t          emr_out_length;
  38         size_t          emr_out_length_used;
  39         /* Internals: low level transport details */
  40         unsigned int    emr_err_code;
  41         unsigned int    emr_err_arg;
  42 #if EFSYS_OPT_MCDI_PROXY_AUTH
  43         uint32_t        emr_proxy_handle;
  44 #endif
  45 };
  46
  47 typedef struct efx_mcdi_iface_s {
  48         unsigned int            emi_port;
  49         unsigned int            emi_max_version;
  50         unsigned int            emi_seq;
  51         efx_mcdi_req_t          *emi_pending_req;
  52         boolean_t               emi_ev_cpl;
  53         boolean_t               emi_new_epoch;
  54         int                     emi_aborted;
  55         uint32_t                emi_poll_cnt;
  56         uint32_t                emi_mc_reboot_status;
  57 } efx_mcdi_iface_t;
  58
  59 LIBEFX_INTERNAL
  60 extern                  void
  61 efx_mcdi_execute(
  62         __in            efx_nic_t *enp,
  63         __inout         efx_mcdi_req_t *emrp);
  64
  65 LIBEFX_INTERNAL
  66 extern                  void
  67 efx_mcdi_execute_quiet(
  68         __in            efx_nic_t *enp,
  69         __inout         efx_mcdi_req_t *emrp);
  70
  71 LIBEFX_INTERNAL
  72 extern                  void
  73 efx_mcdi_ev_cpl(
  74         __in            efx_nic_t *enp,
  75         __in            unsigned int seq,
  76         __in            unsigned int outlen,
  77         __in            int errcode);
  78
  79 #if EFSYS_OPT_MCDI_PROXY_AUTH
  80 LIBEFX_API
  81 extern  __checkReturn   efx_rc_t
  82 efx_mcdi_get_proxy_handle(
  83         __in            efx_nic_t *enp,
  84         __in            efx_mcdi_req_t *emrp,
  85         __out           uint32_t *handlep);
  86
  87 LIBEFX_INTERNAL
  88 extern                  void
  89 efx_mcdi_ev_proxy_response(
  90         __in            efx_nic_t *enp,
  91         __in            unsigned int handle,
  92         __in            unsigned int status);
  93 #endif
  94
  95 #if EFSYS_OPT_MCDI_PROXY_AUTH_SERVER
  96 LIBEFX_INTERNAL
  97 extern                  void
  98 efx_mcdi_ev_proxy_request(
  99         __in            efx_nic_t *enp,
 100         __in            unsigned int index);
 101 #endif /* EFSYS_OPT_MCDI_PROXY_AUTH_SERVER */
 102
 103 LIBEFX_INTERNAL
 104 extern                  void
 105 efx_mcdi_ev_death(
 106         __in            efx_nic_t *enp,
 107         __in            int rc);
 108
 109 LIBEFX_INTERNAL
 110 extern  __checkReturn   efx_rc_t
 111 efx_mcdi_request_errcode(
 112         __in            unsigned int err);
 113
 114 LIBEFX_INTERNAL
 115 extern                  void
 116 efx_mcdi_raise_exception(
 117         __in            efx_nic_t *enp,
 118         __in_opt        efx_mcdi_req_t *emrp,
 119         __in            int rc);
 120
 121 typedef struct efx_mcdi_version_s {
 122         /* Basic version information */
 123         uint16_t                emv_version[4];
 124         uint32_t                emv_firmware;
 125 } efx_mcdi_version_t;
 126
 127 LIBEFX_INTERNAL
 128 extern  __checkReturn   efx_rc_t
 129 efx_mcdi_get_version(
 130         __in            efx_nic_t *enp,
 131         __out           efx_mcdi_version_t *verp);
 132
 133 typedef enum efx_mcdi_boot_e {
 134         EFX_MCDI_BOOT_PRIMARY,
 135         EFX_MCDI_BOOT_SECONDARY,
 136         EFX_MCDI_BOOT_ROM,
 137 } efx_mcdi_boot_t;
 138
 139 LIBEFX_INTERNAL
 140 extern  __checkReturn           efx_rc_t
 141 efx_mcdi_version(
 142         __in                    efx_nic_t *enp,
 143         __out_ecount_opt(4)     uint16_t versionp[4],
 144         __out_opt               uint32_t *buildp,
 145         __out_opt               efx_mcdi_boot_t *statusp);
 146
 147 LIBEFX_INTERNAL
 148 extern  __checkReturn   efx_rc_t
 149 efx_mcdi_get_capabilities(
 150         __in            efx_nic_t *enp,
 151         __out_opt       uint32_t *flagsp,
 152         __out_opt       uint16_t *rx_dpcpu_fw_idp,
 153         __out_opt       uint16_t *tx_dpcpu_fw_idp,
 154         __out_opt       uint32_t *flags2p,
 155         __out_opt       uint32_t *tso2ncp);
 156
 157 LIBEFX_INTERNAL
 158 extern  __checkReturn           efx_rc_t
 159 efx_mcdi_read_assertion(
 160         __in                    efx_nic_t *enp);
 161
 162 LIBEFX_INTERNAL
 163 extern  __checkReturn           efx_rc_t
 164 efx_mcdi_exit_assertion_handler(
 165         __in                    efx_nic_t *enp);
 166
 167 LIBEFX_INTERNAL
 168 extern  __checkReturn           efx_rc_t
 169 efx_mcdi_drv_attach(
 170         __in                    efx_nic_t *enp,
 171         __in                    boolean_t attach);
 172
 173 LIBEFX_INTERNAL
 174 extern  __checkReturn           efx_rc_t
 175 efx_mcdi_get_board_cfg(
 176         __in                    efx_nic_t *enp,
 177         __out_opt               uint32_t *board_typep,
 178         __out_opt               efx_dword_t *capabilitiesp,
 179         __out_ecount_opt(6)     uint8_t mac_addrp[6]);
 180
 181 LIBEFX_INTERNAL
 182 extern  __checkReturn           efx_rc_t
 183 efx_mcdi_get_phy_cfg(
 184         __in                    efx_nic_t *enp);
 185
 186 LIBEFX_INTERNAL
 187 extern  __checkReturn           efx_rc_t
 188 efx_mcdi_firmware_update_supported(
 189         __in                    efx_nic_t *enp,
 190         __out                   boolean_t *supportedp);
 191
 192 LIBEFX_INTERNAL
 193 extern  __checkReturn           efx_rc_t
 194 efx_mcdi_macaddr_change_supported(
 195         __in                    efx_nic_t *enp,
 196         __out                   boolean_t *supportedp);
 197
 198 LIBEFX_INTERNAL
 199 extern  __checkReturn           efx_rc_t
 200 efx_mcdi_link_control_supported(
 201         __in                    efx_nic_t *enp,
 202         __out                   boolean_t *supportedp);
 203
 204 LIBEFX_INTERNAL
 205 extern  __checkReturn           efx_rc_t
 206 efx_mcdi_mac_spoofing_supported(
 207         __in                    efx_nic_t *enp,
 208         __out                   boolean_t *supportedp);
 209
 210
 211 #if EFSYS_OPT_BIST
 212 #if EFX_OPTS_EF10()
 213 LIBEFX_INTERNAL
 214 extern  __checkReturn           efx_rc_t
 215 efx_mcdi_bist_enable_offline(
 216         __in                    efx_nic_t *enp);
 217 #endif /* EFX_OPTS_EF10() */
 218 LIBEFX_INTERNAL
 219 extern  __checkReturn           efx_rc_t
 220 efx_mcdi_bist_start(
 221         __in                    efx_nic_t *enp,
 222         __in                    efx_bist_type_t type);
 223 #endif /* EFSYS_OPT_BIST */
 224
 225 LIBEFX_INTERNAL
 226 extern  __checkReturn           efx_rc_t
 227 efx_mcdi_get_resource_limits(
 228         __in                    efx_nic_t *enp,
 229         __out_opt               uint32_t *nevqp,
 230         __out_opt               uint32_t *nrxqp,
 231         __out_opt               uint32_t *ntxqp);
 232
 233 LIBEFX_INTERNAL
 234 extern  __checkReturn   efx_rc_t
 235 efx_mcdi_log_ctrl(
 236         __in            efx_nic_t *enp);
 237
 238 LIBEFX_INTERNAL
 239 extern  __checkReturn   efx_rc_t
 240 efx_mcdi_mac_stats_clear(
 241         __in            efx_nic_t *enp);
 242
 243 LIBEFX_INTERNAL
 244 extern  __checkReturn   efx_rc_t
 245 efx_mcdi_mac_stats_upload(
 246         __in            efx_nic_t *enp,
 247         __in            efsys_mem_t *esmp);
 248
 249 LIBEFX_INTERNAL
 250 extern  __checkReturn   efx_rc_t
 251 efx_mcdi_mac_stats_periodic(
 252         __in            efx_nic_t *enp,
 253         __in            efsys_mem_t *esmp,
 254         __in            uint16_t period_ms,
 255         __in            boolean_t events);
 256
 257
 258 #if EFSYS_OPT_LOOPBACK
 259 LIBEFX_INTERNAL
 260 extern  __checkReturn   efx_rc_t
 261 efx_mcdi_get_loopback_modes(
 262         __in            efx_nic_t *enp);
 263 #endif /* EFSYS_OPT_LOOPBACK */
 264
 265 LIBEFX_INTERNAL
 266 extern  __checkReturn   efx_rc_t
 267 efx_mcdi_phy_module_get_info(
 268         __in                    efx_nic_t *enp,
 269         __in                    uint8_t dev_addr,
 270         __in                    size_t offset,
 271         __in                    size_t len,
 272         __out_bcount(len)       uint8_t *data);
 273
 274 #define MCDI_IN(_emr, _type, _ofst)                                     \
 275         ((_type *)((_emr).emr_in_buf + (_ofst)))
 276
 277 #define MCDI_IN2(_emr, _type, _ofst)                                    \
 278         MCDI_IN(_emr, _type, MC_CMD_ ## _ofst ## _OFST)
 279
 280 #define MCDI_IN_SET_BYTE(_emr, _ofst, _value)                           \
 281         EFX_POPULATE_BYTE_1(*MCDI_IN2(_emr, efx_byte_t, _ofst),         \
 282                 EFX_BYTE_0, _value)
 283
 284 #define MCDI_IN_SET_WORD(_emr, _ofst, _value)                           \
 285         EFX_POPULATE_WORD_1(*MCDI_IN2(_emr, efx_word_t, _ofst),         \
 286                 EFX_WORD_0, _value)
 287
 288 #define MCDI_IN_SET_DWORD(_emr, _ofst, _value)                          \
 289         EFX_POPULATE_DWORD_1(*MCDI_IN2(_emr, efx_dword_t, _ofst),       \
 290                 EFX_DWORD_0, _value)
 291
 292 #define MCDI_IN_SET_DWORD_FIELD(_emr, _ofst, _field, _value)            \
 293         EFX_SET_DWORD_FIELD(*MCDI_IN2(_emr, efx_dword_t, _ofst),        \
 294                 MC_CMD_ ## _field, _value)
 295
 296 #define MCDI_IN_POPULATE_DWORD_1(_emr, _ofst, _field1, _value1)         \
 297         EFX_POPULATE_DWORD_1(*MCDI_IN2(_emr, efx_dword_t, _ofst),       \
 298                 MC_CMD_ ## _field1, _value1)
 299
 300 #define MCDI_IN_POPULATE_DWORD_2(_emr, _ofst, _field1, _value1,         \
 301                 _field2, _value2)                                       \
 302         EFX_POPULATE_DWORD_2(*MCDI_IN2(_emr, efx_dword_t, _ofst),       \
 303                 MC_CMD_ ## _field1, _value1,                            \
 304                 MC_CMD_ ## _field2, _value2)
 305
 306 #define MCDI_IN_POPULATE_DWORD_3(_emr, _ofst, _field1, _value1,         \
 307                 _field2, _value2, _field3, _value3)                     \
 308         EFX_POPULATE_DWORD_3(*MCDI_IN2(_emr, efx_dword_t, _ofst),       \
 309                 MC_CMD_ ## _field1, _value1,                            \
 310                 MC_CMD_ ## _field2, _value2,                            \
 311                 MC_CMD_ ## _field3, _value3)
 312
 313 #define MCDI_IN_POPULATE_DWORD_4(_emr, _ofst, _field1, _value1,         \
 314                 _field2, _value2, _field3, _value3, _field4, _value4)   \
 315         EFX_POPULATE_DWORD_4(*MCDI_IN2(_emr, efx_dword_t, _ofst),       \
 316                 MC_CMD_ ## _field1, _value1,                            \
 317                 MC_CMD_ ## _field2, _value2,                            \
 318                 MC_CMD_ ## _field3, _value3,                            \
 319                 MC_CMD_ ## _field4, _value4)
 320
 321 #define MCDI_IN_POPULATE_DWORD_5(_emr, _ofst, _field1, _value1,         \
 322                 _field2, _value2, _field3, _value3, _field4, _value4,   \
 323                 _field5, _value5)                                       \
 324         EFX_POPULATE_DWORD_5(*MCDI_IN2(_emr, efx_dword_t, _ofst),       \
 325                 MC_CMD_ ## _field1, _value1,                            \
 326                 MC_CMD_ ## _field2, _value2,                            \
 327                 MC_CMD_ ## _field3, _value3,                            \
 328                 MC_CMD_ ## _field4, _value4,                            \
 329                 MC_CMD_ ## _field5, _value5)
 330
 331 #define MCDI_IN_POPULATE_DWORD_6(_emr, _ofst, _field1, _value1,         \
 332                 _field2, _value2, _field3, _value3, _field4, _value4,   \
 333                 _field5, _value5, _field6, _value6)                     \
 334         EFX_POPULATE_DWORD_6(*MCDI_IN2(_emr, efx_dword_t, _ofst),       \
 335                 MC_CMD_ ## _field1, _value1,                            \
 336                 MC_CMD_ ## _field2, _value2,                            \
 337                 MC_CMD_ ## _field3, _value3,                            \
 338                 MC_CMD_ ## _field4, _value4,                            \
 339                 MC_CMD_ ## _field5, _value5,                            \
 340                 MC_CMD_ ## _field6, _value6)
 341
 342 #define MCDI_IN_POPULATE_DWORD_7(_emr, _ofst, _field1, _value1,         \
 343                 _field2, _value2, _field3, _value3, _field4, _value4,   \
 344                 _field5, _value5, _field6, _value6, _field7, _value7)   \
 345         EFX_POPULATE_DWORD_7(*MCDI_IN2(_emr, efx_dword_t, _ofst),       \
 346                 MC_CMD_ ## _field1, _value1,                            \
 347                 MC_CMD_ ## _field2, _value2,                            \
 348                 MC_CMD_ ## _field3, _value3,                            \
 349                 MC_CMD_ ## _field4, _value4,                            \
 350                 MC_CMD_ ## _field5, _value5,                            \
 351                 MC_CMD_ ## _field6, _value6,                            \
 352                 MC_CMD_ ## _field7, _value7)
 353
 354 #define MCDI_IN_POPULATE_DWORD_8(_emr, _ofst, _field1, _value1,         \
 355                 _field2, _value2, _field3, _value3, _field4, _value4,   \
 356                 _field5, _value5, _field6, _value6, _field7, _value7,   \
 357                 _field8, _value8)                                       \
 358         EFX_POPULATE_DWORD_8(*MCDI_IN2(_emr, efx_dword_t, _ofst),       \
 359                 MC_CMD_ ## _field1, _value1,                            \
 360                 MC_CMD_ ## _field2, _value2,                            \
 361                 MC_CMD_ ## _field3, _value3,                            \
 362                 MC_CMD_ ## _field4, _value4,                            \
 363                 MC_CMD_ ## _field5, _value5,                            \
 364                 MC_CMD_ ## _field6, _value6,                            \
 365                 MC_CMD_ ## _field7, _value7,                            \
 366                 MC_CMD_ ## _field8, _value8)
 367
 368 #define MCDI_IN_POPULATE_DWORD_9(_emr, _ofst, _field1, _value1,         \
 369                 _field2, _value2, _field3, _value3, _field4, _value4,   \
 370                 _field5, _value5, _field6, _value6, _field7, _value7,   \
 371                 _field8, _value8, _field9, _value9)                     \
 372         EFX_POPULATE_DWORD_9(*MCDI_IN2(_emr, efx_dword_t, _ofst),       \
 373                 MC_CMD_ ## _field1, _value1,                            \
 374                 MC_CMD_ ## _field2, _value2,                            \
 375                 MC_CMD_ ## _field3, _value3,                            \
 376                 MC_CMD_ ## _field4, _value4,                            \
 377                 MC_CMD_ ## _field5, _value5,                            \
 378                 MC_CMD_ ## _field6, _value6,                            \
 379                 MC_CMD_ ## _field7, _value7,                            \
 380                 MC_CMD_ ## _field8, _value8,                            \
 381                 MC_CMD_ ## _field9, _value9)
 382
 383 #define MCDI_IN_POPULATE_DWORD_10(_emr, _ofst, _field1, _value1,        \
 384                 _field2, _value2, _field3, _value3, _field4, _value4,   \
 385                 _field5, _value5, _field6, _value6, _field7, _value7,   \
 386                 _field8, _value8, _field9, _value9, _field10, _value10) \
 387         EFX_POPULATE_DWORD_10(*MCDI_IN2(_emr, efx_dword_t, _ofst),      \
 388                 MC_CMD_ ## _field1, _value1,                            \
 389                 MC_CMD_ ## _field2, _value2,                            \
 390                 MC_CMD_ ## _field3, _value3,                            \
 391                 MC_CMD_ ## _field4, _value4,                            \
 392                 MC_CMD_ ## _field5, _value5,                            \
 393                 MC_CMD_ ## _field6, _value6,                            \
 394                 MC_CMD_ ## _field7, _value7,                            \
 395                 MC_CMD_ ## _field8, _value8,                            \
 396                 MC_CMD_ ## _field9, _value9,                            \
 397                 MC_CMD_ ## _field10, _value10)
 398
 399 /*
 400  * Native setters (MCDI_IN_SET_*_NATIVE) are used when MCDI field is in
 401  * network order to avoid conversion to little-endian that is done in
 402  * other setters.
 403  */
 404 #define MCDI_IN_SET_WORD_NATIVE(_emr, _ofst, _value)                    \
 405         MCDI_IN2((_emr), efx_word_t, _ofst)->ew_u16[0] = (_value)
 406
 407 #define MCDI_IN_SET_DWORD_NATIVE(_emr, _ofst, _value)                   \
 408         MCDI_IN2((_emr), efx_dword_t, _ofst)->ed_u32[0] = (_value)
 409
 410 #define MCDI_OUT(_emr, _type, _ofst)                                    \
 411         ((_type *)((_emr).emr_out_buf + (_ofst)))
 412
 413 #define MCDI_OUT2(_emr, _type, _ofst)                                   \
 414         MCDI_OUT(_emr, _type, MC_CMD_ ## _ofst ## _OFST)
 415
 416 #define MCDI_OUT_BYTE(_emr, _ofst)                                      \
 417         EFX_BYTE_FIELD(*MCDI_OUT2(_emr, efx_byte_t, _ofst),             \
 418                     EFX_BYTE_0)
 419
 420 #define MCDI_OUT_WORD(_emr, _ofst)                                      \
 421         EFX_WORD_FIELD(*MCDI_OUT2(_emr, efx_word_t, _ofst),             \
 422                     EFX_WORD_0)
 423
 424 #define MCDI_OUT_WORD_FIELD(_emr, _ofst, _field)                        \
 425         EFX_WORD_FIELD(*MCDI_OUT2(_emr, efx_word_t, _ofst),             \
 426                        MC_CMD_ ## _field)
 427
 428 #define MCDI_OUT_DWORD(_emr, _ofst)                                     \
 429         EFX_DWORD_FIELD(*MCDI_OUT2(_emr, efx_dword_t, _ofst),           \
 430                         EFX_DWORD_0)
 431
 432 #define MCDI_OUT_DWORD_FIELD(_emr, _ofst, _field)                       \
 433         EFX_DWORD_FIELD(*MCDI_OUT2(_emr, efx_dword_t, _ofst),           \
 434                         MC_CMD_ ## _field)
 435
 436 #define MCDI_OUT_INDEXED_DWORD_FIELD(_emr, _ofst, _idx, _field)         \
 437         EFX_DWORD_FIELD(*(MCDI_OUT2(_emr, efx_dword_t, _ofst) +         \
 438                         (_idx)), _field)
 439
 440 #define MCDI_EV_FIELD(_eqp, _field)                                     \
 441         EFX_QWORD_FIELD(*_eqp, MCDI_EVENT_ ## _field)
 442
 443 #define MCDI_CMD_DWORD_FIELD(_edp, _field)                              \
 444         EFX_DWORD_FIELD(*_edp, MC_CMD_ ## _field)
 445
 446 #define EFX_MCDI_HAVE_PRIVILEGE(mask, priv)                             \
 447         (((mask) & (MC_CMD_PRIVILEGE_MASK_IN_GRP_ ## priv)) ==          \
 448         (MC_CMD_PRIVILEGE_MASK_IN_GRP_ ## priv))
 449
 450 #define EFX_MCDI_BUF_SIZE(_in_len, _out_len)                            \
 451         EFX_P2ROUNDUP(size_t,                                           \
 452                 MAX(MAX(_in_len, _out_len), (2 * sizeof (efx_dword_t))),\
 453                 sizeof (efx_dword_t))
 454
 455 /*
 456  * The buffer size must be a multiple of dword to ensure that MCDI works
 457  * properly with Siena based boards (which use on-chip buffer). Also, it
 458  * should be at minimum the size of two dwords to allow space for extended
 459  * error responses if the request/response buffer sizes are smaller.
 460  */
 461 #define EFX_MCDI_DECLARE_BUF(_name, _in_len, _out_len)                  \
 462         uint8_t _name[EFX_MCDI_BUF_SIZE(_in_len, _out_len)] = {0}
 463
 464 typedef enum efx_mcdi_feature_id_e {
 465         EFX_MCDI_FEATURE_FW_UPDATE = 0,
 466         EFX_MCDI_FEATURE_LINK_CONTROL,
 467         EFX_MCDI_FEATURE_MACADDR_CHANGE,
 468         EFX_MCDI_FEATURE_MAC_SPOOFING,
 469         EFX_MCDI_FEATURE_NIDS
 470 } efx_mcdi_feature_id_t;
 471
 472 #ifdef  __cplusplus
 473 }
 474 #endif
 475
 476 #endif  /* _SYS_EFX_MCDI_H */