[deliverable/linux.git] / include / asm-powerpc / prom.h

#ifndef _POWERPC_PROM_H
#define _POWERPC_PROM_H
#ifdef __KERNEL__

/*
 * Definitions for talking to the Open Firmware PROM on
 * Power Macintosh computers.
 *
 * Copyright (C) 1996-2005 Paul Mackerras.
 *
 * Updates for PPC64 by Peter Bergner & David Engebretsen, IBM Corp.
 *
 * 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/types.h>
#include <linux/proc_fs.h>
#include <asm/atomic.h>

/* Definitions used by the flattened device tree */
#define OF_DT_HEADER		0xd00dfeed	/* marker */
#define OF_DT_BEGIN_NODE	0x1		/* Start of node, full name */
#define OF_DT_END_NODE		0x2		/* End node */
#define OF_DT_PROP		0x3		/* Property: name off, size,
						 * content */
#define OF_DT_NOP		0x4		/* nop */
#define OF_DT_END		0x9

#define OF_DT_VERSION		0x10

/*
 * This is what gets passed to the kernel by prom_init or kexec
 *
 * The dt struct contains the device tree structure, full pathes and
 * property contents. The dt strings contain a separate block with just
 * the strings for the property names, and is fully page aligned and
 * self contained in a page, so that it can be kept around by the kernel,
 * each property name appears only once in this page (cheap compression)
 *
 * the mem_rsvmap contains a map of reserved ranges of physical memory,
 * passing it here instead of in the device-tree itself greatly simplifies
 * the job of everybody. It's just a list of u64 pairs (base/size) that
 * ends when size is 0
 */
struct boot_param_header
{
	u32	magic;			/* magic word OF_DT_HEADER */
	u32	totalsize;		/* total size of DT block */
	u32	off_dt_struct;		/* offset to structure */
	u32	off_dt_strings;		/* offset to strings */
	u32	off_mem_rsvmap;		/* offset to memory reserve map */
	u32	version;		/* format version */
	u32	last_comp_version;	/* last compatible version */
	/* version 2 fields below */
	u32	boot_cpuid_phys;	/* Physical CPU id we're booting on */
	/* version 3 fields below */
	u32	dt_strings_size;	/* size of the DT strings block */
};


typedef u32 phandle;
typedef u32 ihandle;

struct interrupt_info {
	int	line;
	int	sense;		/* +ve/-ve logic, edge or level, etc. */
};

struct property {
	char	*name;
	int	length;
	unsigned char *value;
	struct property *next;
};

struct device_node {
	char	*name;
	char	*type;
	phandle	node;
	phandle linux_phandle;
	int	n_intrs;
	struct	interrupt_info *intrs;
	char	*full_name;

	struct	property *properties;
	struct  property *deadprops; /* removed properties */
	struct	device_node *parent;
	struct	device_node *child;
	struct	device_node *sibling;
	struct	device_node *next;	/* next device of same type */
	struct	device_node *allnext;	/* next in list of all nodes */
	struct  proc_dir_entry *pde;	/* this node's proc directory */
	struct  kref kref;
	unsigned long _flags;
	void	*data;
};

extern struct device_node *of_chosen;

/* flag descriptions */
#define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */

#define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
#define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)

#define HAVE_ARCH_DEVTREE_FIXUPS

static inline void set_node_proc_entry(struct device_node *dn, struct proc_dir_entry *de)
{
	dn->pde = de;
}


/* OBSOLETE: Old style node lookup */
extern struct device_node *find_devices(const char *name);
extern struct device_node *find_type_devices(const char *type);
extern struct device_node *find_path_device(const char *path);
extern struct device_node *find_compatible_devices(const char *type,
						   const char *compat);
extern struct device_node *find_all_nodes(void);

/* New style node lookup */
extern struct device_node *of_find_node_by_name(struct device_node *from,
	const char *name);
