MdeModulePkg: Change OPTIONAL keyword usage style

[mirror_edk2.git] / MdeModulePkg / Library / OemHookStatusCodeLibNull / OemHookStatusCodeLibNull.c

/** @file\r
  Null instance of OEM Hook Status Code Library with empty functions.\r
\r
  Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
\r
/**\r
  Initialize OEM status code device .\r
\r
  @retval  EFI_SUCCESS   Always return EFI_SUCCESS.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
OemHookStatusCodeInitialize (\r
  VOID\r
  )\r
{\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Report status code to OEM device.\r
\r
  @param  CodeType      Indicates the type of status code being reported.\r
  @param  Value         Describes the current status of a hardware or software entity.\r
                        This included information about the class and subclass that is used to classify the entity\r
                        as well as an operation.  For progress codes, the operation is the current activity.\r
                        For error codes, it is the exception.  For debug codes, it is not defined at this time.\r
  @param  Instance      The enumeration of a hardware or software entity within the system.\r
                        A system may contain multiple entities that match a class/subclass pairing.\r
                        The instance differentiates between them.  An instance of 0 indicates that instance information is unavailable,\r
                        not meaningful, or not relevant.  Valid instance numbers start with 1.\r
  @param  CallerId      This optional parameter may be used to identify the caller.\r
                        This parameter allows the status code driver to apply different rules to different callers.\r
  @param  Data          This optional parameter may be used to pass additional data\r
\r
  @retval EFI_SUCCESS   Always return EFI_SUCCESS.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
OemHookStatusCodeReport (\r
  IN EFI_STATUS_CODE_TYPE     CodeType,\r
  IN EFI_STATUS_CODE_VALUE    Value,\r
  IN UINT32                   Instance,\r
  IN EFI_GUID                 *CallerId  OPTIONAL,\r
  IN EFI_STATUS_CODE_DATA     *Data      OPTIONAL\r
  )\r
{\r
  return EFI_SUCCESS;\r
}\r