Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Received-SPF: Pass (protection.outlook.com: domain of amd.com designates
 165.204.84.17 as permitted sender) receiver=protection.outlook.com;
 client-ip=165.204.84.17; helo=SATLEXMB04.amd.com; pr=C
Subject: [PATCH v4 4/7] x86/resctrl: Re-arrange RFTYPE flags and add more
 comments
From:   Babu Moger <babu.moger@amd.com>
To:     <corbet@lwn.net>, <reinette.chatre@intel.com>,
        <tglx@linutronix.de>, <mingo@redhat.com>, <bp@alien8.de>
CC:     <fenghua.yu@intel.com>, <dave.hansen@linux.intel.com>,
        <x86@kernel.org>, <hpa@zytor.com>, <paulmck@kernel.org>,
        <akpm@linux-foundation.org>, <quic_neeraju@quicinc.com>,
        <rdunlap@infradead.org>, <damien.lemoal@opensource.wdc.com>,
        <songmuchun@bytedance.com>, <peterz@infradead.org>,
        <jpoimboe@kernel.org>, <pbonzini@redhat.com>, <babu.moger@amd.com>,
        <chang.seok.bae@intel.com>, <pawan.kumar.gupta@linux.intel.com>,
        <jmattson@google.com>, <daniel.sneddon@linux.intel.com>,
        <sandipan.das@amd.com>, <tony.luck@intel.com>,
        <james.morse@arm.com>, <linux-doc@vger.kernel.org>,
        <linux-kernel@vger.kernel.org>, <bagasdotme@gmail.com>,
        <eranian@google.com>, <christophe.leroy@csgroup.eu>,
        <pawan.kumar.gupta@linux.intel.com>, <jarkko@kernel.org>,
        <adrian.hunter@intel.com>, <quic_jiles@quicinc.com>,
        <peternewman@google.com>, <babu.moger@amd.com>
Date:   Mon, 17 Apr 2023 18:34:38 -0500
Message-ID: <168177447844.1758847.17789021842152864417.stgit@bmoger-ubuntu>
In-Reply-To: <168177435378.1758847.8317743523931859131.stgit@bmoger-ubuntu>
References: <168177435378.1758847.8317743523931859131.stgit@bmoger-ubuntu>
User-Agent: StGit/1.1.dev103+g5369f4c
MIME-Version: 1.0
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: quoted-printable
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 17 Apr 2023 23:34:42.7250
 (UTC)
X-MS-Exchange-CrossTenant-Network-Message-Id: 30ae592f-4360-496a-6383-08db3f9c521b
X-MS-Exchange-CrossTenant-Id: 3dd8961f-e488-4e60-8e11-a82d994e183d
X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=3dd8961f-e488-4e60-8e11-a82d994e183d;Ip=[165.204.84.17];Helo=[SATLEXMB04.amd.com]
X-MS-Exchange-CrossTenant-AuthSource: DM6NAM11FT086.eop-nam11.prod.protection.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Anonymous
X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem
X-MS-Exchange-Transport-CrossTenantHeadersStamped: SA0PR12MB4576
X-Spam-Status: No, score=-1.1 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,FORGED_SPF_HELO,
        RCVD_IN_DNSWL_NONE,RCVD_IN_MSPIKE_H2,SPF_HELO_PASS,SPF_NONE,
        T_SCC_BODY_TEXT_LINE autolearn=no autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

Remove gaps in bit definitions of RFTYPE flags and add more comments=0A=
to make it easy for future additions.=0A=
=0A=
Signed-off-by: Babu Moger <babu.moger@amd.com>=0A=
---=0A=
 arch/x86/kernel/cpu/resctrl/internal.h |   49 ++++++++++++++++++++++++++++=
+---=0A=
 1 file changed, 44 insertions(+), 5 deletions(-)=0A=
=0A=
diff --git a/arch/x86/kernel/cpu/resctrl/internal.h b/arch/x86/kernel/cpu/r=
esctrl/internal.h=0A=
index c4fc5a1c630c..75ddbd833fdf 100644=0A=
--- a/arch/x86/kernel/cpu/resctrl/internal.h=0A=
+++ b/arch/x86/kernel/cpu/resctrl/internal.h=0A=
@@ -240,14 +240,53 @@ struct rdtgroup {=0A=
 =0A=
 /*=0A=
  * Define the file type flags for base and info directories.=0A=
+ *=0A=
+ * RESCTRL filesystem has two main components=0A=
+ *   a. info=0A=
+ *   b. base.=0A=
+ *=0A=
+ * /sys/fs/resctrl/=0A=
+ *     |=0A=
+ *     --> info (Displays information about control and monitoring)=0A=
+ *     |=0A=
+ *     --> base (Displays the details on resctrl groups)=0A=
+ *=0A=
+ *    -------------------------------------------------------------=0A=
+ *     info directory structure=0A=
+ *     --> RFTYPE_INFO=0A=
+ *         --> RFTYPE_TOP_INFO=0A=
+ *             last_cmd_status=0A=
+ *=0A=
+ *         --> RFTYPE_MON_INFO=0A=
+ *            --> (L2_MON)=0A=
+ *            --> (L3_MON)=0A=
+ *                max_threshold_occupancy, mbm_local_bytes_config,=0A=
+ *                mbm_total_bytes_config, mon_features, num_rmids=0A=
+ *=0A=
+ *         --> RFTYPE_CTRL_INFO=0A=
+ *            --> RFTYPE_RES_CACHE (L2, L3)=0A=
+ *                bit_usage, cbm_mask, min_cbm_bits, num_closids,=0A=
+ *                shareable_bits=0A=
+ *=0A=
+ *            --> RFTYPE_RES_MB (MB, SMBA)=0A=
+ *                bandwidth_gran, delay_linear, min_bandwidth,=0A=
+ *                num_closids=0A=
+ *=0A=
+ *     group structure=0A=
+ *     -----------------------------------------------------------=0A=
+ *     --> RFTYPE_BASE (Files common for both MON and CTRL groups)=0A=
+ *         cpus, cpus_list, tasks=0A=
+ *=0A=
+ *     --> RFTYPE_CTRL_BASE (Files only for CTRL group)=0A=
+ *         mode, schemata, size=0A=
  */=0A=
 #define RFTYPE_INFO			BIT(0)=0A=
 #define RFTYPE_BASE			BIT(1)=0A=
-#define RFTYPE_CTRL			BIT(4)=0A=
-#define RFTYPE_MON			BIT(5)=0A=
-#define RFTYPE_TOP			BIT(6)=0A=
-#define RFTYPE_RES_CACHE		BIT(8)=0A=
-#define RFTYPE_RES_MB			BIT(9)=0A=
+#define RFTYPE_CTRL			BIT(2)=0A=
+#define RFTYPE_MON			BIT(3)=0A=
+#define RFTYPE_TOP			BIT(4)=0A=
+#define RFTYPE_RES_CACHE		BIT(5)=0A=
+#define RFTYPE_RES_MB			BIT(6)=0A=
 #define RFTYPE_CTRL_INFO		(RFTYPE_INFO | RFTYPE_CTRL)=0A=
 #define RFTYPE_MON_INFO			(RFTYPE_INFO | RFTYPE_MON)=0A=
 #define RFTYPE_TOP_INFO			(RFTYPE_INFO | RFTYPE_TOP)=0A=
=0A=