From nobody Sun Feb 8 14:59:32 2026 Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 35E0E1891A9 for ; Sat, 29 Nov 2025 00:25:28 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=198.137.202.133 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1764375933; cv=none; b=GRW5P4k8ehxUch/9dW8dOl7yD9xRcAdc3/pVAfMr8lbeP8rNdFFGKouRfVg0Flq/KvmlGjSUt9wpkqlRozvOlv/Xd2ZtlGGxCI+ZCGud93txFOS0jXzqrB60kEcF+KSJpXjCYFGauZPz9ahz2ijl7CMgMTcmetPVuqQIKjqOV9A= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1764375933; c=relaxed/simple; bh=vT9ihnKVONdygSo7kT4WRrhZPa/AQMEJvJLseSpp+D4=; h=From:To:Cc:Subject:Date:Message-ID:MIME-Version; b=SqZqGtyh8mSX0zyo9CkkwOENBhea3o7CoGS461FQSlndCo2vfU7UCQzFRVIks1s3N18bskMrsQR5dm2Y1IADz/pse4+Ko44Z6ZeyfQ89/tauoc1jTAC6fS3QZu2ROpjufJpJvVAY/UkNUkEcNLEGGoUsDKkSD/AafRx8o5wSJBA= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=infradead.org; spf=none smtp.mailfrom=infradead.org; dkim=pass (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b=guU8pVDZ; arc=none smtp.client-ip=198.137.202.133 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=infradead.org Authentication-Results: smtp.subspace.kernel.org; spf=none smtp.mailfrom=infradead.org Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b="guU8pVDZ" DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20210309; h=Content-Transfer-Encoding: MIME-Version:Message-ID:Date:Subject:Cc:To:From:Sender:Reply-To:Content-Type: Content-ID:Content-Description:In-Reply-To:References; bh=SnM+ZQceqkFDDn8vsd3yJ6lI8bbX5bFJZr/Po8S3oWY=; b=guU8pVDZhj9mszUI2oLXn+RJFX dDGfOrOIUAsOnjmAptxZp9iFogN+urtCr+06lx/bfq62AqLnI5Ajkt1pWyJjQYA9r/NYrf/H1Ah7L WpMvJ58PBSHBr2fkvDzeSdxVAE7N+IgrZI3JAkJZIgq9TItujETruvPR7cWPyr6FDsTVIZhvAomCu ICC2J/z/KmsK8i3GTf/DmjTOqZ/zBG34on4rxEWBuV2U/WGBguWAfbxEI/gN4Vvq7b5faL2pdtvJx +a3P015+LybboWFPb08XhIY71ROxXK4Y9YVEmdvKyZv5hKVZmTmZubs3QKntLOBFNENjIH8+ykHhg lAQfbt4g==; Received: from [50.53.43.113] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.98.2 #2 (Red Hat Linux)) id 1vP8mD-000000015MF-1Ori; Sat, 29 Nov 2025 00:25:25 +0000 From: Randy Dunlap To: linux-kernel@vger.kernel.org Cc: Randy Dunlap , Thomas Gleixner , Ingo Molnar , Borislav Petkov , Dave Hansen , x86@kernel.org, "H. Peter Anvin" Subject: [PATCH] x86/init: add kernel-doc comments to x86_init.h Date: Fri, 28 Nov 2025 16:25:24 -0800 Message-ID: <20251129002524.1196500-1-rdunlap@infradead.org> X-Mailer: git-send-email 2.52.0 Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Fix most (17) kernel-doc warnings in x86_init.h (except for struct x86_init_ops). The changes are: - fix struct member name typos - add ending ':' to struct member names - add some missing struct member descriptions Signed-off-by: Randy Dunlap --- Cc: Thomas Gleixner Cc: Ingo Molnar Cc: Borislav Petkov Cc: Dave Hansen Cc: x86@kernel.org Cc: "H. Peter Anvin" --- arch/x86/include/asm/x86_init.h | 28 ++++++++++++++++------------ 1 file changed, 16 insertions(+), 12 deletions(-) --- linux-next-20251128.orig/arch/x86/include/asm/x86_init.h +++ linux-next-20251128/arch/x86/include/asm/x86_init.h @@ -79,7 +79,7 @@ struct x86_init_paging { =20 /** * struct x86_init_timers - platform specific timer setup - * @setup_perpcu_clockev: set up the per cpu clock event device for the + * @setup_percpu_clockev: set up the per cpu clock event device for the * boot cpu * @timer_init: initialize the platform timer (default PIT/HPET) * @wallclock_init: init the wallclock device @@ -132,7 +132,7 @@ struct x86_hyper_init { =20 /** * struct x86_init_acpi - x86 ACPI init functions - * @set_root_poitner: set RSDP address + * @set_root_pointer: set RSDP address * @get_root_pointer: get RSDP address * @reduced_hw_early_init: hardware reduced platform early init */ @@ -145,14 +145,14 @@ struct x86_init_acpi { /** * struct x86_guest - Functions used by misc guest incarnations like SEV, = TDX, etc. * - * @enc_status_change_prepare Notify HV before the encryption status of a = range is changed - * @enc_status_change_finish Notify HV after the encryption status of a ra= nge is changed - * @enc_tlb_flush_required Returns true if a TLB flush is needed before ch= anging page encryption status - * @enc_cache_flush_required Returns true if a cache flush is needed befor= e changing page encryption status - * @enc_kexec_begin Begin the two-step process of converting shared memor= y back + * @enc_status_change_prepare: Notify HV before the encryption status of a= range is changed + * @enc_status_change_finish: Notify HV after the encryption status of a r= ange is changed + * @enc_tlb_flush_required: Returns true if a TLB flush is needed before c= hanging page encryption status + * @enc_cache_flush_required: Returns true if a cache flush is needed befo= re changing page encryption status + * @enc_kexec_begin: Begin the two-step process of converting shared memo= ry back * to private. It stops the new conversions from being started * and waits in-flight conversions to finish, if possible. - * @enc_kexec_finish Finish the two-step process of converting shared mem= ory to + * @enc_kexec_finish: Finish the two-step process of converting shared me= mory to * private. All memory is private after the call when * the function returns. * It is called on only one CPU while the others are shut down @@ -229,7 +229,7 @@ struct x86_legacy_devices { * given platform/subarch. * @X86_LEGACY_I8042_FIRMWARE_ABSENT: firmware reports that the controller * is absent. - * @X86_LEGACY_i8042_EXPECTED_PRESENT: the controller is likely to be + * @X86_LEGACY_I8042_EXPECTED_PRESENT: the controller is likely to be * present, the i8042 driver should probe for controller existence. */ enum x86_legacy_i8042_state { @@ -244,6 +244,8 @@ enum x86_legacy_i8042_state { * @i8042: indicated if we expect the device to have i8042 controller * present. * @rtc: this device has a CMOS real-time clock present + * @warm_reset: %1 if platform allows warm reset, else %0 + * @no_vga: %1 if (FADT.boot_flags & ACPI_FADT_NO_VGA) is set, else %0 * @reserve_bios_regions: boot code will search for the EBDA address and t= he * start of the 640k - 1M BIOS region. If false, the platform must * ensure that its memory map correctly reserves sub-1MB regions as neede= d. @@ -290,9 +292,10 @@ struct x86_hyper_runtime { * @calibrate_tsc: calibrate TSC, if different from CPU * @get_wallclock: get time from HW clock like RTC etc. * @set_wallclock: set time back to HW clock - * @is_untracked_pat_range exclude from PAT logic - * @nmi_init enable NMI on cpus - * @get_nmi_reason get the reason an NMI was received + * @iommu_shutdown: set by an IOMMU driver for shutdown if necessary + * @is_untracked_pat_range: exclude from PAT logic + * @nmi_init: enable NMI on cpus + * @get_nmi_reason: get the reason an NMI was received * @save_sched_clock_state: save state for sched_clock() on suspend * @restore_sched_clock_state: restore state for sched_clock() on resume * @apic_post_init: adjust apic if needed @@ -307,6 +310,7 @@ struct x86_hyper_runtime { * @realmode_reserve: reserve memory for realmode trampoline * @realmode_init: initialize realmode trampoline * @hyper: x86 hypervisor specific runtime callbacks + * @guest: guest incarnations callbacks */ struct x86_platform_ops { unsigned long (*calibrate_cpu)(void);