2 * Copyright (c) 2013-2016 ARM Limited. All rights reserved.
4 * SPDX-License-Identifier: Apache-2.0
6 * Licensed under the Apache License, Version 2.0 (the License); you may
7 * not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
10 * www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an AS IS BASIS, WITHOUT
14 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
21 * Project: MCI (Memory Card Interface) Driver definitions
26 * Added timeout and error flags to ARM_MCI_STATUS
27 * Added support for controlling optional RST_n pin (eMMC)
28 * Removed explicit Clock Control (ARM_MCI_CONTROL_CLOCK)
29 * Removed event ARM_MCI_EVENT_BOOT_ACK_TIMEOUT
31 * Decoupled SPI mode from MCI driver
32 * Replaced function ARM_MCI_CardSwitchRead with ARM_MCI_ReadCD and ARM_MCI_ReadWP
35 * SD UHS-I (Ultra High Speed)
38 * Suspend/Resume (SD I/O)
41 * Stream Data transfer (MMC)
42 * VCCQ Power Supply Control (eMMC)
43 * Command Completion Signal (CCS) for CE-ATA
44 * Added ARM_MCI_Control function
45 * Added ARM_MCI_GetStatus function
46 * Removed ARM_MCI_BusMode, ARM_MCI_BusDataWidth, ARM_MCI_BusSingaling functions
47 * (replaced by ARM_MCI_Control)
48 * Changed ARM_MCI_CardPower function (voltage parameter)
49 * Changed ARM_MCI_SendCommnad function (flags parameter)
50 * Changed ARM_MCI_SetupTransfer function (mode parameter)
51 * Removed ARM_MCI_ReadTransfer and ARM_MCI_WriteTransfer functions
52 * Changed prefix ARM_DRV -> ARM_DRIVER
53 * Changed return values of some functions to int32_t
55 * Namespace prefix ARM_ added
68 #include "Driver_Common.h"
70 #define ARM_MCI_API_VERSION ARM_DRIVER_VERSION_MAJOR_MINOR(2,02) /* API version */
73 /****** MCI Send Command Flags *****/
74 #define ARM_MCI_RESPONSE_Pos 0
75 #define ARM_MCI_RESPONSE_Msk (3UL << ARM_MCI_RESPONSE_Pos)
76 #define ARM_MCI_RESPONSE_NONE (0UL << ARM_MCI_RESPONSE_Pos) ///< No response expected (default)
77 #define ARM_MCI_RESPONSE_SHORT (1UL << ARM_MCI_RESPONSE_Pos) ///< Short response (48-bit)
78 #define ARM_MCI_RESPONSE_SHORT_BUSY (2UL << ARM_MCI_RESPONSE_Pos) ///< Short response with busy signal (48-bit)
79 #define ARM_MCI_RESPONSE_LONG (3UL << ARM_MCI_RESPONSE_Pos) ///< Long response (136-bit)
81 #define ARM_MCI_RESPONSE_INDEX (1UL << 2) ///< Check command index in response
82 #define ARM_MCI_RESPONSE_CRC (1UL << 3) ///< Check CRC in response
84 #define ARM_MCI_WAIT_BUSY (1UL << 4) ///< Wait until busy before sending the command
86 #define ARM_MCI_TRANSFER_DATA (1UL << 5) ///< Activate Data transfer
88 #define ARM_MCI_CARD_INITIALIZE (1UL << 6) ///< Execute Memory Card initialization sequence
90 #define ARM_MCI_INTERRUPT_COMMAND (1UL << 7) ///< Send Interrupt command (CMD40 - MMC only)
91 #define ARM_MCI_INTERRUPT_RESPONSE (1UL << 8) ///< Send Interrupt response (CMD40 - MMC only)
93 #define ARM_MCI_BOOT_OPERATION (1UL << 9) ///< Execute Boot operation (MMC only)
94 #define ARM_MCI_BOOT_ALTERNATIVE (1UL << 10) ///< Execute Alternative Boot operation (MMC only)
95 #define ARM_MCI_BOOT_ACK (1UL << 11) ///< Expect Boot Acknowledge (MMC only)
97 #define ARM_MCI_CCSD (1UL << 12) ///< Send Command Completion Signal Disable (CCSD) for CE-ATA device
98 #define ARM_MCI_CCS (1UL << 13) ///< Expect Command Completion Signal (CCS) for CE-ATA device
101 /****** MCI Setup Transfer Mode *****/
102 #define ARM_MCI_TRANSFER_READ (0UL << 0) ///< Data Read Transfer (from MCI)
103 #define ARM_MCI_TRANSFER_WRITE (1UL << 0) ///< Data Write Transfer (to MCI)
104 #define ARM_MCI_TRANSFER_BLOCK (0UL << 1) ///< Block Data transfer (default)
105 #define ARM_MCI_TRANSFER_STREAM (1UL << 1) ///< Stream Data transfer (MMC only)
108 /****** MCI Control Codes *****/
109 #define ARM_MCI_BUS_SPEED (0x01) ///< Set Bus Speed; arg = requested speed in bits/s; returns configured speed in bits/s
110 #define ARM_MCI_BUS_SPEED_MODE (0x02) ///< Set Bus Speed Mode as specified with arg
111 #define ARM_MCI_BUS_CMD_MODE (0x03) ///< Set CMD Line Mode as specified with arg
112 #define ARM_MCI_BUS_DATA_WIDTH (0x04) ///< Set Bus Data Width as specified with arg
113 #define ARM_MCI_DRIVER_STRENGTH (0x05) ///< Set SD UHS-I Driver Strength as specified with arg
114 #define ARM_MCI_CONTROL_RESET (0x06) ///< Control optional RST_n Pin (eMMC); arg: 0=inactive, 1=active
115 #define ARM_MCI_CONTROL_CLOCK_IDLE (0x07) ///< Control Clock generation on CLK Pin when idle; arg: 0=disabled, 1=enabled
116 #define ARM_MCI_UHS_TUNING_OPERATION (0x08) ///< Sampling clock Tuning operation (SD UHS-I); arg: 0=reset, 1=execute
117 #define ARM_MCI_UHS_TUNING_RESULT (0x09) ///< Sampling clock Tuning result (SD UHS-I); returns: 0=done, 1=in progress, -1=error
118 #define ARM_MCI_DATA_TIMEOUT (0x0A) ///< Set Data timeout; arg = timeout in bus cycles
119 #define ARM_MCI_CSS_TIMEOUT (0x0B) ///< Set Command Completion Signal (CCS) timeout; arg = timeout in bus cycles
120 #define ARM_MCI_MONITOR_SDIO_INTERRUPT (0x0C) ///< Monitor SD I/O interrupt: arg: 0=disabled, 1=enabled
121 #define ARM_MCI_CONTROL_READ_WAIT (0x0D) ///< Control Read/Wait for SD I/O; arg: 0=disabled, 1=enabled
122 #define ARM_MCI_SUSPEND_TRANSFER (0x0E) ///< Suspend Data transfer (SD I/O); returns number of remaining bytes to transfer
123 #define ARM_MCI_RESUME_TRANSFER (0x0F) ///< Resume Data transfer (SD I/O)
125 /*----- MCI Bus Speed Mode -----*/
126 #define ARM_MCI_BUS_DEFAULT_SPEED (0x00) ///< SD/MMC: Default Speed mode up to 25/26MHz
127 #define ARM_MCI_BUS_HIGH_SPEED (0x01) ///< SD/MMC: High Speed mode up to 50/52MHz
128 #define ARM_MCI_BUS_UHS_SDR12 (0x02) ///< SD: SDR12 (Single Data Rate) up to 25MHz, 12.5MB/s: UHS-I (Ultra High Speed) 1.8V signaling
129 #define ARM_MCI_BUS_UHS_SDR25 (0x03) ///< SD: SDR25 (Single Data Rate) up to 50MHz, 25 MB/s: UHS-I (Ultra High Speed) 1.8V signaling
130 #define ARM_MCI_BUS_UHS_SDR50 (0x04) ///< SD: SDR50 (Single Data Rate) up to 100MHz, 50 MB/s: UHS-I (Ultra High Speed) 1.8V signaling
131 #define ARM_MCI_BUS_UHS_SDR104 (0x05) ///< SD: SDR104 (Single Data Rate) up to 208MHz, 104 MB/s: UHS-I (Ultra High Speed) 1.8V signaling
132 #define ARM_MCI_BUS_UHS_DDR50 (0x06) ///< SD: DDR50 (Dual Data Rate) up to 50MHz, 50 MB/s: UHS-I (Ultra High Speed) 1.8V signaling
134 /*----- MCI CMD Line Mode -----*/
135 #define ARM_MCI_BUS_CMD_PUSH_PULL (0x00) ///< Push-Pull CMD line (default)
136 #define ARM_MCI_BUS_CMD_OPEN_DRAIN (0x01) ///< Open Drain CMD line (MMC only)
138 /*----- MCI Bus Data Width -----*/
139 #define ARM_MCI_BUS_DATA_WIDTH_1 (0x00) ///< Bus data width: 1 bit (default)
140 #define ARM_MCI_BUS_DATA_WIDTH_4 (0x01) ///< Bus data width: 4 bits
141 #define ARM_MCI_BUS_DATA_WIDTH_8 (0x02) ///< Bus data width: 8 bits
142 #define ARM_MCI_BUS_DATA_WIDTH_4_DDR (0x03) ///< Bus data width: 4 bits, DDR (Dual Data Rate) - MMC only
143 #define ARM_MCI_BUS_DATA_WIDTH_8_DDR (0x04) ///< Bus data width: 8 bits, DDR (Dual Data Rate) - MMC only
145 /*----- MCI Driver Strength -----*/
146 #define ARM_MCI_DRIVER_TYPE_A (0x01) ///< SD UHS-I Driver Type A
147 #define ARM_MCI_DRIVER_TYPE_B (0x00) ///< SD UHS-I Driver Type B (default)
148 #define ARM_MCI_DRIVER_TYPE_C (0x02) ///< SD UHS-I Driver Type C
149 #define ARM_MCI_DRIVER_TYPE_D (0x03) ///< SD UHS-I Driver Type D
152 /****** MCI Card Power *****/
153 #define ARM_MCI_POWER_VDD_Pos 0
154 #define ARM_MCI_POWER_VDD_Msk (0x0FUL << ARM_MCI_POWER_VDD_Pos)
155 #define ARM_MCI_POWER_VDD_OFF (0x01UL << ARM_MCI_POWER_VDD_Pos) ///< VDD (VCC) turned off
156 #define ARM_MCI_POWER_VDD_3V3 (0x02UL << ARM_MCI_POWER_VDD_Pos) ///< VDD (VCC) = 3.3V
157 #define ARM_MCI_POWER_VDD_1V8 (0x03UL << ARM_MCI_POWER_VDD_Pos) ///< VDD (VCC) = 1.8V
158 #define ARM_MCI_POWER_VCCQ_Pos 4
159 #define ARM_MCI_POWER_VCCQ_Msk (0x0FUL << ARM_MCI_POWER_VCCQ_Pos)
160 #define ARM_MCI_POWER_VCCQ_OFF (0x01UL << ARM_MCI_POWER_VCCQ_Pos) ///< eMMC VCCQ turned off
161 #define ARM_MCI_POWER_VCCQ_3V3 (0x02UL << ARM_MCI_POWER_VCCQ_Pos) ///< eMMC VCCQ = 3.3V
162 #define ARM_MCI_POWER_VCCQ_1V8 (0x03UL << ARM_MCI_POWER_VCCQ_Pos) ///< eMMC VCCQ = 1.8V
163 #define ARM_MCI_POWER_VCCQ_1V2 (0x04UL << ARM_MCI_POWER_VCCQ_Pos) ///< eMMC VCCQ = 1.2V
169 typedef struct _ARM_MCI_STATUS {
170 uint32_t command_active : 1; ///< Command active flag
171 uint32_t command_timeout : 1; ///< Command timeout flag (cleared on start of next command)
172 uint32_t command_error : 1; ///< Command error flag (cleared on start of next command)
173 uint32_t transfer_active : 1; ///< Transfer active flag
174 uint32_t transfer_timeout : 1; ///< Transfer timeout flag (cleared on start of next command)
175 uint32_t transfer_error : 1; ///< Transfer error flag (cleared on start of next command)
176 uint32_t sdio_interrupt : 1; ///< SD I/O Interrupt flag (cleared on start of monitoring)
177 uint32_t ccs : 1; ///< CCS flag (cleared on start of next command)
181 /****** MCI Card Event *****/
182 #define ARM_MCI_EVENT_CARD_INSERTED (1UL << 0) ///< Memory Card inserted
183 #define ARM_MCI_EVENT_CARD_REMOVED (1UL << 1) ///< Memory Card removed
184 #define ARM_MCI_EVENT_COMMAND_COMPLETE (1UL << 2) ///< Command completed
185 #define ARM_MCI_EVENT_COMMAND_TIMEOUT (1UL << 3) ///< Command timeout
186 #define ARM_MCI_EVENT_COMMAND_ERROR (1UL << 4) ///< Command response error (CRC error or invalid response)
187 #define ARM_MCI_EVENT_TRANSFER_COMPLETE (1UL << 5) ///< Data transfer completed
188 #define ARM_MCI_EVENT_TRANSFER_TIMEOUT (1UL << 6) ///< Data transfer timeout
189 #define ARM_MCI_EVENT_TRANSFER_ERROR (1UL << 7) ///< Data transfer CRC failed
190 #define ARM_MCI_EVENT_SDIO_INTERRUPT (1UL << 8) ///< SD I/O Interrupt
191 #define ARM_MCI_EVENT_CCS (1UL << 9) ///< Command Completion Signal (CCS)
192 #define ARM_MCI_EVENT_CCS_TIMEOUT (1UL << 10) ///< Command Completion Signal (CCS) Timeout
195 // Function documentation
197 \fn ARM_DRIVER_VERSION ARM_MCI_GetVersion (void)
198 \brief Get driver version.
199 \return \ref ARM_DRIVER_VERSION
202 \fn ARM_MCI_CAPABILITIES ARM_MCI_GetCapabilities (void)
203 \brief Get driver capabilities.
204 \return \ref ARM_MCI_CAPABILITIES
207 \fn int32_t ARM_MCI_Initialize (ARM_MCI_SignalEvent_t cb_event)
208 \brief Initialize the Memory Card Interface
209 \param[in] cb_event Pointer to \ref ARM_MCI_SignalEvent
210 \return \ref execution_status
213 \fn int32_t ARM_MCI_Uninitialize (void)
214 \brief De-initialize Memory Card Interface.
215 \return \ref execution_status
218 \fn int32_t ARM_MCI_PowerControl (ARM_POWER_STATE state)
219 \brief Control Memory Card Interface Power.
220 \param[in] state Power state \ref ARM_POWER_STATE
221 \return \ref execution_status
224 \fn int32_t ARM_MCI_CardPower (uint32_t voltage)
225 \brief Set Memory Card Power supply voltage.
226 \param[in] voltage Memory Card Power supply voltage
227 \return \ref execution_status
230 \fn int32_t ARM_MCI_ReadCD (void)
231 \brief Read Card Detect (CD) state.
232 \return 1:card detected, 0:card not detected, or error
235 \fn int32_t ARM_MCI_ReadWP (void)
236 \brief Read Write Protect (WP) state.
237 \return 1:write protected, 0:not write protected, or error
240 \fn int32_t ARM_MCI_SendCommand (uint32_t cmd,
244 \brief Send Command to card and get the response.
245 \param[in] cmd Memory Card command
246 \param[in] arg Command argument
247 \param[in] flags Command flags
248 \param[out] response Pointer to buffer for response
249 \return \ref execution_status
252 \fn int32_t ARM_MCI_SetupTransfer (uint8_t *data,
253 uint32_t block_count,
256 \brief Setup read or write transfer operation.
257 \param[in,out] data Pointer to data block(s) to be written or read
258 \param[in] block_count Number of blocks
259 \param[in] block_size Size of a block in bytes
260 \param[in] mode Transfer mode
261 \return \ref execution_status
264 \fn int32_t ARM_MCI_AbortTransfer (void)
265 \brief Abort current read/write data transfer.
266 \return \ref execution_status
269 \fn int32_t ARM_MCI_Control (uint32_t control, uint32_t arg)
270 \brief Control MCI Interface.
271 \param[in] control Operation
272 \param[in] arg Argument of operation (optional)
273 \return \ref execution_status
276 \fn ARM_MCI_STATUS ARM_MCI_GetStatus (void)
277 \brief Get MCI status.
278 \return MCI status \ref ARM_MCI_STATUS
282 \fn void ARM_MCI_SignalEvent (uint32_t event)
283 \brief Callback function that signals a MCI Card Event.
284 \param[in] event \ref mci_event_gr
288 typedef void (*ARM_MCI_SignalEvent_t) (uint32_t event); ///< Pointer to \ref ARM_MCI_SignalEvent : Signal MCI Card Event.
292 \brief MCI Driver Capabilities.
294 typedef struct _ARM_MCI_CAPABILITIES {
295 uint32_t cd_state : 1; ///< Card Detect State available
296 uint32_t cd_event : 1; ///< Signal Card Detect change event
297 uint32_t wp_state : 1; ///< Write Protect State available
298 uint32_t vdd : 1; ///< Supports VDD Card Power Supply Control
299 uint32_t vdd_1v8 : 1; ///< Supports 1.8 VDD Card Power Supply
300 uint32_t vccq : 1; ///< Supports VCCQ Card Power Supply Control (eMMC)
301 uint32_t vccq_1v8 : 1; ///< Supports 1.8 VCCQ Card Power Supply (eMMC)
302 uint32_t vccq_1v2 : 1; ///< Supports 1.2 VCCQ Card Power Supply (eMMC)
303 uint32_t data_width_4 : 1; ///< Supports 4-bit data
304 uint32_t data_width_8 : 1; ///< Supports 8-bit data
305 uint32_t data_width_4_ddr : 1; ///< Supports 4-bit data, DDR (Dual Data Rate) - MMC only
306 uint32_t data_width_8_ddr : 1; ///< Supports 8-bit data, DDR (Dual Data Rate) - MMC only
307 uint32_t high_speed : 1; ///< Supports SD/MMC High Speed Mode
308 uint32_t uhs_signaling : 1; ///< Supports SD UHS-I (Ultra High Speed) 1.8V signaling
309 uint32_t uhs_tuning : 1; ///< Supports SD UHS-I tuning
310 uint32_t uhs_sdr50 : 1; ///< Supports SD UHS-I SDR50 (Single Data Rate) up to 50MB/s
311 uint32_t uhs_sdr104 : 1; ///< Supports SD UHS-I SDR104 (Single Data Rate) up to 104MB/s
312 uint32_t uhs_ddr50 : 1; ///< Supports SD UHS-I DDR50 (Dual Data Rate) up to 50MB/s
313 uint32_t uhs_driver_type_a : 1; ///< Supports SD UHS-I Driver Type A
314 uint32_t uhs_driver_type_c : 1; ///< Supports SD UHS-I Driver Type C
315 uint32_t uhs_driver_type_d : 1; ///< Supports SD UHS-I Driver Type D
316 uint32_t sdio_interrupt : 1; ///< Supports SD I/O Interrupt
317 uint32_t read_wait : 1; ///< Supports Read Wait (SD I/O)
318 uint32_t suspend_resume : 1; ///< Supports Suspend/Resume (SD I/O)
319 uint32_t mmc_interrupt : 1; ///< Supports MMC Interrupt
320 uint32_t mmc_boot : 1; ///< Supports MMC Boot
321 uint32_t rst_n : 1; ///< Supports RST_n Pin Control (eMMC)
322 uint32_t ccs : 1; ///< Supports Command Completion Signal (CCS) for CE-ATA
323 uint32_t ccs_timeout : 1; ///< Supports Command Completion Signal (CCS) timeout for CE-ATA
324 } ARM_MCI_CAPABILITIES;
328 \brief Access structure of the MCI Driver.
330 typedef struct _ARM_DRIVER_MCI {
331 ARM_DRIVER_VERSION (*GetVersion) (void); ///< Pointer to \ref ARM_MCI_GetVersion : Get driver version.
332 ARM_MCI_CAPABILITIES (*GetCapabilities)(void); ///< Pointer to \ref ARM_MCI_GetCapabilities : Get driver capabilities.
333 int32_t (*Initialize) (ARM_MCI_SignalEvent_t cb_event); ///< Pointer to \ref ARM_MCI_Initialize : Initialize MCI Interface.
334 int32_t (*Uninitialize) (void); ///< Pointer to \ref ARM_MCI_Uninitialize : De-initialize MCI Interface.
335 int32_t (*PowerControl) (ARM_POWER_STATE state); ///< Pointer to \ref ARM_MCI_PowerControl : Control MCI Interface Power.
336 int32_t (*CardPower) (uint32_t voltage); ///< Pointer to \ref ARM_MCI_CardPower : Set card power supply voltage.
337 int32_t (*ReadCD) (void); ///< Pointer to \ref ARM_MCI_ReadCD : Read Card Detect (CD) state.
338 int32_t (*ReadWP) (void); ///< Pointer to \ref ARM_MCI_ReadWP : Read Write Protect (WP) state.
339 int32_t (*SendCommand) (uint32_t cmd,
342 uint32_t *response); ///< Pointer to \ref ARM_MCI_SendCommand : Send Command to card and get the response.
343 int32_t (*SetupTransfer) (uint8_t *data,
344 uint32_t block_count,
346 uint32_t mode); ///< Pointer to \ref ARM_MCI_SetupTransfer : Setup data transfer operation.
347 int32_t (*AbortTransfer) (void); ///< Pointer to \ref ARM_MCI_AbortTransfer : Abort current data transfer.
348 int32_t (*Control) (uint32_t control, uint32_t arg); ///< Pointer to \ref ARM_MCI_Control : Control MCI Interface.
349 ARM_MCI_STATUS (*GetStatus) (void); ///< Pointer to \ref ARM_MCI_GetStatus : Get MCI status.
350 } const ARM_DRIVER_MCI;
356 #endif /* DRIVER_MCI_H_ */