[linux-2.6-block.git] / include / linux / pnp.h

/*
 * Linux Plug and Play Support
 * Copyright by Adam Belay <ambx1@neo.rr.com>
 */

#ifndef _LINUX_PNP_H
#define _LINUX_PNP_H

#include <linux/device.h>
#include <linux/list.h>
#include <linux/errno.h>
#include <linux/mod_devicetable.h>

#define PNP_NAME_LEN		50

struct pnp_protocol;
struct pnp_dev;

/*
 * Resource Management
 */
struct resource *pnp_get_resource(struct pnp_dev *, unsigned int, unsigned int);

static inline int pnp_resource_valid(struct resource *res)
{
	if (res)
		return 1;
	return 0;
}

static inline int pnp_resource_enabled(struct resource *res)
{
	if (res && !(res->flags & IORESOURCE_DISABLED))
		return 1;
	return 0;
}

static inline resource_size_t pnp_resource_len(struct resource *res)
{
	if (res->start == 0 && res->end == 0)
		return 0;
	return res->end - res->start + 1;
}


static inline resource_size_t pnp_port_start(struct pnp_dev *dev,
					     unsigned int bar)
{
	struct resource *res = pnp_get_resource(dev, IORESOURCE_IO, bar);

	if (pnp_resource_valid(res))
		return res->start;
	return 0;
}

static inline resource_size_t pnp_port_end(struct pnp_dev *dev,
					   unsigned int bar)
{
	struct resource *res = pnp_get_resource(dev, IORESOURCE_IO, bar);

	if (pnp_resource_valid(res))
		return res->end;
	return 0;
}

static inline unsigned long pnp_port_flags(struct pnp_dev *dev,
					   unsigned int bar)
{
	struct resource *res = pnp_get_resource(dev, IORESOURCE_IO, bar);

	if (pnp_resource_valid(res))
		return res->flags;
	return IORESOURCE_IO | IORESOURCE_AUTO;
}

static inline int pnp_port_valid(struct pnp_dev *dev, unsigned int bar)
{
	return pnp_resource_valid(pnp_get_resource(dev, IORESOURCE_IO, bar));
}

static inline resource_size_t pnp_port_len(struct pnp_dev *dev,
					   unsigned int bar)
{
	struct resource *res = pnp_get_resource(dev, IORESOURCE_IO, bar);

	if (pnp_resource_valid(res))
		return pnp_resource_len(res);
	return 0;
}


static inline resource_size_t pnp_mem_start(struct pnp_dev *dev,
					    unsigned int bar)
{
	struct resource *res = pnp_get_resource(dev, IORESOURCE_MEM, bar);

	if (pnp_resource_valid(res))
		return res->start;
	return 0;
}

static inline resource_size_t pnp_mem_end(struct pnp_dev *dev,
					  unsigned int bar)
{
	struct resource *res = pnp_get_resource(dev, IORESOURCE_MEM, bar);

	if (pnp_resource_valid(res))
		return res->end;
	return 0;
}

static inline unsigned long pnp_mem_flags(struct pnp_dev *dev, unsigned int bar)
{
	struct resource *res = pnp_get_resource(dev, IORESOURCE_MEM, bar);

	if (pnp_resource_valid(res))
		return res->flags;
	return IORESOURCE_MEM | IORESOURCE_AUTO;
}

static inline int pnp_mem_valid(struct pnp_dev *dev, unsigned int bar)
{
	return pnp_resource_valid(pnp_get_resource(dev, IORESOURCE_MEM, bar));
}

static inline resource_size_t pnp_mem_len(struct pnp_dev *dev,
					  unsigned int bar)
{
	struct resource *res = pnp_get_resource(dev, IORESOURCE_MEM, bar);

	if (pnp_resource_valid(res))
		return pnp_resource_len(res);
	return 0;
}


static inline resource_size_t pnp_irq(struct pnp_dev *dev, unsigned int bar)
{
	struct resource *res = pnp_get_resource(dev, IORESOURCE_IRQ, bar);

	if (pnp_resource_valid(res))
		return res->start;
	return -1;
}

static inline unsigned long pnp_irq_flags(struct pnp_dev *dev, unsigned int bar)
{
	struct resource *res = pnp_get_resource(dev, IORESOURCE_IRQ, bar);

	if (pnp_resource_valid(res))
		return res->flags;
	return IORESOURCE_IRQ | IORESOURCE_AUTO;
}

static inline int pnp_irq_valid(struct pnp_dev *dev, unsigned int bar)
{
	return pnp_resource_valid(pnp_get_resource(dev, IORESOURCE_IRQ, bar));
}


static inline resource_size_t pnp_dma(struct pnp_dev *dev, unsigned int bar)
{
	struct resource *res = pnp_get_resource(dev, IORESOURCE_DMA, bar);

	if (pnp_resource_valid(res))
		return res->start;
	return -1;
}

static inline unsigned long pnp_dma_flags(struct pnp_dev *dev, unsigned int bar)
{
	struct resource *res = pnp_get_resource(dev, IORESOURCE_DMA, bar);

	if (pnp_resource_valid(res))
		return res->flags;
	return IORESOURCE_DMA | IORESOURCE_AUTO;
}

static inline int pnp_dma_valid(struct pnp_dev *dev, unsigned int bar)
{
	return pnp_resource_valid(pnp_get_resource(dev, IORESOURCE_DMA, bar));
}


#define PNP_PORT_FLAG_16BITADDR	(1<<0)
#define PNP_PORT_FLAG_FIXED	(1<<1)

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

