1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __INC_QOS_TYPE_H
3 #define __INC_QOS_TYPE_H
5 #define MAX_WMMELE_LENGTH 64
9 // enum 0, 1, 2, 4: since we can use the OR(|) operation.
11 // QOS_MODE is redefined for enum can't be ++, | under C++ compiler, 2006.05.17, by rcnjko.
12 //typedef enum _QOS_MODE{
17 //}QOS_MODE,*PQOS_MODE;
19 typedef u32 QOS_MODE, *PQOS_MODE;
25 #define QOS_WMM_UAPSD 16 //WMM Power Save, 2006-06-14 Isaiah
27 #define AC_PARAM_SIZE 4
28 #define WMM_PARAM_ELE_BODY_LEN 18
31 // QoS ACK Policy Field Values
32 // Ref: WMM spec 2.1.6: QoS Control Field, p.10.
34 typedef enum _ACK_POLICY{
36 eAckPlc1_NoACK = 0x01,
37 } ACK_POLICY, *PACK_POLICY;
39 #define WMM_PARAM_ELEMENT_SIZE (8+(4*AC_PARAM_SIZE))
44 // 1. WMM spec 2.1.6: QoS Control Field, p.9.
45 // 2. 802.11e/D13.0 7.1.3.5, p.26.
47 typedef union _QOS_CTRL_FIELD{
61 // 802.11e: QoS data type frame sent by non-AP QSTAs.
64 u8 bIsQsize:1;// 0: BIT[8:15] is TXOP Duration Requested, 1: BIT[8:15] is Queue Size.
67 u8 TxopOrQsize; // (BIT4=0)TXOP Duration Requested or (BIT4=1)Queue Size.
70 // 802.11e: QoS data, QoS Null, and QoS Data+CF-Ack frames sent by HC.
76 u8 PSBufState; // QAP PS Buffer State.
79 // 802.11e: QoS (+) CF-Poll frames sent by HC.
85 u8 TxopLimit; // TXOP Limit.
88 }QOS_CTRL_FIELD, *PQOS_CTRL_FIELD;
94 // 1. WMM spec 2.2.1: WME Information Element, p.11.
95 // 2. 8185 QoS code: QOS_INFO [def. in QoS_mp.h]
97 typedef union _QOS_INFO_FIELD{
101 u8 ucParameterSetCount:4;
106 //Ref WMM_Specification_1-1.pdf, 2006-06-13 Isaiah
118 //Ref WMM_Specification_1-1.pdf, 2006-06-13 Isaiah
119 u8 ucParameterSetCount:4;
135 u8 ucParameterSetCount:4;
168 u8 ucParameterSetCount:4;
175 }QOS_INFO_FIELD, *PQOS_INFO_FIELD;
179 // Ref: WMM spec 2.2.2: WME Parameter Element, p.13.
181 // AC_CODING is redefined for enum can't be ++, | under C++ compiler, 2006.05.17, by rcnjko.
182 //typedef enum _AC_CODING{
183 // AC0_BE = 0, // ACI: 0x00 // Best Effort
184 // AC1_BK = 1, // ACI: 0x01 // Background
185 // AC2_VI = 2, // ACI: 0x10 // Video
186 // AC3_VO = 3, // ACI: 0x11 // Voice
187 // AC_MAX = 4, // Max: define total number; Should not to be used as a real enum.
188 //}AC_CODING,*PAC_CODING;
190 typedef u32 AC_CODING;
191 #define AC0_BE 0 // ACI: 0x00 // Best Effort
192 #define AC1_BK 1 // ACI: 0x01 // Background
193 #define AC2_VI 2 // ACI: 0x10 // Video
194 #define AC3_VO 3 // ACI: 0x11 // Voice
195 #define AC_MAX 4 // Max: define total number; Should not to be used as a real enum.
199 // Ref: WMM spec 2.2.2: WME Parameter Element, p.12.
201 typedef union _ACI_AIFSN{
210 }ACI_AIFSN, *PACI_AIFSN;
213 // ECWmin/ECWmax field.
214 // Ref: WMM spec 2.2.2: WME Parameter Element, p.13.
225 // AC Parameters Record Format.
226 // Ref: WMM spec 2.2.2: WME Parameter Element, p.12.
228 typedef union _AC_PARAM{
237 }AC_PARAM, *PAC_PARAM;
242 // QoS element subtype
244 typedef enum _QOS_ELE_SUBTYPE{
245 QOSELE_TYPE_INFO = 0x00, // 0x00: Information element
246 QOSELE_TYPE_PARAM = 0x01, // 0x01: parameter element
247 } QOS_ELE_SUBTYPE, *PQOS_ELE_SUBTYPE;
251 // Direction Field Values.
252 // Ref: WMM spec 2.2.11: WME TSPEC Element, p.18.
254 typedef enum _DIRECTION_VALUE{
255 DIR_UP = 0, // 0x00 // UpLink
256 DIR_DOWN = 1, // 0x01 // DownLink
257 DIR_DIRECT = 2, // 0x10 // DirectLink
258 DIR_BI_DIR = 3, // 0x11 // Bi-Direction
259 } DIRECTION_VALUE, *PDIRECTION_VALUE;
263 // TS Info field in WMM TSPEC Element.
265 // 1. WMM spec 2.2.11: WME TSPEC Element, p.18.
266 // 2. 8185 QoS code: QOS_TSINFO [def. in QoS_mp.h]
268 typedef union _QOS_TSINFO{
271 u8 ucTrafficType:1; //WMM is reserved
274 u8 ucAccessPolicy:2; //WMM: bit8=0, bit7=1
275 u8 ucAggregation:1; //WMM is reserved
276 u8 ucPSB:1; //WMMSA is APSD
278 u8 ucTSInfoAckPolicy:2; //WMM is reserved
279 u8 ucSchedule:1; //WMM is reserved
282 }QOS_TSINFO, *PQOS_TSINFO;
286 // Ref: WMM spec 2.2.11: WME TSPEC Element, p.16.
288 typedef union _TSPEC_BODY{
292 QOS_TSINFO TSInfo; //u8 TSInfo[3];
299 u32 ServiceStartTime;
306 u16 SurplusBandwidthAllowance;
309 }TSPEC_BODY, *PTSPEC_BODY;
313 // WMM TSPEC Element.
314 // Ref: WMM spec 2.2.11: WME TSPEC Element, p.16.
316 typedef struct _WMM_TSPEC{
324 } WMM_TSPEC, *PWMM_TSPEC;
327 // ACM implementation method.
328 // Annie, 2005-12-13.
330 typedef enum _ACM_METHOD{
331 eAcmWay0_SwAndHw = 0, // By SW and HW.
332 eAcmWay1_HW = 1, // By HW.
333 eAcmWay2_SW = 2, // By SW.
334 } ACM_METHOD, *PACM_METHOD;
341 u8 HwAcmCtl; // TRUE: UsedTime exceed => Do NOT USE this AC. It wll be written to ACM_CONTROL(0xBF BIT 0/1/2 in 8185B).
344 typedef u8 AC_UAPSD, *PAC_UAPSD;
346 #define GET_VO_UAPSD(_apsd) ((_apsd) & BIT(0))
347 #define SET_VO_UAPSD(_apsd) ((_apsd) |= BIT(0))
349 #define GET_VI_UAPSD(_apsd) ((_apsd) & BIT(1))
350 #define SET_VI_UAPSD(_apsd) ((_apsd) |= BIT(1))
352 #define GET_BK_UAPSD(_apsd) ((_apsd) & BIT(2))
353 #define SET_BK_UAPSD(_apsd) ((_apsd) |= BIT(2))
355 #define GET_BE_UAPSD(_apsd) ((_apsd) & BIT(3))
356 #define SET_BE_UAPSD(_apsd) ((_apsd) |= BIT(3))
359 //typedef struct _TCLASS{
361 //} TCLASS, *PTCLASS;
362 typedef union _QOS_TCLAS{
364 struct _TYPE_GENERAL{
411 } QOS_TCLAS, *PQOS_TCLAS;
413 //typedef struct _WMM_TSTREAM{
416 //- AC (which to mapping)
417 //} WMM_TSTREAM, *PWMM_TSTREAM;
418 typedef struct _QOS_TSTREAM{
422 } QOS_TSTREAM, *PQOS_TSTREAM;
424 //typedef struct _U_APSD{
425 //- TriggerEnable [4]
427 //- HighestAcBuffered
428 //} U_APSD, *PU_APSD;
431 // UAPSD function should be implemented by 2 data structure
432 // "Qos control field" and "Qos info field"
433 //typedef struct _QOS_UAPSD{
434 // u8 bTriggerEnable[4];
437 //} QOS_UAPSD, *PQOS_APSD;
439 //----------------------------------------------------------------------------
440 // 802.11 Management frame Status Code field
441 //----------------------------------------------------------------------------
442 typedef struct _OCTET_STRING{
445 }OCTET_STRING, *POCTET_STRING;
449 // Ref: DOT11_QOS in 8185 code. [def. in QoS_mp.h]
451 typedef struct _STA_QOS{
452 //DECLARE_RT_OBJECT(STA_QOS);
453 u8 WMMIEBuf[MAX_WMMELE_LENGTH];
456 // Part 1. Self QoS Mode.
457 QOS_MODE QosCapability; //QoS Capability, 2006-06-14 Isaiah
458 QOS_MODE CurrentQosMode;
460 // For WMM Power Save Mode :
461 // ACs are trigger/delivery enabled or legacy power save enabled. 2006-06-13 Isaiah
462 AC_UAPSD b4ac_Uapsd; //VoUapsd(bit0), ViUapsd(bit1), BkUapsd(bit2), BeUapsd(bit3),
463 AC_UAPSD Curr4acUapsd;
466 int NumBcnBeforeTrigger;
468 // Part 2. EDCA Parameter (perAC)
470 u8 WMMParamEle[WMM_PARAM_ELEMENT_SIZE];
474 //2 ToDo: remove the Qos Info Field and replace it by the above WMM Info element.
475 // By Bruce, 2008-01-30.
476 // Part 2. EDCA Parameter (perAC)
477 QOS_INFO_FIELD QosInfoField_STA; // Maintained by STA
478 QOS_INFO_FIELD QosInfoField_AP; // Retrieved from AP
480 AC_PARAM CurAcParameters[4];
484 ACM_METHOD AcmMethod;
486 // Part 4. Per TID (Part 5: TCLASS will be described by TStream)
487 QOS_TSTREAM TStream[16];
490 u32 QBssWirelessMode;
495 // Enable/Disable Rx immediate BA capability.
502 // Ref: BssDscr in 8185 code. [def. in BssDscr.h]
504 typedef struct _BSS_QOS{
507 u8 bdWMMIEBuf[MAX_WMMELE_LENGTH];
510 QOS_ELE_SUBTYPE EleSubType;
515 QOS_INFO_FIELD QosInfoField;
516 AC_PARAM AcParameter[4];
521 // Ref: sQoSCtlLng and QoSCtl definition in 8185 QoS code.
522 //#define QoSCtl (( (Adapter->bRegQoS) && (Adapter->dot11QoS.QoSMode &(QOS_EDCA|QOS_HCCA)) ) ?sQoSCtlLng:0)
525 #define QOS_CTRL_LEN(_QosMode) ((_QosMode > QOS_DISABLE)? sQoSCtlLng : 0)
529 //UP Mapping to AC, using in MgntQuery_SequenceNumber() and maybe for DSCP
530 //#define UP2AC(up) ((up<3)?((up==0)?1:0):(up>>1))
531 #define IsACValid(ac) ((ac<=7 )?true:false )
533 #endif // #ifndef __INC_QOS_TYPE_H