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 */ 71 enum 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 */ 90 enum 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 */ 101 enum 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 */ 118 enum 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 */ 138 struct 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 */ 155 struct 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 */ 166 struct iwl_nvm_get_info { 167 __le32 reserved; 168 } __packed; /* GRP_REGULATORY_NVM_GET_INFO_CMD_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 */ 174 enum 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 * @reserved: reserved 184 */ 185 struct iwl_nvm_get_info_general { 186 __le32 flags; 187 __le16 nvm_version; 188 u8 board_type; 189 u8 reserved; 190 } __packed; /* GRP_REGULATORY_NVM_GET_INFO_GENERAL_S_VER_1 */ 191 192 /** 193 * struct iwl_nvm_get_info_sku - mac information 194 * @enable_24g: band 2.4G enabled 195 * @enable_5g: band 5G enabled 196 * @enable_11n: 11n enabled 197 * @enable_11ac: 11ac enabled 198 * @mimo_disable: MIMO enabled 199 * @ext_crypto: Extended crypto enabled 200 */ 201 struct iwl_nvm_get_info_sku { 202 __le32 enable_24g; 203 __le32 enable_5g; 204 __le32 enable_11n; 205 __le32 enable_11ac; 206 __le32 mimo_disable; 207 __le32 ext_crypto; 208 } __packed; /* GRP_REGULATORY_NVM_GET_INFO_MAC_SKU_SECTION_S_VER_1 */ 209 210 /** 211 * struct iwl_nvm_get_info_phy - phy information 212 * @tx_chains: BIT 0 chain A, BIT 1 chain B 213 * @rx_chains: BIT 0 chain A, BIT 1 chain B 214 */ 215 struct iwl_nvm_get_info_phy { 216 __le32 tx_chains; 217 __le32 rx_chains; 218 } __packed; /* GRP_REGULATORY_NVM_GET_INFO_PHY_SKU_SECTION_S_VER_1 */ 219 220 #define IWL_NUM_CHANNELS (51) 221 222 /** 223 * struct iwl_nvm_get_info_regulatory - regulatory information 224 * @lar_enabled: is LAR enabled 225 * @channel_profile: regulatory data of this channel 226 * @reserved: reserved 227 */ 228 struct iwl_nvm_get_info_regulatory { 229 __le32 lar_enabled; 230 __le16 channel_profile[IWL_NUM_CHANNELS]; 231 __le16 reserved; 232 } __packed; /* GRP_REGULATORY_NVM_GET_INFO_REGULATORY_S_VER_1 */ 233 234 /** 235 * struct iwl_nvm_get_info_rsp - response to get NVM data 236 * @general: general NVM data 237 * @mac_sku: data relating to MAC sku 238 * @phy_sku: data relating to PHY sku 239 * @regulatory: regulatory data 240 */ 241 struct iwl_nvm_get_info_rsp { 242 struct iwl_nvm_get_info_general general; 243 struct iwl_nvm_get_info_sku mac_sku; 244 struct iwl_nvm_get_info_phy phy_sku; 245 struct iwl_nvm_get_info_regulatory regulatory; 246 } __packed; /* GRP_REGULATORY_NVM_GET_INFO_CMD_RSP_S_VER_1 */ 247 248 /** 249 * struct iwl_nvm_access_complete_cmd - NVM_ACCESS commands are completed 250 * @reserved: reserved 251 */ 252 struct iwl_nvm_access_complete_cmd { 253 __le32 reserved; 254 } __packed; /* NVM_ACCESS_COMPLETE_CMD_API_S_VER_1 */ 255 256 /** 257 * struct iwl_mcc_update_cmd_v1 - Request the device to update geographic 258 * regulatory profile according to the given MCC (Mobile Country Code). 259 * The MCC is two letter-code, ascii upper case[A-Z] or '00' for world domain. 260 * 'ZZ' MCC will be used to switch to NVM default profile; in this case, the 261 * MCC in the cmd response will be the relevant MCC in the NVM. 262 * @mcc: given mobile country code 263 * @source_id: the source from where we got the MCC, see iwl_mcc_source 264 * @reserved: reserved for alignment 265 */ 266 struct iwl_mcc_update_cmd_v1 { 267 __le16 mcc; 268 u8 source_id; 269 u8 reserved; 270 } __packed; /* LAR_UPDATE_MCC_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 */ 284 struct 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 * struct iwl_mcc_update_resp_v1 - response to MCC_UPDATE_CMD. 294 * Contains the new channel control profile map, if changed, and the new MCC 295 * (mobile country code). 296 * The new MCC may be different than what was requested in MCC_UPDATE_CMD. 297 * @status: see &enum iwl_mcc_update_status 298 * @mcc: the new applied MCC 299 * @cap: capabilities for all channels which matches the MCC 300 * @source_id: the MCC source, see iwl_mcc_source 301 * @n_channels: number of channels in @channels_data (may be 14, 39, 50 or 51 302 * channels, depending on platform) 303 * @channels: channel control data map, DWORD for each channel. Only the first 304 * 16bits are used. 305 */ 306 struct iwl_mcc_update_resp_v1 { 307 __le32 status; 308 __le16 mcc; 309 u8 cap; 310 u8 source_id; 311 __le32 n_channels; 312 __le32 channels[0]; 313 } __packed; /* LAR_UPDATE_MCC_CMD_RESP_S_VER_1 */ 314 315 /** 316 * enum iwl_geo_information - geographic information. 317 * @GEO_NO_INFO: no special info for this geo profile. 318 * @GEO_WMM_ETSI_5GHZ_INFO: this geo profile limits the WMM params 319 * for the 5 GHz band. 320 */ 321 enum iwl_geo_information { 322 GEO_NO_INFO = 0, 323 GEO_WMM_ETSI_5GHZ_INFO = BIT(0), 324 }; 325 326 /** 327 * struct iwl_mcc_update_resp - response to MCC_UPDATE_CMD. 328 * Contains the new channel control profile map, if changed, and the new MCC 329 * (mobile country code). 330 * The new MCC may be different than what was requested in MCC_UPDATE_CMD. 331 * @status: see &enum iwl_mcc_update_status 332 * @mcc: the new applied MCC 333 * @cap: capabilities for all channels which matches the MCC 334 * @source_id: the MCC source, see iwl_mcc_source 335 * @time: time elapsed from the MCC test start (in 30 seconds TU) 336 * @geo_info: geographic specific profile information 337 * see &enum iwl_geo_information. 338 * @n_channels: number of channels in @channels_data (may be 14, 39, 50 or 51 339 * channels, depending on platform) 340 * @channels: channel control data map, DWORD for each channel. Only the first 341 * 16bits are used. 342 */ 343 struct iwl_mcc_update_resp { 344 __le32 status; 345 __le16 mcc; 346 u8 cap; 347 u8 source_id; 348 __le16 time; 349 __le16 geo_info; 350 __le32 n_channels; 351 __le32 channels[0]; 352 } __packed; /* LAR_UPDATE_MCC_CMD_RESP_S_VER_3 */ 353 354 /** 355 * struct iwl_mcc_chub_notif - chub notifies of mcc change 356 * (MCC_CHUB_UPDATE_CMD = 0xc9) 357 * The Chub (Communication Hub, CommsHUB) is a HW component that connects to 358 * the cellular and connectivity cores that gets updates of the mcc, and 359 * notifies the ucode directly of any mcc change. 360 * The ucode requests the driver to request the device to update geographic 361 * regulatory profile according to the given MCC (Mobile Country Code). 362 * The MCC is two letter-code, ascii upper case[A-Z] or '00' for world domain. 363 * 'ZZ' MCC will be used to switch to NVM default profile; in this case, the 364 * MCC in the cmd response will be the relevant MCC in the NVM. 365 * @mcc: given mobile country code 366 * @source_id: identity of the change originator, see iwl_mcc_source 367 * @reserved1: reserved for alignment 368 */ 369 struct iwl_mcc_chub_notif { 370 __le16 mcc; 371 u8 source_id; 372 u8 reserved1; 373 } __packed; /* LAR_MCC_NOTIFY_S */ 374 375 enum iwl_mcc_update_status { 376 MCC_RESP_NEW_CHAN_PROFILE, 377 MCC_RESP_SAME_CHAN_PROFILE, 378 MCC_RESP_INVALID, 379 MCC_RESP_NVM_DISABLED, 380 MCC_RESP_ILLEGAL, 381 MCC_RESP_LOW_PRIORITY, 382 MCC_RESP_TEST_MODE_ACTIVE, 383 MCC_RESP_TEST_MODE_NOT_ACTIVE, 384 MCC_RESP_TEST_MODE_DENIAL_OF_SERVICE, 385 }; 386 387 enum iwl_mcc_source { 388 MCC_SOURCE_OLD_FW = 0, 389 MCC_SOURCE_ME = 1, 390 MCC_SOURCE_BIOS = 2, 391 MCC_SOURCE_3G_LTE_HOST = 3, 392 MCC_SOURCE_3G_LTE_DEVICE = 4, 393 MCC_SOURCE_WIFI = 5, 394 MCC_SOURCE_RESERVED = 6, 395 MCC_SOURCE_DEFAULT = 7, 396 MCC_SOURCE_UNINITIALIZED = 8, 397 MCC_SOURCE_MCC_API = 9, 398 MCC_SOURCE_GET_CURRENT = 0x10, 399 MCC_SOURCE_GETTING_MCC_TEST_MODE = 0x11, 400 }; 401 402 #endif /* __iwl_fw_api_nvm_reg_h__ */ 403