SystemPeripherals_Flash.h

Go to the documentation of this file.

// (c) IMT - Information Management Technology AG, CH-9470 Buchs, www.imt.ch.
 
#ifndef SYSTEMPERIPHERALS_FLASH_H
#define SYSTEMPERIPHERALS_FLASH_H
 
#include <Imt.Base.Core.Platform/Platform.h>
 
#include "SystemMemoryMap.h"
 
// Determine if a C++ compiler is being used.  If so, ensure that standard C is used to process the API information.
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
 
typedef enum {
    FLASH_BUSY = 1,
    FLASH_ERROR_PG,
    FLASH_ERROR_WRP,
    FLASH_ERROR_READ,
    FLASH_COMPLETE,
    FLASH_TIMEOUT
} FLASH_Status;
 
typedef enum {
    // FLASH Zero Latency cycle
    FLASH_Latency_0 = ((uint32_t)0x00000000U),
    // FLASH One Latency cycle
    FLASH_Latency_1 = ((uint32_t)0x00000001U),
    // FLASH Two Latency cycles
    FLASH_Latency_2 = ((uint32_t)0x00000002U)
} FLASH_Latency;
 
typedef enum {
    // FLASH Half Cycle Enable
    FLASH_HalfCycleAccess_Enable = ((uint32_t)0x00000008U),
    // FLASH Half Cycle Disable
    FLASH_HalfCycleAccess_Disable = ((uint32_t)0x00000000U)
} FLASH_HalfCycleAccess;
 
typedef enum {
    // FLASH Prefetch Buffer Enable
    FLASH_PrefetchBuffer_Enable = ((uint32_t)0x00000010U),
    // FLASH Prefetch Buffer Disable
    FLASH_PrefetchBuffer_Disable = ((uint32_t)0x00000000U),
} FLASH_PrefetchBuffer;
 
typedef enum {
    // FLASH error interrupt generated on FPEC error
    FLASH_Irq_Error = ((uint32_t)0x00000400U),
    // FLASH EOP interrupt
    FLASH_Irq_EndOfOperation = ((uint32_t)0x00001000U),
} FLASH_Irq;
 
static uint32_t const FLASH_FLAG_BSY = 0x00000001U;
 
static uint32_t const FLASH_FLAG_EOP = 0x00000020U;
 
static uint32_t const FLASH_FLAG_PGERR = 0x00000004U;
 
static uint32_t const FLASH_FLAG_WRPRTERR = 0x00000010U;
 
static uint32_t const FLASH_FLAG_OPTERR = 0x00000001U;
 
void FLASH_SetLatency(FLASH_Latency const latency);
 
void FLASH_HalfCycleAccessCmd(FLASH_HalfCycleAccess const halfCycleAccess);
 
void FLASH_PrefetchBufferCmd(FLASH_PrefetchBuffer const prefetchBuffer);
 
void FLASH_EnableInterrupt(FLASH_Irq const irq, bool const doEnable);
 
void FLASH_Unlock();
 
void FLASH_Lock();
 
FLASH_Status FLASH_ErasePage(uint32_t const pageAddress);
 
FLASH_Status FLASH_ErasePageAsync(uint32_t const pageAddress);
 
void FLASH_ErasePageFinish();
 
FLASH_Status FLASH_ProgramDoubleWord(uint32_t const address, uint32_t const data);
 
bool FLASH_ProgramWordAsync(uint32_t const address, uint16_t const data);
 
void FLASH_ProgramWordFinish();
 
bool FLASH_IsFlag(uint32_t const flag);
 
void FLASH_ClearFlag(uint32_t const flag);
 
FLASH_Status FLASH_GetStatus();
 
FLASH_Status FLASH_WaitForLastOperation(uint32_t const timeout);
 
FLASH_Status FLASH_ReadBlock(uint32_t const address, uint8_t* pBuffer, uint32_t const bufferSize);
 
#ifdef __cplusplus
}
#endif // __cplusplus
#endif // SYSTEMPERIPHERALS_FLASH_H