blob: 26f0ecf401eaa5787a5eba474dd62942e629ed11 [file] [log] [blame]
Thomas Gleixnerd2912cb2019-06-04 10:11:33 +02001/* SPDX-License-Identifier: GPL-2.0-only */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
Linus Walleij4e10ae12010-02-20 09:41:30 +01003 * linux/include/amba/bus.h
4 *
5 * This device type deals with ARM PrimeCells and anything else that
6 * presents a proper CID (0xB105F00D) at the end of the I/O register
7 * region or that is derived from a PrimeCell.
Linus Torvalds1da177e2005-04-16 15:20:36 -07008 *
9 * Copyright (C) 2003 Deep Blue Solutions Ltd, All Rights Reserved.
Linus Torvalds1da177e2005-04-16 15:20:36 -070010 */
11#ifndef ASMARM_AMBA_H
12#define ASMARM_AMBA_H
13
Russell King7cfe2492010-07-15 10:47:14 +010014#include <linux/clk.h>
viresh kumarc36207a2010-03-29 05:28:32 +010015#include <linux/device.h>
Dave Martin1e5f9a22011-10-05 14:40:59 +010016#include <linux/mod_devicetable.h>
Russell King7cfe2492010-07-15 10:47:14 +010017#include <linux/err.h>
viresh kumarc36207a2010-03-29 05:28:32 +010018#include <linux/resource.h>
Linus Walleij65500fa2010-11-04 13:06:59 +010019#include <linux/regulator/consumer.h>
viresh kumarc36207a2010-03-29 05:28:32 +010020
Michal Simek4d8981f2013-10-29 16:02:00 +010021#define AMBA_NR_IRQS 9
Linus Walleij01723a92010-09-07 22:43:19 +010022#define AMBA_CID 0xb105f00d
Pratik Patela06ae862014-11-03 11:07:35 -070023#define CORESIGHT_CID 0xb105900d
Linus Torvalds1da177e2005-04-16 15:20:36 -070024
Mike Leache85fa282019-02-13 14:41:49 +010025/*
26 * CoreSight Architecture specification updates the ID specification
27 * for components on the AMBA bus. (ARM IHI 0029E)
28 *
29 * Bits 15:12 of the CID are the device class.
30 *
31 * Class 0xF remains for PrimeCell and legacy components. (AMBA_CID above)
32 * Class 0x9 defines the component as CoreSight (CORESIGHT_CID above)
33 * Class 0x0, 0x1, 0xB, 0xE define components that do not have driver support
34 * at present.
35 * Class 0x2-0x8,0xA and 0xD-0xD are presently reserved.
36 *
37 * Remaining CID bits stay as 0xb105-00d
38 */
39
40/**
41 * Class 0x9 components use additional values to form a Unique Component
42 * Identifier (UCI), where peripheral ID values are identical for different
43 * components. Passed to the amba bus code from the component driver via
44 * the amba_id->data pointer.
45 * @devarch : coresight devarch register value
46 * @devarch_mask: mask bits used for matching. 0 indicates UCI not used.
47 * @devtype : coresight device type value
48 * @data : additional driver data. As we have usurped the original
49 * pointer some devices may still need additional data
50 */
51struct amba_cs_uci_id {
52 unsigned int devarch;
53 unsigned int devarch_mask;
54 unsigned int devtype;
55 void *data;
56};
57
Mike Leach4a2910f2019-02-13 14:41:50 +010058/* define offsets for registers used by UCI */
59#define UCI_REG_DEVTYPE_OFFSET 0xFCC
60#define UCI_REG_DEVARCH_OFFSET 0xFBC
61
Russell King7cfe2492010-07-15 10:47:14 +010062struct clk;
63
Linus Torvalds1da177e2005-04-16 15:20:36 -070064struct amba_device {
65 struct device dev;
66 struct resource res;
Russell King7cfe2492010-07-15 10:47:14 +010067 struct clk *pclk;
Linus Torvalds1da177e2005-04-16 15:20:36 -070068 unsigned int periphid;
Mike Leach4a2910f2019-02-13 14:41:50 +010069 unsigned int cid;
70 struct amba_cs_uci_id uci;
Linus Torvalds1da177e2005-04-16 15:20:36 -070071 unsigned int irq[AMBA_NR_IRQS];
Antonios Motakis3cf38572015-01-06 11:15:11 +010072 char *driver_override;
Linus Torvalds1da177e2005-04-16 15:20:36 -070073};
74
Linus Torvalds1da177e2005-04-16 15:20:36 -070075struct amba_driver {
76 struct device_driver drv;
Russell Kingaa25afa2011-02-19 15:55:00 +000077 int (*probe)(struct amba_device *, const struct amba_id *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070078 int (*remove)(struct amba_device *);
79 void (*shutdown)(struct amba_device *);
Russell King2d008802011-02-19 15:55:48 +000080 const struct amba_id *id_table;
Linus Torvalds1da177e2005-04-16 15:20:36 -070081};
82
Anders Bergdb4fa452014-09-17 08:46:58 +020083/*
84 * Constants for the designer field of the Peripheral ID register. When bit 7
85 * is set to '1', bits [6:0] should be the JEP106 manufacturer identity code.
86 */
Linus Walleijf17a1f02009-08-04 01:01:02 +010087enum amba_vendor {
88 AMBA_VENDOR_ARM = 0x41,
89 AMBA_VENDOR_ST = 0x80,
srinikfbebf592014-05-15 11:28:44 +010090 AMBA_VENDOR_QCOM = 0x51,
Anders Bergdb4fa452014-09-17 08:46:58 +020091 AMBA_VENDOR_LSI = 0xb6,
Shawn Guo2426fbc2016-07-08 17:00:41 +080092 AMBA_VENDOR_LINUX = 0xfe, /* This value is not official */
Linus Walleijf17a1f02009-08-04 01:01:02 +010093};
94
Shawn Guo2426fbc2016-07-08 17:00:41 +080095/* This is used to generate pseudo-ID for AMBA device */
96#define AMBA_LINUX_ID(conf, rev, part) \
97 (((conf) & 0xff) << 24 | ((rev) & 0xf) << 20 | \
98 AMBA_VENDOR_LINUX << 12 | ((part) & 0xfff))
99
Rob Herring394d5ae2011-02-12 15:58:25 +0100100extern struct bus_type amba_bustype;
101
Rabin Vincentba74ec72011-02-23 04:33:17 +0100102#define to_amba_device(d) container_of(d, struct amba_device, dev)
103
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104#define amba_get_drvdata(d) dev_get_drvdata(&d->dev)
105#define amba_set_drvdata(d,p) dev_set_drvdata(&d->dev, p)
106
107int amba_driver_register(struct amba_driver *);
108void amba_driver_unregister(struct amba_driver *);
Russell Kingd5dc9272011-12-18 11:07:47 +0000109struct amba_device *amba_device_alloc(const char *, resource_size_t, size_t);
110void amba_device_put(struct amba_device *);
111int amba_device_add(struct amba_device *, struct resource *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112int amba_device_register(struct amba_device *, struct resource *);
Linus Walleij6026aa92012-04-03 11:58:42 +0100113struct amba_device *amba_apb_device_add(struct device *parent, const char *name,
114 resource_size_t base, size_t size,
115 int irq1, int irq2, void *pdata,
116 unsigned int periphid);
117struct amba_device *amba_ahb_device_add(struct device *parent, const char *name,
118 resource_size_t base, size_t size,
119 int irq1, int irq2, void *pdata,
120 unsigned int periphid);
Linus Walleij3ad909b2012-11-30 16:30:43 +0100121struct amba_device *
122amba_apb_device_add_res(struct device *parent, const char *name,
123 resource_size_t base, size_t size, int irq1,
124 int irq2, void *pdata, unsigned int periphid,
125 struct resource *resbase);
126struct amba_device *
127amba_ahb_device_add_res(struct device *parent, const char *name,
128 resource_size_t base, size_t size, int irq1,
129 int irq2, void *pdata, unsigned int periphid,
130 struct resource *resbase);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131void amba_device_unregister(struct amba_device *);
132struct amba_device *amba_find_device(const char *, struct device *, unsigned int, unsigned int);
133int amba_request_regions(struct amba_device *, const char *);
134void amba_release_regions(struct amba_device *);
135
Krzysztof Kozlowski67c2b9c2014-11-18 12:18:18 +0100136static inline int amba_pclk_enable(struct amba_device *dev)
137{
138 return clk_enable(dev->pclk);
139}
Russell King7cfe2492010-07-15 10:47:14 +0100140
Krzysztof Kozlowski67c2b9c2014-11-18 12:18:18 +0100141static inline void amba_pclk_disable(struct amba_device *dev)
142{
143 clk_disable(dev->pclk);
144}
Russell King7cfe2492010-07-15 10:47:14 +0100145
Krzysztof Kozlowskif560e322014-11-14 09:47:49 +0100146static inline int amba_pclk_prepare(struct amba_device *dev)
147{
148 return clk_prepare(dev->pclk);
149}
150
151static inline void amba_pclk_unprepare(struct amba_device *dev)
152{
153 clk_unprepare(dev->pclk);
154}
155
Linus Walleij01723a92010-09-07 22:43:19 +0100156/* Some drivers don't use the struct amba_device */
157#define AMBA_CONFIG_BITS(a) (((a) >> 24) & 0xff)
158#define AMBA_REV_BITS(a) (((a) >> 20) & 0x0f)
159#define AMBA_MANF_BITS(a) (((a) >> 12) & 0xff)
160#define AMBA_PART_BITS(a) ((a) & 0xfff)
161
162#define amba_config(d) AMBA_CONFIG_BITS((d)->periphid)
163#define amba_rev(d) AMBA_REV_BITS((d)->periphid)
164#define amba_manf(d) AMBA_MANF_BITS((d)->periphid)
165#define amba_part(d) AMBA_PART_BITS((d)->periphid)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166
Russell Kingcc6e75a2011-12-18 12:06:25 +0000167#define __AMBA_DEV(busid, data, mask) \
168 { \
169 .coherent_dma_mask = mask, \
170 .init_name = busid, \
171 .platform_data = data, \
172 }
173
174/*
175 * APB devices do not themselves have the ability to address memory,
176 * so DMA masks should be zero (much like USB peripheral devices.)
177 * The DMA controller DMA masks should be used instead (much like
178 * USB host controllers in conventional PCs.)
179 */
180#define AMBA_APB_DEVICE(name, busid, id, base, irqs, data) \
181struct amba_device name##_device = { \
182 .dev = __AMBA_DEV(busid, data, 0), \
183 .res = DEFINE_RES_MEM(base, SZ_4K), \
184 .irq = irqs, \
185 .periphid = id, \
186}
187
188/*
189 * AHB devices are DMA capable, so set their DMA masks
190 */
191#define AMBA_AHB_DEVICE(name, busid, id, base, irqs, data) \
192struct amba_device name##_device = { \
193 .dev = __AMBA_DEV(busid, data, ~0ULL), \
194 .res = DEFINE_RES_MEM(base, SZ_4K), \
Russell Kingcc6e75a2011-12-18 12:06:25 +0000195 .irq = irqs, \
196 .periphid = id, \
197}
198
viresh kumar9e5ed092012-03-15 10:40:38 +0100199/*
200 * module_amba_driver() - Helper macro for drivers that don't do anything
201 * special in module init/exit. This eliminates a lot of boilerplate. Each
202 * module may only use this macro once, and calling it replaces module_init()
203 * and module_exit()
204 */
205#define module_amba_driver(__amba_drv) \
206 module_driver(__amba_drv, amba_driver_register, amba_driver_unregister)
207
Paul Gortmaker941943c2016-02-17 17:52:03 -0700208/*
209 * builtin_amba_driver() - Helper macro for drivers that don't do anything
210 * special in driver initcall. This eliminates a lot of boilerplate. Each
211 * driver may only use this macro once, and calling it replaces the instance
212 * device_initcall().
213 */
214#define builtin_amba_driver(__amba_drv) \
215 builtin_driver(__amba_drv, amba_driver_register)
216
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217#endif