arch/x86/include/asm/x86_init.h

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