rpmsg.txt: standardize document format
Each text file under Documentation follows a different format. Some doesn't even have titles! Change its representation to follow the adopted standard, using ReST markups for it to be parseable by Sphinx: - mark document and chapter titles; - mark notes; - mark literal blocks; - adjust identation. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>hifive-unleashed-5.1
Mauro Carvalho Chehab
Jonathan Corbet
parent
773810d30e
commit
af3137f132
|
|
@ -1,10 +1,15 @@
|
|||
============================================
|
||||
Remote Processor Messaging (rpmsg) Framework
|
||||
============================================
|
||||
|
||||
Note: this document describes the rpmsg bus and how to write rpmsg drivers.
|
||||
.. note::
|
||||
|
||||
This document describes the rpmsg bus and how to write rpmsg drivers.
|
||||
To learn how to add rpmsg support for new platforms, check out remoteproc.txt
|
||||
(also a resident of Documentation/).
|
||||
|
||||
1. Introduction
|
||||
Introduction
|
||||
============
|
||||
|
||||
Modern SoCs typically employ heterogeneous remote processor devices in
|
||||
asymmetric multiprocessing (AMP) configurations, which may be running
|
||||
|
|
@ -58,10 +63,14 @@ to their destination address (this is done by invoking the driver's rx handler
|
|||
with the payload of the inbound message).
|
||||
|
||||
|
||||
2. User API
|
||||
User API
|
||||
========
|
||||
|
||||
::
|
||||
|
||||
int rpmsg_send(struct rpmsg_channel *rpdev, void *data, int len);
|
||||
- sends a message across to the remote processor on a given channel.
|
||||
|
||||
sends a message across to the remote processor on a given channel.
|
||||
The caller should specify the channel, the data it wants to send,
|
||||
and its length (in bytes). The message will be sent on the specified
|
||||
channel, i.e. its source and destination address fields will be
|
||||
|
|
@ -72,14 +81,20 @@ with the payload of the inbound message).
|
|||
a tx buffer and puts it back on virtio's used descriptor ring),
|
||||
or a timeout of 15 seconds elapses. When the latter happens,
|
||||
-ERESTARTSYS is returned.
|
||||
|
||||
The function can only be called from a process context (for now).
|
||||
Returns 0 on success and an appropriate error value on failure.
|
||||
|
||||
::
|
||||
|
||||
int rpmsg_sendto(struct rpmsg_channel *rpdev, void *data, int len, u32 dst);
|
||||
- sends a message across to the remote processor on a given channel,
|
||||
|
||||
sends a message across to the remote processor on a given channel,
|
||||
to a destination address provided by the caller.
|
||||
|
||||
The caller should specify the channel, the data it wants to send,
|
||||
its length (in bytes), and an explicit destination address.
|
||||
|
||||
The message will then be sent to the remote processor to which the
|
||||
channel belongs, using the channel's src address, and the user-provided
|
||||
dst address (thus the channel's dst address will be ignored).
|
||||
|
|
@ -89,13 +104,19 @@ with the payload of the inbound message).
|
|||
a tx buffer and puts it back on virtio's used descriptor ring),
|
||||
or a timeout of 15 seconds elapses. When the latter happens,
|
||||
-ERESTARTSYS is returned.
|
||||
|
||||
The function can only be called from a process context (for now).
|
||||
Returns 0 on success and an appropriate error value on failure.
|
||||
|
||||
::
|
||||
|
||||
int rpmsg_send_offchannel(struct rpmsg_channel *rpdev, u32 src, u32 dst,
|
||||
void *data, int len);
|
||||
- sends a message across to the remote processor, using the src and dst
|
||||
|
||||
|
||||
sends a message across to the remote processor, using the src and dst
|
||||
addresses provided by the user.
|
||||
|
||||
The caller should specify the channel, the data it wants to send,
|
||||
its length (in bytes), and explicit source and destination addresses.
|
||||
The message will then be sent to the remote processor to which the
|
||||
|
|
@ -107,11 +128,15 @@ with the payload of the inbound message).
|
|||
a tx buffer and puts it back on virtio's used descriptor ring),
|
||||
or a timeout of 15 seconds elapses. When the latter happens,
|
||||
-ERESTARTSYS is returned.
|
||||
|
||||
The function can only be called from a process context (for now).
|
||||
Returns 0 on success and an appropriate error value on failure.
|
||||
|
||||
::
|
||||
|
||||
int rpmsg_trysend(struct rpmsg_channel *rpdev, void *data, int len);
|
||||
- sends a message across to the remote processor on a given channel.
|
||||
|
||||
sends a message across to the remote processor on a given channel.
|
||||
The caller should specify the channel, the data it wants to send,
|
||||
and its length (in bytes). The message will be sent on the specified
|
||||
channel, i.e. its source and destination address fields will be
|
||||
|
|
@ -119,27 +144,40 @@ with the payload of the inbound message).
|
|||
|
||||
In case there are no TX buffers available, the function will immediately
|
||||
return -ENOMEM without waiting until one becomes available.
|
||||
|
||||
The function can only be called from a process context (for now).
|
||||
Returns 0 on success and an appropriate error value on failure.
|
||||
|
||||
::
|
||||
|
||||
int rpmsg_trysendto(struct rpmsg_channel *rpdev, void *data, int len, u32 dst)
|
||||
- sends a message across to the remote processor on a given channel,
|
||||
|
||||
|
||||
sends a message across to the remote processor on a given channel,
|
||||
to a destination address provided by the user.
|
||||
|
||||
The user should specify the channel, the data it wants to send,
|
||||
its length (in bytes), and an explicit destination address.
|
||||
|
||||
The message will then be sent to the remote processor to which the
|
||||
channel belongs, using the channel's src address, and the user-provided
|
||||
dst address (thus the channel's dst address will be ignored).
|
||||
|
||||
In case there are no TX buffers available, the function will immediately
|
||||
return -ENOMEM without waiting until one becomes available.
|
||||
|
||||
The function can only be called from a process context (for now).
|
||||
Returns 0 on success and an appropriate error value on failure.
|
||||
|
||||
::
|
||||
|
||||
int rpmsg_trysend_offchannel(struct rpmsg_channel *rpdev, u32 src, u32 dst,
|
||||
void *data, int len);
|
||||
- sends a message across to the remote processor, using source and
|
||||
|
||||
|
||||
sends a message across to the remote processor, using source and
|
||||
destination addresses provided by the user.
|
||||
|
||||
The user should specify the channel, the data it wants to send,
|
||||
its length (in bytes), and explicit source and destination addresses.
|
||||
The message will then be sent to the remote processor to which the
|
||||
|
|
@ -148,13 +186,17 @@ with the payload of the inbound message).
|
|||
|
||||
In case there are no TX buffers available, the function will immediately
|
||||
return -ENOMEM without waiting until one becomes available.
|
||||
|
||||
The function can only be called from a process context (for now).
|
||||
Returns 0 on success and an appropriate error value on failure.
|
||||
|
||||
::
|
||||
|
||||
struct rpmsg_endpoint *rpmsg_create_ept(struct rpmsg_channel *rpdev,
|
||||
void (*cb)(struct rpmsg_channel *, void *, int, void *, u32),
|
||||
void *priv, u32 addr);
|
||||
- every rpmsg address in the system is bound to an rx callback (so when
|
||||
|
||||
every rpmsg address in the system is bound to an rx callback (so when
|
||||
inbound messages arrive, they are dispatched by the rpmsg bus using the
|
||||
appropriate callback handler) by means of an rpmsg_endpoint struct.
|
||||
|
||||
|
|
@ -186,29 +228,44 @@ with the payload of the inbound message).
|
|||
|
||||
Returns a pointer to the endpoint on success, or NULL on error.
|
||||
|
||||
::
|
||||
|
||||
void rpmsg_destroy_ept(struct rpmsg_endpoint *ept);
|
||||
- destroys an existing rpmsg endpoint. user should provide a pointer
|
||||
|
||||
|
||||
destroys an existing rpmsg endpoint. user should provide a pointer
|
||||
to an rpmsg endpoint that was previously created with rpmsg_create_ept().
|
||||
|
||||
::
|
||||
|
||||
int register_rpmsg_driver(struct rpmsg_driver *rpdrv);
|
||||
- registers an rpmsg driver with the rpmsg bus. user should provide
|
||||
|
||||
|
||||
registers an rpmsg driver with the rpmsg bus. user should provide
|
||||
a pointer to an rpmsg_driver struct, which contains the driver's
|
||||
->probe() and ->remove() functions, an rx callback, and an id_table
|
||||
specifying the names of the channels this driver is interested to
|
||||
be probed with.
|
||||
|
||||
::
|
||||
|
||||
void unregister_rpmsg_driver(struct rpmsg_driver *rpdrv);
|
||||
- unregisters an rpmsg driver from the rpmsg bus. user should provide
|
||||
|
||||
|
||||
unregisters an rpmsg driver from the rpmsg bus. user should provide
|
||||
a pointer to a previously-registered rpmsg_driver struct.
|
||||
Returns 0 on success, and an appropriate error value on failure.
|
||||
|
||||
|
||||
3. Typical usage
|
||||
Typical usage
|
||||
=============
|
||||
|
||||
The following is a simple rpmsg driver, that sends an "hello!" message
|
||||
on probe(), and whenever it receives an incoming message, it dumps its
|
||||
content to the console.
|
||||
|
||||
::
|
||||
|
||||
#include <linux/kernel.h>
|
||||
#include <linux/module.h>
|
||||
#include <linux/rpmsg.h>
|
||||
|
|
@ -256,10 +313,13 @@ static struct rpmsg_driver rpmsg_sample_client = {
|
|||
};
|
||||
module_rpmsg_driver(rpmsg_sample_client);
|
||||
|
||||
Note: a similar sample which can be built and loaded can be found
|
||||
.. note::
|
||||
|
||||
a similar sample which can be built and loaded can be found
|
||||
in samples/rpmsg/.
|
||||
|
||||
4. Allocations of rpmsg channels:
|
||||
Allocations of rpmsg channels
|
||||
=============================
|
||||
|
||||
At this point we only support dynamic allocations of rpmsg channels.
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue