WIP: Refactor sanity check

Signed-off-by: Mateusz Kusiak <mateusz.kusiak@3mdeb.com>

Author: 3mkusiak

include/dts-functions.sh

@@ -688,17 +688,55 @@ set_flashrom_update_params() {
   fi
 }
 
-# A final check for locked regions before flashing via flashrom.
-# Decide whether we can proceed if any regions are locked.
-flashrom_sanity_check() {
+# Does combined check to assess whether the board has region and if its locked.
+is_region_locked() {
+  local region="$1"
+  local has_var rw_var
+
+  # Uppercase
+  region="${region^^}"
+
+  has_var="BOARD_HAS_${region}_REGION"
+  rw_var="BOARD_${region}_REGION_RW"
+
+  [[ "${!has_var}" -eq 1 && "${!rw_var}" -eq 0 ]]
+}
+
+# Helper function to check whether a certain region is to be flashed.
+# 0 if found, 1 otherwise.
+flashrom_check_for_region() {
+  local region="$1"
+  local -n _args="$2"
+  local i
+
+  # Iterate only up to length-1 since we inspect pairs (i, i+1)
+  for ((i = 0; i < ${#_args[@]} - 1; i++)); do
+    if [[ "${_args[i]}" == "-i" && "${_args[i + 1]}" == "$region" ]]; then
+      return 0
+    fi
+  done
+
+  return 1
+}
+
+# Does a final check for all flashrom parameters if FD or ME are to be flashed
+# and if they're locked. Decide whether we can proceed if any regions are locked.
+flashrom_region_check() {
+  local -n args="$1"
   local locked_regions=()
   local region_list verb
 
-  if [ "$BOARD_FD_REGION_RW" -eq 0 ]; then
+  # If switching to heads, always check the region, otherwise check region only
+  # if specified in params.
+  # The reason is we want to handle both "overwrites" form metadata as well as
+  # dynamically added params from set_intel_regions_update_params()
+  if { flashrom_check_for_region fd args || [[ "$SWITCHING_TO" == "heads" ]]; } &&
+    is_region_locked fd; then
     locked_regions+=("FD")
   fi
 
-  if [ "$BOARD_ME_REGION_RW" -eq 0 ]; then
+  if { flashrom_check_for_region me args || [[ "$SWITCHING_TO" == "heads" ]]; } &&
+    is_region_locked me; then
     locked_regions+=("ME")
   fi
 
@@ -716,10 +754,11 @@ flashrom_sanity_check() {
 
   if [[ "$SWITCHING_TO" == "heads" ]]; then
     print_error "Cannot proceed with heads update when $region_list $verb locked!"
+    print_error "Refer to: https://docs.dasharo.com/guides/firmware-update/#known-issues"
     return 1
   fi
 
-  print_warning "Proceeding without $region_list $verb flashing, as they $verb not critical."
+  print_warning "Proceeding without $region_list flashing, as it is not critical."
   return 0
 }
 

scripts/dasharo-deploy.sh

@@ -880,9 +880,11 @@ deploy_firmware() {
   local _mode
   local _jobs=()     # List of scheduled job indices
   local _messages=() # List of error messages
-  # _job_args_<i> # List of flashrom params per job indice
+  # _job_args_<i>    # List of flashrom params per job indice
   # These are created dynamically in schedule_job() and referenced via nameref.
   local _jobs_total=0
+  local _all_flashrom_args=() # An array for all flashrom args from all jobs
+  local n i                   # Loop iterators
   _mode="$1"
 
   # Helper function to schedule a flashrom job
@@ -909,23 +911,6 @@ deploy_firmware() {
     args_ref=("$@")
   }
 
-  # Helper function to check whether fd flashing is among arguments
-  # 0 if found, 1 otherwise.
-  check_for_fd() {
-    local -n _args="$1"
-    local i
-
-    # Scan argument array for the exact flashrom region selector "-i fd".
-    # Iterate only up to length-1 since we always inspect pairs (i, i+1).
-    for ((i = 0; i < ${#_args[@]} - 1; i++)); do
-      if [[ "${_args[i]}" == "-i" && "${_args[i + 1]}" == "fd" ]]; then
-        return 0
-      fi
-    done
-
-    return 1
-  }
-
   if [ "$_mode" == "update" ]; then
     echo "Updating Dasharo firmware..."
     print_warning "This may take several minutes. Please be patient and do not"
@@ -1033,7 +1018,7 @@ deploy_firmware() {
     # shellcheck disable=SC2178
     local -n args_ref="_job_args_$i"
 
-    if check_for_fd args_ref; then
+    if flashrom_check_for_region fd args_ref; then
       echo "Scheduling dedicated FD update..."
       schedule_job "Failed to flash FD" \
         -p "$PROGRAMMER_BIOS" \
@@ -1050,8 +1035,19 @@ deploy_firmware() {
     fi
   done
 
-  # Last restort check before flashing
-  if ! flashrom_sanity_check; then
+  # Create array of all flashrom params to call flashrom_region_check only once
+  for n in "${!_jobs[@]}"; do
+    i="${_jobs[$n]}"
+    # _job_args_$i is a dynamically named (runtime-created) global array holding
+    # flashrom arguments for a single job.
+    # shellcheck disable=SC2178
+    local -n args_ref="_job_args_$i"
+
+    _all_flashrom_args+=("${args_ref[@]}")
+  done
+
+  # Last resort check before flashing
+  if ! flashrom_region_check _all_flashrom_args; then
     return 1
   fi