bcmsdspi.h revision 8ce1727333a1c411bb88330d69f82386a118c6bf 
1/*
2 * SD-SPI Protocol Conversion - BCMSDH->SPI Translation Layer
3 *
4 * Copyright (C) 1999-2011, Broadcom Corporation
5 *
6 *         Unless you and Broadcom execute a separate written software license
7 * agreement governing use of this software, this software is licensed to you
8 * under the terms of the GNU General Public License version 2 (the "GPL"),
9 * available at http://www.broadcom.com/licenses/GPLv2.php, with the
10 * following added to such license:
11 *
12 *      As a special exception, the copyright holders of this software give you
13 * permission to link this software with independent modules, and to copy and
14 * distribute the resulting executable under terms of your choice, provided that
15 * you also meet, for each linked independent module, the terms and conditions of
16 * the license of that module.  An independent module is a module which is not
17 * derived from this software.  The special exception does not apply to any
18 * modifications of the software.
19 *
20 *      Notwithstanding the above, under no circumstances may you combine this
21 * software in any way with any other Broadcom software provided under a license
22 * other than the GPL, without Broadcom's express prior written consent.
23 *
24 * $Id: bcmsdspi.h 277737 2011-08-16 17:54:59Z $
25 */
26#ifndef	_BCM_SD_SPI_H
27#define	_BCM_SD_SPI_H
28
29/* global msglevel for debug messages - bitvals come from sdiovar.h */
30
31#define sd_err(x)
32#define sd_trace(x)
33#define sd_info(x)
34#define sd_debug(x)
35#define sd_data(x)
36#define sd_ctrl(x)
37
38#define sd_log(x)
39
40#define SDIOH_ASSERT(exp) \
41	do { if (!(exp)) \
42		printf("!!!ASSERT fail: file %s lines %d", __FILE__, __LINE__); \
43	} while (0)
44
45#define BLOCK_SIZE_4318 64
46#define BLOCK_SIZE_4328 512
47
48/* internal return code */
49#define SUCCESS	0
50#undef ERROR
51#define ERROR	1
52
53/* private bus modes */
54#define SDIOH_MODE_SPI		0
55
56#define USE_BLOCKMODE		0x2	/* Block mode can be single block or multi */
57#define USE_MULTIBLOCK		0x4
58
59struct sdioh_info {
60	uint cfg_bar;                   	/* pci cfg address for bar */
61	uint32 caps;                    	/* cached value of capabilities reg */
62	uint		bar0;			/* BAR0 for PCI Device */
63	osl_t 		*osh;			/* osh handler */
64	void		*controller;	/* Pointer to SPI Controller's private data struct */
65
66	uint		lockcount; 		/* nest count of sdspi_lock() calls */
67	bool		client_intr_enabled;	/* interrupt connnected flag */
68	bool		intr_handler_valid;	/* client driver interrupt handler valid */
69	sdioh_cb_fn_t	intr_handler;		/* registered interrupt handler */
70	void		*intr_handler_arg;	/* argument to call interrupt handler */
71	bool		initialized;		/* card initialized */
72	uint32		target_dev;		/* Target device ID */
73	uint32		intmask;		/* Current active interrupts */
74	void		*sdos_info;		/* Pointer to per-OS private data */
75
76	uint32		controller_type;	/* Host controller type */
77	uint8		version;		/* Host Controller Spec Compliance Version */
78	uint 		irq;			/* Client irq */
79	uint32 		intrcount;		/* Client interrupts */
80	uint32 		local_intrcount;	/* Controller interrupts */
81	bool 		host_init_done;		/* Controller initted */
82	bool 		card_init_done;		/* Client SDIO interface initted */
83	bool 		polled_mode;		/* polling for command completion */
84
85	bool		sd_use_dma;		/* DMA on CMD53 */
86	bool 		sd_blockmode;		/* sd_blockmode == FALSE => 64 Byte Cmd 53s. */
87						/*  Must be on for sd_multiblock to be effective */
88	bool 		use_client_ints;	/* If this is false, make sure to restore */
89	bool		got_hcint;		/* Host Controller interrupt. */
90						/*  polling hack in wl_linux.c:wl_timer() */
91	int 		adapter_slot;		/* Maybe dealing with multiple slots/controllers */
92	int 		sd_mode;		/* SD1/SD4/SPI */
93	int 		client_block_size[SDIOD_MAX_IOFUNCS];		/* Blocksize */
94	uint32 		data_xfer_count;	/* Current register transfer size */
95	uint32		cmd53_wr_data;		/* Used to pass CMD53 write data */
96	uint32		card_response;		/* Used to pass back response status byte */
97	uint32		card_rsp_data;		/* Used to pass back response data word */
98	uint16 		card_rca;		/* Current Address */
99	uint8 		num_funcs;		/* Supported funcs on client */
100	uint32 		com_cis_ptr;
101	uint32 		func_cis_ptr[SDIOD_MAX_IOFUNCS];
102	void		*dma_buf;
103	ulong		dma_phys;
104	int 		r_cnt;			/* rx count */
105	int 		t_cnt;			/* tx_count */
106};
107
108/************************************************************
109 * Internal interfaces: per-port references into bcmsdspi.c
110 */
111
112/* Global message bits */
113extern uint sd_msglevel;
114
115/**************************************************************
116 * Internal interfaces: bcmsdspi.c references to per-port code
117 */
118
119/* Register mapping routines */
120extern uint32 *spi_reg_map(osl_t *osh, uintptr addr, int size);
121extern void spi_reg_unmap(osl_t *osh, uintptr addr, int size);
122
123/* Interrupt (de)registration routines */
124extern int spi_register_irq(sdioh_info_t *sd, uint irq);
125extern void spi_free_irq(uint irq, sdioh_info_t *sd);
126
127/* OS-specific interrupt wrappers (atomic interrupt enable/disable) */
128extern void spi_lock(sdioh_info_t *sd);
129extern void spi_unlock(sdioh_info_t *sd);
130
131/* Allocate/init/free per-OS private data */
132extern int spi_osinit(sdioh_info_t *sd);
133extern void spi_osfree(sdioh_info_t *sd);
134
135#endif /* _BCM_SD_SPI_H */
136