RPMsg service APIs

RPMsg service API. More...

Functions
int	rpmsg_service_register_endpoint (const char *name, rpmsg_ept_cb cb)
	Register IPC endpoint.
int	rpmsg_service_send (int endpoint_id, const void *data, size_t len)
	Send data using given IPC endpoint.
bool	rpmsg_service_endpoint_is_bound (int endpoint_id)
	Check if endpoint is bound.

Detailed Description

RPMsg service API.

Function Documentation

rpmsg_service_endpoint_is_bound()

bool rpmsg_service_endpoint_is_bound

(

int

endpoint_id

)

#include <zephyr/ipc/rpmsg_service.h>

Check if endpoint is bound.

Checks if remote endpoint has been created and the master has bound its endpoint to it.

Parameters

endpoint_id

Id of registered endpoint, obtained by rpmsg_service_register_endpoint

Return values

true	endpoint is bound
false	endpoint not bound

rpmsg_service_register_endpoint()

int rpmsg_service_register_endpoint	(	const char *	name,
		rpmsg_ept_cb	cb
	)

#include <zephyr/ipc/rpmsg_service.h>

Register IPC endpoint.

Registers IPC endpoint to enable communication with a remote device. The endpoint is created when the slave device registers it.

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

Parameters

name	String containing the name of the endpoint. Must be identical for master and slave
cb	Callback executed when data are available on given endpoint

Return values

>=0	id of registered endpoint on success;
-EINPROGRESS	when requested to register an endpoint after endpoints creation procedure has started;
-ENOMEM	when there is not enough slots to register the endpoint;
<0	an other negative errno code, reported by rpmsg.

rpmsg_service_send()

int rpmsg_service_send	(	int	endpoint_id,
		const void *	data,
		size_t	len
	)

#include <zephyr/ipc/rpmsg_service.h>

Send data using given IPC endpoint.

Parameters

endpoint_id	Id of registered endpoint, obtained by rpmsg_service_register_endpoint
data	Pointer to the buffer to send through RPMsg service
len	Number of bytes to send.

Return values

>=0	number of sent bytes;
<0	an error code, reported by rpmsg.