|
MotorWare f2806x Driver API Documentation
|
Data Structures | |
| struct | _FLASH_Obj_ |
| Defines the flash (FLASH) object. More... | |
Macros | |
| #define | FLASH_BASE_ADDR (0x00000A80) |
| Defines the base address of the flash (FLASH) registers. More... | |
| #define | FLASH_ACTIVE_WAIT_COUNT_DEFAULT (0x01FF) |
| Defines the default active wait count in units of SYSCLKOUT cycles. More... | |
| #define | FLASH_STANDBY_WAIT_COUNT_DEFAULT (0x01FF) |
| Defines the default standby wait count in units of SYSCLKOUT cycles. More... | |
| #define | FLASH_FOPT_ENPIPE_BITS (1 << 0) |
| Defines the location of the ENPIPE bits in the FOPT register. More... | |
| #define | FLASH_FACTIVEWAIT_ACTIVEWAIT_BITS (255 << 0) |
| Defines the location of the ACTIVEWAIT bits in the FACTIVEWAIT register. More... | |
| #define | FLASH_FBANKWAIT_RANDWAIT_BITS (15 << 0) |
| Defines the location of the RANDWAIT bits in the FBANKWAIT register. More... | |
| #define | FLASH_FBANKWAIT_PAGEWAIT_BITS (15 << 8) |
| Defines the location of the PAGEWAIT bits in the FBANKWAIT register. More... | |
| #define | FLASH_FOTPWAIT_OTPWAIT_BITS (31 << 0) |
| Defines the location of the OTPWAIT bits in the FOTPWAIT register. More... | |
| #define | FLASH_FPWR_PWR_BITS (3 << 0) |
| Defines the location of the PWR bits in the FPWR register. More... | |
| #define | FLASH_FSTATUS_PWRS_BITS (3 << 0) |
| Defines the location of the PWRS bits in the FSTATUS register. More... | |
| #define | FLASH_FSTATUS_STDBYWAITS_BITS (1 << 2) |
| Defines the location of the STDBYWAITS bits in the FSTATUS register. More... | |
| #define | FLASH_FSTATUS_ACTIVEWAITS_BITS (1 << 3) |
| Defines the location of the ACTIVEWAITS bits in the FSTATUS register. More... | |
| #define | FLASH_FSTATUS_3VSTAT_BITS (1 << 8) |
| Defines the location of the 3VSTAT bits in the FSTATUS register. More... | |
| #define | FLASH_FSTDBYWAIT_STDBYWAIT_BITS (255 << 0) |
| Defines the location of the STDBYWAIT bits in the FSTDBYWAIT register. More... | |
Typedefs | |
| typedef struct _FLASH_Obj_ | FLASH_Obj |
| Defines the flash (FLASH) object. More... | |
| typedef struct _FLASH_Obj_ * | FLASH_Handle |
| Defines the flash (FLASH) handle. More... | |
Functions | |
| void | FLASH_clear3VStatus (FLASH_Handle flashHandle) |
| Clears the 3V status. More... | |
| void | FLASH_disablePipelineMode (FLASH_Handle flashHandle) |
| Disables the pipeline mode. More... | |
| void | FLASH_enablePipelineMode (FLASH_Handle flashHandle) |
| Enables the pipeline mode. More... | |
| FLASH_3VStatus_e | FLASH_get3VStatus (FLASH_Handle flashHandle) |
| Gets the 3V status. More... | |
| uint16_t | FLASH_getActiveWaitCount (FLASH_Handle flashHandle) |
| Gets the active wait count. More... | |
| FLASH_CounterStatus_e | FLASH_getActiveWaitStatus (FLASH_Handle flashHandle) |
| Gets the active wait counter status. More... | |
| FLASH_PowerMode_e | FLASH_getPowerMode (FLASH_Handle flashHandle) |
| Gets the power mode. More... | |
| uint16_t | FLASH_getStandbyWaitCount (FLASH_Handle flashHandle) |
| Gets the standby wait count. More... | |
| FLASH_CounterStatus_e | FLASH_getStandbyWaitStatus (FLASH_Handle flashHandle) |
| Gets the standby wait counter status. More... | |
| FLASH_Handle | FLASH_init (void *pMemory, const size_t numBytes) |
| Initializes the flash (FLASH) handle. More... | |
| void | FLASH_setActiveWaitCount (FLASH_Handle flashHandle, const uint16_t count) |
| Sets the active wait count. More... | |
| void | FLASH_setNumPagedReadWaitStates (FLASH_Handle flashHandle, const FLASH_NumPagedWaitStates_e numStates) |
| Sets the number of paged read wait states. More... | |
| void | FLASH_setNumRandomReadWaitStates (FLASH_Handle flashHandle, const FLASH_NumRandomWaitStates_e numStates) |
| Sets the number of random read wait states. More... | |
| void | FLASH_setOtpWaitStates (FLASH_Handle flashHandle, const FLASH_NumOtpWaitStates_e numStates) |
| Sets the number of one-time programmable (OTP) wait states. More... | |
| void | FLASH_setPowerMode (FLASH_Handle flashHandle, const FLASH_PowerMode_e mode) |
| Sets the power mode. More... | |
| void | FLASH_setStandbyWaitCount (FLASH_Handle flashHandle, const uint16_t count) |
| Sets the standby wait count. More... | |
| struct _FLASH_Obj_ |
| #define FLASH_ACTIVE_WAIT_COUNT_DEFAULT (0x01FF) |
| #define FLASH_BASE_ADDR (0x00000A80) |
| #define FLASH_FACTIVEWAIT_ACTIVEWAIT_BITS (255 << 0) |
Defines the location of the ACTIVEWAIT bits in the FACTIVEWAIT register.
Definition at line 87 of file flash.h.
Referenced by FLASH_getActiveWaitCount().
| #define FLASH_FBANKWAIT_PAGEWAIT_BITS (15 << 8) |
Defines the location of the PAGEWAIT bits in the FBANKWAIT register.
Definition at line 96 of file flash.h.
Referenced by FLASH_setNumPagedReadWaitStates().
| #define FLASH_FBANKWAIT_RANDWAIT_BITS (15 << 0) |
Defines the location of the RANDWAIT bits in the FBANKWAIT register.
Definition at line 92 of file flash.h.
Referenced by FLASH_setNumRandomReadWaitStates().
| #define FLASH_FOPT_ENPIPE_BITS (1 << 0) |
Defines the location of the ENPIPE bits in the FOPT register.
Definition at line 82 of file flash.h.
Referenced by FLASH_disablePipelineMode(), and FLASH_enablePipelineMode().
| #define FLASH_FOTPWAIT_OTPWAIT_BITS (31 << 0) |
Defines the location of the OTPWAIT bits in the FOTPWAIT register.
Definition at line 101 of file flash.h.
Referenced by FLASH_setOtpWaitStates().
| #define FLASH_FPWR_PWR_BITS (3 << 0) |
Defines the location of the PWR bits in the FPWR register.
Definition at line 106 of file flash.h.
Referenced by FLASH_setPowerMode().
| #define FLASH_FSTATUS_3VSTAT_BITS (1 << 8) |
Defines the location of the 3VSTAT bits in the FSTATUS register.
Definition at line 123 of file flash.h.
Referenced by FLASH_clear3VStatus(), and FLASH_get3VStatus().
| #define FLASH_FSTATUS_ACTIVEWAITS_BITS (1 << 3) |
Defines the location of the ACTIVEWAITS bits in the FSTATUS register.
Definition at line 119 of file flash.h.
Referenced by FLASH_getActiveWaitStatus().
| #define FLASH_FSTATUS_PWRS_BITS (3 << 0) |
Defines the location of the PWRS bits in the FSTATUS register.
Definition at line 111 of file flash.h.
Referenced by FLASH_getPowerMode().
| #define FLASH_FSTATUS_STDBYWAITS_BITS (1 << 2) |
Defines the location of the STDBYWAITS bits in the FSTATUS register.
Definition at line 115 of file flash.h.
Referenced by FLASH_getStandbyWaitStatus().
| #define FLASH_FSTDBYWAIT_STDBYWAIT_BITS (255 << 0) |
Defines the location of the STDBYWAIT bits in the FSTDBYWAIT register.
Definition at line 128 of file flash.h.
Referenced by FLASH_getStandbyWaitCount().
| #define FLASH_STANDBY_WAIT_COUNT_DEFAULT (0x01FF) |
| typedef struct _FLASH_Obj_* FLASH_Handle |
| typedef struct _FLASH_Obj_ FLASH_Obj |
Defines the flash (FLASH) object.
| enum FLASH_3VStatus_e |
Enumeration to define the number of one-time programmable wait states.
Enumeration to define the number of paged wait states.
Enumeration to define the number of random wait states.
| enum FLASH_PowerMode_e |
| void FLASH_clear3VStatus | ( | FLASH_Handle | flashHandle | ) |
Clears the 3V status.
| [in] | flashHandle | The flash (FLASH) object handle |
Definition at line 56 of file flash.c.
References DISABLE_PROTECTED_REGISTER_WRITE_MODE, ENABLE_PROTECTED_REGISTER_WRITE_MODE, FLASH_FSTATUS_3VSTAT_BITS, and _FLASH_Obj_::FSTATUS.
| void FLASH_disablePipelineMode | ( | FLASH_Handle | flashHandle | ) |
Disables the pipeline mode.
| [in] | flashHandle | The flash (FLASH) object handle |
Definition at line 73 of file flash.c.
References DISABLE_PROTECTED_REGISTER_WRITE_MODE, ENABLE_PROTECTED_REGISTER_WRITE_MODE, FLASH_FOPT_ENPIPE_BITS, and _FLASH_Obj_::FOPT.
| void FLASH_enablePipelineMode | ( | FLASH_Handle | flashHandle | ) |
Enables the pipeline mode.
| [in] | flashHandle | The flash (FLASH) object handle |
Definition at line 90 of file flash.c.
References DISABLE_PROTECTED_REGISTER_WRITE_MODE, ENABLE_PROTECTED_REGISTER_WRITE_MODE, FLASH_FOPT_ENPIPE_BITS, and _FLASH_Obj_::FOPT.
| FLASH_3VStatus_e FLASH_get3VStatus | ( | FLASH_Handle | flashHandle | ) |
Gets the 3V status.
| [in] | flashHandle | The flash (FLASH) object handle |
Definition at line 106 of file flash.c.
References FLASH_FSTATUS_3VSTAT_BITS, and _FLASH_Obj_::FSTATUS.
| uint16_t FLASH_getActiveWaitCount | ( | FLASH_Handle | flashHandle | ) |
Gets the active wait count.
| [in] | flashHandle | The flash (FLASH) object handle |
Definition at line 118 of file flash.c.
References _FLASH_Obj_::FACTIVEWAIT, and FLASH_FACTIVEWAIT_ACTIVEWAIT_BITS.
| FLASH_CounterStatus_e FLASH_getActiveWaitStatus | ( | FLASH_Handle | flashHandle | ) |
Gets the active wait counter status.
| [in] | flashHandle | The flash (FLASH) object handle |
Definition at line 130 of file flash.c.
References FLASH_FSTATUS_ACTIVEWAITS_BITS, and _FLASH_Obj_::FSTATUS.
| FLASH_PowerMode_e FLASH_getPowerMode | ( | FLASH_Handle | flashHandle | ) |
Gets the power mode.
| [in] | flashHandle | The flash (FLASH) object handle |
Definition at line 142 of file flash.c.
References FLASH_FSTATUS_PWRS_BITS, and _FLASH_Obj_::FSTATUS.
| uint16_t FLASH_getStandbyWaitCount | ( | FLASH_Handle | flashHandle | ) |
Gets the standby wait count.
| [in] | flashHandle | The flash (FLASH) object handle |
Definition at line 154 of file flash.c.
References FLASH_FSTDBYWAIT_STDBYWAIT_BITS, and _FLASH_Obj_::FSTDBYWAIT.
| FLASH_CounterStatus_e FLASH_getStandbyWaitStatus | ( | FLASH_Handle | flashHandle | ) |
Gets the standby wait counter status.
| [in] | flashHandle | The flash (FLASH) object handle |
Definition at line 166 of file flash.c.
References FLASH_FSTATUS_STDBYWAITS_BITS, and _FLASH_Obj_::FSTATUS.
| FLASH_Handle FLASH_init | ( | void * | pMemory, |
| const size_t | numBytes | ||
| ) |
| void FLASH_setActiveWaitCount | ( | FLASH_Handle | flashHandle, |
| const uint16_t | count | ||
| ) |
Sets the active wait count.
| [in] | flashHandle | The flash (FLASH) object handle |
| [in] | count | The active wait count |
Definition at line 194 of file flash.c.
References DISABLE_PROTECTED_REGISTER_WRITE_MODE, ENABLE_PROTECTED_REGISTER_WRITE_MODE, and _FLASH_Obj_::FACTIVEWAIT.
| void FLASH_setNumPagedReadWaitStates | ( | FLASH_Handle | flashHandle, |
| const FLASH_NumPagedWaitStates_e | numStates | ||
| ) |
Sets the number of paged read wait states.
| [in] | flashHandle | The flash (FLASH) object handle |
| [in] | numStates | The number of paged read wait states |
Definition at line 210 of file flash.c.
References DISABLE_PROTECTED_REGISTER_WRITE_MODE, ENABLE_PROTECTED_REGISTER_WRITE_MODE, _FLASH_Obj_::FBANKWAIT, and FLASH_FBANKWAIT_PAGEWAIT_BITS.
| void FLASH_setNumRandomReadWaitStates | ( | FLASH_Handle | flashHandle, |
| const FLASH_NumRandomWaitStates_e | numStates | ||
| ) |
Sets the number of random read wait states.
| [in] | flashHandle | The flash (FLASH) object handle |
| [in] | numStates | The number of random read wait states |
Definition at line 230 of file flash.c.
References DISABLE_PROTECTED_REGISTER_WRITE_MODE, ENABLE_PROTECTED_REGISTER_WRITE_MODE, _FLASH_Obj_::FBANKWAIT, and FLASH_FBANKWAIT_RANDWAIT_BITS.
| void FLASH_setOtpWaitStates | ( | FLASH_Handle | flashHandle, |
| const FLASH_NumOtpWaitStates_e | numStates | ||
| ) |
Sets the number of one-time programmable (OTP) wait states.
| [in] | flashHandle | The flash (FLASH) object handle |
| [in] | numStates | The number of one-time programmable (OTP) wait states |
Definition at line 250 of file flash.c.
References DISABLE_PROTECTED_REGISTER_WRITE_MODE, ENABLE_PROTECTED_REGISTER_WRITE_MODE, FLASH_FOTPWAIT_OTPWAIT_BITS, and _FLASH_Obj_::FOTPWAIT.
| void FLASH_setPowerMode | ( | FLASH_Handle | flashHandle, |
| const FLASH_PowerMode_e | mode | ||
| ) |
Sets the power mode.
| [in] | flashHandle | The flash (FLASH) object handle |
| [in] | mode | The power mode |
Definition at line 270 of file flash.c.
References DISABLE_PROTECTED_REGISTER_WRITE_MODE, ENABLE_PROTECTED_REGISTER_WRITE_MODE, FLASH_FPWR_PWR_BITS, and _FLASH_Obj_::FPWR.
| void FLASH_setStandbyWaitCount | ( | FLASH_Handle | flashHandle, |
| const uint16_t | count | ||
| ) |
Sets the standby wait count.
| [in] | flashHandle | The flash (FLASH) object handle |
| [in] | count | The standby wait count |
Definition at line 290 of file flash.c.
References DISABLE_PROTECTED_REGISTER_WRITE_MODE, ENABLE_PROTECTED_REGISTER_WRITE_MODE, and _FLASH_Obj_::FSTDBYWAIT.
1.8.9.1