/** * @file xmc_flash.h * @date 2019-05-06 * * @cond ***************************************************************************** * XMClib v2.2.0 - XMC Peripheral Driver Library * * Copyright (c) 2015-2020, Infineon Technologies AG * All rights reserved. * * Boost Software License - Version 1.0 - August 17th, 2003 * * Permission is hereby granted, free of charge, to any person or organization * obtaining a copy of the software and accompanying documentation covered by * this license (the "Software") to use, reproduce, display, distribute, * execute, and transmit the Software, and to prepare derivative works of the * Software, and to permit third-parties to whom the Software is furnished to * do so, all subject to the following: * * The copyright notices in the Software and this entire statement, including * the above license grant, this restriction and the following disclaimer, * must be included in all copies of the Software, in whole or in part, and * all derivative works of the Software, unless such copies or derivative * works are solely in the form of machine-executable object code generated by * a source language processor. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT * SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE * FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER * DEALINGS IN THE SOFTWARE. * * To improve the quality of the software, users are encouraged to share * modifications, enhancements or bug fixes with Infineon Technologies AG * at XMCSupport@infineon.com. ***************************************************************************** * * Change History * -------------- * * 2014-12-10: * - Initial
* 2015-02-20: * - Updated for Documentation related changes
* 2015-06-20: * - Removed version macros and declaration of GetDriverVersion API * 2019-05-06: * - Moved definitions of XMC_FLASH_ProgramPage() and XMC_FLASH_EraseSector() to xmc1_flash.h and xmc4_flash.h * @endcond * */ #ifndef XMC_FLASH_H #define XMC_FLASH_H /********************************************************************************************************************* * HEADER FILES ********************************************************************************************************************/ #include "xmc_common.h" #if UC_FAMILY == XMC1 #include "xmc1_flash.h" #endif #if UC_FAMILY == XMC4 #include "xmc4_flash.h" #endif /** * @addtogroup XMClib XMC Peripheral Library * @{ */ /** * @addtogroup FLASH * @brief Flash driver for XMC microcontroller family. * * Flash is a non volatile memory module used to store instruction code or constant data. * The flash low level driver provides support to the following functionalities of flash memory.
*
    * \if XMC4 *
  1. Provides function to program a page. ( XMC_FLASH_ProgramPage() )

    2. *
  2. Provides functions to support read and write protection. ( XMC_FLASH_InstallProtection(), * XMC_FLASH_ConfirmProtection(), XMC_FLASH_VerifyReadProtection(), XMC_FLASH_VerifyWriteProtection() )

    3. *
  3. Provides function to erase sector. ( XMC_FLASH_EraseSector() )

    4. * \endif * \if XMC1 *
  4. Provides functions to program and verify pages. ( XMC_FLASH_ProgramPage(), XMC_FLASH_ProgramPages() * XMC_FLASH_ProgramVerifyPage() )

    5. *
  5. Provides functions to write and verify blocks. ( XMC_FLASH_WriteBlocks(), XMC_FLASH_VerifyBlocks() )

    6. *
  6. Provides functions to read data in terms of word and blocks. ( XMC_FLASH_ReadBlocks(), XMC_FLASH_ReadWord() ) *

    7. *
  7. Provides function to erase page. ( XMC_FLASH_ErasePage() )

    8. * \endif *
* @{ */ /******************************************************************************* * API PROTOTYPE *******************************************************************************/ #ifdef __cplusplus extern "C" { #endif /** * * @param None * * @return None * * \parDescription:
* \if XMC1 * Clears the previous error status by reseting the ECC and VERR error status bits of NVMSTATUS register.\n\n * Call this API before starting any flash programming / erase related APIs to ensure all previous errors are cleared. * \endif * \if XMC4 * Clears the previous error status by reseting the FSR status register.\n\n Call this API before starting any flash * programming / erase related APIs to ensure all previous errors are cleared. * \endif * * \parRelated APIs:
* None * */ void XMC_FLASH_ClearStatus(void); /** * * @param None * * @return uint32_t Status of the previous flash operation. * * \parDescription:
* \if XMC1 * Informs the status of flash by reading the NVMSTATUS register.\n\n It indicates the ECC, VERR(verification error), * WRPERR (Write protocol error) errors as well as the current flash state. After calling the flash read/write/erase * operation related APIs, call this API to get the verification status. The return value of this API shall be checked * against the members of @ref XMC_FLASH_STATUS_t enumeration to get the relevant status. * \endif * \if XMC4 * Informs the status of flash by reading the FSR register.\n\n It indicates the error status such as PFOPER, SQER, * PROER, PFDBER, ORIER, VER errors as well as the current flash state. After calling the flash read/write/erase * operation related APIs, call this API to verify flash status. The return value of this API shall be checked against * the members of @ref XMC_FLASH_STATUS_t enumeration to get the relevant status. * \endif * * \parRelated APIs:
* None * */ uint32_t XMC_FLASH_GetStatus(void); /** * * @param event_msk ORed values of @ref XMC_FLASH_EVENT_t enumeration * * @return None * * \parDescription:
* Enables the particular flash events as specified in the input parameter.\n * * \parRelated APIs:
* XMC_FLASH_DisableEvent()\n\n\n * */ void XMC_FLASH_EnableEvent(const uint32_t event_msk); /** * * @param event_msk ORed values of @ref XMC_FLASH_EVENT_t enumeration * * @return None * * \parDescription:
* Disables the particular flash events as specified in the input parameter.\n * * \parRelated APIs:
* XMC_FLASH_EnableEvent()\n\n\n * */ void XMC_FLASH_DisableEvent(const uint32_t event_msk); /** * * @param None * * @return true if flash is in busy state else returns \a false. * * \parDescription:
* Checks whether flash is in busy state or not.\n\n It is checked by calling the XMC_FLASH_GetStatus() API internally. * Refer XMC_FLASH_GetStatus() for more details.\n * * \parRelated APIs:
* XMC_FLASH_GetStatus()\n\n\n * */ __STATIC_INLINE bool XMC_FLASH_IsBusy(void) { return (bool)(XMC_FLASH_GetStatus() & XMC_FLASH_STATUS_BUSY); } #ifdef __cplusplus } #endif /** * @} */ /** * @} */ #endif