lkml.org 
[lkml]   [2021]   [Jul]   [7]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
Patch in this message
/
From
Subject[PATCH] x86/resctrl: Fix kernel-doc in rdtgroup.c
Date
Add description of undocumented parameters. Issues detected by
scripts/kernel-doc.

Signed-off-by: Fabio M. De Francesco <fmdefrancesco@gmail.com>
---
arch/x86/kernel/cpu/resctrl/rdtgroup.c | 19 +++++++++++++++++++
1 file changed, 19 insertions(+)

diff --git a/arch/x86/kernel/cpu/resctrl/rdtgroup.c b/arch/x86/kernel/cpu/resctrl/rdtgroup.c
index 01fd30e7829d..b5a30e57ce5f 100644
--- a/arch/x86/kernel/cpu/resctrl/rdtgroup.c
+++ b/arch/x86/kernel/cpu/resctrl/rdtgroup.c
@@ -877,6 +877,9 @@ static int rdt_shareable_bits_show(struct kernfs_open_file *of,

/**
* rdt_bit_usage_show - Display current usage of resources
+ * @of: kernfs open file
+ * @seq: seq_file for kernfs
+ * @v: unused pointer to void
*
* A domain is a shared resource that can now be allocated differently. Here
* we display the current regions of the domain as an annotated bitmask.
@@ -888,6 +891,8 @@ static int rdt_shareable_bits_show(struct kernfs_open_file *of,
* S - currently used and shareable by software only
* E - currently used exclusively by one resource group
* P - currently pseudo-locked by one resource group
+ *
+ * Return: 0 on success
*/
static int rdt_bit_usage_show(struct kernfs_open_file *of,
struct seq_file *seq, void *v)
@@ -1243,6 +1248,7 @@ bool rdtgroup_cbm_overlaps(struct rdt_resource *r, struct rdt_domain *d,

/**
* rdtgroup_mode_test_exclusive - Test if this resource group can be exclusive
+ * @rdtgrp: resource director technology group
*
* An exclusive resource group implies that there should be no sharing of
* its allocated resources. At the time this group is considered to be
@@ -1283,7 +1289,12 @@ static bool rdtgroup_mode_test_exclusive(struct rdtgroup *rdtgrp)

/**
* rdtgroup_mode_write - Modify the resource group's mode
+ * @of: open file in kernfs
+ * @buf: input data buffer
+ * @nbytes: lenght of input data buffer
+ * @off: offset
*
+ * Return: @nbytes on success, <0 on failure
*/
static ssize_t rdtgroup_mode_write(struct kernfs_open_file *of,
char *buf, size_t nbytes, loff_t off)
@@ -1367,6 +1378,8 @@ static ssize_t rdtgroup_mode_write(struct kernfs_open_file *of,
*
* @cbm is unsigned long, even if only 32 bits are used to make the
* bitmap functions work correctly.
+ *
+ * Return: how many bytes are represented by the bitmask associated with the RDT domain.
*/
unsigned int rdtgroup_cbm_to_size(struct rdt_resource *r,
struct rdt_domain *d, unsigned long cbm)
@@ -1389,10 +1402,14 @@ unsigned int rdtgroup_cbm_to_size(struct rdt_resource *r,

/**
* rdtgroup_size_show - Display size in bytes of allocated regions
+ * @of: open file in kernfs
+ * @s: seq_file
+ * @v: unused pointer to void
*
* The "size" file mirrors the layout of the "schemata" file, printing the
* size in bytes of each region instead of the capacity bitmask.
*
+ * Return: 0 on success, <0 on failure
*/
static int rdtgroup_size_show(struct kernfs_open_file *of,
struct seq_file *s, void *v)
@@ -2618,6 +2635,8 @@ static int mkdir_mondata_all(struct kernfs_node *parent_kn,
* resource group is initialized. The user can follow this with a
* modification to the CBM if the default does not satisfy the
* requirements.
+ *
+ * Return: A bitmap representing a valid contiguous CBM, 0 if @_val is only 0 filled
*/
static u32 cbm_ensure_valid(u32 _val, struct rdt_resource *r)
{
--
2.32.0
\
 
 \ /
  Last update: 2021-07-07 13:30    [W:0.055 / U:0.100 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site