#define PNP_IRQ_NR 256
struct pnp_irq {
	DECLARE_BITMAP(map, PNP_IRQ_NR);	/* bitmask for IRQ lines */
	unsigned char flags;	/* IRQ flags */
	unsigned char pad;	/* pad */
	struct pnp_irq *next;	/* next IRQ */
};

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

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

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

struct pnp_option {
	unsigned short priority;	/* priority */
	struct pnp_port *port;		/* first port */
	struct pnp_irq *irq;		/* first IRQ */
	struct pnp_dma *dma;		/* first DMA */
	struct pnp_mem *mem;		/* first memory resource */
	struct pnp_option *next;	/* used to chain dependent resources */
};

/*
 * Device Management
 */

struct pnp_card {
	struct device dev;		/* Driver Model device interface */
	unsigned char number;		/* used as an index, must be unique */
	struct list_head global_list;	/* node in global list of cards */
	struct list_head protocol_list;	/* node in protocol's list of cards */
	struct list_head devices;	/* devices attached to the card */

	struct pnp_protocol *protocol;
	struct pnp_id *id;		/* contains supported EISA IDs */

	char name[PNP_NAME_LEN];	/* contains a human-readable name */
	unsigned char pnpver;		/* Plug & Play version */
	unsigned char productver;	/* product version */
	unsigned int serial;		/* serial number */
	unsigned char checksum;		/* if zero - checksum passed */
	struct proc_dir_entry *procdir;	/* directory entry in /proc/bus/isapnp */
};

#define global_to_pnp_card(n) list_entry(n, struct pnp_card, global_list)
#define protocol_to_pnp_card(n) list_entry(n, struct pnp_card, protocol_list)
#define to_pnp_card(n) container_of(n, struct pnp_card, dev)
#define pnp_for_each_card(card) \
	for((card) = global_to_pnp_card(pnp_cards.next); \
	(card) != global_to_pnp_card(&pnp_cards); \
	(card) = global_to_pnp_card((card)->global_list.next))

struct pnp_card_link {
	struct pnp_card *card;
	struct pnp_card_driver *driver;
	void *driver_data;
	pm_message_t pm_state;
};

static inline void *pnp_get_card_drvdata(struct pnp_card_link *pcard)
{
	return pcard->driver_data;
}

static inline void pnp_set_card_drvdata(struct pnp_card_link *pcard, void *data)
{
	pcard->driver_data = data;
}

struct pnp_dev {
	struct device dev;		/* Driver Model device interface */
	u64 dma_mask;
	unsigned int number;		/* used as an index, must be unique */
	int status;

	struct list_head global_list;	/* node in global list of devices */
	struct list_head protocol_list;	/* node in list of device's protocol */
	struct list_head card_list;	/* node in card's list of devices */
	struct list_head rdev_list;	/* node in cards list of requested devices */

	struct pnp_protocol *protocol;
	struct pnp_card *card;	/* card the device is attached to, none if NULL */
	struct pnp_driver *driver;
	struct pnp_card_link *card_link;

	struct pnp_id *id;		/* supported EISA IDs */

	int active;
	int capabilities;
	struct pnp_option *independent;
	struct pnp_option *dependent;
	struct list_head resources;

	char name[PNP_NAME_LEN];	/* contains a human-readable name */
	int flags;			/* used by protocols */
	struct proc_dir_entry *procent;	/* device entry in /proc/bus/isapnp */
	void *data;
};

#define global_to_pnp_dev(n) list_entry(n, struct pnp_dev, global_list)
#define card_to_pnp_dev(n) list_entry(n, struct pnp_dev, card_list)
#define protocol_to_pnp_dev(n) list_entry(n, struct pnp_dev, protocol_list)
#define	to_pnp_dev(n) container_of(n, struct pnp_dev, dev)
#define pnp_for_each_dev(dev) \
	for((dev) = global_to_pnp_dev(pnp_global.next); \
	(dev) != global_to_pnp_dev(&pnp_global); \
	(dev) = global_to_pnp_dev((dev)->global_list.next))
#define card_for_each_dev(card,dev) \
	for((dev) = card_to_pnp_dev((card)->devices.next); \
	(dev) != card_to_pnp_dev(&(card)->devices); \
	(dev) = card_to_pnp_dev((dev)->card_list.next))
#define pnp_dev_name(dev) (dev)->name

static inline void *pnp_get_drvdata(struct pnp_dev *pdev)
{
	return dev_get_drvdata(&pdev->dev);
}

static inline void pnp_set_drvdata(struct pnp_dev *pdev, void *data)
{
	dev_set_drvdata(&pdev->dev, data);
}

struct pnp_fixup {
	char id[7];
	void (*quirk_function) (struct pnp_dev * dev);	/* fixup function */
};

/* config parameters */
#define PNP_CONFIG_NORMAL	0x0001
#define PNP_CONFIG_FORCE	0x0002	/* disables validity checking */

/* capabilities */
#define PNP_READ		0x0001
#define PNP_WRITE		0x0002
#define PNP_DISABLE		0x0004
#define PNP_CONFIGURABLE	0x0008
#define PNP_REMOVABLE		0x0010

#define pnp_can_read(dev)	(((dev)->protocol->get) && \
				 ((dev)->capabilities & PNP_READ))
#define pnp_can_write(dev)	(((dev)->protocol->set) && \
				 ((dev)->capabilities & PNP_WRITE))
