[mirror_ubuntu-zesty-kernel.git] / include / asm-powerpc / machdep.h

#ifndef _ASM_POWERPC_MACHDEP_H
#define _ASM_POWERPC_MACHDEP_H
#ifdef __KERNEL__

/*
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version
 * 2 of the License, or (at your option) any later version.
 */

#include <linux/config.h>
#include <linux/seq_file.h>
#include <linux/init.h>
#include <linux/dma-mapping.h>

#include <asm/setup.h>

/* We export this macro for external modules like Alsa to know if
 * ppc_md.feature_call is implemented or not
 */
#define CONFIG_PPC_HAS_FEATURE_CALLS

struct pt_regs;
struct pci_bus;	
struct device_node;
struct iommu_table;
struct rtc_time;
struct file;
#ifdef CONFIG_KEXEC
struct kimage;
#endif

#ifdef CONFIG_SMP
struct smp_ops_t {
	void  (*message_pass)(int target, int msg);
	int   (*probe)(void);
	void  (*kick_cpu)(int nr);
	void  (*setup_cpu)(int nr);
	void  (*take_timebase)(void);
	void  (*give_timebase)(void);
	int   (*cpu_enable)(unsigned int nr);
	int   (*cpu_disable)(void);
	void  (*cpu_die)(unsigned int nr);
	int   (*cpu_bootable)(unsigned int nr);
};
#endif

struct machdep_calls {
#ifdef CONFIG_PPC64
	void            (*hpte_invalidate)(unsigned long slot,
					   unsigned long va,
					   int psize,
					   int local);
	long		(*hpte_updatepp)(unsigned long slot, 
					 unsigned long newpp, 
					 unsigned long va,
					 int pize,
					 int local);
	void            (*hpte_updateboltedpp)(unsigned long newpp, 
					       unsigned long ea,
					       int psize);
	long		(*hpte_insert)(unsigned long hpte_group,
				       unsigned long va,
				       unsigned long prpn,
				       unsigned long rflags,
				       unsigned long vflags,
				       int psize);
	long		(*hpte_remove)(unsigned long hpte_group);
	void		(*flush_hash_range)(unsigned long number, int local);

	/* special for kexec, to be called in real mode, linar mapping is
	 * destroyed as well */
	void		(*hpte_clear_all)(void);

	void		(*tce_build)(struct iommu_table * tbl,
				     long index,
				     long npages,
				     unsigned long uaddr,
				     enum dma_data_direction direction);
	void		(*tce_free)(struct iommu_table *tbl,
				    long index,
				    long npages);
	void		(*tce_flush)(struct iommu_table *tbl);
	void		(*iommu_dev_setup)(struct pci_dev *dev);
	void		(*iommu_bus_setup)(struct pci_bus *bus);
	void		(*irq_bus_setup)(struct pci_bus *bus);
#endif

	int		(*probe)(int platform);
	void		(*setup_arch)(void);
	void		(*init_early)(void);
	/* Optional, may be NULL. */
	void		(*show_cpuinfo)(struct seq_file *m);
	void		(*show_percpuinfo)(struct seq_file *m, int i);

	void		(*init_IRQ)(void);
	int		(*get_irq)(struct pt_regs *);
#ifdef CONFIG_KEXEC
	void		(*kexec_cpu_down)(int crash_shutdown, int secondary);
#endif

	/* PCI stuff */
	/* Called after scanning the bus, before allocating resources */
	void		(*pcibios_fixup)(void);
	int		(*pci_probe_mode)(struct pci_bus *);

	void		(*restart)(char *cmd);
	void		(*power_off)(void);
	void		(*halt)(void);
	void		(*panic)(char *str);
	void		(*cpu_die)(void);

	long		(*time_init)(void); /* Optional, may be NULL */

	int		(*set_rtc_time)(struct rtc_time *);
	void		(*get_rtc_time)(struct rtc_time *);
	unsigned long	(*get_boot_time)(void);
	unsigned char 	(*rtc_read_val)(int addr);
	void		(*rtc_write_val)(int addr, unsigned char val);

	void		(*calibrate_decr)(void);

	void		(*progress)(char *, unsigned short);

	/* Interface for platform error logging */
	void 		(*log_error)(char *buf, unsigned int err_type, int fatal);

