1
0

qcacld-3.0: Fix SON Documentation

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

Change-Id: I2aaa6746b05a963113ea78111a4cc45f35c1f98c
CRs-Fixed: 3359822
Este cometimento está contido em:
Jeff Johnson
2023-01-04 12:47:11 -08:00
cometido por Madan Koyyalamudi
ascendente 4086862b28
cometimento a51ab110dd
4 ficheiros modificados com 25 adições e 19 eliminações

Ver ficheiro

@@ -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