OvmfPkg: Apply uncrustify changes

[mirror_edk2.git] / OvmfPkg / Include / Library / QemuFwCfgSimpleParserLib.h

/** @file\r
  Parse the contents of named fw_cfg files as simple (scalar) data types.\r
\r
  Copyright (C) 2020, Red Hat, Inc.\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
**/\r
\r
#ifndef QEMU_FW_CFG_SIMPLE_PARSER_LIB_H_\r
#define QEMU_FW_CFG_SIMPLE_PARSER_LIB_H_\r
\r
#include <Base.h>\r
\r
/**\r
  Look up FileName with QemuFwCfgFindFile() from QemuFwCfgLib. Read the fw_cfg\r
  file into a small array with automatic storage duration. Parse the array as\r
  the textual representation of a BOOLEAN.\r
\r
  @param[in] FileName  The name of the fw_cfg file to look up and parse.\r
\r
  @param[out] Value    On success, Value is TRUE if the contents of the fw_cfg\r
                       file case-insensitively match "true", "yes", "y",\r
                       "enable", "enabled", "1".\r
\r
                       On success, Value is FALSE if the contents of the fw_cfg\r
                       file case-insensitively match "false", "no", "n",\r
                       "disable", "disabled", "0".\r
\r
                       On failure, Value is not changed.\r
\r
  @retval RETURN_SUCCESS         Parsing successful. Value has been set.\r
\r
  @retval RETURN_UNSUPPORTED     Firmware configuration is unavailable.\r
\r
  @retval RETURN_PROTOCOL_ERROR  Parsing failed. Value has not been changed.\r
\r
  @return                        Error codes propagated from\r
                                 QemuFwCfgFindFile(). Value has not been\r
                                 changed.\r
**/\r
RETURN_STATUS\r
EFIAPI\r
QemuFwCfgParseBool (\r
  IN  CONST CHAR8  *FileName,\r
  OUT BOOLEAN      *Value\r
  );\r
\r
/**\r
  Look up FileName with QemuFwCfgFindFile() from QemuFwCfgLib. Read the fw_cfg\r
  file into a small array with automatic storage duration. Parse the array as\r
  the textual representation of a UINT8.\r
\r
  @param[in] FileName    The name of the fw_cfg file to look up and parse.\r
\r
  @param[in] ParseAsHex  If TRUE, call BaseLib's AsciiStrHexToUint64S() for\r
                         parsing the fw_cfg file.\r
\r
                         If FALSE, call BaseLib's AsciiStrDecimalToUint64S()\r
                         for parsing the fw_cfg file.\r
\r
  @param[out] Value      On success, Value has been parsed with the BaseLib\r
                         function determined by ParseAsHex, and also\r
                         range-checked for [0, MAX_UINT8].\r
\r
                         On failure, Value is not changed.\r
\r
  @retval RETURN_SUCCESS         Parsing successful. Value has been set.\r
\r
  @retval RETURN_UNSUPPORTED     Firmware configuration is unavailable.\r
\r
  @retval RETURN_PROTOCOL_ERROR  Parsing failed. Value has not been changed.\r
\r
  @retval RETURN_PROTOCOL_ERROR  Parsing succeeded, but the result does not fit\r
                                 in the [0, MAX_UINT8] range. Value has not\r
                                 been changed.\r
\r
  @return                        Error codes propagated from\r
                                 QemuFwCfgFindFile() and from the BaseLib\r
                                 function selected by ParseAsHex. Value has not\r
                                 been changed.\r
**/\r
RETURN_STATUS\r
EFIAPI\r
QemuFwCfgParseUint8 (\r
  IN  CONST CHAR8  *FileName,\r
  IN  BOOLEAN      ParseAsHex,\r
  OUT UINT8        *Value\r
  );\r
\r
//\r
// The following functions behave identically to QemuFwCfgParseUint8(),\r
// only their range checks use MAX_UINT16, MAX_UINT32, MAX_UINT64, MAX_UINTN,\r
// respectively.\r
//\r
\r
RETURN_STATUS\r
EFIAPI\r
QemuFwCfgParseUint16 (\r
  IN  CONST CHAR8  *FileName,\r
  IN  BOOLEAN      ParseAsHex,\r
  OUT UINT16       *Value\r
  );\r
\r
RETURN_STATUS\r
EFIAPI\r
QemuFwCfgParseUint32 (\r
  IN  CONST CHAR8  *FileName,\r
  IN  BOOLEAN      ParseAsHex,\r
  OUT UINT32       *Value\r
  );\r
\r
RETURN_STATUS\r
EFIAPI\r
QemuFwCfgParseUint64 (\r
  IN  CONST CHAR8  *FileName,\r
  IN  BOOLEAN      ParseAsHex,\r
  OUT UINT64       *Value\r
  );\r
\r
RETURN_STATUS\r
EFIAPI\r
QemuFwCfgParseUintn (\r
  IN  CONST CHAR8  *FileName,\r
  IN  BOOLEAN      ParseAsHex,\r
  OUT UINTN        *Value\r
  );\r
\r
#endif // QEMU_FW_CFG_SIMPLE_PARSER_LIB_H_\r