STM8S/A Standard Peripherals Drivers: FLASH_Private_Macros

STM8S/A

STM8S/A Standard Peripherals Drivers
FLASH_Private_Macros

Macros used by the assert function in order to check the different functions parameters. More...

Defines

#define IS_FLASH_ADDRESS_OK(ADDRESS)
 Macro used by the assert function in order to check the different sensitivity values for the data eeprom and flash program Address.
#define IS_FLASH_DATA_ADDRESS_OK(ADDRESS)
 Macro used by the assert function in order to check the different sensitivity values for the data eeprom Address.
#define IS_FLASH_DATA_BLOCK_NUMBER_OK(BLOCKNUM)   ((BLOCKNUM) < FLASH_DATA_BLOCKS_NUMBER)
 Macro used by the assert function in order to check the different sensitivity values for the data eeprom Block number.
#define IS_FLASH_FLAGS_OK(FLAG)
 Macro used by the assert function in order to check the different flags values.
#define IS_FLASH_LOW_POWER_MODE_OK(LPMODE)
 Macro used by the assert function in order to check the different sensitivity values for the low power mode.
#define IS_FLASH_PROG_ADDRESS_OK(ADDRESS)
 Macro used by the assert function in order to check the different sensitivity values for the flash program Address.
#define IS_FLASH_PROG_BLOCK_NUMBER_OK(BLOCKNUM)   ((BLOCKNUM) < FLASH_PROG_BLOCKS_NUMBER)
 Macro used by the assert function in order to check the different sensitivity values for the flash program Block number.
#define IS_FLASH_PROGRAM_MODE_OK(MODE)
 Macro used by the assert function in order to check the different sensitivity values for the flash program mode.
#define IS_FLASH_PROGRAM_TIME_OK(TIME)
 Macro used by the assert function in order to check the program time mode.
#define IS_MEMORY_TYPE_OK(MEMTYPE)
 Macro used by the assert function in order to check the different sensitivity values for the flash memory type.
#define IS_OPTION_BYTE_ADDRESS_OK(ADDRESS)
 Macro used by the assert function in order to check the different sensitivity values for the option bytes Address.

Detailed Description

Macros used by the assert function in order to check the different functions parameters.


Define Documentation

#define IS_FLASH_ADDRESS_OK (   ADDRESS)
Value:
((((ADDRESS) >= FLASH_PROG_START_PHYSICAL_ADDRESS) && ((ADDRESS) <= FLASH_PROG_END_PHYSICAL_ADDRESS)) || \
                                     (((ADDRESS) >= FLASH_DATA_START_PHYSICAL_ADDRESS) && ((ADDRESS) <= FLASH_DATA_END_PHYSICAL_ADDRESS)))

Macro used by the assert function in order to check the different sensitivity values for the data eeprom and flash program Address.

Definition at line 179 of file stm8s_flash.h.

Referenced by FLASH_EraseByte(), FLASH_ProgramByte(), FLASH_ProgramWord(), and FLASH_ReadByte().

#define IS_FLASH_DATA_ADDRESS_OK (   ADDRESS)
Value:
(((ADDRESS) >= FLASH_DATA_START_PHYSICAL_ADDRESS) && \
    ((ADDRESS) <= FLASH_DATA_END_PHYSICAL_ADDRESS))

Macro used by the assert function in order to check the different sensitivity values for the data eeprom Address.

Definition at line 173 of file stm8s_flash.h.

#define IS_FLASH_DATA_BLOCK_NUMBER_OK (   BLOCKNUM)    ((BLOCKNUM) < FLASH_DATA_BLOCKS_NUMBER)

Macro used by the assert function in order to check the different sensitivity values for the data eeprom Block number.

Definition at line 190 of file stm8s_flash.h.

#define IS_FLASH_FLAGS_OK (   FLAG)
Value:
(((FLAG) == FLASH_FLAG_DUL) || \
                                 ((FLAG) == FLASH_FLAG_EOP) || \
                                 ((FLAG) == FLASH_FLAG_PUL) || \
                                 ((FLAG) == FLASH_FLAG_WR_PG_DIS))

Macro used by the assert function in order to check the different flags values.

Definition at line 242 of file stm8s_flash.h.

Referenced by FLASH_GetFlagStatus().

#define IS_FLASH_LOW_POWER_MODE_OK (   LPMODE)
Value:
(((LPMODE) == FLASH_LPMODE_POWERDOWN) || \
    ((LPMODE) == FLASH_LPMODE_STANDBY) || \
    ((LPMODE) == FLASH_LPMODE_POWERDOWN_STANDBY) || \
    ((LPMODE) == FLASH_LPMODE_STANDBY_POWERDOWN))

Macro used by the assert function in order to check the different sensitivity values for the low power mode.

Definition at line 218 of file stm8s_flash.h.

Referenced by FLASH_SetLowPowerMode().

#define IS_FLASH_PROG_ADDRESS_OK (   ADDRESS)
Value:
(((ADDRESS) >= FLASH_PROG_START_PHYSICAL_ADDRESS) && \
    ((ADDRESS) <= FLASH_PROG_END_PHYSICAL_ADDRESS))

Macro used by the assert function in order to check the different sensitivity values for the flash program Address.

Definition at line 166 of file stm8s_flash.h.

#define IS_FLASH_PROG_BLOCK_NUMBER_OK (   BLOCKNUM)    ((BLOCKNUM) < FLASH_PROG_BLOCKS_NUMBER)

Macro used by the assert function in order to check the different sensitivity values for the flash program Block number.

Definition at line 185 of file stm8s_flash.h.

#define IS_FLASH_PROGRAM_MODE_OK (   MODE)
Value:
(((MODE) == FLASH_PROGRAMMODE_STANDARD) || \
                                        ((MODE) == FLASH_PROGRAMMODE_FAST))

Macro used by the assert function in order to check the different sensitivity values for the flash program mode.

Definition at line 203 of file stm8s_flash.h.

#define IS_FLASH_PROGRAM_TIME_OK (   TIME)
Value:
(((TIME) == FLASH_PROGRAMTIME_STANDARD) || \
                                        ((TIME) == FLASH_PROGRAMTIME_TPROG))

Macro used by the assert function in order to check the program time mode.

Definition at line 210 of file stm8s_flash.h.

Referenced by FLASH_SetProgrammingTime().

#define IS_MEMORY_TYPE_OK (   MEMTYPE)
Value:
(((MEMTYPE) == FLASH_MEMTYPE_PROG) || \
                                    ((MEMTYPE) == FLASH_MEMTYPE_DATA))

Macro used by the assert function in order to check the different sensitivity values for the flash memory type.

Definition at line 196 of file stm8s_flash.h.

Referenced by FLASH_Lock(), and FLASH_Unlock().

#define IS_OPTION_BYTE_ADDRESS_OK (   ADDRESS)
Value:

Macro used by the assert function in order to check the different sensitivity values for the option bytes Address.

Definition at line 227 of file stm8s_flash.h.

Referenced by FLASH_EraseOptionByte(), FLASH_ProgramOptionByte(), and FLASH_ReadOptionByte().

STM8 Standard Peripherals Library: Footer

 

 

 

      For complete documentation on STM8 8-bit Microcontrollers platform visit www.st.com