diff options
Diffstat (limited to 'MdeModulePkg/Core/Dxe/hand.h')
| -rw-r--r-- | MdeModulePkg/Core/Dxe/hand.h | 205 |
1 files changed, 68 insertions, 137 deletions
diff --git a/MdeModulePkg/Core/Dxe/hand.h b/MdeModulePkg/Core/Dxe/hand.h index 98669de..e52b7e3 100644 --- a/MdeModulePkg/Core/Dxe/hand.h +++ b/MdeModulePkg/Core/Dxe/hand.h @@ -100,220 +100,151 @@ typedef struct { //
-PROTOCOL_ENTRY *
-CoreFindProtocolEntry (
- IN EFI_GUID *Protocol,
- IN BOOLEAN Create
- )
-/*++
-
-Routine Description:
+/**
Finds the protocol entry for the requested protocol.
-
The gProtocolDatabaseLock must be owned
-Arguments:
-
- Protocol - The ID of the protocol
+ @param Protocol The ID of the protocol
+ @param Create Create a new entry if not found
+
+ @return Protocol entry
- Create - Create a new entry if not found
+**/
+PROTOCOL_ENTRY *
+CoreFindProtocolEntry (
+ IN EFI_GUID *Protocol,
+ IN BOOLEAN Create
+ )
+;
-Returns:
- Protocol entry
+/**
+ Signal event for every protocol in protocol entry.
---*/
-;
+ @param ProtEntry Protocol entry
+**/
VOID
CoreNotifyProtocolEntry (
IN PROTOCOL_ENTRY *ProtEntry
)
-/*++
-
-Routine Description:
-
- Signal event for every protocol in protocol entry.
+;
-Arguments:
- ProtEntry - Protocol entry
+/**
+ 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.
-Returns:
+ @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
)
-/*++
-
-Routine Description:
-
- 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.
-
-Arguments:
-
- Handle - The handle to search the protocol on
-
- Protocol - GUID of the protocol
+;
- Interface - The interface for the protocol being searched
-Returns:
+/**
+ Removes Protocol from the protocol list (but not the handle list).
- Protocol instance (NULL: Not found)
+ @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
)
-/*++
-
-Routine Description:
-
- Removes Protocol from the protocol list (but not the handle list).
-
-Arguments:
-
- Handle - The handle to remove protocol on.
-
- Protocol - GUID of the protocol to be moved
+;
- Interface - The interface of the protocol
-Returns:
+/**
+ Removes all the events in the protocol database that match Event.
- Protocol Entry
+ @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
)
-/*++
-
-Routine Description:
-
- Removes all the events in the protocol database that match Event.
+;
-Arguments:
-
- Event - The event to search for in the protocol database.
-Returns:
+/**
+ 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.
- EFI_SUCCESS when done searching the entire database.
+ @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
)
-/*++
-
-Routine Description:
-
- 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.
-
-Arguments:
-
- UserHandle - The handle on which the protocol is installed
- Prot - The protocol to disconnect drivers from
-
-Returns:
+;
- EFI_SUCCESS - Drivers using the protocol interface are all disconnected
- EFI_ACCESS_DENIED - Failed to disconnect one or all of the drivers
---*/
-;
+/**
+ Acquire lock on gProtocolDatabaseLock.
+**/
VOID
CoreAcquireProtocolLock (
VOID
)
-/*++
-
-Routine Description:
-
- Acquire lock on gProtocolDatabaseLock.
-
-Arguments:
-
- None
-
-Returns:
+;
- None
---*/
-;
+/**
+ Release lock on gProtocolDatabaseLock.
+**/
VOID
CoreReleaseProtocolLock (
VOID
)
-/*++
+;
-Routine Description:
- Release lock on gProtocolDatabaseLock.
-
-Arguments:
+/**
+ Check whether a handle is a valid EFI_HANDLE
- None
-
-Returns:
+ @param UserHandle The handle to check
- None
-
---*/
-;
+ @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
)
-/*++
-
-Routine Description:
-
- Check whether a handle is a valid EFI_HANDLE
-
-Arguments:
-
- UserHandle - The handle to check
-
-Returns:
-
- EFI_INVALID_PARAMETER - The handle is NULL or not a valid EFI_HANDLE.
-
- EFI_SUCCESS - The handle is valid EFI_HANDLE.
-
---*/
;
//
|