am930llc.h

Linux Wireless LAN Project 的目标是开发一个完整的

/* am930llc.c: Handles the Linux network interface
*	--------------------------------------------------------------------
*
*   Linux WLAN 
*
*   The contents of this file are subject to the Mozilla Public
*   License Version 1.0 (the "License"); you may not use this file
*   except in compliance with the License. You may obtain a copy of
*   the License at http://www.mozilla.org/MPL/
*
*   Software distributed under the License is distributed on an "AS
*   IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
*   implied. See the License for the specific language governing
*   rights and limitations under the License.
*
*   The initial developer of the original code is Mark S. Mathews
*   <[e-mail]>.  Portions created by Mark S. Mathews
*   are Copyright (C) 1998 AbsoluteValue Software, Inc.  All Rights Reserved.
*
*	--------------------------------------------------------------------
*/

#ifndef _LINUX_AM930LLC_H
#define _LINUX_AM930LLC_H

/*=============================================================*/
/*--- Constants -----------------------------------------------*/
/*=============================================================*/

#define WLAN_ETHADDR_LEN		6
#define WLAN_IEEE_OUI_LEN		3

#define WLAN_ETHCONV_ENCAP		1
#define WLAN_ETHCONV_RFC1042	2
#define WLAN_ETHCONV_8021h		3

#define WLAN_MIN_ETHFRM_LEN		60
#define WLAN_MAX_ETHFRM_LEN		1518
#define WLAN_ETHHDR_LEN			16

/*=============================================================*/
/*--- Macros  -------------------------------------------------*/
/*=============================================================*/

#define V2P(x) ((devpriv_t*)(x))

/*=============================================================*/
/*--- Types ---------------------------------------------------*/
/*=============================================================*/

#if LINUX_VERSION_CODE < 0x2030e
typedef struct device device_t;   /* see linux/netdevice.h */
#else
typedef struct net_device device_t;   /* see linux/netdevice.h */
#endif

/* buffer free method pointer type */
typedef void (* freebuf_method_t)(void *buf, int size);

/* local ether header type */
typedef struct wlan_ethhdr
{
	UINT8	daddr[WLAN_ETHADDR_LEN]		__WLAN_ATTRIB_PACK__;
	UINT8	saddr[WLAN_ETHADDR_LEN]		__WLAN_ATTRIB_PACK__;
	UINT16	type						__WLAN_ATTRIB_PACK__;
} wlan_ethhdr_t;

/* local llc header type */
typedef struct wlan_llc
{
	UINT8	dsap						__WLAN_ATTRIB_PACK__;
	UINT8	ssap						__WLAN_ATTRIB_PACK__;
	UINT8	ctl							__WLAN_ATTRIB_PACK__;
} wlan_llc_t;

/* local snap header type */
typedef struct wlan_snap
{
	UINT8	oui[WLAN_IEEE_OUI_LEN]		__WLAN_ATTRIB_PACK__;
	UINT16	type						__WLAN_ATTRIB_PACK__;
} wlan_snap_t;

