[deliverable/linux.git] / drivers / net / wireless / iwlwifi / iwl-ucode.h

/******************************************************************************
 *
 * This file is provided under a dual BSD/GPLv2 license.  When using or
 * redistributing this file, you may do so under either license.
 *
 * GPL LICENSE SUMMARY
 *
 * Copyright(c) 2008 - 2012 Intel Corporation. All rights reserved.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of version 2 of the GNU General Public License as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
 * USA
 *
 * The full GNU General Public License is included in this distribution
 * in the file called LICENSE.GPL.
 *
 * Contact Information:
 *  Intel Linux Wireless <ilw@linux.intel.com>
 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
 *
 * BSD LICENSE
 *
 * Copyright(c) 2005 - 2012 Intel Corporation. All rights reserved.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *  * Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *  * Neither the name Intel Corporation nor the names of its
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *****************************************************************************/

#ifndef __iwl_ucode_h__
#define __iwl_ucode_h__

/* v1/v2 uCode file layout */
struct iwl_ucode_header {
	__le32 ver;	/* major/minor/API/serial */
	union {
		struct {
			__le32 inst_size;	/* bytes of runtime code */
			__le32 data_size;	/* bytes of runtime data */
			__le32 init_size;	/* bytes of init code */
			__le32 init_data_size;	/* bytes of init data */
			__le32 boot_size;	/* bytes of bootstrap code */
			u8 data[0];		/* in same order as sizes */
		} v1;
		struct {
			__le32 build;		/* build number */
			__le32 inst_size;	/* bytes of runtime code */
			__le32 data_size;	/* bytes of runtime data */
			__le32 init_size;	/* bytes of init code */
			__le32 init_data_size;	/* bytes of init data */
			__le32 boot_size;	/* bytes of bootstrap code */
			u8 data[0];		/* in same order as sizes */
		} v2;
	} u;
};

/*
 * new TLV uCode file layout
 *
 * The new TLV file format contains TLVs, that each specify
 * some piece of data. To facilitate "groups", for example
 * different instruction image with different capabilities,
 * bundled with the same init image, an alternative mechanism
 * is provided:
 * When the alternative field is 0, that means that the item
 * is always valid. When it is non-zero, then it is only
 * valid in conjunction with items of the same alternative,
 * in which case the driver (user) selects one alternative
 * to use.
 */

enum iwl_ucode_tlv_type {
	IWL_UCODE_TLV_INVALID		= 0, /* unused */
	IWL_UCODE_TLV_INST		= 1,
	IWL_UCODE_TLV_DATA		= 2,
	IWL_UCODE_TLV_INIT		= 3,
	IWL_UCODE_TLV_INIT_DATA		= 4,
	IWL_UCODE_TLV_BOOT		= 5,
	IWL_UCODE_TLV_PROBE_MAX_LEN	= 6, /* a u32 value */
	IWL_UCODE_TLV_PAN		= 7,
	IWL_UCODE_TLV_RUNT_EVTLOG_PTR	= 8,
	IWL_UCODE_TLV_RUNT_EVTLOG_SIZE	= 9,
	IWL_UCODE_TLV_RUNT_ERRLOG_PTR	= 10,
	IWL_UCODE_TLV_INIT_EVTLOG_PTR	= 11,
	IWL_UCODE_TLV_INIT_EVTLOG_SIZE	= 12,
	IWL_UCODE_TLV_INIT_ERRLOG_PTR	= 13,
	IWL_UCODE_TLV_ENHANCE_SENS_TBL	= 14,
	IWL_UCODE_TLV_PHY_CALIBRATION_SIZE = 15,
	IWL_UCODE_TLV_WOWLAN_INST	= 16,
	IWL_UCODE_TLV_WOWLAN_DATA	= 17,
	IWL_UCODE_TLV_FLAGS		= 18,
};

/**
 * enum iwl_ucode_tlv_flag - ucode API flags
 * @IWL_UCODE_TLV_FLAGS_PAN: This is PAN capable microcode; this previously
 *	was a separate TLV but moved here to save space.
 * @IWL_UCODE_TLV_FLAGS_NEWSCAN: new uCode scan behaviour on hidden SSID,
 *	treats good CRC threshold as a boolean
 * @IWL_UCODE_TLV_FLAGS_MFP: This uCode image supports MFP (802.11w).
 * @IWL_UCODE_TLV_FLAGS_P2P: This uCode image supports P2P.
 */
enum iwl_ucode_tlv_flag {
	IWL_UCODE_TLV_FLAGS_PAN		= BIT(0),
	IWL_UCODE_TLV_FLAGS_NEWSCAN	= BIT(1),
	IWL_UCODE_TLV_FLAGS_MFP		= BIT(2),
	IWL_UCODE_TLV_FLAGS_P2P		= BIT(3),
};

struct iwl_ucode_tlv {
	__le16 type;		/* see above */
	__le16 alternative;	/* see comment */
	__le32 length;		/* not including type/length fields */
	u8 data[0];
};

#define IWL_TLV_UCODE_MAGIC	0x0a4c5749

struct iwl_tlv_ucode_header {
	/*
	 * The TLV style ucode header is distinguished from
	 * the v1/v2 style header by first four bytes being
	 * zero, as such is an invalid combination of
	 * major/minor/API/serial versions.
	 */
	__le32 zero;
	__le32 magic;
	u8 human_readable[64];
	__le32 ver;		/* major/minor/API/serial */
	__le32 build;
	__le64 alternatives;	/* bitmask of valid alternatives */
	/*
	 * The data contained herein has a TLV layout,
	 * see above for the TLV header and types.
	 * Note that each TLV is padded to a length
	 * that is a multiple of 4 for alignment.
	 */
	u8 data[0];
};

