New upstream version 18.02
[deb_dpdk.git] / drivers / net / sfc / base / ef10_nvram.c
index 3f9d375..1904597 100644 (file)
@@ -1,31 +1,7 @@
-/*
- * Copyright (c) 2012-2016 Solarflare Communications Inc.
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * 1. Redistributions of source code must retain the above copyright notice,
- *    this list of conditions and the following disclaimer.
- * 2. Redistributions in binary form must reproduce the above copyright notice,
- *    this list of conditions and the following disclaimer in the documentation
- *    and/or other materials provided with the distribution.
+/* SPDX-License-Identifier: BSD-3-Clause
  *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
- * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
- * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
- * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
- * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
- * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
- * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
- * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
- * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
- * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- *
- * The views and conclusions contained in the software and documentation are
- * those of the authors and should not be interpreted as representing official
- * policies, either expressed or implied, of the FreeBSD Project.
+ * Copyright (c) 2012-2018 Solarflare Communications Inc.
+ * All rights reserved.
  */
 
 #include "efx.h"
@@ -672,6 +648,7 @@ ef10_nvram_buffer_validate(
        int pos;
        efx_rc_t rc;
 
+       _NOTE(ARGUNUSED(enp, partn))
        EFX_STATIC_ASSERT(sizeof (*header) <= EF10_NVRAM_CHUNK);
 
        if ((partn_data == NULL) || (partn_size == 0)) {
@@ -1282,6 +1259,8 @@ ef10_nvram_buf_read_tlv(
        caddr_t value;
        efx_rc_t rc;
 
+       _NOTE(ARGUNUSED(enp))
+
        if ((seg_data == NULL) || (max_seg_size == 0)) {
                rc = EINVAL;
                goto fail1;
@@ -1937,13 +1916,36 @@ ef10_nvram_partn_read(
        __in                    size_t size)
 {
        /*
-        * Read requests which come in through the EFX API expect to
-        * read the current, active partition.
+        * An A/B partition has two data stores (current and backup).
+        * Read requests which come in through the EFX API expect to read the
+        * current, active store of an A/B partition. For non A/B partitions,
+        * there is only a single store and so the mode param is ignored.
         */
        return ef10_nvram_partn_read_mode(enp, partn, offset, data, size,
                            MC_CMD_NVRAM_READ_IN_V2_TARGET_CURRENT);
 }
 
+       __checkReturn           efx_rc_t
+ef10_nvram_partn_read_backup(
+       __in                    efx_nic_t *enp,
+       __in                    uint32_t partn,
+       __in                    unsigned int offset,
+       __out_bcount(size)      caddr_t data,
+       __in                    size_t size)
+{
+       /*
+        * An A/B partition has two data stores (current and backup).
+        * Read the backup store of an A/B partition (i.e. the store currently
+        * being written to if the partition is locked).
+        *
+        * This is needed when comparing the existing partition content to avoid
+        * unnecessary writes, or to read back what has been written to check
+        * that the writes have succeeded.
+        */
+       return ef10_nvram_partn_read_mode(enp, partn, offset, data, size,
+                           MC_CMD_NVRAM_READ_IN_V2_TARGET_BACKUP);
+}
+
        __checkReturn           efx_rc_t
 ef10_nvram_partn_erase(
        __in                    efx_nic_t *enp,
@@ -2047,15 +2049,15 @@ fail1:
 ef10_nvram_partn_unlock(
        __in                    efx_nic_t *enp,
        __in                    uint32_t partn,
-       __out_opt               uint32_t *resultp)
+       __out_opt               uint32_t *verify_resultp)
 {
        boolean_t reboot = B_FALSE;
        efx_rc_t rc;
 
-       if (resultp != NULL)
-               *resultp = MC_CMD_NVRAM_VERIFY_RC_UNKNOWN;
+       if (verify_resultp != NULL)
+               *verify_resultp = MC_CMD_NVRAM_VERIFY_RC_UNKNOWN;
 
-       rc = efx_mcdi_nvram_update_finish(enp, partn, reboot, resultp);
+       rc = efx_mcdi_nvram_update_finish(enp, partn, reboot, verify_resultp);
        if (rc != 0)
                goto fail1;
 
@@ -2106,83 +2108,48 @@ fail1:
 
 typedef struct ef10_parttbl_entry_s {
        unsigned int            partn;
-       unsigned int            port;
+       unsigned int            port_mask;
        efx_nvram_type_t        nvtype;
 } ef10_parttbl_entry_t;
 
+/* Port mask values */
+#define        PORT_1          (1u << 1)
+#define        PORT_2          (1u << 2)
+#define        PORT_3          (1u << 3)
+#define        PORT_4          (1u << 4)
+#define        PORT_ALL        (0xffffffffu)
+
+#define        PARTN_MAP_ENTRY(partn, port_mask, nvtype)       \
+{ (NVRAM_PARTITION_TYPE_##partn), (PORT_##port_mask), (EFX_NVRAM_##nvtype) }
+
 /* Translate EFX NVRAM types to firmware partition types */
 static ef10_parttbl_entry_t hunt_parttbl[] = {
-       {NVRAM_PARTITION_TYPE_MC_FIRMWARE,         1, EFX_NVRAM_MC_FIRMWARE},
-       {NVRAM_PARTITION_TYPE_MC_FIRMWARE,         2, EFX_NVRAM_MC_FIRMWARE},
-       {NVRAM_PARTITION_TYPE_MC_FIRMWARE,         3, EFX_NVRAM_MC_FIRMWARE},
-       {NVRAM_PARTITION_TYPE_MC_FIRMWARE,         4, EFX_NVRAM_MC_FIRMWARE},
-       {NVRAM_PARTITION_TYPE_MC_FIRMWARE_BACKUP,  1, EFX_NVRAM_MC_GOLDEN},
-       {NVRAM_PARTITION_TYPE_MC_FIRMWARE_BACKUP,  2, EFX_NVRAM_MC_GOLDEN},
-       {NVRAM_PARTITION_TYPE_MC_FIRMWARE_BACKUP,  3, EFX_NVRAM_MC_GOLDEN},
-       {NVRAM_PARTITION_TYPE_MC_FIRMWARE_BACKUP,  4, EFX_NVRAM_MC_GOLDEN},
-       {NVRAM_PARTITION_TYPE_EXPANSION_ROM,       1, EFX_NVRAM_BOOTROM},
-       {NVRAM_PARTITION_TYPE_EXPANSION_ROM,       2, EFX_NVRAM_BOOTROM},
-       {NVRAM_PARTITION_TYPE_EXPANSION_ROM,       3, EFX_NVRAM_BOOTROM},
-       {NVRAM_PARTITION_TYPE_EXPANSION_ROM,       4, EFX_NVRAM_BOOTROM},
-       {NVRAM_PARTITION_TYPE_EXPROM_CONFIG_PORT0, 1, EFX_NVRAM_BOOTROM_CFG},
-       {NVRAM_PARTITION_TYPE_EXPROM_CONFIG_PORT1, 2, EFX_NVRAM_BOOTROM_CFG},
-       {NVRAM_PARTITION_TYPE_EXPROM_CONFIG_PORT2, 3, EFX_NVRAM_BOOTROM_CFG},
-       {NVRAM_PARTITION_TYPE_EXPROM_CONFIG_PORT3, 4, EFX_NVRAM_BOOTROM_CFG},
-       {NVRAM_PARTITION_TYPE_DYNAMIC_CONFIG,      1, EFX_NVRAM_DYNAMIC_CFG},
-       {NVRAM_PARTITION_TYPE_DYNAMIC_CONFIG,      2, EFX_NVRAM_DYNAMIC_CFG},
-       {NVRAM_PARTITION_TYPE_DYNAMIC_CONFIG,      3, EFX_NVRAM_DYNAMIC_CFG},
-       {NVRAM_PARTITION_TYPE_DYNAMIC_CONFIG,      4, EFX_NVRAM_DYNAMIC_CFG},
-       {NVRAM_PARTITION_TYPE_FPGA,                1, EFX_NVRAM_FPGA},
-       {NVRAM_PARTITION_TYPE_FPGA,                2, EFX_NVRAM_FPGA},
-       {NVRAM_PARTITION_TYPE_FPGA,                3, EFX_NVRAM_FPGA},
-       {NVRAM_PARTITION_TYPE_FPGA,                4, EFX_NVRAM_FPGA},
-       {NVRAM_PARTITION_TYPE_FPGA_BACKUP,         1, EFX_NVRAM_FPGA_BACKUP},
-       {NVRAM_PARTITION_TYPE_FPGA_BACKUP,         2, EFX_NVRAM_FPGA_BACKUP},
-       {NVRAM_PARTITION_TYPE_FPGA_BACKUP,         3, EFX_NVRAM_FPGA_BACKUP},
-       {NVRAM_PARTITION_TYPE_FPGA_BACKUP,         4, EFX_NVRAM_FPGA_BACKUP},
-       {NVRAM_PARTITION_TYPE_LICENSE,             1, EFX_NVRAM_LICENSE},
-       {NVRAM_PARTITION_TYPE_LICENSE,             2, EFX_NVRAM_LICENSE},
-       {NVRAM_PARTITION_TYPE_LICENSE,             3, EFX_NVRAM_LICENSE},
-       {NVRAM_PARTITION_TYPE_LICENSE,             4, EFX_NVRAM_LICENSE}
+       /*              partn                   ports   nvtype */
+       PARTN_MAP_ENTRY(MC_FIRMWARE,            ALL,    MC_FIRMWARE),
+       PARTN_MAP_ENTRY(MC_FIRMWARE_BACKUP,     ALL,    MC_GOLDEN),
+       PARTN_MAP_ENTRY(EXPANSION_ROM,          ALL,    BOOTROM),
+       PARTN_MAP_ENTRY(EXPROM_CONFIG_PORT0,    1,      BOOTROM_CFG),
+       PARTN_MAP_ENTRY(EXPROM_CONFIG_PORT1,    2,      BOOTROM_CFG),
+       PARTN_MAP_ENTRY(EXPROM_CONFIG_PORT2,    3,      BOOTROM_CFG),
+       PARTN_MAP_ENTRY(EXPROM_CONFIG_PORT3,    4,      BOOTROM_CFG),
+       PARTN_MAP_ENTRY(DYNAMIC_CONFIG,         ALL,    DYNAMIC_CFG),
+       PARTN_MAP_ENTRY(FPGA,                   ALL,    FPGA),
+       PARTN_MAP_ENTRY(FPGA_BACKUP,            ALL,    FPGA_BACKUP),
+       PARTN_MAP_ENTRY(LICENSE,                ALL,    LICENSE),
 };
 
 static ef10_parttbl_entry_t medford_parttbl[] = {
-       {NVRAM_PARTITION_TYPE_MC_FIRMWARE,         1, EFX_NVRAM_MC_FIRMWARE},
-       {NVRAM_PARTITION_TYPE_MC_FIRMWARE,         2, EFX_NVRAM_MC_FIRMWARE},
-       {NVRAM_PARTITION_TYPE_MC_FIRMWARE,         3, EFX_NVRAM_MC_FIRMWARE},
-       {NVRAM_PARTITION_TYPE_MC_FIRMWARE,         4, EFX_NVRAM_MC_FIRMWARE},
-       {NVRAM_PARTITION_TYPE_MC_FIRMWARE_BACKUP,  1, EFX_NVRAM_MC_GOLDEN},
-       {NVRAM_PARTITION_TYPE_MC_FIRMWARE_BACKUP,  2, EFX_NVRAM_MC_GOLDEN},
-       {NVRAM_PARTITION_TYPE_MC_FIRMWARE_BACKUP,  3, EFX_NVRAM_MC_GOLDEN},
-       {NVRAM_PARTITION_TYPE_MC_FIRMWARE_BACKUP,  4, EFX_NVRAM_MC_GOLDEN},
-       {NVRAM_PARTITION_TYPE_EXPANSION_ROM,       1, EFX_NVRAM_BOOTROM},
-       {NVRAM_PARTITION_TYPE_EXPANSION_ROM,       2, EFX_NVRAM_BOOTROM},
-       {NVRAM_PARTITION_TYPE_EXPANSION_ROM,       3, EFX_NVRAM_BOOTROM},
-       {NVRAM_PARTITION_TYPE_EXPANSION_ROM,       4, EFX_NVRAM_BOOTROM},
-       {NVRAM_PARTITION_TYPE_EXPROM_CONFIG_PORT0, 1, EFX_NVRAM_BOOTROM_CFG},
-       {NVRAM_PARTITION_TYPE_EXPROM_CONFIG_PORT0, 2, EFX_NVRAM_BOOTROM_CFG},
-       {NVRAM_PARTITION_TYPE_EXPROM_CONFIG_PORT0, 3, EFX_NVRAM_BOOTROM_CFG},
-       {NVRAM_PARTITION_TYPE_EXPROM_CONFIG_PORT0, 4, EFX_NVRAM_BOOTROM_CFG},
-       {NVRAM_PARTITION_TYPE_DYNAMIC_CONFIG,      1, EFX_NVRAM_DYNAMIC_CFG},
-       {NVRAM_PARTITION_TYPE_DYNAMIC_CONFIG,      2, EFX_NVRAM_DYNAMIC_CFG},
-       {NVRAM_PARTITION_TYPE_DYNAMIC_CONFIG,      3, EFX_NVRAM_DYNAMIC_CFG},
-       {NVRAM_PARTITION_TYPE_DYNAMIC_CONFIG,      4, EFX_NVRAM_DYNAMIC_CFG},
-       {NVRAM_PARTITION_TYPE_FPGA,                1, EFX_NVRAM_FPGA},
-       {NVRAM_PARTITION_TYPE_FPGA,                2, EFX_NVRAM_FPGA},
-       {NVRAM_PARTITION_TYPE_FPGA,                3, EFX_NVRAM_FPGA},
-       {NVRAM_PARTITION_TYPE_FPGA,                4, EFX_NVRAM_FPGA},
-       {NVRAM_PARTITION_TYPE_FPGA_BACKUP,         1, EFX_NVRAM_FPGA_BACKUP},
-       {NVRAM_PARTITION_TYPE_FPGA_BACKUP,         2, EFX_NVRAM_FPGA_BACKUP},
-       {NVRAM_PARTITION_TYPE_FPGA_BACKUP,         3, EFX_NVRAM_FPGA_BACKUP},
-       {NVRAM_PARTITION_TYPE_FPGA_BACKUP,         4, EFX_NVRAM_FPGA_BACKUP},
-       {NVRAM_PARTITION_TYPE_LICENSE,             1, EFX_NVRAM_LICENSE},
-       {NVRAM_PARTITION_TYPE_LICENSE,             2, EFX_NVRAM_LICENSE},
-       {NVRAM_PARTITION_TYPE_LICENSE,             3, EFX_NVRAM_LICENSE},
-       {NVRAM_PARTITION_TYPE_LICENSE,             4, EFX_NVRAM_LICENSE},
-       {NVRAM_PARTITION_TYPE_EXPANSION_UEFI,      1, EFX_NVRAM_UEFIROM},
-       {NVRAM_PARTITION_TYPE_EXPANSION_UEFI,      2, EFX_NVRAM_UEFIROM},
-       {NVRAM_PARTITION_TYPE_EXPANSION_UEFI,      3, EFX_NVRAM_UEFIROM},
-       {NVRAM_PARTITION_TYPE_EXPANSION_UEFI,      4, EFX_NVRAM_UEFIROM}
+       /*              partn                   ports   nvtype */
+       PARTN_MAP_ENTRY(MC_FIRMWARE,            ALL,    MC_FIRMWARE),
+       PARTN_MAP_ENTRY(MC_FIRMWARE_BACKUP,     ALL,    MC_GOLDEN),
+       PARTN_MAP_ENTRY(EXPANSION_ROM,          ALL,    BOOTROM),
+       PARTN_MAP_ENTRY(EXPROM_CONFIG,          ALL,    BOOTROM_CFG),
+       PARTN_MAP_ENTRY(DYNAMIC_CONFIG,         ALL,    DYNAMIC_CFG),
+       PARTN_MAP_ENTRY(FPGA,                   ALL,    FPGA),
+       PARTN_MAP_ENTRY(FPGA_BACKUP,            ALL,    FPGA_BACKUP),
+       PARTN_MAP_ENTRY(LICENSE,                ALL,    LICENSE),
+       PARTN_MAP_ENTRY(EXPANSION_UEFI,         ALL,    UEFIROM),
+       PARTN_MAP_ENTRY(MUM_FIRMWARE,           ALL,    MUM_FIRMWARE),
 };
 
 static __checkReturn           efx_rc_t
@@ -2220,6 +2187,7 @@ ef10_nvram_type_to_partn(
        size_t parttbl_rows = 0;
        unsigned int i;
 
+       EFSYS_ASSERT3U(type, !=, EFX_NVRAM_INVALID);
        EFSYS_ASSERT3U(type, <, EFX_NVRAM_NTYPES);
        EFSYS_ASSERT(partnp != NULL);
 
@@ -2227,8 +2195,8 @@ ef10_nvram_type_to_partn(
                for (i = 0; i < parttbl_rows; i++) {
                        ef10_parttbl_entry_t *entry = &parttbl[i];
 
-                       if (entry->nvtype == type &&
-                           entry->port == emip->emi_port) {
+                       if ((entry->nvtype == type) &&
+                           (entry->port_mask & (1u << emip->emi_port))) {
                                *partnp = entry->partn;
                                return (0);
                        }
@@ -2257,8 +2225,8 @@ ef10_nvram_partn_to_type(
                for (i = 0; i < parttbl_rows; i++) {
                        ef10_parttbl_entry_t *entry = &parttbl[i];
 
-                       if (entry->partn == partn &&
-                           entry->port == emip->emi_port) {
+                       if ((entry->partn == partn) &&
+                           (entry->port_mask & (1u << emip->emi_port))) {
                                *typep = entry->nvtype;
                                return (0);
                        }
@@ -2346,16 +2314,27 @@ ef10_nvram_partn_rw_start(
        __in                    uint32_t partn,
        __out                   size_t *chunk_sizep)
 {
+       uint32_t write_size = 0;
        efx_rc_t rc;
 
-       if ((rc = ef10_nvram_partn_lock(enp, partn)) != 0)
+       if ((rc = efx_mcdi_nvram_info(enp, partn, NULL, NULL,
+           NULL, &write_size)) != 0)
                goto fail1;
 
-       if (chunk_sizep != NULL)
-               *chunk_sizep = EF10_NVRAM_CHUNK;
+       if ((rc = ef10_nvram_partn_lock(enp, partn)) != 0)
+               goto fail2;
+
+       if (chunk_sizep != NULL) {
+               if (write_size == 0)
+                       *chunk_sizep = EF10_NVRAM_CHUNK;
+               else
+                       *chunk_sizep = write_size;
+       }
 
        return (0);
 
+fail2:
+       EFSYS_PROBE(fail2);
 fail1:
        EFSYS_PROBE1(fail1, efx_rc_t, rc);
 
@@ -2365,11 +2344,12 @@ fail1:
        __checkReturn           efx_rc_t
 ef10_nvram_partn_rw_finish(
        __in                    efx_nic_t *enp,
-       __in                    uint32_t partn)
+       __in                    uint32_t partn,
+       __out_opt               uint32_t *verify_resultp)
 {
        efx_rc_t rc;
 
-       if ((rc = ef10_nvram_partn_unlock(enp, partn, NULL)) != 0)
+       if ((rc = ef10_nvram_partn_unlock(enp, partn, verify_resultp)) != 0)
                goto fail1;
 
        return (0);