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