Skip to content

Commit 33b4c26

Browse files
rddunlapingomolnar
authored andcommitted
x86/platform: Fix and extend kernel-doc comments in <asm/x86_init.h>
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 <rdunlap@infradead.org> Signed-off-by: Ingo Molnar <mingo@kernel.org> Link: https://patch.msgid.link/20251129002524.1196500-1-rdunlap@infradead.org
1 parent 7d0a66e commit 33b4c26

1 file changed

Lines changed: 16 additions & 12 deletions

File tree

arch/x86/include/asm/x86_init.h

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ struct x86_init_paging {
7979

8080
/**
8181
* struct x86_init_timers - platform specific timer setup
82-
* @setup_perpcu_clockev: set up the per cpu clock event device for the
82+
* @setup_percpu_clockev: set up the per cpu clock event device for the
8383
* boot cpu
8484
* @timer_init: initialize the platform timer (default PIT/HPET)
8585
* @wallclock_init: init the wallclock device
@@ -132,7 +132,7 @@ struct x86_hyper_init {
132132

133133
/**
134134
* struct x86_init_acpi - x86 ACPI init functions
135-
* @set_root_poitner: set RSDP address
135+
* @set_root_pointer: set RSDP address
136136
* @get_root_pointer: get RSDP address
137137
* @reduced_hw_early_init: hardware reduced platform early init
138138
*/
@@ -145,14 +145,14 @@ struct x86_init_acpi {
145145
/**
146146
* struct x86_guest - Functions used by misc guest incarnations like SEV, TDX, etc.
147147
*
148-
* @enc_status_change_prepare Notify HV before the encryption status of a range is changed
149-
* @enc_status_change_finish Notify HV after the encryption status of a range is changed
150-
* @enc_tlb_flush_required Returns true if a TLB flush is needed before changing page encryption status
151-
* @enc_cache_flush_required Returns true if a cache flush is needed before changing page encryption status
152-
* @enc_kexec_begin Begin the two-step process of converting shared memory back
148+
* @enc_status_change_prepare: Notify HV before the encryption status of a range is changed
149+
* @enc_status_change_finish: Notify HV after the encryption status of a range is changed
150+
* @enc_tlb_flush_required: Returns true if a TLB flush is needed before changing page encryption status
151+
* @enc_cache_flush_required: Returns true if a cache flush is needed before changing page encryption status
152+
* @enc_kexec_begin: Begin the two-step process of converting shared memory back
153153
* to private. It stops the new conversions from being started
154154
* and waits in-flight conversions to finish, if possible.
155-
* @enc_kexec_finish Finish the two-step process of converting shared memory to
155+
* @enc_kexec_finish: Finish the two-step process of converting shared memory to
156156
* private. All memory is private after the call when
157157
* the function returns.
158158
* It is called on only one CPU while the others are shut down
@@ -229,7 +229,7 @@ struct x86_legacy_devices {
229229
* given platform/subarch.
230230
* @X86_LEGACY_I8042_FIRMWARE_ABSENT: firmware reports that the controller
231231
* is absent.
232-
* @X86_LEGACY_i8042_EXPECTED_PRESENT: the controller is likely to be
232+
* @X86_LEGACY_I8042_EXPECTED_PRESENT: the controller is likely to be
233233
* present, the i8042 driver should probe for controller existence.
234234
*/
235235
enum x86_legacy_i8042_state {
@@ -244,6 +244,8 @@ enum x86_legacy_i8042_state {
244244
* @i8042: indicated if we expect the device to have i8042 controller
245245
* present.
246246
* @rtc: this device has a CMOS real-time clock present
247+
* @warm_reset: 1 if platform allows warm reset, else 0
248+
* @no_vga: 1 if (FADT.boot_flags & ACPI_FADT_NO_VGA) is set, else 0
247249
* @reserve_bios_regions: boot code will search for the EBDA address and the
248250
* start of the 640k - 1M BIOS region. If false, the platform must
249251
* ensure that its memory map correctly reserves sub-1MB regions as needed.
@@ -290,9 +292,10 @@ struct x86_hyper_runtime {
290292
* @calibrate_tsc: calibrate TSC, if different from CPU
291293
* @get_wallclock: get time from HW clock like RTC etc.
292294
* @set_wallclock: set time back to HW clock
293-
* @is_untracked_pat_range exclude from PAT logic
294-
* @nmi_init enable NMI on cpus
295-
* @get_nmi_reason get the reason an NMI was received
295+
* @iommu_shutdown: set by an IOMMU driver for shutdown if necessary
296+
* @is_untracked_pat_range: exclude from PAT logic
297+
* @nmi_init: enable NMI on cpus
298+
* @get_nmi_reason: get the reason an NMI was received
296299
* @save_sched_clock_state: save state for sched_clock() on suspend
297300
* @restore_sched_clock_state: restore state for sched_clock() on resume
298301
* @apic_post_init: adjust apic if needed
@@ -307,6 +310,7 @@ struct x86_hyper_runtime {
307310
* @realmode_reserve: reserve memory for realmode trampoline
308311
* @realmode_init: initialize realmode trampoline
309312
* @hyper: x86 hypervisor specific runtime callbacks
313+
* @guest: guest incarnations callbacks
310314
*/
311315
struct x86_platform_ops {
312316
unsigned long (*calibrate_cpu)(void);

0 commit comments

Comments
 (0)