summaryrefslogtreecommitdiffstats
path: root/meta-egvirt/recipes-extended/vhost-device-can/vhost-device-can-0.1.0/README.md
diff options
context:
space:
mode:
authorTimos Ampelikiotis <t.ampelikiotis@virtualopensystems.com>2024-10-03 11:00:30 +0300
committerJan-Simon Moeller <jsmoeller@linuxfoundation.org>2024-11-07 16:40:10 +0000
commit0b813fa1224e4c31caf4dbab0bd8146c4d038f4e (patch)
treed65dcbb60673cd1a553e469c87316bf5cff90481 /meta-egvirt/recipes-extended/vhost-device-can/vhost-device-can-0.1.0/README.md
parent70c6b997f65a4ea87003b7dcb3c282c590c6cec2 (diff)
Update vhost-device-can and align it with rust-vmm implementation
[v2]: Remove recipe for socketcan-rs lib. Update vhost-device-can recipe to clone and be built with a selected version of socketcan-rs. [v1]: Update vhost-device-can device and align it with the vhost-device upstream implementation (commit: 42fa1204ec) - https://github.com/rust-vmm/vhost-device/tree/main/staging/vhost-device-can Bug-AGL: SPEC-4966 Change-Id: I9b7f5cb5d84c77198bc0c8b8cebc256fb5df6926 Signed-off-by: Timos Ampelikiotis <t.ampelikiotis@virtualopensystems.com>
Diffstat (limited to 'meta-egvirt/recipes-extended/vhost-device-can/vhost-device-can-0.1.0/README.md')
-rw-r--r--meta-egvirt/recipes-extended/vhost-device-can/vhost-device-can-0.1.0/README.md66
1 files changed, 0 insertions, 66 deletions
diff --git a/meta-egvirt/recipes-extended/vhost-device-can/vhost-device-can-0.1.0/README.md b/meta-egvirt/recipes-extended/vhost-device-can/vhost-device-can-0.1.0/README.md
deleted file mode 100644
index fd50c274..00000000
--- a/meta-egvirt/recipes-extended/vhost-device-can/vhost-device-can-0.1.0/README.md
+++ /dev/null
@@ -1,66 +0,0 @@
-# vhost-device-can - CAN emulation backend daemon
-
-## Description
-This program is a vhost-user backend that emulates a VirtIO CAN device.
-The device's binary takes three (3) parameters: a socket, a 'can-out' and a
-'can-in' device name. The socket is commonly used across all vhost-devices to
-communicate with the vhost-user frontend device.
-
-The 'can-out' represents
-the actual CAN/FD device appears in the host system which vhost-device-can will
-forward the messages from the frontend side. Finaly, the 'can-in' is again a
-CAN/FD device connected on the host systems and vhost-device-can reads CAN/FD
-frames and sends them to the frontend. The 'can-in' and 'can-out' can be find
-by "ip link show" command. Also, the vhost-device-can may have the same CAN/FD
-device name for both 'can-in' and 'can-out', if the user desires to setup a
-loopback configuration.
-
-
-This program is tested with Virtio-loopback's `-device vhost-user-can`.
-Examples section below.
-
-## Synopsis
-
-**vhost-device-can** [*OPTIONS*]
-
-## Options
-
-.. program:: vhost-device-gpio
-
-.. option:: -h, --help
-
- Print help.
-
-.. option:: -s, --socket-path=PATH
-
-.. option:: -i, --can-int='CAN/FD interface name'
-
- The name of the input CAN interface to retrive CAN frames by
-
-.. option:: -o, --can-out='CAN/FD interface name'
-
- The name of the ouput CAN interface to send the CAN frames
-
-## Examples
-
-The daemon should be started first:
-
-::
-
- host# vhost-device-can --socket-path=can.sock --can-in="can0" --can-out="can1"
-
-The virtio-looback invocation needs to insert the [virtio-loopback-transport](https://git.virtualopensystems.com/virtio-loopback/loopback_driver/-/tree/epsilon-release) driver
-and then start the [virito-loopback-adapter](https://git.virtualopensystems.com/virtio-loopback/adapter_app/-/tree/epsilon-release) which is the intermediate between
-vhost-device and virtio-loopback-transport driver.
-
-::
-
- host# sudo insmod loopback_driver.ko
- host# sudo ./adapter -s /path/to/can.sock0 -d vhucan
-
-## License
-
-This project is licensed under either of
-
-- [Apache License](http://www.apache.org/licenses/LICENSE-2.0), Version 2.0
-- [BSD-3-Clause License](https://opensource.org/licenses/BSD-3-Clause)