Merge branch 'main' into lizebin/move-iter-out

Author: cutelizebin

Cargo.lock

@@ -1,9 +1,11 @@
 [workspace]
+resolver = "2"
 
 members = [
     "crates/gpio",
     "crates/i2c",
     "crates/rng",
     "crates/scsi",
+    "crates/scmi",
     "crates/vsock",
 ]

Cargo.toml

@@ -1,5 +1,5 @@
 {
-  "coverage_score": 68.2,
+  "coverage_score": 71.0,
   "exclude_path": "",
   "crate_features": ""
 }

coverage_config_x86_64.json

@@ -183,7 +183,7 @@ impl SmbusMsg {
     ///
     /// These smbus related functions try to reverse what Linux does, only
     /// support basic modes (up to word transfer).
-    fn new(reqs: &mut [I2cReq]) -> Result<SmbusMsg> {
+    fn new(reqs: &[I2cReq]) -> Result<SmbusMsg> {
         let mut data = I2cSmbusData {
             block: [0; I2C_SMBUS_BLOCK_MAX + 2],
         };

crates/i2c/src/i2c.rs

@@ -0,0 +1,15 @@
+# Changelog
+## [Unreleased]
+
+### Added
+
+### Changed
+
+### Fixed
+
+### Deprecated
+
+## [0.1.0]
+
+First release
+

crates/scmi/CHANGELOG.md

@@ -0,0 +1,27 @@
+[package]
+name = "vhost-device-scmi"
+version = "0.1.0"
+authors = ["Milan Zamazal <[email protected]>"]
+description = "vhost-user SCMI backend device"
+repository = "https://github.com/rust-vmm/vhost-device"
+readme = "README.md"
+keywords = ["scmi", "vhost", "virt", "backend"]
+license = "Apache-2.0 OR BSD-3-Clause"
+edition = "2021"
+
+[dependencies]
+clap = { version = "4.3",  features = ["derive"] }
+env_logger = "0.10"
+itertools = "0.10"
+log = "0.4"
+thiserror = "1.0"
+vhost = { version = "0.8", features = ["vhost-user-slave"] }
+vhost-user-backend = "0.10"
+virtio-bindings = "0.2"
+virtio-queue = "0.9"
+vm-memory = "0.12"
+vmm-sys-util = "0.11"
+
+[dev-dependencies]
+assert_matches = "1.5"
+virtio-queue = { version = "0.9", features = ["test-utils"] }

crates/scmi/Cargo.toml

@@ -0,0 +1 @@
+../../LICENSE-APACHE

crates/scmi/LICENSE-APACHE

@@ -0,0 +1 @@
+../../LICENSE-BSD-3-Clause

crates/scmi/LICENSE-BSD-3-Clause

@@ -0,0 +1,104 @@
+# 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.
+
+## Testing
+
+SCMI is supported only on Arm in Linux.  This restriction doesn't
+apply to the host, which can be any architecture as long as the guest
+is Arm.
+
+The easiest way to test it on the guest side is using the Linux SCMI
+Industrial I/O driver there.  If an 3-axes accelerometer or gyroscope
+VirtIO SCMI device is present and the guest kernel is compiled with
+`CONFIG_IIO_SCMI` enabled then the device should be available in
+`/sys/bus/iio/devices/`.  The vhost-device-scmi fake device is
+suitable for this.
+
+Of course, other means of accessing SCMI devices can be used too.  The
+following Linux kernel command line can be useful to obtain SCMI trace
+information, in addition to SCMI related messages in dmesg:
+`trace_event=scmi:* ftrace=function ftrace_filter=scmi*`.
+
+### Kernel support for testing
+
+`kernel` subdirectory contains
+[instructions](kernel/iio-dummy/README.md) how to create emulated
+industrial I/O devices for testing.
+
+## 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)
+
+unless specified in particular files otherwise.

crates/scmi/README.md

@@ -0,0 +1,7 @@
+*.cmd
+*.ko
+*.mod
+*.mod.[co]
+*.o
+Module.symvers
+modules.order