iwlwifi: mvm: take the MAC address from HW registers
[linux-2.6-microblaze.git] / drivers / net / wireless / iwlwifi / mvm / nvm.c
1 /******************************************************************************
2  *
3  * This file is provided under a dual BSD/GPLv2 license.  When using or
4  * redistributing this file, you may do so under either license.
5  *
6  * GPL LICENSE SUMMARY
7  *
8  * Copyright(c) 2012 - 2014 Intel Corporation. All rights reserved.
9  * Copyright(c) 2013 - 2014 Intel Mobile Communications GmbH
10  *
11  * This program is free software; you can redistribute it and/or modify
12  * it under the terms of version 2 of the GNU General Public License as
13  * published by the Free Software Foundation.
14  *
15  * This program is distributed in the hope that it will be useful, but
16  * WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18  * General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
23  * USA
24  *
25  * The full GNU General Public License is included in this distribution
26  * in the file called COPYING.
27  *
28  * Contact Information:
29  *  Intel Linux Wireless <ilw@linux.intel.com>
30  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
31  *
32  * BSD LICENSE
33  *
34  * Copyright(c) 2012 - 2014 Intel Corporation. All rights reserved.
35  * Copyright(c) 2013 - 2014 Intel Mobile Communications GmbH
36  * All rights reserved.
37  *
38  * Redistribution and use in source and binary forms, with or without
39  * modification, are permitted provided that the following conditions
40  * are met:
41  *
42  *  * Redistributions of source code must retain the above copyright
43  *    notice, this list of conditions and the following disclaimer.
44  *  * Redistributions in binary form must reproduce the above copyright
45  *    notice, this list of conditions and the following disclaimer in
46  *    the documentation and/or other materials provided with the
47  *    distribution.
48  *  * Neither the name Intel Corporation nor the names of its
49  *    contributors may be used to endorse or promote products derived
50  *    from this software without specific prior written permission.
51  *
52  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
53  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
54  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
55  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
56  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
57  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
58  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
59  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
60  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
61  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
62  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
63  *
64  *****************************************************************************/
65 #include <linux/firmware.h>
66 #include <linux/rtnetlink.h>
67 #include "iwl-trans.h"
68 #include "iwl-csr.h"
69 #include "mvm.h"
70 #include "iwl-eeprom-parse.h"
71 #include "iwl-eeprom-read.h"
72 #include "iwl-nvm-parse.h"
73 #include "iwl-prph.h"
74
75 /* Default NVM size to read */
76 #define IWL_NVM_DEFAULT_CHUNK_SIZE (2*1024)
77 #define IWL_MAX_NVM_SECTION_SIZE        0x1b58
78 #define IWL_MAX_NVM_8000A_SECTION_SIZE  0xffc
79 #define IWL_MAX_NVM_8000B_SECTION_SIZE  0x1ffc
80
81 #define NVM_WRITE_OPCODE 1
82 #define NVM_READ_OPCODE 0
83
84 /* load nvm chunk response */
85 enum {
86         READ_NVM_CHUNK_SUCCEED = 0,
87         READ_NVM_CHUNK_NOT_VALID_ADDRESS = 1
88 };
89
90 /*
91  * prepare the NVM host command w/ the pointers to the nvm buffer
92  * and send it to fw
93  */
94 static int iwl_nvm_write_chunk(struct iwl_mvm *mvm, u16 section,
95                                u16 offset, u16 length, const u8 *data)
96 {
97         struct iwl_nvm_access_cmd nvm_access_cmd = {
98                 .offset = cpu_to_le16(offset),
99                 .length = cpu_to_le16(length),
100                 .type = cpu_to_le16(section),
101                 .op_code = NVM_WRITE_OPCODE,
102         };
103         struct iwl_host_cmd cmd = {
104                 .id = NVM_ACCESS_CMD,
105                 .len = { sizeof(struct iwl_nvm_access_cmd), length },
106                 .flags = CMD_SEND_IN_RFKILL,
107                 .data = { &nvm_access_cmd, data },
108                 /* data may come from vmalloc, so use _DUP */
109                 .dataflags = { 0, IWL_HCMD_DFL_DUP },
110         };
111
112         return iwl_mvm_send_cmd(mvm, &cmd);
113 }
114
115 static int iwl_nvm_read_chunk(struct iwl_mvm *mvm, u16 section,
116                               u16 offset, u16 length, u8 *data)
117 {
118         struct iwl_nvm_access_cmd nvm_access_cmd = {
119                 .offset = cpu_to_le16(offset),
120                 .length = cpu_to_le16(length),
121                 .type = cpu_to_le16(section),
122                 .op_code = NVM_READ_OPCODE,
123         };
124         struct iwl_nvm_access_resp *nvm_resp;
125         struct iwl_rx_packet *pkt;
126         struct iwl_host_cmd cmd = {
127                 .id = NVM_ACCESS_CMD,
128                 .flags = CMD_WANT_SKB | CMD_SEND_IN_RFKILL,
129                 .data = { &nvm_access_cmd, },
130         };
131         int ret, bytes_read, offset_read;
132         u8 *resp_data;
133
134         cmd.len[0] = sizeof(struct iwl_nvm_access_cmd);
135
136         ret = iwl_mvm_send_cmd(mvm, &cmd);
137         if (ret)
138                 return ret;
139
140         pkt = cmd.resp_pkt;
141         if (pkt->hdr.flags & IWL_CMD_FAILED_MSK) {
142                 IWL_ERR(mvm, "Bad return from NVM_ACCES_COMMAND (0x%08X)\n",
143                         pkt->hdr.flags);
144                 ret = -EIO;
145                 goto exit;
146         }
147
148         /* Extract NVM response */
149         nvm_resp = (void *)pkt->data;
150         ret = le16_to_cpu(nvm_resp->status);
151         bytes_read = le16_to_cpu(nvm_resp->length);
152         offset_read = le16_to_cpu(nvm_resp->offset);
153         resp_data = nvm_resp->data;
154         if (ret) {
155                 if ((offset != 0) &&
156                     (ret == READ_NVM_CHUNK_NOT_VALID_ADDRESS)) {
157                         /*
158                          * meaning of NOT_VALID_ADDRESS:
159                          * driver try to read chunk from address that is
160                          * multiple of 2K and got an error since addr is empty.
161                          * meaning of (offset != 0): driver already
162                          * read valid data from another chunk so this case
163                          * is not an error.
164                          */
165                         IWL_DEBUG_EEPROM(mvm->trans->dev,
166                                          "NVM access command failed on offset 0x%x since that section size is multiple 2K\n",
167                                          offset);
168                         ret = 0;
169                 } else {
170                         IWL_DEBUG_EEPROM(mvm->trans->dev,
171                                          "NVM access command failed with status %d (device: %s)\n",
172                                          ret, mvm->cfg->name);
173                         ret = -EIO;
174                 }
175                 goto exit;
176         }
177
178         if (offset_read != offset) {
179                 IWL_ERR(mvm, "NVM ACCESS response with invalid offset %d\n",
180                         offset_read);
181                 ret = -EINVAL;
182                 goto exit;
183         }
184
185         /* Write data to NVM */
186         memcpy(data + offset, resp_data, bytes_read);
187         ret = bytes_read;
188
189 exit:
190         iwl_free_resp(&cmd);
191         return ret;
192 }
193
194 static int iwl_nvm_write_section(struct iwl_mvm *mvm, u16 section,
195                                  const u8 *data, u16 length)
196 {
197         int offset = 0;
198
199         /* copy data in chunks of 2k (and remainder if any) */
200
201         while (offset < length) {
202                 int chunk_size, ret;
203
204                 chunk_size = min(IWL_NVM_DEFAULT_CHUNK_SIZE,
205                                  length - offset);
206
207                 ret = iwl_nvm_write_chunk(mvm, section, offset,
208                                           chunk_size, data + offset);
209                 if (ret < 0)
210                         return ret;
211
212                 offset += chunk_size;
213         }
214
215         return 0;
216 }
217
218 /*
219  * Reads an NVM section completely.
220  * NICs prior to 7000 family doesn't have a real NVM, but just read
221  * section 0 which is the EEPROM. Because the EEPROM reading is unlimited
222  * by uCode, we need to manually check in this case that we don't
223  * overflow and try to read more than the EEPROM size.
224  * For 7000 family NICs, we supply the maximal size we can read, and
225  * the uCode fills the response with as much data as we can,
226  * without overflowing, so no check is needed.
227  */
228 static int iwl_nvm_read_section(struct iwl_mvm *mvm, u16 section,
229                                 u8 *data, u32 size_read)
230 {
231         u16 length, offset = 0;
232         int ret;
233
234         /* Set nvm section read length */
235         length = IWL_NVM_DEFAULT_CHUNK_SIZE;
236
237         ret = length;
238
239         /* Read the NVM until exhausted (reading less than requested) */
240         while (ret == length) {
241                 /* Check no memory assumptions fail and cause an overflow */
242                 if ((size_read + offset + length) >
243                     mvm->cfg->base_params->eeprom_size) {
244                         IWL_ERR(mvm, "EEPROM size is too small for NVM\n");
245                         return -ENOBUFS;
246                 }
247
248                 ret = iwl_nvm_read_chunk(mvm, section, offset, length, data);
249                 if (ret < 0) {
250                         IWL_DEBUG_EEPROM(mvm->trans->dev,
251                                          "Cannot read NVM from section %d offset %d, length %d\n",
252                                          section, offset, length);
253                         return ret;
254                 }
255                 offset += ret;
256         }
257
258         IWL_DEBUG_EEPROM(mvm->trans->dev,
259                          "NVM section %d read completed\n", section);
260         return offset;
261 }
262
263 static struct iwl_nvm_data *
264 iwl_parse_nvm_sections(struct iwl_mvm *mvm)
265 {
266         struct iwl_nvm_section *sections = mvm->nvm_sections;
267         const __le16 *hw, *sw, *calib, *regulatory, *mac_override, *phy_sku;
268         bool is_family_8000_a_step = false, lar_enabled;
269         u32 mac_addr0, mac_addr1;
270
271         /* Checking for required sections */
272         if (mvm->trans->cfg->device_family != IWL_DEVICE_FAMILY_8000) {
273                 if (!mvm->nvm_sections[NVM_SECTION_TYPE_SW].data ||
274                     !mvm->nvm_sections[mvm->cfg->nvm_hw_section_num].data) {
275                         IWL_ERR(mvm, "Can't parse empty OTP/NVM sections\n");
276                         return NULL;
277                 }
278         } else {
279                 /* SW and REGULATORY sections are mandatory */
280                 if (!mvm->nvm_sections[NVM_SECTION_TYPE_SW].data ||
281                     !mvm->nvm_sections[NVM_SECTION_TYPE_REGULATORY].data) {
282                         IWL_ERR(mvm,
283                                 "Can't parse empty family 8000 OTP/NVM sections\n");
284                         return NULL;
285                 }
286                 /* MAC_OVERRIDE or at least HW section must exist */
287                 if (!mvm->nvm_sections[mvm->cfg->nvm_hw_section_num].data &&
288                     !mvm->nvm_sections[NVM_SECTION_TYPE_MAC_OVERRIDE].data) {
289                         IWL_ERR(mvm,
290                                 "Can't parse mac_address, empty sections\n");
291                         return NULL;
292                 }
293
294                 if (CSR_HW_REV_STEP(mvm->trans->hw_rev) == SILICON_A_STEP)
295                         is_family_8000_a_step = true;
296
297                 /* PHY_SKU section is mandatory in B0 */
298                 if (!is_family_8000_a_step &&
299                     !mvm->nvm_sections[NVM_SECTION_TYPE_PHY_SKU].data) {
300                         IWL_ERR(mvm,
301                                 "Can't parse phy_sku in B0, empty sections\n");
302                         return NULL;
303                 }
304         }
305
306         if (WARN_ON(!mvm->cfg))
307                 return NULL;
308
309         /* read the mac address from WFMP registers */
310         mac_addr0 = iwl_trans_read_prph(mvm->trans, WFMP_MAC_ADDR_0);
311         mac_addr1 = iwl_trans_read_prph(mvm->trans, WFMP_MAC_ADDR_1);
312
313         hw = (const __le16 *)sections[mvm->cfg->nvm_hw_section_num].data;
314         sw = (const __le16 *)sections[NVM_SECTION_TYPE_SW].data;
315         calib = (const __le16 *)sections[NVM_SECTION_TYPE_CALIBRATION].data;
316         regulatory = (const __le16 *)sections[NVM_SECTION_TYPE_REGULATORY].data;
317         mac_override =
318                 (const __le16 *)sections[NVM_SECTION_TYPE_MAC_OVERRIDE].data;
319         phy_sku = (const __le16 *)sections[NVM_SECTION_TYPE_PHY_SKU].data;
320
321         lar_enabled = !iwlwifi_mod_params.lar_disable &&
322                       (mvm->fw->ucode_capa.capa[0] &
323                        IWL_UCODE_TLV_CAPA_LAR_SUPPORT);
324
325         return iwl_parse_nvm_data(mvm->trans->dev, mvm->cfg, hw, sw, calib,
326                                   regulatory, mac_override, phy_sku,
327                                   mvm->fw->valid_tx_ant, mvm->fw->valid_rx_ant,
328                                   lar_enabled, is_family_8000_a_step,
329                                   mac_addr0, mac_addr1);
330 }
331
332 #define MAX_NVM_FILE_LEN        16384
333
334 /*
335  * Reads external NVM from a file into mvm->nvm_sections
336  *
337  * HOW TO CREATE THE NVM FILE FORMAT:
338  * ------------------------------
339  * 1. create hex file, format:
340  *      3800 -> header
341  *      0000 -> header
342  *      5a40 -> data
343  *
344  *   rev - 6 bit (word1)
345  *   len - 10 bit (word1)
346  *   id - 4 bit (word2)
347  *   rsv - 12 bit (word2)
348  *
349  * 2. flip 8bits with 8 bits per line to get the right NVM file format
350  *
351  * 3. create binary file from the hex file
352  *
353  * 4. save as "iNVM_xxx.bin" under /lib/firmware
354  */
355 static int iwl_mvm_read_external_nvm(struct iwl_mvm *mvm)
356 {
357         int ret, section_size;
358         u16 section_id;
359         const struct firmware *fw_entry;
360         const struct {
361                 __le16 word1;
362                 __le16 word2;
363                 u8 data[];
364         } *file_sec;
365         const u8 *eof, *temp;
366         int max_section_size;
367         const __le32 *dword_buff;
368
369 #define NVM_WORD1_LEN(x) (8 * (x & 0x03FF))
370 #define NVM_WORD2_ID(x) (x >> 12)
371 #define NVM_WORD2_LEN_FAMILY_8000(x) (2 * ((x & 0xFF) << 8 | x >> 8))
372 #define NVM_WORD1_ID_FAMILY_8000(x) (x >> 4)
373 #define NVM_HEADER_0    (0x2A504C54)
374 #define NVM_HEADER_1    (0x4E564D2A)
375 #define NVM_HEADER_SIZE (4 * sizeof(u32))
376
377         IWL_DEBUG_EEPROM(mvm->trans->dev, "Read from external NVM\n");
378
379         /* Maximal size depends on HW family and step */
380         if (mvm->trans->cfg->device_family != IWL_DEVICE_FAMILY_8000)
381                 max_section_size = IWL_MAX_NVM_SECTION_SIZE;
382         else if (CSR_HW_REV_STEP(mvm->trans->hw_rev) == SILICON_A_STEP)
383                 max_section_size = IWL_MAX_NVM_8000A_SECTION_SIZE;
384         else /* Family 8000 B-step or C-step */
385                 max_section_size = IWL_MAX_NVM_8000B_SECTION_SIZE;
386
387         /*
388          * Obtain NVM image via request_firmware. Since we already used
389          * request_firmware_nowait() for the firmware binary load and only
390          * get here after that we assume the NVM request can be satisfied
391          * synchronously.
392          */
393         ret = request_firmware(&fw_entry, mvm->nvm_file_name,
394                                mvm->trans->dev);
395         if (ret) {
396                 IWL_ERR(mvm, "ERROR: %s isn't available %d\n",
397                         mvm->nvm_file_name, ret);
398                 return ret;
399         }
400
401         IWL_INFO(mvm, "Loaded NVM file %s (%zu bytes)\n",
402                  mvm->nvm_file_name, fw_entry->size);
403
404         if (fw_entry->size > MAX_NVM_FILE_LEN) {
405                 IWL_ERR(mvm, "NVM file too large\n");
406                 ret = -EINVAL;
407                 goto out;
408         }
409
410         eof = fw_entry->data + fw_entry->size;
411         dword_buff = (__le32 *)fw_entry->data;
412
413         /* some NVM file will contain a header.
414          * The header is identified by 2 dwords header as follow:
415          * dword[0] = 0x2A504C54
416          * dword[1] = 0x4E564D2A
417          *
418          * This header must be skipped when providing the NVM data to the FW.
419          */
420         if (fw_entry->size > NVM_HEADER_SIZE &&
421             dword_buff[0] == cpu_to_le32(NVM_HEADER_0) &&
422             dword_buff[1] == cpu_to_le32(NVM_HEADER_1)) {
423                 file_sec = (void *)(fw_entry->data + NVM_HEADER_SIZE);
424                 IWL_INFO(mvm, "NVM Version %08X\n", le32_to_cpu(dword_buff[2]));
425                 IWL_INFO(mvm, "NVM Manufacturing date %08X\n",
426                          le32_to_cpu(dword_buff[3]));
427         } else {
428                 file_sec = (void *)fw_entry->data;
429         }
430
431         while (true) {
432                 if (file_sec->data > eof) {
433                         IWL_ERR(mvm,
434                                 "ERROR - NVM file too short for section header\n");
435                         ret = -EINVAL;
436                         break;
437                 }
438
439                 /* check for EOF marker */
440                 if (!file_sec->word1 && !file_sec->word2) {
441                         ret = 0;
442                         break;
443                 }
444
445                 if (mvm->trans->cfg->device_family != IWL_DEVICE_FAMILY_8000) {
446                         section_size =
447                                 2 * NVM_WORD1_LEN(le16_to_cpu(file_sec->word1));
448                         section_id = NVM_WORD2_ID(le16_to_cpu(file_sec->word2));
449                 } else {
450                         section_size = 2 * NVM_WORD2_LEN_FAMILY_8000(
451                                                 le16_to_cpu(file_sec->word2));
452                         section_id = NVM_WORD1_ID_FAMILY_8000(
453                                                 le16_to_cpu(file_sec->word1));
454                 }
455
456                 if (section_size > max_section_size) {
457                         IWL_ERR(mvm, "ERROR - section too large (%d)\n",
458                                 section_size);
459                         ret = -EINVAL;
460                         break;
461                 }
462
463                 if (!section_size) {
464                         IWL_ERR(mvm, "ERROR - section empty\n");
465                         ret = -EINVAL;
466                         break;
467                 }
468
469                 if (file_sec->data + section_size > eof) {
470                         IWL_ERR(mvm,
471                                 "ERROR - NVM file too short for section (%d bytes)\n",
472                                 section_size);
473                         ret = -EINVAL;
474                         break;
475                 }
476
477                 if (WARN(section_id >= NVM_MAX_NUM_SECTIONS,
478                          "Invalid NVM section ID %d\n", section_id)) {
479                         ret = -EINVAL;
480                         break;
481                 }
482
483                 temp = kmemdup(file_sec->data, section_size, GFP_KERNEL);
484                 if (!temp) {
485                         ret = -ENOMEM;
486                         break;
487                 }
488                 mvm->nvm_sections[section_id].data = temp;
489                 mvm->nvm_sections[section_id].length = section_size;
490
491                 /* advance to the next section */
492                 file_sec = (void *)(file_sec->data + section_size);
493         }
494 out:
495         release_firmware(fw_entry);
496         return ret;
497 }
498
499 /* Loads the NVM data stored in mvm->nvm_sections into the NIC */
500 int iwl_mvm_load_nvm_to_nic(struct iwl_mvm *mvm)
501 {
502         int i, ret = 0;
503         struct iwl_nvm_section *sections = mvm->nvm_sections;
504
505         IWL_DEBUG_EEPROM(mvm->trans->dev, "'Write to NVM\n");
506
507         for (i = 0; i < ARRAY_SIZE(mvm->nvm_sections); i++) {
508                 if (!mvm->nvm_sections[i].data || !mvm->nvm_sections[i].length)
509                         continue;
510                 ret = iwl_nvm_write_section(mvm, i, sections[i].data,
511                                             sections[i].length);
512                 if (ret < 0) {
513                         IWL_ERR(mvm, "iwl_mvm_send_cmd failed: %d\n", ret);
514                         break;
515                 }
516         }
517         return ret;
518 }
519
520 int iwl_nvm_init(struct iwl_mvm *mvm, bool read_nvm_from_nic)
521 {
522         int ret, section;
523         u32 size_read = 0;
524         u8 *nvm_buffer, *temp;
525
526         if (WARN_ON_ONCE(mvm->cfg->nvm_hw_section_num >= NVM_MAX_NUM_SECTIONS))
527                 return -EINVAL;
528
529         /* load NVM values from nic */
530         if (read_nvm_from_nic) {
531                 /* Read From FW NVM */
532                 IWL_DEBUG_EEPROM(mvm->trans->dev, "Read from NVM\n");
533
534                 nvm_buffer = kmalloc(mvm->cfg->base_params->eeprom_size,
535                                      GFP_KERNEL);
536                 if (!nvm_buffer)
537                         return -ENOMEM;
538                 for (section = 0; section < NVM_MAX_NUM_SECTIONS; section++) {
539                         /* we override the constness for initial read */
540                         ret = iwl_nvm_read_section(mvm, section, nvm_buffer,
541                                                    size_read);
542                         if (ret < 0)
543                                 continue;
544                         size_read += ret;
545                         temp = kmemdup(nvm_buffer, ret, GFP_KERNEL);
546                         if (!temp) {
547                                 ret = -ENOMEM;
548                                 break;
549                         }
550                         mvm->nvm_sections[section].data = temp;
551                         mvm->nvm_sections[section].length = ret;
552
553 #ifdef CONFIG_IWLWIFI_DEBUGFS
554                         switch (section) {
555                         case NVM_SECTION_TYPE_SW:
556                                 mvm->nvm_sw_blob.data = temp;
557                                 mvm->nvm_sw_blob.size  = ret;
558                                 break;
559                         case NVM_SECTION_TYPE_CALIBRATION:
560                                 mvm->nvm_calib_blob.data = temp;
561                                 mvm->nvm_calib_blob.size  = ret;
562                                 break;
563                         case NVM_SECTION_TYPE_PRODUCTION:
564                                 mvm->nvm_prod_blob.data = temp;
565                                 mvm->nvm_prod_blob.size  = ret;
566                                 break;
567                         default:
568                                 if (section == mvm->cfg->nvm_hw_section_num) {
569                                         mvm->nvm_hw_blob.data = temp;
570                                         mvm->nvm_hw_blob.size = ret;
571                                         break;
572                                 }
573                         }
574 #endif
575                 }
576                 if (!size_read)
577                         IWL_ERR(mvm, "OTP is blank\n");
578                 kfree(nvm_buffer);
579         }
580
581         /* load external NVM if configured */
582         if (mvm->nvm_file_name) {
583                 /* move to External NVM flow */
584                 ret = iwl_mvm_read_external_nvm(mvm);
585                 if (ret)
586                         return ret;
587         }
588
589         /* parse the relevant nvm sections */
590         mvm->nvm_data = iwl_parse_nvm_sections(mvm);
591         if (!mvm->nvm_data)
592                 return -ENODATA;
593         IWL_DEBUG_EEPROM(mvm->trans->dev, "nvm version = %x\n",
594                          mvm->nvm_data->nvm_version);
595
596         return 0;
597 }
598
599 struct iwl_mcc_update_resp *
600 iwl_mvm_update_mcc(struct iwl_mvm *mvm, const char *alpha2,
601                    enum iwl_mcc_source src_id)
602 {
603         struct iwl_mcc_update_cmd mcc_update_cmd = {
604                 .mcc = cpu_to_le16(alpha2[0] << 8 | alpha2[1]),
605                 .source_id = (u8)src_id,
606         };
607         struct iwl_mcc_update_resp *mcc_resp, *resp_cp = NULL;
608         struct iwl_rx_packet *pkt;
609         struct iwl_host_cmd cmd = {
610                 .id = MCC_UPDATE_CMD,
611                 .flags = CMD_WANT_SKB,
612                 .data = { &mcc_update_cmd },
613         };
614
615         int ret;
616         u32 status;
617         int resp_len, n_channels;
618         u16 mcc;
619
620         if (WARN_ON_ONCE(!iwl_mvm_is_lar_supported(mvm)))
621                 return ERR_PTR(-EOPNOTSUPP);
622
623         cmd.len[0] = sizeof(struct iwl_mcc_update_cmd);
624
625         IWL_DEBUG_LAR(mvm, "send MCC update to FW with '%c%c' src = %d\n",
626                       alpha2[0], alpha2[1], src_id);
627
628         ret = iwl_mvm_send_cmd(mvm, &cmd);
629         if (ret)
630                 return ERR_PTR(ret);
631
632         pkt = cmd.resp_pkt;
633         if (pkt->hdr.flags & IWL_CMD_FAILED_MSK) {
634                 IWL_ERR(mvm, "Bad return from MCC_UPDATE_COMMAND (0x%08X)\n",
635                         pkt->hdr.flags);
636                 ret = -EIO;
637                 goto exit;
638         }
639
640         /* Extract MCC response */
641         mcc_resp = (void *)pkt->data;
642         status = le32_to_cpu(mcc_resp->status);
643
644         mcc = le16_to_cpu(mcc_resp->mcc);
645
646         /* W/A for a FW/NVM issue - returns 0x00 for the world domain */
647         if (mcc == 0) {
648                 mcc = 0x3030;  /* "00" - world */
649                 mcc_resp->mcc = cpu_to_le16(mcc);
650         }
651
652         n_channels =  __le32_to_cpu(mcc_resp->n_channels);
653         IWL_DEBUG_LAR(mvm,
654                       "MCC response status: 0x%x. new MCC: 0x%x ('%c%c') change: %d n_chans: %d\n",
655                       status, mcc, mcc >> 8, mcc & 0xff,
656                       !!(status == MCC_RESP_SAME_CHAN_PROFILE), n_channels);
657
658         resp_len = sizeof(*mcc_resp) + n_channels * sizeof(__le32);
659         resp_cp = kmemdup(mcc_resp, resp_len, GFP_KERNEL);
660         if (!resp_cp) {
661                 ret = -ENOMEM;
662                 goto exit;
663         }
664
665         ret = 0;
666 exit:
667         iwl_free_resp(&cmd);
668         if (ret)
669                 return ERR_PTR(ret);
670         return resp_cp;
671 }
672
673 int iwl_mvm_init_mcc(struct iwl_mvm *mvm)
674 {
675         bool tlv_lar;
676         bool nvm_lar;
677         int retval;
678         struct ieee80211_regdomain *regd;
679
680         if (mvm->cfg->device_family == IWL_DEVICE_FAMILY_8000) {
681                 tlv_lar = mvm->fw->ucode_capa.capa[0] &
682                         IWL_UCODE_TLV_CAPA_LAR_SUPPORT;
683                 nvm_lar = mvm->nvm_data->lar_enabled;
684                 if (tlv_lar != nvm_lar)
685                         IWL_INFO(mvm,
686                                  "Conflict between TLV & NVM regarding enabling LAR (TLV = %s NVM =%s)\n",
687                                  tlv_lar ? "enabled" : "disabled",
688                                  nvm_lar ? "enabled" : "disabled");
689         }
690
691         if (!iwl_mvm_is_lar_supported(mvm))
692                 return 0;
693
694         /*
695          * During HW restart, only replay the last set MCC to FW. Otherwise,
696          * queue an update to cfg80211 to retrieve the default alpha2 from FW.
697          */
698         if (test_bit(IWL_MVM_STATUS_IN_HW_RESTART, &mvm->status)) {
699                 /* This should only be called during vif up and hold RTNL */
700                 return iwl_mvm_init_fw_regd(mvm);
701         }
702
703         /*
704          * Driver regulatory hint for initial update, this also informs the
705          * firmware we support wifi location updates.
706          * Disallow scans that might crash the FW while the LAR regdomain
707          * is not set.
708          */
709         mvm->lar_regdom_set = false;
710
711         regd = iwl_mvm_get_current_regdomain(mvm);
712         if (IS_ERR_OR_NULL(regd))
713                 return -EIO;
714
715         retval = regulatory_set_wiphy_regd_sync_rtnl(mvm->hw->wiphy, regd);
716         kfree(regd);
717         return retval;
718 }
719
720 int iwl_mvm_rx_chub_update_mcc(struct iwl_mvm *mvm,
721                                struct iwl_rx_cmd_buffer *rxb,
722                                struct iwl_device_cmd *cmd)
723 {
724         struct iwl_rx_packet *pkt = rxb_addr(rxb);
725         struct iwl_mcc_chub_notif *notif = (void *)pkt->data;
726         enum iwl_mcc_source src;
727         char mcc[3];
728         struct ieee80211_regdomain *regd;
729
730         lockdep_assert_held(&mvm->mutex);
731
732         if (WARN_ON_ONCE(!iwl_mvm_is_lar_supported(mvm)))
733                 return 0;
734
735         mcc[0] = notif->mcc >> 8;
736         mcc[1] = notif->mcc & 0xff;
737         mcc[2] = '\0';
738         src = notif->source_id;
739
740         IWL_DEBUG_LAR(mvm,
741                       "RX: received chub update mcc cmd (mcc '%s' src %d)\n",
742                       mcc, src);
743         regd = iwl_mvm_get_regdomain(mvm->hw->wiphy, mcc, src);
744         if (IS_ERR_OR_NULL(regd))
745                 return 0;
746
747         regulatory_set_wiphy_regd(mvm->hw->wiphy, regd);
748         kfree(regd);
749
750         return 0;
751 }