	unsigned char 	(*nvram_read_val)(int addr);
	void		(*nvram_write_val)(int addr, unsigned char val);
	ssize_t		(*nvram_write)(char *buf, size_t count, loff_t *index);
	ssize_t		(*nvram_read)(char *buf, size_t count, loff_t *index);	
	ssize_t		(*nvram_size)(void);		
	void		(*nvram_sync)(void);

	/* Exception handlers */
	int		(*system_reset_exception)(struct pt_regs *regs);
	int 		(*machine_check_exception)(struct pt_regs *regs);

	/* Motherboard/chipset features. This is a kind of general purpose
	 * hook used to control some machine specific features (like reset
	 * lines, chip power control, etc...).
	 */
	long	 	(*feature_call)(unsigned int feature, ...);

	/* Check availability of legacy devices like i8042 */
	int 		(*check_legacy_ioport)(unsigned int baseport);

	/* Get legacy PCI/IDE interrupt mapping */ 
	int		(*pci_get_legacy_ide_irq)(struct pci_dev *dev, int channel);
	
	/* Get access protection for /dev/mem */
	pgprot_t	(*phys_mem_access_prot)(struct file *file,
						unsigned long pfn,
						unsigned long size,
						pgprot_t vma_prot);

	/* Idle loop for this platform, leave empty for default idle loop */
	void		(*idle_loop)(void);

	/*
	 * Function for waiting for work with reduced power in idle loop;
	 * called with interrupts disabled.
	 */
	void		(*power_save)(void);

	/* Function to enable performance monitor counters for this
	   platform, called once per cpu. */
	void		(*enable_pmcs)(void);

	/* Set DABR for this platform, leave empty for default implemenation */
	int		(*set_dabr)(unsigned long dabr);

#ifdef CONFIG_PPC32	/* XXX for now */
	/* A general init function, called by ppc_init in init/main.c.
	   May be NULL. */
	void		(*init)(void);

	void		(*setup_io_mappings)(void);

	void		(*early_serial_map)(void);
	void		(*kgdb_map_scc)(void);

	/*
	 * optional PCI "hooks"
	 */

	/* Called after PPC generic resource fixup to perform
	   machine specific fixups */
	void (*pcibios_fixup_resources)(struct pci_dev *);

	/* Called for each PCI bus in the system when it's probed */
	void (*pcibios_fixup_bus)(struct pci_bus *);

	/* Called when pci_enable_device() is called (initial=0) or
	 * when a device with no assigned resource is found (initial=1).
	 * Returns 0 to allow assignment/enabling of the device. */
	int  (*pcibios_enable_device_hook)(struct pci_dev *, int initial);

	/* For interrupt routing */
	unsigned char (*pci_swizzle)(struct pci_dev *, unsigned char *);
	int (*pci_map_irq)(struct pci_dev *, unsigned char, unsigned char);

	/* Called in indirect_* to avoid touching devices */
	int (*pci_exclude_device)(unsigned char, unsigned char);

	/* Called at then very end of pcibios_init() */
	void (*pcibios_after_init)(void);

	/* this is for modules, since _machine can be a define -- Cort */
	int ppc_machine;
#endif /* CONFIG_PPC32 */

	/* Called to shutdown machine specific hardware not already controlled
	 * by other drivers.
	 */
	void (*machine_shutdown)(void);

#ifdef CONFIG_KEXEC
	/* Called to do the minimal shutdown needed to run a kexec'd kernel
	 * to run successfully.
	 * XXX Should we move this one out of kexec scope?
	 */
	void (*machine_crash_shutdown)(struct pt_regs *regs);

	/* Called to do what every setup is needed on image and the
	 * reboot code buffer. Returns 0 on success.
	 * Provide your own (maybe dummy) implementation if your platform
	 * claims to support kexec.
	 */
	int (*machine_kexec_prepare)(struct kimage *image);

	/* Called to handle any machine specific cleanup on image */
	void (*machine_kexec_cleanup)(struct kimage *image);

	/* Called to perform the _real_ kexec.
	 * Do NOT allocate memory or fail here. We are past the point of
	 * no return.
	 */
	void (*machine_kexec)(struct kimage *image);
#endif /* CONFIG_KEXEC */
};

extern void power4_idle(void);
extern void ppc6xx_idle(void);

extern struct machdep_calls ppc_md;
extern char cmd_line[COMMAND_LINE_SIZE];

#ifdef CONFIG_PPC_PMAC
/*
 * Power macintoshes have either a CUDA, PMU or SMU controlling
 * system reset, power, NVRAM, RTC.
 */
