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

/*
 * driver.c - device id matching, driver model, etc.
 *
 * Copyright 2002 Adam Belay <[email protected]>
 */

#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)
{
	mutex_lock(&pnp_lock);
	if (pnp_dev->status != PNP_READY) {
		mutex_unlock(&pnp_lock);
		return -EBUSY;
	}
	pnp_dev->status = PNP_ATTACHED;
	mutex_unlock(&pnp_lock);
	return 0;
}

void pnp_device_detach(struct pnp_dev *pnp_dev)
{
	mutex_lock(&pnp_lock);
	if (pnp_dev->status == PNP_ATTACHED)
		pnp_dev->status = PNP_READY;
	mutex_unlock(&pnp_lock);
}

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;
	}

	if (pnp_dev->active &&
	    (!drv || !(drv->flags & PNP_DRIVER_RES_DO_NOT_CHANGE)))
		pnp_disable_dev(pnp_dev);

	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_can_suspend(pnp_dev))
		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 <[email protected]>
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	{
38f6b38d	61	mutex_lock(&pnp_lock);
9dd78466	62	if (pnp_dev->status != PNP_READY) {
38f6b38d	63	mutex_unlock(&pnp_lock);
1da177e4 LT	64	return -EBUSY;
	65	}
	66	pnp_dev->status = PNP_ATTACHED;
38f6b38d	67	mutex_unlock(&pnp_lock);
1da177e4 LT	68	return 0;
	69	}
	70
	71	void pnp_device_detach(struct pnp_dev *pnp_dev)
	72	{
38f6b38d	73	mutex_lock(&pnp_lock);
1da177e4 LT	74	if (pnp_dev->status == PNP_ATTACHED)
1da177e4 LT	75	pnp_dev->status = PNP_READY;
38f6b38d	76	mutex_unlock(&pnp_lock);
1da177e4 LT	77	}
	78
	79	static int pnp_device_probe(struct device *dev)
	80	{
	81	int error;
	82	struct pnp_driver *pnp_drv;
	83	struct pnp_dev *pnp_dev;
	84	const struct pnp_device_id *dev_id = NULL;
	85	pnp_dev = to_pnp_dev(dev);
	86	pnp_drv = to_pnp_driver(dev->driver);
	87
1da177e4 LT	88	error = pnp_device_attach(pnp_dev);
	89	if (error < 0)
	90	return error;
	91
	92	if (pnp_dev->active == 0) {
	93	if (!(pnp_drv->flags & PNP_DRIVER_RES_DO_NOT_CHANGE)) {
	94	error = pnp_activate_dev(pnp_dev);
	95	if (error < 0)
	96	return error;
	97	}
	98	} else if ((pnp_drv->flags & PNP_DRIVER_RES_DISABLE)
9dd78466	99	== PNP_DRIVER_RES_DISABLE) {
1da177e4 LT	100	error = pnp_disable_dev(pnp_dev);
	101	if (error < 0)
	102	return error;
	103	}
	104	error = 0;
	105	if (pnp_drv->probe) {
	106	dev_id = match_device(pnp_drv, pnp_dev);
	107	if (dev_id != NULL)
	108	error = pnp_drv->probe(pnp_dev, dev_id);
	109	}
9dd78466	110	if (error >= 0) {
1da177e4 LT	111	pnp_dev->driver = pnp_drv;
	112	error = 0;
	113	} else
	114	goto fail;
a05d0781	115
1da177e4 LT	116	return error;
1da177e4 LT	117
1e0aa9ad	118	fail:
1da177e4 LT	119	pnp_device_detach(pnp_dev);
	120	return error;
	121	}
	122
	123	static int pnp_device_remove(struct device *dev)
	124	{
9dd78466 BH	125	struct pnp_dev *pnp_dev = to_pnp_dev(dev);
9dd78466 BH	126	struct pnp_driver *drv = pnp_dev->driver;
1da177e4 LT	127
	128	if (drv) {
	129	if (drv->remove)
	130	drv->remove(pnp_dev);
	131	pnp_dev->driver = NULL;
	132	}
e0f03e87 HK	133
	134	if (pnp_dev->active &&
	135	(!drv \|\| !(drv->flags & PNP_DRIVER_RES_DO_NOT_CHANGE)))
	136	pnp_disable_dev(pnp_dev);
	137
1da177e4 LT	138	pnp_device_detach(pnp_dev);
	139	return 0;
	140	}
	141
