Merge git://git.kernel.org/pub/scm/linux/kernel/git/herbert/crypto-2.6
[deliverable/linux.git] / drivers / staging / rtl8192e / rtl819x_Qos.h
CommitLineData
94a79942
LF
1/******************************************************************************
2 * Copyright(c) 2008 - 2010 Realtek Corporation. All rights reserved.
3 *
4 * This program is distributed in the hope that it will be useful, but WITHOUT
5 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
6 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
7 * more details.
8 *
9 * You should have received a copy of the GNU General Public License along with
10 * this program; if not, write to the Free Software Foundation, Inc.,
11 * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
12 *
13 * The full GNU General Public License is included in this distribution in the
14 * file called LICENSE.
15 *
16 * Contact Information:
17 * wlanfae <wlanfae@realtek.com>
18******************************************************************************/
19#ifndef __INC_QOS_TYPE_H
20#define __INC_QOS_TYPE_H
21
22#include "rtllib_endianfree.h"
23
f88ec6cb
LF
24#define BIT0 0x00000001
25#define BIT1 0x00000002
26#define BIT2 0x00000004
27#define BIT3 0x00000008
28#define BIT4 0x00000010
29#define BIT5 0x00000020
30#define BIT6 0x00000040
31#define BIT7 0x00000080
32#define BIT8 0x00000100
33#define BIT9 0x00000200
34#define BIT10 0x00000400
35#define BIT11 0x00000800
36#define BIT12 0x00001000
37#define BIT13 0x00002000
38#define BIT14 0x00004000
39#define BIT15 0x00008000
40#define BIT16 0x00010000
41#define BIT17 0x00020000
42#define BIT18 0x00040000
43#define BIT19 0x00080000
44#define BIT20 0x00100000
45#define BIT21 0x00200000
46#define BIT22 0x00400000
47#define BIT23 0x00800000
48#define BIT24 0x01000000
49#define BIT25 0x02000000
50#define BIT26 0x04000000
51#define BIT27 0x08000000
52#define BIT28 0x10000000
53#define BIT29 0x20000000
54#define BIT30 0x40000000
55#define BIT31 0x80000000
94a79942 56
42c53e7a 57union qos_tsinfo {
94a79942
LF
58 u8 charData[3];
59 struct {
60 u8 ucTrafficType:1;
61 u8 ucTSID:4;
62 u8 ucDirection:2;
63 u8 ucAccessPolicy:2;
64 u8 ucAggregation:1;
65 u8 ucPSB:1;
66 u8 ucUP:3;
67 u8 ucTSInfoAckPolicy:2;
68 u8 ucSchedule:1;
69 u8 ucReserved:7;
f88ec6cb 70 } field;
42c53e7a
LF
71};
72
ed306e48 73union tspec_body {
94a79942
LF
74 u8 charData[55];
75
f88ec6cb 76 struct {
42c53e7a 77 union qos_tsinfo TSInfo;
94a79942
LF
78 u16 NominalMSDUsize;
79 u16 MaxMSDUsize;
80 u32 MinServiceItv;
81 u32 MaxServiceItv;
82 u32 InactivityItv;
83 u32 SuspenItv;
84 u32 ServiceStartTime;
85 u32 MinDataRate;
86 u32 MeanDataRate;
87 u32 PeakDataRate;
88 u32 MaxBurstSize;
89 u32 DelayBound;
90 u32 MinPhyRate;
91 u16 SurplusBandwidthAllowance;
92 u16 MediumTime;
93 } f;
ed306e48 94};
94a79942 95
95ce5fc9 96struct wmm_tspec {
94a79942
LF
97 u8 ID;
98 u8 Length;
99 u8 OUI[3];
100 u8 OUI_Type;
101 u8 OUI_SubType;
102 u8 Version;
ed306e48 103 union tspec_body Body;
95ce5fc9 104};
94a79942 105
8310b6c0 106struct octet_string {
f88ec6cb
LF
107 u8 *Octet;
108 u16 Length;
d3b2c172 109};
f88ec6cb 110
94a79942
LF
111#define MAX_WMMELE_LENGTH 64
112
9de9f962
LF
113#define QOS_MODE u32
114
94a79942
LF
115#define QOS_DISABLE 0
116#define QOS_WMM 1
117#define QOS_WMMSA 2
118#define QOS_EDCA 4
119#define QOS_HCCA 8
120#define QOS_WMM_UAPSD 16
121
122#define WMM_PARAM_ELE_BODY_LEN 18
123
124#define MAX_STA_TS_COUNT 16
125#define MAX_AP_TS_COUNT 32
126#define QOS_TSTREAM_KEY_SIZE 13
127
128#define WMM_ACTION_CATEGORY_CODE 17
129#define WMM_PARAM_ELE_BODY_LEN 18
130
131#define MAX_TSPEC_TSID 15
132#define SESSION_REJECT_TSID 0xfe
133#define DEFAULT_TSID 0xff
134
135#define ADDTS_TIME_SLOT 100
136
137#define ACM_TIMEOUT 1000
138#define SESSION_REJECT_TIMEOUT 60000
139
4164e4de 140enum ack_policy {
94a79942
LF
141 eAckPlc0_ACK = 0x00,
142 eAckPlc1_NoACK = 0x01,
4164e4de 143};
94a79942
LF
144
145
f88ec6cb
LF
146#define SET_WMM_QOS_INFO_FIELD(_pStart, _val) \
147 WriteEF1Byte(_pStart, _val)
94a79942 148
f88ec6cb
LF
149#define GET_WMM_QOS_INFO_FIELD_PARAMETERSET_COUNT(_pStart) \
150 LE_BITS_TO_1BYTE(_pStart, 0, 4)
151#define SET_WMM_QOS_INFO_FIELD_PARAMETERSET_COUNT(_pStart, _val) \
152 SET_BITS_TO_LE_1BYTE(_pStart, 0, 4, _val)
94a79942 153
f88ec6cb
LF
154#define GET_WMM_QOS_INFO_FIELD_AP_UAPSD(_pStart) \
155 LE_BITS_TO_1BYTE(_pStart, 7, 1)
156#define SET_WMM_QOS_INFO_FIELD_AP_UAPSD(_pStart, _val) \
157 SET_BITS_TO_LE_1BYTE(_pStart, 7, 1, _val)
94a79942 158
f88ec6cb
LF
159#define GET_WMM_QOS_INFO_FIELD_STA_AC_VO_UAPSD(_pStart) \
160 LE_BITS_TO_1BYTE(_pStart, 0, 1)
161#define SET_WMM_QOS_INFO_FIELD_STA_AC_VO_UAPSD(_pStart, _val) \
162 SET_BITS_TO_LE_1BYTE(_pStart, 0, 1, _val)
94a79942 163
f88ec6cb
LF
164#define GET_WMM_QOS_INFO_FIELD_STA_AC_VI_UAPSD(_pStart) \
165 LE_BITS_TO_1BYTE(_pStart, 1, 1)
166#define SET_WMM_QOS_INFO_FIELD_STA_AC_VI_UAPSD(_pStart, _val) \
167 SET_BITS_TO_LE_1BYTE(_pStart, 1, 1, _val)
94a79942 168
f88ec6cb
LF
169#define GET_WMM_QOS_INFO_FIELD_STA_AC_BE_UAPSD(_pStart) \
170 LE_BITS_TO_1BYTE(_pStart, 2, 1)
171#define SET_WMM_QOS_INFO_FIELD_STA_AC_BE_UAPSD(_pStart, _val) \
172 SET_BITS_TO_LE_1BYTE(_pStart, 2, 1, _val)
94a79942 173
f88ec6cb
LF
174#define GET_WMM_QOS_INFO_FIELD_STA_AC_BK_UAPSD(_pStart) \
175 LE_BITS_TO_1BYTE(_pStart, 3, 1)
176#define SET_WMM_QOS_INFO_FIELD_STA_AC_BK_UAPSD(_pStart, _val) \
177 SET_BITS_TO_LE_1BYTE(_pStart, 3, 1, _val)
94a79942 178
f88ec6cb
LF
179#define GET_WMM_QOS_INFO_FIELD_STA_MAX_SP_LEN(_pStart) \
180 LE_BITS_TO_1BYTE(_pStart, 5, 2)
181#define SET_WMM_QOS_INFO_FIELD_STA_MAX_SP_LEN(_pStart, _val) \
182 SET_BITS_TO_LE_1BYTE(_pStart, 5, 2, _val)
94a79942 183
f58a1cd9 184enum qos_ie_source {
94a79942
LF
185 QOSIE_SRC_ADDTSREQ,
186 QOSIE_SRC_ADDTSRSP,
187 QOSIE_SRC_REASOCREQ,
188 QOSIE_SRC_REASOCRSP,
189 QOSIE_SRC_DELTS,
f58a1cd9 190};
94a79942
LF
191
192
9de9f962
LF
193#define AC_CODING u32
194
94a79942
LF
195#define AC0_BE 0
196#define AC1_BK 1
197#define AC2_VI 2
198#define AC3_VO 3
199#define AC_MAX 4
200
201
202#define AC_PARAM_SIZE 4
203
f88ec6cb
LF
204#define GET_WMM_AC_PARAM_AIFSN(_pStart) \
205 ((u8)LE_BITS_TO_4BYTE(_pStart, 0, 4))
206#define SET_WMM_AC_PARAM_AIFSN(_pStart, _val) \
207 SET_BITS_TO_LE_4BYTE(_pStart, 0, 4, _val)
94a79942 208
f88ec6cb
LF
209#define GET_WMM_AC_PARAM_ACM(_pStart) \
210 ((u8)LE_BITS_TO_4BYTE(_pStart, 4, 1))
211#define SET_WMM_AC_PARAM_ACM(_pStart, _val) \
212 SET_BITS_TO_LE_4BYTE(_pStart, 4, 1, _val)
94a79942 213
f88ec6cb
LF
214#define GET_WMM_AC_PARAM_ACI(_pStart) \
215 ((u8)LE_BITS_TO_4BYTE(_pStart, 5, 2))
216#define SET_WMM_AC_PARAM_ACI(_pStart, _val) \
217 SET_BITS_TO_LE_4BYTE(_pStart, 5, 2, _val)
94a79942 218
f88ec6cb
LF
219#define GET_WMM_AC_PARAM_ACI_AIFSN(_pStart) \
220 ((u8)LE_BITS_TO_4BYTE(_pStart, 0, 8))
221#define SET_WMM_AC_PARAM_ACI_AIFSN(_pStart, _val) \
222 SET_BITS_TO_LE_4BYTE(_pStart, 0, 8, _val)
94a79942 223
f88ec6cb
LF
224#define GET_WMM_AC_PARAM_ECWMIN(_pStart) \
225 ((u8)LE_BITS_TO_4BYTE(_pStart, 8, 4))
226#define SET_WMM_AC_PARAM_ECWMIN(_pStart, _val) \
227 SET_BITS_TO_LE_4BYTE(_pStart, 8, 4, _val)
94a79942 228
f88ec6cb
LF
229#define GET_WMM_AC_PARAM_ECWMAX(_pStart) \
230 ((u8)LE_BITS_TO_4BYTE(_pStart, 12, 4))
231#define SET_WMM_AC_PARAM_ECWMAX(_pStart, _val) \
232 SET_BITS_TO_LE_4BYTE(_pStart, 12, 4, _val)
94a79942 233
f88ec6cb
LF
234#define GET_WMM_AC_PARAM_TXOP_LIMIT(_pStart) \
235 ((u8)LE_BITS_TO_4BYTE(_pStart, 16, 16))
236#define SET_WMM_AC_PARAM_TXOP_LIMIT(_pStart, _val) \
237 SET_BITS_TO_LE_4BYTE(_pStart, 16, 16, _val)
94a79942
LF
238
239
240
241#define WMM_PARAM_ELEMENT_SIZE (8+(4*AC_PARAM_SIZE))
242
f58a1cd9 243enum qos_ele_subtype {
94a79942
LF
244 QOSELE_TYPE_INFO = 0x00,
245 QOSELE_TYPE_PARAM = 0x01,
f58a1cd9 246};
94a79942
LF
247
248
f12dfcb0 249enum direction_value {
94a79942
LF
250 DIR_UP = 0,
251 DIR_DOWN = 1,
252 DIR_DIRECT = 2,
253 DIR_BI_DIR = 3,
f12dfcb0 254};
94a79942 255
379a20fb 256enum acm_method {
94a79942
LF
257 eAcmWay0_SwAndHw = 0,
258 eAcmWay1_HW = 1,
259 eAcmWay2_SW = 2,
379a20fb 260};
94a79942
LF
261
262
b0d7de73 263struct acm {
94a79942
LF
264 u64 UsedTime;
265 u64 MediumTime;
266 u8 HwAcmCtl;
d3b2c172 267};
94a79942
LF
268
269
270
9de9f962 271#define AC_UAPSD u8
94a79942
LF
272
273#define GET_VO_UAPSD(_apsd) ((_apsd) & BIT0)
274#define SET_VO_UAPSD(_apsd) ((_apsd) |= BIT0)
275
276#define GET_VI_UAPSD(_apsd) ((_apsd) & BIT1)
277#define SET_VI_UAPSD(_apsd) ((_apsd) |= BIT1)
278
279#define GET_BK_UAPSD(_apsd) ((_apsd) & BIT2)
280#define SET_BK_UAPSD(_apsd) ((_apsd) |= BIT2)
281
282#define GET_BE_UAPSD(_apsd) ((_apsd) & BIT3)
283#define SET_BE_UAPSD(_apsd) ((_apsd) |= BIT3)
284
626f951d 285union qos_tclas {
94a79942 286
f88ec6cb 287 struct _TYPE_GENERAL {
94a79942
LF
288 u8 Priority;
289 u8 ClassifierType;
290 u8 Mask;
291 } TYPE_GENERAL;
292
f88ec6cb 293 struct _TYPE0_ETH {
94a79942
LF
294 u8 Priority;
295 u8 ClassifierType;
296 u8 Mask;
297 u8 SrcAddr[6];
298 u8 DstAddr[6];
299 u16 Type;
300 } TYPE0_ETH;
301
f88ec6cb 302 struct _TYPE1_IPV4 {
94a79942
LF
303 u8 Priority;
304 u8 ClassifierType;
305 u8 Mask;
306 u8 Version;
307 u8 SrcIP[4];
308 u8 DstIP[4];
309 u16 SrcPort;
310 u16 DstPort;
311 u8 DSCP;
312 u8 Protocol;
313 u8 Reserved;
314 } TYPE1_IPV4;
315
f88ec6cb 316 struct _TYPE1_IPV6 {
94a79942
LF
317 u8 Priority;
318 u8 ClassifierType;
319 u8 Mask;
320 u8 Version;
321 u8 SrcIP[16];
322 u8 DstIP[16];
323 u16 SrcPort;
324 u16 DstPort;
325 u8 FlowLabel[3];
326 } TYPE1_IPV6;
327
f88ec6cb 328 struct _TYPE2_8021Q {
94a79942
LF
329 u8 Priority;
330 u8 ClassifierType;
331 u8 Mask;
332 u16 TagType;
333 } TYPE2_8021Q;
626f951d 334};
94a79942 335
1d2a55fb 336struct qos_tstream {
94a79942
LF
337
338 bool bUsed;
339 u16 MsduLifetime;
340 bool bEstablishing;
341 u8 TimeSlotCount;
342 u8 DialogToken;
95ce5fc9
LF
343 struct wmm_tspec TSpec;
344 struct wmm_tspec OutStandingTSpec;
94a79942 345 u8 NominalPhyRate;
1d2a55fb 346};
94a79942 347
0db42799 348struct sta_qos {
f88ec6cb
LF
349 u8 WMMIEBuf[MAX_WMMELE_LENGTH];
350 u8 *WMMIE;
94a79942 351
f88ec6cb
LF
352 QOS_MODE QosCapability;
353 QOS_MODE CurrentQosMode;
94a79942 354
f88ec6cb
LF
355 AC_UAPSD b4ac_Uapsd;
356 AC_UAPSD Curr4acUapsd;
357 u8 bInServicePeriod;
358 u8 MaxSPLength;
359 int NumBcnBeforeTrigger;
94a79942 360
f88ec6cb
LF
361 u8 *pWMMInfoEle;
362 u8 WMMParamEle[WMM_PARAM_ELEMENT_SIZE];
94a79942 363
b0d7de73 364 struct acm acm[4];
379a20fb 365 enum acm_method AcmMethod;
94a79942 366
1d2a55fb 367 struct qos_tstream StaTsArray[MAX_STA_TS_COUNT];
94a79942 368 u8 DialogToken;
95ce5fc9 369 struct wmm_tspec TSpec;
94a79942
LF
370
371 u8 QBssWirelessMode;
372
373 bool bNoAck;
374
375 bool bEnableRxImmBA;
376
d3b2c172 377};
94a79942 378
f88ec6cb
LF
379#define QBSS_LOAD_SIZE 5
380#define GET_QBSS_LOAD_STA_COUNT(__pStart) \
381 ReadEF2Byte(__pStart)
382#define SET_QBSS_LOAD_STA_COUNT(__pStart, __Value) \
383 WriteEF2Byte(__pStart, __Value)
384#define GET_QBSS_LOAD_CHNL_UTILIZATION(__pStart) \
385 ReadEF1Byte((u8 *)(__pStart) + 2)
386#define SET_QBSS_LOAD_CHNL_UTILIZATION(__pStart, __Value) \
387 WriteEF1Byte((u8 *)(__pStart) + 2, __Value)
388#define GET_QBSS_LOAD_AVAILABLE_CAPACITY(__pStart) \
389 ReadEF2Byte((u8 *)(__pStart) + 3)
390#define SET_QBSS_LOAD_AVAILABLE_CAPACITY(__pStart, __Value) \
391 WriteEF2Byte((u8 *)(__pStart) + 3, __Value)
94a79942 392
0157d2e5 393struct bss_qos {
f88ec6cb
LF
394 QOS_MODE bdQoSMode;
395 u8 bdWMMIEBuf[MAX_WMMELE_LENGTH];
8310b6c0 396 struct octet_string bdWMMIE;
94a79942 397
f58a1cd9 398 enum qos_ele_subtype EleSubType;
94a79942 399
f88ec6cb
LF
400 u8 *pWMMInfoEle;
401 u8 *pWMMParamEle;
94a79942 402
f88ec6cb
LF
403 u8 QBssLoad[QBSS_LOAD_SIZE];
404 bool bQBssLoadValid;
d3b2c172 405};
94a79942
LF
406
407#define sQoSCtlLng 2
f88ec6cb 408#define QOS_CTRL_LEN(_QosMode) ((_QosMode > QOS_DISABLE) ? sQoSCtlLng : 0)
94a79942
LF
409
410
f88ec6cb 411#define IsACValid(ac) ((ac >= 0 && ac <= 7) ? true : false)
94a79942
LF
412
413
44a40046 414union aci_aifsn {
94a79942
LF
415 u8 charData;
416
f88ec6cb 417 struct {
94a79942 418 u8 AIFSN:4;
b0d7de73 419 u8 acm:1;
94a79942
LF
420 u8 ACI:2;
421 u8 Reserved:1;
f88ec6cb 422 } f;
44a40046 423};
94a79942 424
a33be1e8 425union ecw {
94a79942 426 u8 charData;
f88ec6cb 427 struct {
94a79942
LF
428 u8 ECWmin:4;
429 u8 ECWmax:4;
f88ec6cb 430 } f;
a33be1e8 431};
94a79942 432
eb85e468 433union ac_param {
94a79942
LF
434 u32 longData;
435 u8 charData[4];
436
f88ec6cb 437 struct {
44a40046 438 union aci_aifsn AciAifsn;
a33be1e8 439 union ecw Ecw;
94a79942 440 u16 TXOPLimit;
f88ec6cb 441 } f;
eb85e468 442};
94a79942
LF
443
444#endif
This page took 0.120945 seconds and 5 git commands to generate.