[deliverable/linux.git] / drivers / net / wireless / iwlwifi / iwl-core.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 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:
 * Tomas Winkler <tomas.winkler@intel.com>
 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
 *
 * BSD LICENSE
 *
 * Copyright(c) 2005 - 2008 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_core_h__
#define __iwl_core_h__

/************************
 * forward declarations *
 ************************/
struct iwl_host_cmd;
struct iwl_cmd;


#define IWLWIFI_VERSION "1.2.26k"
#define DRV_COPYRIGHT	"Copyright(c) 2003-2008 Intel Corporation"

#define IWL_PCI_DEVICE(dev, subdev, cfg) \
	.vendor = PCI_VENDOR_ID_INTEL,  .device = (dev), \
	.subvendor = PCI_ANY_ID, .subdevice = (subdev), \
	.driver_data = (kernel_ulong_t)&(cfg)

#define IWL_SKU_G       0x1
#define IWL_SKU_A       0x2
#define IWL_SKU_N       0x8

struct iwl_hcmd_ops {
};
struct iwl_hcmd_utils_ops {
	int (*enqueue_hcmd)(struct iwl_priv *priv, struct iwl_host_cmd *cmd);
};

struct iwl_lib_ops {
	/* iwlwifi driver (priv) init */
	int (*init_drv)(struct iwl_priv *priv);
	/* set hw dependant perameters */
	int (*set_hw_params)(struct iwl_priv *priv);

	void (*txq_update_byte_cnt_tbl)(struct iwl_priv *priv,
					struct iwl4965_tx_queue *txq,
					u16 byte_cnt);
	/* nic init */
	int (*hw_nic_init)(struct iwl_priv *priv);
	/* alive notification */
	int (*alive_notify)(struct iwl_priv *priv);
	/* check validity of rtc data address */
	int (*is_valid_rtc_data_addr)(u32 addr);
	/* 1st ucode load */
	int (*load_ucode)(struct iwl_priv *priv);
	/* rfkill */
	void (*radio_kill_sw)(struct iwl_priv *priv, int disable_radio);
	/* eeprom operations (as defined in iwl-eeprom.h) */
	struct iwl_eeprom_ops eeprom_ops;
};

struct iwl_ops {
	const struct iwl_lib_ops *lib;
	const struct iwl_hcmd_ops *hcmd;
	const struct iwl_hcmd_utils_ops *utils;
};

struct iwl_mod_params {
	int disable;		/* def: 0 = enable radio */
	int hw_crypto;		/* def: 0 = using software encryption */
	int debug;		/* def: 0 = minimal debug log messages */
	int disable_hw_scan;	/* def: 0 = use h/w scan */
	int num_of_queues;	/* def: HW dependent */
	int enable_qos;		/* def: 1 = use quality of service */
	int amsdu_size_8K;	/* def: 1 = enable 8K amsdu size */
	int antenna;  		/* def: 0 = both antennas (use diversity) */
};

struct iwl_cfg {
	const char *name;
	const char *fw_name;
	unsigned int sku;
	const struct iwl_ops *ops;
	const struct iwl_mod_params *mod_params;
};

/***************************
 *   L i b                 *
 ***************************/

struct ieee80211_hw *iwl_alloc_all(struct iwl_cfg *cfg,
		struct ieee80211_ops *hw_ops);

void iwlcore_clear_stations_table(struct iwl_priv *priv);
void iwlcore_reset_qos(struct iwl_priv *priv);
int iwlcore_set_rxon_channel(struct iwl_priv *priv,
				enum ieee80211_band band,
				u16 channel);

int iwl_setup(struct iwl_priv *priv);

/*****************************************************
 *   S e n d i n g     H o s t     C o m m a n d s   *
 *****************************************************/

const char *get_cmd_string(u8 cmd);
int __must_check iwl_send_cmd_sync(struct iwl_priv *priv,
				   struct iwl_host_cmd *cmd);
