Skip to content

Commit fd2afa7

Browse files
xp4ns3suryasaimadhu
authored andcommitted
x86/resctrl: Fix kernel-doc in internal.h
Add description of undocumented parameters. Issues 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/20210618223206.29539-1-fmdefrancesco@gmail.com
1 parent f9b871c commit fd2afa7

1 file changed

Lines changed: 14 additions & 7 deletions

File tree

arch/x86/kernel/cpu/resctrl/internal.h

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ DECLARE_STATIC_KEY_FALSE(rdt_mon_enable_key);
7070
* struct mon_evt - Entry in the event list of a resource
7171
* @evtid: event id
7272
* @name: name of the event
73+
* @list: entry in &rdt_resource->evt_list
7374
*/
7475
struct mon_evt {
7576
u32 evtid;
@@ -78,10 +79,13 @@ struct mon_evt {
7879
};
7980

8081
/**
81-
* struct mon_data_bits - Monitoring details for each event file
82-
* @rid: Resource id associated with the event file.
82+
* union mon_data_bits - Monitoring details for each event file
83+
* @priv: Used to store monitoring event data in @u
84+
* as kernfs private data
85+
* @rid: Resource id associated with the event file
8386
* @evtid: Event id associated with the event file
8487
* @domid: The domain to which the event file belongs
88+
* @u: Name of the bit fields struct
8589
*/
8690
union mon_data_bits {
8791
void *priv;
@@ -119,6 +123,7 @@ enum rdt_group_type {
119123
* @RDT_MODE_PSEUDO_LOCKSETUP: Resource group will be used for Pseudo-Locking
120124
* @RDT_MODE_PSEUDO_LOCKED: No sharing of this resource group's allocations
121125
* allowed AND the allocations are Cache Pseudo-Locked
126+
* @RDT_NUM_MODES: Total number of modes
122127
*
123128
* The mode of a resource group enables control over the allowed overlap
124129
* between allocations associated with different resource groups (classes
@@ -142,7 +147,7 @@ enum rdtgrp_mode {
142147

143148
/**
144149
* struct mongroup - store mon group's data in resctrl fs.
145-
* @mon_data_kn kernlfs node for the mon_data directory
150+
* @mon_data_kn: kernfs node for the mon_data directory
146151
* @parent: parent rdtgrp
147152
* @crdtgrp_list: child rdtgroup node list
148153
* @rmid: rmid for this rdtgroup
@@ -282,11 +287,11 @@ struct rftype {
282287
/**
283288
* struct mbm_state - status for each MBM counter in each domain
284289
* @chunks: Total data moved (multiply by rdt_group.mon_scale to get bytes)
285-
* @prev_msr Value of IA32_QM_CTR for this RMID last time we read it
290+
* @prev_msr: Value of IA32_QM_CTR for this RMID last time we read it
286291
* @prev_bw_msr:Value of previous IA32_QM_CTR for bandwidth counting
287-
* @prev_bw The most recent bandwidth in MBps
288-
* @delta_bw Difference between the current and previous bandwidth
289-
* @delta_comp Indicates whether to compute the delta_bw
292+
* @prev_bw: The most recent bandwidth in MBps
293+
* @delta_bw: Difference between the current and previous bandwidth
294+
* @delta_comp: Indicates whether to compute the delta_bw
290295
*/
291296
struct mbm_state {
292297
u64 chunks;
@@ -456,11 +461,13 @@ struct rdt_parse_data {
456461
* @data_width: Character width of data when displaying
457462
* @domains: All domains for this resource
458463
* @cache: Cache allocation related data
464+
* @membw: If the component has bandwidth controls, their properties.
459465
* @format_str: Per resource format string to show domain value
460466
* @parse_ctrlval: Per resource function pointer to parse control values
461467
* @evt_list: List of monitoring events
462468
* @num_rmid: Number of RMIDs available
463469
* @mon_scale: cqm counter * mon_scale = occupancy in bytes
470+
* @mbm_width: Monitor width, to detect and correct for overflow.
464471
* @fflags: flags to choose base and info files
465472
*/
466473
struct rdt_resource {

0 commit comments

Comments
 (0)