Data Structures¶

group group_ipc_pipe_data_structures

Data structures are used in the driver.

struct cy_stc_ipc_pipe_ep_t

#include <>

This is the definition of a pipe endpoint.

There is one endpoint structure for each CPU in a pipe. It contains all the information to process a message send to other CPUs in the pipe.

Public Members

uint32_t ipcChan: IPC channel number used for this endpoint to receive messages.

uint32_t intrChan: IPC interrupt channel number used for this endpoint to receive interrupts.

uint32_t pipeIntMask: Release/Notify interrupt mask that includes all endpoints on pipe.

IRQn_Type pipeIntrSrc: Interrupt vector number that includes all endpoints on pipe.

IPC_STRUCT_Type *ipcPtr: Pointer to receive IPC channel ( If ipcPtr == NULL, cannot receive )

IPC_INTR_STRUCT_Type *ipcIntrPtr: Pointer to IPC interrupt, needed to clear the interrupt.

uint32_t busy

Endpoint busy flag.

If sent no messages can be sent from this endpoint

cy_ipc_pipe_callback_array_ptr_t callbackArray: Pointer to array of callback functions, one for each Client.

cy_ipc_pipe_relcallback_ptr_t releaseCallbackPtr: Pointer to release callback function.

cy_ipc_pipe_relcallback_ptr_t defaultReleaseCallbackPtr: Pointer to default release callback function.

struct cy_stc_ipc_pipe_ep_config_t

#include <>

The Pipe endpoint configuration structure.

Public Members

uint32_t epConfig: Configuration mask, contains IPC channel, IPC interrupt number, and the interrupt mask.

struct cy_stc_ipc_pipe_config_t

#include <>

The Pipe channel configuration structure.

Public Members

cy_stc_ipc_pipe_ep_config_t ep0ConfigData: Specifies the notify interrupt number for the first endpoint.

cy_stc_ipc_pipe_ep_config_t ep1ConfigData: Specifies the notify interrupt number for the second endpoint.

uint32_t endpointClientsCount: Client count and size of MsgCallback array.

cy_ipc_pipe_callback_array_ptr_t endpointsCallbacksArray: Pipes callback function array.

cy_israddress userPipeIsrHandler: User IRQ handler function that is called when IPC receive data to process (interrupt was raised).