int iwl_send_cmd(struct iwl_priv *priv, struct iwl_host_cmd *cmd);
int __must_check iwl_send_cmd_pdu(struct iwl_priv *priv, u8 id,
				  u16 len, const void *data);
int iwl_send_cmd_pdu_async(struct iwl_priv *priv, u8 id, u16 len,
			   const void *data,
			   int (*callback)(struct iwl_priv *priv,
					   struct iwl_cmd *cmd,
					   struct sk_buff *skb));
/*************** DRIVER STATUS FUNCTIONS   *****/

#define STATUS_HCMD_ACTIVE	0	/* host command in progress */
#define STATUS_HCMD_SYNC_ACTIVE	1	/* sync host command in progress */
#define STATUS_INT_ENABLED	2
#define STATUS_RF_KILL_HW	3
#define STATUS_RF_KILL_SW	4
#define STATUS_INIT		5
#define STATUS_ALIVE		6
#define STATUS_READY		7
#define STATUS_TEMPERATURE	8
#define STATUS_GEO_CONFIGURED	9
#define STATUS_EXIT_PENDING	10
#define STATUS_IN_SUSPEND	11
#define STATUS_STATISTICS	12
#define STATUS_SCANNING		13
#define STATUS_SCAN_ABORTING	14
#define STATUS_SCAN_HW		15
#define STATUS_POWER_PMI	16
#define STATUS_FW_ERROR		17
#define STATUS_CONF_PENDING	18


static inline int iwl_is_ready(struct iwl_priv *priv)
{
	/* The adapter is 'ready' if READY and GEO_CONFIGURED bits are
	 * set but EXIT_PENDING is not */
	return test_bit(STATUS_READY, &priv->status) &&
	       test_bit(STATUS_GEO_CONFIGURED, &priv->status) &&
	       !test_bit(STATUS_EXIT_PENDING, &priv->status);
}

static inline int iwl_is_alive(struct iwl_priv *priv)
{
	return test_bit(STATUS_ALIVE, &priv->status);
}

static inline int iwl_is_init(struct iwl_priv *priv)
{
	return test_bit(STATUS_INIT, &priv->status);
}

static inline int iwl_is_rfkill(struct iwl_priv *priv)
{
	return test_bit(STATUS_RF_KILL_HW, &priv->status) ||
	       test_bit(STATUS_RF_KILL_SW, &priv->status);
}

static inline int iwl_is_ready_rf(struct iwl_priv *priv)
{

	if (iwl_is_rfkill(priv))
		return 0;

	return iwl_is_ready(priv);
}


enum iwlcore_card_notify {
	IWLCORE_INIT_EVT = 0,
	IWLCORE_START_EVT = 1,
	IWLCORE_STOP_EVT = 2,
	IWLCORE_REMOVE_EVT = 3,
};

int iwlcore_low_level_notify(struct iwl_priv *priv,
			     enum iwlcore_card_notify notify);
extern int iwl_send_statistics_request(struct iwl_priv *priv, u8 flags);
int iwl_send_lq_cmd(struct iwl_priv *priv,
		    struct iwl_link_quality_cmd *lq, u8 flags);
#endif /* __iwl_core_h__ */
Commit	Line	Data
82b9a121 TW	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 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	* Tomas Winkler <tomas.winkler@intel.com>
	29	* Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
	30	*
	31	* BSD LICENSE
	32	*
	33	* Copyright(c) 2005 - 2008 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_core_h__
	64	#define __iwl_core_h__
65
857485c0 TW	66	/************************
	67	* forward declarations *
	68	************************/
	69	struct iwl_host_cmd;
	70	struct iwl_cmd;
	71
	72
df48c323 TW	73	#define IWLWIFI_VERSION "1.2.26k"
	74	#define DRV_COPYRIGHT "Copyright(c) 2003-2008 Intel Corporation"
	75
