X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=MdePkg%2FLibrary%2FBaseS3BootScriptLibNull%2FBootScriptLib.c;fp=MdePkg%2FLibrary%2FBaseS3BootScriptLibNull%2FBootScriptLib.c;h=6436b95001339a3214b3bde0cf93d9c775e3ca5e;hp=f150e8b2e9412c84e7d5a34bf22fbf521070775a;hb=2f88bd3a1296c522317f1c21377876de63de5be7;hpb=1436aea4d5707e672672a11bda72be2c63c936c3 diff --git a/MdePkg/Library/BaseS3BootScriptLibNull/BootScriptLib.c b/MdePkg/Library/BaseS3BootScriptLibNull/BootScriptLib.c index f150e8b2e9..6436b95001 100644 --- a/MdePkg/Library/BaseS3BootScriptLibNull/BootScriptLib.c +++ b/MdePkg/Library/BaseS3BootScriptLibNull/BootScriptLib.c @@ -7,7 +7,6 @@ **/ - #include #include @@ -25,10 +24,10 @@ RETURN_STATUS EFIAPI S3BootScriptSaveIoWrite ( - IN S3_BOOT_SCRIPT_LIB_WIDTH Width, - IN UINT64 Address, - IN UINTN Count, - IN VOID *Buffer + IN S3_BOOT_SCRIPT_LIB_WIDTH Width, + IN UINT64 Address, + IN UINTN Count, + IN VOID *Buffer ) { return RETURN_SUCCESS; @@ -48,10 +47,10 @@ S3BootScriptSaveIoWrite ( RETURN_STATUS EFIAPI S3BootScriptSaveIoReadWrite ( - IN S3_BOOT_SCRIPT_LIB_WIDTH Width, - IN UINT64 Address, - IN VOID *Data, - IN VOID *DataMask + IN S3_BOOT_SCRIPT_LIB_WIDTH Width, + IN UINT64 Address, + IN VOID *Data, + IN VOID *DataMask ) { return RETURN_SUCCESS; @@ -71,14 +70,15 @@ S3BootScriptSaveIoReadWrite ( RETURN_STATUS EFIAPI S3BootScriptSaveMemWrite ( - IN S3_BOOT_SCRIPT_LIB_WIDTH Width, - IN UINT64 Address, - IN UINTN Count, - IN VOID *Buffer + IN S3_BOOT_SCRIPT_LIB_WIDTH Width, + IN UINT64 Address, + IN UINTN Count, + IN VOID *Buffer ) { return RETURN_SUCCESS; } + /** Adds a record for a memory modify operation into a specified boot script table. @@ -93,14 +93,15 @@ S3BootScriptSaveMemWrite ( RETURN_STATUS EFIAPI S3BootScriptSaveMemReadWrite ( - IN S3_BOOT_SCRIPT_LIB_WIDTH Width, - IN UINT64 Address, - IN VOID *Data, - IN VOID *DataMask + IN S3_BOOT_SCRIPT_LIB_WIDTH Width, + IN UINT64 Address, + IN VOID *Data, + IN VOID *DataMask ) { return RETURN_SUCCESS; } + /** Adds a record for a PCI configuration space write operation into a specified boot script table. @@ -115,10 +116,10 @@ S3BootScriptSaveMemReadWrite ( RETURN_STATUS EFIAPI S3BootScriptSavePciCfgWrite ( - IN S3_BOOT_SCRIPT_LIB_WIDTH Width, - IN UINT64 Address, - IN UINTN Count, - IN VOID *Buffer + IN S3_BOOT_SCRIPT_LIB_WIDTH Width, + IN UINT64 Address, + IN UINTN Count, + IN VOID *Buffer ) { return RETURN_SUCCESS; @@ -138,14 +139,15 @@ S3BootScriptSavePciCfgWrite ( RETURN_STATUS EFIAPI S3BootScriptSavePciCfgReadWrite ( - IN S3_BOOT_SCRIPT_LIB_WIDTH Width, - IN UINT64 Address, - IN VOID *Data, - IN VOID *DataMask + IN S3_BOOT_SCRIPT_LIB_WIDTH Width, + IN UINT64 Address, + IN VOID *Data, + IN VOID *DataMask ) { return RETURN_SUCCESS; } + /** Adds a record for a PCI configuration space modify operation into a specified boot script table. @@ -161,15 +163,16 @@ S3BootScriptSavePciCfgReadWrite ( RETURN_STATUS EFIAPI S3BootScriptSavePciCfg2Write ( - IN S3_BOOT_SCRIPT_LIB_WIDTH Width, - IN UINT16 Segment, - IN UINT64 Address, - IN UINTN Count, - IN VOID *Buffer + IN S3_BOOT_SCRIPT_LIB_WIDTH Width, + IN UINT16 Segment, + IN UINT64 Address, + IN UINTN Count, + IN VOID *Buffer ) { return RETURN_SUCCESS; } + /** Adds a record for a PCI configuration space modify operation into a specified boot script table. @@ -185,15 +188,16 @@ S3BootScriptSavePciCfg2Write ( RETURN_STATUS EFIAPI S3BootScriptSavePciCfg2ReadWrite ( - IN S3_BOOT_SCRIPT_LIB_WIDTH Width, - IN UINT16 Segment, - IN UINT64 Address, - IN VOID *Data, - IN VOID *DataMask + IN S3_BOOT_SCRIPT_LIB_WIDTH Width, + IN UINT16 Segment, + IN UINT64 Address, + IN VOID *Data, + IN VOID *DataMask ) { return RETURN_SUCCESS; } + /** Adds a record for an SMBus command execution into a specified boot script table. @@ -209,14 +213,15 @@ S3BootScriptSavePciCfg2ReadWrite ( RETURN_STATUS EFIAPI S3BootScriptSaveSmbusExecute ( - IN UINTN SmBusAddress, - IN EFI_SMBUS_OPERATION Operation, - IN UINTN *Length, - IN VOID *Buffer + IN UINTN SmBusAddress, + IN EFI_SMBUS_OPERATION Operation, + IN UINTN *Length, + IN VOID *Buffer ) { return RETURN_SUCCESS; } + /** Adds a record for an execution stall on the processor into a specified boot script table. @@ -228,11 +233,12 @@ S3BootScriptSaveSmbusExecute ( RETURN_STATUS EFIAPI S3BootScriptSaveStall ( - IN UINTN Duration + IN UINTN Duration ) { return RETURN_SUCCESS; } + /** Adds a record for dispatching specified arbitrary code into a specified boot script table. @@ -244,11 +250,12 @@ S3BootScriptSaveStall ( RETURN_STATUS EFIAPI S3BootScriptSaveDispatch ( - IN VOID *EntryPoint + IN VOID *EntryPoint ) { return RETURN_SUCCESS; } + /** Adds a record for dispatching specified arbitrary code into a specified boot script table. @@ -261,8 +268,8 @@ S3BootScriptSaveDispatch ( RETURN_STATUS EFIAPI S3BootScriptSaveDispatch2 ( - IN VOID *EntryPoint, - IN VOID *Context + IN VOID *EntryPoint, + IN VOID *Context ) { return RETURN_SUCCESS; @@ -291,12 +298,12 @@ S3BootScriptSaveDispatch2 ( RETURN_STATUS EFIAPI S3BootScriptSaveMemPoll ( - IN S3_BOOT_SCRIPT_LIB_WIDTH Width, - IN UINT64 Address, - IN VOID *BitMask, - IN VOID *BitValue, - IN UINTN Duration, - IN UINT64 LoopTimes + IN S3_BOOT_SCRIPT_LIB_WIDTH Width, + IN UINT64 Address, + IN VOID *BitMask, + IN VOID *BitValue, + IN UINTN Duration, + IN UINT64 LoopTimes ) { return RETURN_SUCCESS; @@ -317,12 +324,13 @@ S3BootScriptSaveMemPoll ( RETURN_STATUS EFIAPI S3BootScriptSaveInformation ( - IN UINT32 InformationLength, - IN VOID *Information + IN UINT32 InformationLength, + IN VOID *Information ) { return RETURN_SUCCESS; } + /** Adds a record for I/O reads the I/O location and continues when the exit criteria is satisfied or after a defined duration. @@ -342,11 +350,11 @@ S3BootScriptSaveInformation ( RETURN_STATUS EFIAPI S3BootScriptSaveIoPoll ( - IN S3_BOOT_SCRIPT_LIB_WIDTH Width, - IN UINT64 Address, + IN S3_BOOT_SCRIPT_LIB_WIDTH Width, + IN UINT64 Address, IN VOID *Data, IN VOID *DataMask, - IN UINT64 Delay + IN UINT64 Delay ) { return RETURN_SUCCESS; @@ -371,15 +379,16 @@ S3BootScriptSaveIoPoll ( RETURN_STATUS EFIAPI S3BootScriptSavePciPoll ( - IN S3_BOOT_SCRIPT_LIB_WIDTH Width, - IN UINT64 Address, - IN VOID *Data, - IN VOID *DataMask, - IN UINT64 Delay - ) + IN S3_BOOT_SCRIPT_LIB_WIDTH Width, + IN UINT64 Address, + IN VOID *Data, + IN VOID *DataMask, + IN UINT64 Delay + ) { return RETURN_SUCCESS; } + /** Adds a record for PCI configuration space reads and continues when the exit criteria is satisfied or after a defined duration. @@ -403,16 +412,17 @@ S3BootScriptSavePciPoll ( RETURN_STATUS EFIAPI S3BootScriptSavePci2Poll ( - IN S3_BOOT_SCRIPT_LIB_WIDTH Width, - IN UINT16 Segment, - IN UINT64 Address, - IN VOID *Data, - IN VOID *DataMask, - IN UINT64 Delay + IN S3_BOOT_SCRIPT_LIB_WIDTH Width, + IN UINT16 Segment, + IN UINT64 Address, + IN VOID *Data, + IN VOID *DataMask, + IN UINT64 Delay ) { return RETURN_SUCCESS; } + /** Save ASCII string information specified by Buffer to boot script with opcode EFI_BOOT_SCRIPT_INFORMATION_OPCODE @@ -426,11 +436,12 @@ S3BootScriptSavePci2Poll ( RETURN_STATUS EFIAPI S3BootScriptSaveInformationAsciiString ( - IN CONST CHAR8 *String + IN CONST CHAR8 *String ) { return RETURN_SUCCESS; } + /** This is an function to close the S3 boot script table. The function could only be called in BOOT time phase. To comply with the Framework spec definition on @@ -456,7 +467,7 @@ S3BootScriptSaveInformationAsciiString ( @return the base address of the new copy of the boot script table. **/ -UINT8* +UINT8 * EFIAPI S3BootScriptCloseTable ( VOID @@ -464,6 +475,7 @@ S3BootScriptCloseTable ( { return 0; } + /** Executes the S3 boot script table. @@ -473,11 +485,12 @@ S3BootScriptCloseTable ( RETURN_STATUS EFIAPI S3BootScriptExecute ( - VOID + VOID ) { return RETURN_SUCCESS; } + /** Move the last boot script entry to the position @@ -496,12 +509,13 @@ S3BootScriptExecute ( RETURN_STATUS EFIAPI S3BootScriptMoveLastOpcode ( - IN BOOLEAN BeforeOrAfter, - IN OUT VOID **Position OPTIONAL -) + IN BOOLEAN BeforeOrAfter, + IN OUT VOID **Position OPTIONAL + ) { return RETURN_SUCCESS; } + /** Find a label within the boot script table and, if not present, optionally create it. @@ -527,14 +541,15 @@ S3BootScriptMoveLastOpcode ( RETURN_STATUS EFIAPI S3BootScriptLabel ( - IN BOOLEAN BeforeOrAfter, - IN BOOLEAN CreateIfNotFound, - IN OUT VOID **Position OPTIONAL, - IN CONST CHAR8 *Label + IN BOOLEAN BeforeOrAfter, + IN BOOLEAN CreateIfNotFound, + IN OUT VOID **Position OPTIONAL, + IN CONST CHAR8 *Label ) { return RETURN_SUCCESS; } + /** Compare two positions in the boot script table and return their relative position. @param Position1 The positions in the boot script table to compare @@ -552,9 +567,9 @@ S3BootScriptLabel ( RETURN_STATUS EFIAPI S3BootScriptCompare ( - IN UINT8 *Position1, - IN UINT8 *Position2, - OUT UINTN *RelativePosition + IN UINT8 *Position1, + IN UINT8 *Position2, + OUT UINTN *RelativePosition ) { return RETURN_SUCCESS;