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