82b9a121 TW	76	#define IWL_PCI_DEVICE(dev, subdev, cfg) \
	77	.vendor = PCI_VENDOR_ID_INTEL, .device = (dev), \
	78	.subvendor = PCI_ANY_ID, .subdevice = (subdev), \
	79	.driver_data = (kernel_ulong_t)&(cfg)
	80
	81	#define IWL_SKU_G 0x1
	82	#define IWL_SKU_A 0x2
	83	#define IWL_SKU_N 0x8
	84
3c424c28 TW	85	struct iwl_hcmd_ops {
3c424c28 TW	86	};
857485c0 TW	87	struct iwl_hcmd_utils_ops {
	88	int (enqueue_hcmd)(struct iwl_priv priv, struct iwl_host_cmd *cmd);
	89	};
	90
6bc913bd	91	struct iwl_lib_ops {
bf85ea4f AK	92	/* iwlwifi driver (priv) init */
bf85ea4f AK	93	int (init_drv)(struct iwl_priv priv);
5425e490 TW	94	/* set hw dependant perameters */
5425e490 TW	95	int (set_hw_params)(struct iwl_priv priv);
e2a722eb TW	96
	97	void (txq_update_byte_cnt_tbl)(struct iwl_priv priv,
	98	struct iwl4965_tx_queue *txq,
	99	u16 byte_cnt);
57aab75a TW	100	/* nic init */
	101	int (hw_nic_init)(struct iwl_priv priv);
	102	/* alive notification */
	103	int (alive_notify)(struct iwl_priv priv);
	104	/* check validity of rtc data address */
	105	int (*is_valid_rtc_data_addr)(u32 addr);
	106	/* 1st ucode load */
	107	int (load_ucode)(struct iwl_priv priv);
	108	/* rfkill */
	109	void (radio_kill_sw)(struct iwl_priv priv, int disable_radio);
6bc913bd AK	110	/* eeprom operations (as defined in iwl-eeprom.h) */
	111	struct iwl_eeprom_ops eeprom_ops;
	112	};
	113
	114	struct iwl_ops {
	115	const struct iwl_lib_ops *lib;
3c424c28	116	const struct iwl_hcmd_ops *hcmd;
857485c0	117	const struct iwl_hcmd_utils_ops *utils;
6bc913bd AK	118	};
6bc913bd AK	119
00acbc91 AK	120	struct iwl_mod_params {
	121	int disable; /* def: 0 = enable radio */
	122	int hw_crypto; /* def: 0 = using software encryption */
	123	int debug; /* def: 0 = minimal debug log messages */
	124	int disable_hw_scan; /* def: 0 = use h/w scan */
	125	int num_of_queues; /* def: HW dependent */
	126	int enable_qos; /* def: 1 = use quality of service */
	127	int amsdu_size_8K; /* def: 1 = enable 8K amsdu size */
	128	int antenna; /* def: 0 = both antennas (use diversity) */
	129	};
	130
82b9a121 TW	131	struct iwl_cfg {
	132	const char *name;
	133	const char *fw_name;
	134	unsigned int sku;
6bc913bd	135	const struct iwl_ops *ops;
00acbc91	136	const struct iwl_mod_params *mod_params;
82b9a121 TW	137	};
82b9a121 TW	138
1d0a082d AK	139	/***************************
	140	* L i b *
	141	***************************/
	142
	143	struct ieee80211_hw iwl_alloc_all(struct iwl_cfg cfg,
	144	struct ieee80211_ops *hw_ops);
	145
bf85ea4f AK	146	void iwlcore_clear_stations_table(struct iwl_priv *priv);
	147	void iwlcore_reset_qos(struct iwl_priv *priv);
	148	int iwlcore_set_rxon_channel(struct iwl_priv *priv,
	149	enum ieee80211_band band,
	150	u16 channel);
	151
	152	int iwl_setup(struct iwl_priv *priv);
	153
857485c0 TW	154	/*****************************************************
	155	* S e n d i n g H o s t C o m m a n d s *
	156	*****************************************************/
	157
	158	const char *get_cmd_string(u8 cmd);
