Merge pull request #94 from Dasharo/add-odroid-slimbootloader

Add Odroid DPP Dasharo (Slim Bootloader+UEFI) Initial deployment and Transition

Author: DaniilKl

include/dts-environment.sh

@@ -122,6 +122,7 @@ declare DASHARO_REL_VER_DPP
 declare DASHARO_REL_VER_DPP_CAP
 declare HEADS_REL_VER_DPP
 declare DASHARO_REL_VER_DPP_SEABIOS
+declare DASHARO_REL_VER_DPP_SLIMUEFI
 declare COMPATIBLE_EC_FW_VERSION
 # and for capsules:
 declare DASHARO_REL_VER_CAP
@@ -133,6 +134,11 @@ declare DASHARO_REL_VER_DPP_CAP
 # from which Dasharo firmware supports capsule update for current patform. It is
 # set in board_config:
 declare DASHARO_SUPPORT_CAP_FROM
+# MinIO bucket names:
+declare BUCKET_DPP          # Means coreboot+UEFI
+declare BUCKET_DPP_SEABIOS  # Means coreboot+SeaBIOS
+declare BUCKET_DPP_HEADS    # Means coreboot+Headsd
+declare BUCKET_DPP_SLIMUEFI # Means Slim Bootloader+UEFI
 # Links to files:
 declare BIOS_LINK_COMM
 declare BIOS_HASH_LINK_COMM
@@ -143,6 +149,9 @@ declare BIOS_SIGN_LINK_DPP
 declare BIOS_LINK_DPP_SEABIOS
 declare BIOS_HASH_LINK_DPP_SEABIOS
 declare BIOS_SIGN_LINK_DPP_SEABIOS
+declare BIOS_LINK_DPP_SLIMUEFI
+declare BIOS_HASH_LINK_DPP_SLIMUEFI
+declare BIOS_SIGN_LINK_DPP_SLIMUEFI
 declare EC_LINK_COMM
 declare EC_HASH_LINK_COMM
 declare EC_SIGN_LINK_COMM

include/dts-functions.sh

@@ -654,6 +654,8 @@ board_config() {
     esac
 
     BIOS_LINK_DPP="$BUCKET_DPP/$DASHARO_REL_NAME/v$DASHARO_REL_VER_DPP/${DASHARO_REL_NAME}_v$DASHARO_REL_VER_DPP.rom"
+    # TODO: check if it really will be called "*_slimuefi_*.rom"
+    BIOS_LINK_DPP_SLIMUEFI="${BUCKET_DPP_SLIMUEFI}/${DASHARO_REL_NAME}/v${DASHARO_REL_VER_DPP_SLIMUEFI}/${DASHARO_REL_NAME}_v${DASHARO_REL_VER_DPP_SLIMUEFI}_slim_bootloader_uefi.rom"
     ;;
   "QEMU" | "Emulation")
     case "$SYSTEM_MODEL" in
