superrob1500
/
mirror-linux
mirror of https://github.com/torvalds/linux
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Miscellaneous documentation fixes. 

Signed-off-by: Ingo Molnar <mingo@kernel.org>
 -----BEGIN PGP SIGNATURE-----
 
 iQJFBAABCgAvFiEEBpT5eoXrXCwVQwEKEnMQ0APhK1gFAmk0F6ERHG1pbmdvQGtl
 cm5lbC5vcmcACgkQEnMQ0APhK1hj3w/+N9TghrusYXp4Uoo7krob+SzUIf7cOBEa
 S/akrU1cNgHalPhZFBX5k8oXDcs8HFk5iyXvkr1uVepsdEfxT4BFtvARRRhY/58S
 Z5pFwfMSBDrUx5Xr6Z+jZrRkiSthQ+Dk//4HDhC1/3+344KAL5OvN3wMVrdBAQvx
 +rNS2+NpYpgvFUq7IgtUeRw7pMo4o7rnC+5R6pW6bneCsDYILNmyux9qS9VtnsIC
 +9qNtHlwm+LHEePsDsaQ567D/HFPS+yye/QI0HY2AIyCdO5COIPC73Z4BY3auHr4
 V6709nkQo70HQeY0LVi1oR72WMIW+2WETaL5Vx/Yp8HEAbiY9VKdKg89I8/KHqCI
 4OpjpDD1p/+33Ua8Otf3DAiF9DCfUeVWxAhB+wl17nAiFyUrYtRghNOKh8n+SovM
 EK+EUWX+xMyRVvYAPao7b505nxLqsJn5P6W4EFpN9RWXOKUNDYpo4DSUI32br1HB
 EN2bFQb0AkeRE/AD0K+DTRoorWYe+ZIdwcKXod0GhYoBiSbH36nlhFQ/8zn4p1y/
 hp4DZVcyImk3h/LIqf54PdfZS7s6hoU3VuzOzPVrUHdR+kX6XUs8dEqD+vf+xfCH
 yAwA1+bxpYOo3KNikqGkHBLFTO2K/Hb5gJ5ARUosa1LBu1SvSGbFuhcDzJRntvzK
 G22YpUHWbek=
 =tB8Y
 -----END PGP SIGNATURE-----

Merge tag 'x86-urgent-2025-12-06' of git://git.kernel.org/pub/scm/linux/kernel/git/tip/tip

Pull x86 fixes from Ingo Molnar:
 "Miscellaneous documentation fixes"

* tag 'x86-urgent-2025-12-06' of git://git.kernel.org/pub/scm/linux/kernel/git/tip/tip:
  x86/boot/Documentation: Prefix hexadecimal literals with 0x
  x86/boot/Documentation: Spell 'ID' consistently
  x86/platform: Fix and extend kernel-doc comments in <asm/x86_init.h>
pull/1354/merge
Linus Torvalds 2025-12-06 12:33:26 -08:00
parent 09bcd5ef66 1c3377bee2
commit cc3ee4ba57
2 changed files with 40 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
Documentation/arch/x86/boot.rst
View File

@ -416,7 +416,7 @@ Offset/size: 0x210/1
Protocol: 2.00+ Protocol: 2.00+
============ ================== ============ ==================
If your boot loader has an assigned id (see table below), enter If your boot loader has an assigned ID (see table below), enter
0xTV here, where T is an identifier for the boot loader and V is 0xTV here, where T is an identifier for the boot loader and V is
a version number. Otherwise, enter 0xFF here. a version number. Otherwise, enter 0xFF here.
@ -431,31 +431,31 @@ Protocol: 2.00+
ext_loader_type <- 0x05 ext_loader_type <- 0x05
ext_loader_ver <- 0x23 ext_loader_ver <- 0x23
Assigned boot loader ids (hexadecimal): Assigned boot loader IDs:
== ======================================= == =======================================
0 LILO 0x0 LILO
(0x00 reserved for pre-2.00 bootloader) (0x00 reserved for pre-2.00 bootloader)
1 Loadlin 0x1 Loadlin
2 bootsect-loader 0x2 bootsect-loader
(0x20, all other values reserved) (0x20, all other values reserved)
3 Syslinux 0x3 Syslinux
4 Etherboot/gPXE/iPXE 0x4 Etherboot/gPXE/iPXE
5 ELILO 0x5 ELILO
7 GRUB 0x7 GRUB
8 U-Boot 0x8 U-Boot
9 Xen 0x9 Xen
A Gujin 0xA Gujin
B Qemu 0xB Qemu
C Arcturus Networks uCbootloader 0xC Arcturus Networks uCbootloader
D kexec-tools 0xD kexec-tools
E Extended (see ext_loader_type) 0xE Extended (see ext_loader_type)
F Special (0xFF = undefined) 0xF Special (0xFF = undefined)
10 Reserved 0x10 Reserved
11 Minimal Linux Bootloader 0x11 Minimal Linux Bootloader
<http://sebastian-plotz.blogspot.de> <http://sebastian-plotz.blogspot.de>
12 OVMF UEFI virtualization stack 0x12 OVMF UEFI virtualization stack
13 barebox 0x13 barebox
== ======================================= == =======================================
Please contact <hpa@zytor.com> if you need a bootloader ID value assigned. Please contact <hpa@zytor.com> if you need a bootloader ID value assigned.

