mirror of https://github.com/acidanthera/audk.git
274 lines
8.3 KiB
C
274 lines
8.3 KiB
C
/** @file
|
|
Support functions for managing protocol.
|
|
|
|
Copyright (c) 2006 - 2008, Intel Corporation. <BR>
|
|
All rights reserved. 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
|
|
http://opensource.org/licenses/bsd-license.php
|
|
|
|
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
|
|
|
**/
|
|
|
|
#ifndef _HAND_H_
|
|
#define _HAND_H_
|
|
|
|
|
|
//
|
|
// IHANDLE - contains a list of protocol handles
|
|
//
|
|
|
|
#define EFI_HANDLE_SIGNATURE EFI_SIGNATURE_32('h','n','d','l')
|
|
typedef struct {
|
|
UINTN Signature;
|
|
LIST_ENTRY AllHandles; // All handles list of IHANDLE
|
|
LIST_ENTRY Protocols; // List of PROTOCOL_INTERFACE's for this handle
|
|
UINTN LocateRequest; //
|
|
UINT64 Key; // The Handle Database Key value when this handle was last created or modified
|
|
} IHANDLE;
|
|
|
|
#define ASSERT_IS_HANDLE(a) ASSERT((a)->Signature == EFI_HANDLE_SIGNATURE)
|
|
|
|
|
|
//
|
|
// PROTOCOL_ENTRY - each different protocol has 1 entry in the protocol
|
|
// database. Each handler that supports this protocol is listed, along
|
|
// with a list of registered notifies.
|
|
//
|
|
|
|
#define PROTOCOL_ENTRY_SIGNATURE EFI_SIGNATURE_32('p','r','t','e')
|
|
typedef struct {
|
|
UINTN Signature;
|
|
LIST_ENTRY AllEntries; // Link Entry inserted to mProtocolDatabase
|
|
EFI_GUID ProtocolID; // ID of the protocol
|
|
LIST_ENTRY Protocols; // All protocol interfaces
|
|
LIST_ENTRY Notify; // Registerd notification handlers
|
|
} PROTOCOL_ENTRY;
|
|
|
|
//
|
|
// PROTOCOL_INTERFACE - each protocol installed on a handle is tracked
|
|
// with a protocol interface structure
|
|
//
|
|
|
|
#define PROTOCOL_INTERFACE_SIGNATURE EFI_SIGNATURE_32('p','i','f','c')
|
|
typedef struct {
|
|
UINTN Signature;
|
|
LIST_ENTRY Link; // Link on IHANDLE.Protocols
|
|
IHANDLE *Handle; // Back pointer
|
|
LIST_ENTRY ByProtocol; // Link on PROTOCOL_ENTRY.Protocols
|
|
PROTOCOL_ENTRY *Protocol; // The protocol ID
|
|
VOID *Interface; // The interface value
|
|
|
|
LIST_ENTRY OpenList; // OPEN_PROTOCOL_DATA list.
|
|
UINTN OpenListCount;
|
|
|
|
} PROTOCOL_INTERFACE;
|
|
|
|
#define OPEN_PROTOCOL_DATA_SIGNATURE EFI_SIGNATURE_32('p','o','d','l')
|
|
|
|
typedef struct {
|
|
UINTN Signature;
|
|
LIST_ENTRY Link; //Link on PROTOCOL_INTERFACE.OpenList
|
|
|
|
EFI_HANDLE AgentHandle;
|
|
EFI_HANDLE ControllerHandle;
|
|
UINT32 Attributes;
|
|
UINT32 OpenCount;
|
|
} OPEN_PROTOCOL_DATA;
|
|
|
|
|
|
//
|
|
// PROTOCOL_NOTIFY - used for each register notification for a protocol
|
|
//
|
|
|
|
#define PROTOCOL_NOTIFY_SIGNATURE EFI_SIGNATURE_32('p','r','t','n')
|
|
typedef struct {
|
|
UINTN Signature;
|
|
PROTOCOL_ENTRY *Protocol;
|
|
LIST_ENTRY Link; // All notifications for this protocol
|
|
EFI_EVENT Event; // Event to notify
|
|
LIST_ENTRY *Position; // Last position notified
|
|
} PROTOCOL_NOTIFY;
|
|
|
|
//
|
|
// Internal prototypes
|
|
//
|
|
|
|
|
|
|
|
/**
|
|
Finds the protocol entry for the requested protocol.
|
|
The gProtocolDatabaseLock must be owned
|
|
|
|
@param Protocol The ID of the protocol
|
|
@param Create Create a new entry if not found
|
|
|
|
@return Protocol entry
|
|
|
|
**/
|
|
PROTOCOL_ENTRY *
|
|
CoreFindProtocolEntry (
|
|
IN EFI_GUID *Protocol,
|
|
IN BOOLEAN Create
|
|
);
|
|
|
|
|
|
/**
|
|
Signal event for every protocol in protocol entry.
|
|
|
|
@param ProtEntry Protocol entry
|
|
|
|
**/
|
|
VOID
|
|
CoreNotifyProtocolEntry (
|
|
IN PROTOCOL_ENTRY *ProtEntry
|
|
);
|
|
|
|
|
|
/**
|
|
Finds the protocol instance for the requested handle and protocol.
|
|
Note: This function doesn't do parameters checking, it's caller's responsibility
|
|
to pass in valid parameters.
|
|
|
|
@param Handle The handle to search the protocol on
|
|
@param Protocol GUID of the protocol
|
|
@param Interface The interface for the protocol being searched
|
|
|
|
@return Protocol instance (NULL: Not found)
|
|
|
|
**/
|
|
PROTOCOL_INTERFACE *
|
|
CoreFindProtocolInterface (
|
|
IN IHANDLE *Handle,
|
|
IN EFI_GUID *Protocol,
|
|
IN VOID *Interface
|
|
);
|
|
|
|
|
|
/**
|
|
Removes Protocol from the protocol list (but not the handle list).
|
|
|
|
@param Handle The handle to remove protocol on.
|
|
@param Protocol GUID of the protocol to be moved
|
|
@param Interface The interface of the protocol
|
|
|
|
@return Protocol Entry
|
|
|
|
**/
|
|
PROTOCOL_INTERFACE *
|
|
CoreRemoveInterfaceFromProtocol (
|
|
IN IHANDLE *Handle,
|
|
IN EFI_GUID *Protocol,
|
|
IN VOID *Interface
|
|
);
|
|
|
|
|
|
/**
|
|
Removes all the events in the protocol database that match Event.
|
|
|
|
@param Event The event to search for in the protocol
|
|
database.
|
|
|
|
@return EFI_SUCCESS when done searching the entire database.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
CoreUnregisterProtocolNotify (
|
|
IN EFI_EVENT Event
|
|
);
|
|
|
|
/**
|
|
Connects a controller to a driver.
|
|
|
|
@param ControllerHandle Handle of the controller to be
|
|
connected.
|
|
@param ContextDriverImageHandles DriverImageHandle A pointer to an
|
|
ordered list of driver image
|
|
handles.
|
|
@param RemainingDevicePath RemainingDevicePath A pointer to
|
|
the device path that specifies a
|
|
child of the controller
|
|
specified by ControllerHandle.
|
|
|
|
@retval EFI_SUCCESS One or more drivers were
|
|
connected to ControllerHandle.
|
|
@retval EFI_OUT_OF_RESOURCES No enough system resources to
|
|
complete the request.
|
|
@retval EFI_NOT_FOUND No drivers were connected to
|
|
ControllerHandle.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
CoreConnectSingleController (
|
|
IN EFI_HANDLE ControllerHandle,
|
|
IN EFI_HANDLE *ContextDriverImageHandles OPTIONAL,
|
|
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL
|
|
);
|
|
|
|
/**
|
|
Attempts to disconnect all drivers that are using the protocol interface being queried.
|
|
If failed, reconnect all drivers disconnected.
|
|
Note: This function doesn't do parameters checking, it's caller's responsibility
|
|
to pass in valid parameters.
|
|
|
|
@param UserHandle The handle on which the protocol is installed
|
|
@param Prot The protocol to disconnect drivers from
|
|
|
|
@retval EFI_SUCCESS Drivers using the protocol interface are all
|
|
disconnected
|
|
@retval EFI_ACCESS_DENIED Failed to disconnect one or all of the drivers
|
|
|
|
**/
|
|
EFI_STATUS
|
|
CoreDisconnectControllersUsingProtocolInterface (
|
|
IN EFI_HANDLE UserHandle,
|
|
IN PROTOCOL_INTERFACE *Prot
|
|
);
|
|
|
|
|
|
/**
|
|
Acquire lock on gProtocolDatabaseLock.
|
|
|
|
**/
|
|
VOID
|
|
CoreAcquireProtocolLock (
|
|
VOID
|
|
);
|
|
|
|
|
|
/**
|
|
Release lock on gProtocolDatabaseLock.
|
|
|
|
**/
|
|
VOID
|
|
CoreReleaseProtocolLock (
|
|
VOID
|
|
);
|
|
|
|
|
|
/**
|
|
Check whether a handle is a valid EFI_HANDLE
|
|
|
|
@param UserHandle The handle to check
|
|
|
|
@retval EFI_INVALID_PARAMETER The handle is NULL or not a valid EFI_HANDLE.
|
|
@retval EFI_SUCCESS The handle is valid EFI_HANDLE.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
CoreValidateHandle (
|
|
IN EFI_HANDLE UserHandle
|
|
);
|
|
|
|
//
|
|
// Externs
|
|
//
|
|
|
|
extern EFI_LOCK gProtocolDatabaseLock;
|
|
extern LIST_ENTRY gHandleList;
|
|
extern UINT64 gHandleDatabaseKey;
|
|
|
|
#endif
|