4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/** @file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2004 - 2008, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThis program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncare licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncwhich accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynchttp://opensource.org/licenses/bsd-license.php
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncModule Name:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EfiUtilityMsgs.h
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncAbstract:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Defines and prototypes for common EFI utility error and debug messages.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#ifndef _EFI_UTILITY_MSGS_H_
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define _EFI_UTILITY_MSGS_H_
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <Common/UefiBaseTypes.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Log message print Level
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define VERBOSE_LOG_LEVEL 15
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define WARNING_LOG_LEVEL 15
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define INFO_LOG_LEVEL 20
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define KEY_LOG_LEVEL 40
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define ERROR_LOG_LEVLE 50
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Status codes returned by EFI utility programs and functions
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define STATUS_SUCCESS 0
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define STATUS_WARNING 1
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define STATUS_ERROR 2
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define VOID void
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef int STATUS;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define MAX_LINE_LEN 0x200
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define MAXIMUM_INPUT_FILE_NUM 10
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#ifdef __cplusplus
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncextern "C" {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#endif
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// When we call Error() or Warning(), the module keeps track of the worst
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// case reported. GetUtilityStatus() will get the worst-case results, which
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// can be used as the return value from the app.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncSTATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncGetUtilityStatus (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync VOID
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// If someone prints an error message and didn't specify a source file name,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// then we print the utility name instead. However they must tell us the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// utility name early on via this function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncVOID
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncSetUtilityName (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CHAR8 *ProgramName
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync )
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncVOID
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncPrintMessage (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CHAR8 *Type,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CHAR8 *FileName,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 LineNumber,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 MessageCode,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CHAR8 *Text,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CHAR8 *MsgFmt,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync va_list List
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncVOID
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncError (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CHAR8 *FileName,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 LineNumber,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 ErrorCode,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CHAR8 *OffendingText,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CHAR8 *MsgFmt,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ...
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync )
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncVOID
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncWarning (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CHAR8 *FileName,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 LineNumber,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 WarningCode,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CHAR8 *OffendingText,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CHAR8 *MsgFmt,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ...
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync )
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncVOID
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncDebugMsg (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CHAR8 *FileName,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 LineNumber,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT64 MsgLevel,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CHAR8 *OffendingText,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CHAR8 *MsgFmt,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ...
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync )
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncVOID
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncVerboseMsg (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CHAR8 *MsgFmt,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ...
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncVOID
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncNormalMsg (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CHAR8 *MsgFmt,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ...
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncVOID
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncKeyMsg (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CHAR8 *MsgFmt,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ...
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncVOID
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncSetPrintLevel (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT64 LogLevel
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncVOID
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncParserSetPosition (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CHAR8 *SourceFileName,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 LineNum
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync )
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncVOID
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncParserError (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 ErrorCode,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CHAR8 *OffendingText,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CHAR8 *MsgFmt,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ...
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync )
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncVOID
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncParserWarning (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 ErrorCode,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CHAR8 *OffendingText,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CHAR8 *MsgFmt,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ...
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync )
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncVOID
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncSetPrintLimits (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 NumErrors,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 NumWarnings,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 NumWarningsPlusErrors
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync )
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#ifdef __cplusplus
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync}
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#endif
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#endif // #ifndef _EFI_UTILITY_MSGS_H_