oc-reload.sh

#!/bin/bash
#
# Copyright 2016, 2017 International Business Machines
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

# get capi-utils root
[ -h $0 ] && package_root=`ls -l "$0" |sed -e 's|.*-> ||'` || package_root="$0"
package_root=$(dirname $package_root)
source $package_root/oc-utils-common.sh

bold=\\033[1m
green=\\033[32m
blue=\\033[34m
red=\\033[31m
normal=\\033[0m


program=`basename "$0"`
mylock=0  # var used to remove lock dir only if we created it

# Print usage message helper function
function usage() {
  echo "Usage:  sudo ${program} [OPTIONS]"
  echo "    [-C <card>] card to reload."
  echo "      Example: if you want to reload card"
  echo -e "        ${green} IBM,oc-snap.0004:00:00.1.0 ${normal}"
  echo "      Command line should be:"
  echo -e "        ${green} sudo ./oc-reload.sh -C IBM,oc-snap.0004:00:00.1.0 ${normal}"
  echo "      Or:"
  echo -e "        ${green} sudo ./oc-reload.sh -C 0004:00:00.0 ${normal}"
  echo "      Or:"
  echo -e "        ${green} sudo ./oc-reload.sh -C 4 ${normal}"
  echo "    [-V] Print program version (${version})"
  echo "    [-L] Force No Lock"
  echo "    [-h] Print this help message."
  echo
  echo "Utility to reload FPGA image from the FPGA Flash."
  echo "Please notify other users who you work with them on the same server."
  echo
}

# Select function for FPGA Cards Selection
function select_cards() {
    # print current date on server for comparison
    printf "\n${bold}Current date:${normal}$(date)\n"

    # get number of cards in system
    n=`ls /dev/ocxl 2>/dev/null | wc -l`
    printf "${bold}  $n OpenCAPI cards found.${normal}\n"

    # Find all OC cards in the system
    allcards=`ls /dev/ocxl 2>/dev/null | awk -F"." '{ print $2 }' | sed s/$/.0/ | sort`
    allcards_array=($allcards)

    # print card information
    i=0;
    slot_enum=""
    delimiter="|"
    while read d ; do
      p[$i]=$(cat /sys/bus/pci/devices/${allcards_array[$i]}/subsystem_device)
      # translate the slot number string to a hexa number
      card_slot_hex=$(printf '%x' "0x${allcards_array[$i]::-8}")
      # build a slot_enum of all card numbers and use in the test menu to test user input
      if [ -z "$slot_enum" ]; then
         slot_enum=$card_slot_hex
      else
         slot_enum=$slot_enum$delimiter$card_slot_hex
      fi

      # find in oc-devices files the card corresponding to the slot to display the informations
      while IFS='' read -r line || [[ -n $line ]]; do
        if [[ ${line:0:6} == ${p[$i]:0:6} ]]; then
          parse_info=($line)
          board_vendor[$i]=${parse_info[1]}
	  printf "${bold} Card %s:${normal} %s - %s \n" "$card_slot_hex" "${allcards_array[$i]}" "${board_vendor[$i]}"
        fi
      done < "$package_root/oc-devices"
      i=$[$i+1]
     done < <( lspci -d "1014":"062b" -s .1 )
    printf "\n"

    # prompt card until input is not in list of available slots
    while ! [[ "$c" =~ ^($slot_enum)$ ]]
    do
        echo -e "${green}  From which card number do you want to reload the Flash code? [${bold}$slot_enum]: ${normal}\c" | sed 's/|/-/g'
        read -r c
     done
    printf "\n"

}

# OPTIND Reset done in order to use getopts even if not the first time getopts is called (when sourcing this script by oc-flash-script.sh for example)
OPTIND=1
NO_LOCK=0

# Parse any options given on the command line
while getopts ":C:VhL" opt; do
  case ${opt} in
      C)
      card=$OPTARG
      ;;
      V)
      echo "${version}" >&2
      exit 0
      ;;
      h)
      usage;
      exit 0
      ;;
      L)
      NO_LOCK=1
      ;;
      \?)
      printf "${bold}ERROR:${normal} Invalid option: -${OPTARG}\n" >&2
      exit 1
      ;;
      :)
      printf "${bold}ERROR:${normal} Option -$OPTARG requires an argument.\n" >&2
      exit 1
      ;;
  esac
done

shift $((OPTIND-1))

