[deliverable/linux.git] / drivers / net / wireless / iwlwifi / iwl-shared.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) 2007 - 2011 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 - 2011 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_shared_h__
#define __iwl_shared_h__

struct iwl_cfg;
struct iwl_bus;
struct iwl_priv;
struct iwl_sensitivity_ranges;

extern struct iwl_mod_params iwlagn_mod_params;

struct iwl_mod_params {
	int sw_crypto;		/* def: 0 = using hardware encryption */
	int num_of_queues;	/* def: HW dependent */
	int disable_11n;	/* def: 0 = 11n capabilities enabled */
	int amsdu_size_8K;	/* def: 1 = enable 8K amsdu size */
	int antenna;		/* def: 0 = both antennas (use diversity) */
	int restart_fw;		/* def: 1 = restart firmware */
	bool plcp_check;	/* def: true = enable plcp health check */
	bool ack_check;		/* def: false = disable ack health check */
	bool wd_disable;	/* def: false = enable stuck queue check */
	bool bt_coex_active;	/* def: true = enable bt coex */
	int led_mode;		/* def: 0 = system default */
	bool no_sleep_autoadjust; /* def: true = disable autoadjust */
	bool power_save;	/* def: false = disable power save */
	int power_level;	/* def: 1 = power level */
	u32 debug_level;	/* levels are IWL_DL_* */
	int ant_coupling;
	bool bt_ch_announce;
	int wanted_ucode_alternative;
};

/**
 * struct iwl_hw_params
 * @max_txq_num: Max # Tx queues supported
 * @scd_bc_tbls_size: size of scheduler byte count tables
 * @tfd_size: TFD size
 * @tx/rx_chains_num: Number of TX/RX chains
 * @valid_tx/rx_ant: usable antennas
 * @max_rxq_size: Max # Rx frames in Rx queue (must be power-of-2)
 * @max_rxq_log: Log-base-2 of max_rxq_size
 * @rx_page_order: Rx buffer page order
 * @rx_wrt_ptr_reg: FH{39}_RSCSR_CHNL0_WPTR
 * @max_stations:
 * @ht40_channel: is 40MHz width possible in band 2.4
 * BIT(IEEE80211_BAND_5GHZ) BIT(IEEE80211_BAND_5GHZ)
 * @sw_crypto: 0 for hw, 1 for sw
 * @max_xxx_size: for ucode uses
 * @ct_kill_threshold: temperature threshold
 * @beacon_time_tsf_bits: number of valid tsf bits for beacon time
 * @calib_init_cfg: setup initial calibrations for the hw
 * @calib_rt_cfg: setup runtime calibrations for the hw
 * @struct iwl_sensitivity_ranges: range of sensitivity values
 */
struct iwl_hw_params {
	u8 max_txq_num;
	u16 scd_bc_tbls_size;
	u32 tfd_size;
	u8  tx_chains_num;
	u8  rx_chains_num;
	u8  valid_tx_ant;
	u8  valid_rx_ant;
	u16 max_rxq_size;
	u16 max_rxq_log;
	u32 rx_page_order;
	u8  max_stations;
	u8  ht40_channel;
	u8  max_beacon_itrvl;	/* in 1024 ms */
	u32 max_inst_size;
	u32 max_data_size;
	u32 ct_kill_threshold; /* value in hw-dependent units */
	u32 ct_kill_exit_threshold; /* value in hw-dependent units */
				    /* for 1000, 6000 series and up */
	u16 beacon_time_tsf_bits;
	u32 calib_init_cfg;
	u32 calib_rt_cfg;
	const struct iwl_sensitivity_ranges *sens;
};

/**
 * struct iwl_shared - shared fields for all the layers of the driver
 *
 * @dbg_level_dev: dbg level set per device. Prevails on
 *	iwlagn_mod_params.debug_level if set (!= 0)
 * @cmd_queue: command queue number
 * @status: STATUS_*
 * @bus: pointer to the bus layer data
 * @priv: pointer to the upper layer data
 * @hw_params: see struct iwl_hw_params
 * @workqueue: the workqueue used by all the layers of the driver
 * @lock: protect general shared data
 * @mutex:
 */
struct iwl_shared {
#ifdef CONFIG_IWLWIFI_DEBUG
	u32 dbg_level_dev;
#endif /* CONFIG_IWLWIFI_DEBUG */

	u8 cmd_queue;
	unsigned long status;

