#include "Dhcp6Impl.h"

Functions
EFI_STATUS EFIAPI	Dhcp6ConfigureUdpIo (IN UDP_IO UdpIo, IN VOID Context)

VOID	Dhcp6DestroyService (IN OUT DHCP6_SERVICE *Service)

EFI_STATUS	Dhcp6CreateService (IN EFI_HANDLE Controller, IN EFI_HANDLE ImageHandle, OUT DHCP6_SERVICE **Service)

VOID	Dhcp6DestroyInstance (IN OUT DHCP6_INSTANCE *Instance)

EFI_STATUS	Dhcp6CreateInstance (IN DHCP6_SERVICE Service, OUT DHCP6_INSTANCE *Instance)

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

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

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

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

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

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

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

Variables
EFI_DRIVER_BINDING_PROTOCOL	gDhcp6DriverBinding

EFI_SERVICE_BINDING_PROTOCOL	gDhcp6ServiceBindingTemplate

Detailed Description

Driver Binding functions and Service Binding functions implementation for Dhcp6 Driver.

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

Definition in file Dhcp6Driver.c.

Function Documentation

◆ Dhcp6ConfigureUdpIo()

EFI_STATUS EFIAPI Dhcp6ConfigureUdpIo	(	IN UDP_IO *	UdpIo,
		IN VOID *	Context
	)

Configure the default Udp6Io to receive all the DHCP6 traffic on this network interface.

Parameters

[in]	UdpIo	The pointer to Udp6Io to be configured.
[in]	Context	The pointer to the context.

Return values

EFI_SUCCESS	The Udp6Io is successfully configured.
Others	Failed to configure the Udp6Io.

Definition at line 40 of file Dhcp6Driver.c.

◆ Dhcp6CreateInstance()

EFI_STATUS Dhcp6CreateInstance	(	IN DHCP6_SERVICE *	Service,
		OUT DHCP6_INSTANCE **	Instance
	)

Create the Dhcp6 instance and initialize it.

Parameters

[in]	Service	The pointer to the Dhcp6 service.
[out]	Instance	The pointer to the Dhcp6 instance.

Return values

EFI_SUCCESS	The Dhcp6 instance is created.
EFI_OUT_OF_RESOURCES	Failed to allocate resources.

Definition at line 271 of file Dhcp6Driver.c.

◆ Dhcp6CreateService()

EFI_STATUS Dhcp6CreateService	(	IN EFI_HANDLE	Controller,
		IN EFI_HANDLE	ImageHandle,
		OUT DHCP6_SERVICE **	Service
	)

Create a new Dhcp6 service for the Nic controller.

Parameters

[in]	Controller	The controller to be installed DHCP6 service binding protocol.
[in]	ImageHandle	The image handle of the Dhcp6 driver.
[out]	Service	The return pointer of the new Dhcp6 service.

Return values

EFI_SUCCESS	The Dhcp6 service is created successfully.
EFI_DEVICE_ERROR	An unexpected system or network error occurred.
EFI_OUT_OF_RESOURCES	Failed to allocate resource.

Definition at line 118 of file Dhcp6Driver.c.

◆ Dhcp6DestroyChildEntry()

