[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
 */

/* 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 char 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, struct pnp_resource_table *res);
	int (*set) (struct pnp_dev *dev, struct pnp_resource_table *res);
	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);
int pnp_add_card_id(struct pnp_id *id, struct pnp_card *card);
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_option *option, struct pnp_irq *data);
int pnp_register_dma_resource(struct pnp_option *option, struct pnp_dma *data);
int pnp_register_port_resource(struct pnp_option *option,
			       struct pnp_port *data);
int pnp_register_mem_resource(struct pnp_option *option, struct pnp_mem *data);
void pnp_init_resource_table(struct pnp_resource_table *table);
int pnp_manual_config_dev(struct pnp_dev *dev, struct pnp_resource_table *res,
			  int mode);
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);
void pnp_resource_change(struct resource *resource, resource_size_t start,
			 resource_size_t size);

/* protocol helpers */
int pnp_is_active(struct pnp_dev *dev);
int compare_pnp_id(struct pnp_id *pos, const char *id);
int pnp_add_id(struct pnp_id *id, struct pnp_dev *dev);
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 int pnp_add_card_id(struct pnp_id *id, struct pnp_card *card) { return -ENODEV; }
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_option *option, struct pnp_irq *data) { return -ENODEV; }
static inline int pnp_register_dma_resource(struct pnp_option *option, struct pnp_dma *data) { return -ENODEV; }
static inline int pnp_register_port_resource(struct pnp_option *option, struct pnp_port *data) { return -ENODEV; }
static inline int pnp_register_mem_resource(struct pnp_option *option, struct pnp_mem *data) { return -ENODEV; }
static inline void pnp_init_resource_table(struct pnp_resource_table *table) { }
static inline int pnp_manual_config_dev(struct pnp_dev *dev, struct pnp_resource_table *res, int mode) { return -ENODEV; }
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; }
static inline void pnp_resource_change(struct resource *resource, resource_size_t start, resource_size_t size) { }

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