************************************
Important Notice for the BIOS Update
************************************

On the X14 Birch Stream platform, Supermicro starts to use the SuperServer
Automation Assistant (SAA) UEFI tool to perform the motherboard BIOS update.
The update is performed by the BMC in-band or OOB command. Please note that the
AMI flash utility (AFU) and Supermicro Update Manager SUM) used in previous
generations will no longer work on this platform.

*******************************************************************************
The following instructions describe the BIOS upgrade process in the X14 Birch
Stream BIOS flash package. Please follow the instructions carefully to prevent
any need for RMA repair or replacement.
*******************************************************************************

===============================================================================
Standard BIOS Update Procedure under the UEFI Shell
===============================================================================

1. Save the BIOS update package to your workstation computer.

2. Extract the files from the BIOS flash package to a USB stick. 
   
   Note: The USB stick doesn't have to be bootable, but has to be formatted with
         the FAT32 file system.

3. Plug the USB stick into a USB port, boot to the Built-In UEFI Shell, and
   execute saa_activate_RHI.nsh to activate the Redfish Host Interface before
   flashing the BIOS.  By default, the Redfish Host Interface is deactivated.  .

   Shell> fs0:
   fs0:\> cd X14BIOS
   fs0:\X14BIOS> saa_activate_RHI.nsh

4. Type "flash.nsh <BMC Username> <BMC Password> <BIOS Filename>" to start the
   BIOS update:

   fs0:\X14BIOS> flash.nsh USER PASSWORD BIOS_X14DBTB-1D3C_20240423_1.0_STDsp.bin

   Note: The BMC account used for the BIOS update must have admin privileges.

5. The flash.nsh UEFI script will verify the flash command first. Press any key
   to continue, or press "q" or "Q" to abort the BIOS update.

6. The flash script will invoke the SAA (EFI) tool to perform the BIOS update,
   beginning with uploading the BIOS image to BMC.

7. Do not interrupt the process until the BIOS image upload is complete.  The
   system will reboot automatically to continue, after a short message.

8. After the system reboot, BMC will take over and continue the BIOS update in
   the background. The process will take 3-5 minutes. During this stage, the
   green power LED on the front control panel will blink slowly, and the blue
   UID LED will blink rapidly. There will be no display on the screen.

9. Do NOT unplug the power or try to boot up the system until the LEDs stop
   blinking and the BIOS splash screen is shown.

10. After the BIOS update has completed, the system will boot up automatically.

11. After the reboot, go to the Built-In UEFI Shell again, and execute
    saa_deactivate_RHI.nsh to de-activate the Redfish Host Interface.

    Shell> fs0:
    fs0:\> cd X14BIOS
    fs0:\X14BIOS> saa_deactivate_RHI.nsh


===============================================================================
*Remote* BIOS Update using the OOB Method with the SAA Tool
===============================================================================

1. Download and extract the BIOS from the motherboard webpage to the OS.

2. Follow the below URL to download the SAA tool for your OS type:
   https://www.supermicro.com/en/solutions/management-software/<TBD>

3. Extract the SAA tool from the SAA package in the OS.

4. By default, the Redfish Host Interface is disabled.  Run the below command on
   the workstation to enable it first:

   sas -i <BMC IP> -u <BMC User ID> -p <Password -c rawCommand --raw "30 B5 01 01"

   Example:
   ./saa -i 192.168.1.100 -u ADMIN -p PASSWORD -c rawCommand --raw "30 B5 01 01"

5. Run the below command on the workstation to update the remote system's BIOS:

   saa -i <BMC IP> -u <BMC User ID> -p <Password> -c UpdateBIOS --file <BIOS Name> --reboot

   Example:
   ./saa -i 192.168.1.100 -u ADMIN -p PASSWORD -c UpdateBIOS --file 
   BIOS_X14DBTB-1D3C_20240423_1.0_STDsp.bin --reboot

6. Do not interrupt the process or reboot the system until the BIOS is updated
   successfully.