#define pnp_can_disable(dev)	(((dev)->protocol->disable) && \
				 ((dev)->capabilities & PNP_DISABLE))
#define pnp_can_configure(dev)	((!(dev)->active) && \
				 ((dev)->capabilities & PNP_CONFIGURABLE))

#ifdef CONFIG_ISAPNP
extern struct pnp_protocol isapnp_protocol;
#define pnp_device_is_isapnp(dev) ((dev)->protocol == (&isapnp_protocol))
#else
#define pnp_device_is_isapnp(dev) 0
#endif
extern struct mutex pnp_res_mutex;

#ifdef CONFIG_PNPBIOS
extern struct pnp_protocol pnpbios_protocol;
#define pnp_device_is_pnpbios(dev) ((dev)->protocol == (&pnpbios_protocol))
#else
#define pnp_device_is_pnpbios(dev) 0
#endif

/* status */
#define PNP_READY		0x0000
#define PNP_ATTACHED		0x0001
#define PNP_BUSY		0x0002
#define PNP_FAULTY		0x0004

/* isapnp specific macros */

#define isapnp_card_number(dev)	((dev)->card ? (dev)->card->number : -1)
#define isapnp_csn_number(dev)  ((dev)->number)

/*
 * Driver Management
 */

struct pnp_id {
	char id[PNP_ID_LEN];
	struct pnp_id *next;
};

struct pnp_driver {
	char *name;
	const struct pnp_device_id *id_table;
	unsigned int flags;
	int (*probe) (struct pnp_dev *dev, const struct pnp_device_id *dev_id);
	void (*remove) (struct pnp_dev *dev);
	int (*suspend) (struct pnp_dev *dev, pm_message_t state);
	int (*resume) (struct pnp_dev *dev);
	struct device_driver driver;
};

#define	to_pnp_driver(drv) container_of(drv, struct pnp_driver, driver)

struct pnp_card_driver {
	struct list_head global_list;
	char *name;
	const struct pnp_card_device_id *id_table;
	unsigned int flags;
	int (*probe) (struct pnp_card_link *card,
		      const struct pnp_card_device_id *card_id);
	void (*remove) (struct pnp_card_link *card);
	int (*suspend) (struct pnp_card_link *card, pm_message_t state);
	int (*resume) (struct pnp_card_link *card);
	struct pnp_driver link;
};

#define	to_pnp_card_driver(drv) container_of(drv, struct pnp_card_driver, link)

/* pnp driver flags */
#define PNP_DRIVER_RES_DO_NOT_CHANGE	0x0001	/* do not change the state of the device */
#define PNP_DRIVER_RES_DISABLE		0x0003	/* ensure the device is disabled */

/*
 * Protocol Management
 */

struct pnp_protocol {
	struct list_head protocol_list;
	char *name;

	/* resource control functions */
	int (*get) (struct pnp_dev *dev);
	int (*set) (struct pnp_dev *dev);
	int (*disable) (struct pnp_dev *dev);

	/* protocol specific suspend/resume */
	int (*suspend) (struct pnp_dev * dev, pm_message_t state);
	int (*resume) (struct pnp_dev * dev);

	/* used by pnp layer only (look but don't touch) */
	unsigned char number;	/* protocol number */
	struct device dev;	/* link to driver model */
	struct list_head cards;
	struct list_head devices;
};

#define to_pnp_protocol(n) list_entry(n, struct pnp_protocol, protocol_list)
#define protocol_for_each_card(protocol,card) \
	for((card) = protocol_to_pnp_card((protocol)->cards.next); \
	(card) != protocol_to_pnp_card(&(protocol)->cards); \
	(card) = protocol_to_pnp_card((card)->protocol_list.next))
#define protocol_for_each_dev(protocol,dev) \
	for((dev) = protocol_to_pnp_dev((protocol)->devices.next); \
	(dev) != protocol_to_pnp_dev(&(protocol)->devices); \
	(dev) = protocol_to_pnp_dev((dev)->protocol_list.next))

extern struct bus_type pnp_bus_type;

#if defined(CONFIG_PNP)

/* device management */
int pnp_device_attach(struct pnp_dev *pnp_dev);
void pnp_device_detach(struct pnp_dev *pnp_dev);
extern struct list_head pnp_global;
extern int pnp_platform_devices;

/* multidevice card support */
struct pnp_dev *pnp_request_card_device(struct pnp_card_link *clink,
					const char *id, struct pnp_dev *from);
void pnp_release_card_device(struct pnp_dev *dev);
int pnp_register_card_driver(struct pnp_card_driver *drv);
void pnp_unregister_card_driver(struct pnp_card_driver *drv);
extern struct list_head pnp_cards;

/* resource management */
int pnp_auto_config_dev(struct pnp_dev *dev);
int pnp_start_dev(struct pnp_dev *dev);
int pnp_stop_dev(struct pnp_dev *dev);
int pnp_activate_dev(struct pnp_dev *dev);
int pnp_disable_dev(struct pnp_dev *dev);

/* protocol helpers */
int pnp_is_active(struct pnp_dev *dev);
int compare_pnp_id(struct pnp_id *pos, const char *id);
int pnp_register_driver(struct pnp_driver *drv);
void pnp_unregister_driver(struct pnp_driver *drv);

#else

/* device management */
static inline int pnp_device_attach(struct pnp_dev *pnp_dev) { return -ENODEV; }
static inline void pnp_device_detach(struct pnp_dev *pnp_dev) { }

#define pnp_platform_devices 0

