FlashWFF3.h

Go to the documentation of this file.

/*
 *  Copyright (c) 2024-2025 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.
 *
 */

/*
 *  ========== FlashWFF3.h ==========
 */

#ifndef ti_drivers_nvs_flash_FlashWFF3__include
#define ti_drivers_nvs_flash_FlashWFF3__include

#include <stdint.h>
#include <string.h>
#include <ti/devices/DeviceFamily.h>
#include DeviceFamily_constructPath(driverlib/xip.h)
#include DeviceFamily_constructPath(driverlib/ospi.h)
#include DeviceFamily_constructPath(driverlib/debug.h)

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

/*
 * Values that can be returned from the API functions
 */
#define FLASH_STATUS_SUCCESS         0x00000000 
#define FLASH_TIMEOUT_REACHED_ERROR  (-1300)    
#define PSRAM_XIP_OFFSET             (0x100)    
#define DEVICE_SWITCH_ERROR          (-1)
/*
 * Configuration values that should be passed to #XIPStartUDMATransaction()
 * as the directionMode parameter.
 */
#define FLASH_WR_BOUND_SIZE_IN_BYTES 64U

#define FLASH_RD_BOUND_SIZE_IN_BYTES 256U

/* Defines supports bit manipulation macros #BITMASK_x_0() & #BITMASK_x_y() */
#define __IF__(x)   (x)
#define __THEN__(x) ? (x)
#define __ELSE__(x)     : (x)
#define __ELSE_IF__(x)  : (x)

#define OSPI_IDLE_XSPI_COUNTER_BEFORE_TIMEOUT 100

#define BITMASK_x_0(x)                                                                 \
    (__IF__((x) == 31)               /* For x==31, we immediately return 0xFFFFFFFF */ \
     __THEN__(0xFFFFFFFF)            /* For other x, we return 2^(x+1) - 1.         */ \
     __ELSE__((1 << ((x) + 1)) - 1)) // MACRO BITMASK_x_0() //

#define BITMASK_x_y(x, y)                                                                             \
    (__IF__((y) == 0)                               /* For y==0, we return Bits[x:0]               */ \
     __THEN__(BITMASK_x_0(x))                       /* For y> 0, we return Bits[x:0] - Bits[y-1:0] */ \
     __ELSE__(BITMASK_x_0(x) - BITMASK_x_0((y)-1))) // MACRO BITMASK_x_y(). //

typedef enum
{
    FLASH_OTFDE_DISABLE = 0, 
    FLASH_OTFDE_ENABLE  = 1  
} FlashOtfdeStateSet;

typedef enum
{
    FLASH_UDMA_JOB_DONE  = 0, 
    FLASH_UDMA_JOB_ERROR = 1  
} FlashUdmaJobStatus;

/* STIG status */
typedef enum
{
    FLASH_STIG_DONE    = 0, 
    FLASH_STIG_TIMEOUT = 1, 
    FLASH_STIG_ERROR   = 2  
} FlashStigStatus;

/* STIG configuration operation types */
#define FLASH_STIG_CONFIG_ENTER         0
#define FLASH_STIG_CONFIG_EXIT          1
#define FLASH_STIG_CONFIG_PRE_READ      2
#define FLASH_STIG_CONFIG_EXECUTE_READ  3
#define FLASH_STIG_CONFIG_POST_READ     4
#define FLASH_STIG_CONFIG_PRE_WRITE     5
#define FLASH_STIG_CONFIG_EXECUTE_WRITE 6
#define FLASH_STIG_CONFIG_POST_WRITE    7
#define FLASH_STIG_CONFIG_PRE_ERASE     8
#define FLASH_STIG_CONFIG_EXECUTE_ERASE 9
#define FLASH_STIG_CONFIG_POST_ERASE    10

/*
 *Functions
 */

void FlashRead(uint32_t *readFromAddr, uint32_t *writeToAddr, uint32_t length);

FlashStigStatus FlashReadSTIG(uint32_t readStartAddr, uint32_t *writeToAddr, uint8_t DeviceNum);

FlashStigStatus FlashExecuteReadSTIGCommand(uint32_t srcReadAddr, uint32_t *writeToAddr);

void FlashWrite(uint32_t *readFromAddr, uint32_t *writeToAddr, uint32_t length);

FlashStigStatus FlashWriteSTIG(uint32_t *readFromAddr, uint32_t *writeToAddr, uint8_t DeviceNum);

FlashStigStatus FlashExecuteWriteSTIGCommand(uint32_t srcWriteData, uint32_t srcWriteAddrPhy);

void FlashSetOTFDE(uint8_t setState);

uint32_t FlashExecutePolling(void);

FlashStigStatus FlashExecuteEraseSTIGCommand(uint32_t EraseAddr_en, uint32_t srcEraseAddr);

FlashStigStatus FlashSectorErase(uint32_t eraseStartAddr, uint8_t DeviceNum);

void FlashSetTickPeriod(uint32_t TickPeriod);

uint32_t FlashIsXspiIdle();
#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_nvs_flash_FlashWFF3__include */