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  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of version 2 of the GNU General Public License as
  12  * published by the Free Software Foundation.
  13  *
  14  * This program is distributed in the hope that it will be useful, but
  15  * WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
  22  * USA
  23  *
  24  * The full GNU General Public License is included in this distribution
  25  * in the file called COPYING.
  26  *
  27  * Contact Information:
  28  *  Intel Linux Wireless <ilw@linux.intel.com>
  29  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  30  *
  31  * BSD LICENSE
  32  *
  33  * Copyright(c) 2012 - 2014 Intel Corporation. All rights reserved.
  34  * All rights reserved.
  35  *
  36  * Redistribution and use in source and binary forms, with or without
  37  * modification, are permitted provided that the following conditions
  38  * are met:
  39  *
  40  *  * Redistributions of source code must retain the above copyright
  41  *    notice, this list of conditions and the following disclaimer.
  42  *  * Redistributions in binary form must reproduce the above copyright
  43  *    notice, this list of conditions and the following disclaimer in
  44  *    the documentation and/or other materials provided with the
  45  *    distribution.
  46  *  * Neither the name Intel Corporation nor the names of its
  47  *    contributors may be used to endorse or promote products derived
  48  *    from this software without specific prior written permission.
  49  *
  50  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  51  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  52  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  53  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  54  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  55  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  56  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  57  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  58  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  59  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  60  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  61  *
  62  *****************************************************************************/
  63 #include <linux/firmware.h>
  64 #include "iwl-trans.h"
  65 #include "mvm.h"
  66 #include "iwl-eeprom-parse.h"
  67 #include "iwl-eeprom-read.h"
  68 #include "iwl-nvm-parse.h"
  69
  70 /* Default NVM size to read */
  71 #define IWL_NVM_DEFAULT_CHUNK_SIZE (2*1024)
  72 #define IWL_MAX_NVM_SECTION_SIZE 7000
  73
  74 #define NVM_WRITE_OPCODE 1
  75 #define NVM_READ_OPCODE 0
  76
  77 /*
  78  * prepare the NVM host command w/ the pointers to the nvm buffer
  79  * and send it to fw
  80  */
  81 static int iwl_nvm_write_chunk(struct iwl_mvm *mvm, u16 section,
  82                                u16 offset, u16 length, const u8 *data)
  83 {
  84         struct iwl_nvm_access_cmd nvm_access_cmd = {
  85                 .offset = cpu_to_le16(offset),
  86                 .length = cpu_to_le16(length),
  87                 .type = cpu_to_le16(section),
  88                 .op_code = NVM_WRITE_OPCODE,
  89         };
  90         struct iwl_host_cmd cmd = {
  91                 .id = NVM_ACCESS_CMD,
  92                 .len = { sizeof(struct iwl_nvm_access_cmd), length },
  93                 .flags = CMD_SYNC | CMD_SEND_IN_RFKILL,
  94                 .data = { &nvm_access_cmd, data },
  95                 /* data may come from vmalloc, so use _DUP */
  96                 .dataflags = { 0, IWL_HCMD_DFL_DUP },
  97         };
  98
  99         return iwl_mvm_send_cmd(mvm, &cmd);
 100 }
 101
 102 static int iwl_nvm_read_chunk(struct iwl_mvm *mvm, u16 section,
 103                               u16 offset, u16 length, u8 *data)
 104 {
 105         struct iwl_nvm_access_cmd nvm_access_cmd = {
 106                 .offset = cpu_to_le16(offset),
 107                 .length = cpu_to_le16(length),
 108                 .type = cpu_to_le16(section),
 109                 .op_code = NVM_READ_OPCODE,
 110         };
 111         struct iwl_nvm_access_resp *nvm_resp;
 112         struct iwl_rx_packet *pkt;
 113         struct iwl_host_cmd cmd = {
 114                 .id = NVM_ACCESS_CMD,
 115                 .flags = CMD_SYNC | CMD_WANT_SKB | CMD_SEND_IN_RFKILL,
 116                 .data = { &nvm_access_cmd, },
 117         };
 118         int ret, bytes_read, offset_read;
 119         u8 *resp_data;
 120
 121         cmd.len[0] = sizeof(struct iwl_nvm_access_cmd);
 122
 123         ret = iwl_mvm_send_cmd(mvm, &cmd);
 124         if (ret)
 125                 return ret;
 126
 127         pkt = cmd.resp_pkt;
 128         if (pkt->hdr.flags & IWL_CMD_FAILED_MSK) {
 129                 IWL_ERR(mvm, "Bad return from NVM_ACCES_COMMAND (0x%08X)\n",
 130                         pkt->hdr.flags);
 131                 ret = -EIO;
 132                 goto exit;
 133         }
 134
 135         /* Extract NVM response */
 136         nvm_resp = (void *)pkt->data;
 137         ret = le16_to_cpu(nvm_resp->status);
 138         bytes_read = le16_to_cpu(nvm_resp->length);
 139         offset_read = le16_to_cpu(nvm_resp->offset);
 140         resp_data = nvm_resp->data;
 141         if (ret) {
 142                 IWL_ERR(mvm,
 143                         "NVM access command failed with status %d (device: %s)\n",
 144                         ret, mvm->cfg->name);
 145                 ret = -EINVAL;
 146                 goto exit;
 147         }
 148
 149         if (offset_read != offset) {
 150                 IWL_ERR(mvm, "NVM ACCESS response with invalid offset %d\n",
 151                         offset_read);
 152                 ret = -EINVAL;
 153                 goto exit;
 154         }
 155
 156         /* Write data to NVM */
 157         memcpy(data + offset, resp_data, bytes_read);
 158         ret = bytes_read;
 159
 160 exit:
 161         iwl_free_resp(&cmd);
 162         return ret;
 163 }
 164
 165 static int iwl_nvm_write_section(struct iwl_mvm *mvm, u16 section,
 166                                  const u8 *data, u16 length)
 167 {
 168         int offset = 0;
 169
 170         /* copy data in chunks of 2k (and remainder if any) */
 171
 172         while (offset < length) {
 173                 int chunk_size, ret;
 174
 175                 chunk_size = min(IWL_NVM_DEFAULT_CHUNK_SIZE,
 176                                  length - offset);
 177
 178                 ret = iwl_nvm_write_chunk(mvm, section, offset,
 179                                           chunk_size, data + offset);
 180                 if (ret < 0)
 181                         return ret;
 182
 183                 offset += chunk_size;
 184         }
 185
 186         return 0;
 187 }
 188
 189 /*
 190  * Reads an NVM section completely.
 191  * NICs prior to 7000 family doesn't have a real NVM, but just read
 192  * section 0 which is the EEPROM. Because the EEPROM reading is unlimited
 193  * by uCode, we need to manually check in this case that we don't
 194  * overflow and try to read more than the EEPROM size.
 195  * For 7000 family NICs, we supply the maximal size we can read, and
 196  * the uCode fills the response with as much data as we can,
 197  * without overflowing, so no check is needed.
 198  */
 199 static int iwl_nvm_read_section(struct iwl_mvm *mvm, u16 section,
 200                                 u8 *data)
 201 {
 202         u16 length, offset = 0;
 203         int ret;
 204
 205         /* Set nvm section read length */
 206         length = IWL_NVM_DEFAULT_CHUNK_SIZE;
 207
 208         ret = length;
 209
 210         /* Read the NVM until exhausted (reading less than requested) */
 211         while (ret == length) {
 212                 ret = iwl_nvm_read_chunk(mvm, section, offset, length, data);
 213                 if (ret < 0) {
 214                         IWL_ERR(mvm,
 215                                 "Cannot read NVM from section %d offset %d, length %d\n",
 216                                 section, offset, length);
 217                         return ret;
 218                 }
 219                 offset += ret;
 220         }
 221
 222         IWL_DEBUG_EEPROM(mvm->trans->dev,
 223                          "NVM section %d read completed\n", section);
 224         return offset;
 225 }
 226
 227 static struct iwl_nvm_data *
 228 iwl_parse_nvm_sections(struct iwl_mvm *mvm)
 229 {
 230         struct iwl_nvm_section *sections = mvm->nvm_sections;
 231         const __le16 *hw, *sw, *calib, *regulatory, *mac_override;
 232
 233         /* Checking for required sections */
 234         if (mvm->trans->cfg->device_family != IWL_DEVICE_FAMILY_8000) {
 235                 if (!mvm->nvm_sections[NVM_SECTION_TYPE_SW].data ||
 236                     !mvm->nvm_sections[mvm->cfg->nvm_hw_section_num].data) {
 237                         IWL_ERR(mvm, "Can't parse empty NVM sections\n");
 238                         return NULL;
 239                 }
 240         } else {
 241                 /* SW and REGULATORY sections are mandatory */
 242                 if (!mvm->nvm_sections[NVM_SECTION_TYPE_SW].data ||
 243                     !mvm->nvm_sections[NVM_SECTION_TYPE_REGULATORY].data) {
 244                         IWL_ERR(mvm,
 245                                 "Can't parse empty family 8000 NVM sections\n");
 246                         return NULL;
 247                 }
 248                 /* MAC_OVERRIDE or at least HW section must exist */
 249                 if (!mvm->nvm_sections[mvm->cfg->nvm_hw_section_num].data &&
 250                     !mvm->nvm_sections[NVM_SECTION_TYPE_MAC_OVERRIDE].data) {
 251                         IWL_ERR(mvm,
 252                                 "Can't parse mac_address, empty sections\n");
 253                         return NULL;
 254                 }
 255         }
 256
 257         if (WARN_ON(!mvm->cfg))
 258                 return NULL;
 259
 260         hw = (const __le16 *)sections[mvm->cfg->nvm_hw_section_num].data;
 261         sw = (const __le16 *)sections[NVM_SECTION_TYPE_SW].data;
 262         calib = (const __le16 *)sections[NVM_SECTION_TYPE_CALIBRATION].data;
 263         regulatory = (const __le16 *)sections[NVM_SECTION_TYPE_REGULATORY].data;
 264         mac_override =
 265                 (const __le16 *)sections[NVM_SECTION_TYPE_MAC_OVERRIDE].data;
 266
 267         return iwl_parse_nvm_data(mvm->trans->dev, mvm->cfg, hw, sw, calib,
 268                                   regulatory, mac_override,
 269                                   mvm->fw->valid_tx_ant,
 270                                   mvm->fw->valid_rx_ant);
 271 }
 272
 273 #define MAX_NVM_FILE_LEN        16384
 274
 275 /*
 276  * Reads external NVM from a file into mvm->nvm_sections
 277  *
 278  * HOW TO CREATE THE NVM FILE FORMAT:
 279  * ------------------------------
 280  * 1. create hex file, format:
 281  *      3800 -> header
 282  *      0000 -> header
 283  *      5a40 -> data
 284  *
 285  *   rev - 6 bit (word1)
 286  *   len - 10 bit (word1)
 287  *   id - 4 bit (word2)
 288  *   rsv - 12 bit (word2)
 289  *
 290  * 2. flip 8bits with 8 bits per line to get the right NVM file format
 291  *
 292  * 3. create binary file from the hex file
 293  *
 294  * 4. save as "iNVM_xxx.bin" under /lib/firmware
 295  */
 296 static int iwl_mvm_read_external_nvm(struct iwl_mvm *mvm)
 297 {
 298         int ret, section_size;
 299         u16 section_id;
 300         const struct firmware *fw_entry;
 301         const struct {
 302                 __le16 word1;
 303                 __le16 word2;
 304                 u8 data[];
 305         } *file_sec;
 306         const u8 *eof, *temp;
 307
 308 #define NVM_WORD1_LEN(x) (8 * (x & 0x03FF))
 309 #define NVM_WORD2_ID(x) (x >> 12)
 310 #define NVM_WORD2_LEN_FAMILY_8000(x) (2 * ((x & 0xFF) << 8 | x >> 8))
 311 #define NVM_WORD1_ID_FAMILY_8000(x) (x >> 4)
 312
 313         IWL_DEBUG_EEPROM(mvm->trans->dev, "Read from external NVM\n");
 314
 315         /*
 316          * Obtain NVM image via request_firmware. Since we already used
 317          * request_firmware_nowait() for the firmware binary load and only
 318          * get here after that we assume the NVM request can be satisfied
 319          * synchronously.
 320          */
 321         ret = request_firmware(&fw_entry, mvm->nvm_file_name,
 322                                mvm->trans->dev);
 323         if (ret) {
 324                 IWL_ERR(mvm, "ERROR: %s isn't available %d\n",
 325                         mvm->nvm_file_name, ret);
 326                 return ret;
 327         }
 328
 329         IWL_INFO(mvm, "Loaded NVM file %s (%zu bytes)\n",
 330                  mvm->nvm_file_name, fw_entry->size);
 331
 332         if (fw_entry->size < sizeof(*file_sec)) {
 333                 IWL_ERR(mvm, "NVM file too small\n");
 334                 ret = -EINVAL;
 335                 goto out;
 336         }
 337
 338         if (fw_entry->size > MAX_NVM_FILE_LEN) {
 339                 IWL_ERR(mvm, "NVM file too large\n");
 340                 ret = -EINVAL;
 341                 goto out;
 342         }
 343
 344         eof = fw_entry->data + fw_entry->size;
 345
 346         file_sec = (void *)fw_entry->data;
 347
 348         while (true) {
 349                 if (file_sec->data > eof) {
 350                         IWL_ERR(mvm,
 351                                 "ERROR - NVM file too short for section header\n");
 352                         ret = -EINVAL;
 353                         break;
 354                 }
 355
 356                 /* check for EOF marker */
 357                 if (!file_sec->word1 && !file_sec->word2) {
 358                         ret = 0;
 359                         break;
 360                 }
 361
 362                 if (mvm->trans->cfg->device_family != IWL_DEVICE_FAMILY_8000) {
 363                         section_size =
 364                                 2 * NVM_WORD1_LEN(le16_to_cpu(file_sec->word1));
 365                         section_id = NVM_WORD2_ID(le16_to_cpu(file_sec->word2));
 366                 } else {
 367                         section_size = 2 * NVM_WORD2_LEN_FAMILY_8000(
 368                                                 le16_to_cpu(file_sec->word2));
 369                         section_id = NVM_WORD1_ID_FAMILY_8000(
 370                                                 le16_to_cpu(file_sec->word1));
 371                 }
 372
 373                 if (section_size > IWL_MAX_NVM_SECTION_SIZE) {
 374                         IWL_ERR(mvm, "ERROR - section too large (%d)\n",
 375                                 section_size);
 376                         ret = -EINVAL;
 377                         break;
 378                 }
 379
 380                 if (!section_size) {
 381                         IWL_ERR(mvm, "ERROR - section empty\n");
 382                         ret = -EINVAL;
 383                         break;
 384                 }
 385
 386                 if (file_sec->data + section_size > eof) {
 387                         IWL_ERR(mvm,
 388                                 "ERROR - NVM file too short for section (%d bytes)\n",
 389                                 section_size);
 390                         ret = -EINVAL;
 391                         break;
 392                 }
 393
 394                 if (WARN(section_id >= NVM_MAX_NUM_SECTIONS,
 395                          "Invalid NVM section ID %d\n", section_id)) {
 396                         ret = -EINVAL;
 397                         break;
 398                 }
 399
 400                 temp = kmemdup(file_sec->data, section_size, GFP_KERNEL);
 401                 if (!temp) {
 402                         ret = -ENOMEM;
 403                         break;
 404                 }
 405                 mvm->nvm_sections[section_id].data = temp;
 406                 mvm->nvm_sections[section_id].length = section_size;
 407
 408                 /* advance to the next section */
 409                 file_sec = (void *)(file_sec->data + section_size);
 410         }
 411 out:
 412         release_firmware(fw_entry);
 413         return ret;
 414 }
 415
 416 /* Loads the NVM data stored in mvm->nvm_sections into the NIC */
 417 int iwl_mvm_load_nvm_to_nic(struct iwl_mvm *mvm)
 418 {
 419         int i, ret = 0;
 420         struct iwl_nvm_section *sections = mvm->nvm_sections;
 421
 422         IWL_DEBUG_EEPROM(mvm->trans->dev, "'Write to NVM\n");
 423
 424         for (i = 0; i < ARRAY_SIZE(mvm->nvm_sections); i++) {
 425                 if (!mvm->nvm_sections[i].data || !mvm->nvm_sections[i].length)
 426                         continue;
 427                 ret = iwl_nvm_write_section(mvm, i, sections[i].data,
 428                                             sections[i].length);
 429                 if (ret < 0) {
 430                         IWL_ERR(mvm, "iwl_mvm_send_cmd failed: %d\n", ret);
 431                         break;
 432                 }
 433         }
 434         return ret;
 435 }
 436
 437 int iwl_nvm_init(struct iwl_mvm *mvm, bool read_nvm_from_nic)
 438 {
 439         int ret, i, section;
 440         u8 *nvm_buffer, *temp;
 441         int nvm_to_read[NVM_MAX_NUM_SECTIONS];
 442         int num_of_sections_to_read;
 443
 444         if (WARN_ON_ONCE(mvm->cfg->nvm_hw_section_num >= NVM_MAX_NUM_SECTIONS))
 445                 return -EINVAL;
 446
 447         /* load NVM values from nic */
 448         if (read_nvm_from_nic) {
 449                 /* list of NVM sections we are allowed/need to read */
 450                 if (mvm->trans->cfg->device_family != IWL_DEVICE_FAMILY_8000) {
 451                         nvm_to_read[0] = mvm->cfg->nvm_hw_section_num;
 452                         nvm_to_read[1] = NVM_SECTION_TYPE_SW;
 453                         nvm_to_read[2] = NVM_SECTION_TYPE_CALIBRATION;
 454                         nvm_to_read[3] = NVM_SECTION_TYPE_PRODUCTION;
 455                         num_of_sections_to_read = 4;
 456                 } else {
 457                         nvm_to_read[0] = NVM_SECTION_TYPE_SW;
 458                         nvm_to_read[1] = NVM_SECTION_TYPE_CALIBRATION;
 459                         nvm_to_read[2] = NVM_SECTION_TYPE_PRODUCTION;
 460                         nvm_to_read[3] = NVM_SECTION_TYPE_REGULATORY;
 461                         nvm_to_read[4] = NVM_SECTION_TYPE_MAC_OVERRIDE;
 462                         num_of_sections_to_read = 5;
 463                 }
 464
 465                 /* Read From FW NVM */
 466                 IWL_DEBUG_EEPROM(mvm->trans->dev, "Read from NVM\n");
 467
 468                 nvm_buffer = kmalloc(mvm->cfg->base_params->eeprom_size,
 469                                      GFP_KERNEL);
 470                 if (!nvm_buffer)
 471                         return -ENOMEM;
 472                 for (i = 0; i < num_of_sections_to_read; i++) {
 473                         section = nvm_to_read[i];
 474                         /* we override the constness for initial read */
 475                         ret = iwl_nvm_read_section(mvm, section, nvm_buffer);
 476                         if (ret < 0)
 477                                 break;
 478                         temp = kmemdup(nvm_buffer, ret, GFP_KERNEL);
 479                         if (!temp) {
 480                                 ret = -ENOMEM;
 481                                 break;
 482                         }
 483                         mvm->nvm_sections[section].data = temp;
 484                         mvm->nvm_sections[section].length = ret;
 485
 486 #ifdef CONFIG_IWLWIFI_DEBUGFS
 487                         switch (section) {
 488                         case NVM_SECTION_TYPE_SW:
 489                                 mvm->nvm_sw_blob.data = temp;
 490                                 mvm->nvm_sw_blob.size  = ret;
 491                                 break;
 492                         case NVM_SECTION_TYPE_CALIBRATION:
 493                                 mvm->nvm_calib_blob.data = temp;
 494                                 mvm->nvm_calib_blob.size  = ret;
 495                                 break;
 496                         case NVM_SECTION_TYPE_PRODUCTION:
 497                                 mvm->nvm_prod_blob.data = temp;
 498                                 mvm->nvm_prod_blob.size  = ret;
 499                                 break;
 500                         default:
 501                                 if (section == mvm->cfg->nvm_hw_section_num) {
 502                                         mvm->nvm_hw_blob.data = temp;
 503                                         mvm->nvm_hw_blob.size = ret;
 504                                         break;
 505                                 }
 506                                 WARN(1, "section: %d", section);
 507                         }
 508 #endif
 509                 }
 510                 kfree(nvm_buffer);
 511                 if (ret < 0)
 512                         return ret;
 513         }
 514
 515         /* load external NVM if configured */
 516         if (mvm->nvm_file_name) {
 517                 /* move to External NVM flow */
 518                 ret = iwl_mvm_read_external_nvm(mvm);
 519                 if (ret)
 520                         return ret;
 521         }
 522
 523         /* parse the relevant nvm sections */
 524         mvm->nvm_data = iwl_parse_nvm_sections(mvm);
 525         if (!mvm->nvm_data)
 526                 return -ENODATA;
 527
 528         return 0;
 529 }