Update the copyright notice format

[mirror_edk2.git] / EdkCompatibilityPkg / Foundation / Library / Dxe / Print / Print.c

/*++\r
\r
Copyright (c) 2004 - 2007, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials                          \r
are licensed and made available under the terms and conditions of the BSD License         \r
which accompanies this distribution.  The full text of the license may be found at        \r
http://opensource.org/licenses/bsd-license.php                                            \r
                                                                                          \r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
\r
Module Name:\r
\r
  Print.c\r
\r
Abstract:\r
\r
  Basic Ascii AvSPrintf() function named VSPrint(). VSPrint() enables very\r
  simple implemenation of SPrint() and Print() to support debug. \r
\r
  You can not Print more than EFI_DRIVER_LIB_MAX_PRINT_BUFFER characters at a \r
  time. This makes the implementation very simple.\r
\r
  VSPrint, Print, SPrint format specification has the follwoing form\r
\r
  %[flags][width]type\r
\r
  flags:\r
    '-' - Left justify\r
    '+' - Prefix a sign\r
    ' ' - Prefix a blank\r
    ',' - Place commas in numberss\r
    '0' - Prefix for width with zeros\r
    'l' - UINT64\r
    'L' - UINT64\r
\r
  width:\r
    '*' - Get width from a UINTN argumnet from the argument list\r
    Decimal number that represents width of print\r
\r
  type:\r
    'p' - arugment is VOID *; printed as hex number\r
    'X' - argument is a UINTN hex number, prefix '0'\r
    'x' - argument is a hex number\r
    'd' - argument is a decimal number\r
    'a' - argument is an ascii string \r
    'S','s' - argument is an Unicode string\r
    'g' - argument is a pointer to an EFI_GUID\r
    't' - argument is a pointer to an EFI_TIME structure\r
    'c' - argument is an ascii character\r
    'r' - argument is EFI_STATUS\r
    '%' - Print a %\r
\r
--*/\r
\r
#include "TianoCommon.h"\r
#include "EfiCommonLib.h"\r
#include "PrintWidth.h"\r
#include "EfiPrintLib.h"\r
#include "Print.h"\r
\r
\r
STATIC\r
CHAR_W *\r
GetFlagsAndWidth (\r
  IN  CHAR_W      *Format, \r
  OUT UINTN       *Flags, \r
  OUT UINTN       *Width,\r
  IN OUT  VA_LIST *Marker\r
  );\r
\r
STATIC\r
UINTN\r
GuidToString (\r
  IN  EFI_GUID  *Guid,\r
  IN OUT CHAR_W *Buffer,\r
  IN  UINTN     BufferSize\r
  );\r
\r
STATIC\r
UINTN\r
TimeToString (\r
  IN  EFI_TIME  *Time,\r
  IN OUT CHAR_W *Buffer,\r
  IN  UINTN     BufferSize\r
  );\r
\r
STATIC\r
UINTN\r
EfiStatusToString (\r
  IN EFI_STATUS   Status,\r
  OUT CHAR_W      *Buffer,\r
  IN  UINTN       BufferSize\r
  );\r
