1#include "wifi_hal.h" 2 3#ifndef __WIFI_HAL_STATS_H 4#define __WIFI_HAL_STATS_H 5 6#ifdef __cplusplus 7extern "C" 8{ 9#endif /* __cplusplus */ 10 11#define STATS_MAJOR_VERSION 1 12#define STATS_MINOR_VERSION 0 13#define STATS_MICRO_VERSION 0 14 15typedef enum { 16 WIFI_DISCONNECTED = 0, 17 WIFI_AUTHENTICATING = 1, 18 WIFI_ASSOCIATING = 2, 19 WIFI_ASSOCIATED = 3, 20 WIFI_EAPOL_STARTED = 4, // if done by firmware/driver 21 WIFI_EAPOL_COMPLETED = 5, // if done by firmware/driver 22} wifi_connection_state; 23 24typedef enum { 25 WIFI_ROAMING_IDLE = 0, 26 WIFI_ROAMING_ACTIVE = 1, 27} wifi_roam_state; 28 29typedef enum { 30 WIFI_INTERFACE_STA = 0, 31 WIFI_INTERFACE_SOFTAP = 1, 32 WIFI_INTERFACE_IBSS = 2, 33 WIFI_INTERFACE_P2P_CLIENT = 3, 34 WIFI_INTERFACE_P2P_GO = 4, 35 WIFI_INTERFACE_NAN = 5, 36 WIFI_INTERFACE_MESH = 6, 37 WIFI_INTERFACE_UNKNOWN = -1 38 } wifi_interface_mode; 39 40#define WIFI_CAPABILITY_QOS 0x00000001 // set for QOS association 41#define WIFI_CAPABILITY_PROTECTED 0x00000002 // set for protected association (802.11 beacon frame control protected bit set) 42#define WIFI_CAPABILITY_INTERWORKING 0x00000004 // set if 802.11 Extended Capabilities element interworking bit is set 43#define WIFI_CAPABILITY_HS20 0x00000008 // set for HS20 association 44#define WIFI_CAPABILITY_SSID_UTF8 0x00000010 // set is 802.11 Extended Capabilities element UTF-8 SSID bit is set 45#define WIFI_CAPABILITY_COUNTRY 0x00000020 // set is 802.11 Country Element is present 46 47typedef struct { 48 wifi_interface_mode mode; // interface mode 49 u8 mac_addr[6]; // interface mac address (self) 50 wifi_connection_state state; // connection state (valid for STA, CLI only) 51 wifi_roam_state roaming; // roaming state 52 u32 capabilities; // WIFI_CAPABILITY_XXX (self) 53 u8 ssid[33]; // null terminated SSID 54 u8 bssid[6]; // bssid 55 u8 ap_country_str[3]; // country string advertised by AP 56 u8 country_str[3]; // country string for this association 57} wifi_interface_link_layer_info; 58 59/* channel information */ 60typedef struct { 61 wifi_channel_width width; // channel width (20, 40, 80, 80+80, 160) 62 wifi_channel center_freq; // primary 20 MHz channel 63 wifi_channel center_freq0; // center frequency (MHz) first segment 64 wifi_channel center_freq1; // center frequency (MHz) second segment 65} wifi_channel_info; 66 67/* wifi rate */ 68typedef struct { 69 u32 preamble :3; // 0: OFDM, 1:CCK, 2:HT 3:VHT 4..7 reserved 70 u32 nss :2; // 0:1x1, 1:2x2, 3:3x3, 4:4x4 71 u32 bw :3; // 0:20MHz, 1:40Mhz, 2:80Mhz, 3:160Mhz 72 u32 rateMcsIdx :8; // OFDM/CCK rate code would be as per ieee std in the units of 0.5mbps 73 // HT/VHT it would be mcs index 74 u32 reserved :16; // reserved 75 u32 bitrate; // units of 100 Kbps 76} wifi_rate; 77 78/* channel statistics */ 79typedef struct { 80 wifi_channel_info channel; // channel 81 u32 on_time; // msecs the radio is awake (32 bits number accruing over time) 82 u32 cca_busy_time; // msecs the CCA register is busy (32 bits number accruing over time) 83} wifi_channel_stat; 84 85// Max number of tx power levels. The actual number vary per device and is specified by |num_tx_levels| 86#define RADIO_STAT_MAX_TX_LEVELS 256 87 88/* radio statistics */ 89typedef struct { 90 wifi_radio radio; // wifi radio (if multiple radio supported) 91 u32 on_time; // msecs the radio is awake (32 bits number accruing over time) 92 u32 tx_time; // msecs the radio is transmitting (32 bits number accruing over time) 93 u32 num_tx_levels; // number of radio transmit power levels 94 u32 *tx_time_per_levels; // pointer to an array of radio transmit per power levels in 95 // msecs accured over time 96 u32 rx_time; // msecs the radio is in active receive (32 bits number accruing over time) 97 u32 on_time_scan; // msecs the radio is awake due to all scan (32 bits number accruing over time) 98 u32 on_time_nbd; // msecs the radio is awake due to NAN (32 bits number accruing over time) 99 u32 on_time_gscan; // msecs the radio is awake due to G?scan (32 bits number accruing over time) 100 u32 on_time_roam_scan; // msecs the radio is awake due to roam?scan (32 bits number accruing over time) 101 u32 on_time_pno_scan; // msecs the radio is awake due to PNO scan (32 bits number accruing over time) 102 u32 on_time_hs20; // msecs the radio is awake due to HS2.0 scans and GAS exchange (32 bits number accruing over time) 103 u32 num_channels; // number of channels 104 wifi_channel_stat channels[]; // channel statistics 105} wifi_radio_stat; 106 107/** 108 * Packet statistics reporting by firmware is performed on MPDU basi (i.e. counters increase by 1 for each MPDU) 109 * As well, "data packet" in associated comments, shall be interpreted as 802.11 data packet, 110 * that is, 802.11 frame control subtype == 2 and excluding management and control frames. 111 * 112 * As an example, in the case of transmission of an MSDU fragmented in 16 MPDUs which are transmitted 113 * OTA in a 16 units long a-mpdu, for which a block ack is received with 5 bits set: 114 * tx_mpdu : shall increase by 5 115 * retries : shall increase by 16 116 * tx_ampdu : shall increase by 1 117 * data packet counters shall not increase regardless of the number of BAR potentially sent by device for this a-mpdu 118 * data packet counters shall not increase regardless of the number of BA received by device for this a-mpdu 119 * 120 * For each subsequent retransmission of the 11 remaining non ACK'ed mpdus 121 * (regardless of the fact that they are transmitted in a-mpdu or not) 122 * retries : shall increase by 1 123 * 124 * If no subsequent BA or ACK are received from AP, until packet lifetime expires for those 11 packet that were not ACK'ed 125 * mpdu_lost : shall increase by 11 126 */ 127 128/* per rate statistics */ 129typedef struct { 130 wifi_rate rate; // rate information 131 u32 tx_mpdu; // number of successfully transmitted data pkts (ACK rcvd) 132 u32 rx_mpdu; // number of received data pkts 133 u32 mpdu_lost; // number of data packet losses (no ACK) 134 u32 retries; // total number of data pkt retries 135 u32 retries_short; // number of short data pkt retries 136 u32 retries_long; // number of long data pkt retries 137} wifi_rate_stat; 138 139/* access categories */ 140typedef enum { 141 WIFI_AC_VO = 0, 142 WIFI_AC_VI = 1, 143 WIFI_AC_BE = 2, 144 WIFI_AC_BK = 3, 145 WIFI_AC_MAX = 4, 146} wifi_traffic_ac; 147 148/* wifi peer type */ 149typedef enum 150{ 151 WIFI_PEER_STA, 152 WIFI_PEER_AP, 153 WIFI_PEER_P2P_GO, 154 WIFI_PEER_P2P_CLIENT, 155 WIFI_PEER_NAN, 156 WIFI_PEER_TDLS, 157 WIFI_PEER_INVALID, 158} wifi_peer_type; 159 160/* per peer statistics */ 161typedef struct { 162 wifi_peer_type type; // peer type (AP, TDLS, GO etc.) 163 u8 peer_mac_address[6]; // mac address 164 u32 capabilities; // peer WIFI_CAPABILITY_XXX 165 u32 num_rate; // number of rates 166 wifi_rate_stat rate_stats[]; // per rate statistics, number of entries = num_rate 167} wifi_peer_info; 168 169/* Per access category statistics */ 170typedef struct { 171 wifi_traffic_ac ac; // access category (VI, VO, BE, BK) 172 u32 tx_mpdu; // number of successfully transmitted unicast data pkts (ACK rcvd) 173 u32 rx_mpdu; // number of received unicast data packets 174 u32 tx_mcast; // number of succesfully transmitted multicast data packets 175 // STA case: implies ACK received from AP for the unicast packet in which mcast pkt was sent 176 u32 rx_mcast; // number of received multicast data packets 177 u32 rx_ampdu; // number of received unicast a-mpdus; support of this counter is optional 178 u32 tx_ampdu; // number of transmitted unicast a-mpdus; support of this counter is optional 179 u32 mpdu_lost; // number of data pkt losses (no ACK) 180 u32 retries; // total number of data pkt retries 181 u32 retries_short; // number of short data pkt retries 182 u32 retries_long; // number of long data pkt retries 183 u32 contention_time_min; // data pkt min contention time (usecs) 184 u32 contention_time_max; // data pkt max contention time (usecs) 185 u32 contention_time_avg; // data pkt avg contention time (usecs) 186 u32 contention_num_samples; // num of data pkts used for contention statistics 187} wifi_wmm_ac_stat; 188 189/* interface statistics */ 190typedef struct { 191 wifi_interface_handle iface; // wifi interface 192 wifi_interface_link_layer_info info; // current state of the interface 193 u32 beacon_rx; // access point beacon received count from connected AP 194 u64 average_tsf_offset; // average beacon offset encountered (beacon_TSF - TBTT) 195 // The average_tsf_offset field is used so as to calculate the 196 // typical beacon contention time on the channel as well may be 197 // used to debug beacon synchronization and related power consumption issue 198 u32 leaky_ap_detected; // indicate that this AP typically leaks packets beyond the driver guard time. 199 u32 leaky_ap_avg_num_frames_leaked; // average number of frame leaked by AP after frame with PM bit set was ACK'ed by AP 200 u32 leaky_ap_guard_time; // guard time currently in force (when implementing IEEE power management based on 201 // frame control PM bit), How long driver waits before shutting down the radio and 202 // after receiving an ACK for a data frame with PM bit set) 203 u32 mgmt_rx; // access point mgmt frames received count from connected AP (including Beacon) 204 u32 mgmt_action_rx; // action frames received count 205 u32 mgmt_action_tx; // action frames transmit count 206 wifi_rssi rssi_mgmt; // access Point Beacon and Management frames RSSI (averaged) 207 wifi_rssi rssi_data; // access Point Data Frames RSSI (averaged) from connected AP 208 wifi_rssi rssi_ack; // access Point ACK RSSI (averaged) from connected AP 209 wifi_wmm_ac_stat ac[WIFI_AC_MAX]; // per ac data packet statistics 210 u32 num_peers; // number of peers 211 wifi_peer_info peer_info[]; // per peer statistics 212} wifi_iface_stat; 213 214/* configuration params */ 215typedef struct { 216 u32 mpdu_size_threshold; // threshold to classify the pkts as short or long 217 // packet size < mpdu_size_threshold => short 218 u32 aggressive_statistics_gathering; // set for field debug mode. Driver should collect all statistics regardless of performance impact. 219} wifi_link_layer_params; 220 221/* API to trigger the link layer statistics collection. 222 Unless his API is invoked - link layer statistics will not be collected. 223 Radio statistics (once started) do not stop or get reset unless wifi_clear_link_stats is invoked 224 Interface statistics (once started) reset and start afresh after each connection */ 225wifi_error wifi_set_link_stats(wifi_interface_handle iface, wifi_link_layer_params params); 226 227/* callback for reporting link layer stats */ 228typedef struct { 229 void (*on_link_stats_results) (wifi_request_id id, wifi_iface_stat *iface_stat, 230 int num_radios, wifi_radio_stat *radio_stat); 231} wifi_stats_result_handler; 232 233/* api to collect the link layer statistics for a given iface and all the radio stats */ 234wifi_error wifi_get_link_stats(wifi_request_id id, 235 wifi_interface_handle iface, wifi_stats_result_handler handler); 236 237/* wifi statistics bitmap */ 238#define WIFI_STATS_RADIO 0x00000001 // all radio statistics 239#define WIFI_STATS_RADIO_CCA 0x00000002 // cca_busy_time (within radio statistics) 240#define WIFI_STATS_RADIO_CHANNELS 0x00000004 // all channel statistics (within radio statistics) 241#define WIFI_STATS_RADIO_SCAN 0x00000008 // all scan statistics (within radio statistics) 242#define WIFI_STATS_IFACE 0x00000010 // all interface statistics 243#define WIFI_STATS_IFACE_TXRATE 0x00000020 // all tx rate statistics (within interface statistics) 244#define WIFI_STATS_IFACE_AC 0x00000040 // all ac statistics (within interface statistics) 245#define WIFI_STATS_IFACE_CONTENTION 0x00000080 // all contention (min, max, avg) statistics (within ac statisctics) 246 247/* clear api to reset statistics, stats_clear_rsp_mask identifies what stats have been cleared 248 stop_req = 1 will imply whether to stop the statistics collection. 249 stop_rsp = 1 will imply that stop_req was honored and statistics collection was stopped. 250 */ 251wifi_error wifi_clear_link_stats(wifi_interface_handle iface, 252 u32 stats_clear_req_mask, u32 *stats_clear_rsp_mask, u8 stop_req, u8 *stop_rsp); 253 254#ifdef __cplusplus 255} 256#endif /* __cplusplus */ 257 258#endif /*__WIFI_HAL_STATS_ */ 259 260