374 lines
14 KiB
C
374 lines
14 KiB
C
/*
|
|
* Copyright (c) 2015, Freescale Semiconductor, Inc.
|
|
* Copyright 2016-2020 NXP
|
|
* All rights reserved.
|
|
*
|
|
* SPDX-License-Identifier: BSD-3-Clause
|
|
*/
|
|
|
|
#ifndef _FSL_MMC_H_
|
|
#define _FSL_MMC_H_
|
|
|
|
#include "fsl_sdmmc_common.h"
|
|
|
|
/*!
|
|
* @addtogroup MMCCARD
|
|
* @{
|
|
*/
|
|
|
|
/*******************************************************************************
|
|
* Definitions
|
|
******************************************************************************/
|
|
/*! @brief Middleware mmc version. */
|
|
#define FSL_MMC_DRIVER_VERSION (MAKE_VERSION(2U, 4U, 1U)) /*2.4.1*/
|
|
|
|
/*! @brief MMC card flags
|
|
* @anchor _mmc_card_flag
|
|
*/
|
|
enum
|
|
{
|
|
kMMC_SupportHighSpeed26MHZFlag = (1U << 0U), /*!< Support high speed 26MHZ */
|
|
kMMC_SupportHighSpeed52MHZFlag = (1U << 1U), /*!< Support high speed 52MHZ */
|
|
kMMC_SupportHighSpeedDDR52MHZ180V300VFlag = (1 << 2U), /*!< ddr 52MHZ 1.8V or 3.0V */
|
|
kMMC_SupportHighSpeedDDR52MHZ120VFlag = (1 << 3U), /*!< DDR 52MHZ 1.2V */
|
|
kMMC_SupportHS200200MHZ180VFlag = (1 << 4U), /*!< HS200 ,200MHZ,1.8V */
|
|
kMMC_SupportHS200200MHZ120VFlag = (1 << 5U), /*!< HS200, 200MHZ, 1.2V */
|
|
kMMC_SupportHS400DDR200MHZ180VFlag = (1 << 6U), /*!< HS400, DDR, 200MHZ,1.8V */
|
|
kMMC_SupportHS400DDR200MHZ120VFlag = (1 << 7U), /*!< HS400, DDR, 200MHZ,1.2V */
|
|
kMMC_SupportHighCapacityFlag = (1U << 8U), /*!< Support high capacity */
|
|
kMMC_SupportAlternateBootFlag = (1U << 9U), /*!< Support alternate boot */
|
|
kMMC_SupportDDRBootFlag = (1U << 10U), /*!< support DDR boot flag*/
|
|
kMMC_SupportHighSpeedBootFlag = (1U << 11U), /*!< support high speed boot flag */
|
|
kMMC_SupportEnhanceHS400StrobeFlag = (1U << 12U), /*!< support enhance HS400 strobe */
|
|
};
|
|
|
|
/*! @brief card io strength control */
|
|
typedef void (*mmc_io_strength_t)(uint32_t busFreq);
|
|
|
|
/*! @brief card user parameter */
|
|
typedef struct _mmc_usr_param
|
|
{
|
|
mmc_io_strength_t ioStrength; /*!< swicth sd io strength */
|
|
uint32_t maxFreq; /*!< board support maximum frequency */
|
|
uint32_t capability; /*!< board capability flag */
|
|
} mmc_usr_param_t;
|
|
|
|
/*!
|
|
* @brief mmc card state
|
|
*
|
|
* Define the card structure including the necessary fields to identify and describe the card.
|
|
*/
|
|
typedef struct _mmc_card
|
|
{
|
|
sdmmchost_t *host; /*!< Host information */
|
|
mmc_usr_param_t usrParam; /*!< user parameter */
|
|
|
|
bool isHostReady; /*!< Use this flag to indicate if need host re-init or not*/
|
|
bool noInteralAlign; /*!< use this flag to disable sdmmc align. If disable, sdmmc will not make sure the
|
|
data buffer address is word align, otherwise all the transfer are align to low level driver */
|
|
uint32_t busClock_Hz; /*!< MMC bus clock united in Hz */
|
|
uint32_t relativeAddress; /*!< Relative address of the card */
|
|
bool enablePreDefinedBlockCount; /*!< Enable PRE-DEFINED block count when read/write */
|
|
uint32_t flags; /*!< Capability flag in _mmc_card_flag */
|
|
|
|
uint8_t internalBuffer[FSL_SDMMC_CARD_INTERNAL_BUFFER_SIZE]; /*!< raw buffer used for mmc driver internal */
|
|
uint32_t ocr; /*!< Raw OCR content */
|
|
mmc_cid_t cid; /*!< CID */
|
|
mmc_csd_t csd; /*!< CSD */
|
|
mmc_extended_csd_t extendedCsd; /*!< Extended CSD */
|
|
uint32_t blockSize; /*!< Card block size */
|
|
uint32_t userPartitionBlocks; /*!< Card total block number in user partition */
|
|
uint32_t bootPartitionBlocks; /*!< Boot partition size united as block size */
|
|
uint32_t eraseGroupBlocks; /*!< Erase group size united as block size */
|
|
mmc_access_partition_t currentPartition; /*!< Current access partition */
|
|
mmc_voltage_window_t hostVoltageWindowVCCQ; /*!< application must set this value according to board specific */
|
|
mmc_voltage_window_t hostVoltageWindowVCC; /*!< application must set this value according to board specific */
|
|
mmc_high_speed_timing_t busTiming; /*!< indicate the current work timing mode*/
|
|
mmc_data_bus_width_t busWidth; /*!< indicate the current work bus width */
|
|
} mmc_card_t;
|
|
|
|
/*************************************************************************************************
|
|
* API
|
|
************************************************************************************************/
|
|
#if defined(__cplusplus)
|
|
extern "C" {
|
|
#endif
|
|
|
|
/*!
|
|
* @name MMCCARD Function
|
|
* @{
|
|
*/
|
|
|
|
/*!
|
|
* @brief Initializes the MMC card and host.
|
|
*
|
|
* @param card Card descriptor.
|
|
*
|
|
* @retval kStatus_SDMMC_HostNotReady host is not ready.
|
|
* @retval kStatus_SDMMC_GoIdleFailed Go idle failed.
|
|
* @retval kStatus_SDMMC_SendOperationConditionFailed Send operation condition failed.
|
|
* @retval kStatus_SDMMC_AllSendCidFailed Send CID failed.
|
|
* @retval kStatus_SDMMC_SetRelativeAddressFailed Set relative address failed.
|
|
* @retval kStatus_SDMMC_SendCsdFailed Send CSD failed.
|
|
* @retval kStatus_SDMMC_CardNotSupport Card not support.
|
|
* @retval kStatus_SDMMC_SelectCardFailed Send SELECT_CARD command failed.
|
|
* @retval kStatus_SDMMC_SendExtendedCsdFailed Send EXT_CSD failed.
|
|
* @retval kStatus_SDMMC_SetBusWidthFailed Set bus width failed.
|
|
* @retval kStatus_SDMMC_SwitchHighSpeedFailed Switch high speed failed.
|
|
* @retval kStatus_SDMMC_SetCardBlockSizeFailed Set card block size failed.
|
|
* @retval kStatus_Success Operate successfully.
|
|
*/
|
|
status_t MMC_Init(mmc_card_t *card);
|
|
|
|
/*!
|
|
* @brief Deinitializes the card and host.
|
|
*
|
|
* @param card Card descriptor.
|
|
*/
|
|
void MMC_Deinit(mmc_card_t *card);
|
|
|
|
/*!
|
|
* @brief intialize the card.
|
|
*
|
|
* @param card Card descriptor.
|
|
*
|
|
* @retval kStatus_SDMMC_HostNotReady host is not ready.
|
|
* @retval kStatus_SDMMC_GoIdleFailed Go idle failed.
|
|
* @retval kStatus_SDMMC_SendOperationConditionFailed Send operation condition failed.
|
|
* @retval kStatus_SDMMC_AllSendCidFailed Send CID failed.
|
|
* @retval kStatus_SDMMC_SetRelativeAddressFailed Set relative address failed.
|
|
* @retval kStatus_SDMMC_SendCsdFailed Send CSD failed.
|
|
* @retval kStatus_SDMMC_CardNotSupport Card not support.
|
|
* @retval kStatus_SDMMC_SelectCardFailed Send SELECT_CARD command failed.
|
|
* @retval kStatus_SDMMC_SendExtendedCsdFailed Send EXT_CSD failed.
|
|
* @retval kStatus_SDMMC_SetBusWidthFailed Set bus width failed.
|
|
* @retval kStatus_SDMMC_SwitchHighSpeedFailed Switch high speed failed.
|
|
* @retval kStatus_SDMMC_SetCardBlockSizeFailed Set card block size failed.
|
|
* @retval kStatus_Success Operate successfully.
|
|
*/
|
|
status_t MMC_CardInit(mmc_card_t *card);
|
|
|
|
/*!
|
|
* @brief Deinitializes the card.
|
|
*
|
|
* @param card Card descriptor.
|
|
*/
|
|
void MMC_CardDeinit(mmc_card_t *card);
|
|
|
|
/*!
|
|
* @brief initialize the host.
|
|
*
|
|
* This function deinitializes the specific host.
|
|
*
|
|
* @param card Card descriptor.
|
|
*/
|
|
status_t MMC_HostInit(mmc_card_t *card);
|
|
|
|
/*!
|
|
* @brief Deinitializes the host.
|
|
*
|
|
* This function deinitializes the host.
|
|
*
|
|
* @param card Card descriptor.
|
|
*/
|
|
void MMC_HostDeinit(mmc_card_t *card);
|
|
|
|
/*!
|
|
* @brief reset the host.
|
|
*
|
|
* This function reset the specific host.
|
|
*
|
|
* @param host host descriptor.
|
|
*/
|
|
void MMC_HostReset(SDMMCHOST_CONFIG *host);
|
|
|
|
/*!
|
|
* @brief power on card.
|
|
*
|
|
* The power on operation depend on host or the user define power on function.
|
|
* @deprecated Do not use this function. It has been superceded by @ref MMC_SetCardPower.
|
|
* @param base host base address.
|
|
* @param pwr user define power control configuration
|
|
*/
|
|
void MMC_PowerOnCard(SDMMCHOST_TYPE *base, const sdmmchost_pwr_card_t *pwr);
|
|
|
|
/*!
|
|
* @brief power off card.
|
|
*
|
|
* The power off operation depend on host or the user define power on function.
|
|
* @deprecated Do not use this function. It has been superceded by @ref MMC_SetCardPower.
|
|
* @param base host base address.
|
|
* @param pwr user define power control configuration
|
|
*/
|
|
void MMC_PowerOffCard(SDMMCHOST_TYPE *base, const sdmmchost_pwr_card_t *pwr);
|
|
|
|
/*!
|
|
* @brief set card power.
|
|
*
|
|
* @param card card descriptor.
|
|
* @param enable true is power on, false is power off.
|
|
*/
|
|
void MMC_SetCardPower(mmc_card_t *card, bool enable);
|
|
|
|
/*!
|
|
* @brief Checks if the card is read-only.
|
|
*
|
|
* @param card Card descriptor.
|
|
* @retval true Card is read only.
|
|
* @retval false Card isn't read only.
|
|
*/
|
|
bool MMC_CheckReadOnly(mmc_card_t *card);
|
|
|
|
/*!
|
|
* @brief Reads data blocks from the card.
|
|
*
|
|
* @param card Card descriptor.
|
|
* @param buffer The buffer to save data.
|
|
* @param startBlock The start block index.
|
|
* @param blockCount The number of blocks to read.
|
|
* @retval kStatus_InvalidArgument Invalid argument.
|
|
* @retval kStatus_SDMMC_CardNotSupport Card not support.
|
|
* @retval kStatus_SDMMC_SetBlockCountFailed Set block count failed.
|
|
* @retval kStatus_SDMMC_TransferFailed Transfer failed.
|
|
* @retval kStatus_SDMMC_StopTransmissionFailed Stop transmission failed.
|
|
* @retval kStatus_Success Operate successfully.
|
|
*/
|
|
status_t MMC_ReadBlocks(mmc_card_t *card, uint8_t *buffer, uint32_t startBlock, uint32_t blockCount);
|
|
|
|
/*!
|
|
* @brief Writes data blocks to the card.
|
|
*
|
|
* @param card Card descriptor.
|
|
* @param buffer The buffer to save data blocks.
|
|
* @param startBlock Start block number to write.
|
|
* @param blockCount Block count.
|
|
* @retval kStatus_InvalidArgument Invalid argument.
|
|
* @retval kStatus_SDMMC_NotSupportYet Not support now.
|
|
* @retval kStatus_SDMMC_SetBlockCountFailed Set block count failed.
|
|
* @retval kStatus_SDMMC_WaitWriteCompleteFailed Send status failed.
|
|
* @retval kStatus_SDMMC_TransferFailed Transfer failed.
|
|
* @retval kStatus_SDMMC_StopTransmissionFailed Stop transmission failed.
|
|
* @retval kStatus_Success Operate successfully.
|
|
*/
|
|
status_t MMC_WriteBlocks(mmc_card_t *card, const uint8_t *buffer, uint32_t startBlock, uint32_t blockCount);
|
|
|
|
/*!
|
|
* @brief Erases groups of the card.
|
|
*
|
|
* Erase group is the smallest erase unit in MMC card. The erase range is [startGroup, endGroup].
|
|
*
|
|
* @param card Card descriptor.
|
|
* @param startGroup Start group number.
|
|
* @param endGroup End group number.
|
|
* @retval kStatus_InvalidArgument Invalid argument.
|
|
* @retval kStatus_SDMMC_WaitWriteCompleteFailed Send status failed.
|
|
* @retval kStatus_SDMMC_TransferFailed Transfer failed.
|
|
* @retval kStatus_Success Operate successfully.
|
|
*/
|
|
status_t MMC_EraseGroups(mmc_card_t *card, uint32_t startGroup, uint32_t endGroup);
|
|
|
|
/*!
|
|
* @brief Selects the partition to access.
|
|
*
|
|
* @param card Card descriptor.
|
|
* @param partitionNumber The partition number.
|
|
* @retval kStatus_SDMMC_ConfigureExtendedCsdFailed Configure EXT_CSD failed.
|
|
* @retval kStatus_Success Operate successfully.
|
|
*/
|
|
status_t MMC_SelectPartition(mmc_card_t *card, mmc_access_partition_t partitionNumber);
|
|
|
|
/*!
|
|
* @brief Configures the boot activity of the card.
|
|
*
|
|
* @param card Card descriptor.
|
|
* @param config Boot configuration structure.
|
|
* @retval kStatus_SDMMC_NotSupportYet Not support now.
|
|
* @retval kStatus_SDMMC_ConfigureExtendedCsdFailed Configure EXT_CSD failed.
|
|
* @retval kStatus_SDMMC_ConfigureBootFailed Configure boot failed.
|
|
* @retval kStatus_Success Operate successfully.
|
|
*/
|
|
status_t MMC_SetBootConfig(mmc_card_t *card, const mmc_boot_config_t *config);
|
|
|
|
/*!
|
|
* @brief MMC card start boot.
|
|
*
|
|
* @param card Card descriptor.
|
|
* @param mmcConfig mmc Boot configuration structure.
|
|
* @param buffer address to recieve data.
|
|
* @param hostConfig host boot configurations.
|
|
* @retval kStatus_Fail fail.
|
|
* @retval kStatus_SDMMC_TransferFailed transfer fail.
|
|
* @retval kStatus_SDMMC_GoIdleFailed reset card fail.
|
|
* @retval kStatus_Success Operate successfully.
|
|
*/
|
|
status_t MMC_StartBoot(mmc_card_t *card,
|
|
const mmc_boot_config_t *mmcConfig,
|
|
uint8_t *buffer,
|
|
sdmmchost_boot_config_t *hostConfig);
|
|
|
|
/*!
|
|
* @brief MMC card set boot configuration write protect.
|
|
*
|
|
* @param card Card descriptor.
|
|
* @param wp write protect value.
|
|
*/
|
|
status_t MMC_SetBootConfigWP(mmc_card_t *card, uint8_t wp);
|
|
|
|
/*!
|
|
* @brief MMC card continous read boot data.
|
|
*
|
|
* @param card Card descriptor.
|
|
* @param buffer buffer address.
|
|
* @param hostConfig host boot configurations.
|
|
*/
|
|
status_t MMC_ReadBootData(mmc_card_t *card, uint8_t *buffer, sdmmchost_boot_config_t *hostConfig);
|
|
|
|
/*!
|
|
* @brief MMC card stop boot mode.
|
|
*
|
|
* @param card Card descriptor.
|
|
* @param bootMode boot mode.
|
|
*/
|
|
status_t MMC_StopBoot(mmc_card_t *card, uint32_t bootMode);
|
|
|
|
/*!
|
|
* @brief MMC card set boot partition write protect.
|
|
*
|
|
* @param card Card descriptor.
|
|
* @param bootPartitionWP boot partition write protect value.
|
|
*/
|
|
status_t MMC_SetBootPartitionWP(mmc_card_t *card, mmc_boot_partition_wp_t bootPartitionWP);
|
|
|
|
/*!
|
|
* @brief MMC card cache control function.
|
|
*
|
|
* The mmc device's cache is enabled by the driver by default.
|
|
* The cache should in typical case reduce the access time (compared to an access to the main nonvolatile storage) for
|
|
* both write and read.
|
|
*
|
|
* @param card Card descriptor.
|
|
* @param enable true is enable the cache, false is disable the cache.
|
|
*/
|
|
status_t MMC_EnableCacheControl(mmc_card_t *card, bool enable);
|
|
|
|
/*!
|
|
* @brief MMC card cache flush function.
|
|
*
|
|
* A Flush operation refers to the requirement, from the host to the device, to write the cached data to the nonvolatile
|
|
* memory. Prior to a flush, the device may autonomously write data to the nonvolatile memory, but after the flush
|
|
* operation all data in the volatile area must be written to nonvolatile memory There is no requirement for flush due
|
|
* to switching between the partitions. (Note: This also implies that the cache data shall not be lost when switching
|
|
* between partitions). Cached data may be lost in SLEEP state, so host should flush the cache before placing the device
|
|
* into SLEEP state.
|
|
*
|
|
* @param card Card descriptor.
|
|
*/
|
|
status_t MMC_FlushCache(mmc_card_t *card);
|
|
|
|
/* @} */
|
|
#if defined(__cplusplus)
|
|
}
|
|
#endif
|
|
/*! @} */
|
|
#endif /* _FSL_MMC_H_*/
|