Quality of Service functions


Functions

VOID CuCmd_AddTspec (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Adds a TSPEC.
VOID CuCmd_GetTspec (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Gets a TSPEC.
VOID CuCmd_DeleteTspec (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Deletes a TSPEC.
VOID CuCmd_GetApQosParams (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Shows the BSSID QoS per AC configuration.
VOID CuCmd_GetPsRxStreamingParams (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Shows Rx streaming parameters.
VOID CuCmd_GetApQosCapabilities (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Shows the BSSID global QoS configuration.
VOID CuCmd_GetAcStatus (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Shows the access category status.
VOID CuCmd_ModifyMediumUsageTh (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Configures the medium usage threshold.
VOID CuCmd_GetDesiredPsMode (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Shows the power-save mode.
VOID CuCmd_InsertClsfrEntry (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Adds a classifier.
VOID CuCmd_RemoveClsfrEntry (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Removes a classifier.
VOID CuCmd_SetPsRxDelivery (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Configures power-save Rx delivery.
VOID CuCmd_SetQosParams (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Modifies the QoS parameters.
VOID CuCmd_SetRxTimeOut (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Modifies the Rx timeout.

Detailed Description


Function Documentation

VOID CuCmd_AddTspec ( THandle  hCuCmd,
ConParm_t  parm[],
U16  nParms 
)

Adds a TSPEC.

This function asks the driver to send a TSPEC request to the AP. In a TSPEC request, the station requests from the AP, a bandwidth for data transmission over an admitted access category. The AP can approve the request or reject it. If it approves it, the station transmits the data according to the parameters. Together with the traffic type, the TSPEC request contains the bandwidth and transmission characteristics.

Parameters:
[in] hCuCmd Handle for the command module
[in] parm parm[0] The user priority for transmitting the data (0 - 7)
parm[1] The requested MSDU size, in bytes
parm[2] The requested number of bits per second
parm[3] The minimum requested Tx data rate, in Mbps
parm[4] The excess allocation of time required to transport an MSDU
parm[5] Indicates whether or not the station supports the UPSD power-save delivery protocol for this traffic stream
parm[6] The required minimum service interval, in msecs
parm[7] The required maximum service interval, in msecs
[in] nParms Always 8
Returns:
None
See also:
CuCmd_GetTspec(), CuCmd_DeleteTspec()
Note:
Warning:

VOID CuCmd_DeleteTspec ( THandle  hCuCmd,
ConParm_t  parm[],
U16  nParms 
)

Deletes a TSPEC.

This function asks the driver to delete a TSPEC request.
The driver sends a frame to the AP, and notifies the AP about the TSPEC deletion.
In addition, the driver removes the TSPEC transmission configuration.

Parameters:
[in] hCuCmd Handle for the command module
[in] parm parm[0] The user priority of the TSPEC request
parm[1] The reason for the deletion
[in] nParms Always 2
Returns:
None
See also:
CuCmd_AddTspec(), CuCmd_GetTspec()
Note:
Warning:

VOID CuCmd_GetAcStatus ( THandle  hCuCmd,
ConParm_t  parm[],
U16  nParms 
)

Shows the access category status.

This function gets the current status of an access category from the driver and prints it.

Parameters:
[in] hCuCmd Handle for the command module
[in] parm parm[0] The access category (valid values: 0 - 3)
[in] nParms Always 1
Returns:
None
See also:
Note:
The following are printed:
  • Ps Scheme - Indicates whether the current power-save delivery protocol for this AC is UPSD (un-solicited power-save delivery) or PsPoll (the 802.11 standard power-save delivery)
  • Admission status - Indicates whether the station currently has an admission for this AC
Warning:

VOID CuCmd_GetApQosCapabilities ( THandle  hCuCmd,
ConParm_t  parm[],
U16  nParms 
)

Shows the BSSID global QoS configuration.

This function gets the global QoS configuration of the BSSID from the driver and prints it.

Parameters:
[in] hCuCmd Handle for the command module
[in] parm Not used; should be 0
[in] nParms Not used; should be 0
Returns:
None
See also:
Note:
The following is printed:
  • QOS Flag – Indicates if the BSSID supports QoS
  • APSD Flag – Indicates if the BSSID supports APSD (un-solicited power-save delivery protocol) or PsPoll (the 802.11 standard power-save delivery protocol)
Warning:

VOID CuCmd_GetApQosParams ( THandle  hCuCmd,
ConParm_t  parm[],
U16  nParms 
)

Shows the BSSID QoS per AC configuration.

This function gets the QoS configuration of the BSSID for each access category from the driver and prints them.

Parameters:
[in] hCuCmd Handle for the command module
[in] parm Not used; should be 0
[in] nParms Not used; should be 0
Returns:
None
See also:
Note:
The following parameters are printed per access category:
  • AC index
  • AdmCtrlFlag – Indicates whether or not admission control is supported for this AC
  • AIFS - Defines the number of time slots inside the Arbitration Interframe space; used for transmission decisions
  • CWMin - The back-off exponent minimum boundary
  • CWMax - The back-off exponent maximum boundary
  • TXOP – The size of the transmission opportunity limit
Warning:

VOID CuCmd_GetDesiredPsMode ( THandle  hCuCmd,
ConParm_t  parm[],
U16  nParms 
)

Shows the power-save mode.

This function gets the power-save mode from the driver and prints it.

Parameters:
[in] hCuCmd Handle for the command module
[in] parm Not used; should be 0
[in] nParms Not used; should be 0
Returns:
None
See also:
Note:
The following are printed:
Whether the global power-save delivery protocol is UPSD (un-solicited power-save delivery) or PsPoll (the 802.11 standard power-save delivery)
Whether the power-save delivery protocol per AC is UPSD (un-solicited power-save delivery) or PsPoll (the 802.11 standard power-save delivery)
Warning:

VOID CuCmd_GetPsRxStreamingParams ( THandle  hCuCmd,
ConParm_t  parm[],
U16  nParms 
)

Shows Rx streaming parameters.

This function gets the Rx streaming parameters from the driver and prints them.
The Rx streaming parameters are used by the station for the admitted ACs when working in QoS.
For each traffic identifier, the following are printed:

  • The expected period between two packets of the delivered stream.
  • The time interval. If no Tx traffic triggers arrive during this period, the station starts sending triggers.
  • If 1, this TID streaming is enabled; otherwise, it is 0.

Parameters:
[in] hCuCmd Handle for the command module
[in] parm Not used; should be 0
[in] nParms Not used; should be 0
Returns:
None
See also:
Note:
Warning:

VOID CuCmd_GetTspec ( THandle  hCuCmd,
ConParm_t  parm[],
U16  nParms 
)

Gets a TSPEC.

This function gets a TSPEC for a user priority from the driver and prints the TSPEC parameters granted by the AP.
The following parameters are printed:

  • The user priority used to transmit the data
  • The MSDU size, in bytes
  • The number of bits per second
  • The minimum Tx data rate, in Mbps
  • The excess allocation of time to transport an MSDU
  • Indicates whether or not this traffic stream supports the UPSD power-save delivery protocol
  • The minimum service interval, in msecs
  • The maximum service interval, in msecs
  • The medium time granted

Parameters:
[in] hCuCmd Handle for the command module
[in] parm parm[0] The user priority of the TSPEC request
[in] nParms Always 1
Returns:
None
See also:
CuCmd_AddTspec(), CuCmd_DeleteTspec
Note:
Warning:

VOID CuCmd_InsertClsfrEntry ( THandle  hCuCmd,
ConParm_t  parm[],
U16  nParms 
)

Adds a classifier.

This function adds a classifier to the driver to be used for traffic classification while working in QoS.

Parameters:
[in] hCuCmd Handle for the command module
[in] parm parm[0] The classifier type, which can be one of the following:
  • 1 – Diffserv-based classification
  • 2 - IP port-based classification
  • 3 - IP address and IP port-based classification
    parm[1] The user priority index. The packets that match the given classifier are transmitted over the WLAN with a QoS header containing this priority index (0 - 7).
    parm[2] Can be one of the following:
  • A code point, when using a Diffserv classifier. Frames containing this code point are mapped to the TID (0 - 63).
  • An IP port, when using an IP port classifier. Frames destined to this port are mapped to the TID (1 – 65,535).
  • An IP port, when using an IP address and IP port classifier. Frames destined to the address and this port are mapped to the TID (1 – 65,535).
    parm[3] Used only for an IP address and IP port classifier; represents the first byte of the destination IP address (00 - 255).
    parm[4] Used only for an IP address and IP port classifier; represents the second byte of the destination IP address (00 - 255).
    parm[5] Used only for an IP address and IP port classifier; represents the third byte of the destination IP address (00 - 255).
    parm[6] Used only for an IP address and IP port classifier; represents the fourth byte of the destination IP address (00 - 255).
[in] nParms Can be one of the following:
3 - For a Diffserv classifier or IP port classifier
7 - For an IP address and IP port classifier.
Returns:
None
See also:
CuCmd_RemoveClsfrEntry()
Note:
Warning:

VOID CuCmd_ModifyMediumUsageTh ( THandle  hCuCmd,
ConParm_t  parm[],
U16  nParms 
)

Configures the medium usage threshold.

This function configures the medium usage thresholds per AC on the driver.

Parameters:
[in] hCuCmd Handle for the command module
[in] parm parm[0] The access category (valid values: 0 - 3)
parm[1] The high medium-usage threshold
parm[2] The low medium-usage threshold
[in] nParms The number of parameters, which can be one of the following:
1 - No thresholds are given. The function prints the current thresholds of the given AC.
3 - The thresholds are configured on the driver.
Returns:
None
See also:
Note:
When the high medium threshold is exceeded, or the low medium threshold is crossed downward, an IPC event is sent to the CLI.
This event notifies the user that the station does not transmit according to the AC usage limit.
Warning:

VOID CuCmd_RemoveClsfrEntry ( THandle  hCuCmd,
ConParm_t  parm[],
U16  nParms 
)

Removes a classifier.

This function removes a classifier from the driver. For more details, please refer to the CuCmd_InsertClsfrEntry() function.

Parameters:
[in] hCuCmd Handle for the command module
[in] parm parm[0-6] Please refer to the CuCmd_InsertClsfrEntry() function.
[in] nParms Please refer to the CuCmd_InsertClsfrEntry() function.
Returns:
None
See also:
CuCmd_InsertClsfrEntry()
Note:
Warning:

VOID CuCmd_SetPsRxDelivery ( THandle  hCuCmd,
ConParm_t  parm[],
U16  nParms 
)

Configures power-save Rx delivery.

This function configures the Rx streaming parameters used by the station for the admitted ACs when working in QoS.

Parameters:
[in] hCuCmd Handle for the command module
[in] parm parm[0] The traffic identifier of the Rx stream.
parm[1] The expected period between two packets of the delivered stream.
parm[2] The time interval. If no Tx traffic triggers arrive during this period, the station starts sending triggers.
parm[3] Defines whether or not TID streaming is enabled (1 - enabled, 0 - disabled).
[in] nParms Always 4.
Returns:
None
See also:
Note:
Warning:

VOID CuCmd_SetQosParams ( THandle  hCuCmd,
ConParm_t  parm[],
U16  nParms 
)

Modifies the QoS parameters.

This function configures the QoS parameters per access category.

Parameters:
[in] hCuCmd Handle for the command module
[in] parm parm[0] The access category to be configured (valid values: 0 - 3).
parm[1] The maximum lifetime, in msecs, for frames transmitted over this AC. If this threshold is crossed, the frame is dropped (default = 0).
parm[2] The power-save delivery protocol for this AC (0 - legacy, 1 – upsd; default = 1 - upsd).
[in] nParms Always 3.
Returns:
None
See also:
Note:
Warning:

VOID CuCmd_SetRxTimeOut ( THandle  hCuCmd,
ConParm_t  parm[],
U16  nParms 
)

Modifies the Rx timeout.

This function configures the Rx timeout for the power-save delivery protocol.

Parameters:
[in] hCuCmd Handle for the command module
[in] parm parm[0] Indicates the amount of time, in msecs, the station waits for a frame to be received from the AP, when working using the PsPoll delivery protocol (0 – 65,000; default = 0).
parm[1] Indicates the amount of time, in msecs, the station waits for a frame to be received from the AP, when working using the UPSD delivery protocol (0 – 65,000; default = 0).
[in] nParms the number of parameters, which can be one of the following:
0 - No timeouts are given. The function prints the available timeout values.
2 - The timeouts are configured on the driver.
Returns:
None
See also:
Note:
Warning:


Generated on Sun Dec 6 12:34:03 2009 for WLAN DRIVER API REFERENCE MANUAL by  doxygen 1.5.9