1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 #ifndef _ASM_POWERPC_MACHDEP_H
3 #define _ASM_POWERPC_MACHDEP_H
4 #ifdef __KERNEL__
5
6 #include <linux/seq_file.h>
7 #include <linux/init.h>
8 #include <linux/dma-mapping.h>
9 #include <linux/export.h>
10
11 #include <asm/setup.h>
12
13 /* We export this macro for external modules like Alsa to know if
14 * ppc_md.feature_call is implemented or not
15 */
16 #define CONFIG_PPC_HAS_FEATURE_CALLS
17
18 struct pt_regs;
19 struct pci_bus;
20 struct device_node;
21 struct iommu_table;
22 struct rtc_time;
23 struct file;
24 struct pci_controller;
25 struct kimage;
26 struct pci_host_bridge;
27
28 struct machdep_calls {
29 char *name;
30 #ifdef CONFIG_PPC64
31 #ifdef CONFIG_PM
32 void (*iommu_save)(void);
33 void (*iommu_restore)(void);
34 #endif
35 #ifdef CONFIG_MEMORY_HOTPLUG_SPARSE
36 unsigned long (*memory_block_size)(void);
37 #endif
38 #endif /* CONFIG_PPC64 */
39
40 void (*dma_set_mask)(struct device *dev, u64 dma_mask);
41
42 int (*probe)(void);
43 void (*setup_arch)(void); /* Optional, may be NULL */
44 /* Optional, may be NULL. */
45 void (*show_cpuinfo)(struct seq_file *m);
46 void (*show_percpuinfo)(struct seq_file *m, int i);
47 /* Returns the current operating frequency of "cpu" in Hz */
48 unsigned long (*get_proc_freq)(unsigned int cpu);
49
50 void (*init_IRQ)(void);
51
52 /* Return an irq, or 0 to indicate there are none pending. */
53 unsigned int (*get_irq)(void);
54
55 /* PCI stuff */
56 /* Called after allocating resources */
57 void (*pcibios_fixup)(void);
58 void (*pci_irq_fixup)(struct pci_dev *dev);
59 int (*pcibios_root_bridge_prepare)(struct pci_host_bridge
60 *bridge);
61
62 /* finds all the pci_controllers present at boot */
63 void (*discover_phbs)(void);
64
65 /* To setup PHBs when using automatic OF platform driver for PCI */
66 int (*pci_setup_phb)(struct pci_controller *host);
67
68 void __noreturn (*restart)(char *cmd);
69 void __noreturn (*halt)(void);
70 void (*panic)(char *str);
71 void (*cpu_die)(void);
72
73 long (*time_init)(void); /* Optional, may be NULL */
74
75 int (*set_rtc_time)(struct rtc_time *);
76 void (*get_rtc_time)(struct rtc_time *);
77 time64_t (*get_boot_time)(void);
78 unsigned char (*rtc_read_val)(int addr);
79 void (*rtc_write_val)(int addr, unsigned char val);
80
81 void (*calibrate_decr)(void);
82
83 void (*progress)(char *, unsigned short);
84
85 /* Interface for platform error logging */
86 void (*log_error)(char *buf, unsigned int err_type, int fatal);
87
88 unsigned char (*nvram_read_val)(int addr);
89 void (*nvram_write_val)(int addr, unsigned char val);
90 ssize_t (*nvram_write)(char *buf, size_t count, loff_t *index);
91 ssize_t (*nvram_read)(char *buf, size_t count, loff_t *index);
92 ssize_t (*nvram_size)(void);
93 void (*nvram_sync)(void);
94
95 /* Exception handlers */
96 int (*system_reset_exception)(struct pt_regs *regs);
97 int (*machine_check_exception)(struct pt_regs *regs);
98 int (*handle_hmi_exception)(struct pt_regs *regs);
99
100 /* Early exception handlers called in realmode */
101 int (*hmi_exception_early)(struct pt_regs *regs);
102 long (*machine_check_early)(struct pt_regs *regs);
103
104 /* Called during machine check exception to retrive fixup address. */
105 bool (*mce_check_early_recovery)(struct pt_regs *regs);
106
107 /* Motherboard/chipset features. This is a kind of general purpose
108 * hook used to control some machine specific features (like reset
109 * lines, chip power control, etc...).
110 */
111 long (*feature_call)(unsigned int feature, ...);
112
113 /* Get legacy PCI/IDE interrupt mapping */
114 int (*pci_get_legacy_ide_irq)(struct pci_dev *dev, int channel);
115
116 /* Get access protection for /dev/mem */
117 pgprot_t (*phys_mem_access_prot)(struct file *file,
118 unsigned long pfn,
119 unsigned long size,
120 pgprot_t vma_prot);
121
122 /*
123 * Function for waiting for work with reduced power in idle loop;
124 * called with interrupts disabled.
125 */
126 void (*power_save)(void);
127
128 /* Function to enable performance monitor counters for this
129 platform, called once per cpu. */
130 void (*enable_pmcs)(void);
131
132 /* Set DABR for this platform, leave empty for default implementation */
133 int (*set_dabr)(unsigned long dabr,
134 unsigned long dabrx);
135
136 /* Set DAWR for this platform, leave empty for default implementation */
137 int (*set_dawr)(unsigned long dawr,
138 unsigned long dawrx);
139
140 #ifdef CONFIG_PPC32 /* XXX for now */
141 /* A general init function, called by ppc_init in init/main.c.
142 May be NULL. */
143 void (*init)(void);
144
145 void (*kgdb_map_scc)(void);
146
147 /*
148 * optional PCI "hooks"
149 */
150 /* Called at then very end of pcibios_init() */
151 void (*pcibios_after_init)(void);
152
153 #endif /* CONFIG_PPC32 */
154
155 /* Called in indirect_* to avoid touching devices */
156 int (*pci_exclude_device)(struct pci_controller *, unsigned char, unsigned char);
157
158 /* Called after PPC generic resource fixup to perform
159 machine specific fixups */
160 void (*pcibios_fixup_resources)(struct pci_dev *);
161
162 /* Called for each PCI bus in the system when it's probed */
163 void (*pcibios_fixup_bus)(struct pci_bus *);
164
165 /* Called after scan and before resource survey */
166 void (*pcibios_fixup_phb)(struct pci_controller *hose);
167
168 /*
169 * Called after device has been added to bus and
170 * before sysfs has been created.
171 */
172 void (*pcibios_bus_add_device)(struct pci_dev *pdev);
173
174 resource_size_t (*pcibios_default_alignment)(void);
175
176 #ifdef CONFIG_PCI_IOV
177 void (*pcibios_fixup_sriov)(struct pci_dev *pdev);
178 resource_size_t (*pcibios_iov_resource_alignment)(struct pci_dev *, int resno);
179 int (*pcibios_sriov_enable)(struct pci_dev *pdev, u16 num_vfs);
180 int (*pcibios_sriov_disable)(struct pci_dev *pdev);
181 #endif /* CONFIG_PCI_IOV */
182
183 /* Called to shutdown machine specific hardware not already controlled
184 * by other drivers.
185 */
186 void (*machine_shutdown)(void);
187
188 #ifdef CONFIG_KEXEC_CORE
189 void (*kexec_cpu_down)(int crash_shutdown, int secondary);
190
191 /* Called to do what every setup is needed on image and the
192 * reboot code buffer. Returns 0 on success.
193 * Provide your own (maybe dummy) implementation if your platform
194 * claims to support kexec.
195 */
196 int (*machine_kexec_prepare)(struct kimage *image);
197
198 /* Called to perform the _real_ kexec.
199 * Do NOT allocate memory or fail here. We are past the point of
200 * no return.
201 */
202 void (*machine_kexec)(struct kimage *image);
203 #endif /* CONFIG_KEXEC_CORE */
204
205 #ifdef CONFIG_SUSPEND
206 /* These are called to disable and enable, respectively, IRQs when
207 * entering a suspend state. If NULL, then the generic versions
208 * will be called. The generic versions disable/enable the
209 * decrementer along with interrupts.
210 */
211 void (*suspend_disable_irqs)(void);
212 void (*suspend_enable_irqs)(void);
213 #endif
214 int (*suspend_disable_cpu)(void);
215
216 #ifdef CONFIG_ARCH_CPU_PROBE_RELEASE
217 ssize_t (*cpu_probe)(const char *, size_t);
218 ssize_t (*cpu_release)(const char *, size_t);
219 #endif
220
221 #ifdef CONFIG_ARCH_RANDOM
222 int (*get_random_seed)(unsigned long *v);
223 #endif
224 };
225
226 extern void e500_idle(void);
227 extern void power4_idle(void);
228 extern void power7_idle(void);
229 extern void power9_idle(void);
230 extern void ppc6xx_idle(void);
231 extern void book3e_idle(void);
232
233 /*
234 * ppc_md contains a copy of the machine description structure for the
235 * current platform. machine_id contains the initial address where the
236 * description was found during boot.
237 */
238 extern struct machdep_calls ppc_md;
239 extern struct machdep_calls *machine_id;
240
241 #define __machine_desc __attribute__ ((__section__ (".machine.desc")))
242
243 #define define_machine(name) \
244 extern struct machdep_calls mach_##name; \
245 EXPORT_SYMBOL(mach_##name); \
246 struct machdep_calls mach_##name __machine_desc =
247
248 #define machine_is(name) \
249 ({ \
250 extern struct machdep_calls mach_##name \
251 __attribute__((weak)); \
252 machine_id == &mach_##name; \
253 })
254
255 extern void probe_machine(void);
256
257 #ifdef CONFIG_PPC_PMAC
258 /*
259 * Power macintoshes have either a CUDA, PMU or SMU controlling
260 * system reset, power, NVRAM, RTC.
261 */
262 typedef enum sys_ctrler_kind {
263 SYS_CTRLER_UNKNOWN = 0,
264 SYS_CTRLER_CUDA = 1,
265 SYS_CTRLER_PMU = 2,
266 SYS_CTRLER_SMU = 3,
267 } sys_ctrler_t;
268 extern sys_ctrler_t sys_ctrler;
269
270 #endif /* CONFIG_PPC_PMAC */
271
log_error(char * buf,unsigned int err_type,int fatal)272 static inline void log_error(char *buf, unsigned int err_type, int fatal)
273 {
274 if (ppc_md.log_error)
275 ppc_md.log_error(buf, err_type, fatal);
276 }
277
278 #define __define_machine_initcall(mach, fn, id) \
279 static int __init __machine_initcall_##mach##_##fn(void) { \
280 if (machine_is(mach)) return fn(); \
281 return 0; \
282 } \
283 __define_initcall(__machine_initcall_##mach##_##fn, id);
284
285 #define machine_early_initcall(mach, fn) __define_machine_initcall(mach, fn, early)
286 #define machine_core_initcall(mach, fn) __define_machine_initcall(mach, fn, 1)
287 #define machine_core_initcall_sync(mach, fn) __define_machine_initcall(mach, fn, 1s)
288 #define machine_postcore_initcall(mach, fn) __define_machine_initcall(mach, fn, 2)
289 #define machine_postcore_initcall_sync(mach, fn) __define_machine_initcall(mach, fn, 2s)
290 #define machine_arch_initcall(mach, fn) __define_machine_initcall(mach, fn, 3)
291 #define machine_arch_initcall_sync(mach, fn) __define_machine_initcall(mach, fn, 3s)
292 #define machine_subsys_initcall(mach, fn) __define_machine_initcall(mach, fn, 4)
293 #define machine_subsys_initcall_sync(mach, fn) __define_machine_initcall(mach, fn, 4s)
294 #define machine_fs_initcall(mach, fn) __define_machine_initcall(mach, fn, 5)
295 #define machine_fs_initcall_sync(mach, fn) __define_machine_initcall(mach, fn, 5s)
296 #define machine_rootfs_initcall(mach, fn) __define_machine_initcall(mach, fn, rootfs)
297 #define machine_device_initcall(mach, fn) __define_machine_initcall(mach, fn, 6)
298 #define machine_device_initcall_sync(mach, fn) __define_machine_initcall(mach, fn, 6s)
299 #define machine_late_initcall(mach, fn) __define_machine_initcall(mach, fn, 7)
300 #define machine_late_initcall_sync(mach, fn) __define_machine_initcall(mach, fn, 7s)
301
302 #endif /* __KERNEL__ */
303 #endif /* _ASM_POWERPC_MACHDEP_H */
304