if_wivar.h

一个学习SNMP项目：tmoerlan.

/*
  Copyright (c) 2003, Tijmen Moerland ([e-mail])
*/

/* doxygen comments follow */
/*!	\file if_wivar.h
	\brief Header file containing wireless structures and defines
*/

/*
 * Copyright (c) 2002
 *	M Warner Losh <[e-mail]>.  All rights reserved.
 * Copyright (c) 1997, 1998, 1999
 *	Bill Paul <[e-mail]>.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. 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.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by Bill Paul.
 * 4. Neither the name of the author nor the names of any co-contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY Bill Paul 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 Bill Paul OR THE VOICES IN HIS HEAD
 * 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.
 *
 * $FreeBSD: src/sys/dev/wi/if_wivar.h,v 1.13 2002/09/29 18:40:35 imp Exp $
 */

#define WICACHE				/*!< Turn on signal strength and extended cache code */  
#define MAXWICACHE		50	/*!< Defines the maximum number of entries in both sigcache and extended cache */ 
#define MAXCACHE_TRANSFER	10	/*!< Copy only this number of cache entries in one ioctl call. This has to do with
					the maximum number of bytes that can be transferred in a single call. Actually, this value
					should be WI_MAX_DATALEN / sizeof(struct wi_sigextcache), rounded down.*/
#define EWMACONST_DEFAULT	0.125	/*!< Defines the default EWMA constant used for computing bandwidth and signal, noise, quality averages */
#define TIMEOUT_TIME_DEFAULT	300	/*!< Defines the default cache timeout, in seconds. When this interval expires, the cache entry is removed */

struct wi_counters {
	u_int32_t		wi_tx_unicast_frames;
	u_int32_t		wi_tx_multicast_frames;
	u_int32_t		wi_tx_fragments;
	u_int32_t		wi_tx_unicast_octets;
	u_int32_t		wi_tx_multicast_octets;
	u_int32_t		wi_tx_deferred_xmits;
	u_int32_t		wi_tx_single_retries;
	u_int32_t		wi_tx_multi_retries;
	u_int32_t		wi_tx_retry_limit;
	u_int32_t		wi_tx_discards;
	u_int32_t		wi_rx_unicast_frames;
	u_int32_t		wi_rx_multicast_frames;
	u_int32_t		wi_rx_fragments;
	u_int32_t		wi_rx_unicast_octets;
	u_int32_t		wi_rx_multicast_octets;
	u_int32_t		wi_rx_fcs_errors;
	u_int32_t		wi_rx_discards_nobuf;
	u_int32_t		wi_tx_discards_wrong_sa;
	u_int32_t		wi_rx_WEP_cant_decrypt;
	u_int32_t		wi_rx_msg_in_msg_frags;
	u_int32_t		wi_rx_msg_in_bad_msg_frags;
};

/*
 * Encryption controls. We can enable or disable encryption as
 * well as specify up to 4 encryption keys. We can also specify
 * which of the four keys will be used for transmit encryption.
 */
#define WI_RID_ENCRYPTION	0xFC20
#define WI_RID_AUTHTYPE		0xFC21
#define WI_RID_DEFLT_CRYPT_KEYS	0xFCB0
#define WI_RID_TX_CRYPT_KEY	0xFCB1
#define WI_RID_WEP_AVAIL	0xFD4F
#define WI_RID_P2_TX_CRYPT_KEY	0xFC23
#define WI_RID_P2_CRYPT_KEY0	0xFC24
#define WI_RID_P2_CRYPT_KEY1	0xFC25
#define WI_RID_MICROWAVE_OVEN	0xFC25
#define WI_RID_P2_CRYPT_KEY2	0xFC26
#define WI_RID_P2_CRYPT_KEY3	0xFC27
#define WI_RID_P2_ENCRYPTION	0xFC28
#define WI_RID_ROAMING_MODE	0xFC2D
#define WI_RID_CUR_TX_RATE	0xFD44 /* current TX rate */

/*!	\struct wi_key
	\brief Contains a WEP key
*/
struct wi_key {
	u_int16_t		wi_keylen;
	u_int8_t		wi_keydat[14];
};

#define WI_NLTV_KEYS 4		/*!< Number of WEP keys of a wireless interface */
/*!	\struct wi_ltv_keys
	\brief Used in ioctl calls to get the WEP keys of a wireless interface
*/
struct wi_ltv_keys {
	u_int16_t		wi_len;
	u_int16_t		wi_type;
	struct wi_key		wi_keys[WI_NLTV_KEYS];
};

