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 44 #define ftm_nofl_alert(params...) \ 45 QDF_TRACE_FATAL_NO_FL(QDF_MODULE_ID_FTM, params) 46 #define ftm_nofl_err(params...) \ 47 QDF_TRACE_ERROR_NO_FL(QDF_MODULE_ID_FTM, params) 48 #define ftm_nofl_warn(params...) \ 49 QDF_TRACE_WARN_NO_FL(QDF_MODULE_ID_FTM, params) 50 #define ftm_nofl_notice(params...) \ 51 QDF_TRACE_INFO_NO_FL(QDF_MODULE_ID_FTM, params) 52 #define ftm_nofl_debug(params...) \ 53 QDF_TRACE_DEBUG_NO_FL(QDF_MODULE_ID_FTM, params) 54 55 #else 56 #define ftm_alert(params...) 57 #define ftm_err(params...) 58 #define ftm_warn(params...) 59 #define ftm_notice(params...) 60 #define ftm_debug(params...) 61 62 #define ftm_nofl_alert(params...) 63 #define ftm_nofl_err(params...) 64 #define ftm_nofl_warn(params...) 65 #define ftm_nofl_notice(params...) 66 #define ftm_nofl_debug(params...) 67 #endif 68 69 #define FTM_IOCTL_UNIFIED_UTF_CMD 0x1000 70 #define FTM_IOCTL_UNIFIED_UTF_RSP 0x1001 71 #define FTM_CMD_MAX_BUF_LENGTH 2048 72 73 /** 74 * enum wifi_ftm_cmd_type - the enumeration of the command source per pdev 75 * @WIFI_FTM_CMD_IOCTL: command from ioctl on the pdev 76 * @WIFI_FTM_CMD_NL80211: command from nl80211 on the pdev 77 * 78 */ 79 enum wifi_ftm_pdev_cmd_type { 80 WIFI_FTM_CMD_IOCTL = 1, 81 WIFI_FTM_CMD_NL80211, 82 83 /* command should be added above */ 84 WIFI_FTM_CMD_UNKNOWN, 85 }; 86 87 /** 88 * struct wifi_ftm_pdev_priv_obj - wifi ftm pdev utf event info 89 * @pdev: pointer to pdev 90 * @data: data ptr 91 * @current_seq: curent squence 92 * @expected_seq: expected sequence 93 * @length: length 94 * @offset: offset 95 * @cmd_type: command type from either ioctl or nl80211 96 */ 97 struct wifi_ftm_pdev_priv_obj { 98 struct wlan_objmgr_pdev *pdev; 99 uint8_t *data; 100 uint8_t current_seq; 101 uint8_t expected_seq; 102 qdf_size_t length; 103 qdf_size_t offset; 104 enum wifi_ftm_pdev_cmd_type cmd_type; 105 }; 106 107 /** 108 * wlan_ftm_testmode_cmd() - handle FTM testmode command 109 * @pdev: pdev pointer 110 * @data: data 111 * @len: data length 112 * 113 * Return: QDF_STATUS_SUCCESS on success, QDF_STATUS_E_** on error 114 */ 115 QDF_STATUS ucfg_wlan_ftm_testmode_cmd(struct wlan_objmgr_pdev *pdev, 116 uint8_t *data, uint32_t len); 117 118 /** 119 * wlan_ftm_testmode_rsp() - handle FTM testmode command 120 * @pdev: pdev pointer 121 * @data: data 122 * 123 * Return: QDF_STATUS_SUCCESS on success, QDF_STATUS_E_** on error 124 */ 125 QDF_STATUS ucfg_wlan_ftm_testmode_rsp(struct wlan_objmgr_pdev *pdev, 126 uint8_t *data); 127 128 /** 129 * wlan_ftm_process_utf_event() - process ftm UTF event 130 * @scn_handle: scn handle 131 * @event: event buffer 132 * @len: event length 133 * 134 * return: QDF_STATUS_SUCCESS for success or error code 135 */ 136 QDF_STATUS wlan_ftm_process_utf_event(struct wlan_objmgr_pdev *pdev, 137 uint8_t *event_buf, uint32_t len); 138 #endif /* _WLAN_FTM_UCFG_API_H_ */ 139