EFI_STATUS EFIAPI Dhcp6DestroyChildEntry	(	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_SUCCESS	The entry has been removed successfully.
Others	Fail to remove the entry.

Definition at line 338 of file Dhcp6Driver.c.

◆ Dhcp6DestroyInstance()

VOID Dhcp6DestroyInstance ( IN OUT DHCP6_INSTANCE * Instance )

Destroy the Dhcp6 instance and recycle the resources.

Parameters

[in,out] Instance The pointer to the Dhcp6 instance.

Definition at line 220 of file Dhcp6Driver.c.

◆ Dhcp6DestroyService()

VOID Dhcp6DestroyService ( IN OUT DHCP6_SERVICE * Service )

Destroy the Dhcp6 service. The Dhcp6 service may be partly initialized, or partly destroyed. If a resource is destroyed, it is marked as such in case the destroy failed and being called again later.

Parameters

[in,out] Service The pointer to Dhcp6 service to be destroyed.

Definition at line 84 of file Dhcp6Driver.c.

◆ Dhcp6DriverBindingStart()

EFI_STATUS EFIAPI Dhcp6DriverBindingStart	(	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	The pointer to the driver binding protocol.
[in]	ControllerHandle	The handle of device to be started.
[in]	RemainingDevicePath	Optional parameter use to pick a specific child device to be started.

Return values

EFI_SUCCESS	This driver is installed to ControllerHandle.
EFI_ALREADY_STARTED	This driver is already running on ControllerHandle.
other	This driver does not support this device.

Definition at line 438 of file Dhcp6Driver.c.

◆ Dhcp6DriverBindingStop()

EFI_STATUS EFIAPI Dhcp6DriverBindingStop	(	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 driver on
[in]	NumberOfChildren	Number of Handles in ChildHandleBuffer. If number of children is zero stop the entire bus driver.
[in]	ChildHandleBuffer	List of Child Handles to Stop.

Return values

EFI_SUCCESS	This driver is removed ControllerHandle
EFI_DEVICE_ERROR	An unexpected system or network error occurred.
other	This driver was not removed from this device

Definition at line 514 of file Dhcp6Driver.c.

◆ Dhcp6DriverBindingSupported()

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

[in]	This	The pointer to the driver binding protocol.
[in]	ControllerHandle	The handle of device to be tested.
[in]	RemainingDevicePath	Optional parameter use to pick a specific child device to be started.

Return values

EFI_SUCCESS	This driver supports this device.
Others	This driver does not support this device.

Definition at line 402 of file Dhcp6Driver.c.

◆ Dhcp6DriverEntryPoint()

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

Entry point of the DHCP6 driver to install various protocols.

Parameters

[in]	ImageHandle	The handle of the UEFI image file.
[in]	SystemTable	The pointer to the EFI System Table.

Return values

EFI_SUCCESS	The operation completed successfully.
Others	Unexpected error occurs.

Definition at line 368 of file Dhcp6Driver.c.

◆ Dhcp6ServiceBindingCreateChild()

EFI_STATUS EFIAPI Dhcp6ServiceBindingCreateChild	(	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	ChildHandle is NULL.
other	The child handle was not created.

Definition at line 611 of file Dhcp6Driver.c.

◆ Dhcp6ServiceBindingDestroyChild()

EFI_STATUS EFIAPI Dhcp6ServiceBindingDestroyChild	(	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.

Parameters

[in]	This	Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
[in]	ChildHandle	Handle of the child to destroy

Return values

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

Definition at line 724 of file Dhcp6Driver.c.

Variable Documentation

◆ gDhcp6DriverBinding

EFI_DRIVER_BINDING_PROTOCOL gDhcp6DriverBinding

Initial value:

= {
  Dhcp6DriverBindingSupported,
  Dhcp6DriverBindingStart,
  Dhcp6DriverBindingStop,
  0xa,
  NULL,
  NULL
}

Definition at line 13 of file Dhcp6Driver.c.

◆ gDhcp6ServiceBindingTemplate

EFI_SERVICE_BINDING_PROTOCOL gDhcp6ServiceBindingTemplate

Initial value:

= {
  Dhcp6ServiceBindingCreateChild,
  Dhcp6ServiceBindingDestroyChild
}

Definition at line 22 of file Dhcp6Driver.c.

Functions

Variables

Detailed Description

Function Documentation

◆ Dhcp6ConfigureUdpIo()

◆ Dhcp6CreateInstance()

◆ Dhcp6CreateService()

◆ Dhcp6DestroyChildEntry()

◆ Dhcp6DestroyInstance()

◆ Dhcp6DestroyService()

◆ Dhcp6DriverBindingStart()

◆ Dhcp6DriverBindingStop()

◆ Dhcp6DriverBindingSupported()

◆ Dhcp6DriverEntryPoint()

◆ Dhcp6ServiceBindingCreateChild()

◆ Dhcp6ServiceBindingDestroyChild()

Variable Documentation

◆ gDhcp6DriverBinding

◆ gDhcp6ServiceBindingTemplate