/* multidevice card support */
static inline struct pnp_dev *pnp_request_card_device(struct pnp_card_link *clink, const char *id, struct pnp_dev *from) { return NULL; }
static inline void pnp_release_card_device(struct pnp_dev *dev) { }
static inline int pnp_register_card_driver(struct pnp_card_driver *drv) { return -ENODEV; }
static inline void pnp_unregister_card_driver(struct pnp_card_driver *drv) { }

/* resource management */
static inline int pnp_auto_config_dev(struct pnp_dev *dev) { return -ENODEV; }
static inline int pnp_start_dev(struct pnp_dev *dev) { return -ENODEV; }
static inline int pnp_stop_dev(struct pnp_dev *dev) { return -ENODEV; }
static inline int pnp_activate_dev(struct pnp_dev *dev) { return -ENODEV; }
static inline int pnp_disable_dev(struct pnp_dev *dev) { return -ENODEV; }

/* protocol helpers */
static inline int pnp_is_active(struct pnp_dev *dev) { return 0; }
static inline int compare_pnp_id(struct pnp_id *pos, const char *id) { return -ENODEV; }
static inline int pnp_register_driver(struct pnp_driver *drv) { return -ENODEV; }
static inline void pnp_unregister_driver(struct pnp_driver *drv) { }

#endif /* CONFIG_PNP */

#define pnp_err(format, arg...) printk(KERN_ERR "pnp: " format "\n" , ## arg)
#define pnp_info(format, arg...) printk(KERN_INFO "pnp: " format "\n" , ## arg)
#define pnp_warn(format, arg...) printk(KERN_WARNING "pnp: " format "\n" , ## arg)

#ifdef CONFIG_PNP_DEBUG
#define pnp_dbg(format, arg...) printk(KERN_DEBUG "pnp: " format "\n" , ## arg)
#else
#define pnp_dbg(format, arg...) do {} while (0)
#endif

#endif /* _LINUX_PNP_H */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* Linux Plug and Play Support
	3	* Copyright by Adam Belay <ambx1@neo.rr.com>
1da177e4 LT	4	*/
	5
	6	#ifndef _LINUX_PNP_H
	7	#define _LINUX_PNP_H
	8
1da177e4 LT	9	#include <linux/device.h>
	10	#include <linux/list.h>
	11	#include <linux/errno.h>
	12	#include <linux/mod_devicetable.h>
	13
1da177e4 LT	14	#define PNP_NAME_LEN 50
	15
	16	struct pnp_protocol;
	17	struct pnp_dev;
	18
1da177e4 LT	19	/*
	20	* Resource Management
	21	*/
