1 /* 2 * Copyright (c) 2018 The Linux Foundation. All rights reserved. 3 * 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 /** 21 * DOC: declare the ftm service data structure and apis 22 */ 23 #ifndef _WLAN_FTM_UCFG_API_H_ 24 #define _WLAN_FTM_UCFG_API_H_ 25 26 #include <qdf_types.h> 27 #include <qdf_status.h> 28 #include <wlan_objmgr_cmn.h> 29 30 #define FTM_DEBUG 0 31 32 #if FTM_DEBUG 33 #define ftm_alert(params...) \ 34 QDF_TRACE_FATAL(QDF_MODULE_ID_FTM, params) 35 #define ftm_err(params...) \ 36 QDF_TRACE_ERROR(QDF_MODULE_ID_FTM, params) 37 #define ftm_warn(params...) \ 38 QDF_TRACE_WARN(QDF_MODULE_ID_FTM, params) 39 #define ftm_notice(params...) \ 40 QDF_TRACE_INFO(QDF_MODULE_ID_FTM, params) 41 #define ftm_debug(params...) \ 42 QDF_TRACE_DEBUG(QDF_MODULE_ID_FTM, params) 43 #else 44 #define ftm_alert(format, args...) 45 #define ftm_err(format, args...) 46 #define ftm_warn(format, args...) 47 #define ftm_notice(format, args...) 48 #define ftm_debug(format, args...) 49 #endif 50 51 #define FTM_IOCTL_UNIFIED_UTF_CMD 0x1000 52 #define FTM_IOCTL_UNIFIED_UTF_RSP 0x1001 53 #define FTM_CMD_MAX_BUF_LENGTH 2048 54 55 /** 56 * enum wifi_ftm_cmd_type - the enumeration of the command source per pdev 57 * @WIFI_FTM_CMD_IOCTL: command from ioctl on the pdev 58 * @WIFI_FTM_CMD_NL80211: command from nl80211 on the pdev 59 * 60 */ 61 enum wifi_ftm_pdev_cmd_type { 62 WIFI_FTM_CMD_IOCTL = 1, 63 WIFI_FTM_CMD_NL80211, 64 65 /* command should be added above */ 66 WIFI_FTM_CMD_UNKNOWN, 67 }; 68 69 /** 70 * struct wifi_ftm_pdev_priv_obj - wifi ftm pdev utf event info 71 * @pdev: pointer to pdev 72 * @data: data ptr 73 * @current_seq: curent squence 74 * @expected_seq: expected sequence 75 * @length: length 76 * @offset: offset 77 * @cmd_type: command type from either ioctl or nl80211 78 */ 79 struct wifi_ftm_pdev_priv_obj { 80 struct wlan_objmgr_pdev *pdev; 81 uint8_t *data; 82 uint8_t current_seq; 83 uint8_t expected_seq; 84 qdf_size_t length; 85 qdf_size_t offset; 86 enum wifi_ftm_pdev_cmd_type cmd_type; 87 }; 88 89 /** 90 * wlan_ftm_testmode_cmd() - handle FTM testmode command 91 * @pdev: pdev pointer 92 * @data: data 93 * @len: data length 94 * 95 * Return: QDF_STATUS_SUCCESS on success, QDF_STATUS_E_** on error 96 */ 97 QDF_STATUS ucfg_wlan_ftm_testmode_cmd(struct wlan_objmgr_pdev *pdev, 98 uint8_t *data, uint32_t len); 99 100 /** 101 * wlan_ftm_testmode_rsp() - handle FTM testmode command 102 * @pdev: pdev pointer 103 * @data: data 104 * 105 * Return: QDF_STATUS_SUCCESS on success, QDF_STATUS_E_** on error 106 */ 107 QDF_STATUS ucfg_wlan_ftm_testmode_rsp(struct wlan_objmgr_pdev *pdev, 108 uint8_t *data); 109 110 /** 111 * wlan_ftm_process_utf_event() - process ftm UTF event 112 * @scn_handle: scn handle 113 * @event: event buffer 114 * @len: event length 115 * 116 * return: QDF_STATUS_SUCCESS for success or error code 117 */ 118 QDF_STATUS wlan_ftm_process_utf_event(struct wlan_objmgr_pdev *pdev, 119 uint8_t *event_buf, uint32_t len); 120 #endif /* _WLAN_FTM_UCFG_API_H_ */ 121