28
arch/x86/include/asm/x86_init.h
View File

@ -79,7 +79,7 @@ struct x86_init_paging {
/** /**
* struct x86_init_timers - platform specific timer setup * 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 * boot cpu
* @timer_init: initialize the platform timer (default PIT/HPET) * @timer_init: initialize the platform timer (default PIT/HPET)
* @wallclock_init: init the wallclock device * @wallclock_init: init the wallclock device
@ -132,7 +132,7 @@ struct x86_hyper_init {
/** /**
* struct x86_init_acpi - x86 ACPI init functions * 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 * @get_root_pointer: get RSDP address
* @reduced_hw_early_init: hardware reduced platform early init * @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. * 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_prepare: Notify HV before the encryption status of a range is changed
* @enc_status_change_finish Notify HV after the encryption status of a range is changed * @enc_status_change_finish: Notify HV after the encryption status of a range is changed
* @enc_tlb_flush_required Returns true if a TLB flush is needed before changing page encryption status * @enc_tlb_flush_required: Returns true if a TLB flush is needed before changing page encryption status
* @enc_cache_flush_required Returns true if a cache flush is needed before changing page encryption status * @enc_cache_flush_required: Returns true if a cache flush is needed before changing page encryption status
* @enc_kexec_begin Begin the two-step process of converting shared memory back * @enc_kexec_begin: Begin the two-step process of converting shared memory back
* to private. It stops the new conversions from being started * to private. It stops the new conversions from being started
* and waits in-flight conversions to finish, if possible. * and waits in-flight conversions to finish, if possible.
* @enc_kexec_finish Finish the two-step process of converting shared memory to * @enc_kexec_finish: Finish the two-step process of converting shared memory to
* private. All memory is private after the call when * private. All memory is private after the call when
* the function returns. * the function returns.
* It is called on only one CPU while the others are shut down * It is called on only one CPU while the others are shut down
@ -229,7 +229,7 @@ struct x86_legacy_devices {
* given platform/subarch. * given platform/subarch.
* @X86_LEGACY_I8042_FIRMWARE_ABSENT: firmware reports that the controller * @X86_LEGACY_I8042_FIRMWARE_ABSENT: firmware reports that the controller
* is absent. * 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. * present, the i8042 driver should probe for controller existence.
*/ */
enum x86_legacy_i8042_state { 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 * @i8042: indicated if we expect the device to have i8042 controller
* present. * present.
* @rtc: this device has a CMOS real-time clock 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 the * @reserve_bios_regions: boot code will search for the EBDA address and the
* start of the 640k - 1M BIOS region. If false, the platform must * start of the 640k - 1M BIOS region. If false, the platform must
* ensure that its memory map correctly reserves sub-1MB regions as needed. * ensure that its memory map correctly reserves sub-1MB regions as needed.
@ -290,9 +292,10 @@ struct x86_hyper_runtime {
* @calibrate_tsc: calibrate TSC, if different from CPU * @calibrate_tsc: calibrate TSC, if different from CPU
* @get_wallclock: get time from HW clock like RTC etc. * @get_wallclock: get time from HW clock like RTC etc.
* @set_wallclock: set time back to HW clock * @set_wallclock: set time back to HW clock
* @is_untracked_pat_range exclude from PAT logic * @iommu_shutdown: set by an IOMMU driver for shutdown if necessary
* @nmi_init enable NMI on cpus * @is_untracked_pat_range: exclude from PAT logic
* @get_nmi_reason get the reason an NMI was received * @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 * @save_sched_clock_state: save state for sched_clock() on suspend
* @restore_sched_clock_state: restore state for sched_clock() on resume * @restore_sched_clock_state: restore state for sched_clock() on resume
* @apic_post_init: adjust apic if needed * @apic_post_init: adjust apic if needed
@ -307,6 +310,7 @@ struct x86_hyper_runtime {
* @realmode_reserve: reserve memory for realmode trampoline * @realmode_reserve: reserve memory for realmode trampoline
* @realmode_init: initialize realmode trampoline * @realmode_init: initialize realmode trampoline
* @hyper: x86 hypervisor specific runtime callbacks * @hyper: x86 hypervisor specific runtime callbacks
* @guest: guest incarnations callbacks
*/ */
struct x86_platform_ops { struct x86_platform_ops {
unsigned long (*calibrate_cpu)(void); unsigned long (*calibrate_cpu)(void);