#define for_each_node_by_name(dn, name) \
	for (dn = of_find_node_by_name(NULL, name); dn; \
	     dn = of_find_node_by_name(dn, name))
extern struct device_node *of_find_node_by_type(struct device_node *from,
	const char *type);
#define for_each_node_by_type(dn, type) \
	for (dn = of_find_node_by_type(NULL, type); dn; \
	     dn = of_find_node_by_type(dn, type))
extern struct device_node *of_find_compatible_node(struct device_node *from,
	const char *type, const char *compat);
extern struct device_node *of_find_node_by_path(const char *path);
extern struct device_node *of_find_node_by_phandle(phandle handle);
extern struct device_node *of_find_all_nodes(struct device_node *prev);
extern struct device_node *of_get_parent(const struct device_node *node);
extern struct device_node *of_get_next_child(const struct device_node *node,
					     struct device_node *prev);
extern struct property *of_find_property(struct device_node *np,
					 const char *name,
					 int *lenp);
extern struct device_node *of_node_get(struct device_node *node);
extern void of_node_put(struct device_node *node);

/* For scanning the flat device-tree at boot time */
extern int __init of_scan_flat_dt(int (*it)(unsigned long node,
					    const char *uname, int depth,
					    void *data),
				  void *data);
extern void* __init of_get_flat_dt_prop(unsigned long node, const char *name,
					unsigned long *size);
extern int __init of_flat_dt_is_compatible(unsigned long node, const char *name);
extern unsigned long __init of_get_flat_dt_root(void);

/* For updating the device tree at runtime */
extern void of_attach_node(struct device_node *);
extern void of_detach_node(const struct device_node *);

/* Other Prototypes */
extern void finish_device_tree(void);
extern void unflatten_device_tree(void);
extern void early_init_devtree(void *);
extern int device_is_compatible(struct device_node *device, const char *);
extern int machine_is_compatible(const char *compat);
extern void *get_property(struct device_node *node, const char *name,
		int *lenp);
extern void print_properties(struct device_node *node);
extern int prom_n_addr_cells(struct device_node* np);
extern int prom_n_size_cells(struct device_node* np);
extern int prom_n_intr_cells(struct device_node* np);
extern void prom_get_irq_senses(unsigned char *senses, int off, int max);
extern int prom_add_property(struct device_node* np, struct property* prop);
extern int prom_remove_property(struct device_node *np, struct property *prop);
extern int prom_update_property(struct device_node *np,
				struct property *newprop,
				struct property *oldprop);

#ifdef CONFIG_PPC32
/*
 * PCI <-> OF matching functions
 * (XXX should these be here?)
 */
struct pci_bus;
struct pci_dev;
extern int pci_device_from_OF_node(struct device_node *node,
				   u8* bus, u8* devfn);
extern struct device_node* pci_busdev_to_OF_node(struct pci_bus *, int);
extern struct device_node* pci_device_to_OF_node(struct pci_dev *);
extern void pci_create_OF_bus_map(void);
#endif

extern struct resource *request_OF_resource(struct device_node* node,
				int index, const char* name_postfix);
extern int release_OF_resource(struct device_node* node, int index);


/*
 * OF address retreival & translation
 */


/* Translate an OF address block into a CPU physical address
 */
#define OF_BAD_ADDR	((u64)-1)
extern u64 of_translate_address(struct device_node *np, u32 *addr);

/* Extract an address from a device, returns the region size and
 * the address space flags too. The PCI version uses a BAR number
 * instead of an absolute index
 */
extern u32 *of_get_address(struct device_node *dev, int index,
			   u64 *size, unsigned int *flags);
extern u32 *of_get_pci_address(struct device_node *dev, int bar_no,
			       u64 *size, unsigned int *flags);

/* Get an address as a resource. Note that if your address is
 * a PIO address, the conversion will fail if the physical address
 * can't be internally converted to an IO token with
 * pci_address_to_pio(), that is because it's either called to early
 * or it can't be matched to any host bridge IO space
 */
