arch/x86/include/asm/x86_init.h

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