This is the generated driver interface file for SEC_CORE driver. More...
Files | |
file | sec_core1.h |
This is the generated driver header file for the SEC_CORE1 driver. | |
file | sec_core_types.h |
This is the generated driver types header file for the SEC_CORE driver. | |
file | sec_core1.c |
This is the generated driver source file for SEC_CORE1 driver. | |
Data Structures | |
struct | SEC_CORE_INTERFACE |
Structure containing the function pointers of SEC_CORE driver. More... | |
Enumerations | |
enum | SEC_CORE_SYSTEM_STATUS { SEC_CORE_SYSTEM_STATUS_NOT_IN_LOW_POWER_MODE = 0 , SEC_CORE_SYSTEM_STATUS_SLEEP_MODE = 1 , SEC_CORE_SYSTEM_STATUS_IDLE_MODE = 2 , SEC_CORE_SYSTEM_STATUS_RUNNING_STATE = 3 , SEC_CORE_SYSTEM_STATUS_IN_RESET_STATE = 4 } |
Defines the status enumeration for sec_core. More... | |
enum | SEC_CORE_RESET_CAUSE { SEC_CORE_RESET_CAUSE_WATCHDOG = 0 , SEC_CORE_RESET_CAUSE_UNSPECIFIED = 1 } |
Defines the sec_core reset cause enumeration. More... | |
enum | SEC_CORE_PROTOCOLS { MSI1_ProtocolA , MSI1_ProtocolB } |
Defines the list of Protocols configured for SEC_CORE_driver. More... | |
enum | SEC_CORE_PROTOCOL_SIZE { MSI1_ProtocolA_SIZE = 5 , MSI1_ProtocolB_SIZE = 10 } |
Defines the size for Protocols. More... | |
Functions | |
void | SEC_CORE1_Initialize (void) |
This routine initializes the MSI driver. This routine must be called before any other MSI routine is called. This routine should only be called once during system initialization. | |
void | SEC_CORE1_Deinitialize (void) |
Deinitializes SEC_CORE1 to POR values. | |
void | SEC_CORE1_Start (void) |
This routine enables secondary core. | |
void | SEC_CORE1_Program (void) |
This routine programs secondary. | |
void | SEC_CORE1_InterruptRequestGenerate (void) |
This routine generates interrupt to SEC_CORE1. | |
bool | SEC_CORE1_IsInterruptRequestAcknowledged (void) |
This routine returns the status of interrupt request acknowledge from the SEC_CORE1. | |
void | SEC_CORE1_InterruptRequestComplete (void) |
This routine clears interrupt to SEC_CORE1. | |
bool | SEC_CORE1_IsInterruptRequested (void) |
This routine returns the status of interrupt request from the SEC_CORE1. | |
void | SEC_CORE1_InterruptRequestAcknowledge (void) |
This routine acknowledges interrupt received from SEC_CORE1. | |
void | SEC_CORE1_InterruptRequestAcknowledgeComplete (void) |
This routine clears acknowledge for interrupt received from SEC_CORE1. | |
enum SEC_CORE_RESET_CAUSE | SEC_CORE1_GetResetCause (void) |
This routine returns the cause for SEC_CORE1 reset. | |
void | SEC_CORE1_ResetCauseClear (enum SEC_CORE_RESET_CAUSE resetCause) |
This routine clears the cause for SEC_CORE1 reset. | |
enum SEC_CORE_SYSTEM_STATUS | SEC_CORE1_SystemStatusGet (void) |
This routine returns Secondary system status. | |
uint16_t | SEC_CORE1_FIFORead (uint16_t *pData, uint16_t wordCount) |
This routine reads FIFO data sent from the SEC_CORE1. | |
uint16_t | SEC_CORE1_FIFOWrite (uint16_t *pData, uint16_t wordCount) |
This routine transfers FIFO data to SEC_CORE1. | |
static void | SEC_CORE1_WriteFIFOEnable (void) |
This inline function Enables the Write FIFO. | |
static void | SEC_CORE1_WriteFIFODisable (void) |
This inline function Disables the Write FIFO. | |
static void | SEC_CORE1_ReadFIFOEnable (void) |
This inline function Enables the Read FIFO. | |
static void | SEC_CORE1_ReadFIFODisable (void) |
This inline function Disables the Read FIFO. | |
static bool | SEC_CORE1_FIFOReadIsFull (void) |
This inline function checks whether the status of Read FIFO is full. last write by Secondary core to Read FIFO (RFDATA) was into the last free location. | |
static bool | SEC_CORE1_FIFOReadIsEmpty (void) |
This inline function checks whether the status of Read FIFO is Empty. Returns true if last read by Main core from Read FIFO (RFDATA) emptied the FIFO of all valid data or FIFO is disabled (and initialized to the empty state) | |
static bool | SEC_CORE1_FIFOWriteIsFull (void) |
This inline function checks whether the status of Write FIFO is Full. Returns true if last write by Main core to Write FIFO (WFDATA) was into the last free location. | |
static bool | SEC_CORE1_FIFOWriteIsEmpty (void) |
This inline function checks whether the status of Write FIFO is Empty. Returns true if last write by Main core to Write FIFO (WFDATA) was into the last free location. | |
bool | SEC_CORE1_ProtocolWrite (enum SEC_CORE_PROTOCOLS protocolName, uint16_t *pData) |
This routine writes data to mailbox. | |
bool | SEC_CORE1_ProtocolRead (enum SEC_CORE_PROTOCOLS protocolName, uint16_t *pData) |
This routine reads data from mailbox. | |
static bool | SEC_CORE1_ProtocolIsFull (enum SEC_CORE_PROTOCOLS protocolName) |
This inline function checks whether mailbox is full. Returns true if new data are ready to read. Returns false when no data are available to be read by secondary. | |
static bool | SEC_CORE1_ProtocolIsEmpty (enum SEC_CORE_PROTOCOLS protocolName) |
This inline function checks whether mailbox is empty. Returns true if Protocol is empty indicating mailbox is ready to write by secondary. Returns false indicating write operation cannot be performed by secondary. | |
Variables | |
const struct SEC_CORE_INTERFACE | MSIInterface |
Structure object of type SEC_CORE_INTERFACE with the custom name given by the user in the Melody Driver User interface. The default name e.g. Secondary1 can be changed by the user in the SEC_CORE user interface. This allows defining a structure with application specific name using the 'Custom Name' field. Application specific name allows the API Portability. | |
/**
8
#define MSIInterface_Deinitialize SEC_CORE1_Deinitialize |
Definition at line 72 of file sec_core1.h.
#define MSIInterface_FIFORead SEC_CORE1_FIFORead |
Definition at line 168 of file sec_core1.h.
#define MSIInterface_FIFOReadIsEmpty SEC_CORE1_FIFOReadIsEmpty |
Definition at line 186 of file sec_core1.h.
#define MSIInterface_FIFOReadIsFull SEC_CORE1_FIFOReadIsFull |
Definition at line 180 of file sec_core1.h.
#define MSIInterface_FIFOWrite SEC_CORE1_FIFOWrite |
Definition at line 174 of file sec_core1.h.
#define MSIInterface_FIFOWriteIsEmpty SEC_CORE1_FIFOWriteIsEmpty |
Definition at line 198 of file sec_core1.h.
#define MSIInterface_FIFOWriteIsFull SEC_CORE1_FIFOWriteIsFull |
Definition at line 192 of file sec_core1.h.
#define MSIInterface_GetResetCause SEC_CORE1_GetResetCause |
Definition at line 126 of file sec_core1.h.
#define MSIInterface_Initialize SEC_CORE1_Initialize |
Definition at line 66 of file sec_core1.h.
#define MSIInterface_InterruptRequestAcknowledge SEC_CORE1_InterruptRequestAcknowledge |
Definition at line 114 of file sec_core1.h.
#define MSIInterface_InterruptRequestAcknowledgeComplete SEC_CORE1_InterruptRequestAcknowledgeComplete |
Definition at line 120 of file sec_core1.h.
#define MSIInterface_InterruptRequestComplete SEC_CORE1_InterruptRequestComplete |
Definition at line 102 of file sec_core1.h.
#define MSIInterface_InterruptRequestGenerate SEC_CORE1_InterruptRequestGenerate |
Definition at line 90 of file sec_core1.h.
#define MSIInterface_IsInterruptRequestAcknowledged SEC_CORE1_IsInterruptRequestAcknowledged |
Definition at line 96 of file sec_core1.h.
#define MSIInterface_IsInterruptRequested SEC_CORE1_IsInterruptRequested |
Definition at line 108 of file sec_core1.h.
#define MSIInterface_Program SEC_CORE1_Program |
Definition at line 78 of file sec_core1.h.
#define MSIInterface_ProtocolIsEmpty SEC_CORE1_ProtocolIsEmpty |
Definition at line 222 of file sec_core1.h.
#define MSIInterface_ProtocolIsFull SEC_CORE1_ProtocolIsFull |
Definition at line 216 of file sec_core1.h.
#define MSIInterface_ProtocolRead SEC_CORE1_ProtocolRead |
Definition at line 210 of file sec_core1.h.
#define MSIInterface_ProtocolWrite SEC_CORE1_ProtocolWrite |
Definition at line 204 of file sec_core1.h.
#define MSIInterface_ReadFIFODisable SEC_CORE1_ReadFIFODisable |
Definition at line 162 of file sec_core1.h.
#define MSIInterface_ReadFIFOEnable SEC_CORE1_ReadFIFOEnable |
Definition at line 156 of file sec_core1.h.
#define MSIInterface_ResetCauseClear SEC_CORE1_ResetCauseClear |
Definition at line 132 of file sec_core1.h.
#define MSIInterface_Strat SEC_CORE1_Strat |
Definition at line 84 of file sec_core1.h.
#define MSIInterface_SystemStatusGet SEC_CORE1_SystemStatusGet |
Definition at line 138 of file sec_core1.h.
#define MSIInterface_WriteFIFODisable SEC_CORE1_WriteFIFODisable |
Definition at line 150 of file sec_core1.h.
#define MSIInterface_WriteFIFOEnable SEC_CORE1_WriteFIFOEnable |
Definition at line 144 of file sec_core1.h.
Enumerator | |
---|---|
MSI1_ProtocolA_SIZE | Size of ProtocolA in 16-bit word |
MSI1_ProtocolB_SIZE | Size of ProtocolB in 16-bit word |
Definition at line 84 of file sec_core_types.h.
enum SEC_CORE_PROTOCOLS |
Enumerator | |
---|---|
MSI1_ProtocolA | Custom-name of ProtocolA for write operation only |
MSI1_ProtocolB | Custom-name of ProtocolB for write operation only |
Definition at line 72 of file sec_core_types.h.
enum SEC_CORE_RESET_CAUSE |
Enumerator | |
---|---|
SEC_CORE_RESET_CAUSE_WATCHDOG | sec_core reset caused from Watchdog Timer |
SEC_CORE_RESET_CAUSE_UNSPECIFIED | sec_core reset cause is unspecified |
Definition at line 60 of file sec_core_types.h.
Definition at line 46 of file sec_core_types.h.
void SEC_CORE1_Deinitialize | ( | void | ) |
uint16_t SEC_CORE1_FIFORead | ( | uint16_t * | pData, |
uint16_t | wordCount ) |
[in] | *pData | - Pointer to an array to store the read data |
[in] | wordCount | - Number of words to be read. |
Definition at line 325 of file sec_core1.c.
|
inlinestatic |
Definition at line 420 of file sec_core1.h.
|
inlinestatic |
Definition at line 407 of file sec_core1.h.
uint16_t SEC_CORE1_FIFOWrite | ( | uint16_t * | pData, |
uint16_t | wordCount ) |
[in] | *pData | - Pointer to an array which has data for transmission. |
[in] | wordCount | - Number of words to be transfer. |
Definition at line 345 of file sec_core1.c.
|
inlinestatic |
Definition at line 446 of file sec_core1.h.
|
inlinestatic |
Definition at line 433 of file sec_core1.h.
enum SEC_CORE_RESET_CAUSE SEC_CORE1_GetResetCause | ( | void | ) |
none |
Definition at line 273 of file sec_core1.c.
void SEC_CORE1_Initialize | ( | void | ) |
none |
Definition at line 194 of file sec_core1.c.
void SEC_CORE1_InterruptRequestAcknowledge | ( | void | ) |
void SEC_CORE1_InterruptRequestAcknowledgeComplete | ( | void | ) |
void SEC_CORE1_InterruptRequestComplete | ( | void | ) |
void SEC_CORE1_InterruptRequestGenerate | ( | void | ) |
bool SEC_CORE1_IsInterruptRequestAcknowledged | ( | void | ) |
none |
Definition at line 248 of file sec_core1.c.
bool SEC_CORE1_IsInterruptRequested | ( | void | ) |
none |
Definition at line 259 of file sec_core1.c.
void SEC_CORE1_Program | ( | void | ) |
|
inlinestatic |
[in] | protocolName | - Selected protocol |
Definition at line 507 of file sec_core1.h.
|
inlinestatic |
[in] | protocolName | - Selected protocol |
Definition at line 480 of file sec_core1.h.
bool SEC_CORE1_ProtocolRead | ( | enum SEC_CORE_PROTOCOLS | protocolName, |
uint16_t * | pData ) |
[in] | protocolName | - Selected protocol |
[in] | *pData | - Pointer to a structure to store the read data |
Definition at line 411 of file sec_core1.c.
bool SEC_CORE1_ProtocolWrite | ( | enum SEC_CORE_PROTOCOLS | protocolName, |
uint16_t * | pData ) |
[in] | protocolName | - Selected protocol |
[in] | *pData | - Pointer to a structure which has data for transmission. |
Definition at line 365 of file sec_core1.c.
|
inlinestatic |
|
inlinestatic |
void SEC_CORE1_ResetCauseClear | ( | enum SEC_CORE_RESET_CAUSE | resetCause | ) |
resetCause | - reset to be cleared |
Definition at line 289 of file sec_core1.c.
void SEC_CORE1_Start | ( | void | ) |
enum SEC_CORE_SYSTEM_STATUS SEC_CORE1_SystemStatusGet | ( | void | ) |
none |
Definition at line 300 of file sec_core1.c.
|
inlinestatic |
|
inlinestatic |
|
extern |
Definition at line 155 of file sec_core1.c.