4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Save the S3 data to S3 boot script.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are licensed and made available under the terms and conditions
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the BSD License which accompanies this distribution. The
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Data structure usage:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync +------------------------------+<-- PcdS3BootScriptTablePrivateDataPtr
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync | SCRIPT_TABLE_PRIVATE_DATA |
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync | TableBase |---
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync | TableLength |--|--
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync | AtRuntime | | |
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync | InSmm | | |
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync +------------------------------+ | |
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync +------------------------------+<-- |
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync | EFI_BOOT_SCRIPT_TABLE_HEADER | |
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync | TableLength |----|--
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync +------------------------------+ | |
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync | ...... | | |
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync +------------------------------+<---- |
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync | EFI_BOOT_SCRIPT_TERMINATE | |
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync +------------------------------+<------
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Allocate local copy in SMM because we can not use mS3BootScriptTablePtr when we AtRuntime in InSmm.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 0xaea6b965, 0xdcf5, 0x4311, 0xb4, 0xb8, 0xf, 0x12, 0x46, 0x44, 0x94, 0xd2
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 0x1810ab4a, 0x2314, 0x4df6, 0x81, 0xeb, 0x67, 0xc6, 0xec, 0x5, 0x85, 0x91
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 0x2c680508, 0x2b87, 0x46ab, 0xb9, 0x8a, 0x49, 0xfc, 0x23, 0xf9, 0xf5, 0x95
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This is an internal function to add a terminate node the entry, recalculate the table
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync length and fill into the table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return the base address of the boot script tble.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // the table is not exist
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Append the termination entry.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ScriptTerminate.OpCode = S3_BOOT_SCRIPT_LIB_TERMINATE_OPCODE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ScriptTerminate.Length = (UINT8) sizeof (EFI_BOOT_SCRIPT_TERMINATE);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem (mS3BootScriptTablePtr->TableBase + mS3BootScriptTablePtr->TableLength, &ScriptTerminate, sizeof (EFI_BOOT_SCRIPT_TERMINATE));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // fill the table length
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ScriptTableInfo = (EFI_BOOT_SCRIPT_TABLE_HEADER*)(mS3BootScriptTablePtr->TableBase);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ScriptTableInfo->TableLength = mS3BootScriptTablePtr->TableLength + sizeof (EFI_BOOT_SCRIPT_TERMINATE);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // NOTE: Here we did NOT adjust the mS3BootScriptTablePtr->TableLength to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // mS3BootScriptTablePtr->TableLength + sizeof (EFI_BOOT_SCRIPT_TERMINATE). Because
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // maybe in runtime, we still need add entries into the table, and the runtime entry should be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // added start before this TERMINATE node.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function return the total size of INFORMATION OPCODE in boot script table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return InformationBufferSize The total size of INFORMATION OPCODE in boot script table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((VOID*)&TableHeader, Script, sizeof(EFI_BOOT_SCRIPT_TABLE_HEADER));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Go through the ScriptTable
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync while ((UINTN) Script < (UINTN) (S3TableBase + TableLength)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((VOID*)&ScriptHeader, Script, sizeof(EFI_BOOT_SCRIPT_COMMON_HEADER));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((VOID*)&Information, (VOID*)Script, sizeof(Information));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync InformationBufferSize += Information.InformationLength;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function fix INFORMATION OPCODE in boot script table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Originally, the Information buffer is pointer to EfiRuntimeServicesCode,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EfiRuntimeServicesData, or EfiACPIMemoryNVS. They are seperated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Now, in order to save it to LockBox, we allocate a big EfiACPIMemoryNVS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and fix the pointer for INFORMATION opcode InformationBuffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param InformationBuffer The address of new Information buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param InformationBufferSize The size of new Information buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((VOID*)&TableHeader, Script, sizeof(EFI_BOOT_SCRIPT_TABLE_HEADER));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Go through the ScriptTable
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync while ((UINTN) Script < (UINTN) (S3TableBase + TableLength)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((VOID*)&ScriptHeader, Script, sizeof(EFI_BOOT_SCRIPT_COMMON_HEADER));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((VOID*)&Information, (VOID*)Script, sizeof(Information));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (VOID *)((UINTN)InformationBuffer + FixedInformationBufferSize),
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync gBS->FreePool ((VOID *)(UINTN)Information.Information);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Information.Information = (EFI_PHYSICAL_ADDRESS)((UINTN)InformationBuffer + FixedInformationBufferSize);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((VOID*)Script, (VOID*)&Information, sizeof(Information));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FixedInformationBufferSize += Information.InformationLength;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT (FixedInformationBufferSize == InformationBufferSize);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function save boot script data to LockBox.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 1. BootSriptPrivate data, BootScript data - Image and DispatchContext are handled by platform.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 2. BootScriptExecutor, BootScriptExecutor context
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - ACPI variable - (PI version) sould be handled by SMM driver. S3 Page table is handled here.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - ACPI variable - framework version is already handled by Framework CPU driver.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // We need save BootScriptInformation to LockBox, because it is in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // EfiRuntimeServicesCode, EfiRuntimeServicesData, or EfiACPIMemoryNVS.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync InformationBufferSize = GetBootScriptInformationBufferSize ();
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Fix BootScript information pointer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FixBootScriptInformation ((VOID *)(UINTN)InformationBuffer, InformationBufferSize);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Save BootScript information to lockbox
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = SetLockBoxAttributes (&mBootScriptInformationGuid, LOCK_BOX_ATTRIBUTE_RESTORE_IN_PLACE);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // mS3BootScriptTablePtr->TableLength does not include EFI_BOOT_SCRIPT_TERMINATE, because we need add entry at runtime.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Save all info here, just in case that no one will add boot script entry in SMM.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync mS3BootScriptTablePtr->TableLength + sizeof(EFI_BOOT_SCRIPT_TERMINATE)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = SetLockBoxAttributes (&mBootScriptDataGuid, LOCK_BOX_ATTRIBUTE_RESTORE_IN_PLACE);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Just need save TableBase.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Do not update other field because they will NOT be used in S3.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = SetLockBoxAttributes (&mBootScriptHeaderDataGuid, LOCK_BOX_ATTRIBUTE_RESTORE_IN_PLACE);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This is the Event call back function to notify the Library the system is entering
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync run time phase.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Event Pointer to this event
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Context Event hanlder private data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Try to locate it because EfiCreateProtocolNotifyEvent will trigger it once when registration.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Just return if it is not found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Here we should tell the library that we are enter into runtime phase. and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // the memory page number occupied by the table should not grow anymore.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // In boot time, we need not write the terminate node when adding a node to boot scipt table
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // or else, that will impact the performance. However, in runtime, we should append terminate
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // node on every add to boot script table
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Save BootScript data to lockbox
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This is the Event call back function is triggered in SMM to notify the Library the system is entering
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync run time phase and set InSmm flag.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Protocol Points to the protocol's unique identifier
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Interface Points to the interface instance
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Handle The handle on which the interface was installed
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS SmmEventCallback runs successfully
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Check if it is already done
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (mS3BootScriptTablePtr == &mS3BootScriptTable) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Last chance to call-out, just make sure AtRuntime is set
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Save a local copy
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem (&mS3BootScriptTable, mS3BootScriptTablePtr, sizeof(*mS3BootScriptTablePtr));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // We should not use ACPINvs copy, because it is not safe.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Set InSmm, we allow boot script update when InSmm, but not allow boot script outside SMM.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // InSmm will only be checked if AtRuntime is TRUE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Record LockBoxLength
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync mLockBoxLength = mS3BootScriptTable.TableLength + sizeof(EFI_BOOT_SCRIPT_TERMINATE);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Library Constructor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync this function just identify it is a smm driver or non-smm driver linked against
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync with the library
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ImageHandle The firmware allocated handle for the EFI image.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SystemTable A pointer to the EFI System Table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_SUCCESS Allocate the global memory space to store S3 boot script table private data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_OUT_OF_RESOURCES No enough memory to allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync S3TablePtr = (SCRIPT_TABLE_PRIVATE_DATA*)(UINTN)PcdGet64(PcdS3BootScriptTablePrivateDataPtr);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // The Boot script private data is not be initialized. create it
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_SIZE_TO_PAGES(sizeof(SCRIPT_TABLE_PRIVATE_DATA)),
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PcdSet64 (PcdS3BootScriptTablePrivateDataPtr, (UINT64) (UINTN)S3TablePtr);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ZeroMem (S3TablePtr, sizeof(SCRIPT_TABLE_PRIVATE_DATA));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // create event to notify the library system enter the runtime phase
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync mEnterRuntimeEvent = EfiCreateProtocolNotifyEvent (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Get InSmm, we need to register SmmReadyToLock if this library is linked to SMM driver.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = gBS->LocateProtocol (&gEfiSmmBase2ProtocolGuid, NULL, (VOID**) &SmmBase2);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Good, we are in SMM
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = SmmBase2->GetSmstLocation (SmmBase2, &Smst);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Then register event after lock
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync To get the start address from which a new boot time s3 boot script entry will write into.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the table is not exist, the functio will first allocate a buffer for the table
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the table buffer is not enough for the new entry, in non-smm mode, the funtion will
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync invoke reallocate to enlarge buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param EntryLength the new entry length.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval the address from which the a new s3 boot script entry will write into
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync S3TableBase = (EFI_PHYSICAL_ADDRESS)(UINTN)(mS3BootScriptTablePtr->TableBase);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // The table is not exist. This is the first to add entry.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Allocate ACPI script table space under 4G memory. We need it to save
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // some settings done by CSM, which runs after normal script table closed
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 2 + PcdGet16(PcdS3BootScriptRuntimeTableReservePageNumber),
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Fill Table Header
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ScriptTableInfo = (EFI_BOOT_SCRIPT_TABLE_HEADER*)(UINTN)S3TableBase;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ScriptTableInfo->OpCode = S3_BOOT_SCRIPT_LIB_TABLE_OPCODE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ScriptTableInfo->Length = (UINT8) sizeof (EFI_BOOT_SCRIPT_TABLE_HEADER);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ScriptTableInfo->TableLength = 0; // will be calculate at CloseTable
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync mS3BootScriptTablePtr->TableLength = sizeof (EFI_BOOT_SCRIPT_TABLE_HEADER);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync mS3BootScriptTablePtr->TableBase = (UINT8*)(UINTN)S3TableBase;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync mS3BootScriptTablePtr->TableMemoryPageNumber = (UINT16)(2 + PcdGet16(PcdS3BootScriptRuntimeTableReservePageNumber));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Here we do not count the reserved memory for runtime script table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PageNumber = (UINT16)(mS3BootScriptTablePtr->TableMemoryPageNumber - PcdGet16(PcdS3BootScriptRuntimeTableReservePageNumber));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if ((UINT32)(PageNumber * EFI_PAGE_SIZE) < (TableLength + EntryLength)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // The buffer is too small to hold the table, Reallocate the buffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 2 + PageNumber + PcdGet16(PcdS3BootScriptRuntimeTableReservePageNumber),
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((VOID*)(UINTN)NewS3TableBase, (VOID*)(UINTN)S3TableBase, TableLength);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync gBS->FreePages (S3TableBase, mS3BootScriptTablePtr->TableMemoryPageNumber);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync mS3BootScriptTablePtr->TableBase = (UINT8*)(UINTN)NewS3TableBase;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync mS3BootScriptTablePtr->TableMemoryPageNumber = (UINT16) (2 + PageNumber + PcdGet16(PcdS3BootScriptRuntimeTableReservePageNumber));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // calculate the the start address for the new entry.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NewEntryPtr = mS3BootScriptTablePtr->TableBase + TableLength;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // update the table lenghth
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync mS3BootScriptTablePtr->TableLength = TableLength + EntryLength;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // In the boot time, we will not append the termination entry to the boot script
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // table until the callers think there is no boot time data that should be added and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // it is caller's responsibility to explicit call the CloseTable.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync To get the start address from which a new runtime s3 boot script entry will write into.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync In this case, it should be ensured that there is enough buffer to hold the entry.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param EntryLength the new entry length.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval the address from which the a new s3 runtime script entry will write into
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Check if the memory range reserved for S3 Boot Script table is large enough to hold the node.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (mS3BootScriptTablePtr->TableLength + EntryLength + sizeof (EFI_BOOT_SCRIPT_TERMINATE) <= EFI_PAGES_TO_SIZE((UINT32)(mS3BootScriptTablePtr->TableMemoryPageNumber))) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NewEntryPtr = mS3BootScriptTablePtr->TableBase + mS3BootScriptTablePtr->TableLength;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync mS3BootScriptTablePtr->TableLength = mS3BootScriptTablePtr->TableLength + EntryLength;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Append a terminate node on every insert
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync To get the start address from which a new s3 boot script entry will write into.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param EntryLength the new entry length.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval the address from which the a new s3 runtime script entry will write into
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // We need check InSmm when AtRuntime, because after SmmReadyToLock, only SMM driver is allowed to write boot script.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Add DEBUG ERROR, so that we can find it at boot time.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Do not use ASSERT, because we may have test invoke this interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DEBUG ((EFI_D_ERROR, "FATAL ERROR: Set boot script after ReadyToLock!!!\n"));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // NOTE: OS will restore ACPINvs data. After S3, the table length in mS3BootScriptTable (SMM) is different with
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // table length in BootScriptTable header (ACPINvs).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // So here we need sync them. We choose ACPINvs table length, because we want to override the boot script saved
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // in SMM every time.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT (mS3BootScriptTablePtr == &mS3BootScriptTable);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((VOID*)&TableHeader, (VOID*)mS3BootScriptTablePtr->TableBase, sizeof(EFI_BOOT_SCRIPT_TABLE_HEADER));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (mS3BootScriptTablePtr->TableLength + sizeof(EFI_BOOT_SCRIPT_TERMINATE) != TableHeader.TableLength) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Restore it to use original value
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Copy it again to get original value
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // NOTE: We should NOT use TableHeader.TableLength, because it is already updated to be whole length.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync mS3BootScriptTablePtr->TableLength = (UINT32)(mLockBoxLength - sizeof(EFI_BOOT_SCRIPT_TERMINATE));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NewEntryPtr = S3BootScriptGetRuntimeEntryAddAddress (EntryLength);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Now the length field is updated, need sync to lockbox.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // So in S3 resume, the data can be restored correctly.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((VOID*)&TableHeader, (VOID*)mS3BootScriptTablePtr->TableBase, sizeof(EFI_BOOT_SCRIPT_TABLE_HEADER));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OFFSET_OF(EFI_BOOT_SCRIPT_TABLE_HEADER, TableLength),
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NewEntryPtr = S3BootScriptGetBootTimeEntryAddAddress (EntryLength);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Sync BootScript LockBox data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (!mS3BootScriptTablePtr->AtRuntime || !mS3BootScriptTablePtr->InSmm) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Update Terminate
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // So in S3 resume, the data can be restored correctly.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync mLockBoxLength - sizeof(EFI_BOOT_SCRIPT_TERMINATE),
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (VOID *)((UINTN)mS3BootScriptTablePtr->TableBase + mLockBoxLength - sizeof(EFI_BOOT_SCRIPT_TERMINATE)),
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This is an function to close the S3 boot script table. The function could only be called in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync BOOT time phase. To comply with the Framework spec definition on
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_BOOT_SCRIPT_SAVE_PROTOCOL.CloseTable(), this function will fulfill following things:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 1. Closes the specified boot script table
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 2. It allocates a new memory pool to duplicate all the boot scripts in the specified table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Once this function is called, the table maintained by the library will be destroyed
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync after it is copied into the allocated pool.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 3. Any attempts to add a script record after calling this function will cause a new table
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to be created by the library.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 4. The base address of the allocated pool will be returned in Address. Note that after
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync using the boot script table, the CALLER is responsible for freeing the pool that is allocated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by this function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync In Spec PI1.1, this EFI_BOOT_SCRIPT_SAVE_PROTOCOL.CloseTable() is retired. To provides this API for now is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for Framework Spec compatibility.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If anyone does call CloseTable() on a real platform, then the caller is responsible for figuring out
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync how to get the script to run on an S3 resume because the boot script maintained by the lib will be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return the base address of the new copy of the boot script tble.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @note this function could only called in boot time phase
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Append the termination record the S3 boot script table
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TableLength = mS3BootScriptTablePtr->TableLength + sizeof (EFI_BOOT_SCRIPT_TERMINATE);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Allocate the buffer and copy the boot script to the buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Destroy the table maintained by the library so that the next write operation
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // will write the record to the first entry of the table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Fill the table header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ScriptTableInfo = (EFI_BOOT_SCRIPT_TABLE_HEADER*)S3TableBase;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ScriptTableInfo->OpCode = S3_BOOT_SCRIPT_LIB_TABLE_OPCODE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ScriptTableInfo->Length = (UINT8) sizeof (EFI_BOOT_SCRIPT_TABLE_HEADER);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ScriptTableInfo->TableLength = 0; // will be calculate at close the table
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync mS3BootScriptTablePtr->TableLength = sizeof (EFI_BOOT_SCRIPT_TABLE_HEADER);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Save I/O write to boot script
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Width The width of the I/O operations.Enumerated in S3_BOOT_SCRIPT_LIB_WIDTH.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Address The base address of the I/O operations.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Count The number of I/O operations to perform.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Buffer The source buffer from which to write data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_SUCCESS Opcode is added.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Length = (UINT8)(sizeof (EFI_BOOT_SCRIPT_IO_WRITE) + (WidthInByte * Count));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // save script data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ScriptIoWrite.OpCode = EFI_BOOT_SCRIPT_IO_WRITE_OPCODE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((VOID*)Script, (VOID*)&ScriptIoWrite, sizeof(EFI_BOOT_SCRIPT_IO_WRITE));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((VOID*)(Script + sizeof (EFI_BOOT_SCRIPT_IO_WRITE)), Buffer, WidthInByte * Count);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Adds a record for an I/O modify operation into a S3 boot script table
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Width The width of the I/O operations.Enumerated in S3_BOOT_SCRIPT_LIB_WIDTH.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Address The base address of the I/O operations.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Data A pointer to the data to be OR-ed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DataMask A pointer to the data mask to be AND-ed with the data read from the register
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_SUCCESS Opcode is added.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Length = (UINT8)(sizeof (EFI_BOOT_SCRIPT_IO_READ_WRITE) + (WidthInByte * 2));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Build script data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ScriptIoReadWrite.OpCode = EFI_BOOT_SCRIPT_IO_READ_WRITE_OPCODE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((VOID*)Script, (VOID*)&ScriptIoReadWrite, sizeof(EFI_BOOT_SCRIPT_IO_READ_WRITE));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((VOID*)(Script + sizeof (EFI_BOOT_SCRIPT_IO_READ_WRITE)), Data, WidthInByte);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((VOID*)(Script + sizeof (EFI_BOOT_SCRIPT_IO_READ_WRITE) + WidthInByte), DataMask, WidthInByte);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Adds a record for a memory write operation into a specified boot script table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Width The width of the I/O operations.Enumerated in S3_BOOT_SCRIPT_LIB_WIDTH.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Address The base address of the memory operations
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Count The number of memory operations to perform.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Buffer The source buffer from which to write the data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_SUCCESS Opcode is added.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Length = (UINT8)(sizeof (EFI_BOOT_SCRIPT_MEM_WRITE) + (WidthInByte * Count));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Build script data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ScriptMemWrite.OpCode = EFI_BOOT_SCRIPT_MEM_WRITE_OPCODE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((VOID*)Script, (VOID*)&ScriptMemWrite, sizeof(EFI_BOOT_SCRIPT_MEM_WRITE));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((VOID*)(Script + sizeof (EFI_BOOT_SCRIPT_MEM_WRITE)), Buffer, WidthInByte * Count);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Adds a record for a memory modify operation into a specified boot script table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Width The width of the I/O operations.Enumerated in S3_BOOT_SCRIPT_LIB_WIDTH.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Address The base address of the memory operations. Address needs alignment if required
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Data A pointer to the data to be OR-ed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DataMask A pointer to the data mask to be AND-ed with the data read from the register.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_SUCCESS Opcode is added.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Length = (UINT8)(sizeof (EFI_BOOT_SCRIPT_MEM_READ_WRITE) + (WidthInByte * 2));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Build script data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ScriptMemReadWrite.OpCode = EFI_BOOT_SCRIPT_MEM_READ_WRITE_OPCODE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((VOID*)Script, (VOID*)&ScriptMemReadWrite , sizeof (EFI_BOOT_SCRIPT_MEM_READ_WRITE));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((VOID*)(Script + sizeof (EFI_BOOT_SCRIPT_MEM_READ_WRITE)), Data, WidthInByte);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((VOID*)(Script + sizeof (EFI_BOOT_SCRIPT_MEM_READ_WRITE) + WidthInByte), DataMask, WidthInByte);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Adds a record for a PCI configuration space write operation into a specified boot script table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Width The width of the I/O operations.Enumerated in S3_BOOT_SCRIPT_LIB_WIDTH.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Address The address within the PCI configuration space.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Count The number of PCI operations to perform.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Buffer The source buffer from which to write the data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_SUCCESS Opcode is added.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Length = (UINT8)(sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG_WRITE) + (WidthInByte * Count));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Build script data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ScriptPciWrite.OpCode = EFI_BOOT_SCRIPT_PCI_CONFIG_WRITE_OPCODE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((VOID*)Script, (VOID*)&ScriptPciWrite, sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG_WRITE));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((VOID*)(Script + sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG_WRITE)), Buffer, WidthInByte * Count);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Adds a record for a PCI configuration space modify operation into a specified boot script table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Width The width of the I/O operations.Enumerated in S3_BOOT_SCRIPT_LIB_WIDTH.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Address The address within the PCI configuration space.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Data A pointer to the data to be OR-ed.The size depends on Width.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DataMask A pointer to the data mask to be AND-ed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN__SUCCESS Opcode is added.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_BOOT_SCRIPT_PCI_CONFIG_READ_WRITE ScriptPciReadWrite;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Length = (UINT8)(sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG_READ_WRITE) + (WidthInByte * 2));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Build script data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ScriptPciReadWrite.OpCode = EFI_BOOT_SCRIPT_PCI_CONFIG_READ_WRITE_OPCODE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((VOID*)Script, (VOID*)&ScriptPciReadWrite, sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG_READ_WRITE));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((VOID*)(Script + sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG_READ_WRITE)), Data, WidthInByte);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (VOID*)(Script + sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG_READ_WRITE) + WidthInByte),
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Adds a record for a PCI configuration space modify operation into a specified boot script table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Width The width of the I/O operations.Enumerated in S3_BOOT_SCRIPT_LIB_WIDTH.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Segment The PCI segment number for Address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Address The address within the PCI configuration space.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Count The number of PCI operations to perform.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Buffer The source buffer from which to write the data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_SUCCESS Opcode is added.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Length = (UINT8)(sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG2_WRITE) + (WidthInByte * Count));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Build script data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ScriptPciWrite2.OpCode = EFI_BOOT_SCRIPT_PCI_CONFIG2_WRITE_OPCODE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((VOID*)Script, (VOID*)&ScriptPciWrite2, sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG2_WRITE));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((VOID*)(Script + sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG2_WRITE)), Buffer, WidthInByte * Count);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Adds a record for a PCI configuration space modify operation into a specified boot script table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Width The width of the I/O operations.Enumerated in S3_BOOT_SCRIPT_LIB_WIDTH.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Segment The PCI segment number for Address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Address The address within the PCI configuration space.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Data A pointer to the data to be OR-ed. The size depends on Width.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DataMask A pointer to the data mask to be AND-ed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_SUCCESS Opcode is added.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_BOOT_SCRIPT_PCI_CONFIG2_READ_WRITE ScriptPciReadWrite2;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Length = (UINT8)(sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG2_READ_WRITE) + (WidthInByte * 2));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Build script data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ScriptPciReadWrite2.OpCode = EFI_BOOT_SCRIPT_PCI_CONFIG2_READ_WRITE_OPCODE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((VOID*)Script, (VOID*)&ScriptPciReadWrite2, sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG2_READ_WRITE));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((VOID*)(Script + sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG2_READ_WRITE)), Data, WidthInByte);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (VOID*)(Script + sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG2_READ_WRITE) + WidthInByte),
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Adds a record for an SMBus command execution into a specified boot script table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SmBusAddress Address that encodes the SMBUS Slave Address, SMBUS Command, SMBUS Data Length, and PEC.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Operation Indicates which particular SMBus protocol it will use to execute the SMBus
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync transactions.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Length A pointer to signify the number of bytes that this operation will do.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Buffer Contains the value of data to execute to the SMBUS slave device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_SUCCESS Opcode is added.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DataSize = (UINT8)(sizeof (EFI_BOOT_SCRIPT_SMBUS_EXECUTE) + (*Length));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Script = S3BootScriptGetEntryAddAddress (DataSize);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Build script data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ScriptSmbusExecute.OpCode = EFI_BOOT_SCRIPT_SMBUS_EXECUTE_OPCODE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ScriptSmbusExecute.SmBusAddress = (UINT64) SmBusAddress;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((VOID*)Script, (VOID*)&ScriptSmbusExecute, sizeof (EFI_BOOT_SCRIPT_SMBUS_EXECUTE));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (VOID*)(Script + sizeof (EFI_BOOT_SCRIPT_SMBUS_EXECUTE)),
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Adds a record for an execution stall on the processor into a specified boot script table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Duration Duration in microseconds of the stall
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_SUCCESS Opcode is added.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Build script data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((VOID*)Script, (VOID*)&ScriptStall, sizeof (EFI_BOOT_SCRIPT_STALL));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Adds a record for an execution stall on the processor into a specified boot script table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param EntryPoint Entry point of the code to be dispatched.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Context Argument to be passed into the EntryPoint of the code to be dispatched.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_SUCCESS Opcode is added.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Length = (UINT8)(sizeof (EFI_BOOT_SCRIPT_DISPATCH_2));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Build script data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ScriptDispatch2.OpCode = EFI_BOOT_SCRIPT_DISPATCH_2_OPCODE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ScriptDispatch2.EntryPoint = (EFI_PHYSICAL_ADDRESS)(UINTN)EntryPoint;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ScriptDispatch2.Context = (EFI_PHYSICAL_ADDRESS)(UINTN)Context;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((VOID*)Script, (VOID*)&ScriptDispatch2, sizeof (EFI_BOOT_SCRIPT_DISPATCH_2));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Adds a record for memory reads of the memory location and continues when the exit criteria is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync satisfied or after a defined duration.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Width The width of the memory operations.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Address The base address of the memory operations.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BitMask A pointer to the bit mask to be AND-ed with the data read from the register.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BitValue A pointer to the data value after to be Masked.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Duration Duration in microseconds of the stall.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param LoopTimes The times of the register polling.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_SUCCESS Opcode is added.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Length = (UINT8)(sizeof (EFI_BOOT_SCRIPT_MEM_POLL) + (WidthInByte * 2));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Build script data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ScriptMemPoll.OpCode = EFI_BOOT_SCRIPT_MEM_POLL_OPCODE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((UINT8 *) (Script + sizeof (EFI_BOOT_SCRIPT_MEM_POLL)), BitValue, WidthInByte);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((UINT8 *) (Script + sizeof (EFI_BOOT_SCRIPT_MEM_POLL) + WidthInByte), BitMask, WidthInByte);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((VOID*)Script, (VOID*)&ScriptMemPoll, sizeof (EFI_BOOT_SCRIPT_MEM_POLL));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Store arbitrary information in the boot script table. This opcode is a no-op on dispatch and is only
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync used for debugging script issues.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param InformationLength Length of the data in bytes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Information Information to be logged in the boot scrpit
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_UNSUPPORTED If entering runtime, this method will not support.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_SUCCESS Opcode is added.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Length = (UINT8)(sizeof (EFI_BOOT_SCRIPT_INFORMATION));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Use BootServicesData to hold the data, just in case caller free it.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // It will be copied into ACPINvs later.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Build script data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ScriptInformation.OpCode = EFI_BOOT_SCRIPT_INFORMATION_OPCODE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ScriptInformation.InformationLength = InformationLength;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((VOID *)(UINTN)Buffer, Information,(UINTN) InformationLength);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ScriptInformation.Information = (EFI_PHYSICAL_ADDRESS) (UINTN) Buffer;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((VOID*)Script, (VOID*)&ScriptInformation, sizeof (EFI_BOOT_SCRIPT_INFORMATION));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Store a string in the boot script table. This opcode is a no-op on dispatch and is only
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync used for debugging script issues.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param String The string to save to boot script table
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_SUCCESS Opcode is added.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Adds a record for dispatching specified arbitrary code into a specified boot script table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param EntryPoint Entry point of the code to be dispatched.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_SUCCESS Opcode is added.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Length = (UINT8)(sizeof (EFI_BOOT_SCRIPT_DISPATCH));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Build script data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ScriptDispatch.OpCode = EFI_BOOT_SCRIPT_DISPATCH_OPCODE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ScriptDispatch.EntryPoint = (EFI_PHYSICAL_ADDRESS)(UINTN)EntryPoint;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((VOID*)Script, (VOID*)&ScriptDispatch, sizeof (EFI_BOOT_SCRIPT_DISPATCH));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Adds a record for I/O reads the I/O location and continues when the exit criteria is satisfied or after a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync defined duration.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Width The width of the I/O operations.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Address The base address of the I/O operations.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Data The comparison value used for the polling exit criteria.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DataMask Mask used for the polling criteria. The bits in the bytes below Width which are zero
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync in Data are ignored when polling the memory address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Delay The number of 100ns units to poll. Note that timer available may be of poorer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync granularity so the delay may be longer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_SUCCESS Opcode is added.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Length = (UINT8)(sizeof (EFI_BOOT_SCRIPT_IO_POLL) + (WidthInByte * 2));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Build script data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ScriptIoPoll.OpCode = EFI_BOOT_SCRIPT_IO_POLL_OPCODE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ScriptIoPoll.Length = (UINT8) (sizeof (EFI_BOOT_SCRIPT_IO_POLL) + (WidthInByte * 2));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((VOID*)Script, (VOID*)&ScriptIoPoll, sizeof (EFI_BOOT_SCRIPT_IO_POLL));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((UINT8 *) (Script + sizeof (EFI_BOOT_SCRIPT_IO_POLL)), Data, WidthInByte);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((UINT8 *) (Script + sizeof (EFI_BOOT_SCRIPT_IO_POLL) + WidthInByte), DataMask, WidthInByte);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Adds a record for PCI configuration space reads and continues when the exit criteria is satisfied or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync after a defined duration.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Width The width of the I/O operations.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Address The address within the PCI configuration space.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Data The comparison value used for the polling exit criteria.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DataMask Mask used for the polling criteria. The bits in the bytes below Width which are zero
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync in Data are ignored when polling the memory address
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Delay The number of 100ns units to poll. Note that timer available may be of poorer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync granularity so the delay may be longer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_SUCCESS Opcode is added.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Length = (UINT8)(sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG_POLL) + (WidthInByte * 2));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Build script data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ScriptPciPoll.OpCode = EFI_BOOT_SCRIPT_PCI_CONFIG_POLL_OPCODE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ScriptPciPoll.Length = (UINT8) (sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG_POLL) + (WidthInByte * 2));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((VOID*)Script, (VOID*)&ScriptPciPoll, sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG_POLL));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((UINT8 *) (Script + sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG_POLL)), Data, WidthInByte);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((UINT8 *) (Script + sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG_POLL) + WidthInByte), DataMask, WidthInByte);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Adds a record for PCI configuration space reads and continues when the exit criteria is satisfied or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync after a defined duration.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Width The width of the I/O operations.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Segment The PCI segment number for Address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Address The address within the PCI configuration space.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Data The comparison value used for the polling exit criteria.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DataMask Mask used for the polling criteria. The bits in the bytes below Width which are zero
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync in Data are ignored when polling the memory address
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Delay The number of 100ns units to poll. Note that timer available may be of poorer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync granularity so the delay may be longer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_SUCCESS Opcode is added.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @note A known Limitations in the implementation: When interpreting the opcode EFI_BOOT_SCRIPT_PCI_CONFIG2_WRITE_OPCODE
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_BOOT_SCRIPT_PCI_CONFIG2_READ_WRITE_OPCODE and EFI_BOOT_SCRIPT_PCI_CONFIG2_POLL_OPCODE, the 'Segment' parameter is assumed as
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Zero, or else, assert.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Length = (UINT8)(sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG2_POLL) + (WidthInByte * 2));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Build script data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ScriptPci2Poll.OpCode = EFI_BOOT_SCRIPT_PCI_CONFIG2_POLL_OPCODE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ScriptPci2Poll.Length = (UINT8) (sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG2_POLL) + (WidthInByte * 2));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((VOID*)Script, (VOID*)&ScriptPci2Poll, sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG2_POLL));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((UINT8 *) (Script + sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG2_POLL)), Data, WidthInByte);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((UINT8 *) (Script + sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG2_POLL) + WidthInByte), DataMask, WidthInByte);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Do the calculation of start address from which a new s3 boot script entry will write into.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param EntryLength The new entry length.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Position specifies the position in the boot script table where the opcode will be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync inserted, either before or after, depending on BeforeOrAfter.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BeforeOrAfter The flag to indicate to insert the nod before or after the position.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This parameter is effective when InsertFlag is TRUE
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Script return out the position from which the a new s3 boot script entry will write into
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // The entry inserting to table is already added to the end of the table
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TableLength = mS3BootScriptTablePtr->TableLength - EntryLength;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // calculate the Position offset
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PositionOffset = (UINTN) ((UINT8 *)Position - S3TableBase);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // If the BeforeOrAfter is FALSE, that means to insert the node right after the node.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((VOID*)&ScriptHeader, Position, sizeof(EFI_BOOT_SCRIPT_COMMON_HEADER));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Insert the node before the adjusted Position
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem (S3TableBase+PositionOffset+EntryLength, S3TableBase+PositionOffset, TableLength - PositionOffset);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // calculate the the start address for the new entry.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Insert the node to the end of the table
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Insert the node to the beginning of the table
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PositionOffset = (UINTN) sizeof(EFI_BOOT_SCRIPT_TABLE_HEADER);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem (S3TableBase+PositionOffset+EntryLength, S3TableBase+PositionOffset, TableLength - PositionOffset);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Move the last boot script entry to the position
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BeforeOrAfter Specifies whether the opcode is stored before (TRUE) or after (FALSE) the position
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync in the boot script table specified by Position. If Position is NULL or points to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NULL then the new opcode is inserted at the beginning of the table (if TRUE) or end
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the table (if FALSE).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Position On entry, specifies the position in the boot script table where the opcode will be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync inserted, either before or after, depending on BeforeOrAfter. On exit, specifies
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the position of the inserted opcode in the boot script table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_OUT_OF_RESOURCES The table is not available.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_INVALID_PARAMETER The Position is not a valid position in the boot script table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_SUCCESS Opcode is inserted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT8 TempBootScriptEntry[BOOT_SCRIPT_NODE_MAX_LENGTH];
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TempPosition = (Position == NULL) ? NULL:(*Position);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Script = Script + sizeof(EFI_BOOT_SCRIPT_TABLE_HEADER);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Find the last boot Script Entry which is not the terminate node
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync while ((UINTN) Script < (UINTN) (StartAddress + TableLength)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((VOID*)&ScriptHeader, Script, sizeof(EFI_BOOT_SCRIPT_COMMON_HEADER));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (TempPosition != NULL && TempPosition == Script) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // If the position is specified, the position must be pointed to a boot script entry start address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (ScriptHeader.OpCode != S3_BOOT_SCRIPT_LIB_TERMINATE_OPCODE) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // If the position is specified, but not the start of a boot script entry, it is a invalid input
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((VOID*)&ScriptHeader, LastOpcode, sizeof(EFI_BOOT_SCRIPT_COMMON_HEADER));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem((VOID*)TempBootScriptEntry, LastOpcode, ScriptHeader.Length);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Find the right position to write the node in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Copy the node to Boot script table
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem((VOID*)Script, (VOID*)TempBootScriptEntry, ScriptHeader.Length);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // return out the Position
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Create a Label node in the boot script table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BeforeOrAfter Specifies whether the opcode is stored before (TRUE) or after (FALSE) the position
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync in the boot script table specified by Position. If Position is NULL or points to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NULL then the new opcode is inserted at the beginning of the table (if TRUE) or end
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the table (if FALSE).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Position On entry, specifies the position in the boot script table where the opcode will be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync inserted, either before or after, depending on BeforeOrAfter. On exit, specifies
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the position of the inserted opcode in the boot script table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param InformationLength Length of the label in bytes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Information Label to be logged in the boot scrpit
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_INVALID_PARAMETER The Position is not a valid position in the boot script table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_OUT_OF_RESOURCES Not enough memory for the table do operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_SUCCESS Opcode is added.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Length = (UINT8)(sizeof (EFI_BOOT_SCRIPT_INFORMATION) + InformationLength);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Buffer = Script + sizeof (EFI_BOOT_SCRIPT_INFORMATION);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Build script data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ScriptInformation.OpCode = S3_BOOT_SCRIPT_LIB_LABEL_OPCODE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ScriptInformation.InformationLength = InformationLength;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync AsciiStrnCpy (Buffer, Information,(UINTN) InformationLength);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ScriptInformation.Information = (EFI_PHYSICAL_ADDRESS) (UINTN) Buffer;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((VOID*)Script, (VOID*)&ScriptInformation, sizeof (EFI_BOOT_SCRIPT_INFORMATION));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return S3BootScriptMoveLastOpcode (BeforeOrAfter, Position);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Find a label within the boot script table and, if not present, optionally create it.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BeforeOrAfter Specifies whether the opcode is stored before (TRUE)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync or after (FALSE) the position in the boot script table
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specified by Position.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param CreateIfNotFound Specifies whether the label will be created if the label
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync does not exists (TRUE) or not (FALSE).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Position On entry, specifies the position in the boot script table
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync where the opcode will be inserted, either before or after,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync depending on BeforeOrAfter. On exit, specifies the position
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the inserted opcode in the boot script table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Label Points to the label which will be inserted in the boot script table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The operation succeeded. A record was added into the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specified script table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The parameter is illegal or the given boot script is not supported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the opcode is unknow or not supported because of the PCD
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Feature Flags.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES There is insufficient memory to store the boot script.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Check NULL Label
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Check empty Label
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Check that the script is initialized without adding an entry to the script.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // The code must search for the label first befor it knows if a new entry needs
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // to be added.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Check the header and search for existing label.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((VOID*)&TableHeader, Script, sizeof(EFI_BOOT_SCRIPT_TABLE_HEADER));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (TableHeader.OpCode != S3_BOOT_SCRIPT_LIB_TABLE_OPCODE) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync while ((UINTN) Script < (UINTN) (StartAddress + TableLength)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((VOID*)&ScriptHeader, Script, sizeof(EFI_BOOT_SCRIPT_COMMON_HEADER));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (ScriptHeader.OpCode == S3_BOOT_SCRIPT_LIB_LABEL_OPCODE) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (AsciiStrCmp ((CHAR8 *)(UINTN)(Script+sizeof(EFI_BOOT_SCRIPT_INFORMATION)), Label) == 0) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return S3BootScriptLabelInternal (BeforeOrAfter,Position, LabelLength, Label);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Compare two positions in the boot script table and return their relative position.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Position1 The positions in the boot script table to compare
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Position2 The positions in the boot script table to compare
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param RelativePosition On return, points to the result of the comparison
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The operation succeeded. A record was added into the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specified script table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The parameter is illegal or the given boot script is not supported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the opcode is unknow or not supported because of the PCD
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Feature Flags.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES There is insufficient memory to store the boot script.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TableLength = ((EFI_BOOT_SCRIPT_TABLE_HEADER*)Script)->TableLength;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // If in boot time, TableLength does not include the termination node. so add it up
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (Position1 < Script || Position1 > Script+TableLength) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (Position2 < Script || Position2 > Script+TableLength) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *RelativePosition = (Position1 < Position2)?-1:((Position1 == Position2)?0:1);