pxcloud/vhost-device
5
0
Fork 0
mirror of https://github.com/rust-vmm/vhost-device.git synced 2025-12-26 14:41:23 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
d43fd79bb7
vhost-device/vhost-device-spi
History
Ruoqing He d43fd79bb7 clippy: Fix clippy::precedence 
Fix `clippy::precedence` warnings reported by clippy 0.1.85 (4d91de4e48
2025-02-17).

```console
error: operator precedence can trip the unwary
   --> vhost-device-template/src/vhu_foo.rs:152:9
    |
152 | /         1 << VIRTIO_F_VERSION_1
153 | |             | 1 << VIRTIO_F_NOTIFY_ON_EMPTY
154 | |             | 1 << VIRTIO_RING_F_INDIRECT_DESC
155 | |             | 1 << VIRTIO_RING_F_EVENT_IDX
    | |__________________________________________^
    |
    = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#precedence
    = note: `-D clippy::precedence` implied by `-D warnings`
    = help: to override `-D warnings` add `#[allow(clippy::precedence)]`
help: consider parenthesizing your expression
    |
152 ~         1 << VIRTIO_F_VERSION_1
153 +             | 1 << VIRTIO_F_NOTIFY_ON_EMPTY
154 +             | 1 << VIRTIO_RING_F_INDIRECT_DESC | (1 << VIRTIO_RING_F_EVENT_IDX)
    |
```

Signed-off-by: Ruoqing He <heruoqing@iscas.ac.cn>
2025-03-31 13:45:27 +02:00
..
src clippy: Fix clippy::precedence 2025-03-31 13:45:27 +02:00
Cargo.toml build(deps): bump the rust-vmm group across 2 directories with 1 update 2025-02-17 10:23:08 +02:00
CHANGELOG.md spi: fix changelog format 2024-07-30 19:03:28 +05:30
LICENSE-APACHE vhost-device-spi: Add initial implementation 2024-07-29 09:51:40 +02:00
LICENSE-BSD-3-Clause vhost-device-spi: Add initial implementation 2024-07-29 09:51:40 +02:00
README.md vhost-device-spi: Add initial implementation 2024-07-29 09:51:40 +02:00

README.md

vhost-device-spi - SPI emulation backend daemon

Description

This program is a vhost-user backend that emulates a VirtIO SPI bus. This program takes the layout of the spi bus and its devices on the host OS and then talks to them via the /dev/spidevX.Y interface when a request comes from the guest OS for a SPI device.

Synopsis

vhost-device-spi [OPTIONS]

Options

 -h, --help

  Print help.

 -s, --socket-path=PATH

  Location of vhost-user Unix domain sockets, this path will be suffixed with
  0,1,2..socket_count-1.

 -c, --socket-count=INT

  Number of guests (sockets) to attach to, default set to 1.

 -l, --device=SPI-DEVICES

  Spi device full path at the host OS in the format:
      /dev/spidevX.Y

  Here,
      X: is spi controller's bus number.
      Y: is chip select index.

Examples

Dependencies

For testing the device the required dependencies are:

Test the device

First start the daemon on the host machine::

```console
vhost-device-spi --socket-path=vspi.sock --socket-count=1 --device "/dev/spidev0.0"
```

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

```console
qemu-system-aarch64 -m 1G \
    -chardev socket,path=/home/root/vspi.sock0,id=vspi \
    -device vhost-user-spi-pci,chardev=vspi,id=spi \
    -object memory-backend-file,id=mem,size=1G,mem-path=/dev/shm,share=on \
    -numa node,memdev=mem \
    ...
```

License

This project is licensed under either of