From patchwork Thu Aug 6 23:49:24 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Stefano Stabellini X-Patchwork-Id: 11704549 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id CA9C114DD for ; Thu, 6 Aug 2020 23:50:14 +0000 (UTC) Received: from lists.xenproject.org (lists.xenproject.org [192.237.175.120]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id D32B121744 for ; Thu, 6 Aug 2020 23:50:14 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=fail reason="signature verification failed" (1024-bit key) header.d=kernel.org header.i=@kernel.org header.b="GxI0OoET" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org D32B121744 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=kernel.org Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=xen-devel-bounces@lists.xenproject.org Received: from localhost ([127.0.0.1] helo=lists.xenproject.org) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1k3pdy-0004SJ-S2; Thu, 06 Aug 2020 23:49:54 +0000 Received: from us1-rack-iad1.inumbo.com ([172.99.69.81]) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1k3pdx-0004FC-Kj for xen-devel@lists.xenproject.org; Thu, 06 Aug 2020 23:49:53 +0000 X-Inumbo-ID: 2e66862a-07a4-432f-a589-c70212a3ad76 Received: from mail.kernel.org (unknown [198.145.29.99]) by us1-rack-iad1.inumbo.com (Halon) with ESMTPS id 2e66862a-07a4-432f-a589-c70212a3ad76; Thu, 06 Aug 2020 23:49:39 +0000 (UTC) Received: from sstabellini-ThinkPad-T480s.hsd1.ca.comcast.net (c-67-164-102-47.hsd1.ca.comcast.net [67.164.102.47]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPSA id 0B77622D05; Thu, 6 Aug 2020 23:49:39 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1596757779; bh=tG7IOMVzAKrOpHe65a5zGXzao6XoCl9HRXWwSXpjlE0=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=GxI0OoETdZHYjWzTj7zc4Fx7XEP9Op9CJs1G9FU0BQNvMB2GW4qPIDUvWHf/BCHIq ddrxZ/cSHMxwm9bGiH6wcUoxkQi0iFiursnZBvZz6U6d1sABRHB03beYxelhageYdv 9c/MR87PwOwyC7H57kU4xg0+BW+t22TwJ0vwBAV0= From: Stefano Stabellini To: xen-devel@lists.xenproject.org Subject: [PATCH 05/14] kernel-doc: public/features.h Date: Thu, 6 Aug 2020 16:49:24 -0700 Message-Id: <20200806234933.16448-5-sstabellini@kernel.org> X-Mailer: git-send-email 2.17.1 In-Reply-To: References: X-BeenThere: xen-devel@lists.xenproject.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Xen developer discussion List-Unsubscribe: , List-Post: List-Help: List-Subscribe: , Cc: sstabellini@kernel.org, julien@xen.org, wl@xen.org, andrew.cooper3@citrix.com, ian.jackson@eu.citrix.com, george.dunlap@citrix.com, jbeulich@suse.com, Stefano Stabellini Errors-To: xen-devel-bounces@lists.xenproject.org Sender: "Xen-devel" From: Stefano Stabellini Convert in-code comments to kernel-doc format wherever possible. Signed-off-by: Stefano Stabellini --- xen/include/public/features.h | 78 ++++++++++++++++++++++++++--------- 1 file changed, 59 insertions(+), 19 deletions(-) diff --git a/xen/include/public/features.h b/xen/include/public/features.h index 1613b2aab8..524d1758c4 100644 --- a/xen/include/public/features.h +++ b/xen/include/public/features.h @@ -27,8 +27,8 @@ #ifndef __XEN_PUBLIC_FEATURES_H__ #define __XEN_PUBLIC_FEATURES_H__ -/* - * `incontents 200 elfnotes_features XEN_ELFNOTE_FEATURES +/** + * DOC: XEN_ELFNOTE_FEATURES * * The list of all the features the guest supports. They are set by * parsing the XEN_ELFNOTE_FEATURES and XEN_ELFNOTE_SUPPORTED_FEATURES @@ -41,19 +41,25 @@ * XENFEAT_dom0 MUST be set if the guest is to be booted as dom0, */ -/* - * If set, the guest does not need to write-protect its pagetables, and can - * update them via direct writes. +/** + * DOC: XENFEAT_writable_page_tables + * + * If set, the guest does not need to write-protect its pagetables, and + * can update them via direct writes. */ #define XENFEAT_writable_page_tables 0 -/* +/** + * DOC: XENFEAT_writable_descriptor_tables + * * If set, the guest does not need to write-protect its segment descriptor * tables, and can update them via direct writes. */ #define XENFEAT_writable_descriptor_tables 1 -/* +/** + * DOC: XENFEAT_auto_translated_physmap + * * If set, translation between the guest's 'pseudo-physical' address space * and the host's machine address space are handled by the hypervisor. In this * mode the guest does not need to perform phys-to/from-machine translations @@ -61,37 +67,63 @@ */ #define XENFEAT_auto_translated_physmap 2 -/* If set, the guest is running in supervisor mode (e.g., x86 ring 0). */ +/** + * DOC: XENFEAT_supervisor_mode_kernel + * + * If set, the guest is running in supervisor mode (e.g., x86 ring 0). + */ #define XENFEAT_supervisor_mode_kernel 3 -/* +/** + * DOC: XENFEAT_pae_pgdir_above_4gb + * * If set, the guest does not need to allocate x86 PAE page directories * below 4GB. This flag is usually implied by auto_translated_physmap. */ #define XENFEAT_pae_pgdir_above_4gb 4 -/* x86: Does this Xen host support the MMU_PT_UPDATE_PRESERVE_AD hypercall? */ +/** + * DOC: XENFEAT_mmu_pt_update_preserve_ad + * x86: Does this Xen host support the MMU_PT_UPDATE_PRESERVE_AD hypercall? + */ #define XENFEAT_mmu_pt_update_preserve_ad 5 -/* x86: Does this Xen host support the MMU_{CLEAR,COPY}_PAGE hypercall? */ +/** + * DOC: XENFEAT_highmem_assist + * x86: Does this Xen host support the MMU_{CLEAR,COPY}_PAGE hypercall? + */ #define XENFEAT_highmem_assist 6 -/* +/** + * DOC: XENFEAT_gnttab_map_avail_bits + * * If set, GNTTABOP_map_grant_ref honors flags to be placed into guest kernel * available pte bits. */ #define XENFEAT_gnttab_map_avail_bits 7 -/* x86: Does this Xen host support the HVM callback vector type? */ +/** + * DOC: XENFEAT_hvm_callback_vector + * x86: Does this Xen host support the HVM callback vector type? + */ #define XENFEAT_hvm_callback_vector 8 -/* x86: pvclock algorithm is safe to use on HVM */ +/** + * DOC: XENFEAT_hvm_safe_pvclock + * x86: pvclock algorithm is safe to use on HVM + */ #define XENFEAT_hvm_safe_pvclock 9 -/* x86: pirq can be used by HVM guests */ +/** + * DOC: XENFEAT_hvm_pirqs + * x86: pirq can be used by HVM guests + */ #define XENFEAT_hvm_pirqs 10 -/* operation as Dom0 is supported */ +/** + * DOC: XENFEAT_dom0 + * operation as Dom0 is supported + */ #define XENFEAT_dom0 11 /* Xen also maps grant references at pfn = mfn. @@ -99,13 +131,21 @@ #define XENFEAT_grant_map_identity 12 */ -/* Guest can use XENMEMF_vnode to specify virtual node for memory op. */ +/** + * DOC: XENFEAT_memory_op_vnode_supported + * Guest can use XENMEMF_vnode to specify virtual node for memory op. + */ #define XENFEAT_memory_op_vnode_supported 13 -/* arm: Hypervisor supports ARM SMC calling convention. */ +/** + * DOC: XENFEAT_ARM_SMCCC_supported + * arm: Hypervisor supports ARM SMC calling convention. + */ #define XENFEAT_ARM_SMCCC_supported 14 -/* +/** + * DOC: XENFEAT_linux_rsdp_unrestricted + * * x86/PVH: If set, ACPI RSDP can be placed at any address. Otherwise RSDP * must be located in lower 1MB, as required by ACPI Specification for IA-PC * systems.