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 struct amba_device *amba_device_alloc(const char *, resource_size_t, size_t); 64 void amba_device_put(struct amba_device *); 65 int amba_device_add(struct amba_device *, struct resource *); 66 int amba_device_register(struct amba_device *, struct resource *); 67 void amba_device_unregister(struct amba_device *); 68 struct amba_device *amba_find_device(const char *, struct device *, unsigned int, unsigned int); 69 int amba_request_regions(struct amba_device *, const char *); 70 void amba_release_regions(struct amba_device *); 71 72 #define amba_pclk_enable(d) \ 73 (IS_ERR((d)->pclk) ? 0 : clk_enable((d)->pclk)) 74 75 #define amba_pclk_disable(d) \ 76 do { if (!IS_ERR((d)->pclk)) clk_disable((d)->pclk); } while (0) 77 78 #define amba_vcore_enable(d) \ 79 (IS_ERR((d)->vcore) ? 0 : regulator_enable((d)->vcore)) 80 81 #define amba_vcore_disable(d) \ 82 do { if (!IS_ERR((d)->vcore)) regulator_disable((d)->vcore); } while (0) 83 84 /* Some drivers don't use the struct amba_device */ 85 #define AMBA_CONFIG_BITS(a) (((a) >> 24) & 0xff) 86 #define AMBA_REV_BITS(a) (((a) >> 20) & 0x0f) 87 #define AMBA_MANF_BITS(a) (((a) >> 12) & 0xff) 88 #define AMBA_PART_BITS(a) ((a) & 0xfff) 89 90 #define amba_config(d) AMBA_CONFIG_BITS((d)->periphid) 91 #define amba_rev(d) AMBA_REV_BITS((d)->periphid) 92 #define amba_manf(d) AMBA_MANF_BITS((d)->periphid) 93 #define amba_part(d) AMBA_PART_BITS((d)->periphid) 94 95 #define __AMBA_DEV(busid, data, mask) \ 96 { \ 97 .coherent_dma_mask = mask, \ 98 .init_name = busid, \ 99 .platform_data = data, \ 100 } 101 102 /* 103 * APB devices do not themselves have the ability to address memory, 104 * so DMA masks should be zero (much like USB peripheral devices.) 105 * The DMA controller DMA masks should be used instead (much like 106 * USB host controllers in conventional PCs.) 107 */ 108 #define AMBA_APB_DEVICE(name, busid, id, base, irqs, data) \ 109 struct amba_device name##_device = { \ 110 .dev = __AMBA_DEV(busid, data, 0), \ 111 .res = DEFINE_RES_MEM(base, SZ_4K), \ 112 .irq = irqs, \ 113 .periphid = id, \ 114 } 115 116 /* 117 * AHB devices are DMA capable, so set their DMA masks 118 */ 119 #define AMBA_AHB_DEVICE(name, busid, id, base, irqs, data) \ 120 struct amba_device name##_device = { \ 121 .dev = __AMBA_DEV(busid, data, ~0ULL), \ 122 .res = DEFINE_RES_MEM(base, SZ_4K), \ 123 .dma_mask = ~0ULL, \ 124 .irq = irqs, \ 125 .periphid = id, \ 126 } 127 128 /* 129 * module_amba_driver() - Helper macro for drivers that don't do anything 130 * special in module init/exit. This eliminates a lot of boilerplate. Each 131 * module may only use this macro once, and calling it replaces module_init() 132 * and module_exit() 133 */ 134 #define module_amba_driver(__amba_drv) \ 135 module_driver(__amba_drv, amba_driver_register, amba_driver_unregister) 136 137 #endif 138