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