github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2025-08-14 22:34:26 +00:00
Code Issues Projects Releases Wiki Activity

doc: fix formatting issue and add more info (virtio-net)

Browse Source 
Fix the formatting issue in the "ACRN Device Model parameters" document.

Add more details related to the 'virtio-net' device, specifically what
values can the 'device_type' take.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
Co-authored-by: David Kinder <david.b.kinder@intel.com>
Co-authored-by: Amy Reyes <amy.reyes@intel.com>
This commit is contained in:
Geoffroy Van Cutsem 2022-03-25 11:22:11 +01:00 committed by David Kinder
parent 2aaf61bef8
commit d66c994d33
1 changed files with 17 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
doc/user-guides/acrn-dm-parameters.rst
View File

@ -454,23 +454,25 @@ arguments used for configuration. Here is a table describing these emulated dev
* - ``virtio-net`` * - ``virtio-net``
- Virtio network type device, parameter should be appended with the format: - Virtio network type device, parameter should be appended with the format:
``virtio-net,<device_type>=<name>,[vhost],[mac=<XX:XX:XX:XX:XX:XX>],[mac_seed=<seed_string>]``. ``virtio-net,<device_type>=<name>[,vhost][,mac=<XX:XX:XX:XX:XX:XX> | mac_seed=<seed_string>]``.
The ``mac`` address is optional, ``name`` is the name of the TAP (or MacVTap) device. The only supported ``device_type`` parameter is
``vhost`` specifies vhost backend, otherwise the VBSU backend is used. ``tap``. The ``mac`` address is optional and ``name`` is the name of the TAP
``mac_seed=<seed_string>`` (or MacVTap) device. ``vhost`` specifies vhost backend, otherwise the
Set a platform-unique string as a seed to generate the mac address. Each VBSU backend is used. ``mac_seed=<seed_string>`` sets a platform-unique
VM should have a different "seed_string". The "seed_string" can be string as a seed to generate the MAC address. Each VM should have a
generated by the following method where $(vm_name) contains the name of the different ``seed_string``. The ``seed_string`` can be
VM you are going to launch. generated by the following method where ``$(vm_name)`` contains the name
of the VM you are going to launch.
.. code-block::
mac=$(cat /sys/class/net/e*/address)
seed_string=${mac:9:8}-${vm_name}
.. note:: .. note::
When both ``mac`` and ``mac_seed`` are set, the latter is ignored ``mac`` and ``mac_seed`` are mutually exclusive, when both are set the
and the MAC address is set to the ``mac`` value. ``mac_seed`` will latter is ignored and the MAC address is set to the ``mac`` value.
only be used when ``mac`` is not set. ``mac_seed`` will only be used when ``mac`` is not set.
.. code-block::
mac=$(cat /sys/class/net/e*/address)
seed_string=${mac:9:8}-${vm_name}
* - ``passthru`` * - ``passthru``
- Indicates a passthrough device. Use the parameter with the format - Indicates a passthrough device. Use the parameter with the format