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 This program and the accompanying materials are licensed and made available under
   8 the terms and conditions of the BSD License that accompanies this distribution.
   9 The full text of the license may be found at
  10 http://opensource.org/licenses/bsd-license.php.
  11
  12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  14
  15 **/
  16
  17 #ifndef __PLATFORM_HOOK_LIB__
  18 #define __PLATFORM_HOOK_LIB__
  19
  20 /**
  21   Performs platform specific initialization required for the CPU to access
  22   the hardware associated with a SerialPortLib instance.  This function does
  23   not intiailzie the serial port hardware itself.  Instead, it initializes
  24   hardware devices that are required for the CPU to access the serial port
  25   hardware.  This function may be called more than once.
  26
  27   @retval RETURN_SUCCESS       The platform specific initialization succeeded.
  28   @retval RETURN_DEVICE_ERROR  The platform specific initialization could not be completed.
  29
  30 **/
  31 RETURN_STATUS
  32 EFIAPI
  33 PlatformHookSerialPortInitialize (
  34   VOID
  35   );
  36
  37 #endif // __PLATFORM_HOOK_LIB__
  38