diff --git a/doc/user-guides/acrn-dm-parameters.rst b/doc/user-guides/acrn-dm-parameters.rst index 8bf9896c1..c7d549914 100755 --- a/doc/user-guides/acrn-dm-parameters.rst +++ b/doc/user-guides/acrn-dm-parameters.rst @@ -454,23 +454,25 @@ 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,=,[vhost],[mac=],[mac_seed=]``. - 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=`` - 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,=[,vhost][,mac= | mac_seed=]``. + 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=`` 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. + + .. code-block:: + + mac=$(cat /sys/class/net/e*/address) + seed_string=${mac:9:8}-${vm_name} .. 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} + ``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