xref: /linux/arch/powerpc/include/asm/machdep.h (revision ff10fca5ceacf7bc59636f5ab808e775d1717167)
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 
16 #include <asm/setup.h>
17 
18 /* We export this macro for external modules like Alsa to know if
19  * ppc_md.feature_call is implemented or not
20  */
21 #define CONFIG_PPC_HAS_FEATURE_CALLS
22 
23 struct pt_regs;
24 struct pci_bus;
25 struct device_node;
26 struct iommu_table;
27 struct rtc_time;
28 struct file;
29 struct pci_controller;
30 #ifdef CONFIG_KEXEC
31 struct kimage;
32 #endif
33 
34 #ifdef CONFIG_SMP
35 struct smp_ops_t {
36 	void  (*message_pass)(int target, int msg);
37 	int   (*probe)(void);
38 	void  (*kick_cpu)(int nr);
39 	void  (*setup_cpu)(int nr);
40 	void  (*take_timebase)(void);
41 	void  (*give_timebase)(void);
42 	int   (*cpu_enable)(unsigned int nr);
43 	int   (*cpu_disable)(void);
44 	void  (*cpu_die)(unsigned int nr);
45 	int   (*cpu_bootable)(unsigned int nr);
46 };
47 #endif
48 
49 struct machdep_calls {
50 	char		*name;
51 #ifdef CONFIG_PPC64
52 	void            (*hpte_invalidate)(unsigned long slot,
53 					   unsigned long va,
54 					   int psize, int ssize,
55 					   int local);
56 	long		(*hpte_updatepp)(unsigned long slot,
57 					 unsigned long newpp,
58 					 unsigned long va,
59 					 int psize, int ssize,
60 					 int local);
61 	void            (*hpte_updateboltedpp)(unsigned long newpp,
62 					       unsigned long ea,
63 					       int psize, int ssize);
64 	long		(*hpte_insert)(unsigned long hpte_group,
65 				       unsigned long va,
66 				       unsigned long prpn,
67 				       unsigned long rflags,
68 				       unsigned long vflags,
69 				       int psize, int ssize);
70 	long		(*hpte_remove)(unsigned long hpte_group);
71 	void            (*hpte_removebolted)(unsigned long ea,
72 					     int psize, int ssize);
73 	void		(*flush_hash_range)(unsigned long number, int local);
74 
75 	/* special for kexec, to be called in real mode, linar mapping is
76 	 * destroyed as well */
77 	void		(*hpte_clear_all)(void);
78 
79 	int		(*tce_build)(struct iommu_table *tbl,
80 				     long index,
81 				     long npages,
82 				     unsigned long uaddr,
83 				     enum dma_data_direction direction,
84 				     struct dma_attrs *attrs);
85 	void		(*tce_free)(struct iommu_table *tbl,
86 				    long index,
87 				    long npages);
88 	unsigned long	(*tce_get)(struct iommu_table *tbl,
89 				    long index);
90 	void		(*tce_flush)(struct iommu_table *tbl);
91 
92 	void __iomem *	(*ioremap)(phys_addr_t addr, unsigned long size,
93 				   unsigned long flags, void *caller);
94 	void		(*iounmap)(volatile void __iomem *token);
95 
96 #ifdef CONFIG_PM
97 	void		(*iommu_save)(void);
98 	void		(*iommu_restore)(void);
99 #endif
100 #endif /* CONFIG_PPC64 */
101 
102 	void		(*pci_dma_dev_setup)(struct pci_dev *dev);
103 	void		(*pci_dma_bus_setup)(struct pci_bus *bus);
104 
105 	/* Platform set_dma_mask override */
106 	int		(*dma_set_mask)(struct device *dev, u64 dma_mask);
107 
108 	int		(*probe)(void);
109 	void		(*setup_arch)(void); /* Optional, may be NULL */
110 	void		(*init_early)(void);
111 	/* Optional, may be NULL. */
112 	void		(*show_cpuinfo)(struct seq_file *m);
113 	void		(*show_percpuinfo)(struct seq_file *m, int i);
114 
115 	void		(*init_IRQ)(void);
116 
117 	/* Return an irq, or NO_IRQ to indicate there are none pending.
118 	 * If for some reason there is no irq, but the interrupt
119 	 * shouldn't be counted as spurious, return NO_IRQ_IGNORE. */
120 	unsigned int	(*get_irq)(void);
121 #ifdef CONFIG_KEXEC
122 	void		(*kexec_cpu_down)(int crash_shutdown, int secondary);
123 #endif
124 
125 	/* PCI stuff */
126 	/* Called after scanning the bus, before allocating resources */
127 	void		(*pcibios_fixup)(void);
128 	int		(*pci_probe_mode)(struct pci_bus *);
129 	void		(*pci_irq_fixup)(struct pci_dev *dev);
130 
131 	/* To setup PHBs when using automatic OF platform driver for PCI */
132 	int		(*pci_setup_phb)(struct pci_controller *host);
133 
134 #ifdef CONFIG_PCI_MSI
135 	int		(*msi_check_device)(struct pci_dev* dev,
136 					    int nvec, int type);
137 	int		(*setup_msi_irqs)(struct pci_dev *dev,
138 					  int nvec, int type);
139 	void		(*teardown_msi_irqs)(struct pci_dev *dev);
140 #endif
141 
142 	void		(*restart)(char *cmd);
143 	void		(*power_off)(void);
144 	void		(*halt)(void);
145 	void		(*panic)(char *str);
146 	void		(*cpu_die)(void);
147 
148 	long		(*time_init)(void); /* Optional, may be NULL */
149 
150 	int		(*set_rtc_time)(struct rtc_time *);
151 	void		(*get_rtc_time)(struct rtc_time *);
152 	unsigned long	(*get_boot_time)(void);
153 	unsigned char 	(*rtc_read_val)(int addr);
154 	void		(*rtc_write_val)(int addr, unsigned char val);
155 
156 	void		(*calibrate_decr)(void);
157 
158 	void		(*progress)(char *, unsigned short);
159 
160 	/* Interface for platform error logging */
161 	void 		(*log_error)(char *buf, unsigned int err_type, int fatal);
162 
163 	unsigned char 	(*nvram_read_val)(int addr);
164 	void		(*nvram_write_val)(int addr, unsigned char val);
165 	ssize_t		(*nvram_write)(char *buf, size_t count, loff_t *index);
166 	ssize_t		(*nvram_read)(char *buf, size_t count, loff_t *index);
167 	ssize_t		(*nvram_size)(void);
168 	void		(*nvram_sync)(void);
169 
170 	/* Exception handlers */
171 	int		(*system_reset_exception)(struct pt_regs *regs);
172 	int 		(*machine_check_exception)(struct pt_regs *regs);
173 
174 	/* Motherboard/chipset features. This is a kind of general purpose
175 	 * hook used to control some machine specific features (like reset
176 	 * lines, chip power control, etc...).
177 	 */
178 	long	 	(*feature_call)(unsigned int feature, ...);
179 
180 	/* Get legacy PCI/IDE interrupt mapping */
181 	int		(*pci_get_legacy_ide_irq)(struct pci_dev *dev, int channel);
182 
183 	/* Get access protection for /dev/mem */
184 	pgprot_t	(*phys_mem_access_prot)(struct file *file,
185 						unsigned long pfn,
186 						unsigned long size,
187 						pgprot_t vma_prot);
188 
189 	/* Idle loop for this platform, leave empty for default idle loop */
190 	void		(*idle_loop)(void);
191 
192 	/*
193 	 * Function for waiting for work with reduced power in idle loop;
194 	 * called with interrupts disabled.
195 	 */
196 	void		(*power_save)(void);
197 
198 	/* Function to enable performance monitor counters for this
199 	   platform, called once per cpu. */
200 	void		(*enable_pmcs)(void);
201 
202 	/* Set DABR for this platform, leave empty for default implemenation */
203 	int		(*set_dabr)(unsigned long dabr);
204 
205 #ifdef CONFIG_PPC32	/* XXX for now */
206 	/* A general init function, called by ppc_init in init/main.c.
207 	   May be NULL. */
208 	void		(*init)(void);
209 
210 	void		(*kgdb_map_scc)(void);
211 
212 	/*
213 	 * optional PCI "hooks"
214 	 */
215 	/* Called at then very end of pcibios_init() */
216 	void (*pcibios_after_init)(void);
217 
218 #endif /* CONFIG_PPC32 */
219 
220 	/* Called in indirect_* to avoid touching devices */
221 	int (*pci_exclude_device)(struct pci_controller *, unsigned char, unsigned char);
222 
223 	/* Called after PPC generic resource fixup to perform
224 	   machine specific fixups */
225 	void (*pcibios_fixup_resources)(struct pci_dev *);
226 
227 	/* Called for each PCI bus in the system when it's probed */
228 	void (*pcibios_fixup_bus)(struct pci_bus *);
229 
230 	/* Called when pci_enable_device() is called. Returns 0 to
231 	 * allow assignment/enabling of the device. */
232 	int  (*pcibios_enable_device_hook)(struct pci_dev *);
233 
234 	/* Called to shutdown machine specific hardware not already controlled
235 	 * by other drivers.
236 	 */
237 	void (*machine_shutdown)(void);
238 
239 #ifdef CONFIG_KEXEC
240 	/* Called to do the minimal shutdown needed to run a kexec'd kernel
241 	 * to run successfully.
242 	 * XXX Should we move this one out of kexec scope?
243 	 */
244 	void (*machine_crash_shutdown)(struct pt_regs *regs);
245 
246 	/* Called to do what every setup is needed on image and the
247 	 * reboot code buffer. Returns 0 on success.
248 	 * Provide your own (maybe dummy) implementation if your platform
249 	 * claims to support kexec.
250 	 */
251 	int (*machine_kexec_prepare)(struct kimage *image);
252 
253 	/* Called to handle any machine specific cleanup on image */
254 	void (*machine_kexec_cleanup)(struct kimage *image);
255 
256 	/* Called to perform the _real_ kexec.
257 	 * Do NOT allocate memory or fail here. We are past the point of
258 	 * no return.
259 	 */
260 	void (*machine_kexec)(struct kimage *image);
261 #endif /* CONFIG_KEXEC */
262 
263 #ifdef CONFIG_SUSPEND
264 	/* These are called to disable and enable, respectively, IRQs when
265 	 * entering a suspend state.  If NULL, then the generic versions
266 	 * will be called.  The generic versions disable/enable the
267 	 * decrementer along with interrupts.
268 	 */
269 	void (*suspend_disable_irqs)(void);
270 	void (*suspend_enable_irqs)(void);
271 #endif
272 	int (*suspend_disable_cpu)(void);
273 
274 #ifdef CONFIG_ARCH_CPU_PROBE_RELEASE
275 	ssize_t (*cpu_probe)(const char *, size_t);
276 	ssize_t (*cpu_release)(const char *, size_t);
277 #endif
278 };
279 
280 extern void e500_idle(void);
281 extern void power4_idle(void);
282 extern void power4_cpu_offline_powersave(void);
283 extern void ppc6xx_idle(void);
284 extern void book3e_idle(void);
285 
286 /*
287  * ppc_md contains a copy of the machine description structure for the
288  * current platform. machine_id contains the initial address where the
289  * description was found during boot.
290  */
291 extern struct machdep_calls ppc_md;
292 extern struct machdep_calls *machine_id;
293 
294 #define __machine_desc __attribute__ ((__section__ (".machine.desc")))
295 
296 #define define_machine(name)					\
297 	extern struct machdep_calls mach_##name;		\
298 	EXPORT_SYMBOL(mach_##name);				\
299 	struct machdep_calls mach_##name __machine_desc =
300 
301 #define machine_is(name) \
302 	({ \
303 		extern struct machdep_calls mach_##name \
304 			__attribute__((weak));		 \
305 		machine_id == &mach_##name; \
306 	})
307 
308 extern void probe_machine(void);
309 
310 extern char cmd_line[COMMAND_LINE_SIZE];
311 
312 #ifdef CONFIG_PPC_PMAC
313 /*
314  * Power macintoshes have either a CUDA, PMU or SMU controlling
315  * system reset, power, NVRAM, RTC.
316  */
317 typedef enum sys_ctrler_kind {
318 	SYS_CTRLER_UNKNOWN = 0,
319 	SYS_CTRLER_CUDA = 1,
320 	SYS_CTRLER_PMU = 2,
321 	SYS_CTRLER_SMU = 3,
322 } sys_ctrler_t;
323 extern sys_ctrler_t sys_ctrler;
324 
325 #endif /* CONFIG_PPC_PMAC */
326 
327 extern void setup_pci_ptrs(void);
328 
329 #ifdef CONFIG_SMP
330 /* Poor default implementations */
331 extern void __devinit smp_generic_give_timebase(void);
332 extern void __devinit smp_generic_take_timebase(void);
333 #endif /* CONFIG_SMP */
334 
335 
336 /* Functions to produce codes on the leds.
337  * The SRC code should be unique for the message category and should
338  * be limited to the lower 24 bits (the upper 8 are set by these funcs),
339  * and (for boot & dump) should be sorted numerically in the order
340  * the events occur.
341  */
342 /* Print a boot progress message. */
343 void ppc64_boot_msg(unsigned int src, const char *msg);
344 
345 static inline void log_error(char *buf, unsigned int err_type, int fatal)
346 {
347 	if (ppc_md.log_error)
348 		ppc_md.log_error(buf, err_type, fatal);
349 }
350 
351 #define __define_machine_initcall(mach,level,fn,id) \
352 	static int __init __machine_initcall_##mach##_##fn(void) { \
353 		if (machine_is(mach)) return fn(); \
354 		return 0; \
355 	} \
356 	__define_initcall(level,__machine_initcall_##mach##_##fn,id);
357 
358 #define machine_core_initcall(mach,fn)		__define_machine_initcall(mach,"1",fn,1)
359 #define machine_core_initcall_sync(mach,fn)	__define_machine_initcall(mach,"1s",fn,1s)
360 #define machine_postcore_initcall(mach,fn)	__define_machine_initcall(mach,"2",fn,2)
361 #define machine_postcore_initcall_sync(mach,fn)	__define_machine_initcall(mach,"2s",fn,2s)
362 #define machine_arch_initcall(mach,fn)		__define_machine_initcall(mach,"3",fn,3)
363 #define machine_arch_initcall_sync(mach,fn)	__define_machine_initcall(mach,"3s",fn,3s)
364 #define machine_subsys_initcall(mach,fn)	__define_machine_initcall(mach,"4",fn,4)
365 #define machine_subsys_initcall_sync(mach,fn)	__define_machine_initcall(mach,"4s",fn,4s)
366 #define machine_fs_initcall(mach,fn)		__define_machine_initcall(mach,"5",fn,5)
367 #define machine_fs_initcall_sync(mach,fn)	__define_machine_initcall(mach,"5s",fn,5s)
368 #define machine_rootfs_initcall(mach,fn)	__define_machine_initcall(mach,"rootfs",fn,rootfs)
369 #define machine_device_initcall(mach,fn)	__define_machine_initcall(mach,"6",fn,6)
370 #define machine_device_initcall_sync(mach,fn)	__define_machine_initcall(mach,"6s",fn,6s)
371 #define machine_late_initcall(mach,fn)		__define_machine_initcall(mach,"7",fn,7)
372 #define machine_late_initcall_sync(mach,fn)	__define_machine_initcall(mach,"7s",fn,7s)
373 
374 #endif /* __KERNEL__ */
375 #endif /* _ASM_POWERPC_MACHDEP_H */
376