Commit | Line | Data |
---|---|---|
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 | 57 | union 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 | 73 | union 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 | 96 | struct 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 | 106 | struct 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 | 140 | enum 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 | 184 | enum 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 | ||
94a79942 LF |
204 | #define WMM_PARAM_ELEMENT_SIZE (8+(4*AC_PARAM_SIZE)) |
205 | ||
f58a1cd9 | 206 | enum qos_ele_subtype { |
94a79942 LF |
207 | QOSELE_TYPE_INFO = 0x00, |
208 | QOSELE_TYPE_PARAM = 0x01, | |
f58a1cd9 | 209 | }; |
94a79942 LF |
210 | |
211 | ||
f12dfcb0 | 212 | enum direction_value { |
94a79942 LF |
213 | DIR_UP = 0, |
214 | DIR_DOWN = 1, | |
215 | DIR_DIRECT = 2, | |
216 | DIR_BI_DIR = 3, | |
f12dfcb0 | 217 | }; |
94a79942 | 218 | |
379a20fb | 219 | enum acm_method { |
94a79942 LF |
220 | eAcmWay0_SwAndHw = 0, |
221 | eAcmWay1_HW = 1, | |
222 | eAcmWay2_SW = 2, | |
379a20fb | 223 | }; |
94a79942 LF |
224 | |
225 | ||
b0d7de73 | 226 | struct acm { |
94a79942 LF |
227 | u64 UsedTime; |
228 | u64 MediumTime; | |
229 | u8 HwAcmCtl; | |
d3b2c172 | 230 | }; |
94a79942 LF |
231 | |
232 | ||
233 | ||
9de9f962 | 234 | #define AC_UAPSD u8 |
94a79942 LF |
235 | |
236 | #define GET_VO_UAPSD(_apsd) ((_apsd) & BIT0) | |
237 | #define SET_VO_UAPSD(_apsd) ((_apsd) |= BIT0) | |
238 | ||
239 | #define GET_VI_UAPSD(_apsd) ((_apsd) & BIT1) | |
240 | #define SET_VI_UAPSD(_apsd) ((_apsd) |= BIT1) | |
241 | ||
242 | #define GET_BK_UAPSD(_apsd) ((_apsd) & BIT2) | |
243 | #define SET_BK_UAPSD(_apsd) ((_apsd) |= BIT2) | |
244 | ||
245 | #define GET_BE_UAPSD(_apsd) ((_apsd) & BIT3) | |
246 | #define SET_BE_UAPSD(_apsd) ((_apsd) |= BIT3) | |
247 | ||
626f951d | 248 | union qos_tclas { |
94a79942 | 249 | |
f88ec6cb | 250 | struct _TYPE_GENERAL { |
94a79942 LF |
251 | u8 Priority; |
252 | u8 ClassifierType; | |
253 | u8 Mask; | |
254 | } TYPE_GENERAL; | |
255 | ||
f88ec6cb | 256 | struct _TYPE0_ETH { |
94a79942 LF |
257 | u8 Priority; |
258 | u8 ClassifierType; | |
259 | u8 Mask; | |
260 | u8 SrcAddr[6]; | |
261 | u8 DstAddr[6]; | |
262 | u16 Type; | |
263 | } TYPE0_ETH; | |
264 | ||
f88ec6cb | 265 | struct _TYPE1_IPV4 { |
94a79942 LF |
266 | u8 Priority; |
267 | u8 ClassifierType; | |
268 | u8 Mask; | |
269 | u8 Version; | |
270 | u8 SrcIP[4]; | |
271 | u8 DstIP[4]; | |
272 | u16 SrcPort; | |
273 | u16 DstPort; | |
274 | u8 DSCP; | |
275 | u8 Protocol; | |
276 | u8 Reserved; | |
277 | } TYPE1_IPV4; | |
278 | ||
f88ec6cb | 279 | struct _TYPE1_IPV6 { |
94a79942 LF |
280 | u8 Priority; |
281 | u8 ClassifierType; | |
282 | u8 Mask; | |
283 | u8 Version; | |
284 | u8 SrcIP[16]; | |
285 | u8 DstIP[16]; | |
286 | u16 SrcPort; | |
287 | u16 DstPort; | |
288 | u8 FlowLabel[3]; | |
289 | } TYPE1_IPV6; | |
290 | ||
f88ec6cb | 291 | struct _TYPE2_8021Q { |
94a79942 LF |
292 | u8 Priority; |
293 | u8 ClassifierType; | |
294 | u8 Mask; | |
295 | u16 TagType; | |
296 | } TYPE2_8021Q; | |
626f951d | 297 | }; |
94a79942 | 298 | |
1d2a55fb | 299 | struct qos_tstream { |
94a79942 LF |
300 | |
301 | bool bUsed; | |
302 | u16 MsduLifetime; | |
303 | bool bEstablishing; | |
304 | u8 TimeSlotCount; | |
305 | u8 DialogToken; | |
95ce5fc9 LF |
306 | struct wmm_tspec TSpec; |
307 | struct wmm_tspec OutStandingTSpec; | |
94a79942 | 308 | u8 NominalPhyRate; |
1d2a55fb | 309 | }; |
94a79942 | 310 | |
0db42799 | 311 | struct sta_qos { |
f88ec6cb LF |
312 | u8 WMMIEBuf[MAX_WMMELE_LENGTH]; |
313 | u8 *WMMIE; | |
94a79942 | 314 | |
f88ec6cb LF |
315 | QOS_MODE QosCapability; |
316 | QOS_MODE CurrentQosMode; | |
94a79942 | 317 | |
f88ec6cb LF |
318 | AC_UAPSD b4ac_Uapsd; |
319 | AC_UAPSD Curr4acUapsd; | |
320 | u8 bInServicePeriod; | |
321 | u8 MaxSPLength; | |
322 | int NumBcnBeforeTrigger; | |
94a79942 | 323 | |
f88ec6cb LF |
324 | u8 *pWMMInfoEle; |
325 | u8 WMMParamEle[WMM_PARAM_ELEMENT_SIZE]; | |
94a79942 | 326 | |
b0d7de73 | 327 | struct acm acm[4]; |
379a20fb | 328 | enum acm_method AcmMethod; |
94a79942 | 329 | |
1d2a55fb | 330 | struct qos_tstream StaTsArray[MAX_STA_TS_COUNT]; |
94a79942 | 331 | u8 DialogToken; |
95ce5fc9 | 332 | struct wmm_tspec TSpec; |
94a79942 LF |
333 | |
334 | u8 QBssWirelessMode; | |
335 | ||
336 | bool bNoAck; | |
337 | ||
338 | bool bEnableRxImmBA; | |
339 | ||
d3b2c172 | 340 | }; |
94a79942 | 341 | |
f88ec6cb LF |
342 | #define QBSS_LOAD_SIZE 5 |
343 | #define GET_QBSS_LOAD_STA_COUNT(__pStart) \ | |
344 | ReadEF2Byte(__pStart) | |
345 | #define SET_QBSS_LOAD_STA_COUNT(__pStart, __Value) \ | |
346 | WriteEF2Byte(__pStart, __Value) | |
347 | #define GET_QBSS_LOAD_CHNL_UTILIZATION(__pStart) \ | |
348 | ReadEF1Byte((u8 *)(__pStart) + 2) | |
349 | #define SET_QBSS_LOAD_CHNL_UTILIZATION(__pStart, __Value) \ | |
350 | WriteEF1Byte((u8 *)(__pStart) + 2, __Value) | |
351 | #define GET_QBSS_LOAD_AVAILABLE_CAPACITY(__pStart) \ | |
352 | ReadEF2Byte((u8 *)(__pStart) + 3) | |
353 | #define SET_QBSS_LOAD_AVAILABLE_CAPACITY(__pStart, __Value) \ | |
354 | WriteEF2Byte((u8 *)(__pStart) + 3, __Value) | |
94a79942 | 355 | |
0157d2e5 | 356 | struct bss_qos { |
f88ec6cb LF |
357 | QOS_MODE bdQoSMode; |
358 | u8 bdWMMIEBuf[MAX_WMMELE_LENGTH]; | |
8310b6c0 | 359 | struct octet_string bdWMMIE; |
94a79942 | 360 | |
f58a1cd9 | 361 | enum qos_ele_subtype EleSubType; |
94a79942 | 362 | |
f88ec6cb LF |
363 | u8 *pWMMInfoEle; |
364 | u8 *pWMMParamEle; | |
94a79942 | 365 | |
f88ec6cb LF |
366 | u8 QBssLoad[QBSS_LOAD_SIZE]; |
367 | bool bQBssLoadValid; | |
d3b2c172 | 368 | }; |
94a79942 LF |
369 | |
370 | #define sQoSCtlLng 2 | |
f88ec6cb | 371 | #define QOS_CTRL_LEN(_QosMode) ((_QosMode > QOS_DISABLE) ? sQoSCtlLng : 0) |
94a79942 LF |
372 | |
373 | ||
f88ec6cb | 374 | #define IsACValid(ac) ((ac >= 0 && ac <= 7) ? true : false) |
94a79942 LF |
375 | |
376 | ||
44a40046 | 377 | union aci_aifsn { |
94a79942 LF |
378 | u8 charData; |
379 | ||
f88ec6cb | 380 | struct { |
94a79942 | 381 | u8 AIFSN:4; |
b0d7de73 | 382 | u8 acm:1; |
94a79942 LF |
383 | u8 ACI:2; |
384 | u8 Reserved:1; | |
f88ec6cb | 385 | } f; |
44a40046 | 386 | }; |
94a79942 | 387 | |
a33be1e8 | 388 | union ecw { |
94a79942 | 389 | u8 charData; |
f88ec6cb | 390 | struct { |
94a79942 LF |
391 | u8 ECWmin:4; |
392 | u8 ECWmax:4; | |
f88ec6cb | 393 | } f; |
a33be1e8 | 394 | }; |
94a79942 | 395 | |
eb85e468 | 396 | union ac_param { |
94a79942 LF |
397 | u32 longData; |
398 | u8 charData[4]; | |
399 | ||
f88ec6cb | 400 | struct { |
44a40046 | 401 | union aci_aifsn AciAifsn; |
a33be1e8 | 402 | union ecw Ecw; |
94a79942 | 403 | u16 TXOPLimit; |
f88ec6cb | 404 | } f; |
eb85e468 | 405 | }; |
94a79942 LF |
406 | |
407 | #endif |