7. Disable the Redfish Host Interface with the below command for better security
   after the BIOS update is done:

   sas -i <BMC IP> -u <BMC User ID> -p <Password -c rawCommand --raw "30 B5 01 00"

   Example:
   ./saa -i 192.168.1.100 -u ADMIN -p PASSWORD -c rawCommand --raw "30 B5 01 00"

Notes: (a) Please use SAA Tool on the X14 Birch Stream Platform.
       (b) The "--reboot" switch must be included in the command.
       (c) The OOB license is not required for this BIOS update method.

===============================================================================
*Local* BIOS Update using the In-band Method with the SAA Tool
===============================================================================

1. Download and extract the BIOS from the motherboard webpage to the local OS.

2. Follow the below URL to download the SAA tool for your OS type:
   https://www.supermicro.com/en/solutions/management-software/<TBD>

3. Extract the SAA tool from the SAA package in the local OS.

4. Navigate to /script/ontrol_RHI/ folder inside SAA tool.  Execute below batch
   script to enable the Redfish Host interface:

   saa_activate_RHI.bat (for Windows), or saa_activate_RHI.sh (for Linux)

5. Return to the BIOS folder again and run the below command on the workstation
   to update the local system's BIOS:

   saa -I Redfish_HI -u <BMC User ID> -p <Password> -c UpdateBIOS --file <BIOS Name> --reboot

   Example:
   ./saa -I Redfish_HI -u ADMIN -p PASSWORD UpdateBIOS --file 
   BIOS_X14DBTB-1D3C_20240423_1.0_STDsp.bin --reboot

6. Do not interrupt the process or reboot the system until the BIOS is updated
   successfully.

7. Navigate to \script\control_RHI\ folder inside SAA tool again to disable the
   Redfish Host Interface with below batch script:

   saa_deactivate_RHI.bat (for Windows), or saa_deactivate_RHI.sh (for Linux)

Notes: (a) Please use SAA Tool on the X14 Birch Steam Platform.
       (b) The in-band method will go through the Redfish Host Interface.
       (c) The "--reboot" switch must be included in the command.
       (d) The OOB license is not required for this BIOS update method.


===============================================================================
*Remote* BIOS Update using the OOB Method on IPMI Web UI
===============================================================================

1. Download & extract the BIOS from the motherboard webpage to the OS.

2. Log into IPMI with an Internet browser.

3. To see the BIOS update feature, click the "Firmware Update" button on the
   Dashboard, or go to the Maintenance menu and click the "Firmware Management"
   button.

4. Click the "BIOS" button and then the "Next" button.

5. Select the BIOS image file, then click the "Upload" button.

6. Do not interrupt the process or reboot the system until the BIOS is updated
   successfully.

Note: The OOB license is not required for this BIOS update method.


*******************************************************************************
RMA Information
*******************************************************************************

If the BIOS flash fails, you may contact our RMA Dept. to have the BIOS
chip reprogrammed. This will require shipping the board to our RMA Dept.
for repair. Please submit your RMA request at:

https://www.supermicro.com/en/support/rma


*******************************************************************************
BIOS Naming Convention
*******************************************************************************

BIOS name  : BIOS_X14DXXX-BBBB_YYYYMMDD_VVV_T.Tt_STDsp.bin

"BIOS"     : BIOS image identifier
X14DXXX    : Project name
BBBB       : 4-digit project ID
YYYY       : Year of the build date
MM         : Month of the build date
DD         : Day of the build date
T.Tt       : BIOS revision number
"STD"      : Standard BIOS ("OEM" = Custom BIOS)
"sp"       : Production signed image (No "sp" means unsigned.)

Examples:
           X14DBM-SP -> BIOS_X14DBMS-1D37_20240416_1.0_STDsp.bin
           X14DBT-B  -> BIOS_X14DBTB-1D3C_20240423_1.0_STDsp.bin





---Last Update on: 06/03/2024---

