[mirror_edk2.git] / MdeModulePkg / Library / PiDxeS3BootScriptLib / BootScriptExecute.c

/** @file\r
  Interpret and execute the S3 data in S3 boot script.\r
\r
  Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
#include "InternalBootScriptLib.h"\r
\r
/**\r
  Executes an SMBus operation to an SMBus controller. Returns when either the command has been\r
  executed or an error is encountered in doing the operation.\r
\r
  The SmbusExecute() function provides a standard way to execute an operation as defined in the System\r
  Management Bus (SMBus) Specification. The resulting transaction will be either that the SMBus\r
  slave devices accept this transaction or that this function returns with error.\r
\r
  @param  SmbusAddress            Address that encodes the SMBUS Slave Address, SMBUS Command, SMBUS Data Length,\r
                                  and PEC.\r
  @param  Operation               Signifies which particular SMBus hardware protocol instance that\r
                                  it will use to execute the SMBus transactions. This SMBus\r
                                  hardware protocol is defined by the SMBus Specification and is\r
                                  not related to EFI.\r
  @param  Length                  Signifies the number of bytes that this operation will do. The\r
                                  maximum number of bytes can be revision specific and operation\r
                                  specific. This field will contain the actual number of bytes that\r
                                  are executed for this operation. Not all operations require this\r
                                  argument.\r
  @param  Buffer                  Contains the value of data to execute to the SMBus slave device.\r
                                  Not all operations require this argument. The length of this\r
                                  buffer is identified by Length.\r
\r
  @retval EFI_SUCCESS             The last data that was returned from the access matched the poll\r
                                  exit criteria.\r
  @retval EFI_CRC_ERROR           Checksum is not correct (PEC is incorrect).\r
  @retval EFI_TIMEOUT             Timeout expired before the operation was completed. Timeout is\r
                                  determined by the SMBus host controller device.\r
  @retval EFI_OUT_OF_RESOURCES    The request could not be completed due to a lack of resources.\r
  @retval EFI_DEVICE_ERROR        The request was not completed because a failure that was\r
                                  reflected in the Host Status Register bit. Device errors are a\r
                                  result of a transaction collision, illegal command field,\r
                                  unclaimed cycle (host initiated), or bus errors (collisions).\r
  @retval EFI_INVALID_PARAMETER   Operation is not defined in EFI_SMBUS_OPERATION.\r
  @retval EFI_INVALID_PARAMETER   Length/Buffer is NULL for operations except for EfiSmbusQuickRead\r
                                  and EfiSmbusQuickWrite. Length is outside the range of valid\r
                                  values.\r
  @retval EFI_UNSUPPORTED         The SMBus operation or PEC is not supported.\r
  @retval EFI_BUFFER_TOO_SMALL    Buffer is not sufficient for this operation.\r
\r
**/\r
EFI_STATUS\r
InternalSmbusExecute (\r
  IN     UINTN                SmbusAddress,\r
  IN     EFI_SMBUS_OPERATION  Operation,\r
  IN OUT UINTN                *Length,\r
  IN OUT VOID                 *Buffer\r
  )\r
{\r
  EFI_STATUS  Status;\r
  UINT8       WorkBuffer[MAX_SMBUS_BLOCK_LEN];\r
\r
  switch (Operation) {\r
    case EfiSmbusQuickRead:\r
      DEBUG ((DEBUG_INFO, "EfiSmbusQuickRead - 0x%08x\n", SmbusAddress));\r
      SmBusQuickRead (SmbusAddress, &Status);\r
      break;\r
    case EfiSmbusQuickWrite:\r
      DEBUG ((DEBUG_INFO, "EfiSmbusQuickWrite - 0x%08x\n", SmbusAddress));\r
      SmBusQuickWrite (SmbusAddress, &Status);\r
      break;\r
    case EfiSmbusReceiveByte:\r
      DEBUG ((DEBUG_INFO, "EfiSmbusReceiveByte - 0x%08x\n", SmbusAddress));\r
      SmBusReceiveByte (SmbusAddress, &Status);\r
      break;\r
    case EfiSmbusSendByte:\r
      DEBUG ((DEBUG_INFO, "EfiSmbusSendByte - 0x%08x (0x%02x)\n", SmbusAddress, (UINTN)*(UINT8 *)Buffer));\r
      SmBusSendByte (SmbusAddress, *(UINT8 *)Buffer, &Status);\r
      break;\r
    case EfiSmbusReadByte:\r
      DEBUG ((DEBUG_INFO, "EfiSmbusReadByte - 0x%08x\n", SmbusAddress));\r
      SmBusReadDataByte (SmbusAddress, &Status);\r
      break;\r
    case EfiSmbusWriteByte:\r
      DEBUG ((DEBUG_INFO, "EfiSmbusWriteByte - 0x%08x (0x%02x)\n", SmbusAddress, (UINTN)*(UINT8 *)Buffer));\r
      SmBusWriteDataByte (SmbusAddress, *(UINT8 *)Buffer, &Status);\r
      break;\r
    case EfiSmbusReadWord:\r
      DEBUG ((DEBUG_INFO, "EfiSmbusReadWord - 0x%08x\n", SmbusAddress));\r
      SmBusReadDataWord (SmbusAddress, &Status);\r
      break;\r
    case EfiSmbusWriteWord:\r
      DEBUG ((DEBUG_INFO, "EfiSmbusWriteWord - 0x%08x (0x%04x)\n", SmbusAddress, (UINTN)*(UINT16 *)Buffer));\r
      SmBusWriteDataWord (SmbusAddress, *(UINT16 *)Buffer, &Status);\r
      break;\r
    case EfiSmbusProcessCall:\r
      DEBUG ((DEBUG_INFO, "EfiSmbusProcessCall - 0x%08x (0x%04x)\n", SmbusAddress, (UINTN)*(UINT16 *)Buffer));\r
      SmBusProcessCall (SmbusAddress, *(UINT16 *)Buffer, &Status);\r
      break;\r
    case EfiSmbusReadBlock:\r
      DEBUG ((DEBUG_INFO, "EfiSmbusReadBlock - 0x%08x\n", SmbusAddress));\r
      SmBusReadBlock (SmbusAddress, WorkBuffer, &Status);\r
      break;\r
    case EfiSmbusWriteBlock:\r
      DEBUG ((DEBUG_INFO, "EfiSmbusWriteBlock - 0x%08x\n", SmbusAddress));\r
      SmBusWriteBlock ((SmbusAddress + SMBUS_LIB_ADDRESS (0, 0, (*Length), FALSE)), Buffer, &Status);\r
      break;\r
    case EfiSmbusBWBRProcessCall:\r
      DEBUG ((DEBUG_INFO, "EfiSmbusBWBRProcessCall - 0x%08x\n", SmbusAddress));\r
      SmBusBlockProcessCall ((SmbusAddress + SMBUS_LIB_ADDRESS (0, 0, (*Length), FALSE)), Buffer, WorkBuffer, &Status);\r
      break;\r
    default:\r
      return EFI_INVALID_PARAMETER;\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Translates boot script width and address stride to MDE library interface.\r
\r
\r
  @param Width          Width of the operation.\r
  @param Address        Address of the operation.\r
  @param AddressStride  Instride for stepping input buffer.\r
  @param BufferStride   Outstride for stepping output buffer.\r
\r
  @retval EFI_SUCCESS  Successful translation.\r
  @retval EFI_INVALID_PARAMETER Width or Address is invalid.\r
**/\r
EFI_STATUS\r
BuildLoopData (\r
  IN  S3_BOOT_SCRIPT_LIB_WIDTH  Width,\r
  IN  UINT64                    Address,\r
  OUT UINTN                     *AddressStride,\r
  OUT UINTN                     *BufferStride\r
  )\r
{\r
  UINTN  AlignMask;\r
\r
  if (Width >= S3BootScriptWidthMaximum) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  *AddressStride = (UINT32)(1 << (Width & 0x03));\r
  *BufferStride  = *AddressStride;\r
\r
  AlignMask = *AddressStride - 1;\r
  if ((Address & AlignMask) != 0) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if ((Width >= S3BootScriptWidthFifoUint8) && (Width <= S3BootScriptWidthFifoUint64)) {\r
    *AddressStride = 0;\r
  }\r
\r
  if ((Width >= S3BootScriptWidthFillUint8) && (Width <= S3BootScriptWidthFillUint64)) {\r
    *BufferStride = 0;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Perform IO read operation\r
\r
  @param[in]  Width   Width of the operation.\r
  @param[in]  Address Address of the operation.\r
  @param[in]  Count   Count of the number of accesses to perform.\r
  @param[out] Buffer  Pointer to the buffer to read from I/O space.\r
\r
  @retval EFI_SUCCESS The data was written to the EFI System.\r
  @retval EFI_INVALID_PARAMETER Width is invalid for this EFI System.\r
                                Buffer is NULL.\r
                                The Buffer is not aligned for the given Width.\r
                                Address is outside the legal range of I/O ports.\r
\r
**/\r
EFI_STATUS\r
ScriptIoRead (\r
  IN      S3_BOOT_SCRIPT_LIB_WIDTH  Width,\r
  IN      UINT64                    Address,\r
  IN      UINTN                     Count,\r
  OUT     VOID                      *Buffer\r
  )\r
{\r
  EFI_STATUS  Status;\r
  UINTN       AddressStride;\r
  UINTN       BufferStride;\r
  PTR         Out;\r
\r
  Out.Buf = (UINT8 *)Buffer;\r
\r
  if (Address > MAX_IO_ADDRESS) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Status = BuildLoopData (Width, Address, &AddressStride, &BufferStride);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Loop for each iteration and move the data\r
  //\r
  for ( ; Count > 0; Count--, Address += AddressStride, Out.Buf += BufferStride) {\r
    switch (Width) {\r
      case S3BootScriptWidthUint8:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthUint8 - 0x%08x\n", (UINTN)Address));\r
        *Out.Uint8 = IoRead8 ((UINTN)Address);\r
        break;\r
      case S3BootScriptWidthFifoUint8:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthFifoUint8 - 0x%08x\n", (UINTN)Address));\r
        *Out.Uint8 = IoRead8 ((UINTN)Address);\r
        break;\r
      case S3BootScriptWidthFillUint8:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthFillUint8 - 0x%08x\n", (UINTN)Address));\r
        *Out.Uint8 = IoRead8 ((UINTN)Address);\r
        break;\r
\r
      case S3BootScriptWidthUint16:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthUint16 - 0x%08x\n", (UINTN)Address));\r
        *Out.Uint16 = IoRead16 ((UINTN)Address);\r
        break;\r
      case S3BootScriptWidthFifoUint16:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthFifoUint16 - 0x%08x\n", (UINTN)Address));\r
        *Out.Uint16 = IoRead16 ((UINTN)Address);\r
        break;\r
      case S3BootScriptWidthFillUint16:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthFillUint16 - 0x%08x\n", (UINTN)Address));\r
        *Out.Uint16 = IoRead16 ((UINTN)Address);\r
        break;\r
\r
      case S3BootScriptWidthUint32:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthUint32 - 0x%08x\n", (UINTN)Address));\r
        *Out.Uint32 = IoRead32 ((UINTN)Address);\r
        break;\r
      case S3BootScriptWidthFifoUint32:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthFifoUint32 - 0x%08x\n", (UINTN)Address));\r
        *Out.Uint32 = IoRead32 ((UINTN)Address);\r
        break;\r
      case S3BootScriptWidthFillUint32:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthFillUint32 - 0x%08x\n", (UINTN)Address));\r
        *Out.Uint32 = IoRead32 ((UINTN)Address);\r
        break;\r
\r
      case S3BootScriptWidthUint64:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthUint64 - 0x%08x\n", (UINTN)Address));\r
        *Out.Uint64 = IoRead64 ((UINTN)Address);\r
        break;\r
      case S3BootScriptWidthFifoUint64:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthFifoUint64 - 0x%08x\n", (UINTN)Address));\r
        *Out.Uint64 = IoRead64 ((UINTN)Address);\r
        break;\r
      case S3BootScriptWidthFillUint64:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthFillUint64 - 0x%08x\n", (UINTN)Address));\r
        *Out.Uint64 = IoRead64 ((UINTN)Address);\r
        break;\r
\r
      default:\r
        return EFI_INVALID_PARAMETER;\r
    }\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Perform IO write operation\r
\r
  @param[in]  Width Width of the operation.\r
  @param[in]  Address Address of the operation.\r
  @param[in]  Count Count of the number of accesses to perform.\r
  @param[in]  Buffer Pointer to the buffer to write to I/O space.\r
\r
  @retval EFI_SUCCESS The data was written to the EFI System.\r
  @retval EFI_INVALID_PARAMETER Width is invalid for this EFI System.\r
                                Buffer is NULL.\r
                                The Buffer is not aligned for the given Width.\r
                                Address is outside the legal range of I/O ports.\r
\r
**/\r
EFI_STATUS\r
ScriptIoWrite (\r
  IN      S3_BOOT_SCRIPT_LIB_WIDTH  Width,\r
  IN      UINT64                    Address,\r
  IN      UINTN                     Count,\r
  IN      VOID                      *Buffer\r
  )\r
{\r
  EFI_STATUS  Status;\r
  UINTN       AddressStride;\r
  UINTN       BufferStride;\r
  UINT64      OriginalAddress;\r
  PTR         In;\r
  PTR         OriginalIn;\r
\r
  In.Buf = (UINT8 *)Buffer;\r
\r
  if (Address > MAX_IO_ADDRESS) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Status = BuildLoopData (Width, Address, &AddressStride, &BufferStride);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Loop for each iteration and move the data\r
  //\r
  OriginalAddress = Address;\r
  OriginalIn.Buf  = In.Buf;\r
  for ( ; Count > 0; Count--, Address += AddressStride, In.Buf += BufferStride) {\r
    switch (Width) {\r
      case S3BootScriptWidthUint8:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthUint8 - 0x%08x (0x%02x)\n", (UINTN)Address, (UINTN)*In.Uint8));\r
        IoWrite8 ((UINTN)Address, *In.Uint8);\r
        break;\r
      case S3BootScriptWidthFifoUint8:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthFifoUint8 - 0x%08x (0x%02x)\n", (UINTN)OriginalAddress, (UINTN)*In.Uint8));\r
        IoWrite8 ((UINTN)OriginalAddress, *In.Uint8);\r
        break;\r
      case S3BootScriptWidthFillUint8:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthFillUint8 - 0x%08x (0x%02x)\n", (UINTN)Address, (UINTN)*OriginalIn.Uint8));\r
        IoWrite8 ((UINTN)Address, *OriginalIn.Uint8);\r
        break;\r
      case S3BootScriptWidthUint16:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthUint16 - 0x%08x (0x%04x)\n", (UINTN)Address, (UINTN)*In.Uint16));\r
        IoWrite16 ((UINTN)Address, *In.Uint16);\r
        break;\r
      case S3BootScriptWidthFifoUint16:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthFifoUint16 - 0x%08x (0x%04x)\n", (UINTN)OriginalAddress, (UINTN)*In.Uint16));\r
        IoWrite16 ((UINTN)OriginalAddress, *In.Uint16);\r
        break;\r
      case S3BootScriptWidthFillUint16:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthFillUint16 - 0x%08x (0x%04x)\n", (UINTN)Address, (UINTN)*OriginalIn.Uint16));\r
        IoWrite16 ((UINTN)Address, *OriginalIn.Uint16);\r
        break;\r
      case S3BootScriptWidthUint32:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthUint32 - 0x%08x (0x%08x)\n", (UINTN)Address, (UINTN)*In.Uint32));\r
        IoWrite32 ((UINTN)Address, *In.Uint32);\r
        break;\r
      case S3BootScriptWidthFifoUint32:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthFifoUint32 - 0x%08x (0x%08x)\n", (UINTN)OriginalAddress, (UINTN)*In.Uint32));\r
        IoWrite32 ((UINTN)OriginalAddress, *In.Uint32);\r
        break;\r
      case S3BootScriptWidthFillUint32:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthFillUint32 - 0x%08x (0x%08x)\n", (UINTN)Address, (UINTN)*OriginalIn.Uint32));\r
        IoWrite32 ((UINTN)Address, *OriginalIn.Uint32);\r
        break;\r
      case S3BootScriptWidthUint64:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthUint64 - 0x%08x (0x%016lx)\n", (UINTN)Address, *In.Uint64));\r
        IoWrite64 ((UINTN)Address, *In.Uint64);\r
        break;\r
      case S3BootScriptWidthFifoUint64:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthFifoUint64 - 0x%08x (0x%016lx)\n", (UINTN)OriginalAddress, *In.Uint64));\r
        IoWrite64 ((UINTN)OriginalAddress, *In.Uint64);\r
        break;\r
      case S3BootScriptWidthFillUint64:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthFillUint64 - 0x%08x (0x%016lx)\n", (UINTN)Address, *OriginalIn.Uint64));\r
        IoWrite64 ((UINTN)Address, *OriginalIn.Uint64);\r
        break;\r
      default:\r
        return EFI_INVALID_PARAMETER;\r
    }\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Interpret the boot script node with EFI_BOOT_SCRIPT_IO_WRITE OP code.\r
\r
  @param Script       Pointer to the node which is to be interpreted.\r
\r
  @retval EFI_SUCCESS The data was written to the EFI System.\r
  @retval EFI_INVALID_PARAMETER Width is invalid for this EFI System.\r
                                Buffer is NULL.\r
                                The Buffer is not aligned for the given Width.\r
                                Address is outside the legal range of I/O ports.\r
\r
**/\r
EFI_STATUS\r
BootScriptExecuteIoWrite (\r
  IN UINT8  *Script\r
  )\r
{\r
  S3_BOOT_SCRIPT_LIB_WIDTH  Width;\r
  UINT64                    Address;\r
  UINTN                     Count;\r
  VOID                      *Buffer;\r
  EFI_BOOT_SCRIPT_IO_WRITE  IoWrite;\r
\r
  CopyMem ((VOID *)&IoWrite, (VOID *)Script, sizeof (EFI_BOOT_SCRIPT_IO_WRITE));\r
  Width   = (S3_BOOT_SCRIPT_LIB_WIDTH)IoWrite.Width;\r
  Address = IoWrite.Address;\r
  Count   = IoWrite.Count;\r
  Buffer  = Script + sizeof (EFI_BOOT_SCRIPT_IO_WRITE);\r
\r
  DEBUG ((DEBUG_INFO, "BootScriptExecuteIoWrite - 0x%08x, 0x%08x, 0x%08x\n", (UINTN)Address, Count, (UINTN)Width));\r
  return ScriptIoWrite (Width, Address, Count, Buffer);\r
}\r
\r
/**\r
  Perform memory read operation\r
\r
  @param  Width Width of the operation.\r
  @param  Address Address of the operation.\r
  @param  Count Count of the number of accesses to perform.\r
  @param  Buffer Pointer to the buffer read from memory.\r
\r
  @retval EFI_SUCCESS The data was written to the EFI System.\r
  @retval EFI_INVALID_PARAMETER Width is invalid for this EFI System.\r
                                Buffer is NULL.\r
                                The Buffer is not aligned for the given Width.\r
  @retval EFI_UNSUPPORTED The address range specified by Address, Width, and Count\r
                          is not valid for this EFI System.\r
\r
**/\r
EFI_STATUS\r
ScriptMemoryRead (\r
  IN       S3_BOOT_SCRIPT_LIB_WIDTH  Width,\r
  IN       UINT64                    Address,\r
  IN       UINTN                     Count,\r
  IN OUT   VOID                      *Buffer\r
  )\r
{\r
  EFI_STATUS  Status;\r
  UINTN       AddressStride;\r
  UINTN       BufferStride;\r
  PTR         Out;\r
\r
  Out.Buf = Buffer;\r
\r
  Status = BuildLoopData (Width, Address, &AddressStride, &BufferStride);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Loop for each iteration and move the data\r
  //\r
  for ( ; Count > 0; Count--, Address += AddressStride, Out.Buf += BufferStride) {\r
    switch (Width) {\r
      case S3BootScriptWidthUint8:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthUint8 - 0x%08x\n", (UINTN)Address));\r
        *Out.Uint8 = MmioRead8 ((UINTN)Address);\r
        break;\r
      case S3BootScriptWidthFifoUint8:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthFifoUint8 - 0x%08x\n", (UINTN)Address));\r
        *Out.Uint8 = MmioRead8 ((UINTN)Address);\r
        break;\r
      case S3BootScriptWidthFillUint8:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthFillUint8 - 0x%08x\n", (UINTN)Address));\r
        *Out.Uint8 = MmioRead8 ((UINTN)Address);\r
        break;\r
\r
      case S3BootScriptWidthUint16:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthUint16 - 0x%08x\n", (UINTN)Address));\r
        *Out.Uint16 = MmioRead16 ((UINTN)Address);\r
        break;\r
      case S3BootScriptWidthFifoUint16:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthFifoUint16 - 0x%08x\n", (UINTN)Address));\r
        *Out.Uint16 = MmioRead16 ((UINTN)Address);\r
        break;\r
      case S3BootScriptWidthFillUint16:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthFillUint16 - 0x%08x\n", (UINTN)Address));\r
        *Out.Uint16 = MmioRead16 ((UINTN)Address);\r
        break;\r
\r
      case S3BootScriptWidthUint32:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthUint32 - 0x%08x\n", (UINTN)Address));\r
        *Out.Uint32 = MmioRead32 ((UINTN)Address);\r
        break;\r
      case S3BootScriptWidthFifoUint32:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthFifoUint32 - 0x%08x\n", (UINTN)Address));\r
        *Out.Uint32 = MmioRead32 ((UINTN)Address);\r
        break;\r
      case S3BootScriptWidthFillUint32:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthFillUint32 - 0x%08x\n", (UINTN)Address));\r
        *Out.Uint32 = MmioRead32 ((UINTN)Address);\r
        break;\r
\r
      case S3BootScriptWidthUint64:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthUint64 - 0x%08x\n", (UINTN)Address));\r
        *Out.Uint64 = MmioRead64 ((UINTN)Address);\r
        break;\r
      case S3BootScriptWidthFifoUint64:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthFifoUint64 - 0x%08x\n", (UINTN)Address));\r
        *Out.Uint64 = MmioRead64 ((UINTN)Address);\r
        break;\r
      case S3BootScriptWidthFillUint64:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthFillUint64 - 0x%08x\n", (UINTN)Address));\r
        *Out.Uint64 = MmioRead64 ((UINTN)Address);\r
        break;\r
\r
      default:\r
        return EFI_UNSUPPORTED;\r
    }\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Perform memory write operation\r
\r
  @param   Width   Width of the operation.\r
  @param   Address Address of the operation.\r
  @param   Count   Count of the number of accesses to perform.\r
  @param   Buffer  Pointer to the buffer write to memory.\r
\r
  @retval EFI_SUCCESS The data was written to the EFI System.\r
  @retval EFI_INVALID_PARAMETER Width is invalid for this EFI System.\r
                                Buffer is NULL.\r
                                The Buffer is not aligned for the given Width.\r
  @retval EFI_UNSUPPORTED The address range specified by Address, Width, and Count\r
                          is not valid for this EFI System.\r
\r
**/\r
EFI_STATUS\r
ScriptMemoryWrite (\r
  IN      S3_BOOT_SCRIPT_LIB_WIDTH  Width,\r
  IN      UINT64                    Address,\r
  IN      UINTN                     Count,\r
  IN OUT  VOID                      *Buffer\r
  )\r
{\r
  EFI_STATUS  Status;\r
  UINTN       AddressStride;\r
  UINT64      OriginalAddress;\r
  UINTN       BufferStride;\r
  PTR         In;\r
  PTR         OriginalIn;\r
\r
  In.Buf = Buffer;\r
\r
  Status = BuildLoopData (Width, Address, &AddressStride, &BufferStride);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Loop for each iteration and move the data\r
  //\r
  OriginalAddress = Address;\r
  OriginalIn.Buf  = In.Buf;\r
  for ( ; Count > 0; Count--, Address += AddressStride, In.Buf += BufferStride) {\r
    switch (Width) {\r
      case S3BootScriptWidthUint8:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthUint8 - 0x%08x (0x%02x)\n", (UINTN)Address, (UINTN)*In.Uint8));\r
        MmioWrite8 ((UINTN)Address, *In.Uint8);\r
        break;\r
      case S3BootScriptWidthFifoUint8:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthFifoUint8 - 0x%08x (0x%02x)\n", (UINTN)OriginalAddress, (UINTN)*In.Uint8));\r
        MmioWrite8 ((UINTN)OriginalAddress, *In.Uint8);\r
        break;\r
      case S3BootScriptWidthFillUint8:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthFillUint8 - 0x%08x (0x%02x)\n", (UINTN)Address, (UINTN)*OriginalIn.Uint8));\r
        MmioWrite8 ((UINTN)Address, *OriginalIn.Uint8);\r
        break;\r
      case S3BootScriptWidthUint16:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthUint16 - 0x%08x (0x%04x)\n", (UINTN)Address, (UINTN)*In.Uint16));\r
        MmioWrite16 ((UINTN)Address, *In.Uint16);\r
        break;\r
      case S3BootScriptWidthFifoUint16:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthFifoUint16 - 0x%08x (0x%04x)\n", (UINTN)OriginalAddress, (UINTN)*In.Uint16));\r
        MmioWrite16 ((UINTN)OriginalAddress, *In.Uint16);\r
        break;\r
      case S3BootScriptWidthFillUint16:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthFillUint16 - 0x%08x (0x%04x)\n", (UINTN)Address, (UINTN)*OriginalIn.Uint16));\r
        MmioWrite16 ((UINTN)Address, *OriginalIn.Uint16);\r
        break;\r
      case S3BootScriptWidthUint32:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthUint32 - 0x%08x (0x%08x)\n", (UINTN)Address, (UINTN)*In.Uint32));\r
        MmioWrite32 ((UINTN)Address, *In.Uint32);\r
        break;\r
      case S3BootScriptWidthFifoUint32:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthFifoUint32 - 0x%08x (0x%08x)\n", (UINTN)OriginalAddress, (UINTN)*In.Uint32));\r
        MmioWrite32 ((UINTN)OriginalAddress, *In.Uint32);\r
        break;\r
      case S3BootScriptWidthFillUint32:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthFillUint32 - 0x%08x (0x%08x)\n", (UINTN)Address, (UINTN)*OriginalIn.Uint32));\r
        MmioWrite32 ((UINTN)Address, *OriginalIn.Uint32);\r
        break;\r
      case S3BootScriptWidthUint64:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthUint64 - 0x%08x (0x%016lx)\n", (UINTN)Address, *In.Uint64));\r
        MmioWrite64 ((UINTN)Address, *In.Uint64);\r
        break;\r
      case S3BootScriptWidthFifoUint64:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthFifoUint64 - 0x%08x (0x%016lx)\n", (UINTN)OriginalAddress, *In.Uint64));\r
        MmioWrite64 ((UINTN)OriginalAddress, *In.Uint64);\r
        break;\r
      case S3BootScriptWidthFillUint64:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthFillUint64 - 0x%08x (0x%016lx)\n", (UINTN)Address, *OriginalIn.Uint64));\r
        MmioWrite64 ((UINTN)Address, *OriginalIn.Uint64);\r
        break;\r
      default:\r
        return EFI_UNSUPPORTED;\r
    }\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Interpret the boot script node with EFI_BOOT_SCRIPT_MEM_WRITE OP code.\r
\r
  @param[in]  Script Pointer to the node which is to be interpreted.\r
\r
  @retval EFI_SUCCESS The data was written to the EFI System.\r
  @retval EFI_INVALID_PARAMETER Width is invalid for this EFI System.\r
                                Buffer is NULL.\r
                                The Buffer is not aligned for the given Width.\r
  @retval EFI_UNSUPPORTED The address range specified by Address, Width, and Count\r
                          is not valid for this EFI System.\r
\r
**/\r
EFI_STATUS\r
BootScriptExecuteMemoryWrite (\r
  IN UINT8  *Script\r
  )\r
{\r
  VOID                       *Buffer;\r
  S3_BOOT_SCRIPT_LIB_WIDTH   Width;\r
  UINT64                     Address;\r
  UINTN                      Count;\r
  EFI_BOOT_SCRIPT_MEM_WRITE  MemWrite;\r
\r
  CopyMem ((VOID *)&MemWrite, (VOID *)Script, sizeof (EFI_BOOT_SCRIPT_MEM_WRITE));\r
  Width   = (S3_BOOT_SCRIPT_LIB_WIDTH)MemWrite.Width;\r
  Address = MemWrite.Address;\r
  Count   = MemWrite.Count;\r
  Buffer  = Script + sizeof (EFI_BOOT_SCRIPT_MEM_WRITE);\r
\r
  DEBUG ((DEBUG_INFO, "BootScriptExecuteMemoryWrite - 0x%08x, 0x%08x, 0x%08x\n", (UINTN)Address, Count, (UINTN)Width));\r
  return ScriptMemoryWrite (Width, Address, Count, Buffer);\r
}\r
\r
/**\r
  Performance PCI configuration 2 read operation\r
\r
  @param  Width   Width of the operation.\r
  @param  Segment Pci segment number\r
  @param  Address Address of the operation.\r
  @param  Count   Count of the number of accesses to perform.\r
  @param  Buffer  Pointer to the buffer read from PCI config space\r
\r
  @retval EFI_SUCCESS The read succeed.\r
  @retval EFI_INVALID_PARAMETER if Width is not defined\r
  @note  A known Limitations in the implementation which is 64bits operations are not supported.\r
\r
**/\r
EFI_STATUS\r
ScriptPciCfg2Read (\r
  IN  S3_BOOT_SCRIPT_LIB_WIDTH  Width,\r
  IN  UINT16                    Segment,\r
  IN  UINT64                    Address,\r
  IN  UINTN                     Count,\r
  OUT VOID                      *Buffer\r
  )\r
{\r
  EFI_STATUS  Status;\r
  UINTN       AddressStride;\r
  UINTN       BufferStride;\r
  PTR         Out;\r
  UINT64      PciAddress;\r
\r
  Out.Buf = (UINT8 *)Buffer;\r
\r
  PciAddress = PCI_ADDRESS_ENCODE (Segment, Address);\r
\r
  Status = BuildLoopData (Width, PciAddress, &AddressStride, &BufferStride);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Loop for each iteration and move the data\r
  //\r
  for ( ; Count > 0; Count--, PciAddress += AddressStride, Out.Buf += BufferStride) {\r
    switch (Width) {\r
      case S3BootScriptWidthUint8:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthUint8 - 0x%016lx\n", PciAddress));\r
        *Out.Uint8 = PciSegmentRead8 (PciAddress);\r
        break;\r
      case S3BootScriptWidthFifoUint8:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthFifoUint8 - 0x%016lx\n", PciAddress));\r
        *Out.Uint8 = PciSegmentRead8 (PciAddress);\r
        break;\r
      case S3BootScriptWidthFillUint8:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthFillUint8 - 0x%016lx\n", PciAddress));\r
        *Out.Uint8 = PciSegmentRead8 (PciAddress);\r
        break;\r
\r
      case S3BootScriptWidthUint16:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthUint16 - 0x%016lx\n", PciAddress));\r
        *Out.Uint16 = PciSegmentRead16 (PciAddress);\r
        break;\r
      case S3BootScriptWidthFifoUint16:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthFifoUint16 - 0x%016lx\n", PciAddress));\r
        *Out.Uint16 = PciSegmentRead16 (PciAddress);\r
        break;\r
      case S3BootScriptWidthFillUint16:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthFillUint16 - 0x%016lx\n", PciAddress));\r
        *Out.Uint16 = PciSegmentRead16 (PciAddress);\r
        break;\r
\r
      case S3BootScriptWidthUint32:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthUint32 - 0x%016lx\n", PciAddress));\r
        *Out.Uint32 = PciSegmentRead32 (PciAddress);\r
        break;\r
      case S3BootScriptWidthFifoUint32:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthFifoUint32 - 0x%016lx\n", PciAddress));\r
        *Out.Uint32 = PciSegmentRead32 (PciAddress);\r
        break;\r
      case S3BootScriptWidthFillUint32:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthFillUint32 - 0x%016lx\n", PciAddress));\r
        *Out.Uint32 = PciSegmentRead32 (PciAddress);\r
        break;\r
\r
      default:\r
        return EFI_INVALID_PARAMETER;\r
    }\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Performance PCI configuration 2 write operation\r
\r
  @param  Width   Width of the operation.\r
  @param  Segment Pci segment number\r
  @param  Address Address of the operation.\r
  @param  Count   Count of the number of accesses to perform.\r
  @param  Buffer  Pointer to the buffer write to PCI config space\r
\r
  @retval EFI_SUCCESS The write succeed.\r
  @retval EFI_INVALID_PARAMETER if Width is not defined\r
  @note  A known Limitations in the implementation which is 64bits operations are not supported.\r
\r
**/\r
EFI_STATUS\r
ScriptPciCfg2Write (\r
  IN  S3_BOOT_SCRIPT_LIB_WIDTH  Width,\r
  IN  UINT16                    Segment,\r
  IN  UINT64                    Address,\r
  IN  UINTN                     Count,\r
  IN  VOID                      *Buffer\r
  )\r
{\r
  EFI_STATUS  Status;\r
  UINTN       AddressStride;\r
  UINTN       BufferStride;\r
  UINT64      OriginalPciAddress;\r
  PTR         In;\r
  PTR         OriginalIn;\r
  UINT64      PciAddress;\r
\r
  In.Buf = (UINT8 *)Buffer;\r
\r
  PciAddress = PCI_ADDRESS_ENCODE (Segment, Address);\r
\r
  Status = BuildLoopData (Width, PciAddress, &AddressStride, &BufferStride);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Loop for each iteration and move the data\r
  //\r
  OriginalPciAddress = PciAddress;\r
  OriginalIn.Buf     = In.Buf;\r
  for ( ; Count > 0; Count--, PciAddress += AddressStride, In.Buf += BufferStride) {\r
    switch (Width) {\r
      case S3BootScriptWidthUint8:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthUint8 - 0x%016lx (0x%02x)\n", PciAddress, (UINTN)*In.Uint8));\r
        PciSegmentWrite8 (PciAddress, *In.Uint8);\r
        break;\r
      case S3BootScriptWidthFifoUint8:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthFifoUint8 - 0x%016lx (0x%02x)\n", OriginalPciAddress, (UINTN)*In.Uint8));\r
        PciSegmentWrite8 (OriginalPciAddress, *In.Uint8);\r
        break;\r
      case S3BootScriptWidthFillUint8:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthFillUint8 - 0x%016lx (0x%02x)\n", PciAddress, (UINTN)*OriginalIn.Uint8));\r
        PciSegmentWrite8 (PciAddress, *OriginalIn.Uint8);\r
        break;\r
      case S3BootScriptWidthUint16:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthUint16 - 0x%016lx (0x%04x)\n", PciAddress, (UINTN)*In.Uint16));\r
        PciSegmentWrite16 (PciAddress, *In.Uint16);\r
        break;\r
      case S3BootScriptWidthFifoUint16:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthFifoUint16 - 0x%016lx (0x%04x)\n", OriginalPciAddress, (UINTN)*In.Uint16));\r
        PciSegmentWrite16 (OriginalPciAddress, *In.Uint16);\r
        break;\r
      case S3BootScriptWidthFillUint16:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthFillUint16 - 0x%016lx (0x%04x)\n", PciAddress, (UINTN)*OriginalIn.Uint16));\r
        PciSegmentWrite16 (PciAddress, *OriginalIn.Uint16);\r
        break;\r
      case S3BootScriptWidthUint32:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthUint32 - 0x%016lx (0x%08x)\n", PciAddress, (UINTN)*In.Uint32));\r
        PciSegmentWrite32 (PciAddress, *In.Uint32);\r
        break;\r
      case S3BootScriptWidthFifoUint32:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthFifoUint32 - 0x%016lx (0x%08x)\n", OriginalPciAddress, (UINTN)*In.Uint32));\r
        PciSegmentWrite32 (OriginalPciAddress, *In.Uint32);\r
        break;\r
      case S3BootScriptWidthFillUint32:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptWidthFillUint32 - 0x%016lx (0x%08x)\n", (UINTN)PciAddress, (UINTN)*OriginalIn.Uint32));\r
        PciSegmentWrite32 (PciAddress, *OriginalIn.Uint32);\r
        break;\r
      default:\r
        return EFI_INVALID_PARAMETER;\r
    }\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Performance PCI configuration read operation\r
\r
  @param     Width                      Width of the operation.\r
  @param     Address                    Address of the operation.\r
  @param     Count                      Count of the number of accesses to perform.\r
  @param     Buffer                     Pointer to the buffer to read from PCI config space.\r
\r
  @retval    EFI_SUCCESS                The data was written to the EFI System.\r
  @retval    EFI_INVALID_PARAMETER      Width is invalid for this EFI System.\r
                                        Buffer is NULL.\r
                                        The Buffer is not aligned for the given Width.\r
                                        Address is outside the legal range of I/O ports.\r
\r
**/\r
EFI_STATUS\r
ScriptPciCfgRead (\r
  IN  S3_BOOT_SCRIPT_LIB_WIDTH  Width,\r
  IN  UINT64                    Address,\r
  IN  UINTN                     Count,\r
  OUT VOID                      *Buffer\r
  )\r
{\r
  return ScriptPciCfg2Read (Width, 0, Address, Count, Buffer);\r
}\r
\r
/**\r
  Performance PCI configuration write operation\r
\r
  @param     Width                      Width of the operation.\r
  @param     Address                    Address of the operation.\r
  @param     Count                      Count of the number of accesses to perform.\r
  @param     Buffer                     Pointer to the buffer to write to PCI config space.\r
\r
  @retval    EFI_SUCCESS                The data was written to the EFI System.\r
  @retval    EFI_INVALID_PARAMETER      Width is invalid for this EFI System.\r
                                        Buffer is NULL.\r
                                        The Buffer is not aligned for the given Width.\r
                                        Address is outside the legal range of I/O ports.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
ScriptPciCfgWrite (\r
  IN  S3_BOOT_SCRIPT_LIB_WIDTH  Width,\r
  IN  UINT64                    Address,\r
  IN  UINTN                     Count,\r
  IN  VOID                      *Buffer\r
  )\r
{\r
  return ScriptPciCfg2Write (Width, 0, Address, Count, Buffer);\r
}\r
\r
/**\r
  Interpret the boot script node with EFI_BOOT_SCRIPT_PCI_CONFIG_WRITE OP code.\r
\r
  @param  Script        The pointer of typed node in boot script table\r
\r
  @retval EFI_SUCCESS  The operation was executed successfully\r
**/\r
EFI_STATUS\r
BootScriptExecutePciCfgWrite (\r
  IN UINT8  *Script\r
  )\r
{\r
  VOID                              *Buffer;\r
  S3_BOOT_SCRIPT_LIB_WIDTH          Width;\r
  UINT64                            Address;\r
  UINTN                             Count;\r
  EFI_BOOT_SCRIPT_PCI_CONFIG_WRITE  PciCfgWrite;\r
\r
  CopyMem ((VOID *)&PciCfgWrite, (VOID *)Script, sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG_WRITE));\r
\r
  Width   = (S3_BOOT_SCRIPT_LIB_WIDTH)PciCfgWrite.Width;\r
  Address = PciCfgWrite.Address;\r
  Count   = PciCfgWrite.Count;\r
  Buffer  = Script + sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG_WRITE);\r
\r
  DEBUG ((DEBUG_INFO, "BootScriptExecutePciCfgWrite - 0x%016lx, 0x%08x, 0x%08x\n", PCI_ADDRESS_ENCODE (0, Address), Count, (UINTN)Width));\r
  return ScriptPciCfgWrite (Width, Address, Count, Buffer);\r
}\r
\r
/**\r
  Interpret the boot script node with EFI_BOOT_SCRIPT_IO_READ_WRITE OP code.\r
\r
  @param Script   The pointer of typed node in boot script table\r
  @param AndMask  Mask value for 'and' operation\r
  @param OrMask   Mask value for 'or' operation\r
\r
  @retval EFI_SUCCESS    The operation was executed successfully\r
**/\r
EFI_STATUS\r
BootScriptExecuteIoReadWrite (\r
  IN  UINT8   *Script,\r
  IN  UINT64  AndMask,\r
  IN  UINT64  OrMask\r
  )\r
\r
{\r
  EFI_STATUS                     Status;\r
  UINT64                         Data;\r
  EFI_BOOT_SCRIPT_IO_READ_WRITE  IoReadWrite;\r
\r
  Data = 0;\r
\r
  CopyMem ((VOID *)&IoReadWrite, (VOID *)Script, sizeof (EFI_BOOT_SCRIPT_IO_READ_WRITE));\r
\r
  DEBUG ((DEBUG_INFO, "BootScriptExecuteIoReadWrite - 0x%08x, 0x%016lx, 0x%016lx\n", (UINTN)IoReadWrite.Address, AndMask, OrMask));\r
\r
  Status = ScriptIoRead (\r
             (S3_BOOT_SCRIPT_LIB_WIDTH)IoReadWrite.Width,\r
             IoReadWrite.Address,\r
             1,\r
             &Data\r
             );\r
  if (!EFI_ERROR (Status)) {\r
    Data   = (Data & AndMask) | OrMask;\r
    Status = ScriptIoWrite (\r
               (S3_BOOT_SCRIPT_LIB_WIDTH)IoReadWrite.Width,\r
               IoReadWrite.Address,\r
               1,\r
               &Data\r
               );\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Interpret the boot script node with EFI_BOOT_SCRIPT_MEM_READ_WRITE OP code.\r
\r
  @param Script    The pointer of typed node in boot script table\r
  @param AndMask   Mask value for 'and' operation\r
  @param OrMask    Mask value for 'or' operation\r
\r
  @retval EFI_SUCCESS The operation was executed successfully\r
**/\r
EFI_STATUS\r
BootScriptExecuteMemoryReadWrite (\r
  IN UINT8   *Script,\r
  IN UINT64  AndMask,\r
  IN UINT64  OrMask\r
  )\r
\r
{\r
  EFI_STATUS                      Status;\r
  UINT64                          Data;\r
  EFI_BOOT_SCRIPT_MEM_READ_WRITE  MemReadWrite;\r
\r
  Data = 0;\r
\r
  CopyMem ((VOID *)&MemReadWrite, (VOID *)Script, sizeof (EFI_BOOT_SCRIPT_MEM_READ_WRITE));\r
\r
  DEBUG ((DEBUG_INFO, "BootScriptExecuteMemoryReadWrite - 0x%08x, 0x%016lx, 0x%016lx\n", (UINTN)MemReadWrite.Address, AndMask, OrMask));\r
\r
  Status = ScriptMemoryRead (\r
             (S3_BOOT_SCRIPT_LIB_WIDTH)MemReadWrite.Width,\r
             MemReadWrite.Address,\r
             1,\r
             &Data\r
             );\r
  if (!EFI_ERROR (Status)) {\r
    Data   = (Data & AndMask) | OrMask;\r
    Status = ScriptMemoryWrite (\r
               (S3_BOOT_SCRIPT_LIB_WIDTH)MemReadWrite.Width,\r
               MemReadWrite.Address,\r
               1,\r
               &Data\r
               );\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Interpret the boot script node with EFI_BOOT_SCRIPT_PCI_CFG_READ_WRITE OP code.\r
\r
  @param Script   The pointer of typed node in boot script table\r
  @param AndMask  Mask value for 'and' operation\r
  @param OrMask   Mask value for 'or' operation\r
\r
  @retval EFI_SUCCESS   The operation was executed successfully\r
**/\r
EFI_STATUS\r
BootScriptExecutePciCfgReadWrite (\r
  IN UINT8   *Script,\r
  IN UINT64  AndMask,\r
  IN UINT64  OrMask\r
  )\r
\r
{\r
  EFI_STATUS                             Status;\r
  UINT64                                 Data;\r
  EFI_BOOT_SCRIPT_PCI_CONFIG_READ_WRITE  PciCfgReadWrite;\r
\r
  Data = 0;\r
\r
  CopyMem ((VOID *)&PciCfgReadWrite, (VOID *)Script, sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG_READ_WRITE));\r
\r
  DEBUG ((DEBUG_INFO, "BootScriptExecutePciCfgReadWrite - 0x%016lx, 0x%016lx, 0x%016lx\n", PCI_ADDRESS_ENCODE (0, PciCfgReadWrite.Address), AndMask, OrMask));\r
\r
  Status = ScriptPciCfgRead (\r
             (S3_BOOT_SCRIPT_LIB_WIDTH)PciCfgReadWrite.Width,\r
             PciCfgReadWrite.Address,\r
             1,\r
             &Data\r
             );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  Data = (Data & AndMask) | OrMask;\r
\r
  Status = ScriptPciCfgWrite (\r
             (S3_BOOT_SCRIPT_LIB_WIDTH)PciCfgReadWrite.Width,\r
             PciCfgReadWrite.Address,\r
             1,\r
             &Data\r
             );\r
\r
  return Status;\r
}\r
\r
/**\r
  Interpret the boot script node with EFI_BOOT_SCRIPT_SMBUS_EXECUTE OP code.\r
\r
  @param Script  The pointer of typed node in boot script table\r
\r
  @retval EFI_SUCCESS      The operation was executed successfully\r
  @retval EFI_UNSUPPORTED  Cannot locate smbus ppi or occur error of script execution\r
  @retval Others           Result of script execution\r
**/\r
EFI_STATUS\r
BootScriptExecuteSmbusExecute (\r
  IN UINT8  *Script\r
  )\r
{\r
  UINTN                          SmBusAddress;\r
  UINTN                          DataSize;\r
  EFI_BOOT_SCRIPT_SMBUS_EXECUTE  SmbusExecuteEntry;\r
\r
  CopyMem ((VOID *)&SmbusExecuteEntry, (VOID *)Script, sizeof (EFI_BOOT_SCRIPT_SMBUS_EXECUTE));\r
\r
  DEBUG ((DEBUG_INFO, "BootScriptExecuteSmbusExecute - 0x%08x, 0x%08x\n", (UINTN)SmbusExecuteEntry.SmBusAddress, (UINTN)SmbusExecuteEntry.Operation));\r
\r
  SmBusAddress = (UINTN)SmbusExecuteEntry.SmBusAddress;\r
  DataSize     = (UINTN)SmbusExecuteEntry.DataSize;\r
  return InternalSmbusExecute (\r
           SmBusAddress,\r
           (EFI_SMBUS_OPERATION)SmbusExecuteEntry.Operation,\r
           &DataSize,\r
           Script + sizeof (EFI_BOOT_SCRIPT_SMBUS_EXECUTE)\r
           );\r
}\r
\r
/**\r
  Interpret the boot script node with EFI_BOOT_SCRIPT_STALL OP code.\r
\r
  @param Script      The pointer of typed node in boot script table\r
\r
  @retval EFI_SUCCESS The operation was executed successfully\r
**/\r
EFI_STATUS\r
BootScriptExecuteStall (\r
  IN UINT8  *Script\r
  )\r
{\r
  EFI_BOOT_SCRIPT_STALL  Stall;\r
\r
  CopyMem ((VOID *)&Stall, (VOID *)Script, sizeof (EFI_BOOT_SCRIPT_STALL));\r
\r
  DEBUG ((DEBUG_INFO, "BootScriptExecuteStall - 0x%08x\n", (UINTN)Stall.Duration));\r
\r
  MicroSecondDelay ((UINTN)Stall.Duration);\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Interpret the boot script node with EFI_BOOT_SCRIPT_DISPATCH OP code.\r
\r
  @param Script  The pointer of typed node in boot script table\r
  @retval EFI_SUCCESS  The operation was executed successfully\r
**/\r
EFI_STATUS\r
BootScriptExecuteDispatch (\r
  IN UINT8  *Script\r
  )\r
{\r
  EFI_STATUS                Status;\r
  DISPATCH_ENTRYPOINT_FUNC  EntryFunc;\r
  EFI_BOOT_SCRIPT_DISPATCH  ScriptDispatch;\r
\r
  CopyMem ((VOID *)&ScriptDispatch, (VOID *)Script, sizeof (EFI_BOOT_SCRIPT_DISPATCH));\r
  EntryFunc = (DISPATCH_ENTRYPOINT_FUNC)(UINTN)(ScriptDispatch.EntryPoint);\r
\r
  DEBUG ((DEBUG_INFO, "BootScriptExecuteDispatch - 0x%08x\n", (UINTN)ScriptDispatch.EntryPoint));\r
\r
  Status = EntryFunc (NULL, NULL);\r
\r
  return Status;\r
}\r
\r
/**\r
  Interpret the boot script node with EFI_BOOT_SCRIPT_DISPATCH_2 OP code.\r
\r
  @param  Script       The pointer of typed node in boot script table\r
  @retval EFI_SUCCESS  The operation was executed successfully\r
**/\r
EFI_STATUS\r
BootScriptExecuteDispatch2 (\r
  IN UINT8  *Script\r
  )\r
{\r
  EFI_STATUS                  Status;\r
  DISPATCH_ENTRYPOINT_FUNC    EntryFunc;\r
  EFI_BOOT_SCRIPT_DISPATCH_2  ScriptDispatch2;\r
\r
  CopyMem ((VOID *)&ScriptDispatch2, (VOID *)Script, sizeof (EFI_BOOT_SCRIPT_DISPATCH_2));\r
\r
  DEBUG ((DEBUG_INFO, "BootScriptExecuteDispatch2 - 0x%08x(0x%08x)\n", (UINTN)ScriptDispatch2.EntryPoint, (UINTN)ScriptDispatch2.Context));\r
\r
  EntryFunc = (DISPATCH_ENTRYPOINT_FUNC)(UINTN)(ScriptDispatch2.EntryPoint);\r
\r
  Status = EntryFunc (NULL, (VOID *)(UINTN)ScriptDispatch2.Context);\r
\r
  return Status;\r
}\r
\r
/**\r
  Interpret the boot script node with EFI_BOOT_SCRIPT_MEM_POLL OP code.\r
\r
  @param  Script  The pointer of typed node in boot script table\r
  @param  AndMask  Mask value for 'and' operation\r
  @param  OrMask   Mask value for 'or' operation\r
\r
  @retval EFI_DEVICE_ERROR Data polled from memory does not equal to\r
                           the epecting data within the Loop Times.\r
  @retval EFI_SUCCESS      The operation was executed successfully\r
**/\r
EFI_STATUS\r
BootScriptExecuteMemPoll (\r
  IN UINT8   *Script,\r
  IN UINT64  AndMask,\r
  IN UINT64  OrMask\r
  )\r
{\r
  UINT64                    Data;\r
  UINT64                    LoopTimes;\r
  EFI_STATUS                Status;\r
  EFI_BOOT_SCRIPT_MEM_POLL  MemPoll;\r
\r
  CopyMem ((VOID *)&MemPoll, (VOID *)Script, sizeof (EFI_BOOT_SCRIPT_MEM_POLL));\r
\r
  DEBUG ((DEBUG_INFO, "BootScriptExecuteMemPoll - 0x%08x, 0x%016lx, 0x%016lx\n", (UINTN)MemPoll.Address, AndMask, OrMask));\r
\r
  Data   = 0;\r
  Status = ScriptMemoryRead (\r
             (S3_BOOT_SCRIPT_LIB_WIDTH)MemPoll.Width,\r
             MemPoll.Address,\r
             1,\r
             &Data\r
             );\r
  if ((!EFI_ERROR (Status)) && ((Data & AndMask) == OrMask)) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  for (LoopTimes = 0; LoopTimes < MemPoll.LoopTimes; LoopTimes++) {\r
    MicroSecondDelay ((UINTN)MemPoll.Duration);\r
\r
    Data   = 0;\r
    Status = ScriptMemoryRead (\r
               (S3_BOOT_SCRIPT_LIB_WIDTH)MemPoll.Width,\r
               MemPoll.Address,\r
               1,\r
               &Data\r
               );\r
    if ((!EFI_ERROR (Status)) && ((Data & AndMask) == OrMask)) {\r
      return EFI_SUCCESS;\r
    }\r
  }\r
\r
  if (LoopTimes < MemPoll.LoopTimes) {\r
    return EFI_SUCCESS;\r
  } else {\r
    return EFI_DEVICE_ERROR;\r
  }\r
}\r
\r
/**\r
  Execute the boot script to interpret the Store arbitrary information.\r
  This opcode is a no-op on dispatch and is only used for debugging script issues.\r
\r
  @param Script       The pointer of node in boot script table\r
\r
**/\r
VOID\r
BootScriptExecuteInformation (\r
  IN UINT8  *Script\r
  )\r
\r
{\r
  UINT32                       Index;\r
  EFI_BOOT_SCRIPT_INFORMATION  Information;\r
  UINT8                        *InformationData;\r
\r
  CopyMem ((VOID *)&Information, (VOID *)Script, sizeof (EFI_BOOT_SCRIPT_INFORMATION));\r
\r
  InformationData = Script + sizeof (EFI_BOOT_SCRIPT_INFORMATION);\r
  DEBUG ((DEBUG_INFO, "BootScriptExecuteInformation - 0x%08x\n", (UINTN)InformationData));\r
\r
  DEBUG ((DEBUG_INFO, "BootScriptInformation: "));\r
  for (Index = 0; Index < Information.InformationLength; Index++) {\r
    DEBUG ((DEBUG_INFO, "%02x ", InformationData[Index]));\r
  }\r
\r
  DEBUG ((DEBUG_INFO, "\n"));\r
}\r
\r
/**\r
  Execute the boot script to interpret the Label information.\r
\r
  @param Script       The pointer of node in boot script table\r
\r
**/\r
VOID\r
BootScriptExecuteLabel (\r
  IN UINT8  *Script\r
  )\r
\r
{\r
  UINT32                       Index;\r
  EFI_BOOT_SCRIPT_INFORMATION  Information;\r
  UINT8                        *InformationData;\r
\r
  CopyMem ((VOID *)&Information, (VOID *)Script, sizeof (EFI_BOOT_SCRIPT_INFORMATION));\r
\r
  InformationData = Script + sizeof (EFI_BOOT_SCRIPT_INFORMATION);\r
  DEBUG ((DEBUG_INFO, "BootScriptExecuteLabel - 0x%08x\n", (UINTN)InformationData));\r
\r
  DEBUG ((DEBUG_INFO, "BootScriptLabel: "));\r
  for (Index = 0; Index < Information.InformationLength; Index++) {\r
    DEBUG ((DEBUG_INFO, "%02x ", InformationData[Index]));\r
  }\r
\r
  DEBUG ((DEBUG_INFO, "\n"));\r
}\r
\r
/**\r
  calculate the mask value for 'and' and 'or' operation\r
  @param ScriptHeader   The pointer of header of node in boot script table\r
  @param AndMask  The Mask value for 'and' operation\r
  @param OrMask   The Mask value for 'or' operation\r
  @param Script   Pointer to the entry.\r
\r
**/\r
VOID\r
CheckAndOrMask (\r
  IN   EFI_BOOT_SCRIPT_COMMON_HEADER  *ScriptHeader,\r
  OUT UINT64                          *AndMask,\r
  OUT UINT64                          *OrMask,\r
  IN  UINT8                           *Script\r
  )\r
{\r
  UINT8  *DataPtr;\r
  UINTN  Size;\r
\r
  switch (ScriptHeader->OpCode) {\r
    case EFI_BOOT_SCRIPT_IO_READ_WRITE_OPCODE:\r
      Size = sizeof (EFI_BOOT_SCRIPT_IO_READ_WRITE);\r
      break;\r
\r
    case EFI_BOOT_SCRIPT_MEM_READ_WRITE_OPCODE:\r
      Size = sizeof (EFI_BOOT_SCRIPT_MEM_READ_WRITE);\r
      break;\r
\r
    case EFI_BOOT_SCRIPT_PCI_CONFIG_READ_WRITE_OPCODE:\r
      Size = sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG_READ_WRITE);\r
      break;\r
    case EFI_BOOT_SCRIPT_MEM_POLL_OPCODE:\r
      Size = sizeof (EFI_BOOT_SCRIPT_MEM_POLL);\r
      break;\r
\r
    case EFI_BOOT_SCRIPT_IO_POLL_OPCODE:\r
      Size = sizeof (EFI_BOOT_SCRIPT_IO_POLL);\r
      break;\r
\r
    case EFI_BOOT_SCRIPT_PCI_CONFIG2_READ_WRITE_OPCODE:\r
      Size = sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG2_READ_WRITE);\r
      break;\r
\r
    case EFI_BOOT_SCRIPT_PCI_CONFIG2_POLL_OPCODE:\r
      Size = sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG2_POLL);\r
      break;\r
\r
    case EFI_BOOT_SCRIPT_PCI_CONFIG_POLL_OPCODE:\r
      Size = sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG_POLL);\r
      break;\r
\r
    default:\r
      return;\r
  }\r
\r
  DataPtr = Script + Size;\r
\r
  switch (ScriptHeader->Width) {\r
    case S3BootScriptWidthUint8:\r
      *AndMask = (UINT64)(*(UINT8 *)(DataPtr + 1));\r
      *OrMask  = (UINT64)(*DataPtr);\r
      break;\r
\r
    case S3BootScriptWidthUint16:\r
      *AndMask = (UINT64)(*(UINT16 *)(DataPtr + 2));\r
      *OrMask  = (UINT64)(*(UINT16 *)DataPtr);\r
      break;\r
\r
    case S3BootScriptWidthUint32:\r
      *AndMask = (UINT64)(*(UINT32 *)(DataPtr + 4));\r
      *OrMask  = (UINT64)(*(UINT32 *)DataPtr);\r
      break;\r
\r
    case S3BootScriptWidthUint64:\r
      *AndMask = (UINT64)(*(UINT64 *)(DataPtr + 8));\r
      *OrMask  = (UINT64)(*(UINT64 *)DataPtr);\r
      break;\r
\r
    default:\r
      break;\r
  }\r
\r
  return;\r
}\r
\r
/**\r
  Interpret the boot script node with EFI_BOOT_SCRIPT_IO_POLL OP code.\r
\r
  @param  Script  The pointer of typed node in boot script table\r
  @param  AndMask  Mask value for 'and' operation\r
  @param  OrMask   Mask value for 'or' operation\r
\r
  @retval EFI_DEVICE_ERROR Data polled from memory does not equal to\r
                           the epecting data within the Loop Times.\r
  @retval EFI_SUCCESS      The operation was executed successfully\r
**/\r
EFI_STATUS\r
BootScriptExecuteIoPoll (\r
  IN UINT8   *Script,\r
  IN UINT64  AndMask,\r
  IN UINT64  OrMask\r
  )\r
{\r
  EFI_STATUS               Status;\r
  UINT64                   Data;\r
  UINT64                   LoopTimes;\r
  EFI_BOOT_SCRIPT_IO_POLL  IoPoll;\r
\r
  CopyMem ((VOID *)&IoPoll, (VOID *)Script, sizeof (EFI_BOOT_SCRIPT_IO_POLL));\r
\r
  DEBUG ((DEBUG_INFO, "BootScriptExecuteIoPoll - 0x%08x, 0x%016lx, 0x%016lx\n", (UINTN)IoPoll.Address, AndMask, OrMask));\r
\r
  Data   = 0;\r
  Status = ScriptIoRead (\r
             (S3_BOOT_SCRIPT_LIB_WIDTH)IoPoll.Width,\r
             IoPoll.Address,\r
             1,\r
             &Data\r
             );\r
  if ((!EFI_ERROR (Status)) && ((Data & AndMask) == OrMask)) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  for (LoopTimes = 0; LoopTimes < IoPoll.Delay; LoopTimes++) {\r
    NanoSecondDelay (100);\r
    Data   = 0;\r
    Status = ScriptIoRead (\r
               (S3_BOOT_SCRIPT_LIB_WIDTH)IoPoll.Width,\r
               IoPoll.Address,\r
               1,\r
               &Data\r
               );\r
    if ((!EFI_ERROR (Status)) && ((Data & AndMask) == OrMask)) {\r
      return EFI_SUCCESS;\r
    }\r
  }\r
\r
  if (LoopTimes < IoPoll.Delay) {\r
    return EFI_SUCCESS;\r
  } else {\r
    return EFI_DEVICE_ERROR;\r
  }\r
}\r
\r
/**\r
  Interpret the boot script node with EFI_BOOT_SCRIPT_PCI_CONFIG2_WRITE OP code.\r
\r
  @param    Script              The pointer of S3 boot script\r
\r
  @retval   EFI_SUCCESS         The operation was executed successfully\r
\r
**/\r
EFI_STATUS\r
BootScriptExecutePciCfg2Write (\r
  IN UINT8  *Script\r
  )\r
{\r
  VOID                               *Buffer;\r
  S3_BOOT_SCRIPT_LIB_WIDTH           Width;\r
  UINT16                             Segment;\r
  UINT64                             Address;\r
  UINTN                              Count;\r
  EFI_BOOT_SCRIPT_PCI_CONFIG2_WRITE  PciCfg2Write;\r
\r
  CopyMem ((VOID *)&PciCfg2Write, (VOID *)Script, sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG2_WRITE));\r
\r
  Width   = (S3_BOOT_SCRIPT_LIB_WIDTH)PciCfg2Write.Width;\r
  Segment = PciCfg2Write.Segment;\r
  Address = PciCfg2Write.Address;\r
  Count   = PciCfg2Write.Count;\r
  Buffer  = Script + sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG2_WRITE);\r
\r
  DEBUG ((DEBUG_INFO, "BootScriptExecutePciCfg2Write - 0x%016lx, 0x%08x, 0x%08x\n", PCI_ADDRESS_ENCODE (Segment, Address), Count, (UINTN)Width));\r
  return ScriptPciCfg2Write (Width, Segment, Address, Count, Buffer);\r
}\r
\r
/**\r
  Interpret the boot script node with EFI_BOOT_SCRIPT_PCI_CONFIG2_READ_WRITE OP code.\r
\r
  @param     Script                     The pointer of S3 boot script\r
  @param     AndMask                    Mask value for 'and' operation\r
  @param     OrMask                     Mask value for 'or' operation\r
\r
  @retval    EFI_SUCCESS                The operation was executed successfully\r
\r
**/\r
EFI_STATUS\r
BootScriptExecutePciCfg2ReadWrite (\r
  IN UINT8   *Script,\r
  IN UINT64  AndMask,\r
  IN UINT64  OrMask\r
  )\r
{\r
  UINT64                                  Data;\r
  EFI_STATUS                              Status;\r
  EFI_BOOT_SCRIPT_PCI_CONFIG2_READ_WRITE  PciCfg2ReadWrite;\r
\r
  Data = 0;\r
\r
  CopyMem ((VOID *)&PciCfg2ReadWrite, (VOID *)Script, sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG2_READ_WRITE));\r
\r
  DEBUG ((DEBUG_INFO, "BootScriptExecutePciCfg2ReadWrite - 0x%016lx, 0x%016lx, 0x%016lx\n", PCI_ADDRESS_ENCODE (PciCfg2ReadWrite.Segment, PciCfg2ReadWrite.Address), AndMask, OrMask));\r
\r
  Status = ScriptPciCfg2Read (\r
             (S3_BOOT_SCRIPT_LIB_WIDTH)PciCfg2ReadWrite.Width,\r
             PciCfg2ReadWrite.Segment,\r
             PciCfg2ReadWrite.Address,\r
             1,\r
             &Data\r
             );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  Data   = (Data & AndMask) | OrMask;\r
  Status = ScriptPciCfg2Write (\r
             (S3_BOOT_SCRIPT_LIB_WIDTH)PciCfg2ReadWrite.Width,\r
             PciCfg2ReadWrite.Segment,\r
             PciCfg2ReadWrite.Address,\r
             1,\r
             &Data\r
             );\r
  return Status;\r
}\r
\r
/**\r
  Interpret the boot script node with EFI_BOOT_SCRIPT_PCI_CONFIG_POLL OP code.\r
\r
  @param     Script                     The pointer of S3 boot script\r
  @param     AndMask                    Mask value for 'and' operation\r
  @param     OrMask                     Mask value for 'or' operation\r
\r
  @retval    EFI_SUCCESS                The operation was executed successfully\r
  @retval    EFI_DEVICE_ERROR           Data polled from Pci configuration space does not equal to\r
                                        epecting data within the Loop Times.\r
**/\r
EFI_STATUS\r
BootScriptPciCfgPoll (\r
  IN UINT8   *Script,\r
  IN UINT64  AndMask,\r
  IN UINT64  OrMask\r
  )\r
{\r
  UINT64                           Data;\r
  UINT64                           LoopTimes;\r
  EFI_STATUS                       Status;\r
  EFI_BOOT_SCRIPT_PCI_CONFIG_POLL  PciCfgPoll;\r
\r
  CopyMem ((VOID *)&PciCfgPoll, (VOID *)Script, sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG_POLL));\r
\r
  DEBUG ((DEBUG_INFO, "BootScriptPciCfgPoll - 0x%016lx, 0x%016lx, 0x%016lx\n", PCI_ADDRESS_ENCODE (0, PciCfgPoll.Address), AndMask, OrMask));\r
\r
  Data   = 0;\r
  Status = ScriptPciCfgRead (\r
             (S3_BOOT_SCRIPT_LIB_WIDTH)PciCfgPoll.Width,\r
             PciCfgPoll.Address,\r
             1,\r
             &Data\r
             );\r
  if ((!EFI_ERROR (Status)) && ((Data & AndMask) == OrMask)) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  for (LoopTimes = 0; LoopTimes < PciCfgPoll.Delay; LoopTimes++) {\r
    NanoSecondDelay (100);\r
    Data   = 0;\r
    Status = ScriptPciCfgRead (\r
               (S3_BOOT_SCRIPT_LIB_WIDTH)PciCfgPoll.Width,\r
               PciCfgPoll.Address,\r
               1,\r
               &Data\r
               );\r
    if ((!EFI_ERROR (Status)) &&\r
        ((Data & AndMask) == OrMask))\r
    {\r
      return EFI_SUCCESS;\r
    }\r
  }\r
\r
  if (LoopTimes < PciCfgPoll.Delay) {\r
    return EFI_SUCCESS;\r
  } else {\r
    return EFI_DEVICE_ERROR;\r
  }\r
}\r
\r
/**\r
  Interpret the boot script node with EFI_BOOT_SCRIPT_PCI_CONFIG2_POLL OP code.\r
\r
  @param     Script                     The pointer of S3 Boot Script\r
  @param     AndMask                    Mask value for 'and' operation\r
  @param     OrMask                     Mask value for 'or' operation\r
\r
  @retval    EFI_SUCCESS                The operation was executed successfully\r
  @retval    EFI_DEVICE_ERROR           Data polled from Pci configuration space does not equal to\r
                                        epecting data within the Loop Times.\r
\r
**/\r
EFI_STATUS\r
BootScriptPciCfg2Poll (\r
  IN UINT8   *Script,\r
  IN UINT64  AndMask,\r
  IN UINT64  OrMask\r
  )\r
{\r
  EFI_STATUS                        Status;\r
  UINT64                            Data;\r
  UINT64                            LoopTimes;\r
  EFI_BOOT_SCRIPT_PCI_CONFIG2_POLL  PciCfg2Poll;\r
\r
  Data = 0;\r
  CopyMem ((VOID *)&PciCfg2Poll, (VOID *)Script, sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG2_POLL));\r
\r
  DEBUG ((DEBUG_INFO, "BootScriptPciCfg2Poll - 0x%016lx, 0x%016lx, 0x%016lx\n", PCI_ADDRESS_ENCODE (PciCfg2Poll.Segment, PciCfg2Poll.Address), AndMask, OrMask));\r
\r
  Status = ScriptPciCfg2Read (\r
             (S3_BOOT_SCRIPT_LIB_WIDTH)PciCfg2Poll.Width,\r
             PciCfg2Poll.Segment,\r
             PciCfg2Poll.Address,\r
             1,\r
             &Data\r
             );\r
  if ((!EFI_ERROR (Status)) && ((Data & AndMask) == OrMask)) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  for (LoopTimes = 0; LoopTimes < PciCfg2Poll.Delay; LoopTimes++) {\r
    NanoSecondDelay (100);\r
\r
    Data   = 0;\r
    Status = ScriptPciCfg2Read (\r
               (S3_BOOT_SCRIPT_LIB_WIDTH)PciCfg2Poll.Width,\r
               PciCfg2Poll.Segment,\r
               PciCfg2Poll.Address,\r
               1,\r
               &Data\r
               );\r
    if ((!EFI_ERROR (Status)) &&  ((Data & AndMask) == OrMask)) {\r
      return EFI_SUCCESS;\r
    }\r
  }\r
\r
  if (LoopTimes < PciCfg2Poll.Delay) {\r
    return EFI_SUCCESS;\r
  } else {\r
    return EFI_DEVICE_ERROR;\r
  }\r
}\r
\r
/**\r
  Executes the S3 boot script table.\r
\r
  @retval RETURN_SUCCESS           The boot script table was executed successfully.\r
  @retval RETURN_UNSUPPORTED       Invalid script table or opcode.\r
\r
**/\r
RETURN_STATUS\r
EFIAPI\r
S3BootScriptExecute (\r
  VOID\r
  )\r
{\r
  EFI_STATUS                     Status;\r
  UINT8                          *Script;\r
  UINTN                          StartAddress;\r
  UINT32                         TableLength;\r
  UINT64                         AndMask;\r
  UINT64                         OrMask;\r
  EFI_BOOT_SCRIPT_COMMON_HEADER  ScriptHeader;\r
  EFI_BOOT_SCRIPT_TABLE_HEADER   TableHeader;\r
\r
  Script = mS3BootScriptTablePtr->TableBase;\r
  if (Script != 0) {\r
    CopyMem ((VOID *)&TableHeader, Script, sizeof (EFI_BOOT_SCRIPT_TABLE_HEADER));\r
  } else {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  DEBUG ((DEBUG_INFO, "S3BootScriptExecute:\n"));\r
  if (TableHeader.OpCode != S3_BOOT_SCRIPT_LIB_TABLE_OPCODE) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  DEBUG ((DEBUG_INFO, "TableHeader - 0x%08x\n", Script));\r
\r
  StartAddress = (UINTN)Script;\r
  TableLength  = TableHeader.TableLength;\r
  Script       =    Script + TableHeader.Length;\r
  Status       = EFI_SUCCESS;\r
  AndMask      = 0;\r
  OrMask       = 0;\r
\r
  DEBUG ((DEBUG_INFO, "TableHeader.Version - 0x%04x\n", (UINTN)TableHeader.Version));\r
  DEBUG ((DEBUG_INFO, "TableHeader.TableLength - 0x%08x\n", (UINTN)TableLength));\r
\r
  while ((UINTN)Script < (UINTN)(StartAddress + TableLength)) {\r
    DEBUG ((DEBUG_INFO, "ExecuteBootScript - %08x\n", (UINTN)Script));\r
\r
    CopyMem ((VOID *)&ScriptHeader, Script, sizeof (EFI_BOOT_SCRIPT_COMMON_HEADER));\r
    switch (ScriptHeader.OpCode) {\r
      case EFI_BOOT_SCRIPT_MEM_WRITE_OPCODE:\r
        DEBUG ((DEBUG_INFO, "EFI_BOOT_SCRIPT_MEM_WRITE_OPCODE\n"));\r
        Status = BootScriptExecuteMemoryWrite (Script);\r
        break;\r
\r
      case EFI_BOOT_SCRIPT_MEM_READ_WRITE_OPCODE:\r
        DEBUG ((DEBUG_INFO, "EFI_BOOT_SCRIPT_MEM_READ_WRITE_OPCODE\n"));\r
        CheckAndOrMask (&ScriptHeader, &AndMask, &OrMask, Script);\r
        Status = BootScriptExecuteMemoryReadWrite (\r
                   Script,\r
                   AndMask,\r
                   OrMask\r
                   );\r
        break;\r
\r
      case EFI_BOOT_SCRIPT_IO_WRITE_OPCODE:\r
        DEBUG ((DEBUG_INFO, "EFI_BOOT_SCRIPT_IO_WRITE_OPCODE\n"));\r
        Status = BootScriptExecuteIoWrite (Script);\r
        break;\r
\r
      case EFI_BOOT_SCRIPT_PCI_CONFIG_WRITE_OPCODE:\r
        DEBUG ((DEBUG_INFO, "EFI_BOOT_SCRIPT_PCI_CONFIG_WRITE_OPCODE\n"));\r
        Status = BootScriptExecutePciCfgWrite (Script);\r
        break;\r
\r
      case EFI_BOOT_SCRIPT_PCI_CONFIG_READ_WRITE_OPCODE:\r
        DEBUG ((DEBUG_INFO, "EFI_BOOT_SCRIPT_PCI_CONFIG_READ_WRITE_OPCODE\n"));\r
        CheckAndOrMask (&ScriptHeader, &AndMask, &OrMask, Script);\r
        Status = BootScriptExecutePciCfgReadWrite (\r
                   Script,\r
                   AndMask,\r
                   OrMask\r
                   );\r
        break;\r
      case EFI_BOOT_SCRIPT_PCI_CONFIG2_WRITE_OPCODE:\r
        DEBUG ((DEBUG_INFO, "EFI_BOOT_SCRIPT_PCI_CONFIG2_WRITE_OPCODE\n"));\r
        Status = BootScriptExecutePciCfg2Write (Script);\r
        break;\r
\r
      case EFI_BOOT_SCRIPT_PCI_CONFIG2_READ_WRITE_OPCODE:\r
        DEBUG ((DEBUG_INFO, "EFI_BOOT_SCRIPT_PCI_CONFIG2_READ_WRITE_OPCODE\n"));\r
        CheckAndOrMask (&ScriptHeader, &AndMask, &OrMask, Script);\r
        Status = BootScriptExecutePciCfg2ReadWrite (\r
                   Script,\r
                   AndMask,\r
                   OrMask\r
                   );\r
        break;\r
      case EFI_BOOT_SCRIPT_DISPATCH_OPCODE:\r
        DEBUG ((DEBUG_INFO, "EFI_BOOT_SCRIPT_DISPATCH_OPCODE\n"));\r
        Status = BootScriptExecuteDispatch (Script);\r
        break;\r
\r
      case EFI_BOOT_SCRIPT_DISPATCH_2_OPCODE:\r
        DEBUG ((DEBUG_INFO, "EFI_BOOT_SCRIPT_DISPATCH_2_OPCODE\n"));\r
        Status = BootScriptExecuteDispatch2 (Script);\r
        break;\r
\r
      case EFI_BOOT_SCRIPT_INFORMATION_OPCODE:\r
        DEBUG ((DEBUG_INFO, "EFI_BOOT_SCRIPT_INFORMATION_OPCODE\n"));\r
        BootScriptExecuteInformation (Script);\r
        break;\r
\r
      case S3_BOOT_SCRIPT_LIB_TERMINATE_OPCODE:\r
        DEBUG ((DEBUG_INFO, "S3_BOOT_SCRIPT_LIB_TERMINATE_OPCODE\n"));\r
        DEBUG ((DEBUG_INFO, "S3BootScriptDone - %r\n", EFI_SUCCESS));\r
        return EFI_SUCCESS;\r
\r
      case EFI_BOOT_SCRIPT_IO_READ_WRITE_OPCODE:\r
        DEBUG ((DEBUG_INFO, "EFI_BOOT_SCRIPT_IO_READ_WRITE_OPCODE\n"));\r
        CheckAndOrMask (&ScriptHeader, &AndMask, &OrMask, Script);\r
        Status = BootScriptExecuteIoReadWrite (\r
                   Script,\r
                   AndMask,\r
                   OrMask\r
                   );\r
        break;\r
\r
      case EFI_BOOT_SCRIPT_SMBUS_EXECUTE_OPCODE:\r
        DEBUG ((DEBUG_INFO, "EFI_BOOT_SCRIPT_SMBUS_EXECUTE_OPCODE\n"));\r
        Status = BootScriptExecuteSmbusExecute (Script);\r
        break;\r
\r
      case EFI_BOOT_SCRIPT_STALL_OPCODE:\r
        DEBUG ((DEBUG_INFO, "EFI_BOOT_SCRIPT_STALL_OPCODE\n"));\r
        Status = BootScriptExecuteStall (Script);\r
        break;\r
\r
      case EFI_BOOT_SCRIPT_MEM_POLL_OPCODE:\r
        DEBUG ((DEBUG_INFO, "EFI_BOOT_SCRIPT_MEM_POLL_OPCODE\n"));\r
        CheckAndOrMask (&ScriptHeader, &AndMask, &OrMask, Script);\r
        Status = BootScriptExecuteMemPoll (Script, AndMask, OrMask);\r
\r
        break;\r
\r
      case EFI_BOOT_SCRIPT_IO_POLL_OPCODE:\r
        DEBUG ((DEBUG_INFO, "EFI_BOOT_SCRIPT_IO_POLL_OPCODE\n"));\r
        CheckAndOrMask (&ScriptHeader, &AndMask, &OrMask, Script);\r
        Status = BootScriptExecuteIoPoll (Script, AndMask, OrMask);\r
        break;\r
\r
      case EFI_BOOT_SCRIPT_PCI_CONFIG_POLL_OPCODE:\r
        DEBUG ((DEBUG_INFO, "EFI_BOOT_SCRIPT_PCI_CONFIG_POLL_OPCODE\n"));\r
        CheckAndOrMask (&ScriptHeader, &AndMask, &OrMask, Script);\r
        Status = BootScriptPciCfgPoll (Script, AndMask, OrMask);\r
        break;\r
\r
      case EFI_BOOT_SCRIPT_PCI_CONFIG2_POLL_OPCODE:\r
        DEBUG ((DEBUG_INFO, "EFI_BOOT_SCRIPT_PCI_CONFIG2_POLL_OPCODE\n"));\r
        CheckAndOrMask (&ScriptHeader, &AndMask, &OrMask, Script);\r
        Status = BootScriptPciCfg2Poll (Script, AndMask, OrMask);\r
        break;\r
\r
      case S3_BOOT_SCRIPT_LIB_LABEL_OPCODE:\r
        //\r
        // For label\r
        //\r
        DEBUG ((DEBUG_INFO, "S3_BOOT_SCRIPT_LIB_LABEL_OPCODE\n"));\r
        BootScriptExecuteLabel (Script);\r
        break;\r
      default:\r
        DEBUG ((DEBUG_INFO, "S3BootScriptDone - %r\n", EFI_UNSUPPORTED));\r
        return EFI_UNSUPPORTED;\r
    }\r
\r
    if (EFI_ERROR (Status)) {\r
      DEBUG ((DEBUG_INFO, "S3BootScriptDone - %r\n", Status));\r
      return Status;\r
    }\r
\r
    Script = Script + ScriptHeader.Length;\r
  }\r
\r
  DEBUG ((DEBUG_INFO, "S3BootScriptDone - %r\n", Status));\r
\r
  return Status;\r
}\r