[deliverable/linux.git] / drivers / pnp / driver.c

/*
 * driver.c - device id matching, driver model, etc.
 *
 * Copyright 2002 Adam Belay <ambx1@neo.rr.com>
 */

#include <linux/string.h>
#include <linux/list.h>
#include <linux/module.h>
#include <linux/ctype.h>
#include <linux/slab.h>
#include <linux/pnp.h>
#include "base.h"

static int compare_func(const char *ida, const char *idb)
{
	int i;

	/* we only need to compare the last 4 chars */
	for (i = 3; i < 7; i++) {
		if (ida[i] != 'X' &&
		    idb[i] != 'X' && toupper(ida[i]) != toupper(idb[i]))
			return 0;
	}
	return 1;
}

int compare_pnp_id(struct pnp_id *pos, const char *id)
{
	if (!pos || !id || (strlen(id) != 7))
		return 0;
	if (memcmp(id, "ANYDEVS", 7) == 0)
		return 1;
	while (pos) {
		if (memcmp(pos->id, id, 3) == 0)
			if (compare_func(pos->id, id) == 1)
				return 1;
		pos = pos->next;
	}
	return 0;
}

static const struct pnp_device_id *match_device(struct pnp_driver *drv,
						struct pnp_dev *dev)
{
	const struct pnp_device_id *drv_id = drv->id_table;

	if (!drv_id)
		return NULL;

	while (*drv_id->id) {
		if (compare_pnp_id(dev->id, drv_id->id))
			return drv_id;
		drv_id++;
	}
	return NULL;
}

int pnp_device_attach(struct pnp_dev *pnp_dev)
{
	spin_lock(&pnp_lock);
	if (pnp_dev->status != PNP_READY) {
		spin_unlock(&pnp_lock);
		return -EBUSY;
	}
	pnp_dev->status = PNP_ATTACHED;
	spin_unlock(&pnp_lock);
	return 0;
}

void pnp_device_detach(struct pnp_dev *pnp_dev)
{
	spin_lock(&pnp_lock);
	if (pnp_dev->status == PNP_ATTACHED)
		pnp_dev->status = PNP_READY;
	spin_unlock(&pnp_lock);
	pnp_disable_dev(pnp_dev);
}

static int pnp_device_probe(struct device *dev)
{
	int error;
	struct pnp_driver *pnp_drv;
	struct pnp_dev *pnp_dev;
	const struct pnp_device_id *dev_id = NULL;
	pnp_dev = to_pnp_dev(dev);
	pnp_drv = to_pnp_driver(dev->driver);

	error = pnp_device_attach(pnp_dev);
	if (error < 0)
		return error;

	if (pnp_dev->active == 0) {
		if (!(pnp_drv->flags & PNP_DRIVER_RES_DO_NOT_CHANGE)) {
			error = pnp_activate_dev(pnp_dev);
			if (error < 0)
				return error;
		}
	} else if ((pnp_drv->flags & PNP_DRIVER_RES_DISABLE)
		   == PNP_DRIVER_RES_DISABLE) {
		error = pnp_disable_dev(pnp_dev);
		if (error < 0)
			return error;
	}
	error = 0;
	if (pnp_drv->probe) {
		dev_id = match_device(pnp_drv, pnp_dev);
		if (dev_id != NULL)
			error = pnp_drv->probe(pnp_dev, dev_id);
	}
	if (error >= 0) {
		pnp_dev->driver = pnp_drv;
		error = 0;
	} else
		goto fail;

	return error;

fail:
	pnp_device_detach(pnp_dev);
	return error;
}

static int pnp_device_remove(struct device *dev)
{
	struct pnp_dev *pnp_dev = to_pnp_dev(dev);
	struct pnp_driver *drv = pnp_dev->driver;

	if (drv) {
		if (drv->remove)
			drv->remove(pnp_dev);
		pnp_dev->driver = NULL;
	}
	pnp_device_detach(pnp_dev);
	return 0;
}

static void pnp_device_shutdown(struct device *dev)
{
	struct pnp_dev *pnp_dev = to_pnp_dev(dev);
	struct pnp_driver *drv = pnp_dev->driver;

	if (drv && drv->shutdown)
		drv->shutdown(pnp_dev);
}

static int pnp_bus_match(struct device *dev, struct device_driver *drv)
{
	struct pnp_dev *pnp_dev = to_pnp_dev(dev);
	struct pnp_driver *pnp_drv = to_pnp_driver(drv);

	if (match_device(pnp_drv, pnp_dev) == NULL)
		return 0;
	return 1;
}

