Skip to content

Commit

Permalink
x86/resctrl: Fix kernel-doc in pseudo_lock.c
Browse files Browse the repository at this point in the history
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
  • Loading branch information
Fabio M. De Francesco authored and Borislav Petkov committed Jun 24, 2021
1 parent 13311e7 commit f9b871c
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions arch/x86/kernel/cpu/resctrl/pseudo_lock.c
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ static struct class *pseudo_lock_class;

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

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

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

/**
* rdtgroup_monitor_in_progress - Test if monitoring in progress
* @r: resource group being queried
* @rdtgrp: resource group being queried
*
* Return: 1 if monitor groups have been created for this resource
* group, 0 otherwise.
Expand Down Expand Up @@ -1140,6 +1144,8 @@ static int measure_l3_residency(void *_plr)

/**
* pseudo_lock_measure_cycles - Trigger latency measure to pseudo-locked region
* @rdtgrp: Resource group to which the pseudo-locked region belongs.
* @sel: Selector of which measurement to perform on a pseudo-locked region.
*
* The measurement of latency to access a pseudo-locked region should be
* done from a cpu that is associated with that pseudo-locked region.
Expand Down

0 comments on commit f9b871c

Please sign in to comment.