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 9 25 #define AMBA_CID 0xb105f00d 26 #define CORESIGHT_CID 0xb105900d 27 28 /* 29 * CoreSight Architecture specification updates the ID specification 30 * for components on the AMBA bus. (ARM IHI 0029E) 31 * 32 * Bits 15:12 of the CID are the device class. 33 * 34 * Class 0xF remains for PrimeCell and legacy components. (AMBA_CID above) 35 * Class 0x9 defines the component as CoreSight (CORESIGHT_CID above) 36 * Class 0x0, 0x1, 0xB, 0xE define components that do not have driver support 37 * at present. 38 * Class 0x2-0x8,0xA and 0xD-0xD are presently reserved. 39 * 40 * Remaining CID bits stay as 0xb105-00d 41 */ 42 43 /** 44 * Class 0x9 components use additional values to form a Unique Component 45 * Identifier (UCI), where peripheral ID values are identical for different 46 * components. Passed to the amba bus code from the component driver via 47 * the amba_id->data pointer. 48 * @devarch : coresight devarch register value 49 * @devarch_mask: mask bits used for matching. 0 indicates UCI not used. 50 * @devtype : coresight device type value 51 * @data : additional driver data. As we have usurped the original 52 * pointer some devices may still need additional data 53 */ 54 struct amba_cs_uci_id { 55 unsigned int devarch; 56 unsigned int devarch_mask; 57 unsigned int devtype; 58 void *data; 59 }; 60 61 /* define offsets for registers used by UCI */ 62 #define UCI_REG_DEVTYPE_OFFSET 0xFCC 63 #define UCI_REG_DEVARCH_OFFSET 0xFBC 64 65 struct clk; 66 67 struct amba_device { 68 struct device dev; 69 struct resource res; 70 struct clk *pclk; 71 unsigned int periphid; 72 unsigned int cid; 73 struct amba_cs_uci_id uci; 74 unsigned int irq[AMBA_NR_IRQS]; 75 char *driver_override; 76 }; 77 78 struct amba_driver { 79 struct device_driver drv; 80 int (*probe)(struct amba_device *, const struct amba_id *); 81 int (*remove)(struct amba_device *); 82 void (*shutdown)(struct amba_device *); 83 const struct amba_id *id_table; 84 }; 85 86 /* 87 * Constants for the designer field of the Peripheral ID register. When bit 7 88 * is set to '1', bits [6:0] should be the JEP106 manufacturer identity code. 89 */ 90 enum amba_vendor { 91 AMBA_VENDOR_ARM = 0x41, 92 AMBA_VENDOR_ST = 0x80, 93 AMBA_VENDOR_QCOM = 0x51, 94 AMBA_VENDOR_LSI = 0xb6, 95 AMBA_VENDOR_LINUX = 0xfe, /* This value is not official */ 96 }; 97 98 /* This is used to generate pseudo-ID for AMBA device */ 99 #define AMBA_LINUX_ID(conf, rev, part) \ 100 (((conf) & 0xff) << 24 | ((rev) & 0xf) << 20 | \ 101 AMBA_VENDOR_LINUX << 12 | ((part) & 0xfff)) 102 103 extern struct bus_type amba_bustype; 104 105 #define to_amba_device(d) container_of(d, struct amba_device, dev) 106 107 #define amba_get_drvdata(d) dev_get_drvdata(&d->dev) 108 #define amba_set_drvdata(d,p) dev_set_drvdata(&d->dev, p) 109 110 int amba_driver_register(struct amba_driver *); 111 void amba_driver_unregister(struct amba_driver *); 112 struct amba_device *amba_device_alloc(const char *, resource_size_t, size_t); 113 void amba_device_put(struct amba_device *); 114 int amba_device_add(struct amba_device *, struct resource *); 115 int amba_device_register(struct amba_device *, struct resource *); 116 struct amba_device *amba_apb_device_add(struct device *parent, const char *name, 117 resource_size_t base, size_t size, 118 int irq1, int irq2, void *pdata, 119 unsigned int periphid); 120 struct amba_device *amba_ahb_device_add(struct device *parent, const char *name, 121 resource_size_t base, size_t size, 122 int irq1, int irq2, void *pdata, 123 unsigned int periphid); 124 struct amba_device * 125 amba_apb_device_add_res(struct device *parent, const char *name, 126 resource_size_t base, size_t size, int irq1, 127 int irq2, void *pdata, unsigned int periphid, 128 struct resource *resbase); 129 struct amba_device * 130 amba_ahb_device_add_res(struct device *parent, const char *name, 131 resource_size_t base, size_t size, int irq1, 132 int irq2, void *pdata, unsigned int periphid, 133 struct resource *resbase); 134 void amba_device_unregister(struct amba_device *); 135 struct amba_device *amba_find_device(const char *, struct device *, unsigned int, unsigned int); 136 int amba_request_regions(struct amba_device *, const char *); 137 void amba_release_regions(struct amba_device *); 138 139 static inline int amba_pclk_enable(struct amba_device *dev) 140 { 141 return clk_enable(dev->pclk); 142 } 143 144 static inline void amba_pclk_disable(struct amba_device *dev) 145 { 146 clk_disable(dev->pclk); 147 } 148 149 static inline int amba_pclk_prepare(struct amba_device *dev) 150 { 151 return clk_prepare(dev->pclk); 152 } 153 154 static inline void amba_pclk_unprepare(struct amba_device *dev) 155 { 156 clk_unprepare(dev->pclk); 157 } 158 159 /* Some drivers don't use the struct amba_device */ 160 #define AMBA_CONFIG_BITS(a) (((a) >> 24) & 0xff) 161 #define AMBA_REV_BITS(a) (((a) >> 20) & 0x0f) 162 #define AMBA_MANF_BITS(a) (((a) >> 12) & 0xff) 163 #define AMBA_PART_BITS(a) ((a) & 0xfff) 164 165 #define amba_config(d) AMBA_CONFIG_BITS((d)->periphid) 166 #define amba_rev(d) AMBA_REV_BITS((d)->periphid) 167 #define amba_manf(d) AMBA_MANF_BITS((d)->periphid) 168 #define amba_part(d) AMBA_PART_BITS((d)->periphid) 169 170 #define __AMBA_DEV(busid, data, mask) \ 171 { \ 172 .coherent_dma_mask = mask, \ 173 .init_name = busid, \ 174 .platform_data = data, \ 175 } 176 177 /* 178 * APB devices do not themselves have the ability to address memory, 179 * so DMA masks should be zero (much like USB peripheral devices.) 180 * The DMA controller DMA masks should be used instead (much like 181 * USB host controllers in conventional PCs.) 182 */ 183 #define AMBA_APB_DEVICE(name, busid, id, base, irqs, data) \ 184 struct amba_device name##_device = { \ 185 .dev = __AMBA_DEV(busid, data, 0), \ 186 .res = DEFINE_RES_MEM(base, SZ_4K), \ 187 .irq = irqs, \ 188 .periphid = id, \ 189 } 190 191 /* 192 * AHB devices are DMA capable, so set their DMA masks 193 */ 194 #define AMBA_AHB_DEVICE(name, busid, id, base, irqs, data) \ 195 struct amba_device name##_device = { \ 196 .dev = __AMBA_DEV(busid, data, ~0ULL), \ 197 .res = DEFINE_RES_MEM(base, SZ_4K), \ 198 .irq = irqs, \ 199 .periphid = id, \ 200 } 201 202 /* 203 * module_amba_driver() - Helper macro for drivers that don't do anything 204 * special in module init/exit. This eliminates a lot of boilerplate. Each 205 * module may only use this macro once, and calling it replaces module_init() 206 * and module_exit() 207 */ 208 #define module_amba_driver(__amba_drv) \ 209 module_driver(__amba_drv, amba_driver_register, amba_driver_unregister) 210 211 /* 212 * builtin_amba_driver() - Helper macro for drivers that don't do anything 213 * special in driver initcall. This eliminates a lot of boilerplate. Each 214 * driver may only use this macro once, and calling it replaces the instance 215 * device_initcall(). 216 */ 217 #define builtin_amba_driver(__amba_drv) \ 218 builtin_driver(__amba_drv, amba_driver_register) 219 220 #endif 221