samsung-sm8650/android_kernel_samsung_sm8650-modules
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

qcacmn: Fix FTM documentation

Browse Source 
The kernel-doc script identified a few kernel-doc issues in the ftm
folder, so fix them.

Change-Id: Icf1fac11bb2f3fa39cf29f6dabebc06bcb523d60
CRs-Fixed: 3376407
This commit is contained in:
Jeff Johnson
2023-01-09 17:26:39 -08:00
committed by Madan Koyyalamudi
parent 539d3bfb53
commit b4466310b5
2 changed files with 13 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
ftm/core/src/wlan_ftm_svc_i.h
View File

@@ -1,5 +1,6 @@
/* /*
* Copyright (c) 2018 The Linux Foundation. All rights reserved. * Copyright (c) 2018 The Linux Foundation. All rights reserved.
* Copyright (c) 2023 Qualcomm Innovation Center, Inc. All rights reserved.
* *
* *
* Permission to use, copy, modify, and/or distribute this software for * Permission to use, copy, modify, and/or distribute this software for
@@ -47,7 +48,7 @@ struct ftm_seg_hdr_info {
* @pdev: pdev pointer * @pdev: pdev pointer
* @arg_list: argument list * @arg_list: argument list
* *
* return: QDF_STATUS_SUCCESS for success or error code * Return: QDF_STATUS_SUCCESS for success or error code
*/ */
QDF_STATUS wlan_ftm_pdev_obj_create_notification(struct wlan_objmgr_pdev *pdev, QDF_STATUS wlan_ftm_pdev_obj_create_notification(struct wlan_objmgr_pdev *pdev,
void *arg_list); void *arg_list);
@@ -57,7 +58,7 @@ QDF_STATUS wlan_ftm_pdev_obj_create_notification(struct wlan_objmgr_pdev *pdev,
* @pdev: pdev pointer * @pdev: pdev pointer
* @arg_list: argument list * @arg_list: argument list
* *
* return: QDF_STATUS_SUCCESS for success or error code * Return: QDF_STATUS_SUCCESS for success or error code
*/ */
QDF_STATUS wlan_ftm_pdev_obj_destroy_notification(struct wlan_objmgr_pdev *pdev, QDF_STATUS wlan_ftm_pdev_obj_destroy_notification(struct wlan_objmgr_pdev *pdev,
void *arg_list); void *arg_list);
@@ -67,8 +68,9 @@ QDF_STATUS wlan_ftm_pdev_obj_destroy_notification(struct wlan_objmgr_pdev *pdev,
* @pdev: pdev pointer * @pdev: pdev pointer
* @buf: data buffer * @buf: data buffer
* @len: event length * @len: event length
* @pdev_id: pdev id
* *
* return: QDF_STATUS_SUCCESS for success or error code * Return: QDF_STATUS_SUCCESS for success or error code
*/ */
QDF_STATUS wlan_ftm_cmd_send(struct wlan_objmgr_pdev *pdev, uint8_t *buf, QDF_STATUS wlan_ftm_cmd_send(struct wlan_objmgr_pdev *pdev, uint8_t *buf,
uint32_t len, uint8_t pdev_id); uint32_t len, uint8_t pdev_id);

15
ftm/dispatcher/inc/wlan_ftm_ucfg_api.h
View File

@@ -1,6 +1,6 @@
/* /*
* Copyright (c) 2018 The Linux Foundation. All rights reserved. * Copyright (c) 2018 The Linux Foundation. All rights reserved.
* Copyright (c) 2022 Qualcomm Innovation Center, Inc. All rights reserved. * Copyright (c) 2022-2023 Qualcomm Innovation Center, Inc. All rights reserved.
* *
* *
* Permission to use, copy, modify, and/or distribute this software for * Permission to use, copy, modify, and/or distribute this software for
@@ -72,9 +72,10 @@
#define FTM_CMD_MAX_BUF_LENGTH 2048 #define FTM_CMD_MAX_BUF_LENGTH 2048
/** /**
* enum wifi_ftm_cmd_type - the enumeration of the command source per pdev * enum wifi_ftm_pdev_cmd_type - the enumeration of the command source per pdev
* @WIFI_FTM_CMD_IOCTL: command from ioctl on the pdev * @WIFI_FTM_CMD_IOCTL: command from ioctl on the pdev
* @WIFI_FTM_CMD_NL80211: command from nl80211 on the pdev * @WIFI_FTM_CMD_NL80211: command from nl80211 on the pdev
* @WIFI_FTM_CMD_UNKNOWN: unknown command
* *
*/ */
enum wifi_ftm_pdev_cmd_type { enum wifi_ftm_pdev_cmd_type {
@@ -106,7 +107,7 @@ struct wifi_ftm_pdev_priv_obj {
}; };
/** /**
* wlan_ftm_testmode_cmd() - handle FTM testmode command * ucfg_wlan_ftm_testmode_cmd() - handle FTM testmode command
* @pdev: pdev pointer * @pdev: pdev pointer
* @data: data * @data: data
* @len: data length * @len: data length
@@ -117,7 +118,7 @@ QDF_STATUS ucfg_wlan_ftm_testmode_cmd(struct wlan_objmgr_pdev *pdev,
uint8_t *data, uint32_t len); uint8_t *data, uint32_t len);
/** /**
* wlan_ftm_testmode_rsp() - handle FTM testmode command * ucfg_wlan_ftm_testmode_rsp() - handle FTM testmode command
* @pdev: pdev pointer * @pdev: pdev pointer
* @data: data * @data: data
* *
@@ -128,11 +129,11 @@ QDF_STATUS ucfg_wlan_ftm_testmode_rsp(struct wlan_objmgr_pdev *pdev,
/** /**
* wlan_ftm_process_utf_event() - process ftm UTF event * wlan_ftm_process_utf_event() - process ftm UTF event
* @scn_handle: scn handle * @pdev: pdev pointer
* @event: event buffer * @event_buf: event buffer
* @len: event length * @len: event length
* *
* return: QDF_STATUS_SUCCESS for success or error code * Return: QDF_STATUS_SUCCESS for success or error code
*/ */
QDF_STATUS wlan_ftm_process_utf_event(struct wlan_objmgr_pdev *pdev, QDF_STATUS wlan_ftm_process_utf_event(struct wlan_objmgr_pdev *pdev,
uint8_t *event_buf, uint32_t len); uint8_t *event_buf, uint32_t len);