Skip to content

Commit

Permalink
Terminology: Replace potentially offensive terms in documentation
Browse files Browse the repository at this point in the history
In line with the terminology changes proposed by the OpenAMP
Technical Steering committee. Suppress "master and "slave" terms
in comments and documentations.

Signed-off-by: Arnaud Pouliquen <arnaud.pouliquen@foss.st.com>
  • Loading branch information
arnopo committed May 31, 2022
1 parent ef7a9d0 commit afed3bd
Show file tree
Hide file tree
Showing 44 changed files with 137 additions and 137 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ enable development of software applications for Asymmetric Multiprocessing
environments
3. Compatibility with upstream Linux remoteproc and rpmsg components
4. Following AMP configurations supported
a. Linux master/Generic(Baremetal) remote
b. Generic(Baremetal) master/Linux remote
5. Proxy infrastructure and supplied demos showcase ability of proxy on master
a. Linux host/Generic(Baremetal) remote
b. Generic(Baremetal) host/Linux remote
5. Proxy infrastructure and supplied demos showcase ability of proxy on host
to handle printf, scanf, open, close, read, write calls from Bare metal
based remote contexts.

Expand Down Expand Up @@ -96,7 +96,7 @@ library for it project:
enabled on buffers.
* **RPMSG_BUFFER_SIZE** (default 512): adjust the size of the RPMsg buffers.
The default value of the RPMsg size is compatible with the Linux Kernel hard
coded value. If you AMP configuration is Linux kernel master/ OpenAMP remote,
coded value. If you AMP configuration is Linux kernel host/ OpenAMP remote,
this option must not be used.

