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 /*
 122  * Flags that name portions of extended version information
 123  *
 124  * The values match their MCDI counterparts.
 125  */
 126 #define EFX_MCDI_VERSION_BOARD_INFO     (1U << 4)
 127
 128 typedef struct efx_mcdi_version_s {
 129         /* Basic version information */
 130         uint16_t                emv_version[4];
 131         uint32_t                emv_firmware;
 132
 133         /*
 134          * Extended version information
 135          *
 136          * Valid portions of obtained information are indicated by flags.
 137          */
 138         uint32_t                emv_flags;
 139
 140         /* Information valid if emv_flags has EFX_MCDI_VERSION_BOARD_INFO set */
 141         efx_nic_board_info_t    emv_board_info;
 142 } efx_mcdi_version_t;
 143
 144 LIBEFX_INTERNAL
 145 extern  __checkReturn   efx_rc_t
 146 efx_mcdi_get_version(
 147         __in            efx_nic_t *enp,
 148         __in            uint32_t flags_req,
 149         __out           efx_mcdi_version_t *verp);
 150
 151 typedef enum efx_mcdi_boot_e {
 152         EFX_MCDI_BOOT_PRIMARY,
 153         EFX_MCDI_BOOT_SECONDARY,
 154         EFX_MCDI_BOOT_ROM,
 155 } efx_mcdi_boot_t;
 156
 157 LIBEFX_INTERNAL
 158 extern  __checkReturn           efx_rc_t
 159 efx_mcdi_version(
 160         __in                    efx_nic_t *enp,
 161         __out_ecount_opt(4)     uint16_t versionp[4],
 162         __out_opt               uint32_t *buildp,
 163         __out_opt               efx_mcdi_boot_t *statusp);
 164
 165 LIBEFX_INTERNAL
 166 extern  __checkReturn   efx_rc_t
 167 efx_mcdi_get_capabilities(
 168         __in            efx_nic_t *enp,
 169         __out_opt       uint32_t *flagsp,
 170         __out_opt       uint16_t *rx_dpcpu_fw_idp,
 171         __out_opt       uint16_t *tx_dpcpu_fw_idp,
 172         __out_opt       uint32_t *flags2p,
 173         __out_opt       uint32_t *tso2ncp);
 174
 175 LIBEFX_INTERNAL
 176 extern  __checkReturn           efx_rc_t
 177 efx_mcdi_read_assertion(
 178         __in                    efx_nic_t *enp);
 179
 180 LIBEFX_INTERNAL
 181 extern  __checkReturn           efx_rc_t
 182 efx_mcdi_exit_assertion_handler(
 183         __in                    efx_nic_t *enp);
 184
 185 LIBEFX_INTERNAL
 186 extern  __checkReturn           efx_rc_t
 187 efx_mcdi_drv_attach(
 188         __in                    efx_nic_t *enp,
 189         __in                    boolean_t attach);
 190
 191 LIBEFX_INTERNAL
 192 extern  __checkReturn           efx_rc_t
 193 efx_mcdi_get_board_cfg(
 194         __in                    efx_nic_t *enp,
 195         __out_opt               uint32_t *board_typep,
 196         __out_opt               efx_dword_t *capabilitiesp,
 197         __out_ecount_opt(6)     uint8_t mac_addrp[6]);
 198
 199 LIBEFX_INTERNAL
 200 extern  __checkReturn           efx_rc_t
 201 efx_mcdi_get_phy_cfg(
 202         __in                    efx_nic_t *enp);
 203
 204 LIBEFX_INTERNAL
 205 extern  __checkReturn           efx_rc_t
 206 efx_mcdi_firmware_update_supported(
 207         __in                    efx_nic_t *enp,
 208         __out                   boolean_t *supportedp);
 209
 210 LIBEFX_INTERNAL
 211 extern  __checkReturn           efx_rc_t
 212 efx_mcdi_macaddr_change_supported(
 213         __in                    efx_nic_t *enp,
 214         __out                   boolean_t *supportedp);
 215
 216 LIBEFX_INTERNAL
 217 extern  __checkReturn           efx_rc_t
 218 efx_mcdi_link_control_supported(
 219         __in                    efx_nic_t *enp,
 220         __out                   boolean_t *supportedp);
 221
 222 LIBEFX_INTERNAL
 223 extern  __checkReturn           efx_rc_t
 224 efx_mcdi_mac_spoofing_supported(
 225         __in                    efx_nic_t *enp,
 226         __out                   boolean_t *supportedp);
 227
 228
 229 #if EFSYS_OPT_BIST
 230 #if EFX_OPTS_EF10()
 231 LIBEFX_INTERNAL
 232 extern  __checkReturn           efx_rc_t
 233 efx_mcdi_bist_enable_offline(
 234         __in                    efx_nic_t *enp);
 235 #endif /* EFX_OPTS_EF10() */
 236 LIBEFX_INTERNAL
 237 extern  __checkReturn           efx_rc_t
 238 efx_mcdi_bist_start(
 239         __in                    efx_nic_t *enp,
 240         __in                    efx_bist_type_t type);
 241 #endif /* EFSYS_OPT_BIST */
 242
 243 LIBEFX_INTERNAL
 244 extern  __checkReturn           efx_rc_t
 245 efx_mcdi_get_resource_limits(
 246         __in                    efx_nic_t *enp,
 247         __out_opt               uint32_t *nevqp,
 248         __out_opt               uint32_t *nrxqp,
 249         __out_opt               uint32_t *ntxqp);
 250
 251 LIBEFX_INTERNAL
 252 extern  __checkReturn   efx_rc_t
 253 efx_mcdi_log_ctrl(
 254         __in            efx_nic_t *enp);
 255
 256 LIBEFX_INTERNAL
 257 extern  __checkReturn   efx_rc_t
 258 efx_mcdi_mac_stats_clear(
 259         __in            efx_nic_t *enp);
 260
 261 LIBEFX_INTERNAL
 262 extern  __checkReturn   efx_rc_t
 263 efx_mcdi_mac_stats_upload(
 264         __in            efx_nic_t *enp,
 265         __in            efsys_mem_t *esmp);
 266
 267 LIBEFX_INTERNAL
 268 extern  __checkReturn   efx_rc_t
 269 efx_mcdi_mac_stats_periodic(
 270         __in            efx_nic_t *enp,
 271         __in            efsys_mem_t *esmp,
 272         __in            uint16_t period_ms,
 273         __in            boolean_t events);
 274
 275
 276 #if EFSYS_OPT_LOOPBACK
 277 LIBEFX_INTERNAL
 278 extern  __checkReturn   efx_rc_t
 279 efx_mcdi_get_loopback_modes(
 280         __in            efx_nic_t *enp);
 281 #endif /* EFSYS_OPT_LOOPBACK */
 282
 283 LIBEFX_INTERNAL
 284 extern  __checkReturn   efx_rc_t
 285 efx_mcdi_phy_module_get_info(
 286         __in                    efx_nic_t *enp,
 287         __in                    uint8_t dev_addr,
 288         __in                    size_t offset,
 289         __in                    size_t len,
 290         __out_bcount(len)       uint8_t *data);
 291
 292 #define MCDI_IN(_emr, _type, _ofst)                                     \
 293         ((_type *)((_emr).emr_in_buf + (_ofst)))
 294
 295 #define MCDI_IN2(_emr, _type, _ofst)                                    \
 296         MCDI_IN(_emr, _type, MC_CMD_ ## _ofst ## _OFST)
 297
 298 #define MCDI_IN_SET_BYTE(_emr, _ofst, _value)                           \
 299         EFX_POPULATE_BYTE_1(*MCDI_IN2(_emr, efx_byte_t, _ofst),         \
 300                 EFX_BYTE_0, _value)
 301
 302 #define MCDI_IN_SET_WORD(_emr, _ofst, _value)                           \
 303         EFX_POPULATE_WORD_1(*MCDI_IN2(_emr, efx_word_t, _ofst),         \
 304                 EFX_WORD_0, _value)
 305
 306 #define MCDI_IN_SET_DWORD(_emr, _ofst, _value)                          \
 307         EFX_POPULATE_DWORD_1(*MCDI_IN2(_emr, efx_dword_t, _ofst),       \
 308                 EFX_DWORD_0, _value)
 309
 310 #define MCDI_IN_SET_DWORD_FIELD(_emr, _ofst, _field, _value)            \
 311         EFX_SET_DWORD_FIELD(*MCDI_IN2(_emr, efx_dword_t, _ofst),        \
 312                 MC_CMD_ ## _field, _value)
 313
 314 #define MCDI_IN_POPULATE_DWORD_1(_emr, _ofst, _field1, _value1)         \
 315         EFX_POPULATE_DWORD_1(*MCDI_IN2(_emr, efx_dword_t, _ofst),       \
 316                 MC_CMD_ ## _field1, _value1)
 317
 318 #define MCDI_IN_POPULATE_DWORD_2(_emr, _ofst, _field1, _value1,         \
 319                 _field2, _value2)                                       \
 320         EFX_POPULATE_DWORD_2(*MCDI_IN2(_emr, efx_dword_t, _ofst),       \
 321                 MC_CMD_ ## _field1, _value1,                            \
 322                 MC_CMD_ ## _field2, _value2)
 323
 324 #define MCDI_IN_POPULATE_DWORD_3(_emr, _ofst, _field1, _value1,         \
 325                 _field2, _value2, _field3, _value3)                     \
 326         EFX_POPULATE_DWORD_3(*MCDI_IN2(_emr, efx_dword_t, _ofst),       \
 327                 MC_CMD_ ## _field1, _value1,                            \
 328                 MC_CMD_ ## _field2, _value2,                            \
 329                 MC_CMD_ ## _field3, _value3)
 330
 331 #define MCDI_IN_POPULATE_DWORD_4(_emr, _ofst, _field1, _value1,         \
 332                 _field2, _value2, _field3, _value3, _field4, _value4)   \
 333         EFX_POPULATE_DWORD_4(*MCDI_IN2(_emr, efx_dword_t, _ofst),       \
 334                 MC_CMD_ ## _field1, _value1,                            \
 335                 MC_CMD_ ## _field2, _value2,                            \
 336                 MC_CMD_ ## _field3, _value3,                            \
 337                 MC_CMD_ ## _field4, _value4)
 338
 339 #define MCDI_IN_POPULATE_DWORD_5(_emr, _ofst, _field1, _value1,         \
 340                 _field2, _value2, _field3, _value3, _field4, _value4,   \
 341                 _field5, _value5)                                       \
 342         EFX_POPULATE_DWORD_5(*MCDI_IN2(_emr, efx_dword_t, _ofst),       \
 343                 MC_CMD_ ## _field1, _value1,                            \
 344                 MC_CMD_ ## _field2, _value2,                            \
 345                 MC_CMD_ ## _field3, _value3,                            \
 346                 MC_CMD_ ## _field4, _value4,                            \
 347                 MC_CMD_ ## _field5, _value5)
 348
 349 #define MCDI_IN_POPULATE_DWORD_6(_emr, _ofst, _field1, _value1,         \
 350                 _field2, _value2, _field3, _value3, _field4, _value4,   \
 351                 _field5, _value5, _field6, _value6)                     \
 352         EFX_POPULATE_DWORD_6(*MCDI_IN2(_emr, efx_dword_t, _ofst),       \
 353                 MC_CMD_ ## _field1, _value1,                            \
 354                 MC_CMD_ ## _field2, _value2,                            \
 355                 MC_CMD_ ## _field3, _value3,                            \
 356                 MC_CMD_ ## _field4, _value4,                            \
 357                 MC_CMD_ ## _field5, _value5,                            \
 358                 MC_CMD_ ## _field6, _value6)
 359
 360 #define MCDI_IN_POPULATE_DWORD_7(_emr, _ofst, _field1, _value1,         \
 361                 _field2, _value2, _field3, _value3, _field4, _value4,   \
 362                 _field5, _value5, _field6, _value6, _field7, _value7)   \
 363         EFX_POPULATE_DWORD_7(*MCDI_IN2(_emr, efx_dword_t, _ofst),       \
 364                 MC_CMD_ ## _field1, _value1,                            \
 365                 MC_CMD_ ## _field2, _value2,                            \
 366                 MC_CMD_ ## _field3, _value3,                            \
 367                 MC_CMD_ ## _field4, _value4,                            \
 368                 MC_CMD_ ## _field5, _value5,                            \
 369                 MC_CMD_ ## _field6, _value6,                            \
 370                 MC_CMD_ ## _field7, _value7)
 371
 372 #define MCDI_IN_POPULATE_DWORD_8(_emr, _ofst, _field1, _value1,         \
 373                 _field2, _value2, _field3, _value3, _field4, _value4,   \
 374                 _field5, _value5, _field6, _value6, _field7, _value7,   \
 375                 _field8, _value8)                                       \
 376         EFX_POPULATE_DWORD_8(*MCDI_IN2(_emr, efx_dword_t, _ofst),       \
 377                 MC_CMD_ ## _field1, _value1,                            \
 378                 MC_CMD_ ## _field2, _value2,                            \
 379                 MC_CMD_ ## _field3, _value3,                            \
 380                 MC_CMD_ ## _field4, _value4,                            \
 381                 MC_CMD_ ## _field5, _value5,                            \
 382                 MC_CMD_ ## _field6, _value6,                            \
 383                 MC_CMD_ ## _field7, _value7,                            \
 384                 MC_CMD_ ## _field8, _value8)
 385
 386 #define MCDI_IN_POPULATE_DWORD_9(_emr, _ofst, _field1, _value1,         \
 387                 _field2, _value2, _field3, _value3, _field4, _value4,   \
 388                 _field5, _value5, _field6, _value6, _field7, _value7,   \
 389                 _field8, _value8, _field9, _value9)                     \
 390         EFX_POPULATE_DWORD_9(*MCDI_IN2(_emr, efx_dword_t, _ofst),       \
 391                 MC_CMD_ ## _field1, _value1,                            \
 392                 MC_CMD_ ## _field2, _value2,                            \
 393                 MC_CMD_ ## _field3, _value3,                            \
 394                 MC_CMD_ ## _field4, _value4,                            \
 395                 MC_CMD_ ## _field5, _value5,                            \
 396                 MC_CMD_ ## _field6, _value6,                            \
 397                 MC_CMD_ ## _field7, _value7,                            \
 398                 MC_CMD_ ## _field8, _value8,                            \
 399                 MC_CMD_ ## _field9, _value9)
 400
 401 #define MCDI_IN_POPULATE_DWORD_10(_emr, _ofst, _field1, _value1,        \
 402                 _field2, _value2, _field3, _value3, _field4, _value4,   \
 403                 _field5, _value5, _field6, _value6, _field7, _value7,   \
 404                 _field8, _value8, _field9, _value9, _field10, _value10) \
 405         EFX_POPULATE_DWORD_10(*MCDI_IN2(_emr, efx_dword_t, _ofst),      \
 406                 MC_CMD_ ## _field1, _value1,                            \
 407                 MC_CMD_ ## _field2, _value2,                            \
 408                 MC_CMD_ ## _field3, _value3,                            \
 409                 MC_CMD_ ## _field4, _value4,                            \
 410                 MC_CMD_ ## _field5, _value5,                            \
 411                 MC_CMD_ ## _field6, _value6,                            \
 412                 MC_CMD_ ## _field7, _value7,                            \
 413                 MC_CMD_ ## _field8, _value8,                            \
 414                 MC_CMD_ ## _field9, _value9,                            \
 415                 MC_CMD_ ## _field10, _value10)
 416
 417 /*
 418  * Native setters (MCDI_IN_SET_*_NATIVE) are used when MCDI field is in
 419  * network order to avoid conversion to little-endian that is done in
 420  * other setters.
 421  */
 422 #define MCDI_IN_SET_WORD_NATIVE(_emr, _ofst, _value)                    \
 423         MCDI_IN2((_emr), efx_word_t, _ofst)->ew_u16[0] = (_value)
 424
 425 #define MCDI_IN_SET_DWORD_NATIVE(_emr, _ofst, _value)                   \
 426         MCDI_IN2((_emr), efx_dword_t, _ofst)->ed_u32[0] = (_value)
 427
 428 #define MCDI_OUT(_emr, _type, _ofst)                                    \
 429         ((_type *)((_emr).emr_out_buf + (_ofst)))
 430
 431 #define MCDI_OUT2(_emr, _type, _ofst)                                   \
 432         MCDI_OUT(_emr, _type, MC_CMD_ ## _ofst ## _OFST)
 433
 434 #define MCDI_OUT_BYTE(_emr, _ofst)                                      \
 435         EFX_BYTE_FIELD(*MCDI_OUT2(_emr, efx_byte_t, _ofst),             \
 436                     EFX_BYTE_0)
 437
 438 #define MCDI_OUT_WORD(_emr, _ofst)                                      \
 439         EFX_WORD_FIELD(*MCDI_OUT2(_emr, efx_word_t, _ofst),             \
 440                     EFX_WORD_0)
 441
 442 #define MCDI_OUT_WORD_FIELD(_emr, _ofst, _field)                        \
 443         EFX_WORD_FIELD(*MCDI_OUT2(_emr, efx_word_t, _ofst),             \
 444                        MC_CMD_ ## _field)
 445
 446 #define MCDI_OUT_DWORD(_emr, _ofst)                                     \
 447         EFX_DWORD_FIELD(*MCDI_OUT2(_emr, efx_dword_t, _ofst),           \
 448                         EFX_DWORD_0)
 449
 450 #define MCDI_OUT_DWORD_FIELD(_emr, _ofst, _field)                       \
 451         EFX_DWORD_FIELD(*MCDI_OUT2(_emr, efx_dword_t, _ofst),           \
 452                         MC_CMD_ ## _field)
 453
 454 #define MCDI_OUT_INDEXED_DWORD_FIELD(_emr, _ofst, _idx, _field)         \
 455         EFX_DWORD_FIELD(*(MCDI_OUT2(_emr, efx_dword_t, _ofst) +         \
 456                         (_idx)), _field)
 457
 458 #define MCDI_EV_FIELD(_eqp, _field)                                     \
 459         EFX_QWORD_FIELD(*_eqp, MCDI_EVENT_ ## _field)
 460
 461 #define MCDI_CMD_DWORD_FIELD(_edp, _field)                              \
 462         EFX_DWORD_FIELD(*_edp, MC_CMD_ ## _field)
 463
 464 #define EFX_MCDI_HAVE_PRIVILEGE(mask, priv)                             \
 465         (((mask) & (MC_CMD_PRIVILEGE_MASK_IN_GRP_ ## priv)) ==          \
 466         (MC_CMD_PRIVILEGE_MASK_IN_GRP_ ## priv))
 467
 468 #define EFX_MCDI_BUF_SIZE(_in_len, _out_len)                            \
 469         EFX_P2ROUNDUP(size_t,                                           \
 470                 MAX(MAX(_in_len, _out_len), (2 * sizeof (efx_dword_t))),\
 471                 sizeof (efx_dword_t))
 472
 473 /*
 474  * The buffer size must be a multiple of dword to ensure that MCDI works
 475  * properly with Siena based boards (which use on-chip buffer). Also, it
 476  * should be at minimum the size of two dwords to allow space for extended
 477  * error responses if the request/response buffer sizes are smaller.
 478  */
 479 #define EFX_MCDI_DECLARE_BUF(_name, _in_len, _out_len)                  \
 480         uint8_t _name[EFX_MCDI_BUF_SIZE(_in_len, _out_len)] = {0}
 481
 482 typedef enum efx_mcdi_feature_id_e {
 483         EFX_MCDI_FEATURE_FW_UPDATE = 0,
 484         EFX_MCDI_FEATURE_LINK_CONTROL,
 485         EFX_MCDI_FEATURE_MACADDR_CHANGE,
 486         EFX_MCDI_FEATURE_MAC_SPOOFING,
 487         EFX_MCDI_FEATURE_NIDS
 488 } efx_mcdi_feature_id_t;
 489
 490 #ifdef  __cplusplus
 491 }
 492 #endif
 493
 494 #endif  /* _SYS_EFX_MCDI_H */