lib: Add support for AM64x SoCs
[rpmsg/ti-rpmsg-char.git] / examples / README
1 rpmsg-char-simple application
2 =============================
4 rpmsg-char-simple is a very basic single-threaded application
5 demonstrating the usage of the API provided by the ti-rpmsg-char
6 library to communicate messages to a remote processor exercising
7 the kernel rpmsg_char driver and virtio-rpmsg transport.
9 Usage:
10   rpmsg_char_simple [-r <rproc_id>] [-n <num_msgs>] [-d <rpmsg_dev_name>] [-p <remote_endpt>]
12   Where:
13     -r <rproc_id>        remote processor id to be used.
14                          Valid values are 0 to RPROC_ID_MAX
15     -n <num_msgs>        Number of messages to exchange (default 100)
16     -d <rpmsg_dev_name>  rpmsg device name
17                          (defaults to NULL, translates to rpmsg_chrdev)
18     -p <remote_endpt>    remote end-point address of the rpmsg device
19                          (default 14 based on current example firmwares)
21 Examples:
22 1. rpmsg_char_simple -r 2 -d ti.ipc4.ping-pong -p 13
23      Runs the example using device "ti.ipc4.ping-pong" and remote port 13
24      with rproc_id value of 2 (R5F_MAIN0_0), exchanges 100 messages
25 2. rpmsg_char_simple -r 4 -n 10
26      Runs the example using default rpmsg device "rpmsg_chrdev",
27      remote port 14 with rproc_id value of 4 (R5F_MAIN1_0), exchanges
28      10 messages