### Example to compile OpenAMP for Zephyr
Expand Down Expand Up @@ -264,11 +264,11 @@ The OpenAMP version follows the set of rule proposed in [Semantic Versioning spe
## Supported System and Machines
For now, it supports:
* Zynq generic slave
* Zynq UltraScale+ MPSoC R5 generic slave
* Zynq generic remote
* Zynq UltraScale+ MPSoC R5 generic remote
* Linux host OpenAMP between Linux userspace processes
* Linux userspace OpenAMP RPMsg master
* Linux userspace OpenAMP RPMsg slave
* Linux userspace OpenAMP RPMsg host
* Linux userspace OpenAMP RPMsg remote
* Linux userspace OpenAMP RPMsg and MicroBlaze bare metal remote
## Known Limitations:
Expand Down
4 changes: 2 additions & 2 deletions apps/examples/echo/rpmsg-echo.c
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
/*
* This is a sample demonstration application that showcases usage of rpmsg
* This application is meant to run on the remote CPU running baremetal code.
* This application echoes back data that was sent to it by the master core.
* This application echoes back data that was sent to it by the host core.
*/

#include <stdio.h>
Expand Down Expand Up @@ -41,7 +41,7 @@ static int rpmsg_endpoint_cb(struct rpmsg_endpoint *ept, void *data, size_t len,
return RPMSG_SUCCESS;
}

/* Send data back to master */
/* Send data back to host */
if (rpmsg_send(ept, data, len) < 0) {
LPERROR("rpmsg_send failed\r\n");
}
Expand Down
2 changes: 1 addition & 1 deletion apps/examples/echo/rpmsg-ping.c
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
/*
* This is a sample demonstration application that showcases usage of rpmsg
* This application is meant to run on the remote CPU running baremetal code.
* This application echoes back data that was sent to it by the master core.
* This application echoes back data that was sent to it by the host core.
*/

#include <stdio.h>
Expand Down
6 changes: 3 additions & 3 deletions apps/examples/linux_rpc_demo/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# linux_rpc_demo
This readme is about the OpenAMP linux_rpc_demo.

The linux_rpc_demo is about remote procedure calls between linux master and linux
slave using rpmsg to perform
The linux_rpc_demo is about remote procedure calls between linux host and linux
remote using rpmsg to perform
1. File operations such as open, read, write and close
2. I/O operation such as printf, scanf

Expand Down Expand Up @@ -51,7 +51,7 @@ generated to `build/usr/local/bin` directory.
$ sudo LD_LIBRARY_PATH=<openamp_built>/usr/local/lib:<libmetal_built>/usr/local/lib \
build-openamp/usr/local/bin/linux_rpc_demo-shared 1
```
Enter the inputs on the master side the same gets printed on the remote side. You will see communication between the master and remote process using rpmsg calls.
Enter the inputs on the host side the same gets printed on the remote side. You will see communication between the host and remote process using rpmsg calls.
## Note:
`sudo` is required to run the OpenAMP demos between Linux processes, as it doesn't work on
Expand Down
14 changes: 7 additions & 7 deletions apps/examples/linux_rpc_demo/linux_rpc_demo.c
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
/*This is a sample demonstration application that showcases usage of proxy
*from the remote core.
*This application is meant to run on the remote CPU running linux.
*This application can print to the master console and perform file I/O through
*This application can print to the host console and perform file I/O through
*rpmsg channels.
*/

Expand Down Expand Up @@ -482,10 +482,10 @@ int app(struct rpmsg_device *rdev, void *priv)

printf("\nRemote>Rpmsg based retargetting to proxy initialized..\r\n");

/* Remote performing file IO on Master */
/* Remote performing file IO on Host */
printf("\nRemote>FileIO demo ..\r\n");

printf("\nRemote>Creating a file on master and writing to it..\r\n");
printf("\nRemote>Creating a file on host and writing to it..\r\n");
rpmsg_open(fname, REDEF_O_CREAT | REDEF_O_WRONLY | REDEF_O_APPEND,
S_IRUSR | S_IWUSR);
printf("\nRemote>Opened file '%s' with fd = %d\r\n", fname, fd);
Expand All @@ -496,8 +496,8 @@ int app(struct rpmsg_device *rdev, void *priv)
rpmsg_close(fd);
printf("\nRemote>Closed fd = %d\r\n", fd);

/* Remote performing file IO on Master */
printf("\nRemote>Reading a file on master and displaying its "
/* Remote performing file IO on Host */
printf("\nRemote>Reading a file on host and displaying its "
"contents..\r\n");
rpmsg_open(fname, REDEF_O_RDONLY, S_IRUSR | S_IWUSR);
printf("\nRemote>Opened file '%s' with fd = %d\r\n", fname, fd);
Expand All @@ -509,10 +509,10 @@ int app(struct rpmsg_device *rdev, void *priv)
printf("\nRemote>Closed fd = %d\r\n", fd);

while (1) {
/* Remote performing STDIO on Master */
/* Remote performing STDIO on Host */
printf("\nRemote>Remote firmware using scanf and printf .."
"\r\n");
printf("\nRemote>Scanning user input from master..\r\n");
printf("\nRemote>Scanning user input from host..\r\n");
printf("\nRemote>Enter name\r\n");
rpmsg_input(ubuff, sizeof(ubuff));
ret = bytes_read;
Expand Down
4 changes: 2 additions & 2 deletions apps/examples/linux_rpc_demo/linux_rpc_demod.c
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
/*This is a sample demonstration application that showcases usage of proxy
*from the remote core.
*This application is meant to run on the remote CPU running linux.
*This application can print to the master console and perform file I/O through
*This application can print to the host console and perform file I/O through
*rpmsg channels.
*/

Expand All @@ -32,7 +32,7 @@
#define REDEF_O_ACCMODE 3

#define raw_printf(format, ...) printf(format, ##__VA_ARGS__)
#define LPRINTF(format, ...) raw_printf("Master> " format, ##__VA_ARGS__)
#define LPRINTF(format, ...) raw_printf("Host> " format, ##__VA_ARGS__)
#define LPERROR(format, ...) LPRINTF("ERROR: " format, ##__VA_ARGS__)

static void *platform;
Expand Down
4 changes: 2 additions & 2 deletions apps/examples/matrix_multiply/matrix_multiply.c
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
/*
* This is a sample demonstration application that showcases usage of remoteproc
* and rpmsg APIs on the remote core. This application is meant to run on the remote CPU
* running baremetal code. This applicationr receives two matrices from the master,
* multiplies them and returns the result to the master core.
* running baremetal code. This applicationr receives two matrices from the host,
* multiplies them and returns the result to the host core.
*/

#include <stdio.h>
Expand Down
6 changes: 3 additions & 3 deletions apps/examples/matrix_multiply/matrix_multiplyd.c
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
/*
* This is a sample demonstration application that showcases usage of remoteproc
* and rpmsg APIs on the remote core. This application is meant to run on the remote CPU
* running baremetal code. This applicationr receives two matrices from the master,
* multiplies them and returns the result to the master core.
* running baremetal code. This applicationr receives two matrices from the host,
* multiplies them and returns the result to the host core.
*/

#include <stdio.h>
Expand Down Expand Up @@ -76,7 +76,7 @@ static int rpmsg_endpoint_cb(struct rpmsg_endpoint *ept, void *data, size_t len,
/* Process received data and multiple matrices. */
Matrix_Multiply(&matrix_array[0], &matrix_array[1], &matrix_result);

/* Send the result of matrix multiplication back to master. */
/* Send the result of matrix multiplication back to host. */
if (rpmsg_send(ept, &matrix_result, sizeof(matrix)) < 0) {
LPERROR("rpmsg_send failed\r\n");
}
Expand Down
4 changes: 2 additions & 2 deletions apps/examples/nocopy_echo/rpmsg-nocopy-echo.c
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
/*
* This is a sample demonstration application that showcases usage of rpmsg
* This application is meant to run on the remote CPU running baremetal code.
* This application echoes back data that was sent to it by the master core.
* This application echoes back data that was sent to it by the host core.
*/

#include <stdio.h>
Expand Down Expand Up @@ -111,7 +111,7 @@ int app(struct rpmsg_device *rdev, void *priv)
break;
}
while (rpmsg_list) {
/* Send data back to master */
/* Send data back to host */
ret = rpmsg_send(rpmsg_list->ept, rpmsg_list->data,
rpmsg_list->len);
if (ret < 0) {
Expand Down
14 changes: 7 additions & 7 deletions apps/examples/rpc_demo/rpc_demo.c
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
/*
* This is a sample demonstration application that showcases usage of proxy from the remote core.
* This application is meant to run on the remote CPU running baremetal.
* This application can print to the master console and perform file I/O using proxy mechanism.
* This application can print to the host console and perform file I/O using proxy mechanism.
*/

#include <stdio.h>
Expand Down Expand Up @@ -69,10 +69,10 @@ int app(struct rpmsg_device *rdev, void *priv)

printf("\nRemote>Rpmsg based retargetting to proxy initialized..\r\n");

/* Remote performing file IO on Master */
/* Remote performing file IO on Host */
printf("\nRemote>FileIO demo ..\r\n");

printf("\nRemote>Creating a file on master and writing to it..\r\n");
printf("\nRemote>Creating a file on host and writing to it..\r\n");
fd = open(fname, REDEF_O_CREAT | REDEF_O_WRONLY | REDEF_O_APPEND,
S_IRUSR | S_IWUSR);
printf("\nRemote>Opened file '%s' with fd = %d\r\n", fname, fd);
Expand All @@ -84,8 +84,8 @@ int app(struct rpmsg_device *rdev, void *priv)
close(fd);
printf("\nRemote>Closed fd = %d\r\n", fd);

/* Remote performing file IO on Master */
printf("\nRemote>Reading a file on master and displaying its contents..\r\n");
/* Remote performing file IO on Host */
printf("\nRemote>Reading a file on host and displaying its contents..\r\n");
fd = open(fname, REDEF_O_RDONLY, S_IRUSR | S_IWUSR);
printf("\nRemote>Opened file '%s' with fd = %d\r\n", fname, fd);
bytes_read = read(fd, rbuff, 1024);
Expand All @@ -96,9 +96,9 @@ int app(struct rpmsg_device *rdev, void *priv)
printf("\nRemote>Closed fd = %d\r\n", fd);

while (1) {
/* Remote performing STDIO on Master */
/* Remote performing STDIO on Host */
printf("\nRemote>Remote firmware using scanf and printf ..\r\n");
printf("\nRemote>Scanning user input from master..\r\n");
printf("\nRemote>Scanning user input from host..\r\n");
printf("\nRemote>Enter name\r\n");
ret = scanf("%s", ubuff);
if (ret) {
Expand Down
4 changes: 2 additions & 2 deletions apps/examples/rpc_demo/rpc_demod.c
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
/*
* This is a sample demonstration application that showcases usage of proxy from the remote core.
* This application is meant to run on the remote CPU running baremetal.
* This applicationr can print to to master console and perform file I/O using proxy mechanism.
* This applicationr can print to to host console and perform file I/O using proxy mechanism.
*/

#include <errno.h>
Expand All @@ -29,7 +29,7 @@
#define REDEF_O_ACCMODE 3

#define raw_printf(format, ...) printf(format, ##__VA_ARGS__)
#define LPRINTF(format, ...) raw_printf("Master> " format, ##__VA_ARGS__)
#define LPRINTF(format, ...) raw_printf("Host> " format, ##__VA_ARGS__)
#define LPERROR(format, ...) LPRINTF("ERROR: " format, ##__VA_ARGS__)

static void *platform;
Expand Down
4 changes: 2 additions & 2 deletions apps/examples/rpmsg_sample_echo/rpmsg-sample-echo.c
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
* This is a sample demonstration application that showcases usage of rpmsg
* This application is meant to run on the remote CPU running baremetal code.
* This application allows to check the compatibility with linux OS running on
* the master CPU. For this it echo MSG_LIMIT time message sent by the rpmsg
* the host CPU. For this it echo MSG_LIMIT time message sent by the rpmsg
* sample client available in linux kernel distribution.
*/

Expand Down Expand Up @@ -36,7 +36,7 @@ static int rpmsg_endpoint_cb(struct rpmsg_endpoint *ept, void *data, size_t len,
static uint32_t count = 0;
char payload[RPMSG_BUFFER_SIZE];

/* Send data back MSG_LIMIT time to master */
/* Send data back MSG_LIMIT time to host */
memset(payload, 0, RPMSG_BUFFER_SIZE);
memcpy(payload, data, len);
if (++count <= MSG_LIMIT) {
Expand Down
4 changes: 2 additions & 2 deletions apps/machine/microblaze_generic/platform_info.c
Original file line number Diff line number Diff line change
Expand Up @@ -153,14 +153,14 @@ platform_create_rpmsg_vdev(void *platform, unsigned int vdev_index,

xil_printf("initializing rpmsg shared buffer pool\r\n");
/*
* Only RPMsg virtio master needs to initialize the shared buffers
* Only RPMsg virtio driver needs to initialize the shared buffers
* pool
*/
rpmsg_virtio_init_shm_pool(&shpool, shbuf,
(SHARED_MEM_SIZE - SHARED_BUF_OFFSET));

xil_printf("initializing rpmsg vdev\r\n");
/* RPMsg virtio slave can set shared buffers pool argument to NULL */
/* RPMsg virtio device can set shared buffers pool argument to NULL */
ret = rpmsg_init_vdev(rpmsg_vdev, vdev, ns_bind_cb,
shbuf_io,
&shpool);
Expand Down
2 changes: 1 addition & 1 deletion apps/machine/microblaze_generic/platform_info.h
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ int platform_init(int argc, char *argv[], void **platform);
* @platform: pointer to the private data
* @vdev_index: index of the virtio device, there can more than one vdev
* on the platform.
* @role: virtio master or virtio slave of the vdev
* @role: virtio driver or virtio device of the vdev
* @rst_cb: virtio device reset callback
* @ns_bind_cb: rpmsg name service bind callback
*
Expand Down
2 changes: 1 addition & 1 deletion apps/machine/microblaze_generic/rsc_table.c
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

/*
* This file populates resource table for BM remote
* for use by the Linux Master
* for use by the Linux host
*/

#include <openamp/open_amp.h>
Expand Down
2 changes: 1 addition & 1 deletion apps/machine/microblaze_generic/rsc_table.h
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
/*
* Resource table declarations. Resource table is placed in a separate
* section of a bare-metal binary or firmware. It's used to describe
* shared memory (virtIO devices) resources the remoteproc master should
* shared memory (virtIO devices) resources the remoteproc host should
* initialize and / or use to communicate with the firmware.
*/
#ifndef RSC_TABLE_H_
Expand Down
4 changes: 2 additions & 2 deletions apps/machine/zynq7/platform_info.c
Original file line number Diff line number Diff line change
Expand Up @@ -198,14 +198,14 @@ platform_create_rpmsg_vdev(void *platform, unsigned int vdev_index,

xil_printf("initializing rpmsg vdev\r\n");
if (role == VIRTIO_DEV_DRIVER) {
/* Only RPMsg virtio master needs to initialize the
/* Only RPMsg virtio driver needs to initialize the
* shared buffers pool
*/
rpmsg_virtio_init_shm_pool(&shpool, shbuf,
(SHARED_MEM_SIZE -
SHARED_BUF_OFFSET));

/* RPMsg virtio slave can set shared buffers pool
/* RPMsg virtio device can set shared buffers pool
* argument to NULL
*/
ret = rpmsg_init_vdev(rpmsg_vdev, vdev, ns_bind_cb,
Expand Down
2 changes: 1 addition & 1 deletion apps/machine/zynq7/platform_info.h
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ int platform_init(int argc, char *argv[], void **platform);
* @platform: pointer to the private data
* @vdev_index: index of the virtio device, there can more than one vdev
* on the platform.
* @role: virtio master or virtio slave of the vdev
* @role: virtio driver or virtio device of the vdev
* @rst_cb: virtio device reset callback
* @ns_bind_cb: rpmsg name service bind callback
*
Expand Down
16 changes: 8 additions & 8 deletions apps/machine/zynq7/platform_info_remoteproc_master.c
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,10 @@ extern struct hil_platform_ops zynq_a9_proc_ops;
#define REMOTE_CPU_ID 1

/**
* This array provdes defnition of CPU nodes for master and remote
* This array provdes defnition of CPU nodes for host and remote
* context. It contains two nodes because the same file is intended
* to use with both master and remote configurations. On zynq platform
* only one node definition is required for master/remote as there
* to use with both host and remote configurations. On zynq platform
* only one node definition is required for host/remote as there
* are only two cores present in the platform.
*
* Only platform specific info is populated here. Rest of information
Expand All @@ -63,15 +63,15 @@ extern struct hil_platform_ops zynq_a9_proc_ops;
*
*
* 1) First node in the array is intended for the remote contexts and it
* defines Master CPU ID, shared memory, interrupts info, number of channels
* defines Host CPU ID, shared memory, interrupts info, number of channels
* and there names. This node defines only one channel
* "rpmsg-openamp-demo-channel".
*
* 2)Second node is required by the master and it defines remote CPU ID,
* 2)Second node is required by the host and it defines remote CPU ID,
* shared memory and interrupts info. In general no channel info is required by the
* Master node, however in baremetal master and linux remote case the linux
* rpmsg bus driver behaves as master so the rpmsg driver on linux side still needs
* channel info. This information is not required by the masters for baremetal
* Host node, however in baremetal host and linux remote case the linux
* rpmsg bus driver behaves as host so the rpmsg driver on linux side still needs
* channel info. This information is not required by the hosts for baremetal
* remotes.
*
*/
Expand Down
2 changes: 1 addition & 1 deletion apps/machine/zynq7/rsc_table.c
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

/*
* This file populates resource table for BM remote
* for use by the Linux Master
* for use by the Linux host
*/

#include <openamp/open_amp.h>
Expand Down
Loading

0 comments on commit afed3bd

Please sign in to comment.