| 64d14edf |
1 | /** @file\r |
| 2 | Support for S3 boot script lib. This file defined some internal macro and internal \r |
| 3 | data structure\r |
| 4 | \r |
| 5 | Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r |
| 6 | \r |
| 7 | This program and the accompanying materials\r |
| 8 | are licensed and made available under the terms and conditions\r |
| 9 | of the BSD License which accompanies this distribution. The\r |
| 10 | full text of the license may be found at\r |
| 11 | http://opensource.org/licenses/bsd-license.php\r |
| 12 | \r |
| 13 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r |
| 14 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r |
| 15 | \r |
| 16 | **/\r |
| 17 | #ifndef __INTERNAL_BOOT_SCRIPT_LIB__\r |
| 18 | #define __INTERNAL_BOOT_SCRIPT_LIB__\r |
| 19 | \r |
| 20 | #include <PiDxe.h>\r |
| 21 | \r |
| 22 | #include <Guid/EventGroup.h>\r |
| 23 | #include <Protocol/SmmBase2.h>\r |
| 24 | #include <Protocol/DxeSmmReadyToLock.h>\r |
| 25 | #include <Protocol/SmmReadyToLock.h>\r |
| 26 | \r |
| 27 | #include <Library/S3BootScriptLib.h>\r |
| 28 | \r |
| 29 | #include <Library/UefiBootServicesTableLib.h>\r |
| 30 | #include <Library/BaseLib.h>\r |
| 31 | #include <Library/PcdLib.h>\r |
| 32 | #include <Library/SmbusLib.h>\r |
| 33 | #include <Library/IoLib.h>\r |
| 34 | #include <Library/PciLib.h>\r |
| 35 | #include <Library/DebugLib.h>\r |
| 36 | #include <Library/BaseMemoryLib.h>\r |
| 37 | #include <Library/TimerLib.h>\r |
| 38 | #include <Library/UefiLib.h>\r |
| 39 | #include <Library/LockBoxLib.h>\r |
| 40 | \r |
| 41 | #include "BootScriptInternalFormat.h"\r |
| 42 | \r |
| 43 | #define MAX_IO_ADDRESS 0xFFFF\r |
| 44 | \r |
| 45 | #define PCI_ADDRESS_ENCODE(A) (UINTN)PCI_LIB_ADDRESS( \\r |
| 46 | (((A)& 0xff000000) >> 24), (((A) &0x00ff0000) >> 16), (((A) & 0xff00) >> 8), ((RShiftU64 ((A), 32) & 0xfff) | ((A)& 0xff)) \\r |
| 47 | )\r |
| 48 | \r |
| 49 | \r |
| 50 | \r |
| 51 | typedef union {\r |
| 52 | UINT8 volatile *Buf;\r |
| 53 | UINT8 volatile *Uint8;\r |
| 54 | UINT16 volatile *Uint16;\r |
| 55 | UINT32 volatile *Uint32;\r |
| 56 | UINT64 volatile *Uint64;\r |
| 57 | UINTN volatile Uint;\r |
| 58 | } PTR;\r |
| 59 | \r |
| 60 | \r |
| 61 | // Minimum and maximum length for SMBus bus block protocols defined in SMBus spec 2.0.\r |
| 62 | //\r |
| 63 | #define MIN_SMBUS_BLOCK_LEN 1\r |
| 64 | #define MAX_SMBUS_BLOCK_LEN 32\r |
| 65 | \r |
| 66 | //\r |
| 67 | // The boot script private data.\r |
| 68 | //\r |
| 69 | typedef struct {\r |
| 70 | UINT8 *TableBase;\r |
| 71 | UINT32 TableLength; // Record the actual memory length \r |
| 72 | UINT16 TableMemoryPageNumber; // Record the page number Allocated for the table \r |
| 73 | BOOLEAN AtRuntime; // Record if current state is after SmmReadyToLock\r |
| 74 | BOOLEAN InSmm; // Record if this library is in SMM.\r |
| 75 | } SCRIPT_TABLE_PRIVATE_DATA;\r |
| 76 | \r |
| 77 | typedef\r |
| 78 | EFI_STATUS\r |
| 79 | (EFIAPI *DISPATCH_ENTRYPOINT_FUNC) (\r |
| 80 | IN EFI_HANDLE ImageHandle,\r |
| 81 | IN VOID *Context\r |
| 82 | );\r |
| 83 | \r |
| 84 | extern SCRIPT_TABLE_PRIVATE_DATA *mS3BootScriptTablePtr;\r |
| 85 | \r |
| 86 | //\r |
| 87 | // Define Opcode for Label which is implementation specific and no standard spec define.\r |
| 88 | //\r |
| 89 | #define S3_BOOT_SCRIPT_LIB_LABEL_OPCODE 0xFE\r |
| 90 | \r |
| 91 | ///\r |
| 92 | /// The opcode indicate the start of the boot script table.\r |
| 93 | ///\r |
| 94 | #define S3_BOOT_SCRIPT_LIB_TABLE_OPCODE 0xAA\r |
| 95 | ///\r |
| 96 | /// The opcode indicate the end of the boot script table.\r |
| 97 | ///\r |
| 98 | #define S3_BOOT_SCRIPT_LIB_TERMINATE_OPCODE 0xFF\r |
| 99 | \r |
| 100 | \r |
| 101 | #endif //__INTERNAL_BOOT_SCRIPT_LIB__\r |
| 102 | \r |
projects / mirror_edk2.git / blame