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