[deliverable/linux.git] / drivers / staging / brcm80211 / include / bcmsdh.h

/*
 * 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_

#include <linux/skbuff.h>
#define BCMSDH_ERROR_VAL	0x0001	/* Error */
#define BCMSDH_INFO_VAL		0x0002	/* Info */
extern const uint bcmsdh_msglevel;

#ifdef BCMDBG
#define BCMSDH_ERROR(x)	do { if ((bcmsdh_msglevel & BCMSDH_ERROR_VAL) && net_ratelimit()) printf x; } while (0)
#define BCMSDH_INFO(x)	do { if ((bcmsdh_msglevel & BCMSDH_INFO_VAL) && net_ratelimit()) printf x; } while (0)
#else				/* BCMDBG */
#define BCMSDH_ERROR(x)
#define BCMSDH_INFO(x)
#endif				/* BCMDBG */

/* 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.
 */
extern bcmsdh_info_t *bcmsdh_attach(struct osl_info *osh, void *cfghdl,
				    void **regsva, uint irq);

/* Detach - freeup resources allocated in attach */
extern int bcmsdh_detach(struct osl_info *osh, void *sdh);

/* 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);

#if defined(BCMDBG)
/* 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)
 */
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,
			     int *err);

/* Read/Write 4bytes from/to cfg space */
extern u32 bcmsdh_cfg_read_word(void *sdh, uint fnc_num, u32 addr,
				   int *err);
extern void bcmsdh_cfg_write_word(void *sdh, uint fnc_num, u32 addr,
				  u32 data, int *err);

/* 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.
 */
extern int bcmsdh_cis_read(void *sdh, uint func, u8 *cis, uint length);

/* 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
 */
extern u32 bcmsdh_reg_read(void *sdh, u32 addr, uint size);
extern u32 bcmsdh_reg_write(void *sdh, u32 addr, uint size, u32 data);

/* 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);
extern int bcmsdh_send_buf(void *sdh, u32 addr, uint fn, uint flags,
			   u8 *buf, uint nbytes, void *pkt,
			   bcmsdh_cmplt_fn_t complete, void *handle);
extern int bcmsdh_recv_buf(void *sdh, u32 addr, uint fn, uint flags,
			   u8 *buf, uint nbytes, struct sk_buff *pkt,
			   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.
 */
