ipc.h File Reference

Inter Processor Communications. More...

#include <stdint.h>

Go to the source code of this file.

Classes
struct	ipc_message

Typedefs
typedef void(*	ipc_async_handler_t) (void *param, int return_value)

Functions
void	ipc_initialize ()
	Initializes the IPC Interface.
int	ipc_request (ipc_message *message, ipc_async_handler_t handler, void *params)
	Puts a request in and gets the response.

Detailed Description

Inter Processor Communications.

IPC interface between Broadway and Starlet. Designed to implement IOS's protocol.

Author

Samuel Fitzsimons (rainbain)

Date

2025 @license MIT (see LICENSE file)

Function Documentation

ipc_initialize()

void ipc_initialize ( )

extern

Initializes the IPC Interface.

Usually called through ios_initialize

Initializes the IPC interface. Setups the FreeRTOS Mutexes and data structures for communications.

ipc_request()

int ipc_request ( ipc_message * message, ipc_async_handler_t handler, void * params )

extern

Puts a request in and gets the response.

Puts a request into the IPC interface. Then after its completion, the handler will be called from the interrupt service.

Parameters

message	Data structure to the message to send to Starlet.
handler	Handler called from interrupt service upon compilation.
params	Pointer passed to the handler.

Returns

Result as int, negative if error.