e5472978 TW	159	int __must_check iwl_send_cmd_sync(struct iwl_priv *priv,
e5472978 TW	160	struct iwl_host_cmd *cmd);
857485c0	161	int iwl_send_cmd(struct iwl_priv priv, struct iwl_host_cmd cmd);
e5472978 TW	162	int __must_check iwl_send_cmd_pdu(struct iwl_priv *priv, u8 id,
e5472978 TW	163	u16 len, const void *data);
857485c0 TW	164	int iwl_send_cmd_pdu_async(struct iwl_priv *priv, u8 id, u16 len,
	165	const void *data,
	166	int (callback)(struct iwl_priv priv,
	167	struct iwl_cmd *cmd,
	168	struct sk_buff *skb));
fee1247a TW	169	/************* DRIVER STATUS FUNCTIONS ***/
	170
	171	#define STATUS_HCMD_ACTIVE 0 /* host command in progress */
	172	#define STATUS_HCMD_SYNC_ACTIVE 1 /* sync host command in progress */
	173	#define STATUS_INT_ENABLED 2
	174	#define STATUS_RF_KILL_HW 3
	175	#define STATUS_RF_KILL_SW 4
	176	#define STATUS_INIT 5
	177	#define STATUS_ALIVE 6
	178	#define STATUS_READY 7
	179	#define STATUS_TEMPERATURE 8
	180	#define STATUS_GEO_CONFIGURED 9
	181	#define STATUS_EXIT_PENDING 10
	182	#define STATUS_IN_SUSPEND 11
	183	#define STATUS_STATISTICS 12
	184	#define STATUS_SCANNING 13
	185	#define STATUS_SCAN_ABORTING 14
	186	#define STATUS_SCAN_HW 15
	187	#define STATUS_POWER_PMI 16
	188	#define STATUS_FW_ERROR 17
	189	#define STATUS_CONF_PENDING 18
	190
	191
	192	static inline int iwl_is_ready(struct iwl_priv *priv)
	193	{
	194	/* The adapter is 'ready' if READY and GEO_CONFIGURED bits are
	195	* set but EXIT_PENDING is not */
	196	return test_bit(STATUS_READY, &priv->status) &&
	197	test_bit(STATUS_GEO_CONFIGURED, &priv->status) &&
	198	!test_bit(STATUS_EXIT_PENDING, &priv->status);
	199	}
	200
	201	static inline int iwl_is_alive(struct iwl_priv *priv)
	202	{
	203	return test_bit(STATUS_ALIVE, &priv->status);
	204	}
	205
	206	static inline int iwl_is_init(struct iwl_priv *priv)
	207	{
	208	return test_bit(STATUS_INIT, &priv->status);
	209	}
	210
	211	static inline int iwl_is_rfkill(struct iwl_priv *priv)
	212	{
	213	return test_bit(STATUS_RF_KILL_HW, &priv->status) \|\|
	214	test_bit(STATUS_RF_KILL_SW, &priv->status);
	215	}
	216
	217	static inline int iwl_is_ready_rf(struct iwl_priv *priv)
	218	{
	219
	220	if (iwl_is_rfkill(priv))
	221	return 0;
	222
	223	return iwl_is_ready(priv);
	224	}
	225
857485c0	226
c8381fdc MA	227	enum iwlcore_card_notify {
	228	IWLCORE_INIT_EVT = 0,
	229	IWLCORE_START_EVT = 1,
	230	IWLCORE_STOP_EVT = 2,
	231	IWLCORE_REMOVE_EVT = 3,
	232	};
	233
	234	int iwlcore_low_level_notify(struct iwl_priv *priv,
	235	enum iwlcore_card_notify notify);
49ea8596	236	extern int iwl_send_statistics_request(struct iwl_priv *priv, u8 flags);
66c73db7 TW	237	int iwl_send_lq_cmd(struct iwl_priv *priv,
66c73db7 TW	238	struct iwl_link_quality_cmd *lq, u8 flags);
82b9a121	239	#endif /* __iwl_core_h__ */