1 /* ----------------------------------------------------------------------------
\r
2 * SAM Software Package License
\r
3 * ----------------------------------------------------------------------------
\r
4 * Copyright (c) 2013, Atmel Corporation
\r
6 * All rights reserved.
\r
8 * Redistribution and use in source and binary forms, with or without
\r
9 * modification, are permitted provided that the following conditions are met:
\r
11 * - Redistributions of source code must retain the above copyright notice,
\r
12 * this list of conditions and the disclaimer below.
\r
14 * Atmel's name may not be used to endorse or promote products derived from
\r
15 * this software without specific prior written permission.
\r
17 * DISCLAIMER: THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR
\r
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
\r
19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
\r
20 * DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT,
\r
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
\r
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
\r
23 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
\r
24 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
\r
25 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
\r
26 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
\r
27 * ----------------------------------------------------------------------------
\r
34 * \ingroup sdmmc_hal
\r
35 * \addtogroup mcid_module MCI Driver (HAL for SD/MMC Lib)
\r
39 * This driver implements SD(IO)/MMC command operations and MCI configuration
\r
40 * routines to perform SD(IO)/MMC access. It's used for upper layer
\r
41 * (\ref libsdmmc_module "SD/MMC driver") to perform SD/MMC operations.
\r
45 * -# MCID_Init(): Initializes a MCI driver instance and the underlying
\r
47 * -# MCID_SendCmd(): Starts a MCI transfer which described by
\r
48 * \ref sSdmmcCommand.
\r
49 * -# MCID_CancelCmd(): Cancel a pending command.
\r
50 * -# MCID_IsCmdCompleted(): Check if MCI transfer is finished.
\r
51 * -# MCID_Handler(): Interrupt handler which is called by ISR handler.
\r
52 * -# MCID_IOCtrl(): IO control function to report HW attributes to upper
\r
53 * layer driver and modify HW settings (such as clock
\r
54 * frequency, High-speed support, etc. See
\r
55 * \ref sdmmc_ioctrls).
\r
57 * \sa \ref dmad_module "DMA Driver", \ref hsmci_module "HSMCI",
\r
58 * \ref libsdmmc_module "SD/MMC Library"
\r
62 * \ref mcid_dma.c.\n
\r
67 /** \addtogroup mcid_module
\r
71 /*----------------------------------------------------------------------------
\r
73 *----------------------------------------------------------------------------*/
\r
80 /** \addtogroup mcid_defines MCI Driver Defines
\r
83 /*----------------------------------------------------------------------------
\r
85 *----------------------------------------------------------------------------*/
\r
88 #define MCID_IDLE 0 /**< Idle */
\r
89 #define MCID_LOCKED 1 /**< Locked for specific slot */
\r
90 #define MCID_CMD 2 /**< Processing the command */
\r
91 #define MCID_ERROR 3 /**< Command error */
\r
93 /** MCI Initialize clock 400K Hz */
\r
94 #define MCI_INITIAL_SPEED 400000
\r
98 /*----------------------------------------------------------------------------
\r
100 *----------------------------------------------------------------------------*/
\r
101 /** \addtogroup mcid_structs MCI Driver Data Structs
\r
109 * \brief MCI Driver
\r
111 typedef struct _Mcid
\r
113 /** Pointer to a MCI peripheral. */
\r
115 /** Pointer to a DMA driver */
\r
117 /** Pointer to currently executing command. */
\r
119 /** MCK source, Hz */
\r
121 /** DMA transfer channel */
\r
123 /** DMA transferred data index (bytes) */
\r
125 /** DMA transfer size (bytes) */
\r
127 /** MCI peripheral identifier. */
\r
129 /** Polling mode */
\r
134 volatile uint8_t bState;
\r
136 volatile uint8_t bOpStatus;
\r
140 /*----------------------------------------------------------------------------
\r
141 * Exported functions
\r
142 *----------------------------------------------------------------------------*/
\r
143 /** \addtogroup mcid_functions MCI Driver Functions
\r
145 extern void MCID_Init(sMcid * pMcid,
\r
146 Hsmci * pMci, uint8_t bID, uint32_t dwMck,
\r
150 extern void MCID_Reset(sMcid * pMcid);
\r
152 extern void MCID_SetSlot(Hsmci *pMci, uint8_t slot);
\r
154 extern uint32_t MCID_Lock(sMcid * pMcid, uint8_t bSlot);
\r
156 extern uint32_t MCID_Release(sMcid * pMcid);
\r
158 extern void MCID_Handler(sMcid * pMcid);
\r
160 extern uint32_t MCID_SendCmd(sMcid * pMcid, void * pCmd);
\r
162 extern uint32_t MCID_CancelCmd(sMcid * pMcid);
\r
164 extern uint32_t MCID_IsCmdCompleted(sMcid * pMcid);
\r
166 extern uint32_t MCID_IOCtrl(sMcid * pMcid,uint32_t bCtl,uint32_t param);
\r
173 #endif //#ifndef HSMCID_H
\r