[linux.git] / drivers / pnp / base.h

/*
 * Copyright (C) 2008 Hewlett-Packard Development Company, L.P.
 *	Bjorn Helgaas <[email protected]>
 */

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