flash.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2021-2023 Texas Instruments Incorporated
 *
 *  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.
 */
 
#ifndef FLASH_H_
#define FLASH_H_
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include <stdint.h>
#include <kernel/dpl/SystemP.h>
#include <drivers/hw_include/soc_config.h>
#include <board/flash/flash_config.h>
#include <kernel/dpl/SemaphoreP.h>
 
#define FLASH_INVALID_VALUE (0xFFFFFFFFU)
 
#define CONFIG_FLASH_TYPE_SERIAL            ((uint32_t)0x1)
#define CONFIG_FLASH_TYPE_PARALLEL          ((uint32_t)0x2)
 
#define CONFIG_FLASH_TYPE_SERIAL_NOR               (0x00U)
#define CONFIG_FLASH_TYPE_SERIAL_NAND              (0x01U)
#define CONFIG_FLASH_TYPE_PARALLEL_NOR             (0x02U)
#define CONFIG_FLASH_TYPE_PARALLEL_NAND            (0x03U)
#define CONFIG_FLASH_TYPE_INVALID                  (0xFFU)
 
#define FLASH_NOR_UPDATE_RD_DUMMY_VALUE     (1U)
#define FLASH_NAND_UPDATE_RD_DUMMY_VALUE     (0U)
 
typedef void  *Flash_Handle;
 
typedef struct Flash_Config_s Flash_Config;
 
typedef struct Flash_Params_s Flash_Params;
 
typedef struct Flash_DevConfig_s {
 
    uint8_t  cmdExtType;
    uint8_t  byteOrder;
    uint8_t  enable4BAddr;
    uint8_t  addrByteSupport;
 
    uint8_t  fourByteAddrEnSeq;
    uint8_t  cmdWren;
    uint8_t  cmdRdsr;
    uint8_t  cmdWrsr;
    uint8_t  cmdPageLoad;
    uint8_t  cmdPageProg;
    uint8_t  srWip;
 
    uint8_t  cmdPageLoadCyc1;
    uint8_t  cmdPageLoadCyc2;
    uint8_t  cmdRandomReadCyc1;
    uint8_t  cmdRandomReadCyc2;
    uint8_t  cmdRandomInput;
    uint8_t  cmdPageProgCyc1;
    uint8_t  cmdPageProgCyc2;
    uint8_t  pageColAddrCyc;
    uint8_t  pageRowAddrCyc;
    uint8_t  cmdReadStatus;
    uint8_t  cmdReset;
 
 
    uint8_t  srWel;
    uint8_t  resetType;
    uint8_t  deviceBusyType;
    uint8_t  xspiWipRdCmd;
 
    uint32_t srWipReg;
    uint32_t xspiWipReg;
    uint32_t xspiWipBit;
    uint32_t xspiRdsrDummy;
    uint32_t flashWriteTimeout;
    uint32_t flashBusyTimeout;
 
    FlashCfg_EraseConfig eraseCfg;
    FlashCfg_ReadIDConfig idCfg;
    FlashCfg_ProtoEnConfig protocolCfg;
 
    uint32_t progStatusReg;
    uint32_t xspiProgStatusReg;
    uint32_t eraseStatusReg;
    uint32_t xspiEraseStatusReg;
    uint8_t  srProgStatus;
    uint8_t  srEraseStatus;
    uint8_t  srWriteProtectReg;
    uint8_t  srWriteProtectMask;
 
} Flash_DevConfig;
 
typedef int32_t (*Flash_OpenFxn)(Flash_Config *config, Flash_Params *params);
 
typedef void (*Flash_CloseFxn)(Flash_Config *config);
 
typedef int32_t (*Flash_ReadFxn)(Flash_Config *config, uint32_t offset,
                                   uint8_t *buf, uint32_t len) ;
 
typedef int32_t (*Flash_WriteFxn)(Flash_Config *config, uint32_t offset,
                                   uint8_t *buf, uint32_t len) ;
 
typedef int32_t (*Flash_EraseFxn)(Flash_Config *config, uint32_t blockNum);
 
typedef int32_t (*Flash_EraseSectorFxn)(Flash_Config *config, uint32_t sectorNum);
 
typedef int32_t (*Flash_ResetFxn)(Flash_Config *config);
 
