2010-09-09 04:04:42 +00:00
|
|
|
/*
|
|
|
|
* Copyright (c) 2010 Broadcom Corporation
|
|
|
|
*
|
|
|
|
* Permission to use, copy, modify, and/or distribute this software for any
|
|
|
|
* purpose with or without fee is hereby granted, provided that the above
|
|
|
|
* copyright notice and this permission notice appear in all copies.
|
|
|
|
*
|
|
|
|
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
|
|
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
|
|
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
|
|
|
|
* SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
|
|
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
|
|
|
|
* OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
|
|
|
|
* CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef _bcmsdh_h_
|
|
|
|
#define _bcmsdh_h_
|
|
|
|
|
2011-01-21 09:54:48 +00:00
|
|
|
#include <linux/skbuff.h>
|
2010-09-09 04:04:42 +00:00
|
|
|
#define BCMSDH_ERROR_VAL 0x0001 /* Error */
|
|
|
|
#define BCMSDH_INFO_VAL 0x0002 /* Info */
|
|
|
|
extern const uint bcmsdh_msglevel;
|
|
|
|
|
|
|
|
#ifdef BCMDBG
|
2011-02-10 11:03:44 +00:00
|
|
|
#define BCMSDH_ERROR(x) \
|
|
|
|
do { \
|
|
|
|
if ((bcmsdh_msglevel & BCMSDH_ERROR_VAL) && net_ratelimit()) \
|
|
|
|
printk x; \
|
|
|
|
} while (0)
|
|
|
|
#define BCMSDH_INFO(x) \
|
|
|
|
do { \
|
|
|
|
if ((bcmsdh_msglevel & BCMSDH_INFO_VAL) && net_ratelimit()) \
|
|
|
|
printk x; \
|
|
|
|
} while (0)
|
2010-09-09 04:04:42 +00:00
|
|
|
#else /* BCMDBG */
|
|
|
|
#define BCMSDH_ERROR(x)
|
|
|
|
#define BCMSDH_INFO(x)
|
|
|
|
#endif /* BCMDBG */
|
|
|
|
|
2011-06-01 11:45:40 +00:00
|
|
|
#define SDIO_FUNC_0 0
|
|
|
|
#define SDIO_FUNC_1 1
|
|
|
|
#define SDIO_FUNC_2 2
|
|
|
|
|
|
|
|
#define SDIOD_FBR_SIZE 0x100
|
|
|
|
|
|
|
|
/* io_en */
|
|
|
|
#define SDIO_FUNC_ENABLE_1 0x02
|
|
|
|
#define SDIO_FUNC_ENABLE_2 0x04
|
|
|
|
|
|
|
|
/* io_rdys */
|
|
|
|
#define SDIO_FUNC_READY_1 0x02
|
|
|
|
#define SDIO_FUNC_READY_2 0x04
|
|
|
|
|
|
|
|
/* intr_status */
|
|
|
|
#define INTR_STATUS_FUNC1 0x2
|
|
|
|
#define INTR_STATUS_FUNC2 0x4
|
|
|
|
|
|
|
|
/* Maximum number of I/O funcs */
|
|
|
|
#define SDIOD_MAX_IOFUNCS 7
|
|
|
|
|
2010-09-09 04:04:42 +00:00
|
|
|
/* forward declarations */
|
|
|
|
typedef struct bcmsdh_info bcmsdh_info_t;
|
|
|
|
typedef void (*bcmsdh_cb_fn_t) (void *);
|
|
|
|
|
|
|
|
/* Attach and build an interface to the underlying SD host driver.
|
|
|
|
* - Allocates resources (structs, arrays, mem, OS handles, etc) needed by bcmsdh.
|
|
|
|
* - Returns the bcmsdh handle and virtual address base for register access.
|
|
|
|
* The returned handle should be used in all subsequent calls, but the bcmsh
|
|
|
|
* implementation may maintain a single "default" handle (e.g. the first or
|
|
|
|
* most recent one) to enable single-instance implementations to pass NULL.
|
|
|
|
*/
|
2011-03-02 20:18:48 +00:00
|
|
|
extern bcmsdh_info_t *bcmsdh_attach(void *cfghdl, void **regsva, uint irq);
|
2010-09-09 04:04:42 +00:00
|
|
|
|
|
|
|
/* Detach - freeup resources allocated in attach */
|
2011-03-02 20:18:42 +00:00
|
|
|
extern int bcmsdh_detach(void *sdh);
|
2010-09-09 04:04:42 +00:00
|
|
|
|
|
|
|
/* Query if SD device interrupts are enabled */
|
|
|
|
extern bool bcmsdh_intr_query(void *sdh);
|
|
|
|
|
|
|
|
/* Enable/disable SD interrupt */
|
|
|
|
extern int bcmsdh_intr_enable(void *sdh);
|
|
|
|
extern int bcmsdh_intr_disable(void *sdh);
|
|
|
|
|
|
|
|
/* Register/deregister device interrupt handler. */
|
|
|
|
extern int bcmsdh_intr_reg(void *sdh, bcmsdh_cb_fn_t fn, void *argh);
|
|
|
|
extern int bcmsdh_intr_dereg(void *sdh);
|
|
|
|
|
2011-02-09 20:21:39 +00:00
|
|
|
#if defined(DHD_DEBUG)
|
2010-09-09 04:04:42 +00:00
|
|
|
/* Query pending interrupt status from the host controller */
|
|
|
|
extern bool bcmsdh_intr_pending(void *sdh);
|
|
|
|
#endif
|
|
|
|
extern int bcmsdh_claim_host_and_lock(void *sdh);
|
|
|
|
extern int bcmsdh_release_host_and_unlock(void *sdh);
|
|
|
|
|
|
|
|
/* Register a callback to be called if and when bcmsdh detects
|
|
|
|
* device removal. No-op in the case of non-removable/hardwired devices.
|
|
|
|
*/
|
|
|
|
extern int bcmsdh_devremove_reg(void *sdh, bcmsdh_cb_fn_t fn, void *argh);
|
|
|
|
|
|
|
|
/* Access SDIO address space (e.g. CCCR) using CMD52 (single-byte interface).
|
|
|
|
* fn: function number
|
|
|
|
* addr: unmodified SDIO-space address
|
|
|
|
* data: data byte to write
|
|
|
|
* err: pointer to error code (or NULL)
|
|
|
|
*/
|
2010-10-08 18:05:47 +00:00
|
|
|
extern u8 bcmsdh_cfg_read(void *sdh, uint func, u32 addr, int *err);
|
|
|
|
extern void bcmsdh_cfg_write(void *sdh, uint func, u32 addr, u8 data,
|
2010-09-09 04:04:42 +00:00
|
|
|
int *err);
|
|
|
|
|
|
|
|
/* Read/Write 4bytes from/to cfg space */
|
2010-10-08 18:05:47 +00:00
|
|
|
extern u32 bcmsdh_cfg_read_word(void *sdh, uint fnc_num, u32 addr,
|
2010-09-09 04:04:42 +00:00
|
|
|
int *err);
|
2010-10-08 18:05:47 +00:00
|
|
|
extern void bcmsdh_cfg_write_word(void *sdh, uint fnc_num, u32 addr,
|
|
|
|
u32 data, int *err);
|
2010-09-09 04:04:42 +00:00
|
|
|
|
|
|
|
/* Read CIS content for specified function.
|
|
|
|
* fn: function whose CIS is being requested (0 is common CIS)
|
|
|
|
* cis: pointer to memory location to place results
|
|
|
|
* length: number of bytes to read
|
|
|
|
* Internally, this routine uses the values from the cis base regs (0x9-0xB)
|
|
|
|
* to form an SDIO-space address to read the data from.
|
|
|
|
*/
|
2010-10-05 17:23:40 +00:00
|
|
|
extern int bcmsdh_cis_read(void *sdh, uint func, u8 *cis, uint length);
|
2010-09-09 04:04:42 +00:00
|
|
|
|
|
|
|
/* Synchronous access to device (client) core registers via CMD53 to F1.
|
|
|
|
* addr: backplane address (i.e. >= regsva from attach)
|
|
|
|
* size: register width in bytes (2 or 4)
|
|
|
|
* data: data for register write
|
|
|
|
*/
|
2010-10-08 18:05:47 +00:00
|
|
|
extern u32 bcmsdh_reg_read(void *sdh, u32 addr, uint size);
|
|
|
|
extern u32 bcmsdh_reg_write(void *sdh, u32 addr, uint size, u32 data);
|
2010-09-09 04:04:42 +00:00
|
|
|
|
|
|
|
/* Indicate if last reg read/write failed */
|
|
|
|
extern bool bcmsdh_regfail(void *sdh);
|
|
|
|
|
|
|
|
/* Buffer transfer to/from device (client) core via cmd53.
|
|
|
|
* fn: function number
|
|
|
|
* addr: backplane address (i.e. >= regsva from attach)
|
|
|
|
* flags: backplane width, address increment, sync/async
|
|
|
|
* buf: pointer to memory data buffer
|
|
|
|
* nbytes: number of bytes to transfer to/from buf
|
|
|
|
* pkt: pointer to packet associated with buf (if any)
|
|
|
|
* complete: callback function for command completion (async only)
|
|
|
|
* handle: handle for completion callback (first arg in callback)
|
|
|
|
* Returns 0 or error code.
|
|
|
|
* NOTE: Async operation is not currently supported.
|
|
|
|
*/
|
|
|
|
typedef void (*bcmsdh_cmplt_fn_t) (void *handle, int status, bool sync_waiting);
|
2010-10-08 18:05:47 +00:00
|
|
|
extern int bcmsdh_send_buf(void *sdh, u32 addr, uint fn, uint flags,
|
2010-10-05 17:23:40 +00:00
|
|
|
u8 *buf, uint nbytes, void *pkt,
|
2010-09-09 04:04:42 +00:00
|
|
|
bcmsdh_cmplt_fn_t complete, void *handle);
|
2010-10-08 18:05:47 +00:00
|
|
|
extern int bcmsdh_recv_buf(void *sdh, u32 addr, uint fn, uint flags,
|
2010-11-23 13:06:23 +00:00
|
|
|
u8 *buf, uint nbytes, struct sk_buff *pkt,
|
2010-09-09 04:04:42 +00:00
|
|
|
bcmsdh_cmplt_fn_t complete, void *handle);
|
|
|
|
|
|
|
|
/* Flags bits */
|
|
|
|
#define SDIO_REQ_4BYTE 0x1 /* Four-byte target (backplane) width (vs. two-byte) */
|
|
|
|
#define SDIO_REQ_FIXED 0x2 /* Fixed address (FIFO) (vs. incrementing address) */
|
|
|
|
#define SDIO_REQ_ASYNC 0x4 /* Async request (vs. sync request) */
|
|
|
|
|
|
|
|
/* Pending (non-error) return code */
|
|
|
|
#define BCME_PENDING 1
|
|
|
|
|
|
|
|
/* Read/write to memory block (F1, no FIFO) via CMD53 (sync only).
|
|
|
|
* rw: read or write (0/1)
|
|
|
|
* addr: direct SDIO address
|
|
|
|
* buf: pointer to memory data buffer
|
|
|
|
* nbytes: number of bytes to transfer to/from buf
|
|
|
|
* Returns 0 or error code.
|
|
|
|
*/
|
2010-10-08 18:05:47 +00:00
|
|
|
extern int bcmsdh_rwdata(void *sdh, uint rw, u32 addr, u8 *buf,
|
2010-09-09 04:04:42 +00:00
|
|
|
uint nbytes);
|
|
|
|
|
|
|
|
/* Issue an abort to the specified function */
|
|
|
|
extern int bcmsdh_abort(void *sdh, uint fn);
|
|
|
|
|
|
|
|
/* Start SDIO Host Controller communication */
|
|
|
|
extern int bcmsdh_start(void *sdh, int stage);
|
|
|
|
|
|
|
|
/* Stop SDIO Host Controller communication */
|
|
|
|
extern int bcmsdh_stop(void *sdh);
|
|
|
|
|
|
|
|
/* Returns the "Device ID" of target device on the SDIO bus. */
|
|
|
|
extern int bcmsdh_query_device(void *sdh);
|
|
|
|
|
|
|
|
/* Returns the number of IO functions reported by the device */
|
|
|
|
extern uint bcmsdh_query_iofnum(void *sdh);
|
|
|
|
|
|
|
|
/* Miscellaneous knob tweaker. */
|
|
|
|
extern int bcmsdh_iovar_op(void *sdh, const char *name,
|
|
|
|
void *params, int plen, void *arg, int len,
|
|
|
|
bool set);
|
|
|
|
|
|
|
|
/* Reset and reinitialize the device */
|
2010-09-14 13:45:30 +00:00
|
|
|
extern int bcmsdh_reset(bcmsdh_info_t *sdh);
|
2010-09-09 04:04:42 +00:00
|
|
|
|
|
|
|
/* helper functions */
|
|
|
|
|
2010-09-14 13:45:30 +00:00
|
|
|
extern void *bcmsdh_get_sdioh(bcmsdh_info_t *sdh);
|
2010-09-09 04:04:42 +00:00
|
|
|
|
|
|
|
/* callback functions */
|
|
|
|
typedef struct {
|
|
|
|
/* attach to device */
|
2010-10-08 00:04:47 +00:00
|
|
|
void *(*attach) (u16 vend_id, u16 dev_id, u16 bus, u16 slot,
|
2011-03-02 20:18:48 +00:00
|
|
|
u16 func, uint bustype, void *regsva, void *param);
|
2010-09-09 04:04:42 +00:00
|
|
|
/* detach from device */
|
|
|
|
void (*detach) (void *ch);
|
|
|
|
} bcmsdh_driver_t;
|
|
|
|
|
|
|
|
/* platform specific/high level functions */
|
2010-09-14 13:45:30 +00:00
|
|
|
extern int bcmsdh_register(bcmsdh_driver_t *driver);
|
2010-09-09 04:04:42 +00:00
|
|
|
extern void bcmsdh_unregister(void);
|
2010-10-08 00:04:47 +00:00
|
|
|
extern bool bcmsdh_chipmatch(u16 vendor, u16 device);
|
2010-09-09 04:04:42 +00:00
|
|
|
extern void bcmsdh_device_remove(void *sdh);
|
|
|
|
|
|
|
|
/* Function to pass device-status bits to DHD. */
|
2010-10-08 18:05:47 +00:00
|
|
|
extern u32 bcmsdh_get_dstatus(void *sdh);
|
2010-09-09 04:04:42 +00:00
|
|
|
|
|
|
|
/* Function to return current window addr */
|
2010-10-08 18:05:47 +00:00
|
|
|
extern u32 bcmsdh_cur_sbwad(void *sdh);
|
2010-09-09 04:04:42 +00:00
|
|
|
|
|
|
|
/* Function to pass chipid and rev to lower layers for controlling pr's */
|
2010-10-08 18:05:47 +00:00
|
|
|
extern void bcmsdh_chipinfo(void *sdh, u32 chip, u32 chiprev);
|
2010-09-09 04:04:42 +00:00
|
|
|
|
|
|
|
#endif /* _bcmsdh_h_ */
|