extern int of_address_to_resource(struct device_node *dev, int index,
				  struct resource *r);
extern int of_pci_address_to_resource(struct device_node *dev, int bar,
				      struct resource *r);

/* Parse the ibm,dma-window property of an OF node into the busno, phys and
 * size parameters.
 */
void of_parse_dma_window(struct device_node *dn, unsigned char *dma_window_prop,
		unsigned long *busno, unsigned long *phys, unsigned long *size);

extern void kdump_move_device_tree(void);

/* CPU OF node matching */
struct device_node *of_get_cpu_node(int cpu, unsigned int *thread);

#endif /* __KERNEL__ */
#endif /* _POWERPC_PROM_H */
Commit	Line	Data
9b6b563c PM	1	#ifndef _POWERPC_PROM_H
	2	#define _POWERPC_PROM_H
	3	#ifdef __KERNEL__
	4
	5	/*
	6	* Definitions for talking to the Open Firmware PROM on
	7	* Power Macintosh computers.
	8	*
	9	* Copyright (C) 1996-2005 Paul Mackerras.
	10	*
	11	* Updates for PPC64 by Peter Bergner & David Engebretsen, IBM Corp.
	12	*
	13	* This program is free software; you can redistribute it and/or
	14	* modify it under the terms of the GNU General Public License
	15	* as published by the Free Software Foundation; either version
	16	* 2 of the License, or (at your option) any later version.
	17	*/
	18	#include <linux/types.h>
	19	#include <linux/proc_fs.h>
	20	#include <asm/atomic.h>
	21
	22	/* Definitions used by the flattened device tree */
	23	#define OF_DT_HEADER 0xd00dfeed /* marker */
	24	#define OF_DT_BEGIN_NODE 0x1 /* Start of node, full name */
	25	#define OF_DT_END_NODE 0x2 /* End node */
	26	#define OF_DT_PROP 0x3 /* Property: name off, size,
	27	* content */
	28	#define OF_DT_NOP 0x4 /* nop */
	29	#define OF_DT_END 0x9
	30
	31	#define OF_DT_VERSION 0x10
	32
	33	/*
	34	* This is what gets passed to the kernel by prom_init or kexec
	35	*
	36	* The dt struct contains the device tree structure, full pathes and
	37	* property contents. The dt strings contain a separate block with just
	38	* the strings for the property names, and is fully page aligned and
	39	* self contained in a page, so that it can be kept around by the kernel,
	40	* each property name appears only once in this page (cheap compression)
	41	*
	42	* the mem_rsvmap contains a map of reserved ranges of physical memory,
	43	* passing it here instead of in the device-tree itself greatly simplifies
	44	* the job of everybody. It's just a list of u64 pairs (base/size) that
	45	* ends when size is 0
	46	*/
	47	struct boot_param_header
	48	{
	49	u32 magic; /* magic word OF_DT_HEADER */
	50	u32 totalsize; /* total size of DT block */
	51	u32 off_dt_struct; /* offset to structure */
	52	u32 off_dt_strings; /* offset to strings */
	53	u32 off_mem_rsvmap; /* offset to memory reserve map */
	54	u32 version; /* format version */
	55	u32 last_comp_version; /* last compatible version */
	56	/* version 2 fields below */
	57	u32 boot_cpuid_phys; /* Physical CPU id we're booting on */
	58	/* version 3 fields below */
	59	u32 dt_strings_size; /* size of the DT strings block */
	60	};
	61
	62
	63
	64	typedef u32 phandle;
65	typedef u32 ihandle;
66
9b6b563c PM	67	struct interrupt_info {
	68	int line;
	69	int sense; /* +ve/-ve logic, edge or level, etc. */
	70	};
	71