typedef int32_t (*Flash_EnablePhyPipelineFxn)(Flash_Config *config);
 
typedef int32_t (*Flash_DisablePhyPipelineFxn)(Flash_Config *config);
 
typedef int32_t (*Flash_quirksFxn)(Flash_Config *config);
 
typedef int32_t (*Flash_custProtocolFxn)(Flash_Config *config);
 
typedef struct Flash_Params_s {
 
    Flash_quirksFxn quirksFxn;
    Flash_custProtocolFxn custProtoFxn;
 
} Flash_Params;
 
typedef struct Flash_Fxns_s
{
    Flash_OpenFxn  openFxn;  
    Flash_CloseFxn closeFxn; 
    Flash_ReadFxn  readFxn;  
    Flash_WriteFxn writeFxn; 
    Flash_EraseFxn eraseFxn; 
    Flash_EraseSectorFxn eraseSectorFxn; 
    Flash_ResetFxn resetFxn; 
    Flash_EnablePhyPipelineFxn enablePhyPipelineFxn; 
    Flash_DisablePhyPipelineFxn disablePhyPipelineFxn; 
} Flash_Fxns;
 
typedef struct Flash_Attrs_s {
 
    uint32_t flashType;      
    char *flashName;         
    uint32_t deviceId;       
    uint32_t manufacturerId; 
    uint32_t driverInstance; 
    uint32_t flashSize;      
    uint32_t blockCount;     
    uint32_t blockSize;      
    uint32_t pageCount;      
    uint32_t pageSize;       
    uint32_t sectorCount;    
    uint32_t sectorSize;     
    uint32_t spareAreaSize;  
} Flash_Attrs;
 
typedef struct Flash_Config_s
{
    Flash_Attrs                *attrs;          
    Flash_Fxns                 *fxns;           
    Flash_DevConfig            *devConfig;      
    void                       *object;         
    SemaphoreP_Object          lockSem;         
} Flash_Config;
 
/* Flash specific includes */
#if defined (DRV_VERSION_SERIAL_FLASH_V0)
#include <board/flash/ospi/flash_nor_ospi.h>
#include <board/flash/ospi/flash_nand_ospi.h>
#endif
 
#if defined (DRV_VERSION_SERIAL_FLASH_V1)
#include <board/flash/qspi/flash_nor_qspi.h>
#endif
 
#if defined (DRV_VERSION_PARALLEL_FLASH_V0)
#include <board/flash/gpmc/flash_nand_gpmc.h>
#endif
 
void Flash_Params_init(Flash_Params *params);
 
Flash_Handle Flash_open(uint32_t instanceId, Flash_Params *params);
 
void Flash_close(Flash_Handle handle);
 
Flash_Handle Flash_getHandle(uint32_t instanceId);
 
int32_t Flash_read(Flash_Handle handle, uint32_t offset, uint8_t *buf, uint32_t len);
 
int32_t Flash_write(Flash_Handle handle, uint32_t offset, uint8_t *buf, uint32_t len);
 
int32_t Flash_blkPageToOffset(Flash_Handle handle, uint32_t *offset, uint32_t block, uint32_t page);
 
int32_t Flash_offsetToBlkPage(Flash_Handle handle, uint32_t  offset, uint32_t *block, uint32_t *page);
 
int32_t Flash_SectorPageToOffset(Flash_Handle handle, uint32_t *offset, uint32_t sector, uint32_t page);
 
int32_t Flash_offsetToSectorPage(Flash_Handle handle, uint32_t  offset, uint32_t *sector, uint32_t *page);
 
int32_t Flash_eraseBlk(Flash_Handle handle, uint32_t blockNum);
 
int32_t Flash_eraseSector(Flash_Handle handle, uint32_t sectorNum);
 
int32_t Flash_reset(Flash_Handle handle);
 
int32_t Flash_enablePhyPipeline(Flash_Handle handle);
 
int32_t Flash_disablePhyPipeline(Flash_Handle handle);
 
uint32_t Flash_getPhyTuningOffset(Flash_Handle handle);
 
Flash_Attrs *Flash_getAttrs(uint32_t instanceId);
 
uint32_t Flash_getFlashInterfaceIndex(uint32_t flashType);
 
void Flash_init(void);
 
void Flash_deinit(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* FLASH_H_ */