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 

//*****************************************************************************
//
// Values returned from FlashGetProtection().
//
//*****************************************************************************
#define FLASH_NO_PROTECT    0x00000000 
#define FLASH_WRITE_PROTECT 0x00000001 

//*****************************************************************************
//
//
//*****************************************************************************
__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 FlashGetProtection(uint32_t address)
{
    uint32_t regOffset;
    uint32_t mask;

    if (address >= FLASH_MAIN_SIZE)
    {
        return FAPI_STATUS_ADDRESS_ERROR;
    }

    if (address < (32 * FLASH_MAIN_SECTOR_SIZE)) // Check for VIMS WEPRA
    {
        mask      = (1 << (address / FLASH_MAIN_SECTOR_SIZE));
        regOffset = VIMS_O_WEPRA;
    }
    else if (address < (256 * FLASH_MAIN_SECTOR_SIZE)) // Check for VIMS WEPRB0
    {
        mask      = (1 << ((address / (8 * FLASH_MAIN_SECTOR_SIZE))));
        regOffset = VIMS_O_WEPRB0;
    }
    else if (address < (512 * FLASH_MAIN_SECTOR_SIZE)) // Check for VIMS WEPRB1
    {
        mask      = (1 << ((address / (8 * FLASH_MAIN_SECTOR_SIZE)) % 32));
        regOffset = VIMS_O_WEPRB1;
    }
    else
    {
        return FAPI_STATUS_ADDRESS_ERROR;
    }

    // VIMS WEPRA, WEPRB0 and WEPRB1 are sticky 0 (0 = active, 1 = inactive).
    if (HWREG(VIMS_BASE + regOffset) & mask)
    {
        return FLASH_NO_PROTECT;
    }

    return FLASH_WRITE_PROTECT;
}

#ifndef DRIVERLIB_NS
//*****************************************************************************
//
// Below functions will only be compiled into the driverlib.a library and not
// the driverlib_ns.a library.
// Non-secure applications might be able to access some/all of these functions
// through veneers declared further below in the #else case.
//
//*****************************************************************************

//*****************************************************************************
//
//
//*****************************************************************************
__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 cchctl                  = HWREG(VIMS_BASE + VIMS_O_CCHCTL);
    // Clear instruction cache
    HWREG(VIMS_BASE + VIMS_O_CCHCTL) = (VIMS_CCHCTL_CCHEN_DIS | VIMS_CCHCTL_LINEN_DIS);

    uint32_t retCode = HapiFlashSectorErase(FLASH_API_KEY, sectorAddress);

    // Restore configuration
    HWREG(VIMS_BASE + VIMS_O_CCHCTL) = cchctl;

    return (retCode);
}

//*****************************************************************************
//
//
//*****************************************************************************
__STATIC_INLINE uint32_t FlashEraseBank(uint32_t bankSelect)
{
    // Store current configuration
    uint32_t cchctl = HWREG(VIMS_BASE + VIMS_O_CCHCTL);

    // Clear instruction cache
    HWREG(VIMS_BASE + VIMS_O_CCHCTL) = (VIMS_CCHCTL_CCHEN_DIS | VIMS_CCHCTL_LINEN_DIS);

    uint32_t retCode = HapiFlashBankErase(FLASH_API_KEY, bankSelect);

    // Restore configuration
    HWREG(VIMS_BASE + VIMS_O_CCHCTL) = cchctl;

    return (retCode);
}

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

    // Clear instruction cache
    HWREG(VIMS_BASE + VIMS_O_CCHCTL) = (VIMS_CCHCTL_CCHEN_DIS | VIMS_CCHCTL_LINEN_DIS);

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

    // Restore configuration
    HWREG(VIMS_BASE + VIMS_O_CCHCTL) = cchctl;

    return (retCode);
}

#else
    //*****************************************************************************
    //
    // Secure-only API functions available from non-secure context through
    // veneers.
    //
    // These functions must be linked in from from the secure veneer library.
    //
    //*****************************************************************************

    // No veneers

#endif

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

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

#endif // __FLASH_H__