sys/dev/sfxge/common/efx_mcdi.h

   1 /*-
   2  * Copyright (c) 2009-2015 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  * $FreeBSD$
  31  */
  32
  33 #ifndef _SYS_EFX_MCDI_H
  34 #define _SYS_EFX_MCDI_H
  35
  36 #include "efx.h"
  37 #include "efx_regs.h"
  38 #include "efx_regs_mcdi.h"
  39
  40 #ifdef  __cplusplus
  41 extern "C" {
  42 #endif
  43
  44 /*
  45  * A reboot/assertion causes the MCDI status word to be set after the
  46  * command word is set or a REBOOT event is sent. If we notice a reboot
  47  * via these mechanisms then wait 10ms for the status word to be set.
  48  */
  49 #define EFX_MCDI_STATUS_SLEEP_US        10000
  50
  51 struct efx_mcdi_req_s {
  52         boolean_t       emr_quiet;
  53         /* Inputs: Command #, input buffer and length */
  54         unsigned int    emr_cmd;
  55         uint8_t         *emr_in_buf;
  56         size_t          emr_in_length;
  57         /* Outputs: retcode, buffer, length, and length used*/
  58         int             emr_rc;
  59         uint8_t         *emr_out_buf;
  60         size_t          emr_out_length;
  61         size_t          emr_out_length_used;
  62         /* Internals: low level transport details */
  63         unsigned int    emr_err_code;
  64         unsigned int    emr_err_arg;
  65 #if EFSYS_OPT_MCDI_PROXY_AUTH
  66         uint32_t        emr_proxy_handle;
  67 #endif
  68 };
  69
  70 typedef struct efx_mcdi_iface_s {
  71         unsigned int            emi_port;
  72         unsigned int            emi_max_version;
  73         unsigned int            emi_seq;
  74         efx_mcdi_req_t          *emi_pending_req;
  75         boolean_t               emi_ev_cpl;
  76         boolean_t               emi_new_epoch;
  77         int                     emi_aborted;
  78         uint32_t                emi_poll_cnt;
  79         uint32_t                emi_mc_reboot_status;
  80 } efx_mcdi_iface_t;
  81
  82 extern                  void
  83 efx_mcdi_execute(
  84         __in            efx_nic_t *enp,
  85         __inout         efx_mcdi_req_t *emrp);
  86
  87 extern                  void
  88 efx_mcdi_execute_quiet(
  89         __in            efx_nic_t *enp,
  90         __inout         efx_mcdi_req_t *emrp);
  91
  92  extern                 void
  93 efx_mcdi_read_response_header(
  94         __in            efx_nic_t *enp,
  95         __inout         efx_mcdi_req_t *emrp);
  96
  97 extern                  void
  98 efx_mcdi_ev_cpl(
  99         __in            efx_nic_t *enp,
 100         __in            unsigned int seq,
 101         __in            unsigned int outlen,
 102         __in            int errcode);
 103
 104 #if EFSYS_OPT_MCDI_PROXY_AUTH
 105 extern  __checkReturn   efx_rc_t
 106 efx_mcdi_get_proxy_handle(
 107         __in            efx_nic_t *enp,
 108         __in            efx_mcdi_req_t *emrp,
 109         __out           uint32_t *handlep);
 110
 111 extern                  void
 112 efx_mcdi_ev_proxy_response(
 113         __in            efx_nic_t *enp,
 114         __in            unsigned int handle,
 115         __in            unsigned int status);
 116 #endif
 117
 118 extern                  void
 119 efx_mcdi_ev_death(
 120         __in            efx_nic_t *enp,
 121         __in            int rc);
 122
 123 extern  __checkReturn   efx_rc_t
 124 efx_mcdi_request_errcode(
 125         __in            unsigned int err);
 126
 127 extern                  void
 128 efx_mcdi_raise_exception(
 129         __in            efx_nic_t *enp,
 130         __in_opt        efx_mcdi_req_t *emrp,
 131         __in            int rc);
 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 extern  __checkReturn           efx_rc_t
 140 efx_mcdi_version(
 141         __in                    efx_nic_t *enp,
 142         __out_ecount_opt(4)     uint16_t versionp[4],
 143         __out_opt               uint32_t *buildp,
 144         __out_opt               efx_mcdi_boot_t *statusp);
 145
 146 extern  __checkReturn           efx_rc_t
 147 efx_mcdi_read_assertion(
 148         __in                    efx_nic_t *enp);
 149
 150 extern  __checkReturn           efx_rc_t
 151 efx_mcdi_exit_assertion_handler(
 152         __in                    efx_nic_t *enp);
 153
 154 extern  __checkReturn           efx_rc_t
 155 efx_mcdi_drv_attach(
 156         __in                    efx_nic_t *enp,
 157         __in                    boolean_t attach);
 158
 159 extern  __checkReturn           efx_rc_t
 160 efx_mcdi_get_board_cfg(
 161         __in                    efx_nic_t *enp,
 162         __out_opt               uint32_t *board_typep,
 163         __out_opt               efx_dword_t *capabilitiesp,
 164         __out_ecount_opt(6)     uint8_t mac_addrp[6]);
 165
 166 extern  __checkReturn           efx_rc_t
 167 efx_mcdi_get_phy_cfg(
 168         __in                    efx_nic_t *enp);
 169
 170 extern  __checkReturn           efx_rc_t
 171 efx_mcdi_firmware_update_supported(
 172         __in                    efx_nic_t *enp,
 173         __out                   boolean_t *supportedp);
 174
 175 extern  __checkReturn           efx_rc_t
 176 efx_mcdi_macaddr_change_supported(
 177         __in                    efx_nic_t *enp,
 178         __out                   boolean_t *supportedp);
 179
 180 extern  __checkReturn           efx_rc_t
 181 efx_mcdi_link_control_supported(
 182         __in                    efx_nic_t *enp,
 183         __out                   boolean_t *supportedp);
 184
 185 extern  __checkReturn           efx_rc_t
 186 efx_mcdi_mac_spoofing_supported(
 187         __in                    efx_nic_t *enp,
 188         __out                   boolean_t *supportedp);
 189
 190
 191 #if EFSYS_OPT_BIST
 192 #if EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD
 193 extern  __checkReturn           efx_rc_t
 194 efx_mcdi_bist_enable_offline(
 195         __in                    efx_nic_t *enp);
 196 #endif /* EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD */
 197 extern  __checkReturn           efx_rc_t
 198 efx_mcdi_bist_start(
 199         __in                    efx_nic_t *enp,
 200         __in                    efx_bist_type_t type);
 201 #endif /* EFSYS_OPT_BIST */
 202
 203 extern  __checkReturn           efx_rc_t
 204 efx_mcdi_get_resource_limits(
 205         __in                    efx_nic_t *enp,
 206         __out_opt               uint32_t *nevqp,
 207         __out_opt               uint32_t *nrxqp,
 208         __out_opt               uint32_t *ntxqp);
 209
 210 extern  __checkReturn   efx_rc_t
 211 efx_mcdi_log_ctrl(
 212         __in            efx_nic_t *enp);
 213
 214 extern  __checkReturn   efx_rc_t
 215 efx_mcdi_mac_stats_clear(
 216         __in            efx_nic_t *enp);
 217
 218 extern  __checkReturn   efx_rc_t
 219 efx_mcdi_mac_stats_upload(
 220         __in            efx_nic_t *enp,
 221         __in            efsys_mem_t *esmp);
 222
 223 extern  __checkReturn   efx_rc_t
 224 efx_mcdi_mac_stats_periodic(
 225         __in            efx_nic_t *enp,
 226         __in            efsys_mem_t *esmp,
 227         __in            uint16_t period,
 228         __in            boolean_t events);
 229
 230
 231 #if EFSYS_OPT_LOOPBACK
 232 extern  __checkReturn   efx_rc_t
 233 efx_mcdi_get_loopback_modes(
 234         __in            efx_nic_t *enp);
 235 #endif /* EFSYS_OPT_LOOPBACK */
 236
 237 #define MCDI_IN(_emr, _type, _ofst)                                     \
 238         ((_type *)((_emr).emr_in_buf + (_ofst)))
 239
 240 #define MCDI_IN2(_emr, _type, _ofst)                                    \
 241         MCDI_IN(_emr, _type, MC_CMD_ ## _ofst ## _OFST)
 242
 243 #define MCDI_IN_SET_BYTE(_emr, _ofst, _value)                           \
 244         EFX_POPULATE_BYTE_1(*MCDI_IN2(_emr, efx_byte_t, _ofst),         \
 245                 EFX_BYTE_0, _value)
 246
 247 #define MCDI_IN_SET_WORD(_emr, _ofst, _value)                           \
 248         EFX_POPULATE_WORD_1(*MCDI_IN2(_emr, efx_word_t, _ofst),         \
 249                 EFX_WORD_0, _value)
 250
 251 #define MCDI_IN_SET_DWORD(_emr, _ofst, _value)                          \
 252         EFX_POPULATE_DWORD_1(*MCDI_IN2(_emr, efx_dword_t, _ofst),       \
 253                 EFX_DWORD_0, _value)
 254
 255 #define MCDI_IN_SET_DWORD_FIELD(_emr, _ofst, _field, _value)            \
 256         EFX_SET_DWORD_FIELD(*MCDI_IN2(_emr, efx_dword_t, _ofst),        \
 257                 MC_CMD_ ## _field, _value)
 258
 259 #define MCDI_IN_POPULATE_DWORD_1(_emr, _ofst, _field1, _value1)         \
 260         EFX_POPULATE_DWORD_1(*MCDI_IN2(_emr, efx_dword_t, _ofst),       \
 261                 MC_CMD_ ## _field1, _value1)
 262
 263 #define MCDI_IN_POPULATE_DWORD_2(_emr, _ofst, _field1, _value1,         \
 264                 _field2, _value2)                                       \
 265         EFX_POPULATE_DWORD_2(*MCDI_IN2(_emr, efx_dword_t, _ofst),       \
 266                 MC_CMD_ ## _field1, _value1,                            \
 267                 MC_CMD_ ## _field2, _value2)
 268
 269 #define MCDI_IN_POPULATE_DWORD_3(_emr, _ofst, _field1, _value1,         \
 270                 _field2, _value2, _field3, _value3)                     \
 271         EFX_POPULATE_DWORD_3(*MCDI_IN2(_emr, efx_dword_t, _ofst),       \
 272                 MC_CMD_ ## _field1, _value1,                            \
 273                 MC_CMD_ ## _field2, _value2,                            \
 274                 MC_CMD_ ## _field3, _value3)
 275
 276 #define MCDI_IN_POPULATE_DWORD_4(_emr, _ofst, _field1, _value1,         \
 277                 _field2, _value2, _field3, _value3, _field4, _value4)   \
 278         EFX_POPULATE_DWORD_4(*MCDI_IN2(_emr, efx_dword_t, _ofst),       \
 279                 MC_CMD_ ## _field1, _value1,                            \
 280                 MC_CMD_ ## _field2, _value2,                            \
 281                 MC_CMD_ ## _field3, _value3,                            \
 282                 MC_CMD_ ## _field4, _value4)
 283
 284 #define MCDI_IN_POPULATE_DWORD_5(_emr, _ofst, _field1, _value1,         \
 285                 _field2, _value2, _field3, _value3, _field4, _value4,   \
 286                 _field5, _value5)                                       \
 287         EFX_POPULATE_DWORD_5(*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                 MC_CMD_ ## _field5, _value5)
 293
 294 #define MCDI_IN_POPULATE_DWORD_6(_emr, _ofst, _field1, _value1,         \
 295                 _field2, _value2, _field3, _value3, _field4, _value4,   \
 296                 _field5, _value5, _field6, _value6)                     \
 297         EFX_POPULATE_DWORD_6(*MCDI_IN2(_emr, efx_dword_t, _ofst),       \
 298                 MC_CMD_ ## _field1, _value1,                            \
 299                 MC_CMD_ ## _field2, _value2,                            \
 300                 MC_CMD_ ## _field3, _value3,                            \
 301                 MC_CMD_ ## _field4, _value4,                            \
 302                 MC_CMD_ ## _field5, _value5,                            \
 303                 MC_CMD_ ## _field6, _value6)
 304
 305 #define MCDI_IN_POPULATE_DWORD_7(_emr, _ofst, _field1, _value1,         \
 306                 _field2, _value2, _field3, _value3, _field4, _value4,   \
 307                 _field5, _value5, _field6, _value6, _field7, _value7)   \
 308         EFX_POPULATE_DWORD_7(*MCDI_IN2(_emr, efx_dword_t, _ofst),       \
 309                 MC_CMD_ ## _field1, _value1,                            \
 310                 MC_CMD_ ## _field2, _value2,                            \
 311                 MC_CMD_ ## _field3, _value3,                            \
 312                 MC_CMD_ ## _field4, _value4,                            \
 313                 MC_CMD_ ## _field5, _value5,                            \
 314                 MC_CMD_ ## _field6, _value6,                            \
 315                 MC_CMD_ ## _field7, _value7)
 316
 317 #define MCDI_IN_POPULATE_DWORD_8(_emr, _ofst, _field1, _value1,         \
 318                 _field2, _value2, _field3, _value3, _field4, _value4,   \
 319                 _field5, _value5, _field6, _value6, _field7, _value7,   \
 320                 _field8, _value8)                                       \
 321         EFX_POPULATE_DWORD_8(*MCDI_IN2(_emr, efx_dword_t, _ofst),       \
 322                 MC_CMD_ ## _field1, _value1,                            \
 323                 MC_CMD_ ## _field2, _value2,                            \
 324                 MC_CMD_ ## _field3, _value3,                            \
 325                 MC_CMD_ ## _field4, _value4,                            \
 326                 MC_CMD_ ## _field5, _value5,                            \
 327                 MC_CMD_ ## _field6, _value6,                            \
 328                 MC_CMD_ ## _field7, _value7,                            \
 329                 MC_CMD_ ## _field8, _value8)
 330
 331 #define MCDI_IN_POPULATE_DWORD_9(_emr, _ofst, _field1, _value1,         \
 332                 _field2, _value2, _field3, _value3, _field4, _value4,   \
 333                 _field5, _value5, _field6, _value6, _field7, _value7,   \
 334                 _field8, _value8, _field9, _value9)                     \
 335         EFX_POPULATE_DWORD_9(*MCDI_IN2(_emr, efx_dword_t, _ofst),       \
 336                 MC_CMD_ ## _field1, _value1,                            \
 337                 MC_CMD_ ## _field2, _value2,                            \
 338                 MC_CMD_ ## _field3, _value3,                            \
 339                 MC_CMD_ ## _field4, _value4,                            \
 340                 MC_CMD_ ## _field5, _value5,                            \
 341                 MC_CMD_ ## _field6, _value6,                            \
 342                 MC_CMD_ ## _field7, _value7,                            \
 343                 MC_CMD_ ## _field8, _value8,                            \
 344                 MC_CMD_ ## _field9, _value9)
 345
 346 #define MCDI_IN_POPULATE_DWORD_10(_emr, _ofst, _field1, _value1,        \
 347                 _field2, _value2, _field3, _value3, _field4, _value4,   \
 348                 _field5, _value5, _field6, _value6, _field7, _value7,   \
 349                 _field8, _value8, _field9, _value9, _field10, _value10) \
 350         EFX_POPULATE_DWORD_10(*MCDI_IN2(_emr, efx_dword_t, _ofst),      \
 351                 MC_CMD_ ## _field1, _value1,                            \
 352                 MC_CMD_ ## _field2, _value2,                            \
 353                 MC_CMD_ ## _field3, _value3,                            \
 354                 MC_CMD_ ## _field4, _value4,                            \
 355                 MC_CMD_ ## _field5, _value5,                            \
 356                 MC_CMD_ ## _field6, _value6,                            \
 357                 MC_CMD_ ## _field7, _value7,                            \
 358                 MC_CMD_ ## _field8, _value8,                            \
 359                 MC_CMD_ ## _field9, _value9,                            \
 360                 MC_CMD_ ## _field10, _value10)
 361
 362 #define MCDI_OUT(_emr, _type, _ofst)                                    \
 363         ((_type *)((_emr).emr_out_buf + (_ofst)))
 364
 365 #define MCDI_OUT2(_emr, _type, _ofst)                                   \
 366         MCDI_OUT(_emr, _type, MC_CMD_ ## _ofst ## _OFST)
 367
 368 #define MCDI_OUT_BYTE(_emr, _ofst)                                      \
 369         EFX_BYTE_FIELD(*MCDI_OUT2(_emr, efx_byte_t, _ofst),             \
 370                     EFX_BYTE_0)
 371
 372 #define MCDI_OUT_WORD(_emr, _ofst)                                      \
 373         EFX_WORD_FIELD(*MCDI_OUT2(_emr, efx_word_t, _ofst),             \
 374                     EFX_WORD_0)
 375
 376 #define MCDI_OUT_DWORD(_emr, _ofst)                                     \
 377         EFX_DWORD_FIELD(*MCDI_OUT2(_emr, efx_dword_t, _ofst),           \
 378                         EFX_DWORD_0)
 379
 380 #define MCDI_OUT_DWORD_FIELD(_emr, _ofst, _field)                       \
 381         EFX_DWORD_FIELD(*MCDI_OUT2(_emr, efx_dword_t, _ofst),           \
 382                         MC_CMD_ ## _field)
 383
 384 #define MCDI_EV_FIELD(_eqp, _field)                                     \
 385         EFX_QWORD_FIELD(*_eqp, MCDI_EVENT_ ## _field)
 386
 387 #define MCDI_CMD_DWORD_FIELD(_edp, _field)                              \
 388         EFX_DWORD_FIELD(*_edp, MC_CMD_ ## _field)
 389
 390 #define EFX_MCDI_HAVE_PRIVILEGE(mask, priv)                             \
 391         (((mask) & (MC_CMD_PRIVILEGE_MASK_IN_GRP_ ## priv)) ==          \
 392         (MC_CMD_PRIVILEGE_MASK_IN_GRP_ ## priv))
 393
 394 typedef enum efx_mcdi_feature_id_e {
 395         EFX_MCDI_FEATURE_FW_UPDATE = 0,
 396         EFX_MCDI_FEATURE_LINK_CONTROL,
 397         EFX_MCDI_FEATURE_MACADDR_CHANGE,
 398         EFX_MCDI_FEATURE_MAC_SPOOFING,
 399         EFX_MCDI_FEATURE_NIDS
 400 } efx_mcdi_feature_id_t;
 401
 402 #ifdef  __cplusplus
 403 }
 404 #endif
 405
 406 #endif  /* _SYS_EFX_MCDI_H */