1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
|
/*+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
@file: sdio_hcd_defs.h
@abstract: host controller driver definitions
@notice: Copyright (c), 2005-2006 Atheros Communications, Inc.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation;
*
* Software distributed under the License is distributed on an "AS
* IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
* implied. See the License for the specific language governing
* rights and limitations under the License.
*
* Portions of this code were developed with information supplied from the
* SD Card Association Simplified Specifications. The following conditions and disclaimers may apply:
*
* The following conditions apply to the release of the SD simplified specification (�Simplified
* Specification�) by the SD Card Association. The Simplified Specification is a subset of the complete
* SD Specification which is owned by the SD Card Association. This Simplified Specification is provided
* on a non-confidential basis subject to the disclaimers below. Any implementation of the Simplified
* Specification may require a license from the SD Card Association or other third parties.
* Disclaimers:
* The information contained in the Simplified Specification is presented only as a standard
* specification for SD Cards and SD Host/Ancillary products and is provided "AS-IS" without any
* representations or warranties of any kind. No responsibility is assumed by the SD Card Association for
* any damages, any infringements of patents or other right of the SD Card Association or any third
* parties, which may result from its use. No license is granted by implication, estoppel or otherwise
* under any patent or other rights of the SD Card Association or any third party. Nothing herein shall
* be construed as an obligation by the SD Card Association to disclose or distribute any technical
* information, know-how or other confidential information to any third party.
*
*
* The initial developers of the original code are Seung Yi and Paul Lever
*
* sdio@atheros.com
*
*
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++*/
#ifndef __SDIO_HCD_DEFS_H___
#define __SDIO_HCD_DEFS_H___
/* write protect switch position data */
typedef UINT8 SDCONFIG_WP_VALUE;
/* HC commands */
#define SDCONFIG_SEND_INIT_CLOCKS (SDCONFIG_FLAGS_HC_CONFIG | SDCONFIG_FLAGS_DATA_PUT | 1)
#define SDCONFIG_SDIO_INT_CTRL (SDCONFIG_FLAGS_HC_CONFIG | SDCONFIG_FLAGS_DATA_PUT | 2)
#define SDCONFIG_SDIO_REARM_INT (SDCONFIG_FLAGS_HC_CONFIG | SDCONFIG_FLAGS_DATA_NONE | 3)
#define SDCONFIG_BUS_MODE_CTRL (SDCONFIG_FLAGS_HC_CONFIG | SDCONFIG_FLAGS_DATA_BOTH | 4)
#define SDCONFIG_POWER_CTRL (SDCONFIG_FLAGS_HC_CONFIG | SDCONFIG_FLAGS_DATA_PUT | 5)
#define SDCONFIG_GET_WP (SDCONFIG_FLAGS_HC_CONFIG | SDCONFIG_FLAGS_DATA_GET | 6)
/* slot init clocks control */
typedef struct _SDCONFIG_INIT_CLOCKS_DATA {
UINT16 NumberOfClocks; /* number of clocks to issue in the current bus mode*/
}SDCONFIG_INIT_CLOCKS_DATA, *PSDCONFIG_INIT_CLOCKS_DATA;
/* slot power control */
typedef struct _SDCONFIG_POWER_CTRL_DATA {
BOOL SlotPowerEnable; /* turn on/off slot power */
SLOT_VOLTAGE_MASK SlotPowerVoltageMask; /* slot power voltage mask */
}SDCONFIG_POWER_CTRL_DATA, *PSDCONFIG_POWER_CTRL_DATA;
typedef UINT8 SDIO_IRQ_MODE_FLAGS;
/* SDIO Interrupt control */
typedef struct _SDCONFIG_SDIO_INT_CTRL_DATA {
BOOL SlotIRQEnable; /* turn on/off Slot IRQ detection */
SDIO_IRQ_MODE_FLAGS IRQDetectMode; /* slot IRQ detect mode , only valid if Enabled = TRUE */
#define IRQ_DETECT_RAW 0x00
#define IRQ_DETECT_MULTI_BLK 0x01
#define IRQ_DETECT_4_BIT 0x02
#define IRQ_DETECT_1_BIT 0x04
#define IRQ_DETECT_SPI 0x08
}SDCONFIG_SDIO_INT_CTRL_DATA, *PSDCONFIG_SDIO_INT_CTRL_DATA;
/* card insert */
#define EVENT_HCD_ATTACH 1
/* card remove */
#define EVENT_HCD_DETACH 2
/* card slot interrupt */
#define EVENT_HCD_SDIO_IRQ_PENDING 3
/* transfer done */
#define EVENT_HCD_TRANSFER_DONE 4
/* (internal use only) */
#define EVENT_HCD_CD_POLLING 5
/* NOP */
#define EVENT_HCD_NOP 0
/* attrib_flags */
#define SDHCD_ATTRIB_SUPPORTS_POWER 0x0001 /* host controller driver supports power managment */
#define SDHCD_ATTRIB_BUS_1BIT 0x0002 /* SD Native 1 - bit mode */
#define SDHCD_ATTRIB_BUS_4BIT 0x0004 /* SD Native 4 - bit mode */
#define SDHCD_ATTRIB_BUS_SPI 0x0008 /* SPI mode capable */
#define SDHCD_ATTRIB_READ_WAIT 0x0010 /* read wait supported (SD-only) */
#define SDHCD_ATTRIB_MULTI_BLK_IRQ 0x0020 /* interrupts between multi-block capable (SD-only) */
#define SDHCD_ATTRIB_BUS_MMC8BIT 0x0040 /* MMC 8-bit */
#define SDHCD_ATTRIB_SLOT_POLLING 0x0080 /* requires slot polling for Card Detect */
#define SDHCD_ATTRIB_POWER_SWITCH 0x0100 /* host has power switch control, must be set if SPI
mode can be switched to 1 or 4 bit mode */
#define SDHCD_ATTRIB_NO_SPI_CRC 0x0200 /* when in SPI mode,
host wants to run without SPI CRC */
#define SDHCD_ATTRIB_AUTO_CMD12 0x0400 /* host controller supports auto CMD12 */
#define SDHCD_ATTRIB_NO_4BIT_IRQ 0x0800 /* host controller does not support 4 bit IRQ mode*/
#define SDHCD_ATTRIB_RAW_MODE 0x1000 /* host controller is a raw mode hcd*/
#define SDHCD_ATTRIB_SD_HIGH_SPEED 0x2000 /* host controller supports SD high speed interface */
#define SDHCD_ATTRIB_MMC_HIGH_SPEED 0x4000 /* host controller supports MMC high speed interface */
#define IS_CARD_PRESENT(pHcd) ((pHcd)->CardProperties.Flags & CARD_TYPE_MASK)
#define SET_CURRENT_REQUEST(pHcd,Req) (pHcd)->pCurrentRequest = (Req)
#define IS_HCD_RAW(pHcd) ((pHcd)->Attributes & SDHCD_ATTRIB_RAW_MODE)
/*+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
@function: Get a pointer to the current bus request for a host controller
@function name: GET_CURRENT_REQUEST
@prototype: PSDREQUEST GET_CURRENT_REQUEST (PSDHCD pHcd)
@category: HD_Reference
@input: pHcd - host structure
@return: current SD/SDIO bus request being worked on
@notes: Implemented as a macro. This macro returns the current SD request that is
being worked on.
@example: getting the current request:
pReq = GET_CURRENT_REQUEST(&pHct->Hcd);
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++*/
#define GET_CURRENT_REQUEST(pHcd) (pHcd)->pCurrentRequest
#define GET_CURRENT_BUS_WIDTH(pHcd) SDCONFIG_GET_BUSWIDTH((pHcd)->CardProperties.BusMode)
/*+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
@function: Get host controller's current operational bus clock
@function name: SDHCD_GET_OPER_CLOCK
@prototype: SD_BUSCLOCK_RATE SDHCD_GET_OPER_CLOCK(PSDHCD pHcd)
@category: HD_Reference
@input: pHcd - the registered host structure
@output: none
@return: clock rate
@notes: Implemented as a macro. Returns the current bus clock rate.
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++*/
#define SDHCD_GET_OPER_CLOCK(pHcd) (pHcd)->CardProperties.OperBusClock
/*+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
@function: Is host controller operating in SPI mode
@function name: IS_HCD_BUS_MODE_SPI
@prototype: BOOL IS_HCD_BUS_MODE_SPI (PSDHCD pHcd)
@category: HD_Reference
@input: pHcd - host structure
@return: TRUE if in SPI mode
@notes: Implemented as a macro. Host controllers that operate in SPI mode
dynamically can use this macro to check for SPI operation.
@example: testing for SPI mode:
if (IS_HCD_BUS_MODE_SPI(&pHct->Hcd)) {
.. in spi mode
}
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++*/
#define IS_HCD_BUS_MODE_SPI(pHcd) (GET_CURRENT_BUS_WIDTH(pHcd) == SDCONFIG_BUS_WIDTH_SPI)
/*+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
@function: Is host controller using SPI in non-CRC mode
@function name: IS_HCD_BUS_MODE_SPI_NO_CRC
@prototype: BOOL IS_HCD_BUS_MODE_SPI_NO_CRC(PSDHCD pHcd)
@category: HD_Reference
@input: pHcd - host structure
@return: TRUE if CRC mode is off
@notes: Implemented as a macro. SPI-capable cards and systems can operate in
non-CRC protected mode. In this mode the host controller should ignore
CRC fields and/or disable CRC generation when issuing command or data
packets. This option is useful for software based SPI mode where CRC
should be turned off in order to reduce processing overhead.
@example: test for non-CRC SPI mode:
if (IS_HCD_BUS_MODE_SPI_NO_CRC(&pHct->Hcd)) {
.. disable CRC checking in hardware.
}
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++*/
#define IS_HCD_BUS_MODE_SPI_NO_CRC(pHcd) ((pHcd)->CardProperties.BusMode & \
SDCONFIG_BUS_MODE_SPI_NO_CRC)
typedef UINT8 SDHCD_RESPONSE_CHECK_MODE;
/* have SDIO core check the response token and see if it is okay to continue with
* the data portion */
#define SDHCD_CHECK_DATA_TRANS_OK 0x01
/* have SDIO core check the SPI token received */
#define SDHCD_CHECK_SPI_TOKEN 0x02
/* prototypes */
/* for HCD use */
SDIO_STATUS SDIO_RegisterHostController(PSDHCD pHcd);
SDIO_STATUS SDIO_UnregisterHostController(PSDHCD pHcd);
SDIO_STATUS SDIO_HandleHcdEvent(PSDHCD pHcd, HCD_EVENT Event);
SDIO_STATUS SDIO_CheckResponse(PSDHCD pHcd, PSDREQUEST pReq, SDHCD_RESPONSE_CHECK_MODE CheckMode);
SDIO_STATUS SDIO_BusAddOSDevice(PSDDMA_DESCRIPTION pDma, POS_PNPDRIVER pDriver, POS_PNPDEVICE *pDevice, const char* name);
void SDIO_BusRemoveOSDevice(POS_PNPDRIVER pDriver, POS_PNPDEVICE pDevice);
#endif /* __SDIO_BUSDRIVER_H___ */
|
