xref: /wlan-dirver/qca-wifi-host-cmn/umac/cfr/dispatcher/inc/wlan_cfr_utils_api.h (revision 8b3dca18206e1a0461492f082fa6e270b092c035)
1 /*
2  * Copyright (c) 2019-2021 The Linux Foundation. All rights reserved.
3  * Copyright (c) 2021-2022 Qualcomm Innovation Center, Inc. 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 #if defined(QCA_WIFI_QCA6750) || defined(QCA_WIFI_QCA6490)
55 #define MAX_TA_RA_ENTRIES 4
56 #define MAX_RESET_CFG_ENTRY 0xF
57 #else
58 #define MAX_TA_RA_ENTRIES 16
59 #define MAX_RESET_CFG_ENTRY 0xFFFF
60 #endif
61 #define CFR_INVALID_VDEV_ID 0xff
62 #define DEFAULT_SRNGID_CFR 0
63 #endif
64 
65 #define MAX_CFR_PRD  (10 * 60 * 1000)   /* 10 minutes */
66 #define CFR_MOD_PRD  10                 /* CFR period to be multiples of 10ms */
67 
68 #define MAX_AGC_GAIN 62
69 
70 enum cfrmetaversion {
71 	CFR_META_VERSION_NONE,
72 	CFR_META_VERSION_1, /* initial version for legacy_cfr_metadata */
73 	CFR_META_VERSION_2, /* initial version for dbr_cfr_metadata */
74 	CFR_META_VERSION_3, /* initial version for enh_cfr_metadata */
75 	CFR_META_VERSION_4, /* agc gain, cfo, rx_start_ts in dbr_cfr_metadata */
76 	CFR_META_VERSION_5, /* agc gain, cfo, rx_start_ts in enh_cfr_metadata */
77 	CFR_META_VERSION_6, /* mcs, gi_type in dbr_cfr_metadata */
78 	CFR_META_VERSION_7, /* mcs, gi_type, sig_info in enh_cfr_metadata */
79 	CFR_META_VERSION_8, /* agc gain table index in dbr_cfr_metadata */
80 	CFR_META_VERSION_9, /* agc gain table index in enh_cfr_metadata */
81 	CFR_META_VERSION_MAX = 0xFF,
82 };
83 
84 enum cfrdataversion {
85 	CFR_DATA_VERSION_NONE,
86 	CFR_DATA_VERSION_1,
87 	CFR_DATA_VERSION_MAX = 0xFF,
88 };
89 
90 enum cfrplatformtype {
91 	CFR_PLATFORM_TYPE_NONE,
92 	CFR_PLATFORM_TYPE_MIPS,
93 	CFR_PLATFORM_TYPE_ARM,
94 	CFR_PLATFFORM_TYPE_MAX = 0xFF,
95 };
96 
97 enum cfrradiotype {
98 	CFR_CAPTURE_RADIO_NONE,
99 	CFR_CAPTURE_RADIO_OSPREY,
100 	CFR_CAPTURE_RADIO_PEAKCOCK,
101 	CFR_CAPTURE_RADIO_SCORPION,
102 	CFR_CAPTURE_RADIO_HONEYBEE,
103 	CFR_CAPTURE_RADIO_DRAGONFLY,
104 	CFR_CAPTURE_RADIO_JET,
105 	CFR_CAPTURE_RADIO_PEREGRINE = 17,
106 	CFR_CAPTURE_RADIO_SWIFT,
107 	CFR_CAPTURE_RADIO_BEELINER,
108 	CFR_CAPTURE_RADIO_CASCADE,
109 	CFR_CAPTURE_RADIO_DAKOTA,
110 	CFR_CAPTURE_RADIO_BESRA,
111 	CFR_CAPTURE_RADIO_HKV2,
112 	CFR_CAPTURE_RADIO_CYP,
113 	CFR_CAPTURE_RADIO_HSP,
114 	CFR_CAPTURE_RADIO_PINE,
115 	CFR_CAPTURE_RADIO_ADRASTEA,
116 	CFR_CAPTURE_RADIO_MAPLE,
117 	CFR_CAPTURE_RADIO_MOSELLE,
118 	CFR_CAPTURE_RADIO_SPRUCE,
119 	CFR_CAPTURE_RADIO_ALDER,
120 	CFR_CAPTURE_RADIO_WAIKIKI,
121 	CFR_CAPTURE_RADIO_KIWI,
122 	CFR_CAPTURE_RADIO_MANGO,
123 	CFR_CAPTURE_RADIO_MIAMI,
124 	CFR_CAPTURE_RADIO_MAX = 0xFF,
125 };
126 
127 enum ack_capture_mode {
128 	CFR_LEGACY_ACK     = 0,
129 	CFR_DUP_LEGACY_ACK = 1,
130 	CFR_HT_ACK         = 2,
131 	CFR_VHT_ACK        = 3,
132 	CFR_INVALID_ACK, /*Always keep this at last*/
133 };
134 
135 /* Similar to WMI_PEER_CFR_CAPTURE_METHOD used in one-shot capture */
136 enum cfr_capture_type {
137 	CFR_TYPE_METHOD_NULL_FRAME = 0,
138 	CFR_TYPE_METHOD_NULL_FRAME_WITH_PHASE = 1,
139 	CFR_TYPE_METHOD_PROBE_RESP = 2,
140 	CFR_TYPE_METHOD_TM = 3,
141 	CFR_TYPE_METHOD_FTM = 4,
142 	CFR_TYPE_METHOD_ACK_RESP_TO_TM_FTM = 5,
143 	CFR_TYPE_METHOD_TA_RA_TYPE_FILTER = 6,
144 	CFR_TYPE_METHOD_NDPA_NDP = 7,
145 	CFR_TYPE_METHOD_ALL_PACKET = 8,
146 	/* Add new capture methods before this line */
147 	CFR_TYPE_METHOD_LAST_VALID,
148 	CFR_TYPE_METHOD_AUTO = 0xff,
149 	CFR_TYPE_METHOD_MAX,
150 };
151 
152 #define HOST_MAX_CHAINS 8
153 
154 /* ensure to add new members at the end of the structure only */
155 struct dbr_cfr_metadata {
156 	u_int8_t    peer_addr[QDF_MAC_ADDR_SIZE];
157 	u_int8_t    status;
158 	u_int8_t    capture_bw;
159 	u_int8_t    channel_bw;
160 	u_int8_t    phy_mode;
161 	u_int16_t   prim20_chan;
162 	u_int16_t   center_freq1;
163 	u_int16_t   center_freq2;
164 	u_int8_t    capture_mode;
165 	u_int8_t    capture_type;
166 	u_int8_t    sts_count;
167 	u_int8_t    num_rx_chain;
168 	u_int32_t   timestamp;
169 	u_int32_t   length;
170 	u_int32_t   chain_rssi[HOST_MAX_CHAINS];
171 	u_int16_t   chain_phase[HOST_MAX_CHAINS];
172 	u_int32_t   rtt_cfo_measurement;
173 	u_int8_t    agc_gain[HOST_MAX_CHAINS];
174 	u_int32_t   rx_start_ts;
175 	u_int16_t   mcs_rate;
176 	u_int16_t   gi_type;
177 	u_int8_t    agc_gain_tbl_index[HOST_MAX_CHAINS];
178 } __attribute__ ((__packed__));
179 
180 #ifdef WLAN_ENH_CFR_ENABLE
181 struct cfr_su_sig_info {
182 	u_int8_t coding;
183 	u_int8_t stbc;
184 	u_int8_t beamformed;
185 	u_int8_t dcm;
186 	u_int8_t ltf_size;
187 	u_int8_t sgi;
188 	u_int16_t reserved;
189 } __attribute__ ((__packed__));
190 
191 /* ensure to add new members at the end of the structure only */
192 struct enh_cfr_metadata {
193 	u_int8_t    status;
194 	u_int8_t    capture_bw;
195 	u_int8_t    channel_bw;
196 	u_int8_t    phy_mode;
197 	u_int16_t   prim20_chan;
198 	u_int16_t   center_freq1;
199 	u_int16_t   center_freq2;
200 	u_int8_t    capture_mode; /* ack_capture_mode */
201 	u_int8_t    capture_type; /* cfr_capture_type */
202 	u_int8_t    sts_count;
203 	u_int8_t    num_rx_chain;
204 	u_int64_t   timestamp;
205 	u_int32_t   length;
206 	u_int8_t    is_mu_ppdu;
207 	u_int8_t    num_mu_users;
208 	union {
209 		u_int8_t    su_peer_addr[QDF_MAC_ADDR_SIZE];
210 		u_int8_t    mu_peer_addr[MAX_CFR_MU_USERS][QDF_MAC_ADDR_SIZE];
211 	} peer_addr;
212 	u_int32_t   chain_rssi[HOST_MAX_CHAINS];
213 	u_int16_t   chain_phase[HOST_MAX_CHAINS];
214 	u_int32_t   rtt_cfo_measurement;
215 	u_int8_t    agc_gain[HOST_MAX_CHAINS];
216 	u_int32_t   rx_start_ts;
217 	u_int16_t   mcs_rate;
218 	u_int16_t   gi_type;
219 	struct cfr_su_sig_info sig_info;
220 	u_int8_t    agc_gain_tbl_index[HOST_MAX_CHAINS];
221 } __attribute__ ((__packed__));
222 #endif
223 
224 #define  CFR_META_DATA_LEN \
225 	(sizeof(struct csi_cfr_header) - sizeof(struct cfr_header_cmn))
226 
227 struct cfr_header_cmn {
228 	u_int32_t   start_magic_num;
229 	u_int32_t   vendorid;
230 	u_int8_t    cfr_metadata_version;
231 	u_int8_t    cfr_data_version;
232 	u_int8_t    chip_type;
233 	u_int8_t    pltform_type;
234 	u_int32_t   cfr_metadata_len;
235 	u_int64_t   host_real_ts;
236 } __attribute__ ((__packed__));
237 
238 struct csi_cfr_header {
239 	struct cfr_header_cmn cmn;
240 	union {
241 		struct dbr_cfr_metadata meta_dbr;
242 #ifdef WLAN_ENH_CFR_ENABLE
243 		struct enh_cfr_metadata meta_enh;
244 #endif
245 	} u;
246 } __attribute__ ((__packed__));
247 
248 /**
249  * struct cfr_capture_params - structure to store cfr config param
250  * bandwidth: bandwitdh of capture
251  * period: period of capture
252  * method: enum of method being followed to capture cfr data. 0-QoS null data
253  */
254 struct cfr_capture_params {
255 	u_int8_t   bandwidth;
256 	u_int32_t  period;
257 	u_int8_t   method;
258 };
259 
260 /**
261  * struct psoc_cfr - private psoc object for cfr
262  * psoc_obj: pointer to psoc object
263  * is_cfr_capable: flag to determine if cfr is enabled or not
264  * is_cap_interval_mode_sel_support: flag to determine if target supports both
265  *				     capture_count and capture_duration modes
266  *				     with a nob provided to configure
267  * is_mo_marking_support: flag to determine if MO marking is supported or not
268  */
269 struct psoc_cfr {
270 	struct wlan_objmgr_psoc *psoc_obj;
271 	uint8_t is_cfr_capable;
272 #ifdef WLAN_ENH_CFR_ENABLE
273 	uint8_t is_cap_interval_mode_sel_support;
274 	uint8_t is_mo_marking_support;
275 	uint8_t is_aoa_for_rcc_support;
276 #endif
277 };
278 
279 /**
280  * struct cfr_wmi_host_mem_chunk - wmi mem chunk related
281  * vaddr: pointer to virtual address
282  * paddr: physical address
283  * len: len of the mem chunk allocated
284  * req_id: reqid related to the mem chunk
285  */
286 struct cfr_wmi_host_mem_chunk {
287 	uint32_t *vaddr;
288 	qdf_dma_addr_t paddr;
289 	uint32_t len;
290 	uint32_t req_id;
291 };
292 
293 struct whal_cfir_dma_hdr {
294 	uint16_t
295 		// 'BA'
296 		tag                 : 8,
297 		// '02', length of header in 4 octet units
298 		length              : 6,
299 		// 00
300 		reserved            : 2;
301 	uint16_t
302 		// [16]
303 		upload_done         : 1,
304 		// [17:18], 0: invalid, 1: CFR, 2: CIR, 3: DebugH
305 		capture_type        : 3,
306 		// [19:20], 0: Legacy, 1: HT, 2: VHT, 3: HE
307 		preamble_type       : 2,
308 		// [21:23], 0: 1-stream, 1: 2-stream, ..., 7: 8-stream
309 		nss                 : 3,
310 		// [24:27], 0: invalid, 1: 1-chain, 2: 2-chain, etc.
311 		num_chains          : 3,
312 		// [28:30], 0: 20 MHz, 1: 40 MHz, 2: 80 MHz, 3: 160 MHz
313 		upload_pkt_bw       : 3,    // [31]
314 		sw_peer_id_valid    : 1;
315 	uint16_t
316 		sw_peer_id          : 16;   // [15:0]
317 	uint16_t
318 		phy_ppdu_id         : 16;   // [15:0]
319 };
320 
321 #define MAX_LUT_ENTRIES 140 /* For HKv2 136 is max */
322 
323 /**
324  * struct look_up_table - Placeholder for 2 asynchronous events (DBR and
325  * TXRX event)
326  * dbr_recv: Indicates whether WMI for DBR completion is received or not
327  * tx_recv: Indicates whether WMI for TX completion (or) WDI event for RX
328  * status is received or not
329  * data: pointer to CFR data that ucode DMAs to host memory
330  * data_len: length of CFR data DMAed by ucode
331  * dbr_ppdu_id: PPDU id retrieved from DBR completion WMI event
332  * tx_ppdu_id: PPDU id retrieved from WMI TX completion event (or) PPDU status
333  * TLV
334  * dbr_address: Physical address of the CFR data dump retrieved from DBR
335  * completion WMI event
336  * tx_address1: Physical address of the CFR data from TX/RX event
337  * tx_address2: Physical address of the CFR data from TX/RX event
338  * csi_cfr_header: CFR header constructed by host
339  * whal_cfir_enhanced_hdr: CFR header constructed by ucode
340  * tx_tstamp: Timestamp when TX/RX event was received
341  * dbr_tstamp: Timestamp when DBR completion event was received
342  * header_length: Length of header DMAed by ucode in words
343  * payload_length: Length of CFR payload
344  */
345 struct look_up_table {
346 	bool dbr_recv;
347 	bool tx_recv;
348 	uint8_t *data; /* capture payload */
349 	uint32_t data_len; /* capture len */
350 	uint16_t dbr_ppdu_id; /* ppdu id from dbr */
351 	uint16_t tx_ppdu_id; /* ppdu id from TX event */
352 	qdf_dma_addr_t dbr_address; /* capture len */
353 	uint32_t tx_address1; /* capture len */
354 	uint32_t tx_address2; /* capture len */
355 	struct csi_cfr_header header;
356 	struct whal_cfir_dma_hdr dma_hdr;
357 	uint64_t txrx_tstamp;
358 	uint64_t dbr_tstamp;
359 	uint32_t header_length;
360 	uint32_t payload_length;
361 };
362 
363 struct unassoc_pool_entry {
364 	struct qdf_mac_addr mac;
365 	struct cfr_capture_params cfr_params;
366 	bool is_valid;
367 };
368 
369 #ifdef WLAN_ENH_CFR_ENABLE
370 /**
371  * struct ta_ra_cfr_cfg - structure to store configuration of 16 groups in
372  * M_TA_RA mode
373  * filter_group_id: Filter group number for which the below filters needs to be
374  * applied
375  * bw: CFR capture will be done for packets matching the bandwidths specified
376  * within this bitmask
377  * nss: CFR capture will be done for packets matching the Nss specified within
378  * this bitmask
379  * valid_ta: Ta_addr is valid if set
380  * valid_ta_mask: Ta_addr_mask is valid if set
381  * valid_ra: Ra_addr is valid if set
382  * valid_ra_mask: Ra_addr_mask is valid if set
383  * valid_bw_mask: Bandwidth is valid if set
384  * valid_nss_mask: NSS is valid if set
385  * valid_mgmt_subtype: Mgmt_subtype is valid if set
386  * valid_ctrl_subtype: Ctrl_subtype is valid if set
387  * valid_data_subtype: Data_subtype is valid if set
388  * mgmt_subtype_filter: Managments Packets matching the subtype filter
389  * categories will be filtered in by MAC for CFR capture.
390  * ctrl_subtype_filter: Control Packets matching the subtype filter
391  * categories will be filtered in by MAC for CFR capture.
392  * data_subtype_filter: Data Packets matching the subtype filter
393  * categories will be filtered in by MAC for CFR capture.
394  * tx_addr: Packets whose transmitter address matches (tx_addr & tx_addr_mask)
395  * will be filtered in by MAC
396  * tx_addr_mask: Packets whose transmitter address matches (tx_addr &
397  * tx_addr_mask) will be filtered in by MAC
398  * rx_addr: Packets whose receiver address matches (rx_addr & rx_addr_mask)
399  * will be filtered in by MAC
400  * rx_addr_mask: Packets whose receiver address matches (rx_addr &
401  * rx_addr_mask) will be filtered in by MAC
402  */
403 struct ta_ra_cfr_cfg {
404 	uint8_t filter_group_id;
405 	uint16_t bw                          :6,
406 		 nss                         :8,
407 		 rsvd0                       :2;
408 	uint16_t valid_ta                    :1,
409 		 valid_ta_mask               :1,
410 		 valid_ra                    :1,
411 		 valid_ra_mask               :1,
412 		 valid_bw_mask               :1,
413 		 valid_nss_mask              :1,
414 		 valid_mgmt_subtype          :1,
415 		 valid_ctrl_subtype          :1,
416 		 valid_data_subtype          :1,
417 		 rsvd1                       :7;
418 	uint16_t mgmt_subtype_filter;
419 	uint16_t ctrl_subtype_filter;
420 	uint16_t data_subtype_filter;
421 	uint8_t tx_addr[QDF_MAC_ADDR_SIZE];
422 	uint8_t rx_addr[QDF_MAC_ADDR_SIZE];
423 	uint8_t tx_addr_mask[QDF_MAC_ADDR_SIZE];
424 	uint8_t rx_addr_mask[QDF_MAC_ADDR_SIZE];
425 
426 } qdf_packed;
427 
428 /**
429  * struct cfr_rcc_param - structure to store cfr config param
430  * pdev_id: pdev_id for identifying the MAC
431  * vdev_id: vdev_id of current rcc configures
432  * srng_id: srng id of current rcc configures
433  * capture_duration: Capture Duration field for which CFR capture has to happen,
434  * in microsecond units
435  * capture_interval: Capture interval field which is time in between
436  * consecutive CFR capture, in microsecond units
437  * ul_mu_user_mask_lower: Bitfields indicates which of the users in the current
438  * UL MU tranmission are enabled for CFR capture.
439  * ul_mu_user_mask_upper: This is contiuation of the above lower mask.
440  * freeze_tlv_delay_cnt_en: Enable Freeze TLV delay counter in MAC
441  * freeze_tlv_delay_cnt_thr: Indicates the number of consecutive Rx packets to
442  * be skipped before CFR capture is enabled again.
443  * filter_group_bitmap: Bitfields set indicates which of the CFR group config is
444  * enabled
445  * m_directed_ftm: Filter Directed FTM ACK frames for CFR capture
446  * m_all_ftm_ack: Filter All FTM ACK frames for CFR capture
447  * m_ndpa_ndp_directed: Filter NDPA NDP Directed Frames for CFR capture
448  * m_ndpa_ndp_all: Filter all NDPA NDP for CFR capture
449  * m_ta_ra_filter: Filter Frames based on TA/RA/Subtype as provided in CFR Group
450  * config
451  * m_all_packet: Filter in All packets for CFR Capture
452  * en_ta_ra_filter_in_as_fp: Filter in frames as FP/MO in m_ta_ra_filter mode
453  * num_grp_tlvs: Indicates the number of groups in M_TA_RA mode, that have
454  * changes in the current commit session, use to construct WMI group TLV(s)
455  * curr: Placeholder for M_TA_RA group config in current commit session
456  * modified_in_curr_session: Bitmap indicating number of groups in M_TA_RA mode
457  * that have changed in current commit session.
458  * capture_count: After capture_count+1 number of captures, MAC stops RCC  and
459  * waits for capture_interval duration before enabling again
460  * capture_intval_mode_sel: 0 indicates capture_duration mode, 1 indicates the
461  * capture_count mode.
462  */
463 struct cfr_rcc_param {
464 	uint8_t pdev_id;
465 	uint8_t vdev_id;
466 	uint8_t srng_id;
467 	uint32_t capture_duration;
468 	uint32_t capture_interval;
469 	uint32_t ul_mu_user_mask_lower;
470 	uint32_t ul_mu_user_mask_upper;
471 	uint16_t freeze_tlv_delay_cnt_en  :1,
472 		 freeze_tlv_delay_cnt_thr :8,
473 		 rsvd0 :7;
474 	uint16_t filter_group_bitmap;
475 	uint8_t m_directed_ftm           : 1,
476 		m_all_ftm_ack            : 1,
477 		m_ndpa_ndp_directed      : 1,
478 		m_ndpa_ndp_all           : 1,
479 		m_ta_ra_filter           : 1,
480 		m_all_packet             : 1,
481 		en_ta_ra_filter_in_as_fp : 1,
482 		rsvd1                    : 1;
483 	uint8_t num_grp_tlvs;
484 
485 	struct ta_ra_cfr_cfg curr[MAX_TA_RA_ENTRIES];
486 	unsigned long modified_in_curr_session;
487 	uint32_t capture_count            :16,
488 		 capture_intval_mode_sel  :1,
489 		 rsvd2                    :15;
490 };
491 #endif /* WLAN_ENH_CFR_ENABLE */
492 
493 /**
494  * struct nl_event_cb - nl event cb for cfr data
495  * vdev_id: vdev id
496  * pid: PID to which data is sent via unicast nl evnet
497  * cfr_nl_cb: callback to send nl evnet
498  */
499 struct nl_event_cb {
500 	uint8_t vdev_id;
501 	uint32_t pid;
502 	void (*cfr_nl_cb)(uint8_t vdev_id, uint32_t pid,
503 			  const void *data, uint32_t data_len);
504 };
505 
506 /**
507  * struct pdev_cfr - private pdev object for cfr
508  * pdev_obj: pointer to pdev object
509  * is_cfr_capable: flag to determine if cfr is enabled or not
510  * cfr_timer_enable: flag to enable/disable timer
511  * chip_type: chip type which is defined in enum cfrradiotype
512  * cfr_mem_chunk: Region of memory used for storing cfr data
513  * cfr_max_sta_count: Maximum stations supported in one-shot capture mode
514  * num_subbufs: No. of sub-buffers used in relayfs
515  * subbuf_size: Size of sub-buffer used in relayfs
516  * chan_ptr: Channel in relayfs
517  * dir_ptr: Parent directory of relayfs file
518  * lut: lookup table used to store asynchronous DBR and TX/RX events for
519  * correlation
520  * lut_num: Number of lut
521  * dbr_buf_size: Size of DBR completion buffer
522  * dbr_num_bufs: No. of DBR completions
523  * tx_evt_cnt: No. of TX completion events till CFR stop was issued
524  * total_tx_evt_cnt: No. of Tx completion events since wifi was up
525  * dbr_evt_cnt: No. of WMI DBR completion events
526  * release_cnt: No. of CFR data buffers relayed to userspace
527  * tx_peer_status_cfr_fail: No. of tx events without tx status set to
528  * PEER_CFR_CAPTURE_EVT_STATUS_MASK indicating CFR capture failure on a peer.
529  * tx_evt_status_cfr_fail: No. of tx events without tx status set to
530  * CFR_TX_EVT_STATUS_MASK indicating CFR capture status failure.
531  * tx_dbr_cookie_lookup_fail: No. of dbr cookie lookup failures during tx event
532  * process.
533  * rcc_param: Structure to store CFR config for the current commit session
534  * global: Structure to store accumulated CFR config
535  * rx_tlv_evt_cnt: Number of CFR WDI events from datapath
536  * lut_age_timer: Timer to flush pending TXRX/DBR events in lookup table
537  * lut_timer_init: flag to determine if lut_age_timer is initialized or not
538  * is_cfr_rcc_capable: Flag to determine if RCC is enabled or not.
539  * flush_dbr_cnt: No. of un-correlated DBR completions flushed when a newer PPDU
540  * is correlated successfully with newer DBR completion
541  * invalid_dma_length_cnt: No. of buffers for which CFR DMA header length (or)
542  * data length was invalid
543  * flush_timeout_dbr_cnt: No. of DBR completion flushed out in ageout logic
544  * clear_txrx_event: No. of PPDU status TLVs over-written in LUT
545  * last_success_tstamp: DBR timestamp which indicates that both DBR and TX/RX
546  * events have been received successfully.
547  * cfr_dma_aborts: No. of CFR DMA aborts in ucode
548  * is_cap_interval_mode_sel_support: flag to determine if target supports both
549  * is_mo_marking_support: flag to determine if MO marking is supported or not
550  * is_aoa_for_rcc_support: flag to determine if AoA is available for RCC or not
551  * capture_count and capture_duration modes with a nob provided to configure.
552  * unassoc_pool: Pool of un-associated clients used when capture method is
553  * CFR_CAPTURE_METHOD_PROBE_RESPONSE
554  * nl_cb: call back to register for nl event for cfr data
555  * lut_lock: Lock to protect access to cfr lookup table
556  * is_prevent_suspend: CFR wake lock acquired or not
557  * wake_lock: wake lock for cfr
558  * runtime_lock: runtime lock for cfr
559  * freq: current operating freq for which AoA Phase delta values reported by FW
560  * max_aoa_chains: Indicate the max number of chains to which target supports
561  * AoA data.
562  * phase_delta: per chain phase delta associated with 62 gain values reported by
563  * FW via WMI_PDEV_AOA_PHASEDELTA_EVENTID.
564  * ibf_cal_val: Per chain IBF cal value from FW.
565  */
566 /*
567  * To be extended if we get more capbality info
568  * from FW's extended service ready event.
569  */
570 struct pdev_cfr {
571 	struct wlan_objmgr_pdev *pdev_obj;
572 	uint8_t is_cfr_capable;
573 	uint8_t cfr_timer_enable;
574 	uint8_t chip_type;
575 	struct cfr_wmi_host_mem_chunk cfr_mem_chunk;
576 	uint16_t cfr_max_sta_count;
577 	uint16_t cfr_current_sta_count;
578 	uint32_t num_subbufs;
579 	uint32_t subbuf_size;
580 	qdf_streamfs_chan_t chan_ptr;
581 	qdf_dentry_t dir_ptr;
582 	struct look_up_table **lut;
583 	uint32_t lut_num;
584 	uint32_t dbr_buf_size;
585 	uint32_t dbr_num_bufs;
586 	uint32_t max_mu_users;
587 	uint64_t tx_evt_cnt;
588 	uint64_t total_tx_evt_cnt;
589 	uint64_t dbr_evt_cnt;
590 	uint64_t release_cnt;
591 	uint64_t tx_peer_status_cfr_fail;
592 	uint64_t tx_evt_status_cfr_fail;
593 	uint64_t tx_dbr_cookie_lookup_fail;
594 #ifdef WLAN_ENH_CFR_ENABLE
595 	struct cfr_rcc_param rcc_param;
596 	struct ta_ra_cfr_cfg global[MAX_TA_RA_ENTRIES];
597 	uint64_t rx_tlv_evt_cnt;
598 	qdf_timer_t lut_age_timer;
599 	uint8_t lut_timer_init;
600 	uint8_t is_cfr_rcc_capable;
601 	uint64_t flush_dbr_cnt;
602 	uint64_t invalid_dma_length_cnt;
603 	uint64_t flush_timeout_dbr_cnt;
604 	uint64_t clear_txrx_event;
605 	uint64_t last_success_tstamp;
606 	uint64_t cfr_dma_aborts;
607 	uint8_t is_cap_interval_mode_sel_support;
608 	uint8_t is_mo_marking_support;
609 	uint8_t is_aoa_for_rcc_support;
610 #endif
611 	struct unassoc_pool_entry unassoc_pool[MAX_CFR_ENABLED_CLIENTS];
612 	struct nl_event_cb nl_cb;
613 	qdf_spinlock_t lut_lock;
614 #ifdef WLAN_CFR_PM
615 	bool is_prevent_suspend;
616 	qdf_wake_lock_t wake_lock;
617 	qdf_runtime_lock_t runtime_lock;
618 #endif
619 #ifdef WLAN_ENH_CFR_ENABLE
620 	uint32_t freq;
621 	uint32_t max_aoa_chains;
622 	uint16_t phase_delta[HOST_MAX_CHAINS][MAX_AGC_GAIN];
623 	uint32_t ibf_cal_val[HOST_MAX_CHAINS];
624 #endif
625 };
626 
627 /**
628  * enum cfr_capt_status - CFR capture status
629  */
630 enum cfr_capt_status {
631 	/* Capture not in progress */
632 	PEER_CFR_CAPTURE_DISABLE,
633 	/* Capture in progress */
634 	PEER_CFR_CAPTURE_ENABLE,
635 };
636 
637 /**
638  * struct peer_cfr - private peer object for cfr
639  * peer_obj: pointer to peer_obj
640  * request: Type of request (start/stop)
641  * bandwidth: bandwitdth of capture for this peer
642  * capture_method: enum determining type of cfr data capture.
643  *                 0-Qos null data
644  */
645 struct peer_cfr {
646 	struct wlan_objmgr_peer *peer_obj;
647 	u_int8_t   request;            /* start/stop */
648 	u_int8_t   bandwidth;
649 	u_int32_t  period;
650 	u_int8_t   capture_method;
651 };
652 
653 /**
654  * cfr_initialize_pdev() - cfr initialize pdev
655  * @pdev: Pointer to pdev_obj
656  *
657  * Return: status of cfr pdev init
658  */
659 QDF_STATUS cfr_initialize_pdev(struct wlan_objmgr_pdev *pdev);
660 
661 /**
662  * cfr_deinitialize_pdev() - cfr deinitialize pdev
663  * @pdev: Pointer to pdev_obj
664  *
665  * Return: status of cfr pdev deinit
666  */
667 QDF_STATUS cfr_deinitialize_pdev(struct wlan_objmgr_pdev *pdev);
668 
669 /**
670  * wlan_cfr_init() - Global init for cfr.
671  *
672  * Return: status of global init pass/fail
673  */
674 QDF_STATUS wlan_cfr_init(void);
675 
676 /**
677  * wlan_cfr_deinit() - Global de-init for cfr.
678  *
679  * Return: status of global de-init pass/fail
680  */
681 QDF_STATUS wlan_cfr_deinit(void);
682 
683 /**
684  * wlan_cfr_pdev_open() - pdev_open function for cfr.
685  * @pdev: pointer to pdev object
686  *
687  * Return: status of pdev_open pass/fail
688  */
689 QDF_STATUS wlan_cfr_pdev_open(struct wlan_objmgr_pdev *pdev);
690 
691 /**
692  * wlan_cfr_pdev_close() - pdev_close function for cfr.
693  * @pdev: pointer to pdev object
694  *
695  * Return: status of pdev_close pass/fail
696  */
697 QDF_STATUS wlan_cfr_pdev_close(struct wlan_objmgr_pdev *pdev);
698 
699 /**
700  * count_set_bits() - function to count set bits in a bitmap
701  * @value: input bitmap
702  *
703  * Return: No. of set bits
704  */
705 uint8_t count_set_bits(unsigned long value);
706 
707 /**
708  * wlan_cfr_is_feature_disabled() - Check if cfr feature is disabled
709  * @pdev - the physical device object.
710  *
711  * Return : true if cfr is disabled, else false.
712  */
713 bool wlan_cfr_is_feature_disabled(struct wlan_objmgr_pdev *pdev);
714 
715 #ifdef WLAN_ENH_CFR_ENABLE
716 /**
717  * wlan_cfr_rx_tlv_process() - Process PPDU status TLVs and store info in
718  * lookup table
719  * @pdev_obj: PDEV object
720  * @nbuf: ppdu info
721  *
722  * Return: none
723  */
724 void wlan_cfr_rx_tlv_process(struct wlan_objmgr_pdev *pdev, void *nbuf);
725 #endif
726 #endif
727