ulimit -c unlimited

# check if CAPI boards exists
capi_check=`ls /dev/ocxl 2>/dev/null | wc -l`
if [ $capi_check -eq 0 ]; then
  printf "${bold}ERROR:${normal} No OpenCAPI devices found\n"
  exit 1
fi

if [ -n "$card" ]; then
        if [[ $card  != *":"* ]]; then
           # if card argument is just the card slot (with no :) then add the necessary stuff around it
           card=$(printf '%.4x:00:00.0' "0x${card}")
        fi
else
        select_cards
        # Convert the slot number into a 000x:00:00.0 slot number
        card=$(printf '%.4x:00:00.0' "0x${c}")
fi

        #echo "card selected is : $card"
        

if [ $NO_LOCK -eq 0 ]; then
	echo -e "${blue}Checking if card $card is locked${normal}"
	LockDir="$LockDirPrefix$card"  # taken from oc-utils-common.sh
	# First step: create the dirname of $LockDir (typically /var/ocxl)
	# in case it is not yet existing ("mkdir -p" always successful even if dir already exists)
	mkdir -p `dirname $LockDir`
	
	# Second step: trying to create $LockDir locking directory (typically into /var/ocxl)
	# and testing if the creation succeeded ("mkdir" fails if dir already exists)
	if mkdir $LockDir 2>/dev/null; then
		echo -e "${blue}$LockDir created during oc-reload${normal}"
		# The following line prepares a cleaning of the newly created dir when script will output
		trap 'rm -rf "$LockDir";echo -e "${blue}$LockDir removed at the end of oc-reload${normal}"' EXIT # This prepares a cleaning of the newly created dir
                                                                                # when script will output
	else
		echo
		printf "${bold}${red}ERROR:${normal} $LockDir is already existing\n"
		printf " => Card has been locked already!\n"
		
		DateLastBoot=`who -b | awk '{print $3 " " $4}'`
		EpochLastBoot=`date -d "$DateLastBoot" +%s`
		
		EpochLockDir=`stat --format=%Y $LockDir`
		DateLockDir=`date --date @$EpochLockDir`
		
		if [ $EpochLockDir -lt $EpochLastBoot ]; then
			echo
			echo "Last BOOT:              `date --date @$EpochLastBoot` ($EpochLastBoot)"
			echo "Last LOCK modification: $DateLockDir ($EpochLockDir)"
			echo "$LockDir modified BEFORE last boot"
			echo;echo "======================================================="echo "$LockDir modified BEFORE last boot"
			echo "LOCK is not supposed to still be here"
			echo "  ==> Deleting and recreating $LockDir"
			rmdir $LockDir
			mkdir $LockDir
			echo -e "${blue}$LockDir created during oc-reload${normal}"
			# The following line prepares a cleaning of the newly created dir when script will output
			trap 'rm -rf "$LockDir";echo -e "${blue}$LockDir removed at the end of oc-reload${normal}"' EXIT
		else
			echo "$LockDir modified AFTER last boot"
			printf "${bold}${red}ERROR:${normal} Card has been recently locked\n"
			echo "Exiting..."
			exit 10
		fi
	fi

fi



subsys=$(cat /sys/bus/pci/devices/${card}/subsystem_device)
# adding specific code for 250SOC card (subsystem_id = 0x066A, former id was 0x060d for old cards)
if [[ $subsys = @("0x066a"|"0x060d") ]]; then 
  printf " ${red}Warning:${normal}There is still a known issue on the 250SOC reload:\n"
  printf "         You may need to reboot the server to reload the code just programmed in Flash.\n\n"
  reload_card $card factory " Reloading code from Flash for the OpenCAPI card in slot $card"

#otherwise use the src/img_reload.c compiled code
else
  start=`date +%s`
  $package_root/oc-reload --devicebdf $card  --startaddr 0x0 " Reloading code from Flash for the OpenCAPI card in slot $card (new images)"
  end=`date +%s`

  runtime=$((end-start))
  # in oc-reload we wait for 1 sec to see if EOS is set to 1, if not then a timeout occurs
  if [ $runtime -ge 1 ]; then
     #echo "reload with the reload_card function (old image detected)"
     reload_card $card factory " Reloading code from Flash for the OpenCAPI card in slot $card"
  else
     reset_card $card factory " Resetting card $card after Image Reloading"
  fi
fi