drivers/net/ice/base/ice_nvm.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2001-2019
   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 static 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->nvm.sr_words * 2u))) {
  81                 ice_debug(hw, ICE_DBG_NVM,
  82                           "NVM error: requested data is beyond Shadow RAM limit\n");
  83                 return ICE_ERR_PARAM;
  84         }
  85
  86         do {
  87                 u32 read_size, sector_offset;
  88
  89                 /* ice_aq_read_nvm cannot read more than 4Kb at a time.
  90                  * Additionally, a read from the Shadow RAM may not cross over
  91                  * a sector boundary. Conveniently, the sector size is also
  92                  * 4Kb.
  93                  */
  94                 sector_offset = offset % ICE_AQ_MAX_BUF_LEN;
  95                 read_size = MIN_T(u32, ICE_AQ_MAX_BUF_LEN - sector_offset,
  96                                   inlen - bytes_read);
  97
  98                 last_cmd = !(bytes_read + read_size < inlen);
  99
 100                 /* ice_aq_read_nvm takes the length as a u16. Our read_size is
 101                  * calculated using a u32, but the ICE_AQ_MAX_BUF_LEN maximum
 102                  * size guarantees that it will fit within the 2 bytes.
 103                  */
 104                 status = ice_aq_read_nvm(hw, ICE_AQC_NVM_START_POINT,
 105                                          offset, (u16)read_size,
 106                                          data + bytes_read, last_cmd,
 107                                          read_shadow_ram, NULL);
 108                 if (status)
 109                         break;
 110
 111                 bytes_read += read_size;
 112                 offset += read_size;
 113         } while (!last_cmd);
 114
 115         *length = bytes_read;
 116         return status;
 117 }
 118
 119 /**
 120  * ice_read_sr_word_aq - Reads Shadow RAM via AQ
 121  * @hw: pointer to the HW structure
 122  * @offset: offset of the Shadow RAM word to read (0x000000 - 0x001FFF)
 123  * @data: word read from the Shadow RAM
 124  *
 125  * Reads one 16 bit word from the Shadow RAM using ice_read_flat_nvm.
 126  */
 127 static enum ice_status
 128 ice_read_sr_word_aq(struct ice_hw *hw, u16 offset, u16 *data)
 129 {
 130         u32 bytes = sizeof(u16);
 131         enum ice_status status;
 132         __le16 data_local;
 133
 134         ice_debug(hw, ICE_DBG_TRACE, "%s\n", __func__);
 135
 136         /* Note that ice_read_flat_nvm checks if the read is past the Shadow
 137          * RAM size, and ensures we don't read across a Shadow RAM sector
 138          * boundary
 139          */
 140         status = ice_read_flat_nvm(hw, offset * sizeof(u16), &bytes,
 141                                    (u8 *)&data_local, true);
 142         if (status)
 143                 return status;
 144
 145         *data = LE16_TO_CPU(data_local);
 146         return ICE_SUCCESS;
 147 }
 148
 149 /**
 150  * ice_read_sr_buf_aq - Reads Shadow RAM buf via AQ
 151  * @hw: pointer to the HW structure
 152  * @offset: offset of the Shadow RAM word to read (0x000000 - 0x001FFF)
 153  * @words: (in) number of words to read; (out) number of words actually read
 154  * @data: words read from the Shadow RAM
 155  *
 156  * Reads 16 bit words (data buf) from the Shadow RAM. Ownership of the NVM is
 157  * taken before reading the buffer and later released.
 158  */
 159 static enum ice_status
 160 ice_read_sr_buf_aq(struct ice_hw *hw, u16 offset, u16 *words, u16 *data)
 161 {
 162         u32 bytes = *words * 2, i;
 163         enum ice_status status;
 164
 165         ice_debug(hw, ICE_DBG_TRACE, "%s\n", __func__);
 166
 167         /* ice_read_flat_nvm takes into account the 4Kb AdminQ and Shadow RAM
 168          * sector restrictions necessary when reading from the NVM.
 169          */
 170         status = ice_read_flat_nvm(hw, offset * 2, &bytes, (u8 *)data, true);
 171
 172         /* Report the number of words successfully read */
 173         *words = bytes / 2;
 174
 175         /* Byte swap the words up to the amount we actually read */
 176         for (i = 0; i < *words; i++)
 177                 data[i] = LE16_TO_CPU(((_FORCE_ __le16 *)data)[i]);
 178
 179         return status;
 180 }
 181
 182 /**
 183  * ice_acquire_nvm - Generic request for acquiring the NVM ownership
 184  * @hw: pointer to the HW structure
 185  * @access: NVM access type (read or write)
 186  *
 187  * This function will request NVM ownership.
 188  */
 189 static enum ice_status
 190 ice_acquire_nvm(struct ice_hw *hw, enum ice_aq_res_access_type access)
 191 {
 192         ice_debug(hw, ICE_DBG_TRACE, "%s\n", __func__);
 193
 194         if (hw->nvm.blank_nvm_mode)
 195                 return ICE_SUCCESS;
 196
 197         return ice_acquire_res(hw, ICE_NVM_RES_ID, access, ICE_NVM_TIMEOUT);
 198 }
 199
 200 /**
 201  * ice_release_nvm - Generic request for releasing the NVM ownership
 202  * @hw: pointer to the HW structure
 203  *
 204  * This function will release NVM ownership.
 205  */
 206 static void ice_release_nvm(struct ice_hw *hw)
 207 {
 208         ice_debug(hw, ICE_DBG_TRACE, "%s\n", __func__);
 209
 210         if (hw->nvm.blank_nvm_mode)
 211                 return;
 212
 213         ice_release_res(hw, ICE_NVM_RES_ID);
 214 }
 215
 216 /**
 217  * ice_read_sr_word - Reads Shadow RAM word and acquire NVM if necessary
 218  * @hw: pointer to the HW structure
 219  * @offset: offset of the Shadow RAM word to read (0x000000 - 0x001FFF)
 220  * @data: word read from the Shadow RAM
 221  *
 222  * Reads one 16 bit word from the Shadow RAM using the ice_read_sr_word_aq.
 223  */
 224 enum ice_status ice_read_sr_word(struct ice_hw *hw, u16 offset, u16 *data)
 225 {
 226         enum ice_status status;
 227
 228         status = ice_acquire_nvm(hw, ICE_RES_READ);
 229         if (!status) {
 230                 status = ice_read_sr_word_aq(hw, offset, data);
 231                 ice_release_nvm(hw);
 232         }
 233
 234         return status;
 235 }
 236
 237 /**
 238  * ice_init_nvm - initializes NVM setting
 239  * @hw: pointer to the HW struct
 240  *
 241  * This function reads and populates NVM settings such as Shadow RAM size,
 242  * max_timeout, and blank_nvm_mode
 243  */
 244 enum ice_status ice_init_nvm(struct ice_hw *hw)
 245 {
 246         u16 oem_hi, oem_lo, boot_cfg_tlv, boot_cfg_tlv_len;
 247         struct ice_nvm_info *nvm = &hw->nvm;
 248         u16 eetrack_lo, eetrack_hi;
 249         enum ice_status status;
 250         u32 fla, gens_stat;
 251         u8 sr_size;
 252
 253         ice_debug(hw, ICE_DBG_TRACE, "%s\n", __func__);
 254
 255         /* The SR size is stored regardless of the NVM programming mode
 256          * as the blank mode may be used in the factory line.
 257          */
 258         gens_stat = rd32(hw, GLNVM_GENS);
 259         sr_size = (gens_stat & GLNVM_GENS_SR_SIZE_M) >> GLNVM_GENS_SR_SIZE_S;
 260
 261         /* Switching to words (sr_size contains power of 2) */
 262         nvm->sr_words = BIT(sr_size) * ICE_SR_WORDS_IN_1KB;
 263
 264         /* Check if we are in the normal or blank NVM programming mode */
 265         fla = rd32(hw, GLNVM_FLA);
 266         if (fla & GLNVM_FLA_LOCKED_M) { /* Normal programming mode */
 267                 nvm->blank_nvm_mode = false;
 268         } else {
 269                 /* Blank programming mode */
 270                 nvm->blank_nvm_mode = true;
 271                 ice_debug(hw, ICE_DBG_NVM,
 272                           "NVM init error: unsupported blank mode.\n");
 273                 return ICE_ERR_NVM_BLANK_MODE;
 274         }
 275
 276         status = ice_read_sr_word(hw, ICE_SR_NVM_DEV_STARTER_VER, &nvm->ver);
 277         if (status) {
 278                 ice_debug(hw, ICE_DBG_INIT,
 279                           "Failed to read DEV starter version.\n");
 280                 return status;
 281         }
 282
 283         status = ice_read_sr_word(hw, ICE_SR_NVM_EETRACK_LO, &eetrack_lo);
 284         if (status) {
 285                 ice_debug(hw, ICE_DBG_INIT, "Failed to read EETRACK lo.\n");
 286                 return status;
 287         }
 288         status = ice_read_sr_word(hw, ICE_SR_NVM_EETRACK_HI, &eetrack_hi);
 289         if (status) {
 290                 ice_debug(hw, ICE_DBG_INIT, "Failed to read EETRACK hi.\n");
 291                 return status;
 292         }
 293
 294         nvm->eetrack = (eetrack_hi << 16) | eetrack_lo;
 295
 296         switch (hw->device_id) {
 297         /* the following devices do not have boot_cfg_tlv yet */
 298         case ICE_DEV_ID_E822C_BACKPLANE:
 299         case ICE_DEV_ID_E822C_QSFP:
 300         case ICE_DEV_ID_E822C_10G_BASE_T:
 301         case ICE_DEV_ID_E822C_SGMII:
 302         case ICE_DEV_ID_E822C_SFP:
 303         case ICE_DEV_ID_E822L_BACKPLANE:
 304         case ICE_DEV_ID_E822L_SFP:
 305         case ICE_DEV_ID_E822L_10G_BASE_T:
 306         case ICE_DEV_ID_E822L_SGMII:
 307                 return status;
 308         default:
 309                 break;
 310         }
 311
 312         status = ice_get_pfa_module_tlv(hw, &boot_cfg_tlv, &boot_cfg_tlv_len,
 313                                         ICE_SR_BOOT_CFG_PTR);
 314         if (status) {
 315                 ice_debug(hw, ICE_DBG_INIT,
 316                           "Failed to read Boot Configuration Block TLV.\n");
 317                 return status;
 318         }
 319
 320         /* Boot Configuration Block must have length at least 2 words
 321          * (Combo Image Version High and Combo Image Version Low)
 322          */
 323         if (boot_cfg_tlv_len < 2) {
 324                 ice_debug(hw, ICE_DBG_INIT,
 325                           "Invalid Boot Configuration Block TLV size.\n");
 326                 return ICE_ERR_INVAL_SIZE;
 327         }
 328
 329         status = ice_read_sr_word(hw, (boot_cfg_tlv + ICE_NVM_OEM_VER_OFF),
 330                                   &oem_hi);
 331         if (status) {
 332                 ice_debug(hw, ICE_DBG_INIT, "Failed to read OEM_VER hi.\n");
 333                 return status;
 334         }
 335
 336         status = ice_read_sr_word(hw, (boot_cfg_tlv + ICE_NVM_OEM_VER_OFF + 1),
 337                                   &oem_lo);
 338         if (status) {
 339                 ice_debug(hw, ICE_DBG_INIT, "Failed to read OEM_VER lo.\n");
 340                 return status;
 341         }
 342
 343         nvm->oem_ver = ((u32)oem_hi << 16) | oem_lo;
 344
 345         return ICE_SUCCESS;
 346 }
 347
 348 /**
 349  * ice_read_sr_buf - Reads Shadow RAM buf and acquire lock if necessary
 350  * @hw: pointer to the HW structure
 351  * @offset: offset of the Shadow RAM word to read (0x000000 - 0x001FFF)
 352  * @words: (in) number of words to read; (out) number of words actually read
 353  * @data: words read from the Shadow RAM
 354  *
 355  * Reads 16 bit words (data buf) from the SR using the ice_read_nvm_buf_aq
 356  * method. The buf read is preceded by the NVM ownership take
 357  * and followed by the release.
 358  */
 359 enum ice_status
 360 ice_read_sr_buf(struct ice_hw *hw, u16 offset, u16 *words, u16 *data)
 361 {
 362         enum ice_status status;
 363
 364         status = ice_acquire_nvm(hw, ICE_RES_READ);
 365         if (!status) {
 366                 status = ice_read_sr_buf_aq(hw, offset, words, data);
 367                 ice_release_nvm(hw);
 368         }
 369
 370         return status;
 371 }
 372
 373 /**
 374  * ice_nvm_validate_checksum
 375  * @hw: pointer to the HW struct
 376  *
 377  * Verify NVM PFA checksum validity (0x0706)
 378  */
 379 enum ice_status ice_nvm_validate_checksum(struct ice_hw *hw)
 380 {
 381         struct ice_aqc_nvm_checksum *cmd;
 382         struct ice_aq_desc desc;
 383         enum ice_status status;
 384
 385         status = ice_acquire_nvm(hw, ICE_RES_READ);
 386         if (status)
 387                 return status;
 388
 389         cmd = &desc.params.nvm_checksum;
 390
 391         ice_fill_dflt_direct_cmd_desc(&desc, ice_aqc_opc_nvm_checksum);
 392         cmd->flags = ICE_AQC_NVM_CHECKSUM_VERIFY;
 393
 394         status = ice_aq_send_cmd(hw, &desc, NULL, 0, NULL);
 395         ice_release_nvm(hw);
 396
 397         if (!status)
 398                 if (LE16_TO_CPU(cmd->checksum) != ICE_AQC_NVM_CHECKSUM_CORRECT)
 399                         status = ICE_ERR_NVM_CHECKSUM;
 400
 401         return status;
 402 }
 403
 404 /**
 405  * ice_nvm_access_get_features - Return the NVM access features structure
 406  * @cmd: NVM access command to process
 407  * @data: storage for the driver NVM features
 408  *
 409  * Fill in the data section of the NVM access request with a copy of the NVM
 410  * features structure.
 411  */
 412 enum ice_status
 413 ice_nvm_access_get_features(struct ice_nvm_access_cmd *cmd,
 414                             union ice_nvm_access_data *data)
 415 {
 416         /* The provided data_size must be at least as large as our NVM
 417          * features structure. A larger size should not be treated as an
 418          * error, to allow future extensions to to the features structure to
 419          * work on older drivers.
 420          */
 421         if (cmd->data_size < sizeof(struct ice_nvm_features))
 422                 return ICE_ERR_NO_MEMORY;
 423
 424         /* Initialize the data buffer to zeros */
 425         ice_memset(data, 0, cmd->data_size, ICE_NONDMA_MEM);
 426
 427         /* Fill in the features data */
 428         data->drv_features.major = ICE_NVM_ACCESS_MAJOR_VER;
 429         data->drv_features.minor = ICE_NVM_ACCESS_MINOR_VER;
 430         data->drv_features.size = sizeof(struct ice_nvm_features);
 431         data->drv_features.features[0] = ICE_NVM_FEATURES_0_REG_ACCESS;
 432
 433         return ICE_SUCCESS;
 434 }
 435
 436 /**
 437  * ice_nvm_access_get_module - Helper function to read module value
 438  * @cmd: NVM access command structure
 439  *
 440  * Reads the module value out of the NVM access config field.
 441  */
 442 u32 ice_nvm_access_get_module(struct ice_nvm_access_cmd *cmd)
 443 {
 444         return ((cmd->config & ICE_NVM_CFG_MODULE_M) >> ICE_NVM_CFG_MODULE_S);
 445 }
 446
 447 /**
 448  * ice_nvm_access_get_flags - Helper function to read flags value
 449  * @cmd: NVM access command structure
 450  *
 451  * Reads the flags value out of the NVM access config field.
 452  */
 453 u32 ice_nvm_access_get_flags(struct ice_nvm_access_cmd *cmd)
 454 {
 455         return ((cmd->config & ICE_NVM_CFG_FLAGS_M) >> ICE_NVM_CFG_FLAGS_S);
 456 }
 457
 458 /**
 459  * ice_nvm_access_get_adapter - Helper function to read adapter info
 460  * @cmd: NVM access command structure
 461  *
 462  * Read the adapter info value out of the NVM access config field.
 463  */
 464 u32 ice_nvm_access_get_adapter(struct ice_nvm_access_cmd *cmd)
 465 {
 466         return ((cmd->config & ICE_NVM_CFG_ADAPTER_INFO_M) >>
 467                 ICE_NVM_CFG_ADAPTER_INFO_S);
 468 }
 469
 470 /**
 471  * ice_validate_nvm_rw_reg - Check than an NVM access request is valid
 472  * @cmd: NVM access command structure
 473  *
 474  * Validates that an NVM access structure is request to read or write a valid
 475  * register offset. First validates that the module and flags are correct, and
 476  * then ensures that the register offset is one of the accepted registers.
 477  */
 478 static enum ice_status
 479 ice_validate_nvm_rw_reg(struct ice_nvm_access_cmd *cmd)
 480 {
 481         u32 module, flags, offset;
 482         u16 i;
 483
 484         module = ice_nvm_access_get_module(cmd);
 485         flags = ice_nvm_access_get_flags(cmd);
 486         offset = cmd->offset;
 487
 488         /* Make sure the module and flags indicate a read/write request */
 489         if (module != ICE_NVM_REG_RW_MODULE ||
 490             flags != ICE_NVM_REG_RW_FLAGS ||
 491             cmd->data_size != FIELD_SIZEOF(union ice_nvm_access_data, regval))
 492                 return ICE_ERR_PARAM;
 493
 494         switch (offset) {
 495         case GL_HICR:
 496         case GL_HICR_EN: /* Note, this register is read only */
 497         case GL_FWSTS:
 498         case GL_MNG_FWSM:
 499         case GLGEN_CSR_DEBUG_C:
 500         case GLGEN_RSTAT:
 501         case GLPCI_LBARCTRL:
 502         case GLNVM_GENS:
 503         case GLNVM_FLA:
 504         case PF_FUNC_RID:
 505                 return ICE_SUCCESS;
 506         default:
 507                 break;
 508         }
 509
 510         for (i = 0; i <= ICE_NVM_ACCESS_GL_HIDA_MAX; i++)
 511                 if (offset == (u32)GL_HIDA(i))
 512                         return ICE_SUCCESS;
 513
 514         for (i = 0; i <= ICE_NVM_ACCESS_GL_HIBA_MAX; i++)
 515                 if (offset == (u32)GL_HIBA(i))
 516                         return ICE_SUCCESS;
 517
 518         /* All other register offsets are not valid */
 519         return ICE_ERR_OUT_OF_RANGE;
 520 }
 521
 522 /**
 523  * ice_nvm_access_read - Handle an NVM read request
 524  * @hw: pointer to the HW struct
 525  * @cmd: NVM access command to process
 526  * @data: storage for the register value read
 527  *
 528  * Process an NVM access request to read a register.
 529  */
 530 enum ice_status
 531 ice_nvm_access_read(struct ice_hw *hw, struct ice_nvm_access_cmd *cmd,
 532                     union ice_nvm_access_data *data)
 533 {
 534         enum ice_status status;
 535
 536         ice_debug(hw, ICE_DBG_TRACE, "%s\n", __func__);
 537
 538         /* Always initialize the output data, even on failure */
 539         ice_memset(data, 0, cmd->data_size, ICE_NONDMA_MEM);
 540
 541         /* Make sure this is a valid read/write access request */
 542         status = ice_validate_nvm_rw_reg(cmd);
 543         if (status)
 544                 return status;
 545
 546         ice_debug(hw, ICE_DBG_NVM, "NVM access: reading register %08x\n",
 547                   cmd->offset);
 548
 549         /* Read the register and store the contents in the data field */
 550         data->regval = rd32(hw, cmd->offset);
 551
 552         return ICE_SUCCESS;
 553 }
 554
 555 /**
 556  * ice_nvm_access_write - Handle an NVM write request
 557  * @hw: pointer to the HW struct
 558  * @cmd: NVM access command to process
 559  * @data: NVM access data to write
 560  *
 561  * Process an NVM access request to write a register.
 562  */
 563 enum ice_status
 564 ice_nvm_access_write(struct ice_hw *hw, struct ice_nvm_access_cmd *cmd,
 565                      union ice_nvm_access_data *data)
 566 {
 567         enum ice_status status;
 568
 569         ice_debug(hw, ICE_DBG_TRACE, "%s\n", __func__);
 570
 571         /* Make sure this is a valid read/write access request */
 572         status = ice_validate_nvm_rw_reg(cmd);
 573         if (status)
 574                 return status;
 575
 576         /* Reject requests to write to read-only registers */
 577         switch (cmd->offset) {
 578         case GL_HICR_EN:
 579         case GLGEN_RSTAT:
 580                 return ICE_ERR_OUT_OF_RANGE;
 581         default:
 582                 break;
 583         }
 584
 585         ice_debug(hw, ICE_DBG_NVM,
 586                   "NVM access: writing register %08x with value %08x\n",
 587                   cmd->offset, data->regval);
 588
 589         /* Write the data field to the specified register */
 590         wr32(hw, cmd->offset, data->regval);
 591
 592         return ICE_SUCCESS;
 593 }
 594
 595 /**
 596  * ice_handle_nvm_access - Handle an NVM access request
 597  * @hw: pointer to the HW struct
 598  * @cmd: NVM access command info
 599  * @data: pointer to read or return data
 600  *
 601  * Process an NVM access request. Read the command structure information and
 602  * determine if it is valid. If not, report an error indicating the command
 603  * was invalid.
 604  *
 605  * For valid commands, perform the necessary function, copying the data into
 606  * the provided data buffer.
 607  */
 608 enum ice_status
 609 ice_handle_nvm_access(struct ice_hw *hw, struct ice_nvm_access_cmd *cmd,
 610                       union ice_nvm_access_data *data)
 611 {
 612         u32 module, flags, adapter_info;
 613
 614         ice_debug(hw, ICE_DBG_TRACE, "%s\n", __func__);
 615
 616         /* Extended flags are currently reserved and must be zero */
 617         if ((cmd->config & ICE_NVM_CFG_EXT_FLAGS_M) != 0)
 618                 return ICE_ERR_PARAM;
 619
 620         /* Adapter info must match the HW device ID */
 621         adapter_info = ice_nvm_access_get_adapter(cmd);
 622         if (adapter_info != hw->device_id)
 623                 return ICE_ERR_PARAM;
 624
 625         switch (cmd->command) {
 626         case ICE_NVM_CMD_READ:
 627                 module = ice_nvm_access_get_module(cmd);
 628                 flags = ice_nvm_access_get_flags(cmd);
 629
 630                 /* Getting the driver's NVM features structure shares the same
 631                  * command type as reading a register. Read the config field
 632                  * to determine if this is a request to get features.
 633                  */
 634                 if (module == ICE_NVM_GET_FEATURES_MODULE &&
 635                     flags == ICE_NVM_GET_FEATURES_FLAGS &&
 636                     cmd->offset == 0)
 637                         return ice_nvm_access_get_features(cmd, data);
 638                 else
 639                         return ice_nvm_access_read(hw, cmd, data);
 640         case ICE_NVM_CMD_WRITE:
 641                 return ice_nvm_access_write(hw, cmd, data);
 642         default:
 643                 return ICE_ERR_PARAM;
 644         }
 645 }