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

qcacld-3.0: Fix SON Documentation

Browse Source 
The kernel-doc script identified a few documentation issues in
components/son, so fix them.

Change-Id: I2aaa6746b05a963113ea78111a4cc45f35c1f98c
CRs-Fixed: 3359822
This commit is contained in:
Jeff Johnson
2023-01-04 12:47:11 -08:00
committed by Madan Koyyalamudi
parent 4086862b28
commit a51ab110dd
4 changed files with 25 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
components/son/dispatcher/inc/son_api.h
View File

@@ -1,6 +1,6 @@
/*
* Copyright (c) 2021, The Linux Foundation. All rights reserved.
* Copyright (c) 2021-2022 Qualcomm Innovation Center, Inc. All rights reserved.
* Copyright (c) 2021-2023 Qualcomm Innovation Center, Inc. All rights reserved.
*
* Permission to use, copy, modify, and/or distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
@@ -16,7 +16,7 @@
*/
/**
* DOC : contains interface prototypes for son api
* DOC: contains interface prototypes for son api
*/
#ifndef _SON_API_H_
#define _SON_API_H_
@@ -173,12 +173,12 @@ struct son_cbs {
};
/**
* mlme_deliver_cb - cb to deliver mlme event
* typedef mlme_deliver_cb() - cb to deliver mlme event
* @vdev: pointer to vdev
* @event_len: event length
* @event_buf: event buffer
*
* @Return: 0 if event is sent successfully
* Return: 0 if event is sent successfully
*/
typedef int (*mlme_deliver_cb)(struct wlan_objmgr_vdev *vdev,
uint32_t event_len,
@@ -344,6 +344,7 @@ bool wlan_son_peer_is_kickout_allow(struct wlan_objmgr_vdev *vdev,
/**
* wlan_son_ind_assoc_req_frm() - indicate assoc req frame to son
* @vdev: pointer to vdev
* @macaddr: MAC address
* @is_reassoc: true if it is reassoc req
* @frame: frame body
* @frame_len: frame body length
@@ -355,6 +356,7 @@ void wlan_son_ind_assoc_req_frm(struct wlan_objmgr_vdev *vdev,
uint8_t *macaddr, bool is_reassoc,
uint8_t *frame, uint16_t frame_len,
QDF_STATUS status);
/**
* wlan_son_deliver_tx_power() - notify son module of tx power
* @vdev: vdev

26
components/son/dispatcher/inc/son_ucfg_api.h
View File

@@ -1,6 +1,6 @@
/*
* Copyright (c) 2021, The Linux Foundation. All rights reserved.
* Copyright (c) 2021-2022 Qualcomm Innovation Center, Inc. All rights reserved.
* Copyright (c) 2021-2023 Qualcomm Innovation Center, Inc. All rights reserved.
*
* Permission to use, copy, modify, and/or distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
@@ -16,7 +16,7 @@
*/
/**
* DOC : contains interface prototypes for OS_IF layer
* DOC: contains interface prototypes for OS_IF layer
*/
#ifndef _SON_UCFG_API_H_
#define _SON_UCFG_API_H_
@@ -111,8 +111,8 @@ QDF_STATUS ucfg_son_set_peer_kickout_allow(struct wlan_objmgr_vdev *vdev,
/**
* ucfg_son_register_deliver_opmode_cb() - register deliver opmode cb
* psoc: pointer to psoc
* cb: deliver opmode callback
* @psoc: pointer to psoc
* @cb: deliver opmode callback
*
* Return: QDF_STATUS_SUCCESS on Success else failure.
*/
@@ -121,8 +121,8 @@ QDF_STATUS ucfg_son_register_deliver_opmode_cb(struct wlan_objmgr_psoc *psoc,
/**
* ucfg_son_register_deliver_smps_cb() - register deliver smps cb
* psoc: pointer to psoc
* cb: deliver smps callback
* @psoc: pointer to psoc
* @cb: deliver smps callback
*
* Return: QDF_STATUS_SUCCESS on Success else failure.
*/
@@ -137,13 +137,15 @@ QDF_STATUS ucfg_son_register_deliver_smps_cb(struct wlan_objmgr_psoc *psoc,
*/
int ucfg_son_cbs_init(void);
/* ucfg_son_cbs_deinit - son cbs deinit
/**
* ucfg_son_cbs_deinit() - son cbs deinit
*
* Return: 0 if succeed
*/
int ucfg_son_cbs_deinit(void);
/* ucfg_son_set_cbs() - son cbs set
/**
* ucfg_son_set_cbs() - son cbs set
* @vdev: pointer to vdev
* @enable: enable or disable son cbs
*
@@ -152,7 +154,8 @@ int ucfg_son_cbs_deinit(void);
int ucfg_son_set_cbs(struct wlan_objmgr_vdev *vdev,
bool enable);
/* ucfg_son_set_cbs_wait_time() - cbs wait time configure
/**
* ucfg_son_set_cbs_wait_time() - cbs wait time configure
* @vdev: pointer to vdev
* @val: wait time value
*
@@ -161,7 +164,8 @@ int ucfg_son_set_cbs(struct wlan_objmgr_vdev *vdev,
int ucfg_son_set_cbs_wait_time(struct wlan_objmgr_vdev *vdev,
uint32_t val);
/* ucfg_son_set_cbs_dwell_split_time() - cbs dwell spilt time configure
/**
* ucfg_son_set_cbs_dwell_split_time() - cbs dwell spilt time configure
* @vdev: pointer to vdev
* @val: dwell spilt time value
*
@@ -171,7 +175,7 @@ int ucfg_son_set_cbs_dwell_split_time(struct wlan_objmgr_vdev *vdev,
uint32_t val);
/**
* ucfg_son_get_max_tx_power() - Gets the max transmit power for peer
* ucfg_son_get_tx_power() - Gets the max transmit power for peer
* @assoc_req_ies: assoc req ies
*
* Return: Returns the max tx power

4
components/son/dispatcher/src/son_api.c
View File

@@ -1,6 +1,6 @@
/*
* Copyright (c) 2021, The Linux Foundation. All rights reserved.
* Copyright (c) 2021-2022 Qualcomm Innovation Center, Inc. All rights reserved.
* Copyright (c) 2021-2023 Qualcomm Innovation Center, Inc. All rights reserved.
*
* Permission to use, copy, modify, and/or distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
@@ -16,7 +16,7 @@
*/
/**
* DOC : contains interface prototypes for son api
* DOC: contains interface prototypes for son api
*/
#include <son_api.h>

4
components/son/dispatcher/src/son_ucfg_api.c
View File

@@ -1,6 +1,6 @@
/*
* Copyright (c) 2021, The Linux Foundation. All rights reserved.
* Copyright (c) 2021-2022 Qualcomm Innovation Center, Inc. All rights reserved.
* Copyright (c) 2021-2023 Qualcomm Innovation Center, Inc. All rights reserved.
*
* Permission to use, copy, modify, and/or distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
@@ -16,7 +16,7 @@
*/
/**
* DOC : contains interface prototypes for OS_IF layer
* DOC: contains interface prototypes for OS_IF layer
*/
#include <qdf_trace.h>