2  *  linux/arch/arm/common/amba.c
 
   4  *  Copyright (C) 2003 Deep Blue Solutions Ltd, All Rights Reserved.
 
   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.
 
  10 #include <linux/module.h>
 
  11 #include <linux/init.h>
 
  12 #include <linux/device.h>
 
  13 #include <linux/string.h>
 
  14 #include <linux/slab.h>
 
  15 #include <linux/amba/bus.h>
 
  18 #include <asm/sizes.h>
 
  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)
 
  23 static struct amba_id *
 
  24 amba_lookup(struct amba_id *table, struct amba_device *dev)
 
  29                 ret = (dev->periphid & table->mask) == table->id;
 
  35         return ret ? table : NULL;
 
  38 static int amba_match(struct device *dev, struct device_driver *drv)
 
  40         struct amba_device *pcdev = to_amba_device(dev);
 
  41         struct amba_driver *pcdrv = to_amba_driver(drv);
 
  43         return amba_lookup(pcdrv->id_table, pcdev) != NULL;
 
  47 static int amba_uevent(struct device *dev, struct kobj_uevent_env *env)
 
  49         struct amba_device *pcdev = to_amba_device(dev);
 
  52         retval = add_uevent_var(env, "AMBA_ID=%08x", pcdev->periphid);
 
  56 #define amba_uevent NULL
 
  59 static int amba_suspend(struct device *dev, pm_message_t state)
 
  61         struct amba_driver *drv = to_amba_driver(dev->driver);
 
  64         if (dev->driver && drv->suspend)
 
  65                 ret = drv->suspend(to_amba_device(dev), state);
 
  69 static int amba_resume(struct device *dev)
 
  71         struct amba_driver *drv = to_amba_driver(dev->driver);
 
  74         if (dev->driver && drv->resume)
 
  75                 ret = drv->resume(to_amba_device(dev));
 
  79 #define amba_attr_func(name,fmt,arg...)                                 \
 
  80 static ssize_t name##_show(struct device *_dev,                         \
 
  81                            struct device_attribute *attr, char *buf)    \
 
  83         struct amba_device *dev = to_amba_device(_dev);                 \
 
  84         return sprintf(buf, fmt, arg);                                  \
 
  87 #define amba_attr(name,fmt,arg...)      \
 
  88 amba_attr_func(name,fmt,arg)            \
 
  89 static DEVICE_ATTR(name, S_IRUGO, name##_show, NULL)
 
  91 amba_attr_func(id, "%08x\n", dev->periphid);
 
  92 amba_attr(irq0, "%u\n", dev->irq[0]);
 
  93 amba_attr(irq1, "%u\n", dev->irq[1]);
 
  94 amba_attr_func(resource, "\t%016llx\t%016llx\t%016lx\n",
 
  95          (unsigned long long)dev->res.start, (unsigned long long)dev->res.end,
 
  98 static struct device_attribute amba_dev_attrs[] = {
 
 105  * Primecells are part of the Advanced Microcontroller Bus Architecture,
 
 106  * so we call the bus "amba".
 
 108 static struct bus_type amba_bustype = {
 
 110         .dev_attrs      = amba_dev_attrs,
 
 112         .uevent         = amba_uevent,
 
 113         .suspend        = amba_suspend,
 
 114         .resume         = amba_resume,
 
 117 static int __init amba_init(void)
 
 119         return bus_register(&amba_bustype);
 
 122 postcore_initcall(amba_init);
 
 125  * These are the device model conversion veneers; they convert the
 
 126  * device model structures to our more specific structures.
 
 128 static int amba_probe(struct device *dev)
 
 130         struct amba_device *pcdev = to_amba_device(dev);
 
 131         struct amba_driver *pcdrv = to_amba_driver(dev->driver);
 
 134         id = amba_lookup(pcdrv->id_table, pcdev);
 
 136         return pcdrv->probe(pcdev, id);
 
 139 static int amba_remove(struct device *dev)
 
 141         struct amba_driver *drv = to_amba_driver(dev->driver);
 
 142         return drv->remove(to_amba_device(dev));
 
 145 static void amba_shutdown(struct device *dev)
 
 147         struct amba_driver *drv = to_amba_driver(dev->driver);
 
 148         drv->shutdown(to_amba_device(dev));
 
 152  *      amba_driver_register - register an AMBA device driver
 
 153  *      @drv: amba device driver structure
 
 155  *      Register an AMBA device driver with the Linux device model
 
 156  *      core.  If devices pre-exist, the drivers probe function will
 
 159 int amba_driver_register(struct amba_driver *drv)
 
 161         drv->drv.bus = &amba_bustype;
 
 163 #define SETFN(fn)       if (drv->fn) drv->drv.fn = amba_##fn
 
 168         return driver_register(&drv->drv);
 
 172  *      amba_driver_unregister - remove an AMBA device driver
 
 173  *      @drv: AMBA device driver structure to remove
 
 175  *      Unregister an AMBA device driver from the Linux device
 
 176  *      model.  The device model will call the drivers remove function
 
 177  *      for each device the device driver is currently handling.
 
 179 void amba_driver_unregister(struct amba_driver *drv)
 
 181         driver_unregister(&drv->drv);
 
 185 static void amba_device_release(struct device *dev)
 
 187         struct amba_device *d = to_amba_device(dev);
 
 190                 release_resource(&d->res);
 
 195  *      amba_device_register - register an AMBA device
 
 196  *      @dev: AMBA device to register
 
 197  *      @parent: parent memory resource
 
 199  *      Setup the AMBA device, reading the cell ID if present.
 
 200  *      Claim the resource, and register the AMBA device with
 
 201  *      the Linux device manager.
 
 203 int amba_device_register(struct amba_device *dev, struct resource *parent)
 
 209         dev->dev.release = amba_device_release;
 
 210         dev->dev.bus = &amba_bustype;
 
 211         dev->dev.dma_mask = &dev->dma_mask;
 
 212         dev->res.name = dev->dev.bus_id;
 
 214         if (!dev->dev.coherent_dma_mask && dev->dma_mask)
 
 215                 dev_warn(&dev->dev, "coherent dma mask is unset\n");
 
 217         ret = request_resource(parent, &dev->res);
 
 221         tmp = ioremap(dev->res.start, SZ_4K);
 
 227         for (pid = 0, i = 0; i < 4; i++)
 
 228                 pid |= (readl(tmp + 0xfe0 + 4 * i) & 255) << (i * 8);
 
 229         for (cid = 0, i = 0; i < 4; i++)
 
 230                 cid |= (readl(tmp + 0xff0 + 4 * i) & 255) << (i * 8);
 
 234         if (cid == 0xb105f00d)
 
 237         if (!dev->periphid) {
 
 242         ret = device_register(&dev->dev);
 
 246         if (dev->irq[0] != NO_IRQ)
 
 247                 ret = device_create_file(&dev->dev, &dev_attr_irq0);
 
 248         if (ret == 0 && dev->irq[1] != NO_IRQ)
 
 249                 ret = device_create_file(&dev->dev, &dev_attr_irq1);
 
 253         device_unregister(&dev->dev);
 
 256         release_resource(&dev->res);
 
 262  *      amba_device_unregister - unregister an AMBA device
 
 263  *      @dev: AMBA device to remove
 
 265  *      Remove the specified AMBA device from the Linux device
 
 266  *      manager.  All files associated with this object will be
 
 267  *      destroyed, and device drivers notified that the device has
 
 268  *      been removed.  The AMBA device's resources including
 
 269  *      the amba_device structure will be freed once all
 
 270  *      references to it have been dropped.
 
 272 void amba_device_unregister(struct amba_device *dev)
 
 274         device_unregister(&dev->dev);
 
 279         struct amba_device *dev;
 
 280         struct device *parent;
 
 286 static int amba_find_match(struct device *dev, void *data)
 
 288         struct find_data *d = data;
 
 289         struct amba_device *pcdev = to_amba_device(dev);
 
 292         r = (pcdev->periphid & d->mask) == d->id;
 
 294                 r &= d->parent == dev->parent;
 
 296                 r &= strcmp(dev->bus_id, d->busid) == 0;
 
 307  *      amba_find_device - locate an AMBA device given a bus id
 
 308  *      @busid: bus id for device (or NULL)
 
 309  *      @parent: parent device (or NULL)
 
 310  *      @id: peripheral ID (or 0)
 
 311  *      @mask: peripheral ID mask (or 0)
 
 313  *      Return the AMBA device corresponding to the supplied parameters.
 
 314  *      If no device matches, returns NULL.
 
 316  *      NOTE: When a valid device is found, its refcount is
 
 317  *      incremented, and must be decremented before the returned
 
 321 amba_find_device(const char *busid, struct device *parent, unsigned int id,
 
 324         struct find_data data;
 
 327         data.parent = parent;
 
 332         bus_for_each_dev(&amba_bustype, NULL, &data, amba_find_match);
 
 338  *      amba_request_regions - request all mem regions associated with device
 
 339  *      @dev: amba_device structure for device
 
 340  *      @name: name, or NULL to use driver name
 
 342 int amba_request_regions(struct amba_device *dev, const char *name)
 
 347                 name = dev->dev.driver->name;
 
 349         if (!request_mem_region(dev->res.start, SZ_4K, name))
 
 356  *      amba_release_regions - release mem regions assoicated with device
 
 357  *      @dev: amba_device structure for device
 
 359  *      Release regions claimed by a successful call to amba_request_regions.
 
 361 void amba_release_regions(struct amba_device *dev)
 
 363         release_mem_region(dev->res.start, SZ_4K);
 
 366 EXPORT_SYMBOL(amba_driver_register);
 
 367 EXPORT_SYMBOL(amba_driver_unregister);
 
 368 EXPORT_SYMBOL(amba_device_register);
 
 369 EXPORT_SYMBOL(amba_device_unregister);
 
 370 EXPORT_SYMBOL(amba_find_device);
 
 371 EXPORT_SYMBOL(amba_request_regions);
 
 372 EXPORT_SYMBOL(amba_release_regions);