Update the copyright notice format

[mirror_edk2.git] / EdkCompatibilityPkg / Sample / Platform / Generic / RuntimeDxe / StatusCode / Lib / BsDataHubStatusCode / BsDataHubStatusCode.h

/*++\r
\r
Copyright (c) 2004 - 2007, Intel Corporation. All rights reserved.<BR>\r
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
Module Name:\r
\r
  BsDataHubStatusCode.h\r
\r
Abstract:\r
\r
  Header for the status code data hub logging component\r
\r
--*/\r
\r
#ifndef _EFI_BS_DATA_HUB_STATUS_CODE_H_\r
#define _EFI_BS_DATA_HUB_STATUS_CODE_H_\r
\r
\r
// Statements that include other files.\r
//\r
#include "Tiano.h"\r
#include "EfiCommonLib.h"\r
#include "EfiRuntimeLib.h"\r
#include "EfiPrintLib.h"\r
#include "EfiStatusCode.h"\r
\r
//\r
// Dependent protocols\r
//\r
#include EFI_PROTOCOL_DEPENDENCY (DataHub)\r
\r
//\r
// Consumed protocols\r
//\r
#include EFI_ARCH_PROTOCOL_CONSUMER (StatusCode)\r
\r
//\r
// GUID definitions\r
//\r
#include EFI_GUID_DEFINITION (StatusCode)\r
#include EFI_GUID_DEFINITION (StatusCodeCallerId)\r
#include EFI_GUID_DEFINITION (StatusCodeDataTypeId)\r
\r
//\r
// Private data declarations\r
//\r
#define MAX_RECORD_NUM                    1000\r
#define BYTES_PER_RECORD                  EFI_STATUS_CODE_DATA_MAX_SIZE\r
#define BYTES_PER_BUFFER                  (BYTES_PER_RECORD * sizeof (UINT8))\r
\r
#define BS_DATA_HUB_STATUS_CODE_SIGNATURE EFI_SIGNATURE_32 ('B', 'D', 'H', 'S')\r
\r
typedef struct {\r
  UINTN           Signature;\r
  EFI_LIST_ENTRY  Node;\r
  UINT8           Data[BYTES_PER_RECORD];\r
} DATAHUB_STATUSCODE_RECORD;\r
\r
//\r
// Function prototypes\r
//\r
EFI_STATUS\r
EFIAPI\r
BsDataHubInitializeStatusCode (\r
  IN EFI_HANDLE         ImageHandle,\r
  IN EFI_SYSTEM_TABLE   *SystemTable\r
  );\r
/*++\r
\r
Routine Description:\r
\r
  Install a data hub listener.\r
\r
Arguments:\r
\r
  (Standard EFI Image entry - EFI_IMAGE_ENTRY_POINT)\r
\r
Returns:\r
\r
  EFI_SUCCESS - Logging Hub protocol installed\r
  Other       - No protocol installed, unload driver.\r
\r
--*/\r
\r
EFI_STATUS\r
EFIAPI\r
BsDataHubReportStatusCode (\r
  IN EFI_STATUS_CODE_TYPE     CodeType,\r
  IN EFI_STATUS_CODE_VALUE    Value,\r
  IN UINT32                   Instance,\r
  IN EFI_GUID                 * CallerId,\r
  IN EFI_STATUS_CODE_DATA     * Data OPTIONAL\r
  );\r
/*++\r
\r
Routine Description:\r
\r
  Boot service report status code listener.  This function logs the status code\r
  into the data hub.\r
\r
Arguments:\r
\r
  Same as gRT->ReportStatusCode (See Tiano Runtime Specification)\r
\r
Returns:\r
\r
  None\r
\r
--*/\r
\r
VOID\r
EFIAPI\r
LogDataHubEventHandler (\r
  IN  EFI_EVENT     Event,\r
  IN  VOID          *Context\r
  );\r
/*++\r
\r
Routine Description:\r
\r
  The Event handler which will be notified to log data in Data Hub.\r
\r
Arguments:\r
\r
  Event     -   Instance of the EFI_EVENT to signal whenever data is\r
                available to be logged in the system.\r
  Context   -   Context of the event.\r
\r
Returns:\r
\r
  None.\r
\r
--*/\r
#endif\r