# Flash Library Reference

Flash Library Reference.

# Summary

Variables

- FlashLib_Version : Firmware revision code variable.

Macros

- FLASH_FW_VER_MAJOR : Flash library major version number.
- FLASH_FW_VER_MINOR : Flash library minor version number.
- FLASH_FW_VER_REVISION : Flash library revision version number.
- FLASH_FW_VER : Flash library version number, concatenation of all version numbers.
- FLASH0 : Define FLASH0 as the first flash instance, if this is not defined in the headers.
- FLASH_INSTANCE_NUM : Total number of flash instances.
- FLASH_0_DESCR_NUM : Total number of descriptor types in flash 0 (both RSL15 variants).
- RSL15_284_FLASH_SET : Define the set of memories enabled for the RSL15-284 configuration.

Functions

- Flash_Initialize : Initialize clock and access to flash.
- Flash_WriteWord : Write a word to a flash address.
- Flash_WriteBuffer : Write contents of a static memory buffer to flash.
- Flash_WriteDouble : Write a 38-bit word to flash.
- Flash_ReadWord : Read a 32-bit word from flash.
- Flash_ReadBuffer : Read contents of flash into a static memory buffer.
- Flash_ReadDouble : Read a 38-bit word from flash.
- Flash_EraseFlashBank : Erase a single flash bank.
- Flash_EraseChip : Erase all data and code flash.
- Flash_EraseSector : Erase a sector flash.
- Flash_BlankCheck : Check if flash region is blank.

# Detailed Description

This reference chapter presents a detailed description of all the functions in the flash programming and erase support library. This reference includes calling parameters, returned values, and assumptions.

Warning: All functions provided by the flash library should be executed from RAM or ROM, as executing them from flash can result in hidden, flash-access-related failures.