typedef enum sys_ctrler_kind {
	SYS_CTRLER_UNKNOWN = 0,
	SYS_CTRLER_CUDA = 1,
	SYS_CTRLER_PMU = 2,
	SYS_CTRLER_SMU = 3,
} sys_ctrler_t;
extern sys_ctrler_t sys_ctrler;

#endif /* CONFIG_PPC_PMAC */

extern void setup_pci_ptrs(void);

#ifdef CONFIG_SMP
/* Poor default implementations */
extern void __devinit smp_generic_give_timebase(void);
extern void __devinit smp_generic_take_timebase(void);
#endif /* CONFIG_SMP */


/* Functions to produce codes on the leds.
 * The SRC code should be unique for the message category and should
 * be limited to the lower 24 bits (the upper 8 are set by these funcs),
 * and (for boot & dump) should be sorted numerically in the order
 * the events occur.
 */
/* Print a boot progress message. */
void ppc64_boot_msg(unsigned int src, const char *msg);
/* Print a termination message (print only -- does not stop the kernel) */
void ppc64_terminate_msg(unsigned int src, const char *msg);

static inline void log_error(char *buf, unsigned int err_type, int fatal)
{
	if (ppc_md.log_error)
		ppc_md.log_error(buf, err_type, fatal);
}

#endif /* __KERNEL__ */
#endif /* _ASM_POWERPC_MACHDEP_H */
Commit	Line	Data
b41fc4f8 PM	1	#ifndef _ASM_POWERPC_MACHDEP_H
b41fc4f8 PM	2	#define _ASM_POWERPC_MACHDEP_H
143a1dec	3	#ifdef __KERNEL__
1da177e4 LT	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/config.h>
	13	#include <linux/seq_file.h>
	14	#include <linux/init.h>
	15	#include <linux/dma-mapping.h>
	16
	17	#include <asm/setup.h>
	18
143a1dec PM	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
1da177e4 LT	24	struct pt_regs;
	25	struct pci_bus;
	26	struct device_node;
	27	struct iommu_table;
	28	struct rtc_time;
	29	struct file;
3d1229d6 ME	30	#ifdef CONFIG_KEXEC
	31	struct kimage;
	32	#endif