@@ -688,6 +690,8 @@ board_config() {
   [ -z "$BIOS_SIGN_LINK_DPP_SEABIOS" ] && BIOS_SIGN_LINK_DPP_SEABIOS="${BIOS_HASH_LINK_DPP_SEABIOS}.sig"
   [ -z "$HEADS_HASH_LINK_DPP" ] && HEADS_HASH_LINK_DPP="${HEADS_LINK_DPP}.sha256"
   [ -z "$HEADS_SIGN_LINK_DPP" ] && HEADS_SIGN_LINK_DPP="${HEADS_HASH_LINK_DPP}.sig"
+  [ -z "$BIOS_HASH_LINK_DPP_SLIMUEFI" ] && BIOS_HASH_LINK_DPP_SLIMUEFI="${BIOS_LINK_DPP_SLIMUEFI}.sha256"
+  [ -z "$BIOS_SIGN_LINK_DPP_SLIMUEFI" ] && BIOS_SIGN_LINK_DPP_SLIMUEFI="${BIOS_HASH_LINK_DPP_SLIMUEFI}.sig"
   [ -z "$EC_HASH_LINK_COMM" ] && EC_HASH_LINK_COMM="${EC_LINK_COMM}.sha256"
   [ -z "$EC_SIGN_LINK_COMM" ] && EC_SIGN_LINK_COMM="${EC_HASH_LINK_COMM}.sig"
   [ -z "$EC_HASH_LINK_DPP" ] && EC_HASH_LINK_DPP="${EC_LINK_DPP}.sha256"
@@ -1410,11 +1414,7 @@ show_main_menu() {
   if [ -f "${DPP_SUBMENU_JSON}" ]; then
     echo -e "${BLUE}**${YELLOW}     ${DPP_SUBMENU_OPT})${BLUE} DTS extensions${NORMAL}"
   fi
-  # As of now show this option only for PC Engines and only for non-UEFI
-  # firmware as we only implement transition to UEFI for PC Engines
-  # TODO: migrate all transition logic here e.g. Heads, UEFI->SeaBIOS if
-  # possible
-  if ! $FSREAD_TOOL test -d "/sys/firmware/efi" && [[ "$SYSTEM_VENDOR" == "PC Engines" ]]; then
+  if check_if_dasharo; then
     echo -e "${BLUE}**${YELLOW}     ${TRANSITION_OPT})${BLUE} Transition Dasharo Firmware${NORMAL}"
   fi
 }
@@ -1580,6 +1580,9 @@ main_menu_options() {
     return 0
     ;;
   "${TRANSITION_OPT}")
+    # No transition, if there is no Dasharo firmware installed:
+    check_if_dasharo || return 0
+
     ${CMD_DASHARO_DEPLOY} transition
     result=$?
     if [ "$result" -ne $OK ] && [ "$result" -ne $CANCEL ]; then

include/dts-subscription.sh

@@ -21,6 +21,7 @@ check_for_dasharo_firmware() {
   local _check_dwn_req_resp_uefi_cap="0"
   local _check_dwn_req_resp_heads="0"
   local _check_dwn_req_resp_seabios="0"
+  local _check_dwn_req_resp_slimuefi="0"
   local _check_logs_req_resp="0"
   # Ignore "SC2154 (warning): DPP_CREDENTIAL_FILE is referenced but not assigned"
   # for external variable:
@@ -32,7 +33,7 @@ check_for_dasharo_firmware() {
   board_config
 
   # If board_config function has not set firmware links - exit with warning:
-  if [ -z "$BIOS_LINK_DPP" ] && [ -z "$HEADS_LINK_DPP" ] && [ -z "$BIOS_LINK_DPP_SEABIOS" ] && [ -z "$BIOS_LINK_DPP_CAP" ]; then
+  if [ -z "$BIOS_LINK_DPP" ] && [ -z "$HEADS_LINK_DPP" ] && [ -z "$BIOS_LINK_DPP_SEABIOS" ] && [ -z "$BIOS_LINK_DPP_CAP" ] && [ -z "$BIOS_LINK_DPP_SLIMUEFI" ]; then
     print_warning "There is no Dasharo Firmware available for your platform."
     return 1
   fi
@@ -58,13 +59,19 @@ check_for_dasharo_firmware() {
       mc find "${DPP_SERVER_USER_ALIAS}/${BIOS_LINK_DPP_SEABIOS}" >/dev/null 2>>"$ERR_LOG_FILE"
       _check_dwn_req_resp_seabios=$?
     fi
+
+    if [ -n "$BIOS_LINK_DPP_SLIMUEFI" ]; then
+      mc find "${DPP_SERVER_USER_ALIAS}/${BIOS_LINK_DPP_SLIMUEFI}" >/dev/null 2>>"$ERR_LOG_FILE"
+      _check_dwn_req_resp_slimuefi=$?
+    fi
+
     if [ -n "${DPP_EMAIL}" ]; then
       mc find "${DPP_SERVER_USER_ALIAS}/${DPP_BUCKET}" >/dev/null 2>>"$ERR_LOG_FILE"
       _check_logs_req_resp=$?
     fi
   fi
   # Return 0 if any of Dasharo Firmware binaries is available:
-  if [ ${_check_dwn_req_resp_uefi} -eq 0 ] || [ ${_check_dwn_req_resp_uefi_cap} -eq 0 ] || [ ${_check_dwn_req_resp_heads} -eq 0 ] || [ ${_check_dwn_req_resp_seabios} -eq 0 ]; then
+  if [ ${_check_dwn_req_resp_uefi} -eq 0 ] || [ ${_check_dwn_req_resp_uefi_cap} -eq 0 ] || [ ${_check_dwn_req_resp_heads} -eq 0 ] || [ ${_check_dwn_req_resp_seabios} -eq 0 ] || [ ${_check_dwn_req_resp_slimuefi} -eq 0 ]; then
     if [ ${_check_logs_req_resp} -eq 0 ]; then
       print_ok "A Dasharo Firmware binary has been found for your platform!"
       return 0

include/hal/dts-hal.sh

@@ -200,3 +200,75 @@ check_me_op_mode() {
 
   return 0
 }
+
+check_if_uefi() {
+  # Check if current firmware has UEFI payload. Returns 0 on  success, otherwise
+  # returns 1.
+  grep -q 'UEFI' <(echo "${DASHARO_FLAVOR}") && return 0
+  # Additional check is useful sometimes:
+  $FSREAD_TOOL test -d "/sys/firmware/efi" && return 0
+
+  return 1
+}
+
+check_if_seabios() {
+  # Check if current firmware has SeaBIOS payload. Returns 0 on  success,
+  # otherwise returns 1.
+  grep -q 'SeaBIOS' <(echo "${DASHARO_FLAVOR}") && return 0
+  # Additional check is useful sometimes:
+  tmp_rom=$(mktemp --dry-run)
+  config=/tmp/config
+  # Get current firmware:
+  $FLASHROM flashrom_read_firm_mock -p "$PROGRAMMER_BIOS" ${FLASH_CHIP_SELECT} -r "$tmp_rom" >>"$FLASH_INFO_FILE" 2>>"$ERR_LOG_FILE"
+
+  if [ -f "$tmp_rom" ]; then
+    # extract config
+    $CBFSTOOL read_bios_conffile_mock "$tmp_rom" extract -n config -f "$config" >/dev/null 2>>"$ERR_LOG_FILE"
+    grep -q "CONFIG_PAYLOAD_SEABIOS=y" "$config" 2>>"${ERR_LOG_FILE}" && return 0
+  fi
+
+  return 1
+}
+
+check_for_transition() {
+  # This function checks for possible transition for current hardware and
+  # firmware configuration flows and returns:
+  # * In case no transition flows sare available: return code 1 and empty
+  # stdout.
+  # * In case at least one transition flow is available: return code 0 and the
+  # transition flow name on stdout.
+  #
+  # Check the end of the function for stdout formatting.
+  local _is_uefi="false"
+  local _is_seabios="false"
+  local _transition_list=()
+
+  # The transition is only possible from Dasharo firmware:
+  check_if_dasharo || return 1
+  check_if_uefi && _is_uefi="true"
+  check_if_seabios && _is_seabios="true"
+
+  if [[ "$_is_uefi" == "true" ]]; then
+    # Dasharo (coreboot+UEFI) is installed, check possible transitions:
+    if [[ "$COREBOOT_UEFI_TO_SLIM_BOOTLOADER_UEFI_TRANSITION" == "true" ]]; then
+      _transition_list+=("Dasharo (coreboot+UEFI) to Dasharo (Slim Bootloader+UEFI)")
+    fi
+  fi
+
+  if [[ "$_is_seabios" == "true" ]]; then
+    # Dasharo (coreboot+SeaBIOS) is installed, check possible transitions:
+    if [[ "$COREBOOT_SEABIOS_TO_COREBOOT_UEFI_TRANSITION" == "true" ]]; then
+      _transition_list+=("Dasharo (coreboot+SeaBIOS) to Dasharo (coreboot+UEFI)")
+    fi
+  fi
+
+  # This loop will make this function return a string that contains a string
+  # that contains possible transitions separated by a new line, so it can be
+  # easily reconstructed back to an array with
+  # readarray -t transitions < <(check_for_transition)
+  for transition in "${_transition_list[@]}"; do
+    echo "$transition"
+  done
+
+  [[ -n "${_transition_list[*]}" ]] && return 0 || return 1
+}