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