XMEMWFF3.h

Go to the documentation of this file.

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

/*
 * ========== XMEMWFF3.h ==========
 */
#ifndef ti_drivers_xmem_XMEMWFF3__include
#define ti_drivers_xmem_XMEMWFF3__include

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

#if defined(__cplusplus)
extern "C" {
#endif

#define XMEM_FLASH 0
#define XMEM_PSRAM 1

#define XMEM_WORD_SIZE 4

#define CONFIG_XMEM_COUNT 1

#define XMEM_NUM_HANDLER 16

#define XMEM_STATUS_SUCCESS (0)

#define XMEM_STATUS_ERROR (-1)

#define XMEM_STATUS_TIMEOUT (-3)

#define XMEM_STATUS_INV_OFFSET (-4)

#define XMEM_STATUS_INV_ALIGNMENT (-5)

#define XMEM_STATUS_INV_SIZE (-6)

#define XMEM_STATUS_INV_WRITE (-7)

#define XMEM_STATUS_VERIFYBUFFER (-8)

#define XMEM_STATUS_INVALID_PARAMS (-9)

#define XMEM_READ (0x0)

#define XMEM_READ_STIG (0x1)

#define XMEM_WRITE (0x0)

#define XMEM_WRITE_ERASE (0x1)

#define XMEM_WRITE_PRE_VERIFY (0x2)

#define XMEM_WRITE_POST_VERIFY (0x4)

#define XMEM_WRITE_STIG (0x8)

typedef struct
{
    uint32_t address; 
    uint32_t data;    
} FlashRegister;

typedef struct
{
    uint32_t preStigCfg;                
    uint32_t StigCfg;                   
    uint32_t postStigCfg;               
    FlashRegister preStigOperation[1];  
    FlashRegister stigOperation[1];     
    FlashRegister postStigOperation[1]; 
} FlashStigEraseCfg;

typedef struct
{
    uint32_t preStigCfg;                
    uint32_t postStigCfg;               
    FlashRegister preStigOperation[1];  
    FlashRegister stigOperation[1];     
    FlashRegister postStigOperation[1]; 
} FlashStigWriteCfg;

typedef struct
{
    uint32_t preStigCfg;                
    uint32_t postStigCfg;               
    FlashRegister preStigOperation[1];  
    FlashRegister stigOperation[1];     
    FlashRegister postStigOperation[1]; 
} FlashStigReadCfg;

typedef struct
{
    uint32_t NumOfIteration; 
    uint32_t command;        
    uint32_t timeOut;        
    uint32_t polarity;       
    uint32_t mask;           
} FlashPollingCfg;

typedef struct
{
    FlashRegister enterStigCfg[3];  
    FlashStigReadCfg readStigCfg;   
    FlashStigWriteCfg writeStigCfg; 
    FlashStigEraseCfg eraseStigCfg; 
    FlashRegister exitStigCfg[3];   
    FlashPollingCfg pollingCfg;     
    size_t sectorSize;              
    size_t verifyBufSize;           
} FlashType;

typedef struct
{
    FlashType flashType; 
} XMEMWFF3_HWAttrs;

typedef struct
{
    bool opened;            
    uintptr_t mutexKey;     
    size_t regionBase;      
    size_t regionStartAddr; 
    size_t regionSize;      
    size_t deviceNum;       
} XMEMWFF3_Object;

typedef struct
{
    FlashType flashType; 
} XMEM_Attrs;

typedef struct XMEM_Config_ *XMEM_Handle;

typedef struct XMEM_Config_
{
    void *object;

    const void *hwAttrs;
} XMEM_Config;

typedef struct
{
    size_t regionBase;      
    size_t regionStartAddr; 
    size_t regionSize;      
    uint8_t deviceNum;      
} XMEM_Params;

typedef enum
{
    IS25WJ032F_IDX    = 0,
    IS25WJ064F_IDX    = 1,
    W25Q32JW_IDX      = 2,
    W25Q64JW_IDX      = 3,
    GD25LF32ETJGY_IDX = 4,
    GD25LF64ETJGY_IDX = 5,
    PY25Q32LB_IDX     = 6,
    PY25Q64LB_IDX     = 7,
    PY25Q128LA_IDX    = 8,
    PY25Q256LC_IDX    = 9,
    MX25U3235F_IDX    = 10,
    MX25U6435F_IDX    = 11,
    IS25WJ128F_IDX    = 12,
    W25Q12PW_IDX      = 13,
} XMEM_Flash_Idx;

int_fast16_t XMEMWFF3_close(XMEM_Handle handle);

int_fast16_t XMEMWFF3_erase(XMEM_Handle handle, size_t offset, size_t size);

void XMEMWFF3_getAttrs(XMEM_Handle handle, XMEM_Attrs *attrs);

void XMEMWFF3_getObject(XMEM_Handle handle, XMEMWFF3_Object *object);

uint8_t XMEMWFF3_getActiveHandlers(void);

void XMEMWFF3_init(void);

int_fast16_t XMEMWFF3_lock(XMEM_Handle handle, uint32_t timeout);

XMEM_Handle XMEMWFF3_open(XMEM_Params *params);

int_fast16_t XMEMWFF3_read(XMEM_Handle handle, size_t offset, void *buffer, size_t bufferSize, uint_fast16_t flags);

void XMEMWFF3_unlock(XMEM_Handle handle);

int_fast16_t XMEMWFF3_write(XMEM_Handle handle, size_t offset, void *buffer, size_t bufferSize, uint_fast16_t flags);

#if defined(__cplusplus)
}
#endif /* defined (__cplusplus) */

#endif /* ti_drivers_xmem_XMEMWFF3__include */