extern int bcmsdh_rwdata(void *sdh, uint rw, u32 addr, u8 *buf,
			 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 */
extern int bcmsdh_reset(bcmsdh_info_t *sdh);

/* helper functions */

extern void *bcmsdh_get_sdioh(bcmsdh_info_t *sdh);

/* callback functions */
typedef struct {
	/* attach to device */
	void *(*attach) (u16 vend_id, u16 dev_id, u16 bus, u16 slot,
			 u16 func, uint bustype, void *regsva,
			 struct osl_info *osh, void *param);
	/* detach from device */
	void (*detach) (void *ch);
} bcmsdh_driver_t;

/* platform specific/high level functions */
extern int bcmsdh_register(bcmsdh_driver_t *driver);
extern void bcmsdh_unregister(void);
extern bool bcmsdh_chipmatch(u16 vendor, u16 device);
extern void bcmsdh_device_remove(void *sdh);

/* Function to pass device-status bits to DHD. */
extern u32 bcmsdh_get_dstatus(void *sdh);

/* Function to return current window addr */
extern u32 bcmsdh_cur_sbwad(void *sdh);

/* Function to pass chipid and rev to lower layers for controlling pr's */
extern void bcmsdh_chipinfo(void *sdh, u32 chip, u32 chiprev);

#endif				/* _bcmsdh_h_ */
Commit	Line	Data
a9533e7e HP	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 _bcmsdh_h_
	18	#define _bcmsdh_h_
	19
f8559b69	20	#include <linux/skbuff.h>
a9533e7e HP	21	#define BCMSDH_ERROR_VAL 0x0001 /* Error */
	22	#define BCMSDH_INFO_VAL 0x0002 /* Info */
	23	extern const uint bcmsdh_msglevel;
	24
	25	#ifdef BCMDBG
	26	#define BCMSDH_ERROR(x) do { if ((bcmsdh_msglevel & BCMSDH_ERROR_VAL) && net_ratelimit()) printf x; } while (0)
	27	#define BCMSDH_INFO(x) do { if ((bcmsdh_msglevel & BCMSDH_INFO_VAL) && net_ratelimit()) printf x; } while (0)
	28	#else /* BCMDBG */
	29	#define BCMSDH_ERROR(x)
	30	#define BCMSDH_INFO(x)
	31	#endif /* BCMDBG */
	32
	33	/* forward declarations */
	34	typedef struct bcmsdh_info bcmsdh_info_t;
	35	typedef void (bcmsdh_cb_fn_t) (void );
	36
	37	/* Attach and build an interface to the underlying SD host driver.
	38	* - Allocates resources (structs, arrays, mem, OS handles, etc) needed by bcmsdh.
	39	* - Returns the bcmsdh handle and virtual address base for register access.
	40	* The returned handle should be used in all subsequent calls, but the bcmsh
	41	* implementation may maintain a single "default" handle (e.g. the first or
	42	* most recent one) to enable single-instance implementations to pass NULL.
	43	*/
e69284f2 BR	44	extern bcmsdh_info_t bcmsdh_attach(struct osl_info osh, void *cfghdl,
e69284f2 BR	45	void **regsva, uint irq);
a9533e7e HP	46
a9533e7e HP	47	/* Detach - freeup resources allocated in attach */
e69284f2	48	extern int bcmsdh_detach(struct osl_info osh, void sdh);
a9533e7e HP	49
	50	/* Query if SD device interrupts are enabled */
	51	extern bool bcmsdh_intr_query(void *sdh);
	52
	53	/* Enable/disable SD interrupt */
	54	extern int bcmsdh_intr_enable(void *sdh);
	55	extern int bcmsdh_intr_disable(void *sdh);
	56
	57	/* Register/deregister device interrupt handler. */
	58	extern int bcmsdh_intr_reg(void sdh, bcmsdh_cb_fn_t fn, void argh);
	59	extern int bcmsdh_intr_dereg(void *sdh);
	60
	61	#if defined(BCMDBG)
	62	/* Query pending interrupt status from the host controller */
	63	extern bool bcmsdh_intr_pending(void *sdh);
	64	#endif
	65	extern int bcmsdh_claim_host_and_lock(void *sdh);
	66	extern int bcmsdh_release_host_and_unlock(void *sdh);
	67
	68	/* Register a callback to be called if and when bcmsdh detects
	69	* device removal. No-op in the case of non-removable/hardwired devices.
	70	*/
	71	extern int bcmsdh_devremove_reg(void sdh, bcmsdh_cb_fn_t fn, void argh);
	72
	73	/* Access SDIO address space (e.g. CCCR) using CMD52 (single-byte interface).
	74	* fn: function number
	75	* addr: unmodified SDIO-space address
	76	* data: data byte to write
	77	* err: pointer to error code (or NULL)
	78	*/
66cbd3ab GKH	79	extern u8 bcmsdh_cfg_read(void sdh, uint func, u32 addr, int err);
66cbd3ab GKH	80	extern void bcmsdh_cfg_write(void *sdh, uint func, u32 addr, u8 data,
a9533e7e HP	81	int *err);
	82
	83	/* Read/Write 4bytes from/to cfg space */
66cbd3ab	84	extern u32 bcmsdh_cfg_read_word(void *sdh, uint fnc_num, u32 addr,
a9533e7e	85	int *err);
66cbd3ab GKH	86	extern void bcmsdh_cfg_write_word(void *sdh, uint fnc_num, u32 addr,
66cbd3ab GKH	87	u32 data, int *err);
a9533e7e HP	88
	89	/* Read CIS content for specified function.
	90	* fn: function whose CIS is being requested (0 is common CIS)
	91	* cis: pointer to memory location to place results
	92	* length: number of bytes to read
	93	* Internally, this routine uses the values from the cis base regs (0x9-0xB)
	94	* to form an SDIO-space address to read the data from.
	95	*/
de9bca63	96	extern int bcmsdh_cis_read(void sdh, uint func, u8 cis, uint length);
a9533e7e HP	97
	98	/* Synchronous access to device (client) core registers via CMD53 to F1.
	99	* addr: backplane address (i.e. >= regsva from attach)
	100	* size: register width in bytes (2 or 4)
	101	* data: data for register write
	102	*/
66cbd3ab GKH	103	extern u32 bcmsdh_reg_read(void *sdh, u32 addr, uint size);
66cbd3ab GKH	104	extern u32 bcmsdh_reg_write(void *sdh, u32 addr, uint size, u32 data);
a9533e7e HP	105
	106	/* Indicate if last reg read/write failed */
	107	extern bool bcmsdh_regfail(void *sdh);
	108
	109	/* Buffer transfer to/from device (client) core via cmd53.
	110	* fn: function number
	111	* addr: backplane address (i.e. >= regsva from attach)
	112	* flags: backplane width, address increment, sync/async
	113	* buf: pointer to memory data buffer
	114	* nbytes: number of bytes to transfer to/from buf
	115	* pkt: pointer to packet associated with buf (if any)
	116	* complete: callback function for command completion (async only)
	117	* handle: handle for completion callback (first arg in callback)
	118	* Returns 0 or error code.
	119	* NOTE: Async operation is not currently supported.
	120	*/
	121	typedef void (bcmsdh_cmplt_fn_t) (void handle, int status, bool sync_waiting);
66cbd3ab	122	extern int bcmsdh_send_buf(void *sdh, u32 addr, uint fn, uint flags,
de9bca63	123	u8 buf, uint nbytes, void pkt,
a9533e7e	124	bcmsdh_cmplt_fn_t complete, void *handle);
66cbd3ab	125	extern int bcmsdh_recv_buf(void *sdh, u32 addr, uint fn, uint flags,
c26b1378	126	u8 buf, uint nbytes, struct sk_buff pkt,
a9533e7e HP	127	bcmsdh_cmplt_fn_t complete, void *handle);
	128
	129	/* Flags bits */
	130	#define SDIO_REQ_4BYTE 0x1 /* Four-byte target (backplane) width (vs. two-byte) */
	131	#define SDIO_REQ_FIXED 0x2 /* Fixed address (FIFO) (vs. incrementing address) */
	132	#define SDIO_REQ_ASYNC 0x4 /* Async request (vs. sync request) */
	133
	134	/* Pending (non-error) return code */
	135	#define BCME_PENDING 1
	136
	137	/* Read/write to memory block (F1, no FIFO) via CMD53 (sync only).
	138	* rw: read or write (0/1)
	139	* addr: direct SDIO address
	140	* buf: pointer to memory data buffer
	141	* nbytes: number of bytes to transfer to/from buf
	142	* Returns 0 or error code.
	143	*/
66cbd3ab	144	extern int bcmsdh_rwdata(void sdh, uint rw, u32 addr, u8 buf,
a9533e7e HP	145	uint nbytes);
	146
	147	/* Issue an abort to the specified function */
	148	extern int bcmsdh_abort(void *sdh, uint fn);
	149
	150	/* Start SDIO Host Controller communication */
	151	extern int bcmsdh_start(void *sdh, int stage);
	152
	153	/* Stop SDIO Host Controller communication */
	154	extern int bcmsdh_stop(void *sdh);
	155
	156	/* Returns the "Device ID" of target device on the SDIO bus. */
	157	extern int bcmsdh_query_device(void *sdh);
	158
	159	/* Returns the number of IO functions reported by the device */
	160	extern uint bcmsdh_query_iofnum(void *sdh);
	161
	162	/* Miscellaneous knob tweaker. */
	163	extern int bcmsdh_iovar_op(void sdh, const char name,
	164	void params, int plen, void arg, int len,
	165	bool set);
	166
	167	/* Reset and reinitialize the device */
7cc4a4c0	168	extern int bcmsdh_reset(bcmsdh_info_t *sdh);
a9533e7e HP	169
	170	/* helper functions */
	171
7cc4a4c0	172	extern void bcmsdh_get_sdioh(bcmsdh_info_t sdh);
a9533e7e HP	173
	174	/* callback functions */
	175	typedef struct {
	176	/* attach to device */
7d4df48e	177	void (attach) (u16 vend_id, u16 dev_id, u16 bus, u16 slot,
e69284f2 BR	178	u16 func, uint bustype, void *regsva,
e69284f2 BR	179	struct osl_info osh, void param);
a9533e7e HP	180	/* detach from device */
	181	void (detach) (void ch);
	182	} bcmsdh_driver_t;
	183
	184	/* platform specific/high level functions */
7cc4a4c0	185	extern int bcmsdh_register(bcmsdh_driver_t *driver);
a9533e7e	186	extern void bcmsdh_unregister(void);
7d4df48e	187	extern bool bcmsdh_chipmatch(u16 vendor, u16 device);
a9533e7e HP	188	extern void bcmsdh_device_remove(void *sdh);
	189
	190	/* Function to pass device-status bits to DHD. */
66cbd3ab	191	extern u32 bcmsdh_get_dstatus(void *sdh);
a9533e7e HP	192
a9533e7e HP	193	/* Function to return current window addr */
66cbd3ab	194	extern u32 bcmsdh_cur_sbwad(void *sdh);
a9533e7e HP	195
a9533e7e HP	196	/* Function to pass chipid and rev to lower layers for controlling pr's */
66cbd3ab	197	extern void bcmsdh_chipinfo(void *sdh, u32 chip, u32 chiprev);
a9533e7e HP	198
a9533e7e HP	199	#endif /* _bcmsdh_h_ */