DriverBinding.h File Reference

UEFI DriverBinding Protocol is defined in UEFI specification. More...

#include <gpxe/efi/Protocol/DevicePath.h>

Go to the source code of this file.

Data Structures

struct  _EFI_DRIVER_BINDING_PROTOCOL
 This protocol provides the services required to determine if a driver supports a given controller. More...

Defines

#define EFI_DRIVER_BINDING_PROTOCOL_GUID
 Global ID for the ControllerHandle Driver Protocol.

Typedefs

typedef struct
_EFI_DRIVER_BINDING_PROTOCOL 
EFI_DRIVER_BINDING_PROTOCOL
typedef EFI_STATUS(EFIAPI * EFI_DRIVER_BINDING_SUPPORTED )(IN EFI_DRIVER_BINDING_PROTOCOL *This, IN EFI_HANDLE ControllerHandle, IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL)
 Test to see if this driver supports ControllerHandle.
typedef EFI_STATUS(EFIAPI * EFI_DRIVER_BINDING_START )(IN EFI_DRIVER_BINDING_PROTOCOL *This, IN EFI_HANDLE ControllerHandle, IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL)
 Start this driver on ControllerHandle.
typedef EFI_STATUS(EFIAPI * EFI_DRIVER_BINDING_STOP )(IN EFI_DRIVER_BINDING_PROTOCOL *This, IN EFI_HANDLE ControllerHandle, IN UINTN NumberOfChildren, IN EFI_HANDLE *ChildHandleBuffer OPTIONAL)
 Stop this driver on ControllerHandle.

Variables

EFI_GUID gEfiDriverBindingProtocolGuid


Detailed Description

UEFI DriverBinding Protocol is defined in UEFI specification.

This protocol is produced by every driver that follows the UEFI Driver Model, and it is the central component that allows drivers and controllers to be managed.

Copyright (c) 2006 - 2008, Intel Corporation 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.

Definition in file DriverBinding.h.


Define Documentation

#define EFI_DRIVER_BINDING_PROTOCOL_GUID

Value:

{ \
    0x18a031ab, 0xb443, 0x4d1a, {0xa5, 0xc0, 0xc, 0x9, 0x26, 0x1e, 0x9f, 0x71 } \
  }
Global ID for the ControllerHandle Driver Protocol.

Definition at line 25 of file DriverBinding.h.


Typedef Documentation

Definition at line 30 of file DriverBinding.h.

typedef EFI_STATUS(EFIAPI * EFI_DRIVER_BINDING_SUPPORTED)(IN EFI_DRIVER_BINDING_PROTOCOL *This, IN EFI_HANDLE ControllerHandle, IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL)

Test to see if this driver supports ControllerHandle.

This service is called by the EFI boot service ConnectController(). In order to make drivers as small as possible, there are a few calling restrictions for this service. ConnectController() must follow these calling restrictions. If any other agent wishes to call Supported() it must also follow these calling restrictions.

Parameters:
This Protocol instance pointer.
ControllerHandle Handle of device to test
RemainingDevicePath Optional parameter use to pick a specific child device to start.
Return values:
EFI_SUCCESS This driver supports this device
EFI_ALREADY_STARTED This driver is already running on this device
other This driver does not support this device

Definition at line 52 of file DriverBinding.h.

typedef EFI_STATUS(EFIAPI * EFI_DRIVER_BINDING_START)(IN EFI_DRIVER_BINDING_PROTOCOL *This, IN EFI_HANDLE ControllerHandle, IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL)

Start this driver on ControllerHandle.

This service is called by the EFI boot service ConnectController(). In order to make drivers as small as possible, there are a few calling restrictions for this service. ConnectController() must follow these calling restrictions. If any other agent wishes to call Start() it must also follow these calling restrictions.

Parameters:
This Protocol instance pointer.
ControllerHandle Handle of device to bind driver to
RemainingDevicePath Optional parameter use to pick a specific child device to start.
Return values:
EFI_SUCCESS This driver is added to ControllerHandle
EFI_ALREADY_STARTED This driver is already running on ControllerHandle
other This driver does not support this device

Definition at line 78 of file DriverBinding.h.

typedef EFI_STATUS(EFIAPI * EFI_DRIVER_BINDING_STOP)(IN EFI_DRIVER_BINDING_PROTOCOL *This, IN EFI_HANDLE ControllerHandle, IN UINTN NumberOfChildren, IN EFI_HANDLE *ChildHandleBuffer OPTIONAL)

Stop this driver on ControllerHandle.

This service is called by the EFI boot service DisconnectController(). In order to make drivers as small as possible, there are a few calling restrictions for this service. DisconnectController() must follow these calling restrictions. If any other agent wishes to call Stop() it must also follow these calling restrictions.

Parameters:
This Protocol instance pointer.
ControllerHandle Handle of device to stop driver on
NumberOfChildren Number of Handles in ChildHandleBuffer. If number of children is zero stop the entire bus driver.
ChildHandleBuffer List of Child Handles to Stop.
Return values:
EFI_SUCCESS This driver is removed ControllerHandle
other This driver was not removed from this device

Definition at line 104 of file DriverBinding.h.


Variable Documentation


Generated on Tue Apr 6 20:01:49 2010 for gPXE by  doxygen 1.5.7.1