1 // SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause
3 * Copyright (C) 2012-2014, 2018-2019 Intel Corporation
4 * Copyright (C) 2013-2015 Intel Mobile Communications GmbH
5 * Copyright (C) 2016-2017 Intel Deutschland GmbH
7 #include <linux/firmware.h>
8 #include <linux/rtnetlink.h>
12 #include "iwl-eeprom-parse.h"
13 #include "iwl-eeprom-read.h"
14 #include "iwl-nvm-parse.h"
18 /* Default NVM size to read */
19 #define IWL_NVM_DEFAULT_CHUNK_SIZE (2 * 1024)
21 #define NVM_WRITE_OPCODE 1
22 #define NVM_READ_OPCODE 0
24 /* load nvm chunk response */
26 READ_NVM_CHUNK_SUCCEED = 0,
27 READ_NVM_CHUNK_NOT_VALID_ADDRESS = 1
31 * prepare the NVM host command w/ the pointers to the nvm buffer
34 static int iwl_nvm_write_chunk(struct iwl_mvm *mvm, u16 section,
35 u16 offset, u16 length, const u8 *data)
37 struct iwl_nvm_access_cmd nvm_access_cmd = {
38 .offset = cpu_to_le16(offset),
39 .length = cpu_to_le16(length),
40 .type = cpu_to_le16(section),
41 .op_code = NVM_WRITE_OPCODE,
43 struct iwl_host_cmd cmd = {
45 .len = { sizeof(struct iwl_nvm_access_cmd), length },
46 .flags = CMD_WANT_SKB | CMD_SEND_IN_RFKILL,
47 .data = { &nvm_access_cmd, data },
48 /* data may come from vmalloc, so use _DUP */
49 .dataflags = { 0, IWL_HCMD_DFL_DUP },
51 struct iwl_rx_packet *pkt;
52 struct iwl_nvm_access_resp *nvm_resp;
55 ret = iwl_mvm_send_cmd(mvm, &cmd);
60 /* Extract & check NVM write response */
61 nvm_resp = (void *)pkt->data;
62 if (le16_to_cpu(nvm_resp->status) != READ_NVM_CHUNK_SUCCEED) {
64 "NVM access write command failed for section %u (status = 0x%x)\n",
65 section, le16_to_cpu(nvm_resp->status));
73 static int iwl_nvm_read_chunk(struct iwl_mvm *mvm, u16 section,
74 u16 offset, u16 length, u8 *data)
76 struct iwl_nvm_access_cmd nvm_access_cmd = {
77 .offset = cpu_to_le16(offset),
78 .length = cpu_to_le16(length),
79 .type = cpu_to_le16(section),
80 .op_code = NVM_READ_OPCODE,
82 struct iwl_nvm_access_resp *nvm_resp;
83 struct iwl_rx_packet *pkt;
84 struct iwl_host_cmd cmd = {
86 .flags = CMD_WANT_SKB | CMD_SEND_IN_RFKILL,
87 .data = { &nvm_access_cmd, },
89 int ret, bytes_read, offset_read;
92 cmd.len[0] = sizeof(struct iwl_nvm_access_cmd);
94 ret = iwl_mvm_send_cmd(mvm, &cmd);
100 /* Extract NVM response */
101 nvm_resp = (void *)pkt->data;
102 ret = le16_to_cpu(nvm_resp->status);
103 bytes_read = le16_to_cpu(nvm_resp->length);
104 offset_read = le16_to_cpu(nvm_resp->offset);
105 resp_data = nvm_resp->data;
108 (ret == READ_NVM_CHUNK_NOT_VALID_ADDRESS)) {
110 * meaning of NOT_VALID_ADDRESS:
111 * driver try to read chunk from address that is
112 * multiple of 2K and got an error since addr is empty.
113 * meaning of (offset != 0): driver already
114 * read valid data from another chunk so this case
117 IWL_DEBUG_EEPROM(mvm->trans->dev,
118 "NVM access command failed on offset 0x%x since that section size is multiple 2K\n",
122 IWL_DEBUG_EEPROM(mvm->trans->dev,
123 "NVM access command failed with status %d (device: %s)\n",
124 ret, mvm->trans->name);
130 if (offset_read != offset) {
131 IWL_ERR(mvm, "NVM ACCESS response with invalid offset %d\n",
137 /* Write data to NVM */
138 memcpy(data + offset, resp_data, bytes_read);
146 static int iwl_nvm_write_section(struct iwl_mvm *mvm, u16 section,
147 const u8 *data, u16 length)
151 /* copy data in chunks of 2k (and remainder if any) */
153 while (offset < length) {
156 chunk_size = min(IWL_NVM_DEFAULT_CHUNK_SIZE,
159 ret = iwl_nvm_write_chunk(mvm, section, offset,
160 chunk_size, data + offset);
164 offset += chunk_size;
171 * Reads an NVM section completely.
172 * NICs prior to 7000 family doesn't have a real NVM, but just read
173 * section 0 which is the EEPROM. Because the EEPROM reading is unlimited
174 * by uCode, we need to manually check in this case that we don't
175 * overflow and try to read more than the EEPROM size.
176 * For 7000 family NICs, we supply the maximal size we can read, and
177 * the uCode fills the response with as much data as we can,
178 * without overflowing, so no check is needed.
180 static int iwl_nvm_read_section(struct iwl_mvm *mvm, u16 section,
181 u8 *data, u32 size_read)
183 u16 length, offset = 0;
186 /* Set nvm section read length */
187 length = IWL_NVM_DEFAULT_CHUNK_SIZE;
191 /* Read the NVM until exhausted (reading less than requested) */
192 while (ret == length) {
193 /* Check no memory assumptions fail and cause an overflow */
194 if ((size_read + offset + length) >
195 mvm->trans->trans_cfg->base_params->eeprom_size) {
196 IWL_ERR(mvm, "EEPROM size is too small for NVM\n");
200 ret = iwl_nvm_read_chunk(mvm, section, offset, length, data);
202 IWL_DEBUG_EEPROM(mvm->trans->dev,
203 "Cannot read NVM from section %d offset %d, length %d\n",
204 section, offset, length);
210 iwl_nvm_fixups(mvm->trans->hw_id, section, data, offset);
212 IWL_DEBUG_EEPROM(mvm->trans->dev,
213 "NVM section %d read completed\n", section);
217 static struct iwl_nvm_data *
218 iwl_parse_nvm_sections(struct iwl_mvm *mvm)
220 struct iwl_nvm_section *sections = mvm->nvm_sections;
222 const __le16 *sw, *calib, *regulatory, *mac_override, *phy_sku;
225 /* Checking for required sections */
226 if (mvm->trans->cfg->nvm_type == IWL_NVM) {
227 if (!mvm->nvm_sections[NVM_SECTION_TYPE_SW].data ||
228 !mvm->nvm_sections[mvm->cfg->nvm_hw_section_num].data) {
229 IWL_ERR(mvm, "Can't parse empty OTP/NVM sections\n");
233 if (mvm->trans->cfg->nvm_type == IWL_NVM_SDP)
234 regulatory_type = NVM_SECTION_TYPE_REGULATORY_SDP;
236 regulatory_type = NVM_SECTION_TYPE_REGULATORY;
238 /* SW and REGULATORY sections are mandatory */
239 if (!mvm->nvm_sections[NVM_SECTION_TYPE_SW].data ||
240 !mvm->nvm_sections[regulatory_type].data) {
242 "Can't parse empty family 8000 OTP/NVM sections\n");
245 /* MAC_OVERRIDE or at least HW section must exist */
246 if (!mvm->nvm_sections[mvm->cfg->nvm_hw_section_num].data &&
247 !mvm->nvm_sections[NVM_SECTION_TYPE_MAC_OVERRIDE].data) {
249 "Can't parse mac_address, empty sections\n");
253 /* PHY_SKU section is mandatory in B0 */
254 if (mvm->trans->cfg->nvm_type == IWL_NVM_EXT &&
255 !mvm->nvm_sections[NVM_SECTION_TYPE_PHY_SKU].data) {
257 "Can't parse phy_sku in B0, empty sections\n");
262 hw = (const __be16 *)sections[mvm->cfg->nvm_hw_section_num].data;
263 sw = (const __le16 *)sections[NVM_SECTION_TYPE_SW].data;
264 calib = (const __le16 *)sections[NVM_SECTION_TYPE_CALIBRATION].data;
266 (const __le16 *)sections[NVM_SECTION_TYPE_MAC_OVERRIDE].data;
267 phy_sku = (const __le16 *)sections[NVM_SECTION_TYPE_PHY_SKU].data;
269 regulatory = mvm->trans->cfg->nvm_type == IWL_NVM_SDP ?
270 (const __le16 *)sections[NVM_SECTION_TYPE_REGULATORY_SDP].data :
271 (const __le16 *)sections[NVM_SECTION_TYPE_REGULATORY].data;
273 return iwl_parse_nvm_data(mvm->trans, mvm->cfg, mvm->fw, hw, sw, calib,
274 regulatory, mac_override, phy_sku,
275 mvm->fw->valid_tx_ant, mvm->fw->valid_rx_ant);
278 /* Loads the NVM data stored in mvm->nvm_sections into the NIC */
279 int iwl_mvm_load_nvm_to_nic(struct iwl_mvm *mvm)
282 struct iwl_nvm_section *sections = mvm->nvm_sections;
284 IWL_DEBUG_EEPROM(mvm->trans->dev, "'Write to NVM\n");
286 for (i = 0; i < ARRAY_SIZE(mvm->nvm_sections); i++) {
287 if (!mvm->nvm_sections[i].data || !mvm->nvm_sections[i].length)
289 ret = iwl_nvm_write_section(mvm, i, sections[i].data,
292 IWL_ERR(mvm, "iwl_mvm_send_cmd failed: %d\n", ret);
299 int iwl_nvm_init(struct iwl_mvm *mvm)
303 u8 *nvm_buffer, *temp;
304 const char *nvm_file_C = mvm->cfg->default_nvm_file_C_step;
306 if (WARN_ON_ONCE(mvm->cfg->nvm_hw_section_num >= NVM_MAX_NUM_SECTIONS))
309 /* load NVM values from nic */
310 /* Read From FW NVM */
311 IWL_DEBUG_EEPROM(mvm->trans->dev, "Read from NVM\n");
313 nvm_buffer = kmalloc(mvm->trans->trans_cfg->base_params->eeprom_size,
317 for (section = 0; section < NVM_MAX_NUM_SECTIONS; section++) {
318 /* we override the constness for initial read */
319 ret = iwl_nvm_read_section(mvm, section, nvm_buffer,
321 if (ret == -ENODATA) {
328 temp = kmemdup(nvm_buffer, ret, GFP_KERNEL);
334 iwl_nvm_fixups(mvm->trans->hw_id, section, temp, ret);
336 mvm->nvm_sections[section].data = temp;
337 mvm->nvm_sections[section].length = ret;
339 #ifdef CONFIG_IWLWIFI_DEBUGFS
341 case NVM_SECTION_TYPE_SW:
342 mvm->nvm_sw_blob.data = temp;
343 mvm->nvm_sw_blob.size = ret;
345 case NVM_SECTION_TYPE_CALIBRATION:
346 mvm->nvm_calib_blob.data = temp;
347 mvm->nvm_calib_blob.size = ret;
349 case NVM_SECTION_TYPE_PRODUCTION:
350 mvm->nvm_prod_blob.data = temp;
351 mvm->nvm_prod_blob.size = ret;
353 case NVM_SECTION_TYPE_PHY_SKU:
354 mvm->nvm_phy_sku_blob.data = temp;
355 mvm->nvm_phy_sku_blob.size = ret;
357 case NVM_SECTION_TYPE_REGULATORY_SDP:
358 case NVM_SECTION_TYPE_REGULATORY:
359 mvm->nvm_reg_blob.data = temp;
360 mvm->nvm_reg_blob.size = ret;
363 if (section == mvm->cfg->nvm_hw_section_num) {
364 mvm->nvm_hw_blob.data = temp;
365 mvm->nvm_hw_blob.size = ret;
372 IWL_ERR(mvm, "OTP is blank\n");
375 /* Only if PNVM selected in the mod param - load external NVM */
376 if (mvm->nvm_file_name) {
377 /* read External NVM file from the mod param */
378 ret = iwl_read_external_nvm(mvm->trans, mvm->nvm_file_name,
381 mvm->nvm_file_name = nvm_file_C;
383 if ((ret == -EFAULT || ret == -ENOENT) &&
384 mvm->nvm_file_name) {
385 /* in case nvm file was failed try again */
386 ret = iwl_read_external_nvm(mvm->trans,
397 /* parse the relevant nvm sections */
398 mvm->nvm_data = iwl_parse_nvm_sections(mvm);
401 IWL_DEBUG_EEPROM(mvm->trans->dev, "nvm version = %x\n",
402 mvm->nvm_data->nvm_version);
404 return ret < 0 ? ret : 0;
407 struct iwl_mcc_update_resp *
408 iwl_mvm_update_mcc(struct iwl_mvm *mvm, const char *alpha2,
409 enum iwl_mcc_source src_id)
411 struct iwl_mcc_update_cmd mcc_update_cmd = {
412 .mcc = cpu_to_le16(alpha2[0] << 8 | alpha2[1]),
413 .source_id = (u8)src_id,
415 struct iwl_mcc_update_resp *resp_cp;
416 struct iwl_rx_packet *pkt;
417 struct iwl_host_cmd cmd = {
418 .id = MCC_UPDATE_CMD,
419 .flags = CMD_WANT_SKB,
420 .data = { &mcc_update_cmd },
425 int resp_len, n_channels;
428 if (WARN_ON_ONCE(!iwl_mvm_is_lar_supported(mvm)))
429 return ERR_PTR(-EOPNOTSUPP);
431 cmd.len[0] = sizeof(struct iwl_mcc_update_cmd);
433 IWL_DEBUG_LAR(mvm, "send MCC update to FW with '%c%c' src = %d\n",
434 alpha2[0], alpha2[1], src_id);
436 ret = iwl_mvm_send_cmd(mvm, &cmd);
442 /* Extract MCC response */
443 if (fw_has_capa(&mvm->fw->ucode_capa,
444 IWL_UCODE_TLV_CAPA_MCC_UPDATE_11AX_SUPPORT)) {
445 struct iwl_mcc_update_resp *mcc_resp = (void *)pkt->data;
447 n_channels = __le32_to_cpu(mcc_resp->n_channels);
448 resp_len = sizeof(struct iwl_mcc_update_resp) +
449 n_channels * sizeof(__le32);
450 resp_cp = kmemdup(mcc_resp, resp_len, GFP_KERNEL);
452 resp_cp = ERR_PTR(-ENOMEM);
456 struct iwl_mcc_update_resp_v3 *mcc_resp_v3 = (void *)pkt->data;
458 n_channels = __le32_to_cpu(mcc_resp_v3->n_channels);
459 resp_len = sizeof(struct iwl_mcc_update_resp) +
460 n_channels * sizeof(__le32);
461 resp_cp = kzalloc(resp_len, GFP_KERNEL);
463 resp_cp = ERR_PTR(-ENOMEM);
467 resp_cp->status = mcc_resp_v3->status;
468 resp_cp->mcc = mcc_resp_v3->mcc;
469 resp_cp->cap = cpu_to_le16(mcc_resp_v3->cap);
470 resp_cp->source_id = mcc_resp_v3->source_id;
471 resp_cp->time = mcc_resp_v3->time;
472 resp_cp->geo_info = mcc_resp_v3->geo_info;
473 resp_cp->n_channels = mcc_resp_v3->n_channels;
474 memcpy(resp_cp->channels, mcc_resp_v3->channels,
475 n_channels * sizeof(__le32));
478 status = le32_to_cpu(resp_cp->status);
480 mcc = le16_to_cpu(resp_cp->mcc);
482 /* W/A for a FW/NVM issue - returns 0x00 for the world domain */
484 mcc = 0x3030; /* "00" - world */
485 resp_cp->mcc = cpu_to_le16(mcc);
489 "MCC response status: 0x%x. new MCC: 0x%x ('%c%c') n_chans: %d\n",
490 status, mcc, mcc >> 8, mcc & 0xff, n_channels);
497 int iwl_mvm_init_mcc(struct iwl_mvm *mvm)
502 struct ieee80211_regdomain *regd;
505 if (mvm->cfg->nvm_type == IWL_NVM_EXT) {
506 tlv_lar = fw_has_capa(&mvm->fw->ucode_capa,
507 IWL_UCODE_TLV_CAPA_LAR_SUPPORT);
508 nvm_lar = mvm->nvm_data->lar_enabled;
509 if (tlv_lar != nvm_lar)
511 "Conflict between TLV & NVM regarding enabling LAR (TLV = %s NVM =%s)\n",
512 tlv_lar ? "enabled" : "disabled",
513 nvm_lar ? "enabled" : "disabled");
516 if (!iwl_mvm_is_lar_supported(mvm))
520 * try to replay the last set MCC to FW. If it doesn't exist,
521 * queue an update to cfg80211 to retrieve the default alpha2 from FW.
523 retval = iwl_mvm_init_fw_regd(mvm);
524 if (retval != -ENOENT)
528 * Driver regulatory hint for initial update, this also informs the
529 * firmware we support wifi location updates.
530 * Disallow scans that might crash the FW while the LAR regdomain
533 mvm->lar_regdom_set = false;
535 regd = iwl_mvm_get_current_regdomain(mvm, NULL);
536 if (IS_ERR_OR_NULL(regd))
539 if (iwl_mvm_is_wifi_mcc_supported(mvm) &&
540 !iwl_acpi_get_mcc(mvm->dev, mcc)) {
542 regd = iwl_mvm_get_regdomain(mvm->hw->wiphy, mcc,
543 MCC_SOURCE_BIOS, NULL);
544 if (IS_ERR_OR_NULL(regd))
548 retval = regulatory_set_wiphy_regd_sync(mvm->hw->wiphy, regd);
553 void iwl_mvm_rx_chub_update_mcc(struct iwl_mvm *mvm,
554 struct iwl_rx_cmd_buffer *rxb)
556 struct iwl_rx_packet *pkt = rxb_addr(rxb);
557 struct iwl_mcc_chub_notif *notif = (void *)pkt->data;
558 enum iwl_mcc_source src;
560 struct ieee80211_regdomain *regd;
563 lockdep_assert_held(&mvm->mutex);
565 if (iwl_mvm_is_vif_assoc(mvm) && notif->source_id == MCC_SOURCE_WIFI) {
566 IWL_DEBUG_LAR(mvm, "Ignore mcc update while associated\n");
570 if (WARN_ON_ONCE(!iwl_mvm_is_lar_supported(mvm)))
573 mcc[0] = le16_to_cpu(notif->mcc) >> 8;
574 mcc[1] = le16_to_cpu(notif->mcc) & 0xff;
576 src = notif->source_id;
579 "RX: received chub update mcc cmd (mcc '%s' src %d)\n",
581 regd = iwl_mvm_get_regdomain(mvm->hw->wiphy, mcc, src, NULL);
582 if (IS_ERR_OR_NULL(regd))
585 wgds_tbl_idx = iwl_mvm_get_sar_geo_profile(mvm);
586 if (wgds_tbl_idx < 0)
587 IWL_DEBUG_INFO(mvm, "SAR WGDS is disabled (%d)\n",
590 IWL_DEBUG_INFO(mvm, "SAR WGDS: geo profile %d is configured\n",
593 regulatory_set_wiphy_regd(mvm->hw->wiphy, regd);