1 /*
2  * Copyright (c) 2010 Broadcom Corporation
3  *
4  * Permission to use, copy, modify, and/or distribute this software for any
5  * purpose with or without fee is hereby granted, provided that the above
6  * copyright notice and this permission notice appear in all copies.
7  *
8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
11  * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
13  * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
14  * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15  */
16 
17 #ifndef _BRCM_SCB_H_
18 #define _BRCM_SCB_H_
19 
20 #include <linux/if_ether.h>
21 #include <brcmu_utils.h>
22 #include <defs.h>
23 #include "types.h"
24 
25 #define AMPDU_TX_BA_MAX_WSIZE	64	/* max Tx ba window size (in pdu) */
26 
27 #define AMPDU_MAX_SCB_TID	NUMPRIO
28 
29 /* scb flags */
30 #define SCB_WMECAP		0x0040
31 #define SCB_HTCAP		0x10000	/* HT (MIMO) capable device */
32 #define SCB_IS40		0x80000	/* 40MHz capable */
33 #define SCB_STBCCAP		0x40000000	/* STBC Capable */
34 
35 #define SCB_MAGIC	0xbeefcafe
36 
37 /* structure to store per-tid state for the ampdu initiator */
38 struct scb_ampdu_tid_ini {
39 	u8 tid;		  /* initiator tid for easy lookup */
40 	/* tx retry count; indexed by seq modulo */
41 	u8 txretry[AMPDU_TX_BA_MAX_WSIZE];
42 	struct scb *scb;  /* backptr for easy lookup */
43 	u8 ba_wsize;	  /* negotiated ba window size (in pdu) */
44 };
45 
46 struct scb_ampdu {
47 	struct scb *scb;	/* back pointer for easy reference */
48 	u8 mpdu_density;	/* mpdu density */
49 	u8 max_pdu;		/* max pdus allowed in ampdu */
50 	u8 release;		/* # of mpdus released at a time */
51 	u16 min_len;		/* min mpdu len to support the density */
52 	u32 max_rx_ampdu_bytes;	/* max ampdu rcv length; 8k, 16k, 32k, 64k */
53 
54 	/*
55 	 * This could easily be a ini[] pointer and we keep this info in wl
56 	 * itself instead of having mac80211 hold it for us. Also could be made
57 	 * dynamic per tid instead of static.
58 	 */
59 	/* initiator info - per tid (NUMPRIO): */
60 	struct scb_ampdu_tid_ini ini[AMPDU_MAX_SCB_TID];
61 };
62 
63 /* station control block - one per remote MAC address */
64 struct scb {
65 	u32 magic;
66 	u32 flags;	/* various bit flags as defined below */
67 	u32 flags2;	/* various bit flags2 as defined below */
68 	u8 state;	/* current state bitfield of auth/assoc process */
69 	u8 ea[ETH_ALEN];	/* station address */
70 	uint fragresid[NUMPRIO];/* #bytes unused in frag buffer per prio */
71 
72 	u16 seqctl[NUMPRIO];	/* seqctl of last received frame (for dups) */
73 	/* seqctl of last received frame (for dups) for non-QoS data and
74 	 * management */
75 	u16 seqctl_nonqos;
76 	u16 seqnum[NUMPRIO];/* WME: driver maintained sw seqnum per priority */
77 
78 	struct scb_ampdu scb_ampdu;	/* AMPDU state including per tid info */
79 };
80 
81 #endif				/* _BRCM_SCB_H_ */
82