b90eca0a	22	struct resource pnp_get_resource(struct pnp_dev , unsigned int, unsigned int);
1da177e4	23
13575e81 BH	24	static inline int pnp_resource_valid(struct resource *res)
13575e81 BH	25	{
aee3ad81 BH	26	if (res)
	27	return 1;
	28	return 0;
	29	}
	30
	31	static inline int pnp_resource_enabled(struct resource *res)
	32	{
	33	if (res && !(res->flags & IORESOURCE_DISABLED))
13575e81 BH	34	return 1;
	35	return 0;
	36	}
	37
	38	static inline resource_size_t pnp_resource_len(struct resource *res)
	39	{
	40	if (res->start == 0 && res->end == 0)
	41	return 0;
	42	return res->end - res->start + 1;
	43	}
	44
	45
	46	static inline resource_size_t pnp_port_start(struct pnp_dev *dev,
	47	unsigned int bar)
	48	{
20bfdbba BH	49	struct resource *res = pnp_get_resource(dev, IORESOURCE_IO, bar);
	50
	51	if (pnp_resource_valid(res))
	52	return res->start;
	53	return 0;
13575e81 BH	54	}
	55
	56	static inline resource_size_t pnp_port_end(struct pnp_dev *dev,
	57	unsigned int bar)
	58	{
20bfdbba BH	59	struct resource *res = pnp_get_resource(dev, IORESOURCE_IO, bar);
	60
	61	if (pnp_resource_valid(res))
	62	return res->end;
	63	return 0;
13575e81 BH	64	}
	65
	66	static inline unsigned long pnp_port_flags(struct pnp_dev *dev,
	67	unsigned int bar)
	68	{
20bfdbba BH	69	struct resource *res = pnp_get_resource(dev, IORESOURCE_IO, bar);
	70
	71	if (pnp_resource_valid(res))
	72	return res->flags;
aee3ad81	73	return IORESOURCE_IO \| IORESOURCE_AUTO;
13575e81 BH	74	}
	75
	76	static inline int pnp_port_valid(struct pnp_dev *dev, unsigned int bar)
	77	{
	78	return pnp_resource_valid(pnp_get_resource(dev, IORESOURCE_IO, bar));
	79	}
	80
	81	static inline resource_size_t pnp_port_len(struct pnp_dev *dev,
	82	unsigned int bar)
	83	{
20bfdbba BH	84	struct resource *res = pnp_get_resource(dev, IORESOURCE_IO, bar);
	85
	86	if (pnp_resource_valid(res))
	87	return pnp_resource_len(res);
	88	return 0;
13575e81 BH	89	}
	90
	91
	92	static inline resource_size_t pnp_mem_start(struct pnp_dev *dev,
	93	unsigned int bar)
	94	{
20bfdbba BH	95	struct resource *res = pnp_get_resource(dev, IORESOURCE_MEM, bar);
	96
	97	if (pnp_resource_valid(res))
	98	return res->start;
	99	return 0;
13575e81 BH	100	}
	101
	102	static inline resource_size_t pnp_mem_end(struct pnp_dev *dev,
	103	unsigned int bar)
	104	{
20bfdbba BH	105	struct resource *res = pnp_get_resource(dev, IORESOURCE_MEM, bar);
	106
	107	if (pnp_resource_valid(res))
	108	return res->end;
	109	return 0;
13575e81 BH	110	}
	111
	112	static inline unsigned long pnp_mem_flags(struct pnp_dev *dev, unsigned int bar)
	113	{
20bfdbba BH	114	struct resource *res = pnp_get_resource(dev, IORESOURCE_MEM, bar);
	115
	116	if (pnp_resource_valid(res))
	117	return res->flags;
aee3ad81	118	return IORESOURCE_MEM \| IORESOURCE_AUTO;
13575e81 BH	119	}
	120
	121	static inline int pnp_mem_valid(struct pnp_dev *dev, unsigned int bar)
	122	{
	123	return pnp_resource_valid(pnp_get_resource(dev, IORESOURCE_MEM, bar));
	124	}
	125
	126	static inline resource_size_t pnp_mem_len(struct pnp_dev *dev,
	127	unsigned int bar)
	128	{
20bfdbba BH	129	struct resource *res = pnp_get_resource(dev, IORESOURCE_MEM, bar);
	130
	131	if (pnp_resource_valid(res))
	132	return pnp_resource_len(res);
	133	return 0;
13575e81 BH	134	}
	135
	136
	137	static inline resource_size_t pnp_irq(struct pnp_dev *dev, unsigned int bar)
	138	{
20bfdbba BH	139	struct resource *res = pnp_get_resource(dev, IORESOURCE_IRQ, bar);
	140
	141	if (pnp_resource_valid(res))
	142	return res->start;
	143	return -1;
13575e81 BH	144	}
	145
	146	static inline unsigned long pnp_irq_flags(struct pnp_dev *dev, unsigned int bar)
	147	{
20bfdbba BH	148	struct resource *res = pnp_get_resource(dev, IORESOURCE_IRQ, bar);
	149
	150	if (pnp_resource_valid(res))
	151	return res->flags;
aee3ad81	152	return IORESOURCE_IRQ \| IORESOURCE_AUTO;
13575e81 BH	153	}
	154
	155	static inline int pnp_irq_valid(struct pnp_dev *dev, unsigned int bar)
	156	{
	157	return pnp_resource_valid(pnp_get_resource(dev, IORESOURCE_IRQ, bar));
	158	}
	159
	160
	161	static inline resource_size_t pnp_dma(struct pnp_dev *dev, unsigned int bar)
	162	{
20bfdbba BH	163	struct resource *res = pnp_get_resource(dev, IORESOURCE_DMA, bar);
	164
	165	if (pnp_resource_valid(res))
	166	return res->start;
	167	return -1;
13575e81 BH	168	}
	169
	170	static inline unsigned long pnp_dma_flags(struct pnp_dev *dev, unsigned int bar)
	171	{
20bfdbba BH	172	struct resource *res = pnp_get_resource(dev, IORESOURCE_DMA, bar);
	173
	174	if (pnp_resource_valid(res))
	175	return res->flags;
aee3ad81	176	return IORESOURCE_DMA \| IORESOURCE_AUTO;
13575e81 BH	177	}
	178
	179	static inline int pnp_dma_valid(struct pnp_dev *dev, unsigned int bar)
	180	{
	181	return pnp_resource_valid(pnp_get_resource(dev, IORESOURCE_DMA, bar));
	182	}
1da177e4	183
1da177e4 LT	184
	185	#define PNP_PORT_FLAG_16BITADDR (1<<0)
	186	#define PNP_PORT_FLAG_FIXED (1<<1)
	187
	188	struct pnp_port {
9dd78466 BH	189	unsigned short min; /* min base number */
	190	unsigned short max; /* max base number */
	191	unsigned char align; /* align boundary */
	192	unsigned char size; /* size of range */
	193	unsigned char flags; /* port flags */
	194	unsigned char pad; /* pad */
	195	struct pnp_port next; / next port */
1da177e4 LT	196	};
	197
	198	#define PNP_IRQ_NR 256
	199	struct pnp_irq {
07d4e9af	200	DECLARE_BITMAP(map, PNP_IRQ_NR); /* bitmask for IRQ lines */
9dd78466 BH	201	unsigned char flags; /* IRQ flags */
	202	unsigned char pad; /* pad */
	203	struct pnp_irq next; / next IRQ */
1da177e4 LT	204	};
	205
	206	struct pnp_dma {
9dd78466 BH	207	unsigned char map; /* bitmask for DMA channels */
	208	unsigned char flags; /* DMA flags */
	209	struct pnp_dma next; / next port */
1da177e4 LT	210	};
	211
	212	struct pnp_mem {
9dd78466 BH	213	unsigned int min; /* min base number */
	214	unsigned int max; /* max base number */
	215	unsigned int align; /* align boundary */
	216	unsigned int size; /* size of range */
	217	unsigned char flags; /* memory flags */
	218	unsigned char pad; /* pad */
	219	struct pnp_mem next; / next memory resource */
1da177e4 LT	220	};
	221
	222	#define PNP_RES_PRIORITY_PREFERRED 0
	223	#define PNP_RES_PRIORITY_ACCEPTABLE 1
	224	#define PNP_RES_PRIORITY_FUNCTIONAL 2
	225	#define PNP_RES_PRIORITY_INVALID 65535
	226
	227	struct pnp_option {
	228	unsigned short priority; /* priority */
07d4e9af BH	229	struct pnp_port port; / first port */
	230	struct pnp_irq irq; / first IRQ */
	231	struct pnp_dma dma; / first DMA */
	232	struct pnp_mem mem; / first memory resource */
1da177e4 LT	233	struct pnp_option next; / used to chain dependent resources */
	234	};
	235
