flash_interface.h

Go to the documentation of this file.

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

 @file flash_interface

    @brief An interface that abstracts flash operations for OAD
           this allows on-chip and off-chip OAD to use the same flash APIs

 Group: WCS, BTS
 $Target Device: DEVICES $

 ******************************************************************************
 $License: BSD3 2017 $
 ******************************************************************************
 $Release Name: PACKAGE NAME $
 $Release Date: PACKAGE RELEASE DATE $
 *****************************************************************************/

#ifndef FLASH_INTERFACE
#define FLASH_INTERFACE

#ifdef __cplusplus
extern "C"
{
#endif

/*********************************************************************
 * INCLUDES
 */
#include <string.h>
#include <stdlib.h>
#include <stdbool.h>
#include <stdint.h>

#include <ti/devices/DeviceFamily.h>
#include DeviceFamily_constructPath(driverlib/flash.h)

/*********************************************************************
 * CONSTANTS
 */

#define FLASH_SUCCESS   0x00

#define FLASH_FAILURE   0xFF

#define SPI_MAX_READ_SZ 1024

/*********************************************************************
 * MACROS
 */
#if defined(CC26XX_R2)
    #define FLASH_ADDRESS(page, offset)     (((page) << 12) + (offset))
    #define FLASH_PAGE(addr)                (addr >> 12)
    #define INTFLASH_PAGE_MASK              0xFFFFF000
    #define INTFLASH_PAGE_SIZE              0x1000
    #define MAX_ONCHIP_FLASH_PAGES          32
    #define MAX_OFFCHIP_METADATA_PAGES      MAX_ONCHIP_FLASH_PAGES
#elif defined(DeviceFamily_CC26X2) || defined(DeviceFamily_CC13X2) || \
      defined(DeviceFamily_CC26X2X7) || defined(DeviceFamily_CC13X2X7) || \
      defined(DeviceFamily_CC26X1) || defined(DeviceFamily_CC13X1)
    #define FLASH_ADDRESS(page, offset)     (((page) << 13) + (offset))
    #define FLASH_PAGE(addr)                (addr >> 13)
    #define INTFLASH_PAGE_MASK              0xFFFFE000
    #define INTFLASH_PAGE_SIZE              0x2000
    #if defined(DeviceFamily_CC26X2X7) || defined(DeviceFamily_CC13X2X7)
        #define MAX_ONCHIP_FLASH_PAGES          88
    #else
        #define MAX_ONCHIP_FLASH_PAGES          44
    #endif
    #define MAX_OFFCHIP_METADATA_PAGES      MAX_ONCHIP_FLASH_PAGES
#elif defined(DeviceFamily_CC13X4) || defined(DeviceFamily_CC26X4) ||  \
      defined(DeviceFamily_CC26X3) || defined(DeviceFamily_CC23X0R5) || \
      defined(DeviceFamily_CC23X0R2)
    #define FLASH_ADDRESS(page, offset)     (((page) << 11) + (offset))
    #define FLASH_PAGE(addr)                (addr >> 11)
    #define INTFLASH_PAGE_MASK              0xFFFFF800
    #define INTFLASH_PAGE_SIZE              0x800
    #if defined(DeviceFamily_CC23X0R5)
        #define MAX_ONCHIP_FLASH_PAGES          256
    #elif defined(DeviceFamily_CC23X0R2)
        #define MAX_ONCHIP_FLASH_PAGES          128
    #else
        #define MAX_ONCHIP_FLASH_PAGES          512
    #endif
    #define MAX_OFFCHIP_METADATA_PAGES      MAX_ONCHIP_FLASH_PAGES
#else
    #error
#endif

#define EXT_FLASH_ADDRESS(page, offset)     (((page) << 12) + (offset))

#define EXT_FLASH_PAGE(addr)                (addr >> 12)

#define EXTFLASH_PAGE_MASK                  0xFFFFF000

#define EFL_PAGE_SIZE                       0x1000

#define EFL_FLASH_SIZE                      0x100000

extern void flash_init(void);

extern bool flash_open(void);

extern void flash_close(void);

extern bool hasExternalFlash(void);

extern uint8_t readFlash(uint_least32_t addr, uint8_t *pBuf, size_t len);

extern uint8_t readFlashPg(uint8_t page, uint32_t offset, uint8_t *pBuf,
                            uint16_t len);

extern uint8_t writeFlash(uint_least32_t addr, uint8_t *pBuf, size_t len);

extern uint8_t writeFlashPg(uint8_t page, uint32_t offset, uint8_t *pBuf,
                            uint16_t len);

extern uint8_t eraseFlashPg(uint8_t page);

extern uint8_t eraseFlash(uint8_t page);

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

#ifdef __cplusplus
}
#endif

#endif /* FLASH_INTERFACE */