github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2025-06-22 21:47:22 +00:00
Code Issues Projects Releases Wiki Activity

minor content edits to virtio-rnd doc

Browse Source 
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
This commit is contained in:
Deb Taylor 2019-10-17 22:31:43 -04:00 committed by deb-intel
parent 89ec29e1ee
commit 712dfa9589
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
doc/developer-guides/hld/virtio-rnd.rst
View File

@ -3,8 +3,8 @@
Virtio-rnd Virtio-rnd
########## ##########
Virtio-rnd provides a virtual hardware random source for UOS. It simulates a PCI device Virtio-rnd provides a virtual hardware random source for the UOS. It simulates a PCI device
followed virtio specification, and implemented base on virtio user mode framework. followed by a virtio specification, and is implemented based on the virtio user mode framework.
Architecture Architecture
************ ************
@ -16,11 +16,11 @@ components are parts of Linux software or third party tools.
virtio-rnd is implemented as a virtio legacy device in the ACRN device virtio-rnd is implemented as a virtio legacy device in the ACRN device
model (DM), and is registered as a PCI virtio device to the guest OS model (DM), and is registered as a PCI virtio device to the guest OS
(UOS). Tools such as :command:`od` (dump a file in octal or other format) can (UOS). Tools such as :command:`od` (dump a file in octal or other format) can
be used to read random values from ``/dev/random``. This device file in be used to read random values from ``/dev/random``. This device file in the
UOS is bound with the frontend virtio-rng driver. (The guest kernel must UOS is bound with the frontend virtio-rng driver. (The guest kernel must
be built with ``CONFIG_HW_RANDOM_VIRTIO=y``). The backend be built with ``CONFIG_HW_RANDOM_VIRTIO=y``). The backend
virtio-rnd reads the HW random value from ``/dev/random`` in SOS and sends virtio-rnd reads the HW random value from ``/dev/random`` in the SOS and sends
them to frontend. them to the frontend.
.. figure:: images/virtio-hld-image61.png .. figure:: images/virtio-hld-image61.png
:align: center :align: center
@ -31,18 +31,18 @@ them to frontend.
How to Use How to Use
********** **********
Add a pci slot to the device model acrn-dm command line, for example:: Add a pci slot to the device model acrn-dm command line; for example::
-s <slot_number>,virtio-rnd -s <slot_number>,virtio-rnd
Check if the frontend virtio_rng driver is available in UOS: Check to see if the frontend virtio_rng driver is available in the UOS:
.. code-block:: console .. code-block:: console
# cat /sys/class/misc/hw_random/rng_available # cat /sys/class/misc/hw_random/rng_available
virtio_rng.0 virtio_rng.0
Check if frontend virtio_rng is currently connected to ``/dev/random``: Check to see if the frontend virtio_rng is currently connected to ``/dev/random``:
.. code-block:: console .. code-block:: console
@ -71,5 +71,5 @@ Read random values:
.. note:: HW randomness is a precious resource of the system. The .. note:: HW randomness is a precious resource of the system. The
:command:`od` command will block and wait until there is randomness :command:`od` command will block and wait until randomness is
available. available.