1 /*******************************************************************************
3 * Intel Ethernet Controller XL710 Family Linux Driver
4 * Copyright(c) 2013 - 2014 Intel Corporation.
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms and conditions of the GNU General Public License,
8 * version 2, as published by the Free Software Foundation.
10 * This program is distributed in the hope it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15 * You should have received a copy of the GNU General Public License along
16 * with this program. If not, see <http://www.gnu.org/licenses/>.
18 * The full GNU General Public License is included in this distribution in
19 * the file called "COPYING".
21 * Contact Information:
22 * e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
23 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
25 ******************************************************************************/
27 #include "i40e_prototype.h"
30 * i40e_init_nvm_ops - Initialize NVM function pointers
31 * @hw: pointer to the HW structure
33 * Setup the function pointers and the NVM info structure. Should be called
34 * once per NVM initialization, e.g. inside the i40e_init_shared_code().
35 * Please notice that the NVM term is used here (& in all methods covered
36 * in this file) as an equivalent of the FLASH part mapped into the SR.
37 * We are accessing FLASH always thru the Shadow RAM.
39 i40e_status
i40e_init_nvm(struct i40e_hw
*hw
)
41 struct i40e_nvm_info
*nvm
= &hw
->nvm
;
42 i40e_status ret_code
= 0;
46 /* The SR size is stored regardless of the nvm programming mode
47 * as the blank mode may be used in the factory line.
49 gens
= rd32(hw
, I40E_GLNVM_GENS
);
50 sr_size
= ((gens
& I40E_GLNVM_GENS_SR_SIZE_MASK
) >>
51 I40E_GLNVM_GENS_SR_SIZE_SHIFT
);
52 /* Switching to words (sr_size contains power of 2KB) */
53 nvm
->sr_size
= (1 << sr_size
) * I40E_SR_WORDS_IN_1KB
;
55 /* Check if we are in the normal or blank NVM programming mode */
56 fla
= rd32(hw
, I40E_GLNVM_FLA
);
57 if (fla
& I40E_GLNVM_FLA_LOCKED_MASK
) { /* Normal programming mode */
59 nvm
->timeout
= I40E_MAX_NVM_TIMEOUT
;
60 nvm
->blank_nvm_mode
= false;
61 } else { /* Blank programming mode */
62 nvm
->blank_nvm_mode
= true;
63 ret_code
= I40E_ERR_NVM_BLANK_MODE
;
64 i40e_debug(hw
, I40E_DEBUG_NVM
, "NVM init error: unsupported blank mode.\n");
71 * i40e_acquire_nvm - Generic request for acquiring the NVM ownership
72 * @hw: pointer to the HW structure
73 * @access: NVM access type (read or write)
75 * This function will request NVM ownership for reading
76 * via the proper Admin Command.
78 i40e_status
i40e_acquire_nvm(struct i40e_hw
*hw
,
79 enum i40e_aq_resource_access_type access
)
81 i40e_status ret_code
= 0;
85 if (hw
->nvm
.blank_nvm_mode
)
86 goto i40e_i40e_acquire_nvm_exit
;
88 ret_code
= i40e_aq_request_resource(hw
, I40E_NVM_RESOURCE_ID
, access
,
90 /* Reading the Global Device Timer */
91 gtime
= rd32(hw
, I40E_GLVFGEN_TIMER
);
93 /* Store the timeout */
94 hw
->nvm
.hw_semaphore_timeout
= I40E_MS_TO_GTIME(time_left
) + gtime
;
97 i40e_debug(hw
, I40E_DEBUG_NVM
,
98 "NVM acquire type %d failed time_left=%llu ret=%d aq_err=%d\n",
99 access
, time_left
, ret_code
, hw
->aq
.asq_last_status
);
101 if (ret_code
&& time_left
) {
102 /* Poll until the current NVM owner timeouts */
103 timeout
= I40E_MS_TO_GTIME(I40E_MAX_NVM_TIMEOUT
) + gtime
;
104 while ((gtime
< timeout
) && time_left
) {
105 usleep_range(10000, 20000);
106 gtime
= rd32(hw
, I40E_GLVFGEN_TIMER
);
107 ret_code
= i40e_aq_request_resource(hw
,
108 I40E_NVM_RESOURCE_ID
,
109 access
, 0, &time_left
,
112 hw
->nvm
.hw_semaphore_timeout
=
113 I40E_MS_TO_GTIME(time_left
) + gtime
;
118 hw
->nvm
.hw_semaphore_timeout
= 0;
119 i40e_debug(hw
, I40E_DEBUG_NVM
,
120 "NVM acquire timed out, wait %llu ms before trying again. status=%d aq_err=%d\n",
121 time_left
, ret_code
, hw
->aq
.asq_last_status
);
125 i40e_i40e_acquire_nvm_exit
:
130 * i40e_release_nvm - Generic request for releasing the NVM ownership
131 * @hw: pointer to the HW structure
133 * This function will release NVM resource via the proper Admin Command.
135 void i40e_release_nvm(struct i40e_hw
*hw
)
137 if (!hw
->nvm
.blank_nvm_mode
)
138 i40e_aq_release_resource(hw
, I40E_NVM_RESOURCE_ID
, 0, NULL
);
142 * i40e_poll_sr_srctl_done_bit - Polls the GLNVM_SRCTL done bit
143 * @hw: pointer to the HW structure
145 * Polls the SRCTL Shadow RAM register done bit.
147 static i40e_status
i40e_poll_sr_srctl_done_bit(struct i40e_hw
*hw
)
149 i40e_status ret_code
= I40E_ERR_TIMEOUT
;
152 /* Poll the I40E_GLNVM_SRCTL until the done bit is set */
153 for (wait_cnt
= 0; wait_cnt
< I40E_SRRD_SRCTL_ATTEMPTS
; wait_cnt
++) {
154 srctl
= rd32(hw
, I40E_GLNVM_SRCTL
);
155 if (srctl
& I40E_GLNVM_SRCTL_DONE_MASK
) {
161 if (ret_code
== I40E_ERR_TIMEOUT
)
162 i40e_debug(hw
, I40E_DEBUG_NVM
, "Done bit in GLNVM_SRCTL not set");
167 * i40e_read_nvm_word_srctl - Reads Shadow RAM via SRCTL register
168 * @hw: pointer to the HW structure
169 * @offset: offset of the Shadow RAM word to read (0x000000 - 0x001FFF)
170 * @data: word read from the Shadow RAM
172 * Reads one 16 bit word from the Shadow RAM using the GLNVM_SRCTL register.
174 static i40e_status
i40e_read_nvm_word_srctl(struct i40e_hw
*hw
, u16 offset
,
177 i40e_status ret_code
= I40E_ERR_TIMEOUT
;
180 if (offset
>= hw
->nvm
.sr_size
) {
181 i40e_debug(hw
, I40E_DEBUG_NVM
,
182 "NVM read error: offset %d beyond Shadow RAM limit %d\n",
183 offset
, hw
->nvm
.sr_size
);
184 ret_code
= I40E_ERR_PARAM
;
188 /* Poll the done bit first */
189 ret_code
= i40e_poll_sr_srctl_done_bit(hw
);
191 /* Write the address and start reading */
192 sr_reg
= (u32
)(offset
<< I40E_GLNVM_SRCTL_ADDR_SHIFT
) |
193 (1 << I40E_GLNVM_SRCTL_START_SHIFT
);
194 wr32(hw
, I40E_GLNVM_SRCTL
, sr_reg
);
196 /* Poll I40E_GLNVM_SRCTL until the done bit is set */
197 ret_code
= i40e_poll_sr_srctl_done_bit(hw
);
199 sr_reg
= rd32(hw
, I40E_GLNVM_SRDATA
);
200 *data
= (u16
)((sr_reg
&
201 I40E_GLNVM_SRDATA_RDDATA_MASK
)
202 >> I40E_GLNVM_SRDATA_RDDATA_SHIFT
);
206 i40e_debug(hw
, I40E_DEBUG_NVM
,
207 "NVM read error: Couldn't access Shadow RAM address: 0x%x\n",
215 * i40e_read_nvm_word - Reads Shadow RAM
216 * @hw: pointer to the HW structure
217 * @offset: offset of the Shadow RAM word to read (0x000000 - 0x001FFF)
218 * @data: word read from the Shadow RAM
220 * Reads one 16 bit word from the Shadow RAM using the GLNVM_SRCTL register.
222 i40e_status
i40e_read_nvm_word(struct i40e_hw
*hw
, u16 offset
,
225 return i40e_read_nvm_word_srctl(hw
, offset
, data
);
229 * i40e_read_nvm_buffer_srctl - Reads Shadow RAM buffer via SRCTL register
230 * @hw: pointer to the HW structure
231 * @offset: offset of the Shadow RAM word to read (0x000000 - 0x001FFF).
232 * @words: (in) number of words to read; (out) number of words actually read
233 * @data: words read from the Shadow RAM
235 * Reads 16 bit words (data buffer) from the SR using the i40e_read_nvm_srrd()
236 * method. The buffer read is preceded by the NVM ownership take
237 * and followed by the release.
239 static i40e_status
i40e_read_nvm_buffer_srctl(struct i40e_hw
*hw
, u16 offset
,
240 u16
*words
, u16
*data
)
242 i40e_status ret_code
= 0;
245 /* Loop thru the selected region */
246 for (word
= 0; word
< *words
; word
++) {
247 index
= offset
+ word
;
248 ret_code
= i40e_read_nvm_word_srctl(hw
, index
, &data
[word
]);
253 /* Update the number of words read from the Shadow RAM */
260 * i40e_read_nvm_buffer - Reads Shadow RAM buffer
261 * @hw: pointer to the HW structure
262 * @offset: offset of the Shadow RAM word to read (0x000000 - 0x001FFF).
263 * @words: (in) number of words to read; (out) number of words actually read
264 * @data: words read from the Shadow RAM
266 * Reads 16 bit words (data buffer) from the SR using the i40e_read_nvm_srrd()
267 * method. The buffer read is preceded by the NVM ownership take
268 * and followed by the release.
270 i40e_status
i40e_read_nvm_buffer(struct i40e_hw
*hw
, u16 offset
,
271 u16
*words
, u16
*data
)
273 return i40e_read_nvm_buffer_srctl(hw
, offset
, words
, data
);
277 * i40e_write_nvm_aq - Writes Shadow RAM.
278 * @hw: pointer to the HW structure.
279 * @module_pointer: module pointer location in words from the NVM beginning
280 * @offset: offset in words from module start
281 * @words: number of words to write
282 * @data: buffer with words to write to the Shadow RAM
283 * @last_command: tells the AdminQ that this is the last command
285 * Writes a 16 bit words buffer to the Shadow RAM using the admin command.
287 static i40e_status
i40e_write_nvm_aq(struct i40e_hw
*hw
, u8 module_pointer
,
288 u32 offset
, u16 words
, void *data
,
291 i40e_status ret_code
= I40E_ERR_NVM
;
293 /* Here we are checking the SR limit only for the flat memory model.
294 * We cannot do it for the module-based model, as we did not acquire
295 * the NVM resource yet (we cannot get the module pointer value).
296 * Firmware will check the module-based model.
298 if ((offset
+ words
) > hw
->nvm
.sr_size
)
299 i40e_debug(hw
, I40E_DEBUG_NVM
,
300 "NVM write error: offset %d beyond Shadow RAM limit %d\n",
301 (offset
+ words
), hw
->nvm
.sr_size
);
302 else if (words
> I40E_SR_SECTOR_SIZE_IN_WORDS
)
303 /* We can write only up to 4KB (one sector), in one AQ write */
304 i40e_debug(hw
, I40E_DEBUG_NVM
,
305 "NVM write fail error: tried to write %d words, limit is %d.\n",
306 words
, I40E_SR_SECTOR_SIZE_IN_WORDS
);
307 else if (((offset
+ (words
- 1)) / I40E_SR_SECTOR_SIZE_IN_WORDS
)
308 != (offset
/ I40E_SR_SECTOR_SIZE_IN_WORDS
))
309 /* A single write cannot spread over two sectors */
310 i40e_debug(hw
, I40E_DEBUG_NVM
,
311 "NVM write error: cannot spread over two sectors in a single write offset=%d words=%d\n",
314 ret_code
= i40e_aq_update_nvm(hw
, module_pointer
,
315 2 * offset
, /*bytes*/
317 data
, last_command
, NULL
);
323 * i40e_calc_nvm_checksum - Calculates and returns the checksum
324 * @hw: pointer to hardware structure
325 * @checksum: pointer to the checksum
327 * This function calculates SW Checksum that covers the whole 64kB shadow RAM
328 * except the VPD and PCIe ALT Auto-load modules. The structure and size of VPD
329 * is customer specific and unknown. Therefore, this function skips all maximum
330 * possible size of VPD (1kB).
332 static i40e_status
i40e_calc_nvm_checksum(struct i40e_hw
*hw
,
335 i40e_status ret_code
= 0;
336 struct i40e_virt_mem vmem
;
337 u16 pcie_alt_module
= 0;
338 u16 checksum_local
= 0;
343 ret_code
= i40e_allocate_virt_mem(hw
, &vmem
,
344 I40E_SR_SECTOR_SIZE_IN_WORDS
* sizeof(u16
));
346 goto i40e_calc_nvm_checksum_exit
;
347 data
= (u16
*)vmem
.va
;
349 /* read pointer to VPD area */
350 ret_code
= i40e_read_nvm_word(hw
, I40E_SR_VPD_PTR
, &vpd_module
);
352 ret_code
= I40E_ERR_NVM_CHECKSUM
;
353 goto i40e_calc_nvm_checksum_exit
;
356 /* read pointer to PCIe Alt Auto-load module */
357 ret_code
= i40e_read_nvm_word(hw
, I40E_SR_PCIE_ALT_AUTO_LOAD_PTR
,
360 ret_code
= I40E_ERR_NVM_CHECKSUM
;
361 goto i40e_calc_nvm_checksum_exit
;
364 /* Calculate SW checksum that covers the whole 64kB shadow RAM
365 * except the VPD and PCIe ALT Auto-load modules
367 for (i
= 0; i
< hw
->nvm
.sr_size
; i
++) {
369 if ((i
% I40E_SR_SECTOR_SIZE_IN_WORDS
) == 0) {
370 u16 words
= I40E_SR_SECTOR_SIZE_IN_WORDS
;
372 ret_code
= i40e_read_nvm_buffer(hw
, i
, &words
, data
);
374 ret_code
= I40E_ERR_NVM_CHECKSUM
;
375 goto i40e_calc_nvm_checksum_exit
;
379 /* Skip Checksum word */
380 if (i
== I40E_SR_SW_CHECKSUM_WORD
)
382 /* Skip VPD module (convert byte size to word count) */
383 if ((i
>= (u32
)vpd_module
) &&
384 (i
< ((u32
)vpd_module
+
385 (I40E_SR_VPD_MODULE_MAX_SIZE
/ 2)))) {
388 /* Skip PCIe ALT module (convert byte size to word count) */
389 if ((i
>= (u32
)pcie_alt_module
) &&
390 (i
< ((u32
)pcie_alt_module
+
391 (I40E_SR_PCIE_ALT_MODULE_MAX_SIZE
/ 2)))) {
395 checksum_local
+= data
[i
% I40E_SR_SECTOR_SIZE_IN_WORDS
];
398 *checksum
= (u16
)I40E_SR_SW_CHECKSUM_BASE
- checksum_local
;
400 i40e_calc_nvm_checksum_exit
:
401 i40e_free_virt_mem(hw
, &vmem
);
406 * i40e_update_nvm_checksum - Updates the NVM checksum
407 * @hw: pointer to hardware structure
409 * NVM ownership must be acquired before calling this function and released
410 * on ARQ completion event reception by caller.
411 * This function will commit SR to NVM.
413 i40e_status
i40e_update_nvm_checksum(struct i40e_hw
*hw
)
415 i40e_status ret_code
= 0;
418 ret_code
= i40e_calc_nvm_checksum(hw
, &checksum
);
420 ret_code
= i40e_write_nvm_aq(hw
, 0x00, I40E_SR_SW_CHECKSUM_WORD
,
427 * i40e_validate_nvm_checksum - Validate EEPROM checksum
428 * @hw: pointer to hardware structure
429 * @checksum: calculated checksum
431 * Performs checksum calculation and validates the NVM SW checksum. If the
432 * caller does not need checksum, the value can be NULL.
434 i40e_status
i40e_validate_nvm_checksum(struct i40e_hw
*hw
,
437 i40e_status ret_code
= 0;
439 u16 checksum_local
= 0;
441 ret_code
= i40e_calc_nvm_checksum(hw
, &checksum_local
);
443 goto i40e_validate_nvm_checksum_exit
;
445 /* Do not use i40e_read_nvm_word() because we do not want to take
446 * the synchronization semaphores twice here.
448 i40e_read_nvm_word(hw
, I40E_SR_SW_CHECKSUM_WORD
, &checksum_sr
);
450 /* Verify read checksum from EEPROM is the same as
451 * calculated checksum
453 if (checksum_local
!= checksum_sr
)
454 ret_code
= I40E_ERR_NVM_CHECKSUM
;
456 /* If the user cares, return the calculated checksum */
458 *checksum
= checksum_local
;
460 i40e_validate_nvm_checksum_exit
:
464 static i40e_status
i40e_nvmupd_state_init(struct i40e_hw
*hw
,
465 struct i40e_nvm_access
*cmd
,
466 u8
*bytes
, int *errno
);
467 static i40e_status
i40e_nvmupd_state_reading(struct i40e_hw
*hw
,
468 struct i40e_nvm_access
*cmd
,
469 u8
*bytes
, int *errno
);
470 static i40e_status
i40e_nvmupd_state_writing(struct i40e_hw
*hw
,
471 struct i40e_nvm_access
*cmd
,
472 u8
*bytes
, int *errno
);
473 static enum i40e_nvmupd_cmd
i40e_nvmupd_validate_command(struct i40e_hw
*hw
,
474 struct i40e_nvm_access
*cmd
,
476 static i40e_status
i40e_nvmupd_nvm_erase(struct i40e_hw
*hw
,
477 struct i40e_nvm_access
*cmd
,
479 static i40e_status
i40e_nvmupd_nvm_write(struct i40e_hw
*hw
,
480 struct i40e_nvm_access
*cmd
,
481 u8
*bytes
, int *errno
);
482 static i40e_status
i40e_nvmupd_nvm_read(struct i40e_hw
*hw
,
483 struct i40e_nvm_access
*cmd
,
484 u8
*bytes
, int *errno
);
485 static inline u8
i40e_nvmupd_get_module(u32 val
)
487 return (u8
)(val
& I40E_NVM_MOD_PNT_MASK
);
489 static inline u8
i40e_nvmupd_get_transaction(u32 val
)
491 return (u8
)((val
& I40E_NVM_TRANS_MASK
) >> I40E_NVM_TRANS_SHIFT
);
494 static char *i40e_nvm_update_state_str
[] = {
495 "I40E_NVMUPD_INVALID",
496 "I40E_NVMUPD_READ_CON",
497 "I40E_NVMUPD_READ_SNT",
498 "I40E_NVMUPD_READ_LCB",
499 "I40E_NVMUPD_READ_SA",
500 "I40E_NVMUPD_WRITE_ERA",
501 "I40E_NVMUPD_WRITE_CON",
502 "I40E_NVMUPD_WRITE_SNT",
503 "I40E_NVMUPD_WRITE_LCB",
504 "I40E_NVMUPD_WRITE_SA",
505 "I40E_NVMUPD_CSUM_CON",
506 "I40E_NVMUPD_CSUM_SA",
507 "I40E_NVMUPD_CSUM_LCB",
511 * i40e_nvmupd_command - Process an NVM update command
512 * @hw: pointer to hardware structure
513 * @cmd: pointer to nvm update command
514 * @bytes: pointer to the data buffer
515 * @errno: pointer to return error code
517 * Dispatches command depending on what update state is current
519 i40e_status
i40e_nvmupd_command(struct i40e_hw
*hw
,
520 struct i40e_nvm_access
*cmd
,
521 u8
*bytes
, int *errno
)
528 switch (hw
->nvmupd_state
) {
529 case I40E_NVMUPD_STATE_INIT
:
530 status
= i40e_nvmupd_state_init(hw
, cmd
, bytes
, errno
);
533 case I40E_NVMUPD_STATE_READING
:
534 status
= i40e_nvmupd_state_reading(hw
, cmd
, bytes
, errno
);
537 case I40E_NVMUPD_STATE_WRITING
:
538 status
= i40e_nvmupd_state_writing(hw
, cmd
, bytes
, errno
);
542 /* invalid state, should never happen */
543 i40e_debug(hw
, I40E_DEBUG_NVM
,
544 "NVMUPD: no such state %d\n", hw
->nvmupd_state
);
545 status
= I40E_NOT_SUPPORTED
;
553 * i40e_nvmupd_state_init - Handle NVM update state Init
554 * @hw: pointer to hardware structure
555 * @cmd: pointer to nvm update command buffer
556 * @bytes: pointer to the data buffer
557 * @errno: pointer to return error code
559 * Process legitimate commands of the Init state and conditionally set next
560 * state. Reject all other commands.
562 static i40e_status
i40e_nvmupd_state_init(struct i40e_hw
*hw
,
563 struct i40e_nvm_access
*cmd
,
564 u8
*bytes
, int *errno
)
566 i40e_status status
= 0;
567 enum i40e_nvmupd_cmd upd_cmd
;
569 upd_cmd
= i40e_nvmupd_validate_command(hw
, cmd
, errno
);
572 case I40E_NVMUPD_READ_SA
:
573 status
= i40e_acquire_nvm(hw
, I40E_RESOURCE_READ
);
575 *errno
= i40e_aq_rc_to_posix(status
,
576 hw
->aq
.asq_last_status
);
578 status
= i40e_nvmupd_nvm_read(hw
, cmd
, bytes
, errno
);
579 i40e_release_nvm(hw
);
583 case I40E_NVMUPD_READ_SNT
:
584 status
= i40e_acquire_nvm(hw
, I40E_RESOURCE_READ
);
586 *errno
= i40e_aq_rc_to_posix(status
,
587 hw
->aq
.asq_last_status
);
589 status
= i40e_nvmupd_nvm_read(hw
, cmd
, bytes
, errno
);
591 i40e_release_nvm(hw
);
593 hw
->nvmupd_state
= I40E_NVMUPD_STATE_READING
;
597 case I40E_NVMUPD_WRITE_ERA
:
598 status
= i40e_acquire_nvm(hw
, I40E_RESOURCE_WRITE
);
600 *errno
= i40e_aq_rc_to_posix(status
,
601 hw
->aq
.asq_last_status
);
603 status
= i40e_nvmupd_nvm_erase(hw
, cmd
, errno
);
605 i40e_release_nvm(hw
);
607 hw
->aq
.nvm_release_on_done
= true;
611 case I40E_NVMUPD_WRITE_SA
:
612 status
= i40e_acquire_nvm(hw
, I40E_RESOURCE_WRITE
);
614 *errno
= i40e_aq_rc_to_posix(status
,
615 hw
->aq
.asq_last_status
);
617 status
= i40e_nvmupd_nvm_write(hw
, cmd
, bytes
, errno
);
619 i40e_release_nvm(hw
);
621 hw
->aq
.nvm_release_on_done
= true;
625 case I40E_NVMUPD_WRITE_SNT
:
626 status
= i40e_acquire_nvm(hw
, I40E_RESOURCE_WRITE
);
628 *errno
= i40e_aq_rc_to_posix(status
,
629 hw
->aq
.asq_last_status
);
631 status
= i40e_nvmupd_nvm_write(hw
, cmd
, bytes
, errno
);
633 i40e_release_nvm(hw
);
635 hw
->nvmupd_state
= I40E_NVMUPD_STATE_WRITING
;
639 case I40E_NVMUPD_CSUM_SA
:
640 status
= i40e_acquire_nvm(hw
, I40E_RESOURCE_WRITE
);
642 *errno
= i40e_aq_rc_to_posix(status
,
643 hw
->aq
.asq_last_status
);
645 status
= i40e_update_nvm_checksum(hw
);
647 *errno
= hw
->aq
.asq_last_status
?
648 i40e_aq_rc_to_posix(status
,
649 hw
->aq
.asq_last_status
) :
651 i40e_release_nvm(hw
);
653 hw
->aq
.nvm_release_on_done
= true;
659 i40e_debug(hw
, I40E_DEBUG_NVM
,
660 "NVMUPD: bad cmd %s in init state\n",
661 i40e_nvm_update_state_str
[upd_cmd
]);
662 status
= I40E_ERR_NVM
;
670 * i40e_nvmupd_state_reading - Handle NVM update state Reading
671 * @hw: pointer to hardware structure
672 * @cmd: pointer to nvm update command buffer
673 * @bytes: pointer to the data buffer
674 * @errno: pointer to return error code
676 * NVM ownership is already held. Process legitimate commands and set any
677 * change in state; reject all other commands.
679 static i40e_status
i40e_nvmupd_state_reading(struct i40e_hw
*hw
,
680 struct i40e_nvm_access
*cmd
,
681 u8
*bytes
, int *errno
)
684 enum i40e_nvmupd_cmd upd_cmd
;
686 upd_cmd
= i40e_nvmupd_validate_command(hw
, cmd
, errno
);
689 case I40E_NVMUPD_READ_SA
:
690 case I40E_NVMUPD_READ_CON
:
691 status
= i40e_nvmupd_nvm_read(hw
, cmd
, bytes
, errno
);
694 case I40E_NVMUPD_READ_LCB
:
695 status
= i40e_nvmupd_nvm_read(hw
, cmd
, bytes
, errno
);
696 i40e_release_nvm(hw
);
697 hw
->nvmupd_state
= I40E_NVMUPD_STATE_INIT
;
701 i40e_debug(hw
, I40E_DEBUG_NVM
,
702 "NVMUPD: bad cmd %s in reading state.\n",
703 i40e_nvm_update_state_str
[upd_cmd
]);
704 status
= I40E_NOT_SUPPORTED
;
712 * i40e_nvmupd_state_writing - Handle NVM update state Writing
713 * @hw: pointer to hardware structure
714 * @cmd: pointer to nvm update command buffer
715 * @bytes: pointer to the data buffer
716 * @errno: pointer to return error code
718 * NVM ownership is already held. Process legitimate commands and set any
719 * change in state; reject all other commands
721 static i40e_status
i40e_nvmupd_state_writing(struct i40e_hw
*hw
,
722 struct i40e_nvm_access
*cmd
,
723 u8
*bytes
, int *errno
)
726 enum i40e_nvmupd_cmd upd_cmd
;
727 bool retry_attempt
= false;
729 upd_cmd
= i40e_nvmupd_validate_command(hw
, cmd
, errno
);
733 case I40E_NVMUPD_WRITE_CON
:
734 status
= i40e_nvmupd_nvm_write(hw
, cmd
, bytes
, errno
);
737 case I40E_NVMUPD_WRITE_LCB
:
738 status
= i40e_nvmupd_nvm_write(hw
, cmd
, bytes
, errno
);
740 hw
->aq
.nvm_release_on_done
= true;
741 hw
->nvmupd_state
= I40E_NVMUPD_STATE_INIT
;
744 case I40E_NVMUPD_CSUM_CON
:
745 status
= i40e_update_nvm_checksum(hw
);
747 *errno
= hw
->aq
.asq_last_status
?
748 i40e_aq_rc_to_posix(status
,
749 hw
->aq
.asq_last_status
) :
751 hw
->nvmupd_state
= I40E_NVMUPD_STATE_INIT
;
755 case I40E_NVMUPD_CSUM_LCB
:
756 status
= i40e_update_nvm_checksum(hw
);
758 *errno
= hw
->aq
.asq_last_status
?
759 i40e_aq_rc_to_posix(status
,
760 hw
->aq
.asq_last_status
) :
763 hw
->aq
.nvm_release_on_done
= true;
764 hw
->nvmupd_state
= I40E_NVMUPD_STATE_INIT
;
768 i40e_debug(hw
, I40E_DEBUG_NVM
,
769 "NVMUPD: bad cmd %s in writing state.\n",
770 i40e_nvm_update_state_str
[upd_cmd
]);
771 status
= I40E_NOT_SUPPORTED
;
776 /* In some circumstances, a multi-write transaction takes longer
777 * than the default 3 minute timeout on the write semaphore. If
778 * the write failed with an EBUSY status, this is likely the problem,
779 * so here we try to reacquire the semaphore then retry the write.
780 * We only do one retry, then give up.
782 if (status
&& (hw
->aq
.asq_last_status
== I40E_AQ_RC_EBUSY
) &&
784 i40e_status old_status
= status
;
785 u32 old_asq_status
= hw
->aq
.asq_last_status
;
788 gtime
= rd32(hw
, I40E_GLVFGEN_TIMER
);
789 if (gtime
>= hw
->nvm
.hw_semaphore_timeout
) {
790 i40e_debug(hw
, I40E_DEBUG_ALL
,
791 "NVMUPD: write semaphore expired (%d >= %lld), retrying\n",
792 gtime
, hw
->nvm
.hw_semaphore_timeout
);
793 i40e_release_nvm(hw
);
794 status
= i40e_acquire_nvm(hw
, I40E_RESOURCE_WRITE
);
796 i40e_debug(hw
, I40E_DEBUG_ALL
,
797 "NVMUPD: write semaphore reacquire failed aq_err = %d\n",
798 hw
->aq
.asq_last_status
);
800 hw
->aq
.asq_last_status
= old_asq_status
;
802 retry_attempt
= true;
812 * i40e_nvmupd_validate_command - Validate given command
813 * @hw: pointer to hardware structure
814 * @cmd: pointer to nvm update command buffer
815 * @errno: pointer to return error code
817 * Return one of the valid command types or I40E_NVMUPD_INVALID
819 static enum i40e_nvmupd_cmd
i40e_nvmupd_validate_command(struct i40e_hw
*hw
,
820 struct i40e_nvm_access
*cmd
,
823 enum i40e_nvmupd_cmd upd_cmd
;
824 u8 transaction
, module
;
826 /* anything that doesn't match a recognized case is an error */
827 upd_cmd
= I40E_NVMUPD_INVALID
;
829 transaction
= i40e_nvmupd_get_transaction(cmd
->config
);
830 module
= i40e_nvmupd_get_module(cmd
->config
);
832 /* limits on data size */
833 if ((cmd
->data_size
< 1) ||
834 (cmd
->data_size
> I40E_NVMUPD_MAX_DATA
)) {
835 i40e_debug(hw
, I40E_DEBUG_NVM
,
836 "i40e_nvmupd_validate_command data_size %d\n",
839 return I40E_NVMUPD_INVALID
;
842 switch (cmd
->command
) {
844 switch (transaction
) {
846 upd_cmd
= I40E_NVMUPD_READ_CON
;
849 upd_cmd
= I40E_NVMUPD_READ_SNT
;
852 upd_cmd
= I40E_NVMUPD_READ_LCB
;
855 upd_cmd
= I40E_NVMUPD_READ_SA
;
861 switch (transaction
) {
863 upd_cmd
= I40E_NVMUPD_WRITE_CON
;
866 upd_cmd
= I40E_NVMUPD_WRITE_SNT
;
869 upd_cmd
= I40E_NVMUPD_WRITE_LCB
;
872 upd_cmd
= I40E_NVMUPD_WRITE_SA
;
875 upd_cmd
= I40E_NVMUPD_WRITE_ERA
;
878 upd_cmd
= I40E_NVMUPD_CSUM_CON
;
880 case (I40E_NVM_CSUM
|I40E_NVM_SA
):
881 upd_cmd
= I40E_NVMUPD_CSUM_SA
;
883 case (I40E_NVM_CSUM
|I40E_NVM_LCB
):
884 upd_cmd
= I40E_NVMUPD_CSUM_LCB
;
889 i40e_debug(hw
, I40E_DEBUG_NVM
, "%s state %d nvm_release_on_hold %d\n",
890 i40e_nvm_update_state_str
[upd_cmd
],
892 hw
->aq
.nvm_release_on_done
);
894 if (upd_cmd
== I40E_NVMUPD_INVALID
) {
896 i40e_debug(hw
, I40E_DEBUG_NVM
,
897 "i40e_nvmupd_validate_command returns %d errno %d\n",
904 * i40e_nvmupd_nvm_read - Read NVM
905 * @hw: pointer to hardware structure
906 * @cmd: pointer to nvm update command buffer
907 * @bytes: pointer to the data buffer
908 * @errno: pointer to return error code
910 * cmd structure contains identifiers and data buffer
912 static i40e_status
i40e_nvmupd_nvm_read(struct i40e_hw
*hw
,
913 struct i40e_nvm_access
*cmd
,
914 u8
*bytes
, int *errno
)
917 u8 module
, transaction
;
920 transaction
= i40e_nvmupd_get_transaction(cmd
->config
);
921 module
= i40e_nvmupd_get_module(cmd
->config
);
922 last
= (transaction
== I40E_NVM_LCB
) || (transaction
== I40E_NVM_SA
);
924 status
= i40e_aq_read_nvm(hw
, module
, cmd
->offset
, (u16
)cmd
->data_size
,
927 i40e_debug(hw
, I40E_DEBUG_NVM
,
928 "i40e_nvmupd_nvm_read mod 0x%x off 0x%x len 0x%x\n",
929 module
, cmd
->offset
, cmd
->data_size
);
930 i40e_debug(hw
, I40E_DEBUG_NVM
,
931 "i40e_nvmupd_nvm_read status %d aq %d\n",
932 status
, hw
->aq
.asq_last_status
);
933 *errno
= i40e_aq_rc_to_posix(status
, hw
->aq
.asq_last_status
);
940 * i40e_nvmupd_nvm_erase - Erase an NVM module
941 * @hw: pointer to hardware structure
942 * @cmd: pointer to nvm update command buffer
943 * @errno: pointer to return error code
945 * module, offset, data_size and data are in cmd structure
947 static i40e_status
i40e_nvmupd_nvm_erase(struct i40e_hw
*hw
,
948 struct i40e_nvm_access
*cmd
,
951 i40e_status status
= 0;
952 u8 module
, transaction
;
955 transaction
= i40e_nvmupd_get_transaction(cmd
->config
);
956 module
= i40e_nvmupd_get_module(cmd
->config
);
957 last
= (transaction
& I40E_NVM_LCB
);
958 status
= i40e_aq_erase_nvm(hw
, module
, cmd
->offset
, (u16
)cmd
->data_size
,
961 i40e_debug(hw
, I40E_DEBUG_NVM
,
962 "i40e_nvmupd_nvm_erase mod 0x%x off 0x%x len 0x%x\n",
963 module
, cmd
->offset
, cmd
->data_size
);
964 i40e_debug(hw
, I40E_DEBUG_NVM
,
965 "i40e_nvmupd_nvm_erase status %d aq %d\n",
966 status
, hw
->aq
.asq_last_status
);
967 *errno
= i40e_aq_rc_to_posix(status
, hw
->aq
.asq_last_status
);
974 * i40e_nvmupd_nvm_write - Write NVM
975 * @hw: pointer to hardware structure
976 * @cmd: pointer to nvm update command buffer
977 * @bytes: pointer to the data buffer
978 * @errno: pointer to return error code
980 * module, offset, data_size and data are in cmd structure
982 static i40e_status
i40e_nvmupd_nvm_write(struct i40e_hw
*hw
,
983 struct i40e_nvm_access
*cmd
,
984 u8
*bytes
, int *errno
)
986 i40e_status status
= 0;
987 u8 module
, transaction
;
990 transaction
= i40e_nvmupd_get_transaction(cmd
->config
);
991 module
= i40e_nvmupd_get_module(cmd
->config
);
992 last
= (transaction
& I40E_NVM_LCB
);
994 status
= i40e_aq_update_nvm(hw
, module
, cmd
->offset
,
995 (u16
)cmd
->data_size
, bytes
, last
, NULL
);
997 i40e_debug(hw
, I40E_DEBUG_NVM
,
998 "i40e_nvmupd_nvm_write mod 0x%x off 0x%x len 0x%x\n",
999 module
, cmd
->offset
, cmd
->data_size
);
1000 i40e_debug(hw
, I40E_DEBUG_NVM
,
1001 "i40e_nvmupd_nvm_write status %d aq %d\n",
1002 status
, hw
->aq
.asq_last_status
);
1003 *errno
= i40e_aq_rc_to_posix(status
, hw
->aq
.asq_last_status
);