/*-------------------------------------------------------------
*	NOTE: 
*	TX wlan_pb_t containing ethfrm from OS:
*		ethhostbuf		Points to a host OS TX buffer _structure_ 
*						(if it has one)	on hosts that use a raw byte 
*						array for their pkt	buffers, this and ethbuf 
*						will be the same.
*		ethbuf			Points to the raw byte array containing the
*						pkt to be transmitted.  May be longer than the
*						pkt itself.
*		ethbuflen 		The size of the raw byte array containing the pkt.
*		ethfrmlen		The size of the pkt in ethbuf.
*		eth_hdr			Points at the ethhdr in ethbuf
*		eth_llc			not used
*		eth_snap		not used
*		eth_payload		not used
*		eth_payloadlen	not used
*		
*		p80211hostbuf	Points to a host OS TX buffer _structure_
*						(if it has one).  On hosts that use a raw byte
*						array for pkt buffers, this and p80211buf
*						will be the same.
*		p80211buf		Points to the raw byte array containing the 
*						802.11 header and any additional llc/snap
*						headers required as a result of conversion.
*		p80211buflen	The size of the raw byte array containing the 802.11
*						header [+ llc [+ snap]].
*		p80211frmlen	The size of the 802.11 header [+ llc [+ snap]].
*		p80211_hdr		Points at the 802.11 header in p80211buf.
*		p80211_llc		Points at the llc header in p80211buf, if present.  
*						NULL otherwise.
*		p80211_snap		Points at the snap header in p80211buf, if present. 
*						NULL otherwise.
*		p80211_payload	Points at the portion of the ethbuf that we're
*						making the payload (after llc and snap) of 
*						the 802.11 frame.
*		p80211_payloadlen	Contains the size of the payload data we're
*						grabbing from the ethbuf.
*
*			mac and hw will apply these rules to access the bytes of the 
*			complete 802.11 frame.  mac uses them when fragmentation or 
*			encryption is required.  hw uses them when passing a frame
*			down to the card itself.
*
*	TX wlan_pb_t from within the driver (AP forwards or mgmt frames):
*		ethhostbuf		not used
*		ethbuf			not used
*		ethbuflen 		not used
*		ethfrmlen		not used
*		eth_hdr			not used
*		eth_llc			not used
*		eth_snap		not used
*		eth_payload		not used
*		eth_payloadlen	not used
*		
*		p80211hostbuf	Points to a host OS TX buffer _structure_
*						(if it has one).  On hosts that use a raw byte
*						array for pkt buffers, this and p80211buf
*						will be the same.
*		p80211buf		Points to the raw byte array containing the 
*						received 802.11 frame.
*		p80211buflen	The size of the raw byte array containing the 802.11
*						frame.
*		p80211frmlen	The size of the 802.11 frame.
*		p80211_hdr		Points at the 802.11 header in p80211buf.
*		p80211_llc		not used
*		p80211_snap		not used
*		p80211_payload	Points at the first byte after the 802.11 mac
*						header in p80211buf
*		p80211_payloadlen	Contains the size of the payload data in the 
*						802.11 frame.  Does NOT include the wep IV, wep ICV,
*						or FCS.
*
*	RX wlan_pb_t:
*		ethhostbuf		Points to a host OS TX buffer _structure_ 
*						(if it has one)	on hosts that use a raw byte 
*						array for their pkt	buffers, this and ethbuf 
*						will be the same.
*		ethbuf			Points to the raw byte array containing the
*						pkt to be transmitted.  May be longer than the
*						pkt itself.
*		ethbuflen 		The size of the raw byte array containing the pkt.
*		ethfrmlen		The size of the pkt in ethbuf.
*		eth_hdr			Points at the ethhdr in ethbuf
*		eth_llc			Points at the location in ethbuf where an llc header 
*						might be.
*		eth_snap		Points at the location in ethbuf where a snap header
*						might  be.
*		eth_payload		Points at the first byte after the ethhdr in ethbuf.
*		
*		p80211hostbuf	Points to a host OS TX buffer _structure_
*						(if it has one).  On hosts that use a raw byte
*						array for pkt buffers, this and p80211buf
*						will be the same.
*		p80211buf		Points to the raw byte array containing the 
*						received 802.11 frame.
*		p80211buflen	The size of the raw byte array containing the 802.11
*						frame.
*		p80211frmlen	The size of the 802.11 frame.
*		p80211_hdr		Points at the 802.11 header in p80211buf.
*		p80211_llc		Points at the location in p80211buf where an llc
*						header might be.
*		p80211_snap		Points at the location in p80211buf where a snap
*						header might be.
*		p80211_payload	Points at the first byte after the 802.11 mac
*						header in p80211buf
*		p80211_payloadlen	Contains the size of the payload data in the 
*						802.11 frame.  Does NOT include the wep IV, wep ICV,
*						or FCS.
*
*	NOTES:
*		-	The two TX types are distiguished by the value of the
*			ethhostbuf member.  Internal TX pb's will set ethhostbuf
*			to NULL.
*		-	The iscrypt field indicates the encryption status of a
*			802.11 frame in a pb.  If a frame is received encrypted
*			iscrypt should remain true until the frame is decrypted.
*			If an outgoing frame is being encrypted, iscrypt should
*			be set after the encryption is complete.  The ISWEP bit
*			of the frame header should mirror the value of iscrypt.
*		-	The wep_iv and wep_icv fields are stored in IEEE byte
*			order (little endian).
*		-	The free methods are ptrs to functions that will deal
*			with the deallocation of the ethhostbuf and p80211hostbuf.
*			They are called by the pbfree function.
-------------------------------------------------------------*/

