MdeModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdeModulePkg / Universal / EsrtFmpDxe / EsrtFmpDebugPrint.c

/** @file\r
  Publishes ESRT table from Firmware Management Protocol instances\r
\r
  Copyright (c) 2016, Microsoft Corporation\r
  Copyright (c) 2018, Intel Corporation. All rights reserved.<BR>\r
\r
  All rights reserved.\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include <Uefi.h>\r
#include <Library/BaseLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/DebugLib.h>\r
#include <Protocol/FirmwareManagement.h>\r
#include <Guid/SystemResourceTable.h>\r
\r
/**\r
  Function to print a single ESRT Entry (ESRE) to the debug console.\r
\r
  Print Format:\r
  | 00000000-0000-0000-0000-000000000000 | SSSSSSSSSSSS | 0x00000000 | 0x00000000 | 0x00000000 | 0x00000000 | 0x00000000 |\r
\r
  @param[in]  Entry  - Pointer to an ESRE entry\r
  @retval  EFI_SUCCESS\r
                        EFI_INVALID_PARAMETER\r
**/\r
EFI_STATUS\r
EFIAPI\r
PrintOutEsrtEntry (\r
  IN EFI_SYSTEM_RESOURCE_ENTRY  *Entry\r
  )\r
{\r
  if (Entry == NULL) {\r
    DEBUG ((DEBUG_INFO, "| ERROR:  Invalid resource entry pointer                           "));\r
    DEBUG ((DEBUG_INFO, "                                                    |\n"));\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // GUID FW Class (36 chars plus table formatting)\r
  //\r
  DEBUG ((DEBUG_INFO, "| %g |", &Entry->FwClass));\r
\r
  //\r
  // Entry Type (12 chars plus table formatting)\r
  //\r
  switch (Entry->FwType) {\r
  case (ESRT_FW_TYPE_SYSTEMFIRMWARE) :\r
    DEBUG ((DEBUG_INFO, " System FW    |"));\r
    break;\r
  case (ESRT_FW_TYPE_DEVICEFIRMWARE) :\r
    DEBUG ((DEBUG_INFO, " Device FW    |"));\r
    break;\r
  case (ESRT_FW_TYPE_UEFIDRIVER) :\r
    DEBUG ((DEBUG_INFO, " Uefi Driver  |"));\r
    break;\r
  case (ESRT_FW_TYPE_UNKNOWN) :\r
    DEBUG ((DEBUG_INFO, " Unknown Type |"));\r
    break;\r
  default:\r
    DEBUG ((DEBUG_INFO, " ? 0x%8X |", Entry->FwType));\r
    break;\r
  }\r
\r
  //\r
  // FW Version (10 char UINT32 string plus table formatting)\r
  // Lowest Supported Version (10 char UINT32 string plus table formatting)\r
  // Capsule Flags (10 char UINT32 string plus table formatting)\r
  // Last Attempt Version (10 char UINT32 string plus table formatting)\r
  // Last Attempt Status (10 char UINT32 string plus table formatting)\r
  //\r
  DEBUG ((DEBUG_INFO,\r
    " 0x%8X | 0x%8X | 0x%8X | 0x%8X | 0x%8X |\n",\r
    Entry->FwVersion,\r
    Entry->LowestSupportedFwVersion,\r
    Entry->CapsuleFlags,\r
    Entry->LastAttemptVersion,\r
    Entry->LastAttemptStatus\r
    ));\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Function to print the ESRT table to the debug console.\r
\r
  @param[in]  Table  - Pointer to the ESRT table\r
**/\r
VOID\r
EFIAPI\r
PrintTable (\r
  IN EFI_SYSTEM_RESOURCE_TABLE  *Table\r
  )\r
{\r
  EFI_SYSTEM_RESOURCE_ENTRY  *Entry;\r
  UINTN                      Index;\r
\r
  Entry = (EFI_SYSTEM_RESOURCE_ENTRY *)(((UINT8 *)Table) + sizeof (EFI_SYSTEM_RESOURCE_TABLE));\r
\r
  //\r
  // Print ESRT table information\r
  //\r
  DEBUG ((DEBUG_INFO, "ESRT Table Information:\n"));\r
  if (Table == NULL) {\r
    DEBUG ((DEBUG_INFO, "ERROR:  Invalid table pointer\n"));\r
    return;\r
  }\r
\r
  DEBUG ((DEBUG_INFO, "+--------------------------------------------------------+\n"));\r
  DEBUG ((DEBUG_INFO, "| Firmware Resource Count          : 0x%08x          |\n",  Table->FwResourceCount));\r
  DEBUG ((DEBUG_INFO, "| Firmware Resource Count Max      : 0x%08x          |\n",  Table->FwResourceCountMax));\r
  DEBUG ((DEBUG_INFO, "| Firmware Resource Entry Version  : 0x%016x  |\n",         Table->FwResourceVersion));\r
  DEBUG ((DEBUG_INFO, "+--------------------------------------------------------+\n"));\r
\r
  //\r
  // Print table entry information\r
  //\r
  DEBUG ((DEBUG_INFO, "ESRT Table Entries:\n"));\r
  if (Table->FwResourceVersion != EFI_SYSTEM_RESOURCE_TABLE_FIRMWARE_RESOURCE_VERSION) {\r
    DEBUG ((DEBUG_INFO, "ERROR:  Unsupported Resource Entry Version\n"));\r
    return;\r
  }\r
\r
  DEBUG ((DEBUG_INFO, "+--------------------------------------+--------------+------------"));\r
  DEBUG ((DEBUG_INFO, "+------------+------------+------------+------------+\n"));\r
  DEBUG ((DEBUG_INFO, "|                                      |              |            "));\r
  DEBUG ((DEBUG_INFO, "| Lowest     |            | Last       | Last       |\n"));\r
  DEBUG ((DEBUG_INFO, "|                                      | Firmware     |            "));\r
  DEBUG ((DEBUG_INFO, "| Supported  | Capsule    | Attempted  | Attempted  |\n"));\r
  DEBUG ((DEBUG_INFO, "| CLASS GUID                           | Type         | Version    "));\r
  DEBUG ((DEBUG_INFO, "| Version    | Flags      | Version    | Status     |\n"));\r
  DEBUG ((DEBUG_INFO, "+--------------------------------------+--------------+------------"));\r
  DEBUG ((DEBUG_INFO, "+------------+------------+------------+------------+\n"));\r
\r
  for (Index = 0; Index < Table->FwResourceCount; Index++) {\r
    PrintOutEsrtEntry (&(Entry[Index]));\r
  }\r
\r
  DEBUG ((DEBUG_INFO, "+--------------------------------------+--------------+------------"));\r
  DEBUG ((DEBUG_INFO, "+------------+------------+------------+------------+\n"));\r
}\r
\r