1da177e4 LT	33
	34	#ifdef CONFIG_SMP
	35	struct smp_ops_t {
	36	void (*message_pass)(int target, int msg);
	37	int (*probe)(void);
	38	void (*kick_cpu)(int nr);
	39	void (*setup_cpu)(int nr);
	40	void (*take_timebase)(void);
	41	void (*give_timebase)(void);
	42	int (*cpu_enable)(unsigned int nr);
	43	int (*cpu_disable)(void);
	44	void (*cpu_die)(unsigned int nr);
	45	int (*cpu_bootable)(unsigned int nr);
	46	};
	47	#endif
	48
	49	struct machdep_calls {
143a1dec	50	#ifdef CONFIG_PPC64
1da177e4 LT	51	void (*hpte_invalidate)(unsigned long slot,
1da177e4 LT	52	unsigned long va,
3c726f8d	53	int psize,
1da177e4 LT	54	int local);
	55	long (*hpte_updatepp)(unsigned long slot,
	56	unsigned long newpp,
	57	unsigned long va,
3c726f8d	58	int pize,
1da177e4 LT	59	int local);
1da177e4 LT	60	void (*hpte_updateboltedpp)(unsigned long newpp,
3c726f8d BH	61	unsigned long ea,
3c726f8d BH	62	int psize);
1da177e4 LT	63	long (*hpte_insert)(unsigned long hpte_group,
	64	unsigned long va,
	65	unsigned long prpn,
3c726f8d	66	unsigned long rflags,
96e28449	67	unsigned long vflags,
3c726f8d	68	int psize);
1da177e4	69	long (*hpte_remove)(unsigned long hpte_group);
61b1a942 BH	70	void (*flush_hash_range)(unsigned long number, int local);
61b1a942 BH	71
1da177e4 LT	72	/* special for kexec, to be called in real mode, linar mapping is
	73	* destroyed as well */
	74	void (*hpte_clear_all)(void);
	75
	76	void (tce_build)(struct iommu_table tbl,
	77	long index,
	78	long npages,
	79	unsigned long uaddr,
	80	enum dma_data_direction direction);
	81	void (tce_free)(struct iommu_table tbl,
	82	long index,
	83	long npages);
	84	void (tce_flush)(struct iommu_table tbl);
	85	void (iommu_dev_setup)(struct pci_dev dev);
	86	void (iommu_bus_setup)(struct pci_bus bus);
dad32bbf	87	void (irq_bus_setup)(struct pci_bus bus);
143a1dec	88	#endif
1da177e4 LT	89
	90	int (*probe)(int platform);
	91	void (*setup_arch)(void);
	92	void (*init_early)(void);
	93	/* Optional, may be NULL. */
d8699e65 PM	94	void (show_cpuinfo)(struct seq_file m);
d8699e65 PM	95	void (show_percpuinfo)(struct seq_file m, int i);
1da177e4 LT	96
	97	void (*init_IRQ)(void);
	98	int (get_irq)(struct pt_regs );
c5e24354 ME	99	#ifdef CONFIG_KEXEC
	100	void (*kexec_cpu_down)(int crash_shutdown, int secondary);
	101	#endif
1da177e4 LT	102
1da177e4 LT	103	/* PCI stuff */
143a1dec	104	/* Called after scanning the bus, before allocating resources */
1da177e4	105	void (*pcibios_fixup)(void);
4267292b	106	int (pci_probe_mode)(struct pci_bus );
1da177e4 LT	107
	108	void (restart)(char cmd);
	109	void (*power_off)(void);
	110	void (*halt)(void);
	111	void (panic)(char str);
	112	void (*cpu_die)(void);
	113
143a1dec PM	114	long (time_init)(void); / Optional, may be NULL */
143a1dec PM	115
1da177e4 LT	116	int (set_rtc_time)(struct rtc_time );
1da177e4 LT	117	void (get_rtc_time)(struct rtc_time );
143a1dec PM	118	unsigned long (*get_boot_time)(void);
	119	unsigned char (*rtc_read_val)(int addr);
	120	void (*rtc_write_val)(int addr, unsigned char val);
1da177e4 LT	121
	122	void (*calibrate_decr)(void);
	123
	124	void (progress)(char , unsigned short);
	125
1da177e4 LT	126	/* Interface for platform error logging */
	127	void (log_error)(char buf, unsigned int err_type, int fatal);
	128
35499c01 PM	129	unsigned char (*nvram_read_val)(int addr);
35499c01 PM	130	void (*nvram_write_val)(int addr, unsigned char val);
1da177e4 LT	131	ssize_t (nvram_write)(char buf, size_t count, loff_t *index);
	132	ssize_t (nvram_read)(char buf, size_t count, loff_t *index);
	133	ssize_t (*nvram_size)(void);
143a1dec	134	void (*nvram_sync)(void);
1da177e4 LT	135
1da177e4 LT	136	/* Exception handlers */
c902be71	137	int (system_reset_exception)(struct pt_regs regs);
1da177e4 LT	138	int (machine_check_exception)(struct pt_regs regs);
	139
	140	/* Motherboard/chipset features. This is a kind of general purpose
	141	* hook used to control some machine specific features (like reset
	142	* lines, chip power control, etc...).
	143	*/
	144	long (*feature_call)(unsigned int feature, ...);
	145
	146	/* Check availability of legacy devices like i8042 */
	147	int (*check_legacy_ioport)(unsigned int baseport);
	148
	149	/* Get legacy PCI/IDE interrupt mapping */
	150	int (pci_get_legacy_ide_irq)(struct pci_dev dev, int channel);
	151
	152	/* Get access protection for /dev/mem */
	153	pgprot_t (phys_mem_access_prot)(struct file file,
8b150478	154	unsigned long pfn,
1da177e4 LT	155	unsigned long size,
	156	pgprot_t vma_prot);
	157
fd899c0c	158	/* Idle loop for this platform, leave empty for default idle loop */
143a1dec	159	void (*idle_loop)(void);
180a3362	160
a0652fc9 PM	161	/*
	162	* Function for waiting for work with reduced power in idle loop;
	163	* called with interrupts disabled.
	164	*/
	165	void (*power_save)(void);
	166
143a1dec PM	167	/* Function to enable performance monitor counters for this
143a1dec PM	168	platform, called once per cpu. */
180a3362	169	void (*enable_pmcs)(void);
143a1dec	170
76032de8 ME	171	/* Set DABR for this platform, leave empty for default implemenation */
	172	int (*set_dabr)(unsigned long dabr);
	173
143a1dec	174	#ifdef CONFIG_PPC32 /* XXX for now */
143a1dec PM	175	/* A general init function, called by ppc_init in init/main.c.
	176	May be NULL. */
	177	void (*init)(void);
	178
143a1dec PM	179	void (*setup_io_mappings)(void);
	180
	181	void (*early_serial_map)(void);
	182	void (*kgdb_map_scc)(void);
	183
143a1dec PM	184	/*
	185	* optional PCI "hooks"
	186	*/
	187
	188	/* Called after PPC generic resource fixup to perform
	189	machine specific fixups */
	190	void (pcibios_fixup_resources)(struct pci_dev );
	191
	192	/* Called for each PCI bus in the system when it's probed */
	193	void (pcibios_fixup_bus)(struct pci_bus );
	194
	195	/* Called when pci_enable_device() is called (initial=0) or
	196	* when a device with no assigned resource is found (initial=1).
	197	* Returns 0 to allow assignment/enabling of the device. */
	198	int (pcibios_enable_device_hook)(struct pci_dev , int initial);
	199
	200	/* For interrupt routing */
	201	unsigned char (pci_swizzle)(struct pci_dev , unsigned char *);
	202	int (pci_map_irq)(struct pci_dev , unsigned char, unsigned char);
	203
	204	/* Called in indirect_* to avoid touching devices */
	205	int (*pci_exclude_device)(unsigned char, unsigned char);
	206
	207	/* Called at then very end of pcibios_init() */
	208	void (*pcibios_after_init)(void);
	209
	210	/* this is for modules, since _machine can be a define -- Cort */
	211	int ppc_machine;
3d1229d6	212	#endif /* CONFIG_PPC32 */
143a1dec	213
143a1dec PM	214	/* Called to shutdown machine specific hardware not already controlled
143a1dec PM	215	* by other drivers.
143a1dec PM	216	*/
	217	void (*machine_shutdown)(void);
	218
3d1229d6	219	#ifdef CONFIG_KEXEC
143a1dec PM	220	/* Called to do the minimal shutdown needed to run a kexec'd kernel
	221	* to run successfully.
	222	* XXX Should we move this one out of kexec scope?
	223	*/
cd0ca2ce	224	void (machine_crash_shutdown)(struct pt_regs regs);
143a1dec PM	225
	226	/* Called to do what every setup is needed on image and the
	227	* reboot code buffer. Returns 0 on success.
	228	* Provide your own (maybe dummy) implementation if your platform
	229	* claims to support kexec.
	230	*/
	231	int (machine_kexec_prepare)(struct kimage image);
	232
	233	/* Called to handle any machine specific cleanup on image */
	234	void (machine_kexec_cleanup)(struct kimage image);
	235
	236	/* Called to perform the _real_ kexec.
	237	* Do NOT allocate memory or fail here. We are past the point of
	238	* no return.
	239	*/
	240	void (machine_kexec)(struct kimage image);
	241	#endif /* CONFIG_KEXEC */
1da177e4 LT	242	};
1da177e4 LT	243
a0652fc9 PM	244	extern void power4_idle(void);
a0652fc9 PM	245	extern void ppc6xx_idle(void);
fd899c0c	246
1da177e4 LT	247	extern struct machdep_calls ppc_md;
	248	extern char cmd_line[COMMAND_LINE_SIZE];
	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