static int __pnp_bus_suspend(struct device *dev, pm_message_t state)
{
	struct pnp_dev *pnp_dev = to_pnp_dev(dev);
	struct pnp_driver *pnp_drv = pnp_dev->driver;
	int error;

	if (!pnp_drv)
		return 0;

	if (pnp_drv->driver.pm && pnp_drv->driver.pm->suspend) {
		error = pnp_drv->driver.pm->suspend(dev);
		suspend_report_result(pnp_drv->driver.pm->suspend, error);
		if (error)
			return error;
	}

	if (pnp_drv->suspend) {
		error = pnp_drv->suspend(pnp_dev, state);
		if (error)
			return error;
	}

	if (pnp_can_disable(pnp_dev)) {
		error = pnp_stop_dev(pnp_dev);
		if (error)
			return error;
	}

	if (pnp_dev->protocol->suspend)
		pnp_dev->protocol->suspend(pnp_dev, state);
	return 0;
}

static int pnp_bus_suspend(struct device *dev)
{
	return __pnp_bus_suspend(dev, PMSG_SUSPEND);
}

static int pnp_bus_freeze(struct device *dev)
{
	return __pnp_bus_suspend(dev, PMSG_FREEZE);
}

static int pnp_bus_poweroff(struct device *dev)
{
	return __pnp_bus_suspend(dev, PMSG_HIBERNATE);
}

static int pnp_bus_resume(struct device *dev)
{
	struct pnp_dev *pnp_dev = to_pnp_dev(dev);
	struct pnp_driver *pnp_drv = pnp_dev->driver;
	int error;

	if (!pnp_drv)
		return 0;

	if (pnp_dev->protocol->resume) {
		error = pnp_dev->protocol->resume(pnp_dev);
		if (error)
			return error;
	}

	if (pnp_can_write(pnp_dev)) {
		error = pnp_start_dev(pnp_dev);
		if (error)
			return error;
	}

	if (pnp_drv->driver.pm && pnp_drv->driver.pm->resume) {
		error = pnp_drv->driver.pm->resume(dev);
		if (error)
			return error;
	}

	if (pnp_drv->resume) {
		error = pnp_drv->resume(pnp_dev);
		if (error)
			return error;
	}

	return 0;
}

static const struct dev_pm_ops pnp_bus_dev_pm_ops = {
	/* Suspend callbacks */
	.suspend = pnp_bus_suspend,
	.resume = pnp_bus_resume,
	/* Hibernate callbacks */
	.freeze = pnp_bus_freeze,
	.thaw = pnp_bus_resume,
	.poweroff = pnp_bus_poweroff,
	.restore = pnp_bus_resume,
};

struct bus_type pnp_bus_type = {
	.name    = "pnp",
	.match   = pnp_bus_match,
	.probe   = pnp_device_probe,
	.remove  = pnp_device_remove,
	.shutdown = pnp_device_shutdown,
	.pm	 = &pnp_bus_dev_pm_ops,
	.dev_groups = pnp_dev_groups,
};

int pnp_register_driver(struct pnp_driver *drv)
{
	drv->driver.name = drv->name;
	drv->driver.bus = &pnp_bus_type;

	return driver_register(&drv->driver);
}

void pnp_unregister_driver(struct pnp_driver *drv)
{
	driver_unregister(&drv->driver);
}

/**
 * pnp_add_id - adds an EISA id to the specified device
 * @dev: pointer to the desired device
 * @id: pointer to an EISA id string
 */
struct pnp_id *pnp_add_id(struct pnp_dev *dev, const char *id)
{
	struct pnp_id *dev_id, *ptr;

	dev_id = kzalloc(sizeof(struct pnp_id), GFP_KERNEL);
	if (!dev_id)
		return NULL;

	dev_id->id[0] = id[0];
	dev_id->id[1] = id[1];
	dev_id->id[2] = id[2];
	dev_id->id[3] = tolower(id[3]);
	dev_id->id[4] = tolower(id[4]);
	dev_id->id[5] = tolower(id[5]);
	dev_id->id[6] = tolower(id[6]);
	dev_id->id[7] = '\0';

	dev_id->next = NULL;
	ptr = dev->id;
	while (ptr && ptr->next)
		ptr = ptr->next;
	if (ptr)
		ptr->next = dev_id;
	else
		dev->id = dev_id;

