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