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