ARM: 5951/1: ARM: fix documentation of the PrimeCell bus
[safe/jmp/linux-2.6] / include / linux / amba / bus.h
1 /*
2  *  linux/include/amba/bus.h
3  *
4  *  This device type deals with ARM PrimeCells and anything else that
5  *  presents a proper CID (0xB105F00D) at the end of the I/O register
6  *  region or that is derived from a PrimeCell.
7  *
8  *  Copyright (C) 2003 Deep Blue Solutions Ltd, All Rights Reserved.
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License version 2 as
12  * published by the Free Software Foundation.
13  */
14 #ifndef ASMARM_AMBA_H
15 #define ASMARM_AMBA_H
16
17 #define AMBA_NR_IRQS    2
18
19 struct amba_device {
20         struct device           dev;
21         struct resource         res;
22         u64                     dma_mask;
23         unsigned int            periphid;
24         unsigned int            irq[AMBA_NR_IRQS];
25 };
26
27 struct amba_id {
28         unsigned int            id;
29         unsigned int            mask;
30         void                    *data;
31 };
32
33 struct amba_driver {
34         struct device_driver    drv;
35         int                     (*probe)(struct amba_device *, struct amba_id *);
36         int                     (*remove)(struct amba_device *);
37         void                    (*shutdown)(struct amba_device *);
38         int                     (*suspend)(struct amba_device *, pm_message_t);
39         int                     (*resume)(struct amba_device *);
40         struct amba_id          *id_table;
41 };
42
43 enum amba_vendor {
44         AMBA_VENDOR_ARM = 0x41,
45         AMBA_VENDOR_ST = 0x80,
46 };
47
48 #define amba_get_drvdata(d)     dev_get_drvdata(&d->dev)
49 #define amba_set_drvdata(d,p)   dev_set_drvdata(&d->dev, p)
50
51 int amba_driver_register(struct amba_driver *);
52 void amba_driver_unregister(struct amba_driver *);
53 int amba_device_register(struct amba_device *, struct resource *);
54 void amba_device_unregister(struct amba_device *);
55 struct amba_device *amba_find_device(const char *, struct device *, unsigned int, unsigned int);
56 int amba_request_regions(struct amba_device *, const char *);
57 void amba_release_regions(struct amba_device *);
58
59 #define amba_config(d)  (((d)->periphid >> 24) & 0xff)
60 #define amba_rev(d)     (((d)->periphid >> 20) & 0x0f)
61 #define amba_manf(d)    (((d)->periphid >> 12) & 0xff)
62 #define amba_part(d)    ((d)->periphid & 0xfff)
63
64 #endif