1da177e4	236	/*
fd3f8984	237	* Device Management
1da177e4 LT	238	*/
	239
	240	struct pnp_card {
07d4e9af BH	241	struct device dev; /* Driver Model device interface */
07d4e9af BH	242	unsigned char number; /* used as an index, must be unique */
1da177e4 LT	243	struct list_head global_list; /* node in global list of cards */
	244	struct list_head protocol_list; /* node in protocol's list of cards */
	245	struct list_head devices; /* devices attached to the card */
	246
9dd78466	247	struct pnp_protocol *protocol;
07d4e9af	248	struct pnp_id id; / contains supported EISA IDs */
1da177e4 LT	249
1da177e4 LT	250	char name[PNP_NAME_LEN]; /* contains a human-readable name */
07d4e9af	251	unsigned char pnpver; /* Plug & Play version */
9dd78466	252	unsigned char productver; /* product version */
07d4e9af BH	253	unsigned int serial; /* serial number */
07d4e9af BH	254	unsigned char checksum; /* if zero - checksum passed */
1da177e4 LT	255	struct proc_dir_entry procdir; / directory entry in /proc/bus/isapnp */
	256	};
	257
	258	#define global_to_pnp_card(n) list_entry(n, struct pnp_card, global_list)
	259	#define protocol_to_pnp_card(n) list_entry(n, struct pnp_card, protocol_list)
	260	#define to_pnp_card(n) container_of(n, struct pnp_card, dev)
	261	#define pnp_for_each_card(card) \
	262	for((card) = global_to_pnp_card(pnp_cards.next); \
	263	(card) != global_to_pnp_card(&pnp_cards); \
	264	(card) = global_to_pnp_card((card)->global_list.next))
	265
	266	struct pnp_card_link {
9dd78466 BH	267	struct pnp_card *card;
	268	struct pnp_card_driver *driver;
	269	void *driver_data;
4c98cfef	270	pm_message_t pm_state;
1da177e4 LT	271	};
1da177e4 LT	272
9dd78466	273	static inline void pnp_get_card_drvdata(struct pnp_card_link pcard)
1da177e4 LT	274	{
	275	return pcard->driver_data;
	276	}
	277
9dd78466	278	static inline void pnp_set_card_drvdata(struct pnp_card_link pcard, void data)
1da177e4 LT	279	{
	280	pcard->driver_data = data;
	281	}
	282
	283	struct pnp_dev {
07d4e9af	284	struct device dev; /* Driver Model device interface */
2e17c550	285	u64 dma_mask;
544451a1	286	unsigned int number; /* used as an index, must be unique */
1da177e4 LT	287	int status;
	288
	289	struct list_head global_list; /* node in global list of devices */
	290	struct list_head protocol_list; /* node in list of device's protocol */
	291	struct list_head card_list; /* node in card's list of devices */
	292	struct list_head rdev_list; /* node in cards list of requested devices */
	293
9dd78466 BH	294	struct pnp_protocol *protocol;
	295	struct pnp_card card; / card the device is attached to, none if NULL */
	296	struct pnp_driver *driver;
	297	struct pnp_card_link *card_link;
1da177e4	298
07d4e9af	299	struct pnp_id id; / supported EISA IDs */
1da177e4 LT	300
	301	int active;
	302	int capabilities;
9dd78466 BH	303	struct pnp_option *independent;
9dd78466 BH	304	struct pnp_option *dependent;
aee3ad81	305	struct list_head resources;
1da177e4 LT	306
1da177e4 LT	307	char name[PNP_NAME_LEN]; /* contains a human-readable name */
07d4e9af	308	int flags; /* used by protocols */
1da177e4 LT	309	struct proc_dir_entry procent; / device entry in /proc/bus/isapnp */
	310	void *data;
	311	};
	312
	313	#define global_to_pnp_dev(n) list_entry(n, struct pnp_dev, global_list)
	314	#define card_to_pnp_dev(n) list_entry(n, struct pnp_dev, card_list)
	315	#define protocol_to_pnp_dev(n) list_entry(n, struct pnp_dev, protocol_list)
	316	#define to_pnp_dev(n) container_of(n, struct pnp_dev, dev)
	317	#define pnp_for_each_dev(dev) \
	318	for((dev) = global_to_pnp_dev(pnp_global.next); \
	319	(dev) != global_to_pnp_dev(&pnp_global); \
	320	(dev) = global_to_pnp_dev((dev)->global_list.next))
	321	#define card_for_each_dev(card,dev) \
	322	for((dev) = card_to_pnp_dev((card)->devices.next); \
	323	(dev) != card_to_pnp_dev(&(card)->devices); \
	324	(dev) = card_to_pnp_dev((dev)->card_list.next))
	325	#define pnp_dev_name(dev) (dev)->name
	326
9dd78466	327	static inline void pnp_get_drvdata(struct pnp_dev pdev)
1da177e4 LT	328	{
	329	return dev_get_drvdata(&pdev->dev);
	330	}
	331
