docs/hal_html/hal__flash_8h_source.html

#ifndef HAL_FLASH_H

#define HAL_FLASH_H


#include "hal_common.h"


#if defined(__cplusplus)

extern "C" {

#endif /* __cplusplus */


#define FCTR_IRQ_STS_SET_RESULT_FLAGS                      \

    (FCTR_IRQ_STATUS_SET_READ_OVERFLOW_IRQ_STS_SET_Msk     \

        | FCTR_IRQ_STATUS_SET_CMD_REJECT_IRQ_STS_SET_Msk   \

        | FCTR_IRQ_STATUS_SET_CMD_FAIL_IRQ_STS_SET_Msk     \

        | FCTR_IRQ_STATUS_SET_CMD_SUCCESS_IRQ_STS_SET_Msk)


#define FCTR_IRQ_STS_CLR_SUCCESS_FLAGS                     \

    (FCTR_IRQ_STATUS_CLR_CMD_SUCCESS_IRQ_STS_CLR_Msk       \

        | FCTR_IRQ_STATUS_CLR_CMD_ACCEPT_IRQ_STS_CLR_Msk)


#define FCTR_CMD_READ       (0x1)

#define FCTR_CMD_WRITE      (0x2)

#define FCTR_CMD_ROW_WRITE  (0x3)

#define FCTR_CMD_ERASE      (0x4)

#define FCTR_CMD_MASS_ERASE (0x7)


enum flash_status {

    FLASH_Status_Ok                     = 0,

    FLASH_Status_InvalidArgument        = 1,

    FLASH_Status_CheckError             = 2,

    FLASH_Status_VerifyError            = 3,

    FLASH_Status_ConfigureError         = 4,

    FLASH_Status_AddressAlignmentError  = 5,

    FLASH_Status_AddressOutOfRange      = 6,

};


enum flash_region {

    FLASH_MainRegion    = FLASH_BASE_ADDR,

    FLASH_SystemRegion  = FLASH_BASE_ADDR

        + FLASH_SYSTEM_REGION_OFFSET,

};


#define FLASH_TEST_ADDRESSES(address, length) \

    ( \

        /* Проверка на выравнивание по слову. */\

        ((address & FLASH_WORD_ALIGN_Msk) > 0x0U) \

        || ( \

            /* Проверка на выравнивание по странице. */\

            ((length & FLASH_PAGE_ALIGN_Msk) == 0x0U) \

            && ( \

                ( \

                    (((address + length) & \

                            FLASH_PAGE_ALIGN_Msk) > 0x0U) \

                    && ((address & FLASH_PAGE_ALIGN_Msk) == 0x0U) \

                ) \

                || ((address & FLASH_PAGE_ALIGN_Msk) > 0x0U) \

            ) \

        ) \

    ) ? FLASH_Status_AddressAlignmentError : \

    ( \

        ( \

            /* Проверка попадания в основной раздел. */\

            (address >= FLASH_BASE_ADDR) \

            && ((address + length) \

                <= FLASH_BASE_ADDR + FLASH_MAIN_REGION_SIZE_IN_BYTE) \

        ) ? FLASH_Status_Ok : \

        ( \

            ( \

                /* Проверка попадания в системный раздел. */\

                (address >= FLASH_BASE_ADDR \

                    + FLASH_SYSTEM_REGION_OFFSET) \

                && ((address + length) <= FLASH_BASE_ADDR \

                    + FLASH_SYSTEM_REGION_OFFSET \

                    + FLASH_SYSTEM_REGION_SIZE_IN_BYTE) \

            ) ? FLASH_Status_Ok : FLASH_Status_AddressOutOfRange \

        ) \

    )


enum flash_status FLASH_Init(FCTR_Type *base);


enum flash_status FLASH_WriteWord(FCTR_Type *base, uint32_t addr,

    uint32_t data);


enum flash_status FLASH_Program(FCTR_Type *base, uint32_t *addr, uint32_t *src,

    uint32_t length);


enum flash_status FLASH_VerifyProgram(uint32_t *addr, uint32_t length,

    uint32_t *expected_data, uint32_t *failed_address, uint32_t *failed_data);


enum flash_status FLASH_Erase(FCTR_Type *base, uint32_t *addr,

    uint32_t length);


enum flash_status FLASH_MassErase(FCTR_Type *base, enum flash_region region);


enum flash_status FLASH_VerifyErase(uint32_t *addr, uint32_t length);


enum flash_status FLASH_Read(uint32_t *addr, uint32_t *dest, uint32_t length);


#if defined(__cplusplus)

}

#endif /* __cplusplus */


#endif /* HAL_FLASH_H */


FLASH_Init
enum flash_status FLASH_Init(FCTR_Type *base)
Инициализация накристалльной FLASH-памяти.

FLASH_WriteWord
enum flash_status FLASH_WriteWord(FCTR_Type *base, uint32_t addr, uint32_t data)
Запись 32-битного слова во встроенную FLASH-память.

FLASH_Program
enum flash_status FLASH_Program(FCTR_Type *base, uint32_t *addr, uint32_t *src, uint32_t length)
Запись данных во встроенную FLASH-память.

FLASH_Erase
enum flash_status FLASH_Erase(FCTR_Type *base, uint32_t *addr, uint32_t length)
Стирание сектора накристалльной FLASH-памяти.

FLASH_Read
enum flash_status FLASH_Read(uint32_t *addr, uint32_t *dest, uint32_t length)
Чтение данных из накристалльной FLASH-памяти.

FLASH_MassErase
enum flash_status FLASH_MassErase(FCTR_Type *base, enum flash_region region)
Стирание раздела накристалльной FLASH-памяти.

FLASH_VerifyProgram
enum flash_status FLASH_VerifyProgram(uint32_t *addr, uint32_t length, uint32_t *expected_data, uint32_t *failed_address, uint32_t *failed_data)
Проверка корректности данных, записанных во внутреннюю FLASH-память.

FLASH_VerifyErase
enum flash_status FLASH_VerifyErase(uint32_t *addr, uint32_t length)
Проверка корректности стирания данных накристалльной FLASH-памяти.

flash_status
flash_status
Статусы драйвера модуля FLASH.
Definition hal_flash.h:57

flash_region
flash_region
Регионы накристалльной FLASH-памяти.
Definition hal_flash.h:70

FLASH_Status_ConfigureError
@ FLASH_Status_ConfigureError
Definition hal_flash.h:62

FLASH_Status_CheckError
@ FLASH_Status_CheckError
Definition hal_flash.h:60

FLASH_Status_VerifyError
@ FLASH_Status_VerifyError
Definition hal_flash.h:61

FLASH_Status_AddressAlignmentError
@ FLASH_Status_AddressAlignmentError
Definition hal_flash.h:63

FLASH_Status_AddressOutOfRange
@ FLASH_Status_AddressOutOfRange
Definition hal_flash.h:64

FLASH_Status_Ok
@ FLASH_Status_Ok
Definition hal_flash.h:58

FLASH_Status_InvalidArgument
@ FLASH_Status_InvalidArgument
Definition hal_flash.h:59

FLASH_MainRegion
@ FLASH_MainRegion
Definition hal_flash.h:71

FLASH_SystemRegion
@ FLASH_SystemRegion
Definition hal_flash.h:72