main_core.h File Reference

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

#include <xc.h>
#include <stdint.h>
#include <stdbool.h>
#include "main_core_types.h"
#include "main_core_interface.h"

Include dependency graph for main_core.h:

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

Go to the source code of this file.

Macros
#define	MSIInterface_Initialize   MAIN_CORE_Initialize
	This macro defines the Custom Name for MAIN_CORE_Initialize API.
#define	MSIInterface_Deinitialize   MAIN_CORE_Deinitialize
	This macro defines the Custom Name for MAIN_CORE_Deinitialize API.
#define	MSIInterface_InterruptRequestGenerate   MAIN_CORE_InterruptRequestGenerate
	This macro defines the Custom Name for MAIN_CORE_InterruptRequestGenerate API.
#define	MSIInterface_IsInterruptRequestAcknowledged   MAIN_CORE_IsInterruptRequestAcknowledged
	This macro defines the Custom Name for MAIN_CORE_IsInterruptRequestAcknowledged API.
#define	MSIInterface_InterruptRequestComplete   MAIN_CORE_InterruptRequestComplete
	This macro defines the Custom Name for MAIN_CORE_InterruptRequestComplete API.
#define	MSIInterface_IsInterruptRequested   MAIN_CORE_IsInterruptRequested
	This macro defines the Custom Name for MAIN_CORE_IsInterruptRequested API.
#define	MSIInterface_InterruptRequestAcknowledge   MAIN_CORE_InterruptRequestAcknowledge
	This macro defines the Custom Name for MAIN_CORE_InterruptRequestAcknowledge API.
#define	MSIInterface_InterruptRequestAcknowledgeComplete   MAIN_CORE_InterruptRequestAcknowledgeComplete
	This macro defines the Custom Name for MAIN_CORE_InterruptRequestAcknowledgeComplete API.
#define	MSIInterface_SystemStatusGet   MAIN_CORE_SystemStatusGet
	This macro defines the Custom Name for MAIN_CORE_SystemStatusGet API.
#define	MSIInterface_FIFORead   MAIN_CORE_FIFORead
	This macro defines the Custom Name for MAIN_CORE_FIFORead API.
#define	MSIInterface_FIFOWrite   MAIN_CORE_FIFOWrite
	This macro defines the Custom Name for MAIN_CORE_FIFOWrite API.
#define	MSIInterface_FIFOReadIsFull   MAIN_CORE_FIFOReadIsFull
	This macro defines the Custom Name for MAIN_CORE_FIFOReadIsFull API.
#define	MSIInterface_FIFOReadIsEmpty   MAIN_CORE_FIFOReadIsEmpty
	This macro defines the Custom Name for MAIN_CORE_FIFOReadIsEmpty API.
#define	MSIInterface_FIFOWriteIsFull   MAIN_CORE_FIFOWriteIsFull
	This macro defines the Custom Name for MAIN_CORE_FIFOWriteIsFull API.
#define	MSIInterface_FIFOWriteIsEmpty   MAIN_CORE_FIFOWriteIsEmpty
	This macro defines the Custom Name for MAIN_CORE_FIFOWriteIsEmpty API.
#define	MSIInterface_ProtocolWrite   MAIN_CORE_ProtocolWrite
	This macro defines the Custom Name for MAIN_CORE_ProtocolWrite API.
#define	MSIInterface_ProtocolRead   MAIN_CORE_ProtocolRead
	This macro defines the Custom Name for MAIN_CORE_ProtocolRead API.
#define	MSIInterface_ProtocolIsFull   MAIN_CORE_ProtocolIsFull
	This macro defines the Custom Name for MAIN_CORE_ProtocolIsFull API.
#define	MSIInterface_ProtocolIsEmpty   MAIN_CORE_ProtocolIsEmpty
	This macro defines the Custom Name for MAIN_CORE_ProtocolIsEmpty API.

Functions
void	MAIN_CORE_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	MAIN_CORE_Deinitialize (void)
	Deinitializes MAIN_CORE to POR values.
void	MAIN_CORE_InterruptRequestGenerate (void)
	This routine generates interrupt to MAIN_CORE.
bool	MAIN_CORE_IsInterruptRequestAcknowledged (void)
	This routine returns the status of interrupt request acknowledge from the MAIN_CORE.
void	MAIN_CORE_InterruptRequestComplete (void)
	This routine clears interrupt to MAIN_CORE.
bool	MAIN_CORE_IsInterruptRequested (void)
	This routine returns the status of interrupt request from the MAIN_CORE.
void	MAIN_CORE_InterruptRequestAcknowledge (void)
	This routine acknowledges interrupt received from Main MSI.
void	MAIN_CORE_InterruptRequestAcknowledgeComplete (void)
	This routine clears acknowledge for interrupt received from Main MSI.
enum MAIN_CORE_SYSTEM_STATUS	MAIN_CORE_SystemStatusGet (void)
	This routine returns Main system status.
uint16_t	MAIN_CORE_FIFORead (uint16_t *pData, uint16_t wordCount)
	This routine reads FIFO data sent from the Main Core.
uint16_t	MAIN_CORE_FIFOWrite (uint16_t *pData, uint16_t wordCount)
	This routine transfers FIFO data to Main Core.
static bool	MAIN_CORE_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	MAIN_CORE_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	MAIN_CORE_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	MAIN_CORE_FIFOWriteIsEmpty (void)
	This inline function checks whether the status of Write FIFO is Empty. Returns true if last write by Main to Write FIFO (WFDATA) was into the last free location.
bool	MAIN_CORE_ProtocolWrite (enum MAIN_CORE_PROTOCOLS protocolName, uint16_t *pData)
	This routine writes data to mailbox.
bool	MAIN_CORE_ProtocolRead (enum MAIN_CORE_PROTOCOLS protocolName, uint16_t *pData)
	This routine reads data from mailbox.
static bool	MAIN_CORE_ProtocolIsFull (enum MAIN_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 Main core.
static bool	MAIN_CORE_ProtocolIsEmpty (enum MAIN_CORE_PROTOCOLS protocolName)
	This inline function checks whether mailbox is empty. Returns true if Protocol is empty indicating mailbox is ready to write by Main core. returns false indicating write operation cannot be performed by Main core.

Variables
const struct MAIN_CORE_INTERFACE	MSIInterface
	Structure object of type MAIN_CORE_INTERFACE with the custom name given by the user in the Melody Driver User interface. The default name e.g. Main_Core can be changed by the user in the MAIN_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

MAIN_CORE Generated Driver Header File

Definition in file main_core.h.