drivers/net/sfc/base/efx_nvram.c

   1 /*
   2  * Copyright (c) 2009-2016 Solarflare Communications Inc.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are met:
   7  *
   8  * 1. Redistributions of source code must retain the above copyright notice,
   9  *    this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright notice,
  11  *    this list of conditions and the following disclaimer in the documentation
  12  *    and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  15  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  16  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  21  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  22  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  23  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  24  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  *
  26  * The views and conclusions contained in the software and documentation are
  27  * those of the authors and should not be interpreted as representing official
  28  * policies, either expressed or implied, of the FreeBSD Project.
  29  */
  30
  31 #include "efx.h"
  32 #include "efx_impl.h"
  33
  34 #if EFSYS_OPT_NVRAM
  35
  36 #if EFSYS_OPT_SIENA
  37
  38 static const efx_nvram_ops_t    __efx_nvram_siena_ops = {
  39 #if EFSYS_OPT_DIAG
  40         siena_nvram_test,               /* envo_test */
  41 #endif  /* EFSYS_OPT_DIAG */
  42         siena_nvram_type_to_partn,      /* envo_type_to_partn */
  43         siena_nvram_partn_size,         /* envo_partn_size */
  44         siena_nvram_partn_rw_start,     /* envo_partn_rw_start */
  45         siena_nvram_partn_read,         /* envo_partn_read */
  46         siena_nvram_partn_erase,        /* envo_partn_erase */
  47         siena_nvram_partn_write,        /* envo_partn_write */
  48         siena_nvram_partn_rw_finish,    /* envo_partn_rw_finish */
  49         siena_nvram_partn_get_version,  /* envo_partn_get_version */
  50         siena_nvram_partn_set_version,  /* envo_partn_set_version */
  51         NULL,                           /* envo_partn_validate */
  52 };
  53
  54 #endif  /* EFSYS_OPT_SIENA */
  55
  56 #if EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD
  57
  58 static const efx_nvram_ops_t    __efx_nvram_ef10_ops = {
  59 #if EFSYS_OPT_DIAG
  60         ef10_nvram_test,                /* envo_test */
  61 #endif  /* EFSYS_OPT_DIAG */
  62         ef10_nvram_type_to_partn,       /* envo_type_to_partn */
  63         ef10_nvram_partn_size,          /* envo_partn_size */
  64         ef10_nvram_partn_rw_start,      /* envo_partn_rw_start */
  65         ef10_nvram_partn_read,          /* envo_partn_read */
  66         ef10_nvram_partn_erase,         /* envo_partn_erase */
  67         ef10_nvram_partn_write,         /* envo_partn_write */
  68         ef10_nvram_partn_rw_finish,     /* envo_partn_rw_finish */
  69         ef10_nvram_partn_get_version,   /* envo_partn_get_version */
  70         ef10_nvram_partn_set_version,   /* envo_partn_set_version */
  71         ef10_nvram_buffer_validate,     /* envo_buffer_validate */
  72 };
  73
  74 #endif  /* EFSYS_OPT_HUNTINGTON || EFSYS_OPT_MEDFORD */
  75
  76         __checkReturn   efx_rc_t
  77 efx_nvram_init(
  78         __in            efx_nic_t *enp)
  79 {
  80         const efx_nvram_ops_t *envop;
  81         efx_rc_t rc;
  82
  83         EFSYS_ASSERT3U(enp->en_magic, ==, EFX_NIC_MAGIC);
  84         EFSYS_ASSERT3U(enp->en_mod_flags, &, EFX_MOD_PROBE);
  85         EFSYS_ASSERT(!(enp->en_mod_flags & EFX_MOD_NVRAM));
  86
  87         switch (enp->en_family) {
  88 #if EFSYS_OPT_SIENA
  89         case EFX_FAMILY_SIENA:
  90                 envop = &__efx_nvram_siena_ops;
  91                 break;
  92 #endif  /* EFSYS_OPT_SIENA */
  93
  94 #if EFSYS_OPT_HUNTINGTON
  95         case EFX_FAMILY_HUNTINGTON:
  96                 envop = &__efx_nvram_ef10_ops;
  97                 break;
  98 #endif  /* EFSYS_OPT_HUNTINGTON */
  99
 100 #if EFSYS_OPT_MEDFORD
 101         case EFX_FAMILY_MEDFORD:
 102                 envop = &__efx_nvram_ef10_ops;
 103                 break;
 104 #endif  /* EFSYS_OPT_MEDFORD */
 105
 106         default:
 107                 EFSYS_ASSERT(0);
 108                 rc = ENOTSUP;
 109                 goto fail1;
 110         }
 111
 112         enp->en_envop = envop;
 113         enp->en_mod_flags |= EFX_MOD_NVRAM;
 114
 115         enp->en_nvram_partn_locked = EFX_NVRAM_PARTN_INVALID;
 116
 117         return (0);
 118
 119 fail1:
 120         EFSYS_PROBE1(fail1, efx_rc_t, rc);
 121
 122         return (rc);
 123 }
 124
 125 #if EFSYS_OPT_DIAG
 126
 127         __checkReturn           efx_rc_t
 128 efx_nvram_test(
 129         __in                    efx_nic_t *enp)
 130 {
 131         const efx_nvram_ops_t *envop = enp->en_envop;
 132         efx_rc_t rc;
 133
 134         EFSYS_ASSERT3U(enp->en_magic, ==, EFX_NIC_MAGIC);
 135         EFSYS_ASSERT3U(enp->en_mod_flags, &, EFX_MOD_NVRAM);
 136
 137         if ((rc = envop->envo_test(enp)) != 0)
 138                 goto fail1;
 139
 140         return (0);
 141
 142 fail1:
 143         EFSYS_PROBE1(fail1, efx_rc_t, rc);
 144
 145         return (rc);
 146 }
 147
 148 #endif  /* EFSYS_OPT_DIAG */
 149
 150         __checkReturn           efx_rc_t
 151 efx_nvram_size(
 152         __in                    efx_nic_t *enp,
 153         __in                    efx_nvram_type_t type,
 154         __out                   size_t *sizep)
 155 {
 156         const efx_nvram_ops_t *envop = enp->en_envop;
 157         uint32_t partn;
 158         efx_rc_t rc;
 159
 160         EFSYS_ASSERT3U(enp->en_magic, ==, EFX_NIC_MAGIC);
 161         EFSYS_ASSERT3U(enp->en_mod_flags, &, EFX_MOD_NVRAM);
 162
 163         EFSYS_ASSERT3U(type, <, EFX_NVRAM_NTYPES);
 164
 165         if ((rc = envop->envo_type_to_partn(enp, type, &partn)) != 0)
 166                 goto fail1;
 167
 168         if ((rc = envop->envo_partn_size(enp, partn, sizep)) != 0)
 169                 goto fail2;
 170
 171         return (0);
 172
 173 fail2:
 174         EFSYS_PROBE(fail2);
 175 fail1:
 176         EFSYS_PROBE1(fail1, efx_rc_t, rc);
 177         *sizep = 0;
 178
 179         return (rc);
 180 }
 181
 182         __checkReturn           efx_rc_t
 183 efx_nvram_get_version(
 184         __in                    efx_nic_t *enp,
 185         __in                    efx_nvram_type_t type,
 186         __out                   uint32_t *subtypep,
 187         __out_ecount(4)         uint16_t version[4])
 188 {
 189         const efx_nvram_ops_t *envop = enp->en_envop;
 190         uint32_t partn;
 191         efx_rc_t rc;
 192
 193         EFSYS_ASSERT3U(enp->en_magic, ==, EFX_NIC_MAGIC);
 194         EFSYS_ASSERT3U(enp->en_mod_flags, &, EFX_MOD_PROBE);
 195         EFSYS_ASSERT3U(enp->en_mod_flags, &, EFX_MOD_NVRAM);
 196
 197         EFSYS_ASSERT3U(type, <, EFX_NVRAM_NTYPES);
 198
 199         if ((rc = envop->envo_type_to_partn(enp, type, &partn)) != 0)
 200                 goto fail1;
 201
 202         if ((rc = envop->envo_partn_get_version(enp, partn,
 203                     subtypep, version)) != 0)
 204                 goto fail2;
 205
 206         return (0);
 207
 208 fail2:
 209         EFSYS_PROBE(fail2);
 210 fail1:
 211         EFSYS_PROBE1(fail1, efx_rc_t, rc);
 212
 213         return (rc);
 214 }
 215
 216         __checkReturn           efx_rc_t
 217 efx_nvram_rw_start(
 218         __in                    efx_nic_t *enp,
 219         __in                    efx_nvram_type_t type,
 220         __out_opt               size_t *chunk_sizep)
 221 {
 222         const efx_nvram_ops_t *envop = enp->en_envop;
 223         uint32_t partn;
 224         efx_rc_t rc;
 225
 226         EFSYS_ASSERT3U(enp->en_magic, ==, EFX_NIC_MAGIC);
 227         EFSYS_ASSERT3U(enp->en_mod_flags, &, EFX_MOD_NVRAM);
 228
 229         EFSYS_ASSERT3U(type, <, EFX_NVRAM_NTYPES);
 230         EFSYS_ASSERT3U(type, !=, EFX_NVRAM_INVALID);
 231
 232         if ((rc = envop->envo_type_to_partn(enp, type, &partn)) != 0)
 233                 goto fail1;
 234
 235         EFSYS_ASSERT3U(enp->en_nvram_partn_locked, ==, EFX_NVRAM_PARTN_INVALID);
 236
 237         if ((rc = envop->envo_partn_rw_start(enp, partn, chunk_sizep)) != 0)
 238                 goto fail2;
 239
 240         enp->en_nvram_partn_locked = partn;
 241
 242         return (0);
 243
 244 fail2:
 245         EFSYS_PROBE(fail2);
 246 fail1:
 247         EFSYS_PROBE1(fail1, efx_rc_t, rc);
 248
 249         return (rc);
 250 }
 251
 252         __checkReturn           efx_rc_t
 253 efx_nvram_read_chunk(
 254         __in                    efx_nic_t *enp,
 255         __in                    efx_nvram_type_t type,
 256         __in                    unsigned int offset,
 257         __out_bcount(size)      caddr_t data,
 258         __in                    size_t size)
 259 {
 260         const efx_nvram_ops_t *envop = enp->en_envop;
 261         uint32_t partn;
 262         efx_rc_t rc;
 263
 264         EFSYS_ASSERT3U(enp->en_magic, ==, EFX_NIC_MAGIC);
 265         EFSYS_ASSERT3U(enp->en_mod_flags, &, EFX_MOD_NVRAM);
 266
 267         EFSYS_ASSERT3U(type, <, EFX_NVRAM_NTYPES);
 268         EFSYS_ASSERT3U(type, !=, EFX_NVRAM_INVALID);
 269
 270         if ((rc = envop->envo_type_to_partn(enp, type, &partn)) != 0)
 271                 goto fail1;
 272
 273         EFSYS_ASSERT3U(enp->en_nvram_partn_locked, ==, partn);
 274
 275         if ((rc = envop->envo_partn_read(enp, partn, offset, data, size)) != 0)
 276                 goto fail2;
 277
 278         return (0);
 279
 280 fail2:
 281         EFSYS_PROBE(fail2);
 282 fail1:
 283         EFSYS_PROBE1(fail1, efx_rc_t, rc);
 284
 285         return (rc);
 286 }
 287
 288         __checkReturn           efx_rc_t
 289 efx_nvram_erase(
 290         __in                    efx_nic_t *enp,
 291         __in                    efx_nvram_type_t type)
 292 {
 293         const efx_nvram_ops_t *envop = enp->en_envop;
 294         unsigned int offset = 0;
 295         size_t size = 0;
 296         uint32_t partn;
 297         efx_rc_t rc;
 298
 299         EFSYS_ASSERT3U(enp->en_magic, ==, EFX_NIC_MAGIC);
 300         EFSYS_ASSERT3U(enp->en_mod_flags, &, EFX_MOD_NVRAM);
 301
 302         EFSYS_ASSERT3U(type, <, EFX_NVRAM_NTYPES);
 303         EFSYS_ASSERT3U(type, !=, EFX_NVRAM_INVALID);
 304
 305         if ((rc = envop->envo_type_to_partn(enp, type, &partn)) != 0)
 306                 goto fail1;
 307
 308         EFSYS_ASSERT3U(enp->en_nvram_partn_locked, ==, partn);
 309
 310         if ((rc = envop->envo_partn_size(enp, partn, &size)) != 0)
 311                 goto fail2;
 312
 313         if ((rc = envop->envo_partn_erase(enp, partn, offset, size)) != 0)
 314                 goto fail3;
 315
 316         return (0);
 317
 318 fail3:
 319         EFSYS_PROBE(fail3);
 320 fail2:
 321         EFSYS_PROBE(fail2);
 322 fail1:
 323         EFSYS_PROBE1(fail1, efx_rc_t, rc);
 324
 325         return (rc);
 326 }
 327
 328         __checkReturn           efx_rc_t
 329 efx_nvram_write_chunk(
 330         __in                    efx_nic_t *enp,
 331         __in                    efx_nvram_type_t type,
 332         __in                    unsigned int offset,
 333         __in_bcount(size)       caddr_t data,
 334         __in                    size_t size)
 335 {
 336         const efx_nvram_ops_t *envop = enp->en_envop;
 337         uint32_t partn;
 338         efx_rc_t rc;
 339
 340         EFSYS_ASSERT3U(enp->en_magic, ==, EFX_NIC_MAGIC);
 341         EFSYS_ASSERT3U(enp->en_mod_flags, &, EFX_MOD_NVRAM);
 342
 343         EFSYS_ASSERT3U(type, <, EFX_NVRAM_NTYPES);
 344         EFSYS_ASSERT3U(type, !=, EFX_NVRAM_INVALID);
 345
 346         if ((rc = envop->envo_type_to_partn(enp, type, &partn)) != 0)
 347                 goto fail1;
 348
 349         EFSYS_ASSERT3U(enp->en_nvram_partn_locked, ==, partn);
 350
 351         if ((rc = envop->envo_partn_write(enp, partn, offset, data, size)) != 0)
 352                 goto fail2;
 353
 354         return (0);
 355
 356 fail2:
 357         EFSYS_PROBE(fail2);
 358 fail1:
 359         EFSYS_PROBE1(fail1, efx_rc_t, rc);
 360
 361         return (rc);
 362 }
 363
 364         __checkReturn           efx_rc_t
 365 efx_nvram_rw_finish(
 366         __in                    efx_nic_t *enp,
 367         __in                    efx_nvram_type_t type,
 368         __out_opt               uint32_t *verify_resultp)
 369 {
 370         const efx_nvram_ops_t *envop = enp->en_envop;
 371         uint32_t partn;
 372         uint32_t verify_result = 0;
 373         efx_rc_t rc;
 374
 375         EFSYS_ASSERT3U(enp->en_magic, ==, EFX_NIC_MAGIC);
 376         EFSYS_ASSERT3U(enp->en_mod_flags, &, EFX_MOD_NVRAM);
 377
 378         EFSYS_ASSERT3U(type, <, EFX_NVRAM_NTYPES);
 379         EFSYS_ASSERT3U(type, !=, EFX_NVRAM_INVALID);
 380
 381         if ((rc = envop->envo_type_to_partn(enp, type, &partn)) != 0)
 382                 goto fail1;
 383
 384         EFSYS_ASSERT3U(enp->en_nvram_partn_locked, ==, partn);
 385
 386         if ((rc = envop->envo_partn_rw_finish(enp, partn, &verify_result)) != 0)
 387                 goto fail2;
 388
 389         enp->en_nvram_partn_locked = EFX_NVRAM_PARTN_INVALID;
 390
 391         if (verify_resultp != NULL)
 392                 *verify_resultp = verify_result;
 393
 394         return (0);
 395
 396 fail2:
 397         EFSYS_PROBE(fail2);
 398         enp->en_nvram_partn_locked = EFX_NVRAM_PARTN_INVALID;
 399
 400 fail1:
 401         EFSYS_PROBE1(fail1, efx_rc_t, rc);
 402
 403         /* Always report verification result */
 404         if (verify_resultp != NULL)
 405                 *verify_resultp = verify_result;
 406
 407         return (rc);
 408 }
 409
 410         __checkReturn           efx_rc_t
 411 efx_nvram_set_version(
 412         __in                    efx_nic_t *enp,
 413         __in                    efx_nvram_type_t type,
 414         __in_ecount(4)          uint16_t version[4])
 415 {
 416         const efx_nvram_ops_t *envop = enp->en_envop;
 417         uint32_t partn;
 418         efx_rc_t rc;
 419
 420         EFSYS_ASSERT3U(enp->en_magic, ==, EFX_NIC_MAGIC);
 421         EFSYS_ASSERT3U(enp->en_mod_flags, &, EFX_MOD_PROBE);
 422         EFSYS_ASSERT3U(enp->en_mod_flags, &, EFX_MOD_NVRAM);
 423
 424         EFSYS_ASSERT3U(type, <, EFX_NVRAM_NTYPES);
 425
 426         if ((rc = envop->envo_type_to_partn(enp, type, &partn)) != 0)
 427                 goto fail1;
 428
 429         /*
 430          * The Siena implementation of envo_set_version() will attempt to
 431          * acquire the NVRAM_UPDATE lock for the DYNAMIC_CONFIG partition.
 432          * Therefore, you can't have already acquired the NVRAM_UPDATE lock.
 433          */
 434         EFSYS_ASSERT3U(enp->en_nvram_partn_locked, ==, EFX_NVRAM_PARTN_INVALID);
 435
 436         if ((rc = envop->envo_partn_set_version(enp, partn, version)) != 0)
 437                 goto fail2;
 438
 439         return (0);
 440
 441 fail2:
 442         EFSYS_PROBE(fail2);
 443 fail1:
 444         EFSYS_PROBE1(fail1, efx_rc_t, rc);
 445
 446         return (rc);
 447 }
 448
 449 /* Validate buffer contents (before writing to flash) */
 450         __checkReturn           efx_rc_t
 451 efx_nvram_validate(
 452         __in                    efx_nic_t *enp,
 453         __in                    efx_nvram_type_t type,
 454         __in_bcount(partn_size) caddr_t partn_data,
 455         __in                    size_t partn_size)
 456 {
 457         const efx_nvram_ops_t *envop = enp->en_envop;
 458         uint32_t partn;
 459         efx_rc_t rc;
 460
 461         EFSYS_ASSERT3U(enp->en_magic, ==, EFX_NIC_MAGIC);
 462         EFSYS_ASSERT3U(enp->en_mod_flags, &, EFX_MOD_PROBE);
 463         EFSYS_ASSERT3U(enp->en_mod_flags, &, EFX_MOD_NVRAM);
 464
 465         EFSYS_ASSERT3U(type, <, EFX_NVRAM_NTYPES);
 466
 467
 468         if ((rc = envop->envo_type_to_partn(enp, type, &partn)) != 0)
 469                 goto fail1;
 470
 471         if (envop->envo_type_to_partn != NULL &&
 472             ((rc = envop->envo_buffer_validate(enp, partn,
 473             partn_data, partn_size)) != 0))
 474                 goto fail2;
 475
 476         return (0);
 477
 478 fail2:
 479         EFSYS_PROBE(fail2);
 480 fail1:
 481         EFSYS_PROBE1(fail1, efx_rc_t, rc);
 482
 483         return (rc);
 484 }
 485
 486
 487 void
 488 efx_nvram_fini(
 489         __in            efx_nic_t *enp)
 490 {
 491         EFSYS_ASSERT3U(enp->en_magic, ==, EFX_NIC_MAGIC);
 492         EFSYS_ASSERT3U(enp->en_mod_flags, &, EFX_MOD_PROBE);
 493         EFSYS_ASSERT3U(enp->en_mod_flags, &, EFX_MOD_NVRAM);
 494
 495         EFSYS_ASSERT3U(enp->en_nvram_partn_locked, ==, EFX_NVRAM_PARTN_INVALID);
 496
 497         enp->en_envop = NULL;
 498         enp->en_mod_flags &= ~EFX_MOD_NVRAM;
 499 }
 500
 501 #endif  /* EFSYS_OPT_NVRAM */
 502
 503 #if EFSYS_OPT_NVRAM || EFSYS_OPT_VPD
 504
 505 /*
 506  * Internal MCDI request handling
 507  */
 508
 509         __checkReturn           efx_rc_t
 510 efx_mcdi_nvram_partitions(
 511         __in                    efx_nic_t *enp,
 512         __out_bcount(size)      caddr_t data,
 513         __in                    size_t size,
 514         __out                   unsigned int *npartnp)
 515 {
 516         efx_mcdi_req_t req;
 517         uint8_t payload[MAX(MC_CMD_NVRAM_PARTITIONS_IN_LEN,
 518                             MC_CMD_NVRAM_PARTITIONS_OUT_LENMAX)];
 519         unsigned int npartn;
 520         efx_rc_t rc;
 521
 522         (void) memset(payload, 0, sizeof (payload));
 523         req.emr_cmd = MC_CMD_NVRAM_PARTITIONS;
 524         req.emr_in_buf = payload;
 525         req.emr_in_length = MC_CMD_NVRAM_PARTITIONS_IN_LEN;
 526         req.emr_out_buf = payload;
 527         req.emr_out_length = MC_CMD_NVRAM_PARTITIONS_OUT_LENMAX;
 528
 529         efx_mcdi_execute(enp, &req);
 530
 531         if (req.emr_rc != 0) {
 532                 rc = req.emr_rc;
 533                 goto fail1;
 534         }
 535
 536         if (req.emr_out_length_used < MC_CMD_NVRAM_PARTITIONS_OUT_LENMIN) {
 537                 rc = EMSGSIZE;
 538                 goto fail2;
 539         }
 540         npartn = MCDI_OUT_DWORD(req, NVRAM_PARTITIONS_OUT_NUM_PARTITIONS);
 541
 542         if (req.emr_out_length_used < MC_CMD_NVRAM_PARTITIONS_OUT_LEN(npartn)) {
 543                 rc = ENOENT;
 544                 goto fail3;
 545         }
 546
 547         if (size < npartn * sizeof (uint32_t)) {
 548                 rc = ENOSPC;
 549                 goto fail3;
 550         }
 551
 552         *npartnp = npartn;
 553
 554         memcpy(data,
 555             MCDI_OUT2(req, uint32_t, NVRAM_PARTITIONS_OUT_TYPE_ID),
 556             (npartn * sizeof (uint32_t)));
 557
 558         return (0);
 559
 560 fail3:
 561         EFSYS_PROBE(fail3);
 562 fail2:
 563         EFSYS_PROBE(fail2);
 564 fail1:
 565         EFSYS_PROBE1(fail1, efx_rc_t, rc);
 566
 567         return (rc);
 568 }
 569
 570         __checkReturn           efx_rc_t
 571 efx_mcdi_nvram_metadata(
 572         __in                    efx_nic_t *enp,
 573         __in                    uint32_t partn,
 574         __out                   uint32_t *subtypep,
 575         __out_ecount(4)         uint16_t version[4],
 576         __out_bcount_opt(size)  char *descp,
 577         __in                    size_t size)
 578 {
 579         efx_mcdi_req_t req;
 580         uint8_t payload[MAX(MC_CMD_NVRAM_METADATA_IN_LEN,
 581                             MC_CMD_NVRAM_METADATA_OUT_LENMAX)];
 582         efx_rc_t rc;
 583
 584         (void) memset(payload, 0, sizeof (payload));
 585         req.emr_cmd = MC_CMD_NVRAM_METADATA;
 586         req.emr_in_buf = payload;
 587         req.emr_in_length = MC_CMD_NVRAM_METADATA_IN_LEN;
 588         req.emr_out_buf = payload;
 589         req.emr_out_length = MC_CMD_NVRAM_METADATA_OUT_LENMAX;
 590
 591         MCDI_IN_SET_DWORD(req, NVRAM_METADATA_IN_TYPE, partn);
 592
 593         efx_mcdi_execute(enp, &req);
 594
 595         if (req.emr_rc != 0) {
 596                 rc = req.emr_rc;
 597                 goto fail1;
 598         }
 599
 600         if (req.emr_out_length_used < MC_CMD_NVRAM_METADATA_OUT_LENMIN) {
 601                 rc = EMSGSIZE;
 602                 goto fail2;
 603         }
 604
 605         if (MCDI_OUT_DWORD_FIELD(req, NVRAM_METADATA_OUT_FLAGS,
 606                 NVRAM_METADATA_OUT_SUBTYPE_VALID)) {
 607                 *subtypep = MCDI_OUT_DWORD(req, NVRAM_METADATA_OUT_SUBTYPE);
 608         } else {
 609                 *subtypep = 0;
 610         }
 611
 612         if (MCDI_OUT_DWORD_FIELD(req, NVRAM_METADATA_OUT_FLAGS,
 613                 NVRAM_METADATA_OUT_VERSION_VALID)) {
 614                 version[0] = MCDI_OUT_WORD(req, NVRAM_METADATA_OUT_VERSION_W);
 615                 version[1] = MCDI_OUT_WORD(req, NVRAM_METADATA_OUT_VERSION_X);
 616                 version[2] = MCDI_OUT_WORD(req, NVRAM_METADATA_OUT_VERSION_Y);
 617                 version[3] = MCDI_OUT_WORD(req, NVRAM_METADATA_OUT_VERSION_Z);
 618         } else {
 619                 version[0] = version[1] = version[2] = version[3] = 0;
 620         }
 621
 622         if (MCDI_OUT_DWORD_FIELD(req, NVRAM_METADATA_OUT_FLAGS,
 623                 NVRAM_METADATA_OUT_DESCRIPTION_VALID)) {
 624                 /* Return optional descrition string */
 625                 if ((descp != NULL) && (size > 0)) {
 626                         size_t desclen;
 627
 628                         descp[0] = '\0';
 629                         desclen = (req.emr_out_length_used
 630                             - MC_CMD_NVRAM_METADATA_OUT_LEN(0));
 631
 632                         EFSYS_ASSERT3U(desclen, <=,
 633                             MC_CMD_NVRAM_METADATA_OUT_DESCRIPTION_MAXNUM);
 634
 635                         if (size < desclen) {
 636                                 rc = ENOSPC;
 637                                 goto fail3;
 638                         }
 639
 640                         memcpy(descp, MCDI_OUT2(req, char,
 641                                 NVRAM_METADATA_OUT_DESCRIPTION),
 642                             desclen);
 643
 644                         /* Ensure string is NUL terminated */
 645                         descp[desclen] = '\0';
 646                 }
 647         }
 648
 649         return (0);
 650
 651 fail3:
 652         EFSYS_PROBE(fail3);
 653 fail2:
 654         EFSYS_PROBE(fail2);
 655 fail1:
 656         EFSYS_PROBE1(fail1, efx_rc_t, rc);
 657
 658         return (rc);
 659 }
 660
 661         __checkReturn           efx_rc_t
 662 efx_mcdi_nvram_info(
 663         __in                    efx_nic_t *enp,
 664         __in                    uint32_t partn,
 665         __out_opt               size_t *sizep,
 666         __out_opt               uint32_t *addressp,
 667         __out_opt               uint32_t *erase_sizep,
 668         __out_opt               uint32_t *write_sizep)
 669 {
 670         uint8_t payload[MAX(MC_CMD_NVRAM_INFO_IN_LEN,
 671                             MC_CMD_NVRAM_INFO_V2_OUT_LEN)];
 672         efx_mcdi_req_t req;
 673         efx_rc_t rc;
 674
 675         (void) memset(payload, 0, sizeof (payload));
 676         req.emr_cmd = MC_CMD_NVRAM_INFO;
 677         req.emr_in_buf = payload;
 678         req.emr_in_length = MC_CMD_NVRAM_INFO_IN_LEN;
 679         req.emr_out_buf = payload;
 680         req.emr_out_length = MC_CMD_NVRAM_INFO_V2_OUT_LEN;
 681
 682         MCDI_IN_SET_DWORD(req, NVRAM_INFO_IN_TYPE, partn);
 683
 684         efx_mcdi_execute_quiet(enp, &req);
 685
 686         if (req.emr_rc != 0) {
 687                 rc = req.emr_rc;
 688                 goto fail1;
 689         }
 690
 691         if (req.emr_out_length_used < MC_CMD_NVRAM_INFO_OUT_LEN) {
 692                 rc = EMSGSIZE;
 693                 goto fail2;
 694         }
 695
 696         if (sizep)
 697                 *sizep = MCDI_OUT_DWORD(req, NVRAM_INFO_OUT_SIZE);
 698
 699         if (addressp)
 700                 *addressp = MCDI_OUT_DWORD(req, NVRAM_INFO_OUT_PHYSADDR);
 701
 702         if (erase_sizep)
 703                 *erase_sizep = MCDI_OUT_DWORD(req, NVRAM_INFO_OUT_ERASESIZE);
 704
 705         if (write_sizep) {
 706                 *write_sizep =
 707                         (req.emr_out_length_used <
 708                             MC_CMD_NVRAM_INFO_V2_OUT_LEN) ?
 709                         0 : MCDI_OUT_DWORD(req, NVRAM_INFO_V2_OUT_WRITESIZE);
 710         }
 711
 712         return (0);
 713
 714 fail2:
 715         EFSYS_PROBE(fail2);
 716 fail1:
 717         EFSYS_PROBE1(fail1, efx_rc_t, rc);
 718
 719         return (rc);
 720 }
 721
 722 /*
 723  * MC_CMD_NVRAM_UPDATE_START_V2 must be used to support firmware-verified
 724  * NVRAM updates. Older firmware will ignore the flags field in the request.
 725  */
 726         __checkReturn           efx_rc_t
 727 efx_mcdi_nvram_update_start(
 728         __in                    efx_nic_t *enp,
 729         __in                    uint32_t partn)
 730 {
 731         uint8_t payload[MAX(MC_CMD_NVRAM_UPDATE_START_V2_IN_LEN,
 732                             MC_CMD_NVRAM_UPDATE_START_OUT_LEN)];
 733         efx_mcdi_req_t req;
 734         efx_rc_t rc;
 735
 736         (void) memset(payload, 0, sizeof (payload));
 737         req.emr_cmd = MC_CMD_NVRAM_UPDATE_START;
 738         req.emr_in_buf = payload;
 739         req.emr_in_length = MC_CMD_NVRAM_UPDATE_START_V2_IN_LEN;
 740         req.emr_out_buf = payload;
 741         req.emr_out_length = MC_CMD_NVRAM_UPDATE_START_OUT_LEN;
 742
 743         MCDI_IN_SET_DWORD(req, NVRAM_UPDATE_START_V2_IN_TYPE, partn);
 744
 745         MCDI_IN_POPULATE_DWORD_1(req, NVRAM_UPDATE_START_V2_IN_FLAGS,
 746             NVRAM_UPDATE_START_V2_IN_FLAG_REPORT_VERIFY_RESULT, 1);
 747
 748         efx_mcdi_execute(enp, &req);
 749
 750         if (req.emr_rc != 0) {
 751                 rc = req.emr_rc;
 752                 goto fail1;
 753         }
 754
 755         return (0);
 756
 757 fail1:
 758         EFSYS_PROBE1(fail1, efx_rc_t, rc);
 759
 760         return (rc);
 761 }
 762
 763         __checkReturn           efx_rc_t
 764 efx_mcdi_nvram_read(
 765         __in                    efx_nic_t *enp,
 766         __in                    uint32_t partn,
 767         __in                    uint32_t offset,
 768         __out_bcount(size)      caddr_t data,
 769         __in                    size_t size,
 770         __in                    uint32_t mode)
 771 {
 772         efx_mcdi_req_t req;
 773         uint8_t payload[MAX(MC_CMD_NVRAM_READ_IN_V2_LEN,
 774                             MC_CMD_NVRAM_READ_OUT_LENMAX)];
 775         efx_rc_t rc;
 776
 777         if (size > MC_CMD_NVRAM_READ_OUT_LENMAX) {
 778                 rc = EINVAL;
 779                 goto fail1;
 780         }
 781
 782         (void) memset(payload, 0, sizeof (payload));
 783         req.emr_cmd = MC_CMD_NVRAM_READ;
 784         req.emr_in_buf = payload;
 785         req.emr_in_length = MC_CMD_NVRAM_READ_IN_V2_LEN;
 786         req.emr_out_buf = payload;
 787         req.emr_out_length = MC_CMD_NVRAM_READ_OUT_LENMAX;
 788
 789         MCDI_IN_SET_DWORD(req, NVRAM_READ_IN_V2_TYPE, partn);
 790         MCDI_IN_SET_DWORD(req, NVRAM_READ_IN_V2_OFFSET, offset);
 791         MCDI_IN_SET_DWORD(req, NVRAM_READ_IN_V2_LENGTH, size);
 792         MCDI_IN_SET_DWORD(req, NVRAM_READ_IN_V2_MODE, mode);
 793
 794         efx_mcdi_execute(enp, &req);
 795
 796         if (req.emr_rc != 0) {
 797                 rc = req.emr_rc;
 798                 goto fail1;
 799         }
 800
 801         if (req.emr_out_length_used < MC_CMD_NVRAM_READ_OUT_LEN(size)) {
 802                 rc = EMSGSIZE;
 803                 goto fail2;
 804         }
 805
 806         memcpy(data,
 807             MCDI_OUT2(req, uint8_t, NVRAM_READ_OUT_READ_BUFFER),
 808             size);
 809
 810         return (0);
 811
 812 fail2:
 813         EFSYS_PROBE(fail2);
 814 fail1:
 815         EFSYS_PROBE1(fail1, efx_rc_t, rc);
 816
 817         return (rc);
 818 }
 819
 820         __checkReturn           efx_rc_t
 821 efx_mcdi_nvram_erase(
 822         __in                    efx_nic_t *enp,
 823         __in                    uint32_t partn,
 824         __in                    uint32_t offset,
 825         __in                    size_t size)
 826 {
 827         efx_mcdi_req_t req;
 828         uint8_t payload[MAX(MC_CMD_NVRAM_ERASE_IN_LEN,
 829                             MC_CMD_NVRAM_ERASE_OUT_LEN)];
 830         efx_rc_t rc;
 831
 832         (void) memset(payload, 0, sizeof (payload));
 833         req.emr_cmd = MC_CMD_NVRAM_ERASE;
 834         req.emr_in_buf = payload;
 835         req.emr_in_length = MC_CMD_NVRAM_ERASE_IN_LEN;
 836         req.emr_out_buf = payload;
 837         req.emr_out_length = MC_CMD_NVRAM_ERASE_OUT_LEN;
 838
 839         MCDI_IN_SET_DWORD(req, NVRAM_ERASE_IN_TYPE, partn);
 840         MCDI_IN_SET_DWORD(req, NVRAM_ERASE_IN_OFFSET, offset);
 841         MCDI_IN_SET_DWORD(req, NVRAM_ERASE_IN_LENGTH, size);
 842
 843         efx_mcdi_execute(enp, &req);
 844
 845         if (req.emr_rc != 0) {
 846                 rc = req.emr_rc;
 847                 goto fail1;
 848         }
 849
 850         return (0);
 851
 852 fail1:
 853         EFSYS_PROBE1(fail1, efx_rc_t, rc);
 854
 855         return (rc);
 856 }
 857
 858 /*
 859  * The NVRAM_WRITE MCDI command is a V1 command and so is supported by both
 860  * Sienna and EF10 based boards.  However EF10 based boards support the use
 861  * of this command with payloads up to the maximum MCDI V2 payload length.
 862  */
 863         __checkReturn           efx_rc_t
 864 efx_mcdi_nvram_write(
 865         __in                    efx_nic_t *enp,
 866         __in                    uint32_t partn,
 867         __in                    uint32_t offset,
 868         __out_bcount(size)      caddr_t data,
 869         __in                    size_t size)
 870 {
 871         efx_mcdi_req_t req;
 872         uint8_t payload[MAX(MCDI_CTL_SDU_LEN_MAX_V1,
 873                             MCDI_CTL_SDU_LEN_MAX_V2)];
 874         efx_rc_t rc;
 875         size_t max_data_size;
 876
 877         max_data_size = enp->en_nic_cfg.enc_mcdi_max_payload_length
 878             - MC_CMD_NVRAM_WRITE_IN_LEN(0);
 879         EFSYS_ASSERT3U(enp->en_nic_cfg.enc_mcdi_max_payload_length, >, 0);
 880         EFSYS_ASSERT3U(max_data_size, <,
 881                     enp->en_nic_cfg.enc_mcdi_max_payload_length);
 882
 883         if (size > max_data_size) {
 884                 rc = EINVAL;
 885                 goto fail1;
 886         }
 887
 888         (void) memset(payload, 0, sizeof (payload));
 889         req.emr_cmd = MC_CMD_NVRAM_WRITE;
 890         req.emr_in_buf = payload;
 891         req.emr_in_length = MC_CMD_NVRAM_WRITE_IN_LEN(size);
 892         req.emr_out_buf = payload;
 893         req.emr_out_length = MC_CMD_NVRAM_WRITE_OUT_LEN;
 894
 895         MCDI_IN_SET_DWORD(req, NVRAM_WRITE_IN_TYPE, partn);
 896         MCDI_IN_SET_DWORD(req, NVRAM_WRITE_IN_OFFSET, offset);
 897         MCDI_IN_SET_DWORD(req, NVRAM_WRITE_IN_LENGTH, size);
 898
 899         memcpy(MCDI_IN2(req, uint8_t, NVRAM_WRITE_IN_WRITE_BUFFER),
 900             data, size);
 901
 902         efx_mcdi_execute(enp, &req);
 903
 904         if (req.emr_rc != 0) {
 905                 rc = req.emr_rc;
 906                 goto fail2;
 907         }
 908
 909         return (0);
 910
 911 fail2:
 912         EFSYS_PROBE(fail2);
 913 fail1:
 914         EFSYS_PROBE1(fail1, efx_rc_t, rc);
 915
 916         return (rc);
 917 }
 918
 919
 920 /*
 921  * MC_CMD_NVRAM_UPDATE_FINISH_V2 must be used to support firmware-verified
 922  * NVRAM updates. Older firmware will ignore the flags field in the request.
 923  */
 924         __checkReturn           efx_rc_t
 925 efx_mcdi_nvram_update_finish(
 926         __in                    efx_nic_t *enp,
 927         __in                    uint32_t partn,
 928         __in                    boolean_t reboot,
 929         __out_opt               uint32_t *verify_resultp)
 930 {
 931         const efx_nic_cfg_t *encp = &enp->en_nic_cfg;
 932         efx_mcdi_req_t req;
 933         uint8_t payload[MAX(MC_CMD_NVRAM_UPDATE_FINISH_V2_IN_LEN,
 934                             MC_CMD_NVRAM_UPDATE_FINISH_V2_OUT_LEN)];
 935         uint32_t verify_result = MC_CMD_NVRAM_VERIFY_RC_UNKNOWN;
 936         efx_rc_t rc;
 937
 938         (void) memset(payload, 0, sizeof (payload));
 939         req.emr_cmd = MC_CMD_NVRAM_UPDATE_FINISH;
 940         req.emr_in_buf = payload;
 941         req.emr_in_length = MC_CMD_NVRAM_UPDATE_FINISH_V2_IN_LEN;
 942         req.emr_out_buf = payload;
 943         req.emr_out_length = MC_CMD_NVRAM_UPDATE_FINISH_V2_OUT_LEN;
 944
 945         MCDI_IN_SET_DWORD(req, NVRAM_UPDATE_FINISH_V2_IN_TYPE, partn);
 946         MCDI_IN_SET_DWORD(req, NVRAM_UPDATE_FINISH_V2_IN_REBOOT, reboot);
 947
 948         MCDI_IN_POPULATE_DWORD_1(req, NVRAM_UPDATE_FINISH_V2_IN_FLAGS,
 949             NVRAM_UPDATE_FINISH_V2_IN_FLAG_REPORT_VERIFY_RESULT, 1);
 950
 951         efx_mcdi_execute(enp, &req);
 952
 953         if (req.emr_rc != 0) {
 954                 rc = req.emr_rc;
 955                 goto fail1;
 956         }
 957
 958         if (req.emr_out_length_used < MC_CMD_NVRAM_UPDATE_FINISH_V2_OUT_LEN) {
 959                 verify_result = MC_CMD_NVRAM_VERIFY_RC_UNKNOWN;
 960                 if (encp->enc_nvram_update_verify_result_supported) {
 961                         /* Result of update verification is missing */
 962                         rc = EMSGSIZE;
 963                         goto fail2;
 964                 }
 965         } else {
 966                 verify_result =
 967                     MCDI_OUT_DWORD(req, NVRAM_UPDATE_FINISH_V2_OUT_RESULT_CODE);
 968         }
 969
 970         if ((encp->enc_nvram_update_verify_result_supported) &&
 971             (verify_result != MC_CMD_NVRAM_VERIFY_RC_SUCCESS)) {
 972                 /* Update verification failed */
 973                 rc = EINVAL;
 974                 goto fail3;
 975         }
 976
 977         if (verify_resultp != NULL)
 978                 *verify_resultp = verify_result;
 979
 980         return (0);
 981
 982 fail3:
 983         EFSYS_PROBE(fail3);
 984 fail2:
 985         EFSYS_PROBE(fail2);
 986 fail1:
 987         EFSYS_PROBE1(fail1, efx_rc_t, rc);
 988
 989         /* Always report verification result */
 990         if (verify_resultp != NULL)
 991                 *verify_resultp = verify_result;
 992
 993         return (rc);
 994 }
 995
 996 #if EFSYS_OPT_DIAG
 997
 998         __checkReturn           efx_rc_t
 999 efx_mcdi_nvram_test(
1000         __in                    efx_nic_t *enp,
1001         __in                    uint32_t partn)
1002 {
1003         efx_mcdi_req_t req;
1004         uint8_t payload[MAX(MC_CMD_NVRAM_TEST_IN_LEN,
1005                             MC_CMD_NVRAM_TEST_OUT_LEN)];
1006         int result;
1007         efx_rc_t rc;
1008
1009         (void) memset(payload, 0, sizeof (payload));
1010         req.emr_cmd = MC_CMD_NVRAM_TEST;
1011         req.emr_in_buf = payload;
1012         req.emr_in_length = MC_CMD_NVRAM_TEST_IN_LEN;
1013         req.emr_out_buf = payload;
1014         req.emr_out_length = MC_CMD_NVRAM_TEST_OUT_LEN;
1015
1016         MCDI_IN_SET_DWORD(req, NVRAM_TEST_IN_TYPE, partn);
1017
1018         efx_mcdi_execute(enp, &req);
1019
1020         if (req.emr_rc != 0) {
1021                 rc = req.emr_rc;
1022                 goto fail1;
1023         }
1024
1025         if (req.emr_out_length_used < MC_CMD_NVRAM_TEST_OUT_LEN) {
1026                 rc = EMSGSIZE;
1027                 goto fail2;
1028         }
1029
1030         result = MCDI_OUT_DWORD(req, NVRAM_TEST_OUT_RESULT);
1031         if (result == MC_CMD_NVRAM_TEST_FAIL) {
1032
1033                 EFSYS_PROBE1(nvram_test_failure, int, partn);
1034
1035                 rc = (EINVAL);
1036                 goto fail3;
1037         }
1038
1039         return (0);
1040
1041 fail3:
1042         EFSYS_PROBE(fail3);
1043 fail2:
1044         EFSYS_PROBE(fail2);
1045 fail1:
1046         EFSYS_PROBE1(fail1, efx_rc_t, rc);
1047
1048         return (rc);
1049 }
1050
1051 #endif  /* EFSYS_OPT_DIAG */
1052
1053
1054 #endif /* EFSYS_OPT_NVRAM || EFSYS_OPT_VPD */