summaryrefslogtreecommitdiffstats
path: root/MdeModulePkg/Include/Library/PlatformHookLib.h
diff options
context:
space:
mode:
authormdkinney <mdkinney@6f19259b-4bc3-4df7-8a09-765794883524>2010-12-18 01:02:59 +0000
committermdkinney <mdkinney@6f19259b-4bc3-4df7-8a09-765794883524>2010-12-18 01:02:59 +0000
commit467d15ae63fb9d36904f06f11cde6c4cd5c297a2 (patch)
tree0eb4866c11d4fa5b5d2dc10f10cd706869afddc6 /MdeModulePkg/Include/Library/PlatformHookLib.h
parentccc96db96eca4c65f0172adcdbdfb211b4e703ed (diff)
downloadedk2-467d15ae63fb9d36904f06f11cde6c4cd5c297a2.tar.gz
edk2-467d15ae63fb9d36904f06f11cde6c4cd5c297a2.tar.bz2
edk2-467d15ae63fb9d36904f06f11cde6c4cd5c297a2.zip
Add generic SerialPortLib instance for 16550 UARTs configured through PCDs. Depends on new library class called PlatformHookLib to perform platform specific initialization of the UART.
Add PlatformHookLib.h that defines the PlatformHookLib class Add PlatformHookLibNull instance that is a Null implementation of the PlatformHookLib class git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@11184 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdeModulePkg/Include/Library/PlatformHookLib.h')
-rw-r--r--MdeModulePkg/Include/Library/PlatformHookLib.h38
1 files changed, 38 insertions, 0 deletions
diff --git a/MdeModulePkg/Include/Library/PlatformHookLib.h b/MdeModulePkg/Include/Library/PlatformHookLib.h
new file mode 100644
index 0000000000..0f265d49a3
--- /dev/null
+++ b/MdeModulePkg/Include/Library/PlatformHookLib.h
@@ -0,0 +1,38 @@
+/** @file
+ Platform hook library. Platform can provide an implementation of this
+ library class to provide hooks that may be required for some type of
+ platform initialization.
+
+Copyright (c) 2010, Intel Corporation. All rights reserved.<BR>
+This program and the accompanying materials are licensed and made available under
+the terms and conditions of the BSD License that accompanies this distribution.
+The full text of the license may be found at
+http://opensource.org/licenses/bsd-license.php.
+
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+
+**/
+
+#ifndef __PLATFORM_HOOK_LIB__
+#define __PLATFORM_HOOK_LIB__
+
+/**
+ Performs platform specific initialization required for the CPU to access
+ the hardware associated with a SerialPortLib instance. This function does
+ not intiailzie the serial port hardware itself. Instead, it initializes
+ hardware devices that are required for the CPU to access the serial port
+ hardware. This function may be called more than once.
+
+ @retval RETURN_SUCCESS The platform specific initialization succeeded.
+ @retval RETURN_DEVICE_ERROR The platform specific initialization could not be completed.
+
+**/
+RETURN_STATUS
+EFIAPI
+PlatformHookSerialPortInitialize (
+ VOID
+ );
+
+#endif // __PLATFORM_HOOK_LIB__
+