xref: /openbmc/linux/arch/powerpc/include/asm/machdep.h (revision 711aab1d)
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 				   unsigned long flags, 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		(*cpu_die)(void);
80 
81 	long		(*time_init)(void); /* Optional, may be NULL */
82 
83 	int		(*set_rtc_time)(struct rtc_time *);
84 	void		(*get_rtc_time)(struct rtc_time *);
85 	unsigned long	(*get_boot_time)(void);
86 	unsigned char 	(*rtc_read_val)(int addr);
87 	void		(*rtc_write_val)(int addr, unsigned char val);
88 
89 	void		(*calibrate_decr)(void);
90 
91 	void		(*progress)(char *, unsigned short);
92 
93 	/* Interface for platform error logging */
94 	void 		(*log_error)(char *buf, unsigned int err_type, int fatal);
95 
96 	unsigned char 	(*nvram_read_val)(int addr);
97 	void		(*nvram_write_val)(int addr, unsigned char val);
98 	ssize_t		(*nvram_write)(char *buf, size_t count, loff_t *index);
99 	ssize_t		(*nvram_read)(char *buf, size_t count, loff_t *index);
100 	ssize_t		(*nvram_size)(void);
101 	void		(*nvram_sync)(void);
102 
103 	/* Exception handlers */
104 	int		(*system_reset_exception)(struct pt_regs *regs);
105 	int 		(*machine_check_exception)(struct pt_regs *regs);
106 	int		(*handle_hmi_exception)(struct pt_regs *regs);
107 
108 	/* Early exception handlers called in realmode */
109 	int		(*hmi_exception_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 	resource_size_t (*pcibios_default_alignment)(void);
176 
177 #ifdef CONFIG_PCI_IOV
178 	void (*pcibios_fixup_sriov)(struct pci_dev *pdev);
179 	resource_size_t (*pcibios_iov_resource_alignment)(struct pci_dev *, int resno);
180 #endif /* CONFIG_PCI_IOV */
181 
182 	/* Called to shutdown machine specific hardware not already controlled
183 	 * by other drivers.
184 	 */
185 	void (*machine_shutdown)(void);
186 
187 #ifdef CONFIG_KEXEC_CORE
188 	void (*kexec_cpu_down)(int crash_shutdown, int secondary);
189 
190 	/* Called to do what every setup is needed on image and the
191 	 * reboot code buffer. Returns 0 on success.
192 	 * Provide your own (maybe dummy) implementation if your platform
193 	 * claims to support kexec.
194 	 */
195 	int (*machine_kexec_prepare)(struct kimage *image);
196 
197 	/* Called to perform the _real_ kexec.
198 	 * Do NOT allocate memory or fail here. We are past the point of
199 	 * no return.
200 	 */
201 	void (*machine_kexec)(struct kimage *image);
202 #endif /* CONFIG_KEXEC_CORE */
203 
204 #ifdef CONFIG_SUSPEND
205 	/* These are called to disable and enable, respectively, IRQs when
206 	 * entering a suspend state.  If NULL, then the generic versions
207 	 * will be called.  The generic versions disable/enable the
208 	 * decrementer along with interrupts.
209 	 */
210 	void (*suspend_disable_irqs)(void);
211 	void (*suspend_enable_irqs)(void);
212 #endif
213 	int (*suspend_disable_cpu)(void);
214 
215 #ifdef CONFIG_ARCH_CPU_PROBE_RELEASE
216 	ssize_t (*cpu_probe)(const char *, size_t);
217 	ssize_t (*cpu_release)(const char *, size_t);
218 #endif
219 
220 #ifdef CONFIG_ARCH_RANDOM
221 	int (*get_random_seed)(unsigned long *v);
222 #endif
223 };
224 
225 extern void e500_idle(void);
226 extern void power4_idle(void);
227 extern void power7_idle(void);
228 extern void power9_idle(void);
229 extern void ppc6xx_idle(void);
230 extern void book3e_idle(void);
231 
232 /*
233  * ppc_md contains a copy of the machine description structure for the
234  * current platform. machine_id contains the initial address where the
235  * description was found during boot.
236  */
237 extern struct machdep_calls ppc_md;
238 extern struct machdep_calls *machine_id;
239 
240 #define __machine_desc __attribute__ ((__section__ (".machine.desc")))
241 
242 #define define_machine(name)					\
243 	extern struct machdep_calls mach_##name;		\
244 	EXPORT_SYMBOL(mach_##name);				\
245 	struct machdep_calls mach_##name __machine_desc =
246 
247 #define machine_is(name) \
248 	({ \
249 		extern struct machdep_calls mach_##name \
250 			__attribute__((weak));		 \
251 		machine_id == &mach_##name; \
252 	})
253 
254 extern void probe_machine(void);
255 
256 #ifdef CONFIG_PPC_PMAC
257 /*
258  * Power macintoshes have either a CUDA, PMU or SMU controlling
259  * system reset, power, NVRAM, RTC.
260  */
261 typedef enum sys_ctrler_kind {
262 	SYS_CTRLER_UNKNOWN = 0,
263 	SYS_CTRLER_CUDA = 1,
264 	SYS_CTRLER_PMU = 2,
265 	SYS_CTRLER_SMU = 3,
266 } sys_ctrler_t;
267 extern sys_ctrler_t sys_ctrler;
268 
269 #endif /* CONFIG_PPC_PMAC */
270 
271 static inline void log_error(char *buf, unsigned int err_type, int fatal)
272 {
273 	if (ppc_md.log_error)
274 		ppc_md.log_error(buf, err_type, fatal);
275 }
276 
277 #define __define_machine_initcall(mach, fn, id) \
278 	static int __init __machine_initcall_##mach##_##fn(void) { \
279 		if (machine_is(mach)) return fn(); \
280 		return 0; \
281 	} \
282 	__define_initcall(__machine_initcall_##mach##_##fn, id);
283 
284 #define machine_early_initcall(mach, fn)	__define_machine_initcall(mach, fn, early)
285 #define machine_core_initcall(mach, fn)		__define_machine_initcall(mach, fn, 1)
286 #define machine_core_initcall_sync(mach, fn)	__define_machine_initcall(mach, fn, 1s)
287 #define machine_postcore_initcall(mach, fn)	__define_machine_initcall(mach, fn, 2)
288 #define machine_postcore_initcall_sync(mach, fn)	__define_machine_initcall(mach, fn, 2s)
289 #define machine_arch_initcall(mach, fn)		__define_machine_initcall(mach, fn, 3)
290 #define machine_arch_initcall_sync(mach, fn)	__define_machine_initcall(mach, fn, 3s)
291 #define machine_subsys_initcall(mach, fn)	__define_machine_initcall(mach, fn, 4)
292 #define machine_subsys_initcall_sync(mach, fn)	__define_machine_initcall(mach, fn, 4s)
293 #define machine_fs_initcall(mach, fn)		__define_machine_initcall(mach, fn, 5)
294 #define machine_fs_initcall_sync(mach, fn)	__define_machine_initcall(mach, fn, 5s)
295 #define machine_rootfs_initcall(mach, fn)	__define_machine_initcall(mach, fn, rootfs)
296 #define machine_device_initcall(mach, fn)	__define_machine_initcall(mach, fn, 6)
297 #define machine_device_initcall_sync(mach, fn)	__define_machine_initcall(mach, fn, 6s)
298 #define machine_late_initcall(mach, fn)		__define_machine_initcall(mach, fn, 7)
299 #define machine_late_initcall_sync(mach, fn)	__define_machine_initcall(mach, fn, 7s)
300 
301 #endif /* __KERNEL__ */
302 #endif /* _ASM_POWERPC_MACHDEP_H */
303