clean the codes according to review comments.
[people/mcb30/edk2.git] / edk2 / MdePkg / Library / PeiServicesTablePointerLib / PeiServicesTablePointerInternal.h
1 /** @file\r
2   Internal Header file for PEI Services Table Pointer Library.\r
3 \r
4   Copyright (c) 2006, Intel Corporation<BR>\r
5   All rights reserved. This program and the accompanying materials\r
6   are licensed and made available under the terms and conditions of the BSD License\r
7   which accompanies this distribution.  The full text of the license may be found at\r
8   http://opensource.org/licenses/bsd-license.php\r
9 \r
10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12 \r
13 **/\r
14 \r
15 #ifndef _PEI_SERVICE_TABLE_POINTER_INTERNAL_H_\r
16 #define _PEI_SERVICE_TABLE_POINTER_INTERNAL_H_\r
17 \r
18 /**\r
19   The constructor function caches the pointer to PEI services.\r
20   \r
21   The constructor function caches the pointer to PEI services.\r
22   It will always return EFI_SUCCESS.\r
23 \r
24   @param  FileHandle  Handle of FFS header the loaded driver.\r
25   @param  PeiServices Pointer to the PEI services.\r
26 \r
27   @retval EFI_SUCCESS   The constructor always returns EFI_SUCCESS.\r
28 \r
29 **/\r
30 EFI_STATUS\r
31 EFIAPI\r
32 PeiServicesTablePointerLibConstructor (\r
33   IN EFI_PEI_FILE_HANDLE  FileHandle,\r
34   IN EFI_PEI_SERVICES     **PeiServices\r
35   )\r
36 ;\r
37 #endif\r