Skip to content

Commit e54dd04

Browse files
sadelodunKAGA-KOKO
authored andcommitted
time: tick-oneshot: Add missing Return and parameter descriptions to kernel-doc
Several functions in kernel/time/tick-oneshot.c are missing parameter and return value descriptions in their kernel-doc comments. This causes warnings during doc generation. Update the kernel-doc blocks to include detailed @param and Return: descriptions for better clarity and to fix kernel-doc warnings. No functional code changes are made. Signed-off-by: Sunday Adelodun <adelodunolaoluwa@yahoo.com> Signed-off-by: Thomas Gleixner <tglx@linutronix.de> Link: https://patch.msgid.link/20251106113938.34693-3-adelodunolaoluwa@yahoo.com
1 parent 4702f4e commit e54dd04

1 file changed

Lines changed: 19 additions & 1 deletion

File tree

kernel/time/tick-oneshot.c

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,10 @@
1919

2020
/**
2121
* tick_program_event - program the CPU local timer device for the next event
22+
* @expires: the time at which the next timer event should occur
23+
* @force: flag to force reprograming even if the event time hasn't changed
24+
*
25+
* Return: 0 on success, negative error code on failure
2226
*/
2327
int tick_program_event(ktime_t expires, int force)
2428
{
@@ -57,6 +61,13 @@ void tick_resume_oneshot(void)
5761

5862
/**
5963
* tick_setup_oneshot - setup the event device for oneshot mode (hres or nohz)
64+
* @newdev: Pointer to the clock event device to configure
65+
* @handler: Function to be called when the event device triggers an interrupt
66+
* @next_event: Initial expiry time for the next event (in ktime)
67+
*
68+
* Configures the specified clock event device for onshot mode,
69+
* assigns the given handler as its event callback, and programs
70+
* the device to trigger at the specified next event time.
6071
*/
6172
void tick_setup_oneshot(struct clock_event_device *newdev,
6273
void (*handler)(struct clock_event_device *),
@@ -69,6 +80,10 @@ void tick_setup_oneshot(struct clock_event_device *newdev,
6980

7081
/**
7182
* tick_switch_to_oneshot - switch to oneshot mode
83+
* @handler: function to call when an event occurs on the tick device
84+
*
85+
* Return: 0 on success, -EINVAL if the tick device is not present,
86+
* not functional, or does not support oneshot mode.
7287
*/
7388
int tick_switch_to_oneshot(void (*handler)(struct clock_event_device *))
7489
{
@@ -101,7 +116,7 @@ int tick_switch_to_oneshot(void (*handler)(struct clock_event_device *))
101116
/**
102117
* tick_oneshot_mode_active - check whether the system is in oneshot mode
103118
*
104-
* returns 1 when either nohz or highres are enabled. otherwise 0.
119+
* Return: 1 when either nohz or highres are enabled, otherwise 0.
105120
*/
106121
int tick_oneshot_mode_active(void)
107122
{
@@ -120,6 +135,9 @@ int tick_oneshot_mode_active(void)
120135
* tick_init_highres - switch to high resolution mode
121136
*
122137
* Called with interrupts disabled.
138+
*
139+
* Return: 0 on success, -EINVAL if the tick device cannot switch
140+
* to oneshot/high-resolution mode.
123141
*/
124142
int tick_init_highres(void)
125143
{

0 commit comments

Comments
 (0)