#include "Udp6Impl.h"

Functions
EFI_STATUS EFIAPI	Udp6DriverBindingSupported (IN EFI_DRIVER_BINDING_PROTOCOL This, IN EFI_HANDLE ControllerHandle, IN EFI_DEVICE_PATH_PROTOCOL RemainingDevicePath OPTIONAL)

EFI_STATUS EFIAPI	Udp6DriverBindingStart (IN EFI_DRIVER_BINDING_PROTOCOL This, IN EFI_HANDLE ControllerHandle, IN EFI_DEVICE_PATH_PROTOCOL RemainingDevicePath OPTIONAL)

EFI_STATUS EFIAPI	Udp6DestroyChildEntryInHandleBuffer (IN LIST_ENTRY Entry, IN VOID Context)

EFI_STATUS EFIAPI	Udp6DriverBindingStop (IN EFI_DRIVER_BINDING_PROTOCOL This, IN EFI_HANDLE ControllerHandle, IN UINTN NumberOfChildren, IN EFI_HANDLE ChildHandleBuffer OPTIONAL)

EFI_STATUS EFIAPI	Udp6ServiceBindingCreateChild (IN EFI_SERVICE_BINDING_PROTOCOL This, IN OUT EFI_HANDLE ChildHandle)

EFI_STATUS EFIAPI	Udp6ServiceBindingDestroyChild (IN EFI_SERVICE_BINDING_PROTOCOL *This, IN EFI_HANDLE ChildHandle)

EFI_STATUS EFIAPI	Udp6DriverEntryPoint (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)

Variables
EFI_DRIVER_BINDING_PROTOCOL	gUdp6DriverBinding

EFI_SERVICE_BINDING_PROTOCOL	mUdp6ServiceBinding

Detailed Description

Driver Binding functions and Service Binding functions for the Network driver module.

Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.
Copyright (c) Microsoft Corporation SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file Udp6Driver.c.

Function Documentation

◆ Udp6DestroyChildEntryInHandleBuffer()

EFI_STATUS EFIAPI Udp6DestroyChildEntryInHandleBuffer	(	IN LIST_ENTRY *	Entry,
		IN VOID *	Context
	)

Callback function which provided by user to remove one node in NetDestroyLinkList process.

Parameters

[in]	Entry	The entry to be removed.
[in]	Context	Pointer to the callback context corresponds to the Context in NetDestroyLinkList.

Return values

EFI_INVALID_PARAMETER	Entry is NULL or Context is NULL.
EFI_SUCCESS	The entry has been removed successfully.
Others	Fail to remove the entry.

Definition at line 188 of file Udp6Driver.c.

◆ Udp6DriverBindingStart()