	return dev_id;
}

EXPORT_SYMBOL(pnp_register_driver);
EXPORT_SYMBOL(pnp_unregister_driver);
EXPORT_SYMBOL(pnp_device_attach);
EXPORT_SYMBOL(pnp_device_detach);
Commit	Line	Data
1da177e4 LT	1	/*
	2	* driver.c - device id matching, driver model, etc.
	3	*
	4	* Copyright 2002 Adam Belay <ambx1@neo.rr.com>
1da177e4 LT	5	*/
1da177e4 LT	6
1da177e4 LT	7	#include <linux/string.h>
	8	#include <linux/list.h>
	9	#include <linux/module.h>
	10	#include <linux/ctype.h>
	11	#include <linux/slab.h>
1da177e4 LT	12	#include <linux/pnp.h>
	13	#include "base.h"
	14
	15	static int compare_func(const char ida, const char idb)
	16	{
	17	int i;
07d4e9af	18
1da177e4	19	/* we only need to compare the last 4 chars */
9dd78466	20	for (i = 3; i < 7; i++) {
1da177e4	21	if (ida[i] != 'X' &&
9dd78466	22	idb[i] != 'X' && toupper(ida[i]) != toupper(idb[i]))
1da177e4 LT	23	return 0;
	24	}
	25	return 1;
	26	}
	27
	28	int compare_pnp_id(struct pnp_id pos, const char id)
	29	{
	30	if (!pos \|\| !id \|\| (strlen(id) != 7))
	31	return 0;
9dd78466	32	if (memcmp(id, "ANYDEVS", 7) == 0)
1da177e4	33	return 1;
9dd78466 BH	34	while (pos) {
	35	if (memcmp(pos->id, id, 3) == 0)
	36	if (compare_func(pos->id, id) == 1)
1da177e4 LT	37	return 1;
	38	pos = pos->next;
	39	}
	40	return 0;
	41	}
	42
9dd78466 BH	43	static const struct pnp_device_id match_device(struct pnp_driver drv,
9dd78466 BH	44	struct pnp_dev *dev)
1da177e4 LT	45	{
1da177e4 LT	46	const struct pnp_device_id *drv_id = drv->id_table;
07d4e9af	47
1da177e4 LT	48	if (!drv_id)
	49	return NULL;
	50
	51	while (*drv_id->id) {
	52	if (compare_pnp_id(dev->id, drv_id->id))
	53	return drv_id;
	54	drv_id++;
	55	}
	56	return NULL;
	57	}
	58
	59	int pnp_device_attach(struct pnp_dev *pnp_dev)
	60	{
	61	spin_lock(&pnp_lock);
9dd78466	62	if (pnp_dev->status != PNP_READY) {
1da177e4 LT	63	spin_unlock(&pnp_lock);
	64	return -EBUSY;
	65	}
	66	pnp_dev->status = PNP_ATTACHED;
	67	spin_unlock(&pnp_lock);
	68	return 0;
	69	}
	70
	71	void pnp_device_detach(struct pnp_dev *pnp_dev)
	72	{
	73	spin_lock(&pnp_lock);
	74	if (pnp_dev->status == PNP_ATTACHED)
	75	pnp_dev->status = PNP_READY;
	76	spin_unlock(&pnp_lock);
	77	pnp_disable_dev(pnp_dev);
	78	}
	79
	80	static int pnp_device_probe(struct device *dev)
	81	{
	82	int error;
	83	struct pnp_driver *pnp_drv;
	84	struct pnp_dev *pnp_dev;
	85	const struct pnp_device_id *dev_id = NULL;
	86	pnp_dev = to_pnp_dev(dev);
	87	pnp_drv = to_pnp_driver(dev->driver);
	88
1da177e4 LT	89	error = pnp_device_attach(pnp_dev);
	90	if (error < 0)
	91	return error;
	92
	93	if (pnp_dev->active == 0) {
	94	if (!(pnp_drv->flags & PNP_DRIVER_RES_DO_NOT_CHANGE)) {
	95	error = pnp_activate_dev(pnp_dev);
	96	if (error < 0)
	97	return error;
	98	}
	99	} else if ((pnp_drv->flags & PNP_DRIVER_RES_DISABLE)
9dd78466	100	== PNP_DRIVER_RES_DISABLE) {
1da177e4 LT	101	error = pnp_disable_dev(pnp_dev);
	102	if (error < 0)
	103	return error;
	104	}
	105	error = 0;
	106	if (pnp_drv->probe) {
	107	dev_id = match_device(pnp_drv, pnp_dev);
	108	if (dev_id != NULL)
	109	error = pnp_drv->probe(pnp_dev, dev_id);
	110	}
9dd78466	111	if (error >= 0) {
1da177e4 LT	112	pnp_dev->driver = pnp_drv;
	113	error = 0;
	114	} else
	115	goto fail;
a05d0781	116
1da177e4 LT	117	return error;
1da177e4 LT	118
1e0aa9ad	119	fail:
1da177e4 LT	120	pnp_device_detach(pnp_dev);
	121	return error;
	122	}
	123
	124	static int pnp_device_remove(struct device *dev)
	125	{
9dd78466 BH	126	struct pnp_dev *pnp_dev = to_pnp_dev(dev);
9dd78466 BH	127	struct pnp_driver *drv = pnp_dev->driver;
1da177e4 LT	128
	129	if (drv) {
	130	if (drv->remove)
	131	drv->remove(pnp_dev);
	132	pnp_dev->driver = NULL;
	133	}
	134	pnp_device_detach(pnp_dev);
	135	return 0;
	136	}
	137
