MdeModulePkg/Include/Library/PlatformHookLib.h

   1 /** @file
   2   Platform hook library. Platform can provide an implementation of this
   3   library class to provide hooks that may be required for some type of
   4   platform initialization.
   5
   6 Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR>
   7 SPDX-License-Identifier: BSD-2-Clause-Patent
   8
   9 **/
  10
  11 #ifndef __PLATFORM_HOOK_LIB__
  12 #define __PLATFORM_HOOK_LIB__
  13
  14 /**
  15   Performs platform specific initialization required for the CPU to access
  16   the hardware associated with a SerialPortLib instance.  This function does
  17   not intiailzie the serial port hardware itself.  Instead, it initializes
  18   hardware devices that are required for the CPU to access the serial port
  19   hardware.  This function may be called more than once.
  20
  21   @retval RETURN_SUCCESS       The platform specific initialization succeeded.
  22   @retval RETURN_DEVICE_ERROR  The platform specific initialization could not be completed.
  23
  24 **/
  25 RETURN_STATUS
  26 EFIAPI
  27 PlatformHookSerialPortInitialize (
  28   VOID
  29   );
  30
  31 #endif // __PLATFORM_HOOK_LIB__