doc: Update Board Inspector

- Update prerequisites, commands, command-line options for v3.0 release

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>

doc/tutorials/board_inspector_tool.rst

@@ -13,21 +13,28 @@ configuration file on the target system. The board configuration file stores
 hardware-specific information extracted from the target platform and is used to
 customize your :ref:`ACRN configuration <acrn_configuration_tool>`.
 
+Prerequisites
+*************
+
+This guide assumes you have set up your target system and successfully launched
+the Board Inspector. For steps, see the following Getting Started Guide
+sections:
+
+* :ref:`gsg-dev-computer`
+* :ref:`gsg-board-setup`
+
 Generate a Board Configuration File
 ***********************************
 
 .. important::
 
-   Whenever you change the configuration of the board, such as BIOS settings,
+   Whenever you change the configuration of the board, such as peripherals, BIOS
-   additional memory, or PCI devices, you must generate a new board
+   settings, additional memory, USB devices, or PCI devices, you must generate a
-   configuration file.
+   new board configuration file.
 
 The following steps describe all options in the Board Inspector for generating
 a board configuration file.
 
-#. Make sure the target system is set up and ready to run the Board Inspector,
-   according to :ref:`gsg-board-setup` in the Getting Started Guide.
-
 #. Run the Board Inspector tool (``board_inspector.py``) to generate the board
    configuration file. This example assumes the tool is in the
    ``~/acrn-work/`` directory and ``my_board`` is the desired file
@@ -35,14 +42,8 @@ a board configuration file.
 
    .. code-block:: bash
 
-      cd ~/acrn-work/board_inspector/
+      cd ~/acrn-work
-      sudo python3 board_inspector.py my_board
+      sudo board_inspector.py my_board
-
-   Upon success, the tool displays a message similar to this example:
-
-   .. code-block:: console
-
-      my_board.xml saved successfully!
 
 #. Confirm that the board configuration file ``my_board.xml`` was generated in
    the current directory.
@@ -58,7 +59,9 @@ Board Inspector with the ``-h`` option yields the following usage message:
 .. code-block::
 
    usage: board_inspector.py [-h] [--out OUT] [--basic] [--loglevel LOGLEVEL]
-                [--check-device-status] board_name
+                             [--check-device-status]
+                             [--add-llc-cat <capacity_mask_length:int>,<clos_number:int>,<has_CDP:bool>]
+                             board_name
 
    positional arguments:
      board_name            the name of the board that runs the ACRN hypervisor
@@ -66,11 +69,15 @@ Board Inspector with the ``-h`` option yields the following usage message:
    optional arguments:
      -h, --help            show this help message and exit
      --out OUT             the name of board info file
-     --basic               do not extract advanced information such as ACPI namespace
+     --basic               do not extract advanced information such as ACPI
-     --loglevel LOGLEVEL   choose log level, e.g. info, warning or error
+                           namespace
+     --loglevel LOGLEVEL   choose log level, e.g. debug, info, warning, error or
+                           critical
      --check-device-status
-
                            filter out devices whose _STA object evaluates to 0
+     --add-llc-cat <capacity_mask_length:int>,<clos_number:int>,<has_CDP:bool>
+                           manually set the Cache Allocation Technology
+                           capability of the last level cache
 
 Details about certain arguments:
 
@@ -98,8 +105,7 @@ Details about certain arguments:
        of board configuration files.
 
    * - ``--loglevel``
-     - Optional. Choose log level, e.g., info, warning or error.
+     - Optional. Choose the log level. (Default is warning.)
-       (Default is warning.)
 
    * - ``--check-device-status``
      - Optional. On some boards, the device status (reported by the _STA
@@ -107,3 +113,12 @@ Details about certain arguments:
        pass-through devices. By default, the Board Inspector includes the
        devices in the board configuration file. This option filters out the
        devices, so that they cannot be used.
+
+   * - ``--add-llc-cat``
+     - Optional. Add the Cache Allocation Technology (CAT) capabilities of the
+       last level cache (LLC) to the generated board configuration file even
+       when the hardware does not report them for any reason. For example,
+       ``--add-llc-cat=12,16,y``. CDP (Code and Data Prioritization) performance
+       feature enables separate control over code and data placement in the
+       processor's cache. Valid values for ``bool`` are
+       ``true|false|y|n|yes|no``.