Skip to content

Commit f9b871c

Browse files
xp4ns3suryasaimadhu
authored andcommitted
x86/resctrl: Fix kernel-doc in pseudo_lock.c
Add undocumented parameters detected by scripts/kernel-doc. Signed-off-by: Fabio M. De Francesco <fmdefrancesco@gmail.com> Signed-off-by: Borislav Petkov <bp@suse.de> Reviewed-by: Reinette Chatre <reinette.chatre@intel.com> Link: https://lkml.kernel.org/r/20210616181530.4094-1-fmdefrancesco@gmail.com
1 parent 13311e7 commit f9b871c

1 file changed

Lines changed: 8 additions & 2 deletions

File tree

arch/x86/kernel/cpu/resctrl/pseudo_lock.c

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ static struct class *pseudo_lock_class;
4949

5050
/**
5151
* get_prefetch_disable_bits - prefetch disable bits of supported platforms
52+
* @void: It takes no parameters.
5253
*
5354
* Capture the list of platforms that have been validated to support
5455
* pseudo-locking. This includes testing to ensure pseudo-locked regions
@@ -162,7 +163,7 @@ static struct rdtgroup *region_find_by_minor(unsigned int minor)
162163
}
163164

164165
/**
165-
* pseudo_lock_pm_req - A power management QoS request list entry
166+
* struct pseudo_lock_pm_req - A power management QoS request list entry
166167
* @list: Entry within the @pm_reqs list for a pseudo-locked region
167168
* @req: PM QoS request
168169
*/
@@ -184,6 +185,7 @@ static void pseudo_lock_cstates_relax(struct pseudo_lock_region *plr)
184185

185186
/**
186187
* pseudo_lock_cstates_constrain - Restrict cores from entering C6
188+
* @plr: Pseudo-locked region
187189
*
188190
* To prevent the cache from being affected by power management entering
189191
* C6 has to be avoided. This is accomplished by requesting a latency
@@ -196,6 +198,8 @@ static void pseudo_lock_cstates_relax(struct pseudo_lock_region *plr)
196198
* the ACPI latencies need to be considered while keeping in mind that C2
197199
* may be set to map to deeper sleep states. In this case the latency
198200
* requirement needs to prevent entering C2 also.
201+
*
202+
* Return: 0 on success, <0 on failure
199203
*/
200204
static int pseudo_lock_cstates_constrain(struct pseudo_lock_region *plr)
201205
{
@@ -520,7 +524,7 @@ static int pseudo_lock_fn(void *_rdtgrp)
520524

521525
/**
522526
* rdtgroup_monitor_in_progress - Test if monitoring in progress
523-
* @r: resource group being queried
527+
* @rdtgrp: resource group being queried
524528
*
525529
* Return: 1 if monitor groups have been created for this resource
526530
* group, 0 otherwise.
@@ -1140,6 +1144,8 @@ static int measure_l3_residency(void *_plr)
11401144

11411145
/**
11421146
* pseudo_lock_measure_cycles - Trigger latency measure to pseudo-locked region
1147+
* @rdtgrp: Resource group to which the pseudo-locked region belongs.
1148+
* @sel: Selector of which measurement to perform on a pseudo-locked region.
11431149
*
11441150
* The measurement of latency to access a pseudo-locked region should be
11451151
* done from a cpu that is associated with that pseudo-locked region.

0 commit comments

Comments
 (0)