9dd78466	332	static inline void pnp_set_drvdata(struct pnp_dev pdev, void data)
1da177e4 LT	333	{
	334	dev_set_drvdata(&pdev->dev, data);
	335	}
	336
	337	struct pnp_fixup {
	338	char id[7];
9dd78466	339	void (quirk_function) (struct pnp_dev dev); /* fixup function */
1da177e4 LT	340	};
	341
	342	/* config parameters */
	343	#define PNP_CONFIG_NORMAL 0x0001
	344	#define PNP_CONFIG_FORCE 0x0002 /* disables validity checking */
	345
	346	/* capabilities */
	347	#define PNP_READ 0x0001
	348	#define PNP_WRITE 0x0002
	349	#define PNP_DISABLE 0x0004
	350	#define PNP_CONFIGURABLE 0x0008
	351	#define PNP_REMOVABLE 0x0010
	352
402b310c	353	#define pnp_can_read(dev) (((dev)->protocol->get) && \
1da177e4	354	((dev)->capabilities & PNP_READ))
402b310c	355	#define pnp_can_write(dev) (((dev)->protocol->set) && \
1da177e4	356	((dev)->capabilities & PNP_WRITE))
402b310c	357	#define pnp_can_disable(dev) (((dev)->protocol->disable) && \
1da177e4 LT	358	((dev)->capabilities & PNP_DISABLE))
	359	#define pnp_can_configure(dev) ((!(dev)->active) && \
	360	((dev)->capabilities & PNP_CONFIGURABLE))
	361
	362	#ifdef CONFIG_ISAPNP
	363	extern struct pnp_protocol isapnp_protocol;
	364	#define pnp_device_is_isapnp(dev) ((dev)->protocol == (&isapnp_protocol))
	365	#else
	366	#define pnp_device_is_isapnp(dev) 0
	367	#endif
b3bd86e2	368	extern struct mutex pnp_res_mutex;
1da177e4 LT	369
	370	#ifdef CONFIG_PNPBIOS
	371	extern struct pnp_protocol pnpbios_protocol;
	372	#define pnp_device_is_pnpbios(dev) ((dev)->protocol == (&pnpbios_protocol))
	373	#else
	374	#define pnp_device_is_pnpbios(dev) 0
	375	#endif
	376
1da177e4 LT	377	/* status */
	378	#define PNP_READY 0x0000
	379	#define PNP_ATTACHED 0x0001
	380	#define PNP_BUSY 0x0002
	381	#define PNP_FAULTY 0x0004
	382
	383	/* isapnp specific macros */
	384
	385	#define isapnp_card_number(dev) ((dev)->card ? (dev)->card->number : -1)
	386	#define isapnp_csn_number(dev) ((dev)->number)
	387
	388	/*
	389	* Driver Management
	390	*/
	391
	392	struct pnp_id {
	393	char id[PNP_ID_LEN];
9dd78466	394	struct pnp_id *next;
1da177e4 LT	395	};
	396
	397	struct pnp_driver {
9dd78466	398	char *name;
1da177e4 LT	399	const struct pnp_device_id *id_table;
1da177e4 LT	400	unsigned int flags;
07d4e9af BH	401	int (probe) (struct pnp_dev dev, const struct pnp_device_id *dev_id);
	402	void (remove) (struct pnp_dev dev);
	403	int (suspend) (struct pnp_dev dev, pm_message_t state);
	404	int (resume) (struct pnp_dev dev);
1da177e4 LT	405	struct device_driver driver;
	406	};
	407
	408	#define to_pnp_driver(drv) container_of(drv, struct pnp_driver, driver)
	409
	410	struct pnp_card_driver {
	411	struct list_head global_list;
9dd78466	412	char *name;
1da177e4 LT	413	const struct pnp_card_device_id *id_table;
1da177e4 LT	414	unsigned int flags;
07d4e9af BH	415	int (probe) (struct pnp_card_link card,
	416	const struct pnp_card_device_id *card_id);
	417	void (remove) (struct pnp_card_link card);
	418	int (suspend) (struct pnp_card_link card, pm_message_t state);
	419	int (resume) (struct pnp_card_link card);
1da177e4 LT	420	struct pnp_driver link;
	421	};
	422
	423	#define to_pnp_card_driver(drv) container_of(drv, struct pnp_card_driver, link)
	424
	425	/* pnp driver flags */
	426	#define PNP_DRIVER_RES_DO_NOT_CHANGE 0x0001 /* do not change the state of the device */
	427	#define PNP_DRIVER_RES_DISABLE 0x0003 /* ensure the device is disabled */
	428
1da177e4 LT	429	/*
	430	* Protocol Management
	431	*/
	432
	433	struct pnp_protocol {
9dd78466 BH	434	struct list_head protocol_list;
9dd78466 BH	435	char *name;
1da177e4 LT	436
1da177e4 LT	437	/* resource control functions */
59284cb4 BH	438	int (get) (struct pnp_dev dev);
59284cb4 BH	439	int (set) (struct pnp_dev dev);
07d4e9af	440	int (disable) (struct pnp_dev dev);
1da177e4	441
fc30e68e	442	/* protocol specific suspend/resume */
9dd78466 BH	443	int (suspend) (struct pnp_dev dev, pm_message_t state);
9dd78466 BH	444	int (resume) (struct pnp_dev dev);
fc30e68e	445
1da177e4	446	/* used by pnp layer only (look but don't touch) */
9dd78466 BH	447	unsigned char number; /* protocol number */
	448	struct device dev; /* link to driver model */
	449	struct list_head cards;
	450	struct list_head devices;
1da177e4 LT	451	};
	452
	453	#define to_pnp_protocol(n) list_entry(n, struct pnp_protocol, protocol_list)
	454	#define protocol_for_each_card(protocol,card) \
	455	for((card) = protocol_to_pnp_card((protocol)->cards.next); \
	456	(card) != protocol_to_pnp_card(&(protocol)->cards); \
	457	(card) = protocol_to_pnp_card((card)->protocol_list.next))
	458	#define protocol_for_each_dev(protocol,dev) \
	459	for((dev) = protocol_to_pnp_dev((protocol)->devices.next); \
	460	(dev) != protocol_to_pnp_dev(&(protocol)->devices); \
	461	(dev) = protocol_to_pnp_dev((dev)->protocol_list.next))
	462
