2 Locate handle functions
4 Copyright (c) 2006 - 2008, Intel Corporation. <BR>
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18 // ProtocolRequest - Last LocateHandle request ID
20 UINTN mEfiLocateHandleRequest
= 0;
23 // Internal prototypes
30 PROTOCOL_ENTRY
*ProtEntry
;
36 IN OUT LOCATE_POSITION
*Position
,
41 Routine to get the next Handle, when you are searching for all handles.
43 @param Position Information about which Handle to seach for.
44 @param Interface Return the interface structure for the matching
47 @retval IHANDLE An IHANDLE is returned if the next Position is
48 not the end of the list. A NULL_HANDLE is
49 returned if it's the end of the list.
53 CoreGetNextLocateAllHandles (
54 IN OUT LOCATE_POSITION
*Position
,
59 Routine to get the next Handle, when you are searching for register protocol
62 @param Position Information about which Handle to seach for.
63 @param Interface Return the interface structure for the matching
66 @retval IHANDLE An IHANDLE is returned if the next Position is
67 not the end of the list. A NULL_HANDLE is
68 returned if it's the end of the list.
72 CoreGetNextLocateByRegisterNotify (
73 IN OUT LOCATE_POSITION
*Position
,
78 Routine to get the next Handle, when you are searching for a given protocol.
80 @param Position Information about which Handle to seach for.
81 @param Interface Return the interface structure for the matching
84 @retval IHANDLE An IHANDLE is returned if the next Position is
85 not the end of the list. A NULL_HANDLE is
86 returned if it's the end of the list.
90 CoreGetNextLocateByProtocol (
91 IN OUT LOCATE_POSITION
*Position
,
97 Locates the requested handle(s) and returns them in Buffer.
99 @param SearchType The type of search to perform to locate the
101 @param Protocol The protocol to search for
102 @param SearchKey Dependant on SearchType
103 @param BufferSize On input the size of Buffer. On output the
104 size of data returned.
105 @param Buffer The buffer to return the results in
107 @retval EFI_BUFFER_TOO_SMALL Buffer too small, required buffer size is
108 returned in BufferSize.
109 @retval EFI_INVALID_PARAMETER Invalid parameter
110 @retval EFI_SUCCESS Successfully found the requested handle(s) and
111 returns them in Buffer.
117 IN EFI_LOCATE_SEARCH_TYPE SearchType
,
118 IN EFI_GUID
*Protocol OPTIONAL
,
119 IN VOID
*SearchKey OPTIONAL
,
120 IN OUT UINTN
*BufferSize
,
121 OUT EFI_HANDLE
*Buffer
125 LOCATE_POSITION Position
;
126 PROTOCOL_NOTIFY
*ProtNotify
;
127 CORE_GET_NEXT GetNext
;
130 IHANDLE
**ResultBuffer
;
133 if (BufferSize
== NULL
) {
134 Status
= EFI_INVALID_PARAMETER
;
137 if ((*BufferSize
> 0) && (Buffer
== NULL
)) {
138 return EFI_INVALID_PARAMETER
;
144 // Set initial position
146 Position
.Protocol
= Protocol
;
147 Position
.SearchKey
= SearchKey
;
148 Position
.Position
= &gHandleList
;
151 ResultBuffer
= (IHANDLE
**) Buffer
;
152 Status
= EFI_SUCCESS
;
155 // Lock the protocol database
157 CoreAcquireProtocolLock ();
160 // Get the search function based on type
162 switch (SearchType
) {
164 GetNext
= CoreGetNextLocateAllHandles
;
167 case ByRegisterNotify
:
169 // Must have SearchKey for locate ByRegisterNotify
171 if (SearchKey
== NULL
) {
172 Status
= EFI_INVALID_PARAMETER
;
175 GetNext
= CoreGetNextLocateByRegisterNotify
;
179 GetNext
= CoreGetNextLocateByProtocol
;
180 if (Protocol
== NULL
) {
181 Status
= EFI_INVALID_PARAMETER
;
185 // Look up the protocol entry and set the head pointer
187 Position
.ProtEntry
= CoreFindProtocolEntry (Protocol
, FALSE
);
188 if (Position
.ProtEntry
== NULL
) {
189 Status
= EFI_NOT_FOUND
;
192 Position
.Position
= &Position
.ProtEntry
->Protocols
;
196 Status
= EFI_INVALID_PARAMETER
;
200 if (EFI_ERROR(Status
)) {
201 CoreReleaseProtocolLock ();
206 // Enumerate out the matching handles
208 mEfiLocateHandleRequest
+= 1;
211 // Get the next handle. If no more handles, stop
213 Handle
= GetNext (&Position
, &Interface
);
214 if (NULL
== Handle
) {
219 // Increase the resulting buffer size, and if this handle
222 ResultSize
+= sizeof(Handle
);
223 if (ResultSize
<= *BufferSize
) {
224 *ResultBuffer
= Handle
;
230 // If the result is a zero length buffer, then there were no
233 if (ResultSize
== 0) {
234 Status
= EFI_NOT_FOUND
;
237 // Return the resulting buffer size. If it's larger than what
238 // was passed, then set the error code
240 if (ResultSize
> *BufferSize
) {
241 Status
= EFI_BUFFER_TOO_SMALL
;
244 *BufferSize
= ResultSize
;
246 if (SearchType
== ByRegisterNotify
&& !EFI_ERROR(Status
)) {
248 // If this is a search by register notify and a handle was
249 // returned, update the register notification position
251 ProtNotify
= SearchKey
;
252 ProtNotify
->Position
= ProtNotify
->Position
->ForwardLink
;
256 CoreReleaseProtocolLock ();
263 Routine to get the next Handle, when you are searching for all handles.
265 @param Position Information about which Handle to seach for.
266 @param Interface Return the interface structure for the matching
269 @return An pointer to IHANDLE if the next Position is not the end of the list.
270 Otherwise,NULL_HANDLE is returned.
274 CoreGetNextLocateAllHandles (
275 IN OUT LOCATE_POSITION
*Position
,
284 Position
->Position
= Position
->Position
->ForwardLink
;
287 // If not at the end of the list, get the handle
289 Handle
= NULL_HANDLE
;
291 if (Position
->Position
!= &gHandleList
) {
292 Handle
= CR (Position
->Position
, IHANDLE
, AllHandles
, EFI_HANDLE_SIGNATURE
);
301 Routine to get the next Handle, when you are searching for register protocol
304 @param Position Information about which Handle to seach for.
305 @param Interface Return the interface structure for the matching
308 @return An pointer to IHANDLE if the next Position is not the end of the list.
309 Otherwise,NULL_HANDLE is returned.
313 CoreGetNextLocateByRegisterNotify (
314 IN OUT LOCATE_POSITION
*Position
,
319 PROTOCOL_NOTIFY
*ProtNotify
;
320 PROTOCOL_INTERFACE
*Prot
;
323 Handle
= NULL_HANDLE
;
325 ProtNotify
= Position
->SearchKey
;
328 // If this is the first request, get the next handle
330 if (ProtNotify
!= NULL
) {
331 ASSERT(ProtNotify
->Signature
== PROTOCOL_NOTIFY_SIGNATURE
);
332 Position
->SearchKey
= NULL
;
335 // If not at the end of the list, get the next handle
337 Link
= ProtNotify
->Position
->ForwardLink
;
338 if (Link
!= &ProtNotify
->Protocol
->Protocols
) {
339 Prot
= CR (Link
, PROTOCOL_INTERFACE
, ByProtocol
, PROTOCOL_INTERFACE_SIGNATURE
);
340 Handle
= (IHANDLE
*) Prot
->Handle
;
341 *Interface
= Prot
->Interface
;
350 Routine to get the next Handle, when you are searching for a given protocol.
352 @param Position Information about which Handle to seach for.
353 @param Interface Return the interface structure for the matching
356 @return An pointer to IHANDLE if the next Position is not the end of the list.
357 Otherwise,NULL_HANDLE is returned.
361 CoreGetNextLocateByProtocol (
362 IN OUT LOCATE_POSITION
*Position
,
368 PROTOCOL_INTERFACE
*Prot
;
370 Handle
= NULL_HANDLE
;
376 Link
= Position
->Position
->ForwardLink
;
377 Position
->Position
= Link
;
380 // If not at the end, return the handle
382 if (Link
== &Position
->ProtEntry
->Protocols
) {
383 Handle
= NULL_HANDLE
;
390 Prot
= CR(Link
, PROTOCOL_INTERFACE
, ByProtocol
, PROTOCOL_INTERFACE_SIGNATURE
);
391 Handle
= (IHANDLE
*) Prot
->Handle
;
392 *Interface
= Prot
->Interface
;
395 // If this handle has not been returned this request, then
398 if (Handle
->LocateRequest
!= mEfiLocateHandleRequest
) {
399 Handle
->LocateRequest
= mEfiLocateHandleRequest
;
409 Locates the handle to a device on the device path that best matches the specified protocol.
411 @param Protocol The protocol to search for.
412 @param DevicePath On input, a pointer to a pointer to the device
413 path. On output, the device path pointer is
414 modified to point to the remaining part of the
416 @param Device A pointer to the returned device handle.
418 @retval EFI_SUCCESS The resulting handle was returned.
419 @retval EFI_NOT_FOUND No handles matched the search.
420 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
425 CoreLocateDevicePath (
426 IN EFI_GUID
*Protocol
,
427 IN OUT EFI_DEVICE_PATH_PROTOCOL
**DevicePath
,
428 OUT EFI_HANDLE
*Device
439 EFI_DEVICE_PATH_PROTOCOL
*SourcePath
;
440 EFI_DEVICE_PATH_PROTOCOL
*TmpDevicePath
;
442 if (Protocol
== NULL
) {
443 return EFI_INVALID_PARAMETER
;
446 if ((DevicePath
== NULL
) || (*DevicePath
== NULL
)) {
447 return EFI_INVALID_PARAMETER
;
450 if (Device
== NULL
) {
451 return EFI_INVALID_PARAMETER
;
454 *Device
= NULL_HANDLE
;
455 SourcePath
= *DevicePath
;
456 SourceSize
= CoreDevicePathSize (SourcePath
) - sizeof(EFI_DEVICE_PATH_PROTOCOL
);
459 // The source path can only have 1 instance
461 if (CoreIsDevicePathMultiInstance (SourcePath
)) {
462 DEBUG((DEBUG_ERROR
, "LocateDevicePath: Device path has too many instances\n"));
463 return EFI_INVALID_PARAMETER
;
467 // Get a list of all handles that support the requested protocol
469 Status
= CoreLocateHandleBuffer (ByProtocol
, Protocol
, NULL
, &HandleCount
, &Handles
);
470 if (EFI_ERROR (Status
) || HandleCount
== 0) {
471 return EFI_NOT_FOUND
;
475 for(Index
= 0; Index
< HandleCount
; Index
+= 1) {
476 Handle
= Handles
[Index
];
477 Status
= CoreHandleProtocol (Handle
, &gEfiDevicePathProtocolGuid
, (VOID
**)&TmpDevicePath
);
478 if (EFI_ERROR (Status
)) {
480 // If this handle doesn't support device path, then skip it
486 // Check if DevicePath is first part of SourcePath
488 Size
= CoreDevicePathSize (TmpDevicePath
) - sizeof(EFI_DEVICE_PATH_PROTOCOL
);
489 if ((Size
<= SourceSize
) && CompareMem (SourcePath
, TmpDevicePath
, Size
) == 0) {
491 // If the size is equal to the best match, then we
492 // have a duplice device path for 2 different device
495 ASSERT (Size
!= BestMatch
);
498 // We've got a match, see if it's the best match so far
500 if (Size
> BestMatch
) {
507 CoreFreePool (Handles
);
510 // If there wasn't any match, then no parts of the device path was found.
511 // Which is strange since there is likely a "root level" device path in the system.
513 if (BestMatch
== -1) {
514 return EFI_NOT_FOUND
;
518 // Return the remaining part of the device path
520 *DevicePath
= (EFI_DEVICE_PATH_PROTOCOL
*) (((UINT8
*) SourcePath
) + BestMatch
);
526 Return the first Protocol Interface that matches the Protocol GUID. If
527 Registration is pasased in return a Protocol Instance that was just add
528 to the system. If Retistration is NULL return the first Protocol Interface
531 @param Protocol The protocol to search for
532 @param Registration Optional Registration Key returned from
533 RegisterProtocolNotify()
534 @param Interface Return the Protocol interface (instance).
536 @retval EFI_SUCCESS If a valid Interface is returned
537 @retval EFI_INVALID_PARAMETER Invalid parameter
538 @retval EFI_NOT_FOUND Protocol interface not found
544 IN EFI_GUID
*Protocol
,
545 IN VOID
*Registration OPTIONAL
,
550 LOCATE_POSITION Position
;
551 PROTOCOL_NOTIFY
*ProtNotify
;
554 if (Interface
== NULL
) {
555 return EFI_INVALID_PARAMETER
;
558 if (Protocol
== NULL
) {
559 return EFI_NOT_FOUND
;
563 Status
= EFI_SUCCESS
;
566 // Set initial position
568 Position
.Protocol
= Protocol
;
569 Position
.SearchKey
= Registration
;
570 Position
.Position
= &gHandleList
;
573 // Lock the protocol database
575 CoreAcquireProtocolLock ();
577 mEfiLocateHandleRequest
+= 1;
579 if (Registration
== NULL
) {
581 // Look up the protocol entry and set the head pointer
583 Position
.ProtEntry
= CoreFindProtocolEntry (Protocol
, FALSE
);
584 if (Position
.ProtEntry
== NULL
) {
585 Status
= EFI_NOT_FOUND
;
588 Position
.Position
= &Position
.ProtEntry
->Protocols
;
590 Handle
= CoreGetNextLocateByProtocol (&Position
, Interface
);
592 Handle
= CoreGetNextLocateByRegisterNotify (&Position
, Interface
);
595 if (Handle
== NULL
) {
596 Status
= EFI_NOT_FOUND
;
597 } else if (Registration
!= NULL
) {
599 // If this is a search by register notify and a handle was
600 // returned, update the register notification position
602 ProtNotify
= Registration
;
603 ProtNotify
->Position
= ProtNotify
->Position
->ForwardLink
;
607 CoreReleaseProtocolLock ();
613 Function returns an array of handles that support the requested protocol
614 in a buffer allocated from pool. This is a version of CoreLocateHandle()
615 that allocates a buffer for the caller.
617 @param SearchType Specifies which handle(s) are to be returned.
618 @param Protocol Provides the protocol to search by. This
619 parameter is only valid for SearchType
621 @param SearchKey Supplies the search key depending on the
623 @param NumberHandles The number of handles returned in Buffer.
624 @param Buffer A pointer to the buffer to return the requested
625 array of handles that support Protocol.
627 @retval EFI_SUCCESS The result array of handles was returned.
628 @retval EFI_NOT_FOUND No handles match the search.
629 @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the
631 @retval EFI_INVALID_PARAMETER One or more paramters are not valid.
636 CoreLocateHandleBuffer (
637 IN EFI_LOCATE_SEARCH_TYPE SearchType
,
638 IN EFI_GUID
*Protocol OPTIONAL
,
639 IN VOID
*SearchKey OPTIONAL
,
640 IN OUT UINTN
*NumberHandles
,
641 OUT EFI_HANDLE
**Buffer
647 if (NumberHandles
== NULL
) {
648 return EFI_INVALID_PARAMETER
;
651 if (Buffer
== NULL
) {
652 return EFI_INVALID_PARAMETER
;
658 Status
= CoreLocateHandle (
666 // LocateHandleBuffer() returns incorrect status code if SearchType is
669 // Add code to correctly handle expected errors from CoreLocateHandle().
671 if (EFI_ERROR(Status
) && Status
!= EFI_BUFFER_TOO_SMALL
) {
672 if (Status
!= EFI_INVALID_PARAMETER
) {
673 Status
= EFI_NOT_FOUND
;
678 *Buffer
= CoreAllocateBootServicesPool (BufferSize
);
679 if (*Buffer
== NULL
) {
680 return EFI_OUT_OF_RESOURCES
;
683 Status
= CoreLocateHandle (
691 *NumberHandles
= BufferSize
/ sizeof(EFI_HANDLE
);
692 if (EFI_ERROR(Status
)) {