e8965024323995900673c069ab052f1a837323d6
[deb_dpdk.git] / drivers / net / i40e / base / i40e_nvm.c
1 /*******************************************************************************
2
3 Copyright (c) 2013 - 2015, Intel Corporation
4 All rights reserved.
5
6 Redistribution and use in source and binary forms, with or without
7 modification, are permitted provided that the following conditions are met:
8
9  1. Redistributions of source code must retain the above copyright notice,
10     this list of conditions and the following disclaimer.
11
12  2. Redistributions in binary form must reproduce the above copyright
13     notice, this list of conditions and the following disclaimer in the
14     documentation and/or other materials provided with the distribution.
15
16  3. Neither the name of the Intel Corporation nor the names of its
17     contributors may be used to endorse or promote products derived from
18     this software without specific prior written permission.
19
20 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
24 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 POSSIBILITY OF SUCH DAMAGE.
31
32 ***************************************************************************/
33
34 #include "i40e_prototype.h"
35
36 enum i40e_status_code i40e_read_nvm_word_srctl(struct i40e_hw *hw, u16 offset,
37                                                u16 *data);
38 enum i40e_status_code i40e_read_nvm_word_aq(struct i40e_hw *hw, u16 offset,
39                                             u16 *data);
40 enum i40e_status_code i40e_read_nvm_buffer_srctl(struct i40e_hw *hw, u16 offset,
41                                                  u16 *words, u16 *data);
42 enum i40e_status_code i40e_read_nvm_buffer_aq(struct i40e_hw *hw, u16 offset,
43                                               u16 *words, u16 *data);
44 enum i40e_status_code i40e_read_nvm_aq(struct i40e_hw *hw, u8 module_pointer,
45                                        u32 offset, u16 words, void *data,
46                                        bool last_command);
47
48 /**
49  * i40e_init_nvm_ops - Initialize NVM function pointers
50  * @hw: pointer to the HW structure
51  *
52  * Setup the function pointers and the NVM info structure. Should be called
53  * once per NVM initialization, e.g. inside the i40e_init_shared_code().
54  * Please notice that the NVM term is used here (& in all methods covered
55  * in this file) as an equivalent of the FLASH part mapped into the SR.
56  * We are accessing FLASH always through the Shadow RAM.
57  **/
58 enum i40e_status_code i40e_init_nvm(struct i40e_hw *hw)
59 {
60         struct i40e_nvm_info *nvm = &hw->nvm;
61         enum i40e_status_code ret_code = I40E_SUCCESS;
62         u32 fla, gens;
63         u8 sr_size;
64
65         DEBUGFUNC("i40e_init_nvm");
66
67         /* The SR size is stored regardless of the nvm programming mode
68          * as the blank mode may be used in the factory line.
69          */
70         gens = rd32(hw, I40E_GLNVM_GENS);
71         sr_size = ((gens & I40E_GLNVM_GENS_SR_SIZE_MASK) >>
72                            I40E_GLNVM_GENS_SR_SIZE_SHIFT);
73         /* Switching to words (sr_size contains power of 2KB) */
74         nvm->sr_size = BIT(sr_size) * I40E_SR_WORDS_IN_1KB;
75
76         /* Check if we are in the normal or blank NVM programming mode */
77         fla = rd32(hw, I40E_GLNVM_FLA);
78         if (fla & I40E_GLNVM_FLA_LOCKED_MASK) { /* Normal programming mode */
79                 /* Max NVM timeout */
80                 nvm->timeout = I40E_MAX_NVM_TIMEOUT;
81                 nvm->blank_nvm_mode = false;
82         } else { /* Blank programming mode */
83                 nvm->blank_nvm_mode = true;
84                 ret_code = I40E_ERR_NVM_BLANK_MODE;
85                 i40e_debug(hw, I40E_DEBUG_NVM, "NVM init error: unsupported blank mode.\n");
86         }
87
88         return ret_code;
89 }
90
91 /**
92  * i40e_acquire_nvm - Generic request for acquiring the NVM ownership
93  * @hw: pointer to the HW structure
94  * @access: NVM access type (read or write)
95  *
96  * This function will request NVM ownership for reading
97  * via the proper Admin Command.
98  **/
99 enum i40e_status_code i40e_acquire_nvm(struct i40e_hw *hw,
100                                        enum i40e_aq_resource_access_type access)
101 {
102         enum i40e_status_code ret_code = I40E_SUCCESS;
103         u64 gtime, timeout;
104         u64 time_left = 0;
105
106         DEBUGFUNC("i40e_acquire_nvm");
107
108         if (hw->nvm.blank_nvm_mode)
109                 goto i40e_i40e_acquire_nvm_exit;
110
111         ret_code = i40e_aq_request_resource(hw, I40E_NVM_RESOURCE_ID, access,
112                                             0, &time_left, NULL);
113         /* Reading the Global Device Timer */
114         gtime = rd32(hw, I40E_GLVFGEN_TIMER);
115
116         /* Store the timeout */
117         hw->nvm.hw_semaphore_timeout = I40E_MS_TO_GTIME(time_left) + gtime;
118
119         if (ret_code)
120                 i40e_debug(hw, I40E_DEBUG_NVM,
121                            "NVM acquire type %d failed time_left=%llu ret=%d aq_err=%d\n",
122                            access, time_left, ret_code, hw->aq.asq_last_status);
123
124         if (ret_code && time_left) {
125                 /* Poll until the current NVM owner timeouts */
126                 timeout = I40E_MS_TO_GTIME(I40E_MAX_NVM_TIMEOUT) + gtime;
127                 while ((gtime < timeout) && time_left) {
128                         i40e_msec_delay(10);
129                         gtime = rd32(hw, I40E_GLVFGEN_TIMER);
130                         ret_code = i40e_aq_request_resource(hw,
131                                                         I40E_NVM_RESOURCE_ID,
132                                                         access, 0, &time_left,
133                                                         NULL);
134                         if (ret_code == I40E_SUCCESS) {
135                                 hw->nvm.hw_semaphore_timeout =
136                                             I40E_MS_TO_GTIME(time_left) + gtime;
137                                 break;
138                         }
139                 }
140                 if (ret_code != I40E_SUCCESS) {
141                         hw->nvm.hw_semaphore_timeout = 0;
142                         i40e_debug(hw, I40E_DEBUG_NVM,
143                                    "NVM acquire timed out, wait %llu ms before trying again. status=%d aq_err=%d\n",
144                                    time_left, ret_code, hw->aq.asq_last_status);
145                 }
146         }
147
148 i40e_i40e_acquire_nvm_exit:
149         return ret_code;
150 }
151
152 /**
153  * i40e_release_nvm - Generic request for releasing the NVM ownership
154  * @hw: pointer to the HW structure
155  *
156  * This function will release NVM resource via the proper Admin Command.
157  **/
158 void i40e_release_nvm(struct i40e_hw *hw)
159 {
160         enum i40e_status_code ret_code = I40E_SUCCESS;
161         u32 total_delay = 0;
162
163         DEBUGFUNC("i40e_release_nvm");
164
165         if (hw->nvm.blank_nvm_mode)
166                 return;
167
168         ret_code = i40e_aq_release_resource(hw, I40E_NVM_RESOURCE_ID, 0, NULL);
169
170         /* there are some rare cases when trying to release the resource
171          * results in an admin Q timeout, so handle them correctly
172          */
173         while ((ret_code == I40E_ERR_ADMIN_QUEUE_TIMEOUT) &&
174                (total_delay < hw->aq.asq_cmd_timeout)) {
175                         i40e_msec_delay(1);
176                         ret_code = i40e_aq_release_resource(hw,
177                                                 I40E_NVM_RESOURCE_ID, 0, NULL);
178                         total_delay++;
179         }
180 }
181
182 /**
183  * i40e_poll_sr_srctl_done_bit - Polls the GLNVM_SRCTL done bit
184  * @hw: pointer to the HW structure
185  *
186  * Polls the SRCTL Shadow RAM register done bit.
187  **/
188 static enum i40e_status_code i40e_poll_sr_srctl_done_bit(struct i40e_hw *hw)
189 {
190         enum i40e_status_code ret_code = I40E_ERR_TIMEOUT;
191         u32 srctl, wait_cnt;
192
193         DEBUGFUNC("i40e_poll_sr_srctl_done_bit");
194
195         /* Poll the I40E_GLNVM_SRCTL until the done bit is set */
196         for (wait_cnt = 0; wait_cnt < I40E_SRRD_SRCTL_ATTEMPTS; wait_cnt++) {
197                 srctl = rd32(hw, I40E_GLNVM_SRCTL);
198                 if (srctl & I40E_GLNVM_SRCTL_DONE_MASK) {
199                         ret_code = I40E_SUCCESS;
200                         break;
201                 }
202                 i40e_usec_delay(5);
203         }
204         if (ret_code == I40E_ERR_TIMEOUT)
205                 i40e_debug(hw, I40E_DEBUG_NVM, "Done bit in GLNVM_SRCTL not set");
206         return ret_code;
207 }
208
209 /**
210  * i40e_read_nvm_word - Reads nvm word and acquire lock if necessary
211  * @hw: pointer to the HW structure
212  * @offset: offset of the Shadow RAM word to read (0x000000 - 0x001FFF)
213  * @data: word read from the Shadow RAM
214  *
215  * Reads one 16 bit word from the Shadow RAM using the GLNVM_SRCTL register.
216  **/
217 enum i40e_status_code i40e_read_nvm_word(struct i40e_hw *hw, u16 offset,
218                                          u16 *data)
219 {
220         enum i40e_status_code ret_code = I40E_SUCCESS;
221
222         ret_code = i40e_acquire_nvm(hw, I40E_RESOURCE_READ);
223         if (!ret_code) {
224                 if (hw->flags & I40E_HW_FLAG_AQ_SRCTL_ACCESS_ENABLE) {
225                         ret_code = i40e_read_nvm_word_aq(hw, offset, data);
226                 } else {
227                         ret_code = i40e_read_nvm_word_srctl(hw, offset, data);
228                 }
229                 i40e_release_nvm(hw);
230         }
231         return ret_code;
232 }
233
234 /**
235  * __i40e_read_nvm_word - Reads nvm word, assumes caller does the locking
236  * @hw: pointer to the HW structure
237  * @offset: offset of the Shadow RAM word to read (0x000000 - 0x001FFF)
238  * @data: word read from the Shadow RAM
239  *
240  * Reads one 16 bit word from the Shadow RAM using the GLNVM_SRCTL register.
241  **/
242 enum i40e_status_code __i40e_read_nvm_word(struct i40e_hw *hw,
243                                            u16 offset,
244                                            u16 *data)
245 {
246         enum i40e_status_code ret_code = I40E_SUCCESS;
247
248         if (hw->flags & I40E_HW_FLAG_AQ_SRCTL_ACCESS_ENABLE)
249                 ret_code = i40e_read_nvm_word_aq(hw, offset, data);
250         else
251                 ret_code = i40e_read_nvm_word_srctl(hw, offset, data);
252         return ret_code;
253 }
254
255 /**
256  * i40e_read_nvm_word_srctl - Reads Shadow RAM via SRCTL register
257  * @hw: pointer to the HW structure
258  * @offset: offset of the Shadow RAM word to read (0x000000 - 0x001FFF)
259  * @data: word read from the Shadow RAM
260  *
261  * Reads one 16 bit word from the Shadow RAM using the GLNVM_SRCTL register.
262  **/
263 enum i40e_status_code i40e_read_nvm_word_srctl(struct i40e_hw *hw, u16 offset,
264                                                u16 *data)
265 {
266         enum i40e_status_code ret_code = I40E_ERR_TIMEOUT;
267         u32 sr_reg;
268
269         DEBUGFUNC("i40e_read_nvm_word_srctl");
270
271         if (offset >= hw->nvm.sr_size) {
272                 i40e_debug(hw, I40E_DEBUG_NVM,
273                            "NVM read error: Offset %d beyond Shadow RAM limit %d\n",
274                            offset, hw->nvm.sr_size);
275                 ret_code = I40E_ERR_PARAM;
276                 goto read_nvm_exit;
277         }
278
279         /* Poll the done bit first */
280         ret_code = i40e_poll_sr_srctl_done_bit(hw);
281         if (ret_code == I40E_SUCCESS) {
282                 /* Write the address and start reading */
283                 sr_reg = ((u32)offset << I40E_GLNVM_SRCTL_ADDR_SHIFT) |
284                          BIT(I40E_GLNVM_SRCTL_START_SHIFT);
285                 wr32(hw, I40E_GLNVM_SRCTL, sr_reg);
286
287                 /* Poll I40E_GLNVM_SRCTL until the done bit is set */
288                 ret_code = i40e_poll_sr_srctl_done_bit(hw);
289                 if (ret_code == I40E_SUCCESS) {
290                         sr_reg = rd32(hw, I40E_GLNVM_SRDATA);
291                         *data = (u16)((sr_reg &
292                                        I40E_GLNVM_SRDATA_RDDATA_MASK)
293                                     >> I40E_GLNVM_SRDATA_RDDATA_SHIFT);
294                 }
295         }
296         if (ret_code != I40E_SUCCESS)
297                 i40e_debug(hw, I40E_DEBUG_NVM,
298                            "NVM read error: Couldn't access Shadow RAM address: 0x%x\n",
299                            offset);
300
301 read_nvm_exit:
302         return ret_code;
303 }
304
305 /**
306  * i40e_read_nvm_word_aq - Reads Shadow RAM via AQ
307  * @hw: pointer to the HW structure
308  * @offset: offset of the Shadow RAM word to read (0x000000 - 0x001FFF)
309  * @data: word read from the Shadow RAM
310  *
311  * Reads one 16 bit word from the Shadow RAM using the GLNVM_SRCTL register.
312  **/
313 enum i40e_status_code i40e_read_nvm_word_aq(struct i40e_hw *hw, u16 offset,
314                                             u16 *data)
315 {
316         enum i40e_status_code ret_code = I40E_ERR_TIMEOUT;
317
318         DEBUGFUNC("i40e_read_nvm_word_aq");
319
320         ret_code = i40e_read_nvm_aq(hw, 0x0, offset, 1, data, true);
321         *data = LE16_TO_CPU(*(__le16 *)data);
322
323         return ret_code;
324 }
325
326 /**
327  * __i40e_read_nvm_buffer - Reads nvm buffer, caller must acquire lock
328  * @hw: pointer to the HW structure
329  * @offset: offset of the Shadow RAM word to read (0x000000 - 0x001FFF).
330  * @words: (in) number of words to read; (out) number of words actually read
331  * @data: words read from the Shadow RAM
332  *
333  * Reads 16 bit words (data buffer) from the SR using the i40e_read_nvm_srrd()
334  * method. The buffer read is preceded by the NVM ownership take
335  * and followed by the release.
336  **/
337 enum i40e_status_code __i40e_read_nvm_buffer(struct i40e_hw *hw,
338                                              u16 offset,
339                                              u16 *words, u16 *data)
340 {
341         enum i40e_status_code ret_code = I40E_SUCCESS;
342
343         if (hw->flags & I40E_HW_FLAG_AQ_SRCTL_ACCESS_ENABLE)
344                 ret_code = i40e_read_nvm_buffer_aq(hw, offset, words, data);
345         else
346                 ret_code = i40e_read_nvm_buffer_srctl(hw, offset, words, data);
347         return ret_code;
348 }
349
350 /**
351  * i40e_read_nvm_buffer - Reads Shadow RAM buffer and acuire lock if necessary
352  * @hw: pointer to the HW structure
353  * @offset: offset of the Shadow RAM word to read (0x000000 - 0x001FFF).
354  * @words: (in) number of words to read; (out) number of words actually read
355  * @data: words read from the Shadow RAM
356  *
357  * Reads 16 bit words (data buffer) from the SR using the i40e_read_nvm_srrd()
358  * method. The buffer read is preceded by the NVM ownership take
359  * and followed by the release.
360  **/
361 enum i40e_status_code i40e_read_nvm_buffer(struct i40e_hw *hw, u16 offset,
362                                            u16 *words, u16 *data)
363 {
364         enum i40e_status_code ret_code = I40E_SUCCESS;
365
366         if (hw->flags & I40E_HW_FLAG_AQ_SRCTL_ACCESS_ENABLE) {
367                 ret_code = i40e_acquire_nvm(hw, I40E_RESOURCE_READ);
368                 if (!ret_code) {
369                         ret_code = i40e_read_nvm_buffer_aq(hw, offset, words,
370                                                          data);
371                         i40e_release_nvm(hw);
372                 }
373         } else {
374                 ret_code = i40e_read_nvm_buffer_srctl(hw, offset, words, data);
375         }
376         return ret_code;
377 }
378
379 /**
380  * i40e_read_nvm_buffer_srctl - Reads Shadow RAM buffer via SRCTL register
381  * @hw: pointer to the HW structure
382  * @offset: offset of the Shadow RAM word to read (0x000000 - 0x001FFF).
383  * @words: (in) number of words to read; (out) number of words actually read
384  * @data: words read from the Shadow RAM
385  *
386  * Reads 16 bit words (data buffer) from the SR using the i40e_read_nvm_srrd()
387  * method. The buffer read is preceded by the NVM ownership take
388  * and followed by the release.
389  **/
390 enum i40e_status_code i40e_read_nvm_buffer_srctl(struct i40e_hw *hw, u16 offset,
391                                                  u16 *words, u16 *data)
392 {
393         enum i40e_status_code ret_code = I40E_SUCCESS;
394         u16 index, word;
395
396         DEBUGFUNC("i40e_read_nvm_buffer_srctl");
397
398         /* Loop through the selected region */
399         for (word = 0; word < *words; word++) {
400                 index = offset + word;
401                 ret_code = i40e_read_nvm_word_srctl(hw, index, &data[word]);
402                 if (ret_code != I40E_SUCCESS)
403                         break;
404         }
405
406         /* Update the number of words read from the Shadow RAM */
407         *words = word;
408
409         return ret_code;
410 }
411
412 /**
413  * i40e_read_nvm_buffer_aq - Reads Shadow RAM buffer via AQ
414  * @hw: pointer to the HW structure
415  * @offset: offset of the Shadow RAM word to read (0x000000 - 0x001FFF).
416  * @words: (in) number of words to read; (out) number of words actually read
417  * @data: words read from the Shadow RAM
418  *
419  * Reads 16 bit words (data buffer) from the SR using the i40e_read_nvm_aq()
420  * method. The buffer read is preceded by the NVM ownership take
421  * and followed by the release.
422  **/
423 enum i40e_status_code i40e_read_nvm_buffer_aq(struct i40e_hw *hw, u16 offset,
424                                               u16 *words, u16 *data)
425 {
426         enum i40e_status_code ret_code;
427         u16 read_size = *words;
428         bool last_cmd = false;
429         u16 words_read = 0;
430         u16 i = 0;
431
432         DEBUGFUNC("i40e_read_nvm_buffer_aq");
433
434         do {
435                 /* Calculate number of bytes we should read in this step.
436                  * FVL AQ do not allow to read more than one page at a time or
437                  * to cross page boundaries.
438                  */
439                 if (offset % I40E_SR_SECTOR_SIZE_IN_WORDS)
440                         read_size = min(*words,
441                                         (u16)(I40E_SR_SECTOR_SIZE_IN_WORDS -
442                                       (offset % I40E_SR_SECTOR_SIZE_IN_WORDS)));
443                 else
444                         read_size = min((*words - words_read),
445                                         I40E_SR_SECTOR_SIZE_IN_WORDS);
446
447                 /* Check if this is last command, if so set proper flag */
448                 if ((words_read + read_size) >= *words)
449                         last_cmd = true;
450
451                 ret_code = i40e_read_nvm_aq(hw, 0x0, offset, read_size,
452                                             data + words_read, last_cmd);
453                 if (ret_code != I40E_SUCCESS)
454                         goto read_nvm_buffer_aq_exit;
455
456                 /* Increment counter for words already read and move offset to
457                  * new read location
458                  */
459                 words_read += read_size;
460                 offset += read_size;
461         } while (words_read < *words);
462
463         for (i = 0; i < *words; i++)
464                 data[i] = LE16_TO_CPU(((__le16 *)data)[i]);
465
466 read_nvm_buffer_aq_exit:
467         *words = words_read;
468         return ret_code;
469 }
470
471 /**
472  * i40e_read_nvm_aq - Read Shadow RAM.
473  * @hw: pointer to the HW structure.
474  * @module_pointer: module pointer location in words from the NVM beginning
475  * @offset: offset in words from module start
476  * @words: number of words to write
477  * @data: buffer with words to write to the Shadow RAM
478  * @last_command: tells the AdminQ that this is the last command
479  *
480  * Writes a 16 bit words buffer to the Shadow RAM using the admin command.
481  **/
482 enum i40e_status_code i40e_read_nvm_aq(struct i40e_hw *hw, u8 module_pointer,
483                                        u32 offset, u16 words, void *data,
484                                        bool last_command)
485 {
486         enum i40e_status_code ret_code = I40E_ERR_NVM;
487         struct i40e_asq_cmd_details cmd_details;
488
489         DEBUGFUNC("i40e_read_nvm_aq");
490
491         memset(&cmd_details, 0, sizeof(cmd_details));
492         cmd_details.wb_desc = &hw->nvm_wb_desc;
493
494         /* Here we are checking the SR limit only for the flat memory model.
495          * We cannot do it for the module-based model, as we did not acquire
496          * the NVM resource yet (we cannot get the module pointer value).
497          * Firmware will check the module-based model.
498          */
499         if ((offset + words) > hw->nvm.sr_size)
500                 i40e_debug(hw, I40E_DEBUG_NVM,
501                            "NVM write error: offset %d beyond Shadow RAM limit %d\n",
502                            (offset + words), hw->nvm.sr_size);
503         else if (words > I40E_SR_SECTOR_SIZE_IN_WORDS)
504                 /* We can write only up to 4KB (one sector), in one AQ write */
505                 i40e_debug(hw, I40E_DEBUG_NVM,
506                            "NVM write fail error: tried to write %d words, limit is %d.\n",
507                            words, I40E_SR_SECTOR_SIZE_IN_WORDS);
508         else if (((offset + (words - 1)) / I40E_SR_SECTOR_SIZE_IN_WORDS)
509                  != (offset / I40E_SR_SECTOR_SIZE_IN_WORDS))
510                 /* A single write cannot spread over two sectors */
511                 i40e_debug(hw, I40E_DEBUG_NVM,
512                            "NVM write error: cannot spread over two sectors in a single write offset=%d words=%d\n",
513                            offset, words);
514         else
515                 ret_code = i40e_aq_read_nvm(hw, module_pointer,
516                                             2 * offset,  /*bytes*/
517                                             2 * words,   /*bytes*/
518                                             data, last_command, &cmd_details);
519
520         return ret_code;
521 }
522
523 /**
524  * i40e_write_nvm_aq - Writes Shadow RAM.
525  * @hw: pointer to the HW structure.
526  * @module_pointer: module pointer location in words from the NVM beginning
527  * @offset: offset in words from module start
528  * @words: number of words to write
529  * @data: buffer with words to write to the Shadow RAM
530  * @last_command: tells the AdminQ that this is the last command
531  *
532  * Writes a 16 bit words buffer to the Shadow RAM using the admin command.
533  **/
534 enum i40e_status_code i40e_write_nvm_aq(struct i40e_hw *hw, u8 module_pointer,
535                                         u32 offset, u16 words, void *data,
536                                         bool last_command)
537 {
538         enum i40e_status_code ret_code = I40E_ERR_NVM;
539         struct i40e_asq_cmd_details cmd_details;
540
541         DEBUGFUNC("i40e_write_nvm_aq");
542
543         memset(&cmd_details, 0, sizeof(cmd_details));
544         cmd_details.wb_desc = &hw->nvm_wb_desc;
545
546         /* Here we are checking the SR limit only for the flat memory model.
547          * We cannot do it for the module-based model, as we did not acquire
548          * the NVM resource yet (we cannot get the module pointer value).
549          * Firmware will check the module-based model.
550          */
551         if ((offset + words) > hw->nvm.sr_size)
552                 DEBUGOUT("NVM write error: offset beyond Shadow RAM limit.\n");
553         else if (words > I40E_SR_SECTOR_SIZE_IN_WORDS)
554                 /* We can write only up to 4KB (one sector), in one AQ write */
555                 DEBUGOUT("NVM write fail error: cannot write more than 4KB in a single write.\n");
556         else if (((offset + (words - 1)) / I40E_SR_SECTOR_SIZE_IN_WORDS)
557                  != (offset / I40E_SR_SECTOR_SIZE_IN_WORDS))
558                 /* A single write cannot spread over two sectors */
559                 DEBUGOUT("NVM write error: cannot spread over two sectors in a single write.\n");
560         else
561                 ret_code = i40e_aq_update_nvm(hw, module_pointer,
562                                               2 * offset,  /*bytes*/
563                                               2 * words,   /*bytes*/
564                                               data, last_command, &cmd_details);
565
566         return ret_code;
567 }
568
569 /**
570  * __i40e_write_nvm_word - Writes Shadow RAM word
571  * @hw: pointer to the HW structure
572  * @offset: offset of the Shadow RAM word to write
573  * @data: word to write to the Shadow RAM
574  *
575  * Writes a 16 bit word to the SR using the i40e_write_nvm_aq() method.
576  * NVM ownership have to be acquired and released (on ARQ completion event
577  * reception) by caller. To commit SR to NVM update checksum function
578  * should be called.
579  **/
580 enum i40e_status_code __i40e_write_nvm_word(struct i40e_hw *hw, u32 offset,
581                                             void *data)
582 {
583         DEBUGFUNC("i40e_write_nvm_word");
584
585         *((__le16 *)data) = CPU_TO_LE16(*((u16 *)data));
586
587         /* Value 0x00 below means that we treat SR as a flat mem */
588         return i40e_write_nvm_aq(hw, 0x00, offset, 1, data, false);
589 }
590
591 /**
592  * __i40e_write_nvm_buffer - Writes Shadow RAM buffer
593  * @hw: pointer to the HW structure
594  * @module_pointer: module pointer location in words from the NVM beginning
595  * @offset: offset of the Shadow RAM buffer to write
596  * @words: number of words to write
597  * @data: words to write to the Shadow RAM
598  *
599  * Writes a 16 bit words buffer to the Shadow RAM using the admin command.
600  * NVM ownership must be acquired before calling this function and released
601  * on ARQ completion event reception by caller. To commit SR to NVM update
602  * checksum function should be called.
603  **/
604 enum i40e_status_code __i40e_write_nvm_buffer(struct i40e_hw *hw,
605                                               u8 module_pointer, u32 offset,
606                                               u16 words, void *data)
607 {
608         __le16 *le_word_ptr = (__le16 *)data;
609         u16 *word_ptr = (u16 *)data;
610         u32 i = 0;
611
612         DEBUGFUNC("i40e_write_nvm_buffer");
613
614         for (i = 0; i < words; i++)
615                 le_word_ptr[i] = CPU_TO_LE16(word_ptr[i]);
616
617         /* Here we will only write one buffer as the size of the modules
618          * mirrored in the Shadow RAM is always less than 4K.
619          */
620         return i40e_write_nvm_aq(hw, module_pointer, offset, words,
621                                  data, false);
622 }
623
624 /**
625  * i40e_calc_nvm_checksum - Calculates and returns the checksum
626  * @hw: pointer to hardware structure
627  * @checksum: pointer to the checksum
628  *
629  * This function calculates SW Checksum that covers the whole 64kB shadow RAM
630  * except the VPD and PCIe ALT Auto-load modules. The structure and size of VPD
631  * is customer specific and unknown. Therefore, this function skips all maximum
632  * possible size of VPD (1kB).
633  **/
634 enum i40e_status_code i40e_calc_nvm_checksum(struct i40e_hw *hw, u16 *checksum)
635 {
636         enum i40e_status_code ret_code = I40E_SUCCESS;
637         struct i40e_virt_mem vmem;
638         u16 pcie_alt_module = 0;
639         u16 checksum_local = 0;
640         u16 vpd_module = 0;
641         u16 *data;
642         u16 i = 0;
643
644         DEBUGFUNC("i40e_calc_nvm_checksum");
645
646         ret_code = i40e_allocate_virt_mem(hw, &vmem,
647                                     I40E_SR_SECTOR_SIZE_IN_WORDS * sizeof(u16));
648         if (ret_code)
649                 goto i40e_calc_nvm_checksum_exit;
650         data = (u16 *)vmem.va;
651
652         /* read pointer to VPD area */
653         ret_code = __i40e_read_nvm_word(hw, I40E_SR_VPD_PTR,
654                                         &vpd_module);
655         if (ret_code != I40E_SUCCESS) {
656                 ret_code = I40E_ERR_NVM_CHECKSUM;
657                 goto i40e_calc_nvm_checksum_exit;
658         }
659
660         /* read pointer to PCIe Alt Auto-load module */
661         ret_code = __i40e_read_nvm_word(hw,
662                                         I40E_SR_PCIE_ALT_AUTO_LOAD_PTR,
663                                         &pcie_alt_module);
664         if (ret_code != I40E_SUCCESS) {
665                 ret_code = I40E_ERR_NVM_CHECKSUM;
666                 goto i40e_calc_nvm_checksum_exit;
667         }
668
669         /* Calculate SW checksum that covers the whole 64kB shadow RAM
670          * except the VPD and PCIe ALT Auto-load modules
671          */
672         for (i = 0; i < hw->nvm.sr_size; i++) {
673                 /* Read SR page */
674                 if ((i % I40E_SR_SECTOR_SIZE_IN_WORDS) == 0) {
675                         u16 words = I40E_SR_SECTOR_SIZE_IN_WORDS;
676
677                         ret_code = __i40e_read_nvm_buffer(hw, i, &words, data);
678                         if (ret_code != I40E_SUCCESS) {
679                                 ret_code = I40E_ERR_NVM_CHECKSUM;
680                                 goto i40e_calc_nvm_checksum_exit;
681                         }
682                 }
683
684                 /* Skip Checksum word */
685                 if (i == I40E_SR_SW_CHECKSUM_WORD)
686                         continue;
687                 /* Skip VPD module (convert byte size to word count) */
688                 if ((i >= (u32)vpd_module) &&
689                     (i < ((u32)vpd_module +
690                      (I40E_SR_VPD_MODULE_MAX_SIZE / 2)))) {
691                         continue;
692                 }
693                 /* Skip PCIe ALT module (convert byte size to word count) */
694                 if ((i >= (u32)pcie_alt_module) &&
695                     (i < ((u32)pcie_alt_module +
696                      (I40E_SR_PCIE_ALT_MODULE_MAX_SIZE / 2)))) {
697                         continue;
698                 }
699
700                 checksum_local += data[i % I40E_SR_SECTOR_SIZE_IN_WORDS];
701         }
702
703         *checksum = (u16)I40E_SR_SW_CHECKSUM_BASE - checksum_local;
704
705 i40e_calc_nvm_checksum_exit:
706         i40e_free_virt_mem(hw, &vmem);
707         return ret_code;
708 }
709
710 /**
711  * i40e_update_nvm_checksum - Updates the NVM checksum
712  * @hw: pointer to hardware structure
713  *
714  * NVM ownership must be acquired before calling this function and released
715  * on ARQ completion event reception by caller.
716  * This function will commit SR to NVM.
717  **/
718 enum i40e_status_code i40e_update_nvm_checksum(struct i40e_hw *hw)
719 {
720         enum i40e_status_code ret_code = I40E_SUCCESS;
721         u16 checksum;
722         __le16 le_sum;
723
724         DEBUGFUNC("i40e_update_nvm_checksum");
725
726         ret_code = i40e_calc_nvm_checksum(hw, &checksum);
727         le_sum = CPU_TO_LE16(checksum);
728         if (ret_code == I40E_SUCCESS)
729                 ret_code = i40e_write_nvm_aq(hw, 0x00, I40E_SR_SW_CHECKSUM_WORD,
730                                              1, &le_sum, true);
731
732         return ret_code;
733 }
734
735 /**
736  * i40e_validate_nvm_checksum - Validate EEPROM checksum
737  * @hw: pointer to hardware structure
738  * @checksum: calculated checksum
739  *
740  * Performs checksum calculation and validates the NVM SW checksum. If the
741  * caller does not need checksum, the value can be NULL.
742  **/
743 enum i40e_status_code i40e_validate_nvm_checksum(struct i40e_hw *hw,
744                                                  u16 *checksum)
745 {
746         enum i40e_status_code ret_code = I40E_SUCCESS;
747         u16 checksum_sr = 0;
748         u16 checksum_local = 0;
749
750         DEBUGFUNC("i40e_validate_nvm_checksum");
751
752         if (hw->flags & I40E_HW_FLAG_AQ_SRCTL_ACCESS_ENABLE)
753                 ret_code = i40e_acquire_nvm(hw, I40E_RESOURCE_READ);
754         if (!ret_code) {
755                 ret_code = i40e_calc_nvm_checksum(hw, &checksum_local);
756                 if (hw->flags & I40E_HW_FLAG_AQ_SRCTL_ACCESS_ENABLE)
757                         i40e_release_nvm(hw);
758                 if (ret_code != I40E_SUCCESS)
759                         goto i40e_validate_nvm_checksum_exit;
760         } else {
761                 goto i40e_validate_nvm_checksum_exit;
762         }
763
764         i40e_read_nvm_word(hw, I40E_SR_SW_CHECKSUM_WORD, &checksum_sr);
765
766         /* Verify read checksum from EEPROM is the same as
767          * calculated checksum
768          */
769         if (checksum_local != checksum_sr)
770                 ret_code = I40E_ERR_NVM_CHECKSUM;
771
772         /* If the user cares, return the calculated checksum */
773         if (checksum)
774                 *checksum = checksum_local;
775
776 i40e_validate_nvm_checksum_exit:
777         return ret_code;
778 }
779
780 STATIC enum i40e_status_code i40e_nvmupd_state_init(struct i40e_hw *hw,
781                                                     struct i40e_nvm_access *cmd,
782                                                     u8 *bytes, int *perrno);
783 STATIC enum i40e_status_code i40e_nvmupd_state_reading(struct i40e_hw *hw,
784                                                     struct i40e_nvm_access *cmd,
785                                                     u8 *bytes, int *perrno);
786 STATIC enum i40e_status_code i40e_nvmupd_state_writing(struct i40e_hw *hw,
787                                                     struct i40e_nvm_access *cmd,
788                                                     u8 *bytes, int *perrno);
789 STATIC enum i40e_nvmupd_cmd i40e_nvmupd_validate_command(struct i40e_hw *hw,
790                                                     struct i40e_nvm_access *cmd,
791                                                     int *perrno);
792 STATIC enum i40e_status_code i40e_nvmupd_nvm_erase(struct i40e_hw *hw,
793                                                    struct i40e_nvm_access *cmd,
794                                                    int *perrno);
795 STATIC enum i40e_status_code i40e_nvmupd_nvm_write(struct i40e_hw *hw,
796                                                    struct i40e_nvm_access *cmd,
797                                                    u8 *bytes, int *perrno);
798 STATIC enum i40e_status_code i40e_nvmupd_nvm_read(struct i40e_hw *hw,
799                                                   struct i40e_nvm_access *cmd,
800                                                   u8 *bytes, int *perrno);
801 STATIC enum i40e_status_code i40e_nvmupd_exec_aq(struct i40e_hw *hw,
802                                                  struct i40e_nvm_access *cmd,
803                                                  u8 *bytes, int *perrno);
804 STATIC enum i40e_status_code i40e_nvmupd_get_aq_result(struct i40e_hw *hw,
805                                                     struct i40e_nvm_access *cmd,
806                                                     u8 *bytes, int *perrno);
807 STATIC INLINE u8 i40e_nvmupd_get_module(u32 val)
808 {
809         return (u8)(val & I40E_NVM_MOD_PNT_MASK);
810 }
811 STATIC INLINE u8 i40e_nvmupd_get_transaction(u32 val)
812 {
813         return (u8)((val & I40E_NVM_TRANS_MASK) >> I40E_NVM_TRANS_SHIFT);
814 }
815
816 STATIC const char *i40e_nvm_update_state_str[] = {
817         "I40E_NVMUPD_INVALID",
818         "I40E_NVMUPD_READ_CON",
819         "I40E_NVMUPD_READ_SNT",
820         "I40E_NVMUPD_READ_LCB",
821         "I40E_NVMUPD_READ_SA",
822         "I40E_NVMUPD_WRITE_ERA",
823         "I40E_NVMUPD_WRITE_CON",
824         "I40E_NVMUPD_WRITE_SNT",
825         "I40E_NVMUPD_WRITE_LCB",
826         "I40E_NVMUPD_WRITE_SA",
827         "I40E_NVMUPD_CSUM_CON",
828         "I40E_NVMUPD_CSUM_SA",
829         "I40E_NVMUPD_CSUM_LCB",
830         "I40E_NVMUPD_STATUS",
831         "I40E_NVMUPD_EXEC_AQ",
832         "I40E_NVMUPD_GET_AQ_RESULT",
833 };
834
835 /**
836  * i40e_nvmupd_command - Process an NVM update command
837  * @hw: pointer to hardware structure
838  * @cmd: pointer to nvm update command
839  * @bytes: pointer to the data buffer
840  * @perrno: pointer to return error code
841  *
842  * Dispatches command depending on what update state is current
843  **/
844 enum i40e_status_code i40e_nvmupd_command(struct i40e_hw *hw,
845                                           struct i40e_nvm_access *cmd,
846                                           u8 *bytes, int *perrno)
847 {
848         enum i40e_status_code status;
849         enum i40e_nvmupd_cmd upd_cmd;
850
851         DEBUGFUNC("i40e_nvmupd_command");
852
853         /* assume success */
854         *perrno = 0;
855
856         /* early check for status command and debug msgs */
857         upd_cmd = i40e_nvmupd_validate_command(hw, cmd, perrno);
858
859         i40e_debug(hw, I40E_DEBUG_NVM, "%s state %d nvm_release_on_hold %d opc 0x%04x cmd 0x%08x config 0x%08x offset 0x%08x data_size 0x%08x\n",
860                    i40e_nvm_update_state_str[upd_cmd],
861                    hw->nvmupd_state,
862                    hw->nvm_release_on_done, hw->nvm_wait_opcode,
863                    cmd->command, cmd->config, cmd->offset, cmd->data_size);
864
865         if (upd_cmd == I40E_NVMUPD_INVALID) {
866                 *perrno = -EFAULT;
867                 i40e_debug(hw, I40E_DEBUG_NVM,
868                            "i40e_nvmupd_validate_command returns %d errno %d\n",
869                            upd_cmd, *perrno);
870         }
871
872         /* a status request returns immediately rather than
873          * going into the state machine
874          */
875         if (upd_cmd == I40E_NVMUPD_STATUS) {
876                 if (!cmd->data_size) {
877                         *perrno = -EFAULT;
878                         return I40E_ERR_BUF_TOO_SHORT;
879                 }
880
881                 bytes[0] = hw->nvmupd_state;
882
883                 if (cmd->data_size >= 4) {
884                         bytes[1] = 0;
885                         *((u16 *)&bytes[2]) = hw->nvm_wait_opcode;
886                 }
887
888                 /* Clear error status on read */
889                 if (hw->nvmupd_state == I40E_NVMUPD_STATE_ERROR)
890                         hw->nvmupd_state = I40E_NVMUPD_STATE_INIT;
891
892                 return I40E_SUCCESS;
893         }
894
895         /* Clear status even it is not read and log */
896         if (hw->nvmupd_state == I40E_NVMUPD_STATE_ERROR) {
897                 i40e_debug(hw, I40E_DEBUG_NVM,
898                            "Clearing I40E_NVMUPD_STATE_ERROR state without reading\n");
899                 hw->nvmupd_state = I40E_NVMUPD_STATE_INIT;
900         }
901
902         switch (hw->nvmupd_state) {
903         case I40E_NVMUPD_STATE_INIT:
904                 status = i40e_nvmupd_state_init(hw, cmd, bytes, perrno);
905                 break;
906
907         case I40E_NVMUPD_STATE_READING:
908                 status = i40e_nvmupd_state_reading(hw, cmd, bytes, perrno);
909                 break;
910
911         case I40E_NVMUPD_STATE_WRITING:
912                 status = i40e_nvmupd_state_writing(hw, cmd, bytes, perrno);
913                 break;
914
915         case I40E_NVMUPD_STATE_INIT_WAIT:
916         case I40E_NVMUPD_STATE_WRITE_WAIT:
917                 /* if we need to stop waiting for an event, clear
918                  * the wait info and return before doing anything else
919                  */
920                 if (cmd->offset == 0xffff) {
921                         i40e_nvmupd_check_wait_event(hw, hw->nvm_wait_opcode);
922                         return I40E_SUCCESS;
923                 }
924
925                 status = I40E_ERR_NOT_READY;
926                 *perrno = -EBUSY;
927                 break;
928
929         default:
930                 /* invalid state, should never happen */
931                 i40e_debug(hw, I40E_DEBUG_NVM,
932                            "NVMUPD: no such state %d\n", hw->nvmupd_state);
933                 status = I40E_NOT_SUPPORTED;
934                 *perrno = -ESRCH;
935                 break;
936         }
937         return status;
938 }
939
940 /**
941  * i40e_nvmupd_state_init - Handle NVM update state Init
942  * @hw: pointer to hardware structure
943  * @cmd: pointer to nvm update command buffer
944  * @bytes: pointer to the data buffer
945  * @perrno: pointer to return error code
946  *
947  * Process legitimate commands of the Init state and conditionally set next
948  * state. Reject all other commands.
949  **/
950 STATIC enum i40e_status_code i40e_nvmupd_state_init(struct i40e_hw *hw,
951                                                     struct i40e_nvm_access *cmd,
952                                                     u8 *bytes, int *perrno)
953 {
954         enum i40e_status_code status = I40E_SUCCESS;
955         enum i40e_nvmupd_cmd upd_cmd;
956
957         DEBUGFUNC("i40e_nvmupd_state_init");
958
959         upd_cmd = i40e_nvmupd_validate_command(hw, cmd, perrno);
960
961         switch (upd_cmd) {
962         case I40E_NVMUPD_READ_SA:
963                 status = i40e_acquire_nvm(hw, I40E_RESOURCE_READ);
964                 if (status) {
965                         *perrno = i40e_aq_rc_to_posix(status,
966                                                      hw->aq.asq_last_status);
967                 } else {
968                         status = i40e_nvmupd_nvm_read(hw, cmd, bytes, perrno);
969                         i40e_release_nvm(hw);
970                 }
971                 break;
972
973         case I40E_NVMUPD_READ_SNT:
974                 status = i40e_acquire_nvm(hw, I40E_RESOURCE_READ);
975                 if (status) {
976                         *perrno = i40e_aq_rc_to_posix(status,
977                                                      hw->aq.asq_last_status);
978                 } else {
979                         status = i40e_nvmupd_nvm_read(hw, cmd, bytes, perrno);
980                         if (status)
981                                 i40e_release_nvm(hw);
982                         else
983                                 hw->nvmupd_state = I40E_NVMUPD_STATE_READING;
984                 }
985                 break;
986
987         case I40E_NVMUPD_WRITE_ERA:
988                 status = i40e_acquire_nvm(hw, I40E_RESOURCE_WRITE);
989                 if (status) {
990                         *perrno = i40e_aq_rc_to_posix(status,
991                                                      hw->aq.asq_last_status);
992                 } else {
993                         status = i40e_nvmupd_nvm_erase(hw, cmd, perrno);
994                         if (status) {
995                                 i40e_release_nvm(hw);
996                         } else {
997                                 hw->nvm_release_on_done = true;
998                                 hw->nvm_wait_opcode = i40e_aqc_opc_nvm_erase;
999                                 hw->nvmupd_state = I40E_NVMUPD_STATE_INIT_WAIT;
1000                         }
1001                 }
1002                 break;
1003
1004         case I40E_NVMUPD_WRITE_SA:
1005                 status = i40e_acquire_nvm(hw, I40E_RESOURCE_WRITE);
1006                 if (status) {
1007                         *perrno = i40e_aq_rc_to_posix(status,
1008                                                      hw->aq.asq_last_status);
1009                 } else {
1010                         status = i40e_nvmupd_nvm_write(hw, cmd, bytes, perrno);
1011                         if (status) {
1012                                 i40e_release_nvm(hw);
1013                         } else {
1014                                 hw->nvm_release_on_done = true;
1015                                 hw->nvm_wait_opcode = i40e_aqc_opc_nvm_update;
1016                                 hw->nvmupd_state = I40E_NVMUPD_STATE_INIT_WAIT;
1017                         }
1018                 }
1019                 break;
1020
1021         case I40E_NVMUPD_WRITE_SNT:
1022                 status = i40e_acquire_nvm(hw, I40E_RESOURCE_WRITE);
1023                 if (status) {
1024                         *perrno = i40e_aq_rc_to_posix(status,
1025                                                      hw->aq.asq_last_status);
1026                 } else {
1027                         status = i40e_nvmupd_nvm_write(hw, cmd, bytes, perrno);
1028                         if (status) {
1029                                 i40e_release_nvm(hw);
1030                         } else {
1031                                 hw->nvm_wait_opcode = i40e_aqc_opc_nvm_update;
1032                                 hw->nvmupd_state = I40E_NVMUPD_STATE_WRITE_WAIT;
1033                         }
1034                 }
1035                 break;
1036
1037         case I40E_NVMUPD_CSUM_SA:
1038                 status = i40e_acquire_nvm(hw, I40E_RESOURCE_WRITE);
1039                 if (status) {
1040                         *perrno = i40e_aq_rc_to_posix(status,
1041                                                      hw->aq.asq_last_status);
1042                 } else {
1043                         status = i40e_update_nvm_checksum(hw);
1044                         if (status) {
1045                                 *perrno = hw->aq.asq_last_status ?
1046                                    i40e_aq_rc_to_posix(status,
1047                                                        hw->aq.asq_last_status) :
1048                                    -EIO;
1049                                 i40e_release_nvm(hw);
1050                         } else {
1051                                 hw->nvm_release_on_done = true;
1052                                 hw->nvm_wait_opcode = i40e_aqc_opc_nvm_update;
1053                                 hw->nvmupd_state = I40E_NVMUPD_STATE_INIT_WAIT;
1054                         }
1055                 }
1056                 break;
1057
1058         case I40E_NVMUPD_EXEC_AQ:
1059                 status = i40e_nvmupd_exec_aq(hw, cmd, bytes, perrno);
1060                 break;
1061
1062         case I40E_NVMUPD_GET_AQ_RESULT:
1063                 status = i40e_nvmupd_get_aq_result(hw, cmd, bytes, perrno);
1064                 break;
1065
1066         default:
1067                 i40e_debug(hw, I40E_DEBUG_NVM,
1068                            "NVMUPD: bad cmd %s in init state\n",
1069                            i40e_nvm_update_state_str[upd_cmd]);
1070                 status = I40E_ERR_NVM;
1071                 *perrno = -ESRCH;
1072                 break;
1073         }
1074         return status;
1075 }
1076
1077 /**
1078  * i40e_nvmupd_state_reading - Handle NVM update state Reading
1079  * @hw: pointer to hardware structure
1080  * @cmd: pointer to nvm update command buffer
1081  * @bytes: pointer to the data buffer
1082  * @perrno: pointer to return error code
1083  *
1084  * NVM ownership is already held.  Process legitimate commands and set any
1085  * change in state; reject all other commands.
1086  **/
1087 STATIC enum i40e_status_code i40e_nvmupd_state_reading(struct i40e_hw *hw,
1088                                                     struct i40e_nvm_access *cmd,
1089                                                     u8 *bytes, int *perrno)
1090 {
1091         enum i40e_status_code status = I40E_SUCCESS;
1092         enum i40e_nvmupd_cmd upd_cmd;
1093
1094         DEBUGFUNC("i40e_nvmupd_state_reading");
1095
1096         upd_cmd = i40e_nvmupd_validate_command(hw, cmd, perrno);
1097
1098         switch (upd_cmd) {
1099         case I40E_NVMUPD_READ_SA:
1100         case I40E_NVMUPD_READ_CON:
1101                 status = i40e_nvmupd_nvm_read(hw, cmd, bytes, perrno);
1102                 break;
1103
1104         case I40E_NVMUPD_READ_LCB:
1105                 status = i40e_nvmupd_nvm_read(hw, cmd, bytes, perrno);
1106                 i40e_release_nvm(hw);
1107                 hw->nvmupd_state = I40E_NVMUPD_STATE_INIT;
1108                 break;
1109
1110         default:
1111                 i40e_debug(hw, I40E_DEBUG_NVM,
1112                            "NVMUPD: bad cmd %s in reading state.\n",
1113                            i40e_nvm_update_state_str[upd_cmd]);
1114                 status = I40E_NOT_SUPPORTED;
1115                 *perrno = -ESRCH;
1116                 break;
1117         }
1118         return status;
1119 }
1120
1121 /**
1122  * i40e_nvmupd_state_writing - Handle NVM update state Writing
1123  * @hw: pointer to hardware structure
1124  * @cmd: pointer to nvm update command buffer
1125  * @bytes: pointer to the data buffer
1126  * @perrno: pointer to return error code
1127  *
1128  * NVM ownership is already held.  Process legitimate commands and set any
1129  * change in state; reject all other commands
1130  **/
1131 STATIC enum i40e_status_code i40e_nvmupd_state_writing(struct i40e_hw *hw,
1132                                                     struct i40e_nvm_access *cmd,
1133                                                     u8 *bytes, int *perrno)
1134 {
1135         enum i40e_status_code status = I40E_SUCCESS;
1136         enum i40e_nvmupd_cmd upd_cmd;
1137         bool retry_attempt = false;
1138
1139         DEBUGFUNC("i40e_nvmupd_state_writing");
1140
1141         upd_cmd = i40e_nvmupd_validate_command(hw, cmd, perrno);
1142
1143 retry:
1144         switch (upd_cmd) {
1145         case I40E_NVMUPD_WRITE_CON:
1146                 status = i40e_nvmupd_nvm_write(hw, cmd, bytes, perrno);
1147                 if (!status) {
1148                         hw->nvm_wait_opcode = i40e_aqc_opc_nvm_update;
1149                         hw->nvmupd_state = I40E_NVMUPD_STATE_WRITE_WAIT;
1150                 }
1151                 break;
1152
1153         case I40E_NVMUPD_WRITE_LCB:
1154                 status = i40e_nvmupd_nvm_write(hw, cmd, bytes, perrno);
1155                 if (status) {
1156                         *perrno = hw->aq.asq_last_status ?
1157                                    i40e_aq_rc_to_posix(status,
1158                                                        hw->aq.asq_last_status) :
1159                                    -EIO;
1160                         hw->nvmupd_state = I40E_NVMUPD_STATE_INIT;
1161                 } else {
1162                         hw->nvm_release_on_done = true;
1163                         hw->nvm_wait_opcode = i40e_aqc_opc_nvm_update;
1164                         hw->nvmupd_state = I40E_NVMUPD_STATE_INIT_WAIT;
1165                 }
1166                 break;
1167
1168         case I40E_NVMUPD_CSUM_CON:
1169                 /* Assumes the caller has acquired the nvm */
1170                 status = i40e_update_nvm_checksum(hw);
1171                 if (status) {
1172                         *perrno = hw->aq.asq_last_status ?
1173                                    i40e_aq_rc_to_posix(status,
1174                                                        hw->aq.asq_last_status) :
1175                                    -EIO;
1176                         hw->nvmupd_state = I40E_NVMUPD_STATE_INIT;
1177                 } else {
1178                         hw->nvm_wait_opcode = i40e_aqc_opc_nvm_update;
1179                         hw->nvmupd_state = I40E_NVMUPD_STATE_WRITE_WAIT;
1180                 }
1181                 break;
1182
1183         case I40E_NVMUPD_CSUM_LCB:
1184                 /* Assumes the caller has acquired the nvm */
1185                 status = i40e_update_nvm_checksum(hw);
1186                 if (status) {
1187                         *perrno = hw->aq.asq_last_status ?
1188                                    i40e_aq_rc_to_posix(status,
1189                                                        hw->aq.asq_last_status) :
1190                                    -EIO;
1191                         hw->nvmupd_state = I40E_NVMUPD_STATE_INIT;
1192                 } else {
1193                         hw->nvm_release_on_done = true;
1194                         hw->nvm_wait_opcode = i40e_aqc_opc_nvm_update;
1195                         hw->nvmupd_state = I40E_NVMUPD_STATE_INIT_WAIT;
1196                 }
1197                 break;
1198
1199         default:
1200                 i40e_debug(hw, I40E_DEBUG_NVM,
1201                            "NVMUPD: bad cmd %s in writing state.\n",
1202                            i40e_nvm_update_state_str[upd_cmd]);
1203                 status = I40E_NOT_SUPPORTED;
1204                 *perrno = -ESRCH;
1205                 break;
1206         }
1207
1208         /* In some circumstances, a multi-write transaction takes longer
1209          * than the default 3 minute timeout on the write semaphore.  If
1210          * the write failed with an EBUSY status, this is likely the problem,
1211          * so here we try to reacquire the semaphore then retry the write.
1212          * We only do one retry, then give up.
1213          */
1214         if (status && (hw->aq.asq_last_status == I40E_AQ_RC_EBUSY) &&
1215             !retry_attempt) {
1216                 enum i40e_status_code old_status = status;
1217                 u32 old_asq_status = hw->aq.asq_last_status;
1218                 u32 gtime;
1219
1220                 gtime = rd32(hw, I40E_GLVFGEN_TIMER);
1221                 if (gtime >= hw->nvm.hw_semaphore_timeout) {
1222                         i40e_debug(hw, I40E_DEBUG_ALL,
1223                                    "NVMUPD: write semaphore expired (%d >= %lld), retrying\n",
1224                                    gtime, hw->nvm.hw_semaphore_timeout);
1225                         i40e_release_nvm(hw);
1226                         status = i40e_acquire_nvm(hw, I40E_RESOURCE_WRITE);
1227                         if (status) {
1228                                 i40e_debug(hw, I40E_DEBUG_ALL,
1229                                            "NVMUPD: write semaphore reacquire failed aq_err = %d\n",
1230                                            hw->aq.asq_last_status);
1231                                 status = old_status;
1232                                 hw->aq.asq_last_status = old_asq_status;
1233                         } else {
1234                                 retry_attempt = true;
1235                                 goto retry;
1236                         }
1237                 }
1238         }
1239
1240         return status;
1241 }
1242
1243 /**
1244  * i40e_nvmupd_check_wait_event - handle NVM update operation events
1245  * @hw: pointer to the hardware structure
1246  * @opcode: the event that just happened
1247  **/
1248 void i40e_nvmupd_check_wait_event(struct i40e_hw *hw, u16 opcode)
1249 {
1250         if (opcode == hw->nvm_wait_opcode) {
1251
1252                 i40e_debug(hw, I40E_DEBUG_NVM,
1253                            "NVMUPD: clearing wait on opcode 0x%04x\n", opcode);
1254                 if (hw->nvm_release_on_done) {
1255                         i40e_release_nvm(hw);
1256                         hw->nvm_release_on_done = false;
1257                 }
1258                 hw->nvm_wait_opcode = 0;
1259
1260                 if (hw->aq.arq_last_status) {
1261                         hw->nvmupd_state = I40E_NVMUPD_STATE_ERROR;
1262                         return;
1263                 }
1264
1265                 switch (hw->nvmupd_state) {
1266                 case I40E_NVMUPD_STATE_INIT_WAIT:
1267                         hw->nvmupd_state = I40E_NVMUPD_STATE_INIT;
1268                         break;
1269
1270                 case I40E_NVMUPD_STATE_WRITE_WAIT:
1271                         hw->nvmupd_state = I40E_NVMUPD_STATE_WRITING;
1272                         break;
1273
1274                 default:
1275                         break;
1276                 }
1277         }
1278 }
1279
1280 /**
1281  * i40e_nvmupd_validate_command - Validate given command
1282  * @hw: pointer to hardware structure
1283  * @cmd: pointer to nvm update command buffer
1284  * @perrno: pointer to return error code
1285  *
1286  * Return one of the valid command types or I40E_NVMUPD_INVALID
1287  **/
1288 STATIC enum i40e_nvmupd_cmd i40e_nvmupd_validate_command(struct i40e_hw *hw,
1289                                                     struct i40e_nvm_access *cmd,
1290                                                     int *perrno)
1291 {
1292         enum i40e_nvmupd_cmd upd_cmd;
1293         u8 module, transaction;
1294
1295         DEBUGFUNC("i40e_nvmupd_validate_command\n");
1296
1297         /* anything that doesn't match a recognized case is an error */
1298         upd_cmd = I40E_NVMUPD_INVALID;
1299
1300         transaction = i40e_nvmupd_get_transaction(cmd->config);
1301         module = i40e_nvmupd_get_module(cmd->config);
1302
1303         /* limits on data size */
1304         if ((cmd->data_size < 1) ||
1305             (cmd->data_size > I40E_NVMUPD_MAX_DATA)) {
1306                 i40e_debug(hw, I40E_DEBUG_NVM,
1307                            "i40e_nvmupd_validate_command data_size %d\n",
1308                            cmd->data_size);
1309                 *perrno = -EFAULT;
1310                 return I40E_NVMUPD_INVALID;
1311         }
1312
1313         switch (cmd->command) {
1314         case I40E_NVM_READ:
1315                 switch (transaction) {
1316                 case I40E_NVM_CON:
1317                         upd_cmd = I40E_NVMUPD_READ_CON;
1318                         break;
1319                 case I40E_NVM_SNT:
1320                         upd_cmd = I40E_NVMUPD_READ_SNT;
1321                         break;
1322                 case I40E_NVM_LCB:
1323                         upd_cmd = I40E_NVMUPD_READ_LCB;
1324                         break;
1325                 case I40E_NVM_SA:
1326                         upd_cmd = I40E_NVMUPD_READ_SA;
1327                         break;
1328                 case I40E_NVM_EXEC:
1329                         if (module == 0xf)
1330                                 upd_cmd = I40E_NVMUPD_STATUS;
1331                         else if (module == 0)
1332                                 upd_cmd = I40E_NVMUPD_GET_AQ_RESULT;
1333                         break;
1334                 }
1335                 break;
1336
1337         case I40E_NVM_WRITE:
1338                 switch (transaction) {
1339                 case I40E_NVM_CON:
1340                         upd_cmd = I40E_NVMUPD_WRITE_CON;
1341                         break;
1342                 case I40E_NVM_SNT:
1343                         upd_cmd = I40E_NVMUPD_WRITE_SNT;
1344                         break;
1345                 case I40E_NVM_LCB:
1346                         upd_cmd = I40E_NVMUPD_WRITE_LCB;
1347                         break;
1348                 case I40E_NVM_SA:
1349                         upd_cmd = I40E_NVMUPD_WRITE_SA;
1350                         break;
1351                 case I40E_NVM_ERA:
1352                         upd_cmd = I40E_NVMUPD_WRITE_ERA;
1353                         break;
1354                 case I40E_NVM_CSUM:
1355                         upd_cmd = I40E_NVMUPD_CSUM_CON;
1356                         break;
1357                 case (I40E_NVM_CSUM|I40E_NVM_SA):
1358                         upd_cmd = I40E_NVMUPD_CSUM_SA;
1359                         break;
1360                 case (I40E_NVM_CSUM|I40E_NVM_LCB):
1361                         upd_cmd = I40E_NVMUPD_CSUM_LCB;
1362                         break;
1363                 case I40E_NVM_EXEC:
1364                         if (module == 0)
1365                                 upd_cmd = I40E_NVMUPD_EXEC_AQ;
1366                         break;
1367                 }
1368                 break;
1369         }
1370
1371         return upd_cmd;
1372 }
1373
1374 /**
1375  * i40e_nvmupd_exec_aq - Run an AQ command
1376  * @hw: pointer to hardware structure
1377  * @cmd: pointer to nvm update command buffer
1378  * @bytes: pointer to the data buffer
1379  * @perrno: pointer to return error code
1380  *
1381  * cmd structure contains identifiers and data buffer
1382  **/
1383 STATIC enum i40e_status_code i40e_nvmupd_exec_aq(struct i40e_hw *hw,
1384                                                  struct i40e_nvm_access *cmd,
1385                                                  u8 *bytes, int *perrno)
1386 {
1387         struct i40e_asq_cmd_details cmd_details;
1388         enum i40e_status_code status;
1389         struct i40e_aq_desc *aq_desc;
1390         u32 buff_size = 0;
1391         u8 *buff = NULL;
1392         u32 aq_desc_len;
1393         u32 aq_data_len;
1394
1395         i40e_debug(hw, I40E_DEBUG_NVM, "NVMUPD: %s\n", __func__);
1396         memset(&cmd_details, 0, sizeof(cmd_details));
1397         cmd_details.wb_desc = &hw->nvm_wb_desc;
1398
1399         aq_desc_len = sizeof(struct i40e_aq_desc);
1400         memset(&hw->nvm_wb_desc, 0, aq_desc_len);
1401
1402         /* get the aq descriptor */
1403         if (cmd->data_size < aq_desc_len) {
1404                 i40e_debug(hw, I40E_DEBUG_NVM,
1405                            "NVMUPD: not enough aq desc bytes for exec, size %d < %d\n",
1406                            cmd->data_size, aq_desc_len);
1407                 *perrno = -EINVAL;
1408                 return I40E_ERR_PARAM;
1409         }
1410         aq_desc = (struct i40e_aq_desc *)bytes;
1411
1412         /* if data buffer needed, make sure it's ready */
1413         aq_data_len = cmd->data_size - aq_desc_len;
1414         buff_size = max(aq_data_len, (u32)LE16_TO_CPU(aq_desc->datalen));
1415         if (buff_size) {
1416                 if (!hw->nvm_buff.va) {
1417                         status = i40e_allocate_virt_mem(hw, &hw->nvm_buff,
1418                                                         hw->aq.asq_buf_size);
1419                         if (status)
1420                                 i40e_debug(hw, I40E_DEBUG_NVM,
1421                                            "NVMUPD: i40e_allocate_virt_mem for exec buff failed, %d\n",
1422                                            status);
1423                 }
1424
1425                 if (hw->nvm_buff.va) {
1426                         buff = hw->nvm_buff.va;
1427                         i40e_memcpy(buff, &bytes[aq_desc_len], aq_data_len,
1428                                 I40E_NONDMA_TO_NONDMA);
1429                 }
1430         }
1431
1432         /* and away we go! */
1433         status = i40e_asq_send_command(hw, aq_desc, buff,
1434                                        buff_size, &cmd_details);
1435         if (status) {
1436                 i40e_debug(hw, I40E_DEBUG_NVM,
1437                            "i40e_nvmupd_exec_aq err %s aq_err %s\n",
1438                            i40e_stat_str(hw, status),
1439                            i40e_aq_str(hw, hw->aq.asq_last_status));
1440                 *perrno = i40e_aq_rc_to_posix(status, hw->aq.asq_last_status);
1441         }
1442
1443         /* should we wait for a followup event? */
1444         if (cmd->offset) {
1445                 hw->nvm_wait_opcode = cmd->offset;
1446                 hw->nvmupd_state = I40E_NVMUPD_STATE_INIT_WAIT;
1447         }
1448
1449         return status;
1450 }
1451
1452 /**
1453  * i40e_nvmupd_get_aq_result - Get the results from the previous exec_aq
1454  * @hw: pointer to hardware structure
1455  * @cmd: pointer to nvm update command buffer
1456  * @bytes: pointer to the data buffer
1457  * @perrno: pointer to return error code
1458  *
1459  * cmd structure contains identifiers and data buffer
1460  **/
1461 STATIC enum i40e_status_code i40e_nvmupd_get_aq_result(struct i40e_hw *hw,
1462                                                     struct i40e_nvm_access *cmd,
1463                                                     u8 *bytes, int *perrno)
1464 {
1465         u32 aq_total_len;
1466         u32 aq_desc_len;
1467         int remainder;
1468         u8 *buff;
1469
1470         i40e_debug(hw, I40E_DEBUG_NVM, "NVMUPD: %s\n", __func__);
1471
1472         aq_desc_len = sizeof(struct i40e_aq_desc);
1473         aq_total_len = aq_desc_len + LE16_TO_CPU(hw->nvm_wb_desc.datalen);
1474
1475         /* check offset range */
1476         if (cmd->offset > aq_total_len) {
1477                 i40e_debug(hw, I40E_DEBUG_NVM, "%s: offset too big %d > %d\n",
1478                            __func__, cmd->offset, aq_total_len);
1479                 *perrno = -EINVAL;
1480                 return I40E_ERR_PARAM;
1481         }
1482
1483         /* check copylength range */
1484         if (cmd->data_size > (aq_total_len - cmd->offset)) {
1485                 int new_len = aq_total_len - cmd->offset;
1486
1487                 i40e_debug(hw, I40E_DEBUG_NVM, "%s: copy length %d too big, trimming to %d\n",
1488                            __func__, cmd->data_size, new_len);
1489                 cmd->data_size = new_len;
1490         }
1491
1492         remainder = cmd->data_size;
1493         if (cmd->offset < aq_desc_len) {
1494                 u32 len = aq_desc_len - cmd->offset;
1495
1496                 len = min(len, cmd->data_size);
1497                 i40e_debug(hw, I40E_DEBUG_NVM, "%s: aq_desc bytes %d to %d\n",
1498                            __func__, cmd->offset, cmd->offset + len);
1499
1500                 buff = ((u8 *)&hw->nvm_wb_desc) + cmd->offset;
1501                 i40e_memcpy(bytes, buff, len, I40E_NONDMA_TO_NONDMA);
1502
1503                 bytes += len;
1504                 remainder -= len;
1505                 buff = hw->nvm_buff.va;
1506         } else {
1507                 buff = (u8 *)hw->nvm_buff.va + (cmd->offset - aq_desc_len);
1508         }
1509
1510         if (remainder > 0) {
1511                 int start_byte = buff - (u8 *)hw->nvm_buff.va;
1512
1513                 i40e_debug(hw, I40E_DEBUG_NVM, "%s: databuf bytes %d to %d\n",
1514                            __func__, start_byte, start_byte + remainder);
1515                 i40e_memcpy(bytes, buff, remainder, I40E_NONDMA_TO_NONDMA);
1516         }
1517
1518         return I40E_SUCCESS;
1519 }
1520
1521 /**
1522  * i40e_nvmupd_nvm_read - Read NVM
1523  * @hw: pointer to hardware structure
1524  * @cmd: pointer to nvm update command buffer
1525  * @bytes: pointer to the data buffer
1526  * @perrno: pointer to return error code
1527  *
1528  * cmd structure contains identifiers and data buffer
1529  **/
1530 STATIC enum i40e_status_code i40e_nvmupd_nvm_read(struct i40e_hw *hw,
1531                                                   struct i40e_nvm_access *cmd,
1532                                                   u8 *bytes, int *perrno)
1533 {
1534         struct i40e_asq_cmd_details cmd_details;
1535         enum i40e_status_code status;
1536         u8 module, transaction;
1537         bool last;
1538
1539         transaction = i40e_nvmupd_get_transaction(cmd->config);
1540         module = i40e_nvmupd_get_module(cmd->config);
1541         last = (transaction == I40E_NVM_LCB) || (transaction == I40E_NVM_SA);
1542
1543         memset(&cmd_details, 0, sizeof(cmd_details));
1544         cmd_details.wb_desc = &hw->nvm_wb_desc;
1545
1546         status = i40e_aq_read_nvm(hw, module, cmd->offset, (u16)cmd->data_size,
1547                                   bytes, last, &cmd_details);
1548         if (status) {
1549                 i40e_debug(hw, I40E_DEBUG_NVM,
1550                            "i40e_nvmupd_nvm_read mod 0x%x  off 0x%x  len 0x%x\n",
1551                            module, cmd->offset, cmd->data_size);
1552                 i40e_debug(hw, I40E_DEBUG_NVM,
1553                            "i40e_nvmupd_nvm_read status %d aq %d\n",
1554                            status, hw->aq.asq_last_status);
1555                 *perrno = i40e_aq_rc_to_posix(status, hw->aq.asq_last_status);
1556         }
1557
1558         return status;
1559 }
1560
1561 /**
1562  * i40e_nvmupd_nvm_erase - Erase an NVM module
1563  * @hw: pointer to hardware structure
1564  * @cmd: pointer to nvm update command buffer
1565  * @perrno: pointer to return error code
1566  *
1567  * module, offset, data_size and data are in cmd structure
1568  **/
1569 STATIC enum i40e_status_code i40e_nvmupd_nvm_erase(struct i40e_hw *hw,
1570                                                    struct i40e_nvm_access *cmd,
1571                                                    int *perrno)
1572 {
1573         enum i40e_status_code status = I40E_SUCCESS;
1574         struct i40e_asq_cmd_details cmd_details;
1575         u8 module, transaction;
1576         bool last;
1577
1578         transaction = i40e_nvmupd_get_transaction(cmd->config);
1579         module = i40e_nvmupd_get_module(cmd->config);
1580         last = (transaction & I40E_NVM_LCB);
1581
1582         memset(&cmd_details, 0, sizeof(cmd_details));
1583         cmd_details.wb_desc = &hw->nvm_wb_desc;
1584
1585         status = i40e_aq_erase_nvm(hw, module, cmd->offset, (u16)cmd->data_size,
1586                                    last, &cmd_details);
1587         if (status) {
1588                 i40e_debug(hw, I40E_DEBUG_NVM,
1589                            "i40e_nvmupd_nvm_erase mod 0x%x  off 0x%x len 0x%x\n",
1590                            module, cmd->offset, cmd->data_size);
1591                 i40e_debug(hw, I40E_DEBUG_NVM,
1592                            "i40e_nvmupd_nvm_erase status %d aq %d\n",
1593                            status, hw->aq.asq_last_status);
1594                 *perrno = i40e_aq_rc_to_posix(status, hw->aq.asq_last_status);
1595         }
1596
1597         return status;
1598 }
1599
1600 /**
1601  * i40e_nvmupd_nvm_write - Write NVM
1602  * @hw: pointer to hardware structure
1603  * @cmd: pointer to nvm update command buffer
1604  * @bytes: pointer to the data buffer
1605  * @perrno: pointer to return error code
1606  *
1607  * module, offset, data_size and data are in cmd structure
1608  **/
1609 STATIC enum i40e_status_code i40e_nvmupd_nvm_write(struct i40e_hw *hw,
1610                                                    struct i40e_nvm_access *cmd,
1611                                                    u8 *bytes, int *perrno)
1612 {
1613         enum i40e_status_code status = I40E_SUCCESS;
1614         struct i40e_asq_cmd_details cmd_details;
1615         u8 module, transaction;
1616         bool last;
1617
1618         transaction = i40e_nvmupd_get_transaction(cmd->config);
1619         module = i40e_nvmupd_get_module(cmd->config);
1620         last = (transaction & I40E_NVM_LCB);
1621
1622         memset(&cmd_details, 0, sizeof(cmd_details));
1623         cmd_details.wb_desc = &hw->nvm_wb_desc;
1624
1625         status = i40e_aq_update_nvm(hw, module, cmd->offset,
1626                                     (u16)cmd->data_size, bytes, last,
1627                                     &cmd_details);
1628         if (status) {
1629                 i40e_debug(hw, I40E_DEBUG_NVM,
1630                            "i40e_nvmupd_nvm_write mod 0x%x off 0x%x len 0x%x\n",
1631                            module, cmd->offset, cmd->data_size);
1632                 i40e_debug(hw, I40E_DEBUG_NVM,
1633                            "i40e_nvmupd_nvm_write status %d aq %d\n",
1634                            status, hw->aq.asq_last_status);
1635                 *perrno = i40e_aq_rc_to_posix(status, hw->aq.asq_last_status);
1636         }
1637
1638         return status;
1639 }