9b6b563c PM	72	struct property {
	73	char *name;
	74	int length;
	75	unsigned char *value;
	76	struct property *next;
	77	};
	78
	79	struct device_node {
	80	char *name;
	81	char *type;
	82	phandle node;
	83	phandle linux_phandle;
9b6b563c PM	84	int n_intrs;
	85	struct interrupt_info *intrs;
	86	char *full_name;
	87
	88	struct property *properties;
088186de	89	struct property deadprops; / removed properties */
9b6b563c PM	90	struct device_node *parent;
	91	struct device_node *child;
	92	struct device_node *sibling;
	93	struct device_node next; / next device of same type */
	94	struct device_node allnext; / next in list of all nodes */
	95	struct proc_dir_entry pde; / this node's proc directory */
	96	struct kref kref;
	97	unsigned long _flags;
	98	void *data;
	99	};
	100
	101	extern struct device_node *of_chosen;
	102
	103	/* flag descriptions */
	104	#define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */
	105
	106	#define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
	107	#define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
	108
	109	#define HAVE_ARCH_DEVTREE_FIXUPS
	110
	111	static inline void set_node_proc_entry(struct device_node dn, struct proc_dir_entry de)
	112	{
	113	dn->pde = de;
	114	}
	115
	116
	117	/* OBSOLETE: Old style node lookup */
bf20a000 PM	118	extern struct device_node find_devices(const char name);
	119	extern struct device_node find_type_devices(const char type);
	120	extern struct device_node find_path_device(const char path);
	121	extern struct device_node find_compatible_devices(const char type,
9b6b563c	122	const char *compat);
bf20a000	123	extern struct device_node *find_all_nodes(void);
9b6b563c PM	124
	125	/* New style node lookup */
	126	extern struct device_node of_find_node_by_name(struct device_node from,
	127	const char *name);
e3385222 CH	128	#define for_each_node_by_name(dn, name) \
	129	for (dn = of_find_node_by_name(NULL, name); dn; \
	130	dn = of_find_node_by_name(dn, name))
9b6b563c PM	131	extern struct device_node of_find_node_by_type(struct device_node from,
9b6b563c PM	132	const char *type);
e3385222 CH	133	#define for_each_node_by_type(dn, type) \
	134	for (dn = of_find_node_by_type(NULL, type); dn; \
	135	dn = of_find_node_by_type(dn, type))
9b6b563c PM	136	extern struct device_node of_find_compatible_node(struct device_node from,
	137	const char type, const char compat);
	138	extern struct device_node of_find_node_by_path(const char path);
	139	extern struct device_node *of_find_node_by_phandle(phandle handle);
	140	extern struct device_node of_find_all_nodes(struct device_node prev);
	141	extern struct device_node of_get_parent(const struct device_node node);
	142	extern struct device_node of_get_next_child(const struct device_node node,
	143	struct device_node *prev);
ecaa8b0f DB	144	extern struct property of_find_property(struct device_node np,
	145	const char *name,
	146	int *lenp);
9b6b563c PM	147	extern struct device_node of_node_get(struct device_node node);
	148	extern void of_node_put(struct device_node *node);
	149
3c726f8d	150	/* For scanning the flat device-tree at boot time */
e8222502 BH	151	extern int __init of_scan_flat_dt(int (*it)(unsigned long node,
	152	const char *uname, int depth,
	153	void *data),
	154	void *data);
	155	extern void* __init of_get_flat_dt_prop(unsigned long node, const char *name,
	156	unsigned long *size);
	157	extern int __init of_flat_dt_is_compatible(unsigned long node, const char *name);
	158	extern unsigned long __init of_get_flat_dt_root(void);
3c726f8d	159
9b6b563c PM	160	/* For updating the device tree at runtime */
	161	extern void of_attach_node(struct device_node *);
	162	extern void of_detach_node(const struct device_node *);
	163
	164	/* Other Prototypes */
	165	extern void finish_device_tree(void);
	166	extern void unflatten_device_tree(void);
	167	extern void early_init_devtree(void *);
	168	extern int device_is_compatible(struct device_node device, const char );
	169	extern int machine_is_compatible(const char *compat);
