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