BaseTools: replace string constants used for module types

[mirror_edk2.git] / Vlv2TbltDevicePkg / PlatformSmm / SmmScriptSave.c

/** @file\r
\r
  Copyright (c) 2004  - 2014, Intel Corporation. All rights reserved.<BR>\r
                                                                                   \r\r
  This program and the accompanying materials are licensed and made available under\r\r
  the terms and conditions of the BSD License that accompanies this distribution.  \r\r
  The full text of the license may be found at                                     \r\r
  http://opensource.org/licenses/bsd-license.php.                                  \r\r
                                                                                   \r\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,            \r\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.    \r\r
                                                                                   \r\r
\r
\r
Module Name:\r
\r
\r
    SmmScriptSave.c\r
\r
Abstract:\r
\r
    ScriptTableSave module at run time\r
\r
--*/\r
\r
#include "SmmScriptSave.h"\r
\r
//\r
// internal functions\r
//\r
\r
EFI_STATUS\r
BootScriptIoWrite  (\r
  IN EFI_SMM_SCRIPT_TABLE     *ScriptTable,\r
  IN VA_LIST                  Marker\r
  );\r
\r
EFI_STATUS\r
BootScriptPciCfgWrite  (\r
  IN EFI_SMM_SCRIPT_TABLE     *ScriptTable,\r
  IN VA_LIST                  Marker\r
  );\r
\r
VOID\r
SmmCopyMem (\r
  IN  UINT8    *Destination,\r
  IN  UINT8    *Source,\r
  IN  UINTN    ByteCount\r
  );\r
