xref: /wlan-driver/qca-wifi-host-cmn/ftm/dispatcher/inc/wlan_ftm_ucfg_api.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2018 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  *
6*5113495bSYour Name  * Permission to use, copy, modify, and/or distribute this software for
7*5113495bSYour Name  * any purpose with or without fee is hereby granted, provided that the
8*5113495bSYour Name  * above copyright notice and this permission notice appear in all
9*5113495bSYour Name  * copies.
10*5113495bSYour Name  *
11*5113495bSYour Name  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
12*5113495bSYour Name  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
13*5113495bSYour Name  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
14*5113495bSYour Name  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
15*5113495bSYour Name  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
16*5113495bSYour Name  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
17*5113495bSYour Name  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
18*5113495bSYour Name  * PERFORMANCE OF THIS SOFTWARE.
19*5113495bSYour Name  */
20*5113495bSYour Name 
21*5113495bSYour Name /**
22*5113495bSYour Name  * DOC: declare the ftm service data structure and apis
23*5113495bSYour Name  */
24*5113495bSYour Name #ifndef _WLAN_FTM_UCFG_API_H_
25*5113495bSYour Name #define _WLAN_FTM_UCFG_API_H_
26*5113495bSYour Name 
27*5113495bSYour Name #include <qdf_types.h>
28*5113495bSYour Name #include <qdf_status.h>
29*5113495bSYour Name #include <wlan_objmgr_cmn.h>
30*5113495bSYour Name 
31*5113495bSYour Name #define FTM_DEBUG       0
32*5113495bSYour Name 
33*5113495bSYour Name #if FTM_DEBUG
34*5113495bSYour Name #define ftm_alert(params...) \
35*5113495bSYour Name 	QDF_TRACE_FATAL(QDF_MODULE_ID_FTM, params)
36*5113495bSYour Name #define ftm_err(params...) \
37*5113495bSYour Name 	QDF_TRACE_ERROR(QDF_MODULE_ID_FTM, params)
38*5113495bSYour Name #define ftm_warn(params...) \
39*5113495bSYour Name 	QDF_TRACE_WARN(QDF_MODULE_ID_FTM, params)
40*5113495bSYour Name #define ftm_notice(params...) \
41*5113495bSYour Name 	QDF_TRACE_INFO(QDF_MODULE_ID_FTM, params)
42*5113495bSYour Name #define ftm_debug(params...) \
43*5113495bSYour Name 	QDF_TRACE_DEBUG(QDF_MODULE_ID_FTM, params)
44*5113495bSYour Name 
45*5113495bSYour Name #define ftm_nofl_alert(params...) \
46*5113495bSYour Name 	QDF_TRACE_FATAL_NO_FL(QDF_MODULE_ID_FTM, params)
47*5113495bSYour Name #define ftm_nofl_err(params...) \
48*5113495bSYour Name 	QDF_TRACE_ERROR_NO_FL(QDF_MODULE_ID_FTM, params)
49*5113495bSYour Name #define ftm_nofl_warn(params...) \
50*5113495bSYour Name 	QDF_TRACE_WARN_NO_FL(QDF_MODULE_ID_FTM, params)
51*5113495bSYour Name #define ftm_nofl_notice(params...) \
52*5113495bSYour Name 	QDF_TRACE_INFO_NO_FL(QDF_MODULE_ID_FTM, params)
53*5113495bSYour Name #define ftm_nofl_debug(params...) \
54*5113495bSYour Name 	QDF_TRACE_DEBUG_NO_FL(QDF_MODULE_ID_FTM, params)
55*5113495bSYour Name 
56*5113495bSYour Name #else
57*5113495bSYour Name #define ftm_alert(params...)
58*5113495bSYour Name #define ftm_err(params...)
59*5113495bSYour Name #define ftm_warn(params...)
60*5113495bSYour Name #define ftm_notice(params...)
61*5113495bSYour Name #define ftm_debug(params...)
62*5113495bSYour Name 
63*5113495bSYour Name #define ftm_nofl_alert(params...)
64*5113495bSYour Name #define ftm_nofl_err(params...)
65*5113495bSYour Name #define ftm_nofl_warn(params...)
66*5113495bSYour Name #define ftm_nofl_notice(params...)
67*5113495bSYour Name #define ftm_nofl_debug(params...)
68*5113495bSYour Name #endif
69*5113495bSYour Name 
70*5113495bSYour Name #define FTM_IOCTL_UNIFIED_UTF_CMD		0x1000
71*5113495bSYour Name #define FTM_IOCTL_UNIFIED_UTF_RSP		0x1001
72*5113495bSYour Name #define FTM_CMD_MAX_BUF_LENGTH		    2048
73*5113495bSYour Name 
74*5113495bSYour Name /**
75*5113495bSYour Name  * enum wifi_ftm_pdev_cmd_type - the enumeration of the command source per pdev
76*5113495bSYour Name  * @WIFI_FTM_CMD_IOCTL: command from ioctl on the pdev
77*5113495bSYour Name  * @WIFI_FTM_CMD_NL80211: command from nl80211 on the pdev
78*5113495bSYour Name  * @WIFI_FTM_CMD_UNKNOWN: unknown command
79*5113495bSYour Name  *
80*5113495bSYour Name  */
81*5113495bSYour Name enum wifi_ftm_pdev_cmd_type {
82*5113495bSYour Name 	WIFI_FTM_CMD_IOCTL = 1,
83*5113495bSYour Name 	WIFI_FTM_CMD_NL80211,
84*5113495bSYour Name 
85*5113495bSYour Name 	/* command should be added above */
86*5113495bSYour Name 	WIFI_FTM_CMD_UNKNOWN,
87*5113495bSYour Name };
88*5113495bSYour Name 
89*5113495bSYour Name /**
90*5113495bSYour Name  * struct wifi_ftm_pdev_priv_obj - wifi ftm pdev utf event info
91*5113495bSYour Name  * @pdev: pointer to pdev
92*5113495bSYour Name  * @data: data ptr
93*5113495bSYour Name  * @current_seq: current sequence
94*5113495bSYour Name  * @expected_seq: expected sequence
95*5113495bSYour Name  * @length: length
96*5113495bSYour Name  * @offset: offset
97*5113495bSYour Name  * @cmd_type: command type from either ioctl or nl80211
98*5113495bSYour Name  */
99*5113495bSYour Name struct wifi_ftm_pdev_priv_obj {
100*5113495bSYour Name 	struct wlan_objmgr_pdev *pdev;
101*5113495bSYour Name 	uint8_t *data;
102*5113495bSYour Name 	uint8_t current_seq;
103*5113495bSYour Name 	uint8_t expected_seq;
104*5113495bSYour Name 	qdf_size_t length;
105*5113495bSYour Name 	qdf_size_t offset;
106*5113495bSYour Name 	enum wifi_ftm_pdev_cmd_type cmd_type;
107*5113495bSYour Name };
108*5113495bSYour Name 
109*5113495bSYour Name /**
110*5113495bSYour Name  * ucfg_wlan_ftm_testmode_cmd() - handle FTM testmode command
111*5113495bSYour Name  * @pdev: pdev pointer
112*5113495bSYour Name  * @data: data
113*5113495bSYour Name  * @len: data length
114*5113495bSYour Name  *
115*5113495bSYour Name  * Return: QDF_STATUS_SUCCESS on success, QDF_STATUS_E_** on error
116*5113495bSYour Name  */
117*5113495bSYour Name QDF_STATUS ucfg_wlan_ftm_testmode_cmd(struct wlan_objmgr_pdev *pdev,
118*5113495bSYour Name 					uint8_t *data, uint32_t len);
119*5113495bSYour Name 
120*5113495bSYour Name /**
121*5113495bSYour Name  * ucfg_wlan_ftm_testmode_rsp() - handle FTM testmode command
122*5113495bSYour Name  * @pdev: pdev pointer
123*5113495bSYour Name  * @data: data
124*5113495bSYour Name  *
125*5113495bSYour Name  * Return: QDF_STATUS_SUCCESS on success, QDF_STATUS_E_** on error
126*5113495bSYour Name  */
127*5113495bSYour Name QDF_STATUS ucfg_wlan_ftm_testmode_rsp(struct wlan_objmgr_pdev *pdev,
128*5113495bSYour Name 					uint8_t *data);
129*5113495bSYour Name 
130*5113495bSYour Name /**
131*5113495bSYour Name  * wlan_ftm_process_utf_event() - process ftm UTF event
132*5113495bSYour Name  * @pdev: pdev pointer
133*5113495bSYour Name  * @event_buf: event buffer
134*5113495bSYour Name  * @len: event length
135*5113495bSYour Name  *
136*5113495bSYour Name  * Return: QDF_STATUS_SUCCESS for success or error code
137*5113495bSYour Name  */
138*5113495bSYour Name QDF_STATUS wlan_ftm_process_utf_event(struct wlan_objmgr_pdev *pdev,
139*5113495bSYour Name 					uint8_t *event_buf, uint32_t len);
140*5113495bSYour Name #endif /* _WLAN_FTM_UCFG_API_H_ */
141