qcacmn: Fix Scheduler documentation

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

Change-Id: Iab5488cb765a2f5440493f28ba7c8b2716cf5953
CRs-Fixed: 3376446
This commit is contained in:
Jeff Johnson
2023-01-09 18:06:05 -08:00
committed by Madan Koyyalamudi
parent c65ba14b5f
commit 70a19e1678
2 changed files with 27 additions and 9 deletions

View File

@@ -1,6 +1,6 @@
/*
* Copyright (c) 2014-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
@@ -111,10 +111,11 @@ struct sched_qdf_mc_timer_cb_wrapper *scheduler_qdf_mc_timer_init(
void *data);
/**
* scheduler_qdf_mc_timer_callback_t_wrapper() - wrapper for mc timer callbacks
* scheduler_qdf_mc_timer_deinit_return_data_ptr() - deinitialize callback and
* return data
* @wrapper_ptr: wrapper ptr
*
* Return: return void ptr
* Return: original data supplied to scheduler_qdf_mc_timer_init()
*/
void *scheduler_qdf_mc_timer_deinit_return_data_ptr(
struct sched_qdf_mc_timer_cb_wrapper *wrapper_ptr);
@@ -219,14 +220,17 @@ static inline QDF_STATUS scheduler_post_msg(uint32_t qid,
}
/**
* scheduler_post_message() - post normal messages(no priority)
* scheduler_post_message_debug() - post normal messages(no priority)
* @src_id: Source module of the message
* @dest_id: Destination module of the message
* @que_id: Queue to which the message has to posted.
* @msg: message pointer
* @line: caller line number
* @func: caller function
*
* This function will mask the src_id, and destination id to qid of
* scheduler_post_msg
*
* Return: QDF status
*/
QDF_STATUS scheduler_post_message_debug(QDF_MODULE_ID src_id,
@@ -236,6 +240,18 @@ QDF_STATUS scheduler_post_message_debug(QDF_MODULE_ID src_id,
int line,
const char *func);
/**
* scheduler_post_message() - post normal messages(no priority)
* @src_id: Source module of the message
* @dest_id: Destination module of the message
* @que_id: Queue to which the message has to posted.
* @msg: message pointer
*
* This function will mask the src_id, and destination id to qid of
* scheduler_post_msg
*
* Return: QDF status
*/
#define scheduler_post_message(src_id, dest_id, que_id, msg) \
scheduler_post_message_debug(src_id, dest_id, que_id, msg, \
__LINE__, __func__)
@@ -251,7 +267,8 @@ QDF_STATUS scheduler_post_message_debug(QDF_MODULE_ID src_id,
void scheduler_resume(void);
/**
* scheduler_set_timeout() - set scheduler timeout for msg processing
* scheduler_set_watchdog_timeout() - set scheduler timeout for msg processing
* @timeout: timeout value in milliseconds
*
* Configure the timeout for triggering the scheduler watchdog timer
* in milliseconds
@@ -262,7 +279,7 @@ void scheduler_set_watchdog_timeout(uint32_t timeout);
/**
* scheduler_register_hdd_suspend_callback() - suspend callback to hdd
* @callback: hdd callback to be called when controllred thread is suspended
* @callback: hdd callback to be called when controller thread is suspended
*
* Return: none
*/

View File

@@ -1,5 +1,6 @@
/*
* Copyright (c) 2014-2021 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
* any purpose with or without fee is hereby granted, provided that the
@@ -129,7 +130,7 @@ struct scheduler_ctx {
};
/**
* scheduler_core_msg_dup() duplicate the given scheduler message
* scheduler_core_msg_dup() - duplicate the given scheduler message
* @msg: the message to duplicated
*
* Note: Duplicated messages must be freed using scheduler_core_msg_free().
@@ -234,11 +235,11 @@ QDF_STATUS scheduler_queues_init(struct scheduler_ctx *sched_ctx);
*
* Return: QDF_STATUS based on success of failure
*/
QDF_STATUS scheduler_queues_deinit(struct scheduler_ctx *gp_sch_ctx);
QDF_STATUS scheduler_queues_deinit(struct scheduler_ctx *sched_ctx);
/**
* scheduler_queues_flush() - flush all of the scheduler queues
* @sch_ctx: pointer to scheduler context
* @sched_ctx: pointer to scheduler context
*
* This routine is used to clean the module's queues
*