1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2001-2020 Intel Corporation
5 #include "ice_common.h"
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
18 * Read the NVM using the admin queue commands (0x0701)
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,
25 struct ice_aq_desc desc;
26 struct ice_aqc_nvm *cmd;
28 ice_debug(hw, ICE_DBG_TRACE, "%s\n", __func__);
30 cmd = &desc.params.nvm;
32 if (offset > ICE_AQC_NVM_MAX_OFFSET)
35 ice_fill_dflt_direct_cmd_desc(&desc, ice_aqc_opc_nvm_read);
37 if (!read_shadow_ram && module_typeid == ICE_AQC_NVM_START_POINT)
38 cmd->cmd_flags |= ICE_AQC_NVM_FLASH_ONLY;
40 /* If this is the last command in a series, set the proper flag. */
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);
48 return ice_aq_send_cmd(hw, &desc, data, length, cd);
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
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.
63 * Returns a status code on failure. Note that the data pointer may be
64 * partially updated if some reads succeed before a failure.
67 ice_read_flat_nvm(struct ice_hw *hw, u32 offset, u32 *length, u8 *data,
70 enum ice_status status;
75 ice_debug(hw, ICE_DBG_TRACE, "%s\n", __func__);
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");
86 u32 read_size, sector_offset;
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
93 sector_offset = offset % ICE_AQ_MAX_BUF_LEN;
94 read_size = MIN_T(u32, ICE_AQ_MAX_BUF_LEN - sector_offset,
97 last_cmd = !(bytes_read + read_size < inlen);
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.
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);
110 bytes_read += read_size;
114 *length = bytes_read;
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
124 * Reads one 16 bit word from the Shadow RAM using ice_read_flat_nvm.
126 static enum ice_status
127 ice_read_sr_word_aq(struct ice_hw *hw, u16 offset, u16 *data)
129 u32 bytes = sizeof(u16);
130 enum ice_status status;
133 ice_debug(hw, ICE_DBG_TRACE, "%s\n", __func__);
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
139 status = ice_read_flat_nvm(hw, offset * sizeof(u16), &bytes,
140 (_FORCE_ u8 *)&data_local, true);
144 *data = LE16_TO_CPU(data_local);
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
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.
158 static enum ice_status
159 ice_read_sr_buf_aq(struct ice_hw *hw, u16 offset, u16 *words, u16 *data)
161 u32 bytes = *words * 2, i;
162 enum ice_status status;
164 ice_debug(hw, ICE_DBG_TRACE, "%s\n", __func__);
166 /* ice_read_flat_nvm takes into account the 4KB AdminQ and Shadow RAM
167 * sector restrictions necessary when reading from the NVM.
169 status = ice_read_flat_nvm(hw, offset * 2, &bytes, (u8 *)data, true);
171 /* Report the number of words successfully read */
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]);
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)
186 * This function will request NVM ownership.
189 ice_acquire_nvm(struct ice_hw *hw, enum ice_aq_res_access_type access)
191 ice_debug(hw, ICE_DBG_TRACE, "%s\n", __func__);
193 if (hw->flash.blank_nvm_mode)
196 return ice_acquire_res(hw, ICE_NVM_RES_ID, access, ICE_NVM_TIMEOUT);
200 * ice_release_nvm - Generic request for releasing the NVM ownership
201 * @hw: pointer to the HW structure
203 * This function will release NVM ownership.
205 void ice_release_nvm(struct ice_hw *hw)
207 ice_debug(hw, ICE_DBG_TRACE, "%s\n", __func__);
209 if (hw->flash.blank_nvm_mode)
212 ice_release_res(hw, ICE_NVM_RES_ID);
216 * ice_read_sr_word - Reads Shadow RAM word and acquire NVM if necessary
217 * @hw: pointer to the HW structure
218 * @offset: offset of the Shadow RAM word to read (0x000000 - 0x001FFF)
219 * @data: word read from the Shadow RAM
221 * Reads one 16 bit word from the Shadow RAM using the ice_read_sr_word_aq.
223 enum ice_status ice_read_sr_word(struct ice_hw *hw, u16 offset, u16 *data)
225 enum ice_status status;
227 status = ice_acquire_nvm(hw, ICE_RES_READ);
229 status = ice_read_sr_word_aq(hw, offset, data);
237 * ice_get_pfa_module_tlv - Reads sub module TLV from NVM PFA
238 * @hw: pointer to hardware structure
239 * @module_tlv: pointer to module TLV to return
240 * @module_tlv_len: pointer to module TLV length to return
241 * @module_type: module type requested
243 * Finds the requested sub module TLV type from the Preserved Field
244 * Area (PFA) and returns the TLV pointer and length. The caller can
245 * use these to read the variable length TLV value.
248 ice_get_pfa_module_tlv(struct ice_hw *hw, u16 *module_tlv, u16 *module_tlv_len,
251 enum ice_status status;
252 u16 pfa_len, pfa_ptr;
255 status = ice_read_sr_word(hw, ICE_SR_PFA_PTR, &pfa_ptr);
256 if (status != ICE_SUCCESS) {
257 ice_debug(hw, ICE_DBG_INIT, "Preserved Field Array pointer.\n");
260 status = ice_read_sr_word(hw, pfa_ptr, &pfa_len);
261 if (status != ICE_SUCCESS) {
262 ice_debug(hw, ICE_DBG_INIT, "Failed to read PFA length.\n");
265 /* Starting with first TLV after PFA length, iterate through the list
266 * of TLVs to find the requested one.
268 next_tlv = pfa_ptr + 1;
269 while (next_tlv < pfa_ptr + pfa_len) {
270 u16 tlv_sub_module_type;
274 status = ice_read_sr_word(hw, next_tlv, &tlv_sub_module_type);
275 if (status != ICE_SUCCESS) {
276 ice_debug(hw, ICE_DBG_INIT, "Failed to read TLV type.\n");
279 /* Read TLV length */
280 status = ice_read_sr_word(hw, next_tlv + 1, &tlv_len);
281 if (status != ICE_SUCCESS) {
282 ice_debug(hw, ICE_DBG_INIT, "Failed to read TLV length.\n");
285 if (tlv_sub_module_type == module_type) {
287 *module_tlv = next_tlv;
288 *module_tlv_len = tlv_len;
291 return ICE_ERR_INVAL_SIZE;
293 /* Check next TLV, i.e. current TLV pointer + length + 2 words
294 * (for current TLV's type and length)
296 next_tlv = next_tlv + tlv_len + 2;
298 /* Module does not exist */
299 return ICE_ERR_DOES_NOT_EXIST;
303 * ice_read_pba_string - Reads part number string from NVM
304 * @hw: pointer to hardware structure
305 * @pba_num: stores the part number string from the NVM
306 * @pba_num_size: part number string buffer length
308 * Reads the part number string from the NVM.
311 ice_read_pba_string(struct ice_hw *hw, u8 *pba_num, u32 pba_num_size)
313 u16 pba_tlv, pba_tlv_len;
314 enum ice_status status;
315 u16 pba_word, pba_size;
318 status = ice_get_pfa_module_tlv(hw, &pba_tlv, &pba_tlv_len,
319 ICE_SR_PBA_BLOCK_PTR);
320 if (status != ICE_SUCCESS) {
321 ice_debug(hw, ICE_DBG_INIT, "Failed to read PBA Block TLV.\n");
325 /* pba_size is the next word */
326 status = ice_read_sr_word(hw, (pba_tlv + 2), &pba_size);
327 if (status != ICE_SUCCESS) {
328 ice_debug(hw, ICE_DBG_INIT, "Failed to read PBA Section size.\n");
332 if (pba_tlv_len < pba_size) {
333 ice_debug(hw, ICE_DBG_INIT, "Invalid PBA Block TLV size.\n");
334 return ICE_ERR_INVAL_SIZE;
337 /* Subtract one to get PBA word count (PBA Size word is included in
341 if (pba_num_size < (((u32)pba_size * 2) + 1)) {
342 ice_debug(hw, ICE_DBG_INIT, "Buffer too small for PBA data.\n");
343 return ICE_ERR_PARAM;
346 for (i = 0; i < pba_size; i++) {
347 status = ice_read_sr_word(hw, (pba_tlv + 2 + 1) + i, &pba_word);
348 if (status != ICE_SUCCESS) {
349 ice_debug(hw, ICE_DBG_INIT, "Failed to read PBA Block word %d.\n", i);
353 pba_num[(i * 2)] = (pba_word >> 8) & 0xFF;
354 pba_num[(i * 2) + 1] = pba_word & 0xFF;
356 pba_num[(pba_size * 2)] = '\0';
362 * ice_get_nvm_ver_info - Read NVM version information
363 * @hw: pointer to the HW struct
364 * @nvm: pointer to NVM info structure
366 * Read the NVM EETRACK ID and map version of the main NVM image bank, filling
367 * in the nvm info structure.
369 static enum ice_status
370 ice_get_nvm_ver_info(struct ice_hw *hw, struct ice_nvm_info *nvm)
372 u16 eetrack_lo, eetrack_hi, ver;
373 enum ice_status status;
375 status = ice_read_sr_word(hw, ICE_SR_NVM_DEV_STARTER_VER, &ver);
377 ice_debug(hw, ICE_DBG_NVM, "Failed to read DEV starter version.\n");
380 nvm->major = (ver & ICE_NVM_VER_HI_MASK) >> ICE_NVM_VER_HI_SHIFT;
381 nvm->minor = (ver & ICE_NVM_VER_LO_MASK) >> ICE_NVM_VER_LO_SHIFT;
383 status = ice_read_sr_word(hw, ICE_SR_NVM_EETRACK_LO, &eetrack_lo);
385 ice_debug(hw, ICE_DBG_NVM, "Failed to read EETRACK lo.\n");
388 status = ice_read_sr_word(hw, ICE_SR_NVM_EETRACK_HI, &eetrack_hi);
390 ice_debug(hw, ICE_DBG_NVM, "Failed to read EETRACK hi.\n");
394 nvm->eetrack = (eetrack_hi << 16) | eetrack_lo;
400 * ice_get_orom_ver_info - Read Option ROM version information
401 * @hw: pointer to the HW struct
402 * @orom: pointer to Option ROM info structure
404 * Read the Combo Image version data from the Boot Configuration TLV and fill
405 * in the option ROM version data.
407 static enum ice_status
408 ice_get_orom_ver_info(struct ice_hw *hw, struct ice_orom_info *orom)
410 u16 combo_hi, combo_lo, boot_cfg_tlv, boot_cfg_tlv_len;
411 enum ice_status status;
414 status = ice_get_pfa_module_tlv(hw, &boot_cfg_tlv, &boot_cfg_tlv_len,
415 ICE_SR_BOOT_CFG_PTR);
417 ice_debug(hw, ICE_DBG_INIT, "Failed to read Boot Configuration Block TLV.\n");
421 /* Boot Configuration Block must have length at least 2 words
422 * (Combo Image Version High and Combo Image Version Low)
424 if (boot_cfg_tlv_len < 2) {
425 ice_debug(hw, ICE_DBG_INIT, "Invalid Boot Configuration Block TLV size.\n");
426 return ICE_ERR_INVAL_SIZE;
429 status = ice_read_sr_word(hw, (boot_cfg_tlv + ICE_NVM_OROM_VER_OFF),
432 ice_debug(hw, ICE_DBG_INIT, "Failed to read OROM_VER hi.\n");
436 status = ice_read_sr_word(hw, (boot_cfg_tlv + ICE_NVM_OROM_VER_OFF + 1),
439 ice_debug(hw, ICE_DBG_INIT, "Failed to read OROM_VER lo.\n");
443 combo_ver = ((u32)combo_hi << 16) | combo_lo;
445 orom->major = (u8)((combo_ver & ICE_OROM_VER_MASK) >>
447 orom->patch = (u8)(combo_ver & ICE_OROM_VER_PATCH_MASK);
448 orom->build = (u16)((combo_ver & ICE_OROM_VER_BUILD_MASK) >>
449 ICE_OROM_VER_BUILD_SHIFT);
455 * ice_discover_flash_size - Discover the available flash size.
456 * @hw: pointer to the HW struct
458 * The device flash could be up to 16MB in size. However, it is possible that
459 * the actual size is smaller. Use bisection to determine the accessible size
462 static enum ice_status ice_discover_flash_size(struct ice_hw *hw)
464 u32 min_size = 0, max_size = ICE_AQC_NVM_MAX_OFFSET + 1;
465 enum ice_status status;
467 ice_debug(hw, ICE_DBG_TRACE, "%s\n", __func__);
469 status = ice_acquire_nvm(hw, ICE_RES_READ);
473 while ((max_size - min_size) > 1) {
474 u32 offset = (max_size + min_size) / 2;
478 status = ice_read_flat_nvm(hw, offset, &len, &data, false);
479 if (status == ICE_ERR_AQ_ERROR &&
480 hw->adminq.sq_last_status == ICE_AQ_RC_EINVAL) {
481 ice_debug(hw, ICE_DBG_NVM, "%s: New upper bound of %u bytes\n",
483 status = ICE_SUCCESS;
485 } else if (!status) {
486 ice_debug(hw, ICE_DBG_NVM, "%s: New lower bound of %u bytes\n",
490 /* an unexpected error occurred */
491 goto err_read_flat_nvm;
495 ice_debug(hw, ICE_DBG_NVM, "Predicted flash size is %u bytes\n", max_size);
497 hw->flash.flash_size = max_size;
506 * ice_read_sr_pointer - Read the value of a Shadow RAM pointer word
507 * @hw: pointer to the HW structure
508 * @offset: the word offset of the Shadow RAM word to read
509 * @pointer: pointer value read from Shadow RAM
511 * Read the given Shadow RAM word, and convert it to a pointer value specified
512 * in bytes. This function assumes the specified offset is a valid pointer
515 * Each pointer word specifies whether it is stored in word size or 4KB
516 * sector size by using the highest bit. The reported pointer value will be in
517 * bytes, intended for flat NVM reads.
519 static enum ice_status
520 ice_read_sr_pointer(struct ice_hw *hw, u16 offset, u32 *pointer)
522 enum ice_status status;
525 status = ice_read_sr_word(hw, offset, &value);
529 /* Determine if the pointer is in 4KB or word units */
530 if (value & ICE_SR_NVM_PTR_4KB_UNITS)
531 *pointer = (value & ~ICE_SR_NVM_PTR_4KB_UNITS) * 4 * 1024;
533 *pointer = value * 2;
539 * ice_read_sr_area_size - Read an area size from a Shadow RAM word
540 * @hw: pointer to the HW structure
541 * @offset: the word offset of the Shadow RAM to read
542 * @size: size value read from the Shadow RAM
544 * Read the given Shadow RAM word, and convert it to an area size value
545 * specified in bytes. This function assumes the specified offset is a valid
548 * Each area size word is specified in 4KB sector units. This function reports
549 * the size in bytes, intended for flat NVM reads.
551 static enum ice_status
552 ice_read_sr_area_size(struct ice_hw *hw, u16 offset, u32 *size)
554 enum ice_status status;
557 status = ice_read_sr_word(hw, offset, &value);
561 /* Area sizes are always specified in 4KB units */
562 *size = value * 4 * 1024;
568 * ice_determine_active_flash_banks - Discover active bank for each module
569 * @hw: pointer to the HW struct
571 * Read the Shadow RAM control word and determine which banks are active for
572 * the NVM, OROM, and Netlist modules. Also read and calculate the associated
573 * pointer and size. These values are then cached into the ice_flash_info
574 * structure for later use in order to calculate the correct offset to read
575 * from the active module.
577 static enum ice_status
578 ice_determine_active_flash_banks(struct ice_hw *hw)
580 struct ice_bank_info *banks = &hw->flash.banks;
581 enum ice_status status;
584 status = ice_read_sr_word(hw, ICE_SR_NVM_CTRL_WORD, &ctrl_word);
586 ice_debug(hw, ICE_DBG_NVM, "Failed to read the Shadow RAM control word\n");
590 /* Check that the control word indicates validity */
591 if ((ctrl_word & ICE_SR_CTRL_WORD_1_M) >> ICE_SR_CTRL_WORD_1_S != ICE_SR_CTRL_WORD_VALID) {
592 ice_debug(hw, ICE_DBG_NVM, "Shadow RAM control word is invalid\n");
596 if (!(ctrl_word & ICE_SR_CTRL_WORD_NVM_BANK))
597 banks->nvm_bank = ICE_1ST_FLASH_BANK;
599 banks->nvm_bank = ICE_2ND_FLASH_BANK;
601 if (!(ctrl_word & ICE_SR_CTRL_WORD_OROM_BANK))
602 banks->orom_bank = ICE_1ST_FLASH_BANK;
604 banks->orom_bank = ICE_2ND_FLASH_BANK;
606 if (!(ctrl_word & ICE_SR_CTRL_WORD_NETLIST_BANK))
607 banks->netlist_bank = ICE_1ST_FLASH_BANK;
609 banks->netlist_bank = ICE_2ND_FLASH_BANK;
611 status = ice_read_sr_pointer(hw, ICE_SR_1ST_NVM_BANK_PTR, &banks->nvm_ptr);
613 ice_debug(hw, ICE_DBG_NVM, "Failed to read NVM bank pointer\n");
617 status = ice_read_sr_area_size(hw, ICE_SR_NVM_BANK_SIZE, &banks->nvm_size);
619 ice_debug(hw, ICE_DBG_NVM, "Failed to read NVM bank area size\n");
623 status = ice_read_sr_pointer(hw, ICE_SR_1ST_OROM_BANK_PTR, &banks->orom_ptr);
625 ice_debug(hw, ICE_DBG_NVM, "Failed to read OROM bank pointer\n");
629 status = ice_read_sr_area_size(hw, ICE_SR_OROM_BANK_SIZE, &banks->orom_size);
631 ice_debug(hw, ICE_DBG_NVM, "Failed to read OROM bank area size\n");
635 status = ice_read_sr_pointer(hw, ICE_SR_NETLIST_BANK_PTR, &banks->netlist_ptr);
637 ice_debug(hw, ICE_DBG_NVM, "Failed to read Netlist bank pointer\n");
641 status = ice_read_sr_area_size(hw, ICE_SR_NETLIST_BANK_SIZE, &banks->netlist_size);
643 ice_debug(hw, ICE_DBG_NVM, "Failed to read Netlist bank area size\n");
651 * ice_init_nvm - initializes NVM setting
652 * @hw: pointer to the HW struct
654 * This function reads and populates NVM settings such as Shadow RAM size,
655 * max_timeout, and blank_nvm_mode
657 enum ice_status ice_init_nvm(struct ice_hw *hw)
659 struct ice_flash_info *flash = &hw->flash;
660 enum ice_status status;
664 ice_debug(hw, ICE_DBG_TRACE, "%s\n", __func__);
666 /* The SR size is stored regardless of the NVM programming mode
667 * as the blank mode may be used in the factory line.
669 gens_stat = rd32(hw, GLNVM_GENS);
670 sr_size = (gens_stat & GLNVM_GENS_SR_SIZE_M) >> GLNVM_GENS_SR_SIZE_S;
672 /* Switching to words (sr_size contains power of 2) */
673 flash->sr_words = BIT(sr_size) * ICE_SR_WORDS_IN_1KB;
675 /* Check if we are in the normal or blank NVM programming mode */
676 fla = rd32(hw, GLNVM_FLA);
677 if (fla & GLNVM_FLA_LOCKED_M) { /* Normal programming mode */
678 flash->blank_nvm_mode = false;
680 /* Blank programming mode */
681 flash->blank_nvm_mode = true;
682 ice_debug(hw, ICE_DBG_NVM, "NVM init error: unsupported blank mode.\n");
683 return ICE_ERR_NVM_BLANK_MODE;
686 status = ice_discover_flash_size(hw);
688 ice_debug(hw, ICE_DBG_NVM, "NVM init error: failed to discover flash size.\n");
692 status = ice_determine_active_flash_banks(hw);
694 ice_debug(hw, ICE_DBG_NVM, "Failed to determine active flash banks.\n");
698 status = ice_get_nvm_ver_info(hw, &flash->nvm);
700 ice_debug(hw, ICE_DBG_INIT, "Failed to read NVM info.\n");
704 status = ice_get_orom_ver_info(hw, &flash->orom);
706 ice_debug(hw, ICE_DBG_INIT, "Failed to read Option ROM info.\n");
714 * ice_read_sr_buf - Reads Shadow RAM buf and acquire lock if necessary
715 * @hw: pointer to the HW structure
716 * @offset: offset of the Shadow RAM word to read (0x000000 - 0x001FFF)
717 * @words: (in) number of words to read; (out) number of words actually read
718 * @data: words read from the Shadow RAM
720 * Reads 16 bit words (data buf) from the SR using the ice_read_nvm_buf_aq
721 * method. The buf read is preceded by the NVM ownership take
722 * and followed by the release.
725 ice_read_sr_buf(struct ice_hw *hw, u16 offset, u16 *words, u16 *data)
727 enum ice_status status;
729 status = ice_acquire_nvm(hw, ICE_RES_READ);
731 status = ice_read_sr_buf_aq(hw, offset, words, data);
739 * ice_nvm_validate_checksum
740 * @hw: pointer to the HW struct
742 * Verify NVM PFA checksum validity (0x0706)
744 enum ice_status ice_nvm_validate_checksum(struct ice_hw *hw)
746 struct ice_aqc_nvm_checksum *cmd;
747 struct ice_aq_desc desc;
748 enum ice_status status;
750 status = ice_acquire_nvm(hw, ICE_RES_READ);
754 cmd = &desc.params.nvm_checksum;
756 ice_fill_dflt_direct_cmd_desc(&desc, ice_aqc_opc_nvm_checksum);
757 cmd->flags = ICE_AQC_NVM_CHECKSUM_VERIFY;
759 status = ice_aq_send_cmd(hw, &desc, NULL, 0, NULL);
763 if (LE16_TO_CPU(cmd->checksum) != ICE_AQC_NVM_CHECKSUM_CORRECT)
764 status = ICE_ERR_NVM_CHECKSUM;
770 * ice_nvm_access_get_features - Return the NVM access features structure
771 * @cmd: NVM access command to process
772 * @data: storage for the driver NVM features
774 * Fill in the data section of the NVM access request with a copy of the NVM
775 * features structure.
778 ice_nvm_access_get_features(struct ice_nvm_access_cmd *cmd,
779 union ice_nvm_access_data *data)
781 /* The provided data_size must be at least as large as our NVM
782 * features structure. A larger size should not be treated as an
783 * error, to allow future extensions to the features structure to
784 * work on older drivers.
786 if (cmd->data_size < sizeof(struct ice_nvm_features))
787 return ICE_ERR_NO_MEMORY;
789 /* Initialize the data buffer to zeros */
790 ice_memset(data, 0, cmd->data_size, ICE_NONDMA_MEM);
792 /* Fill in the features data */
793 data->drv_features.major = ICE_NVM_ACCESS_MAJOR_VER;
794 data->drv_features.minor = ICE_NVM_ACCESS_MINOR_VER;
795 data->drv_features.size = sizeof(struct ice_nvm_features);
796 data->drv_features.features[0] = ICE_NVM_FEATURES_0_REG_ACCESS;
802 * ice_nvm_access_get_module - Helper function to read module value
803 * @cmd: NVM access command structure
805 * Reads the module value out of the NVM access config field.
807 u32 ice_nvm_access_get_module(struct ice_nvm_access_cmd *cmd)
809 return ((cmd->config & ICE_NVM_CFG_MODULE_M) >> ICE_NVM_CFG_MODULE_S);
813 * ice_nvm_access_get_flags - Helper function to read flags value
814 * @cmd: NVM access command structure
816 * Reads the flags value out of the NVM access config field.
818 u32 ice_nvm_access_get_flags(struct ice_nvm_access_cmd *cmd)
820 return ((cmd->config & ICE_NVM_CFG_FLAGS_M) >> ICE_NVM_CFG_FLAGS_S);
824 * ice_nvm_access_get_adapter - Helper function to read adapter info
825 * @cmd: NVM access command structure
827 * Read the adapter info value out of the NVM access config field.
829 u32 ice_nvm_access_get_adapter(struct ice_nvm_access_cmd *cmd)
831 return ((cmd->config & ICE_NVM_CFG_ADAPTER_INFO_M) >>
832 ICE_NVM_CFG_ADAPTER_INFO_S);
836 * ice_validate_nvm_rw_reg - Check than an NVM access request is valid
837 * @cmd: NVM access command structure
839 * Validates that an NVM access structure is request to read or write a valid
840 * register offset. First validates that the module and flags are correct, and
841 * then ensures that the register offset is one of the accepted registers.
843 static enum ice_status
844 ice_validate_nvm_rw_reg(struct ice_nvm_access_cmd *cmd)
846 u32 module, flags, offset;
849 module = ice_nvm_access_get_module(cmd);
850 flags = ice_nvm_access_get_flags(cmd);
851 offset = cmd->offset;
853 /* Make sure the module and flags indicate a read/write request */
854 if (module != ICE_NVM_REG_RW_MODULE ||
855 flags != ICE_NVM_REG_RW_FLAGS ||
856 cmd->data_size != FIELD_SIZEOF(union ice_nvm_access_data, regval))
857 return ICE_ERR_PARAM;
861 case GL_HICR_EN: /* Note, this register is read only */
864 case GLGEN_CSR_DEBUG_C:
875 for (i = 0; i <= ICE_NVM_ACCESS_GL_HIDA_MAX; i++)
876 if (offset == (u32)GL_HIDA(i))
879 for (i = 0; i <= ICE_NVM_ACCESS_GL_HIBA_MAX; i++)
880 if (offset == (u32)GL_HIBA(i))
883 /* All other register offsets are not valid */
884 return ICE_ERR_OUT_OF_RANGE;
888 * ice_nvm_access_read - Handle an NVM read request
889 * @hw: pointer to the HW struct
890 * @cmd: NVM access command to process
891 * @data: storage for the register value read
893 * Process an NVM access request to read a register.
896 ice_nvm_access_read(struct ice_hw *hw, struct ice_nvm_access_cmd *cmd,
897 union ice_nvm_access_data *data)
899 enum ice_status status;
901 ice_debug(hw, ICE_DBG_TRACE, "%s\n", __func__);
903 /* Always initialize the output data, even on failure */
904 ice_memset(data, 0, cmd->data_size, ICE_NONDMA_MEM);
906 /* Make sure this is a valid read/write access request */
907 status = ice_validate_nvm_rw_reg(cmd);
911 ice_debug(hw, ICE_DBG_NVM, "NVM access: reading register %08x\n",
914 /* Read the register and store the contents in the data field */
915 data->regval = rd32(hw, cmd->offset);
921 * ice_nvm_access_write - Handle an NVM write request
922 * @hw: pointer to the HW struct
923 * @cmd: NVM access command to process
924 * @data: NVM access data to write
926 * Process an NVM access request to write a register.
929 ice_nvm_access_write(struct ice_hw *hw, struct ice_nvm_access_cmd *cmd,
930 union ice_nvm_access_data *data)
932 enum ice_status status;
934 ice_debug(hw, ICE_DBG_TRACE, "%s\n", __func__);
936 /* Make sure this is a valid read/write access request */
937 status = ice_validate_nvm_rw_reg(cmd);
941 /* Reject requests to write to read-only registers */
942 switch (cmd->offset) {
945 return ICE_ERR_OUT_OF_RANGE;
950 ice_debug(hw, ICE_DBG_NVM, "NVM access: writing register %08x with value %08x\n",
951 cmd->offset, data->regval);
953 /* Write the data field to the specified register */
954 wr32(hw, cmd->offset, data->regval);
960 * ice_handle_nvm_access - Handle an NVM access request
961 * @hw: pointer to the HW struct
962 * @cmd: NVM access command info
963 * @data: pointer to read or return data
965 * Process an NVM access request. Read the command structure information and
966 * determine if it is valid. If not, report an error indicating the command
969 * For valid commands, perform the necessary function, copying the data into
970 * the provided data buffer.
973 ice_handle_nvm_access(struct ice_hw *hw, struct ice_nvm_access_cmd *cmd,
974 union ice_nvm_access_data *data)
976 u32 module, flags, adapter_info;
978 ice_debug(hw, ICE_DBG_TRACE, "%s\n", __func__);
980 /* Extended flags are currently reserved and must be zero */
981 if ((cmd->config & ICE_NVM_CFG_EXT_FLAGS_M) != 0)
982 return ICE_ERR_PARAM;
984 /* Adapter info must match the HW device ID */
985 adapter_info = ice_nvm_access_get_adapter(cmd);
986 if (adapter_info != hw->device_id)
987 return ICE_ERR_PARAM;
989 switch (cmd->command) {
990 case ICE_NVM_CMD_READ:
991 module = ice_nvm_access_get_module(cmd);
992 flags = ice_nvm_access_get_flags(cmd);
994 /* Getting the driver's NVM features structure shares the same
995 * command type as reading a register. Read the config field
996 * to determine if this is a request to get features.
998 if (module == ICE_NVM_GET_FEATURES_MODULE &&
999 flags == ICE_NVM_GET_FEATURES_FLAGS &&
1001 return ice_nvm_access_get_features(cmd, data);
1003 return ice_nvm_access_read(hw, cmd, data);
1004 case ICE_NVM_CMD_WRITE:
1005 return ice_nvm_access_write(hw, cmd, data);
1007 return ICE_ERR_PARAM;