1 /******************************************************************************
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.
8 * Copyright(c) 2008 - 2012 Intel Corporation. All rights reserved.
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.
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.
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,
24 * The full GNU General Public License is included in this distribution
25 * in the file called LICENSE.GPL.
27 * Contact Information:
28 * Intel Linux Wireless <ilw@linux.intel.com>
29 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
33 * Copyright(c) 2005 - 2012 Intel Corporation. All rights reserved.
34 * All rights reserved.
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions
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
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.
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 *****************************************************************************/
65 #include <linux/types.h>
68 * enum iwl_ucode_tlv_flag - ucode API flags
69 * @IWL_UCODE_TLV_FLAGS_PAN: This is PAN capable microcode; this previously
70 * was a separate TLV but moved here to save space.
71 * @IWL_UCODE_TLV_FLAGS_NEWSCAN: new uCode scan behaviour on hidden SSID,
72 * treats good CRC threshold as a boolean
73 * @IWL_UCODE_TLV_FLAGS_MFP: This uCode image supports MFP (802.11w).
74 * @IWL_UCODE_TLV_FLAGS_P2P: This uCode image supports P2P.
76 enum iwl_ucode_tlv_flag {
77 IWL_UCODE_TLV_FLAGS_PAN = BIT(0),
78 IWL_UCODE_TLV_FLAGS_NEWSCAN = BIT(1),
79 IWL_UCODE_TLV_FLAGS_MFP = BIT(2),
80 IWL_UCODE_TLV_FLAGS_P2P = BIT(3),
83 /* The default calibrate table size if not specified by firmware file */
84 #define IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE 18
85 #define IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE 19
86 #define IWL_MAX_PHY_CALIBRATE_TBL_SIZE 253
93 * @IWL_UCODE_REGULAR: Normal runtime ucode
94 * @IWL_UCODE_INIT: Initial ucode
95 * @IWL_UCODE_WOWLAN: Wake on Wireless enabled ucode
104 struct iwl_ucode_capabilities {
105 u32 max_probe_length;
106 u32 standard_phy_calibration_size;
110 /* one for each uCode image (inst/data, init/runtime/wowlan) */
112 dma_addr_t p_addr; /* hardware address */
113 void *v_addr; /* software address */
114 u32 len; /* size in bytes */
115 u32 offset; /* offset in the device */
119 struct fw_desc code; /* firmware code image */
120 struct fw_desc data; /* firmware data image */
123 /* uCode version contains 4 values: Major/Minor/API/Serial */
124 #define IWL_UCODE_MAJOR(ver) (((ver) & 0xFF000000) >> 24)
125 #define IWL_UCODE_MINOR(ver) (((ver) & 0x00FF0000) >> 16)
126 #define IWL_UCODE_API(ver) (((ver) & 0x0000FF00) >> 8)
127 #define IWL_UCODE_SERIAL(ver) ((ver) & 0x000000FF)
130 * struct iwl_fw - variables associated with the firmware
132 * @ucode_ver: ucode version from the ucode file
133 * @fw_version: firmware version string
134 * @ucode_rt: run time ucode image
135 * @ucode_init: init ucode image
136 * @ucode_wowlan: wake on wireless ucode image (optional)
137 * @ucode_capa: capabilities parsed from the ucode file.
138 * @enhance_sensitivity_table: device can do enhanced sensitivity.
139 * @init_evtlog_ptr: event log offset for init ucode.
140 * @init_evtlog_size: event log size for init ucode.
141 * @init_errlog_ptr: error log offfset for init ucode.
142 * @inst_evtlog_ptr: event log offset for runtime ucode.
143 * @inst_evtlog_size: event log size for runtime ucode.
144 * @inst_errlog_ptr: error log offfset for runtime ucode.
149 char fw_version[ETHTOOL_BUSINFO_LEN];
152 struct fw_img ucode_rt;
153 struct fw_img ucode_init;
154 struct fw_img ucode_wowlan;
156 struct iwl_ucode_capabilities ucode_capa;
157 bool enhance_sensitivity_table;
159 u32 init_evtlog_ptr, init_evtlog_size, init_errlog_ptr;
160 u32 inst_evtlog_ptr, inst_evtlog_size, inst_errlog_ptr;
162 u64 default_calib[IWL_UCODE_TYPE_MAX];
166 #endif /* __iwl_fw_h__ */