Skip to content

Commit 42a997f

Browse files
committed
ARM: vexpress/spc: Fix all the kernel-doc build warnings
There are more kernel-doc build warnings as below than the ones reported by kernel test robot recently for this file. | arch/arm/mach-vexpress/spc.c:125: warning: missing initial short description on line: | * ve_spc_global_wakeup_irq() | arch/arm/mach-vexpress/spc.c:131: warning: contents before sections | arch/arm/mach-vexpress/spc.c:148: warning: missing initial short description on line: | * ve_spc_cpu_wakeup_irq() | arch/arm/mach-vexpress/spc.c:154: warning: contents before sections | arch/arm/mach-vexpress/spc.c:203: warning: missing initial short description on line: | * ve_spc_powerdown() | arch/arm/mach-vexpress/spc.c:209: warning: contents before sections | arch/arm/mach-vexpress/spc.c:231: warning: missing initial short description on line: | * ve_spc_cpu_in_wfi() | 7 warnings Fix all these warnings. Link: https://lore.kernel.org/r/20220404130207.1162445-2-sudeep.holla@arm.com Cc: Liviu Dudau <liviu.dudau@arm.com> Cc: Lorenzo Pieralisi <lorenzo.pieralisi@arm.com> Signed-off-by: Sudeep Holla <sudeep.holla@arm.com>
1 parent 5063b7a commit 42a997f

1 file changed

Lines changed: 13 additions & 13 deletions

File tree

  • arch/arm/mach-vexpress

arch/arm/mach-vexpress/spc.c

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -122,13 +122,13 @@ static inline bool cluster_is_a15(u32 cluster)
122122
}
123123

124124
/**
125-
* ve_spc_global_wakeup_irq()
125+
* ve_spc_global_wakeup_irq() - sets/clears global wakeup IRQs
126+
*
127+
* @set: if true, global wake-up IRQs are set, if false they are cleared
126128
*
127129
* Function to set/clear global wakeup IRQs. Not protected by locking since
128130
* it might be used in code paths where normal cacheable locks are not
129131
* working. Locking must be provided by the caller to ensure atomicity.
130-
*
131-
* @set: if true, global wake-up IRQs are set, if false they are cleared
132132
*/
133133
void ve_spc_global_wakeup_irq(bool set)
134134
{
@@ -145,15 +145,15 @@ void ve_spc_global_wakeup_irq(bool set)
145145
}
146146

147147
/**
148-
* ve_spc_cpu_wakeup_irq()
149-
*
150-
* Function to set/clear per-CPU wake-up IRQs. Not protected by locking since
151-
* it might be used in code paths where normal cacheable locks are not
152-
* working. Locking must be provided by the caller to ensure atomicity.
148+
* ve_spc_cpu_wakeup_irq() - sets/clears per-CPU wake-up IRQs
153149
*
154150
* @cluster: mpidr[15:8] bitfield describing cluster affinity level
155151
* @cpu: mpidr[7:0] bitfield describing cpu affinity level
156152
* @set: if true, wake-up IRQs are set, if false they are cleared
153+
*
154+
* Function to set/clear per-CPU wake-up IRQs. Not protected by locking since
155+
* it might be used in code paths where normal cacheable locks are not
156+
* working. Locking must be provided by the caller to ensure atomicity.
157157
*/
158158
void ve_spc_cpu_wakeup_irq(u32 cluster, u32 cpu, bool set)
159159
{
@@ -200,14 +200,14 @@ void ve_spc_set_resume_addr(u32 cluster, u32 cpu, u32 addr)
200200
}
201201

202202
/**
203-
* ve_spc_powerdown()
203+
* ve_spc_powerdown() - enables/disables cluster powerdown
204+
*
205+
* @cluster: mpidr[15:8] bitfield describing cluster affinity level
206+
* @enable: if true enables powerdown, if false disables it
204207
*
205208
* Function to enable/disable cluster powerdown. Not protected by locking
206209
* since it might be used in code paths where normal cacheable locks are not
207210
* working. Locking must be provided by the caller to ensure atomicity.
208-
*
209-
* @cluster: mpidr[15:8] bitfield describing cluster affinity level
210-
* @enable: if true enables powerdown, if false disables it
211211
*/
212212
void ve_spc_powerdown(u32 cluster, bool enable)
213213
{
@@ -228,7 +228,7 @@ static u32 standbywfi_cpu_mask(u32 cpu, u32 cluster)
228228
}
229229

230230
/**
231-
* ve_spc_cpu_in_wfi()
231+
* ve_spc_cpu_in_wfi() - Checks if the specified CPU is in WFI or not
232232
*
233233
* @cpu: mpidr[7:0] bitfield describing CPU affinity level within cluster
234234
* @cluster: mpidr[15:8] bitfield describing cluster affinity level

0 commit comments

Comments
 (0)