From 9d5e2e0b21a2e8da75b8d3986fae5526e95b9f21 Mon Sep 17 00:00:00 2001
From: Ron Stone <ronald.stone@windriver.com>
Date: Fri, 8 Oct 2021 11:43:46 -0400
Subject: [PATCH] N3000 firmware update for BMC and Retimer

Add BMC Retimer bool to functional device-image-upload options.
Formatting fixes.
Addressed patchset 2 review comments.

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I1bfcf996ef8f3ee3dc4d034cedb2aaf2c3046cec
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
---
 .../updating-an-intel-n3000-fpga-image.rst    | 26 +++++++++++--------
 1 file changed, 15 insertions(+), 11 deletions(-)

diff --git a/doc/source/node_management/kubernetes/hardware_acceleration_devices/updating-an-intel-n3000-fpga-image.rst b/doc/source/node_management/kubernetes/hardware_acceleration_devices/updating-an-intel-n3000-fpga-image.rst
index 14f0571dd..65b550157 100644
--- a/doc/source/node_management/kubernetes/hardware_acceleration_devices/updating-an-intel-n3000-fpga-image.rst
+++ b/doc/source/node_management/kubernetes/hardware_acceleration_devices/updating-an-intel-n3000-fpga-image.rst
@@ -92,40 +92,44 @@ specialized equipment.
 
         .. code-block:: none
 
-            ~(keystone_admin)$ system device-image-upload <imagefile> functional <pci_vendor> <pci_device> --bitstream-id <bitstream_id> --name <imagename> --description <description> --image-version <version>
+            ~(keystone_admin)$ system device-image-upload <imagefile> functional <pci_vendor> <pci_device> --bitstream-id <bitstream_id> --name <imagename> --description <description> --image-version <version> --retimer-included <true/false>
 
     In the above :command:`device-image-upload` commands, the following
     substitutions apply:
 
-    **<imagefile>**
+    ``<imagefile>``
         The filepath of the binary device image file.
 
-    **<pci\_vendor>**
+    ``<pci_vendor>``
         The hexadecimal string identifying the |PCI| vendor ID of the device
         this image applies to.
 
-    **<pci\_device>**
+    ``<pci_device>``
         The hexadecimal string identifying the |PCI| device ID of the device
         this image applies to.
 
-    **<key\_signature>**
+    ``<key_signature>``
         A hexidecimal string identifying the root key device image.
 
-    **<revoke\_key\_id>**
+    ``<revoke_key_id>``
         A decimal key ID for the key revocation device image.
 
-    **<bitstream\_id>**
+    ``<bitstream_id>``
         A hexidecimal string of the functional device image.
 
-    **<name>**
+    ``<name>``
         The name of the device image \(optional\).
 
-    **<description>**
+    ``<description>``
         Is the description of the device image \(optional\).
 
-    **<image-version>**
+    ``<image-version>``
         The version of the device image \(optional\).
 
+    ``--retimer-included <true/false>``
+        A boolean indicates whether the |BMC| firmware includes a retimer
+        firmware (optional).
+
 #.  Assign a device label to the device.
 
     Labels are key-value pairs that are assigned to host |PCI| devices and are
@@ -211,7 +215,7 @@ specialized equipment.
 
     -   Once all pending device updates for the host are complete,
         :command:`system host-show` <hostname> will again display an empty
-        string for **device\_image\_update**.
+        string for **device_image_update**.
 
 #.  Lock and unlock the host.