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