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
7struct ghcb;
8struct mpc_bus;
9struct mpc_cpu;
10struct pt_regs;
11struct mpc_table;
12struct cpuinfo_x86;
13struct 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 */
21struct 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 */
35struct 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 */
50struct 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 */
63struct 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 */
75struct 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 */
86struct 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 */
96struct 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 */
107struct 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 * @init_mem_mapping:		setup early mappings during init_mem_mapping()
120 * @init_after_bootmem:		guest init after boot allocator is finished
121 */
122struct x86_hyper_init {
123	void (*init_platform)(void);
124	void (*guest_late_init)(void);
125	bool (*x2apic_available)(void);
126	void (*init_mem_mapping)(void);
127	void (*init_after_bootmem)(void);
128};
129
130/**
131 * struct x86_init_acpi - x86 ACPI init functions
132 * @set_root_poitner:		set RSDP address
133 * @get_root_pointer:		get RSDP address
134 * @reduced_hw_early_init:	hardware reduced platform early init
135 */
136struct x86_init_acpi {
137	void (*set_root_pointer)(u64 addr);
138	u64 (*get_root_pointer)(void);
139	void (*reduced_hw_early_init)(void);
140};
141
142/**
143 * struct x86_init_ops - functions for platform specific setup
144 *
145 */
146struct x86_init_ops {
147	struct x86_init_resources	resources;
148	struct x86_init_mpparse		mpparse;
149	struct x86_init_irqs		irqs;
150	struct x86_init_oem		oem;
151	struct x86_init_paging		paging;
152	struct x86_init_timers		timers;
153	struct x86_init_iommu		iommu;
154	struct x86_init_pci		pci;
155	struct x86_hyper_init		hyper;
156	struct x86_init_acpi		acpi;
157};
158
159/**
160 * struct x86_cpuinit_ops - platform specific cpu hotplug setups
161 * @setup_percpu_clockev:	set up the per cpu clock event device
162 * @early_percpu_clock_init:	early init of the per cpu clock event device
163 */
164struct x86_cpuinit_ops {
165	void (*setup_percpu_clockev)(void);
166	void (*early_percpu_clock_init)(void);
167	void (*fixup_cpu_id)(struct cpuinfo_x86 *c, int node);
168};
169
170struct timespec64;
171
172/**
173 * struct x86_legacy_devices - legacy x86 devices
174 *
175 * @pnpbios: this platform can have a PNPBIOS. If this is disabled the platform
176 * 	is known to never have a PNPBIOS.
177 *
178 * These are devices known to require LPC or ISA bus. The definition of legacy
179 * devices adheres to the ACPI 5.2.9.3 IA-PC Boot Architecture flag
180 * ACPI_FADT_LEGACY_DEVICES. These devices consist of user visible devices on
181 * the LPC or ISA bus. User visible devices are devices that have end-user
182 * accessible connectors (for example, LPT parallel port). Legacy devices on
183 * the LPC bus consist for example of serial and parallel ports, PS/2 keyboard
184 * / mouse, and the floppy disk controller. A system that lacks all known
185 * legacy devices can assume all devices can be detected exclusively via
186 * standard device enumeration mechanisms including the ACPI namespace.
187 *
188 * A system which has does not have ACPI_FADT_LEGACY_DEVICES enabled must not
189 * have any of the legacy devices enumerated below present.
190 */
191struct x86_legacy_devices {
192	int pnpbios;
193};
194
195/**
196 * enum x86_legacy_i8042_state - i8042 keyboard controller state
197 * @X86_LEGACY_I8042_PLATFORM_ABSENT: the controller is always absent on
198 *	given platform/subarch.
199 * @X86_LEGACY_I8042_FIRMWARE_ABSENT: firmware reports that the controller
200 *	is absent.
201 * @X86_LEGACY_i8042_EXPECTED_PRESENT: the controller is likely to be
202 *	present, the i8042 driver should probe for controller existence.
203 */
204enum x86_legacy_i8042_state {
205	X86_LEGACY_I8042_PLATFORM_ABSENT,
206	X86_LEGACY_I8042_FIRMWARE_ABSENT,
207	X86_LEGACY_I8042_EXPECTED_PRESENT,
208};
209
210/**
211 * struct x86_legacy_features - legacy x86 features
212 *
213 * @i8042: indicated if we expect the device to have i8042 controller
214 *	present.
215 * @rtc: this device has a CMOS real-time clock present
216 * @reserve_bios_regions: boot code will search for the EBDA address and the
217 * 	start of the 640k - 1M BIOS region.  If false, the platform must
218 * 	ensure that its memory map correctly reserves sub-1MB regions as needed.
219 * @devices: legacy x86 devices, refer to struct x86_legacy_devices
220 * 	documentation for further details.
221 */
222struct x86_legacy_features {
223	enum x86_legacy_i8042_state i8042;
224	int rtc;
225	int warm_reset;
226	int no_vga;
227	int reserve_bios_regions;
228	struct x86_legacy_devices devices;
229};
230
231/**
232 * struct x86_hyper_runtime - x86 hypervisor specific runtime callbacks
233 *
234 * @pin_vcpu:			pin current vcpu to specified physical
235 *				cpu (run rarely)
236 * @sev_es_hcall_prepare:	Load additional hypervisor-specific
237 *				state into the GHCB when doing a VMMCALL under
238 *				SEV-ES. Called from the #VC exception handler.
239 * @sev_es_hcall_finish:	Copies state from the GHCB back into the
240 *				processor (or pt_regs). Also runs checks on the
241 *				state returned from the hypervisor after a
242 *				VMMCALL under SEV-ES.  Needs to return 'false'
243 *				if the checks fail.  Called from the #VC
244 *				exception handler.
245 */
246struct x86_hyper_runtime {
247	void (*pin_vcpu)(int cpu);
248	void (*sev_es_hcall_prepare)(struct ghcb *ghcb, struct pt_regs *regs);
249	bool (*sev_es_hcall_finish)(struct ghcb *ghcb, struct pt_regs *regs);
250};
251
252/**
253 * struct x86_platform_ops - platform specific runtime functions
254 * @calibrate_cpu:		calibrate CPU
255 * @calibrate_tsc:		calibrate TSC, if different from CPU
256 * @get_wallclock:		get time from HW clock like RTC etc.
257 * @set_wallclock:		set time back to HW clock
258 * @is_untracked_pat_range	exclude from PAT logic
259 * @nmi_init			enable NMI on cpus
260 * @save_sched_clock_state:	save state for sched_clock() on suspend
261 * @restore_sched_clock_state:	restore state for sched_clock() on resume
262 * @apic_post_init:		adjust apic if needed
263 * @legacy:			legacy features
264 * @set_legacy_features:	override legacy features. Use of this callback
265 * 				is highly discouraged. You should only need
266 * 				this if your hardware platform requires further
267 * 				custom fine tuning far beyond what may be
268 * 				possible in x86_early_init_platform_quirks() by
269 * 				only using the current x86_hardware_subarch
270 * 				semantics.
271 * @hyper:			x86 hypervisor specific runtime callbacks
272 */
273struct x86_platform_ops {
274	unsigned long (*calibrate_cpu)(void);
275	unsigned long (*calibrate_tsc)(void);
276	void (*get_wallclock)(struct timespec64 *ts);
277	int (*set_wallclock)(const struct timespec64 *ts);
278	void (*iommu_shutdown)(void);
279	bool (*is_untracked_pat_range)(u64 start, u64 end);
280	void (*nmi_init)(void);
281	unsigned char (*get_nmi_reason)(void);
282	void (*save_sched_clock_state)(void);
283	void (*restore_sched_clock_state)(void);
284	void (*apic_post_init)(void);
285	struct x86_legacy_features legacy;
286	void (*set_legacy_features)(void);
287	struct x86_hyper_runtime hyper;
288};
289
290struct pci_dev;
291
292struct x86_msi_ops {
293	void (*restore_msi_irqs)(struct pci_dev *dev);
294};
295
296struct x86_apic_ops {
297	unsigned int	(*io_apic_read)   (unsigned int apic, unsigned int reg);
298	void		(*restore)(void);
299};
300
301extern struct x86_init_ops x86_init;
302extern struct x86_cpuinit_ops x86_cpuinit;
303extern struct x86_platform_ops x86_platform;
304extern struct x86_msi_ops x86_msi;
305extern struct x86_apic_ops x86_apic_ops;
306
307extern void x86_early_init_platform_quirks(void);
308extern void x86_init_noop(void);
309extern void x86_init_uint_noop(unsigned int unused);
310extern bool bool_x86_init_noop(void);
311extern void x86_op_int_noop(int cpu);
312extern bool x86_pnpbios_disabled(void);
313
314#endif
315