xref: /wlan-dirver/qca-wifi-host-cmn/umac/cfr/dispatcher/inc/wlan_cfr_utils_api.h (revision 45a38684b07295822dc8eba39e293408f203eec8)
1 
2 /*
3  * Copyright (c) 2019-2020 The Linux Foundation. All rights reserved.
4  *
5  * Permission to use, copy, modify, and/or distribute this software for
6  * any purpose with or without fee is hereby granted, provided that the
7  * above copyright notice and this permission notice appear in all
8  * copies.
9  *
10  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
11  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
12  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
13  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
14  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
15  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
16  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
17  * PERFORMANCE OF THIS SOFTWARE.
18  */
19 
20 #ifndef _WLAN_CFR_UTILS_API_H_
21 #define _WLAN_CFR_UTILS_API_H_
22 
23 #include <wlan_objmgr_cmn.h>
24 #include <qdf_streamfs.h>
25 #ifdef WLAN_ENH_CFR_ENABLE
26 #include <qdf_timer.h>
27 #endif
28 
29 #define cfr_alert(format, args...) \
30 		QDF_TRACE_FATAL(QDF_MODULE_ID_CFR, format, ## args)
31 
32 #define cfr_err(format, args...) \
33 		QDF_TRACE_ERROR(QDF_MODULE_ID_CFR, format, ## args)
34 
35 #define cfr_warn(format, args...) \
36 		QDF_TRACE_WARN(QDF_MODULE_ID_CFR, format, ## args)
37 
38 #define cfr_info(format, args...) \
39 		QDF_TRACE_INFO(QDF_MODULE_ID_CFR, format, ## args)
40 
41 #define cfr_debug(format, args...) \
42 		QDF_TRACE_DEBUG(QDF_MODULE_ID_CFR, format, ## args)
43 
44 #define DBR_EVENT_TIMEOUT_IN_MS_CFR 1
45 #define DBR_NUM_RESP_PER_EVENT_CFR 1
46 #define MAX_CFR_ENABLED_CLIENTS 10
47 #define CFR_CAPTURE_HOST_MEM_REQ_ID 9
48 #define CFR_HOST_MEM_READ_INDEX_DEFAULT 8
49 #define CFR_VENDOR_ID 0x8cfdf0
50 #ifdef WLAN_ENH_CFR_ENABLE
51 #define MAX_CFR_MU_USERS 4
52 #define NUM_CHAN_CAPTURE_STATUS 4
53 #define NUM_CHAN_CAPTURE_REASON 6
54 #define MAX_TA_RA_ENTRIES 16
55 #define MAX_RESET_CFG_ENTRY 0xFFFF
56 #define CFR_INVALID_VDEV_ID 0xff
57 #define DEFAULT_SRNGID_CFR 0
58 #endif
59 
60 enum cfrmetaversion {
61 	CFR_META_VERSION_NONE,
62 	CFR_META_VERSION_1,
63 	CFR_META_VERSION_2,
64 	CFR_META_VERSION_3,
65 	CFR_META_VERSION_MAX = 0xFF,
66 };
67 
68 enum cfrdataversion {
69 	CFR_DATA_VERSION_NONE,
70 	CFR_DATA_VERSION_1,
71 	CFR_DATA_VERSION_MAX = 0xFF,
72 };
73 
74 enum cfrplatformtype {
75 	CFR_PLATFORM_TYPE_NONE,
76 	CFR_PLATFORM_TYPE_MIPS,
77 	CFR_PLATFORM_TYPE_ARM,
78 	CFR_PLATFFORM_TYPE_MAX = 0xFF,
79 };
80 
81 enum cfrradiotype {
82 	CFR_CAPTURE_RADIO_NONE,
83 	CFR_CAPTURE_RADIO_OSPREY,
84 	CFR_CAPTURE_RADIO_PEAKCOCK,
85 	CFR_CAPTURE_RADIO_SCORPION,
86 	CFR_CAPTURE_RADIO_HONEYBEE,
87 	CFR_CAPTURE_RADIO_DRAGONFLY,
88 	CFR_CAPTURE_RADIO_JET,
89 	CFR_CAPTURE_RADIO_PEREGRINE = 17,
90 	CFR_CAPTURE_RADIO_SWIFT,
91 	CFR_CAPTURE_RADIO_BEELINER,
92 	CFR_CAPTURE_RADIO_CASCADE,
93 	CFR_CAPTURE_RADIO_DAKOTA,
94 	CFR_CAPTURE_RADIO_BESRA,
95 	CFR_CAPTURE_RADIO_HKV2,
96 	CFR_CAPTURE_RADIO_CYP,
97 	CFR_CAPTURE_RADIO_HSP,
98 	CFR_CAPTURE_RADIO_PINE,
99 	CFR_CAPTURE_RADIO_ADRASTEA,
100 	CFR_CAPTURE_RADIO_MAX = 0xFF,
101 };
102 
103 enum ack_capture_mode {
104 	CFR_LEGACY_ACK     = 0,
105 	CFR_DUP_LEGACY_ACK = 1,
106 	CFR_HT_ACK         = 2,
107 	CFR_VHT_ACK        = 3,
108 	CFR_INVALID_ACK, /*Always keep this at last*/
109 };
110 
111 /* Similar to WMI_PEER_CFR_CAPTURE_METHOD used in one-shot capture */
112 enum cfr_capture_type {
113 	CFR_TYPE_METHOD_NULL_FRAME = 0,
114 	CFR_TYPE_METHOD_NULL_FRAME_WITH_PHASE = 1,
115 	CFR_TYPE_METHOD_PROBE_RESP = 2,
116 	CFR_TYPE_METHOD_TM = 3,
117 	CFR_TYPE_METHOD_FTM = 4,
118 	CFR_TYPE_METHOD_ACK_RESP_TO_TM_FTM = 5,
119 	CFR_TYPE_METHOD_TA_RA_TYPE_FILTER = 6,
120 	CFR_TYPE_METHOD_NDPA_NDP = 7,
121 	CFR_TYPE_METHOD_ALL_PACKET = 8,
122 	/* Add new capture methods before this line */
123 	CFR_TYPE_METHOD_LAST_VALID,
124 	CFR_TYPE_METHOD_AUTO = 0xff,
125 	CFR_TYPE_METHOD_MAX,
126 };
127 
128 struct cfr_metadata_version_1 {
129 	u_int8_t    peer_addr[QDF_MAC_ADDR_SIZE];
130 	u_int8_t    status;
131 	u_int8_t    capture_bw;
132 	u_int8_t    channel_bw;
133 	u_int8_t    phy_mode;
134 	u_int16_t   prim20_chan;
135 	u_int16_t   center_freq1;
136 	u_int16_t   center_freq2;
137 	u_int8_t    capture_mode;
138 	u_int8_t    capture_type;
139 	u_int8_t    sts_count;
140 	u_int8_t    num_rx_chain;
141 	u_int32_t   timestamp;
142 	u_int32_t   length;
143 } __attribute__ ((__packed__));
144 
145 #define HOST_MAX_CHAINS 8
146 
147 struct cfr_metadata_version_2 {
148 	u_int8_t    peer_addr[QDF_MAC_ADDR_SIZE];
149 	u_int8_t    status;
150 	u_int8_t    capture_bw;
151 	u_int8_t    channel_bw;
152 	u_int8_t    phy_mode;
153 	u_int16_t   prim20_chan;
154 	u_int16_t   center_freq1;
155 	u_int16_t   center_freq2;
156 	u_int8_t    capture_mode;
157 	u_int8_t    capture_type;
158 	u_int8_t    sts_count;
159 	u_int8_t    num_rx_chain;
160 	u_int32_t   timestamp;
161 	u_int32_t   length;
162 	u_int32_t   chain_rssi[HOST_MAX_CHAINS];
163 	u_int16_t   chain_phase[HOST_MAX_CHAINS];
164 } __attribute__ ((__packed__));
165 
166 #ifdef WLAN_ENH_CFR_ENABLE
167 struct cfr_metadata_version_3 {
168 	u_int8_t    status;
169 	u_int8_t    capture_bw;
170 	u_int8_t    channel_bw;
171 	u_int8_t    phy_mode;
172 	u_int16_t   prim20_chan;
173 	u_int16_t   center_freq1;
174 	u_int16_t   center_freq2;
175 	u_int8_t    capture_mode; /* ack_capture_mode */
176 	u_int8_t    capture_type; /* cfr_capture_type */
177 	u_int8_t    sts_count;
178 	u_int8_t    num_rx_chain;
179 	u_int32_t   timestamp;
180 	u_int32_t   length;
181 	u_int8_t    is_mu_ppdu;
182 	u_int8_t    num_mu_users;
183 	union {
184 		u_int8_t    su_peer_addr[QDF_MAC_ADDR_SIZE];
185 		u_int8_t    mu_peer_addr[MAX_CFR_MU_USERS][QDF_MAC_ADDR_SIZE];
186 	} peer_addr;
187 	u_int32_t   chain_rssi[HOST_MAX_CHAINS];
188 	u_int16_t   chain_phase[HOST_MAX_CHAINS];
189 } __attribute__ ((__packed__));
190 #endif
191 
192 struct csi_cfr_header {
193 	u_int32_t   start_magic_num;
194 	u_int32_t   vendorid;
195 	u_int8_t    cfr_metadata_version;
196 	u_int8_t    cfr_data_version;
197 	u_int8_t    chip_type;
198 	u_int8_t    pltform_type;
199 	u_int32_t   Reserved;
200 
201 	union {
202 		struct cfr_metadata_version_1 meta_v1;
203 		struct cfr_metadata_version_2 meta_v2;
204 #ifdef WLAN_ENH_CFR_ENABLE
205 		struct cfr_metadata_version_3 meta_v3;
206 #endif
207 	} u;
208 } __attribute__ ((__packed__));
209 
210 /**
211  * struct cfr_capture_params - structure to store cfr config param
212  * bandwidth: bandwitdh of capture
213  * period: period of capture
214  * method: enum of method being followed to capture cfr data. 0-QoS null data
215  */
216 struct cfr_capture_params {
217 	u_int8_t   bandwidth;
218 	u_int32_t  period;
219 	u_int8_t   method;
220 };
221 
222 /**
223  * struct psoc_cfr - private psoc object for cfr
224  * psoc_obj: pointer to psoc object
225  * is_cfr_capable: flag to determine if cfr is enabled or not
226  * is_cap_interval_mode_sel_support: flag to determine if target supports both
227  *				     capture_count and capture_duration modes
228  *				     with a nob provided to configure
229  * is_mo_marking_support: flag to determine if MO marking is supported or not
230  */
231 struct psoc_cfr {
232 	struct wlan_objmgr_psoc *psoc_obj;
233 	uint8_t is_cfr_capable;
234 #ifdef WLAN_ENH_CFR_ENABLE
235 	uint8_t is_cap_interval_mode_sel_support;
236 	uint8_t is_mo_marking_support;
237 #endif
238 };
239 
240 /**
241  * struct cfr_wmi_host_mem_chunk - wmi mem chunk related
242  * vaddr: pointer to virtual address
243  * paddr: physical address
244  * len: len of the mem chunk allocated
245  * req_id: reqid related to the mem chunk
246  */
247 struct cfr_wmi_host_mem_chunk {
248 	uint32_t *vaddr;
249 	qdf_dma_addr_t paddr;
250 	uint32_t len;
251 	uint32_t req_id;
252 };
253 
254 struct whal_cfir_dma_hdr {
255 	uint16_t
256 		// 'BA'
257 		tag                 : 8,
258 		// '02', length of header in 4 octet units
259 		length              : 6,
260 		// 00
261 		reserved            : 2;
262 	uint16_t
263 		// [16]
264 		upload_done         : 1,
265 		// [17:18], 0: invalid, 1: CFR, 2: CIR, 3: DebugH
266 		capture_type        : 3,
267 		// [19:20], 0: Legacy, 1: HT, 2: VHT, 3: HE
268 		preamble_type       : 2,
269 		// [21:23], 0: 1-stream, 1: 2-stream, ..., 7: 8-stream
270 		nss                 : 3,
271 		// [24:27], 0: invalid, 1: 1-chain, 2: 2-chain, etc.
272 		num_chains          : 3,
273 		// [28:30], 0: 20 MHz, 1: 40 MHz, 2: 80 MHz, 3: 160 MHz
274 		upload_pkt_bw       : 3,    // [31]
275 		sw_peer_id_valid    : 1;
276 	uint16_t
277 		sw_peer_id          : 16;   // [15:0]
278 	uint16_t
279 		phy_ppdu_id         : 16;   // [15:0]
280 };
281 
282 #define MAX_LUT_ENTRIES 140 /* For HKv2 136 is max */
283 
284 /**
285  * struct look_up_table - Placeholder for 2 asynchronous events (DBR and
286  * TXRX event)
287  * dbr_recv: Indicates whether WMI for DBR completion is received or not
288  * tx_recv: Indicates whether WMI for TX completion (or) WDI event for RX
289  * status is received or not
290  * data: pointer to CFR data that ucode DMAs to host memory
291  * data_len: length of CFR data DMAed by ucode
292  * dbr_ppdu_id: PPDU id retrieved from DBR completion WMI event
293  * tx_ppdu_id: PPDU id retrieved from WMI TX completion event (or) PPDU status
294  * TLV
295  * dbr_address: Physical address of the CFR data dump retrieved from DBR
296  * completion WMI event
297  * tx_address1: Physical address of the CFR data from TX/RX event
298  * tx_address2: Physical address of the CFR data from TX/RX event
299  * csi_cfr_header: CFR header constructed by host
300  * whal_cfir_enhanced_hdr: CFR header constructed by ucode
301  * tx_tstamp: Timestamp when TX/RX event was received
302  * dbr_tstamp: Timestamp when DBR completion event was received
303  * header_length: Length of header DMAed by ucode in words
304  * payload_length: Length of CFR payload
305  */
306 struct look_up_table {
307 	bool dbr_recv;
308 	bool tx_recv;
309 	uint8_t *data; /* capture payload */
310 	uint32_t data_len; /* capture len */
311 	uint16_t dbr_ppdu_id; /* ppdu id from dbr */
312 	uint16_t tx_ppdu_id; /* ppdu id from TX event */
313 	qdf_dma_addr_t dbr_address; /* capture len */
314 	uint32_t tx_address1; /* capture len */
315 	uint32_t tx_address2; /* capture len */
316 	struct csi_cfr_header header;
317 	struct whal_cfir_dma_hdr dma_hdr;
318 	uint64_t txrx_tstamp;
319 	uint64_t dbr_tstamp;
320 	uint32_t header_length;
321 	uint32_t payload_length;
322 };
323 
324 struct unassoc_pool_entry {
325 	struct qdf_mac_addr mac;
326 	struct cfr_capture_params cfr_params;
327 	bool is_valid;
328 };
329 
330 #ifdef WLAN_ENH_CFR_ENABLE
331 /**
332  * struct ta_ra_cfr_cfg - structure to store configuration of 16 groups in
333  * M_TA_RA mode
334  * filter_group_id: Filter group number for which the below filters needs to be
335  * applied
336  * bw: CFR capture will be done for packets matching the bandwidths specified
337  * within this bitmask
338  * nss: CFR capture will be done for packets matching the Nss specified within
339  * this bitmask
340  * valid_ta: Ta_addr is valid if set
341  * valid_ta_mask: Ta_addr_mask is valid if set
342  * valid_ra: Ra_addr is valid if set
343  * valid_ra_mask: Ra_addr_mask is valid if set
344  * valid_bw_mask: Bandwidth is valid if set
345  * valid_nss_mask: NSS is valid if set
346  * valid_mgmt_subtype: Mgmt_subtype is valid if set
347  * valid_ctrl_subtype: Ctrl_subtype is valid if set
348  * valid_data_subtype: Data_subtype is valid if set
349  * mgmt_subtype_filter: Managments Packets matching the subtype filter
350  * categories will be filtered in by MAC for CFR capture.
351  * ctrl_subtype_filter: Control Packets matching the subtype filter
352  * categories will be filtered in by MAC for CFR capture.
353  * data_subtype_filter: Data Packets matching the subtype filter
354  * categories will be filtered in by MAC for CFR capture.
355  * tx_addr: Packets whose transmitter address matches (tx_addr & tx_addr_mask)
356  * will be filtered in by MAC
357  * tx_addr_mask: Packets whose transmitter address matches (tx_addr &
358  * tx_addr_mask) will be filtered in by MAC
359  * rx_addr: Packets whose receiver address matches (rx_addr & rx_addr_mask)
360  * will be filtered in by MAC
361  * rx_addr_mask: Packets whose receiver address matches (rx_addr &
362  * rx_addr_mask) will be filtered in by MAC
363  */
364 struct ta_ra_cfr_cfg {
365 	uint8_t filter_group_id;
366 	uint16_t bw                          :5,
367 		 nss                         :8,
368 		 rsvd0                       :3;
369 	uint16_t valid_ta                    :1,
370 		 valid_ta_mask               :1,
371 		 valid_ra                    :1,
372 		 valid_ra_mask               :1,
373 		 valid_bw_mask               :1,
374 		 valid_nss_mask              :1,
375 		 valid_mgmt_subtype          :1,
376 		 valid_ctrl_subtype          :1,
377 		 valid_data_subtype          :1,
378 		 rsvd1                       :7;
379 	uint16_t mgmt_subtype_filter;
380 	uint16_t ctrl_subtype_filter;
381 	uint16_t data_subtype_filter;
382 	uint8_t tx_addr[QDF_MAC_ADDR_SIZE];
383 	uint8_t rx_addr[QDF_MAC_ADDR_SIZE];
384 	uint8_t tx_addr_mask[QDF_MAC_ADDR_SIZE];
385 	uint8_t rx_addr_mask[QDF_MAC_ADDR_SIZE];
386 
387 } qdf_packed;
388 
389 /**
390  * struct cfr_rcc_param - structure to store cfr config param
391  * pdev_id: pdev_id for identifying the MAC
392  * vdev_id: vdev_id of current rcc configures
393  * srng_id: srng id of current rcc configures
394  * capture_duration: Capture Duration field for which CFR capture has to happen,
395  * in microsecond units
396  * capture_interval: Capture interval field which is time in between
397  * consecutive CFR capture, in microsecond units
398  * ul_mu_user_mask_lower: Bitfields indicates which of the users in the current
399  * UL MU tranmission are enabled for CFR capture.
400  * ul_mu_user_mask_upper: This is contiuation of the above lower mask.
401  * freeze_tlv_delay_cnt_en: Enable Freeze TLV delay counter in MAC
402  * freeze_tlv_delay_cnt_thr: Indicates the number of consecutive Rx packets to
403  * be skipped before CFR capture is enabled again.
404  * filter_group_bitmap: Bitfields set indicates which of the CFR group config is
405  * enabled
406  * m_directed_ftm: Filter Directed FTM ACK frames for CFR capture
407  * m_all_ftm_ack: Filter All FTM ACK frames for CFR capture
408  * m_ndpa_ndp_directed: Filter NDPA NDP Directed Frames for CFR capture
409  * m_ndpa_ndp_all: Filter all NDPA NDP for CFR capture
410  * m_ta_ra_filter: Filter Frames based on TA/RA/Subtype as provided in CFR Group
411  * config
412  * m_all_packet: Filter in All packets for CFR Capture
413  * en_ta_ra_filter_in_as_fp: Filter in frames as FP/MO in m_ta_ra_filter mode
414  * num_grp_tlvs: Indicates the number of groups in M_TA_RA mode, that have
415  * changes in the current commit session, use to construct WMI group TLV(s)
416  * curr: Placeholder for M_TA_RA group config in current commit session
417  * modified_in_curr_session: Bitmap indicating number of groups in M_TA_RA mode
418  * that have changed in current commit session.
419  * capture_count: After capture_count+1 number of captures, MAC stops RCC  and
420  * waits for capture_interval duration before enabling again
421  * capture_intval_mode_sel: 0 indicates capture_duration mode, 1 indicates the
422  * capture_count mode.
423  */
424 struct cfr_rcc_param {
425 	uint8_t pdev_id;
426 	uint8_t vdev_id;
427 	uint8_t srng_id;
428 	uint32_t capture_duration;
429 	uint32_t capture_interval;
430 	uint32_t ul_mu_user_mask_lower;
431 	uint32_t ul_mu_user_mask_upper;
432 	uint16_t freeze_tlv_delay_cnt_en  :1,
433 		 freeze_tlv_delay_cnt_thr :8,
434 		 rsvd0 :7;
435 	uint16_t filter_group_bitmap;
436 	uint8_t m_directed_ftm           : 1,
437 		m_all_ftm_ack            : 1,
438 		m_ndpa_ndp_directed      : 1,
439 		m_ndpa_ndp_all           : 1,
440 		m_ta_ra_filter           : 1,
441 		m_all_packet             : 1,
442 		en_ta_ra_filter_in_as_fp : 1,
443 		rsvd1                    : 1;
444 	uint8_t num_grp_tlvs;
445 
446 	struct ta_ra_cfr_cfg curr[MAX_TA_RA_ENTRIES];
447 	uint16_t modified_in_curr_session;
448 	uint32_t capture_count            :16,
449 		 capture_intval_mode_sel  :1,
450 		 rsvd2                    :15;
451 };
452 #endif /* WLAN_ENH_CFR_ENABLE */
453 
454 /**
455  * struct pdev_cfr - private pdev object for cfr
456  * pdev_obj: pointer to pdev object
457  * is_cfr_capable: flag to determine if cfr is enabled or not
458  * cfr_timer_enable: flag to enable/disable timer
459  * chip_type: chip type which is defined in enum cfrradiotype
460  * cfr_mem_chunk: Region of memory used for storing cfr data
461  * cfr_max_sta_count: Maximum stations supported in one-shot capture mode
462  * num_subbufs: No. of sub-buffers used in relayfs
463  * subbuf_size: Size of sub-buffer used in relayfs
464  * chan_ptr: Channel in relayfs
465  * dir_ptr: Parent directory of relayfs file
466  * lut: lookup table used to store asynchronous DBR and TX/RX events for
467  * correlation
468  * lut_num: Number of lut
469  * dbr_buf_size: Size of DBR completion buffer
470  * dbr_num_bufs: No. of DBR completions
471  * tx_evt_cnt: No. of TX completion events till CFR stop was issued
472  * total_tx_evt_cnt: No. of Tx completion events since wifi was up
473  * dbr_evt_cnt: No. of WMI DBR completion events
474  * release_cnt: No. of CFR data buffers relayed to userspace
475  * tx_peer_status_cfr_fail: No. of tx events without tx status set to
476  * PEER_CFR_CAPTURE_EVT_STATUS_MASK indicating CFR capture failure on a peer.
477  * tx_evt_status_cfr_fail: No. of tx events without tx status set to
478  * CFR_TX_EVT_STATUS_MASK indicating CFR capture status failure.
479  * tx_dbr_cookie_lookup_fail: No. of dbr cookie lookup failures during tx event
480  * process.
481  * rcc_param: Structure to store CFR config for the current commit session
482  * global: Structure to store accumulated CFR config
483  * rx_tlv_evt_cnt: Number of CFR WDI events from datapath
484  * lut_age_timer: Timer to flush pending TXRX/DBR events in lookup table
485  * lut_timer_init: flag to determine if lut_age_timer is initialized or not
486  * is_cfr_rcc_capable: Flag to determine if RCC is enabled or not.
487  * flush_dbr_cnt: No. of un-correlated DBR completions flushed when a newer PPDU
488  * is correlated successfully with newer DBR completion
489  * invalid_dma_length_cnt: No. of buffers for which CFR DMA header length (or)
490  * data length was invalid
491  * flush_timeout_dbr_cnt: No. of DBR completion flushed out in ageout logic
492  * clear_txrx_event: No. of PPDU status TLVs over-written in LUT
493  * last_success_tstamp: DBR timestamp which indicates that both DBR and TX/RX
494  * events have been received successfully.
495  * cfr_dma_aborts: No. of CFR DMA aborts in ucode
496  * is_cap_interval_mode_sel_support: flag to determine if target supports both
497  * is_mo_marking_support: flag to determine if MO marking is supported or not
498  * capture_count and capture_duration modes with a nob provided to configure.
499  * unassoc_pool: Pool of un-associated clients used when capture method is
500  * CFR_CAPTURE_METHOD_PROBE_RESPONSE
501  * lut_lock: Lock to protect access to cfr lookup table
502  */
503 /*
504  * To be extended if we get more capbality info
505  * from FW's extended service ready event.
506  */
507 struct pdev_cfr {
508 	struct wlan_objmgr_pdev *pdev_obj;
509 	uint8_t is_cfr_capable;
510 	uint8_t cfr_timer_enable;
511 	uint8_t chip_type;
512 	struct cfr_wmi_host_mem_chunk cfr_mem_chunk;
513 	uint16_t cfr_max_sta_count;
514 	uint16_t cfr_current_sta_count;
515 	uint32_t num_subbufs;
516 	uint32_t subbuf_size;
517 	qdf_streamfs_chan_t chan_ptr;
518 	qdf_dentry_t dir_ptr;
519 	struct look_up_table **lut;
520 	uint32_t lut_num;
521 	uint32_t dbr_buf_size;
522 	uint32_t dbr_num_bufs;
523 	uint32_t max_mu_users;
524 	uint64_t tx_evt_cnt;
525 	uint64_t total_tx_evt_cnt;
526 	uint64_t dbr_evt_cnt;
527 	uint64_t release_cnt;
528 	uint64_t tx_peer_status_cfr_fail;
529 	uint64_t tx_evt_status_cfr_fail;
530 	uint64_t tx_dbr_cookie_lookup_fail;
531 #ifdef WLAN_ENH_CFR_ENABLE
532 	struct cfr_rcc_param rcc_param;
533 	struct ta_ra_cfr_cfg global[MAX_TA_RA_ENTRIES];
534 	uint64_t rx_tlv_evt_cnt;
535 	qdf_timer_t lut_age_timer;
536 	uint8_t lut_timer_init;
537 	uint8_t is_cfr_rcc_capable;
538 	uint64_t flush_dbr_cnt;
539 	uint64_t invalid_dma_length_cnt;
540 	uint64_t flush_timeout_dbr_cnt;
541 	uint64_t clear_txrx_event;
542 	uint64_t last_success_tstamp;
543 	uint64_t cfr_dma_aborts;
544 	uint8_t is_cap_interval_mode_sel_support;
545 	uint8_t is_mo_marking_support;
546 #endif
547 	struct unassoc_pool_entry unassoc_pool[MAX_CFR_ENABLED_CLIENTS];
548 	qdf_spinlock_t lut_lock;
549 };
550 
551 /**
552  * enum cfr_capt_status - CFR capture status
553  */
554 enum cfr_capt_status {
555 	/* Capture not in progress */
556 	PEER_CFR_CAPTURE_DISABLE,
557 	/* Capture in progress */
558 	PEER_CFR_CAPTURE_ENABLE,
559 };
560 
561 /**
562  * struct peer_cfr - private peer object for cfr
563  * peer_obj: pointer to peer_obj
564  * request: Type of request (start/stop)
565  * bandwidth: bandwitdth of capture for this peer
566  * capture_method: enum determining type of cfr data capture.
567  *                 0-Qos null data
568  */
569 struct peer_cfr {
570 	struct wlan_objmgr_peer *peer_obj;
571 	u_int8_t   request;            /* start/stop */
572 	u_int8_t   bandwidth;
573 	u_int32_t  period;
574 	u_int8_t   capture_method;
575 };
576 
577 /**
578  * cfr_initialize_pdev() - cfr initialize pdev
579  * @pdev: Pointer to pdev_obj
580  *
581  * Return: status of cfr pdev init
582  */
583 QDF_STATUS cfr_initialize_pdev(struct wlan_objmgr_pdev *pdev);
584 
585 /**
586  * cfr_deinitialize_pdev() - cfr deinitialize pdev
587  * @pdev: Pointer to pdev_obj
588  *
589  * Return: status of cfr pdev deinit
590  */
591 QDF_STATUS cfr_deinitialize_pdev(struct wlan_objmgr_pdev *pdev);
592 
593 /**
594  * wlan_cfr_init() - Global init for cfr.
595  *
596  * Return: status of global init pass/fail
597  */
598 QDF_STATUS wlan_cfr_init(void);
599 
600 /**
601  * wlan_cfr_deinit() - Global de-init for cfr.
602  *
603  * Return: status of global de-init pass/fail
604  */
605 QDF_STATUS wlan_cfr_deinit(void);
606 
607 /**
608  * wlan_cfr_pdev_open() - pdev_open function for cfr.
609  * @pdev: pointer to pdev object
610  *
611  * Return: status of pdev_open pass/fail
612  */
613 QDF_STATUS wlan_cfr_pdev_open(struct wlan_objmgr_pdev *pdev);
614 
615 /**
616  * wlan_cfr_pdev_close() - pdev_close function for cfr.
617  * @pdev: pointer to pdev object
618  *
619  * Return: status of pdev_close pass/fail
620  */
621 QDF_STATUS wlan_cfr_pdev_close(struct wlan_objmgr_pdev *pdev);
622 
623 /**
624  * count_set_bits() - function to count set bits in a bitmap
625  * @value: input bitmap
626  *
627  * Return: No. of set bits
628  */
629 uint8_t count_set_bits(uint32_t value);
630 
631 /**
632  * wlan_cfr_is_feature_disabled() - Check if cfr feature is disabled
633  * @pdev - the physical device object.
634  *
635  * Return : true if cfr is disabled, else false.
636  */
637 bool wlan_cfr_is_feature_disabled(struct wlan_objmgr_pdev *pdev);
638 
639 #ifdef WLAN_ENH_CFR_ENABLE
640 /**
641  * wlan_cfr_rx_tlv_process() - Process PPDU status TLVs and store info in
642  * lookup table
643  * @pdev_obj: PDEV object
644  * @nbuf: ppdu info
645  *
646  * Return: none
647  */
648 void wlan_cfr_rx_tlv_process(struct wlan_objmgr_pdev *pdev, void *nbuf);
649 #endif
650 #endif
651