drivers/net/sfc/base/efx_mcdi.h

   1 /*
   2  * Copyright (c) 2009-2016 Solarflare Communications Inc.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are met:
   7  *
   8  * 1. Redistributions of source code must retain the above copyright notice,
   9  *    this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright notice,
  11  *    this list of conditions and the following disclaimer in the documentation
  12  *    and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  15  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  16  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  21  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  22  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  23  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  24  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  *
  26  * The views and conclusions contained in the software and documentation are
  27  * those of the authors and should not be interpreted as representing official
  28  * policies, either expressed or implied, of the FreeBSD Project.
  29  */
  30
  31 #ifndef _SYS_EFX_MCDI_H
  32 #define _SYS_EFX_MCDI_H
  33
  34 #include "efx.h"
  35 #include "efx_regs_mcdi.h"
  36
  37 #ifdef  __cplusplus
  38 extern "C" {
  39 #endif
  40
  41 /*
  42  * A reboot/assertion causes the MCDI status word to be set after the
  43  * command word is set or a REBOOT event is sent. If we notice a reboot
  44  * via these mechanisms then wait 10ms for the status word to be set.
  45  */
  46 #define EFX_MCDI_STATUS_SLEEP_US        10000
  47
  48 struct efx_mcdi_req_s {
  49         boolean_t       emr_quiet;
  50         /* Inputs: Command #, input buffer and length */
  51         unsigned int    emr_cmd;
  52         uint8_t         *emr_in_buf;
  53         size_t          emr_in_length;
  54         /* Outputs: retcode, buffer, length, and length used */
  55         efx_rc_t        emr_rc;
  56         uint8_t         *emr_out_buf;
  57         size_t          emr_out_length;
  58         size_t          emr_out_length_used;
  59         /* Internals: low level transport details */
  60         unsigned int    emr_err_code;
  61         unsigned int    emr_err_arg;
  62 #if EFSYS_OPT_MCDI_PROXY_AUTH
  63         uint32_t        emr_proxy_handle;
  64 #endif
  65 };
  66
  67 typedef struct efx_mcdi_iface_s {
  68         unsigned int            emi_port;
  69         unsigned int            emi_max_version;
  70         unsigned int            emi_seq;
  71         efx_mcdi_req_t          *emi_pending_req;
  72         boolean_t               emi_ev_cpl;
  73         boolean_t               emi_new_epoch;
  74         int                     emi_aborted;
  75         uint32_t                emi_poll_cnt;
  76         uint32_t                emi_mc_reboot_status;
  77 } efx_mcdi_iface_t;
  78
  79 extern                  void
  80 efx_mcdi_execute(
  81         __in            efx_nic_t *enp,
  82         __inout         efx_mcdi_req_t *emrp);
  83
  84 extern                  void
  85 efx_mcdi_execute_quiet(
  86         __in            efx_nic_t *enp,
  87         __inout         efx_mcdi_req_t *emrp);
  88
  89 extern                  void
  90 efx_mcdi_ev_cpl(
  91         __in            efx_nic_t *enp,
  92         __in            unsigned int seq,
  93         __in            unsigned int outlen,
  94         __in            int errcode);
  95
  96 #if EFSYS_OPT_MCDI_PROXY_AUTH
  97 extern  __checkReturn   efx_rc_t
  98 efx_mcdi_get_proxy_handle(
  99         __in            efx_nic_t *enp,
 100         __in            efx_mcdi_req_t *emrp,
 101         __out           uint32_t *handlep);
 102
 103 extern                  void
 104 efx_mcdi_ev_proxy_response(
 105         __in            efx_nic_t *enp,
 106         __in            unsigned int handle,
 107         __in            unsigned int status);
 108 #endif
 109
 110 extern                  void
 111 efx_mcdi_ev_death(
 112         __in            efx_nic_t *enp,
 113         __in            int rc);
 114
 115 extern  __checkReturn   efx_rc_t
 116 efx_mcdi_request_errcode(
 117         __in            unsigned int err);
 118
 119 extern                  void
 120 efx_mcdi_raise_exception(
 121         __in            efx_nic_t *enp,
 122         __in_opt        efx_mcdi_req_t *emrp,
 123         __in            int rc);
 124
 125 typedef enum efx_mcdi_boot_e {
 126         EFX_MCDI_BOOT_PRIMARY,
 127         EFX_MCDI_BOOT_SECONDARY,
 128         EFX_MCDI_BOOT_ROM,
 129 } efx_mcdi_boot_t;
 130
 131 extern  __checkReturn           efx_rc_t
 132 efx_mcdi_version(
 133         __in                    efx_nic_t *enp,
 134         __out_ecount_opt(4)     uint16_t versionp[4],
 135         __out_opt               uint32_t *buildp,
 136         __out_opt               efx_mcdi_boot_t *statusp);
 137
 138 extern  __checkReturn   efx_rc_t
 139 efx_mcdi_get_capabilities(
 140         __in            efx_nic_t *enp,
 141         __out_opt       uint32_t *flagsp,
 142         __out_opt       uint16_t *rx_dpcpu_fw_idp,
 143         __out_opt       uint16_t *tx_dpcpu_fw_idp,
 144         __out_opt       uint32_t *flags2p,
 145         __out_opt       uint32_t *tso2ncp);
 146
 147 extern  __checkReturn           efx_rc_t
 148 efx_mcdi_read_assertion(
 149         __in                    efx_nic_t *enp);
 150
 151 extern  __checkReturn           efx_rc_t
 152 efx_mcdi_exit_assertion_handler(
 153         __in                    efx_nic_t *enp);
 154
 155 extern  __checkReturn           efx_rc_t
 156 efx_mcdi_drv_attach(
 157         __in                    efx_nic_t *enp,
 158         __in                    boolean_t attach);
 159
 160 extern  __checkReturn           efx_rc_t
 161 efx_mcdi_get_board_cfg(
 162         __in                    efx_nic_t *enp,
 163         __out_opt               uint32_t *board_typep,
 164         __out_opt               efx_dword_t *capabilitiesp,
 165         __out_ecount_opt(6)     uint8_t mac_addrp[6]);
 166
 167 extern  __checkReturn           efx_rc_t
 168 efx_mcdi_get_phy_cfg(
 169         __in                    efx_nic_t *enp);
 170
 171 extern  __checkReturn           efx_rc_t
 172 efx_mcdi_firmware_update_supported(
 173         __in                    efx_nic_t *enp,
 174         __out                   boolean_t *supportedp);
 175
 176 extern  __checkReturn           efx_rc_t
 177 efx_mcdi_macaddr_change_supported(
 178         __in                    efx_nic_t *enp,
 179         __out                   boolean_t *supportedp);
 180
 181 extern  __checkReturn           efx_rc_t
 182 efx_mcdi_link_control_supported(
 183         __in                    efx_nic_t *enp,
 184         __out                   boolean_t *supportedp);
 185
 186 extern  __checkReturn           efx_rc_t
 187 efx_mcdi_mac_spoofing_supported(
 188         __in                    efx_nic_t *enp,
 189         __out                   boolean_t *supportedp);
 190
 191
 192 #if EFSYS_OPT_BIST
 193 #if EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD
 194 extern  __checkReturn           efx_rc_t
 195 efx_mcdi_bist_enable_offline(
 196         __in                    efx_nic_t *enp);
 197 #endif /* EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD */
 198 extern  __checkReturn           efx_rc_t
 199 efx_mcdi_bist_start(
 200         __in                    efx_nic_t *enp,
 201         __in                    efx_bist_type_t type);
 202 #endif /* EFSYS_OPT_BIST */
 203
 204 extern  __checkReturn           efx_rc_t
 205 efx_mcdi_get_resource_limits(
 206         __in                    efx_nic_t *enp,
 207         __out_opt               uint32_t *nevqp,
 208         __out_opt               uint32_t *nrxqp,
 209         __out_opt               uint32_t *ntxqp);
 210
 211 extern  __checkReturn   efx_rc_t
 212 efx_mcdi_log_ctrl(
 213         __in            efx_nic_t *enp);
 214
 215 extern  __checkReturn   efx_rc_t
 216 efx_mcdi_mac_stats_clear(
 217         __in            efx_nic_t *enp);
 218
 219 extern  __checkReturn   efx_rc_t
 220 efx_mcdi_mac_stats_upload(
 221         __in            efx_nic_t *enp,
 222         __in            efsys_mem_t *esmp);
 223
 224 extern  __checkReturn   efx_rc_t
 225 efx_mcdi_mac_stats_periodic(
 226         __in            efx_nic_t *enp,
 227         __in            efsys_mem_t *esmp,
 228         __in            uint16_t period_ms,
 229         __in            boolean_t events);
 230
 231
 232 #if EFSYS_OPT_LOOPBACK
 233 extern  __checkReturn   efx_rc_t
 234 efx_mcdi_get_loopback_modes(
 235         __in            efx_nic_t *enp);
 236 #endif /* EFSYS_OPT_LOOPBACK */
 237
 238 extern  __checkReturn   efx_rc_t
 239 efx_mcdi_phy_module_get_info(
 240         __in                    efx_nic_t *enp,
 241         __in                    uint8_t dev_addr,
 242         __in                    uint8_t offset,
 243         __in                    uint8_t len,
 244         __out_bcount(len)       uint8_t *data);
 245
 246 #define MCDI_IN(_emr, _type, _ofst)                                     \
 247         ((_type *)((_emr).emr_in_buf + (_ofst)))
 248
 249 #define MCDI_IN2(_emr, _type, _ofst)                                    \
 250         MCDI_IN(_emr, _type, MC_CMD_ ## _ofst ## _OFST)
 251
 252 #define MCDI_IN_SET_BYTE(_emr, _ofst, _value)                           \
 253         EFX_POPULATE_BYTE_1(*MCDI_IN2(_emr, efx_byte_t, _ofst),         \
 254                 EFX_BYTE_0, _value)
 255
 256 #define MCDI_IN_SET_WORD(_emr, _ofst, _value)                           \
 257         EFX_POPULATE_WORD_1(*MCDI_IN2(_emr, efx_word_t, _ofst),         \
 258                 EFX_WORD_0, _value)
 259
 260 #define MCDI_IN_SET_DWORD(_emr, _ofst, _value)                          \
 261         EFX_POPULATE_DWORD_1(*MCDI_IN2(_emr, efx_dword_t, _ofst),       \
 262                 EFX_DWORD_0, _value)
 263
 264 #define MCDI_IN_SET_DWORD_FIELD(_emr, _ofst, _field, _value)            \
 265         EFX_SET_DWORD_FIELD(*MCDI_IN2(_emr, efx_dword_t, _ofst),        \
 266                 MC_CMD_ ## _field, _value)
 267
 268 #define MCDI_IN_POPULATE_DWORD_1(_emr, _ofst, _field1, _value1)         \
 269         EFX_POPULATE_DWORD_1(*MCDI_IN2(_emr, efx_dword_t, _ofst),       \
 270                 MC_CMD_ ## _field1, _value1)
 271
 272 #define MCDI_IN_POPULATE_DWORD_2(_emr, _ofst, _field1, _value1,         \
 273                 _field2, _value2)                                       \
 274         EFX_POPULATE_DWORD_2(*MCDI_IN2(_emr, efx_dword_t, _ofst),       \
 275                 MC_CMD_ ## _field1, _value1,                            \
 276                 MC_CMD_ ## _field2, _value2)
 277
 278 #define MCDI_IN_POPULATE_DWORD_3(_emr, _ofst, _field1, _value1,         \
 279                 _field2, _value2, _field3, _value3)                     \
 280         EFX_POPULATE_DWORD_3(*MCDI_IN2(_emr, efx_dword_t, _ofst),       \
 281                 MC_CMD_ ## _field1, _value1,                            \
 282                 MC_CMD_ ## _field2, _value2,                            \
 283                 MC_CMD_ ## _field3, _value3)
 284
 285 #define MCDI_IN_POPULATE_DWORD_4(_emr, _ofst, _field1, _value1,         \
 286                 _field2, _value2, _field3, _value3, _field4, _value4)   \
 287         EFX_POPULATE_DWORD_4(*MCDI_IN2(_emr, efx_dword_t, _ofst),       \
 288                 MC_CMD_ ## _field1, _value1,                            \
 289                 MC_CMD_ ## _field2, _value2,                            \
 290                 MC_CMD_ ## _field3, _value3,                            \
 291                 MC_CMD_ ## _field4, _value4)
 292
 293 #define MCDI_IN_POPULATE_DWORD_5(_emr, _ofst, _field1, _value1,         \
 294                 _field2, _value2, _field3, _value3, _field4, _value4,   \
 295                 _field5, _value5)                                       \
 296         EFX_POPULATE_DWORD_5(*MCDI_IN2(_emr, efx_dword_t, _ofst),       \
 297                 MC_CMD_ ## _field1, _value1,                            \
 298                 MC_CMD_ ## _field2, _value2,                            \
 299                 MC_CMD_ ## _field3, _value3,                            \
 300                 MC_CMD_ ## _field4, _value4,                            \
 301                 MC_CMD_ ## _field5, _value5)
 302
 303 #define MCDI_IN_POPULATE_DWORD_6(_emr, _ofst, _field1, _value1,         \
 304                 _field2, _value2, _field3, _value3, _field4, _value4,   \
 305                 _field5, _value5, _field6, _value6)                     \
 306         EFX_POPULATE_DWORD_6(*MCDI_IN2(_emr, efx_dword_t, _ofst),       \
 307                 MC_CMD_ ## _field1, _value1,                            \
 308                 MC_CMD_ ## _field2, _value2,                            \
 309                 MC_CMD_ ## _field3, _value3,                            \
 310                 MC_CMD_ ## _field4, _value4,                            \
 311                 MC_CMD_ ## _field5, _value5,                            \
 312                 MC_CMD_ ## _field6, _value6)
 313
 314 #define MCDI_IN_POPULATE_DWORD_7(_emr, _ofst, _field1, _value1,         \
 315                 _field2, _value2, _field3, _value3, _field4, _value4,   \
 316                 _field5, _value5, _field6, _value6, _field7, _value7)   \
 317         EFX_POPULATE_DWORD_7(*MCDI_IN2(_emr, efx_dword_t, _ofst),       \
 318                 MC_CMD_ ## _field1, _value1,                            \
 319                 MC_CMD_ ## _field2, _value2,                            \
 320                 MC_CMD_ ## _field3, _value3,                            \
 321                 MC_CMD_ ## _field4, _value4,                            \
 322                 MC_CMD_ ## _field5, _value5,                            \
 323                 MC_CMD_ ## _field6, _value6,                            \
 324                 MC_CMD_ ## _field7, _value7)
 325
 326 #define MCDI_IN_POPULATE_DWORD_8(_emr, _ofst, _field1, _value1,         \
 327                 _field2, _value2, _field3, _value3, _field4, _value4,   \
 328                 _field5, _value5, _field6, _value6, _field7, _value7,   \
 329                 _field8, _value8)                                       \
 330         EFX_POPULATE_DWORD_8(*MCDI_IN2(_emr, efx_dword_t, _ofst),       \
 331                 MC_CMD_ ## _field1, _value1,                            \
 332                 MC_CMD_ ## _field2, _value2,                            \
 333                 MC_CMD_ ## _field3, _value3,                            \
 334                 MC_CMD_ ## _field4, _value4,                            \
 335                 MC_CMD_ ## _field5, _value5,                            \
 336                 MC_CMD_ ## _field6, _value6,                            \
 337                 MC_CMD_ ## _field7, _value7,                            \
 338                 MC_CMD_ ## _field8, _value8)
 339
 340 #define MCDI_IN_POPULATE_DWORD_9(_emr, _ofst, _field1, _value1,         \
 341                 _field2, _value2, _field3, _value3, _field4, _value4,   \
 342                 _field5, _value5, _field6, _value6, _field7, _value7,   \
 343                 _field8, _value8, _field9, _value9)                     \
 344         EFX_POPULATE_DWORD_9(*MCDI_IN2(_emr, efx_dword_t, _ofst),       \
 345                 MC_CMD_ ## _field1, _value1,                            \
 346                 MC_CMD_ ## _field2, _value2,                            \
 347                 MC_CMD_ ## _field3, _value3,                            \
 348                 MC_CMD_ ## _field4, _value4,                            \
 349                 MC_CMD_ ## _field5, _value5,                            \
 350                 MC_CMD_ ## _field6, _value6,                            \
 351                 MC_CMD_ ## _field7, _value7,                            \
 352                 MC_CMD_ ## _field8, _value8,                            \
 353                 MC_CMD_ ## _field9, _value9)
 354
 355 #define MCDI_IN_POPULATE_DWORD_10(_emr, _ofst, _field1, _value1,        \
 356                 _field2, _value2, _field3, _value3, _field4, _value4,   \
 357                 _field5, _value5, _field6, _value6, _field7, _value7,   \
 358                 _field8, _value8, _field9, _value9, _field10, _value10) \
 359         EFX_POPULATE_DWORD_10(*MCDI_IN2(_emr, efx_dword_t, _ofst),      \
 360                 MC_CMD_ ## _field1, _value1,                            \
 361                 MC_CMD_ ## _field2, _value2,                            \
 362                 MC_CMD_ ## _field3, _value3,                            \
 363                 MC_CMD_ ## _field4, _value4,                            \
 364                 MC_CMD_ ## _field5, _value5,                            \
 365                 MC_CMD_ ## _field6, _value6,                            \
 366                 MC_CMD_ ## _field7, _value7,                            \
 367                 MC_CMD_ ## _field8, _value8,                            \
 368                 MC_CMD_ ## _field9, _value9,                            \
 369                 MC_CMD_ ## _field10, _value10)
 370
 371 #define MCDI_OUT(_emr, _type, _ofst)                                    \
 372         ((_type *)((_emr).emr_out_buf + (_ofst)))
 373
 374 #define MCDI_OUT2(_emr, _type, _ofst)                                   \
 375         MCDI_OUT(_emr, _type, MC_CMD_ ## _ofst ## _OFST)
 376
 377 #define MCDI_OUT_BYTE(_emr, _ofst)                                      \
 378         EFX_BYTE_FIELD(*MCDI_OUT2(_emr, efx_byte_t, _ofst),             \
 379                     EFX_BYTE_0)
 380
 381 #define MCDI_OUT_WORD(_emr, _ofst)                                      \
 382         EFX_WORD_FIELD(*MCDI_OUT2(_emr, efx_word_t, _ofst),             \
 383                     EFX_WORD_0)
 384
 385 #define MCDI_OUT_WORD_FIELD(_emr, _ofst, _field)                        \
 386         EFX_WORD_FIELD(*MCDI_OUT2(_emr, efx_word_t, _ofst),             \
 387                        MC_CMD_ ## _field)
 388
 389 #define MCDI_OUT_DWORD(_emr, _ofst)                                     \
 390         EFX_DWORD_FIELD(*MCDI_OUT2(_emr, efx_dword_t, _ofst),           \
 391                         EFX_DWORD_0)
 392
 393 #define MCDI_OUT_DWORD_FIELD(_emr, _ofst, _field)                       \
 394         EFX_DWORD_FIELD(*MCDI_OUT2(_emr, efx_dword_t, _ofst),           \
 395                         MC_CMD_ ## _field)
 396
 397 #define MCDI_EV_FIELD(_eqp, _field)                                     \
 398         EFX_QWORD_FIELD(*_eqp, MCDI_EVENT_ ## _field)
 399
 400 #define MCDI_CMD_DWORD_FIELD(_edp, _field)                              \
 401         EFX_DWORD_FIELD(*_edp, MC_CMD_ ## _field)
 402
 403 #define EFX_MCDI_HAVE_PRIVILEGE(mask, priv)                             \
 404         (((mask) & (MC_CMD_PRIVILEGE_MASK_IN_GRP_ ## priv)) ==          \
 405         (MC_CMD_PRIVILEGE_MASK_IN_GRP_ ## priv))
 406
 407 typedef enum efx_mcdi_feature_id_e {
 408         EFX_MCDI_FEATURE_FW_UPDATE = 0,
 409         EFX_MCDI_FEATURE_LINK_CONTROL,
 410         EFX_MCDI_FEATURE_MACADDR_CHANGE,
 411         EFX_MCDI_FEATURE_MAC_SPOOFING,
 412         EFX_MCDI_FEATURE_NIDS
 413 } efx_mcdi_feature_id_t;
 414
 415 #ifdef  __cplusplus
 416 }
 417 #endif
 418
 419 #endif  /* _SYS_EFX_MCDI_H */