[deliverable/linux.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;
struct pnp_resource_table;

/*
 * 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 && !(res->flags & IORESOURCE_UNSET))
		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)
{
	return pnp_get_resource(dev, IORESOURCE_IO, bar)->start;
}

static inline resource_size_t pnp_port_end(struct pnp_dev *dev,
					   unsigned int bar)
{
	return pnp_get_resource(dev, IORESOURCE_IO, bar)->end;
}

static inline unsigned long pnp_port_flags(struct pnp_dev *dev,
					   unsigned int bar)
{
	return pnp_get_resource(dev, IORESOURCE_IO, bar)->flags;
}

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)
{
	return pnp_resource_len(pnp_get_resource(dev, IORESOURCE_IO, bar));
}


static inline resource_size_t pnp_mem_start(struct pnp_dev *dev,
					    unsigned int bar)
{
	return pnp_get_resource(dev, IORESOURCE_MEM, bar)->start;
}

static inline resource_size_t pnp_mem_end(struct pnp_dev *dev,
					  unsigned int bar)
{
	return pnp_get_resource(dev, IORESOURCE_MEM, bar)->end;
}

static inline unsigned long pnp_mem_flags(struct pnp_dev *dev, unsigned int bar)
{
	return pnp_get_resource(dev, IORESOURCE_MEM, bar)->flags;
}

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)
{
	return pnp_resource_len(pnp_get_resource(dev, IORESOURCE_MEM, bar));
}


static inline resource_size_t pnp_irq(struct pnp_dev *dev, unsigned int bar)
{
	return pnp_get_resource(dev, IORESOURCE_IRQ, bar)->start;
}

static inline unsigned long pnp_irq_flags(struct pnp_dev *dev, unsigned int bar)
{
	return pnp_get_resource(dev, IORESOURCE_IRQ, bar)->flags;
}

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)
{
	return pnp_get_resource(dev, IORESOURCE_DMA, bar)->start;
}

static inline unsigned long pnp_dma_flags(struct pnp_dev *dev, unsigned int bar)
{
	return pnp_get_resource(dev, IORESOURCE_DMA, bar)->flags;
}

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 pnp_resource_table *res;

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