From c90cb55572eee60b3b13d0766be45322765a8a97 Mon Sep 17 00:00:00 2001 From: Jeff Johnson Date: Sat, 14 Jan 2023 22:15:27 -0800 Subject: [PATCH] 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 --- umac/green_ap/core/src/wlan_green_ap_main.c | 12 ++++---- umac/green_ap/core/src/wlan_green_ap_main_i.h | 30 +++++++++---------- .../dispatcher/inc/wlan_green_ap_ucfg_api.h | 6 ++-- 3 files changed, 25 insertions(+), 23 deletions(-) diff --git a/umac/green_ap/core/src/wlan_green_ap_main.c b/umac/green_ap/core/src/wlan_green_ap_main.c index 0de1a512c6..3e06ffbd70 100644 --- a/umac/green_ap/core/src/wlan_green_ap_main.c +++ b/umac/green_ap/core/src/wlan_green_ap_main.c @@ -1,6 +1,6 @@ /* * 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 * any purpose with or without fee is hereby granted, provided that the @@ -23,11 +23,11 @@ #include "wlan_green_ap_main_i.h" -/* +/** * 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 * * 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 - * @pdev: pdev pointer + * @green_ap_ctx: Green AP pdev context * @state: ps state * @event: ps event * - * @Return: Success or Failure + * Return: Success or Failure */ static QDF_STATUS wlan_green_ap_ps_event_state_update( struct wlan_pdev_green_ap_ctx *green_ap_ctx, diff --git a/umac/green_ap/core/src/wlan_green_ap_main_i.h b/umac/green_ap/core/src/wlan_green_ap_main_i.h index 8c2b7c7e3f..d74efa4a23 100644 --- a/umac/green_ap/core/src/wlan_green_ap_main_i.h +++ b/umac/green_ap/core/src/wlan_green_ap_main_i.h @@ -1,6 +1,6 @@ /* * 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 * any purpose with or without fee is hereby granted, provided that the @@ -67,10 +67,10 @@ #define WLAN_GREEN_AP_PS_SUSPEND 2 /** * enum wlan_green_ap_ps_state - PS states - * @WLAN_GREEN_AP_PS_IDLE_STATE - Idle - * @WLAN_GREEN_AP_PS_OFF_STATE - Off - * @WLAN_GREEN_AP_PS_WAIT_STATE - Wait - * @WLAN_GREEN_AP_PS_ON_STATE - On + * @WLAN_GREEN_AP_PS_IDLE_STATE: Idle + * @WLAN_GREEN_AP_PS_OFF_STATE: Off + * @WLAN_GREEN_AP_PS_WAIT_STATE: Wait + * @WLAN_GREEN_AP_PS_ON_STATE: On */ enum wlan_green_ap_ps_state { 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 - * @WLAN_GREEN_AP_PS_START_EVENT - Start - * @WLAN_GREEN_AP_PS_STOP_EVENT - Stop - * @WLAN_GREEN_AP_ADD_STA_EVENT - Sta assoc - * @WLAN_GREEN_AP_DEL_STA_EVENT - Sta disassoc - * @WLAN_GREEN_AP_ADD_MULTISTREAM_STA_EVENT - Multistream sta assoc - * @WLAN_GREEN_AP_DEL_MULTISTREAM_STA_EVENT - Multistream sta disassoc - * @WLAN_GREEN_AP_PS_ON_EVENT - PS on - * @WLAN_GREEN_AP_PS_OFF_EVENT - PS off + * @WLAN_GREEN_AP_PS_START_EVENT: Start + * @WLAN_GREEN_AP_PS_STOP_EVENT: Stop + * @WLAN_GREEN_AP_ADD_STA_EVENT: Sta assoc + * @WLAN_GREEN_AP_DEL_STA_EVENT: Sta disassoc + * @WLAN_GREEN_AP_ADD_MULTISTREAM_STA_EVENT: Multistream sta assoc + * @WLAN_GREEN_AP_DEL_MULTISTREAM_STA_EVENT: Multistream sta disassoc + * @WLAN_GREEN_AP_PS_ON_EVENT: PS on + * @WLAN_GREEN_AP_PS_WAIT_EVENT: PS wait */ enum wlan_green_ap_ps_event { 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 - * @WLAN_GREEN_AP_LL_PS_DISABLE - Disable PS - * @WLAN_GREEN_AP_LL_PS_ENABLE - Enable PS + * @WLAN_GREEN_AP_LL_PS_DISABLE: Disable PS + * @WLAN_GREEN_AP_LL_PS_ENABLE: Enable PS */ enum wlan_green_ap_ll_ps_state { WLAN_GREEN_AP_LL_PS_DISABLE = 0, diff --git a/umac/green_ap/dispatcher/inc/wlan_green_ap_ucfg_api.h b/umac/green_ap/dispatcher/inc/wlan_green_ap_ucfg_api.h index 0652348f9d..a211772aa0 100644 --- a/umac/green_ap/dispatcher/inc/wlan_green_ap_ucfg_api.h +++ b/umac/green_ap/dispatcher/inc/wlan_green_ap_ucfg_api.h @@ -1,6 +1,6 @@ /* * 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 * 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 * @pdev: pdev pointer - * @value - value to be set + * @value: value to be set * * 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 * @pdev: pdev pointer + * @val: config value * * 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 * @pdev: pdev pointer + * @val: debug value * * Return: None */