[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

#ifdef __KERNEL__

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

#define PNP_MAX_PORT		40
#define PNP_MAX_MEM		24
#define PNP_MAX_IRQ		2
#define PNP_MAX_DMA		2
#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);

/* Use these instead of directly reading pnp_dev to get resource information */
#define pnp_port_start(dev,bar)   ((dev)->res.port_resource[(bar)].start)
#define pnp_port_end(dev,bar)     ((dev)->res.port_resource[(bar)].end)
#define pnp_port_flags(dev,bar)   ((dev)->res.port_resource[(bar)].flags)
#define pnp_port_valid(dev,bar) \
	((pnp_port_flags((dev),(bar)) & (IORESOURCE_IO | IORESOURCE_UNSET)) \
		== IORESOURCE_IO)
#define pnp_port_len(dev,bar) \
	((pnp_port_start((dev),(bar)) == 0 &&	\
	  pnp_port_end((dev),(bar)) ==		\
	  pnp_port_start((dev),(bar))) ? 0 :	\
	  					\
	 (pnp_port_end((dev),(bar)) -		\
	  pnp_port_start((dev),(bar)) + 1))

#define pnp_mem_start(dev,bar)   ((dev)->res.mem_resource[(bar)].start)
#define pnp_mem_end(dev,bar)     ((dev)->res.mem_resource[(bar)].end)
#define pnp_mem_flags(dev,bar)   ((dev)->res.mem_resource[(bar)].flags)
#define pnp_mem_valid(dev,bar) \
	((pnp_mem_flags((dev),(bar)) & (IORESOURCE_MEM | IORESOURCE_UNSET)) \
		== IORESOURCE_MEM)
#define pnp_mem_len(dev,bar) \
	((pnp_mem_start((dev),(bar)) == 0 &&	\
	  pnp_mem_end((dev),(bar)) ==		\
	  pnp_mem_start((dev),(bar))) ? 0 :	\
	  					\
	 (pnp_mem_end((dev),(bar)) -		\
	  pnp_mem_start((dev),(bar)) + 1))

#define pnp_irq(dev,bar)	 ((dev)->res.irq_resource[(bar)].start)
#define pnp_irq_flags(dev,bar)	 ((dev)->res.irq_resource[(bar)].flags)
#define pnp_irq_valid(dev,bar) \
	((pnp_irq_flags((dev),(bar)) & (IORESOURCE_IRQ | IORESOURCE_UNSET)) \
		== IORESOURCE_IRQ)

#define pnp_dma(dev,bar)	 ((dev)->res.dma_resource[(bar)].start)
#define pnp_dma_flags(dev,bar)	 ((dev)->res.dma_resource[(bar)].flags)
#define pnp_dma_valid(dev,bar) \
	((pnp_dma_flags((dev),(bar)) & (IORESOURCE_DMA | IORESOURCE_UNSET)) \
		== IORESOURCE_DMA)

#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 */
};

struct pnp_resource_table {
	struct resource port_resource[PNP_MAX_PORT];
	struct resource mem_resource[PNP_MAX_MEM];
	struct resource dma_resource[PNP_MAX_DMA];
	struct resource irq_resource[PNP_MAX_IRQ];
};

/*
 * 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 */
	unsigned short regs;		/* ISAPnP: supported registers */
	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_register_protocol(struct pnp_protocol *protocol);
void pnp_unregister_protocol(struct pnp_protocol *protocol);
int pnp_add_device(struct pnp_dev *dev);
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 */
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_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 */
struct pnp_option *pnp_register_independent_option(struct pnp_dev *dev);
struct pnp_option *pnp_register_dependent_option(struct pnp_dev *dev,
						 int priority);
int pnp_register_irq_resource(struct pnp_dev *dev, struct pnp_option *option,
			      struct pnp_irq *data);
int pnp_register_dma_resource(struct pnp_dev *dev, struct pnp_option *option,
			      struct pnp_dma *data);
int pnp_register_port_resource(struct pnp_dev *dev, struct pnp_option *option,
			       struct pnp_port *data);
int pnp_register_mem_resource(struct pnp_dev *dev, struct pnp_option *option,
			      struct pnp_mem *data);
void pnp_init_resources(struct pnp_dev *dev);
int pnp_auto_config_dev(struct pnp_dev *dev);
int pnp_validate_config(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_register_protocol(struct pnp_protocol *protocol) { return -ENODEV; }
static inline void pnp_unregister_protocol(struct pnp_protocol *protocol) { }
static inline int pnp_init_device(struct pnp_dev *dev) { return -ENODEV; }
static inline int pnp_add_device(struct pnp_dev *dev) { return -ENODEV; }
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 int pnp_add_card(struct pnp_card *card) { return -ENODEV; }
static inline void pnp_remove_card(struct pnp_card *card) { }
static inline int pnp_add_card_device(struct pnp_card *card, struct pnp_dev *dev) { return -ENODEV; }
static inline void pnp_remove_card_device(struct pnp_dev *dev) { }
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 struct pnp_option *pnp_register_independent_option(struct pnp_dev *dev) { return NULL; }
static inline struct pnp_option *pnp_register_dependent_option(struct pnp_dev *dev, int priority) { return NULL; }
static inline int pnp_register_irq_resource(struct pnp_dev *dev, struct pnp_option *option, struct pnp_irq *data) { return -ENODEV; }
static inline int pnp_register_dma_resource(struct pnp_dev *dev, struct pnp_option *option, struct pnp_dma *data) { return -ENODEV; }
static inline int pnp_register_port_resource(struct pnp_dev *dev, struct pnp_option *option, struct pnp_port *data) { return -ENODEV; }
static inline int pnp_register_mem_resource(struct pnp_dev *dev, struct pnp_option *option, struct pnp_mem *data) { return -ENODEV; }
static inline void pnp_init_resources(struct pnp_dev *dev) { }
static inline int pnp_auto_config_dev(struct pnp_dev *dev) { return -ENODEV; }
static inline int pnp_validate_config(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 /* __KERNEL__ */

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