OobUpdate.py

#!/usr/bin/env python3
# SPDX-License-Identifier: BSD-3-Clause
# Copyright (c) 2024, NVIDIA CORPORATION. All rights reserved.


import argparse
import os
import sys

sys.path.append(os.path.dirname(os.path.abspath(__file__)) + '/src')
import bf_dpu_update


# Version of this script tool
Version = '24.10-5.3'


def get_arg_parser():
    parser = argparse.ArgumentParser()
    parser.add_argument('-U',             metavar="<username>",        dest="username",     type=str, required=False, help='Username of BMC')
    parser.add_argument('-P',             metavar="<password>",        dest="password",     type=str, required=False, help='Password of BMC')
    parser.add_argument('-F',             metavar="<firmware_file>",   dest="fw_file_path", type=str, required=False, help='Firmware file path (absolute/relative)')
    parser.add_argument('-T',             metavar="<module>",          dest="module",       type=str, required=False, help='The module to be updated: BMC|CEC|BIOS|FRU|CONFIG', choices=('BMC', 'CEC', 'BIOS', 'FRU', 'CONFIG'))
    parser.add_argument('-H',             metavar="<bmc_ip>",          dest="bmc_ip",       type=str, required=False, help='IP/Host of BMC')
    parser.add_argument('-C',             action='store_true',         dest="clear_config",           required=False, help='Reset to factory configuration (Only used for BMC|BIOS)')
    parser.add_argument('-o', '--output', metavar="<output_log_file>", dest="output_file",  type=str, required=False, help='Output log file')
    parser.add_argument('-p', '--port',   metavar="<bmc_port>",        dest="bmc_port",     type=str, required=False, help='Port of BMC (443 by default).')
    parser.add_argument('--bios_update_protocol', metavar='<bios_update_protocol>', dest="bios_update_protocol", required=False, help=argparse.SUPPRESS, choices=('HTTP', 'SCP'))
    parser.add_argument('--config',       metavar='<config_file>',     dest="config_file",  type=str, required=False, help='Configuration file')
    parser.add_argument('-s',             action='append',             metavar="<oem_fru>", dest="oem_fru",           type=str, required=False, help='FRU data in the format "Section:Key=Value"')
    parser.add_argument('-v', '--version',     action='store_true',    dest="show_version",           required=False, help='Show the version of this scripts')
    parser.add_argument('--skip_same_version', action='store_true',    dest="skip_same_version",      required=False, help='Do not upgrade, if upgrade version is the same as current running version')
    parser.add_argument('--show_all_versions', action='store_true',    dest="show_all_versions",      required=False, help=argparse.SUPPRESS)
    parser.add_argument('-d', '--debug',       action='store_true',    dest="debug",                  required=False, help='Show more debug info')
    return parser


def main():
    parser = get_arg_parser()
    args   = parser.parse_args()

    if args.show_version:
        print(Version)
        return 0
    if not (
        args.username and args.password and args.bmc_ip
    ):
        print("Please use -h/--help to get help informations, "
              "the following arguments are required for Update: -U, -P, -H.")
        return 0
    if args.module:
        if not (args.fw_file_path or args.clear_config or args.oem_fru):
            print("Argument -F, -C or -s is required while -T is provided")
            return 0

    try:
        dpu_update = bf_dpu_update.BF_DPU_Update(args.bmc_ip,
                                                 args.bmc_port,
                                                 args.username,
                                                 args.password,
                                                 args.fw_file_path,
                                                 args.module,
                                                 args.oem_fru,
                                                 args.skip_same_version,
                                                 args.debug,
                                                 args.output_file,
                                                 bfb_update_protocol = args.bios_update_protocol,
                                                 use_curl = True)

        if args.show_all_versions:
            dpu_update.show_all_versions()
            return 0

        if args.fw_file_path is not None or args.oem_fru is not None:
            dpu_update.do_update()

        if args.config_file is not None:
            dpu_config = bf_dpu_update.BF_DPU_Update(args.bmc_ip,
                                                     args.bmc_port,
                                                     args.username,
                                                     args.password,
                                                     args.config_file,
                                                     'CONFIG',
                                                     args.oem_fru,
                                                     args.skip_same_version,
                                                     args.debug,
                                                     args.output_file,
                                                     bfb_update_protocol = args.bios_update_protocol,
                                                     use_curl = True)
            dpu_config.do_update()

        if args.clear_config:
            dpu_update.reset_config()

        return 0

    except bf_dpu_update.Err_Exception as e:
        sys.stderr.write("[Error Happened]:\n\t" + str(e) + '\n')
        if args.debug:
            import traceback
            traceback.print_exc()
        return e.err_num.value
    except Exception as e:
        sys.stderr.write("[Error Happened]:\n\t" + str(e) + '; please use -d to get detail info \n')
        if args.debug:
            import traceback
            traceback.print_exc()
        return bf_dpu_update.Err_Num.OTHER_EXCEPTION.value


if __name__ == '__main__':
    ret = main()
    sys.exit(ret)