[deliverable/linux.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/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 {
	char		*name;
#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);
	unsigned long	(*tce_get)(struct iommu_table *tbl,
				    long index);
	void		(*tce_flush)(struct iommu_table *tbl);
	void		(*iommu_dev_setup)(struct pci_dev *dev);
	void		(*iommu_bus_setup)(struct pci_bus *bus);
#endif /* CONFIG_PPC64 */

	int		(*probe)(void);
	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);
	unsigned int	(*get_irq)(void);
#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		(*pci_irq_fixup)(struct pci_dev *dev);

	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);

	/* 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);

#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 */

#ifdef CONFIG_PCI_MSI
	int (*enable_msi)(struct pci_dev *pdev);
	void (*disable_msi)(struct pci_dev *pdev);
#endif /* CONFIG_PCI_MSI */
};

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

/*
 * ppc_md contains a copy of the machine description structure for the
 * current platform. machine_id contains the initial address where the
 * description was found during boot.
 */
extern struct machdep_calls ppc_md;
extern struct machdep_calls *machine_id;

#define __machine_desc __attribute__ ((__section__ (".machine.desc")))

#define define_machine(name)					\
	extern struct machdep_calls mach_##name;		\
	EXPORT_SYMBOL(mach_##name);				\
	struct machdep_calls mach_##name __machine_desc =

#define machine_is(name) \
	({ \
		extern struct machdep_calls mach_##name \
			__attribute__((weak));		 \
		machine_id == &mach_##name; \
	})

extern void probe_machine(void);

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
1da177e4 LT	12	#include <linux/seq_file.h>
	13	#include <linux/init.h>
	14	#include <linux/dma-mapping.h>
	15
	16	#include <asm/setup.h>
	17
143a1dec PM	18	/* We export this macro for external modules like Alsa to know if
	19	* ppc_md.feature_call is implemented or not
	20	*/
	21	#define CONFIG_PPC_HAS_FEATURE_CALLS
	22
1da177e4 LT	23	struct pt_regs;
	24	struct pci_bus;
	25	struct device_node;
	26	struct iommu_table;
	27	struct rtc_time;
	28	struct file;
3d1229d6 ME	29	#ifdef CONFIG_KEXEC
	30	struct kimage;
	31	#endif
1da177e4 LT	32
	33	#ifdef CONFIG_SMP
	34	struct smp_ops_t {
	35	void (*message_pass)(int target, int msg);
	36	int (*probe)(void);
	37	void (*kick_cpu)(int nr);
	38	void (*setup_cpu)(int nr);
	39	void (*take_timebase)(void);
	40	void (*give_timebase)(void);
	41	int (*cpu_enable)(unsigned int nr);
	42	int (*cpu_disable)(void);
	43	void (*cpu_die)(unsigned int nr);
	44	int (*cpu_bootable)(unsigned int nr);
	45	};
	46	#endif
	47
	48	struct machdep_calls {
e8222502	49	char *name;
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);
5f50867b HM	84	unsigned long (tce_get)(struct iommu_table tbl,
5f50867b HM	85	long index);
1da177e4 LT	86	void (tce_flush)(struct iommu_table tbl);
	87	void (iommu_dev_setup)(struct pci_dev dev);
	88	void (iommu_bus_setup)(struct pci_bus bus);
e8222502	89	#endif /* CONFIG_PPC64 */
1da177e4	90
e8222502	91	int (*probe)(void);
1da177e4 LT	92	void (*setup_arch)(void);
	93	void (*init_early)(void);
	94	/* Optional, may be NULL. */
d8699e65 PM	95	void (show_cpuinfo)(struct seq_file m);
d8699e65 PM	96	void (show_percpuinfo)(struct seq_file m, int i);
1da177e4 LT	97
1da177e4 LT	98	void (*init_IRQ)(void);
35a84c2f	99	unsigned int (*get_irq)(void);
c5e24354 ME	100	#ifdef CONFIG_KEXEC
	101	void (*kexec_cpu_down)(int crash_shutdown, int secondary);
	102	#endif
1da177e4 LT	103
1da177e4 LT	104	/* PCI stuff */
143a1dec	105	/* Called after scanning the bus, before allocating resources */
1da177e4	106	void (*pcibios_fixup)(void);
4267292b	107	int (pci_probe_mode)(struct pci_bus );
f90bb153	108	void (pci_irq_fixup)(struct pci_dev dev);
1da177e4 LT	109
	110	void (restart)(char cmd);
	111	void (*power_off)(void);
	112	void (*halt)(void);
	113	void (panic)(char str);
	114	void (*cpu_die)(void);
	115
143a1dec PM	116	long (time_init)(void); / Optional, may be NULL */
143a1dec PM	117
1da177e4 LT	118	int (set_rtc_time)(struct rtc_time );
1da177e4 LT	119	void (get_rtc_time)(struct rtc_time );
143a1dec PM	120	unsigned long (*get_boot_time)(void);
	121	unsigned char (*rtc_read_val)(int addr);
	122	void (*rtc_write_val)(int addr, unsigned char val);
1da177e4 LT	123
	124	void (*calibrate_decr)(void);
	125
	126	void (progress)(char , unsigned short);
	127
1da177e4 LT	128	/* Interface for platform error logging */
	129	void (log_error)(char buf, unsigned int err_type, int fatal);
	130
35499c01 PM	131	unsigned char (*nvram_read_val)(int addr);
35499c01 PM	132	void (*nvram_write_val)(int addr, unsigned char val);
1da177e4 LT	133	ssize_t (nvram_write)(char buf, size_t count, loff_t *index);
	134	ssize_t (nvram_read)(char buf, size_t count, loff_t *index);
	135	ssize_t (*nvram_size)(void);
143a1dec	136	void (*nvram_sync)(void);
1da177e4 LT	137
1da177e4 LT	138	/* Exception handlers */
c902be71	139	int (system_reset_exception)(struct pt_regs regs);
1da177e4 LT	140	int (machine_check_exception)(struct pt_regs regs);
	141
	142	/* Motherboard/chipset features. This is a kind of general purpose
	143	* hook used to control some machine specific features (like reset
	144	* lines, chip power control, etc...).
	145	*/
	146	long (*feature_call)(unsigned int feature, ...);
	147
	148	/* Check availability of legacy devices like i8042 */
	149	int (*check_legacy_ioport)(unsigned int baseport);
	150
	151	/* Get legacy PCI/IDE interrupt mapping */
	152	int (pci_get_legacy_ide_irq)(struct pci_dev dev, int channel);
	153
	154	/* Get access protection for /dev/mem */
	155	pgprot_t (phys_mem_access_prot)(struct file file,
8b150478	156	unsigned long pfn,
1da177e4 LT	157	unsigned long size,
	158	pgprot_t vma_prot);
	159
fd899c0c	160	/* Idle loop for this platform, leave empty for default idle loop */
143a1dec	161	void (*idle_loop)(void);
180a3362	162
a0652fc9 PM	163	/*
	164	* Function for waiting for work with reduced power in idle loop;
	165	* called with interrupts disabled.
	166	*/
	167	void (*power_save)(void);
	168
143a1dec PM	169	/* Function to enable performance monitor counters for this
143a1dec PM	170	platform, called once per cpu. */
180a3362	171	void (*enable_pmcs)(void);
143a1dec	172
76032de8 ME	173	/* Set DABR for this platform, leave empty for default implemenation */
	174	int (*set_dabr)(unsigned long dabr);
	175
143a1dec	176	#ifdef CONFIG_PPC32 /* XXX for now */
143a1dec PM	177	/* A general init function, called by ppc_init in init/main.c.
	178	May be NULL. */
	179	void (*init)(void);
	180
143a1dec PM	181	void (*setup_io_mappings)(void);
	182
	183	void (*early_serial_map)(void);
	184	void (*kgdb_map_scc)(void);
	185
143a1dec PM	186	/*
	187	* optional PCI "hooks"
	188	*/
	189
	190	/* Called after PPC generic resource fixup to perform
	191	machine specific fixups */
	192	void (pcibios_fixup_resources)(struct pci_dev );
	193
	194	/* Called for each PCI bus in the system when it's probed */
	195	void (pcibios_fixup_bus)(struct pci_bus );
	196
	197	/* Called when pci_enable_device() is called (initial=0) or
	198	* when a device with no assigned resource is found (initial=1).
	199	* Returns 0 to allow assignment/enabling of the device. */
	200	int (pcibios_enable_device_hook)(struct pci_dev , int initial);
	201
143a1dec PM	202	/* Called in indirect_* to avoid touching devices */
	203	int (*pci_exclude_device)(unsigned char, unsigned char);
	204
	205	/* Called at then very end of pcibios_init() */
	206	void (*pcibios_after_init)(void);
	207
3d1229d6	208	#endif /* CONFIG_PPC32 */
143a1dec	209
143a1dec PM	210	/* Called to shutdown machine specific hardware not already controlled
143a1dec PM	211	* by other drivers.
143a1dec PM	212	*/
	213	void (*machine_shutdown)(void);
	214
3d1229d6	215	#ifdef CONFIG_KEXEC
143a1dec PM	216	/* Called to do the minimal shutdown needed to run a kexec'd kernel
	217	* to run successfully.
	218	* XXX Should we move this one out of kexec scope?
	219	*/
cd0ca2ce	220	void (machine_crash_shutdown)(struct pt_regs regs);
143a1dec PM	221
	222	/* Called to do what every setup is needed on image and the
	223	* reboot code buffer. Returns 0 on success.
	224	* Provide your own (maybe dummy) implementation if your platform
	225	* claims to support kexec.
	226	*/
	227	int (machine_kexec_prepare)(struct kimage image);
	228
	229	/* Called to handle any machine specific cleanup on image */
	230	void (machine_kexec_cleanup)(struct kimage image);
	231
	232	/* Called to perform the _real_ kexec.
	233	* Do NOT allocate memory or fail here. We are past the point of
	234	* no return.
	235	*/
	236	void (machine_kexec)(struct kimage image);
	237	#endif /* CONFIG_KEXEC */
204face4 JM	238
	239	#ifdef CONFIG_PCI_MSI
	240	int (enable_msi)(struct pci_dev pdev);
	241	void (disable_msi)(struct pci_dev pdev);
	242	#endif /* CONFIG_PCI_MSI */
1da177e4 LT	243	};
1da177e4 LT	244
a0652fc9 PM	245	extern void power4_idle(void);
a0652fc9 PM	246	extern void ppc6xx_idle(void);
fd899c0c	247
e8222502 BH	248	/*
	249	* ppc_md contains a copy of the machine description structure for the
	250	* current platform. machine_id contains the initial address where the
	251	* description was found during boot.
	252	*/
