drivers/net/wireless/rkwifi/bcmdhd/include/siutils.h

   1 /*
   2  * Misc utility routines for accessing the SOC Interconnects
   3  * of Broadcom HNBU chips.
   4  *
   5  * $Copyright Open Broadcom Corporation$
   6  *
   7  * $Id: siutils.h 385510 2013-02-15 21:02:07Z $
   8  */
   9
  10 #ifndef _siutils_h_
  11 #define _siutils_h_
  12
  13
  14 struct si_pub {
  15         uint    socitype;
  16
  17         uint    bustype;
  18         uint    buscoretype;
  19         uint    buscorerev;
  20         uint    buscoreidx;
  21         int     ccrev;
  22         uint32  cccaps;
  23         uint32  cccaps_ext;
  24         int     pmurev;
  25         uint32  pmucaps;
  26         uint    boardtype;
  27         uint    boardrev;
  28         uint    boardvendor;
  29         uint    boardflags;
  30         uint    boardflags2;
  31         uint    chip;
  32         uint    chiprev;
  33         uint    chippkg;
  34         uint32  chipst;
  35         bool    issim;
  36         uint    socirev;
  37         bool    pci_pr32414;
  38
  39 };
  40
  41
  42 typedef const struct si_pub si_t;
  43
  44
  45
  46 #define SI_OSH          NULL
  47
  48 #define BADIDX          (SI_MAXCORES + 1)
  49
  50
  51 #define XTAL                    0x1
  52 #define PLL                     0x2
  53
  54
  55 #define CLK_FAST                0
  56 #define CLK_DYNAMIC             2
  57
  58
  59 #define GPIO_DRV_PRIORITY       0
  60 #define GPIO_APP_PRIORITY       1
  61 #define GPIO_HI_PRIORITY        2
  62
  63
  64 #define GPIO_PULLUP             0
  65 #define GPIO_PULLDN             1
  66
  67
  68 #define GPIO_REGEVT             0
  69 #define GPIO_REGEVT_INTMSK      1
  70 #define GPIO_REGEVT_INTPOL      2
  71
  72
  73 #define SI_DEVPATH_BUFSZ        16
  74
  75
  76 #define SI_DOATTACH     1
  77 #define SI_PCIDOWN      2
  78 #define SI_PCIUP        3
  79
  80 #define ISSIM_ENAB(sih) 0
  81
  82
  83 #if defined(BCMPMUCTL)
  84 #define PMUCTL_ENAB(sih)        (BCMPMUCTL)
  85 #else
  86 #define PMUCTL_ENAB(sih)        ((sih)->cccaps & CC_CAP_PMU)
  87 #endif
  88
  89
  90 #if defined(BCMPMUCTL) && BCMPMUCTL
  91 #define CCCTL_ENAB(sih)         (0)
  92 #define CCPLL_ENAB(sih)         (0)
  93 #else
  94 #define CCCTL_ENAB(sih)         ((sih)->cccaps & CC_CAP_PWR_CTL)
  95 #define CCPLL_ENAB(sih)         ((sih)->cccaps & CC_CAP_PLL_MASK)
  96 #endif
  97
  98 typedef void (*gpio_handler_t)(uint32 stat, void *arg);
  99
 100 #define CC_BTCOEX_EN_MASK  0x01
 101
 102 #define GPIO_CTRL_EPA_EN_MASK 0x40
 103
 104 #define GPIO_CTRL_5_6_EN_MASK 0x60
 105 #define GPIO_CTRL_7_6_EN_MASK 0xC0
 106 #define GPIO_OUT_7_EN_MASK 0x80
 107
 108
 109
 110 #define SI_CR4_CAP                      (0x04)
 111 #define SI_CR4_BANKIDX          (0x40)
 112 #define SI_CR4_BANKINFO         (0x44)
 113
 114 #define ARMCR4_TCBBNB_MASK      0xf0
 115 #define ARMCR4_TCBBNB_SHIFT     4
 116 #define ARMCR4_TCBANB_MASK      0xf
 117 #define ARMCR4_TCBANB_SHIFT     0
 118
 119 #define SICF_CPUHALT            (0x0020)
 120 #define ARMCR4_BSZ_MASK         0x3f
 121 #define ARMCR4_BSZ_MULT         8192
 122
 123
 124
 125 extern si_t *si_attach(uint pcidev, osl_t *osh, void *regs, uint bustype,
 126                        void *sdh, char **vars, uint *varsz);
 127 extern si_t *si_kattach(osl_t *osh);
 128 extern void si_detach(si_t *sih);
 129 extern bool si_pci_war16165(si_t *sih);
 130
 131 extern uint si_corelist(si_t *sih, uint coreid[]);
 132 extern uint si_coreid(si_t *sih);
 133 extern uint si_flag(si_t *sih);
 134 extern uint si_flag_alt(si_t *sih);
 135 extern uint si_intflag(si_t *sih);
 136 extern uint si_coreidx(si_t *sih);
 137 extern uint si_coreunit(si_t *sih);
 138 extern uint si_corevendor(si_t *sih);
 139 extern uint si_corerev(si_t *sih);
 140 extern void *si_osh(si_t *sih);
 141 extern void si_setosh(si_t *sih, osl_t *osh);
 142 extern uint si_corereg(si_t *sih, uint coreidx, uint regoff, uint mask, uint val);
 143 extern void *si_coreregs(si_t *sih);
 144 extern uint si_wrapperreg(si_t *sih, uint32 offset, uint32 mask, uint32 val);
 145 extern uint si_core_wrapperreg(si_t *sih, uint32 coreidx, uint32 offset, uint32 mask, uint32 val);
 146 extern void *si_wrapperregs(si_t *sih);
 147 extern uint32 si_core_cflags(si_t *sih, uint32 mask, uint32 val);
 148 extern void si_core_cflags_wo(si_t *sih, uint32 mask, uint32 val);
 149 extern uint32 si_core_sflags(si_t *sih, uint32 mask, uint32 val);
 150 extern bool si_iscoreup(si_t *sih);
 151 extern uint si_findcoreidx(si_t *sih, uint coreid, uint coreunit);
 152 extern void *si_setcoreidx(si_t *sih, uint coreidx);
 153 extern void *si_setcore(si_t *sih, uint coreid, uint coreunit);
 154 extern void *si_switch_core(si_t *sih, uint coreid, uint *origidx, uint *intr_val);
 155 extern void si_restore_core(si_t *sih, uint coreid, uint intr_val);
 156 extern int si_numaddrspaces(si_t *sih);
 157 extern uint32 si_addrspace(si_t *sih, uint asidx);
 158 extern uint32 si_addrspacesize(si_t *sih, uint asidx);
 159 extern void si_coreaddrspaceX(si_t *sih, uint asidx, uint32 *addr, uint32 *size);
 160 extern int si_corebist(si_t *sih);
 161 extern void si_core_reset(si_t *sih, uint32 bits, uint32 resetbits);
 162 extern void si_core_disable(si_t *sih, uint32 bits);
 163 extern uint32 si_clock_rate(uint32 pll_type, uint32 n, uint32 m);
 164 extern uint si_chip_hostif(si_t *sih);
 165 extern bool si_read_pmu_autopll(si_t *sih);
 166 extern uint32 si_clock(si_t *sih);
 167 extern uint32 si_alp_clock(si_t *sih);
 168 extern uint32 si_ilp_clock(si_t *sih);
 169 extern void si_pci_setup(si_t *sih, uint coremask);
 170 extern void si_pcmcia_init(si_t *sih);
 171 extern void si_setint(si_t *sih, int siflag);
 172 extern bool si_backplane64(si_t *sih);
 173 extern void si_register_intr_callback(si_t *sih, void *intrsoff_fn, void *intrsrestore_fn,
 174         void *intrsenabled_fn, void *intr_arg);
 175 extern void si_deregister_intr_callback(si_t *sih);
 176 extern void si_clkctl_init(si_t *sih);
 177 extern uint16 si_clkctl_fast_pwrup_delay(si_t *sih);
 178 extern bool si_clkctl_cc(si_t *sih, uint mode);
 179 extern int si_clkctl_xtal(si_t *sih, uint what, bool on);
 180 extern uint32 si_gpiotimerval(si_t *sih, uint32 mask, uint32 val);
 181 extern void si_btcgpiowar(si_t *sih);
 182 extern bool si_deviceremoved(si_t *sih);
 183 extern uint32 si_socram_size(si_t *sih);
 184 extern uint32 si_socdevram_size(si_t *sih);
 185 extern uint32 si_socram_srmem_size(si_t *sih);
 186 extern void si_socdevram(si_t *sih, bool set, uint8 *ennable, uint8 *protect, uint8 *remap);
 187 extern bool si_socdevram_pkg(si_t *sih);
 188 extern bool si_socdevram_remap_isenb(si_t *sih);
 189 extern uint32 si_socdevram_remap_size(si_t *sih);
 190
 191 extern void si_watchdog(si_t *sih, uint ticks);
 192 extern void si_watchdog_ms(si_t *sih, uint32 ms);
 193 extern uint32 si_watchdog_msticks(void);
 194 extern void *si_gpiosetcore(si_t *sih);
 195 extern uint32 si_gpiocontrol(si_t *sih, uint32 mask, uint32 val, uint8 priority);
 196 extern uint32 si_gpioouten(si_t *sih, uint32 mask, uint32 val, uint8 priority);
 197 extern uint32 si_gpioout(si_t *sih, uint32 mask, uint32 val, uint8 priority);
 198 extern uint32 si_gpioin(si_t *sih);
 199 extern uint32 si_gpiointpolarity(si_t *sih, uint32 mask, uint32 val, uint8 priority);
 200 extern uint32 si_gpiointmask(si_t *sih, uint32 mask, uint32 val, uint8 priority);
 201 extern uint32 si_gpioled(si_t *sih, uint32 mask, uint32 val);
 202 extern uint32 si_gpioreserve(si_t *sih, uint32 gpio_num, uint8 priority);
 203 extern uint32 si_gpiorelease(si_t *sih, uint32 gpio_num, uint8 priority);
 204 extern uint32 si_gpiopull(si_t *sih, bool updown, uint32 mask, uint32 val);
 205 extern uint32 si_gpioevent(si_t *sih, uint regtype, uint32 mask, uint32 val);
 206 extern uint32 si_gpio_int_enable(si_t *sih, bool enable);
 207
 208
 209 extern void *si_gpio_handler_register(si_t *sih, uint32 e, bool lev, gpio_handler_t cb, void *arg);
 210 extern void si_gpio_handler_unregister(si_t *sih, void* gpioh);
 211 extern void si_gpio_handler_process(si_t *sih);
 212
 213
 214 extern bool si_pci_pmecap(si_t *sih);
 215 struct osl_info;
 216 extern bool si_pci_fastpmecap(struct osl_info *osh);
 217 extern bool si_pci_pmestat(si_t *sih);
 218 extern void si_pci_pmeclr(si_t *sih);
 219 extern void si_pci_pmeen(si_t *sih);
 220 extern void si_pci_pmestatclr(si_t *sih);
 221 extern uint si_pcie_readreg(void *sih, uint addrtype, uint offset);
 222
 223 extern void si_sdio_init(si_t *sih);
 224
 225 extern uint16 si_d11_devid(si_t *sih);
 226 extern int si_corepciid(si_t *sih, uint func, uint16 *pcivendor, uint16 *pcidevice,
 227         uint8 *pciclass, uint8 *pcisubclass, uint8 *pciprogif, uint8 *pciheader);
 228
 229 #define si_eci(sih) 0
 230 static INLINE void * si_eci_init(si_t *sih) {return NULL;}
 231 #define si_eci_notify_bt(sih, type, val)  (0)
 232 #define si_seci(sih) 0
 233 #define si_seci_upd(sih, a)     do {} while (0)
 234 static INLINE void * si_seci_init(si_t *sih, uint8 use_seci) {return NULL;}
 235 #define si_seci_down(sih) do {} while (0)
 236 #define si_gci(sih) 0
 237 static INLINE void * si_gci_init(si_t *sih) {return NULL;}
 238
 239
 240 extern bool si_is_otp_disabled(si_t *sih);
 241 extern bool si_is_otp_powered(si_t *sih);
 242 extern void si_otp_power(si_t *sih, bool on);
 243
 244
 245 extern bool si_is_sprom_available(si_t *sih);
 246 extern bool si_is_sprom_enabled(si_t *sih);
 247 extern void si_sprom_enable(si_t *sih, bool enable);
 248
 249
 250 extern int si_cis_source(si_t *sih);
 251 #define CIS_DEFAULT     0
 252 #define CIS_SROM        1
 253 #define CIS_OTP         2
 254
 255
 256 #define DEFAULT_FAB     0x0
 257 #define CSM_FAB7        0x1
 258 #define TSMC_FAB12      0x2
 259 #define SMIC_FAB4       0x3
 260 extern int si_otp_fabid(si_t *sih, uint16 *fabid, bool rw);
 261 extern uint16 si_fabid(si_t *sih);
 262
 263
 264 extern int si_devpath(si_t *sih, char *path, int size);
 265
 266 extern char *si_getdevpathvar(si_t *sih, const char *name);
 267 extern int si_getdevpathintvar(si_t *sih, const char *name);
 268 extern char *si_coded_devpathvar(si_t *sih, char *varname, int var_len, const char *name);
 269
 270
 271 extern uint8 si_pcieclkreq(si_t *sih, uint32 mask, uint32 val);
 272 extern uint32 si_pcielcreg(si_t *sih, uint32 mask, uint32 val);
 273 extern uint8 si_pcieltrenable(si_t *sih, uint32 mask, uint32 val);
 274 extern void si_pcie_set_error_injection(si_t *sih, uint32 mode);
 275 extern void si_war42780_clkreq(si_t *sih, bool clkreq);
 276 extern void si_pci_down(si_t *sih);
 277 extern void si_pci_up(si_t *sih);
 278 extern void si_pci_sleep(si_t *sih);
 279 extern void si_pcie_war_ovr_update(si_t *sih, uint8 aspm);
 280 extern void si_pcie_power_save_enable(si_t *sih, bool enable);
 281 extern void si_pcie_extendL1timer(si_t *sih, bool extend);
 282 extern int si_pci_fixcfg(si_t *sih);
 283 extern void si_chippkg_set(si_t *sih, uint);
 284
 285 extern void si_chipcontrl_btshd0_4331(si_t *sih, bool on);
 286 extern void si_chipcontrl_restore(si_t *sih, uint32 val);
 287 extern uint32 si_chipcontrl_read(si_t *sih);
 288 extern void si_chipcontrl_epa4331(si_t *sih, bool on);
 289 extern void si_chipcontrl_epa4331_wowl(si_t *sih, bool enter_wowl);
 290 extern void si_chipcontrl_srom4360(si_t *sih, bool on);
 291
 292 extern void si_epa_4313war(si_t *sih);
 293 extern void si_btc_enable_chipcontrol(si_t *sih);
 294
 295 extern void si_btcombo_p250_4313_war(si_t *sih);
 296 extern void si_btcombo_43228_war(si_t *sih);
 297 extern void si_clk_pmu_htavail_set(si_t *sih, bool set_clear);
 298 extern void si_pmu_synth_pwrsw_4313_war(si_t *sih);
 299 extern uint si_pll_reset(si_t *sih);
 300
 301
 302 extern bool si_taclear(si_t *sih, bool details);
 303
 304
 305
 306 extern uint32 si_ccreg(si_t *sih, uint32 offset, uint32 mask, uint32 val);
 307 extern uint32 si_pciereg(si_t *sih, uint32 offset, uint32 mask, uint32 val, uint type);
 308 extern uint32 si_pcieserdesreg(si_t *sih, uint32 mdioslave, uint32 offset, uint32 mask, uint32 val);
 309 extern void si_pcie_set_request_size(si_t *sih, uint16 size);
 310 extern uint16 si_pcie_get_request_size(si_t *sih);
 311 extern void si_pcie_set_maxpayload_size(si_t *sih, uint16 size);
 312 extern uint16 si_pcie_get_maxpayload_size(si_t *sih);
 313 extern uint16 si_pcie_get_ssid(si_t *sih);
 314 extern uint32 si_pcie_get_bar0(si_t *sih);
 315 extern int si_pcie_configspace_cache(si_t *sih);
 316 extern int si_pcie_configspace_restore(si_t *sih);
 317 extern int si_pcie_configspace_get(si_t *sih, uint8 *buf, uint size);
 318
 319 char *si_getnvramflvar(si_t *sih, const char *name);
 320
 321
 322 extern uint32 si_tcm_size(si_t *sih);
 323
 324 extern int si_set_sromctl(si_t *sih, uint32 value);
 325 extern uint32 si_get_sromctl(si_t *sih);
 326
 327 extern uint32 si_gci_direct(si_t *sih, uint offset, uint32 mask, uint32 val);
 328 extern void si_gci_reset(si_t *sih);
 329 extern void si_gci_set_functionsel(si_t *sih, uint32 pin, uint8 fnsel);
 330 extern uint8 si_gci_get_chipctrlreg_idx(uint32 pin, uint32 *regidx, uint32 *pos);
 331 extern uint32 si_gci_chipcontrol(si_t *sih, uint reg, uint32 mask, uint32 val);
 332
 333 #define CHIPCTRLREG2 0x2
 334 #define CHIPCTRLREG3 0x3
 335 #define CHIPCTRLREG4 0x4
 336 #define MINRESMASKREG 0x618
 337 #define CHIPCTRLADDR 0x650
 338 #define CHIPCTRLDATA 0x654
 339 #define RSRCTABLEADDR 0x620
 340 #define RSRCUPDWNTIME 0x628
 341 #define PMUREG_RESREQ_MASK 0x68c
 342
 343 void
 344 si_update_masks(si_t *sih);
 345
 346 void
 347 si_force_islanding(si_t *sih, bool enable);
 348
 349 #endif