struct iwl_priv;

int __must_check iwl_request_firmware(struct iwl_priv *priv, bool first);

#endif  /* __iwl_ucode_h__ */
Commit	Line	Data
edf38334 DF	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) 2008 - 2012 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 LICENSE.GPL.
	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) 2005 - 2012 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	#ifndef __iwl_ucode_h__
	64	#define __iwl_ucode_h__
65
66	/* v1/v2 uCode file layout */
67	struct iwl_ucode_header {
68	__le32 ver; /* major/minor/API/serial */
69	union {
70	struct {
71	__le32 inst_size; /* bytes of runtime code */
72	__le32 data_size; /* bytes of runtime data */
73	__le32 init_size; /* bytes of init code */
74	__le32 init_data_size; /* bytes of init data */
75	__le32 boot_size; /* bytes of bootstrap code */
76	u8 data[0]; /* in same order as sizes */
77	} v1;
78	struct {
79	__le32 build; /* build number */
80	__le32 inst_size; /* bytes of runtime code */
81	__le32 data_size; /* bytes of runtime data */
82	__le32 init_size; /* bytes of init code */
83	__le32 init_data_size; /* bytes of init data */
84	__le32 boot_size; /* bytes of bootstrap code */
85	u8 data[0]; /* in same order as sizes */
86	} v2;
87	} u;
88	};
89
90	/*
91	* new TLV uCode file layout
92	*
93	* The new TLV file format contains TLVs, that each specify
94	* some piece of data. To facilitate "groups", for example
95	* different instruction image with different capabilities,
96	* bundled with the same init image, an alternative mechanism
97	* is provided:
98	* When the alternative field is 0, that means that the item
99	* is always valid. When it is non-zero, then it is only
100	* valid in conjunction with items of the same alternative,
101	* in which case the driver (user) selects one alternative
102	* to use.
103	*/
104
105	enum iwl_ucode_tlv_type {
106	IWL_UCODE_TLV_INVALID = 0, /* unused */
107	IWL_UCODE_TLV_INST = 1,
108	IWL_UCODE_TLV_DATA = 2,
109	IWL_UCODE_TLV_INIT = 3,
110	IWL_UCODE_TLV_INIT_DATA = 4,
111	IWL_UCODE_TLV_BOOT = 5,
112	IWL_UCODE_TLV_PROBE_MAX_LEN = 6, /* a u32 value */
113	IWL_UCODE_TLV_PAN = 7,
114	IWL_UCODE_TLV_RUNT_EVTLOG_PTR = 8,
115	IWL_UCODE_TLV_RUNT_EVTLOG_SIZE = 9,
116	IWL_UCODE_TLV_RUNT_ERRLOG_PTR = 10,
117	IWL_UCODE_TLV_INIT_EVTLOG_PTR = 11,
118	IWL_UCODE_TLV_INIT_EVTLOG_SIZE = 12,
119	IWL_UCODE_TLV_INIT_ERRLOG_PTR = 13,
120	IWL_UCODE_TLV_ENHANCE_SENS_TBL = 14,
121	IWL_UCODE_TLV_PHY_CALIBRATION_SIZE = 15,
122	IWL_UCODE_TLV_WOWLAN_INST = 16,
123	IWL_UCODE_TLV_WOWLAN_DATA = 17,
124	IWL_UCODE_TLV_FLAGS = 18,
125	};
126
127	/**
128	* enum iwl_ucode_tlv_flag - ucode API flags
129	* @IWL_UCODE_TLV_FLAGS_PAN: This is PAN capable microcode; this previously
130	* was a separate TLV but moved here to save space.
131	* @IWL_UCODE_TLV_FLAGS_NEWSCAN: new uCode scan behaviour on hidden SSID,
132	* treats good CRC threshold as a boolean
133	* @IWL_UCODE_TLV_FLAGS_MFP: This uCode image supports MFP (802.11w).
134	* @IWL_UCODE_TLV_FLAGS_P2P: This uCode image supports P2P.
135	*/
136	enum iwl_ucode_tlv_flag {
137	IWL_UCODE_TLV_FLAGS_PAN = BIT(0),
138	IWL_UCODE_TLV_FLAGS_NEWSCAN = BIT(1),
139	IWL_UCODE_TLV_FLAGS_MFP = BIT(2),
140	IWL_UCODE_TLV_FLAGS_P2P = BIT(3),
141	};
142
143	struct iwl_ucode_tlv {
144	__le16 type; /* see above */
145	__le16 alternative; /* see comment */
146	__le32 length; /* not including type/length fields */
147	u8 data[0];
148	};
149
150	#define IWL_TLV_UCODE_MAGIC 0x0a4c5749
151
152	struct iwl_tlv_ucode_header {
153	/*
154	* The TLV style ucode header is distinguished from
155	* the v1/v2 style header by first four bytes being
156	* zero, as such is an invalid combination of
157	* major/minor/API/serial versions.
158	*/
159	__le32 zero;
160	__le32 magic;
161	u8 human_readable[64];
162	__le32 ver; /* major/minor/API/serial */
163	__le32 build;
164	__le64 alternatives; /* bitmask of valid alternatives */
165	/*
166	* The data contained herein has a TLV layout,
167	* see above for the TLV header and types.
168	* Note that each TLV is padded to a length
169	* that is a multiple of 4 for alignment.
170	*/
171	u8 data[0];
172	};
173
174	struct iwl_priv;
175
176	int __must_check iwl_request_firmware(struct iwl_priv *priv, bool first);
177
178	#endif /* __iwl_ucode_h__ */