Add script for flashing FP4 devices

#!/usr/bin/env bash

##########

# This script is created and maintained by

#       Bharath(@teamb58).org

# Feel free to connect for any queries or suggestions.

##########

##########

# This script flashes a software release and complete wipes the device.

#

##########

set -e

set -u

# Target device info

PRODUCT="Fairphone 4"

PRODUCT_ID="FP4"

# Paths/files

ROOT_DIR="$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )"

IMAGES_DIR="${ROOT_DIR}"

# Abort the script (and wait for a key to be pressed).

abort_now() {

  echo ""

  read -rp "ERROR: Aborting now (press Enter to terminate)." a

  exit 1

}

# Check for connected phone

find_device() {

  echo "INFO: Looking for connected device(s)..."

  DEVICE_FOUND="false"

  while [ ${DEVICE_FOUND} = "false" ]

  do

    serial_numbers=

    for sn in $(${FASTBOOT_BIN} devices | grep fastboot | grep -oE '^[[:alnum:]]+')

    do

      # Checking the product ID

      PRODUCT_STRING=$(${FASTBOOT_BIN} -s "${sn}" getvar product 2>&1)

      # Add serial, if product matches

      if [[ ${PRODUCT_STRING} == *"${PRODUCT_ID}"* ]] || [[ ${PRODUCT_STRING} == *"${PRODUCT_ID_OLD}"* ]]

      then

        serial_numbers="${serial_numbers} $sn"

      fi

    done

    case $(echo "${serial_numbers}" | wc -w | grep -oE '[0-9]+') in

      0)

        echo ""

        echo "WARNING: No ${PRODUCT} found in fastboot mode."

        echo "WARNING: Make sure that a ${PRODUCT} is connected."

        ;;

      1)

          echo "INFO: One ${PRODUCT} in fastboot mode found (serial number: ${sn})."

        DEVICE_FOUND="true"

        break

        ;;

      *)

        echo ""

        echo "WARNING: Several ${PRODUCT}'s in fastboot mode connected."

        echo "WARNING: Please connect only one ${PRODUCT}."

        ;;

    esac

    echo ""

    while true

    do

      read -rp "Do you want to look for a ${PRODUCT} again? [(Y)es/(n)o]: " a

      if [ -z "${a}" ] || [ "${a}" = 'y' ] || [ "${a}" = 'Y' ]

      then

        break

      elif [ "${a}" = 'n' ] || [ "${a}" = 'N' ]

      then

        exit 0

      fi

    done

  done

}

# Flash (or manipulate) relevant partitions

flash_device() {

  flash_image_ab_or_abort "${sn}" bluetooth "${IMAGES_DIR}/bluetooth.img

  flash_image_ab_or_abort "${sn}" devcfg "${IMAGES_DIR}/devcfg.img

  flash_image_ab_or_abort "${sn}" dsp "${IMAGES_DIR}/dsp.img

  flash_image_ab_or_abort "${sn}" modem "${IMAGES_DIR}/modem.img

  flash_image_ab_or_abort "${sn}" xbl "${IMAGES_DIR}/xbl.img

  flash_image_ab_or_abort "${sn}" tz "${IMAGES_DIR}/tz.img

  flash_image_ab_or_abort "${sn}" hyp "${IMAGES_DIR}/hyp.img

  flash_image_ab_or_abort "${sn}" keymaster "${IMAGES_DIR}/keymaster.img

  flash_image_ab_or_abort "${sn}" abl "${IMAGES_DIR}/abl.img

  flash_image_ab_or_abort "${sn}" boot "${IMAGES_DIR}/boot.img

  flash_image_ab_or_abort "${sn}" recovery "${IMAGES_DIR}/recovery.img

  flash_image_ab_or_abort "${sn}" dtbo "${IMAGES_DIR}/dtbo.img

  flash_image_ab_or_abort "${sn}" vbmeta_system "${IMAGES_DIR}/vbmeta_system.img

  flash_image_ab_or_abort "${sn}" vbmeta "${IMAGES_DIR}/vbmeta.img

  flash_image_or_abort "${sn}" super "${IMAGES_DIR}/super.img

  flash_image_ab_or_abort "${sn}" aop "${IMAGES_DIR}/aop.img

  flash_image_ab_or_abort "${sn}" featenabler "${IMAGES_DIR}/featenabler.img

  flash_image_ab_or_abort "${sn}" imagefv "${IMAGES_DIR}/imagefv.img

  flash_image_ab_or_abort "${sn}" multiimgoem "${IMAGES_DIR}/multiimgoem.img

  flash_image_ab_or_abort "${sn}" qupfw "${IMAGES_DIR}/qupfw.img

  flash_image_ab_or_abort "${sn}" uefisecapp "${IMAGES_DIR}/uefisecapp.img

  flash_image_ab_or_abort "${sn}" xbl_config "${IMAGES_DIR}/xbl_config.img

  flash_image_ab_or_abort "${sn}" core_nhlos "${IMAGES_DIR}/core_nhlos.img

  $FASTBOOT_BIN -s "${sn}" erase userdata

  $FASTBOOT_BIN -s "${sn}" erase metadata

  $FASTBOOT_BIN -s "${sn}" --set-active=a

}

# Flash an image to a partition. Abort on failure.

# Arguments: <device serial number> <partition name> <image file>

flash_image_or_abort() {

  local retval=0

  $FASTBOOT_BIN -s "${1}" flash "${2}" "${3}" || retval=$?

  if [ "${retval}" -ne 0 ]

  then

    echo ""

    echo "ERROR: Could not flash the ${2} partition on device ${1}."

    echo ""

    echo "ERROR: Please unplug the phone, take the battery out, boot the device into"

    echo "ERROR: fastboot mode, and start this script again."

    echo "ERROR: (To get to fastboot mode, press Volume-Down and plug in the USB-C)"

    echo "ERROR: (cable until the fastboot menu appears.)"

    abort_now

  fi

}

# Flash an image to both A and B slot of partition. Abort on failure.

# Arguments: <device serial number> <partition name without slot> <image file>

flash_image_ab_or_abort() {

  flash_image_or_abort "${1}" "${2}_a" "${3}"

  flash_image_or_abort "${1}" "${2}_b" "${3}"

}

# Operating system checks and variable definition

os_checks() {

  echo "INFO: You are using a Linux distribution."

  FASTBOOT_BIN="${ROOT_DIR}/bin-linux-x86/fastboot"

}

# Control the reboot sequence

reboot_device() {

  echo "-----------"

  echo ""

  echo "INFO: Done. The device will reboot now."

  "${FASTBOOT_BIN}" -s "${sn}" reboot

  echo ""

  echo "INFO: You can unplug the USB cable now."

  echo ""

}

echo ""

echo "*** ${PRODUCT} flashing script ***"

echo ""

echo "INFO: The procedure will start soon. Please wait..."

echo "Note that this will detect and flash only on FP3 or FP3+ devices."

sleep 2

# Begin with some OS checks and variable definition

os_checks

# Call function to look for device(s)

# If only one device is found $sn will store its serial number

find_device

# Flash the device

flash_device

# Reboot device

reboot_device