\r
//\r
// Function implementations\r
//\r
EFI_STATUS\r
SmmBootScriptWrite (\r
  IN OUT EFI_SMM_SCRIPT_TABLE    *ScriptTable,\r
  IN UINTN                       Type,\r
  IN UINT16                      OpCode,\r
  ...\r
  )\r
{\r
  EFI_STATUS    Status;\r
  VA_LIST       Marker;\r
\r
  if (ScriptTable == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // Build script according to opcode\r
  //\r
  switch ( OpCode ) {\r
\r
    case EFI_BOOT_SCRIPT_IO_WRITE_OPCODE:\r
      VA_START(Marker, OpCode);\r
      Status = BootScriptIoWrite (ScriptTable, Marker);\r
      VA_END(Marker);\r
      break;\r
\r
    case EFI_BOOT_SCRIPT_PCI_CONFIG_WRITE_OPCODE:\r
      VA_START(Marker, OpCode);\r
      Status = BootScriptPciCfgWrite(ScriptTable, Marker);\r
      VA_END(Marker);\r
      break;\r
\r
    default:\r
      Status = EFI_SUCCESS;\r
      break;\r
  }\r
\r
  return Status;\r
}\r
\r
\r
EFI_STATUS\r
SmmBootScriptCreateTable (\r
  IN OUT EFI_SMM_SCRIPT_TABLE    *ScriptTable,\r
  IN UINTN                       Type\r
  )\r
{\r
  BOOT_SCRIPT_POINTERS          Script;\r
  UINT8                         *Buffer;\r
\r
  if (ScriptTable == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Buffer = (UINT8*) ((UINTN)(*ScriptTable));\r
\r
  //\r
  // Fill Table Header\r
  //\r
  Script.Raw = Buffer;\r
  Script.TableInfo->OpCode      = EFI_BOOT_SCRIPT_TABLE_OPCODE;\r
  Script.TableInfo->Length      = sizeof(EFI_BOOT_SCRIPT_TABLE_HEADER);\r
  Script.TableInfo->TableLength = sizeof(EFI_BOOT_SCRIPT_TABLE_HEADER);\r
\r
  //\r
  // Update current table pointer\r
  //\r
  *ScriptTable = *ScriptTable + sizeof(EFI_BOOT_SCRIPT_TABLE_HEADER);\r
  return EFI_SUCCESS;\r
}\r
\r
\r
EFI_STATUS\r
SmmBootScriptCloseTable (\r
  IN EFI_SMM_SCRIPT_TABLE        ScriptTableBase,\r
  IN EFI_SMM_SCRIPT_TABLE        ScriptTablePtr,\r
  IN UINTN                       Type\r
  )\r
{\r
  BOOT_SCRIPT_POINTERS    Script;\r
\r
  //\r
  // Add final "termination" node to script table\r
  //\r
  Script.Raw               = (UINT8*) ((UINTN)ScriptTablePtr);\r
  Script.Terminate->OpCode = EFI_BOOT_SCRIPT_TERMINATE_OPCODE;\r
  Script.Terminate->Length = sizeof (EFI_BOOT_SCRIPT_TERMINATE);\r
  ScriptTablePtr          += sizeof (EFI_BOOT_SCRIPT_TERMINATE);\r
\r
\r
  //\r
  // Update Table Header\r
  //\r
  Script.Raw                    = (UINT8*) ((UINTN)ScriptTableBase);\r
  Script.TableInfo->OpCode      = EFI_BOOT_SCRIPT_TABLE_OPCODE;\r
  Script.TableInfo->Length      = sizeof (EFI_BOOT_SCRIPT_TABLE_HEADER);\r
  Script.TableInfo->TableLength = (UINT32)(ScriptTablePtr - ScriptTableBase);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
\r
EFI_STATUS\r
BootScriptIoWrite  (\r
  IN EFI_SMM_SCRIPT_TABLE     *ScriptTable,\r
  IN VA_LIST                  Marker\r
  )\r
{\r
  BOOT_SCRIPT_POINTERS    Script;\r
  EFI_BOOT_SCRIPT_WIDTH   Width;\r
  UINTN                   Address;\r
  UINTN                   Count;\r
  UINT8                   *Buffer;\r
  UINTN                   NodeLength;\r
  UINT8                   WidthInByte;\r
\r
  Width     = VA_ARG(Marker, EFI_BOOT_SCRIPT_WIDTH);\r
  Address   = VA_ARG(Marker, UINTN);\r
  Count     = VA_ARG(Marker, UINTN);\r
  Buffer    = VA_ARG(Marker, UINT8*);\r
\r
  WidthInByte = (UINT8)(0x01 << (Width & 0x03));\r
  Script.Raw  = (UINT8*) ((UINTN)(*ScriptTable));\r
  NodeLength  = sizeof (EFI_BOOT_SCRIPT_IO_WRITE) + (WidthInByte * Count);\r
\r
  //\r
  // Build script data\r
  //\r
  Script.IoWrite->OpCode  = EFI_BOOT_SCRIPT_IO_WRITE_OPCODE;\r
  Script.IoWrite->Length  = (UINT8)(NodeLength);\r
  Script.IoWrite->Width   = Width;\r
  Script.IoWrite->Address = Address;\r
  Script.IoWrite->Count   = (UINT32)Count;\r
  SmmCopyMem (\r
    (UINT8*)(Script.Raw + sizeof (EFI_BOOT_SCRIPT_IO_WRITE)),\r
    Buffer,\r
    WidthInByte * Count\r
    );\r
\r
  //\r
  // Update Script table pointer\r
  //\r
  *ScriptTable = *ScriptTable + NodeLength;\r
  return EFI_SUCCESS;\r
}\r
\r
\r
EFI_STATUS\r
BootScriptPciCfgWrite  (\r
  IN EFI_SMM_SCRIPT_TABLE        *ScriptTable,\r
  IN VA_LIST                     Marker\r
  )\r
{\r
  BOOT_SCRIPT_POINTERS    Script;\r
  EFI_BOOT_SCRIPT_WIDTH   Width;\r
  UINT64                  Address;\r
  UINTN                   Count;\r
  UINT8                   *Buffer;\r
  UINTN                   NodeLength;\r
  UINT8                   WidthInByte;\r
\r
  Width     = VA_ARG(Marker, EFI_BOOT_SCRIPT_WIDTH);\r
  Address   = VA_ARG(Marker, UINT64);\r
  Count     = VA_ARG(Marker, UINTN);\r
  Buffer    = VA_ARG(Marker, UINT8*);\r
\r
  WidthInByte = (UINT8)(0x01 << (Width & 0x03));\r
  Script.Raw  = (UINT8*) ((UINTN)(*ScriptTable));\r
  NodeLength  = sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG_WRITE) + (WidthInByte * Count);\r
\r
  //\r
  // Build script data\r
  //\r
  Script.PciWrite->OpCode  = EFI_BOOT_SCRIPT_PCI_CONFIG_WRITE_OPCODE;\r
  Script.PciWrite->Length  = (UINT8)(NodeLength);\r
  Script.PciWrite->Width   = Width;\r
  Script.PciWrite->Address = Address;\r
  Script.PciWrite->Count   = (UINT32)Count;\r
  SmmCopyMem (\r
    (UINT8*)(Script.Raw + sizeof (EFI_BOOT_SCRIPT_PCI_CONFIG_WRITE)),\r
    Buffer,\r
    WidthInByte * Count\r
    );\r
\r
  //\r
  // Update Script table pointer\r
  //\r
  *ScriptTable = *ScriptTable + NodeLength;\r
  return EFI_SUCCESS;\r
}\r
\r
VOID\r
SmmCopyMem (\r
  IN  UINT8    *Destination,\r
  IN  UINT8    *Source,\r
  IN  UINTN    ByteCount\r
  )\r
{\r
  UINTN   Index;\r
\r
  for (Index = 0; Index < ByteCount; Index++, Destination++, Source++) {\r
    *Destination = *Source;\r
  }\r
}\r