	struct iwl_bus *bus;
	struct iwl_priv *priv;
	struct iwl_hw_params hw_params;

	struct workqueue_struct *workqueue;
	spinlock_t lock;
	struct mutex mutex;
};

/*Whatever _m is (iwl_trans, iwl_priv, iwl_bus, these macros will work */
#define priv(_m)	((_m)->shrd->priv)
#define bus(_m)		((_m)->shrd->bus)
#define hw_params(_m)	((_m)->shrd->hw_params)

#ifdef CONFIG_IWLWIFI_DEBUG
/*
 * iwl_get_debug_level: Return active debug level for device
 *
 * Using sysfs it is possible to set per device debug level. This debug
 * level will be used if set, otherwise the global debug level which can be
 * set via module parameter is used.
 */
static inline u32 iwl_get_debug_level(struct iwl_shared *shrd)
{
	if (shrd->dbg_level_dev)
		return shrd->dbg_level_dev;
	else
		return iwlagn_mod_params.debug_level;
}
#else
static inline u32 iwl_get_debug_level(struct iwl_shared *shrd)
{
	return iwlagn_mod_params.debug_level;
}
#endif

#ifdef CONFIG_PM
int iwl_suspend(struct iwl_priv *priv);
int iwl_resume(struct iwl_priv *priv);
#endif /* !CONFIG_PM */

int iwl_probe(struct iwl_bus *bus, struct iwl_cfg *cfg);
void __devexit iwl_remove(struct iwl_priv * priv);

#endif /* #__iwl_shared_h__ */
Commit	Line	Data
48f20d35 EG	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) 2007 - 2011 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 - 2011 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_shared_h__
	64	#define __iwl_shared_h__
65
66	struct iwl_cfg;
cac988a6	67	struct iwl_bus;
48f20d35	68	struct iwl_priv;
d6189124	69	struct iwl_sensitivity_ranges;
48f20d35 EG	70
	71	extern struct iwl_mod_params iwlagn_mod_params;
	72
	73	struct iwl_mod_params {
	74	int sw_crypto; /* def: 0 = using hardware encryption */
	75	int num_of_queues; /* def: HW dependent */
	76	int disable_11n; /* def: 0 = 11n capabilities enabled */
	77	int amsdu_size_8K; /* def: 1 = enable 8K amsdu size */
	78	int antenna; /* def: 0 = both antennas (use diversity) */
	79	int restart_fw; /* def: 1 = restart firmware */
	80	bool plcp_check; /* def: true = enable plcp health check */
	81	bool ack_check; /* def: false = disable ack health check */
	82	bool wd_disable; /* def: false = enable stuck queue check */
	83	bool bt_coex_active; /* def: true = enable bt coex */
	84	int led_mode; /* def: 0 = system default */
	85	bool no_sleep_autoadjust; /* def: true = disable autoadjust */
	86	bool power_save; /* def: false = disable power save */
	87	int power_level; /* def: 1 = power level */
	88	u32 debug_level; /* levels are IWL_DL_* */
	89	int ant_coupling;
	90	bool bt_ch_announce;
	91	int wanted_ucode_alternative;
	92	};
	93
d6189124 EG	94	/**
	95	* struct iwl_hw_params
	96	* @max_txq_num: Max # Tx queues supported
	97	* @scd_bc_tbls_size: size of scheduler byte count tables
	98	* @tfd_size: TFD size
	99	* @tx/rx_chains_num: Number of TX/RX chains
	100	* @valid_tx/rx_ant: usable antennas
	101	* @max_rxq_size: Max # Rx frames in Rx queue (must be power-of-2)
	102	* @max_rxq_log: Log-base-2 of max_rxq_size
	103	* @rx_page_order: Rx buffer page order
	104	* @rx_wrt_ptr_reg: FH{39}_RSCSR_CHNL0_WPTR
	105	* @max_stations:
	106	* @ht40_channel: is 40MHz width possible in band 2.4
	107	* BIT(IEEE80211_BAND_5GHZ) BIT(IEEE80211_BAND_5GHZ)
	108	* @sw_crypto: 0 for hw, 1 for sw
	109	* @max_xxx_size: for ucode uses
	110	* @ct_kill_threshold: temperature threshold
	111	* @beacon_time_tsf_bits: number of valid tsf bits for beacon time
	112	* @calib_init_cfg: setup initial calibrations for the hw
	113	* @calib_rt_cfg: setup runtime calibrations for the hw
	114	* @struct iwl_sensitivity_ranges: range of sensitivity values
	115	*/
	116	struct iwl_hw_params {
	117	u8 max_txq_num;
	118	u16 scd_bc_tbls_size;
	119	u32 tfd_size;
	120	u8 tx_chains_num;
	121	u8 rx_chains_num;
	122	u8 valid_tx_ant;
	123	u8 valid_rx_ant;
	124	u16 max_rxq_size;
	125	u16 max_rxq_log;
	126	u32 rx_page_order;
	127	u8 max_stations;
	128	u8 ht40_channel;
	129	u8 max_beacon_itrvl; /* in 1024 ms */
	130	u32 max_inst_size;
	131	u32 max_data_size;
	132	u32 ct_kill_threshold; /* value in hw-dependent units */
	133	u32 ct_kill_exit_threshold; /* value in hw-dependent units */
	134	/* for 1000, 6000 series and up */
	135	u16 beacon_time_tsf_bits;
	136	u32 calib_init_cfg;
	137	u32 calib_rt_cfg;
	138	const struct iwl_sensitivity_ranges *sens;
	139	};
	140
