Test (ATE) API

Detailed Description

Extended API particularly intended for test use cases.

Enumerations
enum	mmwlan_mcs {   MMWLAN_MCS_NONE = -1 , MMWLAN_MCS_0 = 0 , MMWLAN_MCS_1 , MMWLAN_MCS_2 ,   MMWLAN_MCS_3 , MMWLAN_MCS_4 , MMWLAN_MCS_5 , MMWLAN_MCS_6 ,   MMWLAN_MCS_7 , MMWLAN_MCS_8 , MMWLAN_MCS_9 , MMWLAN_MCS_MAX = MMWLAN_MCS_9 }
	Enumeration of MCS rates. More...
enum	mmwlan_bw {   MMWLAN_BW_NONE = -1 , MMWLAN_BW_1MHZ = 1 , MMWLAN_BW_2MHZ = 2 , MMWLAN_BW_4MHZ = 4 ,   MMWLAN_BW_8MHZ = 8 , MMWLAN_BW_MAX = MMWLAN_BW_8MHZ }
	Enumeration of bandwidths. More...
enum	mmwlan_gi { MMWLAN_GI_NONE = -1 , MMWLAN_GI_SHORT = 0 , MMWLAN_GI_LONG , MMWLAN_GI_MAX = MMWLAN_GI_LONG }
	Enumeration of guard intervals. More...

Functions
enum mmwlan_status	mmwlan_ate_override_rate_control (enum mmwlan_mcs tx_rate_override, enum mmwlan_bw bandwidth_override, enum mmwlan_gi gi_override)
	Enable/disable override of rate control parameters. More...
enum mmwlan_status	mmwlan_ate_execute_command (uint8_t *command, uint32_t command_len, uint8_t *response, uint32_t *response_len)
	Execute a test/debug command. More...

Enumeration Type Documentation

mmwlan_bw

enum mmwlan_bw

Enumeration of bandwidths.

Enumerator
MMWLAN_BW_NONE	Use-case specific special value.
MMWLAN_BW_1MHZ	1 MHz bandwidth
MMWLAN_BW_2MHZ	2 MHz bandwidth
MMWLAN_BW_4MHZ	4 MHz bandwidth
MMWLAN_BW_8MHZ	8 MHz bandwidth
MMWLAN_BW_MAX	Maximum supported bandwidth.

Definition at line 2733 of file mmwlan.h.

mmwlan_gi

enum mmwlan_gi

Enumeration of guard intervals.

Enumerator
MMWLAN_GI_NONE	Use-case specific special value.
MMWLAN_GI_SHORT	Short guard interval.
MMWLAN_GI_LONG	Long guard interval.
MMWLAN_GI_MAX	Maximum valid value of this enum.

Definition at line 2744 of file mmwlan.h.

mmwlan_mcs

enum mmwlan_mcs

Enumeration of MCS rates.

Enumerator
MMWLAN_MCS_NONE	Use-case specific special value.
MMWLAN_MCS_0	MCS0.
MMWLAN_MCS_1	MCS1.
MMWLAN_MCS_2	MCS2.
MMWLAN_MCS_3	MCS3.
MMWLAN_MCS_4	MCS4.
MMWLAN_MCS_5	MCS5.
MMWLAN_MCS_6	MCS6.
MMWLAN_MCS_7	MCS7.
MMWLAN_MCS_8	MCS8.
MMWLAN_MCS_9	MCS9.
MMWLAN_MCS_MAX	Maximum supported MCS rate.

Definition at line 2716 of file mmwlan.h.

Function Documentation

mmwlan_ate_execute_command()

enum mmwlan_status mmwlan_ate_execute_command	(	uint8_t *	command,
		uint32_t	command_len,
		uint8_t *	response,
		uint32_t *	response_len
	)

Execute a test/debug command.

The format of command and response is opaque to this API.

Parameters

[in]	command	Buffer containing the command to be executed. Note that buffer contents may be modified by this function.
[in]	command_len	Length of the command to be executed.
[out]	response	Buffer to received the response to the command. May be NULL, in which case response_len should also be NULL.
[in,out]	response_len	Pointer to a uint32_t that is initialized to the length of the response buffer. On success, the value will be updated to the length of data that was put into the response buffer. May be NULL, in which case response must also be NULL.

Returns

MMWLAN_SUCCESS on success, else an appropriate error code.

mmwlan_ate_override_rate_control()

enum mmwlan_status mmwlan_ate_override_rate_control	(	enum mmwlan_mcs	tx_rate_override,
		enum mmwlan_bw	bandwidth_override,
		enum mmwlan_gi	gi_override
	)

Enable/disable override of rate control parameters.

Parameters

tx_rate_override	Overrides the transmit MCS rate. Set to MMWLAN_MCS_NONE for no override.
bandwidth_override	Overrides the TX bandwidth. Set to MMWLAN_BW_NONE for no override.
gi_override	Overrides the guard interval. Set to MMWLAN_GI_NONE for no override.

Returns

MMWLAN_SUCCESS on success, else an appropriate error code.