flash.h

Go to the documentation of this file.

/******************************************************************************
 *  Copyright (c) 2022-2024 Texas Instruments Incorporated
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *
 *  1) Redistributions of source code must retain the above copyright notice,
 *     this list of conditions and the following disclaimer.
 *
 *  2) 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.
 *
 *  3) Neither the name of the copyright holder 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.
 *
 ******************************************************************************/

#ifndef __FLASH_H__
#define __FLASH_H__

//*****************************************************************************
//
//
//*****************************************************************************

//*****************************************************************************
//
// If building with a C++ compiler, make all of the definitions in this header
// have a C binding.
//
//*****************************************************************************
#ifdef __cplusplus
extern "C" {
#endif

#include <stdbool.h>
#include <stdint.h>

#include "../inc/hw_types.h"
#include "../inc/hw_flash.h"
#include "../inc/hw_memmap.h"
#include "../inc/hw_ints.h"
#include "../inc/hw_vims.h"
#include "hapi.h"
#include "chipinfo.h"
#include "interrupt.h"
#include "debug.h"

//*****************************************************************************
// Values that can be returned from the API functions
//*****************************************************************************
#define FAPI_STATUS_SUCCESS                     0x00000000 
#define FAPI_STATUS_FSM_BUSY                    0x00000001 
#define FAPI_STATUS_FSM_READY                   0x00000002 
#define FAPI_STATUS_INCORRECT_DATABUFFER_LENGTH 0x00000003 
#define FAPI_STATUS_FSM_ERROR                   0x00000004 
#define FAPI_STATUS_ADDRESS_ERROR               0x00000005 
#define FAPI_STATUS_INVALID_KEY                 0x00000010 

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE uint32_t FlashGetSectorSize(void)
{
    return (FLASH_MAIN_SECTOR_SIZE);
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE uint32_t FlashGetSize(void)
{
    // Return flash size in number of bytes
    return (FLASH_MAIN_SIZE);
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE uint32_t FlashCheckFsmForError(void)
{
    if (HWREG(FLASH_BASE + FLASH_O_STATCMD) & FLASH_STATCMD_CMDPASS_M)
    {
        return (FAPI_STATUS_SUCCESS);
    }
    else
    {
        return (FAPI_STATUS_FSM_ERROR);
    }
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE uint32_t FlashCheckFsmForReady(void)
{
    if (HWREG(FLASH_BASE + FLASH_O_STATCMD) & FLASH_STATCMD_CMDDONE_M)
    {
        return (FAPI_STATUS_FSM_READY);
    }
    else
    {
        return (FAPI_STATUS_FSM_BUSY);
    }
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE uint32_t FlashEraseSector(uint32_t sectorAddress)
{
    // Store current configuration
    uint32_t cchctrl                  = HWREG(VIMS_BASE + VIMS_O_CCHCTRL);
    // Clear instruction cache
    HWREG(VIMS_BASE + VIMS_O_CCHCTRL) = (VIMS_CCHCTRL_CCHMPEN_DIS | VIMS_CCHCTRL_CCHPFEN_DIS | VIMS_CCHCTRL_CCHEN_DIS);

    uint32_t retCode = HapiFlashSectorErase(FLASH_API_KEY, sectorAddress);

    // Restore configuration
    HWREG(VIMS_BASE + VIMS_O_CCHCTRL) = cchctrl;

    return (retCode);
}

/*****************************************************************************
 * \brief Erase all unprotected sectors in the flash main bank
 *
 * This function will erase all unprotected main bank flash sectors. It will
 * not return until the flash sectors has been erased or an error condition
 * occurs.
 *
 * \warning Please note that code can not execute in flash while any part of
 * the flash is being programmed or erased. The application must disable
 * interrupts that have interrupt routines in flash.
 *
 * \return Returns the status of the sector erase:
 * - \ref FAPI_STATUS_SUCCESS (0): Success
 * - \ref FAPI_STATUS_FSM_ERROR  : An erase error is encountered.
 *****************************************************************************/
__STATIC_INLINE uint32_t FlashEraseBank(void)
{
    // Store current configuration
    uint32_t cchctrl = HWREG(VIMS_BASE + VIMS_O_CCHCTRL);

    // Clear instruction cache
    HWREG(VIMS_BASE + VIMS_O_CCHCTRL) = (VIMS_CCHCTRL_CCHMPEN_DIS | VIMS_CCHCTRL_CCHPFEN_DIS | VIMS_CCHCTRL_CCHEN_DIS);

    uint32_t retCode = HapiFlashBankErase(FLASH_API_KEY);

    // Restore configuration
    HWREG(VIMS_BASE + VIMS_O_CCHCTRL) = cchctrl;

    return (retCode);
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE uint32_t FlashProgram(uint8_t *dataBuffer, uint32_t address, uint32_t count)
{
    // Store current configuration
    uint32_t cchctrl = HWREG(VIMS_BASE + VIMS_O_CCHCTRL);

    // Clear instruction cache
    HWREG(VIMS_BASE + VIMS_O_CCHCTRL) = (VIMS_CCHCTRL_CCHMPEN_DIS | VIMS_CCHCTRL_CCHPFEN_DIS | VIMS_CCHCTRL_CCHEN_DIS);

    uint32_t retCode = HapiFlashProgram(FLASH_API_KEY, dataBuffer, address, count);

    // Restore configuration
    HWREG(VIMS_BASE + VIMS_O_CCHCTRL) = cchctrl;

    return (retCode);
}

//*****************************************************************************
//
// Mark the end of the C bindings section for C++ compilers.
//
//*****************************************************************************
#ifdef __cplusplus
}
#endif

//*****************************************************************************
//
//
//*****************************************************************************

#endif // __FLASH_H__