MdeModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdeModulePkg / Core / Dxe / Event / Event.h

/** @file\r
  UEFI Event support functions and structure.\r
\r
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
(C) Copyright 2015 Hewlett Packard Enterprise Development LP<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef __EVENT_H__\r
#define __EVENT_H__\r
\r
\r
#define VALID_TPL(a)            ((a) <= TPL_HIGH_LEVEL)\r
extern  UINTN                   gEventPending;\r
\r
///\r
/// Set if Event is part of an event group\r
///\r
#define EVT_EXFLAG_EVENT_GROUP                    0x01\r
///\r
/// Set if Event is registered on a protocol notify\r
///\r
#define EVT_EXFLAG_EVENT_PROTOCOL_NOTIFICATION    0x02\r
\r
//\r
// EFI_EVENT\r
//\r
\r
///\r
/// Timer event information\r
///\r
typedef struct {\r
  LIST_ENTRY      Link;\r
  UINT64          TriggerTime;\r
  UINT64          Period;\r
} TIMER_EVENT_INFO;\r
\r
#define EVENT_SIGNATURE         SIGNATURE_32('e','v','n','t')\r
typedef struct {\r
  UINTN                   Signature;\r
  UINT32                  Type;\r
  UINT32                  SignalCount;\r
  ///\r
  /// Entry if the event is registered to be signalled\r
  ///\r
  LIST_ENTRY              SignalLink;\r
  ///\r
  /// Notification information for this event\r
  ///\r
  EFI_TPL                 NotifyTpl;\r
  EFI_EVENT_NOTIFY        NotifyFunction;\r
  VOID                    *NotifyContext;\r
  EFI_GUID                EventGroup;\r
  LIST_ENTRY              NotifyLink;\r
  UINT8                   ExFlag;\r
  ///\r
  /// A list of all runtime events\r
  ///\r
  EFI_RUNTIME_EVENT_ENTRY RuntimeData;\r
  TIMER_EVENT_INFO        Timer;\r
} IEVENT;\r
\r
//\r
// Internal prototypes\r
//\r
\r
\r
/**\r
  Dispatches all pending events.\r
\r
  @param  Priority               The task priority level of event notifications\r
                                 to dispatch\r
\r
**/\r
VOID\r
CoreDispatchEventNotifies (\r
  IN EFI_TPL      Priority\r
  );\r
\r
\r
/**\r
  Initializes timer support.\r
\r
**/\r
VOID\r
CoreInitializeTimer (\r
  VOID\r
  );\r
\r
#endif\r