ipc_service_backend Struct Reference

IPC Service backend. More...

#include <ipc_service_backend.h>

Data Fields
int(*	open_instance )(const struct device *instance)
	Pointer to the function that will be used to open an instance. More...
int(*	send )(const struct device *instance, void *token, const void *data, size_t len)
	Pointer to the function that will be used to send data to the endpoint. More...
int(*	register_endpoint )(const struct device *instance, void **token, const struct ipc_ept_cfg *cfg)
	Pointer to the function that will be used to register endpoints. More...

Detailed Description

IPC Service backend.

IPC backend configuration structure.

This structure is used for configuration backend during registration.

Field Documentation

open_instance

int(* ipc_service_backend::open_instance) (const struct device *instance)

Pointer to the function that will be used to open an instance.

Parameters

instance

Instance pointer.

Return values

-EALREADY	when the instance is already opened.
0	on success
other	errno codes depending on the implementation of the backend.

register_endpoint

int(* ipc_service_backend::register_endpoint) (const struct device *instance, void **token, const struct ipc_ept_cfg *cfg)

Pointer to the function that will be used to register endpoints.

Parameters

instance	Instance to register the endpoint onto.
token	Backend-specific token.
cfg	Endpoint configuration.

Return values

-EINVAL	when the endpoint configuration or instance is invalid.
-EBUSY	when the instance is busy or not ready.
0	on success
other	errno codes depending on the implementation of the backend.

send

int(* ipc_service_backend::send) (const struct device *instance, void *token, const void *data, size_t len)

Pointer to the function that will be used to send data to the endpoint.

Parameters

instance	Instance pointer.
token	Backend-specific token.
data	Pointer to the buffer to send.
len	Number of bytes to send.

Return values

-EINVAL	when instance is invalid.
-EBADMSG	when the message is invalid.
-EBUSY	when the instance is busy or not ready.
0	on success
other	errno codes depending on the implementation of the backend.

---

The documentation for this struct was generated from the following file:

• include/ipc/ipc_service_backend.h