doc: fix formatting issue and add more info (virtio-net)
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.
@@ -454,24 +454,26 @@ arguments used for configuration. Here is a table describing these emulated dev
* - ``virtio-net``
- 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>]``.
- The ``mac`` address is optional, ``name`` is the name of the TAP (or MacVTap) device.
- ``vhost`` specifies vhost backend, otherwise the VBSU backend is used.
- ``mac_seed=<seed_string>``
- Set a platform-unique string as a seed to generate the mac address. Each
- VM should have a different "seed_string". The "seed_string" can be
- generated by the following method where $(vm_name) contains the name of the
- VM you are going to launch.
+ ``virtio-net,<device_type>=<name>[,vhost][,mac=<XX:XX:XX:XX:XX:XX> | mac_seed=<seed_string>]``.
+ The only supported ``device_type`` parameter is
+ ``tap``. The ``mac`` address is optional and ``name`` is the name of the TAP
+ (or MacVTap) device. ``vhost`` specifies vhost backend, otherwise the
+ VBSU backend is used. ``mac_seed=<seed_string>`` sets a platform-unique
+ string as a seed to generate the MAC address. Each VM should have a
+ different ``seed_string``. The ``seed_string`` can be
+ generated by the following method where ``$(vm_name)`` contains the name
+ of the VM you are going to launch.
- .. note::
- When both ``mac`` and ``mac_seed`` are set, the latter is ignored
- and the MAC address is set to the ``mac`` value. ``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}
+ .. note::
+ ``mac`` and ``mac_seed`` are mutually exclusive, when both are set the
+ latter is ignored and the MAC address is set to the ``mac`` value.
+ ``mac_seed`` will only be used when ``mac`` is not set.
+
* - ``passthru``
- Indicates a passthrough device. Use the parameter with the format
``passthru,<bus>/<device>/<function>,<optional parameter>``