143a1dec PM	265	extern void setup_pci_ptrs(void);
	266
	267	#ifdef CONFIG_SMP
	268	/* Poor default implementations */
	269	extern void __devinit smp_generic_give_timebase(void);
	270	extern void __devinit smp_generic_take_timebase(void);
	271	#endif /* CONFIG_SMP */
1da177e4 LT	272
	273
	274	/* Functions to produce codes on the leds.
	275	* The SRC code should be unique for the message category and should
	276	* be limited to the lower 24 bits (the upper 8 are set by these funcs),
	277	* and (for boot & dump) should be sorted numerically in the order
	278	* the events occur.
	279	*/
	280	/* Print a boot progress message. */
	281	void ppc64_boot_msg(unsigned int src, const char *msg);
	282	/* Print a termination message (print only -- does not stop the kernel) */
	283	void ppc64_terminate_msg(unsigned int src, const char *msg);
1da177e4 LT	284
	285	static inline void log_error(char *buf, unsigned int err_type, int fatal)
	286	{
	287	if (ppc_md.log_error)
	288	ppc_md.log_error(buf, err_type, fatal);
	289	}
	290
1da177e4	291	#endif /* __KERNEL__ */
b41fc4f8	292	#endif /* _ASM_POWERPC_MACHDEP_H */