[linux.git] / drivers / amba / bus.c

/*
 *  linux/arch/arm/common/amba.c
 *
 *  Copyright (C) 2003 Deep Blue Solutions Ltd, All Rights Reserved.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */
#include <linux/module.h>
#include <linux/init.h>
#include <linux/device.h>
#include <linux/string.h>
#include <linux/slab.h>
#include <linux/amba/bus.h>

#include <asm/io.h>
#include <asm/sizes.h>

#define to_amba_device(d)	container_of(d, struct amba_device, dev)
#define to_amba_driver(d)	container_of(d, struct amba_driver, drv)

static struct amba_id *
amba_lookup(struct amba_id *table, struct amba_device *dev)
{
	int ret = 0;

	while (table->mask) {
		ret = (dev->periphid & table->mask) == table->id;
		if (ret)
			break;
		table++;
	}

	return ret ? table : NULL;
}

static int amba_match(struct device *dev, struct device_driver *drv)
{
	struct amba_device *pcdev = to_amba_device(dev);
	struct amba_driver *pcdrv = to_amba_driver(drv);

	return amba_lookup(pcdrv->id_table, pcdev) != NULL;
}

#ifdef CONFIG_HOTPLUG
static int amba_uevent(struct device *dev, char **envp, int nr_env, char *buf, int bufsz)
{
	struct amba_device *pcdev = to_amba_device(dev);

	if (nr_env < 2)
		return -ENOMEM;

	snprintf(buf, bufsz, "AMBA_ID=%08x", pcdev->periphid);
	*envp++ = buf;
	*envp++ = NULL;
	return 0;
}
#else
#define amba_uevent NULL
#endif

static int amba_suspend(struct device *dev, pm_message_t state)
{
	struct amba_driver *drv = to_amba_driver(dev->driver);
	int ret = 0;

	if (dev->driver && drv->suspend)
		ret = drv->suspend(to_amba_device(dev), state);
	return ret;
}

static int amba_resume(struct device *dev)
{
	struct amba_driver *drv = to_amba_driver(dev->driver);
	int ret = 0;

	if (dev->driver && drv->resume)
		ret = drv->resume(to_amba_device(dev));
	return ret;
}

/*
 * Primecells are part of the Advanced Microcontroller Bus Architecture,
 * so we call the bus "amba".
 */
static struct bus_type amba_bustype = {
	.name		= "amba",
	.match		= amba_match,
	.uevent		= amba_uevent,
	.suspend	= amba_suspend,
	.resume		= amba_resume,
};

static int __init amba_init(void)
{
	return bus_register(&amba_bustype);
}

postcore_initcall(amba_init);

/*
 * These are the device model conversion veneers; they convert the
 * device model structures to our more specific structures.
 */
static int amba_probe(struct device *dev)
{
	struct amba_device *pcdev = to_amba_device(dev);
	struct amba_driver *pcdrv = to_amba_driver(dev->driver);
	struct amba_id *id;

	id = amba_lookup(pcdrv->id_table, pcdev);

	return pcdrv->probe(pcdev, id);
}

static int amba_remove(struct device *dev)
{
	struct amba_driver *drv = to_amba_driver(dev->driver);
	return drv->remove(to_amba_device(dev));
}

static void amba_shutdown(struct device *dev)
{
	struct amba_driver *drv = to_amba_driver(dev->driver);
	drv->shutdown(to_amba_device(dev));
}

/**
 *	amba_driver_register - register an AMBA device driver
 *	@drv: amba device driver structure
 *
 *	Register an AMBA device driver with the Linux device model
 *	core.  If devices pre-exist, the drivers probe function will
 *	be called.
 */
int amba_driver_register(struct amba_driver *drv)
{
	drv->drv.bus = &amba_bustype;

#define SETFN(fn)	if (drv->fn) drv->drv.fn = amba_##fn
	SETFN(probe);
	SETFN(remove);
	SETFN(shutdown);

	return driver_register(&drv->drv);
}

/**
 *	amba_driver_unregister - remove an AMBA device driver
 *	@drv: AMBA device driver structure to remove
 *
 *	Unregister an AMBA device driver from the Linux device
 *	model.  The device model will call the drivers remove function
 *	for each device the device driver is currently handling.
 */
void amba_driver_unregister(struct amba_driver *drv)
{
	driver_unregister(&drv->drv);
}


static void amba_device_release(struct device *dev)
{
	struct amba_device *d = to_amba_device(dev);

	if (d->res.parent)
		release_resource(&d->res);
	kfree(d);
}

