1/* SPDX-License-Identifier: GPL-2.0-or-later */
2#ifndef _ASM_POWERPC_MACHDEP_H
3#define _ASM_POWERPC_MACHDEP_H
4#ifdef __KERNEL__
5
6#include <linux/seq_file.h>
7#include <linux/init.h>
8#include <linux/dma-mapping.h>
9#include <linux/export.h>
10
11#include <asm/setup.h>
12
13/* We export this macro for external modules like Alsa to know if
14 * ppc_md.feature_call is implemented or not
15 */
16#define CONFIG_PPC_HAS_FEATURE_CALLS
17
18struct pt_regs;
19struct pci_bus;
20struct device_node;
21struct iommu_table;
22struct rtc_time;
23struct file;
24struct pci_controller;
25struct kimage;
26struct pci_host_bridge;
27
28struct machdep_calls {
29	char		*name;
30#ifdef CONFIG_PPC64
31#ifdef CONFIG_PM
32	void		(*iommu_save)(void);
33	void		(*iommu_restore)(void);
34#endif
35#ifdef CONFIG_MEMORY_HOTPLUG_SPARSE
36	unsigned long	(*memory_block_size)(void);
37#endif
38#endif /* CONFIG_PPC64 */
39
40	void		(*dma_set_mask)(struct device *dev, u64 dma_mask);
41
42	int		(*probe)(void);
43	void		(*setup_arch)(void); /* Optional, may be NULL */
44	/* Optional, may be NULL. */
45	void		(*show_cpuinfo)(struct seq_file *m);
46	void		(*show_percpuinfo)(struct seq_file *m, int i);
47	/* Returns the current operating frequency of "cpu" in Hz */
48	unsigned long  	(*get_proc_freq)(unsigned int cpu);
49
50	void		(*init_IRQ)(void);
51
52	/* Return an irq, or 0 to indicate there are none pending. */
53	unsigned int	(*get_irq)(void);
54
55	/* PCI stuff */
56	/* Called after allocating resources */
57	void		(*pcibios_fixup)(void);
58	void		(*pci_irq_fixup)(struct pci_dev *dev);
59	int		(*pcibios_root_bridge_prepare)(struct pci_host_bridge
60				*bridge);
61
62	/* finds all the pci_controllers present at boot */
63	void 		(*discover_phbs)(void);
64
65	/* To setup PHBs when using automatic OF platform driver for PCI */
66	int		(*pci_setup_phb)(struct pci_controller *host);
67
68	void __noreturn	(*restart)(char *cmd);
69	void __noreturn (*halt)(void);
70	void		(*panic)(char *str);
71
72	long		(*time_init)(void); /* Optional, may be NULL */
73
74	int		(*set_rtc_time)(struct rtc_time *);
75	void		(*get_rtc_time)(struct rtc_time *);
76	time64_t	(*get_boot_time)(void);
77	unsigned char 	(*rtc_read_val)(int addr);
78	void		(*rtc_write_val)(int addr, unsigned char val);
79
80	void		(*calibrate_decr)(void);
81
82	void		(*progress)(char *, unsigned short);
83
84	/* Interface for platform error logging */
85	void 		(*log_error)(char *buf, unsigned int err_type, int fatal);
86
87	unsigned char 	(*nvram_read_val)(int addr);
88	void		(*nvram_write_val)(int addr, unsigned char val);
89	ssize_t		(*nvram_write)(char *buf, size_t count, loff_t *index);
90	ssize_t		(*nvram_read)(char *buf, size_t count, loff_t *index);
91	ssize_t		(*nvram_size)(void);
92	void		(*nvram_sync)(void);
93
94	/* Exception handlers */
95	int		(*system_reset_exception)(struct pt_regs *regs);
96	int 		(*machine_check_exception)(struct pt_regs *regs);
97	int		(*handle_hmi_exception)(struct pt_regs *regs);
98
99	/* Early exception handlers called in realmode */
100	int		(*hmi_exception_early)(struct pt_regs *regs);
101	long		(*machine_check_early)(struct pt_regs *regs);
102
103	/* Called during machine check exception to retrive fixup address. */
104	bool		(*mce_check_early_recovery)(struct pt_regs *regs);
105
106	/* Motherboard/chipset features. This is a kind of general purpose
107	 * hook used to control some machine specific features (like reset
108	 * lines, chip power control, etc...).
109	 */
110	long	 	(*feature_call)(unsigned int feature, ...);
111
112	/* Get legacy PCI/IDE interrupt mapping */
113	int		(*pci_get_legacy_ide_irq)(struct pci_dev *dev, int channel);
114
115	/* Get access protection for /dev/mem */
116	pgprot_t	(*phys_mem_access_prot)(struct file *file,
117						unsigned long pfn,
118						unsigned long size,
119						pgprot_t vma_prot);
120
121	/*
122	 * Function for waiting for work with reduced power in idle loop;
123	 * called with interrupts disabled.
124	 */
125	void		(*power_save)(void);
126
127	/* Function to enable performance monitor counters for this
128	   platform, called once per cpu. */
129	void		(*enable_pmcs)(void);
130
131	/* Set DABR for this platform, leave empty for default implementation */
132	int		(*set_dabr)(unsigned long dabr,
133				    unsigned long dabrx);
134
135	/* Set DAWR for this platform, leave empty for default implementation */
136	int		(*set_dawr)(int nr, unsigned long dawr,
137				    unsigned long dawrx);
138
139#ifdef CONFIG_PPC32	/* XXX for now */
140	/* A general init function, called by ppc_init in init/main.c.
141	   May be NULL. */
142	void		(*init)(void);
143
144	void		(*kgdb_map_scc)(void);
145
146	/*
147	 * optional PCI "hooks"
148	 */
149	/* Called at then very end of pcibios_init() */
150	void (*pcibios_after_init)(void);
151
152#endif /* CONFIG_PPC32 */
153
154	/* Called in indirect_* to avoid touching devices */
155	int (*pci_exclude_device)(struct pci_controller *, unsigned char, unsigned char);
156
157	/* Called after PPC generic resource fixup to perform
158	   machine specific fixups */
159	void (*pcibios_fixup_resources)(struct pci_dev *);
160
161	/* Called for each PCI bus in the system when it's probed */
162	void (*pcibios_fixup_bus)(struct pci_bus *);
163
164	/* Called after scan and before resource survey */
165	void (*pcibios_fixup_phb)(struct pci_controller *hose);
166
167	/*
168	 * Called after device has been added to bus and
169	 * before sysfs has been created.
170	 */
171	void (*pcibios_bus_add_device)(struct pci_dev *pdev);
172
173	resource_size_t (*pcibios_default_alignment)(void);
174
175#ifdef CONFIG_PCI_IOV
176	void (*pcibios_fixup_sriov)(struct pci_dev *pdev);
177	resource_size_t (*pcibios_iov_resource_alignment)(struct pci_dev *, int resno);
178	int (*pcibios_sriov_enable)(struct pci_dev *pdev, u16 num_vfs);
179	int (*pcibios_sriov_disable)(struct pci_dev *pdev);
180#endif /* CONFIG_PCI_IOV */
181
182	/* Called to shutdown machine specific hardware not already controlled
183	 * by other drivers.
184	 */
185	void (*machine_shutdown)(void);
186
187#ifdef CONFIG_KEXEC_CORE
188	void (*kexec_cpu_down)(int crash_shutdown, int secondary);
189
190	/* Called to do what every setup is needed on image and the
191	 * reboot code buffer. Returns 0 on success.
192	 * Provide your own (maybe dummy) implementation if your platform
193	 * claims to support kexec.
194	 */
195	int (*machine_kexec_prepare)(struct kimage *image);
196
197	/* Called to perform the _real_ kexec.
198	 * Do NOT allocate memory or fail here. We are past the point of
199	 * no return.
200	 */
201	void (*machine_kexec)(struct kimage *image);
202#endif /* CONFIG_KEXEC_CORE */
203
204#ifdef CONFIG_SUSPEND
205	/* These are called to disable and enable, respectively, IRQs when
206	 * entering a suspend state.  If NULL, then the generic versions
207	 * will be called.  The generic versions disable/enable the
208	 * decrementer along with interrupts.
209	 */
210	void (*suspend_disable_irqs)(void);
211	void (*suspend_enable_irqs)(void);
212#endif
213	int (*suspend_disable_cpu)(void);
214
215#ifdef CONFIG_ARCH_CPU_PROBE_RELEASE
216	ssize_t (*cpu_probe)(const char *, size_t);
217	ssize_t (*cpu_release)(const char *, size_t);
218#endif
219
220#ifdef CONFIG_ARCH_RANDOM
221	int (*get_random_seed)(unsigned long *v);
222#endif
223};
224
225extern void e500_idle(void);
226extern void power4_idle(void);
227extern void ppc6xx_idle(void);
228extern void book3e_idle(void);
229
230/*
231 * ppc_md contains a copy of the machine description structure for the
232 * current platform. machine_id contains the initial address where the
233 * description was found during boot.
234 */
235extern struct machdep_calls ppc_md;
236extern struct machdep_calls *machine_id;
237
238#define __machine_desc __section(".machine.desc")
239
240#define define_machine(name)					\
241	extern struct machdep_calls mach_##name;		\
242	EXPORT_SYMBOL(mach_##name);				\
243	struct machdep_calls mach_##name __machine_desc =
244
245#define machine_is(name) \
246	({ \
247		extern struct machdep_calls mach_##name \
248			__attribute__((weak));		 \
249		machine_id == &mach_##name; \
250	})
251
252extern void probe_machine(void);
253
254#ifdef CONFIG_PPC_PMAC
255/*
256 * Power macintoshes have either a CUDA, PMU or SMU controlling
257 * system reset, power, NVRAM, RTC.
258 */
259typedef enum sys_ctrler_kind {
260	SYS_CTRLER_UNKNOWN = 0,
261	SYS_CTRLER_CUDA = 1,
262	SYS_CTRLER_PMU = 2,
263	SYS_CTRLER_SMU = 3,
264} sys_ctrler_t;
265extern sys_ctrler_t sys_ctrler;
266
267#endif /* CONFIG_PPC_PMAC */
268
269static inline void log_error(char *buf, unsigned int err_type, int fatal)
270{
271	if (ppc_md.log_error)
272		ppc_md.log_error(buf, err_type, fatal);
273}
274
275#define __define_machine_initcall(mach, fn, id) \
276	static int __init __machine_initcall_##mach##_##fn(void) { \
277		if (machine_is(mach)) return fn(); \
278		return 0; \
279	} \
280	__define_initcall(__machine_initcall_##mach##_##fn, id);
281
282#define machine_early_initcall(mach, fn)	__define_machine_initcall(mach, fn, early)
283#define machine_core_initcall(mach, fn)		__define_machine_initcall(mach, fn, 1)
284#define machine_core_initcall_sync(mach, fn)	__define_machine_initcall(mach, fn, 1s)
285#define machine_postcore_initcall(mach, fn)	__define_machine_initcall(mach, fn, 2)
286#define machine_postcore_initcall_sync(mach, fn)	__define_machine_initcall(mach, fn, 2s)
287#define machine_arch_initcall(mach, fn)		__define_machine_initcall(mach, fn, 3)
288#define machine_arch_initcall_sync(mach, fn)	__define_machine_initcall(mach, fn, 3s)
289#define machine_subsys_initcall(mach, fn)	__define_machine_initcall(mach, fn, 4)
290#define machine_subsys_initcall_sync(mach, fn)	__define_machine_initcall(mach, fn, 4s)
291#define machine_fs_initcall(mach, fn)		__define_machine_initcall(mach, fn, 5)
292#define machine_fs_initcall_sync(mach, fn)	__define_machine_initcall(mach, fn, 5s)
293#define machine_rootfs_initcall(mach, fn)	__define_machine_initcall(mach, fn, rootfs)
294#define machine_device_initcall(mach, fn)	__define_machine_initcall(mach, fn, 6)
295#define machine_device_initcall_sync(mach, fn)	__define_machine_initcall(mach, fn, 6s)
296#define machine_late_initcall(mach, fn)		__define_machine_initcall(mach, fn, 7)
297#define machine_late_initcall_sync(mach, fn)	__define_machine_initcall(mach, fn, 7s)
298
299#endif /* __KERNEL__ */
300#endif /* _ASM_POWERPC_MACHDEP_H */
301