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