IPC service APIs

IPC Service API. More...

Data Structures
struct	ipc_service_cb
	Event callback structure. More...
struct	ipc_ept_cfg
	Endpoint configuration structure. More...
struct	ipc_service_backend
	IPC Service backend. More...

Functions
int	ipc_service_register_endpoint (struct ipc_ept **ept, const struct ipc_ept_cfg *cfg)
	Register IPC endpoint. More...
int	ipc_service_send (struct ipc_ept *ept, const void *data, size_t len)
	Send data using given IPC endpoint. More...

Detailed Description

IPC Service API.

Function Documentation

ipc_service_register_endpoint()

int ipc_service_register_endpoint	(	struct ipc_ept **	ept,
		const struct ipc_ept_cfg *	cfg
	)

#include <include/ipc/ipc_service.h>

Register IPC endpoint.

Registers IPC endpoint to enable communication with a remote device.

The same function registers endpoints for both master and slave devices.

Parameters

ept	Endpoint object.
cfg	Endpoint configuration.

Return values

-EIO	when no backend is registered.
-EINVAL	when pointer to an endpoint or endpoint configuration is invalid.
Other	errno codes depending on the implementation of the backend.

ipc_service_send()

int ipc_service_send	(	struct ipc_ept *	ept,
		const void *	data,
		size_t	len
	)

#include <include/ipc/ipc_service.h>

Send data using given IPC endpoint.

Parameters

ept	Registered endpoint by ipc_service_register_endpoint.
data	Pointer to the buffer to send.
len	Number of bytes to send.

Return values

-EIO	when no backend is registered.
Other	errno codes depending on the implementation of the backend.