1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _ASM_X86_PLATFORM_H
3 #define _ASM_X86_PLATFORM_H
5 #include <asm/bootparam.h>
16 * struct x86_init_mpparse - platform specific mpparse ops
17 * @setup_ioapic_ids: platform specific ioapic id override
18 * @find_smp_config: find the smp configuration
19 * @get_smp_config: get the smp configuration
21 struct x86_init_mpparse {
22 void (*setup_ioapic_ids)(void);
23 void (*find_smp_config)(void);
24 void (*get_smp_config)(unsigned int early);
28 * struct x86_init_resources - platform specific resource related ops
29 * @probe_roms: probe BIOS roms
30 * @reserve_resources: reserve the standard resources for the
32 * @memory_setup: platform specific memory setup
33 * @dmi_setup: platform specific DMI setup
35 struct x86_init_resources {
36 void (*probe_roms)(void);
37 void (*reserve_resources)(void);
38 char *(*memory_setup)(void);
39 void (*dmi_setup)(void);
43 * struct x86_init_irqs - platform specific interrupt setup
44 * @pre_vector_init: init code to run before interrupt vectors
46 * @intr_init: interrupt init code
47 * @intr_mode_select: interrupt delivery mode selection
48 * @intr_mode_init: interrupt delivery mode setup
49 * @create_pci_msi_domain: Create the PCI/MSI interrupt domain
51 struct x86_init_irqs {
52 void (*pre_vector_init)(void);
53 void (*intr_init)(void);
54 void (*intr_mode_select)(void);
55 void (*intr_mode_init)(void);
56 struct irq_domain *(*create_pci_msi_domain)(void);
60 * struct x86_init_oem - oem platform specific customizing functions
61 * @arch_setup: platform specific architecture setup
62 * @banner: print a platform specific banner
65 void (*arch_setup)(void);
70 * struct x86_init_paging - platform specific paging functions
71 * @pagetable_init: platform specific paging initialization call to setup
72 * the kernel pagetables and prepare accessors functions.
73 * Callback must call paging_init(). Called once after the
74 * direct mapping for phys memory is available.
76 struct x86_init_paging {
77 void (*pagetable_init)(void);
81 * struct x86_init_timers - platform specific timer setup
82 * @setup_perpcu_clockev: set up the per cpu clock event device for the
84 * @timer_init: initialize the platform timer (default PIT/HPET)
85 * @wallclock_init: init the wallclock device
87 struct x86_init_timers {
88 void (*setup_percpu_clockev)(void);
89 void (*timer_init)(void);
90 void (*wallclock_init)(void);
94 * struct x86_init_iommu - platform specific iommu setup
95 * @iommu_init: platform specific iommu setup
97 struct x86_init_iommu {
98 int (*iommu_init)(void);
102 * struct x86_init_pci - platform specific pci init functions
103 * @arch_init: platform specific pci arch init call
104 * @init: platform specific pci subsystem init
105 * @init_irq: platform specific pci irq init
106 * @fixup_irqs: platform specific pci irq fixup
108 struct x86_init_pci {
109 int (*arch_init)(void);
111 void (*init_irq)(void);
112 void (*fixup_irqs)(void);
116 * struct x86_hyper_init - x86 hypervisor init functions
117 * @init_platform: platform setup
118 * @guest_late_init: guest late init
119 * @x2apic_available: X2APIC detection
120 * @msi_ext_dest_id: MSI supports 15-bit APIC IDs
121 * @init_mem_mapping: setup early mappings during init_mem_mapping()
122 * @init_after_bootmem: guest init after boot allocator is finished
124 struct x86_hyper_init {
125 void (*init_platform)(void);
126 void (*guest_late_init)(void);
127 bool (*x2apic_available)(void);
128 bool (*msi_ext_dest_id)(void);
129 void (*init_mem_mapping)(void);
130 void (*init_after_bootmem)(void);
134 * struct x86_init_acpi - x86 ACPI init functions
135 * @set_root_poitner: set RSDP address
136 * @get_root_pointer: get RSDP address
137 * @reduced_hw_early_init: hardware reduced platform early init
139 struct x86_init_acpi {
140 void (*set_root_pointer)(u64 addr);
141 u64 (*get_root_pointer)(void);
142 void (*reduced_hw_early_init)(void);
146 * struct x86_guest - Functions used by misc guest incarnations like SEV, TDX, etc.
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
154 bool (*enc_status_change_prepare)(unsigned long vaddr, int npages, bool enc);
155 bool (*enc_status_change_finish)(unsigned long vaddr, int npages, bool enc);
156 bool (*enc_tlb_flush_required)(bool enc);
157 bool (*enc_cache_flush_required)(void);
161 * struct x86_init_ops - functions for platform specific setup
164 struct x86_init_ops {
165 struct x86_init_resources resources;
166 struct x86_init_mpparse mpparse;
167 struct x86_init_irqs irqs;
168 struct x86_init_oem oem;
169 struct x86_init_paging paging;
170 struct x86_init_timers timers;
171 struct x86_init_iommu iommu;
172 struct x86_init_pci pci;
173 struct x86_hyper_init hyper;
174 struct x86_init_acpi acpi;
178 * struct x86_cpuinit_ops - platform specific cpu hotplug setups
179 * @setup_percpu_clockev: set up the per cpu clock event device
180 * @early_percpu_clock_init: early init of the per cpu clock event device
182 struct x86_cpuinit_ops {
183 void (*setup_percpu_clockev)(void);
184 void (*early_percpu_clock_init)(void);
185 void (*fixup_cpu_id)(struct cpuinfo_x86 *c, int node);
191 * struct x86_legacy_devices - legacy x86 devices
193 * @pnpbios: this platform can have a PNPBIOS. If this is disabled the platform
194 * is known to never have a PNPBIOS.
196 * These are devices known to require LPC or ISA bus. The definition of legacy
197 * devices adheres to the ACPI 5.2.9.3 IA-PC Boot Architecture flag
198 * ACPI_FADT_LEGACY_DEVICES. These devices consist of user visible devices on
199 * the LPC or ISA bus. User visible devices are devices that have end-user
200 * accessible connectors (for example, LPT parallel port). Legacy devices on
201 * the LPC bus consist for example of serial and parallel ports, PS/2 keyboard
202 * / mouse, and the floppy disk controller. A system that lacks all known
203 * legacy devices can assume all devices can be detected exclusively via
204 * standard device enumeration mechanisms including the ACPI namespace.
206 * A system which has does not have ACPI_FADT_LEGACY_DEVICES enabled must not
207 * have any of the legacy devices enumerated below present.
209 struct x86_legacy_devices {
214 * enum x86_legacy_i8042_state - i8042 keyboard controller state
215 * @X86_LEGACY_I8042_PLATFORM_ABSENT: the controller is always absent on
216 * given platform/subarch.
217 * @X86_LEGACY_I8042_FIRMWARE_ABSENT: firmware reports that the controller
219 * @X86_LEGACY_i8042_EXPECTED_PRESENT: the controller is likely to be
220 * present, the i8042 driver should probe for controller existence.
222 enum x86_legacy_i8042_state {
223 X86_LEGACY_I8042_PLATFORM_ABSENT,
224 X86_LEGACY_I8042_FIRMWARE_ABSENT,
225 X86_LEGACY_I8042_EXPECTED_PRESENT,
229 * struct x86_legacy_features - legacy x86 features
231 * @i8042: indicated if we expect the device to have i8042 controller
233 * @rtc: this device has a CMOS real-time clock present
234 * @reserve_bios_regions: boot code will search for the EBDA address and the
235 * start of the 640k - 1M BIOS region. If false, the platform must
236 * ensure that its memory map correctly reserves sub-1MB regions as needed.
237 * @devices: legacy x86 devices, refer to struct x86_legacy_devices
238 * documentation for further details.
240 struct x86_legacy_features {
241 enum x86_legacy_i8042_state i8042;
245 int reserve_bios_regions;
246 struct x86_legacy_devices devices;
250 * struct x86_hyper_runtime - x86 hypervisor specific runtime callbacks
252 * @pin_vcpu: pin current vcpu to specified physical
254 * @sev_es_hcall_prepare: Load additional hypervisor-specific
255 * state into the GHCB when doing a VMMCALL under
256 * SEV-ES. Called from the #VC exception handler.
257 * @sev_es_hcall_finish: Copies state from the GHCB back into the
258 * processor (or pt_regs). Also runs checks on the
259 * state returned from the hypervisor after a
260 * VMMCALL under SEV-ES. Needs to return 'false'
261 * if the checks fail. Called from the #VC
264 struct x86_hyper_runtime {
265 void (*pin_vcpu)(int cpu);
266 void (*sev_es_hcall_prepare)(struct ghcb *ghcb, struct pt_regs *regs);
267 bool (*sev_es_hcall_finish)(struct ghcb *ghcb, struct pt_regs *regs);
271 * struct x86_platform_ops - platform specific runtime functions
272 * @calibrate_cpu: calibrate CPU
273 * @calibrate_tsc: calibrate TSC, if different from CPU
274 * @get_wallclock: get time from HW clock like RTC etc.
275 * @set_wallclock: set time back to HW clock
276 * @is_untracked_pat_range exclude from PAT logic
277 * @nmi_init enable NMI on cpus
278 * @save_sched_clock_state: save state for sched_clock() on suspend
279 * @restore_sched_clock_state: restore state for sched_clock() on resume
280 * @apic_post_init: adjust apic if needed
281 * @legacy: legacy features
282 * @set_legacy_features: override legacy features. Use of this callback
283 * is highly discouraged. You should only need
284 * this if your hardware platform requires further
285 * custom fine tuning far beyond what may be
286 * possible in x86_early_init_platform_quirks() by
287 * only using the current x86_hardware_subarch
289 * @realmode_reserve: reserve memory for realmode trampoline
290 * @realmode_init: initialize realmode trampoline
291 * @hyper: x86 hypervisor specific runtime callbacks
293 struct x86_platform_ops {
294 unsigned long (*calibrate_cpu)(void);
295 unsigned long (*calibrate_tsc)(void);
296 void (*get_wallclock)(struct timespec64 *ts);
297 int (*set_wallclock)(const struct timespec64 *ts);
298 void (*iommu_shutdown)(void);
299 bool (*is_untracked_pat_range)(u64 start, u64 end);
300 void (*nmi_init)(void);
301 unsigned char (*get_nmi_reason)(void);
302 void (*save_sched_clock_state)(void);
303 void (*restore_sched_clock_state)(void);
304 void (*apic_post_init)(void);
305 struct x86_legacy_features legacy;
306 void (*set_legacy_features)(void);
307 void (*realmode_reserve)(void);
308 void (*realmode_init)(void);
309 struct x86_hyper_runtime hyper;
310 struct x86_guest guest;
313 struct x86_apic_ops {
314 unsigned int (*io_apic_read) (unsigned int apic, unsigned int reg);
315 void (*restore)(void);
318 extern struct x86_init_ops x86_init;
319 extern struct x86_cpuinit_ops x86_cpuinit;
320 extern struct x86_platform_ops x86_platform;
321 extern struct x86_msi_ops x86_msi;
322 extern struct x86_apic_ops x86_apic_ops;
324 extern void x86_early_init_platform_quirks(void);
325 extern void x86_init_noop(void);
326 extern void x86_init_uint_noop(unsigned int unused);
327 extern bool bool_x86_init_noop(void);
328 extern void x86_op_int_noop(int cpu);
329 extern bool x86_pnpbios_disabled(void);