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