Getdriver(), Prototype, Parameters – Intel Extensible Firmware Interface User Manual

Page 274: Description, Status codes returned

Advertising
background image

Extensible Firmware Interface Specification

9-32

12/01/02

Version 1.10

EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL.GetDriver()

Summary

Uses a bus specific algorithm to retrieve a driver image handle for a controller.

Prototype

typedef
EFI_STATUS
(EFIAPI *EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_GET_DRIVER) (
IN EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL

*This,

IN OUT EFI_HANDLE

*DriverImageHandle

);

Parameters

This

A pointer to the

EFI_BUS_SPECIFIC_DRIVER_

OVERRIDE_PROTOCOL

instance.

DriverImageHandle

On input, a pointer to the previous driver image handle returned
by

GetDriver()

. On output, a pointer to the next driver

image handle. Passing in a

NULL

, will return the first driver

image handle.

Description

This function is used to retrieve a driver image handle that is selected in a bus specific manner. The
first driver image handle is retrieved by passing in a

DriverImageHandle

value of

NULL

. This

will cause the first driver image handle to be returned in

DriverImageHandle

. On each

successive call, the previous value of

DriverImageHandle

must be passed in. If a call to this

function returns a valid driver image handle, then

EFI_SUCCESS

is returned. This process is

repeated until

EFI_NOT_FOUND

is returned. If a

DriverImageHandle

is passed in that was

not returned on a prior call to this function, then

EFI_INVALID_PARAMETER

is returned. The

first driver image handle has the highest precedence, and the last driver image handle has the lowest
precedence. This ordered list of driver image handles is used by the boot service

ConnectController()

to search for the best driver for a controller.

Status Codes Returned

EFI_SUCCESS

A bus specific override driver is returned in

DriverImageHandle

.

EFI_NOT_FOUND

The end of the list of override drivers was reached. A bus specific
override driver is not returned in

DriverImageHandle

.

EFI_INVALID_PARAMETER

DriverImageHandle

is not a handle that was returned on a

previous call to

GetDriver

()

.

Advertising