Udp4Driver.h revision 4fd606d1f5abe38e1f42c38de1d2e895166bd0f4
074e084f68dd0b08686612bec695a0cfe249da6dml/** @file
074e084f68dd0b08686612bec695a0cfe249da6dml
074e084f68dd0b08686612bec695a0cfe249da6dmlCopyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
074e084f68dd0b08686612bec695a0cfe249da6dmlThis program and the accompanying materials
074e084f68dd0b08686612bec695a0cfe249da6dmlare licensed and made available under the terms and conditions of the BSD License
074e084f68dd0b08686612bec695a0cfe249da6dmlwhich accompanies this distribution. The full text of the license may be found at
074e084f68dd0b08686612bec695a0cfe249da6dmlhttp://opensource.org/licenses/bsd-license.php
074e084f68dd0b08686612bec695a0cfe249da6dml
074e084f68dd0b08686612bec695a0cfe249da6dmlTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
074e084f68dd0b08686612bec695a0cfe249da6dmlWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
074e084f68dd0b08686612bec695a0cfe249da6dml
074e084f68dd0b08686612bec695a0cfe249da6dml**/
074e084f68dd0b08686612bec695a0cfe249da6dml
074e084f68dd0b08686612bec695a0cfe249da6dml#ifndef _UDP4_DRIVER_H_
074e084f68dd0b08686612bec695a0cfe249da6dml#define _UDP4_DRIVER_H_
074e084f68dd0b08686612bec695a0cfe249da6dml
074e084f68dd0b08686612bec695a0cfe249da6dml#include <Uefi.h>
074e084f68dd0b08686612bec695a0cfe249da6dml#include <Library/BaseLib.h>
074e084f68dd0b08686612bec695a0cfe249da6dml#include <Library/NetLib.h>
074e084f68dd0b08686612bec695a0cfe249da6dml#include <Protocol/DriverBinding.h>
074e084f68dd0b08686612bec695a0cfe249da6dml#include <Protocol/ServiceBinding.h>
074e084f68dd0b08686612bec695a0cfe249da6dml
074e084f68dd0b08686612bec695a0cfe249da6dml/**
074e084f68dd0b08686612bec695a0cfe249da6dml Test to see if this driver supports ControllerHandle. This service
074e084f68dd0b08686612bec695a0cfe249da6dml is called by the EFI boot service ConnectController(). In
074e084f68dd0b08686612bec695a0cfe249da6dml order to make drivers as small as possible, there are a few calling
074e084f68dd0b08686612bec695a0cfe249da6dml restrictions for this service. ConnectController() must
074e084f68dd0b08686612bec695a0cfe249da6dml follow these calling restrictions. If any other agent wishes to call
074e084f68dd0b08686612bec695a0cfe249da6dml Supported() it must also follow these calling restrictions.
074e084f68dd0b08686612bec695a0cfe249da6dml
074e084f68dd0b08686612bec695a0cfe249da6dml @param[in] This Protocol instance pointer.
074e084f68dd0b08686612bec695a0cfe249da6dml @param[in] ControllerHandle Handle of device to test
074e084f68dd0b08686612bec695a0cfe249da6dml @param[in] RemainingDevicePath Optional parameter use to pick a specific child
074e084f68dd0b08686612bec695a0cfe249da6dml device to start.
074e084f68dd0b08686612bec695a0cfe249da6dml
074e084f68dd0b08686612bec695a0cfe249da6dml @retval EFI_SUCCESS This driver supports this device
@retval EFI_ALREADY_STARTED This driver is already running on this device
@retval other This driver does not support this device
**/
EFI_STATUS
EFIAPI
Udp4DriverBindingSupported (
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.
@param[in] This Protocol instance pointer.
@param[in] ControllerHandle Handle of device to bind driver to
@param[in] RemainingDevicePath Optional parameter use to pick a specific child
device to start.
@retval EFI_SUCCESS This driver is added to ControllerHandle
@retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle
@retval other This driver does not support this device
**/
EFI_STATUS
EFIAPI
Udp4DriverBindingStart (
IN EFI_DRIVER_BINDING_PROTOCOL *This,
IN EFI_HANDLE ControllerHandle,
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath 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.
@param[in] This Protocol instance pointer.
@param[in] ControllerHandle Handle of device to stop driver on
@param[in] NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
children is zero stop the entire bus driver.
@param[in] ChildHandleBuffer List of Child Handles to Stop.
@retval EFI_SUCCESS This driver is removed ControllerHandle
@retval other This driver was not removed from this device
**/
EFI_STATUS
EFIAPI
Udp4DriverBindingStop (
IN EFI_DRIVER_BINDING_PROTOCOL *This,
IN EFI_HANDLE ControllerHandle,
IN UINTN NumberOfChildren,
IN EFI_HANDLE *ChildHandleBuffer
);
/**
Creates a child handle and installs a protocol.
The CreateChild() function installs a protocol on ChildHandle.
If ChildHandle is a pointer to NULL, then a new handle is created and returned in ChildHandle.
If ChildHandle is not a pointer to NULL, then the protocol installs on the existing ChildHandle.
@param[in] This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
@param[in] ChildHandle Pointer to the handle of the child to create. If it is NULL,
then a new handle is created. If it is a pointer to an existing UEFI handle,
then the protocol is added to the existing UEFI handle.
@retval EFI_SUCCES The protocol was added to ChildHandle.
@retval EFI_INVALID_PARAMETER ChildHandle is NULL.
@retval EFI_OUT_OF_RESOURCES There are not enough resources availabe to create
the child
@retval other The child handle was not created
**/
EFI_STATUS
EFIAPI
Udp4ServiceBindingCreateChild (
IN EFI_SERVICE_BINDING_PROTOCOL *This,
IN EFI_HANDLE *ChildHandle
);
/**
Destroys a child handle with a protocol installed on it.
The DestroyChild() function does the opposite of CreateChild(). It removes a protocol
that was installed by CreateChild() from ChildHandle. If the removed protocol is the
last protocol on ChildHandle, then ChildHandle is destroyed.
@param[in] This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
@param[in] ChildHandle Handle of the child to destroy
@retval EFI_SUCCES The protocol was removed from ChildHandle.
@retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed.
@retval EFI_INVALID_PARAMETER Child handle is NULL.
@retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle
because its services are being used.
@retval other The child handle was not destroyed
**/
EFI_STATUS
EFIAPI
Udp4ServiceBindingDestroyChild (
IN EFI_SERVICE_BINDING_PROTOCOL *This,
IN EFI_HANDLE ChildHandle
);
#endif