drivers/staging/brcm80211/include/siutils.h

   1 /*
   2  * Copyright (c) 2010 Broadcom Corporation
   3  *
   4  * Permission to use, copy, modify, and/or distribute this software for any
   5  * purpose with or without fee is hereby granted, provided that the above
   6  * copyright notice and this permission notice appear in all copies.
   7  *
   8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
   9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
  11  * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
  13  * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
  14  * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  15  */
  16
  17 #ifndef _siutils_h_
  18 #define _siutils_h_
  19
  20 #include <hndsoc.h>
  21
  22 /*
  23  * Data structure to export all chip specific common variables
  24  *   public (read-only) portion of siutils handle returned by si_attach()
  25  */
  26 struct si_pub {
  27         uint socitype;          /* SOCI_SB, SOCI_AI */
  28
  29         uint bustype;           /* SI_BUS, PCI_BUS */
  30         uint buscoretype;       /* PCI_CORE_ID, PCIE_CORE_ID, PCMCIA_CORE_ID */
  31         uint buscorerev;        /* buscore rev */
  32         uint buscoreidx;        /* buscore index */
  33         int ccrev;              /* chip common core rev */
  34         u32 cccaps;             /* chip common capabilities */
  35         u32 cccaps_ext; /* chip common capabilities extension */
  36         int pmurev;             /* pmu core rev */
  37         u32 pmucaps;            /* pmu capabilities */
  38         uint boardtype;         /* board type */
  39         uint boardvendor;       /* board vendor */
  40         uint boardflags;        /* board flags */
  41         uint boardflags2;       /* board flags2 */
  42         uint chip;              /* chip number */
  43         uint chiprev;           /* chip revision */
  44         uint chippkg;           /* chip package option */
  45         u32 chipst;             /* chip status */
  46         bool issim;             /* chip is in simulation or emulation */
  47         uint socirev;           /* SOC interconnect rev */
  48         bool pci_pr32414;
  49
  50 };
  51
  52 /* for HIGH_ONLY driver, the si_t must be writable to allow states sync from BMAC to HIGH driver
  53  * for monolithic driver, it is readonly to prevent accident change
  54  */
  55 typedef const struct si_pub si_t;
  56
  57 /*
  58  * Many of the routines below take an 'sih' handle as their first arg.
  59  * Allocate this by calling si_attach().  Free it by calling si_detach().
  60  * At any one time, the sih is logically focused on one particular si core
  61  * (the "current core").
  62  * Use si_setcore() or si_setcoreidx() to change the association to another core.
  63  */
  64
  65 #define BADIDX          (SI_MAXCORES + 1)
  66
  67 /* clkctl xtal what flags */
  68 #define XTAL                    0x1     /* primary crystal oscillator (2050) */
  69 #define PLL                     0x2     /* main chip pll */
  70
  71 /* clkctl clk mode */
  72 #define CLK_FAST                0       /* force fast (pll) clock */
  73 #define CLK_DYNAMIC             2       /* enable dynamic clock control */
  74
  75 /* GPIO usage priorities */
  76 #define GPIO_DRV_PRIORITY       0       /* Driver */
  77 #define GPIO_APP_PRIORITY       1       /* Application */
  78 #define GPIO_HI_PRIORITY        2       /* Highest priority. Ignore GPIO reservation */
  79
  80 /* GPIO pull up/down */
  81 #define GPIO_PULLUP             0
  82 #define GPIO_PULLDN             1
  83
  84 /* GPIO event regtype */
  85 #define GPIO_REGEVT             0       /* GPIO register event */
  86 #define GPIO_REGEVT_INTMSK      1       /* GPIO register event int mask */
  87 #define GPIO_REGEVT_INTPOL      2       /* GPIO register event int polarity */
  88
  89 /* device path */
  90 #define SI_DEVPATH_BUFSZ        16      /* min buffer size in bytes */
  91
  92 /* SI routine enumeration: to be used by update function with multiple hooks */
  93 #define SI_DOATTACH     1
  94 #define SI_PCIDOWN      2
  95 #define SI_PCIUP        3
  96
  97 #define ISSIM_ENAB(sih) 0
  98
  99 /* PMU clock/power control */
 100 #if defined(BCMPMUCTL)
 101 #define PMUCTL_ENAB(sih)        (BCMPMUCTL)
 102 #else
 103 #define PMUCTL_ENAB(sih)        ((sih)->cccaps & CC_CAP_PMU)
 104 #endif
 105
 106 /* chipcommon clock/power control (exclusive with PMU's) */
 107 #if defined(BCMPMUCTL) && BCMPMUCTL
 108 #define CCCTL_ENAB(sih)         (0)
 109 #define CCPLL_ENAB(sih)         (0)
 110 #else
 111 #define CCCTL_ENAB(sih)         ((sih)->cccaps & CC_CAP_PWR_CTL)
 112 #define CCPLL_ENAB(sih)         ((sih)->cccaps & CC_CAP_PLL_MASK)
 113 #endif
 114
 115 typedef void (*gpio_handler_t) (u32 stat, void *arg);
 116
 117 /* External PA enable mask */
 118 #define GPIO_CTRL_EPA_EN_MASK 0x40
 119
 120 /* === exported functions === */
 121 extern si_t *si_attach(uint pcidev, struct osl_info *osh, void *regs,
 122                        uint bustype, void *sdh, char **vars, uint *varsz);
 123
 124 extern void si_detach(si_t *sih);
 125 extern bool si_pci_war16165(si_t *sih);
 126
 127 extern uint si_coreid(si_t *sih);
 128 extern uint si_flag(si_t *sih);
 129 extern uint si_coreidx(si_t *sih);
 130 extern uint si_corerev(si_t *sih);
 131 struct osl_info *si_osh(si_t *sih);
 132 extern uint si_corereg(si_t *sih, uint coreidx, uint regoff, uint mask,
 133                 uint val);
 134 extern void si_write_wrapperreg(si_t *sih, u32 offset, u32 val);
 135 extern u32 si_core_cflags(si_t *sih, u32 mask, u32 val);
 136 extern u32 si_core_sflags(si_t *sih, u32 mask, u32 val);
 137 extern bool si_iscoreup(si_t *sih);
 138 extern uint si_findcoreidx(si_t *sih, uint coreid, uint coreunit);
 139 #ifndef BCMSDIO
 140 extern void *si_setcoreidx(si_t *sih, uint coreidx);
 141 #endif
 142 extern void *si_setcore(si_t *sih, uint coreid, uint coreunit);
 143 extern void *si_switch_core(si_t *sih, uint coreid, uint *origidx,
 144                             uint *intr_val);
 145 extern void si_restore_core(si_t *sih, uint coreid, uint intr_val);
 146 extern void si_core_reset(si_t *sih, u32 bits, u32 resetbits);
 147 extern void si_core_disable(si_t *sih, u32 bits);
 148 extern u32 si_alp_clock(si_t *sih);
 149 extern u32 si_ilp_clock(si_t *sih);
 150 extern void si_pci_setup(si_t *sih, uint coremask);
 151 extern void si_setint(si_t *sih, int siflag);
 152 extern bool si_backplane64(si_t *sih);
 153 extern void si_register_intr_callback(si_t *sih, void *intrsoff_fn,
 154                                       void *intrsrestore_fn,
 155                                       void *intrsenabled_fn, void *intr_arg);
 156 extern void si_deregister_intr_callback(si_t *sih);
 157 extern void si_clkctl_init(si_t *sih);
 158 extern u16 si_clkctl_fast_pwrup_delay(si_t *sih);
 159 extern bool si_clkctl_cc(si_t *sih, uint mode);
 160 extern int si_clkctl_xtal(si_t *sih, uint what, bool on);
 161 extern bool si_deviceremoved(si_t *sih);
 162 extern u32 si_socram_size(si_t *sih);
 163
 164 extern void si_watchdog(si_t *sih, uint ticks);
 165 extern u32 si_gpiocontrol(si_t *sih, u32 mask, u32 val,
 166                              u8 priority);
 167
 168 #ifdef BCMSDIO
 169 extern void si_sdio_init(si_t *sih);
 170 #endif
 171
 172 #define si_eci(sih) 0
 173 #define si_eci_init(sih) (0)
 174 #define si_eci_notify_bt(sih, type, val)  (0)
 175 #define si_seci(sih) 0
 176 static inline void *si_seci_init(si_t *sih, u8 use_seci)
 177 {
 178         return NULL;
 179 }
 180
 181 /* OTP status */
 182 extern bool si_is_otp_disabled(si_t *sih);
 183 extern bool si_is_otp_powered(si_t *sih);
 184 extern void si_otp_power(si_t *sih, bool on);
 185
 186 /* SPROM availability */
 187 extern bool si_is_sprom_available(si_t *sih);
 188 #ifdef SI_SPROM_PROBE
 189 extern void si_sprom_init(si_t *sih);
 190 #endif                          /* SI_SPROM_PROBE */
 191
 192 #define SI_ERROR(args)
 193
 194 #ifdef BCMDBG
 195 #define SI_MSG(args)    printf args
 196 #else
 197 #define SI_MSG(args)
 198 #endif                          /* BCMDBG */
 199
 200 /* Define SI_VMSG to printf for verbose debugging, but don't check it in */
 201 #define SI_VMSG(args)
 202
 203 #define IS_SIM(chippkg) ((chippkg == HDLSIM_PKG_ID) || (chippkg == HWSIM_PKG_ID))
 204
 205 typedef u32(*si_intrsoff_t) (void *intr_arg);
 206 typedef void (*si_intrsrestore_t) (void *intr_arg, u32 arg);
 207 typedef bool(*si_intrsenabled_t) (void *intr_arg);
 208
 209 typedef struct gpioh_item {
 210         void *arg;
 211         bool level;
 212         gpio_handler_t handler;
 213         u32 event;
 214         struct gpioh_item *next;
 215 } gpioh_item_t;
 216
 217 /* misc si info needed by some of the routines */
 218 typedef struct si_info {
 219         struct si_pub pub;      /* back plane public state (must be first field) */
 220         struct osl_info *osh;           /* osl os handle */
 221         void *sdh;              /* bcmsdh handle */
 222         uint dev_coreid;        /* the core provides driver functions */
 223         void *intr_arg;         /* interrupt callback function arg */
 224         si_intrsoff_t intrsoff_fn;      /* turns chip interrupts off */
 225         si_intrsrestore_t intrsrestore_fn;      /* restore chip interrupts */
 226         si_intrsenabled_t intrsenabled_fn;      /* check if interrupts are enabled */
 227
 228         void *pch;              /* PCI/E core handle */
 229
 230         gpioh_item_t *gpioh_head;       /* GPIO event handlers list */
 231
 232         bool memseg;            /* flag to toggle MEM_SEG register */
 233
 234         char *vars;
 235         uint varsz;
 236
 237         void *curmap;           /* current regs va */
 238         void *regs[SI_MAXCORES];        /* other regs va */
 239
 240         uint curidx;            /* current core index */
 241         uint numcores;          /* # discovered cores */
 242         uint coreid[SI_MAXCORES];       /* id of each core */
 243         u32 coresba[SI_MAXCORES];       /* backplane address of each core */
 244         void *regs2[SI_MAXCORES];       /* va of each core second register set (usbh20) */
 245         u32 coresba2[SI_MAXCORES];      /* address of each core second register set (usbh20) */
 246         u32 coresba_size[SI_MAXCORES];  /* backplane address space size */
 247         u32 coresba2_size[SI_MAXCORES]; /* second address space size */
 248
 249         void *curwrap;          /* current wrapper va */
 250         void *wrappers[SI_MAXCORES];    /* other cores wrapper va */
 251         u32 wrapba[SI_MAXCORES];        /* address of controlling wrapper */
 252
 253         u32 cia[SI_MAXCORES];   /* erom cia entry for each core */
 254         u32 cib[SI_MAXCORES];   /* erom cia entry for each core */
 255         u32 oob_router; /* oob router registers for axi */
 256 } si_info_t;
 257
 258 #define SI_INFO(sih)    (si_info_t *)sih
 259
 260 #define GOODCOREADDR(x, b) (((x) >= (b)) && ((x) < ((b) + SI_MAXCORES * SI_CORE_SIZE)) && \
 261                 IS_ALIGNED((x), SI_CORE_SIZE))
 262 #define GOODREGS(regs)  ((regs) != NULL && IS_ALIGNED((unsigned long)(regs), SI_CORE_SIZE))
 263 #define BADCOREADDR     0
 264 #define GOODIDX(idx)    (((uint)idx) < SI_MAXCORES)
 265 #define NOREV           -1      /* Invalid rev */
 266
 267 /* Newer chips can access PCI/PCIE and CC core without requiring to change
 268  * PCI BAR0 WIN
 269  */
 270 #define SI_FAST(si) (((si)->pub.buscoretype == PCIE_CORE_ID) || \
 271                      (((si)->pub.buscoretype == PCI_CORE_ID) && (si)->pub.buscorerev >= 13))
 272
 273 #define PCIEREGS(si) (((char *)((si)->curmap) + PCI_16KB0_PCIREGS_OFFSET))
 274 #define CCREGS_FAST(si) (((char *)((si)->curmap) + PCI_16KB0_CCREGS_OFFSET))
 275
 276 /*
 277  * Macros to disable/restore function core(D11, ENET, ILINE20, etc) interrupts
 278  * before after core switching to avoid invalid register accesss inside ISR.
 279  */
 280 #define INTR_OFF(si, intr_val) \
 281         if ((si)->intrsoff_fn && (si)->coreid[(si)->curidx] == (si)->dev_coreid) {      \
 282                 intr_val = (*(si)->intrsoff_fn)((si)->intr_arg); }
 283 #define INTR_RESTORE(si, intr_val) \
 284         if ((si)->intrsrestore_fn && (si)->coreid[(si)->curidx] == (si)->dev_coreid) {  \
 285                 (*(si)->intrsrestore_fn)((si)->intr_arg, intr_val); }
 286
 287 /* dynamic clock control defines */
 288 #define LPOMINFREQ              25000   /* low power oscillator min */
 289 #define LPOMAXFREQ              43000   /* low power oscillator max */
 290 #define XTALMINFREQ             19800000        /* 20 MHz - 1% */
 291 #define XTALMAXFREQ             20200000        /* 20 MHz + 1% */
 292 #define PCIMINFREQ              25000000        /* 25 MHz */
 293 #define PCIMAXFREQ              34000000        /* 33 MHz + fudge */
 294
 295 #define ILP_DIV_5MHZ            0       /* ILP = 5 MHz */
 296 #define ILP_DIV_1MHZ            4       /* ILP = 1 MHz */
 297
 298 #define PCI(si)         (((si)->pub.bustype == PCI_BUS) &&      \
 299                          ((si)->pub.buscoretype == PCI_CORE_ID))
 300 #define PCIE(si)        (((si)->pub.bustype == PCI_BUS) &&      \
 301                          ((si)->pub.buscoretype == PCIE_CORE_ID))
 302 #define PCI_FORCEHT(si) \
 303         (PCIE(si) && (si->pub.chip == BCM4716_CHIP_ID))
 304
 305 /* GPIO Based LED powersave defines */
 306 #define DEFAULT_GPIO_ONTIME     10      /* Default: 10% on */
 307 #define DEFAULT_GPIO_OFFTIME    90      /* Default: 10% on */
 308
 309 #ifndef DEFAULT_GPIOTIMERVAL
 310 #define DEFAULT_GPIOTIMERVAL  ((DEFAULT_GPIO_ONTIME << GPIO_ONTIME_SHIFT) | DEFAULT_GPIO_OFFTIME)
 311 #endif
 312
 313 /*
 314  * Build device path. Path size must be >= SI_DEVPATH_BUFSZ.
 315  * The returned path is NULL terminated and has trailing '/'.
 316  * Return 0 on success, nonzero otherwise.
 317  */
 318 extern int si_devpath(si_t *sih, char *path, int size);
 319 /* Read variable with prepending the devpath to the name */
 320 extern char *si_getdevpathvar(si_t *sih, const char *name);
 321 extern int si_getdevpathintvar(si_t *sih, const char *name);
 322
 323 extern void si_war42780_clkreq(si_t *sih, bool clkreq);
 324 extern void si_pci_sleep(si_t *sih);
 325 extern void si_pci_down(si_t *sih);
 326 extern void si_pci_up(si_t *sih);
 327 extern void si_pcie_extendL1timer(si_t *sih, bool extend);
 328 extern int si_pci_fixcfg(si_t *sih);
 329
 330 extern void si_chipcontrl_epa4331(si_t *sih, bool on);
 331 /* Enable Ex-PA for 4313 */
 332 extern void si_epa_4313war(si_t *sih);
 333
 334 char *si_getnvramflvar(si_t *sih, const char *name);
 335
 336 /* AMBA Interconnect exported externs */
 337 extern si_t *ai_attach(uint pcidev, struct osl_info *osh, void *regs,
 338                        uint bustype, void *sdh, char **vars, uint *varsz);
 339 extern si_t *ai_kattach(struct osl_info *osh);
 340 extern void ai_scan(si_t *sih, void *regs, uint devid);
 341
 342 extern uint ai_flag(si_t *sih);
 343 extern void ai_setint(si_t *sih, int siflag);
 344 extern uint ai_coreidx(si_t *sih);
 345 extern uint ai_corevendor(si_t *sih);
 346 extern uint ai_corerev(si_t *sih);
 347 extern bool ai_iscoreup(si_t *sih);
 348 extern void *ai_setcoreidx(si_t *sih, uint coreidx);
 349 extern u32 ai_core_cflags(si_t *sih, u32 mask, u32 val);
 350 extern void ai_core_cflags_wo(si_t *sih, u32 mask, u32 val);
 351 extern u32 ai_core_sflags(si_t *sih, u32 mask, u32 val);
 352 extern uint ai_corereg(si_t *sih, uint coreidx, uint regoff, uint mask,
 353                        uint val);
 354 extern void ai_core_reset(si_t *sih, u32 bits, u32 resetbits);
 355 extern void ai_core_disable(si_t *sih, u32 bits);
 356 extern int ai_numaddrspaces(si_t *sih);
 357 extern u32 ai_addrspace(si_t *sih, uint asidx);
 358 extern u32 ai_addrspacesize(si_t *sih, uint asidx);
 359 extern void ai_write_wrap_reg(si_t *sih, u32 offset, u32 val);
 360
 361 #ifdef BCMSDIO
 362 #define si_setcoreidx(sih, idx) sb_setcoreidx(sih, idx)
 363 #define si_coreid(sih) sb_coreid(sih)
 364 #define si_corerev(sih) sb_corerev(sih)
 365 #endif
 366
 367 #endif                          /* _siutils_h_ */