[net-next-2.6.git] / drivers / pnp / base.h

/*
 * Copyright (C) 2008 Hewlett-Packard Development Company, L.P.
 *	Bjorn Helgaas <bjorn.helgaas@hp.com>
 */

extern spinlock_t pnp_lock;
extern struct device_attribute pnp_interface_attrs[];
void *pnp_alloc(long size);

int pnp_register_protocol(struct pnp_protocol *protocol);
void pnp_unregister_protocol(struct pnp_protocol *protocol);

#define PNP_EISA_ID_MASK 0x7fffffff
void pnp_eisa_id_to_string(u32 id, char *str);
struct pnp_dev *pnp_alloc_dev(struct pnp_protocol *, int id,
			      const char *pnpid);
struct pnp_card *pnp_alloc_card(struct pnp_protocol *, int id, char *pnpid);

int pnp_add_device(struct pnp_dev *dev);
struct pnp_id *pnp_add_id(struct pnp_dev *dev, const char *id);

int pnp_add_card(struct pnp_card *card);
void pnp_remove_card(struct pnp_card *card);
int pnp_add_card_device(struct pnp_card *card, struct pnp_dev *dev);
void pnp_remove_card_device(struct pnp_dev *dev);

struct pnp_port {
	resource_size_t min;	/* min base number */
	resource_size_t max;	/* max base number */
	resource_size_t align;	/* align boundary */
	resource_size_t size;	/* size of range */
	unsigned char flags;	/* port flags */
};

#define PNP_IRQ_NR 256
typedef struct { DECLARE_BITMAP(bits, PNP_IRQ_NR); } pnp_irq_mask_t;

struct pnp_irq {
	pnp_irq_mask_t map;	/* bitmap for IRQ lines */
	unsigned char flags;	/* IRQ flags */
};

struct pnp_dma {
	unsigned char map;	/* bitmask for DMA channels */
	unsigned char flags;	/* DMA flags */
};

struct pnp_mem {
	resource_size_t min;	/* min base number */
	resource_size_t max;	/* max base number */
	resource_size_t align;	/* align boundary */
	resource_size_t size;	/* size of range */
	unsigned char flags;	/* memory flags */
};

#define PNP_OPTION_DEPENDENT		0x80000000
#define PNP_OPTION_SET_MASK		0xffff
#define PNP_OPTION_SET_SHIFT		12
#define PNP_OPTION_PRIORITY_MASK	0xfff
#define PNP_OPTION_PRIORITY_SHIFT	0

#define PNP_RES_PRIORITY_PREFERRED	0
#define PNP_RES_PRIORITY_ACCEPTABLE	1
#define PNP_RES_PRIORITY_FUNCTIONAL	2
#define PNP_RES_PRIORITY_INVALID	PNP_OPTION_PRIORITY_MASK

struct pnp_option {
	struct list_head list;
	unsigned int flags;	/* independent/dependent, set, priority */

	unsigned long type;	/* IORESOURCE_{IO,MEM,IRQ,DMA} */
	union {
		struct pnp_port port;
		struct pnp_irq irq;
		struct pnp_dma dma;
		struct pnp_mem mem;
	} u;
};

int pnp_register_irq_resource(struct pnp_dev *dev, unsigned int option_flags,
			      pnp_irq_mask_t *map, unsigned char flags);
int pnp_register_dma_resource(struct pnp_dev *dev, unsigned int option_flags,
			      unsigned char map, unsigned char flags);
int pnp_register_port_resource(struct pnp_dev *dev, unsigned int option_flags,
			       resource_size_t min, resource_size_t max,
			       resource_size_t align, resource_size_t size,
			       unsigned char flags);
int pnp_register_mem_resource(struct pnp_dev *dev, unsigned int option_flags,
			      resource_size_t min, resource_size_t max,
			      resource_size_t align, resource_size_t size,
			      unsigned char flags);

static inline int pnp_option_is_dependent(struct pnp_option *option)
{
	return option->flags & PNP_OPTION_DEPENDENT ? 1 : 0;
}

static inline unsigned int pnp_option_set(struct pnp_option *option)
{
	return (option->flags >> PNP_OPTION_SET_SHIFT) & PNP_OPTION_SET_MASK;
}

