x86/intel_rdt: Add info files to Documentation
authorThomas Gleixner <tglx@linutronix.de>
Mon, 7 Nov 2016 10:58:12 +0000 (11:58 +0100)
committerThomas Gleixner <tglx@linutronix.de>
Mon, 7 Nov 2016 11:20:53 +0000 (12:20 +0100)
The content of the directories and files in the info directory of the
resctrl filesystem are not documented.

Add the missing bits and pieces.

Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
Cc: Shaohua Li <shli@fb.com>
Cc: Fenghua Yu <fenghua.yu@intel.com>
Cc: Tony Luck <tony.luck@intel.com>
Documentation/x86/intel_rdt_ui.txt

index 3b0ebd4..d918d26 100644 (file)
@@ -17,6 +17,25 @@ mount options are:
 "cdp": Enable code/data prioritization in L3 cache allocations.
 
 
+Info directory
+--------------
+
+The 'info' directory contains information about the enabled
+resources. Each resource has its own subdirectory. The subdirectory
+names reflect the resource names. Each subdirectory contains the
+following files:
+
+"num_closids":  The number of CLOSIDs which are valid for this
+               resource. The kernel uses the smallest number of
+               CLOSIDs of all enabled resources as limit.
+
+"cbm_mask":     The bitmask which is valid for this resource. This
+               mask is equivalent to 100%.
+
+"min_cbm_bits": The minimum number of consecutive bits which must be
+               set when writing a mask.
+
+
 Resource groups
 ---------------
 Resource groups are represented as directories in the resctrl file