MdeModulePkg: Clean up source files

[mirror_edk2.git] / MdeModulePkg / Include / Library / PlatformHookLib.h

/** @file\r
  Platform hook library. Platform can provide an implementation of this\r
  library class to provide hooks that may be required for some type of\r
  platform initialization.\r
\r
Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials are licensed and made available under\r
the terms and conditions of the BSD License that accompanies this distribution.\r
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
#ifndef __PLATFORM_HOOK_LIB__\r
#define __PLATFORM_HOOK_LIB__\r
\r
/**\r
  Performs platform specific initialization required for the CPU to access\r
  the hardware associated with a SerialPortLib instance.  This function does\r
  not intiailzie the serial port hardware itself.  Instead, it initializes\r
  hardware devices that are required for the CPU to access the serial port\r
  hardware.  This function may be called more than once.\r
\r
  @retval RETURN_SUCCESS       The platform specific initialization succeeded.\r
  @retval RETURN_DEVICE_ERROR  The platform specific initialization could not be completed.\r
\r
**/\r
RETURN_STATUS\r
EFIAPI\r
PlatformHookSerialPortInitialize (\r
  VOID\r
  );\r
\r
#endif // __PLATFORM_HOOK_LIB__\r
\r