xref: /wlan-driver/qcacld-3.0/core/cds/inc/cds_utils.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2014-2021 The Linux Foundation. All rights reserved.
3*5113495bSYour Name  * Copyright (c) 2022-2023 Qualcomm Innovation Center, Inc. All rights reserved.
4*5113495bSYour Name  *
5*5113495bSYour Name  * Permission to use, copy, modify, and/or distribute this software for
6*5113495bSYour Name  * any purpose with or without fee is hereby granted, provided that the
7*5113495bSYour Name  * above copyright notice and this permission notice appear in all
8*5113495bSYour Name  * copies.
9*5113495bSYour Name  *
10*5113495bSYour Name  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
11*5113495bSYour Name  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
12*5113495bSYour Name  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
13*5113495bSYour Name  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
14*5113495bSYour Name  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
15*5113495bSYour Name  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
16*5113495bSYour Name  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
17*5113495bSYour Name  * PERFORMANCE OF THIS SOFTWARE.
18*5113495bSYour Name  */
19*5113495bSYour Name 
20*5113495bSYour Name #ifndef __CDS_UTILS_H
21*5113495bSYour Name #define __CDS_UTILS_H
22*5113495bSYour Name 
23*5113495bSYour Name /**
24*5113495bSYour Name  * DOC: cds_utils.h
25*5113495bSYour Name  *      Connectivity driver services (CDS) utility APIs
26*5113495bSYour Name  *      Various utility functions
27*5113495bSYour Name  */
28*5113495bSYour Name 
29*5113495bSYour Name #include <qdf_types.h>
30*5113495bSYour Name #include <qdf_status.h>
31*5113495bSYour Name #include <qdf_event.h>
32*5113495bSYour Name #include <qdf_lock.h>
33*5113495bSYour Name #include "ani_global.h"
34*5113495bSYour Name 
35*5113495bSYour Name /*--------------------------------------------------------------------------
36*5113495bSYour Name    Preprocessor definitions and constants
37*5113495bSYour Name    ------------------------------------------------------------------------*/
38*5113495bSYour Name #define CDS_24_GHZ_BASE_FREQ   (2407)
39*5113495bSYour Name #define CDS_5_GHZ_BASE_FREQ    (5000)
40*5113495bSYour Name #define CDS_24_GHZ_CHANNEL_1   (1)
41*5113495bSYour Name #define CDS_24_GHZ_CHANNEL_14  (14)
42*5113495bSYour Name #define CDS_24_GHZ_CHANNEL_15  (15)
43*5113495bSYour Name #define CDS_24_GHZ_CHANNEL_27  (27)
44*5113495bSYour Name #define CDS_5_GHZ_CHANNEL_165  (165)
45*5113495bSYour Name #define CDS_5_GHZ_CHANNEL_170  (170)
46*5113495bSYour Name #define CDS_CHAN_SPACING_5MHZ  (5)
47*5113495bSYour Name #define CDS_CHAN_SPACING_20MHZ (20)
48*5113495bSYour Name #define CDS_CHAN_14_FREQ       (2484)
49*5113495bSYour Name #define CDS_CHAN_15_FREQ       (2512)
50*5113495bSYour Name #define CDS_CHAN_170_FREQ      (5852)
51*5113495bSYour Name 
52*5113495bSYour Name #define INVALID_SCAN_ID        0xFFFFFFFF
53*5113495bSYour Name 
54*5113495bSYour Name #define CDS_DBS_SCAN_CLIENTS_MAX           (7)
55*5113495bSYour Name #define CDS_DBS_SCAN_PARAM_PER_CLIENT      (3)
56*5113495bSYour Name 
57*5113495bSYour Name #define cds_alert(params...) QDF_TRACE_FATAL(QDF_MODULE_ID_QDF, params)
58*5113495bSYour Name #define cds_err(params...) QDF_TRACE_ERROR(QDF_MODULE_ID_QDF, params)
59*5113495bSYour Name #define cds_warn(params...) QDF_TRACE_WARN(QDF_MODULE_ID_QDF, params)
60*5113495bSYour Name #define cds_info(params...) QDF_TRACE_INFO(QDF_MODULE_ID_QDF, params)
61*5113495bSYour Name #define cds_debug(params...) QDF_TRACE_DEBUG(QDF_MODULE_ID_QDF, params)
62*5113495bSYour Name 
63*5113495bSYour Name #define cds_nofl_alert(params...) \
64*5113495bSYour Name 	QDF_TRACE_FATAL_NO_FL(QDF_MODULE_ID_QDF, params)
65*5113495bSYour Name #define cds_nofl_err(params...) \
66*5113495bSYour Name 	QDF_TRACE_ERROR_NO_FL(QDF_MODULE_ID_QDF, params)
67*5113495bSYour Name #define cds_nofl_warn(params...) \
68*5113495bSYour Name 	QDF_TRACE_WARN_NO_FL(QDF_MODULE_ID_QDF, params)
69*5113495bSYour Name #define cds_nofl_info(params...) \
70*5113495bSYour Name 	QDF_TRACE_INFO_NO_FL(QDF_MODULE_ID_QDF, params)
71*5113495bSYour Name #define cds_nofl_debug(params...) \
72*5113495bSYour Name 	QDF_TRACE_DEBUG_NO_FL(QDF_MODULE_ID_QDF, params)
73*5113495bSYour Name 
74*5113495bSYour Name #define cds_enter() QDF_TRACE_ENTER(QDF_MODULE_ID_QDF, "enter")
75*5113495bSYour Name #define cds_exit() QDF_TRACE_EXIT(QDF_MODULE_ID_QDF, "exit")
76*5113495bSYour Name 
77*5113495bSYour Name /**
78*5113495bSYour Name  * enum cds_band_type - Band type - 2g, 5g or all
79*5113495bSYour Name  * @CDS_BAND_ALL: Both 2G and 5G are valid.
80*5113495bSYour Name  * @CDS_BAND_2GHZ: only 2G is valid.
81*5113495bSYour Name  * @CDS_BAND_5GHZ: only 5G is valid.
82*5113495bSYour Name  */
83*5113495bSYour Name enum cds_band_type {
84*5113495bSYour Name 	CDS_BAND_ALL = 0,
85*5113495bSYour Name 	CDS_BAND_2GHZ = 1,
86*5113495bSYour Name 	CDS_BAND_5GHZ = 2
87*5113495bSYour Name };
88*5113495bSYour Name 
89*5113495bSYour Name /*-------------------------------------------------------------------------
90*5113495bSYour Name    Function declarations and documentation
91*5113495bSYour Name    ------------------------------------------------------------------------*/
92*5113495bSYour Name 
93*5113495bSYour Name uint32_t cds_chan_to_freq(uint8_t chan);
94*5113495bSYour Name uint8_t cds_freq_to_chan(uint32_t freq);
95*5113495bSYour Name enum cds_band_type cds_chan_to_band(uint32_t chan);
96*5113495bSYour Name 
97*5113495bSYour Name uint8_t cds_get_mmie_size(void);
98*5113495bSYour Name 
99*5113495bSYour Name /**
100*5113495bSYour Name  * cds_get_gmac_mmie_size() - Gives length of GMAC MMIE size
101*5113495bSYour Name  *
102*5113495bSYour Name  * Return: Size of MMIE for GMAC
103*5113495bSYour Name  */
104*5113495bSYour Name uint8_t cds_get_gmac_mmie_size(void);
105*5113495bSYour Name 
cds_host_diag_log_work(qdf_wake_lock_t * lock,uint32_t msec,uint32_t reason)106*5113495bSYour Name static inline void cds_host_diag_log_work(qdf_wake_lock_t *lock, uint32_t msec,
107*5113495bSYour Name 			    uint32_t reason) {
108*5113495bSYour Name 	if (((cds_get_ring_log_level(RING_ID_WAKELOCK) >= WLAN_LOG_LEVEL_ACTIVE)
109*5113495bSYour Name 	     && (WIFI_POWER_EVENT_WAKELOCK_HOLD_RX == reason)) ||
110*5113495bSYour Name 	    (WIFI_POWER_EVENT_WAKELOCK_HOLD_RX != reason)) {
111*5113495bSYour Name 		host_diag_log_wlock(reason, qdf_wake_lock_name(lock),
112*5113495bSYour Name 				    msec, WIFI_POWER_EVENT_WAKELOCK_TAKEN);
113*5113495bSYour Name 	}
114*5113495bSYour Name }
115*5113495bSYour Name 
116*5113495bSYour Name /**
117*5113495bSYour Name  * cds_copy_hlp_info() - Copy HLP info
118*5113495bSYour Name  * @input_dst_mac: input HLP destination MAC address
119*5113495bSYour Name  * @input_src_mac: input HLP source MAC address
120*5113495bSYour Name  * @input_hlp_data_len: input HLP data length
121*5113495bSYour Name  * @input_hlp_data: Pointer to input HLP data
122*5113495bSYour Name  * @output_dst_mac: output HLP destination MAC address
123*5113495bSYour Name  * @output_src_mac: output HLP source MAC address
124*5113495bSYour Name  * @output_hlp_data_len: Pointer to output HLP data length
125*5113495bSYour Name  * @output_hlp_data: output Pointer to HLP data
126*5113495bSYour Name  *
127*5113495bSYour Name  * Util API to copy HLP info from input to output
128*5113495bSYour Name  *
129*5113495bSYour Name  * Return: None
130*5113495bSYour Name  */
131*5113495bSYour Name void cds_copy_hlp_info(struct qdf_mac_addr *input_dst_mac,
132*5113495bSYour Name 		       struct qdf_mac_addr *input_src_mac,
133*5113495bSYour Name 		       uint16_t input_hlp_data_len,
134*5113495bSYour Name 		       uint8_t *input_hlp_data,
135*5113495bSYour Name 		       struct qdf_mac_addr *output_dst_mac,
136*5113495bSYour Name 		       struct qdf_mac_addr *output_src_mac,
137*5113495bSYour Name 		       uint16_t *output_hlp_data_len,
138*5113495bSYour Name 		       uint8_t *output_hlp_data);
139*5113495bSYour Name #endif /* #ifndef __CDS_UTILS_H */
140