\r
UINTN\r
SPrint (\r
  OUT CHAR_W        *Buffer,\r
  IN  UINTN         BufferSize,\r
  IN  CONST CHAR_W  *Format,\r
  ...\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  SPrint function to process format and place the results in Buffer.\r
\r
Arguments:\r
\r
  Buffer     - Wide char buffer to print the results of the parsing of Format into.\r
\r
  BufferSize - Maximum number of characters to put into buffer. Zero means no \r
               limit.\r
\r
  Format - Format string see file header for more details.\r
\r
  ...    - Vararg list consumed by processing Format.\r
\r
Returns: \r
\r
  Number of characters printed.\r
\r
--*/\r
{\r
  UINTN   Return;\r
  VA_LIST Marker;\r
\r
  VA_START (Marker, Format);\r
  Return = VSPrint (Buffer, BufferSize, Format, Marker);\r
  VA_END (Marker);\r
  \r
  return Return;\r
}\r
\r
\r
UINTN\r
EFIAPI\r
VSPrint (\r
  OUT CHAR_W        *StartOfBuffer,\r
  IN  UINTN         BufferSize,\r
  IN  CONST CHAR_W  *FormatString,\r
  IN  VA_LIST       Marker\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  VSPrint function to process format and place the results in Buffer. Since a \r
  VA_LIST is used this rountine allows the nesting of Vararg routines. Thus \r
  this is the main print working routine\r
\r
Arguments:\r
\r
  StartOfBuffer - Unicode buffer to print the results of the parsing of Format into.\r
\r
  BufferSize    - Maximum number of characters to put into buffer. Zero means \r
                  no limit.\r
\r
  FormatString  - Unicode format string see file header for more details.\r
\r
  Marker        - Vararg list consumed by processing Format.\r
\r
Returns: \r
\r
  Number of characters printed.\r
\r
--*/\r
{\r
  CHAR16    TempBuffer[CHARACTER_NUMBER_FOR_VALUE];\r
  CHAR_W    *Buffer;\r
  CHAR8     *AsciiStr;\r
  CHAR16    *UnicodeStr;\r
  CHAR_W    *Format;\r
  UINTN     Index;\r
  UINTN     Flags;\r
  UINTN     Width;\r
  UINTN     Count;\r
  UINTN     NumberOfCharacters;\r
  UINTN     BufferLeft;\r
  UINT64    Value;\r
  EFI_GUID  *TmpGUID;\r
\r
  //\r
  // Process the format string. Stop if Buffer is over run.\r
  //\r
\r
  Buffer = StartOfBuffer;\r
  Format = (CHAR_W *)FormatString; \r
  NumberOfCharacters = BufferSize/sizeof(CHAR_W);\r
  BufferLeft = BufferSize;\r
  for (Index = 0; (*Format != '\0') && (Index < NumberOfCharacters - 1); Format++) {\r
    if (*Format != '%') {\r
      if ((*Format == '\n') && (Index < NumberOfCharacters - 2)) {                  \r
        //\r
        // If carage return add line feed\r
        //\r
        Buffer[Index++] = '\r';\r
        BufferLeft -= sizeof(CHAR_W);\r
      }\r
      Buffer[Index++] = *Format;\r
      BufferLeft -= sizeof(CHAR_W);\r
    } else {\r
      \r
      //\r
      // Now it's time to parse what follows after %\r
      //\r
      Format = GetFlagsAndWidth (Format, &Flags, &Width, &Marker);\r
      switch (*Format) {\r
      case 'p':\r
        //\r
        // Flag space, +, 0, L & l are invalid for type p.\r
        //\r
        Flags &= ~(PREFIX_BLANK| PREFIX_SIGN | LONG_TYPE);\r
        if (sizeof (VOID *) > 4) {\r
          Flags |= LONG_TYPE;\r
          Value = VA_ARG (Marker, UINT64);\r
        } else {\r
          Value = VA_ARG (Marker, UINTN);\r
        }\r
        Flags |= PREFIX_ZERO;\r
\r
        EfiValueToHexStr (TempBuffer, Value, Flags, Width);\r
        UnicodeStr = TempBuffer;\r
\r
        for ( ;(*UnicodeStr != '\0') && (Index < NumberOfCharacters - 1); UnicodeStr++) {\r
          Buffer[Index++] = *UnicodeStr;\r
        }\r
        break;\r
        \r
      case 'X':\r
        Flags |= PREFIX_ZERO;\r
        Width = sizeof (UINT64) * 2;\r
        //\r
        // break skiped on purpose\r
        //\r
      case 'x':\r
        if ((Flags & LONG_TYPE) == LONG_TYPE) {\r
          Value = VA_ARG (Marker, UINT64);\r
        } else {\r
          Value = VA_ARG (Marker, UINTN);\r
        }\r
\r
        EfiValueToHexStr (TempBuffer, Value, Flags, Width);\r
        UnicodeStr = TempBuffer;\r
\r
        for ( ;(*UnicodeStr != '\0') && (Index < NumberOfCharacters - 1); UnicodeStr++) {\r
          Buffer[Index++] = *UnicodeStr;\r
        }\r
        break;\r
\r
      case 'd':\r
        if ((Flags & LONG_TYPE) == LONG_TYPE) {\r
          Value = VA_ARG (Marker, UINT64);\r
        } else {\r
          Value = (UINTN)VA_ARG (Marker, UINTN);\r
        }\r
\r
        EfiValueToString (TempBuffer, Value, Flags, Width);\r
        UnicodeStr = TempBuffer;                              \r
\r
        for ( ;(*UnicodeStr != '\0') && (Index < NumberOfCharacters - 1); UnicodeStr++) {\r
          Buffer[Index++] = *UnicodeStr;\r
        }\r
        break;\r
\r
      case 's':\r
      case 'S':\r
        UnicodeStr = (CHAR16 *)VA_ARG (Marker, CHAR_W *);\r
        if (UnicodeStr == NULL) {\r
          UnicodeStr = L"<null string>";\r
        }\r
        for (Count = 0 ;(*UnicodeStr != '\0') && (Index < NumberOfCharacters - 1); UnicodeStr++, Count++) {\r
          Buffer[Index++] = *UnicodeStr;\r
        }\r
        //\r
        // Add padding if needed\r
        //\r
        for (; (Count < Width) && (Index < NumberOfCharacters - 1); Count++) {\r
          Buffer[Index++] = ' ';\r
        }\r
\r
        break;\r
\r
      case 'a':\r
        AsciiStr = (CHAR8 *)VA_ARG (Marker, CHAR8 *);\r
        if (AsciiStr == NULL) {\r
          AsciiStr = (CHAR8 *) "<null string>";\r
        }\r
        for (Count = 0 ;(*AsciiStr != '\0') && (Index < NumberOfCharacters - 1); AsciiStr++, Count++) {\r
          Buffer[Index++] = (CHAR_W)*AsciiStr;\r
        }\r
        //\r
        // Add padding if needed\r
        //\r
        for (;(Count < Width) && (Index < NumberOfCharacters - 1); Count++) {\r
          Buffer[Index++] = ' ';\r
        }\r
        break;\r
\r
      case 'c':\r
        Buffer[Index++] = (CHAR_W)VA_ARG (Marker, UINTN);\r
        break;\r
\r
      case 'g':\r
        TmpGUID = VA_ARG (Marker, EFI_GUID *); \r
        if (TmpGUID != NULL) {\r
          Index += GuidToString (\r
                    TmpGUID, \r
                    &Buffer[Index], \r
                    BufferLeft\r
                    );\r
        }\r
        break;\r
\r
      case 't':\r
        Index += TimeToString (\r
                  VA_ARG (Marker, EFI_TIME *), \r
                  &Buffer[Index], \r
                  BufferLeft\r
                  );\r
        break;\r
\r
      case 'r':\r
        Index += EfiStatusToString (\r
                  VA_ARG (Marker, EFI_STATUS), \r
                  &Buffer[Index], \r
                  BufferLeft\r
                  );\r
        break;\r
\r
      case '%':\r
        Buffer[Index++] = *Format;\r
        break;\r
    \r
      default:\r
        //\r
        // if the type is unknown print it to the screen\r
        //\r
        Buffer[Index++] = *Format;\r
      }\r
      BufferLeft = BufferSize - Index * sizeof(CHAR_W) ;\r
    } \r
  }\r
  Buffer[Index++] = '\0'; \r
   \r
  return &Buffer[Index] - StartOfBuffer;\r
}\r
\r
\r
\r
STATIC\r
CHAR_W *\r
GetFlagsAndWidth (\r
  IN  CHAR_W      *Format, \r
  OUT UINTN       *Flags, \r
  OUT UINTN       *Width,\r
  IN OUT  VA_LIST *Marker\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  VSPrint worker function that parses flag and width information from the \r
  Format string and returns the next index into the Format string that needs\r
  to be parsed. See file headed for details of Flag and Width.\r
\r
Arguments:\r
\r
  Format - Current location in the VSPrint format string.\r
\r
  Flags  - Returns flags\r
\r
  Width  - Returns width of element\r
\r
  Marker - Vararg list that may be paritally consumed and returned.\r
\r
Returns: \r
\r
  Pointer indexed into the Format string for all the information parsed\r
  by this routine.\r
\r
--*/\r
{\r
  UINTN   Count;\r
  BOOLEAN Done;\r
\r
  *Flags = 0;\r
  *Width = 0;\r
  for (Done = FALSE; !Done; ) {\r
    Format++;\r
\r
    switch (*Format) {\r
\r
    case '-': *Flags |= LEFT_JUSTIFY; break;\r
    case '+': *Flags |= PREFIX_SIGN;  break;\r
    case ' ': *Flags |= PREFIX_BLANK; break;\r
    case ',': *Flags |= COMMA_TYPE;   break;\r
    case 'L':\r
    case 'l': *Flags |= LONG_TYPE;    break;\r
\r
    case '*':\r
      *Width = VA_ARG (*Marker, UINTN);\r
      break;\r
\r
    case '0':\r
      *Flags |= PREFIX_ZERO;\r
    case '1':\r
    case '2':\r
    case '3':\r
    case '4':\r
    case '5':\r
    case '6':\r
    case '7':\r
    case '8':\r
    case '9':\r
      Count = 0;\r
      do {\r
        Count = (Count * 10) + *Format - '0';\r
        Format++;\r
      } while ((*Format >= '0')  &&  (*Format <= '9'));\r
      Format--;\r
      *Width = Count;\r
      break;\r
\r
    default:\r
      Done = TRUE;\r
    }\r
  }\r
  return Format;\r
}\r
\r
STATIC\r
UINTN\r
GuidToString (\r
  IN  EFI_GUID  *Guid,\r
  IN  CHAR_W    *Buffer,\r
  IN  UINTN     BufferSize\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  VSPrint worker function that prints an EFI_GUID.\r
\r
Arguments:\r
\r
  Guid       - Pointer to GUID to print.\r
\r
  Buffer     - Buffe to print Guid into.\r
  \r
  BufferSize - Size of Buffer.\r
\r
Returns: \r
\r
  Number of characters printed.  \r
\r
--*/\r
{\r
  UINTN Size;\r
\r
  Size = SPrint (\r
            Buffer,\r
            BufferSize, \r
            STRING_W ("%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x"),\r
            (UINTN)Guid->Data1,                    \r
            (UINTN)Guid->Data2,\r
            (UINTN)Guid->Data3,\r
            (UINTN)Guid->Data4[0],\r
            (UINTN)Guid->Data4[1],\r
            (UINTN)Guid->Data4[2],\r
            (UINTN)Guid->Data4[3],\r
            (UINTN)Guid->Data4[4],\r
            (UINTN)Guid->Data4[5],\r
            (UINTN)Guid->Data4[6],\r
            (UINTN)Guid->Data4[7]\r
            );\r
\r
  //\r
  // SPrint will null terminate the string. The -1 skips the null\r
  //\r
  return Size - 1;\r
}\r
\r
\r
STATIC\r
UINTN\r
TimeToString (\r
  IN EFI_TIME   *Time,\r
  OUT CHAR_W    *Buffer,\r
  IN  UINTN     BufferSize\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  VSPrint worker function that prints EFI_TIME.\r
\r
Arguments:\r
\r
  Time       - Pointer to EFI_TIME sturcture to print.\r
\r
  Buffer     - Buffer to print Time into.\r
  \r
  BufferSize - Size of Buffer.\r
\r
Returns: \r
\r
  Number of characters printed.  \r
\r
--*/\r
{ \r
  UINTN Size;\r
\r
  Size = SPrint (\r
            Buffer,\r
            BufferSize, \r
            STRING_W ("%02d/%02d/%04d  %02d:%02d"),\r
            (UINTN)Time->Month,\r
            (UINTN)Time->Day,\r
            (UINTN)Time->Year,\r
            (UINTN)Time->Hour,\r
            (UINTN)Time->Minute\r
            );\r
\r
  //\r
  // SPrint will null terminate the string. The -1 skips the null\r
  //\r
  return Size - 1;\r
} \r
\r
STATIC\r
UINTN\r
EfiStatusToString (\r
  IN EFI_STATUS   Status,\r
  OUT CHAR_W      *Buffer,\r
  IN  UINTN       BufferSize\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  VSPrint worker function that prints EFI_STATUS as a string. If string is\r
  not known a hex value will be printed.\r
\r
Arguments:\r
\r
  Status     -  EFI_STATUS sturcture to print.\r
\r
  Buffer     - Buffer to print EFI_STATUS message string into.\r
  \r
  BufferSize - Size of Buffer.\r
\r
Returns: \r
\r
  Number of characters printed.  \r
\r
--*/\r
{\r
  UINTN   Size;\r
  CHAR8   *Desc;\r
  \r
  Desc = NULL;\r
\r
  //\r
  // Can't use global Status String Array as UINTN is not constant for EBC\r
  //\r
  if (Status == EFI_SUCCESS) { Desc = (CHAR8 *) "Success"; } else \r
  if (Status == EFI_LOAD_ERROR) { Desc = (CHAR8 *) "Load Error"; } else\r
  if (Status == EFI_INVALID_PARAMETER) { Desc = (CHAR8 *) "Invalid Parameter"; } else\r
  if (Status == EFI_UNSUPPORTED) { Desc = (CHAR8 *) "Unsupported"; } else\r
  if (Status == EFI_BAD_BUFFER_SIZE) { Desc = (CHAR8 *) "Bad Buffer Size"; } else\r
  if (Status == EFI_BUFFER_TOO_SMALL) { Desc = (CHAR8 *) "Buffer Too Small"; } else\r
  if (Status == EFI_NOT_READY) { Desc = (CHAR8 *) "Not Ready"; } else\r
  if (Status == EFI_DEVICE_ERROR) { Desc = (CHAR8 *) "Device Error"; } else\r
  if (Status == EFI_WRITE_PROTECTED) { Desc = (CHAR8 *) "Write Protected"; } else\r
  if (Status == EFI_OUT_OF_RESOURCES) { Desc = (CHAR8 *) "Out of Resources"; } else\r
  if (Status == EFI_VOLUME_CORRUPTED) { Desc = (CHAR8 *) "Volume Corrupt"; } else\r
  if (Status == EFI_VOLUME_FULL) { Desc = (CHAR8 *) "Volume Full"; } else\r
  if (Status == EFI_NO_MEDIA) { Desc = (CHAR8 *) "No Media"; } else\r
  if (Status == EFI_MEDIA_CHANGED) { Desc = (CHAR8 *) "Media changed"; } else\r
  if (Status == EFI_NOT_FOUND) { Desc = (CHAR8 *) "Not Found"; } else\r
  if (Status == EFI_ACCESS_DENIED) { Desc = (CHAR8 *) "Access Denied"; } else\r
  if (Status == EFI_NO_RESPONSE) { Desc = (CHAR8 *) "No Response"; } else\r
  if (Status == EFI_NO_MAPPING) { Desc = (CHAR8 *) "No mapping"; } else\r
  if (Status == EFI_TIMEOUT) { Desc = (CHAR8 *) "Time out"; } else\r
  if (Status == EFI_NOT_STARTED) { Desc = (CHAR8 *) "Not started"; } else\r
  if (Status == EFI_ALREADY_STARTED) { Desc = (CHAR8 *) "Already started"; } else\r
  if (Status == EFI_ABORTED) { Desc = (CHAR8 *) "Aborted"; } else\r
  if (Status == EFI_ICMP_ERROR) { Desc = (CHAR8 *) "ICMP Error"; } else\r
  if (Status == EFI_TFTP_ERROR) { Desc = (CHAR8 *) "TFTP Error"; } else\r
  if (Status == EFI_PROTOCOL_ERROR) { Desc = (CHAR8 *) "Protocol Error"; } else\r
  if (Status == EFI_WARN_UNKNOWN_GLYPH) { Desc = (CHAR8 *) "Warning Unknown Glyph"; } else\r
  if (Status == EFI_WARN_DELETE_FAILURE) { Desc = (CHAR8 *) "Warning Delete Failure"; } else\r
  if (Status == EFI_WARN_WRITE_FAILURE) { Desc = (CHAR8 *) "Warning Write Failure"; } else\r
  if (Status == EFI_WARN_BUFFER_TOO_SMALL) { Desc = (CHAR8 *) "Warning Buffer Too Small"; } \r
  \r
  //\r
  // If we found a match, copy the message to the user's buffer. Otherwise\r
  // sprint the hex status code to their buffer.\r
  //\r
  if (Desc != NULL) {\r
    Size = SPrint (Buffer, BufferSize, STRING_W ("%a"), Desc);\r
  } else {\r
    Size = SPrint (Buffer, BufferSize, STRING_W ("%X"), Status);\r
  }\r
  return Size - 1;\r
}\r