include/linux/bcma/bcma.h

   1 #ifndef LINUX_BCMA_H_
   2 #define LINUX_BCMA_H_
   3
   4 #include <linux/pci.h>
   5 #include <linux/mod_devicetable.h>
   6
   7 #include <linux/bcma/bcma_driver_chipcommon.h>
   8 #include <linux/bcma/bcma_driver_pci.h>
   9 #include <linux/bcma/bcma_driver_mips.h>
  10 #include <linux/ssb/ssb.h> /* SPROM sharing */
  11
  12 #include "bcma_regs.h"
  13
  14 struct bcma_device;
  15 struct bcma_bus;
  16
  17 enum bcma_hosttype {
  18         BCMA_HOSTTYPE_PCI,
  19         BCMA_HOSTTYPE_SDIO,
  20         BCMA_HOSTTYPE_SOC,
  21 };
  22
  23 struct bcma_chipinfo {
  24         u16 id;
  25         u8 rev;
  26         u8 pkg;
  27 };
  28
  29 enum bcma_clkmode {
  30         BCMA_CLKMODE_FAST,
  31         BCMA_CLKMODE_DYNAMIC,
  32 };
  33
  34 struct bcma_host_ops {
  35         u8 (*read8)(struct bcma_device *core, u16 offset);
  36         u16 (*read16)(struct bcma_device *core, u16 offset);
  37         u32 (*read32)(struct bcma_device *core, u16 offset);
  38         void (*write8)(struct bcma_device *core, u16 offset, u8 value);
  39         void (*write16)(struct bcma_device *core, u16 offset, u16 value);
  40         void (*write32)(struct bcma_device *core, u16 offset, u32 value);
  41 #ifdef CONFIG_BCMA_BLOCKIO
  42         void (*block_read)(struct bcma_device *core, void *buffer,
  43                            size_t count, u16 offset, u8 reg_width);
  44         void (*block_write)(struct bcma_device *core, const void *buffer,
  45                             size_t count, u16 offset, u8 reg_width);
  46 #endif
  47         /* Agent ops */
  48         u32 (*aread32)(struct bcma_device *core, u16 offset);
  49         void (*awrite32)(struct bcma_device *core, u16 offset, u32 value);
  50 };
  51
  52 /* Core manufacturers */
  53 #define BCMA_MANUF_ARM                  0x43B
  54 #define BCMA_MANUF_MIPS                 0x4A7
  55 #define BCMA_MANUF_BCM                  0x4BF
  56
  57 /* Core class values. */
  58 #define BCMA_CL_SIM                     0x0
  59 #define BCMA_CL_EROM                    0x1
  60 #define BCMA_CL_CORESIGHT               0x9
  61 #define BCMA_CL_VERIF                   0xB
  62 #define BCMA_CL_OPTIMO                  0xD
  63 #define BCMA_CL_GEN                     0xE
  64 #define BCMA_CL_PRIMECELL               0xF
  65
  66 /* Core-ID values. */
  67 #define BCMA_CORE_OOB_ROUTER            0x367   /* Out of band */
  68 #define BCMA_CORE_INVALID               0x700
  69 #define BCMA_CORE_CHIPCOMMON            0x800
  70 #define BCMA_CORE_ILINE20               0x801
  71 #define BCMA_CORE_SRAM                  0x802
  72 #define BCMA_CORE_SDRAM                 0x803
  73 #define BCMA_CORE_PCI                   0x804
  74 #define BCMA_CORE_MIPS                  0x805
  75 #define BCMA_CORE_ETHERNET              0x806
  76 #define BCMA_CORE_V90                   0x807
  77 #define BCMA_CORE_USB11_HOSTDEV         0x808
  78 #define BCMA_CORE_ADSL                  0x809
  79 #define BCMA_CORE_ILINE100              0x80A
  80 #define BCMA_CORE_IPSEC                 0x80B
  81 #define BCMA_CORE_UTOPIA                0x80C
  82 #define BCMA_CORE_PCMCIA                0x80D
  83 #define BCMA_CORE_INTERNAL_MEM          0x80E
  84 #define BCMA_CORE_MEMC_SDRAM            0x80F
  85 #define BCMA_CORE_OFDM                  0x810
  86 #define BCMA_CORE_EXTIF                 0x811
  87 #define BCMA_CORE_80211                 0x812
  88 #define BCMA_CORE_PHY_A                 0x813
  89 #define BCMA_CORE_PHY_B                 0x814
  90 #define BCMA_CORE_PHY_G                 0x815
  91 #define BCMA_CORE_MIPS_3302             0x816
  92 #define BCMA_CORE_USB11_HOST            0x817
  93 #define BCMA_CORE_USB11_DEV             0x818
  94 #define BCMA_CORE_USB20_HOST            0x819
  95 #define BCMA_CORE_USB20_DEV             0x81A
  96 #define BCMA_CORE_SDIO_HOST             0x81B
  97 #define BCMA_CORE_ROBOSWITCH            0x81C
  98 #define BCMA_CORE_PARA_ATA              0x81D
  99 #define BCMA_CORE_SATA_XORDMA           0x81E
 100 #define BCMA_CORE_ETHERNET_GBIT         0x81F
 101 #define BCMA_CORE_PCIE                  0x820
 102 #define BCMA_CORE_PHY_N                 0x821
 103 #define BCMA_CORE_SRAM_CTL              0x822
 104 #define BCMA_CORE_MINI_MACPHY           0x823
 105 #define BCMA_CORE_ARM_1176              0x824
 106 #define BCMA_CORE_ARM_7TDMI             0x825
 107 #define BCMA_CORE_PHY_LP                0x826
 108 #define BCMA_CORE_PMU                   0x827
 109 #define BCMA_CORE_PHY_SSN               0x828
 110 #define BCMA_CORE_SDIO_DEV              0x829
 111 #define BCMA_CORE_ARM_CM3               0x82A
 112 #define BCMA_CORE_PHY_HT                0x82B
 113 #define BCMA_CORE_MIPS_74K              0x82C
 114 #define BCMA_CORE_MAC_GBIT              0x82D
 115 #define BCMA_CORE_DDR12_MEM_CTL         0x82E
 116 #define BCMA_CORE_PCIE_RC               0x82F   /* PCIe Root Complex */
 117 #define BCMA_CORE_OCP_OCP_BRIDGE        0x830
 118 #define BCMA_CORE_SHARED_COMMON         0x831
 119 #define BCMA_CORE_OCP_AHB_BRIDGE        0x832
 120 #define BCMA_CORE_SPI_HOST              0x833
 121 #define BCMA_CORE_I2S                   0x834
 122 #define BCMA_CORE_SDR_DDR1_MEM_CTL      0x835   /* SDR/DDR1 memory controller core */
 123 #define BCMA_CORE_SHIM                  0x837   /* SHIM component in ubus/6362 */
 124 #define BCMA_CORE_DEFAULT               0xFFF
 125
 126 #define BCMA_MAX_NR_CORES               16
 127
 128 struct bcma_device {
 129         struct bcma_bus *bus;
 130         struct bcma_device_id id;
 131
 132         struct device dev;
 133         struct device *dma_dev;
 134
 135         unsigned int irq;
 136         bool dev_registered;
 137
 138         u8 core_index;
 139
 140         u32 addr;
 141         u32 wrap;
 142
 143         void __iomem *io_addr;
 144         void __iomem *io_wrap;
 145
 146         void *drvdata;
 147         struct list_head list;
 148 };
 149
 150 static inline void *bcma_get_drvdata(struct bcma_device *core)
 151 {
 152         return core->drvdata;
 153 }
 154 static inline void bcma_set_drvdata(struct bcma_device *core, void *drvdata)
 155 {
 156         core->drvdata = drvdata;
 157 }
 158
 159 struct bcma_driver {
 160         const char *name;
 161         const struct bcma_device_id *id_table;
 162
 163         int (*probe)(struct bcma_device *dev);
 164         void (*remove)(struct bcma_device *dev);
 165         int (*suspend)(struct bcma_device *dev, pm_message_t state);
 166         int (*resume)(struct bcma_device *dev);
 167         void (*shutdown)(struct bcma_device *dev);
 168
 169         struct device_driver drv;
 170 };
 171 extern
 172 int __bcma_driver_register(struct bcma_driver *drv, struct module *owner);
 173 static inline int bcma_driver_register(struct bcma_driver *drv)
 174 {
 175         return __bcma_driver_register(drv, THIS_MODULE);
 176 }
 177 extern void bcma_driver_unregister(struct bcma_driver *drv);
 178
 179 struct bcma_bus {
 180         /* The MMIO area. */
 181         void __iomem *mmio;
 182
 183         const struct bcma_host_ops *ops;
 184
 185         enum bcma_hosttype hosttype;
 186         union {
 187                 /* Pointer to the PCI bus (only for BCMA_HOSTTYPE_PCI) */
 188                 struct pci_dev *host_pci;
 189                 /* Pointer to the SDIO device (only for BCMA_HOSTTYPE_SDIO) */
 190                 struct sdio_func *host_sdio;
 191         };
 192
 193         struct bcma_chipinfo chipinfo;
 194
 195         struct bcma_device *mapped_core;
 196         struct list_head cores;
 197         u8 nr_cores;
 198         u8 init_done:1;
 199
 200         struct bcma_drv_cc drv_cc;
 201         struct bcma_drv_pci drv_pci;
 202         struct bcma_drv_mips drv_mips;
 203
 204         /* We decided to share SPROM struct with SSB as long as we do not need
 205          * any hacks for BCMA. This simplifies drivers code. */
 206         struct ssb_sprom sprom;
 207 };
 208
 209 extern inline u32 bcma_read8(struct bcma_device *core, u16 offset)
 210 {
 211         return core->bus->ops->read8(core, offset);
 212 }
 213 extern inline u32 bcma_read16(struct bcma_device *core, u16 offset)
 214 {
 215         return core->bus->ops->read16(core, offset);
 216 }
 217 extern inline u32 bcma_read32(struct bcma_device *core, u16 offset)
 218 {
 219         return core->bus->ops->read32(core, offset);
 220 }
 221 extern inline
 222 void bcma_write8(struct bcma_device *core, u16 offset, u32 value)
 223 {
 224         core->bus->ops->write8(core, offset, value);
 225 }
 226 extern inline
 227 void bcma_write16(struct bcma_device *core, u16 offset, u32 value)
 228 {
 229         core->bus->ops->write16(core, offset, value);
 230 }
 231 extern inline
 232 void bcma_write32(struct bcma_device *core, u16 offset, u32 value)
 233 {
 234         core->bus->ops->write32(core, offset, value);
 235 }
 236 #ifdef CONFIG_BCMA_BLOCKIO
 237 extern inline void bcma_block_read(struct bcma_device *core, void *buffer,
 238                                    size_t count, u16 offset, u8 reg_width)
 239 {
 240         core->bus->ops->block_read(core, buffer, count, offset, reg_width);
 241 }
 242 extern inline void bcma_block_write(struct bcma_device *core, const void *buffer,
 243                                     size_t count, u16 offset, u8 reg_width)
 244 {
 245         core->bus->ops->block_write(core, buffer, count, offset, reg_width);
 246 }
 247 #endif
 248 extern inline u32 bcma_aread32(struct bcma_device *core, u16 offset)
 249 {
 250         return core->bus->ops->aread32(core, offset);
 251 }
 252 extern inline
 253 void bcma_awrite32(struct bcma_device *core, u16 offset, u32 value)
 254 {
 255         core->bus->ops->awrite32(core, offset, value);
 256 }
 257
 258 #define bcma_mask32(cc, offset, mask) \
 259         bcma_write32(cc, offset, bcma_read32(cc, offset) & (mask))
 260 #define bcma_set32(cc, offset, set) \
 261         bcma_write32(cc, offset, bcma_read32(cc, offset) | (set))
 262 #define bcma_maskset32(cc, offset, mask, set) \
 263         bcma_write32(cc, offset, (bcma_read32(cc, offset) & (mask)) | (set))
 264
 265 extern bool bcma_core_is_enabled(struct bcma_device *core);
 266 extern void bcma_core_disable(struct bcma_device *core, u32 flags);
 267 extern int bcma_core_enable(struct bcma_device *core, u32 flags);
 268 extern void bcma_core_set_clockmode(struct bcma_device *core,
 269                                     enum bcma_clkmode clkmode);
 270 extern void bcma_core_pll_ctl(struct bcma_device *core, u32 req, u32 status,
 271                               bool on);
 272 #define BCMA_DMA_TRANSLATION_MASK       0xC0000000
 273 #define  BCMA_DMA_TRANSLATION_NONE      0x00000000
 274 #define  BCMA_DMA_TRANSLATION_DMA32_CMT 0x40000000 /* Client Mode Translation for 32-bit DMA */
 275 #define  BCMA_DMA_TRANSLATION_DMA64_CMT 0x80000000 /* Client Mode Translation for 64-bit DMA */
 276 extern u32 bcma_core_dma_translation(struct bcma_device *core);
 277
 278 #endif /* LINUX_BCMA_H_ */