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