doc: change the parameter of virtio-net

Remove device name requirement for “tap” and "vmnet", change the
parameter format like:
"-s 4,virtio-net,tap/vmnet=dev_name".
change mac_seed to virtio-net sub-parameter
As a parameter of acrn-dm,the mac_seed is only used for virtio-net.
So this patch change it to the sub-parameter of virtio-net.
The final format is:
-s 4,virtio-net,tap/vmnet=dev_name,mac_seed=XXXX

Tracked-On: #6690
Signed-off-by: Chenli Wei chenli.wei@linux.intel.com
This commit is contained in:
Chenli Wei
2022-03-21 09:58:25 +08:00
committed by David Kinder
parent f5b021b1b5
commit 7dec39a9e8
9 changed files with 34 additions and 38 deletions

View File

@@ -93,19 +93,6 @@ Here are descriptions for each of these ``acrn-dm`` command line parameters:
----
``--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.
.. code-block::
mac=$(cat /sys/class/net/e*/address)
seed_string=${mac:9:8}-${vm_name}
----
``-r``, ``--ramdisk <ramdisk_image_path>``
Set the ramdisk (full path) for the User VM. The maximum length is 1023.
The supported ramdisk format depends on your User VM kernel configuration.
@@ -467,10 +454,23 @@ 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_name>,[vhost],[mac=<XX:XX:XX:XX:XX:XX>]``.
The ``mac`` address is optional, ``device_name`` is the name of the TAP (or MacVTap) device.
It must include the keyword ``tap``.
``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.
.. 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}
* - ``passthru``
- Indicates a passthrough device. Use the parameter with the format