HPM SDK
HPMicro Software Development Kit
hpm_ipc_event_mgr.h File Reference

Go to the source code of this file.

Data Structures

struct  ipc_event_t
 Type definition of structure with event handler and data. More...
 

Typedefs

typedef void(* ipc_event_callback_t) (uint16_t event_data, void *context)
 Type definition of event callback function pointer. More...
 

Enumerations

enum  ipc_event_type_t { ipc_remote_start_event = 1 , ipc_remote_rpmsg_event , ipc_event_table_len }
 Type definition of event types. More...
 

Functions

void ipc_init (void)
 IPC Init. More...
 
void ipc_enable_event_interrupt (uint32_t priority)
 Enbale IPC event interrupt. More...
 
void ipc_disable_event_interrupt (void)
 Disbale IPC event interrupt. More...
 
hpm_stat_t ipc_register_event (ipc_event_type_t type, ipc_event_callback_t callback, void *callback_data)
 Register IPC event. More...
 
hpm_stat_t ipc_tigger_event (ipc_event_type_t type, uint16_t event_data)
 Trigger IPC event. More...
 
void ipc_event_handler (uint32_t data)
 event handler More...
 

Typedef Documentation

◆ ipc_event_callback_t

typedef void(* ipc_event_callback_t) (uint16_t event_data, void *context)

Type definition of event callback function pointer.

Parameters
[in]eventdata
[in]callbackcontext data

Enumeration Type Documentation

◆ ipc_event_type_t

Type definition of event types.

Enumerator
ipc_remote_start_event 
ipc_remote_rpmsg_event 
ipc_event_table_len 

Function Documentation

◆ ipc_disable_event_interrupt()

void ipc_disable_event_interrupt ( void  )

Disbale IPC event interrupt.

◆ ipc_enable_event_interrupt()

void ipc_enable_event_interrupt ( uint32_t  priority)

Enbale IPC event interrupt.

Parameters
[in]interruptpriority

◆ ipc_event_handler()

void ipc_event_handler ( uint32_t  data)

event handler

This function is called when event received

Parameters
[in]eventtype and data.

◆ ipc_init()

void ipc_init ( void  )

IPC Init.

◆ ipc_register_event()

hpm_stat_t ipc_register_event ( ipc_event_type_t  type,
ipc_event_callback_t  callback,
void *  callback_data 
)

Register IPC event.

Parameters
[in]eventtype
[in]eventcallback function
[in]eventcallback data
Return values
status_successif no error occurred
status_invalid_argumentif the parameter is invalid

◆ ipc_tigger_event()

hpm_stat_t ipc_tigger_event ( ipc_event_type_t  type,
uint16_t  event_data 
)

Trigger IPC event.

Parameters
[in]eventtype
[in]eventdata
Return values
status_successif no error occurred
status_invalid_argumentif any parameters are invalid