cbcdc1de DB	463	extern struct bus_type pnp_bus_type;
cbcdc1de DB	464
1da177e4 LT	465	#if defined(CONFIG_PNP)
	466
	467	/* device management */
1da177e4 LT	468	int pnp_device_attach(struct pnp_dev *pnp_dev);
	469	void pnp_device_detach(struct pnp_dev *pnp_dev);
	470	extern struct list_head pnp_global;
8f81dd14	471	extern int pnp_platform_devices;
1da177e4 LT	472
1da177e4 LT	473	/* multidevice card support */
9dd78466 BH	474	struct pnp_dev pnp_request_card_device(struct pnp_card_link clink,
	475	const char id, struct pnp_dev from);
	476	void pnp_release_card_device(struct pnp_dev *dev);
	477	int pnp_register_card_driver(struct pnp_card_driver *drv);
	478	void pnp_unregister_card_driver(struct pnp_card_driver *drv);
1da177e4 LT	479	extern struct list_head pnp_cards;
	480
	481	/* resource management */
1da177e4	482	int pnp_auto_config_dev(struct pnp_dev *dev);
68094e32 PO	483	int pnp_start_dev(struct pnp_dev *dev);
68094e32 PO	484	int pnp_stop_dev(struct pnp_dev *dev);
1da177e4 LT	485	int pnp_activate_dev(struct pnp_dev *dev);
1da177e4 LT	486	int pnp_disable_dev(struct pnp_dev *dev);
1da177e4 LT	487
1da177e4 LT	488	/* protocol helpers */
9dd78466 BH	489	int pnp_is_active(struct pnp_dev *dev);
9dd78466 BH	490	int compare_pnp_id(struct pnp_id pos, const char id);
1da177e4 LT	491	int pnp_register_driver(struct pnp_driver *drv);
	492	void pnp_unregister_driver(struct pnp_driver *drv);
	493
	494	#else
	495
	496	/* device management */
07d4e9af BH	497	static inline int pnp_device_attach(struct pnp_dev *pnp_dev) { return -ENODEV; }
07d4e9af BH	498	static inline void pnp_device_detach(struct pnp_dev *pnp_dev) { }
9dd78466	499
8f81dd14	500	#define pnp_platform_devices 0
1da177e4 LT	501
1da177e4 LT	502	/* multidevice card support */
07d4e9af BH	503	static inline struct pnp_dev pnp_request_card_device(struct pnp_card_link clink, const char id, struct pnp_dev from) { return NULL; }
	504	static inline void pnp_release_card_device(struct pnp_dev *dev) { }
	505	static inline int pnp_register_card_driver(struct pnp_card_driver *drv) { return -ENODEV; }
	506	static inline void pnp_unregister_card_driver(struct pnp_card_driver *drv) { }
1da177e4 LT	507
1da177e4 LT	508	/* resource management */
07d4e9af	509	static inline int pnp_auto_config_dev(struct pnp_dev *dev) { return -ENODEV; }
07d4e9af BH	510	static inline int pnp_start_dev(struct pnp_dev *dev) { return -ENODEV; }
	511	static inline int pnp_stop_dev(struct pnp_dev *dev) { return -ENODEV; }
	512	static inline int pnp_activate_dev(struct pnp_dev *dev) { return -ENODEV; }
	513	static inline int pnp_disable_dev(struct pnp_dev *dev) { return -ENODEV; }
1da177e4 LT	514
1da177e4 LT	515	/* protocol helpers */
07d4e9af BH	516	static inline int pnp_is_active(struct pnp_dev *dev) { return 0; }
07d4e9af BH	517	static inline int compare_pnp_id(struct pnp_id pos, const char id) { return -ENODEV; }
07d4e9af BH	518	static inline int pnp_register_driver(struct pnp_driver *drv) { return -ENODEV; }
07d4e9af BH	519	static inline void pnp_unregister_driver(struct pnp_driver *drv) { }
1da177e4 LT	520
	521	#endif /* CONFIG_PNP */
	522
1da177e4 LT	523	#define pnp_err(format, arg...) printk(KERN_ERR "pnp: " format "\n" , ## arg)
	524	#define pnp_info(format, arg...) printk(KERN_INFO "pnp: " format "\n" , ## arg)
	525	#define pnp_warn(format, arg...) printk(KERN_WARNING "pnp: " format "\n" , ## arg)
	526
e139aa59	527	#ifdef CONFIG_PNP_DEBUG
1da177e4 LT	528	#define pnp_dbg(format, arg...) printk(KERN_DEBUG "pnp: " format "\n" , ## arg)
	529	#else
	530	#define pnp_dbg(format, arg...) do {} while (0)
	531	#endif
	532
1da177e4	533	#endif /* _LINUX_PNP_H */