include/linux/amba/bus.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /*
   3  *  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.
   8  *
   9  *  Copyright (C) 2003 Deep Blue Solutions Ltd, All Rights Reserved.
  10  */
  11 #ifndef ASMARM_AMBA_H
  12 #define ASMARM_AMBA_H
  13
  14 #include <linux/clk.h>
  15 #include <linux/device.h>
  16 #include <linux/mod_devicetable.h>
  17 #include <linux/err.h>
  18 #include <linux/resource.h>
  19 #include <linux/regulator/consumer.h>
  20
  21 #define AMBA_NR_IRQS    9
  22 #define AMBA_CID        0xb105f00d
  23 #define CORESIGHT_CID   0xb105900d
  24
  25 /*
  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  */
  51 struct amba_cs_uci_id {
  52         unsigned int devarch;
  53         unsigned int devarch_mask;
  54         unsigned int devtype;
  55         void *data;
  56 };
  57
  58 /* define offsets for registers used by UCI */
  59 #define UCI_REG_DEVTYPE_OFFSET  0xFCC
  60 #define UCI_REG_DEVARCH_OFFSET  0xFBC
  61
  62 struct clk;
  63
  64 struct amba_device {
  65         struct device           dev;
  66         struct resource         res;
  67         struct clk              *pclk;
  68         unsigned int            periphid;
  69         unsigned int            cid;
  70         struct amba_cs_uci_id   uci;
  71         unsigned int            irq[AMBA_NR_IRQS];
  72         char                    *driver_override;
  73 };
  74
  75 struct amba_driver {
  76         struct device_driver    drv;
  77         int                     (*probe)(struct amba_device *, const struct amba_id *);
  78         int                     (*remove)(struct amba_device *);
  79         void                    (*shutdown)(struct amba_device *);
  80         const struct amba_id    *id_table;
  81 };
  82
  83 /*
  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  */
  87 enum amba_vendor {
  88         AMBA_VENDOR_ARM = 0x41,
  89         AMBA_VENDOR_ST = 0x80,
  90         AMBA_VENDOR_QCOM = 0x51,
  91         AMBA_VENDOR_LSI = 0xb6,
  92         AMBA_VENDOR_LINUX = 0xfe,       /* This value is not official */
  93 };
  94
  95 /* 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
 100 extern struct bus_type amba_bustype;
 101
 102 #define to_amba_device(d)       container_of(d, struct amba_device, dev)
 103
 104 #define amba_get_drvdata(d)     dev_get_drvdata(&d->dev)
 105 #define amba_set_drvdata(d,p)   dev_set_drvdata(&d->dev, p)
 106
 107 int amba_driver_register(struct amba_driver *);
 108 void amba_driver_unregister(struct amba_driver *);
 109 struct amba_device *amba_device_alloc(const char *, resource_size_t, size_t);
 110 void amba_device_put(struct amba_device *);
 111 int amba_device_add(struct amba_device *, struct resource *);
 112 int amba_device_register(struct amba_device *, struct resource *);
 113 struct 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);
 117 struct 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);
 121 struct amba_device *
 122 amba_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);
 126 struct amba_device *
 127 amba_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);
 131 void amba_device_unregister(struct amba_device *);
 132 struct amba_device *amba_find_device(const char *, struct device *, unsigned int, unsigned int);
 133 int amba_request_regions(struct amba_device *, const char *);
 134 void amba_release_regions(struct amba_device *);
 135
 136 static inline int amba_pclk_enable(struct amba_device *dev)
 137 {
 138         return clk_enable(dev->pclk);
 139 }
 140
 141 static inline void amba_pclk_disable(struct amba_device *dev)
 142 {
 143         clk_disable(dev->pclk);
 144 }
 145
 146 static inline int amba_pclk_prepare(struct amba_device *dev)
 147 {
 148         return clk_prepare(dev->pclk);
 149 }
 150
 151 static inline void amba_pclk_unprepare(struct amba_device *dev)
 152 {
 153         clk_unprepare(dev->pclk);
 154 }
 155
 156 /* 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)
 166
 167 #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)      \
 181 struct 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)      \
 192 struct amba_device name##_device = {                            \
 193         .dev = __AMBA_DEV(busid, data, ~0ULL),                  \
 194         .res = DEFINE_RES_MEM(base, SZ_4K),                     \
 195         .irq = irqs,                                            \
 196         .periphid = id,                                         \
 197 }
 198
 199 /*
 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
 208 /*
 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
 217 #endif