2015-07-07 10:22:03 +02:00
|
|
|
/** @file
|
|
|
|
|
The header files of the driver binding and service binding protocol for DnsDxe driver.
|
|
|
|
|
|
2018-06-27 15:12:32 +02:00
|
|
|
Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.<BR>
|
2015-07-07 10:22:03 +02:00
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
**/
|
|
|
|
|
|
|
|
|
|
#ifndef _DNS_DRIVER_H_
|
|
|
|
|
#define _DNS_DRIVER_H_
|
|
|
|
|
|
|
|
|
|
#include <Protocol/DriverBinding.h>
|
|
|
|
|
#include <Protocol/ServiceBinding.h>
|
|
|
|
|
|
|
|
|
|
///
|
|
|
|
|
/// Dns service block
|
|
|
|
|
///
|
|
|
|
|
typedef struct _DNS_DRIVER_DATA DNS_DRIVER_DATA;
|
|
|
|
|
|
|
|
|
|
///
|
|
|
|
|
/// Dns service block
|
|
|
|
|
///
|
|
|
|
|
typedef struct _DNS_SERVICE DNS_SERVICE;
|
|
|
|
|
|
|
|
|
|
///
|
|
|
|
|
/// Dns instance block
|
|
|
|
|
///
|
|
|
|
|
typedef struct _DNS_INSTANCE DNS_INSTANCE;
|
|
|
|
|
|
|
|
|
|
#define DNS_SERVICE_SIGNATURE SIGNATURE_32 ('D', 'N', 'S', 'S')
|
|
|
|
|
|
2018-06-27 15:12:32 +02:00
|
|
|
#define DNS_INSTANCE_SIGNATURE SIGNATURE_32 ('D', 'N', 'S', 'I')
|
2015-07-07 10:22:03 +02:00
|
|
|
|
|
|
|
|
struct _DNS_DRIVER_DATA {
|
|
|
|
|
EFI_EVENT Timer; /// Ticking timer for DNS cache update.
|
2018-06-27 15:12:32 +02:00
|
|
|
|
2015-07-07 10:22:03 +02:00
|
|
|
LIST_ENTRY Dns4CacheList;
|
|
|
|
|
LIST_ENTRY Dns4ServerList;
|
|
|
|
|
|
|
|
|
|
LIST_ENTRY Dns6CacheList;
|
|
|
|
|
LIST_ENTRY Dns6ServerList;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
struct _DNS_SERVICE {
|
|
|
|
|
UINT32 Signature;
|
|
|
|
|
EFI_SERVICE_BINDING_PROTOCOL ServiceBinding;
|
|
|
|
|
|
|
|
|
|
UINT16 Dns4ChildrenNum;
|
|
|
|
|
LIST_ENTRY Dns4ChildrenList;
|
|
|
|
|
|
|
|
|
|
UINT16 Dns6ChildrenNum;
|
|
|
|
|
LIST_ENTRY Dns6ChildrenList;
|
|
|
|
|
|
|
|
|
|
EFI_HANDLE ControllerHandle;
|
|
|
|
|
EFI_HANDLE ImageHandle;
|
2018-06-27 15:12:32 +02:00
|
|
|
|
2015-07-07 10:22:03 +02:00
|
|
|
EFI_EVENT TimerToGetMap;
|
|
|
|
|
|
|
|
|
|
EFI_EVENT Timer; /// Ticking timer for packet retransmission.
|
|
|
|
|
|
|
|
|
|
UINT8 IpVersion;
|
|
|
|
|
UDP_IO *ConnectUdp;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
struct _DNS_INSTANCE {
|
|
|
|
|
UINT32 Signature;
|
|
|
|
|
LIST_ENTRY Link;
|
2018-06-27 15:12:32 +02:00
|
|
|
|
2015-07-07 10:22:03 +02:00
|
|
|
EFI_DNS4_PROTOCOL Dns4;
|
|
|
|
|
EFI_DNS6_PROTOCOL Dns6;
|
2018-06-27 15:12:32 +02:00
|
|
|
|
2015-07-07 10:22:03 +02:00
|
|
|
INTN State;
|
|
|
|
|
BOOLEAN InDestroy;
|
|
|
|
|
|
|
|
|
|
DNS_SERVICE *Service;
|
|
|
|
|
EFI_HANDLE ChildHandle;
|
|
|
|
|
|
|
|
|
|
EFI_DNS4_CONFIG_DATA Dns4CfgData;
|
|
|
|
|
EFI_DNS6_CONFIG_DATA Dns6CfgData;
|
|
|
|
|
|
|
|
|
|
EFI_IP_ADDRESS SessionDnsServer;
|
|
|
|
|
|
|
|
|
|
NET_MAP Dns4TxTokens;
|
|
|
|
|
NET_MAP Dns6TxTokens;
|
|
|
|
|
|
|
|
|
|
UDP_IO *UdpIo;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
typedef struct {
|
|
|
|
|
EFI_SERVICE_BINDING_PROTOCOL *ServiceBinding;
|
|
|
|
|
UINTN NumberOfChildren;
|
|
|
|
|
EFI_HANDLE *ChildHandleBuffer;
|
|
|
|
|
} DNS_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT;
|
|
|
|
|
|
|
|
|
|
extern DNS_DRIVER_DATA *mDriverData;
|
|
|
|
|
|
|
|
|
|
#define DNS_SERVICE_FROM_THIS(a) \
|
|
|
|
|
CR (a, DNS_SERVICE, ServiceBinding, DNS_SERVICE_SIGNATURE)
|
|
|
|
|
|
|
|
|
|
#define DNS_INSTANCE_FROM_THIS_PROTOCOL4(a) \
|
|
|
|
|
CR (a, DNS_INSTANCE, Dns4, DNS_INSTANCE_SIGNATURE)
|
|
|
|
|
|
|
|
|
|
#define DNS_INSTANCE_FROM_THIS_PROTOCOL6(a) \
|
|
|
|
|
CR (a, DNS_INSTANCE, Dns6, DNS_INSTANCE_SIGNATURE)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
Destroy the DNS instance and recycle the resources.
|
|
|
|
|
|
|
|
|
|
@param[in] Instance The pointer to the DNS instance.
|
|
|
|
|
|
|
|
|
|
**/
|
|
|
|
|
VOID
|
|
|
|
|
DnsDestroyInstance (
|
|
|
|
|
IN DNS_INSTANCE *Instance
|
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
Create the DNS instance and initialize it.
|
|
|
|
|
|
|
|
|
|
@param[in] Service The pointer to the DNS service.
|
|
|
|
|
@param[out] Instance The pointer to the DNS instance.
|
|
|
|
|
|
|
|
|
|
@retval EFI_OUT_OF_RESOURCES Failed to allocate resources.
|
|
|
|
|
@retval EFI_SUCCESS The DNS instance is created.
|
|
|
|
|
|
|
|
|
|
**/
|
|
|
|
|
EFI_STATUS
|
|
|
|
|
DnsCreateInstance (
|
|
|
|
|
IN DNS_SERVICE *Service,
|
|
|
|
|
OUT DNS_INSTANCE **Instance
|
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
Callback function which provided by user to remove one node in NetDestroyLinkList process.
|
2018-06-27 15:12:32 +02:00
|
|
|
|
2015-07-07 10:22:03 +02:00
|
|
|
@param[in] Entry The entry to be removed.
|
|
|
|
|
@param[in] Context Pointer to the callback context corresponds to the Context in NetDestroyLinkList.
|
|
|
|
|
|
|
|
|
|
@retval EFI_SUCCESS The entry has been removed successfully.
|
|
|
|
|
@retval Others Fail to remove the entry.
|
|
|
|
|
|
|
|
|
|
**/
|
|
|
|
|
EFI_STATUS
|
|
|
|
|
EFIAPI
|
|
|
|
|
DnsDestroyChildEntryInHandleBuffer (
|
|
|
|
|
IN LIST_ENTRY *Entry,
|
|
|
|
|
IN VOID *Context
|
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
Config a NULL UDP that is used to keep the connection between UDP and DNS.
|
|
|
|
|
|
|
|
|
|
Just leave the Udp child unconfigured. When UDP is unloaded,
|
|
|
|
|
DNS will be informed with DriverBinding Stop.
|
|
|
|
|
|
|
|
|
|
@param UdpIo The UDP_IO to configure
|
|
|
|
|
@param Context The opaque parameter to the callback
|
|
|
|
|
|
|
|
|
|
@retval EFI_SUCCESS It always return EFI_SUCCESS directly.
|
|
|
|
|
|
|
|
|
|
**/
|
|
|
|
|
EFI_STATUS
|
|
|
|
|
EFIAPI
|
|
|
|
|
DnsConfigNullUdp (
|
|
|
|
|
IN UDP_IO *UdpIo,
|
|
|
|
|
IN VOID *Context
|
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
Release all the resource used the DNS service binding instance.
|
|
|
|
|
|
|
|
|
|
@param DnsSb The Dns service binding instance.
|
|
|
|
|
|
|
|
|
|
**/
|
|
|
|
|
VOID
|
|
|
|
|
DnsDestroyService (
|
|
|
|
|
IN DNS_SERVICE *DnsSb
|
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
Create then initialize a Dns service binding instance.
|
|
|
|
|
|
|
|
|
|
@param Controller The controller to install the DNS service
|
|
|
|
|
binding on
|
|
|
|
|
@param Image The driver binding image of the DNS driver
|
|
|
|
|
@param IpVersion IpVersion for this service
|
|
|
|
|
@param Service The variable to receive the created service
|
|
|
|
|
binding instance.
|
|
|
|
|
|
|
|
|
|
@retval EFI_OUT_OF_RESOURCES Failed to allocate resource to create the instance.
|
|
|
|
|
@retval EFI_DEVICE_ERROR Failed to create a NULL UDP port to keep
|
|
|
|
|
connection with UDP.
|
|
|
|
|
@retval EFI_SUCCESS The service instance is created for the
|
|
|
|
|
controller.
|
|
|
|
|
|
|
|
|
|
**/
|
|
|
|
|
EFI_STATUS
|
|
|
|
|
DnsCreateService (
|
|
|
|
|
IN EFI_HANDLE Controller,
|
|
|
|
|
IN EFI_HANDLE Image,
|
|
|
|
|
IN UINT8 IpVersion,
|
|
|
|
|
OUT DNS_SERVICE **Service
|
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
Unloads an image.
|
|
|
|
|
|
|
|
|
|
@param ImageHandle Handle that identifies the image to be unloaded.
|
|
|
|
|
|
|
|
|
|
@retval EFI_SUCCESS The image has been unloaded.
|
|
|
|
|
@retval EFI_INVALID_PARAMETER ImageHandle is not a valid image handle.
|
|
|
|
|
|
|
|
|
|
**/
|
2018-06-27 15:12:32 +02:00
|
|
|
EFI_STATUS
|
2015-07-07 10:22:03 +02:00
|
|
|
EFIAPI
|
|
|
|
|
DnsUnload (
|
|
|
|
|
IN EFI_HANDLE ImageHandle
|
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
This is the declaration of an EFI image entry point. This entry point is
|
|
|
|
|
the same for UEFI Applications, UEFI OS Loaders, and UEFI Drivers including
|
|
|
|
|
both device drivers and bus drivers.
|
|
|
|
|
|
|
|
|
|
@param ImageHandle The firmware allocated handle for the UEFI image.
|
|
|
|
|
@param SystemTable A pointer to the EFI System Table.
|
|
|
|
|
|
|
|
|
|
@retval EFI_SUCCESS The operation completed successfully.
|
|
|
|
|
@retval Others An unexpected error occurred.
|
|
|
|
|
**/
|
|
|
|
|
EFI_STATUS
|
|
|
|
|
EFIAPI
|
|
|
|
|
DnsDriverEntryPoint (
|
|
|
|
|
IN EFI_HANDLE ImageHandle,
|
|
|
|
|
IN EFI_SYSTEM_TABLE *SystemTable
|
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
/**
|
2018-06-27 15:12:32 +02:00
|
|
|
Tests to see if this driver supports a given controller. If a child device is provided,
|
2015-07-07 10:22:03 +02:00
|
|
|
it further tests to see if this driver supports creating a handle for the specified child device.
|
|
|
|
|
|
2018-06-27 15:12:32 +02:00
|
|
|
This function checks to see if the driver specified by This supports the device specified by
|
|
|
|
|
ControllerHandle. Drivers will typically use the device path attached to
|
|
|
|
|
ControllerHandle and/or the services from the bus I/O abstraction attached to
|
|
|
|
|
ControllerHandle to determine if the driver supports ControllerHandle. This function
|
|
|
|
|
may be called many times during platform initialization. In order to reduce boot times, the tests
|
|
|
|
|
performed by this function must be very small, and take as little time as possible to execute. This
|
|
|
|
|
function must not change the state of any hardware devices, and this function must be aware that the
|
|
|
|
|
device specified by ControllerHandle may already be managed by the same driver or a
|
|
|
|
|
different driver. This function must match its calls to AllocatePages() with FreePages(),
|
|
|
|
|
AllocatePool() with FreePool(), and OpenProtocol() with CloseProtocol().
|
|
|
|
|
Because ControllerHandle may have been previously started by the same driver, if a protocol is
|
|
|
|
|
already in the opened state, then it must not be closed with CloseProtocol(). This is required
|
2015-07-07 10:22:03 +02:00
|
|
|
to guarantee the state of ControllerHandle is not modified by this function.
|
|
|
|
|
|
|
|
|
|
@param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
|
2018-06-27 15:12:32 +02:00
|
|
|
@param[in] ControllerHandle The handle of the controller to test. This handle
|
|
|
|
|
must support a protocol interface that supplies
|
2015-07-07 10:22:03 +02:00
|
|
|
an I/O abstraction to the driver.
|
2018-06-27 15:12:32 +02:00
|
|
|
@param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This
|
|
|
|
|
parameter is ignored by device drivers, and is optional for bus
|
|
|
|
|
drivers. For bus drivers, if this parameter is not NULL, then
|
|
|
|
|
the bus driver must determine if the bus controller specified
|
|
|
|
|
by ControllerHandle and the child controller specified
|
|
|
|
|
by RemainingDevicePath are both supported by this
|
2015-07-07 10:22:03 +02:00
|
|
|
bus driver.
|
|
|
|
|
|
|
|
|
|
@retval EFI_SUCCESS The device specified by ControllerHandle and
|
|
|
|
|
RemainingDevicePath is supported by the driver specified by This.
|
|
|
|
|
@retval EFI_ALREADY_STARTED The device specified by ControllerHandle and
|
|
|
|
|
RemainingDevicePath is already being managed by the driver
|
|
|
|
|
specified by This.
|
|
|
|
|
@retval EFI_ACCESS_DENIED The device specified by ControllerHandle and
|
|
|
|
|
RemainingDevicePath is already being managed by a different
|
|
|
|
|
driver or an application that requires exclusive access.
|
|
|
|
|
Currently not implemented.
|
|
|
|
|
@retval EFI_UNSUPPORTED The device specified by ControllerHandle and
|
|
|
|
|
RemainingDevicePath is not supported by the driver specified by This.
|
|
|
|
|
**/
|
|
|
|
|
EFI_STATUS
|
|
|
|
|
EFIAPI
|
|
|
|
|
Dns4DriverBindingSupported (
|
|
|
|
|
IN EFI_DRIVER_BINDING_PROTOCOL *This,
|
|
|
|
|
IN EFI_HANDLE ControllerHandle,
|
|
|
|
|
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL
|
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
Starts a device controller or a bus controller.
|
|
|
|
|
|
|
|
|
|
The Start() function is designed to be invoked from the EFI boot service ConnectController().
|
2018-06-27 15:12:32 +02:00
|
|
|
As a result, much of the error checking on the parameters to Start() has been moved into this
|
|
|
|
|
common boot service. It is legal to call Start() from other locations,
|
2015-07-07 10:22:03 +02:00
|
|
|
but the following calling restrictions must be followed, or the system behavior will not be deterministic.
|
|
|
|
|
1. ControllerHandle must be a valid EFI_HANDLE.
|
|
|
|
|
2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned
|
|
|
|
|
EFI_DEVICE_PATH_PROTOCOL.
|
|
|
|
|
3. Prior to calling Start(), the Supported() function for the driver specified by This must
|
2018-06-27 15:12:32 +02:00
|
|
|
have been called with the same calling parameters, and Supported() must have returned EFI_SUCCESS.
|
2015-07-07 10:22:03 +02:00
|
|
|
|
|
|
|
|
@param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
|
2018-06-27 15:12:32 +02:00
|
|
|
@param[in] ControllerHandle The handle of the controller to start. This handle
|
|
|
|
|
must support a protocol interface that supplies
|
2015-07-07 10:22:03 +02:00
|
|
|
an I/O abstraction to the driver.
|
2018-06-27 15:12:32 +02:00
|
|
|
@param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This
|
|
|
|
|
parameter is ignored by device drivers, and is optional for bus
|
|
|
|
|
drivers. For a bus driver, if this parameter is NULL, then handles
|
|
|
|
|
for all the children of Controller are created by this driver.
|
|
|
|
|
If this parameter is not NULL and the first Device Path Node is
|
|
|
|
|
not the End of Device Path Node, then only the handle for the
|
|
|
|
|
child device specified by the first Device Path Node of
|
2015-07-07 10:22:03 +02:00
|
|
|
RemainingDevicePath is created by this driver.
|
2018-06-27 15:12:32 +02:00
|
|
|
If the first Device Path Node of RemainingDevicePath is
|
2015-07-07 10:22:03 +02:00
|
|
|
the End of Device Path Node, no child handle is created by this
|
|
|
|
|
driver.
|
|
|
|
|
|
|
|
|
|
@retval EFI_SUCCESS The device was started.
|
|
|
|
|
@retval EFI_DEVICE_ERROR The device could not be started due to a device error.Currently not implemented.
|
|
|
|
|
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
|
|
|
|
|
@retval Others The driver failded to start the device.
|
|
|
|
|
|
|
|
|
|
**/
|
|
|
|
|
EFI_STATUS
|
|
|
|
|
EFIAPI
|
|
|
|
|
Dns4DriverBindingStart (
|
|
|
|
|
IN EFI_DRIVER_BINDING_PROTOCOL *This,
|
|
|
|
|
IN EFI_HANDLE ControllerHandle,
|
|
|
|
|
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL
|
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
Stops a device controller or a bus controller.
|
2018-06-27 15:12:32 +02:00
|
|
|
|
|
|
|
|
The Stop() function is designed to be invoked from the EFI boot service DisconnectController().
|
|
|
|
|
As a result, much of the error checking on the parameters to Stop() has been moved
|
|
|
|
|
into this common boot service. It is legal to call Stop() from other locations,
|
2015-07-07 10:22:03 +02:00
|
|
|
but the following calling restrictions must be followed, or the system behavior will not be deterministic.
|
|
|
|
|
1. ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this
|
|
|
|
|
same driver's Start() function.
|
|
|
|
|
2. The first NumberOfChildren handles of ChildHandleBuffer must all be a valid
|
|
|
|
|
EFI_HANDLE. In addition, all of these handles must have been created in this driver's
|
|
|
|
|
Start() function, and the Start() function must have called OpenProtocol() on
|
|
|
|
|
ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER.
|
2018-06-27 15:12:32 +02:00
|
|
|
|
2015-07-07 10:22:03 +02:00
|
|
|
@param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
|
2018-06-27 15:12:32 +02:00
|
|
|
@param[in] ControllerHandle A handle to the device being stopped. The handle must
|
|
|
|
|
support a bus specific I/O protocol for the driver
|
2015-07-07 10:22:03 +02:00
|
|
|
to use to stop the device.
|
|
|
|
|
@param[in] NumberOfChildren The number of child device handles in ChildHandleBuffer.
|
2018-06-27 15:12:32 +02:00
|
|
|
@param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL
|
2015-07-07 10:22:03 +02:00
|
|
|
if NumberOfChildren is 0.
|
|
|
|
|
|
|
|
|
|
@retval EFI_SUCCESS The device was stopped.
|
|
|
|
|
@retval EFI_DEVICE_ERROR The device could not be stopped due to a device error.
|
|
|
|
|
|
|
|
|
|
**/
|
|
|
|
|
EFI_STATUS
|
|
|
|
|
EFIAPI
|
|
|
|
|
Dns4DriverBindingStop (
|
|
|
|
|
IN EFI_DRIVER_BINDING_PROTOCOL *This,
|
|
|
|
|
IN EFI_HANDLE ControllerHandle,
|
|
|
|
|
IN UINTN NumberOfChildren,
|
|
|
|
|
IN EFI_HANDLE *ChildHandleBuffer OPTIONAL
|
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
/**
|
2018-06-27 15:12:32 +02:00
|
|
|
Tests to see if this driver supports a given controller. If a child device is provided,
|
2015-07-07 10:22:03 +02:00
|
|
|
it further tests to see if this driver supports creating a handle for the specified child device.
|
|
|
|
|
|
2018-06-27 15:12:32 +02:00
|
|
|
This function checks to see if the driver specified by This supports the device specified by
|
|
|
|
|
ControllerHandle. Drivers will typically use the device path attached to
|
|
|
|
|
ControllerHandle and/or the services from the bus I/O abstraction attached to
|
|
|
|
|
ControllerHandle to determine if the driver supports ControllerHandle. This function
|
|
|
|
|
may be called many times during platform initialization. In order to reduce boot times, the tests
|
|
|
|
|
performed by this function must be very small, and take as little time as possible to execute. This
|
|
|
|
|
function must not change the state of any hardware devices, and this function must be aware that the
|
|
|
|
|
device specified by ControllerHandle may already be managed by the same driver or a
|
|
|
|
|
different driver. This function must match its calls to AllocatePages() with FreePages(),
|
|
|
|
|
AllocatePool() with FreePool(), and OpenProtocol() with CloseProtocol().
|
|
|
|
|
Because ControllerHandle may have been previously started by the same driver, if a protocol is
|
|
|
|
|
already in the opened state, then it must not be closed with CloseProtocol(). This is required
|
2015-07-07 10:22:03 +02:00
|
|
|
to guarantee the state of ControllerHandle is not modified by this function.
|
|
|
|
|
|
|
|
|
|
@param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
|
2018-06-27 15:12:32 +02:00
|
|
|
@param[in] ControllerHandle The handle of the controller to test. This handle
|
|
|
|
|
must support a protocol interface that supplies
|
2015-07-07 10:22:03 +02:00
|
|
|
an I/O abstraction to the driver.
|
2018-06-27 15:12:32 +02:00
|
|
|
@param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This
|
|
|
|
|
parameter is ignored by device drivers, and is optional for bus
|
|
|
|
|
drivers. For bus drivers, if this parameter is not NULL, then
|
|
|
|
|
the bus driver must determine if the bus controller specified
|
|
|
|
|
by ControllerHandle and the child controller specified
|
|
|
|
|
by RemainingDevicePath are both supported by this
|
2015-07-07 10:22:03 +02:00
|
|
|
bus driver.
|
|
|
|
|
|
|
|
|
|
@retval EFI_SUCCESS The device specified by ControllerHandle and
|
|
|
|
|
RemainingDevicePath is supported by the driver specified by This.
|
|
|
|
|
@retval EFI_ALREADY_STARTED The device specified by ControllerHandle and
|
|
|
|
|
RemainingDevicePath is already being managed by the driver
|
|
|
|
|
specified by This.
|
|
|
|
|
@retval EFI_ACCESS_DENIED The device specified by ControllerHandle and
|
|
|
|
|
RemainingDevicePath is already being managed by a different
|
|
|
|
|
driver or an application that requires exclusive access.
|
|
|
|
|
Currently not implemented.
|
|
|
|
|
@retval EFI_UNSUPPORTED The device specified by ControllerHandle and
|
|
|
|
|
RemainingDevicePath is not supported by the driver specified by This.
|
|
|
|
|
**/
|
|
|
|
|
EFI_STATUS
|
|
|
|
|
EFIAPI
|
|
|
|
|
Dns6DriverBindingSupported (
|
|
|
|
|
IN EFI_DRIVER_BINDING_PROTOCOL *This,
|
|
|
|
|
IN EFI_HANDLE ControllerHandle,
|
|
|
|
|
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL
|
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
Starts a device controller or a bus controller.
|
|
|
|
|
|
|
|
|
|
The Start() function is designed to be invoked from the EFI boot service ConnectController().
|
2018-06-27 15:12:32 +02:00
|
|
|
As a result, much of the error checking on the parameters to Start() has been moved into this
|
|
|
|
|
common boot service. It is legal to call Start() from other locations,
|
2015-07-07 10:22:03 +02:00
|
|
|
but the following calling restrictions must be followed, or the system behavior will not be deterministic.
|
|
|
|
|
1. ControllerHandle must be a valid EFI_HANDLE.
|
|
|
|
|
2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned
|
|
|
|
|
EFI_DEVICE_PATH_PROTOCOL.
|
|
|
|
|
3. Prior to calling Start(), the Supported() function for the driver specified by This must
|
2018-06-27 15:12:32 +02:00
|
|
|
have been called with the same calling parameters, and Supported() must have returned EFI_SUCCESS.
|
2015-07-07 10:22:03 +02:00
|
|
|
|
|
|
|
|
@param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
|
2018-06-27 15:12:32 +02:00
|
|
|
@param[in] ControllerHandle The handle of the controller to start. This handle
|
|
|
|
|
must support a protocol interface that supplies
|
2015-07-07 10:22:03 +02:00
|
|
|
an I/O abstraction to the driver.
|
2018-06-27 15:12:32 +02:00
|
|
|
@param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This
|
|
|
|
|
parameter is ignored by device drivers, and is optional for bus
|
|
|
|
|
drivers. For a bus driver, if this parameter is NULL, then handles
|
|
|
|
|
for all the children of Controller are created by this driver.
|
|
|
|
|
If this parameter is not NULL and the first Device Path Node is
|
|
|
|
|
not the End of Device Path Node, then only the handle for the
|
|
|
|
|
child device specified by the first Device Path Node of
|
2015-07-07 10:22:03 +02:00
|
|
|
RemainingDevicePath is created by this driver.
|
2018-06-27 15:12:32 +02:00
|
|
|
If the first Device Path Node of RemainingDevicePath is
|
2015-07-07 10:22:03 +02:00
|
|
|
the End of Device Path Node, no child handle is created by this
|
|
|
|
|
driver.
|
|
|
|
|
|
|
|
|
|
@retval EFI_SUCCESS The device was started.
|
|
|
|
|
@retval EFI_DEVICE_ERROR The device could not be started due to a device error.Currently not implemented.
|
|
|
|
|
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
|
|
|
|
|
@retval Others The driver failded to start the device.
|
|
|
|
|
|
|
|
|
|
**/
|
|
|
|
|
EFI_STATUS
|
|
|
|
|
EFIAPI
|
|
|
|
|
Dns6DriverBindingStart (
|
|
|
|
|
IN EFI_DRIVER_BINDING_PROTOCOL *This,
|
|
|
|
|
IN EFI_HANDLE ControllerHandle,
|
|
|
|
|
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL
|
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
Stops a device controller or a bus controller.
|
2018-06-27 15:12:32 +02:00
|
|
|
|
|
|
|
|
The Stop() function is designed to be invoked from the EFI boot service DisconnectController().
|
|
|
|
|
As a result, much of the error checking on the parameters to Stop() has been moved
|
|
|
|
|
into this common boot service. It is legal to call Stop() from other locations,
|
2015-07-07 10:22:03 +02:00
|
|
|
but the following calling restrictions must be followed, or the system behavior will not be deterministic.
|
|
|
|
|
1. ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this
|
|
|
|
|
same driver's Start() function.
|
|
|
|
|
2. The first NumberOfChildren handles of ChildHandleBuffer must all be a valid
|
|
|
|
|
EFI_HANDLE. In addition, all of these handles must have been created in this driver's
|
|
|
|
|
Start() function, and the Start() function must have called OpenProtocol() on
|
|
|
|
|
ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER.
|
2018-06-27 15:12:32 +02:00
|
|
|
|
2015-07-07 10:22:03 +02:00
|
|
|
@param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
|
2018-06-27 15:12:32 +02:00
|
|
|
@param[in] ControllerHandle A handle to the device being stopped. The handle must
|
|
|
|
|
support a bus specific I/O protocol for the driver
|
2015-07-07 10:22:03 +02:00
|
|
|
to use to stop the device.
|
|
|
|
|
@param[in] NumberOfChildren The number of child device handles in ChildHandleBuffer.
|
2018-06-27 15:12:32 +02:00
|
|
|
@param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL
|
2015-07-07 10:22:03 +02:00
|
|
|
if NumberOfChildren is 0.
|
|
|
|
|
|
|
|
|
|
@retval EFI_SUCCESS The device was stopped.
|
|
|
|
|
@retval EFI_DEVICE_ERROR The device could not be stopped due to a device error.
|
|
|
|
|
|
|
|
|
|
**/
|
|
|
|
|
EFI_STATUS
|
|
|
|
|
EFIAPI
|
|
|
|
|
Dns6DriverBindingStop (
|
|
|
|
|
IN EFI_DRIVER_BINDING_PROTOCOL *This,
|
|
|
|
|
IN EFI_HANDLE ControllerHandle,
|
|
|
|
|
IN UINTN NumberOfChildren,
|
|
|
|
|
IN EFI_HANDLE *ChildHandleBuffer OPTIONAL
|
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
Creates a child handle and installs a protocol.
|
2018-06-27 15:12:32 +02:00
|
|
|
|
|
|
|
|
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.
|
2015-07-07 10:22:03 +02:00
|
|
|
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,
|
2018-06-27 15:12:32 +02:00
|
|
|
then a new handle is created. If it is a pointer to an existing UEFI handle,
|
2015-07-07 10:22:03 +02:00
|
|
|
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.
|
2016-07-08 08:21:06 +02:00
|
|
|
@retval EFI_OUT_OF_RESOURCES There are not enough resources available to create
|
2015-07-07 10:22:03 +02:00
|
|
|
the child
|
|
|
|
|
@retval other The child handle was not created
|
|
|
|
|
|
|
|
|
|
**/
|
|
|
|
|
EFI_STATUS
|
|
|
|
|
EFIAPI
|
|
|
|
|
Dns4ServiceBindingCreateChild (
|
|
|
|
|
IN EFI_SERVICE_BINDING_PROTOCOL *This,
|
|
|
|
|
IN EFI_HANDLE *ChildHandle
|
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
Destroys a child handle with a protocol installed on it.
|
2018-06-27 15:12:32 +02:00
|
|
|
|
|
|
|
|
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
|
2015-07-07 10:22:03 +02:00
|
|
|
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
|
|
|
|
|
Dns4ServiceBindingDestroyChild (
|
|
|
|
|
IN EFI_SERVICE_BINDING_PROTOCOL *This,
|
|
|
|
|
IN EFI_HANDLE ChildHandle
|
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
Creates a child handle and installs a protocol.
|
2018-06-27 15:12:32 +02:00
|
|
|
|
|
|
|
|
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.
|
2015-07-07 10:22:03 +02:00
|
|
|
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,
|
2018-06-27 15:12:32 +02:00
|
|
|
then a new handle is created. If it is a pointer to an existing UEFI handle,
|
2015-07-07 10:22:03 +02:00
|
|
|
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.
|
2016-07-08 08:21:06 +02:00
|
|
|
@retval EFI_OUT_OF_RESOURCES There are not enough resources available to create
|
2015-07-07 10:22:03 +02:00
|
|
|
the child
|
|
|
|
|
@retval other The child handle was not created
|
|
|
|
|
|
|
|
|
|
**/
|
|
|
|
|
EFI_STATUS
|
|
|
|
|
EFIAPI
|
|
|
|
|
Dns6ServiceBindingCreateChild (
|
|
|
|
|
IN EFI_SERVICE_BINDING_PROTOCOL *This,
|
|
|
|
|
IN EFI_HANDLE *ChildHandle
|
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
Destroys a child handle with a protocol installed on it.
|
2018-06-27 15:12:32 +02:00
|
|
|
|
|
|
|
|
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
|
2015-07-07 10:22:03 +02:00
|
|
|
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
|
|
|
|
|
Dns6ServiceBindingDestroyChild (
|
|
|
|
|
IN EFI_SERVICE_BINDING_PROTOCOL *This,
|
|
|
|
|
IN EFI_HANDLE ChildHandle
|
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#endif
|