abd6633c DH	142	static void pnp_device_shutdown(struct device *dev)
	143	{
	144	struct pnp_dev *pnp_dev = to_pnp_dev(dev);
	145	struct pnp_driver *drv = pnp_dev->driver;
	146
	147	if (drv && drv->shutdown)
	148	drv->shutdown(pnp_dev);
	149	}
	150
1da177e4 LT	151	static int pnp_bus_match(struct device dev, struct device_driver drv)
1da177e4 LT	152	{
9dd78466 BH	153	struct pnp_dev *pnp_dev = to_pnp_dev(dev);
9dd78466 BH	154	struct pnp_driver *pnp_drv = to_pnp_driver(drv);
07d4e9af	155
1da177e4 LT	156	if (match_device(pnp_drv, pnp_dev) == NULL)
	157	return 0;
	158	return 1;
	159	}
	160
eaf140b6	161	static int __pnp_bus_suspend(struct device *dev, pm_message_t state)
4c98cfef	162	{
9dd78466 BH	163	struct pnp_dev *pnp_dev = to_pnp_dev(dev);
9dd78466 BH	164	struct pnp_driver *pnp_drv = pnp_dev->driver;
68094e32 PO	165	int error;
	166
	167	if (!pnp_drv)
	168	return 0;
	169
729377d5 SK	170	if (pnp_drv->driver.pm && pnp_drv->driver.pm->suspend) {
	171	error = pnp_drv->driver.pm->suspend(dev);
	172	suspend_report_result(pnp_drv->driver.pm->suspend, error);
	173	if (error)
	174	return error;
	175	}
	176
68094e32 PO	177	if (pnp_drv->suspend) {
	178	error = pnp_drv->suspend(pnp_dev, state);
	179	if (error)
	180	return error;
	181	}
	182
5d38998e	183	if (pnp_can_disable(pnp_dev)) {
9dd78466 BH	184	error = pnp_stop_dev(pnp_dev);
	185	if (error)
	186	return error;
68094e32	187	}
4c98cfef	188
01395d79	189	if (pnp_can_suspend(pnp_dev))
fc30e68e	190	pnp_dev->protocol->suspend(pnp_dev, state);
4c98cfef TI	191	return 0;
	192	}
	193
eaf140b6 SK	194	static int pnp_bus_suspend(struct device *dev)
	195	{
	196	return __pnp_bus_suspend(dev, PMSG_SUSPEND);
	197	}
	198
	199	static int pnp_bus_freeze(struct device *dev)
	200	{
	201	return __pnp_bus_suspend(dev, PMSG_FREEZE);
	202	}
	203
8a37ea50 DT	204	static int pnp_bus_poweroff(struct device *dev)
	205	{
	206	return __pnp_bus_suspend(dev, PMSG_HIBERNATE);
	207	}
	208
