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