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