cac988a6 EG	141	/**
	142	* struct iwl_shared - shared fields for all the layers of the driver
	143	*
8f470ce3 EG	144	* @dbg_level_dev: dbg level set per device. Prevails on
8f470ce3 EG	145	* iwlagn_mod_params.debug_level if set (!= 0)
cefeaa5f	146	* @cmd_queue: command queue number
63013ae3	147	* @status: STATUS_*
cac988a6 EG	148	* @bus: pointer to the bus layer data
cac988a6 EG	149	* @priv: pointer to the upper layer data
d6189124	150	* @hw_params: see struct iwl_hw_params
74e28e44	151	* @workqueue: the workqueue used by all the layers of the driver
10b15e6f	152	* @lock: protect general shared data
6ac2f839	153	* @mutex:
cac988a6 EG	154	*/
cac988a6 EG	155	struct iwl_shared {
8f470ce3 EG	156	#ifdef CONFIG_IWLWIFI_DEBUG
	157	u32 dbg_level_dev;
	158	#endif /* CONFIG_IWLWIFI_DEBUG */
	159
cefeaa5f	160	u8 cmd_queue;
63013ae3	161	unsigned long status;
cefeaa5f	162
cac988a6 EG	163	struct iwl_bus *bus;
cac988a6 EG	164	struct iwl_priv *priv;
d6189124	165	struct iwl_hw_params hw_params;
74e28e44 EG	166
74e28e44 EG	167	struct workqueue_struct *workqueue;
10b15e6f	168	spinlock_t lock;
6ac2f839	169	struct mutex mutex;
cac988a6 EG	170	};
	171
	172	/Whatever _m is (iwl_trans, iwl_priv, iwl_bus, these macros will work /
	173	#define priv(_m) ((_m)->shrd->priv)
	174	#define bus(_m) ((_m)->shrd->bus)
d6189124	175	#define hw_params(_m) ((_m)->shrd->hw_params)
cac988a6	176
8f470ce3 EG	177	#ifdef CONFIG_IWLWIFI_DEBUG
	178	/*
	179	* iwl_get_debug_level: Return active debug level for device
	180	*
	181	* Using sysfs it is possible to set per device debug level. This debug
	182	* level will be used if set, otherwise the global debug level which can be
	183	* set via module parameter is used.
	184	*/
	185	static inline u32 iwl_get_debug_level(struct iwl_shared *shrd)
	186	{
	187	if (shrd->dbg_level_dev)
	188	return shrd->dbg_level_dev;
	189	else
	190	return iwlagn_mod_params.debug_level;
	191	}
	192	#else
	193	static inline u32 iwl_get_debug_level(struct iwl_shared *shrd)
	194	{
	195	return iwlagn_mod_params.debug_level;
	196	}
	197	#endif
	198
48f20d35 EG	199	#ifdef CONFIG_PM
	200	int iwl_suspend(struct iwl_priv *priv);
	201	int iwl_resume(struct iwl_priv *priv);
	202	#endif /* !CONFIG_PM */
	203
	204	int iwl_probe(struct iwl_bus bus, struct iwl_cfg cfg);
	205	void __devexit iwl_remove(struct iwl_priv * priv);
	206
	207	#endif /* #__iwl_shared_h__ */