1 /* SPDX-License-Identifier: GPL-2.0 */ 2 #ifndef _ASM_X86_PLATFORM_H 3 #define _ASM_X86_PLATFORM_H 4 5 #include <asm/bootparam.h> 6 7 struct ghcb; 8 struct mpc_bus; 9 struct mpc_cpu; 10 struct pt_regs; 11 struct mpc_table; 12 struct cpuinfo_x86; 13 struct irq_domain; 14 15 /** 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 20 */ 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); 25 }; 26 27 /** 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 31 * platform 32 * @memory_setup: platform specific memory setup 33 * 34 */ 35 struct x86_init_resources { 36 void (*probe_roms)(void); 37 void (*reserve_resources)(void); 38 char *(*memory_setup)(void); 39 }; 40 41 /** 42 * struct x86_init_irqs - platform specific interrupt setup 43 * @pre_vector_init: init code to run before interrupt vectors 44 * are set up. 45 * @intr_init: interrupt init code 46 * @intr_mode_select: interrupt delivery mode selection 47 * @intr_mode_init: interrupt delivery mode setup 48 * @create_pci_msi_domain: Create the PCI/MSI interrupt domain 49 */ 50 struct x86_init_irqs { 51 void (*pre_vector_init)(void); 52 void (*intr_init)(void); 53 void (*intr_mode_select)(void); 54 void (*intr_mode_init)(void); 55 struct irq_domain *(*create_pci_msi_domain)(void); 56 }; 57 58 /** 59 * struct x86_init_oem - oem platform specific customizing functions 60 * @arch_setup: platform specific architecture setup 61 * @banner: print a platform specific banner 62 */ 63 struct x86_init_oem { 64 void (*arch_setup)(void); 65 void (*banner)(void); 66 }; 67 68 /** 69 * struct x86_init_paging - platform specific paging functions 70 * @pagetable_init: platform specific paging initialization call to setup 71 * the kernel pagetables and prepare accessors functions. 72 * Callback must call paging_init(). Called once after the 73 * direct mapping for phys memory is available. 74 */ 75 struct x86_init_paging { 76 void (*pagetable_init)(void); 77 }; 78 79 /** 80 * struct x86_init_timers - platform specific timer setup 81 * @setup_perpcu_clockev: set up the per cpu clock event device for the 82 * boot cpu 83 * @timer_init: initialize the platform timer (default PIT/HPET) 84 * @wallclock_init: init the wallclock device 85 */ 86 struct x86_init_timers { 87 void (*setup_percpu_clockev)(void); 88 void (*timer_init)(void); 89 void (*wallclock_init)(void); 90 }; 91 92 /** 93 * struct x86_init_iommu - platform specific iommu setup 94 * @iommu_init: platform specific iommu setup 95 */ 96 struct x86_init_iommu { 97 int (*iommu_init)(void); 98 }; 99 100 /** 101 * struct x86_init_pci - platform specific pci init functions 102 * @arch_init: platform specific pci arch init call 103 * @init: platform specific pci subsystem init 104 * @init_irq: platform specific pci irq init 105 * @fixup_irqs: platform specific pci irq fixup 106 */ 107 struct x86_init_pci { 108 int (*arch_init)(void); 109 int (*init)(void); 110 void (*init_irq)(void); 111 void (*fixup_irqs)(void); 112 }; 113 114 /** 115 * struct x86_hyper_init - x86 hypervisor init functions 116 * @init_platform: platform setup 117 * @guest_late_init: guest late init 118 * @x2apic_available: X2APIC detection 119 * @msi_ext_dest_id: MSI supports 15-bit APIC IDs 120 * @init_mem_mapping: setup early mappings during init_mem_mapping() 121 * @init_after_bootmem: guest init after boot allocator is finished 122 */ 123 struct x86_hyper_init { 124 void (*init_platform)(void); 125 void (*guest_late_init)(void); 126 bool (*x2apic_available)(void); 127 bool (*msi_ext_dest_id)(void); 128 void (*init_mem_mapping)(void); 129 void (*init_after_bootmem)(void); 130 }; 131 132 /** 133 * struct x86_init_acpi - x86 ACPI init functions 134 * @set_root_poitner: set RSDP address 135 * @get_root_pointer: get RSDP address 136 * @reduced_hw_early_init: hardware reduced platform early init 137 */ 138 struct x86_init_acpi { 139 void (*set_root_pointer)(u64 addr); 140 u64 (*get_root_pointer)(void); 141 void (*reduced_hw_early_init)(void); 142 }; 143 144 /** 145 * struct x86_guest - Functions used by misc guest incarnations like SEV, TDX, etc. 146 * 147 * @enc_status_change_prepare Notify HV before the encryption status of a range is changed 148 * @enc_status_change_finish Notify HV after the encryption status of a range is changed 149 * @enc_tlb_flush_required Returns true if a TLB flush is needed before changing page encryption status 150 * @enc_cache_flush_required Returns true if a cache flush is needed before changing page encryption status 151 */ 152 struct x86_guest { 153 void (*enc_status_change_prepare)(unsigned long vaddr, int npages, bool enc); 154 bool (*enc_status_change_finish)(unsigned long vaddr, int npages, bool enc); 155 bool (*enc_tlb_flush_required)(bool enc); 156 bool (*enc_cache_flush_required)(void); 157 }; 158 159 /** 160 * struct x86_init_ops - functions for platform specific setup 161 * 162 */ 163 struct x86_init_ops { 164 struct x86_init_resources resources; 165 struct x86_init_mpparse mpparse; 166 struct x86_init_irqs irqs; 167 struct x86_init_oem oem; 168 struct x86_init_paging paging; 169 struct x86_init_timers timers; 170 struct x86_init_iommu iommu; 171 struct x86_init_pci pci; 172 struct x86_hyper_init hyper; 173 struct x86_init_acpi acpi; 174 }; 175 176 /** 177 * struct x86_cpuinit_ops - platform specific cpu hotplug setups 178 * @setup_percpu_clockev: set up the per cpu clock event device 179 * @early_percpu_clock_init: early init of the per cpu clock event device 180 */ 181 struct x86_cpuinit_ops { 182 void (*setup_percpu_clockev)(void); 183 void (*early_percpu_clock_init)(void); 184 void (*fixup_cpu_id)(struct cpuinfo_x86 *c, int node); 185 }; 186 187 struct timespec64; 188 189 /** 190 * struct x86_legacy_devices - legacy x86 devices 191 * 192 * @pnpbios: this platform can have a PNPBIOS. If this is disabled the platform 193 * is known to never have a PNPBIOS. 194 * 195 * These are devices known to require LPC or ISA bus. The definition of legacy 196 * devices adheres to the ACPI 5.2.9.3 IA-PC Boot Architecture flag 197 * ACPI_FADT_LEGACY_DEVICES. These devices consist of user visible devices on 198 * the LPC or ISA bus. User visible devices are devices that have end-user 199 * accessible connectors (for example, LPT parallel port). Legacy devices on 200 * the LPC bus consist for example of serial and parallel ports, PS/2 keyboard 201 * / mouse, and the floppy disk controller. A system that lacks all known 202 * legacy devices can assume all devices can be detected exclusively via 203 * standard device enumeration mechanisms including the ACPI namespace. 204 * 205 * A system which has does not have ACPI_FADT_LEGACY_DEVICES enabled must not 206 * have any of the legacy devices enumerated below present. 207 */ 208 struct x86_legacy_devices { 209 int pnpbios; 210 }; 211 212 /** 213 * enum x86_legacy_i8042_state - i8042 keyboard controller state 214 * @X86_LEGACY_I8042_PLATFORM_ABSENT: the controller is always absent on 215 * given platform/subarch. 216 * @X86_LEGACY_I8042_FIRMWARE_ABSENT: firmware reports that the controller 217 * is absent. 218 * @X86_LEGACY_i8042_EXPECTED_PRESENT: the controller is likely to be 219 * present, the i8042 driver should probe for controller existence. 220 */ 221 enum x86_legacy_i8042_state { 222 X86_LEGACY_I8042_PLATFORM_ABSENT, 223 X86_LEGACY_I8042_FIRMWARE_ABSENT, 224 X86_LEGACY_I8042_EXPECTED_PRESENT, 225 }; 226 227 /** 228 * struct x86_legacy_features - legacy x86 features 229 * 230 * @i8042: indicated if we expect the device to have i8042 controller 231 * present. 232 * @rtc: this device has a CMOS real-time clock present 233 * @reserve_bios_regions: boot code will search for the EBDA address and the 234 * start of the 640k - 1M BIOS region. If false, the platform must 235 * ensure that its memory map correctly reserves sub-1MB regions as needed. 236 * @devices: legacy x86 devices, refer to struct x86_legacy_devices 237 * documentation for further details. 238 */ 239 struct x86_legacy_features { 240 enum x86_legacy_i8042_state i8042; 241 int rtc; 242 int warm_reset; 243 int no_vga; 244 int reserve_bios_regions; 245 struct x86_legacy_devices devices; 246 }; 247 248 /** 249 * struct x86_hyper_runtime - x86 hypervisor specific runtime callbacks 250 * 251 * @pin_vcpu: pin current vcpu to specified physical 252 * cpu (run rarely) 253 * @sev_es_hcall_prepare: Load additional hypervisor-specific 254 * state into the GHCB when doing a VMMCALL under 255 * SEV-ES. Called from the #VC exception handler. 256 * @sev_es_hcall_finish: Copies state from the GHCB back into the 257 * processor (or pt_regs). Also runs checks on the 258 * state returned from the hypervisor after a 259 * VMMCALL under SEV-ES. Needs to return 'false' 260 * if the checks fail. Called from the #VC 261 * exception handler. 262 */ 263 struct x86_hyper_runtime { 264 void (*pin_vcpu)(int cpu); 265 void (*sev_es_hcall_prepare)(struct ghcb *ghcb, struct pt_regs *regs); 266 bool (*sev_es_hcall_finish)(struct ghcb *ghcb, struct pt_regs *regs); 267 }; 268 269 /** 270 * struct x86_platform_ops - platform specific runtime functions 271 * @calibrate_cpu: calibrate CPU 272 * @calibrate_tsc: calibrate TSC, if different from CPU 273 * @get_wallclock: get time from HW clock like RTC etc. 274 * @set_wallclock: set time back to HW clock 275 * @is_untracked_pat_range exclude from PAT logic 276 * @nmi_init enable NMI on cpus 277 * @save_sched_clock_state: save state for sched_clock() on suspend 278 * @restore_sched_clock_state: restore state for sched_clock() on resume 279 * @apic_post_init: adjust apic if needed 280 * @legacy: legacy features 281 * @set_legacy_features: override legacy features. Use of this callback 282 * is highly discouraged. You should only need 283 * this if your hardware platform requires further 284 * custom fine tuning far beyond what may be 285 * possible in x86_early_init_platform_quirks() by 286 * only using the current x86_hardware_subarch 287 * semantics. 288 * @hyper: x86 hypervisor specific runtime callbacks 289 */ 290 struct x86_platform_ops { 291 unsigned long (*calibrate_cpu)(void); 292 unsigned long (*calibrate_tsc)(void); 293 void (*get_wallclock)(struct timespec64 *ts); 294 int (*set_wallclock)(const struct timespec64 *ts); 295 void (*iommu_shutdown)(void); 296 bool (*is_untracked_pat_range)(u64 start, u64 end); 297 void (*nmi_init)(void); 298 unsigned char (*get_nmi_reason)(void); 299 void (*save_sched_clock_state)(void); 300 void (*restore_sched_clock_state)(void); 301 void (*apic_post_init)(void); 302 struct x86_legacy_features legacy; 303 void (*set_legacy_features)(void); 304 struct x86_hyper_runtime hyper; 305 struct x86_guest guest; 306 }; 307 308 struct x86_apic_ops { 309 unsigned int (*io_apic_read) (unsigned int apic, unsigned int reg); 310 void (*restore)(void); 311 }; 312 313 extern struct x86_init_ops x86_init; 314 extern struct x86_cpuinit_ops x86_cpuinit; 315 extern struct x86_platform_ops x86_platform; 316 extern struct x86_msi_ops x86_msi; 317 extern struct x86_apic_ops x86_apic_ops; 318 319 extern void x86_early_init_platform_quirks(void); 320 extern void x86_init_noop(void); 321 extern void x86_init_uint_noop(unsigned int unused); 322 extern bool bool_x86_init_noop(void); 323 extern void x86_op_int_noop(int cpu); 324 extern bool x86_pnpbios_disabled(void); 325 326 #endif 327