Statistics API

Detailed Description

API for retrieving statistics information from the WLAN subsystem.

Modules
	UMAC Stats
	API to get stats from the UMAC.

Data Structures
struct	mmwlan_rc_stats
	Rate control statistics data structure. More...
struct	mmwlan_morse_stats
	Data structure used to represent an opaque buffer containing Morse statistics. More...

Enumerations
enum	mmwlan_rc_stats_rate_info_offsets { MMWLAN_RC_STATS_RATE_INFO_BW_OFFSET = 0 , MMWLAN_RC_STATS_RATE_INFO_RATE_OFFSET = 4 , MMWLAN_RC_STATS_RATE_INFO_GUARD_OFFSET = 8 }
	Enumeration defined offsets into the bit field of rate information (rate_info in mmwlan_rc_stats). More...

Functions
struct mmwlan_rc_stats *	mmwlan_get_rc_stats (void)
	Retrieves WLAN rate control statistics. More...
void	mmwlan_free_rc_stats (struct mmwlan_rc_stats *stats)
	Free a mmwlan_rc_stats structure that was allocated with mmwlan_get_rc_stats(). More...
struct mmwlan_morse_stats *	mmwlan_get_morse_stats (uint32_t core_num, bool reset)
	Retrieves statistics from the Morse transceiver. More...
void	mmwlan_free_morse_stats (struct mmwlan_morse_stats *stats)
	Frees a mmwlan_morse_stats instance that was returned by mmwlan_get_morse_stats(). More...
enum mmwlan_status	mmwlan_clear_umac_stats (void)
	Clear all current values of the UMAC statistics. More...

Enumeration Type Documentation

mmwlan_rc_stats_rate_info_offsets

enum mmwlan_rc_stats_rate_info_offsets

Enumeration defined offsets into the bit field of rate information (rate_info in mmwlan_rc_stats).

31         9       8      4    0
+----------+-------+------+----+
| Reserved | Guard | Rate | BW |
|    23    |   1   |  4   | 4  |
+----------+-------+------+----+

• BW: 0 = 1 MHz, 1 = 2 MHz, 2 = 4 MHz
• Rate: MCS Rate
• Guard: 0 = LGI, 1 = SGI

Definition at line 2615 of file mmwlan.h.

Function Documentation

mmwlan_clear_umac_stats()

enum mmwlan_status mmwlan_clear_umac_stats

(

void

)

Clear all current values of the UMAC statistics.

Returns

MMWLAN_SUCCESS

mmwlan_free_morse_stats()

void mmwlan_free_morse_stats

(

struct mmwlan_morse_stats *

stats

)

Frees a mmwlan_morse_stats instance that was returned by mmwlan_get_morse_stats().

Parameters

stats

The instance to free. May be @ NULL.

mmwlan_free_rc_stats()

void mmwlan_free_rc_stats

(

struct mmwlan_rc_stats *

stats

)

Free a mmwlan_rc_stats structure that was allocated with mmwlan_get_rc_stats().

Parameters

stats

The structure to be freed (may be NULL).

mmwlan_get_morse_stats()

struct mmwlan_morse_stats * mmwlan_get_morse_stats	(	uint32_t	core_num,
		bool	reset
	)

Retrieves statistics from the Morse transceiver.

The stats are returned as a binary blob that can be parsed by host tools.

Parameters

core_num	The core to retrieve stats for.
reset	Boolean indicating whether to reset the stats after retrieving.

Note

The returned mmwlan_morse_stats instance must be freed using mmwlan_free_morse_stats.

Returns

a mmwlan_morse_stats instance on success or NULL on failure.

mmwlan_get_rc_stats()

struct mmwlan_rc_stats * mmwlan_get_rc_stats

(

void

)

Retrieves WLAN rate control statistics.

Note

The returned data structure must be freed using mmwlan_free_rc_stats().

Returns

the statistics data structure on success or NULL on failure.