#define amba_attr(name,fmt,arg...)				\
static ssize_t show_##name(struct device *_dev, struct device_attribute *attr, char *buf)	\
{								\
	struct amba_device *dev = to_amba_device(_dev);		\
	return sprintf(buf, fmt, arg);				\
}								\
static DEVICE_ATTR(name, S_IRUGO, show_##name, NULL)

amba_attr(id, "%08x\n", dev->periphid);
amba_attr(irq0, "%u\n", dev->irq[0]);
amba_attr(irq1, "%u\n", dev->irq[1]);
amba_attr(resource, "\t%016llx\t%016llx\t%016lx\n",
	 (unsigned long long)dev->res.start, (unsigned long long)dev->res.end,
	 dev->res.flags);

/**
 *	amba_device_register - register an AMBA device
 *	@dev: AMBA device to register
 *	@parent: parent memory resource
 *
 *	Setup the AMBA device, reading the cell ID if present.
 *	Claim the resource, and register the AMBA device with
 *	the Linux device manager.
 */
int amba_device_register(struct amba_device *dev, struct resource *parent)
{
	u32 pid, cid;
	void __iomem *tmp;
	int i, ret;

	dev->dev.release = amba_device_release;
	dev->dev.bus = &amba_bustype;
	dev->dev.dma_mask = &dev->dma_mask;
	dev->res.name = dev->dev.bus_id;

	if (!dev->dev.coherent_dma_mask && dev->dma_mask)
		dev_warn(&dev->dev, "coherent dma mask is unset\n");

	ret = request_resource(parent, &dev->res);
	if (ret == 0) {
		tmp = ioremap(dev->res.start, SZ_4K);
		if (!tmp) {
			ret = -ENOMEM;
			goto out;
		}

		for (pid = 0, i = 0; i < 4; i++)
			pid |= (readl(tmp + 0xfe0 + 4 * i) & 255) << (i * 8);
		for (cid = 0, i = 0; i < 4; i++)
			cid |= (readl(tmp + 0xff0 + 4 * i) & 255) << (i * 8);

		iounmap(tmp);

		if (cid == 0xb105f00d)
			dev->periphid = pid;

		if (dev->periphid)
			ret = device_register(&dev->dev);
		else
			ret = -ENODEV;

		if (ret == 0) {
			device_create_file(&dev->dev, &dev_attr_id);
			if (dev->irq[0] != NO_IRQ)
				device_create_file(&dev->dev, &dev_attr_irq0);
			if (dev->irq[1] != NO_IRQ)
				device_create_file(&dev->dev, &dev_attr_irq1);
			device_create_file(&dev->dev, &dev_attr_resource);
		} else {
 out:
			release_resource(&dev->res);
		}
	}
	return ret;
}

/**
 *	amba_device_unregister - unregister an AMBA device
 *	@dev: AMBA device to remove
 *
 *	Remove the specified AMBA device from the Linux device
 *	manager.  All files associated with this object will be
 *	destroyed, and device drivers notified that the device has
 *	been removed.  The AMBA device's resources including
 *	the amba_device structure will be freed once all
 *	references to it have been dropped.
 */
void amba_device_unregister(struct amba_device *dev)
{
	device_unregister(&dev->dev);
}


struct find_data {
	struct amba_device *dev;
	struct device *parent;
	const char *busid;
	unsigned int id;
	unsigned int mask;
};

static int amba_find_match(struct device *dev, void *data)
{
	struct find_data *d = data;
	struct amba_device *pcdev = to_amba_device(dev);
	int r;

	r = (pcdev->periphid & d->mask) == d->id;
	if (d->parent)
		r &= d->parent == dev->parent;
	if (d->busid)
		r &= strcmp(dev->bus_id, d->busid) == 0;

	if (r) {
		get_device(dev);
		d->dev = pcdev;
	}

	return r;
}

/**
 *	amba_find_device - locate an AMBA device given a bus id
 *	@busid: bus id for device (or NULL)
 *	@parent: parent device (or NULL)
 *	@id: peripheral ID (or 0)
 *	@mask: peripheral ID mask (or 0)
 *
 *	Return the AMBA device corresponding to the supplied parameters.
 *	If no device matches, returns NULL.
 *
 *	NOTE: When a valid device is found, its refcount is
 *	incremented, and must be decremented before the returned
 *	reference.
 */
struct amba_device *
amba_find_device(const char *busid, struct device *parent, unsigned int id,
		 unsigned int mask)
{
	struct find_data data;

	data.dev = NULL;
	data.parent = parent;
	data.busid = busid;
	data.id = id;
	data.mask = mask;

	bus_for_each_dev(&amba_bustype, NULL, &data, amba_find_match);

	return data.dev;
}

/**
 *	amba_request_regions - request all mem regions associated with device
 *	@dev: amba_device structure for device
 *	@name: name, or NULL to use driver name
 */
int amba_request_regions(struct amba_device *dev, const char *name)
{
	int ret = 0;

	if (!name)
		name = dev->dev.driver->name;

	if (!request_mem_region(dev->res.start, SZ_4K, name))
		ret = -EBUSY;

	return ret;
}

/**
 *	amba_release_regions - release mem regions assoicated with device
 *	@dev: amba_device structure for device
 *
 *	Release regions claimed by a successful call to amba_request_regions.
 */
void amba_release_regions(struct amba_device *dev)
{
	release_mem_region(dev->res.start, SZ_4K);
}

EXPORT_SYMBOL(amba_driver_register);
EXPORT_SYMBOL(amba_driver_unregister);
EXPORT_SYMBOL(amba_device_register);
EXPORT_SYMBOL(amba_device_unregister);
EXPORT_SYMBOL(amba_find_device);
EXPORT_SYMBOL(amba_request_regions);
EXPORT_SYMBOL(amba_release_regions);
Commit	Line	Data
1da177e4 LT	1	/*
	2	* linux/arch/arm/common/amba.c
	3	*
	4	* Copyright (C) 2003 Deep Blue Solutions Ltd, All Rights Reserved.
	5	*
	6	* This program is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License version 2 as
	8	* published by the Free Software Foundation.
	9	*/
	10	#include <linux/module.h>
	11	#include <linux/init.h>
	12	#include <linux/device.h>
4e57b681 TS	13	#include <linux/string.h>
4e57b681 TS	14	#include <linux/slab.h>
a62c80e5	15	#include <linux/amba/bus.h>
1da177e4 LT	16
1da177e4 LT	17	#include <asm/io.h>
1da177e4 LT	18	#include <asm/sizes.h>
	19
	20	#define to_amba_device(d) container_of(d, struct amba_device, dev)
	21	#define to_amba_driver(d) container_of(d, struct amba_driver, drv)
	22
	23	static struct amba_id *
	24	amba_lookup(struct amba_id table, struct amba_device dev)
	25	{
	26	int ret = 0;
	27
	28	while (table->mask) {
	29	ret = (dev->periphid & table->mask) == table->id;
	30	if (ret)
	31	break;
	32	table++;
	33	}
	34
	35	return ret ? table : NULL;
	36	}
	37
	38	static int amba_match(struct device dev, struct device_driver drv)
	39	{
	40	struct amba_device *pcdev = to_amba_device(dev);
	41	struct amba_driver *pcdrv = to_amba_driver(drv);
	42
	43	return amba_lookup(pcdrv->id_table, pcdev) != NULL;
	44	}
	45
	46	#ifdef CONFIG_HOTPLUG
6d20b035	47	static int amba_uevent(struct device dev, char envp, int nr_env, char buf, int bufsz)
1da177e4 LT	48	{
	49	struct amba_device *pcdev = to_amba_device(dev);
	50
	51	if (nr_env < 2)
	52	return -ENOMEM;
	53
	54	snprintf(buf, bufsz, "AMBA_ID=%08x", pcdev->periphid);
	55	*envp++ = buf;
	56	*envp++ = NULL;
	57	return 0;
	58	}
	59	#else
6d20b035	60	#define amba_uevent NULL
1da177e4 LT	61	#endif
	62
	63	static int amba_suspend(struct device *dev, pm_message_t state)
	64	{
	65	struct amba_driver *drv = to_amba_driver(dev->driver);
	66	int ret = 0;
	67
	68	if (dev->driver && drv->suspend)
	69	ret = drv->suspend(to_amba_device(dev), state);
	70	return ret;
	71	}
	72
	73	static int amba_resume(struct device *dev)
	74	{
	75	struct amba_driver *drv = to_amba_driver(dev->driver);
	76	int ret = 0;
	77
	78	if (dev->driver && drv->resume)
	79	ret = drv->resume(to_amba_device(dev));
	80	return ret;
	81	}
	82
	83	/*
	84	* Primecells are part of the Advanced Microcontroller Bus Architecture,
	85	* so we call the bus "amba".
	86	*/
	87	static struct bus_type amba_bustype = {
	88	.name = "amba",
	89	.match = amba_match,
6d20b035	90	.uevent = amba_uevent,
1da177e4 LT	91	.suspend = amba_suspend,
	92	.resume = amba_resume,
	93	};
	94
	95	static int __init amba_init(void)
	96	{
	97	return bus_register(&amba_bustype);
	98	}
	99
	100	postcore_initcall(amba_init);
	101
	102	/*
	103	* These are the device model conversion veneers; they convert the
	104	* device model structures to our more specific structures.
	105	*/
	106	static int amba_probe(struct device *dev)
	107	{
	108	struct amba_device *pcdev = to_amba_device(dev);
	109	struct amba_driver *pcdrv = to_amba_driver(dev->driver);
	110	struct amba_id *id;
	111
	112	id = amba_lookup(pcdrv->id_table, pcdev);
	113
	114	return pcdrv->probe(pcdev, id);
	115	}
	116
	117	static int amba_remove(struct device *dev)
	118	{
	119	struct amba_driver *drv = to_amba_driver(dev->driver);
	120	return drv->remove(to_amba_device(dev));
	121	}
	122
	123	static void amba_shutdown(struct device *dev)
	124	{
	125	struct amba_driver *drv = to_amba_driver(dev->driver);
	126	drv->shutdown(to_amba_device(dev));
	127	}
	128
	129	/**
	130	* amba_driver_register - register an AMBA device driver
	131	* @drv: amba device driver structure
	132	*
	133	* Register an AMBA device driver with the Linux device model
	134	* core. If devices pre-exist, the drivers probe function will
	135	* be called.
	136	*/
	137	int amba_driver_register(struct amba_driver *drv)
	138	{
	139	drv->drv.bus = &amba_bustype;
	140
	141	#define SETFN(fn) if (drv->fn) drv->drv.fn = amba_##fn
	142	SETFN(probe);
	143	SETFN(remove);
	144	SETFN(shutdown);
	145
	146	return driver_register(&drv->drv);
	147	}
	148
	149	/**
	150	* amba_driver_unregister - remove an AMBA device driver
	151	* @drv: AMBA device driver structure to remove
	152	*
	153	* Unregister an AMBA device driver from the Linux device
	154	* model. The device model will call the drivers remove function
155	* for each device the device driver is currently handling.
156	*/
157	void amba_driver_unregister(struct amba_driver *drv)
158	{
159	driver_unregister(&drv->drv);
160	}
161
162
163	static void amba_device_release(struct device *dev)
164	{
165	struct amba_device *d = to_amba_device(dev);
166
167	if (d->res.parent)
168	release_resource(&d->res);
169	kfree(d);
170	}
171
172	#define amba_attr(name,fmt,arg...) \
ff381d22	173	static ssize_t show_##name(struct device _dev, struct device_attribute attr, char *buf) \
1da177e4 LT	174	{ \
	175	struct amba_device *dev = to_amba_device(_dev); \
	176	return sprintf(buf, fmt, arg); \
	177	} \
	178	static DEVICE_ATTR(name, S_IRUGO, show_##name, NULL)
	179
	180	amba_attr(id, "%08x\n", dev->periphid);
	181	amba_attr(irq0, "%u\n", dev->irq[0]);
	182	amba_attr(irq1, "%u\n", dev->irq[1]);
e29419ff GKH	183	amba_attr(resource, "\t%016llx\t%016llx\t%016lx\n",
	184	(unsigned long long)dev->res.start, (unsigned long long)dev->res.end,
	185	dev->res.flags);
1da177e4 LT	186
	187	/**
	188	* amba_device_register - register an AMBA device
	189	* @dev: AMBA device to register
	190	* @parent: parent memory resource
	191	*
	192	* Setup the AMBA device, reading the cell ID if present.
	193	* Claim the resource, and register the AMBA device with
	194	* the Linux device manager.
	195	*/
	196	int amba_device_register(struct amba_device dev, struct resource parent)
	197	{
	198	u32 pid, cid;
	199	void __iomem *tmp;
	200	int i, ret;
	201
	202	dev->dev.release = amba_device_release;
	203	dev->dev.bus = &amba_bustype;
	204	dev->dev.dma_mask = &dev->dma_mask;
	205	dev->res.name = dev->dev.bus_id;
	206
	207	if (!dev->dev.coherent_dma_mask && dev->dma_mask)
	208	dev_warn(&dev->dev, "coherent dma mask is unset\n");
	209
	210	ret = request_resource(parent, &dev->res);
	211	if (ret == 0) {
	212	tmp = ioremap(dev->res.start, SZ_4K);
	213	if (!tmp) {
	214	ret = -ENOMEM;
	215	goto out;
	216	}
	217
	218	for (pid = 0, i = 0; i < 4; i++)
	219	pid \|= (readl(tmp + 0xfe0 + 4 * i) & 255) << (i * 8);
	220	for (cid = 0, i = 0; i < 4; i++)
	221	cid \|= (readl(tmp + 0xff0 + 4 * i) & 255) << (i * 8);
	222
	223	iounmap(tmp);
	224
	225	if (cid == 0xb105f00d)
	226	dev->periphid = pid;
	227
	228	if (dev->periphid)
	229	ret = device_register(&dev->dev);
	230	else
	231	ret = -ENODEV;
	232
	233	if (ret == 0) {
	234	device_create_file(&dev->dev, &dev_attr_id);
	235	if (dev->irq[0] != NO_IRQ)
	236	device_create_file(&dev->dev, &dev_attr_irq0);
	237	if (dev->irq[1] != NO_IRQ)
	238	device_create_file(&dev->dev, &dev_attr_irq1);
	239	device_create_file(&dev->dev, &dev_attr_resource);
	240	} else {
	241	out:
	242	release_resource(&dev->res);
	243	}
	244	}
	245	return ret;
	246	}
	247
	248	/**
	249	* amba_device_unregister - unregister an AMBA device
250	* @dev: AMBA device to remove
251	*
252	* Remove the specified AMBA device from the Linux device
253	* manager. All files associated with this object will be
254	* destroyed, and device drivers notified that the device has
255	* been removed. The AMBA device's resources including
256	* the amba_device structure will be freed once all
257	* references to it have been dropped.
258	*/
259	void amba_device_unregister(struct amba_device *dev)
260	{
261	device_unregister(&dev->dev);
262	}
263
264
265	struct find_data {
266	struct amba_device *dev;
267	struct device *parent;
268	const char *busid;
269	unsigned int id;
270	unsigned int mask;
271	};
272
273	static int amba_find_match(struct device dev, void data)
274	{
275	struct find_data *d = data;
276	struct amba_device *pcdev = to_amba_device(dev);
277	int r;
278
279	r = (pcdev->periphid & d->mask) == d->id;
280	if (d->parent)
281	r &= d->parent == dev->parent;
282	if (d->busid)
283	r &= strcmp(dev->bus_id, d->busid) == 0;
284
285	if (r) {
286	get_device(dev);
287	d->dev = pcdev;
288	}
289
290	return r;
291	}
292
293	/**
294	* amba_find_device - locate an AMBA device given a bus id
295	* @busid: bus id for device (or NULL)
296	* @parent: parent device (or NULL)
297	* @id: peripheral ID (or 0)
298	* @mask: peripheral ID mask (or 0)
299	*
300	* Return the AMBA device corresponding to the supplied parameters.
301	* If no device matches, returns NULL.
302	*
303	* NOTE: When a valid device is found, its refcount is
304	* incremented, and must be decremented before the returned
305	* reference.
306	*/
307	struct amba_device *
308	amba_find_device(const char busid, struct device parent, unsigned int id,
309	unsigned int mask)
310	{
311	struct find_data data;
312
313	data.dev = NULL;
314	data.parent = parent;
315	data.busid = busid;
316	data.id = id;
317	data.mask = mask;
318
319	bus_for_each_dev(&amba_bustype, NULL, &data, amba_find_match);
320
321	return data.dev;
322	}
323
324	/**
325	* amba_request_regions - request all mem regions associated with device
326	* @dev: amba_device structure for device
327	* @name: name, or NULL to use driver name
328	*/
329	int amba_request_regions(struct amba_device dev, const char name)
330	{
331	int ret = 0;
332
333	if (!name)
334	name = dev->dev.driver->name;
335
336	if (!request_mem_region(dev->res.start, SZ_4K, name))
337	ret = -EBUSY;
338
339	return ret;
340	}
341
342	/**
343	* amba_release_regions - release mem regions assoicated with device
344	* @dev: amba_device structure for device
345	*
346	* Release regions claimed by a successful call to amba_request_regions.
347	*/
348	void amba_release_regions(struct amba_device *dev)
349	{
350	release_mem_region(dev->res.start, SZ_4K);
351	}
352
353	EXPORT_SYMBOL(amba_driver_register);
354	EXPORT_SYMBOL(amba_driver_unregister);
355	EXPORT_SYMBOL(amba_device_register);
356	EXPORT_SYMBOL(amba_device_unregister);
357	EXPORT_SYMBOL(amba_find_device);
358	EXPORT_SYMBOL(amba_request_regions);
359	EXPORT_SYMBOL(amba_release_regions);