Update all files to follow doxygen style file header.

[mirror_edk2.git] / MdeModulePkg / Library / ExtendedIfrSupportLib / R8Lib.h

/** @file\r
  <Todo: Add file description>\r
\r
Copyright (c) 2007 - 2008, Intel Corporation. <BR>\r
All rights reserved. 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
**/\r
\r
\r
\r
/**\r
  Converts binary buffer to Unicode string.\r
  At a minimum, any blob of data could be represented as a hex string.\r
\r
  @param  Str                    Pointer to the string.\r
  @param  HexStringBufferLength  Length in bytes of buffer to hold the hex string.\r
                                 Includes tailing '\0' character. If routine return\r
                                 with EFI_SUCCESS, containing length of hex string\r
                                 buffer. If routine return with\r
                                 EFI_BUFFER_TOO_SMALL, containg length of hex\r
                                 string buffer desired.\r
  @param  Buf                    Buffer to be converted from.\r
  @param  Len                    Length in bytes of the buffer to be converted.\r
\r
  @retval EFI_SUCCESS            Routine success.\r
  @retval EFI_BUFFER_TOO_SMALL   The hex string buffer is too small.\r
\r
**/\r
EFI_STATUS\r
R8_BufToHexString (\r
  IN OUT CHAR16                    *Str,\r
  IN OUT UINTN                     *HexStringBufferLength,\r
  IN     UINT8                     *Buf,\r
  IN     UINTN                      Len\r
  )\r
;\r
\r
\r
\r
\r
/**\r
  Converts Unicode string to binary buffer.\r
  The conversion may be partial.\r
  The first character in the string that is not hex digit stops the conversion.\r
  At a minimum, any blob of data could be represented as a hex string.\r
\r
  @param  Buf                    Pointer to buffer that receives the data.\r
  @param  Len                    Length in bytes of the buffer to hold converted\r
                                 data. If routine return with EFI_SUCCESS,\r
                                 containing length of converted data. If routine\r
                                 return with EFI_BUFFER_TOO_SMALL, containg length\r
                                 of buffer desired.\r
  @param  Str                    String to be converted from.\r
  @param  ConvertedStrLen        Length of the Hex String consumed.\r
\r
  @retval EFI_SUCCESS            Routine Success.\r
  @retval EFI_BUFFER_TOO_SMALL   The buffer is too small to hold converted data.\r
\r
**/\r
EFI_STATUS\r
R8_HexStringToBuf (\r
  IN OUT UINT8                     *Buf,\r
  IN OUT UINTN                    *Len,\r
  IN     CHAR16                    *Str,\r
  OUT    UINTN                     *ConvertedStrLen  OPTIONAL\r
  )\r
;\r
\r
/**\r
  Determines if a Unicode character is a hexadecimal digit.\r
  The test is case insensitive.\r
\r
  @param  Digit                  Pointer to byte that receives the value of the hex\r
                                 character.\r
  @param  Char                   Unicode character to test.\r
\r
  @retval TRUE                   If the character is a hexadecimal digit.\r
  @retval FALSE                  Otherwise.\r
\r
**/\r
BOOLEAN\r
R8_IsHexDigit (\r
  OUT UINT8      *Digit,\r
  IN  CHAR16      Char\r
  )\r
;\r
\r