drivers/net/ice/base/ice_nvm.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2001-2020 Intel Corporation
   3  */
   4
   5 #include "ice_common.h"
   6
   7 /**
   8  * ice_aq_read_nvm
   9  * @hw: pointer to the HW struct
  10  * @module_typeid: module pointer location in words from the NVM beginning
  11  * @offset: byte offset from the module beginning
  12  * @length: length of the section to be read (in bytes from the offset)
  13  * @data: command buffer (size [bytes] = length)
  14  * @last_command: tells if this is the last command in a series
  15  * @read_shadow_ram: tell if this is a shadow RAM read
  16  * @cd: pointer to command details structure or NULL
  17  *
  18  * Read the NVM using the admin queue commands (0x0701)
  19  */
  20 enum ice_status
  21 ice_aq_read_nvm(struct ice_hw *hw, u16 module_typeid, u32 offset, u16 length,
  22                 void *data, bool last_command, bool read_shadow_ram,
  23                 struct ice_sq_cd *cd)
  24 {
  25         struct ice_aq_desc desc;
  26         struct ice_aqc_nvm *cmd;
  27
  28         ice_debug(hw, ICE_DBG_TRACE, "%s\n", __func__);
  29
  30         cmd = &desc.params.nvm;
  31
  32         if (offset > ICE_AQC_NVM_MAX_OFFSET)
  33                 return ICE_ERR_PARAM;
  34
  35         ice_fill_dflt_direct_cmd_desc(&desc, ice_aqc_opc_nvm_read);
  36
  37         if (!read_shadow_ram && module_typeid == ICE_AQC_NVM_START_POINT)
  38                 cmd->cmd_flags |= ICE_AQC_NVM_FLASH_ONLY;
  39
  40         /* If this is the last command in a series, set the proper flag. */
  41         if (last_command)
  42                 cmd->cmd_flags |= ICE_AQC_NVM_LAST_CMD;
  43         cmd->module_typeid = CPU_TO_LE16(module_typeid);
  44         cmd->offset_low = CPU_TO_LE16(offset & 0xFFFF);
  45         cmd->offset_high = (offset >> 16) & 0xFF;
  46         cmd->length = CPU_TO_LE16(length);
  47
  48         return ice_aq_send_cmd(hw, &desc, data, length, cd);
  49 }
  50
  51 /**
  52  * ice_read_flat_nvm - Read portion of NVM by flat offset
  53  * @hw: pointer to the HW struct
  54  * @offset: offset from beginning of NVM
  55  * @length: (in) number of bytes to read; (out) number of bytes actually read
  56  * @data: buffer to return data in (sized to fit the specified length)
  57  * @read_shadow_ram: if true, read from shadow RAM instead of NVM
  58  *
  59  * Reads a portion of the NVM, as a flat memory space. This function correctly
  60  * breaks read requests across Shadow RAM sectors and ensures that no single
  61  * read request exceeds the maximum 4KB read for a single AdminQ command.
  62  *
  63  * Returns a status code on failure. Note that the data pointer may be
  64  * partially updated if some reads succeed before a failure.
  65  */
  66 enum ice_status
  67 ice_read_flat_nvm(struct ice_hw *hw, u32 offset, u32 *length, u8 *data,
  68                   bool read_shadow_ram)
  69 {
  70         enum ice_status status;
  71         u32 inlen = *length;
  72         u32 bytes_read = 0;
  73         bool last_cmd;
  74
  75         ice_debug(hw, ICE_DBG_TRACE, "%s\n", __func__);
  76
  77         *length = 0;
  78
  79         /* Verify the length of the read if this is for the Shadow RAM */
  80         if (read_shadow_ram && ((offset + inlen) > (hw->flash.sr_words * 2u))) {
  81                 ice_debug(hw, ICE_DBG_NVM, "NVM error: requested data is beyond Shadow RAM limit\n");
  82                 return ICE_ERR_PARAM;
  83         }
  84
  85         do {
  86                 u32 read_size, sector_offset;
  87
  88                 /* ice_aq_read_nvm cannot read more than 4KB at a time.
  89                  * Additionally, a read from the Shadow RAM may not cross over
  90                  * a sector boundary. Conveniently, the sector size is also
  91                  * 4KB.
  92                  */
  93                 sector_offset = offset % ICE_AQ_MAX_BUF_LEN;
  94                 read_size = MIN_T(u32, ICE_AQ_MAX_BUF_LEN - sector_offset,
  95                                   inlen - bytes_read);
  96
  97                 last_cmd = !(bytes_read + read_size < inlen);
  98
  99                 /* ice_aq_read_nvm takes the length as a u16. Our read_size is
 100                  * calculated using a u32, but the ICE_AQ_MAX_BUF_LEN maximum
 101                  * size guarantees that it will fit within the 2 bytes.
 102                  */
 103                 status = ice_aq_read_nvm(hw, ICE_AQC_NVM_START_POINT,
 104                                          offset, (u16)read_size,
 105                                          data + bytes_read, last_cmd,
 106                                          read_shadow_ram, NULL);
 107                 if (status)
 108                         break;
 109
 110                 bytes_read += read_size;
 111                 offset += read_size;
 112         } while (!last_cmd);
 113
 114         *length = bytes_read;
 115         return status;
 116 }
 117
 118 /**
 119  * ice_read_sr_word_aq - Reads Shadow RAM via AQ
 120  * @hw: pointer to the HW structure
 121  * @offset: offset of the Shadow RAM word to read (0x000000 - 0x001FFF)
 122  * @data: word read from the Shadow RAM
 123  *
 124  * Reads one 16 bit word from the Shadow RAM using ice_read_flat_nvm.
 125  */
 126 static enum ice_status
 127 ice_read_sr_word_aq(struct ice_hw *hw, u16 offset, u16 *data)
 128 {
 129         u32 bytes = sizeof(u16);
 130         enum ice_status status;
 131         __le16 data_local;
 132
 133         ice_debug(hw, ICE_DBG_TRACE, "%s\n", __func__);
 134
 135         /* Note that ice_read_flat_nvm checks if the read is past the Shadow
 136          * RAM size, and ensures we don't read across a Shadow RAM sector
 137          * boundary
 138          */
 139         status = ice_read_flat_nvm(hw, offset * sizeof(u16), &bytes,
 140                                    (_FORCE_ u8 *)&data_local, true);
 141         if (status)
 142                 return status;
 143
 144         *data = LE16_TO_CPU(data_local);
 145         return ICE_SUCCESS;
 146 }
 147
 148 /**
 149  * ice_read_sr_buf_aq - Reads Shadow RAM buf via AQ
 150  * @hw: pointer to the HW structure
 151  * @offset: offset of the Shadow RAM word to read (0x000000 - 0x001FFF)
 152  * @words: (in) number of words to read; (out) number of words actually read
 153  * @data: words read from the Shadow RAM
 154  *
 155  * Reads 16 bit words (data buf) from the Shadow RAM. Ownership of the NVM is
 156  * taken before reading the buffer and later released.
 157  */
 158 static enum ice_status
 159 ice_read_sr_buf_aq(struct ice_hw *hw, u16 offset, u16 *words, u16 *data)
 160 {
 161         u32 bytes = *words * 2, i;
 162         enum ice_status status;
 163
 164         ice_debug(hw, ICE_DBG_TRACE, "%s\n", __func__);
 165
 166         /* ice_read_flat_nvm takes into account the 4KB AdminQ and Shadow RAM
 167          * sector restrictions necessary when reading from the NVM.
 168          */
 169         status = ice_read_flat_nvm(hw, offset * 2, &bytes, (u8 *)data, true);
 170
 171         /* Report the number of words successfully read */
 172         *words = bytes / 2;
 173
 174         /* Byte swap the words up to the amount we actually read */
 175         for (i = 0; i < *words; i++)
 176                 data[i] = LE16_TO_CPU(((_FORCE_ __le16 *)data)[i]);
 177
 178         return status;
 179 }
 180
 181 /**
 182  * ice_acquire_nvm - Generic request for acquiring the NVM ownership
 183  * @hw: pointer to the HW structure
 184  * @access: NVM access type (read or write)
 185  *
 186  * This function will request NVM ownership.
 187  */
 188 enum ice_status
 189 ice_acquire_nvm(struct ice_hw *hw, enum ice_aq_res_access_type access)
 190 {
 191         ice_debug(hw, ICE_DBG_TRACE, "%s\n", __func__);
 192
 193         if (hw->flash.blank_nvm_mode)
 194                 return ICE_SUCCESS;
 195
 196         return ice_acquire_res(hw, ICE_NVM_RES_ID, access, ICE_NVM_TIMEOUT);
 197 }
 198
 199 /**
 200  * ice_release_nvm - Generic request for releasing the NVM ownership
 201  * @hw: pointer to the HW structure
 202  *
 203  * This function will release NVM ownership.
 204  */
 205 void ice_release_nvm(struct ice_hw *hw)
 206 {
 207         ice_debug(hw, ICE_DBG_TRACE, "%s\n", __func__);
 208
 209         if (hw->flash.blank_nvm_mode)
 210                 return;
 211
 212         ice_release_res(hw, ICE_NVM_RES_ID);
 213 }
 214
 215 /**
 216  * ice_get_flash_bank_offset - Get offset into requested flash bank
 217  * @hw: pointer to the HW structure
 218  * @bank: whether to read from the active or inactive flash bank
 219  * @module: the module to read from
 220  *
 221  * Based on the module, lookup the module offset from the beginning of the
 222  * flash.
 223  *
 224  * Returns the flash offset. Note that a value of zero is invalid and must be
 225  * treated as an error.
 226  */
 227 static u32 ice_get_flash_bank_offset(struct ice_hw *hw, enum ice_bank_select bank, u16 module)
 228 {
 229         struct ice_bank_info *banks = &hw->flash.banks;
 230         enum ice_flash_bank active_bank;
 231         bool second_bank_active;
 232         u32 offset, size;
 233
 234         switch (module) {
 235         case ICE_SR_1ST_NVM_BANK_PTR:
 236                 offset = banks->nvm_ptr;
 237                 size = banks->nvm_size;
 238                 active_bank = banks->nvm_bank;
 239                 break;
 240         case ICE_SR_1ST_OROM_BANK_PTR:
 241                 offset = banks->orom_ptr;
 242                 size = banks->orom_size;
 243                 active_bank = banks->orom_bank;
 244                 break;
 245         case ICE_SR_NETLIST_BANK_PTR:
 246                 offset = banks->netlist_ptr;
 247                 size = banks->netlist_size;
 248                 active_bank = banks->netlist_bank;
 249                 break;
 250         default:
 251                 ice_debug(hw, ICE_DBG_NVM, "Unexpected value for flash module: 0x%04x\n", module);
 252                 return 0;
 253         }
 254
 255         switch (active_bank) {
 256         case ICE_1ST_FLASH_BANK:
 257                 second_bank_active = false;
 258                 break;
 259         case ICE_2ND_FLASH_BANK:
 260                 second_bank_active = true;
 261                 break;
 262         default:
 263                 ice_debug(hw, ICE_DBG_NVM, "Unexpected value for active flash bank: %u\n",
 264                           active_bank);
 265                 return 0;
 266         }
 267
 268         /* The second flash bank is stored immediately following the first
 269          * bank. Based on whether the 1st or 2nd bank is active, and whether
 270          * we want the active or inactive bank, calculate the desired offset.
 271          */
 272         switch (bank) {
 273         case ICE_ACTIVE_FLASH_BANK:
 274                 return offset + (second_bank_active ? size : 0);
 275         case ICE_INACTIVE_FLASH_BANK:
 276                 return offset + (second_bank_active ? 0 : size);
 277         }
 278
 279         ice_debug(hw, ICE_DBG_NVM, "Unexpected value for flash bank selection: %u\n", bank);
 280         return 0;
 281 }
 282
 283 /**
 284  * ice_read_flash_module - Read a word from one of the main NVM modules
 285  * @hw: pointer to the HW structure
 286  * @bank: which bank of the module to read
 287  * @module: the module to read
 288  * @offset: the offset into the module in words
 289  * @data: storage for the word read from the flash
 290  *
 291  * Read data from the specified flash module. The bank parameter indicates
 292  * whether or not to read from the active bank or the inactive bank of that
 293  * module.
 294  *
 295  * The word will be read using flat NVM access, and relies on the
 296  * hw->flash.banks data being setup by ice_determine_active_flash_banks()
 297  * during initialization.
 298  */
 299 static enum ice_status
 300 ice_read_flash_module(struct ice_hw *hw, enum ice_bank_select bank, u16 module,
 301                       u32 offset, u16 *data)
 302 {
 303         u32 bytes = sizeof(u16);
 304         enum ice_status status;
 305         __le16 data_local;
 306         u32 start;
 307
 308         ice_debug(hw, ICE_DBG_TRACE, "%s\n", __func__);
 309
 310         start = ice_get_flash_bank_offset(hw, bank, module);
 311         if (!start) {
 312                 ice_debug(hw, ICE_DBG_NVM, "Unable to calculate flash bank offset for module 0x%04x\n",
 313                           module);
 314                 return ICE_ERR_PARAM;
 315         }
 316
 317         status = ice_acquire_nvm(hw, ICE_RES_READ);
 318         if (status)
 319                 return status;
 320
 321         status = ice_read_flat_nvm(hw, start + offset * sizeof(u16), &bytes,
 322                                    (_FORCE_ u8 *)&data_local, false);
 323         if (!status)
 324                 *data = LE16_TO_CPU(data_local);
 325
 326         ice_release_nvm(hw);
 327
 328         return status;
 329 }
 330
 331 /**
 332  * ice_read_active_nvm_module - Read from the active main NVM module
 333  * @hw: pointer to the HW structure
 334  * @offset: offset into the NVM module to read, in words
 335  * @data: storage for returned word value
 336  *
 337  * Read the specified word from the active NVM module. This includes the CSS
 338  * header at the start of the NVM module.
 339  */
 340 static enum ice_status
 341 ice_read_active_nvm_module(struct ice_hw *hw, u32 offset, u16 *data)
 342 {
 343         return ice_read_flash_module(hw, ICE_ACTIVE_FLASH_BANK,
 344                                      ICE_SR_1ST_NVM_BANK_PTR, offset, data);
 345 }
 346
 347 /**
 348  * ice_read_active_orom_module - Read from the active Option ROM module
 349  * @hw: pointer to the HW structure
 350  * @offset: offset into the OROM module to read, in words
 351  * @data: storage for returned word value
 352  *
 353  * Read the specified word from the active Option ROM module of the flash.
 354  * Note that unlike the NVM module, the CSS data is stored at the end of the
 355  * module instead of at the beginning.
 356  */
 357 static enum ice_status
 358 ice_read_active_orom_module(struct ice_hw *hw, u32 offset, u16 *data)
 359 {
 360         return ice_read_flash_module(hw, ICE_ACTIVE_FLASH_BANK,
 361                                      ICE_SR_1ST_OROM_BANK_PTR, offset, data);
 362 }
 363
 364 /**
 365  * ice_read_sr_word - Reads Shadow RAM word and acquire NVM if necessary
 366  * @hw: pointer to the HW structure
 367  * @offset: offset of the Shadow RAM word to read (0x000000 - 0x001FFF)
 368  * @data: word read from the Shadow RAM
 369  *
 370  * Reads one 16 bit word from the Shadow RAM using the ice_read_sr_word_aq.
 371  */
 372 enum ice_status ice_read_sr_word(struct ice_hw *hw, u16 offset, u16 *data)
 373 {
 374         enum ice_status status;
 375
 376         status = ice_acquire_nvm(hw, ICE_RES_READ);
 377         if (!status) {
 378                 status = ice_read_sr_word_aq(hw, offset, data);
 379                 ice_release_nvm(hw);
 380         }
 381
 382         return status;
 383 }
 384
 385 /**
 386  * ice_get_pfa_module_tlv - Reads sub module TLV from NVM PFA
 387  * @hw: pointer to hardware structure
 388  * @module_tlv: pointer to module TLV to return
 389  * @module_tlv_len: pointer to module TLV length to return
 390  * @module_type: module type requested
 391  *
 392  * Finds the requested sub module TLV type from the Preserved Field
 393  * Area (PFA) and returns the TLV pointer and length. The caller can
 394  * use these to read the variable length TLV value.
 395  */
 396 enum ice_status
 397 ice_get_pfa_module_tlv(struct ice_hw *hw, u16 *module_tlv, u16 *module_tlv_len,
 398                        u16 module_type)
 399 {
 400         enum ice_status status;
 401         u16 pfa_len, pfa_ptr;
 402         u16 next_tlv;
 403
 404         status = ice_read_sr_word(hw, ICE_SR_PFA_PTR, &pfa_ptr);
 405         if (status != ICE_SUCCESS) {
 406                 ice_debug(hw, ICE_DBG_INIT, "Preserved Field Array pointer.\n");
 407                 return status;
 408         }
 409         status = ice_read_sr_word(hw, pfa_ptr, &pfa_len);
 410         if (status != ICE_SUCCESS) {
 411                 ice_debug(hw, ICE_DBG_INIT, "Failed to read PFA length.\n");
 412                 return status;
 413         }
 414         /* Starting with first TLV after PFA length, iterate through the list
 415          * of TLVs to find the requested one.
 416          */
 417         next_tlv = pfa_ptr + 1;
 418         while (next_tlv < pfa_ptr + pfa_len) {
 419                 u16 tlv_sub_module_type;
 420                 u16 tlv_len;
 421
 422                 /* Read TLV type */
 423                 status = ice_read_sr_word(hw, next_tlv, &tlv_sub_module_type);
 424                 if (status != ICE_SUCCESS) {
 425                         ice_debug(hw, ICE_DBG_INIT, "Failed to read TLV type.\n");
 426                         break;
 427                 }
 428                 /* Read TLV length */
 429                 status = ice_read_sr_word(hw, next_tlv + 1, &tlv_len);
 430                 if (status != ICE_SUCCESS) {
 431                         ice_debug(hw, ICE_DBG_INIT, "Failed to read TLV length.\n");
 432                         break;
 433                 }
 434                 if (tlv_sub_module_type == module_type) {
 435                         if (tlv_len) {
 436                                 *module_tlv = next_tlv;
 437                                 *module_tlv_len = tlv_len;
 438                                 return ICE_SUCCESS;
 439                         }
 440                         return ICE_ERR_INVAL_SIZE;
 441                 }
 442                 /* Check next TLV, i.e. current TLV pointer + length + 2 words
 443                  * (for current TLV's type and length)
 444                  */
 445                 next_tlv = next_tlv + tlv_len + 2;
 446         }
 447         /* Module does not exist */
 448         return ICE_ERR_DOES_NOT_EXIST;
 449 }
 450
 451 /**
 452  * ice_read_pba_string - Reads part number string from NVM
 453  * @hw: pointer to hardware structure
 454  * @pba_num: stores the part number string from the NVM
 455  * @pba_num_size: part number string buffer length
 456  *
 457  * Reads the part number string from the NVM.
 458  */
 459 enum ice_status
 460 ice_read_pba_string(struct ice_hw *hw, u8 *pba_num, u32 pba_num_size)
 461 {
 462         u16 pba_tlv, pba_tlv_len;
 463         enum ice_status status;
 464         u16 pba_word, pba_size;
 465         u16 i;
 466
 467         status = ice_get_pfa_module_tlv(hw, &pba_tlv, &pba_tlv_len,
 468                                         ICE_SR_PBA_BLOCK_PTR);
 469         if (status != ICE_SUCCESS) {
 470                 ice_debug(hw, ICE_DBG_INIT, "Failed to read PBA Block TLV.\n");
 471                 return status;
 472         }
 473
 474         /* pba_size is the next word */
 475         status = ice_read_sr_word(hw, (pba_tlv + 2), &pba_size);
 476         if (status != ICE_SUCCESS) {
 477                 ice_debug(hw, ICE_DBG_INIT, "Failed to read PBA Section size.\n");
 478                 return status;
 479         }
 480
 481         if (pba_tlv_len < pba_size) {
 482                 ice_debug(hw, ICE_DBG_INIT, "Invalid PBA Block TLV size.\n");
 483                 return ICE_ERR_INVAL_SIZE;
 484         }
 485
 486         /* Subtract one to get PBA word count (PBA Size word is included in
 487          * total size)
 488          */
 489         pba_size--;
 490         if (pba_num_size < (((u32)pba_size * 2) + 1)) {
 491                 ice_debug(hw, ICE_DBG_INIT, "Buffer too small for PBA data.\n");
 492                 return ICE_ERR_PARAM;
 493         }
 494
 495         for (i = 0; i < pba_size; i++) {
 496                 status = ice_read_sr_word(hw, (pba_tlv + 2 + 1) + i, &pba_word);
 497                 if (status != ICE_SUCCESS) {
 498                         ice_debug(hw, ICE_DBG_INIT, "Failed to read PBA Block word %d.\n", i);
 499                         return status;
 500                 }
 501
 502                 pba_num[(i * 2)] = (pba_word >> 8) & 0xFF;
 503                 pba_num[(i * 2) + 1] = pba_word & 0xFF;
 504         }
 505         pba_num[(pba_size * 2)] = '\0';
 506
 507         return status;
 508 }
 509
 510 /**
 511  * ice_get_nvm_srev - Read the security revision from the NVM CSS header
 512  * @hw: pointer to the HW struct
 513  * @srev: storage for security revision
 514  *
 515  * Read the security revision out of the CSS header of the active NVM module
 516  * bank.
 517  */
 518 static enum ice_status ice_get_nvm_srev(struct ice_hw *hw, u32 *srev)
 519 {
 520         enum ice_status status;
 521         u16 srev_l, srev_h;
 522
 523         status = ice_read_active_nvm_module(hw, ICE_NVM_CSS_SREV_L, &srev_l);
 524         if (status)
 525                 return status;
 526
 527         status = ice_read_active_nvm_module(hw, ICE_NVM_CSS_SREV_H, &srev_h);
 528         if (status)
 529                 return status;
 530
 531         *srev = srev_h << 16 | srev_l;
 532
 533         return ICE_SUCCESS;
 534 }
 535
 536 /**
 537  * ice_get_nvm_ver_info - Read NVM version information
 538  * @hw: pointer to the HW struct
 539  * @nvm: pointer to NVM info structure
 540  *
 541  * Read the NVM EETRACK ID and map version of the main NVM image bank, filling
 542  * in the nvm info structure.
 543  */
 544 static enum ice_status
 545 ice_get_nvm_ver_info(struct ice_hw *hw, struct ice_nvm_info *nvm)
 546 {
 547         u16 eetrack_lo, eetrack_hi, ver;
 548         enum ice_status status;
 549
 550         status = ice_read_sr_word(hw, ICE_SR_NVM_DEV_STARTER_VER, &ver);
 551         if (status) {
 552                 ice_debug(hw, ICE_DBG_NVM, "Failed to read DEV starter version.\n");
 553                 return status;
 554         }
 555         nvm->major = (ver & ICE_NVM_VER_HI_MASK) >> ICE_NVM_VER_HI_SHIFT;
 556         nvm->minor = (ver & ICE_NVM_VER_LO_MASK) >> ICE_NVM_VER_LO_SHIFT;
 557
 558         status = ice_read_sr_word(hw, ICE_SR_NVM_EETRACK_LO, &eetrack_lo);
 559         if (status) {
 560                 ice_debug(hw, ICE_DBG_NVM, "Failed to read EETRACK lo.\n");
 561                 return status;
 562         }
 563         status = ice_read_sr_word(hw, ICE_SR_NVM_EETRACK_HI, &eetrack_hi);
 564         if (status) {
 565                 ice_debug(hw, ICE_DBG_NVM, "Failed to read EETRACK hi.\n");
 566                 return status;
 567         }
 568
 569         nvm->eetrack = (eetrack_hi << 16) | eetrack_lo;
 570
 571         status = ice_get_nvm_srev(hw, &nvm->srev);
 572         if (status)
 573                 ice_debug(hw, ICE_DBG_NVM, "Failed to read NVM security revision.\n");
 574
 575         return ICE_SUCCESS;
 576 }
 577
 578 /**
 579  * ice_get_orom_srev - Read the security revision from the OROM CSS header
 580  * @hw: pointer to the HW struct
 581  * @srev: storage for security revision
 582  *
 583  * Read the security revision out of the CSS header of the active OROM module
 584  * bank.
 585  */
 586 static enum ice_status ice_get_orom_srev(struct ice_hw *hw, u32 *srev)
 587 {
 588         enum ice_status status;
 589         u16 srev_l, srev_h;
 590         u32 css_start;
 591
 592         if (hw->flash.banks.orom_size < ICE_NVM_OROM_TRAILER_LENGTH) {
 593                 ice_debug(hw, ICE_DBG_NVM, "Unexpected Option ROM Size of %u\n",
 594                           hw->flash.banks.orom_size);
 595                 return ICE_ERR_CFG;
 596         }
 597
 598         /* calculate how far into the Option ROM the CSS header starts. Note
 599          * that ice_read_active_orom_module takes a word offset so we need to
 600          * divide by 2 here.
 601          */
 602         css_start = (hw->flash.banks.orom_size - ICE_NVM_OROM_TRAILER_LENGTH) / 2;
 603
 604         status = ice_read_active_orom_module(hw, css_start + ICE_NVM_CSS_SREV_L, &srev_l);
 605         if (status)
 606                 return status;
 607
 608         status = ice_read_active_orom_module(hw, css_start + ICE_NVM_CSS_SREV_H, &srev_h);
 609         if (status)
 610                 return status;
 611
 612         *srev = srev_h << 16 | srev_l;
 613
 614         return ICE_SUCCESS;
 615 }
 616
 617 /**
 618  * ice_get_orom_ver_info - Read Option ROM version information
 619  * @hw: pointer to the HW struct
 620  * @orom: pointer to Option ROM info structure
 621  *
 622  * Read the Combo Image version data from the Boot Configuration TLV and fill
 623  * in the option ROM version data.
 624  */
 625 static enum ice_status
 626 ice_get_orom_ver_info(struct ice_hw *hw, struct ice_orom_info *orom)
 627 {
 628         u16 combo_hi, combo_lo, boot_cfg_tlv, boot_cfg_tlv_len;
 629         enum ice_status status;
 630         u32 combo_ver;
 631
 632         status = ice_get_pfa_module_tlv(hw, &boot_cfg_tlv, &boot_cfg_tlv_len,
 633                                         ICE_SR_BOOT_CFG_PTR);
 634         if (status) {
 635                 ice_debug(hw, ICE_DBG_INIT, "Failed to read Boot Configuration Block TLV.\n");
 636                 return status;
 637         }
 638
 639         /* Boot Configuration Block must have length at least 2 words
 640          * (Combo Image Version High and Combo Image Version Low)
 641          */
 642         if (boot_cfg_tlv_len < 2) {
 643                 ice_debug(hw, ICE_DBG_INIT, "Invalid Boot Configuration Block TLV size.\n");
 644                 return ICE_ERR_INVAL_SIZE;
 645         }
 646
 647         status = ice_read_sr_word(hw, (boot_cfg_tlv + ICE_NVM_OROM_VER_OFF),
 648                                   &combo_hi);
 649         if (status) {
 650                 ice_debug(hw, ICE_DBG_INIT, "Failed to read OROM_VER hi.\n");
 651                 return status;
 652         }
 653
 654         status = ice_read_sr_word(hw, (boot_cfg_tlv + ICE_NVM_OROM_VER_OFF + 1),
 655                                   &combo_lo);
 656         if (status) {
 657                 ice_debug(hw, ICE_DBG_INIT, "Failed to read OROM_VER lo.\n");
 658                 return status;
 659         }
 660
 661         combo_ver = ((u32)combo_hi << 16) | combo_lo;
 662
 663         orom->major = (u8)((combo_ver & ICE_OROM_VER_MASK) >>
 664                            ICE_OROM_VER_SHIFT);
 665         orom->patch = (u8)(combo_ver & ICE_OROM_VER_PATCH_MASK);
 666         orom->build = (u16)((combo_ver & ICE_OROM_VER_BUILD_MASK) >>
 667                             ICE_OROM_VER_BUILD_SHIFT);
 668
 669         status = ice_get_orom_srev(hw, &orom->srev);
 670         if (status)
 671                 ice_debug(hw, ICE_DBG_NVM, "Failed to read Option ROM security revision.\n");
 672
 673         return ICE_SUCCESS;
 674 }
 675
 676 /**
 677  * ice_discover_flash_size - Discover the available flash size.
 678  * @hw: pointer to the HW struct
 679  *
 680  * The device flash could be up to 16MB in size. However, it is possible that
 681  * the actual size is smaller. Use bisection to determine the accessible size
 682  * of flash memory.
 683  */
 684 static enum ice_status ice_discover_flash_size(struct ice_hw *hw)
 685 {
 686         u32 min_size = 0, max_size = ICE_AQC_NVM_MAX_OFFSET + 1;
 687         enum ice_status status;
 688
 689         ice_debug(hw, ICE_DBG_TRACE, "%s\n", __func__);
 690
 691         status = ice_acquire_nvm(hw, ICE_RES_READ);
 692         if (status)
 693                 return status;
 694
 695         while ((max_size - min_size) > 1) {
 696                 u32 offset = (max_size + min_size) / 2;
 697                 u32 len = 1;
 698                 u8 data;
 699
 700                 status = ice_read_flat_nvm(hw, offset, &len, &data, false);
 701                 if (status == ICE_ERR_AQ_ERROR &&
 702                     hw->adminq.sq_last_status == ICE_AQ_RC_EINVAL) {
 703                         ice_debug(hw, ICE_DBG_NVM, "%s: New upper bound of %u bytes\n",
 704                                   __func__, offset);
 705                         status = ICE_SUCCESS;
 706                         max_size = offset;
 707                 } else if (!status) {
 708                         ice_debug(hw, ICE_DBG_NVM, "%s: New lower bound of %u bytes\n",
 709                                   __func__, offset);
 710                         min_size = offset;
 711                 } else {
 712                         /* an unexpected error occurred */
 713                         goto err_read_flat_nvm;
 714                 }
 715         }
 716
 717         ice_debug(hw, ICE_DBG_NVM, "Predicted flash size is %u bytes\n", max_size);
 718
 719         hw->flash.flash_size = max_size;
 720
 721 err_read_flat_nvm:
 722         ice_release_nvm(hw);
 723
 724         return status;
 725 }
 726
 727 /**
 728  * ice_read_sr_pointer - Read the value of a Shadow RAM pointer word
 729  * @hw: pointer to the HW structure
 730  * @offset: the word offset of the Shadow RAM word to read
 731  * @pointer: pointer value read from Shadow RAM
 732  *
 733  * Read the given Shadow RAM word, and convert it to a pointer value specified
 734  * in bytes. This function assumes the specified offset is a valid pointer
 735  * word.
 736  *
 737  * Each pointer word specifies whether it is stored in word size or 4KB
 738  * sector size by using the highest bit. The reported pointer value will be in
 739  * bytes, intended for flat NVM reads.
 740  */
 741 static enum ice_status
 742 ice_read_sr_pointer(struct ice_hw *hw, u16 offset, u32 *pointer)
 743 {
 744         enum ice_status status;
 745         u16 value;
 746
 747         status = ice_read_sr_word(hw, offset, &value);
 748         if (status)
 749                 return status;
 750
 751         /* Determine if the pointer is in 4KB or word units */
 752         if (value & ICE_SR_NVM_PTR_4KB_UNITS)
 753                 *pointer = (value & ~ICE_SR_NVM_PTR_4KB_UNITS) * 4 * 1024;
 754         else
 755                 *pointer = value * 2;
 756
 757         return ICE_SUCCESS;
 758 }
 759
 760 /**
 761  * ice_read_sr_area_size - Read an area size from a Shadow RAM word
 762  * @hw: pointer to the HW structure
 763  * @offset: the word offset of the Shadow RAM to read
 764  * @size: size value read from the Shadow RAM
 765  *
 766  * Read the given Shadow RAM word, and convert it to an area size value
 767  * specified in bytes. This function assumes the specified offset is a valid
 768  * area size word.
 769  *
 770  * Each area size word is specified in 4KB sector units. This function reports
 771  * the size in bytes, intended for flat NVM reads.
 772  */
 773 static enum ice_status
 774 ice_read_sr_area_size(struct ice_hw *hw, u16 offset, u32 *size)
 775 {
 776         enum ice_status status;
 777         u16 value;
 778
 779         status = ice_read_sr_word(hw, offset, &value);
 780         if (status)
 781                 return status;
 782
 783         /* Area sizes are always specified in 4KB units */
 784         *size = value * 4 * 1024;
 785
 786         return ICE_SUCCESS;
 787 }
 788
 789 /**
 790  * ice_determine_active_flash_banks - Discover active bank for each module
 791  * @hw: pointer to the HW struct
 792  *
 793  * Read the Shadow RAM control word and determine which banks are active for
 794  * the NVM, OROM, and Netlist modules. Also read and calculate the associated
 795  * pointer and size. These values are then cached into the ice_flash_info
 796  * structure for later use in order to calculate the correct offset to read
 797  * from the active module.
 798  */
 799 static enum ice_status
 800 ice_determine_active_flash_banks(struct ice_hw *hw)
 801 {
 802         struct ice_bank_info *banks = &hw->flash.banks;
 803         enum ice_status status;
 804         u16 ctrl_word;
 805
 806         status = ice_read_sr_word(hw, ICE_SR_NVM_CTRL_WORD, &ctrl_word);
 807         if (status) {
 808                 ice_debug(hw, ICE_DBG_NVM, "Failed to read the Shadow RAM control word\n");
 809                 return status;
 810         }
 811
 812         /* Check that the control word indicates validity */
 813         if ((ctrl_word & ICE_SR_CTRL_WORD_1_M) >> ICE_SR_CTRL_WORD_1_S != ICE_SR_CTRL_WORD_VALID) {
 814                 ice_debug(hw, ICE_DBG_NVM, "Shadow RAM control word is invalid\n");
 815                 return ICE_ERR_CFG;
 816         }
 817
 818         if (!(ctrl_word & ICE_SR_CTRL_WORD_NVM_BANK))
 819                 banks->nvm_bank = ICE_1ST_FLASH_BANK;
 820         else
 821                 banks->nvm_bank = ICE_2ND_FLASH_BANK;
 822
 823         if (!(ctrl_word & ICE_SR_CTRL_WORD_OROM_BANK))
 824                 banks->orom_bank = ICE_1ST_FLASH_BANK;
 825         else
 826                 banks->orom_bank = ICE_2ND_FLASH_BANK;
 827
 828         if (!(ctrl_word & ICE_SR_CTRL_WORD_NETLIST_BANK))
 829                 banks->netlist_bank = ICE_1ST_FLASH_BANK;
 830         else
 831                 banks->netlist_bank = ICE_2ND_FLASH_BANK;
 832
 833         status = ice_read_sr_pointer(hw, ICE_SR_1ST_NVM_BANK_PTR, &banks->nvm_ptr);
 834         if (status) {
 835                 ice_debug(hw, ICE_DBG_NVM, "Failed to read NVM bank pointer\n");
 836                 return status;
 837         }
 838
 839         status = ice_read_sr_area_size(hw, ICE_SR_NVM_BANK_SIZE, &banks->nvm_size);
 840         if (status) {
 841                 ice_debug(hw, ICE_DBG_NVM, "Failed to read NVM bank area size\n");
 842                 return status;
 843         }
 844
 845         status = ice_read_sr_pointer(hw, ICE_SR_1ST_OROM_BANK_PTR, &banks->orom_ptr);
 846         if (status) {
 847                 ice_debug(hw, ICE_DBG_NVM, "Failed to read OROM bank pointer\n");
 848                 return status;
 849         }
 850
 851         status = ice_read_sr_area_size(hw, ICE_SR_OROM_BANK_SIZE, &banks->orom_size);
 852         if (status) {
 853                 ice_debug(hw, ICE_DBG_NVM, "Failed to read OROM bank area size\n");
 854                 return status;
 855         }
 856
 857         status = ice_read_sr_pointer(hw, ICE_SR_NETLIST_BANK_PTR, &banks->netlist_ptr);
 858         if (status) {
 859                 ice_debug(hw, ICE_DBG_NVM, "Failed to read Netlist bank pointer\n");
 860                 return status;
 861         }
 862
 863         status = ice_read_sr_area_size(hw, ICE_SR_NETLIST_BANK_SIZE, &banks->netlist_size);
 864         if (status) {
 865                 ice_debug(hw, ICE_DBG_NVM, "Failed to read Netlist bank area size\n");
 866                 return status;
 867         }
 868
 869         return ICE_SUCCESS;
 870 }
 871
 872 /**
 873  * ice_init_nvm - initializes NVM setting
 874  * @hw: pointer to the HW struct
 875  *
 876  * This function reads and populates NVM settings such as Shadow RAM size,
 877  * max_timeout, and blank_nvm_mode
 878  */
 879 enum ice_status ice_init_nvm(struct ice_hw *hw)
 880 {
 881         struct ice_flash_info *flash = &hw->flash;
 882         enum ice_status status;
 883         u32 fla, gens_stat;
 884         u8 sr_size;
 885
 886         ice_debug(hw, ICE_DBG_TRACE, "%s\n", __func__);
 887
 888         /* The SR size is stored regardless of the NVM programming mode
 889          * as the blank mode may be used in the factory line.
 890          */
 891         gens_stat = rd32(hw, GLNVM_GENS);
 892         sr_size = (gens_stat & GLNVM_GENS_SR_SIZE_M) >> GLNVM_GENS_SR_SIZE_S;
 893
 894         /* Switching to words (sr_size contains power of 2) */
 895         flash->sr_words = BIT(sr_size) * ICE_SR_WORDS_IN_1KB;
 896
 897         /* Check if we are in the normal or blank NVM programming mode */
 898         fla = rd32(hw, GLNVM_FLA);
 899         if (fla & GLNVM_FLA_LOCKED_M) { /* Normal programming mode */
 900                 flash->blank_nvm_mode = false;
 901         } else {
 902                 /* Blank programming mode */
 903                 flash->blank_nvm_mode = true;
 904                 ice_debug(hw, ICE_DBG_NVM, "NVM init error: unsupported blank mode.\n");
 905                 return ICE_ERR_NVM_BLANK_MODE;
 906         }
 907
 908         status = ice_discover_flash_size(hw);
 909         if (status) {
 910                 ice_debug(hw, ICE_DBG_NVM, "NVM init error: failed to discover flash size.\n");
 911                 return status;
 912         }
 913
 914         status = ice_determine_active_flash_banks(hw);
 915         if (status) {
 916                 ice_debug(hw, ICE_DBG_NVM, "Failed to determine active flash banks.\n");
 917                 return status;
 918         }
 919
 920         status = ice_get_nvm_ver_info(hw, &flash->nvm);
 921         if (status) {
 922                 ice_debug(hw, ICE_DBG_INIT, "Failed to read NVM info.\n");
 923                 return status;
 924         }
 925
 926         status = ice_get_orom_ver_info(hw, &flash->orom);
 927         if (status) {
 928                 ice_debug(hw, ICE_DBG_INIT, "Failed to read Option ROM info.\n");
 929                 return status;
 930         }
 931
 932         return ICE_SUCCESS;
 933 }
 934
 935 /**
 936  * ice_read_sr_buf - Reads Shadow RAM buf and acquire lock if necessary
 937  * @hw: pointer to the HW structure
 938  * @offset: offset of the Shadow RAM word to read (0x000000 - 0x001FFF)
 939  * @words: (in) number of words to read; (out) number of words actually read
 940  * @data: words read from the Shadow RAM
 941  *
 942  * Reads 16 bit words (data buf) from the SR using the ice_read_nvm_buf_aq
 943  * method. The buf read is preceded by the NVM ownership take
 944  * and followed by the release.
 945  */
 946 enum ice_status
 947 ice_read_sr_buf(struct ice_hw *hw, u16 offset, u16 *words, u16 *data)
 948 {
 949         enum ice_status status;
 950
 951         status = ice_acquire_nvm(hw, ICE_RES_READ);
 952         if (!status) {
 953                 status = ice_read_sr_buf_aq(hw, offset, words, data);
 954                 ice_release_nvm(hw);
 955         }
 956
 957         return status;
 958 }
 959
 960 /**
 961  * ice_nvm_validate_checksum
 962  * @hw: pointer to the HW struct
 963  *
 964  * Verify NVM PFA checksum validity (0x0706)
 965  */
 966 enum ice_status ice_nvm_validate_checksum(struct ice_hw *hw)
 967 {
 968         struct ice_aqc_nvm_checksum *cmd;
 969         struct ice_aq_desc desc;
 970         enum ice_status status;
 971
 972         status = ice_acquire_nvm(hw, ICE_RES_READ);
 973         if (status)
 974                 return status;
 975
 976         cmd = &desc.params.nvm_checksum;
 977
 978         ice_fill_dflt_direct_cmd_desc(&desc, ice_aqc_opc_nvm_checksum);
 979         cmd->flags = ICE_AQC_NVM_CHECKSUM_VERIFY;
 980
 981         status = ice_aq_send_cmd(hw, &desc, NULL, 0, NULL);
 982         ice_release_nvm(hw);
 983
 984         if (!status)
 985                 if (LE16_TO_CPU(cmd->checksum) != ICE_AQC_NVM_CHECKSUM_CORRECT)
 986                         status = ICE_ERR_NVM_CHECKSUM;
 987
 988         return status;
 989 }
 990
 991 /**
 992  * ice_nvm_access_get_features - Return the NVM access features structure
 993  * @cmd: NVM access command to process
 994  * @data: storage for the driver NVM features
 995  *
 996  * Fill in the data section of the NVM access request with a copy of the NVM
 997  * features structure.
 998  */
 999 enum ice_status
