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