68094e32	209	static int pnp_bus_resume(struct device *dev)
4c98cfef	210	{
9dd78466 BH	211	struct pnp_dev *pnp_dev = to_pnp_dev(dev);
9dd78466 BH	212	struct pnp_driver *pnp_drv = pnp_dev->driver;
68094e32 PO	213	int error;
	214
	215	if (!pnp_drv)
	216	return 0;
	217
cc8e7a35 RW	218	if (pnp_dev->protocol->resume) {
	219	error = pnp_dev->protocol->resume(pnp_dev);
	220	if (error)
	221	return error;
	222	}
fc30e68e	223
5d38998e	224	if (pnp_can_write(pnp_dev)) {
68094e32 PO	225	error = pnp_start_dev(pnp_dev);
	226	if (error)
	227	return error;
	228	}
4c98cfef	229
729377d5 SK	230	if (pnp_drv->driver.pm && pnp_drv->driver.pm->resume) {
	231	error = pnp_drv->driver.pm->resume(dev);
	232	if (error)
	233	return error;
	234	}
	235
5d38998e RH	236	if (pnp_drv->resume) {
	237	error = pnp_drv->resume(pnp_dev);
	238	if (error)
	239	return error;
	240	}
68094e32 PO	241
68094e32 PO	242	return 0;
4c98cfef	243	}
1da177e4	244
eaf140b6	245	static const struct dev_pm_ops pnp_bus_dev_pm_ops = {
8a37ea50	246	/* Suspend callbacks */
eaf140b6	247	.suspend = pnp_bus_suspend,
eaf140b6	248	.resume = pnp_bus_resume,
8a37ea50 DT	249	/* Hibernate callbacks */
	250	.freeze = pnp_bus_freeze,
	251	.thaw = pnp_bus_resume,
	252	.poweroff = pnp_bus_poweroff,
	253	.restore = pnp_bus_resume,
eaf140b6 SK	254	};
eaf140b6 SK	255
1da177e4	256	struct bus_type pnp_bus_type = {
07d4e9af BH	257	.name = "pnp",
	258	.match = pnp_bus_match,
	259	.probe = pnp_device_probe,
	260	.remove = pnp_device_remove,
abd6633c	261	.shutdown = pnp_device_shutdown,
eaf140b6	262	.pm = &pnp_bus_dev_pm_ops,
2df43901	263	.dev_groups = pnp_dev_groups,
1da177e4 LT	264	};
1da177e4 LT	265
1da177e4 LT	266	int pnp_register_driver(struct pnp_driver *drv)
1da177e4 LT	267	{
1da177e4 LT	268	drv->driver.name = drv->name;
1da177e4 LT	269	drv->driver.bus = &pnp_bus_type;
1da177e4	270
982c6094	271	return driver_register(&drv->driver);
1da177e4 LT	272	}
	273
	274	void pnp_unregister_driver(struct pnp_driver *drv)
	275	{
	276	driver_unregister(&drv->driver);
1da177e4 LT	277	}
	278
	279	/**
	280	* pnp_add_id - adds an EISA id to the specified device
1da177e4	281	* @dev: pointer to the desired device
772defc6	282	* @id: pointer to an EISA id string
1da177e4	283	*/
620e112c	284	struct pnp_id pnp_add_id(struct pnp_dev dev, const char *id)
1da177e4	285	{
772defc6	286	struct pnp_id dev_id, ptr;
07d4e9af	287
772defc6 BH	288	dev_id = kzalloc(sizeof(struct pnp_id), GFP_KERNEL);
	289	if (!dev_id)
	290	return NULL;
	291
	292	dev_id->id[0] = id[0];
	293	dev_id->id[1] = id[1];
	294	dev_id->id[2] = id[2];
	295	dev_id->id[3] = tolower(id[3]);
	296	dev_id->id[4] = tolower(id[4]);
	297	dev_id->id[5] = tolower(id[5]);
	298	dev_id->id[6] = tolower(id[6]);
	299	dev_id->id[7] = '\0';
	300
	301	dev_id->next = NULL;
1da177e4 LT	302	ptr = dev->id;
	303	while (ptr && ptr->next)
	304	ptr = ptr->next;
	305	if (ptr)
772defc6	306	ptr->next = dev_id;
1da177e4	307	else
772defc6 BH	308	dev->id = dev_id;
	309
	310	return dev_id;
1da177e4 LT	311	}
	312
	313	EXPORT_SYMBOL(pnp_register_driver);
	314	EXPORT_SYMBOL(pnp_unregister_driver);
1da177e4 LT	315	EXPORT_SYMBOL(pnp_device_attach);
1da177e4 LT	316	EXPORT_SYMBOL(pnp_device_detach);