1/****************************************************************************** 2 * 3 * This file is provided under a dual BSD/GPLv2 license. When using or 4 * redistributing this file, you may do so under either license. 5 * 6 * GPL LICENSE SUMMARY 7 * 8 * Copyright(c) 2012 - 2014 Intel Corporation. All rights reserved. 9 * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH 10 * Copyright(c) 2016 - 2017 Intel Deutschland GmbH 11 * Copyright (C) 2018 Intel Corporation 12 * 13 * This program is free software; you can redistribute it and/or modify 14 * it under the terms of version 2 of the GNU General Public License as 15 * published by the Free Software Foundation. 16 * 17 * This program is distributed in the hope that it will be useful, but 18 * WITHOUT ANY WARRANTY; without even the implied warranty of 19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 20 * General Public License for more details. 21 * 22 * The full GNU General Public License is included in this distribution 23 * in the file called COPYING. 24 * 25 * Contact Information: 26 * Intel Linux Wireless <linuxwifi@intel.com> 27 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497 28 * 29 * BSD LICENSE 30 * 31 * Copyright(c) 2012 - 2014 Intel Corporation. All rights reserved. 32 * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH 33 * Copyright(c) 2016 - 2017 Intel Deutschland GmbH 34 * Copyright (C) 2018 Intel Corporation 35 * All rights reserved. 36 * 37 * Redistribution and use in source and binary forms, with or without 38 * modification, are permitted provided that the following conditions 39 * are met: 40 * 41 * * Redistributions of source code must retain the above copyright 42 * notice, this list of conditions and the following disclaimer. 43 * * Redistributions in binary form must reproduce the above copyright 44 * notice, this list of conditions and the following disclaimer in 45 * the documentation and/or other materials provided with the 46 * distribution. 47 * * Neither the name Intel Corporation nor the names of its 48 * contributors may be used to endorse or promote products derived 49 * from this software without specific prior written permission. 50 * 51 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 52 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 53 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 54 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 55 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 56 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 57 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 58 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 59 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 60 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 61 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 62 * 63 *****************************************************************************/ 64 65#ifndef __iwl_fw_api_nvm_reg_h__ 66#define __iwl_fw_api_nvm_reg_h__ 67 68/** 69 * enum iwl_regulatory_and_nvm_subcmd_ids - regulatory/NVM commands 70 */ 71enum iwl_regulatory_and_nvm_subcmd_ids { 72 /** 73 * @NVM_ACCESS_COMPLETE: &struct iwl_nvm_access_complete_cmd 74 */ 75 NVM_ACCESS_COMPLETE = 0x0, 76 77 /** 78 * @NVM_GET_INFO: 79 * Command is &struct iwl_nvm_get_info, 80 * response is &struct iwl_nvm_get_info_rsp 81 */ 82 NVM_GET_INFO = 0x2, 83}; 84 85/** 86 * enum iwl_nvm_access_op - NVM access opcode 87 * @IWL_NVM_READ: read NVM 88 * @IWL_NVM_WRITE: write NVM 89 */ 90enum iwl_nvm_access_op { 91 IWL_NVM_READ = 0, 92 IWL_NVM_WRITE = 1, 93}; 94 95/** 96 * enum iwl_nvm_access_target - target of the NVM_ACCESS_CMD 97 * @NVM_ACCESS_TARGET_CACHE: access the cache 98 * @NVM_ACCESS_TARGET_OTP: access the OTP 99 * @NVM_ACCESS_TARGET_EEPROM: access the EEPROM 100 */ 101enum iwl_nvm_access_target { 102 NVM_ACCESS_TARGET_CACHE = 0, 103 NVM_ACCESS_TARGET_OTP = 1, 104 NVM_ACCESS_TARGET_EEPROM = 2, 105}; 106 107/** 108 * enum iwl_nvm_section_type - section types for NVM_ACCESS_CMD 109 * @NVM_SECTION_TYPE_SW: software section 110 * @NVM_SECTION_TYPE_REGULATORY: regulatory section 111 * @NVM_SECTION_TYPE_CALIBRATION: calibration section 112 * @NVM_SECTION_TYPE_PRODUCTION: production section 113 * @NVM_SECTION_TYPE_REGULATORY_SDP: regulatory section used by 3168 series 114 * @NVM_SECTION_TYPE_MAC_OVERRIDE: MAC override section 115 * @NVM_SECTION_TYPE_PHY_SKU: PHY SKU section 116 * @NVM_MAX_NUM_SECTIONS: number of sections 117 */ 118enum iwl_nvm_section_type { 119 NVM_SECTION_TYPE_SW = 1, 120 NVM_SECTION_TYPE_REGULATORY = 3, 121 NVM_SECTION_TYPE_CALIBRATION = 4, 122 NVM_SECTION_TYPE_PRODUCTION = 5, 123 NVM_SECTION_TYPE_REGULATORY_SDP = 8, 124 NVM_SECTION_TYPE_MAC_OVERRIDE = 11, 125 NVM_SECTION_TYPE_PHY_SKU = 12, 126 NVM_MAX_NUM_SECTIONS = 13, 127}; 128 129/** 130 * struct iwl_nvm_access_cmd - Request the device to send an NVM section 131 * @op_code: &enum iwl_nvm_access_op 132 * @target: &enum iwl_nvm_access_target 133 * @type: &enum iwl_nvm_section_type 134 * @offset: offset in bytes into the section 135 * @length: in bytes, to read/write 136 * @data: if write operation, the data to write. On read its empty 137 */ 138struct iwl_nvm_access_cmd { 139 u8 op_code; 140 u8 target; 141 __le16 type; 142 __le16 offset; 143 __le16 length; 144 u8 data[]; 145} __packed; /* NVM_ACCESS_CMD_API_S_VER_2 */ 146 147/** 148 * struct iwl_nvm_access_resp_ver2 - response to NVM_ACCESS_CMD 149 * @offset: offset in bytes into the section 150 * @length: in bytes, either how much was written or read 151 * @type: NVM_SECTION_TYPE_* 152 * @status: 0 for success, fail otherwise 153 * @data: if read operation, the data returned. Empty on write. 154 */ 155struct iwl_nvm_access_resp { 156 __le16 offset; 157 __le16 length; 158 __le16 type; 159 __le16 status; 160 u8 data[]; 161} __packed; /* NVM_ACCESS_CMD_RESP_API_S_VER_2 */ 162 163/* 164 * struct iwl_nvm_get_info - request to get NVM data 165 */ 166struct iwl_nvm_get_info { 167 __le32 reserved; 168} __packed; /* REGULATORY_NVM_GET_INFO_CMD_API_S_VER_1 */ 169 170/** 171 * enum iwl_nvm_info_general_flags - flags in NVM_GET_INFO resp 172 * @NVM_GENERAL_FLAGS_EMPTY_OTP: 1 if OTP is empty 173 */ 174enum iwl_nvm_info_general_flags { 175 NVM_GENERAL_FLAGS_EMPTY_OTP = BIT(0), 176}; 177 178/** 179 * struct iwl_nvm_get_info_general - general NVM data 180 * @flags: bit 0: 1 - empty, 0 - non-empty 181 * @nvm_version: nvm version 182 * @board_type: board type 183 * @n_hw_addrs: number of reserved MAC addresses 184 */ 185struct iwl_nvm_get_info_general { 186 __le32 flags; 187 __le16 nvm_version; 188 u8 board_type; 189 u8 n_hw_addrs; 190} __packed; /* REGULATORY_NVM_GET_INFO_GENERAL_S_VER_2 */ 191 192/** 193 * enum iwl_nvm_mac_sku_flags - flags in &iwl_nvm_get_info_sku 194 * @NVM_MAC_SKU_FLAGS_BAND_2_4_ENABLED: true if 2.4 band enabled 195 * @NVM_MAC_SKU_FLAGS_BAND_5_2_ENABLED: true if 5.2 band enabled 196 * @NVM_MAC_SKU_FLAGS_802_11N_ENABLED: true if 11n enabled 197 * @NVM_MAC_SKU_FLAGS_802_11AC_ENABLED: true if 11ac enabled 198 * @NVM_MAC_SKU_FLAGS_MIMO_DISABLED: true if MIMO disabled 199 * @NVM_MAC_SKU_FLAGS_WAPI_ENABLED: true if WAPI enabled 200 * @NVM_MAC_SKU_FLAGS_REG_CHECK_ENABLED: true if regulatory checker enabled 201 * @NVM_MAC_SKU_FLAGS_API_LOCK_ENABLED: true if API lock enabled 202 */ 203enum iwl_nvm_mac_sku_flags { 204 NVM_MAC_SKU_FLAGS_BAND_2_4_ENABLED = BIT(0), 205 NVM_MAC_SKU_FLAGS_BAND_5_2_ENABLED = BIT(1), 206 NVM_MAC_SKU_FLAGS_802_11N_ENABLED = BIT(2), 207 NVM_MAC_SKU_FLAGS_802_11AC_ENABLED = BIT(3), 208 /** 209 * @NVM_MAC_SKU_FLAGS_802_11AX_ENABLED: true if 11ax enabled 210 */ 211 NVM_MAC_SKU_FLAGS_802_11AX_ENABLED = BIT(4), 212 NVM_MAC_SKU_FLAGS_MIMO_DISABLED = BIT(5), 213 NVM_MAC_SKU_FLAGS_WAPI_ENABLED = BIT(8), 214 NVM_MAC_SKU_FLAGS_REG_CHECK_ENABLED = BIT(14), 215 NVM_MAC_SKU_FLAGS_API_LOCK_ENABLED = BIT(15), 216}; 217 218/** 219 * struct iwl_nvm_get_info_sku - mac information 220 * @mac_sku_flags: flags for SKU, see &enum iwl_nvm_mac_sku_flags 221 */ 222struct iwl_nvm_get_info_sku { 223 __le32 mac_sku_flags; 224} __packed; /* REGULATORY_NVM_GET_INFO_MAC_SKU_SECTION_S_VER_2 */ 225 226/** 227 * struct iwl_nvm_get_info_phy - phy information 228 * @tx_chains: BIT 0 chain A, BIT 1 chain B 229 * @rx_chains: BIT 0 chain A, BIT 1 chain B 230 */ 231struct iwl_nvm_get_info_phy { 232 __le32 tx_chains; 233 __le32 rx_chains; 234} __packed; /* REGULATORY_NVM_GET_INFO_PHY_SKU_SECTION_S_VER_1 */ 235 236#define IWL_NUM_CHANNELS (51) 237 238/** 239 * struct iwl_nvm_get_info_regulatory - regulatory information 240 * @lar_enabled: is LAR enabled 241 * @channel_profile: regulatory data of this channel 242 * @reserved: reserved 243 */ 244struct iwl_nvm_get_info_regulatory { 245 __le32 lar_enabled; 246 __le16 channel_profile[IWL_NUM_CHANNELS]; 247 __le16 reserved; 248} __packed; /* REGULATORY_NVM_GET_INFO_REGULATORY_S_VER_1 */ 249 250/** 251 * struct iwl_nvm_get_info_rsp - response to get NVM data 252 * @general: general NVM data 253 * @mac_sku: data relating to MAC sku 254 * @phy_sku: data relating to PHY sku 255 * @regulatory: regulatory data 256 */ 257struct iwl_nvm_get_info_rsp { 258 struct iwl_nvm_get_info_general general; 259 struct iwl_nvm_get_info_sku mac_sku; 260 struct iwl_nvm_get_info_phy phy_sku; 261 struct iwl_nvm_get_info_regulatory regulatory; 262} __packed; /* REGULATORY_NVM_GET_INFO_RSP_API_S_VER_3 */ 263 264/** 265 * struct iwl_nvm_access_complete_cmd - NVM_ACCESS commands are completed 266 * @reserved: reserved 267 */ 268struct iwl_nvm_access_complete_cmd { 269 __le32 reserved; 270} __packed; /* NVM_ACCESS_COMPLETE_CMD_API_S_VER_1 */ 271 272/** 273 * struct iwl_mcc_update_cmd - Request the device to update geographic 274 * regulatory profile according to the given MCC (Mobile Country Code). 275 * The MCC is two letter-code, ascii upper case[A-Z] or '00' for world domain. 276 * 'ZZ' MCC will be used to switch to NVM default profile; in this case, the 277 * MCC in the cmd response will be the relevant MCC in the NVM. 278 * @mcc: given mobile country code 279 * @source_id: the source from where we got the MCC, see iwl_mcc_source 280 * @reserved: reserved for alignment 281 * @key: integrity key for MCC API OEM testing 282 * @reserved2: reserved 283 */ 284struct iwl_mcc_update_cmd { 285 __le16 mcc; 286 u8 source_id; 287 u8 reserved; 288 __le32 key; 289 u8 reserved2[20]; 290} __packed; /* LAR_UPDATE_MCC_CMD_API_S_VER_2 */ 291 292/** 293 * enum iwl_geo_information - geographic information. 294 * @GEO_NO_INFO: no special info for this geo profile. 295 * @GEO_WMM_ETSI_5GHZ_INFO: this geo profile limits the WMM params 296 * for the 5 GHz band. 297 */ 298enum iwl_geo_information { 299 GEO_NO_INFO = 0, 300 GEO_WMM_ETSI_5GHZ_INFO = BIT(0), 301}; 302 303/** 304 * struct iwl_mcc_update_resp_v3 - response to MCC_UPDATE_CMD. 305 * Contains the new channel control profile map, if changed, and the new MCC 306 * (mobile country code). 307 * The new MCC may be different than what was requested in MCC_UPDATE_CMD. 308 * @status: see &enum iwl_mcc_update_status 309 * @mcc: the new applied MCC 310 * @cap: capabilities for all channels which matches the MCC 311 * @source_id: the MCC source, see iwl_mcc_source 312 * @time: time elapsed from the MCC test start (in units of 30 seconds) 313 * @geo_info: geographic specific profile information 314 * see &enum iwl_geo_information. 315 * @n_channels: number of channels in @channels_data. 316 * @channels: channel control data map, DWORD for each channel. Only the first 317 * 16bits are used. 318 */ 319struct iwl_mcc_update_resp_v3 { 320 __le32 status; 321 __le16 mcc; 322 u8 cap; 323 u8 source_id; 324 __le16 time; 325 __le16 geo_info; 326 __le32 n_channels; 327 __le32 channels[0]; 328} __packed; /* LAR_UPDATE_MCC_CMD_RESP_S_VER_3 */ 329 330/** 331 * struct iwl_mcc_update_resp - response to MCC_UPDATE_CMD. 332 * Contains the new channel control profile map, if changed, and the new MCC 333 * (mobile country code). 334 * The new MCC may be different than what was requested in MCC_UPDATE_CMD. 335 * @status: see &enum iwl_mcc_update_status 336 * @mcc: the new applied MCC 337 * @cap: capabilities for all channels which matches the MCC 338 * @time: time elapsed from the MCC test start (in units of 30 seconds) 339 * @geo_info: geographic specific profile information 340 * see &enum iwl_geo_information. 341 * @source_id: the MCC source, see iwl_mcc_source 342 * @reserved: for four bytes alignment. 343 * @n_channels: number of channels in @channels_data. 344 * @channels: channel control data map, DWORD for each channel. Only the first 345 * 16bits are used. 346 */ 347struct iwl_mcc_update_resp { 348 __le32 status; 349 __le16 mcc; 350 __le16 cap; 351 __le16 time; 352 __le16 geo_info; 353 u8 source_id; 354 u8 reserved[3]; 355 __le32 n_channels; 356 __le32 channels[0]; 357} __packed; /* LAR_UPDATE_MCC_CMD_RESP_S_VER_4 */ 358 359/** 360 * struct iwl_mcc_chub_notif - chub notifies of mcc change 361 * (MCC_CHUB_UPDATE_CMD = 0xc9) 362 * The Chub (Communication Hub, CommsHUB) is a HW component that connects to 363 * the cellular and connectivity cores that gets updates of the mcc, and 364 * notifies the ucode directly of any mcc change. 365 * The ucode requests the driver to request the device to update geographic 366 * regulatory profile according to the given MCC (Mobile Country Code). 367 * The MCC is two letter-code, ascii upper case[A-Z] or '00' for world domain. 368 * 'ZZ' MCC will be used to switch to NVM default profile; in this case, the 369 * MCC in the cmd response will be the relevant MCC in the NVM. 370 * @mcc: given mobile country code 371 * @source_id: identity of the change originator, see iwl_mcc_source 372 * @reserved1: reserved for alignment 373 */ 374struct iwl_mcc_chub_notif { 375 __le16 mcc; 376 u8 source_id; 377 u8 reserved1; 378} __packed; /* LAR_MCC_NOTIFY_S */ 379 380enum iwl_mcc_update_status { 381 MCC_RESP_NEW_CHAN_PROFILE, 382 MCC_RESP_SAME_CHAN_PROFILE, 383 MCC_RESP_INVALID, 384 MCC_RESP_NVM_DISABLED, 385 MCC_RESP_ILLEGAL, 386 MCC_RESP_LOW_PRIORITY, 387 MCC_RESP_TEST_MODE_ACTIVE, 388 MCC_RESP_TEST_MODE_NOT_ACTIVE, 389 MCC_RESP_TEST_MODE_DENIAL_OF_SERVICE, 390}; 391 392enum iwl_mcc_source { 393 MCC_SOURCE_OLD_FW = 0, 394 MCC_SOURCE_ME = 1, 395 MCC_SOURCE_BIOS = 2, 396 MCC_SOURCE_3G_LTE_HOST = 3, 397 MCC_SOURCE_3G_LTE_DEVICE = 4, 398 MCC_SOURCE_WIFI = 5, 399 MCC_SOURCE_RESERVED = 6, 400 MCC_SOURCE_DEFAULT = 7, 401 MCC_SOURCE_UNINITIALIZED = 8, 402 MCC_SOURCE_MCC_API = 9, 403 MCC_SOURCE_GET_CURRENT = 0x10, 404 MCC_SOURCE_GETTING_MCC_TEST_MODE = 0x11, 405}; 406 407#endif /* __iwl_fw_api_nvm_reg_h__ */ 408