1da177e4	253	extern struct machdep_calls ppc_md;
e8222502 BH	254	extern struct machdep_calls *machine_id;
	255
	256	#define __machine_desc __attribute__ ((__section__ (".machine.desc")))
	257
d0e15bed PM	258	#define define_machine(name) \
	259	extern struct machdep_calls mach_##name; \
	260	EXPORT_SYMBOL(mach_##name); \
	261	struct machdep_calls mach_##name __machine_desc =
	262
e8222502 BH	263	#define machine_is(name) \
	264	({ \
	265	extern struct machdep_calls mach_##name \
	266	__attribute__((weak)); \
	267	machine_id == &mach_##name; \
	268	})
	269
	270	extern void probe_machine(void);
	271
1da177e4 LT	272	extern char cmd_line[COMMAND_LINE_SIZE];
	273
	274	#ifdef CONFIG_PPC_PMAC
	275	/*
	276	* Power macintoshes have either a CUDA, PMU or SMU controlling
	277	* system reset, power, NVRAM, RTC.
	278	*/
	279	typedef enum sys_ctrler_kind {
	280	SYS_CTRLER_UNKNOWN = 0,
	281	SYS_CTRLER_CUDA = 1,
	282	SYS_CTRLER_PMU = 2,
	283	SYS_CTRLER_SMU = 3,
	284	} sys_ctrler_t;
	285	extern sys_ctrler_t sys_ctrler;
	286
	287	#endif /* CONFIG_PPC_PMAC */
	288
143a1dec PM	289	extern void setup_pci_ptrs(void);
	290
	291	#ifdef CONFIG_SMP
	292	/* Poor default implementations */
	293	extern void __devinit smp_generic_give_timebase(void);
	294	extern void __devinit smp_generic_take_timebase(void);
	295	#endif /* CONFIG_SMP */
1da177e4 LT	296
	297
	298	/* Functions to produce codes on the leds.
	299	* The SRC code should be unique for the message category and should
	300	* be limited to the lower 24 bits (the upper 8 are set by these funcs),
	301	* and (for boot & dump) should be sorted numerically in the order
	302	* the events occur.
	303	*/
	304	/* Print a boot progress message. */
	305	void ppc64_boot_msg(unsigned int src, const char *msg);
	306	/* Print a termination message (print only -- does not stop the kernel) */
	307	void ppc64_terminate_msg(unsigned int src, const char *msg);
1da177e4 LT	308
	309	static inline void log_error(char *buf, unsigned int err_type, int fatal)
	310	{
	311	if (ppc_md.log_error)
	312	ppc_md.log_error(buf, err_type, fatal);
	313	}
	314
1da177e4	315	#endif /* __KERNEL__ */
b41fc4f8	316	#endif /* _ASM_POWERPC_MACHDEP_H */