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 #include <linux/clk.h>
18 #include <linux/device.h>
19 #include <linux/mod_devicetable.h>
20 #include <linux/err.h>
21 #include <linux/resource.h>
22 #include <linux/regulator/consumer.h>
23 
24 #define AMBA_NR_IRQS	2
25 #define AMBA_CID	0xb105f00d
26 
27 struct clk;
28 
29 struct amba_device {
30 	struct device		dev;
31 	struct resource		res;
32 	struct clk		*pclk;
33 	struct regulator	*vcore;
34 	u64			dma_mask;
35 	unsigned int		periphid;
36 	unsigned int		irq[AMBA_NR_IRQS];
37 };
38 
39 struct amba_driver {
40 	struct device_driver	drv;
41 	int			(*probe)(struct amba_device *, const struct amba_id *);
42 	int			(*remove)(struct amba_device *);
43 	void			(*shutdown)(struct amba_device *);
44 	int			(*suspend)(struct amba_device *, pm_message_t);
45 	int			(*resume)(struct amba_device *);
46 	const struct amba_id	*id_table;
47 };
48 
49 enum amba_vendor {
50 	AMBA_VENDOR_ARM = 0x41,
51 	AMBA_VENDOR_ST = 0x80,
52 };
53 
54 extern struct bus_type amba_bustype;
55 
56 #define to_amba_device(d)	container_of(d, struct amba_device, dev)
57 
58 #define amba_get_drvdata(d)	dev_get_drvdata(&d->dev)
59 #define amba_set_drvdata(d,p)	dev_set_drvdata(&d->dev, p)
60 
61 int amba_driver_register(struct amba_driver *);
62 void amba_driver_unregister(struct amba_driver *);
63 int amba_device_register(struct amba_device *, struct resource *);
64 void amba_device_unregister(struct amba_device *);
65 struct amba_device *amba_find_device(const char *, struct device *, unsigned int, unsigned int);
66 int amba_request_regions(struct amba_device *, const char *);
67 void amba_release_regions(struct amba_device *);
68 
69 #define amba_pclk_enable(d)	\
70 	(IS_ERR((d)->pclk) ? 0 : clk_enable((d)->pclk))
71 
72 #define amba_pclk_disable(d)	\
73 	do { if (!IS_ERR((d)->pclk)) clk_disable((d)->pclk); } while (0)
74 
75 #define amba_vcore_enable(d)	\
76 	(IS_ERR((d)->vcore) ? 0 : regulator_enable((d)->vcore))
77 
78 #define amba_vcore_disable(d)	\
79 	do { if (!IS_ERR((d)->vcore)) regulator_disable((d)->vcore); } while (0)
80 
81 /* Some drivers don't use the struct amba_device */
82 #define AMBA_CONFIG_BITS(a) (((a) >> 24) & 0xff)
83 #define AMBA_REV_BITS(a) (((a) >> 20) & 0x0f)
84 #define AMBA_MANF_BITS(a) (((a) >> 12) & 0xff)
85 #define AMBA_PART_BITS(a) ((a) & 0xfff)
86 
87 #define amba_config(d)	AMBA_CONFIG_BITS((d)->periphid)
88 #define amba_rev(d)	AMBA_REV_BITS((d)->periphid)
89 #define amba_manf(d)	AMBA_MANF_BITS((d)->periphid)
90 #define amba_part(d)	AMBA_PART_BITS((d)->periphid)
91 
92 #endif
93