# BEGIN_ICS_COPYRIGHT8 ****************************************
# 
# Copyright (c) 2015-2017, Intel Corporation
# 
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
# 
#     * Redistributions of source code must retain the above copyright notice,
#       this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above copyright
#       notice, this list of conditions and the following disclaimer in the
#       documentation and/or other materials provided with the distribution.
#     * Neither the name of Intel Corporation nor the names of its contributors
#       may be used to endorse or promote products derived from this software
#       without specific prior written permission.
# 
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
# 
# END_ICS_COPYRIGHT8   ****************************************

# [ICS VERSION STRING: unknown]

#=============================================================================#
# Test Suite Description:
#-----------------------------------------------------------------------------#
## switch_upgrade
## --------------
## upgrade firmware of all externally managed switch nodes
#=============================================================================#

# manditory setup
log_user 0;	# disable detailed logging to stdout

# uncomment the following to debug the test
#strace 20
#log_user 1
#exp_internal 1
#cmd_trace on
#strace 4

set install_exit_code 0

proc suite_setup {} {
	# example of conditional setup
	#test_execute {load populate} {
		#do some installation or configuration stuff
	#}
}

proc case_setup {} {
# setup to do at start of each test case
# Usage:
#	pass as argument to start_suite
# Arguments:
#	None
# This procedure will be run at the start of every test case
# It provides an opportunity for uniform cleanup/setup for each test case

}

proc case_cleanup { failed } {
# cleanup to do after each test case
# Usage:
#	pass as argument to start_suite
# Arguments:
#	failed - set to 1 if test case failed in which case additional
#		information/files may be desired in test_tmp
#		set to 0 if test case passed
# This procedure will be run at the end of every test case
# It provides an opportunity for uniform cleanup after each test case
	global env

	test_execute {} {
		if { $failed } {
			global opaswitch
			# could put cleanup here
		}
	}
}

test_suite "upgrade" "upgrade firmware" "upgrade all externally managed switch nodes
Firmware package File: $env(CFG_FWFILE)
Firmware Files: $env(CFG_FWBINFILES)
Action: $env(CFG_FWACTION)
File: /usr/lib/eth-tools/switch_upgrade.exp" suite_setup noop {
	global env
	global opaswitch

	# Global Initializations for Test Suite:
	# --------------------------------------

	# ADD ANY GLOBAL INITIALIZATION HERE, SUCH AS:
	# set env(MY_ENV_VAR) value
	# also validate the environment
	# if the environment is bad call fail_suite "information" abort_now
	# abort_now should be 0 if it is safe to proceed and simply ignore all
	# test_case calls.  it should be 1 if that is not possible.

	# Procedures used to support Test Suite:
	# --------------------------------------

	# The actual test cases:
	# ----------------------

	if { [ test_case "check" "check firmware files" "check firmware to be pushed to all externally managed switch nodes
Firmware package File: $env(CFG_FWFILE)
Firmware Files: $env(CFG_FWBINFILES)
Firmware Release Info: $env(CFG_FWRELINFO)
File: /usr/lib/eth-tools/switch_upgrade.exp" case_setup case_cleanup {
			set fw_version ""
			set fw_type ""
			set fw_speed ""
			set fw_rel_info ""
            set fw_rel_info_param "fwtype"

            # For now simply retrieve the information from the release informatio file,
            # in the future may add functionality to utilize this information.
			set num_fw [llength $env(CFG_FWFILES)]
	
            foreach fw_rel_info $env(CFG_FWRELINFO) {
                switch -exact -- $fw_rel_info_param {
                    fwtype {
                        set fw_rel_info_param "fwversion"
                        set fw_type $fw_rel_info
                        log_message "Firmware Type: $fw_type\n"
                    }
                    fwversion {
						if { [ string equal "$fw_type" "12000"] } {
							set fw_speed "QDR"
							set fw_version $fw_rel_info
                        	set fw_rel_info_param ""
						} else {
							set fw_version "V0"
                        	set fw_rel_info_param "fwspeed"
						}
                        set fw_version $fw_rel_info
                        log_message "Firmware Version: $fw_version\n"
                    }
                    fwspeed {
                        set fw_rel_info_param ""
                        set fw_speed $fw_rel_info
                        set speed $fw_speed
                        log_message "Firmware Speed: $fw_speed\n"
                    }
                }
            }
            if { $fw_rel_info_param != "" } {
                fail_suite  "Invalid Firmware Files"
            }
		} ] } {
		fail_suite  "Invalid Firmware Files"
	}

	# We only get here if all the firmware files supplied are valid
	# determine max distance, opaswitches w/o distance are treated as furthest
	set max_distance "-1"
	set blank_distance 0
	foreach opaswitch $env(CFG_OPASWITCHES) {
		set distance [ get_opaswitch_distance "$opaswitch" ]
		if { [ string equal "$distance" "" ] } {
			set blank_distance 1
		} elseif { $distance > $max_distance } {
			set max_distance $distance
		}
	}
	if { $blank_distance } {
		incr max_distance
	}

	# work from furthest away to closest
	for { set i $max_distance } {$i>=0} {incr i -1} {
		parallel opaswitch $env(CFG_OPASWITCHES) {
			set distance [ get_opaswitch_distance "$opaswitch" ]
			if { $distance == $i
				 || ( $distance == "" && $i == $max_distance ) } {
				set opaswitch [ trim_opaswitch_distance "$opaswitch"]
				set speed $env(CFG_FWSPEED)
				set asicver $env(CFG_FWASICVER)
        		if { [ string equal "$env(CFG_FWACTION)" "run"] } {
            		# Push and select the firmware image, and reboot the switch.
            		test_case_i2c_extmgd_eeprom "upgrade" $opaswitch $speed $asicver "-S -d $env(CFG_FWTEMPDIR) -t [ trim_opaswitch_hfi_port $opaswitch]"
        		} else {
            		# Push and select the firmware image.
            		test_case_i2c_extmgd_eeprom "upgrade" $opaswitch $speed $asicver "-d $env(CFG_FWTEMPDIR) -t [trim_opaswitch_hfi_port $opaswitch]"
        		}
    		}
		}
	}
}