typedef struct wlan_pb
{
	freebuf_method_t	ethfree;
	void				*ethhostbuf;		
	UINT8				*ethbuf;
	UINT				ethbuflen;
	UINT				ethfrmlen;
	wlan_ethhdr_t		*eth_hdr;
	wlan_llc_t			*eth_llc;
	wlan_snap_t			*eth_snap;
	UINT8				*eth_payload;
	UINT				eth_payloadlen;

	freebuf_method_t	p80211free;
	void				*p80211hostbuf;
	UINT8				*p80211buf;
	UINT				p80211buflen;
	UINT				p80211frmlen;
	p80211_hdr_t		*p80211_hdr;
	wlan_llc_t			*p80211_llc;
	wlan_snap_t			*p80211_snap;
	UINT8				*p80211_payload;
	UINT				p80211_payloadlen;

	UINT				wep_iscrypt;
	UINT32				wep_iv;
	UINT32				wep_icv;
} wlan_pb_t;



/*-------------------------------------------------------------
*	llc component type
-------------------------------------------------------------*/

struct am930mac;	/* predecls, gotta love circular dependencies... */
struct am930mgr;
struct am930hw;

typedef struct am930llc
{
	/* component pointers */
	struct am930mac		*mac;
	struct am930mgr		*mgr;
	device_t			*dev;

	/* Main timer, distributes ticks to the rest of the driver */
	struct timer_list	timer;

	/* ioctl cmd state */
	UINT				cmdstatus;
	UINT				cmdbusy;
	UINT				currcmd;
	struct timer_list	cmdtimer;	/* ioctl cmd timeout timer */
	struct wait_queue	*cmdwq;		/* ioctl blocking wait queue */

	/* Implementation specific config items */
	int					ethconv;
	struct sock			*nlsk;
	int					snifferpid;	/* zero indicates no sniffer */

	/* State save variables */
	void 				*saveirq_fn;

} am930llc_t;


/*=============================================================*/
/*--- Function Declarations -----------------------------------*/
/*=============================================================*/

am930llc_t *am930llc_construct(struct am930mac *mac, struct am930mgr *mgr);
void am930llc_destruct( am930llc_t *llc);

void am930llc_rxframe( am930llc_t *llc, wlan_pb_t *pb);
void am930llc_rxframe_err(am930llc_t *llc);
void am930llc_ontxcomplete( am930llc_t *llc, UINT32 txresult);
void am930llc_cmdcomplete(am930llc_t *llc, UINT status);

/* frame translation routines */
int am930llc_pb_ether_to_p80211( am930llc_t *llc, wlan_pb_t *pb);
int am930llc_pb_p80211_to_ether( am930llc_t *llc, wlan_pb_t *pb);

/* free methods for pb structure */
void am930llc_pbfreeskb(void *buf, int size);
void am930llc_pbkfree_s(void *buf, int size);

/* pb alloc and dealloc */
wlan_pb_t* am930llc_pballoc(void);
void am930llc_pbfree(wlan_pb_t* pb);
void am930llc_pballoc_p80211( wlan_pb_t* pb, UINT len);

/* 802.1h selective translation table */
int am930llc_stt_findproto(am930llc_t *llc, UINT16 proto);
int am930llc_stt_addproto(am930llc_t *llc, UINT16 proto);
int am930llc_stt_rmproto(am930llc_t *llc, UINT16 proto);

/* Sniffer functions */
void am930llc_sendtosniffer(am930llc_t *llc, struct sk_buff *skb);

#endif /* _LINUX_AM930LLC_H */