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 struct clk; 29 30 struct amba_device { 31 struct device dev; 32 struct resource res; 33 struct clk *pclk; 34 unsigned int periphid; 35 unsigned int irq[AMBA_NR_IRQS]; 36 }; 37 38 struct amba_driver { 39 struct device_driver drv; 40 int (*probe)(struct amba_device *, const struct amba_id *); 41 int (*remove)(struct amba_device *); 42 void (*shutdown)(struct amba_device *); 43 int (*suspend)(struct amba_device *, pm_message_t); 44 int (*resume)(struct amba_device *); 45 const struct amba_id *id_table; 46 }; 47 48 /* 49 * Constants for the designer field of the Peripheral ID register. When bit 7 50 * is set to '1', bits [6:0] should be the JEP106 manufacturer identity code. 51 */ 52 enum amba_vendor { 53 AMBA_VENDOR_ARM = 0x41, 54 AMBA_VENDOR_ST = 0x80, 55 AMBA_VENDOR_QCOM = 0x51, 56 AMBA_VENDOR_LSI = 0xb6, 57 }; 58 59 extern struct bus_type amba_bustype; 60 61 #define to_amba_device(d) container_of(d, struct amba_device, dev) 62 63 #define amba_get_drvdata(d) dev_get_drvdata(&d->dev) 64 #define amba_set_drvdata(d,p) dev_set_drvdata(&d->dev, p) 65 66 int amba_driver_register(struct amba_driver *); 67 void amba_driver_unregister(struct amba_driver *); 68 struct amba_device *amba_device_alloc(const char *, resource_size_t, size_t); 69 void amba_device_put(struct amba_device *); 70 int amba_device_add(struct amba_device *, struct resource *); 71 int amba_device_register(struct amba_device *, struct resource *); 72 struct amba_device *amba_apb_device_add(struct device *parent, const char *name, 73 resource_size_t base, size_t size, 74 int irq1, int irq2, void *pdata, 75 unsigned int periphid); 76 struct amba_device *amba_ahb_device_add(struct device *parent, const char *name, 77 resource_size_t base, size_t size, 78 int irq1, int irq2, void *pdata, 79 unsigned int periphid); 80 struct amba_device * 81 amba_apb_device_add_res(struct device *parent, const char *name, 82 resource_size_t base, size_t size, int irq1, 83 int irq2, void *pdata, unsigned int periphid, 84 struct resource *resbase); 85 struct amba_device * 86 amba_ahb_device_add_res(struct device *parent, const char *name, 87 resource_size_t base, size_t size, int irq1, 88 int irq2, void *pdata, unsigned int periphid, 89 struct resource *resbase); 90 void amba_device_unregister(struct amba_device *); 91 struct amba_device *amba_find_device(const char *, struct device *, unsigned int, unsigned int); 92 int amba_request_regions(struct amba_device *, const char *); 93 void amba_release_regions(struct amba_device *); 94 95 #define amba_pclk_enable(d) \ 96 (IS_ERR((d)->pclk) ? 0 : clk_enable((d)->pclk)) 97 98 #define amba_pclk_disable(d) \ 99 do { if (!IS_ERR((d)->pclk)) clk_disable((d)->pclk); } while (0) 100 101 static inline int amba_pclk_prepare(struct amba_device *dev) 102 { 103 return clk_prepare(dev->pclk); 104 } 105 106 static inline void amba_pclk_unprepare(struct amba_device *dev) 107 { 108 clk_unprepare(dev->pclk); 109 } 110 111 /* Some drivers don't use the struct amba_device */ 112 #define AMBA_CONFIG_BITS(a) (((a) >> 24) & 0xff) 113 #define AMBA_REV_BITS(a) (((a) >> 20) & 0x0f) 114 #define AMBA_MANF_BITS(a) (((a) >> 12) & 0xff) 115 #define AMBA_PART_BITS(a) ((a) & 0xfff) 116 117 #define amba_config(d) AMBA_CONFIG_BITS((d)->periphid) 118 #define amba_rev(d) AMBA_REV_BITS((d)->periphid) 119 #define amba_manf(d) AMBA_MANF_BITS((d)->periphid) 120 #define amba_part(d) AMBA_PART_BITS((d)->periphid) 121 122 #define __AMBA_DEV(busid, data, mask) \ 123 { \ 124 .coherent_dma_mask = mask, \ 125 .init_name = busid, \ 126 .platform_data = data, \ 127 } 128 129 /* 130 * APB devices do not themselves have the ability to address memory, 131 * so DMA masks should be zero (much like USB peripheral devices.) 132 * The DMA controller DMA masks should be used instead (much like 133 * USB host controllers in conventional PCs.) 134 */ 135 #define AMBA_APB_DEVICE(name, busid, id, base, irqs, data) \ 136 struct amba_device name##_device = { \ 137 .dev = __AMBA_DEV(busid, data, 0), \ 138 .res = DEFINE_RES_MEM(base, SZ_4K), \ 139 .irq = irqs, \ 140 .periphid = id, \ 141 } 142 143 /* 144 * AHB devices are DMA capable, so set their DMA masks 145 */ 146 #define AMBA_AHB_DEVICE(name, busid, id, base, irqs, data) \ 147 struct amba_device name##_device = { \ 148 .dev = __AMBA_DEV(busid, data, ~0ULL), \ 149 .res = DEFINE_RES_MEM(base, SZ_4K), \ 150 .irq = irqs, \ 151 .periphid = id, \ 152 } 153 154 /* 155 * module_amba_driver() - Helper macro for drivers that don't do anything 156 * special in module init/exit. This eliminates a lot of boilerplate. Each 157 * module may only use this macro once, and calling it replaces module_init() 158 * and module_exit() 159 */ 160 #define module_amba_driver(__amba_drv) \ 161 module_driver(__amba_drv, amba_driver_register, amba_driver_unregister) 162 163 #endif 164