Merge branch '2237-s-add-flash-script-for-gs290' into 'v1-s'

#!/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

CLEAN_FLASH="true" # Control data wipe behavior. Default is "true".

# Target device info

PRODUCT="Gigaset GS290"

PRODUCT_ID="k63v2_64_bsp"

# 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_or_abort "${sn}" system system.img

  flash_image_or_abort "${sn}" vendor vendor.img

  flash_image_or_abort "${sn}" boot boot.img

  flash_image_or_abort "${sn}" dtbo dtbo.img

  flash_image_or_abort "${sn}" recovery recovery.img

  flash_image_or_abort "${sn}" logo logo.img

  flash_image_or_abort "${sn}" md1dsp md1dsp.img

  flash_image_or_abort "${sn}" md1img md1img.img

  flash_image_or_abort "${sn}" spmfw spmfw.img

  flash_image_or_abort "${sn}" lk lk.img

  flash_image_or_abort "${sn}" lk2 lk.img

  flash_image_or_abort "${sn}" sspm_1 sspm.img

  flash_image_or_abort "${sn}" sspm_2 sspm.img

  flash_image_or_abort "${sn}" tee1 trustzone1.bin

  flash_image_or_abort "${sn}" tee2 trustzone2.bin

  flash_image_or_abort "${sn}" preloader preloader.img

  if [ "${CLEAN_FLASH}" = "true" ]

  then

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

  fi

}

# 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}" "${IMAGES_DIR}"/"${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 and 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() {

  case "$(uname -s 2> /dev/null)" in

    Linux|GNU/Linux)

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

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

      ;;

    msys|MINGW*)

      echo "INFO: You are using MinGW on Windows"

      FASTBOOT_BIN="${ROOT_DIR}/bin-msys/fastboot.exe"

      ;;

    *)

      echo "ERROR: Unsupported operating system (${OSTYPE})."

      echo "ERROR: Only GNU/Linux, and MinGW on Windows are currently supported."

      abort_now

      ;;

  esac

}

# 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 ""

}

# Warn about data wipe, and ask for confirmation

data_wipe_check() {

  if [ "${CLEAN_FLASH}" = "true" ]

  then

    echo ""

    echo "WARNING: Flashing this image wipes all user data and settings on the phone."

    echo " Are you sure you want to wipe data and continue?"

    echo ""

    # Read user's input

    read -rp " Type \"Yes\" (case sensitive) and press enter to wipe data and continue. Else, just press enter: " a

    echo ""

    if [ "_${a:-"No"}" != '_Yes' ]

      # NOTE: $a is being set by the read command above,

      #   so the check for a to be set is mostly redundant

    then

         echo "WARNING: You DID NOT type \"Yes\", proceeding without data wipe."

         echo ""

         CLEAN_FLASH="false"

    else

         echo "WARNING: You typed \"Yes\", proceeding with data wipe."

         CLEAN_FLASH="true"

    fi

  fi

}

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 ${PRODUCT} device."

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

# Call function to look for data wipe check

data_wipe_check

# Flash the device

flash_device

# Reboot device

reboot_device