arch/powerpc/include/asm/machdep.h

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