/*!	\struct wi_softc
	\brief Every wi interface gets this structure. It contains all information the driver needs to work with the interface.
	\note It also contains the signal cache and extended cache

	This structure is interface specific. Only the interface it 'belongs' to uses the data.

	Added extended cache and supporting variables, see variable definitions. Since wi_sigcache and wi_sigextcache have exactly the same
	entries (same MAC address), some variables like wi_sigitems can be used for both caches.
*/
struct wi_softc	{
	struct arpcom		arpcom;
	struct ifmedia		ifmedia;
	device_t		dev;
	int			wi_unit;
	struct resource *	local;
	int					local_rid;
	struct resource *	iobase;
	int					iobase_rid;
	struct resource *	irq;
	int					irq_rid;
	struct resource *	mem;
	int					mem_rid;
	bus_space_handle_t	wi_localhandle;
	bus_space_tag_t		wi_localtag;
	bus_space_handle_t	wi_bhandle;
	bus_space_tag_t		wi_btag;
	bus_space_handle_t	wi_bmemhandle;
	bus_space_tag_t		wi_bmemtag;
	void *			wi_intrhand;
	int			sc_firmware_type;
#define WI_NOTYPE	0
#define	WI_LUCENT	1
#define	WI_INTERSIL	2
#define	WI_SYMBOL	3
	int			sc_pri_firmware_ver;	/* Primary firmware */
	int			sc_sta_firmware_ver;	/* Station firmware */
	int			sc_enabled;
	int			wi_io_addr;
	int			wi_tx_data_id;
	int			wi_tx_mgmt_id;
	int			wi_gone;
	int			wi_flags;
#define WI_FLAGS_ATTACHED		0x01
#define WI_FLAGS_INITIALIZED		0x02
#define WI_FLAGS_HAS_WEP		0x04
#define WI_FLAGS_HAS_IBSS		0x08
#define WI_FLAGS_HAS_CREATE_IBSS	0x10
#define WI_FLAGS_HAS_MOR		0x20
#define WI_FLAGS_HAS_ROAMING		0x30
#define WI_FLAGS_HAS_DIVERSITY		0x40
#define WI_FLAGS_HAS_HOSTAP		0x80
	int			wi_if_flags;
	u_int16_t		wi_procframe;
	u_int16_t		wi_ptype;
	u_int16_t		wi_portnum;
	u_int16_t		wi_max_data_len;
	u_int16_t		wi_rts_thresh;
	u_int16_t		wi_ap_density;
	u_int16_t		wi_tx_rate;
	u_int16_t		wi_create_ibss;
	u_int16_t		wi_channel;
	u_int16_t		wi_pm_enabled;
	u_int16_t		wi_mor_enabled;
	u_int16_t		wi_max_sleep;
	u_int16_t		wi_supprates;
	u_int16_t		wi_authtype;
	u_int16_t		wi_roaming;
	char			wi_node_name[32];
	char			wi_net_name[32];
	char			wi_ibss_name[32];
	u_int8_t		wi_txbuf[1596];
	u_int8_t		wi_scanbuf[1596];
	int			wi_scanbuf_len;
	struct wi_counters	wi_stats;
	int			wi_has_wep;
	int			wi_use_wep;
	int			wi_authmode;
	int			wi_tx_key;
	struct wi_ltv_keys	wi_keys;
#ifdef WICACHE
	int			wi_sigitems;	/*!< The current number of cache entries, for both wi_sigcache and wi_sigextcache */
	struct wi_sigcache	wi_sigcache[MAXWICACHE]; /*< The array of normal sigcache entries. This is where the cache is really stored. */
	struct wi_sigextcache	wi_sigextcache[MAXWICACHE];	/*< The array of extended sigcache enries. This is where the cache is really stored. */
	int			wi_nextitem;	/*!< Not sure, more or less the same as wi_sigitems */
	float			wi_ewmaconst_bw;	/*!< The EWMA constant used by this interface for bandwidth average calculation */
	float			wi_ewmaconst_snq;	/*!< The EWMA constant used by this interface for signal, noise, quality average calculation */
	u_int16_t		wi_timeout_time;	/*!< The time interval (seconds) that should pass after which a cache entry is removed */
	u_int8_t		wi_cache_init;	/*!< \brief Flag field with two defined bits
	
								bit 1: indicates whether above variables have been set to the default yet. 0 = no, 1 = yes. 
								Used in wi_init() to make sure user selected values for above variables are not overwritten by the default. 
								bit 2: indicates wheter the 'every_second' function call has already been started. We want to start
								it only once!! But wi_init() can be called many times, thus needs to keep track of this. Also used in wi_stop()
								to determine if it has been started so it can untimeout.
								*/
	struct callout_handle every_second_handle; /*! Handle to the every second function call */
#endif
	struct wihap_info	wi_hostap_info;
	u_int32_t		wi_icv;
	int			wi_icv_flag;
	int			wi_ibss_port;
	struct callout_handle	wi_stat_ch;
#if __FreeBSD_version >= 500000
	struct mtx		wi_mtx;
#endif
	int			wi_nic_type;

	int			wi_bus_type;	/* Bus attachment type */
	struct {
		u_int16_t               wi_sleep;
		u_int16_t               wi_delaysupp;
		u_int16_t               wi_txsupp;
		u_int16_t               wi_monitor;
		u_int16_t               wi_ledtest;
		u_int16_t               wi_ledtest_param0;
		u_int16_t               wi_ledtest_param1;
		u_int16_t               wi_conttx;
		u_int16_t               wi_conttx_param0;
		u_int16_t               wi_contrx;
		u_int16_t               wi_sigstate;
		u_int16_t               wi_sigstate_param0;
		u_int16_t               wi_confbits;
		u_int16_t               wi_confbits_param0;
	} wi_debug;

};

struct wi_card_ident {
	u_int16_t	card_id;
	char		*card_name;
	u_int8_t	firm_type;
};

#if __FreeBSD_version < 500000
/*
 * Various compat hacks/kludges
 */
#define le16toh(x) (x)
#define htole16(x) (x)
#define ifaddr_byindex(idx) ifnet_addrs[(idx) - 1];
#define	WI_LOCK(_sc, _s)	s = splimp()
#define	WI_UNLOCK(_sc, _s)	splx(s)
#else
#define	WI_LOCK(_sc, _s) _s = 1
#define	WI_UNLOCK(_sc, _s)
#endif

int wi_generic_attach(device_t);
int wi_generic_detach(device_t);
void wi_shutdown(device_t);
int wi_alloc(device_t, int);
void wi_free(device_t);
extern devclass_t wi_devclass;
int wi_mgmt_xmit(struct wi_softc *, caddr_t, int);
int wi_symbol_load_firm(struct wi_softc *, const void *, int, const void *, int);