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

/*
 * Linux Plug and Play Support
 * Copyright by Adam Belay <ambx1@neo.rr.com>
 * Copyright (C) 2008 Hewlett-Packard Development Company, L.P.
 *	Bjorn Helgaas <bjorn.helgaas@hp.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>
#include <linux/console.h>

#define PNP_NAME_LEN		50

struct pnp_protocol;
struct pnp_dev;

/*
 * Resource Management
 */
#ifdef CONFIG_PNP
struct resource *pnp_get_resource(struct pnp_dev *dev, unsigned long type,
				unsigned int num);
#else
static inline struct resource *pnp_get_resource(struct pnp_dev *dev,
			unsigned long type, unsigned int num)
{
	return NULL;
}
#endif

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

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

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


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

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

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

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

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

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

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

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

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


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

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

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

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

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

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

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

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

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


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

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

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

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

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


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

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

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

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

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


/*
 * 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;
	unsigned int num_dependent_sets;
	struct list_head resources;
	struct list_head options;

	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_CONSOLE		0x0020

#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) &&	  \
				 (!((dev)->capabilities & PNP_CONSOLE) || \
				  console_suspend_enabled))
#define pnp_can_configure(dev)	((!(dev)->active) && \
				 ((dev)->capabilities & PNP_CONFIGURABLE))
#define pnp_can_suspend(dev)	(((dev)->protocol->suspend) &&		  \
				 (!((dev)->capabilities & PNP_CONSOLE) || \
				  console_suspend_enabled))


#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;
extern bool arch_pnpbios_disabled(void);
#define pnp_device_is_pnpbios(dev) ((dev)->protocol == (&pnpbios_protocol))
#else
#define pnp_device_is_pnpbios(dev) 0
#define arch_pnpbios_disabled()	false
#endif

#ifdef CONFIG_PNPACPI
extern struct pnp_protocol pnpacpi_protocol;

static inline struct acpi_device *pnp_acpi_device(struct pnp_dev *dev)
{
	if (dev->protocol == &pnpacpi_protocol)
		return dev->data;
	return NULL;
}
#else
#define pnp_acpi_device(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);
	void (*shutdown) (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 */
	bool (*can_wakeup) (struct pnp_dev *dev);
	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_possible_config(struct pnp_dev *dev, int type, resource_size_t base,
			resource_size_t size);
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);
int pnp_range_reserved(resource_size_t start, resource_size_t end);

/* 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_possible_config(struct pnp_dev *dev, int type,
				      resource_size_t base,
				      resource_size_t size) { return 0; }
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; }
static inline int pnp_range_reserved(resource_size_t start, resource_size_t end) { return 0;}

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

/**
 * module_pnp_driver() - Helper macro for registering a PnP driver
 * @__pnp_driver: pnp_driver struct
 *
 * Helper macro for PnP drivers which do not do anything special in module
 * init/exit. This eliminates a lot of boilerplate. Each module may only
 * use this macro once, and calling it replaces module_init() and module_exit()
 */
#define module_pnp_driver(__pnp_driver) \
	module_driver(__pnp_driver, pnp_register_driver, \
				    pnp_unregister_driver)

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