From 410d317fe42ccd895746dd111720d0fc0687f8e5 Mon Sep 17 00:00:00 2001 From: "David B. Kinder" Date: Wed, 20 Apr 2022 13:32:20 -0700 Subject: [PATCH] doc: update schema type documentation Add documentation for enumerated types and value restrictions so it shows up in the option documention. Also add additional acrn:title annotations. Tracked-On: #5692 Signed-off-by: David B. Kinder --- misc/config_tools/schema/VMtypes.xsd | 28 ++++++++++++++++++++++----- misc/config_tools/schema/config.xsd | 6 +++--- misc/config_tools/schema/types.xsd | 29 ++++++++++++++++++++++++---- 3 files changed, 51 insertions(+), 12 deletions(-) diff --git a/misc/config_tools/schema/VMtypes.xsd b/misc/config_tools/schema/VMtypes.xsd index f5ffc55d6..bd803bd2b 100644 --- a/misc/config_tools/schema/VMtypes.xsd +++ b/misc/config_tools/schema/VMtypes.xsd @@ -7,8 +7,8 @@ Current supported VM types are: -- ``PRE_LAUNCHED_VM`` pre-launched VM - ``SERVICE_VM`` Service VM +- ``PRE_LAUNCHED_VM`` pre-launched VM - ``POST_LAUNCHED_VM`` post-launched VM @@ -46,8 +46,7 @@ - A pCPU that this VM's vCPU is allowed to pin -to. + A pCPU that this VM's vCPU is allowed to pin to. @@ -180,7 +179,7 @@ CLOSID 0 and the second is mapped to virtual CLOSID 1, etc. - vCOM type + A string with value: ``legacy`` or ``pci``. @@ -214,7 +213,11 @@ CLOSID 0 and the second is mapped to virtual CLOSID 1, etc. - + + + Specify the vUART name. + + Select the communication virtual UART (vUART) type. @@ -257,6 +260,9 @@ CLOSID 0 and the second is mapped to virtual CLOSID 1, etc. + + A string with value: ``Kernel based (Virtual Host)`` or ``User space based (VBSU)``. + @@ -275,6 +281,9 @@ CLOSID 0 and the second is mapped to virtual CLOSID 1, etc. Specify the network interface name that will appear in the Service VM. Use the `ip a` command in the Service VM to display the network interface names. + + A string of letters, digits, ``_``, or ``-``. + @@ -284,6 +293,9 @@ CLOSID 0 and the second is mapped to virtual CLOSID 1, etc. + + A string with value: ``Virtio console`` or ``Virtio serial port`` + @@ -291,6 +303,9 @@ CLOSID 0 and the second is mapped to virtual CLOSID 1, etc. + + A string with value: ``pty``, ``stdio``, or ``file``. + @@ -350,6 +365,9 @@ device file when user config it as virtio serial port, which can be read and wri Specifying unique identifier to distinguish same devices in guest. + + A string with letters, digits, ``_``, or ``-``. + diff --git a/misc/config_tools/schema/config.xsd b/misc/config_tools/schema/config.xsd index 8a6a23495..fe0651c98 100644 --- a/misc/config_tools/schema/config.xsd +++ b/misc/config_tools/schema/config.xsd @@ -298,7 +298,7 @@ Refer to :ref:`vuart_config` for detailed vUART settings. - string from 1 to 32 characters long. + A string from 1 to 32 characters long (with no spaces). @@ -474,14 +474,14 @@ mouse, and tablet. It sends Linux input layer events over virtio. - + The hypervisor configuration defines a working scenario and target board by configuring the hypervisor image features and capabilities such as setting up the log and the serial port. - + VM configuration includes **scenario-based** VM configuration information that is used to describe the characteristics and attributes for all VMs in a user scenario. It also includes **launch script-based** VM diff --git a/misc/config_tools/schema/types.xsd b/misc/config_tools/schema/types.xsd index cd333a352..2a47703e1 100644 --- a/misc/config_tools/schema/types.xsd +++ b/misc/config_tools/schema/types.xsd @@ -14,6 +14,9 @@ + + A string with value: ``Enable`` or ``Disable``. + @@ -22,7 +25,7 @@ - An Integer value in hexadecimal format. + An Integer value in hexadecimal format (with a leading ``0x``). @@ -37,7 +40,7 @@ - A string that indicates the build type of the hypervisor. + A string with value ``Release`` or ``Debug`` that indicates the build type of the hypervisor. @@ -126,14 +129,14 @@ higher value (lower severity) are discarded. - Options: + A string specifying the scheduling option: - ``No-Operation (NOOP)``: The No-Operation (NOOP) scheduler means there is a strict one-to-one mapping between vCPUs and pCPUs. - ``Borrowed Virtual Time``: The Borrowed Virtual Time (BVT) scheduler is a virtual time-based scheduling algorithm. It dispatches the runnable thread with the earliest effective virtual time. -- ``Priority Based Scheduling``: The priority based scheduler supports vCPU scheduling based on their pre-configured priorities. +- ``Priority Based Scheduling``: The priority based scheduler supports vCPU scheduling based on pre-configured priorities. Read more about the available scheduling options in :ref:`cpu_sharing`. @@ -181,18 +184,27 @@ Read more about the available scheduling options in :ref:`cpu_sharing`. + + A string of up to 15 letters, digits, ``_``, or ``-``. + + + A string with up to two hex digits, a ``:``, two hex digits, a ``.``, and one digit between 0-7. + + + A string with value ``Hypervisor`` or ``Device Model``. + @@ -215,6 +227,9 @@ Read more about the available scheduling options in :ref:`cpu_sharing`. + + A sequence of Shared VM names and their Virtual BDF values. + @@ -225,6 +240,9 @@ Read more about the available scheduling options in :ref:`cpu_sharing`. + + An Integer with value a power of 2 between 2 and 512. + @@ -245,6 +263,9 @@ Read more about the available scheduling options in :ref:`cpu_sharing`.Name of the shared memory region. + + A string with no spaces. +