rpmsg_endpoint Struct Reference

Structure that binds a local RPMsg address to its user. More...

#include <rpmsg.h>

Data Fields
char	name [RPMSG_NAME_SIZE]
	Name of the service supported. More...
struct rpmsg_device *	rdev
	Pointer to the RPMsg device. More...
uint32_t	addr
	Local address of the endpoint. More...
uint32_t	dest_addr
	Address of the default remote endpoint binded. More...
uint32_t	refcnt
	Reference count for determining whether the endpoint can be deallocated. More...
rpmsg_ept_release_cb	release_cb
	Callback to inform the user that the endpoint allocation can be safely removed. More...
rpmsg_ept_cb	cb
	User rx callback, return value of this callback is reserved for future use, for now, only allow RPMSG_SUCCESS as return value. More...
rpmsg_ns_unbind_cb	ns_unbind_cb
	Endpoint service unbind callback, called when remote ept is destroyed. More...
struct metal_list	node
	Endpoint node. More...
void *	priv
	Private data for the driver's use. More...

Detailed Description

Structure that binds a local RPMsg address to its user.

In essence, an RPMsg endpoint represents a listener on the RPMsg bus, as it binds an RPMsg address with an rx callback handler.

Field Documentation

addr

uint32_t rpmsg_endpoint::addr

Local address of the endpoint.

cb

rpmsg_ept_cb rpmsg_endpoint::cb

User rx callback, return value of this callback is reserved for future use, for now, only allow RPMSG_SUCCESS as return value.

dest_addr

uint32_t rpmsg_endpoint::dest_addr

Address of the default remote endpoint binded.

name

char rpmsg_endpoint::name[RPMSG_NAME_SIZE]

Name of the service supported.

node

struct metal_list rpmsg_endpoint::node

Endpoint node.

ns_unbind_cb

rpmsg_ns_unbind_cb rpmsg_endpoint::ns_unbind_cb

Endpoint service unbind callback, called when remote ept is destroyed.

priv

void* rpmsg_endpoint::priv

Private data for the driver's use.

rdev

struct rpmsg_device* rpmsg_endpoint::rdev

Pointer to the RPMsg device.

refcnt

uint32_t rpmsg_endpoint::refcnt

Reference count for determining whether the endpoint can be deallocated.

release_cb

rpmsg_ept_release_cb rpmsg_endpoint::release_cb

Callback to inform the user that the endpoint allocation can be safely removed.

---

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

• lib/include/openamp/rpmsg.h