a1af5b2f JK	170	extern void get_property(struct device_node node, const char *name,
a1af5b2f JK	171	int *lenp);
9b6b563c PM	172	extern void print_properties(struct device_node *node);
	173	extern int prom_n_addr_cells(struct device_node* np);
	174	extern int prom_n_size_cells(struct device_node* np);
	175	extern int prom_n_intr_cells(struct device_node* np);
	176	extern void prom_get_irq_senses(unsigned char *senses, int off, int max);
183d0202	177	extern int prom_add_property(struct device_node* np, struct property* prop);
088186de DB	178	extern int prom_remove_property(struct device_node np, struct property prop);
	179	extern int prom_update_property(struct device_node *np,
	180	struct property *newprop,
	181	struct property *oldprop);
9b6b563c	182
40ef8cbc	183	#ifdef CONFIG_PPC32
9b6b563c PM	184	/*
	185	* PCI <-> OF matching functions
	186	* (XXX should these be here?)
	187	*/
	188	struct pci_bus;
	189	struct pci_dev;
	190	extern int pci_device_from_OF_node(struct device_node *node,
	191	u8* bus, u8* devfn);
	192	extern struct device_node* pci_busdev_to_OF_node(struct pci_bus *, int);
	193	extern struct device_node* pci_device_to_OF_node(struct pci_dev *);
	194	extern void pci_create_OF_bus_map(void);
40ef8cbc PM	195	#endif
40ef8cbc PM	196
9b6b563c PM	197	extern struct resource request_OF_resource(struct device_node node,
	198	int index, const char* name_postfix);
	199	extern int release_OF_resource(struct device_node* node, int index);
	200
d2dd482b	201
d1405b86	202	/*
d2dd482b BH	203	* OF address retreival & translation
	204	*/
	205
	206
	207	/* Translate an OF address block into a CPU physical address
d1405b86 BH	208	*/
	209	#define OF_BAD_ADDR ((u64)-1)
	210	extern u64 of_translate_address(struct device_node np, u32 addr);
d1405b86	211
d2dd482b BH	212	/* Extract an address from a device, returns the region size and
	213	* the address space flags too. The PCI version uses a BAR number
	214	* instead of an absolute index
	215	*/
	216	extern u32 of_get_address(struct device_node dev, int index,
	217	u64 size, unsigned int flags);
	218	extern u32 of_get_pci_address(struct device_node dev, int bar_no,
	219	u64 size, unsigned int flags);
	220
	221	/* Get an address as a resource. Note that if your address is
	222	* a PIO address, the conversion will fail if the physical address
	223	* can't be internally converted to an IO token with
	224	* pci_address_to_pio(), that is because it's either called to early
	225	* or it can't be matched to any host bridge IO space
	226	*/
	227	extern int of_address_to_resource(struct device_node *dev, int index,
	228	struct resource *r);
	229	extern int of_pci_address_to_resource(struct device_node *dev, int bar,
	230	struct resource *r);
d1405b86	231
d4ad66fa JK	232	/* Parse the ibm,dma-window property of an OF node into the busno, phys and
	233	* size parameters.
	234	*/
	235	void of_parse_dma_window(struct device_node dn, unsigned char dma_window_prop,
	236	unsigned long busno, unsigned long phys, unsigned long *size);
	237
b68239ee ME	238	extern void kdump_move_device_tree(void);
b68239ee ME	239
acf7d768 BH	240	/* CPU OF node matching */
	241	struct device_node of_get_cpu_node(int cpu, unsigned int thread);
	242
9b6b563c PM	243	#endif /* __KERNEL__ */
9b6b563c PM	244	#endif /* _POWERPC_PROM_H */