EFI_STATUS EFIAPI Udp6DriverBindingStart	(	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

[in]	This	Protocol instance pointer.
[in]	ControllerHandle	Handle of device to bind the driver to.
[in]	RemainingDevicePath	Optional parameter use to pick a specific child device to start.

Return values

EFI_SUCCESS	This driver is added to ControllerHandle.
EFI_OUT_OF_RESOURCES	The required system resource can't be allocated.
other	This driver does not support this device.

Definition at line 129 of file Udp6Driver.c.

◆ Udp6DriverBindingStop()

EFI_STATUS EFIAPI Udp6DriverBindingStop	(	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

[in]	This	Protocol instance pointer.
[in]	ControllerHandle	Handle of device to stop the driver on.
[in]	NumberOfChildren	Number of Handles in ChildHandleBuffer. If the number of children is zero stop the entire bus driver.
[in]	ChildHandleBuffer	List of Child Handles to Stop. It is optional.

Return values

EFI_SUCCESS	This driver is removed ControllerHandle.
EFI_DEVICE_ERROR	Can't find the NicHandle from the ControllerHandle and specified GUID.
other	This driver was not removed from this device.

Definition at line 236 of file Udp6Driver.c.

◆ Udp6DriverBindingSupported()

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

Tests to see if this driver supports a given controller. If a child device is provided, it further tests to see if this driver supports creating a handle for the specified child device.

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 to guarantee the state of ControllerHandle is not modified by this function.

Parameters

[in]	This	A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
[in]	ControllerHandle	The handle of the controller to test. This handle must support a protocol interface that supplies an I/O abstraction to the driver.
[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 bus driver.

Return values

EFI_SUCCESS	The device specified by ControllerHandle and RemainingDevicePath is supported by the driver specified by This.
EFI_ALREADY_STARTED	The device specified by ControllerHandle and RemainingDevicePath is already being managed by the driver specified by This.
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.
EFI_UNSUPPORTED	The device specified by ControllerHandle and RemainingDevicePath is not supported by the driver specified by This.

Definition at line 70 of file Udp6Driver.c.

◆ Udp6DriverEntryPoint()

EFI_STATUS EFIAPI Udp6DriverEntryPoint	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

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.

The entry point for Udp6 driver that installs the driver binding and component name protocol on its ImageHandle.

Parameters

[in]	ImageHandle	The firmware allocated handle for the UEFI image.
[in]	SystemTable	A pointer to the EFI System Table.

Return values

EFI_SUCCESS	The operation completed successfully.
EFI_OUT_OF_RESOURCES	The request could not be completed due to a lack of resources.

Definition at line 593 of file Udp6Driver.c.

◆ Udp6ServiceBindingCreateChild()

EFI_STATUS EFIAPI Udp6ServiceBindingCreateChild	(	IN EFI_SERVICE_BINDING_PROTOCOL *	This,
		IN OUT EFI_HANDLE *	ChildHandle
	)

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.

Parameters

[in]	This	Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
[in,out]	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.

Return values

EFI_SUCCESS	The protocol was added to ChildHandle.
EFI_INVALID_PARAMETER	This is NULL or ChildHandle is NULL.
EFI_OUT_OF_RESOURCES	There are not enough resources available to create the child.
other	The child handle was not created.

Definition at line 325 of file Udp6Driver.c.

◆ Udp6ServiceBindingDestroyChild()

EFI_STATUS EFIAPI Udp6ServiceBindingDestroyChild	(	IN EFI_SERVICE_BINDING_PROTOCOL *	This,
		IN EFI_HANDLE	ChildHandle
	)

Destroys a child handle with a set of I/O services. 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.

Parameters

[in]	This	Protocol instance pointer.
[in]	ChildHandle	Handle of the child to destroy.

Return values

EFI_SUCCESS	The I/O services were removed from the child handle.
EFI_UNSUPPORTED	The child handle does not support the I/O services that are being removed.
EFI_INVALID_PARAMETER	Child handle is NULL.
EFI_ACCESS_DENIED	The child handle could not be destroyed because its I/O services are being used.
other	The child handle was not destroyed.

Definition at line 461 of file Udp6Driver.c.

Variable Documentation

◆ gUdp6DriverBinding

EFI_DRIVER_BINDING_PROTOCOL gUdp6DriverBinding

Initial value:

= {
  Udp6DriverBindingSupported,
  Udp6DriverBindingStart,
  Udp6DriverBindingStop,
  0xa,
  NULL,
  NULL
}

Definition at line 12 of file Udp6Driver.c.

◆ mUdp6ServiceBinding

EFI_SERVICE_BINDING_PROTOCOL mUdp6ServiceBinding

Initial value:

= {
  Udp6ServiceBindingCreateChild,
  Udp6ServiceBindingDestroyChild
}

Definition at line 21 of file Udp6Driver.c.

Functions

Variables

Detailed Description

Function Documentation

◆ Udp6DestroyChildEntryInHandleBuffer()

◆ Udp6DriverBindingStart()

◆ Udp6DriverBindingStop()

◆ Udp6DriverBindingSupported()

◆ Udp6DriverEntryPoint()

◆ Udp6ServiceBindingCreateChild()

◆ Udp6ServiceBindingDestroyChild()

Variable Documentation

◆ gUdp6DriverBinding

◆ mUdp6ServiceBinding