abd6633c DH	138	static void pnp_device_shutdown(struct device *dev)
	139	{
	140	struct pnp_dev *pnp_dev = to_pnp_dev(dev);
	141	struct pnp_driver *drv = pnp_dev->driver;
	142
	143	if (drv && drv->shutdown)
	144	drv->shutdown(pnp_dev);
	145	}
	146
1da177e4 LT	147	static int pnp_bus_match(struct device dev, struct device_driver drv)
1da177e4 LT	148	{
9dd78466 BH	149	struct pnp_dev *pnp_dev = to_pnp_dev(dev);
9dd78466 BH	150	struct pnp_driver *pnp_drv = to_pnp_driver(drv);
07d4e9af	151
1da177e4 LT	152	if (match_device(pnp_drv, pnp_dev) == NULL)
	153	return 0;
	154	return 1;
	155	}
	156
eaf140b6	157	static int __pnp_bus_suspend(struct device *dev, pm_message_t state)
4c98cfef	158	{
9dd78466 BH	159	struct pnp_dev *pnp_dev = to_pnp_dev(dev);
9dd78466 BH	160	struct pnp_driver *pnp_drv = pnp_dev->driver;
68094e32 PO	161	int error;
	162
	163	if (!pnp_drv)
	164	return 0;
	165
729377d5 SK	166	if (pnp_drv->driver.pm && pnp_drv->driver.pm->suspend) {
	167	error = pnp_drv->driver.pm->suspend(dev);
	168	suspend_report_result(pnp_drv->driver.pm->suspend, error);
	169	if (error)
	170	return error;
	171	}
	172
68094e32 PO	173	if (pnp_drv->suspend) {
	174	error = pnp_drv->suspend(pnp_dev, state);
	175	if (error)
	176	return error;
	177	}
	178
5d38998e	179	if (pnp_can_disable(pnp_dev)) {
9dd78466 BH	180	error = pnp_stop_dev(pnp_dev);
	181	if (error)
	182	return error;
68094e32	183	}
4c98cfef	184
0bc11fd4	185	if (pnp_dev->protocol->suspend)
fc30e68e	186	pnp_dev->protocol->suspend(pnp_dev, state);
4c98cfef TI	187	return 0;
	188	}
	189
eaf140b6 SK	190	static int pnp_bus_suspend(struct device *dev)
	191	{
	192	return __pnp_bus_suspend(dev, PMSG_SUSPEND);
	193	}
	194
	195	static int pnp_bus_freeze(struct device *dev)
	196	{
	197	return __pnp_bus_suspend(dev, PMSG_FREEZE);
	198	}
	199
8a37ea50 DT	200	static int pnp_bus_poweroff(struct device *dev)
	201	{
	202	return __pnp_bus_suspend(dev, PMSG_HIBERNATE);
	203	}
	204
