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  *
  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 <linuxwifi@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 - 2015 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 <linux/pci.h>
  68 #include <linux/acpi.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_NVM_8000_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         if (!pkt) {
 122                 IWL_ERR(mvm, "Error in NVM_ACCESS response\n");
 123                 return -EINVAL;
 124         }
 125         /* Extract & check NVM write response */
 126         nvm_resp = (void *)pkt->data;
 127         if (le16_to_cpu(nvm_resp->status) != READ_NVM_CHUNK_SUCCEED) {
 128                 IWL_ERR(mvm,
 129                         "NVM access write command failed for section %u (status = 0x%x)\n",
 130                         section, le16_to_cpu(nvm_resp->status));
 131                 ret = -EIO;
 132         }
 133
 134         iwl_free_resp(&cmd);
 135         return ret;
 136 }
 137
 138 static int iwl_nvm_read_chunk(struct iwl_mvm *mvm, u16 section,
 139                               u16 offset, u16 length, u8 *data)
 140 {
 141         struct iwl_nvm_access_cmd nvm_access_cmd = {
 142                 .offset = cpu_to_le16(offset),
 143                 .length = cpu_to_le16(length),
 144                 .type = cpu_to_le16(section),
 145                 .op_code = NVM_READ_OPCODE,
 146         };
 147         struct iwl_nvm_access_resp *nvm_resp;
 148         struct iwl_rx_packet *pkt;
 149         struct iwl_host_cmd cmd = {
 150                 .id = NVM_ACCESS_CMD,
 151                 .flags = CMD_WANT_SKB | CMD_SEND_IN_RFKILL,
 152                 .data = { &nvm_access_cmd, },
 153         };
 154         int ret, bytes_read, offset_read;
 155         u8 *resp_data;
 156
 157         cmd.len[0] = sizeof(struct iwl_nvm_access_cmd);
 158
 159         ret = iwl_mvm_send_cmd(mvm, &cmd);
 160         if (ret)
 161                 return ret;
 162
 163         pkt = cmd.resp_pkt;
 164
 165         /* Extract NVM response */
 166         nvm_resp = (void *)pkt->data;
 167         ret = le16_to_cpu(nvm_resp->status);
 168         bytes_read = le16_to_cpu(nvm_resp->length);
 169         offset_read = le16_to_cpu(nvm_resp->offset);
 170         resp_data = nvm_resp->data;
 171         if (ret) {
 172                 if ((offset != 0) &&
 173                     (ret == READ_NVM_CHUNK_NOT_VALID_ADDRESS)) {
 174                         /*
 175                          * meaning of NOT_VALID_ADDRESS:
 176                          * driver try to read chunk from address that is
 177                          * multiple of 2K and got an error since addr is empty.
 178                          * meaning of (offset != 0): driver already
 179                          * read valid data from another chunk so this case
 180                          * is not an error.
 181                          */
 182                         IWL_DEBUG_EEPROM(mvm->trans->dev,
 183                                          "NVM access command failed on offset 0x%x since that section size is multiple 2K\n",
 184                                          offset);
 185                         ret = 0;
 186                 } else {
 187                         IWL_DEBUG_EEPROM(mvm->trans->dev,
 188                                          "NVM access command failed with status %d (device: %s)\n",
 189                                          ret, mvm->cfg->name);
 190                         ret = -EIO;
 191                 }
 192                 goto exit;
 193         }
 194
 195         if (offset_read != offset) {
 196                 IWL_ERR(mvm, "NVM ACCESS response with invalid offset %d\n",
 197                         offset_read);
 198                 ret = -EINVAL;
 199                 goto exit;
 200         }
 201
 202         /* Write data to NVM */
 203         memcpy(data + offset, resp_data, bytes_read);
 204         ret = bytes_read;
 205
 206 exit:
 207         iwl_free_resp(&cmd);
 208         return ret;
 209 }
 210
 211 static int iwl_nvm_write_section(struct iwl_mvm *mvm, u16 section,
 212                                  const u8 *data, u16 length)
 213 {
 214         int offset = 0;
 215
 216         /* copy data in chunks of 2k (and remainder if any) */
 217
 218         while (offset < length) {
 219                 int chunk_size, ret;
 220
 221                 chunk_size = min(IWL_NVM_DEFAULT_CHUNK_SIZE,
 222                                  length - offset);
 223
 224                 ret = iwl_nvm_write_chunk(mvm, section, offset,
 225                                           chunk_size, data + offset);
 226                 if (ret < 0)
 227                         return ret;
 228
 229                 offset += chunk_size;
 230         }
 231
 232         return 0;
 233 }
 234
 235 static void iwl_mvm_nvm_fixups(struct iwl_mvm *mvm, unsigned int section,
 236                                u8 *data, unsigned int len)
 237 {
 238 #define IWL_4165_DEVICE_ID      0x5501
 239 #define NVM_SKU_CAP_MIMO_DISABLE BIT(5)
 240
 241         if (section == NVM_SECTION_TYPE_PHY_SKU &&
 242             mvm->trans->hw_id == IWL_4165_DEVICE_ID && data && len >= 5 &&
 243             (data[4] & NVM_SKU_CAP_MIMO_DISABLE))
 244                 /* OTP 0x52 bug work around: it's a 1x1 device */
 245                 data[3] = ANT_B | (ANT_B << 4);
 246 }
 247
 248 /*
 249  * Reads an NVM section completely.
 250  * NICs prior to 7000 family doesn't have a real NVM, but just read
 251  * section 0 which is the EEPROM. Because the EEPROM reading is unlimited
 252  * by uCode, we need to manually check in this case that we don't
 253  * overflow and try to read more than the EEPROM size.
 254  * For 7000 family NICs, we supply the maximal size we can read, and
 255  * the uCode fills the response with as much data as we can,
 256  * without overflowing, so no check is needed.
 257  */
 258 static int iwl_nvm_read_section(struct iwl_mvm *mvm, u16 section,
 259                                 u8 *data, u32 size_read)
 260 {
 261         u16 length, offset = 0;
 262         int ret;
 263
 264         /* Set nvm section read length */
 265         length = IWL_NVM_DEFAULT_CHUNK_SIZE;
 266
 267         ret = length;
 268
 269         /* Read the NVM until exhausted (reading less than requested) */
 270         while (ret == length) {
 271                 /* Check no memory assumptions fail and cause an overflow */
 272                 if ((size_read + offset + length) >
 273                     mvm->cfg->base_params->eeprom_size) {
 274                         IWL_ERR(mvm, "EEPROM size is too small for NVM\n");
 275                         return -ENOBUFS;
 276                 }
 277
 278                 ret = iwl_nvm_read_chunk(mvm, section, offset, length, data);
 279                 if (ret < 0) {
 280                         IWL_DEBUG_EEPROM(mvm->trans->dev,
 281                                          "Cannot read NVM from section %d offset %d, length %d\n",
 282                                          section, offset, length);
 283                         return ret;
 284                 }
 285                 offset += ret;
 286         }
 287
 288         iwl_mvm_nvm_fixups(mvm, section, data, offset);
 289
 290         IWL_DEBUG_EEPROM(mvm->trans->dev,
 291                          "NVM section %d read completed\n", section);
 292         return offset;
 293 }
 294
 295 static struct iwl_nvm_data *
 296 iwl_parse_nvm_sections(struct iwl_mvm *mvm)
 297 {
 298         struct iwl_nvm_section *sections = mvm->nvm_sections;
 299         const __le16 *hw, *sw, *calib, *regulatory, *mac_override, *phy_sku;
 300         bool lar_enabled;
 301         u32 mac_addr0, mac_addr1;
 302
 303         /* Checking for required sections */
 304         if (mvm->trans->cfg->device_family != IWL_DEVICE_FAMILY_8000) {
 305                 if (!mvm->nvm_sections[NVM_SECTION_TYPE_SW].data ||
 306                     !mvm->nvm_sections[mvm->cfg->nvm_hw_section_num].data) {
 307                         IWL_ERR(mvm, "Can't parse empty OTP/NVM sections\n");
 308                         return NULL;
 309                 }
 310         } else {
 311                 /* SW and REGULATORY sections are mandatory */
 312                 if (!mvm->nvm_sections[NVM_SECTION_TYPE_SW].data ||
 313                     !mvm->nvm_sections[NVM_SECTION_TYPE_REGULATORY].data) {
 314                         IWL_ERR(mvm,
 315                                 "Can't parse empty family 8000 OTP/NVM sections\n");
 316                         return NULL;
 317                 }
 318                 /* MAC_OVERRIDE or at least HW section must exist */
 319                 if (!mvm->nvm_sections[mvm->cfg->nvm_hw_section_num].data &&
 320                     !mvm->nvm_sections[NVM_SECTION_TYPE_MAC_OVERRIDE].data) {
 321                         IWL_ERR(mvm,
 322                                 "Can't parse mac_address, empty sections\n");
 323                         return NULL;
 324                 }
 325
 326                 /* PHY_SKU section is mandatory in B0 */
 327                 if (!mvm->nvm_sections[NVM_SECTION_TYPE_PHY_SKU].data) {
 328                         IWL_ERR(mvm,
 329                                 "Can't parse phy_sku in B0, empty sections\n");
 330                         return NULL;
 331                 }
 332         }
 333
 334         if (WARN_ON(!mvm->cfg))
 335                 return NULL;
 336
 337         /* read the mac address from WFMP registers */
 338         mac_addr0 = iwl_trans_read_prph(mvm->trans, WFMP_MAC_ADDR_0);
 339         mac_addr1 = iwl_trans_read_prph(mvm->trans, WFMP_MAC_ADDR_1);
 340
 341         hw = (const __le16 *)sections[mvm->cfg->nvm_hw_section_num].data;
 342         sw = (const __le16 *)sections[NVM_SECTION_TYPE_SW].data;
 343         calib = (const __le16 *)sections[NVM_SECTION_TYPE_CALIBRATION].data;
 344         regulatory = (const __le16 *)sections[NVM_SECTION_TYPE_REGULATORY].data;
 345         mac_override =
 346                 (const __le16 *)sections[NVM_SECTION_TYPE_MAC_OVERRIDE].data;
 347         phy_sku = (const __le16 *)sections[NVM_SECTION_TYPE_PHY_SKU].data;
 348
 349         lar_enabled = !iwlwifi_mod_params.lar_disable &&
 350                       fw_has_capa(&mvm->fw->ucode_capa,
 351                                   IWL_UCODE_TLV_CAPA_LAR_SUPPORT);
 352
 353         return iwl_parse_nvm_data(mvm->trans->dev, mvm->cfg, hw, sw, calib,
 354                                   regulatory, mac_override, phy_sku,
 355                                   mvm->fw->valid_tx_ant, mvm->fw->valid_rx_ant,
 356                                   lar_enabled, mac_addr0, mac_addr1);
 357 }
 358
 359 #define MAX_NVM_FILE_LEN        16384
 360
 361 /*
 362  * Reads external NVM from a file into mvm->nvm_sections
 363  *
 364  * HOW TO CREATE THE NVM FILE FORMAT:
 365  * ------------------------------
 366  * 1. create hex file, format:
 367  *      3800 -> header
 368  *      0000 -> header
 369  *      5a40 -> data
 370  *
 371  *   rev - 6 bit (word1)
 372  *   len - 10 bit (word1)
 373  *   id - 4 bit (word2)
 374  *   rsv - 12 bit (word2)
 375  *
 376  * 2. flip 8bits with 8 bits per line to get the right NVM file format
 377  *
 378  * 3. create binary file from the hex file
 379  *
 380  * 4. save as "iNVM_xxx.bin" under /lib/firmware
 381  */
 382 static int iwl_mvm_read_external_nvm(struct iwl_mvm *mvm)
 383 {
 384         int ret, section_size;
 385         u16 section_id;
 386         const struct firmware *fw_entry;
 387         const struct {
 388                 __le16 word1;
 389                 __le16 word2;
 390                 u8 data[];
 391         } *file_sec;
 392         const u8 *eof;
 393         u8 *temp;
 394         int max_section_size;
 395         const __le32 *dword_buff;
 396
 397 #define NVM_WORD1_LEN(x) (8 * (x & 0x03FF))
 398 #define NVM_WORD2_ID(x) (x >> 12)
 399 #define NVM_WORD2_LEN_FAMILY_8000(x) (2 * ((x & 0xFF) << 8 | x >> 8))
 400 #define NVM_WORD1_ID_FAMILY_8000(x) (x >> 4)
 401 #define NVM_HEADER_0    (0x2A504C54)
 402 #define NVM_HEADER_1    (0x4E564D2A)
 403 #define NVM_HEADER_SIZE (4 * sizeof(u32))
 404
 405         IWL_DEBUG_EEPROM(mvm->trans->dev, "Read from external NVM\n");
 406
 407         /* Maximal size depends on HW family and step */
 408         if (mvm->trans->cfg->device_family != IWL_DEVICE_FAMILY_8000)
 409                 max_section_size = IWL_MAX_NVM_SECTION_SIZE;
 410         else
 411                 max_section_size = IWL_MAX_NVM_8000_SECTION_SIZE;
 412
 413         /*
 414          * Obtain NVM image via request_firmware. Since we already used
 415          * request_firmware_nowait() for the firmware binary load and only
 416          * get here after that we assume the NVM request can be satisfied
 417          * synchronously.
 418          */
 419         ret = request_firmware(&fw_entry, mvm->nvm_file_name,
 420                                mvm->trans->dev);
 421         if (ret) {
 422                 IWL_ERR(mvm, "ERROR: %s isn't available %d\n",
 423                         mvm->nvm_file_name, ret);
 424                 return ret;
 425         }
 426
 427         IWL_INFO(mvm, "Loaded NVM file %s (%zu bytes)\n",
 428                  mvm->nvm_file_name, fw_entry->size);
 429
 430         if (fw_entry->size > MAX_NVM_FILE_LEN) {
 431                 IWL_ERR(mvm, "NVM file too large\n");
 432                 ret = -EINVAL;
 433                 goto out;
 434         }
 435
 436         eof = fw_entry->data + fw_entry->size;
 437         dword_buff = (__le32 *)fw_entry->data;
 438
 439         /* some NVM file will contain a header.
 440          * The header is identified by 2 dwords header as follow:
 441          * dword[0] = 0x2A504C54
 442          * dword[1] = 0x4E564D2A
 443          *
 444          * This header must be skipped when providing the NVM data to the FW.
 445          */
 446         if (fw_entry->size > NVM_HEADER_SIZE &&
 447             dword_buff[0] == cpu_to_le32(NVM_HEADER_0) &&
 448             dword_buff[1] == cpu_to_le32(NVM_HEADER_1)) {
 449                 file_sec = (void *)(fw_entry->data + NVM_HEADER_SIZE);
 450                 IWL_INFO(mvm, "NVM Version %08X\n", le32_to_cpu(dword_buff[2]));
 451                 IWL_INFO(mvm, "NVM Manufacturing date %08X\n",
 452                          le32_to_cpu(dword_buff[3]));
 453
 454                 /* nvm file validation, dword_buff[2] holds the file version */
 455                 if ((CSR_HW_REV_STEP(mvm->trans->hw_rev) == SILICON_C_STEP &&
 456                      le32_to_cpu(dword_buff[2]) < 0xE4A) ||
 457                     (CSR_HW_REV_STEP(mvm->trans->hw_rev) == SILICON_B_STEP &&
 458                      le32_to_cpu(dword_buff[2]) >= 0xE4A)) {
 459                         ret = -EFAULT;
 460                         goto out;
 461                 }
 462         } else {
 463                 file_sec = (void *)fw_entry->data;
 464         }
 465
 466         while (true) {
 467                 if (file_sec->data > eof) {
 468                         IWL_ERR(mvm,
 469                                 "ERROR - NVM file too short for section header\n");
 470                         ret = -EINVAL;
 471                         break;
 472                 }
 473
 474                 /* check for EOF marker */
 475                 if (!file_sec->word1 && !file_sec->word2) {
 476                         ret = 0;
 477                         break;
 478                 }
 479
 480                 if (mvm->trans->cfg->device_family != IWL_DEVICE_FAMILY_8000) {
 481                         section_size =
 482                                 2 * NVM_WORD1_LEN(le16_to_cpu(file_sec->word1));
 483                         section_id = NVM_WORD2_ID(le16_to_cpu(file_sec->word2));
 484                 } else {
 485                         section_size = 2 * NVM_WORD2_LEN_FAMILY_8000(
 486                                                 le16_to_cpu(file_sec->word2));
 487                         section_id = NVM_WORD1_ID_FAMILY_8000(
 488                                                 le16_to_cpu(file_sec->word1));
 489                 }
 490
 491                 if (section_size > max_section_size) {
 492                         IWL_ERR(mvm, "ERROR - section too large (%d)\n",
 493                                 section_size);
 494                         ret = -EINVAL;
 495                         break;
 496                 }
 497
 498                 if (!section_size) {
 499                         IWL_ERR(mvm, "ERROR - section empty\n");
 500                         ret = -EINVAL;
 501                         break;
 502                 }
 503
 504                 if (file_sec->data + section_size > eof) {
 505                         IWL_ERR(mvm,
 506                                 "ERROR - NVM file too short for section (%d bytes)\n",
 507                                 section_size);
 508                         ret = -EINVAL;
 509                         break;
 510                 }
 511
 512                 if (WARN(section_id >= NVM_MAX_NUM_SECTIONS,
 513                          "Invalid NVM section ID %d\n", section_id)) {
 514                         ret = -EINVAL;
 515                         break;
 516                 }
 517
 518                 temp = kmemdup(file_sec->data, section_size, GFP_KERNEL);
 519                 if (!temp) {
 520                         ret = -ENOMEM;
 521                         break;
 522                 }
 523
 524                 iwl_mvm_nvm_fixups(mvm, section_id, temp, section_size);
 525
 526                 kfree(mvm->nvm_sections[section_id].data);
 527                 mvm->nvm_sections[section_id].data = temp;
 528                 mvm->nvm_sections[section_id].length = section_size;
 529
 530                 /* advance to the next section */
 531                 file_sec = (void *)(file_sec->data + section_size);
 532         }
 533 out:
 534         release_firmware(fw_entry);
 535         return ret;
 536 }
 537
 538 /* Loads the NVM data stored in mvm->nvm_sections into the NIC */
 539 int iwl_mvm_load_nvm_to_nic(struct iwl_mvm *mvm)
 540 {
 541         int i, ret = 0;
 542         struct iwl_nvm_section *sections = mvm->nvm_sections;
 543
 544         IWL_DEBUG_EEPROM(mvm->trans->dev, "'Write to NVM\n");
 545
 546         for (i = 0; i < ARRAY_SIZE(mvm->nvm_sections); i++) {
 547                 if (!mvm->nvm_sections[i].data || !mvm->nvm_sections[i].length)
 548                         continue;
 549                 ret = iwl_nvm_write_section(mvm, i, sections[i].data,
 550                                             sections[i].length);
 551                 if (ret < 0) {
 552                         IWL_ERR(mvm, "iwl_mvm_send_cmd failed: %d\n", ret);
 553                         break;
 554                 }
 555         }
 556         return ret;
 557 }
 558
 559 int iwl_nvm_init(struct iwl_mvm *mvm, bool read_nvm_from_nic)
 560 {
 561         int ret, section;
 562         u32 size_read = 0;
 563         u8 *nvm_buffer, *temp;
 564         const char *nvm_file_B = mvm->cfg->default_nvm_file_B_step;
 565         const char *nvm_file_C = mvm->cfg->default_nvm_file_C_step;
 566
 567         if (WARN_ON_ONCE(mvm->cfg->nvm_hw_section_num >= NVM_MAX_NUM_SECTIONS))
 568                 return -EINVAL;
 569
 570         /* load NVM values from nic */
 571         if (read_nvm_from_nic) {
 572                 /* Read From FW NVM */
 573                 IWL_DEBUG_EEPROM(mvm->trans->dev, "Read from NVM\n");
 574
 575                 nvm_buffer = kmalloc(mvm->cfg->base_params->eeprom_size,
 576                                      GFP_KERNEL);
 577                 if (!nvm_buffer)
 578                         return -ENOMEM;
 579                 for (section = 0; section < NVM_MAX_NUM_SECTIONS; section++) {
 580                         /* we override the constness for initial read */
 581                         ret = iwl_nvm_read_section(mvm, section, nvm_buffer,
 582                                                    size_read);
 583                         if (ret < 0)
 584                                 continue;
 585                         size_read += ret;
 586                         temp = kmemdup(nvm_buffer, ret, GFP_KERNEL);
 587                         if (!temp) {
 588                                 ret = -ENOMEM;
 589                                 break;
 590                         }
 591
 592                         iwl_mvm_nvm_fixups(mvm, section, temp, ret);
 593
 594                         mvm->nvm_sections[section].data = temp;
 595                         mvm->nvm_sections[section].length = ret;
 596
 597 #ifdef CONFIG_IWLWIFI_DEBUGFS
 598                         switch (section) {
 599                         case NVM_SECTION_TYPE_SW:
 600                                 mvm->nvm_sw_blob.data = temp;
 601                                 mvm->nvm_sw_blob.size  = ret;
 602                                 break;
 603                         case NVM_SECTION_TYPE_CALIBRATION:
 604                                 mvm->nvm_calib_blob.data = temp;
 605                                 mvm->nvm_calib_blob.size  = ret;
 606                                 break;
 607                         case NVM_SECTION_TYPE_PRODUCTION:
 608                                 mvm->nvm_prod_blob.data = temp;
 609                                 mvm->nvm_prod_blob.size  = ret;
 610                                 break;
 611                         case NVM_SECTION_TYPE_PHY_SKU:
 612                                 mvm->nvm_phy_sku_blob.data = temp;
 613                                 mvm->nvm_phy_sku_blob.size  = ret;
 614                                 break;
 615                         default:
 616                                 if (section == mvm->cfg->nvm_hw_section_num) {
 617                                         mvm->nvm_hw_blob.data = temp;
 618                                         mvm->nvm_hw_blob.size = ret;
 619                                         break;
 620                                 }
 621                         }
 622 #endif
 623                 }
 624                 if (!size_read)
 625                         IWL_ERR(mvm, "OTP is blank\n");
 626                 kfree(nvm_buffer);
 627         }
 628
 629         /* Only if PNVM selected in the mod param - load external NVM  */
 630         if (mvm->nvm_file_name) {
 631                 /* read External NVM file from the mod param */
 632                 ret = iwl_mvm_read_external_nvm(mvm);
 633                 if (ret) {
 634                         /* choose the nvm_file name according to the
 635                          * HW step
 636                          */
 637                         if (CSR_HW_REV_STEP(mvm->trans->hw_rev) ==
 638                             SILICON_B_STEP)
 639                                 mvm->nvm_file_name = nvm_file_B;
 640                         else
 641                                 mvm->nvm_file_name = nvm_file_C;
 642
 643                         if (ret == -EFAULT && mvm->nvm_file_name) {
 644                                 /* in case nvm file was failed try again */
 645                                 ret = iwl_mvm_read_external_nvm(mvm);
 646                                 if (ret)
 647                                         return ret;
 648                         } else {
 649                                 return ret;
 650                         }
 651                 }
 652         }
 653
 654         /* parse the relevant nvm sections */
 655         mvm->nvm_data = iwl_parse_nvm_sections(mvm);
 656         if (!mvm->nvm_data)
 657                 return -ENODATA;
 658         IWL_DEBUG_EEPROM(mvm->trans->dev, "nvm version = %x\n",
 659                          mvm->nvm_data->nvm_version);
 660
 661         return 0;
 662 }
 663
 664 struct iwl_mcc_update_resp *
 665 iwl_mvm_update_mcc(struct iwl_mvm *mvm, const char *alpha2,
 666                    enum iwl_mcc_source src_id)
 667 {
 668         struct iwl_mcc_update_cmd mcc_update_cmd = {
 669                 .mcc = cpu_to_le16(alpha2[0] << 8 | alpha2[1]),
 670                 .source_id = (u8)src_id,
 671         };
 672         struct iwl_mcc_update_resp *mcc_resp, *resp_cp = NULL;
 673         struct iwl_rx_packet *pkt;
 674         struct iwl_host_cmd cmd = {
 675                 .id = MCC_UPDATE_CMD,
 676                 .flags = CMD_WANT_SKB,
 677                 .data = { &mcc_update_cmd },
 678         };
 679
 680         int ret;
 681         u32 status;
 682         int resp_len, n_channels;
 683         u16 mcc;
 684
 685         if (WARN_ON_ONCE(!iwl_mvm_is_lar_supported(mvm)))
 686                 return ERR_PTR(-EOPNOTSUPP);
 687
 688         cmd.len[0] = sizeof(struct iwl_mcc_update_cmd);
 689
 690         IWL_DEBUG_LAR(mvm, "send MCC update to FW with '%c%c' src = %d\n",
 691                       alpha2[0], alpha2[1], src_id);
 692
 693         ret = iwl_mvm_send_cmd(mvm, &cmd);
 694         if (ret)
 695                 return ERR_PTR(ret);
 696
 697         pkt = cmd.resp_pkt;
 698
 699         /* Extract MCC response */
 700         mcc_resp = (void *)pkt->data;
 701         status = le32_to_cpu(mcc_resp->status);
 702
 703         mcc = le16_to_cpu(mcc_resp->mcc);
 704
 705         /* W/A for a FW/NVM issue - returns 0x00 for the world domain */
 706         if (mcc == 0) {
 707                 mcc = 0x3030;  /* "00" - world */
 708                 mcc_resp->mcc = cpu_to_le16(mcc);
 709         }
 710
 711         n_channels =  __le32_to_cpu(mcc_resp->n_channels);
 712         IWL_DEBUG_LAR(mvm,
 713                       "MCC response status: 0x%x. new MCC: 0x%x ('%c%c') change: %d n_chans: %d\n",
 714                       status, mcc, mcc >> 8, mcc & 0xff,
 715                       !!(status == MCC_RESP_NEW_CHAN_PROFILE), n_channels);
 716
 717         resp_len = sizeof(*mcc_resp) + n_channels * sizeof(__le32);
 718         resp_cp = kmemdup(mcc_resp, resp_len, GFP_KERNEL);
 719         if (!resp_cp) {
 720                 ret = -ENOMEM;
 721                 goto exit;
 722         }
 723
 724         ret = 0;
 725 exit:
 726         iwl_free_resp(&cmd);
 727         if (ret)
 728                 return ERR_PTR(ret);
 729         return resp_cp;
 730 }
 731
 732 #ifdef CONFIG_ACPI
 733 #define WRD_METHOD              "WRDD"
 734 #define WRDD_WIFI               (0x07)
 735 #define WRDD_WIGIG              (0x10)
 736
 737 static u32 iwl_mvm_wrdd_get_mcc(struct iwl_mvm *mvm, union acpi_object *wrdd)
 738 {
 739         union acpi_object *mcc_pkg, *domain_type, *mcc_value;
 740         u32 i;
 741
 742         if (wrdd->type != ACPI_TYPE_PACKAGE ||
 743             wrdd->package.count < 2 ||
 744             wrdd->package.elements[0].type != ACPI_TYPE_INTEGER ||
 745             wrdd->package.elements[0].integer.value != 0) {
 746                 IWL_DEBUG_LAR(mvm, "Unsupported wrdd structure\n");
 747                 return 0;
 748         }
 749
 750         for (i = 1 ; i < wrdd->package.count ; ++i) {
 751                 mcc_pkg = &wrdd->package.elements[i];
 752
 753                 if (mcc_pkg->type != ACPI_TYPE_PACKAGE ||
 754                     mcc_pkg->package.count < 2 ||
 755                     mcc_pkg->package.elements[0].type != ACPI_TYPE_INTEGER ||
 756                     mcc_pkg->package.elements[1].type != ACPI_TYPE_INTEGER) {
 757                         mcc_pkg = NULL;
 758                         continue;
 759                 }
 760
 761                 domain_type = &mcc_pkg->package.elements[0];
 762                 if (domain_type->integer.value == WRDD_WIFI)
 763                         break;
 764
 765                 mcc_pkg = NULL;
 766         }
 767
 768         if (mcc_pkg) {
 769                 mcc_value = &mcc_pkg->package.elements[1];
 770                 return mcc_value->integer.value;
 771         }
 772
 773         return 0;
 774 }
 775
 776 static int iwl_mvm_get_bios_mcc(struct iwl_mvm *mvm, char *mcc)
 777 {
 778         acpi_handle root_handle;
 779         acpi_handle handle;
 780         struct acpi_buffer wrdd = {ACPI_ALLOCATE_BUFFER, NULL};
 781         acpi_status status;
 782         u32 mcc_val;
 783         struct pci_dev *pdev = to_pci_dev(mvm->dev);
 784
 785         root_handle = ACPI_HANDLE(&pdev->dev);
 786         if (!root_handle) {
 787                 IWL_DEBUG_LAR(mvm,
 788                               "Could not retrieve root port ACPI handle\n");
 789                 return -ENOENT;
 790         }
 791
 792         /* Get the method's handle */
 793         status = acpi_get_handle(root_handle, (acpi_string)WRD_METHOD, &handle);
 794         if (ACPI_FAILURE(status)) {
 795                 IWL_DEBUG_LAR(mvm, "WRD method not found\n");
 796                 return -ENOENT;
 797         }
 798
 799         /* Call WRDD with no arguments */
 800         status = acpi_evaluate_object(handle, NULL, NULL, &wrdd);
 801         if (ACPI_FAILURE(status)) {
 802                 IWL_DEBUG_LAR(mvm, "WRDC invocation failed (0x%x)\n", status);
 803                 return -ENOENT;
 804         }
 805
 806         mcc_val = iwl_mvm_wrdd_get_mcc(mvm, wrdd.pointer);
 807         kfree(wrdd.pointer);
 808         if (!mcc_val)
 809                 return -ENOENT;
 810
 811         mcc[0] = (mcc_val >> 8) & 0xff;
 812         mcc[1] = mcc_val & 0xff;
 813         mcc[2] = '\0';
 814         return 0;
 815 }
 816 #else /* CONFIG_ACPI */
 817 static int iwl_mvm_get_bios_mcc(struct iwl_mvm *mvm, char *mcc)
 818 {
 819         return -ENOENT;
 820 }
 821 #endif
 822
 823 int iwl_mvm_init_mcc(struct iwl_mvm *mvm)
 824 {
 825         bool tlv_lar;
 826         bool nvm_lar;
 827         int retval;
 828         struct ieee80211_regdomain *regd;
 829         char mcc[3];
 830
 831         if (mvm->cfg->device_family == IWL_DEVICE_FAMILY_8000) {
 832                 tlv_lar = fw_has_capa(&mvm->fw->ucode_capa,
 833                                       IWL_UCODE_TLV_CAPA_LAR_SUPPORT);
 834                 nvm_lar = mvm->nvm_data->lar_enabled;
 835                 if (tlv_lar != nvm_lar)
 836                         IWL_INFO(mvm,
 837                                  "Conflict between TLV & NVM regarding enabling LAR (TLV = %s NVM =%s)\n",
 838                                  tlv_lar ? "enabled" : "disabled",
 839                                  nvm_lar ? "enabled" : "disabled");
 840         }
 841
 842         if (!iwl_mvm_is_lar_supported(mvm))
 843                 return 0;
 844
 845         /*
 846          * try to replay the last set MCC to FW. If it doesn't exist,
 847          * queue an update to cfg80211 to retrieve the default alpha2 from FW.
 848          */
 849         retval = iwl_mvm_init_fw_regd(mvm);
 850         if (retval != -ENOENT)
 851                 return retval;
 852
 853         /*
 854          * Driver regulatory hint for initial update, this also informs the
 855          * firmware we support wifi location updates.
 856          * Disallow scans that might crash the FW while the LAR regdomain
 857          * is not set.
 858          */
 859         mvm->lar_regdom_set = false;
 860
 861         regd = iwl_mvm_get_current_regdomain(mvm, NULL);
 862         if (IS_ERR_OR_NULL(regd))
 863                 return -EIO;
 864
 865         if (iwl_mvm_is_wifi_mcc_supported(mvm) &&
 866             !iwl_mvm_get_bios_mcc(mvm, mcc)) {
 867                 kfree(regd);
 868                 regd = iwl_mvm_get_regdomain(mvm->hw->wiphy, mcc,
 869                                              MCC_SOURCE_BIOS, NULL);
 870                 if (IS_ERR_OR_NULL(regd))
 871                         return -EIO;
 872         }
 873
 874         retval = regulatory_set_wiphy_regd_sync_rtnl(mvm->hw->wiphy, regd);
 875         kfree(regd);
 876         return retval;
 877 }
 878
 879 void iwl_mvm_rx_chub_update_mcc(struct iwl_mvm *mvm,
 880                                 struct iwl_rx_cmd_buffer *rxb)
 881 {
 882         struct iwl_rx_packet *pkt = rxb_addr(rxb);
 883         struct iwl_mcc_chub_notif *notif = (void *)pkt->data;
 884         enum iwl_mcc_source src;
 885         char mcc[3];
 886         struct ieee80211_regdomain *regd;
 887
 888         lockdep_assert_held(&mvm->mutex);
 889
 890         if (WARN_ON_ONCE(!iwl_mvm_is_lar_supported(mvm)))
 891                 return;
 892
 893         mcc[0] = notif->mcc >> 8;
 894         mcc[1] = notif->mcc & 0xff;
 895         mcc[2] = '\0';
 896         src = notif->source_id;
 897
 898         IWL_DEBUG_LAR(mvm,
 899                       "RX: received chub update mcc cmd (mcc '%s' src %d)\n",
 900                       mcc, src);
 901         regd = iwl_mvm_get_regdomain(mvm->hw->wiphy, mcc, src, NULL);
 902         if (IS_ERR_OR_NULL(regd))
 903                 return;
 904
 905         regulatory_set_wiphy_regd(mvm->hw->wiphy, regd);
 906         kfree(regd);
 907 }