static inline unsigned int pnp_option_priority(struct pnp_option *option)
{
	return (option->flags >> PNP_OPTION_PRIORITY_SHIFT) &
	    PNP_OPTION_PRIORITY_MASK;
}

static inline unsigned int pnp_new_dependent_set(struct pnp_dev *dev,
						 int priority)
{
	unsigned int flags;

	if (priority > PNP_RES_PRIORITY_FUNCTIONAL) {
		dev_warn(&dev->dev, "invalid dependent option priority %d "
			 "clipped to %d", priority,
			 PNP_RES_PRIORITY_INVALID);
		priority = PNP_RES_PRIORITY_INVALID;
	}

	flags = PNP_OPTION_DEPENDENT |
	    ((dev->num_dependent_sets & PNP_OPTION_SET_MASK) <<
		PNP_OPTION_SET_SHIFT) |
	    ((priority & PNP_OPTION_PRIORITY_MASK) <<
		PNP_OPTION_PRIORITY_SHIFT);

	dev->num_dependent_sets++;

	return flags;
}

char *pnp_option_priority_name(struct pnp_option *option);
void dbg_pnp_show_option(struct pnp_dev *dev, struct pnp_option *option);

void pnp_init_resources(struct pnp_dev *dev);

void pnp_fixup_device(struct pnp_dev *dev);
void pnp_free_options(struct pnp_dev *dev);
int __pnp_add_device(struct pnp_dev *dev);
void __pnp_remove_device(struct pnp_dev *dev);

int pnp_check_port(struct pnp_dev *dev, struct resource *res);
int pnp_check_mem(struct pnp_dev *dev, struct resource *res);
int pnp_check_irq(struct pnp_dev *dev, struct resource *res);
int pnp_check_dma(struct pnp_dev *dev, struct resource *res);

char *pnp_resource_type_name(struct resource *res);
void dbg_pnp_show_resources(struct pnp_dev *dev, char *desc);

void pnp_free_resources(struct pnp_dev *dev);
unsigned long pnp_resource_type(struct resource *res);

struct pnp_resource {
	struct list_head list;
	struct resource res;
};

void pnp_free_resource(struct pnp_resource *pnp_res);

struct pnp_resource *pnp_add_irq_resource(struct pnp_dev *dev, int irq,
					  int flags);
struct pnp_resource *pnp_add_dma_resource(struct pnp_dev *dev, int dma,
					  int flags);
struct pnp_resource *pnp_add_io_resource(struct pnp_dev *dev,
					 resource_size_t start,
					 resource_size_t end, int flags);
struct pnp_resource *pnp_add_mem_resource(struct pnp_dev *dev,
					  resource_size_t start,
					  resource_size_t end, int flags);
struct pnp_resource *pnp_add_bus_resource(struct pnp_dev *dev,
					  resource_size_t start,
					  resource_size_t end);

extern int pnp_debug;

