2009-08-19 16:48:38 +04:00
# ifndef _ASM_X86_PLATFORM_H
# define _ASM_X86_PLATFORM_H
2009-08-29 17:03:59 +04:00
# include <asm/bootparam.h>
2009-08-20 16:30:02 +04:00
2009-08-20 14:45:33 +04:00
struct mpc_bus ;
2009-08-20 12:41:58 +04:00
struct mpc_cpu ;
2009-08-20 14:18:32 +04:00
struct mpc_table ;
2011-12-05 12:20:37 +04:00
struct cpuinfo_x86 ;
2009-08-20 12:41:58 +04:00
2009-08-20 14:05:01 +04:00
/**
* struct x86_init_mpparse - platform specific mpparse ops
* @ mpc_record : platform specific mpc record accounting
2009-08-20 11:27:29 +04:00
* @ setup_ioapic_ids : platform specific ioapic id override
2009-08-20 12:41:58 +04:00
* @ mpc_apic_id : platform specific mpc apic id assignment
2009-08-20 14:18:32 +04:00
* @ smp_read_mpc_oem : platform specific oem mpc table setup
2009-08-20 14:45:33 +04:00
* @ mpc_oem_pci_bus : platform specific pci bus setup ( default NULL )
2009-08-20 14:34:47 +04:00
* @ mpc_oem_bus_info : platform specific mpc bus info
2009-08-20 13:11:52 +04:00
* @ find_smp_config : find the smp configuration
* @ get_smp_config : get the smp configuration
2009-08-20 14:05:01 +04:00
*/
struct x86_init_mpparse {
void ( * mpc_record ) ( unsigned int mode ) ;
2009-08-20 11:27:29 +04:00
void ( * setup_ioapic_ids ) ( void ) ;
2009-08-20 12:41:58 +04:00
int ( * mpc_apic_id ) ( struct mpc_cpu * m ) ;
2009-08-20 14:18:32 +04:00
void ( * smp_read_mpc_oem ) ( struct mpc_table * mpc ) ;
2009-08-20 14:45:33 +04:00
void ( * mpc_oem_pci_bus ) ( struct mpc_bus * m ) ;
2009-08-20 14:34:47 +04:00
void ( * mpc_oem_bus_info ) ( struct mpc_bus * m , char * name ) ;
2009-11-24 13:48:18 +03:00
void ( * find_smp_config ) ( void ) ;
2009-08-20 13:11:52 +04:00
void ( * get_smp_config ) ( unsigned int early ) ;
2009-08-20 14:05:01 +04:00
} ;
2009-08-19 16:43:56 +04:00
/**
* struct x86_init_resources - platform specific resource related ops
* @ probe_roms : probe BIOS roms
2009-08-19 16:55:50 +04:00
* @ reserve_resources : reserve the standard resources for the
* platform
2009-08-20 12:19:54 +04:00
* @ memory_setup : platform specific memory setup
2009-08-19 16:43:56 +04:00
*
*/
struct x86_init_resources {
void ( * probe_roms ) ( void ) ;
2009-08-19 16:55:50 +04:00
void ( * reserve_resources ) ( void ) ;
2009-08-20 12:19:54 +04:00
char * ( * memory_setup ) ( void ) ;
2009-08-19 16:43:56 +04:00
} ;
2009-08-20 11:41:38 +04:00
/**
* struct x86_init_irqs - platform specific interrupt setup
* @ pre_vector_init : init code to run before interrupt vectors
* are set up .
2009-08-20 11:59:09 +04:00
* @ intr_init : interrupt init code
2009-08-20 12:35:46 +04:00
* @ trap_init : platform specific trap setup
2009-08-20 11:41:38 +04:00
*/
struct x86_init_irqs {
void ( * pre_vector_init ) ( void ) ;
2009-08-20 11:59:09 +04:00
void ( * intr_init ) ( void ) ;
2009-08-20 12:35:46 +04:00
void ( * trap_init ) ( void ) ;
2009-08-20 11:41:38 +04:00
} ;
2009-08-20 15:04:10 +04:00
/**
* struct x86_init_oem - oem platform specific customizing functions
* @ arch_setup : platform specific architecure setup
2009-08-20 15:19:57 +04:00
* @ banner : print a platform specific banner
2009-08-20 15:04:10 +04:00
*/
struct x86_init_oem {
void ( * arch_setup ) ( void ) ;
2009-08-20 15:19:57 +04:00
void ( * banner ) ( void ) ;
2009-08-20 15:04:10 +04:00
} ;
2009-08-20 16:30:02 +04:00
/**
* struct x86_init_paging - platform specific paging functions
2012-08-22 00:22:41 +04:00
* @ pagetable_init : platform specific paging initialization call to setup
* the kernel pagetables and prepare accessors functions .
* Callback must call paging_init ( ) . Called once after the
* direct mapping for phys memory is available .
2009-08-20 16:30:02 +04:00
*/
struct x86_init_paging {
2012-08-22 00:22:38 +04:00
void ( * pagetable_init ) ( void ) ;
2009-08-20 16:30:02 +04:00
} ;
2009-08-19 14:35:53 +04:00
/**
* struct x86_init_timers - platform specific timer setup
* @ setup_perpcu_clockev : set up the per cpu clock event device for the
* boot cpu
2009-08-19 17:37:03 +04:00
* @ timer_init : initialize the platform timer ( default PIT / HPET )
2011-02-14 19:13:31 +03:00
* @ wallclock_init : init the wallclock device
2009-08-19 14:35:53 +04:00
*/
struct x86_init_timers {
void ( * setup_percpu_clockev ) ( void ) ;
2009-08-19 17:37:03 +04:00
void ( * timer_init ) ( void ) ;
2011-02-14 19:13:31 +03:00
void ( * wallclock_init ) ( void ) ;
2009-08-19 14:35:53 +04:00
} ;
2009-11-10 13:46:12 +03:00
/**
* struct x86_init_iommu - platform specific iommu setup
* @ iommu_init : platform specific iommu setup
*/
struct x86_init_iommu {
int ( * iommu_init ) ( void ) ;
} ;
2010-02-22 16:38:38 +03:00
/**
* struct x86_init_pci - platform specific pci init functions
* @ arch_init : platform specific pci arch init call
* @ init : platform specific pci subsystem init
2009-08-29 19:47:33 +04:00
* @ init_irq : platform specific pci irq init
2009-08-29 19:51:26 +04:00
* @ fixup_irqs : platform specific pci irq fixup
2009-08-29 18:24:51 +04:00
*/
struct x86_init_pci {
2010-02-22 16:38:38 +03:00
int ( * arch_init ) ( void ) ;
2009-08-29 18:24:51 +04:00
int ( * init ) ( void ) ;
2009-08-29 19:47:33 +04:00
void ( * init_irq ) ( void ) ;
2009-08-29 19:51:26 +04:00
void ( * fixup_irqs ) ( void ) ;
2009-08-29 18:24:51 +04:00
} ;
2009-08-19 16:48:38 +04:00
/**
* struct x86_init_ops - functions for platform specific setup
*
*/
struct x86_init_ops {
2009-08-20 14:05:01 +04:00
struct x86_init_resources resources ;
struct x86_init_mpparse mpparse ;
2009-08-20 11:41:38 +04:00
struct x86_init_irqs irqs ;
2009-08-20 15:04:10 +04:00
struct x86_init_oem oem ;
2009-08-20 16:30:02 +04:00
struct x86_init_paging paging ;
2009-08-19 14:35:53 +04:00
struct x86_init_timers timers ;
2009-11-10 13:46:12 +03:00
struct x86_init_iommu iommu ;
2009-08-29 18:24:51 +04:00
struct x86_init_pci pci ;
2009-08-19 14:35:53 +04:00
} ;
/**
* struct x86_cpuinit_ops - platform specific cpu hotplug setups
* @ setup_percpu_clockev : set up the per cpu clock event device
2012-02-07 18:52:44 +04:00
* @ early_percpu_clock_init : early init of the per cpu clock event device
2009-08-19 14:35:53 +04:00
*/
struct x86_cpuinit_ops {
void ( * setup_percpu_clockev ) ( void ) ;
2012-02-07 18:52:44 +04:00
void ( * early_percpu_clock_init ) ( void ) ;
2011-12-05 12:20:37 +04:00
void ( * fixup_cpu_id ) ( struct cpuinfo_x86 * c , int node ) ;
2009-08-19 16:48:38 +04:00
} ;
2013-05-13 21:56:06 +04:00
struct timespec ;
2016-04-14 03:04:41 +03:00
/**
* struct x86_legacy_devices - legacy x86 devices
*
* @ pnpbios : this platform can have a PNPBIOS . If this is disabled the platform
* is known to never have a PNPBIOS .
*
* These are devices known to require LPC or ISA bus . The definition of legacy
* devices adheres to the ACPI 5.2 .9 .3 IA - PC Boot Architecture flag
* ACPI_FADT_LEGACY_DEVICES . These devices consist of user visible devices on
* the LPC or ISA bus . User visible devices are devices that have end - user
* accessible connectors ( for example , LPT parallel port ) . Legacy devices on
* the LPC bus consist for example of serial and parallel ports , PS / 2 keyboard
* / mouse , and the floppy disk controller . A system that lacks all known
* legacy devices can assume all devices can be detected exclusively via
* standard device enumeration mechanisms including the ACPI namespace .
*
* A system which has does not have ACPI_FADT_LEGACY_DEVICES enabled must not
* have any of the legacy devices enumerated below present .
*/
struct x86_legacy_devices {
int pnpbios ;
} ;
2016-04-14 03:04:34 +03:00
/**
* struct x86_legacy_features - legacy x86 features
*
* @ rtc : this device has a CMOS real - time clock present
2016-07-22 00:16:51 +03:00
* @ reserve_bios_regions : boot code will search for the EBDA address and the
* start of the 640 k - 1 M BIOS region . If false , the platform must
* ensure that its memory map correctly reserves sub - 1 MB regions as needed .
2016-04-14 03:04:41 +03:00
* @ devices : legacy x86 devices , refer to struct x86_legacy_devices
* documentation for further details .
2016-04-14 03:04:34 +03:00
*/
struct x86_legacy_features {
int rtc ;
x86/boot: Reorganize and clean up the BIOS area reservation code
So the reserve_ebda_region() code has accumulated a number of
problems over the years that make it really difficult to read
and understand:
- The calculation of 'lowmem' and 'ebda_addr' is an unnecessarily
interleaved mess of first lowmem, then ebda_addr, then lowmem tweaks...
- 'lowmem' here means 'super low mem' - i.e. 16-bit addressable memory. In other
parts of the x86 code 'lowmem' means 32-bit addressable memory... This makes it
super confusing to read.
- It does not help at all that we have various memory range markers, half of which
are 'start of range', half of which are 'end of range' - but this crucial
property is not obvious in the naming at all ... gave me a headache trying to
understand all this.
- Also, the 'ebda_addr' name sucks: it highlights that it's an address (which is
obvious, all values here are addresses!), while it does not highlight that it's
the _start_ of the EBDA region ...
- 'BIOS_LOWMEM_KILOBYTES' says a lot of things, except that this is the only value
that is a pointer to a value, not a memory range address!
- The function name itself is a misnomer: it says 'reserve_ebda_region()' while
its main purpose is to reserve all the firmware ROM typically between 640K and
1MB, while the 'EBDA' part is only a small part of that ...
- Likewise, the paravirt quirk flag name 'ebda_search' is misleading as well: this
too should be about whether to reserve firmware areas in the paravirt case.
- In fact thinking about this as 'end of RAM' is confusing: what this function
*really* wants to reserve is firmware data and code areas! Once the thinking is
inverted from a mixed 'ram' and 'reserved firmware area' notion to a pure
'reserved area' notion everything becomes a lot clearer.
To improve all this rewrite the whole code (without changing the logic):
- Firstly invert the naming from 'lowmem end' to 'BIOS reserved area start'
and propagate this concept through all the variable names and constants.
BIOS_RAM_SIZE_KB_PTR // was: BIOS_LOWMEM_KILOBYTES
BIOS_START_MIN // was: INSANE_CUTOFF
ebda_start // was: ebda_addr
bios_start // was: lowmem
BIOS_START_MAX // was: LOWMEM_CAP
- Then clean up the name of the function itself by renaming it
to reserve_bios_regions() and renaming the ::ebda_search paravirt
flag to ::reserve_bios_regions.
- Fix up all the comments (fix typos), harmonize and simplify their
formulation and remove comments that become unnecessary due to
the much better naming all around.
Signed-off-by: Ingo Molnar <mingo@kernel.org>
2016-07-21 10:53:52 +03:00
int reserve_bios_regions ;
2016-04-14 03:04:41 +03:00
struct x86_legacy_devices devices ;
2016-04-14 03:04:34 +03:00
} ;
2009-08-20 19:06:25 +04:00
/**
* struct x86_platform_ops - platform specific runtime functions
2016-06-17 08:22:51 +03:00
* @ calibrate_cpu : calibrate CPU
* @ calibrate_tsc : calibrate TSC , if different from CPU
2009-09-10 06:48:56 +04:00
* @ get_wallclock : get time from HW clock like RTC etc .
* @ set_wallclock : set time back to HW clock
2009-11-24 01:46:07 +03:00
* @ is_untracked_pat_range exclude from PAT logic
2010-02-26 19:49:12 +03:00
* @ nmi_init enable NMI on cpus
2010-07-05 19:03:18 +04:00
* @ i8042_detect pre - detect if i8042 controller exists
2012-02-13 17:07:27 +04:00
* @ save_sched_clock_state : save state for sched_clock ( ) on suspend
* @ restore_sched_clock_state : restore state for sched_clock ( ) on resume
2012-06-03 02:11:34 +04:00
* @ apic_post_init : adjust apic if neeeded
2016-04-14 03:04:34 +03:00
* @ legacy : legacy features
* @ set_legacy_features : override legacy features . Use of this callback
* is highly discouraged . You should only need
* this if your hardware platform requires further
* custom fine tuning far beyong what may be
* possible in x86_early_init_platform_quirks ( ) by
* only using the current x86_hardware_subarch
* semantics .
2009-08-20 19:06:25 +04:00
*/
struct x86_platform_ops {
2016-06-17 08:22:51 +03:00
unsigned long ( * calibrate_cpu ) ( void ) ;
2009-08-20 19:06:25 +04:00
unsigned long ( * calibrate_tsc ) ( void ) ;
2013-05-13 21:56:06 +04:00
void ( * get_wallclock ) ( struct timespec * ts ) ;
int ( * set_wallclock ) ( const struct timespec * ts ) ;
2009-10-27 10:34:44 +03:00
void ( * iommu_shutdown ) ( void ) ;
2009-11-24 01:46:07 +03:00
bool ( * is_untracked_pat_range ) ( u64 start , u64 end ) ;
2010-02-26 19:49:12 +03:00
void ( * nmi_init ) ( void ) ;
2011-11-10 17:43:05 +04:00
unsigned char ( * get_nmi_reason ) ( void ) ;
2010-07-05 19:03:18 +04:00
int ( * i8042_detect ) ( void ) ;
2012-02-13 17:07:27 +04:00
void ( * save_sched_clock_state ) ( void ) ;
void ( * restore_sched_clock_state ) ( void ) ;
2012-06-03 02:11:34 +04:00
void ( * apic_post_init ) ( void ) ;
2016-04-14 03:04:34 +03:00
struct x86_legacy_features legacy ;
void ( * set_legacy_features ) ( void ) ;
2009-08-20 19:06:25 +04:00
} ;
2010-10-07 00:12:28 +04:00
struct pci_dev ;
struct x86_msi_ops {
int ( * setup_msi_irqs ) ( struct pci_dev * dev , int nvec , int type ) ;
void ( * teardown_msi_irq ) ( unsigned int irq ) ;
void ( * teardown_msi_irqs ) ( struct pci_dev * dev ) ;
2013-12-04 09:09:16 +04:00
void ( * restore_msi_irqs ) ( struct pci_dev * dev ) ;
2010-10-07 00:12:28 +04:00
} ;
2012-03-28 20:37:36 +04:00
struct x86_io_apic_ops {
2012-09-26 14:44:35 +04:00
unsigned int ( * read ) ( unsigned int apic , unsigned int reg ) ;
void ( * disable ) ( void ) ;
2012-03-28 20:37:36 +04:00
} ;
2009-08-19 16:48:38 +04:00
extern struct x86_init_ops x86_init ;
2009-08-19 14:35:53 +04:00
extern struct x86_cpuinit_ops x86_cpuinit ;
2009-08-20 19:06:25 +04:00
extern struct x86_platform_ops x86_platform ;
2010-10-07 00:12:28 +04:00
extern struct x86_msi_ops x86_msi ;
2012-03-28 20:37:36 +04:00
extern struct x86_io_apic_ops x86_io_apic_ops ;
2016-04-14 03:04:34 +03:00
extern void x86_early_init_platform_quirks ( void ) ;
2009-08-19 16:48:38 +04:00
extern void x86_init_noop ( void ) ;
2009-08-20 14:05:01 +04:00
extern void x86_init_uint_noop ( unsigned int unused ) ;
2009-08-19 16:48:38 +04:00
# endif