BaseTools: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / BaseTools / Source / Python / UPT / Logger / ToolError.py

## @file\r
# Standardized Error Handling infrastructures.\r
#\r
# Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>\r
#\r
# SPDX-License-Identifier: BSD-2-Clause-Patent\r
#\r
\r
'''\r
ToolError\r
'''\r
\r
import Logger.StringTable as ST\r
\r
FILE_OPEN_FAILURE = 1\r
FILE_WRITE_FAILURE = 2\r
FILE_PARSE_FAILURE = 3\r
FILE_READ_FAILURE = 4\r
FILE_CREATE_FAILURE = 5\r
FILE_CHECKSUM_FAILURE = 6\r
FILE_COMPRESS_FAILURE = 7\r
FILE_DECOMPRESS_FAILURE = 8\r
FILE_MOVE_FAILURE = 9\r
FILE_DELETE_FAILURE = 10\r
FILE_COPY_FAILURE = 11\r
FILE_POSITIONING_FAILURE = 12\r
FILE_ALREADY_EXIST = 13\r
FILE_NOT_FOUND = 14\r
FILE_TYPE_MISMATCH = 15\r
FILE_CASE_MISMATCH = 16\r
FILE_DUPLICATED = 17\r
FILE_UNKNOWN_ERROR = 0x0FFF\r
\r
OPTION_UNKNOWN = 0x1000\r
OPTION_MISSING = 0x1001\r
OPTION_CONFLICT = 0x1002\r
OPTION_VALUE_INVALID = 0x1003\r
OPTION_DEPRECATED = 0x1004\r
OPTION_NOT_SUPPORTED = 0x1005\r
OPTION_UNKNOWN_ERROR = 0x1FFF\r
\r
PARAMETER_INVALID = 0x2000\r
PARAMETER_MISSING = 0x2001\r
PARAMETER_UNKNOWN_ERROR = 0x2FFF\r
\r
FORMAT_INVALID = 0x3000\r
FORMAT_NOT_SUPPORTED = 0x3001\r
FORMAT_UNKNOWN = 0x3002\r
FORMAT_UNKNOWN_ERROR = 0x3FFF\r
\r
RESOURCE_NOT_AVAILABLE = 0x4000\r
RESOURCE_ALLOCATE_FAILURE = 0x4001\r
RESOURCE_FULL = 0x4002\r
RESOURCE_OVERFLOW = 0x4003\r
RESOURCE_UNDERRUN = 0x4004\r
RESOURCE_UNKNOWN_ERROR = 0x4FFF\r
\r
ATTRIBUTE_NOT_AVAILABLE = 0x5000\r
ATTRIBUTE_GET_FAILURE = 0x5001\r
ATTRIBUTE_SET_FAILURE = 0x5002\r
ATTRIBUTE_UPDATE_FAILURE = 0x5003\r
ATTRIBUTE_ACCESS_DENIED = 0x5004\r
ATTRIBUTE_RETRIEVE_FAILURE = 0x5005\r
ATTRIBUTE_UNKNOWN_ERROR = 0x5FFF\r
ATTRIBUTE_RETRIEVE_FAILURE = 0x5F00\r
\r
IO_NOT_READY = 0x6000\r
IO_BUSY = 0x6001\r
IO_TIMEOUT = 0x6002\r
IO_UNKNOWN_ERROR = 0x6FFF\r
\r
COMMAND_FAILURE = 0x7000\r
\r
CODE_ERROR = 0xC0DE\r
\r
AUTOGEN_ERROR = 0xF000\r
PARSER_ERROR = 0xF001\r
BUILD_ERROR = 0xF002\r
GENFDS_ERROR = 0xF003\r
ECC_ERROR = 0xF004\r
EOT_ERROR = 0xF005\r
DDC_ERROR = 0xF009\r
WARNING_AS_ERROR = 0xF006\r
MIGRATION_ERROR = 0xF010\r
EDK1_INF_ERROR = 0xF011\r
ABORT_ERROR = 0xFFFE\r
UNKNOWN_ERROR = 0xFFFF\r
\r
UPT_ALREADY_INSTALLED_ERROR = 0xD000\r
UPT_ENVIRON_MISSING_ERROR = 0xD001\r
UPT_REPKG_ERROR = 0xD002\r
UPT_ALREADY_RUNNING_ERROR = 0xD003\r
UPT_MUL_DEC_ERROR = 0xD004\r
UPT_DB_UPDATE_ERROR = 0xD005\r
UPT_INI_PARSE_ERROR = 0xE000\r
\r
## Error message of each error code\r
#\r
gERROR_MESSAGE = {\r
    FILE_NOT_FOUND          :   ST.ERR_FILE_NOT_FOUND,\r
    FILE_OPEN_FAILURE       :   ST.ERR_FILE_OPEN_FAILURE,\r
    FILE_WRITE_FAILURE      :   ST.ERR_FILE_WRITE_FAILURE,\r
    FILE_PARSE_FAILURE      :   ST.ERR_FILE_PARSE_FAILURE,\r
    FILE_READ_FAILURE       :   ST.ERR_FILE_READ_FAILURE,\r
    FILE_CREATE_FAILURE     :   ST.ERR_FILE_CREATE_FAILURE,\r
    FILE_CHECKSUM_FAILURE   :   ST.ERR_FILE_CHECKSUM_FAILURE,\r
    FILE_COMPRESS_FAILURE   :   ST.ERR_FILE_COMPRESS_FAILURE,\r
    FILE_DECOMPRESS_FAILURE :   ST.ERR_FILE_DECOMPRESS_FAILURE,\r
    FILE_MOVE_FAILURE       :   ST.ERR_FILE_MOVE_FAILURE,\r
    FILE_DELETE_FAILURE     :   ST.ERR_FILE_DELETE_FAILURE,\r
    FILE_COPY_FAILURE       :   ST.ERR_FILE_COPY_FAILURE,\r
    FILE_POSITIONING_FAILURE:   ST.ERR_FILE_POSITIONING_FAILURE,\r
    FILE_ALREADY_EXIST      :   ST.ERR_FILE_ALREADY_EXIST,\r
    FILE_TYPE_MISMATCH      :   ST.ERR_FILE_TYPE_MISMATCH ,\r
    FILE_CASE_MISMATCH      :   ST.ERR_FILE_CASE_MISMATCH,\r
    FILE_DUPLICATED         :   ST.ERR_FILE_DUPLICATED,\r
    FILE_UNKNOWN_ERROR      :   ST.ERR_FILE_UNKNOWN_ERROR,\r
\r
    OPTION_UNKNOWN          :   ST.ERR_OPTION_UNKNOWN,\r
    OPTION_MISSING          :   ST.ERR_OPTION_MISSING,\r
    OPTION_CONFLICT         :   ST.ERR_OPTION_CONFLICT,\r
    OPTION_VALUE_INVALID    :   ST.ERR_OPTION_VALUE_INVALID,\r
    OPTION_DEPRECATED       :   ST.ERR_OPTION_DEPRECATED,\r
    OPTION_NOT_SUPPORTED    :   ST.ERR_OPTION_NOT_SUPPORTED,\r
    OPTION_UNKNOWN_ERROR    :   ST.ERR_OPTION_UNKNOWN_ERROR,\r
\r
    PARAMETER_INVALID       :   ST.ERR_PARAMETER_INVALID,\r
    PARAMETER_MISSING       :   ST.ERR_PARAMETER_MISSING,\r
    PARAMETER_UNKNOWN_ERROR :   ST.ERR_PARAMETER_UNKNOWN_ERROR,\r
\r
    FORMAT_INVALID          :   ST.ERR_FORMAT_INVALID,\r
    FORMAT_NOT_SUPPORTED    :   ST.ERR_FORMAT_NOT_SUPPORTED,\r
    FORMAT_UNKNOWN          :   ST.ERR_FORMAT_UNKNOWN,\r
    FORMAT_UNKNOWN_ERROR    :   ST.ERR_FORMAT_UNKNOWN_ERROR,\r
\r
    RESOURCE_NOT_AVAILABLE  :   ST.ERR_RESOURCE_NOT_AVAILABLE,\r
    RESOURCE_ALLOCATE_FAILURE : ST.ERR_RESOURCE_ALLOCATE_FAILURE,\r
    RESOURCE_FULL           :   ST.ERR_RESOURCE_FULL,\r
    RESOURCE_OVERFLOW       :   ST.ERR_RESOURCE_OVERFLOW,\r
    RESOURCE_UNDERRUN       :   ST.ERR_RESOURCE_UNDERRUN,\r
    RESOURCE_UNKNOWN_ERROR  :   ST.ERR_RESOURCE_UNKNOWN_ERROR,\r
\r
    ATTRIBUTE_NOT_AVAILABLE :   ST.ERR_ATTRIBUTE_NOT_AVAILABLE,\r
    ATTRIBUTE_RETRIEVE_FAILURE : ST.ERR_ATTRIBUTE_RETRIEVE_FAILURE,\r
    ATTRIBUTE_SET_FAILURE   :   ST.ERR_ATTRIBUTE_SET_FAILURE,\r
    ATTRIBUTE_UPDATE_FAILURE:   ST.ERR_ATTRIBUTE_UPDATE_FAILURE,\r
    ATTRIBUTE_ACCESS_DENIED :   ST.ERR_ATTRIBUTE_ACCESS_DENIED,\r
    ATTRIBUTE_UNKNOWN_ERROR :   ST.ERR_ATTRIBUTE_UNKNOWN_ERROR,\r
\r
    COMMAND_FAILURE         :   ST.ERR_COMMAND_FAILURE,\r
\r
    IO_NOT_READY            :   ST.ERR_IO_NOT_READY,\r
    IO_BUSY                 :   ST.ERR_IO_BUSY,\r
    IO_TIMEOUT              :   ST.ERR_IO_TIMEOUT,\r
    IO_UNKNOWN_ERROR        :   ST.ERR_IO_UNKNOWN_ERROR,\r
\r
    UNKNOWN_ERROR           :   ST.ERR_UNKNOWN_ERROR,\r
\r
    UPT_ALREADY_INSTALLED_ERROR : ST.ERR_UPT_ALREADY_INSTALLED_ERROR,\r
    UPT_ENVIRON_MISSING_ERROR   : ST.ERR_UPT_ENVIRON_MISSING_ERROR,\r
    UPT_REPKG_ERROR             : ST.ERR_UPT_REPKG_ERROR,\r
    UPT_ALREADY_RUNNING_ERROR   : ST.ERR_UPT_ALREADY_RUNNING_ERROR,\r
    UPT_MUL_DEC_ERROR           : ST.ERR_MUL_DEC_ERROR,\r
    UPT_INI_PARSE_ERROR     :   ST.ERR_UPT_INI_PARSE_ERROR,\r
}\r
\r
## Exception indicating a fatal error\r
#\r
class FatalError(Exception):\r
    pass\r
\r