Add doxygen style comments for functions in DxeMain.

[mirror_edk2.git] / MdeModulePkg / Core / Dxe / Misc / InstallConfigurationTable.c

/** @file \r
\r
  UEFI Miscellaneous boot Services InstallConfigurationTable service\r
\r
Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
All rights reserved. This program and the accompanying materials                          \r
are licensed and made available under the terms and conditions of the BSD License         \r
which accompanies this distribution.  The full text of the license may be found at        \r
http://opensource.org/licenses/bsd-license.php                                            \r
                                                                                          \r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
\r
**/\r
\r
#include <DxeMain.h>\r
\r
#define CONFIG_TABLE_SIZE_INCREASED 0x10\r
\r
UINTN mSystemTableAllocateSize = 0;\r
\r
\r
\r
/**\r
  Find a config table by name in system table's ConfigurationTable.\r
\r
  @param  Guid           The table name to look for \r
  @param  Table          Pointer of the config table \r
\r
  @retval EFI_NOT_FOUND  Could not find the table in system table's \r
                         ConfigurationTable. \r
  @retval EFI_SUCCESS    Table successfully found.\r
\r
**/\r
EFI_STATUS\r
CoreGetConfigTable (\r
  IN EFI_GUID *Guid,\r
  OUT VOID    **Table\r
  )\r
{\r
  UINTN Index;\r
\r
  for (Index = 0; Index < gDxeCoreST->NumberOfTableEntries; Index++) {\r
    if (CompareGuid (Guid, &(gDxeCoreST->ConfigurationTable[Index].VendorGuid))) {\r
      *Table = gDxeCoreST->ConfigurationTable[Index].VendorTable;\r
      return EFI_SUCCESS;\r
    }\r
  }\r
\r
  return EFI_NOT_FOUND;\r
}\r
\r
\r
\r
\r
/**\r
  Boot Service called to add, modify, or remove a system configuration table from\r
  the EFI System Table.\r
\r
  @param  Guid           Pointer to the GUID for the entry to add, update, or \r
                         remove \r
  @param  Table          Pointer to the configuration table for the entry to add, \r
                         update, or remove, may be NULL. \r
\r
  @return EFI_SUCCESS               Guid, Table pair added, updated, or removed.\r
  @return EFI_INVALID_PARAMETER     Input GUID not valid.\r
  @return EFI_NOT_FOUND             Attempted to delete non-existant entry\r
  @return EFI_OUT_OF_RESOURCES      Not enough memory available\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
CoreInstallConfigurationTable (\r
  IN EFI_GUID *Guid,\r
  IN VOID     *Table\r
  )\r
{\r
  UINTN                   Index;\r
  EFI_CONFIGURATION_TABLE *EfiConfigurationTable;\r
\r
  //\r
  // If Guid is NULL, then this operation cannot be performed\r
  //\r
  if (Guid == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  EfiConfigurationTable = gDxeCoreST->ConfigurationTable;\r
\r
  //\r
  // Search all the table for an entry that matches Guid\r
  //\r
  for (Index = 0; Index < gDxeCoreST->NumberOfTableEntries; Index++) {\r
    if (CompareGuid (Guid, &(gDxeCoreST->ConfigurationTable[Index].VendorGuid))) {\r
      break;\r
    }\r
  }\r
\r
  if (Index < gDxeCoreST->NumberOfTableEntries) {\r
    //\r
    // A match was found, so this is either a modify or a delete operation\r
    //\r
    if (Table != NULL) {\r
      //\r
      // If Table is not NULL, then this is a modify operation.\r
      // Modify the table enty and return.\r
      //\r
      gDxeCoreST->ConfigurationTable[Index].VendorTable = Table;\r
\r
      //\r
      // Signal Configuration Table change\r
      //\r
      CoreNotifySignalList (Guid);\r
\r
      return EFI_SUCCESS;\r
    }\r
\r
    //\r
    // A match was found and Table is NULL, so this is a delete operation.\r
    //\r
    gDxeCoreST->NumberOfTableEntries--;\r
\r
    //\r
    // Copy over deleted entry\r
    //\r
    CopyMem (\r
      &(EfiConfigurationTable[Index]),\r
      &(gDxeCoreST->ConfigurationTable[Index + 1]),\r
      (gDxeCoreST->NumberOfTableEntries - Index) * sizeof (EFI_CONFIGURATION_TABLE)\r
      );\r
\r
  } else {\r
\r
    //\r
    // No matching GUIDs were found, so this is an add operation.\r
    //\r
\r
    if (Table == NULL) {\r
      //\r
      // If Table is NULL on an add operation, then return an error.\r
      //\r
      return EFI_NOT_FOUND;\r
    }\r
\r
    //\r
    // Assume that Index == gDxeCoreST->NumberOfTableEntries\r
    //\r
    if ((Index * sizeof (EFI_CONFIGURATION_TABLE)) >= mSystemTableAllocateSize) {\r
      //\r
      // Allocate a table with one additional entry.\r
      //\r
      mSystemTableAllocateSize += (CONFIG_TABLE_SIZE_INCREASED * sizeof (EFI_CONFIGURATION_TABLE));\r
      EfiConfigurationTable = CoreAllocateRuntimePool (mSystemTableAllocateSize);\r
      if (EfiConfigurationTable == NULL) {\r
        //\r
        // If a new table could not be allocated, then return an error.\r
        //\r
        return EFI_OUT_OF_RESOURCES;\r
      }\r
\r
      if (gDxeCoreST->ConfigurationTable != NULL) {\r
        //\r
        // Copy the old table to the new table.\r
        //\r
        CopyMem (\r
          EfiConfigurationTable,\r
          gDxeCoreST->ConfigurationTable,\r
          Index * sizeof (EFI_CONFIGURATION_TABLE)\r
          );\r
\r
        //\r
        // Free Old Table\r
        //\r
        CoreFreePool (gDxeCoreST->ConfigurationTable);\r
      }\r
\r
      //\r
      // Update System Table\r
      //\r
      gDxeCoreST->ConfigurationTable = EfiConfigurationTable;\r
    }\r
\r
    //\r
    // Fill in the new entry\r
    //\r
    CopyMem ((VOID *)&EfiConfigurationTable[Index].VendorGuid, Guid, sizeof (EFI_GUID));\r
    EfiConfigurationTable[Index].VendorTable  = Table;\r
\r
    //\r
    // This is an add operation, so increment the number of table entries\r
    //\r
    gDxeCoreST->NumberOfTableEntries++;\r
  }\r
\r
  //\r
  // Fix up the CRC-32 in the EFI System Table\r
  //\r
  CalculateEfiHdrCrc (&gDxeCoreST->Hdr);\r
\r
  //\r
  // Signal Configuration Table change\r
  //\r
  CoreNotifySignalList (Guid);\r
\r
  return EFI_SUCCESS;\r
}\r