sec_core1.h File Reference

This is the generated driver header file for the SEC_CORE1 driver. More...

#include <xc.h>
#include <stdint.h>
#include <stdbool.h>
#include "sec_core_types.h"
#include "sec_core_interface.h"

Include dependency graph for sec_core1.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	MSIInterface_Initialize   SEC_CORE1_Initialize
	This macro defines the Custom Name for SEC_CORE1_Initialize API.
#define	MSIInterface_Deinitialize   SEC_CORE1_Deinitialize
	This macro defines the Custom Name for SEC_CORE1_Deinitialize API.
#define	MSIInterface_Program   SEC_CORE1_Program
	This macro defines the Custom Name for SEC_CORE1_Program API.
#define	MSIInterface_Strat   SEC_CORE1_Strat
	This macro defines the Custom Name for SEC_CORE1_Strat API.
#define	MSIInterface_InterruptRequestGenerate   SEC_CORE1_InterruptRequestGenerate
	This macro defines the Custom Name for SEC_CORE1_InterruptRequestGenerate API.
#define	MSIInterface_IsInterruptRequestAcknowledged   SEC_CORE1_IsInterruptRequestAcknowledged
	This macro defines the Custom Name for SEC_CORE1_IsInterruptRequestAcknowledged API.
#define	MSIInterface_InterruptRequestComplete   SEC_CORE1_InterruptRequestComplete
	This macro defines the Custom Name for SEC_CORE1_InterruptRequestComplete API.
#define	MSIInterface_IsInterruptRequested   SEC_CORE1_IsInterruptRequested
	This macro defines the Custom Name for SEC_CORE1_IsInterruptRequested API.
#define	MSIInterface_InterruptRequestAcknowledge   SEC_CORE1_InterruptRequestAcknowledge
	This macro defines the Custom Name for SEC_CORE1_InterruptRequestAcknowledge API.
#define	MSIInterface_InterruptRequestAcknowledgeComplete   SEC_CORE1_InterruptRequestAcknowledgeComplete
	This macro defines the Custom Name for SEC_CORE1_InterruptRequestAcknowledgeComplete API.
#define	MSIInterface_GetResetCause   SEC_CORE1_GetResetCause
	This macro defines the Custom Name for SEC_CORE1_GetResetCause API.
#define	MSIInterface_ResetCauseClear   SEC_CORE1_ResetCauseClear
	This macro defines the Custom Name for SEC_CORE1_ResetCauseClear API.
#define	MSIInterface_SystemStatusGet   SEC_CORE1_SystemStatusGet
	This macro defines the Custom Name for SEC_CORE1_SystemStatusGet API.
#define	MSIInterface_WriteFIFOEnable   SEC_CORE1_WriteFIFOEnable
	This macro defines the Custom Name for SEC_CORE1_WriteFIFOEnable API.
#define	MSIInterface_WriteFIFODisable   SEC_CORE1_WriteFIFODisable
	This macro defines the Custom Name for SEC_CORE1_WriteFIFODisable API.
#define	MSIInterface_ReadFIFOEnable   SEC_CORE1_ReadFIFOEnable
	This macro defines the Custom Name for SEC_CORE1_ReadFIFOEnable API.
#define	MSIInterface_ReadFIFODisable   SEC_CORE1_ReadFIFODisable
	This macro defines the Custom Name for SEC_CORE1_ReadFIFODisable API.
#define	MSIInterface_FIFORead   SEC_CORE1_FIFORead
	This macro defines the Custom Name for SEC_CORE1_FIFORead API.
#define	MSIInterface_FIFOWrite   SEC_CORE1_FIFOWrite
	This macro defines the Custom Name for SEC_CORE1_FIFOWrite API.
#define	MSIInterface_FIFOReadIsFull   SEC_CORE1_FIFOReadIsFull
	This macro defines the Custom Name for SEC_CORE1_FIFOReadIsFull API.
#define	MSIInterface_FIFOReadIsEmpty   SEC_CORE1_FIFOReadIsEmpty
	This macro defines the Custom Name for SEC_CORE1_FIFOReadIsEmpty API.
#define	MSIInterface_FIFOWriteIsFull   SEC_CORE1_FIFOWriteIsFull
	This macro defines the Custom Name for SEC_CORE1_FIFOWriteIsFull API.
#define	MSIInterface_FIFOWriteIsEmpty   SEC_CORE1_FIFOWriteIsEmpty
	This macro defines the Custom Name for SEC_CORE1_FIFOWriteIsEmpty API.
#define	MSIInterface_ProtocolWrite   SEC_CORE1_ProtocolWrite
	This macro defines the Custom Name for SEC_CORE1_ProtocolWrite API.
#define	MSIInterface_ProtocolRead   SEC_CORE1_ProtocolRead
	This macro defines the Custom Name for SEC_CORE1_ProtocolRead API.
#define	MSIInterface_ProtocolIsFull   SEC_CORE1_ProtocolIsFull
	This macro defines the Custom Name for SEC_CORE1_ProtocolIsFull API.
#define	MSIInterface_ProtocolIsEmpty   SEC_CORE1_ProtocolIsEmpty
	This macro defines the Custom Name for SEC_CORE1_ProtocolIsEmpty API.

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.

Detailed Description

SEC_CORE1 Generated Driver Header File

Definition in file sec_core1.h.