1000 ice_nvm_access_get_features(struct ice_nvm_access_cmd *cmd,
1001                             union ice_nvm_access_data *data)
1002 {
1003         /* The provided data_size must be at least as large as our NVM
1004          * features structure. A larger size should not be treated as an
1005          * error, to allow future extensions to the features structure to
1006          * work on older drivers.
1007          */
1008         if (cmd->data_size < sizeof(struct ice_nvm_features))
1009                 return ICE_ERR_NO_MEMORY;
1010
1011         /* Initialize the data buffer to zeros */
1012         ice_memset(data, 0, cmd->data_size, ICE_NONDMA_MEM);
1013
1014         /* Fill in the features data */
1015         data->drv_features.major = ICE_NVM_ACCESS_MAJOR_VER;
1016         data->drv_features.minor = ICE_NVM_ACCESS_MINOR_VER;
1017         data->drv_features.size = sizeof(struct ice_nvm_features);
1018         data->drv_features.features[0] = ICE_NVM_FEATURES_0_REG_ACCESS;
1019
1020         return ICE_SUCCESS;
1021 }
1022
1023 /**
1024  * ice_nvm_access_get_module - Helper function to read module value
1025  * @cmd: NVM access command structure
1026  *
1027  * Reads the module value out of the NVM access config field.
1028  */
1029 u32 ice_nvm_access_get_module(struct ice_nvm_access_cmd *cmd)
1030 {
1031         return ((cmd->config & ICE_NVM_CFG_MODULE_M) >> ICE_NVM_CFG_MODULE_S);
1032 }
1033
1034 /**
1035  * ice_nvm_access_get_flags - Helper function to read flags value
1036  * @cmd: NVM access command structure
1037  *
1038  * Reads the flags value out of the NVM access config field.
1039  */
1040 u32 ice_nvm_access_get_flags(struct ice_nvm_access_cmd *cmd)
1041 {
1042         return ((cmd->config & ICE_NVM_CFG_FLAGS_M) >> ICE_NVM_CFG_FLAGS_S);
1043 }
1044
1045 /**
1046  * ice_nvm_access_get_adapter - Helper function to read adapter info
1047  * @cmd: NVM access command structure
1048  *
1049  * Read the adapter info value out of the NVM access config field.
1050  */
1051 u32 ice_nvm_access_get_adapter(struct ice_nvm_access_cmd *cmd)
1052 {
1053         return ((cmd->config & ICE_NVM_CFG_ADAPTER_INFO_M) >>
1054                 ICE_NVM_CFG_ADAPTER_INFO_S);
1055 }
1056
1057 /**
1058  * ice_validate_nvm_rw_reg - Check than an NVM access request is valid
1059  * @cmd: NVM access command structure
1060  *
1061  * Validates that an NVM access structure is request to read or write a valid
1062  * register offset. First validates that the module and flags are correct, and
1063  * then ensures that the register offset is one of the accepted registers.
1064  */
1065 static enum ice_status
1066 ice_validate_nvm_rw_reg(struct ice_nvm_access_cmd *cmd)
1067 {
1068         u32 module, flags, offset;
1069         u16 i;
1070
1071         module = ice_nvm_access_get_module(cmd);
1072         flags = ice_nvm_access_get_flags(cmd);
1073         offset = cmd->offset;
1074
1075         /* Make sure the module and flags indicate a read/write request */
1076         if (module != ICE_NVM_REG_RW_MODULE ||
1077             flags != ICE_NVM_REG_RW_FLAGS ||
1078             cmd->data_size != FIELD_SIZEOF(union ice_nvm_access_data, regval))
1079                 return ICE_ERR_PARAM;
1080
1081         switch (offset) {
1082         case GL_HICR:
1083         case GL_HICR_EN: /* Note, this register is read only */
1084         case GL_FWSTS:
1085         case GL_MNG_FWSM:
1086         case GLGEN_CSR_DEBUG_C:
1087         case GLGEN_RSTAT:
1088         case GLPCI_LBARCTRL:
1089         case GLNVM_GENS:
1090         case GLNVM_FLA:
1091         case PF_FUNC_RID:
1092                 return ICE_SUCCESS;
1093         default:
1094                 break;
1095         }
1096
1097         for (i = 0; i <= ICE_NVM_ACCESS_GL_HIDA_MAX; i++)
1098                 if (offset == (u32)GL_HIDA(i))
1099                         return ICE_SUCCESS;
1100
1101         for (i = 0; i <= ICE_NVM_ACCESS_GL_HIBA_MAX; i++)
1102                 if (offset == (u32)GL_HIBA(i))
1103                         return ICE_SUCCESS;
1104
1105         /* All other register offsets are not valid */
1106         return ICE_ERR_OUT_OF_RANGE;
1107 }
1108
1109 /**
1110  * ice_nvm_access_read - Handle an NVM read request
1111  * @hw: pointer to the HW struct
1112  * @cmd: NVM access command to process
1113  * @data: storage for the register value read
1114  *
1115  * Process an NVM access request to read a register.
1116  */
1117 enum ice_status
1118 ice_nvm_access_read(struct ice_hw *hw, struct ice_nvm_access_cmd *cmd,
1119                     union ice_nvm_access_data *data)
1120 {
1121         enum ice_status status;
1122
1123         ice_debug(hw, ICE_DBG_TRACE, "%s\n", __func__);
1124
1125         /* Always initialize the output data, even on failure */
1126         ice_memset(data, 0, cmd->data_size, ICE_NONDMA_MEM);
1127
1128         /* Make sure this is a valid read/write access request */
1129         status = ice_validate_nvm_rw_reg(cmd);
1130         if (status)
1131                 return status;
1132
1133         ice_debug(hw, ICE_DBG_NVM, "NVM access: reading register %08x\n",
1134                   cmd->offset);
1135
1136         /* Read the register and store the contents in the data field */
1137         data->regval = rd32(hw, cmd->offset);
1138
1139         return ICE_SUCCESS;
1140 }
1141
1142 /**
1143  * ice_nvm_access_write - Handle an NVM write request
1144  * @hw: pointer to the HW struct
1145  * @cmd: NVM access command to process
1146  * @data: NVM access data to write
1147  *
1148  * Process an NVM access request to write a register.
1149  */
1150 enum ice_status
1151 ice_nvm_access_write(struct ice_hw *hw, struct ice_nvm_access_cmd *cmd,
1152                      union ice_nvm_access_data *data)
1153 {
1154         enum ice_status status;
1155
1156         ice_debug(hw, ICE_DBG_TRACE, "%s\n", __func__);
1157
1158         /* Make sure this is a valid read/write access request */
1159         status = ice_validate_nvm_rw_reg(cmd);
1160         if (status)
1161                 return status;
1162
1163         /* Reject requests to write to read-only registers */
1164         switch (cmd->offset) {
1165         case GL_HICR_EN:
1166         case GLGEN_RSTAT:
1167                 return ICE_ERR_OUT_OF_RANGE;
1168         default:
1169                 break;
1170         }
1171
1172         ice_debug(hw, ICE_DBG_NVM, "NVM access: writing register %08x with value %08x\n",
1173                   cmd->offset, data->regval);
1174
1175         /* Write the data field to the specified register */
1176         wr32(hw, cmd->offset, data->regval);
1177
1178         return ICE_SUCCESS;
1179 }
1180
1181 /**
1182  * ice_handle_nvm_access - Handle an NVM access request
1183  * @hw: pointer to the HW struct
1184  * @cmd: NVM access command info
1185  * @data: pointer to read or return data
1186  *
1187  * Process an NVM access request. Read the command structure information and
1188  * determine if it is valid. If not, report an error indicating the command
1189  * was invalid.
1190  *
1191  * For valid commands, perform the necessary function, copying the data into
1192  * the provided data buffer.
1193  */
1194 enum ice_status
1195 ice_handle_nvm_access(struct ice_hw *hw, struct ice_nvm_access_cmd *cmd,
1196                       union ice_nvm_access_data *data)
1197 {
1198         u32 module, flags, adapter_info;
1199
1200         ice_debug(hw, ICE_DBG_TRACE, "%s\n", __func__);
1201
1202         /* Extended flags are currently reserved and must be zero */
1203         if ((cmd->config & ICE_NVM_CFG_EXT_FLAGS_M) != 0)
1204                 return ICE_ERR_PARAM;
1205
1206         /* Adapter info must match the HW device ID */
1207         adapter_info = ice_nvm_access_get_adapter(cmd);
1208         if (adapter_info != hw->device_id)
1209                 return ICE_ERR_PARAM;
1210
1211         switch (cmd->command) {
1212         case ICE_NVM_CMD_READ:
1213                 module = ice_nvm_access_get_module(cmd);
1214                 flags = ice_nvm_access_get_flags(cmd);
1215
1216                 /* Getting the driver's NVM features structure shares the same
1217                  * command type as reading a register. Read the config field
1218                  * to determine if this is a request to get features.
1219                  */
1220                 if (module == ICE_NVM_GET_FEATURES_MODULE &&
1221                     flags == ICE_NVM_GET_FEATURES_FLAGS &&
1222                     cmd->offset == 0)
1223                         return ice_nvm_access_get_features(cmd, data);
1224                 else
1225                         return ice_nvm_access_read(hw, cmd, data);
1226         case ICE_NVM_CMD_WRITE:
1227                 return ice_nvm_access_write(hw, cmd, data);
1228         default:
1229                 return ICE_ERR_PARAM;
1230         }
1231 }