drivers/net/wireless/brcm80211/brcmfmac/sdio_host.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 _BRCM_SDH_H_
  18 #define _BRCM_SDH_H_
  19
  20 #include <linux/skbuff.h>
  21
  22 #define SDIO_FUNC_0             0
  23 #define SDIO_FUNC_1             1
  24 #define SDIO_FUNC_2             2
  25
  26 #define SDIOD_FBR_SIZE          0x100
  27
  28 /* io_en */
  29 #define SDIO_FUNC_ENABLE_1      0x02
  30 #define SDIO_FUNC_ENABLE_2      0x04
  31
  32 /* io_rdys */
  33 #define SDIO_FUNC_READY_1       0x02
  34 #define SDIO_FUNC_READY_2       0x04
  35
  36 /* intr_status */
  37 #define INTR_STATUS_FUNC1       0x2
  38 #define INTR_STATUS_FUNC2       0x4
  39
  40 /* Maximum number of I/O funcs */
  41 #define SDIOD_MAX_IOFUNCS       7
  42
  43 /* mask of register map */
  44 #define REG_F0_CCCR_MASK        0xFF
  45 #define REG_F1_MISC_MASK        0x1FFFF
  46
  47 /* as of sdiod rev 0, supports 3 functions */
  48 #define SBSDIO_NUM_FUNCTION             3
  49
  50 /* function 0 vendor specific CCCR registers */
  51 #define SDIO_CCCR_BRCM_SEPINT           0xf2
  52
  53 #define  SDIO_SEPINT_MASK               0x01
  54 #define  SDIO_SEPINT_OE                 0x02
  55 #define  SDIO_SEPINT_ACT_HI             0x04
  56
  57 /* function 1 miscellaneous registers */
  58
  59 /* sprom command and status */
  60 #define SBSDIO_SPROM_CS                 0x10000
  61 /* sprom info register */
  62 #define SBSDIO_SPROM_INFO               0x10001
  63 /* sprom indirect access data byte 0 */
  64 #define SBSDIO_SPROM_DATA_LOW           0x10002
  65 /* sprom indirect access data byte 1 */
  66 #define SBSDIO_SPROM_DATA_HIGH          0x10003
  67 /* sprom indirect access addr byte 0 */
  68 #define SBSDIO_SPROM_ADDR_LOW           0x10004
  69 /* sprom indirect access addr byte 0 */
  70 #define SBSDIO_SPROM_ADDR_HIGH          0x10005
  71 /* xtal_pu (gpio) output */
  72 #define SBSDIO_CHIP_CTRL_DATA           0x10006
  73 /* xtal_pu (gpio) enable */
  74 #define SBSDIO_CHIP_CTRL_EN             0x10007
  75 /* rev < 7, watermark for sdio device */
  76 #define SBSDIO_WATERMARK                0x10008
  77 /* control busy signal generation */
  78 #define SBSDIO_DEVICE_CTL               0x10009
  79
  80 /* SB Address Window Low (b15) */
  81 #define SBSDIO_FUNC1_SBADDRLOW          0x1000A
  82 /* SB Address Window Mid (b23:b16) */
  83 #define SBSDIO_FUNC1_SBADDRMID          0x1000B
  84 /* SB Address Window High (b31:b24)    */
  85 #define SBSDIO_FUNC1_SBADDRHIGH         0x1000C
  86 /* Frame Control (frame term/abort) */
  87 #define SBSDIO_FUNC1_FRAMECTRL          0x1000D
  88 /* ChipClockCSR (ALP/HT ctl/status) */
  89 #define SBSDIO_FUNC1_CHIPCLKCSR         0x1000E
  90 /* SdioPullUp (on cmd, d0-d2) */
  91 #define SBSDIO_FUNC1_SDIOPULLUP         0x1000F
  92 /* Write Frame Byte Count Low */
  93 #define SBSDIO_FUNC1_WFRAMEBCLO         0x10019
  94 /* Write Frame Byte Count High */
  95 #define SBSDIO_FUNC1_WFRAMEBCHI         0x1001A
  96 /* Read Frame Byte Count Low */
  97 #define SBSDIO_FUNC1_RFRAMEBCLO         0x1001B
  98 /* Read Frame Byte Count High */
  99 #define SBSDIO_FUNC1_RFRAMEBCHI         0x1001C
 100
 101 #define SBSDIO_FUNC1_MISC_REG_START     0x10000 /* f1 misc register start */
 102 #define SBSDIO_FUNC1_MISC_REG_LIMIT     0x1001C /* f1 misc register end */
 103
 104 /* function 1 OCP space */
 105
 106 /* sb offset addr is <= 15 bits, 32k */
 107 #define SBSDIO_SB_OFT_ADDR_MASK         0x07FFF
 108 #define SBSDIO_SB_OFT_ADDR_LIMIT        0x08000
 109 /* with b15, maps to 32-bit SB access */
 110 #define SBSDIO_SB_ACCESS_2_4B_FLAG      0x08000
 111
 112 /* valid bits in SBSDIO_FUNC1_SBADDRxxx regs */
 113
 114 #define SBSDIO_SBADDRLOW_MASK           0x80    /* Valid bits in SBADDRLOW */
 115 #define SBSDIO_SBADDRMID_MASK           0xff    /* Valid bits in SBADDRMID */
 116 #define SBSDIO_SBADDRHIGH_MASK          0xffU   /* Valid bits in SBADDRHIGH */
 117 /* Address bits from SBADDR regs */
 118 #define SBSDIO_SBWINDOW_MASK            0xffff8000
 119
 120 #define SDIOH_READ              0       /* Read request */
 121 #define SDIOH_WRITE             1       /* Write request */
 122
 123 #define SDIOH_DATA_FIX          0       /* Fixed addressing */
 124 #define SDIOH_DATA_INC          1       /* Incremental addressing */
 125
 126 /* internal return code */
 127 #define SUCCESS 0
 128 #define ERROR   1
 129
 130 /* Packet alignment for most efficient SDIO (can change based on platform) */
 131 #define BRCMF_SDALIGN   (1 << 6)
 132
 133 /* watchdog polling interval in ms */
 134 #define BRCMF_WD_POLL_MS        10
 135
 136 struct brcmf_sdreg {
 137         int func;
 138         int offset;
 139         int value;
 140 };
 141
 142 struct brcmf_sdio;
 143
 144 struct brcmf_sdio_dev {
 145         struct sdio_func *func[SDIO_MAX_FUNCS];
 146         u8 num_funcs;                   /* Supported funcs on client */
 147         u32 func_cis_ptr[SDIOD_MAX_IOFUNCS];
 148         u32 sbwad;                      /* Save backplane window address */
 149         bool regfail;                   /* status of last reg_r/w call */
 150         void *bus;
 151         atomic_t suspend;               /* suspend flag */
 152         wait_queue_head_t request_byte_wait;
 153         wait_queue_head_t request_word_wait;
 154         wait_queue_head_t request_chain_wait;
 155         wait_queue_head_t request_buffer_wait;
 156         struct device *dev;
 157         struct brcmf_bus *bus_if;
 158 #ifdef CONFIG_BRCMFMAC_SDIO_OOB
 159         unsigned int irq;               /* oob interrupt number */
 160         unsigned long irq_flags;        /* board specific oob flags */
 161         bool irq_en;                    /* irq enable flags */
 162         spinlock_t irq_en_lock;
 163         bool irq_wake;                  /* irq wake enable flags */
 164 #endif          /* CONFIG_BRCMFMAC_SDIO_OOB */
 165 };
 166
 167 /* Register/deregister interrupt handler. */
 168 extern int brcmf_sdio_intr_register(struct brcmf_sdio_dev *sdiodev);
 169 extern int brcmf_sdio_intr_unregister(struct brcmf_sdio_dev *sdiodev);
 170
 171 /* Access SDIO address space (e.g. CCCR) using CMD52 (single-byte interface).
 172  *   fn:   function number
 173  *   addr: unmodified SDIO-space address
 174  *   data: data byte to write
 175  *   err:  pointer to error code (or NULL)
 176  */
 177 extern u8 brcmf_sdcard_cfg_read(struct brcmf_sdio_dev *sdiodev, uint func,
 178                                 u32 addr, int *err);
 179 extern void brcmf_sdcard_cfg_write(struct brcmf_sdio_dev *sdiodev, uint func,
 180                                    u32 addr, u8 data, int *err);
 181
 182 /* Synchronous access to device (client) core registers via CMD53 to F1.
 183  *   addr: backplane address (i.e. >= regsva from attach)
 184  *   size: register width in bytes (2 or 4)
 185  *   data: data for register write
 186  */
 187 extern u32
 188 brcmf_sdcard_reg_read(struct brcmf_sdio_dev *sdiodev, u32 addr);
 189
 190 extern u32
 191 brcmf_sdcard_reg_write(struct brcmf_sdio_dev *sdiodev, u32 addr, u32 data);
 192
 193 /* sdio device register access interface */
 194 extern u8 brcmf_sdio_regrb(struct brcmf_sdio_dev *sdiodev, u32 addr, int *ret);
 195 extern u32 brcmf_sdio_regrl(struct brcmf_sdio_dev *sdiodev, u32 addr, int *ret);
 196 extern void brcmf_sdio_regwb(struct brcmf_sdio_dev *sdiodev, u32 addr,
 197                              u8 data, int *ret);
 198 extern void brcmf_sdio_regwl(struct brcmf_sdio_dev *sdiodev, u32 addr,
 199                              u32 data, int *ret);
 200
 201 /* Indicate if last reg read/write failed */
 202 extern bool brcmf_sdcard_regfail(struct brcmf_sdio_dev *sdiodev);
 203
 204 /* Buffer transfer to/from device (client) core via cmd53.
 205  *   fn:       function number
 206  *   addr:     backplane address (i.e. >= regsva from attach)
 207  *   flags:    backplane width, address increment, sync/async
 208  *   buf:      pointer to memory data buffer
 209  *   nbytes:   number of bytes to transfer to/from buf
 210  *   pkt:      pointer to packet associated with buf (if any)
 211  *   complete: callback function for command completion (async only)
 212  *   handle:   handle for completion callback (first arg in callback)
 213  * Returns 0 or error code.
 214  * NOTE: Async operation is not currently supported.
 215  */
 216 extern int
 217 brcmf_sdcard_send_pkt(struct brcmf_sdio_dev *sdiodev, u32 addr, uint fn,
 218                       uint flags, struct sk_buff *pkt);
 219 extern int
 220 brcmf_sdcard_send_buf(struct brcmf_sdio_dev *sdiodev, u32 addr, uint fn,
 221                       uint flags, u8 *buf, uint nbytes);
 222
 223 extern int
 224 brcmf_sdcard_recv_pkt(struct brcmf_sdio_dev *sdiodev, u32 addr, uint fn,
 225                       uint flags, struct sk_buff *pkt);
 226 extern int
 227 brcmf_sdcard_recv_buf(struct brcmf_sdio_dev *sdiodev, u32 addr, uint fn,
 228                       uint flags, u8 *buf, uint nbytes);
 229 extern int
 230 brcmf_sdcard_recv_chain(struct brcmf_sdio_dev *sdiodev, u32 addr, uint fn,
 231                         uint flags, struct sk_buff_head *pktq);
 232
 233 /* Flags bits */
 234
 235 /* Four-byte target (backplane) width (vs. two-byte) */
 236 #define SDIO_REQ_4BYTE  0x1
 237 /* Fixed address (FIFO) (vs. incrementing address) */
 238 #define SDIO_REQ_FIXED  0x2
 239 /* Async request (vs. sync request) */
 240 #define SDIO_REQ_ASYNC  0x4
 241
 242 /* Read/write to memory block (F1, no FIFO) via CMD53 (sync only).
 243  *   rw:       read or write (0/1)
 244  *   addr:     direct SDIO address
 245  *   buf:      pointer to memory data buffer
 246  *   nbytes:   number of bytes to transfer to/from buf
 247  * Returns 0 or error code.
 248  */
 249 extern int brcmf_sdcard_rwdata(struct brcmf_sdio_dev *sdiodev, uint rw,
 250                                u32 addr, u8 *buf, uint nbytes);
 251
 252 /* Issue an abort to the specified function */
 253 extern int brcmf_sdcard_abort(struct brcmf_sdio_dev *sdiodev, uint fn);
 254
 255 /* platform specific/high level functions */
 256 extern int brcmf_sdio_probe(struct brcmf_sdio_dev *sdiodev);
 257 extern int brcmf_sdio_remove(struct brcmf_sdio_dev *sdiodev);
 258
 259 extern int brcmf_sdcard_set_sbaddr_window(struct brcmf_sdio_dev *sdiodev,
 260                                           u32 address);
 261
 262 /* attach, return handler on success, NULL if failed.
 263  *  The handler shall be provided by all subsequent calls. No local cache
 264  *  cfghdl points to the starting address of pci device mapped memory
 265  */
 266 extern int brcmf_sdioh_attach(struct brcmf_sdio_dev *sdiodev);
 267 extern void brcmf_sdioh_detach(struct brcmf_sdio_dev *sdiodev);
 268
 269 /* read or write one byte using cmd52 */
 270 extern int brcmf_sdioh_request_byte(struct brcmf_sdio_dev *sdiodev, uint rw,
 271                                     uint fnc, uint addr, u8 *byte);
 272
 273 /* read or write 2/4 bytes using cmd53 */
 274 extern int
 275 brcmf_sdioh_request_word(struct brcmf_sdio_dev *sdiodev,
 276                          uint rw, uint fnc, uint addr,
 277                          u32 *word, uint nbyte);
 278
 279 /* read or write any buffer using cmd53 */
 280 extern int
 281 brcmf_sdioh_request_buffer(struct brcmf_sdio_dev *sdiodev,
 282                            uint fix_inc, uint rw, uint fnc_num, u32 addr,
 283                            struct sk_buff *pkt);
 284 extern int
 285 brcmf_sdioh_request_chain(struct brcmf_sdio_dev *sdiodev, uint fix_inc,
 286                           uint write, uint func, uint addr,
 287                           struct sk_buff_head *pktq);
 288
 289 /* Watchdog timer interface for pm ops */
 290 extern void brcmf_sdio_wdtmr_enable(struct brcmf_sdio_dev *sdiodev,
 291                                     bool enable);
 292
 293 extern void *brcmf_sdbrcm_probe(u32 regsva, struct brcmf_sdio_dev *sdiodev);
 294 extern void brcmf_sdbrcm_disconnect(void *ptr);
 295 extern void brcmf_sdbrcm_isr(void *arg);
 296
 297 extern void brcmf_sdbrcm_wd_timer(struct brcmf_sdio *bus, uint wdtick);
 298 #endif                          /* _BRCM_SDH_H_ */