#if defined(CONFIG_PNP_DEBUG_MESSAGES)
#define pnp_dbg(dev, format, arg...)					\
	({ if (pnp_debug) dev_printk(KERN_DEBUG, dev, format, ## arg); 0; })
#else
#define pnp_dbg(dev, format, arg...)					\
	({ if (0) dev_printk(KERN_DEBUG, dev, format, ## arg); 0; })
#endif
Commit	Line	Data
1f32ca31 BH	1	/*
	2	* Copyright (C) 2008 Hewlett-Packard Development Company, L.P.
	3	* Bjorn Helgaas <bjorn.helgaas@hp.com>
	4	*/
	5
1da177e4	6	extern spinlock_t pnp_lock;
8a89efd1	7	extern struct device_attribute pnp_interface_attrs[];
1da177e4	8	void *pnp_alloc(long size);
62cfb298 BH	9
	10	int pnp_register_protocol(struct pnp_protocol *protocol);
	11	void pnp_unregister_protocol(struct pnp_protocol *protocol);
	12
25eb8461 BH	13	#define PNP_EISA_ID_MASK 0x7fffffff
25eb8461 BH	14	void pnp_eisa_id_to_string(u32 id, char *str);
620e112c TR	15	struct pnp_dev pnp_alloc_dev(struct pnp_protocol , int id,
620e112c TR	16	const char *pnpid);
6bf2aab2	17	struct pnp_card pnp_alloc_card(struct pnp_protocol , int id, char *pnpid);
62cfb298 BH	18
62cfb298 BH	19	int pnp_add_device(struct pnp_dev *dev);
620e112c	20	struct pnp_id pnp_add_id(struct pnp_dev dev, const char *id);
62cfb298 BH	21
62cfb298 BH	22	int pnp_add_card(struct pnp_card *card);
62cfb298 BH	23	void pnp_remove_card(struct pnp_card *card);
	24	int pnp_add_card_device(struct pnp_card card, struct pnp_dev dev);
	25	void pnp_remove_card_device(struct pnp_dev *dev);
	26
a1802c42	27	struct pnp_port {
169aaffe BH	28	resource_size_t min; /* min base number */
	29	resource_size_t max; /* max base number */
	30	resource_size_t align; /* align boundary */
	31	resource_size_t size; /* size of range */
a1802c42	32	unsigned char flags; /* port flags */
a1802c42 BH	33	};
	34
	35	#define PNP_IRQ_NR 256
7aefff51 BH	36	typedef struct { DECLARE_BITMAP(bits, PNP_IRQ_NR); } pnp_irq_mask_t;
7aefff51 BH	37
a1802c42	38	struct pnp_irq {
7aefff51	39	pnp_irq_mask_t map; /* bitmap for IRQ lines */
a1802c42	40	unsigned char flags; /* IRQ flags */
a1802c42 BH	41	};
	42
	43	struct pnp_dma {
	44	unsigned char map; /* bitmask for DMA channels */
	45	unsigned char flags; /* DMA flags */
a1802c42 BH	46	};
	47
	48	struct pnp_mem {
169aaffe BH	49	resource_size_t min; /* min base number */
	50	resource_size_t max; /* max base number */
	51	resource_size_t align; /* align boundary */
	52	resource_size_t size; /* size of range */
a1802c42	53	unsigned char flags; /* memory flags */
a1802c42 BH	54	};
a1802c42 BH	55
1f32ca31 BH	56	#define PNP_OPTION_DEPENDENT 0x80000000
	57	#define PNP_OPTION_SET_MASK 0xffff
	58	#define PNP_OPTION_SET_SHIFT 12
	59	#define PNP_OPTION_PRIORITY_MASK 0xfff
	60	#define PNP_OPTION_PRIORITY_SHIFT 0
	61
a1802c42 BH	62	#define PNP_RES_PRIORITY_PREFERRED 0
	63	#define PNP_RES_PRIORITY_ACCEPTABLE 1
	64	#define PNP_RES_PRIORITY_FUNCTIONAL 2
1f32ca31	65	#define PNP_RES_PRIORITY_INVALID PNP_OPTION_PRIORITY_MASK
a1802c42 BH	66
a1802c42 BH	67	struct pnp_option {
1f32ca31 BH	68	struct list_head list;
	69	unsigned int flags; /* independent/dependent, set, priority */
	70
	71	unsigned long type; /* IORESOURCE_{IO,MEM,IRQ,DMA} */
	72	union {
	73	struct pnp_port port;
	74	struct pnp_irq irq;
	75	struct pnp_dma dma;
	76	struct pnp_mem mem;
	77	} u;
a1802c42 BH	78	};
a1802c42 BH	79
1f32ca31	80	int pnp_register_irq_resource(struct pnp_dev *dev, unsigned int option_flags,
c227536b	81	pnp_irq_mask_t *map, unsigned char flags);
1f32ca31	82	int pnp_register_dma_resource(struct pnp_dev *dev, unsigned int option_flags,
c227536b	83	unsigned char map, unsigned char flags);
1f32ca31	84	int pnp_register_port_resource(struct pnp_dev *dev, unsigned int option_flags,
c227536b BH	85	resource_size_t min, resource_size_t max,
	86	resource_size_t align, resource_size_t size,
	87	unsigned char flags);
1f32ca31	88	int pnp_register_mem_resource(struct pnp_dev *dev, unsigned int option_flags,
c227536b BH	89	resource_size_t min, resource_size_t max,
	90	resource_size_t align, resource_size_t size,
	91	unsigned char flags);
1f32ca31 BH	92
	93	static inline int pnp_option_is_dependent(struct pnp_option *option)
	94	{
	95	return option->flags & PNP_OPTION_DEPENDENT ? 1 : 0;
	96	}
	97
	98	static inline unsigned int pnp_option_set(struct pnp_option *option)
	99	{
	100	return (option->flags >> PNP_OPTION_SET_SHIFT) & PNP_OPTION_SET_MASK;
	101	}
	102
	103	static inline unsigned int pnp_option_priority(struct pnp_option *option)
	104	{
	105	return (option->flags >> PNP_OPTION_PRIORITY_SHIFT) &
	106	PNP_OPTION_PRIORITY_MASK;
	107	}
	108
	109	static inline unsigned int pnp_new_dependent_set(struct pnp_dev *dev,
	110	int priority)
	111	{
	112	unsigned int flags;
	113
	114	if (priority > PNP_RES_PRIORITY_FUNCTIONAL) {
	115	dev_warn(&dev->dev, "invalid dependent option priority %d "
	116	"clipped to %d", priority,
	117	PNP_RES_PRIORITY_INVALID);
	118	priority = PNP_RES_PRIORITY_INVALID;
	119	}
	120
	121	flags = PNP_OPTION_DEPENDENT \|
	122	((dev->num_dependent_sets & PNP_OPTION_SET_MASK) <<
	123	PNP_OPTION_SET_SHIFT) \|
	124	((priority & PNP_OPTION_PRIORITY_MASK) <<
	125	PNP_OPTION_PRIORITY_SHIFT);
	126
	127	dev->num_dependent_sets++;
	128
	129	return flags;
	130	}
	131
	132	char pnp_option_priority_name(struct pnp_option option);
	133	void dbg_pnp_show_option(struct pnp_dev dev, struct pnp_option option);
	134
62cfb298 BH	135	void pnp_init_resources(struct pnp_dev *dev);
62cfb298 BH	136
1da177e4	137	void pnp_fixup_device(struct pnp_dev *dev);
1f32ca31	138	void pnp_free_options(struct pnp_dev *dev);
1da177e4 LT	139	int __pnp_add_device(struct pnp_dev *dev);
	140	void __pnp_remove_device(struct pnp_dev *dev);
	141
f5d94ff0 BH	142	int pnp_check_port(struct pnp_dev dev, struct resource res);
	143	int pnp_check_mem(struct pnp_dev dev, struct resource res);
	144	int pnp_check_irq(struct pnp_dev dev, struct resource res);
	145	int pnp_check_dma(struct pnp_dev dev, struct resource res);
81b5c75f	146
9fdee4e0	147	char pnp_resource_type_name(struct resource res);
81b5c75f	148	void dbg_pnp_show_resources(struct pnp_dev dev, char desc);
d948a8da	149
aee3ad81	150	void pnp_free_resources(struct pnp_dev *dev);
b563cf59	151	unsigned long pnp_resource_type(struct resource *res);
02d83b5d	152
784f01d5	153	struct pnp_resource {
aee3ad81	154	struct list_head list;
784f01d5 BH	155	struct resource res;
	156	};
	157
aee3ad81	158	void pnp_free_resource(struct pnp_resource *pnp_res);
dbddd038 BH	159
	160	struct pnp_resource pnp_add_irq_resource(struct pnp_dev dev, int irq,
	161	int flags);
dc16f5f2 BH	162	struct pnp_resource pnp_add_dma_resource(struct pnp_dev dev, int dma,
dc16f5f2 BH	163	int flags);
cc8c2e30 BH	164	struct pnp_resource pnp_add_io_resource(struct pnp_dev dev,
	165	resource_size_t start,
	166	resource_size_t end, int flags);
d6180f36 BH	167	struct pnp_resource pnp_add_mem_resource(struct pnp_dev dev,
	168	resource_size_t start,
	169	resource_size_t end, int flags);
7e0e9c04 BH	170	struct pnp_resource pnp_add_bus_resource(struct pnp_dev dev,
	171	resource_size_t start,
	172	resource_size_t end);
97ef062b BH	173
	174	extern int pnp_debug;
	175
	176	#if defined(CONFIG_PNP_DEBUG_MESSAGES)
	177	#define pnp_dbg(dev, format, arg...) \
	178	({ if (pnp_debug) dev_printk(KERN_DEBUG, dev, format, ## arg); 0; })
	179	#else
	180	#define pnp_dbg(dev, format, arg...) \
	181	({ if (0) dev_printk(KERN_DEBUG, dev, format, ## arg); 0; })
	182	#endif