mirror of https://github.com/rust-vmm/vhost-device.git synced 2026-01-28 04:10:14 +00:00

History

Milan Zamazal 923fa4312a scmi: Add CHANGELOG.md Signed-off-by: Milan Zamazal <mzamazal@redhat.com>		2023-09-04 16:15:33 +01:00
..
kernel/iio-dummy	scmi: Add scale & offset to the accelerator in the kernel	2023-09-04 16:15:33 +01:00
src	scmi: Improve output on backend configuration error	2023-09-04 16:15:33 +01:00
Cargo.toml	scmi: Implement SCMI base protocol	2023-09-04 16:15:33 +01:00
CHANGELOG.md	scmi: Add CHANGELOG.md	2023-09-04 16:15:33 +01:00
LICENSE-APACHE	scmi: Initial skeleton	2023-09-04 16:15:33 +01:00
LICENSE-BSD-3-Clause	scmi: Initial skeleton	2023-09-04 16:15:33 +01:00
README.md	scmi: Improve command line processing	2023-09-04 16:15:33 +01:00

README.md

vhost-device-scmi

This program is a vhost-user backend for a VirtIO SCMI device. It provides SCMI access to various entities on the host; not necessarily only those providing an SCMI interface themselves.

It is tested with QEMU's -device vhost-user-scmi-pci but should work with any virtual machine monitor (VMM) that supports vhost-user. See the Examples section below.

Synopsis

vhost-device-scmi [OPTIONS]

Options

.. program:: vhost-device-scmi

.. option:: -h, --help

Print help.

.. option:: -s, --socket-path=PATH

Location of the vhost-user Unix domain sockets.

.. option:: -d, --device=SPEC

SCMI device specification in the format ID,PROPERTY=VALUE,....
For example: -d iio,path=/sys/bus/iio/devices/iio:device0,channel=in_accel.
Can be used multiple times for multiple exposed devices. If no device is specified then no device will be provided to the guest OS but VirtIO SCMI will be still available there. Use --help-devices to list help on all the available devices.

You can set RUST_LOG environment variable to debug to get maximum messages on the standard error output.

Examples

The daemon should be started first:

host# vhost-device-scmi --socket-path=scmi.sock --device fake,name=foo

The QEMU invocation needs to create a chardev socket the device can use to communicate as well as share the guests memory over a memfd:

host# qemu-system
-chardev socket,path=scmi.sock,id=scmi
-device vhost-user-scmi-pci,chardev=vscmi,id=scmi
-machine YOUR-MACHINE-OPTIONS,memory-backend=mem
-m 4096
-object memory-backend-file,id=mem,size=4G,mem-path=/dev/shm,share=on
...

Supported SCMI protocols

The currently supported SCMI protocols are:

base
sensor management

Basically only the mandatory and necessary parts of the protocols are implemented.

See source code (scmi crate) documentation for details and how to add more protocols, host device bindings or other functionality.

Kernel support for testing

kernel subdirectory contains instructions how to create emulated industrial I/O devices for testing.

License

This project is licensed under either of

Apache License, Version 2.0
BSD-3-Clause License

unless specified in particular files otherwise.