/**
* @file xmc_sdmmc.c
* @date 2016-07-11
*
* @cond
*********************************************************************************************************************
* XMClib v2.1.12 - XMC Peripheral Driver Library
*
* Copyright (c) 2015-2017, Infineon Technologies AG
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification,are permitted provided that the
* following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following
* disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials provided with the distribution.
*
* Neither the name of the copyright holders nor the names of its contributors may be used to endorse or promote
* products derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY,OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* To improve the quality of the software, users are encouraged to share modifications, enhancements or bug fixes with
* Infineon Technologies AG dave@infineon.com).
*********************************************************************************************************************
*
* Change History
* --------------
*
* 2015-02-20:
* - Initial
* - Removed GetDriverVersion API
*
* 2015-06-20:
* - Removed definition of GetDriverVersion API
*
* 2016-03-14:
* - Values are directly assigned to the int status registers
*
* 2016-07-11:
* - XMC_SDMMC_SetDataTransferMode() shall not invoke SetDateLineTimeout()
*
* @endcond
*/
/**
* @addtogroup XMClib
* @{
*/
/**
* @addtogroup SDMMC
* @brief SDMMC driver
* @{
*/
/*******************************************************************************
* HEADER FILES
*******************************************************************************/
#include "xmc_sdmmc.h"
/*
* The SDMMC peripheral is only available on the
* XMC4500. The SDMMC definition can be found in
* the XMC4500.h (device header file).
*/
#if defined (SDMMC)
#include "xmc_scu.h"
/*******************************************************************************
* MACROS
*******************************************************************************/
/*
* Check for valid SDMMC error events
*
* This macro is used in the LLD for assertion checks (XMC_ASSERT).
*/
#define XMC_SDMMC_CHECK_ERROR_EVENT(e)\
((e == XMC_SDMMC_CMD_TIMEOUT_ERR) ||\
(e == XMC_SDMMC_CMD_CRC_ERR) ||\
(e == XMC_SDMMC_CMD_END_BIT_ERR) ||\
(e == XMC_SDMMC_CMD_IND_ERR) ||\
(e == XMC_SDMMC_DATA_TIMEOUT_ERR) ||\
(e == XMC_SDMMC_DATA_CRC_ERR) ||\
(e == XMC_SDMMC_DATA_END_BIT_ERR) ||\
(e == XMC_SDMMC_CURRENT_LIMIT_ERR) ||\
(e == XMC_SDMMC_ACMD_ERR) ||\
(e == XMC_SDMMC_TARGET_RESP_ERR))
/*
* Check for valid SDMMC normal events
*
* This macro is used in the LLD for assertion checks (XMC_ASSERT).
*/
#define XMC_SDMMC_CHECK_NORMAL_EVENT(e)\
((e == XMC_SDMMC_CMD_COMPLETE) ||\
(e == XMC_SDMMC_TX_COMPLETE) ||\
(e == XMC_SDMMC_BLOCK_GAP_EVENT) ||\
(e == XMC_SDMMC_BUFFER_WRITE_READY) ||\
(e == XMC_SDMMC_BUFFER_READ_READY) ||\
(e == XMC_SDMMC_CARD_INS) ||\
(e == XMC_SDMMC_CARD_REMOVAL) ||\
(e == XMC_SDMMC_CARD_INT))
/*
* Check for both normal and error events
*
* This macro is used in the LLD for assertion checks (XMC_ASSERT).
*/
#define XMC_SDMMC_CHECK_EVENT(e)\
((XMC_SDMMC_CHECK_NORMAL_EVENT(e)) ||\
(XMC_SDMMC_CHECK_ERROR_EVENT(e)))
/*
* Check for valid SDMMC wakeup events
*
* This macro is used in the LLD for assertion checks (XMC_ASSERT).
*/
#define XMC_SDMMC_CHECK_WAKEUP_EVENT(w)\
((w == XMC_SDMMC_WAKEUP_EN_CARD_INT) ||\
(w == XMC_SDMMC_WAKEUP_EN_CARD_INS) ||\
(w == XMC_SDMMC_WAKEUP_EN_CARD_REM))
/*
* Check for valid SDMMC software reset modes
*
* This macro is used in the LLD for assertion checks (XMC_ASSERT).
*/
#define XMC_SDMMC_CHECK_SW_RESET_MODE(m)\
((m == XMC_SDMMC_SW_RESET_ALL) ||\
(m == XMC_SDMMC_SW_RST_CMD_LINE) ||\
(m == XMC_SDMMC_SW_RST_DAT_LINE))
/*
* Check for valid SDMMC transfer modes
*
* This macro is used in the LLD for assertion checks (XMC_ASSERT).
*/
#define XMC_SDMMC_CHECK_TRANSFER_MODE(m)\
((m == XMC_SDMMC_TRANSFER_MODE_TYPE_SINGLE) ||\
(m == XMC_SDMMC_TRANSFER_MODE_TYPE_INFINITE) ||\
(m == XMC_SDMMC_TRANSFER_MODE_TYPE_MULTIPLE) ||\
(m == XMC_SDMMC_TRANSFER_MODE_TYPE_STOP_MULTIPLE))
/*******************************************************************************
* API IMPLEMENTATION
*******************************************************************************/
/* Get power status of the SDMMC peripheral */
bool XMC_SDMMC_GetPowerStatus(XMC_SDMMC_t *const sdmmc)
{
XMC_ASSERT("XMC_SDMMC_GetPowerStatus: Invalid module pointer", XMC_SDMMC_CHECK_MODULE_PTR(sdmmc));
return (bool)(sdmmc->POWER_CTRL & SDMMC_POWER_CTRL_SD_BUS_POWER_Msk);
}
/*
* De-assert the peripheral reset. The SDMMC peripheral
* needs to be initialized
*/
void XMC_SDMMC_Enable(XMC_SDMMC_t *const sdmmc)
{
XMC_ASSERT("XMC_SDMMC_Enable: Invalid module pointer", XMC_SDMMC_CHECK_MODULE_PTR(sdmmc));
#if defined(CLOCK_GATING_SUPPORTED)
XMC_SCU_CLOCK_UngatePeripheralClock(XMC_SCU_PERIPHERAL_CLOCK_SDMMC);
#endif
#if defined(PERIPHERAL_RESET_SUPPORTED)
XMC_SCU_RESET_DeassertPeripheralReset(XMC_SCU_PERIPHERAL_RESET_SDMMC);
#endif
}
/* Assert the peripheral reset */
void XMC_SDMMC_Disable(XMC_SDMMC_t *const sdmmc)
{
XMC_ASSERT("XMC_SDMMC_Disable: Invalid module pointer", XMC_SDMMC_CHECK_MODULE_PTR(sdmmc));
#if defined(PERIPHERAL_RESET_SUPPORTED)
XMC_SCU_RESET_AssertPeripheralReset(XMC_SCU_PERIPHERAL_RESET_SDMMC);
#endif
#if defined(CLOCK_GATING_SUPPORTED)
XMC_SCU_CLOCK_GatePeripheralClock(XMC_SCU_PERIPHERAL_CLOCK_SDMMC);
#endif
}
/* Initialize SDMMC peripheral */
XMC_SDMMC_STATUS_t XMC_SDMMC_Init(XMC_SDMMC_t *const sdmmc, const XMC_SDMMC_CONFIG_t *config)
{
XMC_ASSERT("XMC_SDMMC_Init: Invalid module pointer", XMC_SDMMC_CHECK_MODULE_PTR(sdmmc));
XMC_ASSERT("XMC_SDMMC_Init: Invalid clock divider value", XMC_SDMMC_CHECK_SDCLK_FREQ(config->clock_divider));
XMC_ASSERT("XMC_SDMMC_Init: Invalid bus width", XMC_SDMMC_CHECK_DATA_LINES(config->bus_width));
/* Enable SDMMC peripheral */
XMC_SDMMC_Enable(sdmmc);
/* Write internal clock divider register */
sdmmc->CLOCK_CTRL |= (uint16_t)((uint32_t)config->clock_divider << SDMMC_CLOCK_CTRL_SDCLK_FREQ_SEL_Pos);
/* Set bus width */
sdmmc->HOST_CTRL = (uint8_t)((sdmmc->HOST_CTRL & (uint8_t)~SDMMC_HOST_CTRL_DATA_TX_WIDTH_Msk) |
((uint8_t)config->bus_width << SDMMC_HOST_CTRL_DATA_TX_WIDTH_Pos));
return XMC_SDMMC_STATUS_SUCCESS;
}
/* Enable event status */
void XMC_SDMMC_EnableEventStatus(XMC_SDMMC_t *const sdmmc, uint32_t event)
{
XMC_ASSERT("XMC_SDMMC_EnableEventStatus: Invalid module pointer", XMC_SDMMC_CHECK_MODULE_PTR(sdmmc));
/* Set INT status enable register */
sdmmc->EN_INT_STATUS_NORM |= (uint16_t)event;
sdmmc->EN_INT_STATUS_ERR |= (uint16_t)(event >> 16U);
}
/* Disable event status */
void XMC_SDMMC_DisableEventStatus(XMC_SDMMC_t *const sdmmc, uint32_t event)
{
XMC_ASSERT("XMC_SDMMC_DisableEventStatus: Invalid module pointer", XMC_SDMMC_CHECK_MODULE_PTR(sdmmc));
/* Clear INT status enable register */
sdmmc->EN_INT_STATUS_NORM &= (uint16_t)~event;
sdmmc->EN_INT_STATUS_ERR &= (uint16_t)~(event >> 16U);
}
/* Enable SDMMC event */
void XMC_SDMMC_EnableEvent(XMC_SDMMC_t *const sdmmc, uint32_t event)
{
XMC_ASSERT("XMC_SDMMC_EnableEvent: Invalid module pointer", XMC_SDMMC_CHECK_MODULE_PTR(sdmmc));
XMC_SDMMC_EnableEventStatus(sdmmc, event);
sdmmc->EN_INT_SIGNAL_NORM |= (uint16_t)event;
sdmmc->EN_INT_SIGNAL_ERR |= (uint16_t)(event >> 16U);
}
/* Disable SDMMC event without disabling event status */
void XMC_SDMMC_DisableEvent(XMC_SDMMC_t *const sdmmc, uint32_t event)
{
XMC_ASSERT("XMC_SDMMC_DisableEvent: Invalid module pointer", XMC_SDMMC_CHECK_MODULE_PTR(sdmmc));
/* Clear INT signal enable register */
sdmmc->EN_INT_SIGNAL_NORM &= (uint16_t)~event;
sdmmc->EN_INT_SIGNAL_ERR &= (uint16_t)~(event >> 16U);
}
/* Clear SDMMC event(s) */
void XMC_SDMMC_ClearEvent(XMC_SDMMC_t *const sdmmc, uint32_t event)
{
XMC_ASSERT("XMC_SDMMC_ClearEvent: Invalid module pointer", XMC_SDMMC_CHECK_MODULE_PTR(sdmmc));
XMC_ASSERT("XMC_SDMMC_ClearEvent: Invalid bit-field", !(event & XMC_SDMMC_TARGET_RESP_ERR));
sdmmc->INT_STATUS_NORM = (uint16_t)event;
sdmmc->INT_STATUS_ERR = (uint16_t)(event >> 16U);
}
/* Get the status of an SDMMC event */
bool XMC_SDMMC_GetEvent(XMC_SDMMC_t *const sdmmc, XMC_SDMMC_EVENT_t event)
{
bool status;
XMC_ASSERT("XMC_SDMMC_GetEvent: Invalid module pointer", XMC_SDMMC_CHECK_MODULE_PTR(sdmmc));
XMC_ASSERT("XMC_SDMMC_GetEvent: Invalid SDMMC event", XMC_SDMMC_CHECK_EVENT(event));
if (event < XMC_SDMMC_CMD_TIMEOUT_ERR)
{
status = (bool)(sdmmc->INT_STATUS_NORM & (uint16_t)event);
}
else
{
status = (bool)(sdmmc->INT_STATUS_ERR & (uint16_t)((uint32_t)event >> 16U));
}
return status;
}
/* Read R2 response (CID, CSD register) */
void XMC_SDMMC_GetR2Response(XMC_SDMMC_t *const sdmmc, XMC_SDMMC_RESPONSE_t *const response)
{
XMC_ASSERT("XMC_SDMMC_GetR2Response: Invalid module pointer", XMC_SDMMC_CHECK_MODULE_PTR(sdmmc));
response->response_0 = sdmmc->RESPONSE[0];
response->response_2 = sdmmc->RESPONSE[1];
response->response_4 = sdmmc->RESPONSE[2];
response->response_6 = sdmmc->RESPONSE[3];
}
/* Send SDMMC command */
XMC_SDMMC_STATUS_t XMC_SDMMC_SendCommand(XMC_SDMMC_t *const sdmmc, const XMC_SDMMC_COMMAND_t *cmd, uint32_t arg)
{
XMC_ASSERT("XMC_SDMMC_SendCommand: Invalid module pointer", XMC_SDMMC_CHECK_MODULE_PTR(sdmmc));
sdmmc->ARGUMENT1 = arg;
sdmmc->COMMAND = (uint16_t)(*(uint16_t *)cmd);
return XMC_SDMMC_STATUS_SUCCESS;
}
/* Set data transfer mode */
void XMC_SDMMC_SetDataTransferMode(XMC_SDMMC_t *const sdmmc, XMC_SDMMC_TRANSFER_MODE_t *const response)
{
XMC_ASSERT("XMC_SDMMC_SetDataTransferMode: Invalid module pointer", XMC_SDMMC_CHECK_MODULE_PTR(sdmmc));
XMC_ASSERT("XMC_SDMMC_SetDataTransferMode: Invalid transfer type", XMC_SDMMC_CHECK_TRANSFER_MODE(response->type));
/* Block size */
sdmmc->BLOCK_SIZE = (uint16_t)(response->block_size);
/* Number of blocks */
sdmmc->BLOCK_COUNT = (uint16_t)(response->num_blocks);
/* Type of data transfer: single, infinite, multiple or stop multiple */
sdmmc->TRANSFER_MODE = (uint16_t)((sdmmc->TRANSFER_MODE & (uint16_t)~SDMMC_TRANSFER_MODE_MULTI_BLOCK_SELECT_Msk) |
((uint16_t)response->type));
/*
* Clear block count enable bit; that's only valid for
* a multi-block transfer
*/
if (response->type == XMC_SDMMC_TRANSFER_MODE_TYPE_SINGLE)
{
sdmmc->TRANSFER_MODE &= (uint16_t)~SDMMC_TRANSFER_MODE_BLOCK_COUNT_EN_Msk;
}
/* Auto CMD configuration */
sdmmc->TRANSFER_MODE = (uint16_t)((sdmmc->TRANSFER_MODE & (uint16_t)~SDMMC_TRANSFER_MODE_ACMD_EN_Msk) |
((uint16_t)response->auto_cmd << SDMMC_TRANSFER_MODE_ACMD_EN_Pos));
}
#endif /* #if defined (SDMMC) */
/**
* @}
*/
/**
* @}
*/