net/ice/base: preserve NVM capabilities in safe mode
[dpdk.git] / drivers / net / ice / base / ice_nvm.c
index 1c7050c..5df0713 100644 (file)
@@ -1,5 +1,5 @@
 /* SPDX-License-Identifier: BSD-3-Clause
- * Copyright(c) 2001-2019
+ * Copyright(c) 2001-2020 Intel Corporation
  */
 
 #include "ice_common.h"
@@ -17,7 +17,7 @@
  *
  * Read the NVM using the admin queue commands (0x0701)
  */
-static enum ice_status
+enum ice_status
 ice_aq_read_nvm(struct ice_hw *hw, u16 module_typeid, u32 offset, u16 length,
                void *data, bool last_command, bool read_shadow_ram,
                struct ice_sq_cd *cd)
@@ -58,7 +58,7 @@ ice_aq_read_nvm(struct ice_hw *hw, u16 module_typeid, u32 offset, u16 length,
  *
  * Reads a portion of the NVM, as a flat memory space. This function correctly
  * breaks read requests across Shadow RAM sectors and ensures that no single
- * read request exceeds the maximum 4Kb read for a single AdminQ command.
+ * read request exceeds the maximum 4KB read for a single AdminQ command.
  *
  * Returns a status code on failure. Note that the data pointer may be
  * partially updated if some reads succeed before a failure.
@@ -78,18 +78,17 @@ ice_read_flat_nvm(struct ice_hw *hw, u32 offset, u32 *length, u8 *data,
 
        /* Verify the length of the read if this is for the Shadow RAM */
        if (read_shadow_ram && ((offset + inlen) > (hw->nvm.sr_words * 2u))) {
-               ice_debug(hw, ICE_DBG_NVM,
-                         "NVM error: requested data is beyond Shadow RAM limit\n");
+               ice_debug(hw, ICE_DBG_NVM, "NVM error: requested data is beyond Shadow RAM limit\n");
                return ICE_ERR_PARAM;
        }
 
        do {
                u32 read_size, sector_offset;
 
-               /* ice_aq_read_nvm cannot read more than 4Kb at a time.
+               /* ice_aq_read_nvm cannot read more than 4KB at a time.
                 * Additionally, a read from the Shadow RAM may not cross over
                 * a sector boundary. Conveniently, the sector size is also
-                * 4Kb.
+                * 4KB.
                 */
                sector_offset = offset % ICE_AQ_MAX_BUF_LEN;
                read_size = MIN_T(u32, ICE_AQ_MAX_BUF_LEN - sector_offset,
@@ -138,7 +137,7 @@ ice_read_sr_word_aq(struct ice_hw *hw, u16 offset, u16 *data)
         * boundary
         */
        status = ice_read_flat_nvm(hw, offset * sizeof(u16), &bytes,
-                                  (u8 *)&data_local, true);
+                                  (_FORCE_ u8 *)&data_local, true);
        if (status)
                return status;
 
@@ -164,7 +163,7 @@ ice_read_sr_buf_aq(struct ice_hw *hw, u16 offset, u16 *words, u16 *data)
 
        ice_debug(hw, ICE_DBG_TRACE, "%s\n", __func__);
 
-       /* ice_read_flat_nvm takes into account the 4Kb AdminQ and Shadow RAM
+       /* ice_read_flat_nvm takes into account the 4KB AdminQ and Shadow RAM
         * sector restrictions necessary when reading from the NVM.
         */
        status = ice_read_flat_nvm(hw, offset * 2, &bytes, (u8 *)data, true);
@@ -186,7 +185,7 @@ ice_read_sr_buf_aq(struct ice_hw *hw, u16 offset, u16 *words, u16 *data)
  *
  * This function will request NVM ownership.
  */
-static enum ice_status
+enum ice_status
 ice_acquire_nvm(struct ice_hw *hw, enum ice_aq_res_access_type access)
 {
        ice_debug(hw, ICE_DBG_TRACE, "%s\n", __func__);
@@ -203,7 +202,7 @@ ice_acquire_nvm(struct ice_hw *hw, enum ice_aq_res_access_type access)
  *
  * This function will release NVM ownership.
  */
-static void ice_release_nvm(struct ice_hw *hw)
+void ice_release_nvm(struct ice_hw *hw)
 {
        ice_debug(hw, ICE_DBG_TRACE, "%s\n", __func__);
 
@@ -234,6 +233,131 @@ enum ice_status ice_read_sr_word(struct ice_hw *hw, u16 offset, u16 *data)
        return status;
 }
 
+/**
+ * ice_get_pfa_module_tlv - Reads sub module TLV from NVM PFA
+ * @hw: pointer to hardware structure
+ * @module_tlv: pointer to module TLV to return
+ * @module_tlv_len: pointer to module TLV length to return
+ * @module_type: module type requested
+ *
+ * Finds the requested sub module TLV type from the Preserved Field
+ * Area (PFA) and returns the TLV pointer and length. The caller can
+ * use these to read the variable length TLV value.
+ */
+enum ice_status
+ice_get_pfa_module_tlv(struct ice_hw *hw, u16 *module_tlv, u16 *module_tlv_len,
+                      u16 module_type)
+{
+       enum ice_status status;
+       u16 pfa_len, pfa_ptr;
+       u16 next_tlv;
+
+       status = ice_read_sr_word(hw, ICE_SR_PFA_PTR, &pfa_ptr);
+       if (status != ICE_SUCCESS) {
+               ice_debug(hw, ICE_DBG_INIT, "Preserved Field Array pointer.\n");
+               return status;
+       }
+       status = ice_read_sr_word(hw, pfa_ptr, &pfa_len);
+       if (status != ICE_SUCCESS) {
+               ice_debug(hw, ICE_DBG_INIT, "Failed to read PFA length.\n");
+               return status;
+       }
+       /* Starting with first TLV after PFA length, iterate through the list
+        * of TLVs to find the requested one.
+        */
+       next_tlv = pfa_ptr + 1;
+       while (next_tlv < pfa_ptr + pfa_len) {
+               u16 tlv_sub_module_type;
+               u16 tlv_len;
+
+               /* Read TLV type */
+               status = ice_read_sr_word(hw, next_tlv, &tlv_sub_module_type);
+               if (status != ICE_SUCCESS) {
+                       ice_debug(hw, ICE_DBG_INIT, "Failed to read TLV type.\n");
+                       break;
+               }
+               /* Read TLV length */
+               status = ice_read_sr_word(hw, next_tlv + 1, &tlv_len);
+               if (status != ICE_SUCCESS) {
+                       ice_debug(hw, ICE_DBG_INIT, "Failed to read TLV length.\n");
+                       break;
+               }
+               if (tlv_sub_module_type == module_type) {
+                       if (tlv_len) {
+                               *module_tlv = next_tlv;
+                               *module_tlv_len = tlv_len;
+                               return ICE_SUCCESS;
+                       }
+                       return ICE_ERR_INVAL_SIZE;
+               }
+               /* Check next TLV, i.e. current TLV pointer + length + 2 words
+                * (for current TLV's type and length)
+                */
+               next_tlv = next_tlv + tlv_len + 2;
+       }
+       /* Module does not exist */
+       return ICE_ERR_DOES_NOT_EXIST;
+}
+
+/**
+ * ice_read_pba_string - Reads part number string from NVM
+ * @hw: pointer to hardware structure
+ * @pba_num: stores the part number string from the NVM
+ * @pba_num_size: part number string buffer length
+ *
+ * Reads the part number string from the NVM.
+ */
+enum ice_status
+ice_read_pba_string(struct ice_hw *hw, u8 *pba_num, u32 pba_num_size)
+{
+       u16 pba_tlv, pba_tlv_len;
+       enum ice_status status;
+       u16 pba_word, pba_size;
+       u16 i;
+
+       status = ice_get_pfa_module_tlv(hw, &pba_tlv, &pba_tlv_len,
+                                       ICE_SR_PBA_BLOCK_PTR);
+       if (status != ICE_SUCCESS) {
+               ice_debug(hw, ICE_DBG_INIT, "Failed to read PBA Block TLV.\n");
+               return status;
+       }
+
+       /* pba_size is the next word */
+       status = ice_read_sr_word(hw, (pba_tlv + 2), &pba_size);
+       if (status != ICE_SUCCESS) {
+               ice_debug(hw, ICE_DBG_INIT, "Failed to read PBA Section size.\n");
+               return status;
+       }
+
+       if (pba_tlv_len < pba_size) {
+               ice_debug(hw, ICE_DBG_INIT, "Invalid PBA Block TLV size.\n");
+               return ICE_ERR_INVAL_SIZE;
+       }
+
+       /* Subtract one to get PBA word count (PBA Size word is included in
+        * total size)
+        */
+       pba_size--;
+       if (pba_num_size < (((u32)pba_size * 2) + 1)) {
+               ice_debug(hw, ICE_DBG_INIT, "Buffer too small for PBA data.\n");
+               return ICE_ERR_PARAM;
+       }
+
+       for (i = 0; i < pba_size; i++) {
+               status = ice_read_sr_word(hw, (pba_tlv + 2 + 1) + i, &pba_word);
+               if (status != ICE_SUCCESS) {
+                       ice_debug(hw, ICE_DBG_INIT, "Failed to read PBA Block word %d.\n", i);
+                       return status;
+               }
+
+               pba_num[(i * 2)] = (pba_word >> 8) & 0xFF;
+               pba_num[(i * 2) + 1] = pba_word & 0xFF;
+       }
+       pba_num[(pba_size * 2)] = '\0';
+
+       return status;
+}
+
 /**
  * ice_get_orom_ver_info - Read Option ROM version information
  * @hw: pointer to the HW struct
@@ -251,8 +375,7 @@ static enum ice_status ice_get_orom_ver_info(struct ice_hw *hw)
        status = ice_get_pfa_module_tlv(hw, &boot_cfg_tlv, &boot_cfg_tlv_len,
                                        ICE_SR_BOOT_CFG_PTR);
        if (status) {
-               ice_debug(hw, ICE_DBG_INIT,
-                         "Failed to read Boot Configuration Block TLV.\n");
+               ice_debug(hw, ICE_DBG_INIT, "Failed to read Boot Configuration Block TLV.\n");
                return status;
        }
 
@@ -260,8 +383,7 @@ static enum ice_status ice_get_orom_ver_info(struct ice_hw *hw)
         * (Combo Image Version High and Combo Image Version Low)
         */
        if (boot_cfg_tlv_len < 2) {
-               ice_debug(hw, ICE_DBG_INIT,
-                         "Invalid Boot Configuration Block TLV size.\n");
+               ice_debug(hw, ICE_DBG_INIT, "Invalid Boot Configuration Block TLV size.\n");
                return ICE_ERR_INVAL_SIZE;
        }
 
@@ -290,6 +412,57 @@ static enum ice_status ice_get_orom_ver_info(struct ice_hw *hw)
        return ICE_SUCCESS;
 }
 
+/**
+ * ice_discover_flash_size - Discover the available flash size.
+ * @hw: pointer to the HW struct
+ *
+ * The device flash could be up to 16MB in size. However, it is possible that
+ * the actual size is smaller. Use bisection to determine the accessible size
+ * of flash memory.
+ */
+static enum ice_status ice_discover_flash_size(struct ice_hw *hw)
+{
+       u32 min_size = 0, max_size = ICE_AQC_NVM_MAX_OFFSET + 1;
+       enum ice_status status;
+
+       ice_debug(hw, ICE_DBG_TRACE, "%s\n", __func__);
+
+       status = ice_acquire_nvm(hw, ICE_RES_READ);
+       if (status)
+               return status;
+
+       while ((max_size - min_size) > 1) {
+               u32 offset = (max_size + min_size) / 2;
+               u32 len = 1;
+               u8 data;
+
+               status = ice_read_flat_nvm(hw, offset, &len, &data, false);
+               if (status == ICE_ERR_AQ_ERROR &&
+                   hw->adminq.sq_last_status == ICE_AQ_RC_EINVAL) {
+                       ice_debug(hw, ICE_DBG_NVM, "%s: New upper bound of %u bytes\n",
+                                 __func__, offset);
+                       status = ICE_SUCCESS;
+                       max_size = offset;
+               } else if (!status) {
+                       ice_debug(hw, ICE_DBG_NVM, "%s: New lower bound of %u bytes\n",
+                                 __func__, offset);
+                       min_size = offset;
+               } else {
+                       /* an unexpected error occurred */
+                       goto err_read_flat_nvm;
+               }
+       }
+
+       ice_debug(hw, ICE_DBG_NVM, "Predicted flash size is %u bytes\n", max_size);
+
+       hw->nvm.flash_size = max_size;
+
+err_read_flat_nvm:
+       ice_release_nvm(hw);
+
+       return status;
+}
+
 /**
  * ice_init_nvm - initializes NVM setting
  * @hw: pointer to the HW struct
@@ -323,8 +496,7 @@ enum ice_status ice_init_nvm(struct ice_hw *hw)
        } else {
                /* Blank programming mode */
                nvm->blank_nvm_mode = true;
-               ice_debug(hw, ICE_DBG_NVM,
-                         "NVM init error: unsupported blank mode.\n");
+               ice_debug(hw, ICE_DBG_NVM, "NVM init error: unsupported blank mode.\n");
                return ICE_ERR_NVM_BLANK_MODE;
        }
 
@@ -350,6 +522,13 @@ enum ice_status ice_init_nvm(struct ice_hw *hw)
 
        nvm->eetrack = (eetrack_hi << 16) | eetrack_lo;
 
+       status = ice_discover_flash_size(hw);
+       if (status) {
+               ice_debug(hw, ICE_DBG_NVM,
+                         "NVM init error: failed to discover flash size.\n");
+               return status;
+       }
+
        switch (hw->device_id) {
        /* the following devices do not have boot_cfg_tlv yet */
        case ICE_DEV_ID_E822C_BACKPLANE:
@@ -361,6 +540,11 @@ enum ice_status ice_init_nvm(struct ice_hw *hw)
        case ICE_DEV_ID_E822L_SFP:
        case ICE_DEV_ID_E822L_10G_BASE_T:
        case ICE_DEV_ID_E822L_SGMII:
+       case ICE_DEV_ID_E823L_BACKPLANE:
+       case ICE_DEV_ID_E823L_SFP:
+       case ICE_DEV_ID_E823L_10G_BASE_T:
+       case ICE_DEV_ID_E823L_1GBE:
+       case ICE_DEV_ID_E823L_QSFP:
                return status;
        default:
                break;
@@ -445,7 +629,7 @@ ice_nvm_access_get_features(struct ice_nvm_access_cmd *cmd,
 {
        /* The provided data_size must be at least as large as our NVM
         * features structure. A larger size should not be treated as an
-        * error, to allow future extensions to to the features structure to
+        * error, to allow future extensions to the features structure to
         * work on older drivers.
         */
        if (cmd->data_size < sizeof(struct ice_nvm_features))
@@ -612,8 +796,7 @@ ice_nvm_access_write(struct ice_hw *hw, struct ice_nvm_access_cmd *cmd,
                break;
        }
 
-       ice_debug(hw, ICE_DBG_NVM,
-                 "NVM access: writing register %08x with value %08x\n",
+       ice_debug(hw, ICE_DBG_NVM, "NVM access: writing register %08x with value %08x\n",
                  cmd->offset, data->regval);
 
        /* Write the data field to the specified register */