drivers/net/sfc/base/efx_mcdi.c

   1 /*
   2  * Copyright (c) 2008-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 #include "efx.h"
  32 #include "efx_impl.h"
  33
  34 #if EFSYS_OPT_MCDI
  35
  36 /*
  37  * There are three versions of the MCDI interface:
  38  *  - MCDIv0: Siena BootROM. Transport uses MCDIv1 headers.
  39  *  - MCDIv1: Siena firmware and Huntington BootROM.
  40  *  - MCDIv2: EF10 firmware (Huntington/Medford) and Medford BootROM.
  41  *            Transport uses MCDIv2 headers.
  42  *
  43  * MCDIv2 Header NOT_EPOCH flag
  44  * ----------------------------
  45  * A new epoch begins at initial startup or after an MC reboot, and defines when
  46  * the MC should reject stale MCDI requests.
  47  *
  48  * The first MCDI request sent by the host should contain NOT_EPOCH=0, and all
  49  * subsequent requests (until the next MC reboot) should contain NOT_EPOCH=1.
  50  *
  51  * After rebooting the MC will fail all requests with NOT_EPOCH=1 by writing a
  52  * response with ERROR=1 and DATALEN=0 until a request is seen with NOT_EPOCH=0.
  53  */
  54
  55
  56
  57 #if EFSYS_OPT_SIENA
  58
  59 static const efx_mcdi_ops_t     __efx_mcdi_siena_ops = {
  60         siena_mcdi_init,                /* emco_init */
  61         siena_mcdi_send_request,        /* emco_send_request */
  62         siena_mcdi_poll_reboot,         /* emco_poll_reboot */
  63         siena_mcdi_poll_response,       /* emco_poll_response */
  64         siena_mcdi_read_response,       /* emco_read_response */
  65         siena_mcdi_fini,                /* emco_fini */
  66         siena_mcdi_feature_supported,   /* emco_feature_supported */
  67         siena_mcdi_get_timeout,         /* emco_get_timeout */
  68 };
  69
  70 #endif  /* EFSYS_OPT_SIENA */
  71
  72 #if EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD
  73
  74 static const efx_mcdi_ops_t     __efx_mcdi_ef10_ops = {
  75         ef10_mcdi_init,                 /* emco_init */
  76         ef10_mcdi_send_request,         /* emco_send_request */
  77         ef10_mcdi_poll_reboot,          /* emco_poll_reboot */
  78         ef10_mcdi_poll_response,        /* emco_poll_response */
  79         ef10_mcdi_read_response,        /* emco_read_response */
  80         ef10_mcdi_fini,                 /* emco_fini */
  81         ef10_mcdi_feature_supported,    /* emco_feature_supported */
  82         ef10_mcdi_get_timeout,          /* emco_get_timeout */
  83 };
  84
  85 #endif  /* EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD */
  86
  87
  88
  89         __checkReturn   efx_rc_t
  90 efx_mcdi_init(
  91         __in            efx_nic_t *enp,
  92         __in            const efx_mcdi_transport_t *emtp)
  93 {
  94         const efx_mcdi_ops_t *emcop;
  95         efx_rc_t rc;
  96
  97         EFSYS_ASSERT3U(enp->en_magic, ==, EFX_NIC_MAGIC);
  98         EFSYS_ASSERT3U(enp->en_mod_flags, ==, 0);
  99
 100         switch (enp->en_family) {
 101 #if EFSYS_OPT_SIENA
 102         case EFX_FAMILY_SIENA:
 103                 emcop = &__efx_mcdi_siena_ops;
 104                 break;
 105 #endif  /* EFSYS_OPT_SIENA */
 106
 107 #if EFSYS_OPT_HUNTINGTON
 108         case EFX_FAMILY_HUNTINGTON:
 109                 emcop = &__efx_mcdi_ef10_ops;
 110                 break;
 111 #endif  /* EFSYS_OPT_HUNTINGTON */
 112
 113 #if EFSYS_OPT_MEDFORD
 114         case EFX_FAMILY_MEDFORD:
 115                 emcop = &__efx_mcdi_ef10_ops;
 116                 break;
 117 #endif  /* EFSYS_OPT_MEDFORD */
 118
 119         default:
 120                 EFSYS_ASSERT(0);
 121                 rc = ENOTSUP;
 122                 goto fail1;
 123         }
 124
 125         if (enp->en_features & EFX_FEATURE_MCDI_DMA) {
 126                 /* MCDI requires a DMA buffer in host memory */
 127                 if ((emtp == NULL) || (emtp->emt_dma_mem) == NULL) {
 128                         rc = EINVAL;
 129                         goto fail2;
 130                 }
 131         }
 132         enp->en_mcdi.em_emtp = emtp;
 133
 134         if (emcop != NULL && emcop->emco_init != NULL) {
 135                 if ((rc = emcop->emco_init(enp, emtp)) != 0)
 136                         goto fail3;
 137         }
 138
 139         enp->en_mcdi.em_emcop = emcop;
 140         enp->en_mod_flags |= EFX_MOD_MCDI;
 141
 142         return (0);
 143
 144 fail3:
 145         EFSYS_PROBE(fail3);
 146 fail2:
 147         EFSYS_PROBE(fail2);
 148 fail1:
 149         EFSYS_PROBE1(fail1, efx_rc_t, rc);
 150
 151         enp->en_mcdi.em_emcop = NULL;
 152         enp->en_mcdi.em_emtp = NULL;
 153         enp->en_mod_flags &= ~EFX_MOD_MCDI;
 154
 155         return (rc);
 156 }
 157
 158                         void
 159 efx_mcdi_fini(
 160         __in            efx_nic_t *enp)
 161 {
 162         efx_mcdi_iface_t *emip = &(enp->en_mcdi.em_emip);
 163         const efx_mcdi_ops_t *emcop = enp->en_mcdi.em_emcop;
 164
 165         EFSYS_ASSERT3U(enp->en_magic, ==, EFX_NIC_MAGIC);
 166         EFSYS_ASSERT3U(enp->en_mod_flags, ==, EFX_MOD_MCDI);
 167
 168         if (emcop != NULL && emcop->emco_fini != NULL)
 169                 emcop->emco_fini(enp);
 170
 171         emip->emi_port = 0;
 172         emip->emi_aborted = 0;
 173
 174         enp->en_mcdi.em_emcop = NULL;
 175         enp->en_mod_flags &= ~EFX_MOD_MCDI;
 176 }
 177
 178                         void
 179 efx_mcdi_new_epoch(
 180         __in            efx_nic_t *enp)
 181 {
 182         efx_mcdi_iface_t *emip = &(enp->en_mcdi.em_emip);
 183         efsys_lock_state_t state;
 184
 185         /* Start a new epoch (allow fresh MCDI requests to succeed) */
 186         EFSYS_LOCK(enp->en_eslp, state);
 187         emip->emi_new_epoch = B_TRUE;
 188         EFSYS_UNLOCK(enp->en_eslp, state);
 189 }
 190
 191 static                  void
 192 efx_mcdi_send_request(
 193         __in            efx_nic_t *enp,
 194         __in            void *hdrp,
 195         __in            size_t hdr_len,
 196         __in            void *sdup,
 197         __in            size_t sdu_len)
 198 {
 199         const efx_mcdi_ops_t *emcop = enp->en_mcdi.em_emcop;
 200
 201         emcop->emco_send_request(enp, hdrp, hdr_len, sdup, sdu_len);
 202 }
 203
 204 static                  efx_rc_t
 205 efx_mcdi_poll_reboot(
 206         __in            efx_nic_t *enp)
 207 {
 208         const efx_mcdi_ops_t *emcop = enp->en_mcdi.em_emcop;
 209         efx_rc_t rc;
 210
 211         rc = emcop->emco_poll_reboot(enp);
 212         return (rc);
 213 }
 214
 215 static                  boolean_t
 216 efx_mcdi_poll_response(
 217         __in            efx_nic_t *enp)
 218 {
 219         const efx_mcdi_ops_t *emcop = enp->en_mcdi.em_emcop;
 220         boolean_t available;
 221
 222         available = emcop->emco_poll_response(enp);
 223         return (available);
 224 }
 225
 226 static                  void
 227 efx_mcdi_read_response(
 228         __in            efx_nic_t *enp,
 229         __out           void *bufferp,
 230         __in            size_t offset,
 231         __in            size_t length)
 232 {
 233         const efx_mcdi_ops_t *emcop = enp->en_mcdi.em_emcop;
 234
 235         emcop->emco_read_response(enp, bufferp, offset, length);
 236 }
 237
 238                         void
 239 efx_mcdi_request_start(
 240         __in            efx_nic_t *enp,
 241         __in            efx_mcdi_req_t *emrp,
 242         __in            boolean_t ev_cpl)
 243 {
 244 #if EFSYS_OPT_MCDI_LOGGING
 245         const efx_mcdi_transport_t *emtp = enp->en_mcdi.em_emtp;
 246 #endif
 247         efx_mcdi_iface_t *emip = &(enp->en_mcdi.em_emip);
 248         efx_dword_t hdr[2];
 249         size_t hdr_len;
 250         unsigned int max_version;
 251         unsigned int seq;
 252         unsigned int xflags;
 253         boolean_t new_epoch;
 254         efsys_lock_state_t state;
 255
 256         EFSYS_ASSERT3U(enp->en_magic, ==, EFX_NIC_MAGIC);
 257         EFSYS_ASSERT3U(enp->en_mod_flags, &, EFX_MOD_MCDI);
 258         EFSYS_ASSERT3U(enp->en_features, &, EFX_FEATURE_MCDI);
 259
 260         /*
 261          * efx_mcdi_request_start() is naturally serialised against both
 262          * efx_mcdi_request_poll() and efx_mcdi_ev_cpl()/efx_mcdi_ev_death(),
 263          * by virtue of there only being one outstanding MCDI request.
 264          * Unfortunately, upper layers may also call efx_mcdi_request_abort()
 265          * at any time, to timeout a pending mcdi request, That request may
 266          * then subsequently complete, meaning efx_mcdi_ev_cpl() or
 267          * efx_mcdi_ev_death() may end up running in parallel with
 268          * efx_mcdi_request_start(). This race is handled by ensuring that
 269          * %emi_pending_req, %emi_ev_cpl and %emi_seq are protected by the
 270          * en_eslp lock.
 271          */
 272         EFSYS_LOCK(enp->en_eslp, state);
 273         EFSYS_ASSERT(emip->emi_pending_req == NULL);
 274         emip->emi_pending_req = emrp;
 275         emip->emi_ev_cpl = ev_cpl;
 276         emip->emi_poll_cnt = 0;
 277         seq = emip->emi_seq++ & EFX_MASK32(MCDI_HEADER_SEQ);
 278         new_epoch = emip->emi_new_epoch;
 279         max_version = emip->emi_max_version;
 280         EFSYS_UNLOCK(enp->en_eslp, state);
 281
 282         xflags = 0;
 283         if (ev_cpl)
 284                 xflags |= MCDI_HEADER_XFLAGS_EVREQ;
 285
 286         /*
 287          * Huntington firmware supports MCDIv2, but the Huntington BootROM only
 288          * supports MCDIv1. Use MCDIv1 headers for MCDIv1 commands where
 289          * possible to support this.
 290          */
 291         if ((max_version >= 2) &&
 292             ((emrp->emr_cmd > MC_CMD_CMD_SPACE_ESCAPE_7) ||
 293             (emrp->emr_in_length > MCDI_CTL_SDU_LEN_MAX_V1))) {
 294                 /* Construct MCDI v2 header */
 295                 hdr_len = sizeof (hdr);
 296                 EFX_POPULATE_DWORD_8(hdr[0],
 297                     MCDI_HEADER_CODE, MC_CMD_V2_EXTN,
 298                     MCDI_HEADER_RESYNC, 1,
 299                     MCDI_HEADER_DATALEN, 0,
 300                     MCDI_HEADER_SEQ, seq,
 301                     MCDI_HEADER_NOT_EPOCH, new_epoch ? 0 : 1,
 302                     MCDI_HEADER_ERROR, 0,
 303                     MCDI_HEADER_RESPONSE, 0,
 304                     MCDI_HEADER_XFLAGS, xflags);
 305
 306                 EFX_POPULATE_DWORD_2(hdr[1],
 307                     MC_CMD_V2_EXTN_IN_EXTENDED_CMD, emrp->emr_cmd,
 308                     MC_CMD_V2_EXTN_IN_ACTUAL_LEN, emrp->emr_in_length);
 309         } else {
 310                 /* Construct MCDI v1 header */
 311                 hdr_len = sizeof (hdr[0]);
 312                 EFX_POPULATE_DWORD_8(hdr[0],
 313                     MCDI_HEADER_CODE, emrp->emr_cmd,
 314                     MCDI_HEADER_RESYNC, 1,
 315                     MCDI_HEADER_DATALEN, emrp->emr_in_length,
 316                     MCDI_HEADER_SEQ, seq,
 317                     MCDI_HEADER_NOT_EPOCH, new_epoch ? 0 : 1,
 318                     MCDI_HEADER_ERROR, 0,
 319                     MCDI_HEADER_RESPONSE, 0,
 320                     MCDI_HEADER_XFLAGS, xflags);
 321         }
 322
 323 #if EFSYS_OPT_MCDI_LOGGING
 324         if (emtp->emt_logger != NULL) {
 325                 emtp->emt_logger(emtp->emt_context, EFX_LOG_MCDI_REQUEST,
 326                     &hdr[0], hdr_len,
 327                     emrp->emr_in_buf, emrp->emr_in_length);
 328         }
 329 #endif /* EFSYS_OPT_MCDI_LOGGING */
 330
 331         efx_mcdi_send_request(enp, &hdr[0], hdr_len,
 332             emrp->emr_in_buf, emrp->emr_in_length);
 333 }
 334
 335
 336 static                  void
 337 efx_mcdi_read_response_header(
 338         __in            efx_nic_t *enp,
 339         __inout         efx_mcdi_req_t *emrp)
 340 {
 341 #if EFSYS_OPT_MCDI_LOGGING
 342         const efx_mcdi_transport_t *emtp = enp->en_mcdi.em_emtp;
 343 #endif /* EFSYS_OPT_MCDI_LOGGING */
 344         efx_mcdi_iface_t *emip = &(enp->en_mcdi.em_emip);
 345         efx_dword_t hdr[2];
 346         unsigned int hdr_len;
 347         unsigned int data_len;
 348         unsigned int seq;
 349         unsigned int cmd;
 350         unsigned int error;
 351         efx_rc_t rc;
 352
 353         EFSYS_ASSERT(emrp != NULL);
 354
 355         efx_mcdi_read_response(enp, &hdr[0], 0, sizeof (hdr[0]));
 356         hdr_len = sizeof (hdr[0]);
 357
 358         cmd = EFX_DWORD_FIELD(hdr[0], MCDI_HEADER_CODE);
 359         seq = EFX_DWORD_FIELD(hdr[0], MCDI_HEADER_SEQ);
 360         error = EFX_DWORD_FIELD(hdr[0], MCDI_HEADER_ERROR);
 361
 362         if (cmd != MC_CMD_V2_EXTN) {
 363                 data_len = EFX_DWORD_FIELD(hdr[0], MCDI_HEADER_DATALEN);
 364         } else {
 365                 efx_mcdi_read_response(enp, &hdr[1], hdr_len, sizeof (hdr[1]));
 366                 hdr_len += sizeof (hdr[1]);
 367
 368                 cmd = EFX_DWORD_FIELD(hdr[1], MC_CMD_V2_EXTN_IN_EXTENDED_CMD);
 369                 data_len =
 370                     EFX_DWORD_FIELD(hdr[1], MC_CMD_V2_EXTN_IN_ACTUAL_LEN);
 371         }
 372
 373         if (error && (data_len == 0)) {
 374                 /* The MC has rebooted since the request was sent. */
 375                 EFSYS_SPIN(EFX_MCDI_STATUS_SLEEP_US);
 376                 efx_mcdi_poll_reboot(enp);
 377                 rc = EIO;
 378                 goto fail1;
 379         }
 380         if ((cmd != emrp->emr_cmd) ||
 381             (seq != ((emip->emi_seq - 1) & EFX_MASK32(MCDI_HEADER_SEQ)))) {
 382                 /* Response is for a different request */
 383                 rc = EIO;
 384                 goto fail2;
 385         }
 386         if (error) {
 387                 efx_dword_t err[2];
 388                 unsigned int err_len = MIN(data_len, sizeof (err));
 389                 int err_code = MC_CMD_ERR_EPROTO;
 390                 int err_arg = 0;
 391
 392                 /* Read error code (and arg num for MCDI v2 commands) */
 393                 efx_mcdi_read_response(enp, &err, hdr_len, err_len);
 394
 395                 if (err_len >= (MC_CMD_ERR_CODE_OFST + sizeof (efx_dword_t)))
 396                         err_code = EFX_DWORD_FIELD(err[0], EFX_DWORD_0);
 397 #ifdef WITH_MCDI_V2
 398                 if (err_len >= (MC_CMD_ERR_ARG_OFST + sizeof (efx_dword_t)))
 399                         err_arg = EFX_DWORD_FIELD(err[1], EFX_DWORD_0);
 400 #endif
 401                 emrp->emr_err_code = err_code;
 402                 emrp->emr_err_arg = err_arg;
 403
 404 #if EFSYS_OPT_MCDI_PROXY_AUTH
 405                 if ((err_code == MC_CMD_ERR_PROXY_PENDING) &&
 406                     (err_len == sizeof (err))) {
 407                         /*
 408                          * The MCDI request would normally fail with EPERM, but
 409                          * firmware has forwarded it to an authorization agent
 410                          * attached to a privileged PF.
 411                          *
 412                          * Save the authorization request handle. The client
 413                          * must wait for a PROXY_RESPONSE event, or timeout.
 414                          */
 415                         emrp->emr_proxy_handle = err_arg;
 416                 }
 417 #endif /* EFSYS_OPT_MCDI_PROXY_AUTH */
 418
 419 #if EFSYS_OPT_MCDI_LOGGING
 420                 if (emtp->emt_logger != NULL) {
 421                         emtp->emt_logger(emtp->emt_context,
 422                             EFX_LOG_MCDI_RESPONSE,
 423                             &hdr[0], hdr_len,
 424                             &err[0], err_len);
 425                 }
 426 #endif /* EFSYS_OPT_MCDI_LOGGING */
 427
 428                 if (!emrp->emr_quiet) {
 429                         EFSYS_PROBE3(mcdi_err_arg, int, emrp->emr_cmd,
 430                             int, err_code, int, err_arg);
 431                 }
 432
 433                 rc = efx_mcdi_request_errcode(err_code);
 434                 goto fail3;
 435         }
 436
 437         emrp->emr_rc = 0;
 438         emrp->emr_out_length_used = data_len;
 439 #if EFSYS_OPT_MCDI_PROXY_AUTH
 440         emrp->emr_proxy_handle = 0;
 441 #endif /* EFSYS_OPT_MCDI_PROXY_AUTH */
 442         return;
 443
 444 fail3:
 445 fail2:
 446 fail1:
 447         emrp->emr_rc = rc;
 448         emrp->emr_out_length_used = 0;
 449 }
 450
 451 static                  void
 452 efx_mcdi_finish_response(
 453         __in            efx_nic_t *enp,
 454         __in            efx_mcdi_req_t *emrp)
 455 {
 456 #if EFSYS_OPT_MCDI_LOGGING
 457         const efx_mcdi_transport_t *emtp = enp->en_mcdi.em_emtp;
 458 #endif /* EFSYS_OPT_MCDI_LOGGING */
 459         efx_dword_t hdr[2];
 460         unsigned int hdr_len;
 461         size_t bytes;
 462
 463         if (emrp->emr_out_buf == NULL)
 464                 return;
 465
 466         /* Read the command header to detect MCDI response format */
 467         hdr_len = sizeof (hdr[0]);
 468         efx_mcdi_read_response(enp, &hdr[0], 0, hdr_len);
 469         if (EFX_DWORD_FIELD(hdr[0], MCDI_HEADER_CODE) == MC_CMD_V2_EXTN) {
 470                 /*
 471                  * Read the actual payload length. The length given in the event
 472                  * is only correct for responses with the V1 format.
 473                  */
 474                 efx_mcdi_read_response(enp, &hdr[1], hdr_len, sizeof (hdr[1]));
 475                 hdr_len += sizeof (hdr[1]);
 476
 477                 emrp->emr_out_length_used = EFX_DWORD_FIELD(hdr[1],
 478                                             MC_CMD_V2_EXTN_IN_ACTUAL_LEN);
 479         }
 480
 481         /* Copy payload out into caller supplied buffer */
 482         bytes = MIN(emrp->emr_out_length_used, emrp->emr_out_length);
 483         efx_mcdi_read_response(enp, emrp->emr_out_buf, hdr_len, bytes);
 484
 485 #if EFSYS_OPT_MCDI_LOGGING
 486         if (emtp->emt_logger != NULL) {
 487                 emtp->emt_logger(emtp->emt_context,
 488                     EFX_LOG_MCDI_RESPONSE,
 489                     &hdr[0], hdr_len,
 490                     emrp->emr_out_buf, bytes);
 491         }
 492 #endif /* EFSYS_OPT_MCDI_LOGGING */
 493 }
 494
 495
 496         __checkReturn   boolean_t
 497 efx_mcdi_request_poll(
 498         __in            efx_nic_t *enp)
 499 {
 500         efx_mcdi_iface_t *emip = &(enp->en_mcdi.em_emip);
 501         efx_mcdi_req_t *emrp;
 502         efsys_lock_state_t state;
 503         efx_rc_t rc;
 504
 505         EFSYS_ASSERT3U(enp->en_magic, ==, EFX_NIC_MAGIC);
 506         EFSYS_ASSERT3U(enp->en_mod_flags, &, EFX_MOD_MCDI);
 507         EFSYS_ASSERT3U(enp->en_features, &, EFX_FEATURE_MCDI);
 508
 509         /* Serialise against post-watchdog efx_mcdi_ev* */
 510         EFSYS_LOCK(enp->en_eslp, state);
 511
 512         EFSYS_ASSERT(emip->emi_pending_req != NULL);
 513         EFSYS_ASSERT(!emip->emi_ev_cpl);
 514         emrp = emip->emi_pending_req;
 515
 516         /* Check for reboot atomically w.r.t efx_mcdi_request_start */
 517         if (emip->emi_poll_cnt++ == 0) {
 518                 if ((rc = efx_mcdi_poll_reboot(enp)) != 0) {
 519                         emip->emi_pending_req = NULL;
 520                         EFSYS_UNLOCK(enp->en_eslp, state);
 521
 522                         /* Reboot/Assertion */
 523                         if (rc == EIO || rc == EINTR)
 524                                 efx_mcdi_raise_exception(enp, emrp, rc);
 525
 526                         goto fail1;
 527                 }
 528         }
 529
 530         /* Check if a response is available */
 531         if (efx_mcdi_poll_response(enp) == B_FALSE) {
 532                 EFSYS_UNLOCK(enp->en_eslp, state);
 533                 return (B_FALSE);
 534         }
 535
 536         /* Read the response header */
 537         efx_mcdi_read_response_header(enp, emrp);
 538
 539         /* Request complete */
 540         emip->emi_pending_req = NULL;
 541
 542         /* Ensure stale MCDI requests fail after an MC reboot. */
 543         emip->emi_new_epoch = B_FALSE;
 544
 545         EFSYS_UNLOCK(enp->en_eslp, state);
 546
 547         if ((rc = emrp->emr_rc) != 0)
 548                 goto fail2;
 549
 550         efx_mcdi_finish_response(enp, emrp);
 551         return (B_TRUE);
 552
 553 fail2:
 554         if (!emrp->emr_quiet)
 555                 EFSYS_PROBE(fail2);
 556 fail1:
 557         if (!emrp->emr_quiet)
 558                 EFSYS_PROBE1(fail1, efx_rc_t, rc);
 559
 560         return (B_TRUE);
 561 }
 562
 563         __checkReturn   boolean_t
 564 efx_mcdi_request_abort(
 565         __in            efx_nic_t *enp)
 566 {
 567         efx_mcdi_iface_t *emip = &(enp->en_mcdi.em_emip);
 568         efx_mcdi_req_t *emrp;
 569         boolean_t aborted;
 570         efsys_lock_state_t state;
 571
 572         EFSYS_ASSERT3U(enp->en_magic, ==, EFX_NIC_MAGIC);
 573         EFSYS_ASSERT3U(enp->en_mod_flags, &, EFX_MOD_MCDI);
 574         EFSYS_ASSERT3U(enp->en_features, &, EFX_FEATURE_MCDI);
 575
 576         /*
 577          * efx_mcdi_ev_* may have already completed this event, and be
 578          * spinning/blocked on the upper layer lock. So it *is* legitimate
 579          * to for emi_pending_req to be NULL. If there is a pending event
 580          * completed request, then provide a "credit" to allow
 581          * efx_mcdi_ev_cpl() to accept a single spurious completion.
 582          */
 583         EFSYS_LOCK(enp->en_eslp, state);
 584         emrp = emip->emi_pending_req;
 585         aborted = (emrp != NULL);
 586         if (aborted) {
 587                 emip->emi_pending_req = NULL;
 588
 589                 /* Error the request */
 590                 emrp->emr_out_length_used = 0;
 591                 emrp->emr_rc = ETIMEDOUT;
 592
 593                 /* Provide a credit for seqno/emr_pending_req mismatches */
 594                 if (emip->emi_ev_cpl)
 595                         ++emip->emi_aborted;
 596
 597                 /*
 598                  * The upper layer has called us, so we don't
 599                  * need to complete the request.
 600                  */
 601         }
 602         EFSYS_UNLOCK(enp->en_eslp, state);
 603
 604         return (aborted);
 605 }
 606
 607                         void
 608 efx_mcdi_get_timeout(
 609         __in            efx_nic_t *enp,
 610         __in            efx_mcdi_req_t *emrp,
 611         __out           uint32_t *timeoutp)
 612 {
 613         const efx_mcdi_ops_t *emcop = enp->en_mcdi.em_emcop;
 614
 615         emcop->emco_get_timeout(enp, emrp, timeoutp);
 616 }
 617
 618         __checkReturn   efx_rc_t
 619 efx_mcdi_request_errcode(
 620         __in            unsigned int err)
 621 {
 622
 623         switch (err) {
 624                 /* MCDI v1 */
 625         case MC_CMD_ERR_EPERM:
 626                 return (EACCES);
 627         case MC_CMD_ERR_ENOENT:
 628                 return (ENOENT);
 629         case MC_CMD_ERR_EINTR:
 630                 return (EINTR);
 631         case MC_CMD_ERR_EACCES:
 632                 return (EACCES);
 633         case MC_CMD_ERR_EBUSY:
 634                 return (EBUSY);
 635         case MC_CMD_ERR_EINVAL:
 636                 return (EINVAL);
 637         case MC_CMD_ERR_EDEADLK:
 638                 return (EDEADLK);
 639         case MC_CMD_ERR_ENOSYS:
 640                 return (ENOTSUP);
 641         case MC_CMD_ERR_ETIME:
 642                 return (ETIMEDOUT);
 643         case MC_CMD_ERR_ENOTSUP:
 644                 return (ENOTSUP);
 645         case MC_CMD_ERR_EALREADY:
 646                 return (EALREADY);
 647
 648                 /* MCDI v2 */
 649         case MC_CMD_ERR_EEXIST:
 650                 return (EEXIST);
 651 #ifdef MC_CMD_ERR_EAGAIN
 652         case MC_CMD_ERR_EAGAIN:
 653                 return (EAGAIN);
 654 #endif
 655 #ifdef MC_CMD_ERR_ENOSPC
 656         case MC_CMD_ERR_ENOSPC:
 657                 return (ENOSPC);
 658 #endif
 659         case MC_CMD_ERR_ERANGE:
 660                 return (ERANGE);
 661
 662         case MC_CMD_ERR_ALLOC_FAIL:
 663                 return (ENOMEM);
 664         case MC_CMD_ERR_NO_VADAPTOR:
 665                 return (ENOENT);
 666         case MC_CMD_ERR_NO_EVB_PORT:
 667                 return (ENOENT);
 668         case MC_CMD_ERR_NO_VSWITCH:
 669                 return (ENODEV);
 670         case MC_CMD_ERR_VLAN_LIMIT:
 671                 return (EINVAL);
 672         case MC_CMD_ERR_BAD_PCI_FUNC:
 673                 return (ENODEV);
 674         case MC_CMD_ERR_BAD_VLAN_MODE:
 675                 return (EINVAL);
 676         case MC_CMD_ERR_BAD_VSWITCH_TYPE:
 677                 return (EINVAL);
 678         case MC_CMD_ERR_BAD_VPORT_TYPE:
 679                 return (EINVAL);
 680         case MC_CMD_ERR_MAC_EXIST:
 681                 return (EEXIST);
 682
 683         case MC_CMD_ERR_PROXY_PENDING:
 684                 return (EAGAIN);
 685
 686         default:
 687                 EFSYS_PROBE1(mc_pcol_error, int, err);
 688                 return (EIO);
 689         }
 690 }
 691
 692                         void
 693 efx_mcdi_raise_exception(
 694         __in            efx_nic_t *enp,
 695         __in_opt        efx_mcdi_req_t *emrp,
 696         __in            int rc)
 697 {
 698         const efx_mcdi_transport_t *emtp = enp->en_mcdi.em_emtp;
 699         efx_mcdi_exception_t exception;
 700
 701         /* Reboot or Assertion failure only */
 702         EFSYS_ASSERT(rc == EIO || rc == EINTR);
 703
 704         /*
 705          * If MC_CMD_REBOOT causes a reboot (dependent on parameters),
 706          * then the EIO is not worthy of an exception.
 707          */
 708         if (emrp != NULL && emrp->emr_cmd == MC_CMD_REBOOT && rc == EIO)
 709                 return;
 710
 711         exception = (rc == EIO)
 712                 ? EFX_MCDI_EXCEPTION_MC_REBOOT
 713                 : EFX_MCDI_EXCEPTION_MC_BADASSERT;
 714
 715         emtp->emt_exception(emtp->emt_context, exception);
 716 }
 717
 718                         void
 719 efx_mcdi_execute(
 720         __in            efx_nic_t *enp,
 721         __inout         efx_mcdi_req_t *emrp)
 722 {
 723         const efx_mcdi_transport_t *emtp = enp->en_mcdi.em_emtp;
 724
 725         EFSYS_ASSERT3U(enp->en_mod_flags, &, EFX_MOD_MCDI);
 726         EFSYS_ASSERT3U(enp->en_features, &, EFX_FEATURE_MCDI);
 727
 728         emrp->emr_quiet = B_FALSE;
 729         emtp->emt_execute(emtp->emt_context, emrp);
 730 }
 731
 732                         void
 733 efx_mcdi_execute_quiet(
 734         __in            efx_nic_t *enp,
 735         __inout         efx_mcdi_req_t *emrp)
 736 {
 737         const efx_mcdi_transport_t *emtp = enp->en_mcdi.em_emtp;
 738
 739         EFSYS_ASSERT3U(enp->en_mod_flags, &, EFX_MOD_MCDI);
 740         EFSYS_ASSERT3U(enp->en_features, &, EFX_FEATURE_MCDI);
 741
 742         emrp->emr_quiet = B_TRUE;
 743         emtp->emt_execute(emtp->emt_context, emrp);
 744 }
 745
 746                         void
 747 efx_mcdi_ev_cpl(
 748         __in            efx_nic_t *enp,
 749         __in            unsigned int seq,
 750         __in            unsigned int outlen,
 751         __in            int errcode)
 752 {
 753         efx_mcdi_iface_t *emip = &(enp->en_mcdi.em_emip);
 754         const efx_mcdi_transport_t *emtp = enp->en_mcdi.em_emtp;
 755         efx_mcdi_req_t *emrp;
 756         efsys_lock_state_t state;
 757
 758         EFSYS_ASSERT3U(enp->en_mod_flags, &, EFX_MOD_MCDI);
 759         EFSYS_ASSERT3U(enp->en_features, &, EFX_FEATURE_MCDI);
 760
 761         /*
 762          * Serialise against efx_mcdi_request_poll()/efx_mcdi_request_start()
 763          * when we're completing an aborted request.
 764          */
 765         EFSYS_LOCK(enp->en_eslp, state);
 766         if (emip->emi_pending_req == NULL || !emip->emi_ev_cpl ||
 767             (seq != ((emip->emi_seq - 1) & EFX_MASK32(MCDI_HEADER_SEQ)))) {
 768                 EFSYS_ASSERT(emip->emi_aborted > 0);
 769                 if (emip->emi_aborted > 0)
 770                         --emip->emi_aborted;
 771                 EFSYS_UNLOCK(enp->en_eslp, state);
 772                 return;
 773         }
 774
 775         emrp = emip->emi_pending_req;
 776         emip->emi_pending_req = NULL;
 777         EFSYS_UNLOCK(enp->en_eslp, state);
 778
 779         if (emip->emi_max_version >= 2) {
 780                 /* MCDIv2 response details do not fit into an event. */
 781                 efx_mcdi_read_response_header(enp, emrp);
 782         } else {
 783                 if (errcode != 0) {
 784                         if (!emrp->emr_quiet) {
 785                                 EFSYS_PROBE2(mcdi_err, int, emrp->emr_cmd,
 786                                     int, errcode);
 787                         }
 788                         emrp->emr_out_length_used = 0;
 789                         emrp->emr_rc = efx_mcdi_request_errcode(errcode);
 790                 } else {
 791                         emrp->emr_out_length_used = outlen;
 792                         emrp->emr_rc = 0;
 793                 }
 794         }
 795         if (errcode == 0) {
 796                 efx_mcdi_finish_response(enp, emrp);
 797         }
 798
 799         emtp->emt_ev_cpl(emtp->emt_context);
 800 }
 801
 802 #if EFSYS_OPT_MCDI_PROXY_AUTH
 803
 804         __checkReturn   efx_rc_t
 805 efx_mcdi_get_proxy_handle(
 806         __in            efx_nic_t *enp,
 807         __in            efx_mcdi_req_t *emrp,
 808         __out           uint32_t *handlep)
 809 {
 810         efx_rc_t rc;
 811
 812         /*
 813          * Return proxy handle from MCDI request that returned with error
 814          * MC_MCD_ERR_PROXY_PENDING. This handle is used to wait for a matching
 815          * PROXY_RESPONSE event.
 816          */
 817         if ((emrp == NULL) || (handlep == NULL)) {
 818                 rc = EINVAL;
 819                 goto fail1;
 820         }
 821         if ((emrp->emr_rc != 0) &&
 822             (emrp->emr_err_code == MC_CMD_ERR_PROXY_PENDING)) {
 823                 *handlep = emrp->emr_proxy_handle;
 824                 rc = 0;
 825         } else {
 826                 *handlep = 0;
 827                 rc = ENOENT;
 828         }
 829         return (rc);
 830
 831 fail1:
 832         EFSYS_PROBE1(fail1, efx_rc_t, rc);
 833         return (rc);
 834 }
 835
 836                         void
 837 efx_mcdi_ev_proxy_response(
 838         __in            efx_nic_t *enp,
 839         __in            unsigned int handle,
 840         __in            unsigned int status)
 841 {
 842         const efx_mcdi_transport_t *emtp = enp->en_mcdi.em_emtp;
 843         efx_rc_t rc;
 844
 845         /*
 846          * Handle results of an authorization request for a privileged MCDI
 847          * command. If authorization was granted then we must re-issue the
 848          * original MCDI request. If authorization failed or timed out,
 849          * then the original MCDI request should be completed with the
 850          * result code from this event.
 851          */
 852         rc = (status == 0) ? 0 : efx_mcdi_request_errcode(status);
 853
 854         emtp->emt_ev_proxy_response(emtp->emt_context, handle, rc);
 855 }
 856 #endif /* EFSYS_OPT_MCDI_PROXY_AUTH */
 857
 858                         void
 859 efx_mcdi_ev_death(
 860         __in            efx_nic_t *enp,
 861         __in            int rc)
 862 {
 863         efx_mcdi_iface_t *emip = &(enp->en_mcdi.em_emip);
 864         const efx_mcdi_transport_t *emtp = enp->en_mcdi.em_emtp;
 865         efx_mcdi_req_t *emrp = NULL;
 866         boolean_t ev_cpl;
 867         efsys_lock_state_t state;
 868
 869         /*
 870          * The MCDI request (if there is one) has been terminated, either
 871          * by a BADASSERT or REBOOT event.
 872          *
 873          * If there is an outstanding event-completed MCDI operation, then we
 874          * will never receive the completion event (because both MCDI
 875          * completions and BADASSERT events are sent to the same evq). So
 876          * complete this MCDI op.
 877          *
 878          * This function might run in parallel with efx_mcdi_request_poll()
 879          * for poll completed mcdi requests, and also with
 880          * efx_mcdi_request_start() for post-watchdog completions.
 881          */
 882         EFSYS_LOCK(enp->en_eslp, state);
 883         emrp = emip->emi_pending_req;
 884         ev_cpl = emip->emi_ev_cpl;
 885         if (emrp != NULL && emip->emi_ev_cpl) {
 886                 emip->emi_pending_req = NULL;
 887
 888                 emrp->emr_out_length_used = 0;
 889                 emrp->emr_rc = rc;
 890                 ++emip->emi_aborted;
 891         }
 892
 893         /*
 894          * Since we're running in parallel with a request, consume the
 895          * status word before dropping the lock.
 896          */
 897         if (rc == EIO || rc == EINTR) {
 898                 EFSYS_SPIN(EFX_MCDI_STATUS_SLEEP_US);
 899                 (void) efx_mcdi_poll_reboot(enp);
 900                 emip->emi_new_epoch = B_TRUE;
 901         }
 902
 903         EFSYS_UNLOCK(enp->en_eslp, state);
 904
 905         efx_mcdi_raise_exception(enp, emrp, rc);
 906
 907         if (emrp != NULL && ev_cpl)
 908                 emtp->emt_ev_cpl(emtp->emt_context);
 909 }
 910
 911         __checkReturn           efx_rc_t
 912 efx_mcdi_version(
 913         __in                    efx_nic_t *enp,
 914         __out_ecount_opt(4)     uint16_t versionp[4],
 915         __out_opt               uint32_t *buildp,
 916         __out_opt               efx_mcdi_boot_t *statusp)
 917 {
 918         efx_mcdi_req_t req;
 919         uint8_t payload[MAX(MAX(MC_CMD_GET_VERSION_IN_LEN,
 920                                 MC_CMD_GET_VERSION_OUT_LEN),
 921                             MAX(MC_CMD_GET_BOOT_STATUS_IN_LEN,
 922                                 MC_CMD_GET_BOOT_STATUS_OUT_LEN))];
 923         efx_word_t *ver_words;
 924         uint16_t version[4];
 925         uint32_t build;
 926         efx_mcdi_boot_t status;
 927         efx_rc_t rc;
 928
 929         EFSYS_ASSERT3U(enp->en_features, &, EFX_FEATURE_MCDI);
 930
 931         (void) memset(payload, 0, sizeof (payload));
 932         req.emr_cmd = MC_CMD_GET_VERSION;
 933         req.emr_in_buf = payload;
 934         req.emr_in_length = MC_CMD_GET_VERSION_IN_LEN;
 935         req.emr_out_buf = payload;
 936         req.emr_out_length = MC_CMD_GET_VERSION_OUT_LEN;
 937
 938         efx_mcdi_execute(enp, &req);
 939
 940         if (req.emr_rc != 0) {
 941                 rc = req.emr_rc;
 942                 goto fail1;
 943         }
 944
 945         /* bootrom support */
 946         if (req.emr_out_length_used == MC_CMD_GET_VERSION_V0_OUT_LEN) {
 947                 version[0] = version[1] = version[2] = version[3] = 0;
 948                 build = MCDI_OUT_DWORD(req, GET_VERSION_OUT_FIRMWARE);
 949
 950                 goto version;
 951         }
 952
 953         if (req.emr_out_length_used < MC_CMD_GET_VERSION_OUT_LEN) {
 954                 rc = EMSGSIZE;
 955                 goto fail2;
 956         }
 957
 958         ver_words = MCDI_OUT2(req, efx_word_t, GET_VERSION_OUT_VERSION);
 959         version[0] = EFX_WORD_FIELD(ver_words[0], EFX_WORD_0);
 960         version[1] = EFX_WORD_FIELD(ver_words[1], EFX_WORD_0);
 961         version[2] = EFX_WORD_FIELD(ver_words[2], EFX_WORD_0);
 962         version[3] = EFX_WORD_FIELD(ver_words[3], EFX_WORD_0);
 963         build = MCDI_OUT_DWORD(req, GET_VERSION_OUT_FIRMWARE);
 964
 965 version:
 966         /* The bootrom doesn't understand BOOT_STATUS */
 967         if (MC_FW_VERSION_IS_BOOTLOADER(build)) {
 968                 status = EFX_MCDI_BOOT_ROM;
 969                 goto out;
 970         }
 971
 972         (void) memset(payload, 0, sizeof (payload));
 973         req.emr_cmd = MC_CMD_GET_BOOT_STATUS;
 974         req.emr_in_buf = payload;
 975         req.emr_in_length = MC_CMD_GET_BOOT_STATUS_IN_LEN;
 976         req.emr_out_buf = payload;
 977         req.emr_out_length = MC_CMD_GET_BOOT_STATUS_OUT_LEN;
 978
 979         efx_mcdi_execute_quiet(enp, &req);
 980
 981         if (req.emr_rc == EACCES) {
 982                 /* Unprivileged functions cannot access BOOT_STATUS */
 983                 status = EFX_MCDI_BOOT_PRIMARY;
 984                 version[0] = version[1] = version[2] = version[3] = 0;
 985                 build = 0;
 986                 goto out;
 987         }
 988
 989         if (req.emr_rc != 0) {
 990                 rc = req.emr_rc;
 991                 goto fail3;
 992         }
 993
 994         if (req.emr_out_length_used < MC_CMD_GET_BOOT_STATUS_OUT_LEN) {
 995                 rc = EMSGSIZE;
 996                 goto fail4;
 997         }
 998
 999         if (MCDI_OUT_DWORD_FIELD(req, GET_BOOT_STATUS_OUT_FLAGS,
1000             GET_BOOT_STATUS_OUT_FLAGS_PRIMARY))
1001                 status = EFX_MCDI_BOOT_PRIMARY;
1002         else
1003                 status = EFX_MCDI_BOOT_SECONDARY;
1004
1005 out:
1006         if (versionp != NULL)
1007                 memcpy(versionp, version, sizeof (version));
1008         if (buildp != NULL)
1009                 *buildp = build;
1010         if (statusp != NULL)
1011                 *statusp = status;
1012
1013         return (0);
1014
1015 fail4:
1016         EFSYS_PROBE(fail4);
1017 fail3:
1018         EFSYS_PROBE(fail3);
1019 fail2:
1020         EFSYS_PROBE(fail2);
1021 fail1:
1022         EFSYS_PROBE1(fail1, efx_rc_t, rc);
1023
1024         return (rc);
1025 }
1026
1027 static  __checkReturn   efx_rc_t
1028 efx_mcdi_do_reboot(
1029         __in            efx_nic_t *enp,
1030         __in            boolean_t after_assertion)
1031 {
1032         uint8_t payload[MAX(MC_CMD_REBOOT_IN_LEN, MC_CMD_REBOOT_OUT_LEN)];
1033         efx_mcdi_req_t req;
1034         efx_rc_t rc;
1035
1036         /*
1037          * We could require the caller to have caused en_mod_flags=0 to
1038          * call this function. This doesn't help the other port though,
1039          * who's about to get the MC ripped out from underneath them.
1040          * Since they have to cope with the subsequent fallout of MCDI
1041          * failures, we should as well.
1042          */
1043         EFSYS_ASSERT3U(enp->en_magic, ==, EFX_NIC_MAGIC);
1044
1045         (void) memset(payload, 0, sizeof (payload));
1046         req.emr_cmd = MC_CMD_REBOOT;
1047         req.emr_in_buf = payload;
1048         req.emr_in_length = MC_CMD_REBOOT_IN_LEN;
1049         req.emr_out_buf = payload;
1050         req.emr_out_length = MC_CMD_REBOOT_OUT_LEN;
1051
1052         MCDI_IN_SET_DWORD(req, REBOOT_IN_FLAGS,
1053             (after_assertion ? MC_CMD_REBOOT_FLAGS_AFTER_ASSERTION : 0));
1054
1055         efx_mcdi_execute_quiet(enp, &req);
1056
1057         if (req.emr_rc == EACCES) {
1058                 /* Unprivileged functions cannot reboot the MC. */
1059                 goto out;
1060         }
1061
1062         /* A successful reboot request returns EIO. */
1063         if (req.emr_rc != 0 && req.emr_rc != EIO) {
1064                 rc = req.emr_rc;
1065                 goto fail1;
1066         }
1067
1068 out:
1069         return (0);
1070
1071 fail1:
1072         EFSYS_PROBE1(fail1, efx_rc_t, rc);
1073
1074         return (rc);
1075 }
1076
1077         __checkReturn   efx_rc_t
1078 efx_mcdi_reboot(
1079         __in            efx_nic_t *enp)
1080 {
1081         return (efx_mcdi_do_reboot(enp, B_FALSE));
1082 }
1083
1084         __checkReturn   efx_rc_t
1085 efx_mcdi_exit_assertion_handler(
1086         __in            efx_nic_t *enp)
1087 {
1088         return (efx_mcdi_do_reboot(enp, B_TRUE));
1089 }
1090
1091         __checkReturn   efx_rc_t
1092 efx_mcdi_read_assertion(
1093         __in            efx_nic_t *enp)
1094 {
1095         efx_mcdi_req_t req;
1096         uint8_t payload[MAX(MC_CMD_GET_ASSERTS_IN_LEN,
1097                             MC_CMD_GET_ASSERTS_OUT_LEN)];
1098         const char *reason;
1099         unsigned int flags;
1100         unsigned int index;
1101         unsigned int ofst;
1102         int retry;
1103         efx_rc_t rc;
1104
1105         /*
1106          * Before we attempt to chat to the MC, we should verify that the MC
1107          * isn't in it's assertion handler, either due to a previous reboot,
1108          * or because we're reinitializing due to an eec_exception().
1109          *
1110          * Use GET_ASSERTS to read any assertion state that may be present.
1111          * Retry this command twice. Once because a boot-time assertion failure
1112          * might cause the 1st MCDI request to fail. And once again because
1113          * we might race with efx_mcdi_exit_assertion_handler() running on
1114          * partner port(s) on the same NIC.
1115          */
1116         retry = 2;
1117         do {
1118                 (void) memset(payload, 0, sizeof (payload));
1119                 req.emr_cmd = MC_CMD_GET_ASSERTS;
1120                 req.emr_in_buf = payload;
1121                 req.emr_in_length = MC_CMD_GET_ASSERTS_IN_LEN;
1122                 req.emr_out_buf = payload;
1123                 req.emr_out_length = MC_CMD_GET_ASSERTS_OUT_LEN;
1124
1125                 MCDI_IN_SET_DWORD(req, GET_ASSERTS_IN_CLEAR, 1);
1126                 efx_mcdi_execute_quiet(enp, &req);
1127
1128         } while ((req.emr_rc == EINTR || req.emr_rc == EIO) && retry-- > 0);
1129
1130         if (req.emr_rc != 0) {
1131                 if (req.emr_rc == EACCES) {
1132                         /* Unprivileged functions cannot clear assertions. */
1133                         goto out;
1134                 }
1135                 rc = req.emr_rc;
1136                 goto fail1;
1137         }
1138
1139         if (req.emr_out_length_used < MC_CMD_GET_ASSERTS_OUT_LEN) {
1140                 rc = EMSGSIZE;
1141                 goto fail2;
1142         }
1143
1144         /* Print out any assertion state recorded */
1145         flags = MCDI_OUT_DWORD(req, GET_ASSERTS_OUT_GLOBAL_FLAGS);
1146         if (flags == MC_CMD_GET_ASSERTS_FLAGS_NO_FAILS)
1147                 return (0);
1148
1149         reason = (flags == MC_CMD_GET_ASSERTS_FLAGS_SYS_FAIL)
1150                 ? "system-level assertion"
1151                 : (flags == MC_CMD_GET_ASSERTS_FLAGS_THR_FAIL)
1152                 ? "thread-level assertion"
1153                 : (flags == MC_CMD_GET_ASSERTS_FLAGS_WDOG_FIRED)
1154                 ? "watchdog reset"
1155                 : (flags == MC_CMD_GET_ASSERTS_FLAGS_ADDR_TRAP)
1156                 ? "illegal address trap"
1157                 : "unknown assertion";
1158         EFSYS_PROBE3(mcpu_assertion,
1159             const char *, reason, unsigned int,
1160             MCDI_OUT_DWORD(req, GET_ASSERTS_OUT_SAVED_PC_OFFS),
1161             unsigned int,
1162             MCDI_OUT_DWORD(req, GET_ASSERTS_OUT_THREAD_OFFS));
1163
1164         /* Print out the registers (r1 ... r31) */
1165         ofst = MC_CMD_GET_ASSERTS_OUT_GP_REGS_OFFS_OFST;
1166         for (index = 1;
1167                 index < 1 + MC_CMD_GET_ASSERTS_OUT_GP_REGS_OFFS_NUM;
1168                 index++) {
1169                 EFSYS_PROBE2(mcpu_register, unsigned int, index, unsigned int,
1170                             EFX_DWORD_FIELD(*MCDI_OUT(req, efx_dword_t, ofst),
1171                                             EFX_DWORD_0));
1172                 ofst += sizeof (efx_dword_t);
1173         }
1174         EFSYS_ASSERT(ofst <= MC_CMD_GET_ASSERTS_OUT_LEN);
1175
1176 out:
1177         return (0);
1178
1179 fail2:
1180         EFSYS_PROBE(fail2);
1181 fail1:
1182         EFSYS_PROBE1(fail1, efx_rc_t, rc);
1183
1184         return (rc);
1185 }
1186
1187
1188 /*
1189  * Internal routines for for specific MCDI requests.
1190  */
1191
1192         __checkReturn   efx_rc_t
1193 efx_mcdi_drv_attach(
1194         __in            efx_nic_t *enp,
1195         __in            boolean_t attach)
1196 {
1197         efx_mcdi_req_t req;
1198         uint8_t payload[MAX(MC_CMD_DRV_ATTACH_IN_LEN,
1199                             MC_CMD_DRV_ATTACH_EXT_OUT_LEN)];
1200         efx_rc_t rc;
1201
1202         (void) memset(payload, 0, sizeof (payload));
1203         req.emr_cmd = MC_CMD_DRV_ATTACH;
1204         req.emr_in_buf = payload;
1205         req.emr_in_length = MC_CMD_DRV_ATTACH_IN_LEN;
1206         req.emr_out_buf = payload;
1207         req.emr_out_length = MC_CMD_DRV_ATTACH_EXT_OUT_LEN;
1208
1209         /*
1210          * Use DONT_CARE for the datapath firmware type to ensure that the
1211          * driver can attach to an unprivileged function. The datapath firmware
1212          * type to use is controlled by the 'sfboot' utility.
1213          */
1214         MCDI_IN_SET_DWORD(req, DRV_ATTACH_IN_NEW_STATE, attach ? 1 : 0);
1215         MCDI_IN_SET_DWORD(req, DRV_ATTACH_IN_UPDATE, 1);
1216         MCDI_IN_SET_DWORD(req, DRV_ATTACH_IN_FIRMWARE_ID, MC_CMD_FW_DONT_CARE);
1217
1218         efx_mcdi_execute(enp, &req);
1219
1220         if (req.emr_rc != 0) {
1221                 rc = req.emr_rc;
1222                 goto fail1;
1223         }
1224
1225         if (req.emr_out_length_used < MC_CMD_DRV_ATTACH_OUT_LEN) {
1226                 rc = EMSGSIZE;
1227                 goto fail2;
1228         }
1229
1230         return (0);
1231
1232 fail2:
1233         EFSYS_PROBE(fail2);
1234 fail1:
1235         EFSYS_PROBE1(fail1, efx_rc_t, rc);
1236
1237         return (rc);
1238 }
1239
1240         __checkReturn           efx_rc_t
1241 efx_mcdi_get_board_cfg(
1242         __in                    efx_nic_t *enp,
1243         __out_opt               uint32_t *board_typep,
1244         __out_opt               efx_dword_t *capabilitiesp,
1245         __out_ecount_opt(6)     uint8_t mac_addrp[6])
1246 {
1247         efx_mcdi_iface_t *emip = &(enp->en_mcdi.em_emip);
1248         efx_mcdi_req_t req;
1249         uint8_t payload[MAX(MC_CMD_GET_BOARD_CFG_IN_LEN,
1250                             MC_CMD_GET_BOARD_CFG_OUT_LENMIN)];
1251         efx_rc_t rc;
1252
1253         (void) memset(payload, 0, sizeof (payload));
1254         req.emr_cmd = MC_CMD_GET_BOARD_CFG;
1255         req.emr_in_buf = payload;
1256         req.emr_in_length = MC_CMD_GET_BOARD_CFG_IN_LEN;
1257         req.emr_out_buf = payload;
1258         req.emr_out_length = MC_CMD_GET_BOARD_CFG_OUT_LENMIN;
1259
1260         efx_mcdi_execute(enp, &req);
1261
1262         if (req.emr_rc != 0) {
1263                 rc = req.emr_rc;
1264                 goto fail1;
1265         }
1266
1267         if (req.emr_out_length_used < MC_CMD_GET_BOARD_CFG_OUT_LENMIN) {
1268                 rc = EMSGSIZE;
1269                 goto fail2;
1270         }
1271
1272         if (mac_addrp != NULL) {
1273                 uint8_t *addrp;
1274
1275                 if (emip->emi_port == 1) {
1276                         addrp = MCDI_OUT2(req, uint8_t,
1277                             GET_BOARD_CFG_OUT_MAC_ADDR_BASE_PORT0);
1278                 } else if (emip->emi_port == 2) {
1279                         addrp = MCDI_OUT2(req, uint8_t,
1280                             GET_BOARD_CFG_OUT_MAC_ADDR_BASE_PORT1);
1281                 } else {
1282                         rc = EINVAL;
1283                         goto fail3;
1284                 }
1285
1286                 EFX_MAC_ADDR_COPY(mac_addrp, addrp);
1287         }
1288
1289         if (capabilitiesp != NULL) {
1290                 if (emip->emi_port == 1) {
1291                         *capabilitiesp = *MCDI_OUT2(req, efx_dword_t,
1292                             GET_BOARD_CFG_OUT_CAPABILITIES_PORT0);
1293                 } else if (emip->emi_port == 2) {
1294                         *capabilitiesp = *MCDI_OUT2(req, efx_dword_t,
1295                             GET_BOARD_CFG_OUT_CAPABILITIES_PORT1);
1296                 } else {
1297                         rc = EINVAL;
1298                         goto fail4;
1299                 }
1300         }
1301
1302         if (board_typep != NULL) {
1303                 *board_typep = MCDI_OUT_DWORD(req,
1304                     GET_BOARD_CFG_OUT_BOARD_TYPE);
1305         }
1306
1307         return (0);
1308
1309 fail4:
1310         EFSYS_PROBE(fail4);
1311 fail3:
1312         EFSYS_PROBE(fail3);
1313 fail2:
1314         EFSYS_PROBE(fail2);
1315 fail1:
1316         EFSYS_PROBE1(fail1, efx_rc_t, rc);
1317
1318         return (rc);
1319 }
1320
1321         __checkReturn   efx_rc_t
1322 efx_mcdi_get_resource_limits(
1323         __in            efx_nic_t *enp,
1324         __out_opt       uint32_t *nevqp,
1325         __out_opt       uint32_t *nrxqp,
1326         __out_opt       uint32_t *ntxqp)
1327 {
1328         efx_mcdi_req_t req;
1329         uint8_t payload[MAX(MC_CMD_GET_RESOURCE_LIMITS_IN_LEN,
1330                             MC_CMD_GET_RESOURCE_LIMITS_OUT_LEN)];
1331         efx_rc_t rc;
1332
1333         (void) memset(payload, 0, sizeof (payload));
1334         req.emr_cmd = MC_CMD_GET_RESOURCE_LIMITS;
1335         req.emr_in_buf = payload;
1336         req.emr_in_length = MC_CMD_GET_RESOURCE_LIMITS_IN_LEN;
1337         req.emr_out_buf = payload;
1338         req.emr_out_length = MC_CMD_GET_RESOURCE_LIMITS_OUT_LEN;
1339
1340         efx_mcdi_execute(enp, &req);
1341
1342         if (req.emr_rc != 0) {
1343                 rc = req.emr_rc;
1344                 goto fail1;
1345         }
1346
1347         if (req.emr_out_length_used < MC_CMD_GET_RESOURCE_LIMITS_OUT_LEN) {
1348                 rc = EMSGSIZE;
1349                 goto fail2;
1350         }
1351
1352         if (nevqp != NULL)
1353                 *nevqp = MCDI_OUT_DWORD(req, GET_RESOURCE_LIMITS_OUT_EVQ);
1354         if (nrxqp != NULL)
1355                 *nrxqp = MCDI_OUT_DWORD(req, GET_RESOURCE_LIMITS_OUT_RXQ);
1356         if (ntxqp != NULL)
1357                 *ntxqp = MCDI_OUT_DWORD(req, GET_RESOURCE_LIMITS_OUT_TXQ);
1358
1359         return (0);
1360
1361 fail2:
1362         EFSYS_PROBE(fail2);
1363 fail1:
1364         EFSYS_PROBE1(fail1, efx_rc_t, rc);
1365
1366         return (rc);
1367 }
1368
1369         __checkReturn   efx_rc_t
1370 efx_mcdi_get_phy_cfg(
1371         __in            efx_nic_t *enp)
1372 {
1373         efx_port_t *epp = &(enp->en_port);
1374         efx_nic_cfg_t *encp = &(enp->en_nic_cfg);
1375         efx_mcdi_req_t req;
1376         uint8_t payload[MAX(MC_CMD_GET_PHY_CFG_IN_LEN,
1377                             MC_CMD_GET_PHY_CFG_OUT_LEN)];
1378         efx_rc_t rc;
1379
1380         (void) memset(payload, 0, sizeof (payload));
1381         req.emr_cmd = MC_CMD_GET_PHY_CFG;
1382         req.emr_in_buf = payload;
1383         req.emr_in_length = MC_CMD_GET_PHY_CFG_IN_LEN;
1384         req.emr_out_buf = payload;
1385         req.emr_out_length = MC_CMD_GET_PHY_CFG_OUT_LEN;
1386
1387         efx_mcdi_execute(enp, &req);
1388
1389         if (req.emr_rc != 0) {
1390                 rc = req.emr_rc;
1391                 goto fail1;
1392         }
1393
1394         if (req.emr_out_length_used < MC_CMD_GET_PHY_CFG_OUT_LEN) {
1395                 rc = EMSGSIZE;
1396                 goto fail2;
1397         }
1398
1399         encp->enc_phy_type = MCDI_OUT_DWORD(req, GET_PHY_CFG_OUT_TYPE);
1400 #if EFSYS_OPT_NAMES
1401         (void) strncpy(encp->enc_phy_name,
1402                 MCDI_OUT2(req, char, GET_PHY_CFG_OUT_NAME),
1403                 MIN(sizeof (encp->enc_phy_name) - 1,
1404                     MC_CMD_GET_PHY_CFG_OUT_NAME_LEN));
1405 #endif  /* EFSYS_OPT_NAMES */
1406         (void) memset(encp->enc_phy_revision, 0,
1407             sizeof (encp->enc_phy_revision));
1408         memcpy(encp->enc_phy_revision,
1409                 MCDI_OUT2(req, char, GET_PHY_CFG_OUT_REVISION),
1410                 MIN(sizeof (encp->enc_phy_revision) - 1,
1411                     MC_CMD_GET_PHY_CFG_OUT_REVISION_LEN));
1412 #if EFSYS_OPT_PHY_LED_CONTROL
1413         encp->enc_led_mask = ((1 << EFX_PHY_LED_DEFAULT) |
1414                             (1 << EFX_PHY_LED_OFF) |
1415                             (1 << EFX_PHY_LED_ON));
1416 #endif  /* EFSYS_OPT_PHY_LED_CONTROL */
1417
1418         /* Get the media type of the fixed port, if recognised. */
1419         EFX_STATIC_ASSERT(MC_CMD_MEDIA_XAUI == EFX_PHY_MEDIA_XAUI);
1420         EFX_STATIC_ASSERT(MC_CMD_MEDIA_CX4 == EFX_PHY_MEDIA_CX4);
1421         EFX_STATIC_ASSERT(MC_CMD_MEDIA_KX4 == EFX_PHY_MEDIA_KX4);
1422         EFX_STATIC_ASSERT(MC_CMD_MEDIA_XFP == EFX_PHY_MEDIA_XFP);
1423         EFX_STATIC_ASSERT(MC_CMD_MEDIA_SFP_PLUS == EFX_PHY_MEDIA_SFP_PLUS);
1424         EFX_STATIC_ASSERT(MC_CMD_MEDIA_BASE_T == EFX_PHY_MEDIA_BASE_T);
1425         EFX_STATIC_ASSERT(MC_CMD_MEDIA_QSFP_PLUS == EFX_PHY_MEDIA_QSFP_PLUS);
1426         epp->ep_fixed_port_type =
1427                 (efx_phy_media_type_t) MCDI_OUT_DWORD(req, GET_PHY_CFG_OUT_MEDIA_TYPE);
1428         if (epp->ep_fixed_port_type >= EFX_PHY_MEDIA_NTYPES)
1429                 epp->ep_fixed_port_type = EFX_PHY_MEDIA_INVALID;
1430
1431         epp->ep_phy_cap_mask =
1432                 MCDI_OUT_DWORD(req, GET_PHY_CFG_OUT_SUPPORTED_CAP);
1433 #if EFSYS_OPT_PHY_FLAGS
1434         encp->enc_phy_flags_mask = MCDI_OUT_DWORD(req, GET_PHY_CFG_OUT_FLAGS);
1435 #endif  /* EFSYS_OPT_PHY_FLAGS */
1436
1437         encp->enc_port = (uint8_t)MCDI_OUT_DWORD(req, GET_PHY_CFG_OUT_PRT);
1438
1439         /* Populate internal state */
1440         encp->enc_mcdi_mdio_channel =
1441                 (uint8_t)MCDI_OUT_DWORD(req, GET_PHY_CFG_OUT_CHANNEL);
1442
1443 #if EFSYS_OPT_PHY_STATS
1444         encp->enc_mcdi_phy_stat_mask =
1445                 MCDI_OUT_DWORD(req, GET_PHY_CFG_OUT_STATS_MASK);
1446 #endif  /* EFSYS_OPT_PHY_STATS */
1447
1448 #if EFSYS_OPT_BIST
1449         encp->enc_bist_mask = 0;
1450         if (MCDI_OUT_DWORD_FIELD(req, GET_PHY_CFG_OUT_FLAGS,
1451             GET_PHY_CFG_OUT_BIST_CABLE_SHORT))
1452                 encp->enc_bist_mask |= (1 << EFX_BIST_TYPE_PHY_CABLE_SHORT);
1453         if (MCDI_OUT_DWORD_FIELD(req, GET_PHY_CFG_OUT_FLAGS,
1454             GET_PHY_CFG_OUT_BIST_CABLE_LONG))
1455                 encp->enc_bist_mask |= (1 << EFX_BIST_TYPE_PHY_CABLE_LONG);
1456         if (MCDI_OUT_DWORD_FIELD(req, GET_PHY_CFG_OUT_FLAGS,
1457             GET_PHY_CFG_OUT_BIST))
1458                 encp->enc_bist_mask |= (1 << EFX_BIST_TYPE_PHY_NORMAL);
1459 #endif  /* EFSYS_OPT_BIST */
1460
1461         return (0);
1462
1463 fail2:
1464         EFSYS_PROBE(fail2);
1465 fail1:
1466         EFSYS_PROBE1(fail1, efx_rc_t, rc);
1467
1468         return (rc);
1469 }
1470
1471         __checkReturn           efx_rc_t
1472 efx_mcdi_firmware_update_supported(
1473         __in                    efx_nic_t *enp,
1474         __out                   boolean_t *supportedp)
1475 {
1476         const efx_mcdi_ops_t *emcop = enp->en_mcdi.em_emcop;
1477         efx_rc_t rc;
1478
1479         if (emcop != NULL) {
1480                 if ((rc = emcop->emco_feature_supported(enp,
1481                             EFX_MCDI_FEATURE_FW_UPDATE, supportedp)) != 0)
1482                         goto fail1;
1483         } else {
1484                 /* Earlier devices always supported updates */
1485                 *supportedp = B_TRUE;
1486         }
1487
1488         return (0);
1489
1490 fail1:
1491         EFSYS_PROBE1(fail1, efx_rc_t, rc);
1492
1493         return (rc);
1494 }
1495
1496         __checkReturn           efx_rc_t
1497 efx_mcdi_macaddr_change_supported(
1498         __in                    efx_nic_t *enp,
1499         __out                   boolean_t *supportedp)
1500 {
1501         const efx_mcdi_ops_t *emcop = enp->en_mcdi.em_emcop;
1502         efx_rc_t rc;
1503
1504         if (emcop != NULL) {
1505                 if ((rc = emcop->emco_feature_supported(enp,
1506                             EFX_MCDI_FEATURE_MACADDR_CHANGE, supportedp)) != 0)
1507                         goto fail1;
1508         } else {
1509                 /* Earlier devices always supported MAC changes */
1510                 *supportedp = B_TRUE;
1511         }
1512
1513         return (0);
1514
1515 fail1:
1516         EFSYS_PROBE1(fail1, efx_rc_t, rc);
1517
1518         return (rc);
1519 }
1520
1521         __checkReturn           efx_rc_t
1522 efx_mcdi_link_control_supported(
1523         __in                    efx_nic_t *enp,
1524         __out                   boolean_t *supportedp)
1525 {
1526         const efx_mcdi_ops_t *emcop = enp->en_mcdi.em_emcop;
1527         efx_rc_t rc;
1528
1529         if (emcop != NULL) {
1530                 if ((rc = emcop->emco_feature_supported(enp,
1531                             EFX_MCDI_FEATURE_LINK_CONTROL, supportedp)) != 0)
1532                         goto fail1;
1533         } else {
1534                 /* Earlier devices always supported link control */
1535                 *supportedp = B_TRUE;
1536         }
1537
1538         return (0);
1539
1540 fail1:
1541         EFSYS_PROBE1(fail1, efx_rc_t, rc);
1542
1543         return (rc);
1544 }
1545
1546         __checkReturn           efx_rc_t
1547 efx_mcdi_mac_spoofing_supported(
1548         __in                    efx_nic_t *enp,
1549         __out                   boolean_t *supportedp)
1550 {
1551         const efx_mcdi_ops_t *emcop = enp->en_mcdi.em_emcop;
1552         efx_rc_t rc;
1553
1554         if (emcop != NULL) {
1555                 if ((rc = emcop->emco_feature_supported(enp,
1556                             EFX_MCDI_FEATURE_MAC_SPOOFING, supportedp)) != 0)
1557                         goto fail1;
1558         } else {
1559                 /* Earlier devices always supported MAC spoofing */
1560                 *supportedp = B_TRUE;
1561         }
1562
1563         return (0);
1564
1565 fail1:
1566         EFSYS_PROBE1(fail1, efx_rc_t, rc);
1567
1568         return (rc);
1569 }
1570
1571 #if EFSYS_OPT_BIST
1572
1573 #if EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD
1574 /*
1575  * Enter bist offline mode. This is a fw mode which puts the NIC into a state
1576  * where memory BIST tests can be run and not much else can interfere or happen.
1577  * A reboot is required to exit this mode.
1578  */
1579         __checkReturn           efx_rc_t
1580 efx_mcdi_bist_enable_offline(
1581         __in                    efx_nic_t *enp)
1582 {
1583         efx_mcdi_req_t req;
1584         efx_rc_t rc;
1585
1586         EFX_STATIC_ASSERT(MC_CMD_ENABLE_OFFLINE_BIST_IN_LEN == 0);
1587         EFX_STATIC_ASSERT(MC_CMD_ENABLE_OFFLINE_BIST_OUT_LEN == 0);
1588
1589         req.emr_cmd = MC_CMD_ENABLE_OFFLINE_BIST;
1590         req.emr_in_buf = NULL;
1591         req.emr_in_length = 0;
1592         req.emr_out_buf = NULL;
1593         req.emr_out_length = 0;
1594
1595         efx_mcdi_execute(enp, &req);
1596
1597         if (req.emr_rc != 0) {
1598                 rc = req.emr_rc;
1599                 goto fail1;
1600         }
1601
1602         return (0);
1603
1604 fail1:
1605         EFSYS_PROBE1(fail1, efx_rc_t, rc);
1606
1607         return (rc);
1608 }
1609 #endif /* EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD */
1610
1611         __checkReturn           efx_rc_t
1612 efx_mcdi_bist_start(
1613         __in                    efx_nic_t *enp,
1614         __in                    efx_bist_type_t type)
1615 {
1616         efx_mcdi_req_t req;
1617         uint8_t payload[MAX(MC_CMD_START_BIST_IN_LEN,
1618                             MC_CMD_START_BIST_OUT_LEN)];
1619         efx_rc_t rc;
1620
1621         (void) memset(payload, 0, sizeof (payload));
1622         req.emr_cmd = MC_CMD_START_BIST;
1623         req.emr_in_buf = payload;
1624         req.emr_in_length = MC_CMD_START_BIST_IN_LEN;
1625         req.emr_out_buf = payload;
1626         req.emr_out_length = MC_CMD_START_BIST_OUT_LEN;
1627
1628         switch (type) {
1629         case EFX_BIST_TYPE_PHY_NORMAL:
1630                 MCDI_IN_SET_DWORD(req, START_BIST_IN_TYPE, MC_CMD_PHY_BIST);
1631                 break;
1632         case EFX_BIST_TYPE_PHY_CABLE_SHORT:
1633                 MCDI_IN_SET_DWORD(req, START_BIST_IN_TYPE,
1634                     MC_CMD_PHY_BIST_CABLE_SHORT);
1635                 break;
1636         case EFX_BIST_TYPE_PHY_CABLE_LONG:
1637                 MCDI_IN_SET_DWORD(req, START_BIST_IN_TYPE,
1638                     MC_CMD_PHY_BIST_CABLE_LONG);
1639                 break;
1640         case EFX_BIST_TYPE_MC_MEM:
1641                 MCDI_IN_SET_DWORD(req, START_BIST_IN_TYPE,
1642                     MC_CMD_MC_MEM_BIST);
1643                 break;
1644         case EFX_BIST_TYPE_SAT_MEM:
1645                 MCDI_IN_SET_DWORD(req, START_BIST_IN_TYPE,
1646                     MC_CMD_PORT_MEM_BIST);
1647                 break;
1648         case EFX_BIST_TYPE_REG:
1649                 MCDI_IN_SET_DWORD(req, START_BIST_IN_TYPE,
1650                     MC_CMD_REG_BIST);
1651                 break;
1652         default:
1653                 EFSYS_ASSERT(0);
1654         }
1655
1656         efx_mcdi_execute(enp, &req);
1657
1658         if (req.emr_rc != 0) {
1659                 rc = req.emr_rc;
1660                 goto fail1;
1661         }
1662
1663         return (0);
1664
1665 fail1:
1666         EFSYS_PROBE1(fail1, efx_rc_t, rc);
1667
1668         return (rc);
1669 }
1670
1671 #endif /* EFSYS_OPT_BIST */
1672
1673
1674 /* Enable logging of some events (e.g. link state changes) */
1675         __checkReturn   efx_rc_t
1676 efx_mcdi_log_ctrl(
1677         __in            efx_nic_t *enp)
1678 {
1679         efx_mcdi_req_t req;
1680         uint8_t payload[MAX(MC_CMD_LOG_CTRL_IN_LEN,
1681                             MC_CMD_LOG_CTRL_OUT_LEN)];
1682         efx_rc_t rc;
1683
1684         (void) memset(payload, 0, sizeof (payload));
1685         req.emr_cmd = MC_CMD_LOG_CTRL;
1686         req.emr_in_buf = payload;
1687         req.emr_in_length = MC_CMD_LOG_CTRL_IN_LEN;
1688         req.emr_out_buf = payload;
1689         req.emr_out_length = MC_CMD_LOG_CTRL_OUT_LEN;
1690
1691         MCDI_IN_SET_DWORD(req, LOG_CTRL_IN_LOG_DEST,
1692                     MC_CMD_LOG_CTRL_IN_LOG_DEST_EVQ);
1693         MCDI_IN_SET_DWORD(req, LOG_CTRL_IN_LOG_DEST_EVQ, 0);
1694
1695         efx_mcdi_execute(enp, &req);
1696
1697         if (req.emr_rc != 0) {
1698                 rc = req.emr_rc;
1699                 goto fail1;
1700         }
1701
1702         return (0);
1703
1704 fail1:
1705         EFSYS_PROBE1(fail1, efx_rc_t, rc);
1706
1707         return (rc);
1708 }
1709
1710
1711 #if EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD
1712
1713 /*
1714  * This function returns the pf and vf number of a function.  If it is a pf the
1715  * vf number is 0xffff.  The vf number is the index of the vf on that
1716  * function. So if you have 3 vfs on pf 0 the 3 vfs will return (pf=0,vf=0),
1717  * (pf=0,vf=1), (pf=0,vf=2) aand the pf will return (pf=0, vf=0xffff).
1718  */
1719         __checkReturn           efx_rc_t
1720 efx_mcdi_get_function_info(
1721         __in                    efx_nic_t *enp,
1722         __out                   uint32_t *pfp,
1723         __out_opt               uint32_t *vfp)
1724 {
1725         efx_mcdi_req_t req;
1726         uint8_t payload[MAX(MC_CMD_GET_FUNCTION_INFO_IN_LEN,
1727                             MC_CMD_GET_FUNCTION_INFO_OUT_LEN)];
1728         efx_rc_t rc;
1729
1730         (void) memset(payload, 0, sizeof (payload));
1731         req.emr_cmd = MC_CMD_GET_FUNCTION_INFO;
1732         req.emr_in_buf = payload;
1733         req.emr_in_length = MC_CMD_GET_FUNCTION_INFO_IN_LEN;
1734         req.emr_out_buf = payload;
1735         req.emr_out_length = MC_CMD_GET_FUNCTION_INFO_OUT_LEN;
1736
1737         efx_mcdi_execute(enp, &req);
1738
1739         if (req.emr_rc != 0) {
1740                 rc = req.emr_rc;
1741                 goto fail1;
1742         }
1743
1744         if (req.emr_out_length_used < MC_CMD_GET_FUNCTION_INFO_OUT_LEN) {
1745                 rc = EMSGSIZE;
1746                 goto fail2;
1747         }
1748
1749         *pfp = MCDI_OUT_DWORD(req, GET_FUNCTION_INFO_OUT_PF);
1750         if (vfp != NULL)
1751                 *vfp = MCDI_OUT_DWORD(req, GET_FUNCTION_INFO_OUT_VF);
1752
1753         return (0);
1754
1755 fail2:
1756         EFSYS_PROBE(fail2);
1757 fail1:
1758         EFSYS_PROBE1(fail1, efx_rc_t, rc);
1759
1760         return (rc);
1761 }
1762
1763         __checkReturn           efx_rc_t
1764 efx_mcdi_privilege_mask(
1765         __in                    efx_nic_t *enp,
1766         __in                    uint32_t pf,
1767         __in                    uint32_t vf,
1768         __out                   uint32_t *maskp)
1769 {
1770         efx_mcdi_req_t req;
1771         uint8_t payload[MAX(MC_CMD_PRIVILEGE_MASK_IN_LEN,
1772                             MC_CMD_PRIVILEGE_MASK_OUT_LEN)];
1773         efx_rc_t rc;
1774
1775         (void) memset(payload, 0, sizeof (payload));
1776         req.emr_cmd = MC_CMD_PRIVILEGE_MASK;
1777         req.emr_in_buf = payload;
1778         req.emr_in_length = MC_CMD_PRIVILEGE_MASK_IN_LEN;
1779         req.emr_out_buf = payload;
1780         req.emr_out_length = MC_CMD_PRIVILEGE_MASK_OUT_LEN;
1781
1782         MCDI_IN_POPULATE_DWORD_2(req, PRIVILEGE_MASK_IN_FUNCTION,
1783             PRIVILEGE_MASK_IN_FUNCTION_PF, pf,
1784             PRIVILEGE_MASK_IN_FUNCTION_VF, vf);
1785
1786         efx_mcdi_execute(enp, &req);
1787
1788         if (req.emr_rc != 0) {
1789                 rc = req.emr_rc;
1790                 goto fail1;
1791         }
1792
1793         if (req.emr_out_length_used < MC_CMD_PRIVILEGE_MASK_OUT_LEN) {
1794                 rc = EMSGSIZE;
1795                 goto fail2;
1796         }
1797
1798         *maskp = MCDI_OUT_DWORD(req, PRIVILEGE_MASK_OUT_OLD_MASK);
1799
1800         return (0);
1801
1802 fail2:
1803         EFSYS_PROBE(fail2);
1804 fail1:
1805         EFSYS_PROBE1(fail1, efx_rc_t, rc);
1806
1807         return (rc);
1808 }
1809
1810 #endif /* EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD */
1811
1812         __checkReturn           efx_rc_t
1813 efx_mcdi_set_workaround(
1814         __in                    efx_nic_t *enp,
1815         __in                    uint32_t type,
1816         __in                    boolean_t enabled,
1817         __out_opt               uint32_t *flagsp)
1818 {
1819         efx_mcdi_req_t req;
1820         uint8_t payload[MAX(MC_CMD_WORKAROUND_IN_LEN,
1821                             MC_CMD_WORKAROUND_EXT_OUT_LEN)];
1822         efx_rc_t rc;
1823
1824         (void) memset(payload, 0, sizeof (payload));
1825         req.emr_cmd = MC_CMD_WORKAROUND;
1826         req.emr_in_buf = payload;
1827         req.emr_in_length = MC_CMD_WORKAROUND_IN_LEN;
1828         req.emr_out_buf = payload;
1829         req.emr_out_length = MC_CMD_WORKAROUND_OUT_LEN;
1830
1831         MCDI_IN_SET_DWORD(req, WORKAROUND_IN_TYPE, type);
1832         MCDI_IN_SET_DWORD(req, WORKAROUND_IN_ENABLED, enabled ? 1 : 0);
1833
1834         efx_mcdi_execute_quiet(enp, &req);
1835
1836         if (req.emr_rc != 0) {
1837                 rc = req.emr_rc;
1838                 goto fail1;
1839         }
1840
1841         if (flagsp != NULL) {
1842                 if (req.emr_out_length_used >= MC_CMD_WORKAROUND_EXT_OUT_LEN)
1843                         *flagsp = MCDI_OUT_DWORD(req, WORKAROUND_EXT_OUT_FLAGS);
1844                 else
1845                         *flagsp = 0;
1846         }
1847
1848         return (0);
1849
1850 fail1:
1851         EFSYS_PROBE1(fail1, efx_rc_t, rc);
1852
1853         return (rc);
1854 }
1855
1856
1857         __checkReturn           efx_rc_t
1858 efx_mcdi_get_workarounds(
1859         __in                    efx_nic_t *enp,
1860         __out_opt               uint32_t *implementedp,
1861         __out_opt               uint32_t *enabledp)
1862 {
1863         efx_mcdi_req_t req;
1864         uint8_t payload[MC_CMD_GET_WORKAROUNDS_OUT_LEN];
1865         efx_rc_t rc;
1866
1867         (void) memset(payload, 0, sizeof (payload));
1868         req.emr_cmd = MC_CMD_GET_WORKAROUNDS;
1869         req.emr_in_buf = NULL;
1870         req.emr_in_length = 0;
1871         req.emr_out_buf = payload;
1872         req.emr_out_length = MC_CMD_GET_WORKAROUNDS_OUT_LEN;
1873
1874         efx_mcdi_execute(enp, &req);
1875
1876         if (req.emr_rc != 0) {
1877                 rc = req.emr_rc;
1878                 goto fail1;
1879         }
1880
1881         if (implementedp != NULL) {
1882                 *implementedp =
1883                     MCDI_OUT_DWORD(req, GET_WORKAROUNDS_OUT_IMPLEMENTED);
1884         }
1885
1886         if (enabledp != NULL) {
1887                 *enabledp = MCDI_OUT_DWORD(req, GET_WORKAROUNDS_OUT_ENABLED);
1888         }
1889
1890         return (0);
1891
1892 fail1:
1893         EFSYS_PROBE1(fail1, efx_rc_t, rc);
1894
1895         return (rc);
1896 }
1897
1898 /*
1899  * Size of media information page in accordance with SFF-8472 and SFF-8436.
1900  * It is used in MCDI interface as well.
1901  */
1902 #define EFX_PHY_MEDIA_INFO_PAGE_SIZE            0x80
1903
1904 static  __checkReturn           efx_rc_t
1905 efx_mcdi_get_phy_media_info(
1906         __in                    efx_nic_t *enp,
1907         __in                    uint32_t mcdi_page,
1908         __in                    uint8_t offset,
1909         __in                    uint8_t len,
1910         __out_bcount(len)       uint8_t *data)
1911 {
1912         efx_mcdi_req_t req;
1913         uint8_t payload[MAX(MC_CMD_GET_PHY_MEDIA_INFO_IN_LEN,
1914                             MC_CMD_GET_PHY_MEDIA_INFO_OUT_LEN(
1915                                 EFX_PHY_MEDIA_INFO_PAGE_SIZE))];
1916         efx_rc_t rc;
1917
1918         EFSYS_ASSERT((uint32_t)offset + len <= EFX_PHY_MEDIA_INFO_PAGE_SIZE);
1919
1920         (void) memset(payload, 0, sizeof (payload));
1921         req.emr_cmd = MC_CMD_GET_PHY_MEDIA_INFO;
1922         req.emr_in_buf = payload;
1923         req.emr_in_length = MC_CMD_GET_PHY_MEDIA_INFO_IN_LEN;
1924         req.emr_out_buf = payload;
1925         req.emr_out_length =
1926             MC_CMD_GET_PHY_MEDIA_INFO_OUT_LEN(EFX_PHY_MEDIA_INFO_PAGE_SIZE);
1927
1928         MCDI_IN_SET_DWORD(req, GET_PHY_MEDIA_INFO_IN_PAGE, mcdi_page);
1929
1930         efx_mcdi_execute(enp, &req);
1931
1932         if (req.emr_rc != 0) {
1933                 rc = req.emr_rc;
1934                 goto fail1;
1935         }
1936
1937         if (req.emr_out_length_used !=
1938             MC_CMD_GET_PHY_MEDIA_INFO_OUT_LEN(EFX_PHY_MEDIA_INFO_PAGE_SIZE)) {
1939                 rc = EMSGSIZE;
1940                 goto fail2;
1941         }
1942
1943         if (MCDI_OUT_DWORD(req, GET_PHY_MEDIA_INFO_OUT_DATALEN) !=
1944             EFX_PHY_MEDIA_INFO_PAGE_SIZE) {
1945                 rc = EIO;
1946                 goto fail3;
1947         }
1948
1949         memcpy(data,
1950             MCDI_OUT2(req, uint8_t, GET_PHY_MEDIA_INFO_OUT_DATA) + offset,
1951             len);
1952
1953         return (0);
1954
1955 fail3:
1956         EFSYS_PROBE(fail3);
1957 fail2:
1958         EFSYS_PROBE(fail2);
1959 fail1:
1960         EFSYS_PROBE1(fail1, efx_rc_t, rc);
1961
1962         return (rc);
1963 }
1964
1965 /*
1966  * 2-wire device address of the base information in accordance with SFF-8472
1967  * Diagnostic Monitoring Interface for Optical Transceivers section
1968  * 4 Memory Organization.
1969  */
1970 #define EFX_PHY_MEDIA_INFO_DEV_ADDR_SFP_BASE    0xA0
1971
1972 /*
1973  * 2-wire device address of the digital diagnostics monitoring interface
1974  * in accordance with SFF-8472 Diagnostic Monitoring Interface for Optical
1975  * Transceivers section 4 Memory Organization.
1976  */
1977 #define EFX_PHY_MEDIA_INFO_DEV_ADDR_SFP_DDM     0xA2
1978
1979 /*
1980  * Hard wired 2-wire device address for QSFP+ in accordance with SFF-8436
1981  * QSFP+ 10 Gbs 4X PLUGGABLE TRANSCEIVER section 7.4 Device Addressing and
1982  * Operation.
1983  */
1984 #define EFX_PHY_MEDIA_INFO_DEV_ADDR_QSFP        0xA0
1985
1986         __checkReturn           efx_rc_t
1987 efx_mcdi_phy_module_get_info(
1988         __in                    efx_nic_t *enp,
1989         __in                    uint8_t dev_addr,
1990         __in                    uint8_t offset,
1991         __in                    uint8_t len,
1992         __out_bcount(len)       uint8_t *data)
1993 {
1994         efx_port_t *epp = &(enp->en_port);
1995         efx_rc_t rc;
1996         uint32_t mcdi_lower_page;
1997         uint32_t mcdi_upper_page;
1998
1999         EFSYS_ASSERT3U(enp->en_mod_flags, &, EFX_MOD_PROBE);
2000
2001         /*
2002          * Map device address to MC_CMD_GET_PHY_MEDIA_INFO pages.
2003          * Offset plus length interface allows to access page 0 only.
2004          * I.e. non-zero upper pages are not accessible.
2005          * See SFF-8472 section 4 Memory Organization and SFF-8436 section 7.6
2006          * QSFP+ Memory Map for details on how information is structured
2007          * and accessible.
2008          */
2009         switch (epp->ep_fixed_port_type) {
2010         case EFX_PHY_MEDIA_SFP_PLUS:
2011                 /*
2012                  * In accordance with SFF-8472 Diagnostic Monitoring
2013                  * Interface for Optical Transceivers section 4 Memory
2014                  * Organization two 2-wire addresses are defined.
2015                  */
2016                 switch (dev_addr) {
2017                 /* Base information */
2018                 case EFX_PHY_MEDIA_INFO_DEV_ADDR_SFP_BASE:
2019                         /*
2020                          * MCDI page 0 should be used to access lower
2021                          * page 0 (0x00 - 0x7f) at the device address 0xA0.
2022                          */
2023                         mcdi_lower_page = 0;
2024                         /*
2025                          * MCDI page 1 should be used to access  upper
2026                          * page 0 (0x80 - 0xff) at the device address 0xA0.
2027                          */
2028                         mcdi_upper_page = 1;
2029                         break;
2030                 /* Diagnostics */
2031                 case EFX_PHY_MEDIA_INFO_DEV_ADDR_SFP_DDM:
2032                         /*
2033                          * MCDI page 2 should be used to access lower
2034                          * page 0 (0x00 - 0x7f) at the device address 0xA2.
2035                          */
2036                         mcdi_lower_page = 2;
2037                         /*
2038                          * MCDI page 3 should be used to access upper
2039                          * page 0 (0x80 - 0xff) at the device address 0xA2.
2040                          */
2041                         mcdi_upper_page = 3;
2042                         break;
2043                 default:
2044                         rc = ENOTSUP;
2045                         goto fail1;
2046                 }
2047                 break;
2048         case EFX_PHY_MEDIA_QSFP_PLUS:
2049                 switch (dev_addr) {
2050                 case EFX_PHY_MEDIA_INFO_DEV_ADDR_QSFP:
2051                         /*
2052                          * MCDI page -1 should be used to access lower page 0
2053                          * (0x00 - 0x7f).
2054                          */
2055                         mcdi_lower_page = (uint32_t)-1;
2056                         /*
2057                          * MCDI page 0 should be used to access upper page 0
2058                          * (0x80h - 0xff).
2059                          */
2060                         mcdi_upper_page = 0;
2061                         break;
2062                 default:
2063                         rc = ENOTSUP;
2064                         goto fail1;
2065                 }
2066                 break;
2067         default:
2068                 rc = ENOTSUP;
2069                 goto fail1;
2070         }
2071
2072         if (offset < EFX_PHY_MEDIA_INFO_PAGE_SIZE) {
2073                 uint8_t read_len =
2074                     MIN(len, EFX_PHY_MEDIA_INFO_PAGE_SIZE - offset);
2075
2076                 rc = efx_mcdi_get_phy_media_info(enp,
2077                     mcdi_lower_page, offset, read_len, data);
2078                 if (rc != 0)
2079                         goto fail2;
2080
2081                 data += read_len;
2082                 len -= read_len;
2083
2084                 offset = 0;
2085         } else {
2086                 offset -= EFX_PHY_MEDIA_INFO_PAGE_SIZE;
2087         }
2088
2089         if (len > 0) {
2090                 EFSYS_ASSERT3U(len, <=, EFX_PHY_MEDIA_INFO_PAGE_SIZE);
2091                 EFSYS_ASSERT3U(offset, <, EFX_PHY_MEDIA_INFO_PAGE_SIZE);
2092
2093                 rc = efx_mcdi_get_phy_media_info(enp,
2094                     mcdi_upper_page, offset, len, data);
2095                 if (rc != 0)
2096                         goto fail3;
2097         }
2098
2099         return (0);
2100
2101 fail3:
2102         EFSYS_PROBE(fail3);
2103 fail2:
2104         EFSYS_PROBE(fail2);
2105 fail1:
2106         EFSYS_PROBE1(fail1, efx_rc_t, rc);
2107
2108         return (rc);
2109 }
2110
2111 #endif  /* EFSYS_OPT_MCDI */