Event.c revision 4fd606d1f5abe38e1f42c38de1d2e895166bd0f4
/** @file
UEFI Event support functions implemented in this file.
Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#include "DxeMain.h"
#include "Event.h"
///
/// gEfiCurrentTpl - Current Task priority level
///
///
/// gEventQueueLock - Protects the event queues
///
///
/// gEventQueue - A list of event's to notify for each priority level
///
///
/// gEventPending - A bitmask of the EventQueues that are pending
///
UINTN gEventPending = 0;
///
/// gEventSignalQueue - A list of events to signal based on EventGroup type
///
///
/// Enumerate the valid types
///
UINT32 mEventTable[] = {
///
/// 0x80000200 Timer event with a notification function that is
/// queue when the event is signaled with SignalEvent()
///
///
/// 0x80000000 Timer event without a notification function. It can be
/// signaled with SignalEvent() and checked with CheckEvent() or WaitForEvent().
///
///
/// 0x00000100 Generic event with a notification function that
/// can be waited on with CheckEvent() or WaitForEvent()
///
///
/// 0x00000200 Generic event with a notification function that
/// is queue when the event is signaled with SignalEvent()
///
///
/// 0x00000201 ExitBootServicesEvent.
///
///
/// 0x60000202 SetVirtualAddressMapEvent.
///
///
/// 0x00000000 Generic event without a notification function.
/// It can be signaled with SignalEvent() and checked with CheckEvent()
/// or WaitForEvent().
///
0x00000000,
///
/// 0x80000100 Timer event with a notification function that can be
/// waited on with CheckEvent() or WaitForEvent()
///
};
///
/// gIdleLoopEvent - Event which is signalled when the core is idle
///
/**
Enter critical section by acquiring the lock on gEventQueueLock.
**/
)
{
}
/**
Exit critical section by releasing the lock on gEventQueueLock.
**/
)
{
}
/**
Initializes "event" support.
@retval EFI_SUCCESS Always return success
**/
)
{
}
NULL,
);
return EFI_SUCCESS;
}
/**
Dispatches all pending events.
@param Priority The task priority level of event notifications
to dispatch
**/
)
{
//
// Dispatch all the pending notifications
//
while (!IsListEmpty (Head)) {
//
// Only clear the SIGNAL status if it is a SIGNAL type event.
// WAIT type events are only cleared in CheckEvent()
//
Event->SignalCount = 0;
}
//
// Notify this event
//
//
// Check for next pending event
//
}
}
/**
Queues the event's notification function to fire.
@param Event The Event to notify
**/
)
{
//
// Event database must be locked
//
//
// If the event is queued somewhere, remove it
//
}
//
// Queue the event to the pending notification list
//
}
/**
Signals all events in the EventGroup.
@param EventGroup The list to signal
**/
)
{
}
}
}
/**
Creates an event.
@param Type The type of event to create and its mode and
attributes
@param NotifyTpl The task priority level of event notifications
@param NotifyFunction Pointer to the events notification function
@param NotifyContext Pointer to the notification functions context;
corresponds to parameter "Context" in the
notification function
@param Event Pointer to the newly created event if the call
succeeds; undefined otherwise
@retval EFI_SUCCESS The event structure was created
@retval EFI_INVALID_PARAMETER One of the parameters has an invalid value
@retval EFI_OUT_OF_RESOURCES The event could not be allocated
**/
)
{
}
/**
Creates an event in a group.
@param Type The type of event to create and its mode and
attributes
@param NotifyTpl The task priority level of event notifications
@param NotifyFunction Pointer to the events notification function
@param NotifyContext Pointer to the notification functions context;
corresponds to parameter "Context" in the
notification function
@param EventGroup GUID for EventGroup if NULL act the same as
gBS->CreateEvent().
@param Event Pointer to the newly created event if the call
succeeds; undefined otherwise
@retval EFI_SUCCESS The event structure was created
@retval EFI_INVALID_PARAMETER One of the parameters has an invalid value
@retval EFI_OUT_OF_RESOURCES The event could not be allocated
**/
)
{
//
// If it's a notify type of event, check for invalid NotifyTpl
//
if (NotifyTpl != TPL_APPLICATION &&
NotifyTpl != TPL_CALLBACK &&
NotifyTpl != TPL_NOTIFY) {
return EFI_INVALID_PARAMETER;
}
}
}
/**
Creates a general-purpose event structure
@param Type The type of event to create and its mode and
attributes
@param NotifyTpl The task priority level of event notifications
@param NotifyFunction Pointer to the events notification function
@param NotifyContext Pointer to the notification functions context;
corresponds to parameter "Context" in the
notification function
@param EventGroup GUID for EventGroup if NULL act the same as
gBS->CreateEvent().
@param Event Pointer to the newly created event if the call
succeeds; undefined otherwise
@retval EFI_SUCCESS The event structure was created
@retval EFI_INVALID_PARAMETER One of the parameters has an invalid value
@retval EFI_OUT_OF_RESOURCES The event could not be allocated
**/
)
{
return EFI_INVALID_PARAMETER;
}
//
// Check to make sure no reserved flags are set
//
break;
}
}
return EFI_INVALID_PARAMETER;
}
//
// Convert Event type for pre-defined Event groups
//
if (EventGroup != NULL) {
//
// For event group, type EVT_SIGNAL_EXIT_BOOT_SERVICES and EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE
// are not valid
//
return EFI_INVALID_PARAMETER;
}
}
} else {
//
// Convert EFI 1.10 Events to their UEFI 2.0 CreateEventEx mapping
//
if (Type == EVT_SIGNAL_EXIT_BOOT_SERVICES) {
} else if (Type == EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE) {
}
}
//
// If it's a notify type of event, check its parameters
//
//
// Check for an invalid NotifyFunction or NotifyTpl
//
if ((NotifyFunction == NULL) ||
(NotifyTpl <= TPL_APPLICATION) ||
(NotifyTpl >= TPL_HIGH_LEVEL)) {
return EFI_INVALID_PARAMETER;
}
} else {
//
// No notification needed, zero ignored values
//
NotifyTpl = 0;
}
//
// Allocate and initialize a new event structure.
//
if ((Type & EVT_RUNTIME) != 0) {
} else {
}
return EFI_OUT_OF_RESOURCES;
}
if (EventGroup != NULL) {
}
if ((Type & EVT_RUNTIME) != 0) {
//
// Keep a list of all RT events so we can tell the RT AP.
//
}
//
// The Event's NotifyFunction must be queued whenever the event is signaled
//
}
//
// Done
//
return EFI_SUCCESS;
}
/**
Signals the event. Queues the event to be notified if needed.
@param UserEvent The event to signal .
@retval EFI_INVALID_PARAMETER Parameters are not valid.
@retval EFI_SUCCESS The event was signaled.
**/
)
{
return EFI_INVALID_PARAMETER;
}
return EFI_INVALID_PARAMETER;
}
//
// If the event is not already signalled, do so
//
Event->SignalCount++;
//
// If signalling type is a notify function, queue it
//
//
// The CreateEventEx() style requires all members of the Event Group
// to be signaled.
//
} else {
}
}
}
return EFI_SUCCESS;
}
/**
Check the status of an event.
@param UserEvent The event to check
@retval EFI_SUCCESS The event is in the signaled state
@retval EFI_NOT_READY The event is not in the signaled state
@retval EFI_INVALID_PARAMETER Event is of type EVT_NOTIFY_SIGNAL
**/
)
{
return EFI_INVALID_PARAMETER;
}
return EFI_INVALID_PARAMETER;
}
return EFI_INVALID_PARAMETER;
}
//
// Queue the wait notify function
//
if (Event->SignalCount == 0) {
}
}
//
// If the even looks signalled, get the lock and clear it
//
if (Event->SignalCount != 0) {
if (Event->SignalCount != 0) {
Event->SignalCount = 0;
}
}
return Status;
}
/**
Stops execution until an event is signaled.
@param NumberOfEvents The number of events in the UserEvents array
@param UserEvents An array of EFI_EVENT
@param UserIndex Pointer to the index of the event which
satisfied the wait condition
@retval EFI_SUCCESS The event indicated by Index was signaled.
@retval EFI_INVALID_PARAMETER The event indicated by Index has a notification
function or Event was not a valid type
@retval EFI_UNSUPPORTED The current TPL is not TPL_APPLICATION
**/
)
{
//
// Can only WaitForEvent at TPL_APPLICATION
//
if (gEfiCurrentTpl != TPL_APPLICATION) {
return EFI_UNSUPPORTED;
}
for(;;) {
//
// provide index of event that caused problem
//
if (Status != EFI_NOT_READY) {
return Status;
}
}
//
// Signal the Idle event
//
}
}
/**
Closes an event and frees the event structure.
@param UserEvent Event to close
@retval EFI_INVALID_PARAMETER Parameters are not valid.
@retval EFI_SUCCESS The event has been closed
**/
)
{
return EFI_INVALID_PARAMETER;
}
return EFI_INVALID_PARAMETER;
}
//
// If it's a timer event, make sure it's not pending
//
}
//
// If the event is queued somewhere, remove it
//
}
}
}
//
// If the event is registered on a protocol notify, then remove it from the protocol database
//
return Status;
}