net/ice: support new devices
[dpdk.git] / drivers / net / ice / base / ice_nvm.c
index d5e6215..61af767 100644 (file)
@@ -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.
@@ -77,19 +77,18 @@ ice_read_flat_nvm(struct ice_hw *hw, u32 offset, u32 *length, u8 *data,
        *length = 0;
 
        /* 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");
+       if (read_shadow_ram && ((offset + inlen) > (hw->flash.sr_words * 2u))) {
+               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,12 +185,12 @@ 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__);
 
-       if (hw->nvm.blank_nvm_mode)
+       if (hw->flash.blank_nvm_mode)
                return ICE_SUCCESS;
 
        return ice_acquire_res(hw, ICE_NVM_RES_ID, access, ICE_NVM_TIMEOUT);
@@ -203,11 +202,11 @@ 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__);
 
-       if (hw->nvm.blank_nvm_mode)
+       if (hw->flash.blank_nvm_mode)
                return;
 
        ice_release_res(hw, ICE_NVM_RES_ID);
@@ -300,25 +299,122 @@ ice_get_pfa_module_tlv(struct ice_hw *hw, u16 *module_tlv, u16 *module_tlv_len,
        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_nvm_ver_info - Read NVM version information
+ * @hw: pointer to the HW struct
+ * @nvm: pointer to NVM info structure
+ *
+ * Read the NVM EETRACK ID and map version of the main NVM image bank, filling
+ * in the nvm info structure.
+ */
+static enum ice_status
+ice_get_nvm_ver_info(struct ice_hw *hw, struct ice_nvm_info *nvm)
+{
+       u16 eetrack_lo, eetrack_hi, ver;
+       enum ice_status status;
+
+       status = ice_read_sr_word(hw, ICE_SR_NVM_DEV_STARTER_VER, &ver);
+       if (status) {
+               ice_debug(hw, ICE_DBG_NVM, "Failed to read DEV starter version.\n");
+               return status;
+       }
+       nvm->major = (ver & ICE_NVM_VER_HI_MASK) >> ICE_NVM_VER_HI_SHIFT;
+       nvm->minor = (ver & ICE_NVM_VER_LO_MASK) >> ICE_NVM_VER_LO_SHIFT;
+
+       status = ice_read_sr_word(hw, ICE_SR_NVM_EETRACK_LO, &eetrack_lo);
+       if (status) {
+               ice_debug(hw, ICE_DBG_NVM, "Failed to read EETRACK lo.\n");
+               return status;
+       }
+       status = ice_read_sr_word(hw, ICE_SR_NVM_EETRACK_HI, &eetrack_hi);
+       if (status) {
+               ice_debug(hw, ICE_DBG_NVM, "Failed to read EETRACK hi.\n");
+               return status;
+       }
+
+       nvm->eetrack = (eetrack_hi << 16) | eetrack_lo;
+
+       return ICE_SUCCESS;
+}
+
 /**
  * ice_get_orom_ver_info - Read Option ROM version information
  * @hw: pointer to the HW struct
+ * @orom: pointer to Option ROM info structure
  *
  * Read the Combo Image version data from the Boot Configuration TLV and fill
  * in the option ROM version data.
  */
-static enum ice_status ice_get_orom_ver_info(struct ice_hw *hw)
+static enum ice_status
+ice_get_orom_ver_info(struct ice_hw *hw, struct ice_orom_info *orom)
 {
        u16 combo_hi, combo_lo, boot_cfg_tlv, boot_cfg_tlv_len;
-       struct ice_orom_info *orom = &hw->nvm.orom;
        enum ice_status status;
        u32 combo_ver;
 
        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;
        }
 
@@ -326,8 +422,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;
        }
 
@@ -383,14 +478,12 @@ static enum ice_status ice_discover_flash_size(struct ice_hw *hw)
                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",
+                       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",
+                       ice_debug(hw, ICE_DBG_NVM, "%s: New lower bound of %u bytes\n",
                                  __func__, offset);
                        min_size = offset;
                } else {
@@ -399,10 +492,9 @@ static enum ice_status ice_discover_flash_size(struct ice_hw *hw)
                }
        }
 
-       ice_debug(hw, ICE_DBG_NVM,
-                 "Predicted flash size is %u bytes\n", max_size);
+       ice_debug(hw, ICE_DBG_NVM, "Predicted flash size is %u bytes\n", max_size);
 
-       hw->nvm.flash_size = max_size;
+       hw->flash.flash_size = max_size;
 
 err_read_flat_nvm:
        ice_release_nvm(hw);
@@ -410,6 +502,151 @@ err_read_flat_nvm:
        return status;
 }
 
