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