qcacmn: Fix umac/green_ap documentation

The kernel-doc script identified some documentation errors in the
umac/green_ap folder, so fix them.

Change-Id: If4c1290ebcb395094e41b963b212d75da84fc4f5
CRs-Fixed: 3380569
This commit is contained in:
Jeff Johnson
2023-01-14 22:15:27 -08:00
committed by Madan Koyyalamudi
parent b13df1bdce
commit c90cb55572
3 changed files with 25 additions and 23 deletions

View File

@@ -1,6 +1,6 @@
/* /*
* Copyright (c) 2017-2020 The Linux Foundation. All rights reserved. * Copyright (c) 2017-2020 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
* any purpose with or without fee is hereby granted, provided that the * any purpose with or without fee is hereby granted, provided that the
@@ -23,11 +23,11 @@
#include "wlan_green_ap_main_i.h" #include "wlan_green_ap_main_i.h"
/* /**
* wlan_green_ap_ant_ps_reset() - Reset function * wlan_green_ap_ant_ps_reset() - Reset function
* @green_ap - green ap context * @green_ap_ctx: green ap context
* *
* Reset fiunction, so that Antenna Mask can come into effect. * Reset function, so that Antenna Mask can come into effect.
* This applies for only few of the hardware chips * This applies for only few of the hardware chips
* *
* Return: QDF_STATUS * Return: QDF_STATUS
@@ -113,11 +113,11 @@ qdf_export_symbol(wlan_is_egap_enabled);
/** /**
* wlan_green_ap_ps_event_state_update() - Update PS state and event * wlan_green_ap_ps_event_state_update() - Update PS state and event
* @pdev: pdev pointer * @green_ap_ctx: Green AP pdev context
* @state: ps state * @state: ps state
* @event: ps event * @event: ps event
* *
* @Return: Success or Failure * Return: Success or Failure
*/ */
static QDF_STATUS wlan_green_ap_ps_event_state_update( static QDF_STATUS wlan_green_ap_ps_event_state_update(
struct wlan_pdev_green_ap_ctx *green_ap_ctx, struct wlan_pdev_green_ap_ctx *green_ap_ctx,

View File

@@ -1,6 +1,6 @@
/* /*
* Copyright (c) 2017-2019 The Linux Foundation. All rights reserved. * Copyright (c) 2017-2019 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
* any purpose with or without fee is hereby granted, provided that the * any purpose with or without fee is hereby granted, provided that the
@@ -67,10 +67,10 @@
#define WLAN_GREEN_AP_PS_SUSPEND 2 #define WLAN_GREEN_AP_PS_SUSPEND 2
/** /**
* enum wlan_green_ap_ps_state - PS states * enum wlan_green_ap_ps_state - PS states
* @WLAN_GREEN_AP_PS_IDLE_STATE - Idle * @WLAN_GREEN_AP_PS_IDLE_STATE: Idle
* @WLAN_GREEN_AP_PS_OFF_STATE - Off * @WLAN_GREEN_AP_PS_OFF_STATE: Off
* @WLAN_GREEN_AP_PS_WAIT_STATE - Wait * @WLAN_GREEN_AP_PS_WAIT_STATE: Wait
* @WLAN_GREEN_AP_PS_ON_STATE - On * @WLAN_GREEN_AP_PS_ON_STATE: On
*/ */
enum wlan_green_ap_ps_state { enum wlan_green_ap_ps_state {
WLAN_GREEN_AP_PS_IDLE_STATE = 1, WLAN_GREEN_AP_PS_IDLE_STATE = 1,
@@ -81,14 +81,14 @@ enum wlan_green_ap_ps_state {
/** /**
* enum wlan_green_ap_ps_event - PS event * enum wlan_green_ap_ps_event - PS event
* @WLAN_GREEN_AP_PS_START_EVENT - Start * @WLAN_GREEN_AP_PS_START_EVENT: Start
* @WLAN_GREEN_AP_PS_STOP_EVENT - Stop * @WLAN_GREEN_AP_PS_STOP_EVENT: Stop
* @WLAN_GREEN_AP_ADD_STA_EVENT - Sta assoc * @WLAN_GREEN_AP_ADD_STA_EVENT: Sta assoc
* @WLAN_GREEN_AP_DEL_STA_EVENT - Sta disassoc * @WLAN_GREEN_AP_DEL_STA_EVENT: Sta disassoc
* @WLAN_GREEN_AP_ADD_MULTISTREAM_STA_EVENT - Multistream sta assoc * @WLAN_GREEN_AP_ADD_MULTISTREAM_STA_EVENT: Multistream sta assoc
* @WLAN_GREEN_AP_DEL_MULTISTREAM_STA_EVENT - Multistream sta disassoc * @WLAN_GREEN_AP_DEL_MULTISTREAM_STA_EVENT: Multistream sta disassoc
* @WLAN_GREEN_AP_PS_ON_EVENT - PS on * @WLAN_GREEN_AP_PS_ON_EVENT: PS on
* @WLAN_GREEN_AP_PS_OFF_EVENT - PS off * @WLAN_GREEN_AP_PS_WAIT_EVENT: PS wait
*/ */
enum wlan_green_ap_ps_event { enum wlan_green_ap_ps_event {
WLAN_GREEN_AP_PS_START_EVENT = 1, WLAN_GREEN_AP_PS_START_EVENT = 1,
@@ -103,8 +103,8 @@ enum wlan_green_ap_ps_event {
/** /**
* enum wlan_green_ap_ll_ps_state - PS state * enum wlan_green_ap_ll_ps_state - PS state
* @WLAN_GREEN_AP_LL_PS_DISABLE - Disable PS * @WLAN_GREEN_AP_LL_PS_DISABLE: Disable PS
* @WLAN_GREEN_AP_LL_PS_ENABLE - Enable PS * @WLAN_GREEN_AP_LL_PS_ENABLE: Enable PS
*/ */
enum wlan_green_ap_ll_ps_state { enum wlan_green_ap_ll_ps_state {
WLAN_GREEN_AP_LL_PS_DISABLE = 0, WLAN_GREEN_AP_LL_PS_DISABLE = 0,

View File

@@ -1,6 +1,6 @@
/* /*
* Copyright (c) 2017-2018 The Linux Foundation. All rights reserved. * Copyright (c) 2017-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
* any purpose with or without fee is hereby granted, provided that the * any purpose with or without fee is hereby granted, provided that the
@@ -60,7 +60,7 @@ QDF_STATUS ucfg_green_ap_ll_ps(struct wlan_objmgr_pdev *pdev,
/** /**
* ucfg_green_ap_set_ps_config() - Set ps value * ucfg_green_ap_set_ps_config() - Set ps value
* @pdev: pdev pointer * @pdev: pdev pointer
* @value - value to be set * @value: value to be set
* *
* Return: Success or Failure * Return: Success or Failure
*/ */
@@ -103,6 +103,7 @@ QDF_STATUS ucfg_green_ap_get_transition_time(struct wlan_objmgr_pdev *pdev,
/** /**
* ucfg_green_ap_config() - Config green AP * ucfg_green_ap_config() - Config green AP
* @pdev: pdev pointer * @pdev: pdev pointer
* @val: config value
* *
* Return: Success or Failure * Return: Success or Failure
*/ */
@@ -111,6 +112,7 @@ QDF_STATUS ucfg_green_ap_config(struct wlan_objmgr_pdev *pdev, uint8_t val);
/** /**
* ucfg_green_ap_enable_debug_prints() - Enable debugs * ucfg_green_ap_enable_debug_prints() - Enable debugs
* @pdev: pdev pointer * @pdev: pdev pointer
* @val: debug value
* *
* Return: None * Return: None
*/ */