+/**
+ * ice_read_sr_pointer - Read the value of a Shadow RAM pointer word
+ * @hw: pointer to the HW structure
+ * @offset: the word offset of the Shadow RAM word to read
+ * @pointer: pointer value read from Shadow RAM
+ *
+ * Read the given Shadow RAM word, and convert it to a pointer value specified
+ * in bytes. This function assumes the specified offset is a valid pointer
+ * word.
+ *
+ * Each pointer word specifies whether it is stored in word size or 4KB
+ * sector size by using the highest bit. The reported pointer value will be in
+ * bytes, intended for flat NVM reads.
+ */
+static enum ice_status
+ice_read_sr_pointer(struct ice_hw *hw, u16 offset, u32 *pointer)
+{
+       enum ice_status status;
+       u16 value;
+
+       status = ice_read_sr_word(hw, offset, &value);
+       if (status)
+               return status;
+
+       /* Determine if the pointer is in 4KB or word units */
+       if (value & ICE_SR_NVM_PTR_4KB_UNITS)
+               *pointer = (value & ~ICE_SR_NVM_PTR_4KB_UNITS) * 4 * 1024;
+       else
+               *pointer = value * 2;
+
+       return ICE_SUCCESS;
+}
+
+/**
+ * ice_read_sr_area_size - Read an area size from a Shadow RAM word
+ * @hw: pointer to the HW structure
+ * @offset: the word offset of the Shadow RAM to read
+ * @size: size value read from the Shadow RAM
+ *
+ * Read the given Shadow RAM word, and convert it to an area size value
+ * specified in bytes. This function assumes the specified offset is a valid
+ * area size word.
+ *
+ * Each area size word is specified in 4KB sector units. This function reports
+ * the size in bytes, intended for flat NVM reads.
+ */
+static enum ice_status
+ice_read_sr_area_size(struct ice_hw *hw, u16 offset, u32 *size)
+{
+       enum ice_status status;
+       u16 value;
+
+       status = ice_read_sr_word(hw, offset, &value);
+       if (status)
+               return status;
+
+       /* Area sizes are always specified in 4KB units */
+       *size = value * 4 * 1024;
+
+       return ICE_SUCCESS;
+}
+
+/**
+ * ice_determine_active_flash_banks - Discover active bank for each module
+ * @hw: pointer to the HW struct
+ *
+ * Read the Shadow RAM control word and determine which banks are active for
+ * the NVM, OROM, and Netlist modules. Also read and calculate the associated
+ * pointer and size. These values are then cached into the ice_flash_info
+ * structure for later use in order to calculate the correct offset to read
+ * from the active module.
+ */
+static enum ice_status
+ice_determine_active_flash_banks(struct ice_hw *hw)
+{
+       struct ice_bank_info *banks = &hw->flash.banks;
+       enum ice_status status;
+       u16 ctrl_word;
+
+       status = ice_read_sr_word(hw, ICE_SR_NVM_CTRL_WORD, &ctrl_word);
+       if (status) {
+               ice_debug(hw, ICE_DBG_NVM, "Failed to read the Shadow RAM control word\n");
+               return status;
+       }
+
+       /* Check that the control word indicates validity */
+       if ((ctrl_word & ICE_SR_CTRL_WORD_1_M) >> ICE_SR_CTRL_WORD_1_S != ICE_SR_CTRL_WORD_VALID) {
+               ice_debug(hw, ICE_DBG_NVM, "Shadow RAM control word is invalid\n");
+               return ICE_ERR_CFG;
+       }
+
+       if (!(ctrl_word & ICE_SR_CTRL_WORD_NVM_BANK))
+               banks->nvm_bank = ICE_1ST_FLASH_BANK;
+       else
+               banks->nvm_bank = ICE_2ND_FLASH_BANK;
+
+       if (!(ctrl_word & ICE_SR_CTRL_WORD_OROM_BANK))
+               banks->orom_bank = ICE_1ST_FLASH_BANK;
+       else
+               banks->orom_bank = ICE_2ND_FLASH_BANK;
+
+       if (!(ctrl_word & ICE_SR_CTRL_WORD_NETLIST_BANK))
+               banks->netlist_bank = ICE_1ST_FLASH_BANK;
+       else
+               banks->netlist_bank = ICE_2ND_FLASH_BANK;
+
+       status = ice_read_sr_pointer(hw, ICE_SR_1ST_NVM_BANK_PTR, &banks->nvm_ptr);
+       if (status) {
+               ice_debug(hw, ICE_DBG_NVM, "Failed to read NVM bank pointer\n");
+               return status;
+       }
+
+       status = ice_read_sr_area_size(hw, ICE_SR_NVM_BANK_SIZE, &banks->nvm_size);
+       if (status) {
+               ice_debug(hw, ICE_DBG_NVM, "Failed to read NVM bank area size\n");
+               return status;
+       }
+
+       status = ice_read_sr_pointer(hw, ICE_SR_1ST_OROM_BANK_PTR, &banks->orom_ptr);
+       if (status) {
+               ice_debug(hw, ICE_DBG_NVM, "Failed to read OROM bank pointer\n");
+               return status;
+       }
+
+       status = ice_read_sr_area_size(hw, ICE_SR_OROM_BANK_SIZE, &banks->orom_size);
+       if (status) {
+               ice_debug(hw, ICE_DBG_NVM, "Failed to read OROM bank area size\n");
+               return status;
+       }
+
+       status = ice_read_sr_pointer(hw, ICE_SR_NETLIST_BANK_PTR, &banks->netlist_ptr);
+       if (status) {
+               ice_debug(hw, ICE_DBG_NVM, "Failed to read Netlist bank pointer\n");
+               return status;
+       }
+
+       status = ice_read_sr_area_size(hw, ICE_SR_NETLIST_BANK_SIZE, &banks->netlist_size);
+       if (status) {
+               ice_debug(hw, ICE_DBG_NVM, "Failed to read Netlist bank area size\n");
+               return status;
+       }
+
+       return ICE_SUCCESS;
+}
+
 /**
  * ice_init_nvm - initializes NVM setting
  * @hw: pointer to the HW struct
@@ -419,8 +656,7 @@ err_read_flat_nvm:
  */
 enum ice_status ice_init_nvm(struct ice_hw *hw)
 {
-       struct ice_nvm_info *nvm = &hw->nvm;
-       u16 eetrack_lo, eetrack_hi, ver;
+       struct ice_flash_info *flash = &hw->flash;
        enum ice_status status;
        u32 fla, gens_stat;
        u8 sr_size;
@@ -434,66 +670,38 @@ enum ice_status ice_init_nvm(struct ice_hw *hw)
        sr_size = (gens_stat & GLNVM_GENS_SR_SIZE_M) >> GLNVM_GENS_SR_SIZE_S;
 
        /* Switching to words (sr_size contains power of 2) */
-       nvm->sr_words = BIT(sr_size) * ICE_SR_WORDS_IN_1KB;
+       flash->sr_words = BIT(sr_size) * ICE_SR_WORDS_IN_1KB;
 
        /* Check if we are in the normal or blank NVM programming mode */
        fla = rd32(hw, GLNVM_FLA);
        if (fla & GLNVM_FLA_LOCKED_M) { /* Normal programming mode */
-               nvm->blank_nvm_mode = false;
+               flash->blank_nvm_mode = false;
        } else {
                /* Blank programming mode */
-               nvm->blank_nvm_mode = true;
-               ice_debug(hw, ICE_DBG_NVM,
-                         "NVM init error: unsupported blank mode.\n");
+               flash->blank_nvm_mode = true;
+               ice_debug(hw, ICE_DBG_NVM, "NVM init error: unsupported blank mode.\n");
                return ICE_ERR_NVM_BLANK_MODE;
        }
 
-       status = ice_read_sr_word(hw, ICE_SR_NVM_DEV_STARTER_VER, &ver);
+       status = ice_discover_flash_size(hw);
        if (status) {
-               ice_debug(hw, ICE_DBG_INIT,
-                         "Failed to read DEV starter version.\n");
+               ice_debug(hw, ICE_DBG_NVM, "NVM init error: failed to discover flash size.\n");
                return status;
        }
-       nvm->major_ver = (ver & ICE_NVM_VER_HI_MASK) >> ICE_NVM_VER_HI_SHIFT;
-       nvm->minor_ver = (ver & ICE_NVM_VER_LO_MASK) >> ICE_NVM_VER_LO_SHIFT;
 
-       status = ice_read_sr_word(hw, ICE_SR_NVM_EETRACK_LO, &eetrack_lo);
+       status = ice_determine_active_flash_banks(hw);
        if (status) {
-               ice_debug(hw, ICE_DBG_INIT, "Failed to read EETRACK lo.\n");
+               ice_debug(hw, ICE_DBG_NVM, "Failed to determine active flash banks.\n");
                return status;
        }
-       status = ice_read_sr_word(hw, ICE_SR_NVM_EETRACK_HI, &eetrack_hi);
-       if (status) {
-               ice_debug(hw, ICE_DBG_INIT, "Failed to read EETRACK hi.\n");
-               return status;
-       }
-
-       nvm->eetrack = (eetrack_hi << 16) | eetrack_lo;
 
-       status = ice_discover_flash_size(hw);
+       status = ice_get_nvm_ver_info(hw, &flash->nvm);
        if (status) {
-               ice_debug(hw, ICE_DBG_NVM,
-                         "NVM init error: failed to discover flash size.\n");
+               ice_debug(hw, ICE_DBG_INIT, "Failed to read NVM info.\n");
                return status;
        }
 
-       switch (hw->device_id) {
-       /* the following devices do not have boot_cfg_tlv yet */
-       case ICE_DEV_ID_E822C_BACKPLANE:
-       case ICE_DEV_ID_E822C_QSFP:
-       case ICE_DEV_ID_E822C_10G_BASE_T:
-       case ICE_DEV_ID_E822C_SGMII:
-       case ICE_DEV_ID_E822C_SFP:
-       case ICE_DEV_ID_E822L_BACKPLANE:
-       case ICE_DEV_ID_E822L_SFP:
-       case ICE_DEV_ID_E822L_10G_BASE_T:
-       case ICE_DEV_ID_E822L_SGMII:
-               return status;
-       default:
-               break;
-       }
-
-       status = ice_get_orom_ver_info(hw);
+       status = ice_get_orom_ver_info(hw, &flash->orom);
        if (status) {
                ice_debug(hw, ICE_DBG_INIT, "Failed to read Option ROM info.\n");
                return status;
@@ -572,7 +780,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))
@@ -739,8 +947,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 */