[linux-2.6-block.git] / drivers / pnp / base.h

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

extern struct mutex pnp_lock;
extern const struct attribute_group *pnp_dev_groups[];
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);
#ifdef CONFIG_ISA_DMA_API
int pnp_check_dma(struct pnp_dev *dev, struct resource *res);
#endif

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