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 - Reads Shadow RAM
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 i40e_status i40e_read_nvm_word(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_buffer - Reads Shadow RAM buffer
216 * @hw: pointer to the HW structure
217 * @offset: offset of the Shadow RAM word to read (0x000000 - 0x001FFF).
218 * @words: (in) number of words to read; (out) number of words actually read
219 * @data: words read from the Shadow RAM
221 * Reads 16 bit words (data buffer) from the SR using the i40e_read_nvm_srrd()
222 * method. The buffer read is preceded by the NVM ownership take
223 * and followed by the release.
225 i40e_status i40e_read_nvm_buffer(struct i40e_hw *hw, u16 offset,
226 u16 *words, u16 *data)
228 i40e_status ret_code = 0;
231 /* Loop thru the selected region */
232 for (word = 0; word < *words; word++) {
233 index = offset + word;
234 ret_code = i40e_read_nvm_word(hw, index, &data[word]);
239 /* Update the number of words read from the Shadow RAM */
246 * i40e_write_nvm_aq - Writes Shadow RAM.
247 * @hw: pointer to the HW structure.
248 * @module_pointer: module pointer location in words from the NVM beginning
249 * @offset: offset in words from module start
250 * @words: number of words to write
251 * @data: buffer with words to write to the Shadow RAM
252 * @last_command: tells the AdminQ that this is the last command
254 * Writes a 16 bit words buffer to the Shadow RAM using the admin command.
256 static i40e_status i40e_write_nvm_aq(struct i40e_hw *hw, u8 module_pointer,
257 u32 offset, u16 words, void *data,
260 i40e_status ret_code = I40E_ERR_NVM;
262 /* Here we are checking the SR limit only for the flat memory model.
263 * We cannot do it for the module-based model, as we did not acquire
264 * the NVM resource yet (we cannot get the module pointer value).
265 * Firmware will check the module-based model.
267 if ((offset + words) > hw->nvm.sr_size)
268 i40e_debug(hw, I40E_DEBUG_NVM,
269 "NVM write error: offset %d beyond Shadow RAM limit %d\n",
270 (offset + words), hw->nvm.sr_size);
271 else if (words > I40E_SR_SECTOR_SIZE_IN_WORDS)
272 /* We can write only up to 4KB (one sector), in one AQ write */
273 i40e_debug(hw, I40E_DEBUG_NVM,
274 "NVM write fail error: tried to write %d words, limit is %d.\n",
275 words, I40E_SR_SECTOR_SIZE_IN_WORDS);
276 else if (((offset + (words - 1)) / I40E_SR_SECTOR_SIZE_IN_WORDS)
277 != (offset / I40E_SR_SECTOR_SIZE_IN_WORDS))
278 /* A single write cannot spread over two sectors */
279 i40e_debug(hw, I40E_DEBUG_NVM,
280 "NVM write error: cannot spread over two sectors in a single write offset=%d words=%d\n",
283 ret_code = i40e_aq_update_nvm(hw, module_pointer,
284 2 * offset, /*bytes*/
286 data, last_command, NULL);
292 * i40e_calc_nvm_checksum - Calculates and returns the checksum
293 * @hw: pointer to hardware structure
294 * @checksum: pointer to the checksum
296 * This function calculates SW Checksum that covers the whole 64kB shadow RAM
297 * except the VPD and PCIe ALT Auto-load modules. The structure and size of VPD
298 * is customer specific and unknown. Therefore, this function skips all maximum
299 * possible size of VPD (1kB).
301 static i40e_status i40e_calc_nvm_checksum(struct i40e_hw *hw,
304 i40e_status ret_code = 0;
305 u16 pcie_alt_module = 0;
306 u16 checksum_local = 0;
311 /* read pointer to VPD area */
312 ret_code = i40e_read_nvm_word(hw, I40E_SR_VPD_PTR, &vpd_module);
314 ret_code = I40E_ERR_NVM_CHECKSUM;
315 goto i40e_calc_nvm_checksum_exit;
318 /* read pointer to PCIe Alt Auto-load module */
319 ret_code = i40e_read_nvm_word(hw, I40E_SR_PCIE_ALT_AUTO_LOAD_PTR,
322 ret_code = I40E_ERR_NVM_CHECKSUM;
323 goto i40e_calc_nvm_checksum_exit;
326 /* Calculate SW checksum that covers the whole 64kB shadow RAM
327 * except the VPD and PCIe ALT Auto-load modules
329 for (i = 0; i < hw->nvm.sr_size; i++) {
330 /* Skip Checksum word */
331 if (i == I40E_SR_SW_CHECKSUM_WORD)
333 /* Skip VPD module (convert byte size to word count) */
334 if (i == (u32)vpd_module) {
335 i += (I40E_SR_VPD_MODULE_MAX_SIZE / 2);
336 if (i >= hw->nvm.sr_size)
339 /* Skip PCIe ALT module (convert byte size to word count) */
340 if (i == (u32)pcie_alt_module) {
341 i += (I40E_SR_PCIE_ALT_MODULE_MAX_SIZE / 2);
342 if (i >= hw->nvm.sr_size)
346 ret_code = i40e_read_nvm_word(hw, (u16)i, &word);
348 ret_code = I40E_ERR_NVM_CHECKSUM;
349 goto i40e_calc_nvm_checksum_exit;
351 checksum_local += word;
354 *checksum = (u16)I40E_SR_SW_CHECKSUM_BASE - checksum_local;
356 i40e_calc_nvm_checksum_exit:
361 * i40e_update_nvm_checksum - Updates the NVM checksum
362 * @hw: pointer to hardware structure
364 * NVM ownership must be acquired before calling this function and released
365 * on ARQ completion event reception by caller.
366 * This function will commit SR to NVM.
368 i40e_status i40e_update_nvm_checksum(struct i40e_hw *hw)
370 i40e_status ret_code = 0;
373 ret_code = i40e_calc_nvm_checksum(hw, &checksum);
375 ret_code = i40e_write_nvm_aq(hw, 0x00, I40E_SR_SW_CHECKSUM_WORD,
382 * i40e_validate_nvm_checksum - Validate EEPROM checksum
383 * @hw: pointer to hardware structure
384 * @checksum: calculated checksum
386 * Performs checksum calculation and validates the NVM SW checksum. If the
387 * caller does not need checksum, the value can be NULL.
389 i40e_status i40e_validate_nvm_checksum(struct i40e_hw *hw,
392 i40e_status ret_code = 0;
394 u16 checksum_local = 0;
396 ret_code = i40e_calc_nvm_checksum(hw, &checksum_local);
398 goto i40e_validate_nvm_checksum_exit;
400 /* Do not use i40e_read_nvm_word() because we do not want to take
401 * the synchronization semaphores twice here.
403 i40e_read_nvm_word(hw, I40E_SR_SW_CHECKSUM_WORD, &checksum_sr);
405 /* Verify read checksum from EEPROM is the same as
406 * calculated checksum
408 if (checksum_local != checksum_sr)
409 ret_code = I40E_ERR_NVM_CHECKSUM;
411 /* If the user cares, return the calculated checksum */
413 *checksum = checksum_local;
415 i40e_validate_nvm_checksum_exit:
419 static i40e_status i40e_nvmupd_state_init(struct i40e_hw *hw,
420 struct i40e_nvm_access *cmd,
421 u8 *bytes, int *errno);
422 static i40e_status i40e_nvmupd_state_reading(struct i40e_hw *hw,
423 struct i40e_nvm_access *cmd,
424 u8 *bytes, int *errno);
425 static i40e_status i40e_nvmupd_state_writing(struct i40e_hw *hw,
426 struct i40e_nvm_access *cmd,
427 u8 *bytes, int *errno);
428 static enum i40e_nvmupd_cmd i40e_nvmupd_validate_command(struct i40e_hw *hw,
429 struct i40e_nvm_access *cmd,
431 static i40e_status i40e_nvmupd_nvm_erase(struct i40e_hw *hw,
432 struct i40e_nvm_access *cmd,
434 static i40e_status i40e_nvmupd_nvm_write(struct i40e_hw *hw,
435 struct i40e_nvm_access *cmd,
436 u8 *bytes, int *errno);
437 static i40e_status i40e_nvmupd_nvm_read(struct i40e_hw *hw,
438 struct i40e_nvm_access *cmd,
439 u8 *bytes, int *errno);
440 static inline u8 i40e_nvmupd_get_module(u32 val)
442 return (u8)(val & I40E_NVM_MOD_PNT_MASK);
444 static inline u8 i40e_nvmupd_get_transaction(u32 val)
446 return (u8)((val & I40E_NVM_TRANS_MASK) >> I40E_NVM_TRANS_SHIFT);
449 static char *i40e_nvm_update_state_str[] = {
450 "I40E_NVMUPD_INVALID",
451 "I40E_NVMUPD_READ_CON",
452 "I40E_NVMUPD_READ_SNT",
453 "I40E_NVMUPD_READ_LCB",
454 "I40E_NVMUPD_READ_SA",
455 "I40E_NVMUPD_WRITE_ERA",
456 "I40E_NVMUPD_WRITE_CON",
457 "I40E_NVMUPD_WRITE_SNT",
458 "I40E_NVMUPD_WRITE_LCB",
459 "I40E_NVMUPD_WRITE_SA",
460 "I40E_NVMUPD_CSUM_CON",
461 "I40E_NVMUPD_CSUM_SA",
462 "I40E_NVMUPD_CSUM_LCB",
466 * i40e_nvmupd_command - Process an NVM update command
467 * @hw: pointer to hardware structure
468 * @cmd: pointer to nvm update command
469 * @bytes: pointer to the data buffer
470 * @errno: pointer to return error code
472 * Dispatches command depending on what update state is current
474 i40e_status i40e_nvmupd_command(struct i40e_hw *hw,
475 struct i40e_nvm_access *cmd,
476 u8 *bytes, int *errno)
483 switch (hw->nvmupd_state) {
484 case I40E_NVMUPD_STATE_INIT:
485 status = i40e_nvmupd_state_init(hw, cmd, bytes, errno);
488 case I40E_NVMUPD_STATE_READING:
489 status = i40e_nvmupd_state_reading(hw, cmd, bytes, errno);
492 case I40E_NVMUPD_STATE_WRITING:
493 status = i40e_nvmupd_state_writing(hw, cmd, bytes, errno);
497 /* invalid state, should never happen */
498 i40e_debug(hw, I40E_DEBUG_NVM,
499 "NVMUPD: no such state %d\n", hw->nvmupd_state);
500 status = I40E_NOT_SUPPORTED;
508 * i40e_nvmupd_state_init - Handle NVM update state Init
509 * @hw: pointer to hardware structure
510 * @cmd: pointer to nvm update command buffer
511 * @bytes: pointer to the data buffer
512 * @errno: pointer to return error code
514 * Process legitimate commands of the Init state and conditionally set next
515 * state. Reject all other commands.
517 static i40e_status i40e_nvmupd_state_init(struct i40e_hw *hw,
518 struct i40e_nvm_access *cmd,
519 u8 *bytes, int *errno)
521 i40e_status status = 0;
522 enum i40e_nvmupd_cmd upd_cmd;
524 upd_cmd = i40e_nvmupd_validate_command(hw, cmd, errno);
527 case I40E_NVMUPD_READ_SA:
528 status = i40e_acquire_nvm(hw, I40E_RESOURCE_READ);
530 *errno = i40e_aq_rc_to_posix(status,
531 hw->aq.asq_last_status);
533 status = i40e_nvmupd_nvm_read(hw, cmd, bytes, errno);
534 i40e_release_nvm(hw);
538 case I40E_NVMUPD_READ_SNT:
539 status = i40e_acquire_nvm(hw, I40E_RESOURCE_READ);
541 *errno = i40e_aq_rc_to_posix(status,
542 hw->aq.asq_last_status);
544 status = i40e_nvmupd_nvm_read(hw, cmd, bytes, errno);
546 i40e_release_nvm(hw);
548 hw->nvmupd_state = I40E_NVMUPD_STATE_READING;
552 case I40E_NVMUPD_WRITE_ERA:
553 status = i40e_acquire_nvm(hw, I40E_RESOURCE_WRITE);
555 *errno = i40e_aq_rc_to_posix(status,
556 hw->aq.asq_last_status);
558 status = i40e_nvmupd_nvm_erase(hw, cmd, errno);
560 i40e_release_nvm(hw);
562 hw->aq.nvm_release_on_done = true;
566 case I40E_NVMUPD_WRITE_SA:
567 status = i40e_acquire_nvm(hw, I40E_RESOURCE_WRITE);
569 *errno = i40e_aq_rc_to_posix(status,
570 hw->aq.asq_last_status);
572 status = i40e_nvmupd_nvm_write(hw, cmd, bytes, errno);
574 i40e_release_nvm(hw);
576 hw->aq.nvm_release_on_done = true;
580 case I40E_NVMUPD_WRITE_SNT:
581 status = i40e_acquire_nvm(hw, I40E_RESOURCE_WRITE);
583 *errno = i40e_aq_rc_to_posix(status,
584 hw->aq.asq_last_status);
586 status = i40e_nvmupd_nvm_write(hw, cmd, bytes, errno);
588 i40e_release_nvm(hw);
590 hw->nvmupd_state = I40E_NVMUPD_STATE_WRITING;
594 case I40E_NVMUPD_CSUM_SA:
595 status = i40e_acquire_nvm(hw, I40E_RESOURCE_WRITE);
597 *errno = i40e_aq_rc_to_posix(status,
598 hw->aq.asq_last_status);
600 status = i40e_update_nvm_checksum(hw);
602 *errno = hw->aq.asq_last_status ?
603 i40e_aq_rc_to_posix(status,
604 hw->aq.asq_last_status) :
606 i40e_release_nvm(hw);
608 hw->aq.nvm_release_on_done = true;
614 i40e_debug(hw, I40E_DEBUG_NVM,
615 "NVMUPD: bad cmd %s in init state\n",
616 i40e_nvm_update_state_str[upd_cmd]);
617 status = I40E_ERR_NVM;
625 * i40e_nvmupd_state_reading - Handle NVM update state Reading
626 * @hw: pointer to hardware structure
627 * @cmd: pointer to nvm update command buffer
628 * @bytes: pointer to the data buffer
629 * @errno: pointer to return error code
631 * NVM ownership is already held. Process legitimate commands and set any
632 * change in state; reject all other commands.
634 static i40e_status i40e_nvmupd_state_reading(struct i40e_hw *hw,
635 struct i40e_nvm_access *cmd,
636 u8 *bytes, int *errno)
639 enum i40e_nvmupd_cmd upd_cmd;
641 upd_cmd = i40e_nvmupd_validate_command(hw, cmd, errno);
644 case I40E_NVMUPD_READ_SA:
645 case I40E_NVMUPD_READ_CON:
646 status = i40e_nvmupd_nvm_read(hw, cmd, bytes, errno);
649 case I40E_NVMUPD_READ_LCB:
650 status = i40e_nvmupd_nvm_read(hw, cmd, bytes, errno);
651 i40e_release_nvm(hw);
652 hw->nvmupd_state = I40E_NVMUPD_STATE_INIT;
656 i40e_debug(hw, I40E_DEBUG_NVM,
657 "NVMUPD: bad cmd %s in reading state.\n",
658 i40e_nvm_update_state_str[upd_cmd]);
659 status = I40E_NOT_SUPPORTED;
667 * i40e_nvmupd_state_writing - Handle NVM update state Writing
668 * @hw: pointer to hardware structure
669 * @cmd: pointer to nvm update command buffer
670 * @bytes: pointer to the data buffer
671 * @errno: pointer to return error code
673 * NVM ownership is already held. Process legitimate commands and set any
674 * change in state; reject all other commands
676 static i40e_status i40e_nvmupd_state_writing(struct i40e_hw *hw,
677 struct i40e_nvm_access *cmd,
678 u8 *bytes, int *errno)
681 enum i40e_nvmupd_cmd upd_cmd;
682 bool retry_attempt = false;
684 upd_cmd = i40e_nvmupd_validate_command(hw, cmd, errno);
688 case I40E_NVMUPD_WRITE_CON:
689 status = i40e_nvmupd_nvm_write(hw, cmd, bytes, errno);
692 case I40E_NVMUPD_WRITE_LCB:
693 status = i40e_nvmupd_nvm_write(hw, cmd, bytes, errno);
695 hw->aq.nvm_release_on_done = true;
696 hw->nvmupd_state = I40E_NVMUPD_STATE_INIT;
699 case I40E_NVMUPD_CSUM_CON:
700 status = i40e_update_nvm_checksum(hw);
702 *errno = hw->aq.asq_last_status ?
703 i40e_aq_rc_to_posix(status,
704 hw->aq.asq_last_status) :
706 hw->nvmupd_state = I40E_NVMUPD_STATE_INIT;
710 case I40E_NVMUPD_CSUM_LCB:
711 status = i40e_update_nvm_checksum(hw);
713 *errno = hw->aq.asq_last_status ?
714 i40e_aq_rc_to_posix(status,
715 hw->aq.asq_last_status) :
718 hw->aq.nvm_release_on_done = true;
719 hw->nvmupd_state = I40E_NVMUPD_STATE_INIT;
723 i40e_debug(hw, I40E_DEBUG_NVM,
724 "NVMUPD: bad cmd %s in writing state.\n",
725 i40e_nvm_update_state_str[upd_cmd]);
726 status = I40E_NOT_SUPPORTED;
731 /* In some circumstances, a multi-write transaction takes longer
732 * than the default 3 minute timeout on the write semaphore. If
733 * the write failed with an EBUSY status, this is likely the problem,
734 * so here we try to reacquire the semaphore then retry the write.
735 * We only do one retry, then give up.
737 if (status && (hw->aq.asq_last_status == I40E_AQ_RC_EBUSY) &&
739 i40e_status old_status = status;
740 u32 old_asq_status = hw->aq.asq_last_status;
743 gtime = rd32(hw, I40E_GLVFGEN_TIMER);
744 if (gtime >= hw->nvm.hw_semaphore_timeout) {
745 i40e_debug(hw, I40E_DEBUG_ALL,
746 "NVMUPD: write semaphore expired (%d >= %lld), retrying\n",
747 gtime, hw->nvm.hw_semaphore_timeout);
748 i40e_release_nvm(hw);
749 status = i40e_acquire_nvm(hw, I40E_RESOURCE_WRITE);
751 i40e_debug(hw, I40E_DEBUG_ALL,
752 "NVMUPD: write semaphore reacquire failed aq_err = %d\n",
753 hw->aq.asq_last_status);
755 hw->aq.asq_last_status = old_asq_status;
757 retry_attempt = true;
767 * i40e_nvmupd_validate_command - Validate given command
768 * @hw: pointer to hardware structure
769 * @cmd: pointer to nvm update command buffer
770 * @errno: pointer to return error code
772 * Return one of the valid command types or I40E_NVMUPD_INVALID
774 static enum i40e_nvmupd_cmd i40e_nvmupd_validate_command(struct i40e_hw *hw,
775 struct i40e_nvm_access *cmd,
778 enum i40e_nvmupd_cmd upd_cmd;
779 u8 transaction, module;
781 /* anything that doesn't match a recognized case is an error */
782 upd_cmd = I40E_NVMUPD_INVALID;
784 transaction = i40e_nvmupd_get_transaction(cmd->config);
785 module = i40e_nvmupd_get_module(cmd->config);
787 /* limits on data size */
788 if ((cmd->data_size < 1) ||
789 (cmd->data_size > I40E_NVMUPD_MAX_DATA)) {
790 i40e_debug(hw, I40E_DEBUG_NVM,
791 "i40e_nvmupd_validate_command data_size %d\n",
794 return I40E_NVMUPD_INVALID;
797 switch (cmd->command) {
799 switch (transaction) {
801 upd_cmd = I40E_NVMUPD_READ_CON;
804 upd_cmd = I40E_NVMUPD_READ_SNT;
807 upd_cmd = I40E_NVMUPD_READ_LCB;
810 upd_cmd = I40E_NVMUPD_READ_SA;
816 switch (transaction) {
818 upd_cmd = I40E_NVMUPD_WRITE_CON;
821 upd_cmd = I40E_NVMUPD_WRITE_SNT;
824 upd_cmd = I40E_NVMUPD_WRITE_LCB;
827 upd_cmd = I40E_NVMUPD_WRITE_SA;
830 upd_cmd = I40E_NVMUPD_WRITE_ERA;
833 upd_cmd = I40E_NVMUPD_CSUM_CON;
835 case (I40E_NVM_CSUM|I40E_NVM_SA):
836 upd_cmd = I40E_NVMUPD_CSUM_SA;
838 case (I40E_NVM_CSUM|I40E_NVM_LCB):
839 upd_cmd = I40E_NVMUPD_CSUM_LCB;
844 i40e_debug(hw, I40E_DEBUG_NVM, "%s state %d nvm_release_on_hold %d\n",
845 i40e_nvm_update_state_str[upd_cmd],
847 hw->aq.nvm_release_on_done);
849 if (upd_cmd == I40E_NVMUPD_INVALID) {
851 i40e_debug(hw, I40E_DEBUG_NVM,
852 "i40e_nvmupd_validate_command returns %d errno %d\n",
859 * i40e_nvmupd_nvm_read - Read NVM
860 * @hw: pointer to hardware structure
861 * @cmd: pointer to nvm update command buffer
862 * @bytes: pointer to the data buffer
863 * @errno: pointer to return error code
865 * cmd structure contains identifiers and data buffer
867 static i40e_status i40e_nvmupd_nvm_read(struct i40e_hw *hw,
868 struct i40e_nvm_access *cmd,
869 u8 *bytes, int *errno)
872 u8 module, transaction;
875 transaction = i40e_nvmupd_get_transaction(cmd->config);
876 module = i40e_nvmupd_get_module(cmd->config);
877 last = (transaction == I40E_NVM_LCB) || (transaction == I40E_NVM_SA);
879 status = i40e_aq_read_nvm(hw, module, cmd->offset, (u16)cmd->data_size,
882 i40e_debug(hw, I40E_DEBUG_NVM,
883 "i40e_nvmupd_nvm_read mod 0x%x off 0x%x len 0x%x\n",
884 module, cmd->offset, cmd->data_size);
885 i40e_debug(hw, I40E_DEBUG_NVM,
886 "i40e_nvmupd_nvm_read status %d aq %d\n",
887 status, hw->aq.asq_last_status);
888 *errno = i40e_aq_rc_to_posix(status, hw->aq.asq_last_status);
895 * i40e_nvmupd_nvm_erase - Erase an NVM module
896 * @hw: pointer to hardware structure
897 * @cmd: pointer to nvm update command buffer
898 * @errno: pointer to return error code
900 * module, offset, data_size and data are in cmd structure
902 static i40e_status i40e_nvmupd_nvm_erase(struct i40e_hw *hw,
903 struct i40e_nvm_access *cmd,
906 i40e_status status = 0;
907 u8 module, transaction;
910 transaction = i40e_nvmupd_get_transaction(cmd->config);
911 module = i40e_nvmupd_get_module(cmd->config);
912 last = (transaction & I40E_NVM_LCB);
913 status = i40e_aq_erase_nvm(hw, module, cmd->offset, (u16)cmd->data_size,
916 i40e_debug(hw, I40E_DEBUG_NVM,
917 "i40e_nvmupd_nvm_erase mod 0x%x off 0x%x len 0x%x\n",
918 module, cmd->offset, cmd->data_size);
919 i40e_debug(hw, I40E_DEBUG_NVM,
920 "i40e_nvmupd_nvm_erase status %d aq %d\n",
921 status, hw->aq.asq_last_status);
922 *errno = i40e_aq_rc_to_posix(status, hw->aq.asq_last_status);
929 * i40e_nvmupd_nvm_write - Write NVM
930 * @hw: pointer to hardware structure
931 * @cmd: pointer to nvm update command buffer
932 * @bytes: pointer to the data buffer
933 * @errno: pointer to return error code
935 * module, offset, data_size and data are in cmd structure
937 static i40e_status i40e_nvmupd_nvm_write(struct i40e_hw *hw,
938 struct i40e_nvm_access *cmd,
939 u8 *bytes, int *errno)
941 i40e_status status = 0;
942 u8 module, transaction;
945 transaction = i40e_nvmupd_get_transaction(cmd->config);
946 module = i40e_nvmupd_get_module(cmd->config);
947 last = (transaction & I40E_NVM_LCB);
949 status = i40e_aq_update_nvm(hw, module, cmd->offset,
950 (u16)cmd->data_size, bytes, last, NULL);
952 i40e_debug(hw, I40E_DEBUG_NVM,
953 "i40e_nvmupd_nvm_write mod 0x%x off 0x%x len 0x%x\n",
954 module, cmd->offset, cmd->data_size);
955 i40e_debug(hw, I40E_DEBUG_NVM,
956 "i40e_nvmupd_nvm_write status %d aq %d\n",
957 status, hw->aq.asq_last_status);
958 *errno = i40e_aq_rc_to_posix(status, hw->aq.asq_last_status);