68094e32	205	static int pnp_bus_resume(struct device *dev)
4c98cfef	206	{
9dd78466 BH	207	struct pnp_dev *pnp_dev = to_pnp_dev(dev);
9dd78466 BH	208	struct pnp_driver *pnp_drv = pnp_dev->driver;
68094e32 PO	209	int error;
	210
	211	if (!pnp_drv)
	212	return 0;
	213
cc8e7a35 RW	214	if (pnp_dev->protocol->resume) {
	215	error = pnp_dev->protocol->resume(pnp_dev);
	216	if (error)
	217	return error;
	218	}
fc30e68e	219
5d38998e	220	if (pnp_can_write(pnp_dev)) {
68094e32 PO	221	error = pnp_start_dev(pnp_dev);
	222	if (error)
	223	return error;
	224	}
4c98cfef	225
729377d5 SK	226	if (pnp_drv->driver.pm && pnp_drv->driver.pm->resume) {
	227	error = pnp_drv->driver.pm->resume(dev);
	228	if (error)
	229	return error;
	230	}
	231
5d38998e RH	232	if (pnp_drv->resume) {
	233	error = pnp_drv->resume(pnp_dev);
	234	if (error)
	235	return error;
	236	}
68094e32 PO	237
68094e32 PO	238	return 0;
4c98cfef	239	}
1da177e4	240
eaf140b6	241	static const struct dev_pm_ops pnp_bus_dev_pm_ops = {
8a37ea50	242	/* Suspend callbacks */
eaf140b6	243	.suspend = pnp_bus_suspend,
eaf140b6	244	.resume = pnp_bus_resume,
8a37ea50 DT	245	/* Hibernate callbacks */
	246	.freeze = pnp_bus_freeze,
	247	.thaw = pnp_bus_resume,
	248	.poweroff = pnp_bus_poweroff,
	249	.restore = pnp_bus_resume,
eaf140b6 SK	250	};
eaf140b6 SK	251
1da177e4	252	struct bus_type pnp_bus_type = {
07d4e9af BH	253	.name = "pnp",
	254	.match = pnp_bus_match,
	255	.probe = pnp_device_probe,
	256	.remove = pnp_device_remove,
abd6633c	257	.shutdown = pnp_device_shutdown,
eaf140b6	258	.pm = &pnp_bus_dev_pm_ops,
2df43901	259	.dev_groups = pnp_dev_groups,
1da177e4 LT	260	};
1da177e4 LT	261
1da177e4 LT	262	int pnp_register_driver(struct pnp_driver *drv)
1da177e4 LT	263	{
1da177e4 LT	264	drv->driver.name = drv->name;
1da177e4 LT	265	drv->driver.bus = &pnp_bus_type;
1da177e4	266
982c6094	267	return driver_register(&drv->driver);
1da177e4 LT	268	}
	269
	270	void pnp_unregister_driver(struct pnp_driver *drv)
	271	{
	272	driver_unregister(&drv->driver);
1da177e4 LT	273	}
	274
	275	/**
	276	* pnp_add_id - adds an EISA id to the specified device
1da177e4	277	* @dev: pointer to the desired device
772defc6	278	* @id: pointer to an EISA id string
1da177e4	279	*/
620e112c	280	struct pnp_id pnp_add_id(struct pnp_dev dev, const char *id)
1da177e4	281	{
772defc6	282	struct pnp_id dev_id, ptr;
07d4e9af	283
772defc6 BH	284	dev_id = kzalloc(sizeof(struct pnp_id), GFP_KERNEL);
	285	if (!dev_id)
	286	return NULL;
	287
	288	dev_id->id[0] = id[0];
	289	dev_id->id[1] = id[1];
	290	dev_id->id[2] = id[2];
	291	dev_id->id[3] = tolower(id[3]);
	292	dev_id->id[4] = tolower(id[4]);
	293	dev_id->id[5] = tolower(id[5]);
	294	dev_id->id[6] = tolower(id[6]);
	295	dev_id->id[7] = '\0';
	296
	297	dev_id->next = NULL;
1da177e4 LT	298	ptr = dev->id;
	299	while (ptr && ptr->next)
	300	ptr = ptr->next;
	301	if (ptr)
772defc6	302	ptr->next = dev_id;
1da177e4	303	else
772defc6 BH	304	dev->id = dev_id;
	305
	306	return dev_id;
1da177e4 LT	307	}
	308
	309	EXPORT_SYMBOL(pnp_register_driver);
	310	EXPORT_SYMBOL(pnp_unregister_driver);
1da177e4 LT	311	EXPORT_SYMBOL(pnp_device_attach);
1da177e4 LT	312	EXPORT_SYMBOL(pnp_device_detach);