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