From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-15.8 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id BF985C48BDF for ; Fri, 18 Jun 2021 22:32:15 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id A091A6128C for ; Fri, 18 Jun 2021 22:32:15 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234936AbhFRWeY (ORCPT ); Fri, 18 Jun 2021 18:34:24 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:41928 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230268AbhFRWeW (ORCPT ); Fri, 18 Jun 2021 18:34:22 -0400 Received: from mail-ej1-x62b.google.com (mail-ej1-x62b.google.com [IPv6:2a00:1450:4864:20::62b]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id D3300C061574 for ; Fri, 18 Jun 2021 15:32:12 -0700 (PDT) Received: by mail-ej1-x62b.google.com with SMTP id ho18so18096349ejc.8 for ; Fri, 18 Jun 2021 15:32:12 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=p2FKOWnBaMuz6OBPKnzqLMqFzmhzNRt6rC9qAPa6m8w=; b=uW2EaoaUMOePMn5sgclv0HFxRXMahfmUgqHBhKFkp5IYnQbVMFhdmrjc+7BoyWTQf5 Nr0mE/nO13rhiJcyjE0cE4NXzZnJVDpBVSo9IltDFdUIXI45bfjcUnpRTRb6gb7ApKD/ z6o/24F1h9uvNeu5t+b0NiJXcMjjAor1isLlJjLLI85eIwHM8J7ey+YK4XdIERQ5Jp5d SMutEKNbasUT9v6qJAQ/p+vMn8JVejMBxjCaGFgKB8GOTYlTZS8fKGrPp84wp2nRSkek ELO5VyfXQuO+2itDk2aiNUMDk7v6N1/jTF4nq2VUmSoBb77hRm6+O0lKxjN0Tm40M3Mx hovw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=p2FKOWnBaMuz6OBPKnzqLMqFzmhzNRt6rC9qAPa6m8w=; b=MyC552jobLkrwsSsARC9Wy2SNp4wKXTFT42pd/yI7R25hItYymddFImin4CeJd2xxM zQGvdN73ioOu/GVPSnqYFfl/XDhNGJDBZZ9RyHJ8UE4q8uMgQwMGtDL0A9vGlibRJbqT asCab0cffmLkm9YXBi8NpjkmTcmtTSCG230EufVKpfXZ59xN1VNqQZcDQkFPbey/8RSO gs8GIjf5a28enWqj33zk7UMgeXYs3Sew0kMi/FmzRt7tvKxuGYbh8f8UylEe9lLdJpS5 zeRsjoJKAmsJu3QRpdw5Virqvsg21JOM89TezZnrPKpPZSQ+Es/HJXxW6aDvcRXjTir8 0rWw== X-Gm-Message-State: AOAM531kX73J014ZXru4of2dCLm3QZJZApxdO5O+qNVT428vYXWj8Ilj DWpwilt0umt3XFEKyoHzGRE= X-Google-Smtp-Source: ABdhPJzmXlFsXSKDbtvJUfftMmU/TDhRSqP5Yia+MeQMiBuATXPLT8b9SUs6NaneaLwPux2DVpiyKQ== X-Received: by 2002:a17:907:c87:: with SMTP id gi7mr12939090ejc.452.1624055531462; Fri, 18 Jun 2021 15:32:11 -0700 (PDT) Received: from linux.local (host-82-59-55-132.retail.telecomitalia.it. [82.59.55.132]) by smtp.gmail.com with ESMTPSA id n13sm6873182edx.30.2021.06.18.15.32.09 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 18 Jun 2021 15:32:10 -0700 (PDT) From: "Fabio M. De Francesco" To: Reinette Chatre , Fenghua Yu , Thomas Gleixner , Ingo Molnar , Borislav Petkov , x86@kernel.org, "H. Peter Anvin" , linux-kernel@vger.kernel.org Cc: "Fabio M. De Francesco" Subject: [PATCH v4] x86/resctrl: Fix kernel-doc in internal.h Date: Sat, 19 Jun 2021 00:32:06 +0200 Message-Id: <20210618223206.29539-1-fmdefrancesco@gmail.com> X-Mailer: git-send-email 2.32.0 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Add description of undocumented parameters. Issues detected by scripts/kernel-doc. Signed-off-by: Fabio M. De Francesco --- v3->v4: Make consistent use of spaces in the documentation of struct mon_data_bits. v2->v3: Fix typo. Inherit the descriptions of membw and mbm_width from commit https://lore.kernel.org/lkml/20210614200941.12383-2-james.morse@arm.com/ to make it easier to merge both patches. v1->v2: According to a first review by Reinette Chartre, remove changes unrelated to the subject of this patch and modify the descriptions of two parameters. arch/x86/kernel/cpu/resctrl/internal.h | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/arch/x86/kernel/cpu/resctrl/internal.h b/arch/x86/kernel/cpu/resctrl/internal.h index c4d320d02fd5..6a5f60a37219 100644 --- a/arch/x86/kernel/cpu/resctrl/internal.h +++ b/arch/x86/kernel/cpu/resctrl/internal.h @@ -70,6 +70,7 @@ DECLARE_STATIC_KEY_FALSE(rdt_mon_enable_key); * struct mon_evt - Entry in the event list of a resource * @evtid: event id * @name: name of the event + * @list: entry in &rdt_resource->evt_list */ struct mon_evt { u32 evtid; @@ -78,10 +79,13 @@ struct mon_evt { }; /** - * struct mon_data_bits - Monitoring details for each event file - * @rid: Resource id associated with the event file. + * union mon_data_bits - Monitoring details for each event file + * @priv: Used to store monitoring event data in @u + * as kernfs private data + * @rid: Resource id associated with the event file * @evtid: Event id associated with the event file * @domid: The domain to which the event file belongs + * @u: Name of the bit fields struct */ union mon_data_bits { void *priv; @@ -119,6 +123,7 @@ enum rdt_group_type { * @RDT_MODE_PSEUDO_LOCKSETUP: Resource group will be used for Pseudo-Locking * @RDT_MODE_PSEUDO_LOCKED: No sharing of this resource group's allocations * allowed AND the allocations are Cache Pseudo-Locked + * @RDT_NUM_MODES: Total number of modes * * The mode of a resource group enables control over the allowed overlap * between allocations associated with different resource groups (classes @@ -142,7 +147,7 @@ enum rdtgrp_mode { /** * struct mongroup - store mon group's data in resctrl fs. - * @mon_data_kn kernlfs node for the mon_data directory + * @mon_data_kn: kernfs node for the mon_data directory * @parent: parent rdtgrp * @crdtgrp_list: child rdtgroup node list * @rmid: rmid for this rdtgroup @@ -282,11 +287,11 @@ struct rftype { /** * struct mbm_state - status for each MBM counter in each domain * @chunks: Total data moved (multiply by rdt_group.mon_scale to get bytes) - * @prev_msr Value of IA32_QM_CTR for this RMID last time we read it + * @prev_msr: Value of IA32_QM_CTR for this RMID last time we read it * @prev_bw_msr:Value of previous IA32_QM_CTR for bandwidth counting - * @prev_bw The most recent bandwidth in MBps - * @delta_bw Difference between the current and previous bandwidth - * @delta_comp Indicates whether to compute the delta_bw + * @prev_bw: The most recent bandwidth in MBps + * @delta_bw: Difference between the current and previous bandwidth + * @delta_comp: Indicates whether to compute the delta_bw */ struct mbm_state { u64 chunks; @@ -456,11 +461,13 @@ struct rdt_parse_data { * @data_width: Character width of data when displaying * @domains: All domains for this resource * @cache: Cache allocation related data + * @membw: If the component has bandwidth controls, their properties. * @format_str: Per resource format string to show domain value * @parse_ctrlval: Per resource function pointer to parse control values * @evt_list: List of monitoring events * @num_rmid: Number of RMIDs available * @mon_scale: cqm counter * mon_scale = occupancy in bytes + * @mbm_width: Monitor width, to detect and correct for overflow. * @fflags: flags to choose base and info files */ struct rdt_resource { -- 2.32.0