Ip6Driver.c File Reference

#include "Ip6Impl.h"

Go to the source code of this file.

Functions
VOID EFIAPI	IpSec2InstalledCallback (IN EFI_EVENT Event, IN VOID *Context)
EFI_STATUS EFIAPI	Ip6DriverEntryPoint (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
EFI_STATUS EFIAPI	Ip6DriverBindingSupported (IN EFI_DRIVER_BINDING_PROTOCOL *This, IN EFI_HANDLE ControllerHandle, IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL)
EFI_STATUS	Ip6CleanService (IN IP6_SERVICE *IpSb)
EFI_STATUS	Ip6CreateService (IN EFI_HANDLE Controller, IN EFI_HANDLE ImageHandle, OUT IP6_SERVICE **Service)
EFI_STATUS EFIAPI	Ip6DriverBindingStart (IN EFI_DRIVER_BINDING_PROTOCOL *This, IN EFI_HANDLE ControllerHandle, IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL)
EFI_STATUS EFIAPI	Ip6DestroyChildEntryInHandleBuffer (IN LIST_ENTRY *Entry, IN VOID *Context)
EFI_STATUS EFIAPI	Ip6DriverBindingStop (IN EFI_DRIVER_BINDING_PROTOCOL *This, IN EFI_HANDLE ControllerHandle, IN UINTN NumberOfChildren, IN EFI_HANDLE *ChildHandleBuffer OPTIONAL)
EFI_STATUS EFIAPI	Ip6ServiceBindingCreateChild (IN EFI_SERVICE_BINDING_PROTOCOL *This, IN EFI_HANDLE *ChildHandle)
EFI_STATUS EFIAPI	Ip6ServiceBindingDestroyChild (IN EFI_SERVICE_BINDING_PROTOCOL *This, IN EFI_HANDLE ChildHandle)

Variables
EFI_DRIVER_BINDING_PROTOCOL	gIp6DriverBinding
BOOLEAN	mIpSec2Installed = FALSE

Detailed Description

The driver binding and service binding protocol for IP6 driver.

Copyright (c) 2009 - 2019, Intel Corporation. All rights reserved.
(C) Copyright 2015 Hewlett-Packard Development Company, L.P.
Copyright (c) Microsoft Corporation SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file Ip6Driver.c.

Function Documentation

Ip6CleanService()

EFI_STATUS Ip6CleanService

(

IN IP6_SERVICE *

IpSb

)

Clean up an IP6 service binding instance. It releases all the resource allocated by the instance. The instance may be partly initialized, or partly destroyed. If a resource is destroyed, it is marked as that in case the destroy failed and being called again later.

Parameters

[in]

IpSb

The IP6 service binding instance to clean up.

Return values

EFI_SUCCESS	The resource used by the instance are cleaned up.
Others	Failed to clean up some of the resources.

Definition at line 145 of file Ip6Driver.c.

Ip6CreateService()

EFI_STATUS Ip6CreateService	(	IN EFI_HANDLE	Controller,
		IN EFI_HANDLE	ImageHandle,
		OUT IP6_SERVICE **	Service
	)

Create a new IP6 driver service binding protocol.

Parameters

[in]	Controller	The controller that has MNP service binding installed.
[in]	ImageHandle	The IP6 driver's image handle.
[out]	Service	The variable to receive the newly created IP6 service.

Return values

EFI_OUT_OF_RESOURCES	Failed to allocate some resources.
EFI_SUCCESS	A new IP6 service binding private is created.

Definition at line 259 of file Ip6Driver.c.

Ip6DestroyChildEntryInHandleBuffer()

EFI_STATUS EFIAPI Ip6DestroyChildEntryInHandleBuffer	(	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 702 of file Ip6Driver.c.

Ip6DriverBindingStart()

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

Start this driver on ControllerHandle.

Parameters

[in]	This	Protocol instance pointer.
[in]	ControllerHandle	Handle of device to bind driver to.
[in]	RemainingDevicePath	Optional parameter used 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 513 of file Ip6Driver.c.

Ip6DriverBindingStop()

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

Stop this driver on ControllerHandle.

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	An array of child handles to be freed. May be NULL if NumberOfChildren is 0.

Return values

EFI_SUCCESS	The device was stopped.
EFI_DEVICE_ERROR	The device could not be stopped due to a device error.

Definition at line 744 of file Ip6Driver.c.

Ip6DriverBindingSupported()

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

Parameters

[in]	This	Protocol instance pointer.
[in]	ControllerHandle	Handle of device to test.
[in]	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 112 of file Ip6Driver.c.

Ip6DriverEntryPoint()

EFI_STATUS EFIAPI Ip6DriverEntryPoint	(	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 IP6 driver which installs the driver binding and component name protocol on its image.

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 72 of file Ip6Driver.c.

Ip6ServiceBindingCreateChild()

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

Creates a child handle with a set of I/O services.

Parameters

[in]	This	Protocol instance pointer.
[in]	ChildHandle	Pointer to the handle of the child to create. If it is NULL, then a new handle is created. If it is not NULL, then the I/O services are added to the existing child handle.

Return values

EFI_SUCCESS	The child handle was created with the I/O services.
EFI_OUT_OF_RESOURCES	There are not enough resources available to create the child.
other	The child handle was not created.

Definition at line 845 of file Ip6Driver.c.

Ip6ServiceBindingDestroyChild()

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

Destroys a child handle with a set of I/O services.

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 950 of file Ip6Driver.c.

IpSec2InstalledCallback()

VOID EFIAPI IpSec2InstalledCallback	(	IN EFI_EVENT	Event,
		IN VOID *	Context
	)

Callback function for IpSec2 Protocol install.

Parameters

[in]	Event	Event whose notification function is being invoked
[in]	Context	Pointer to the notification function's context

Definition at line 33 of file Ip6Driver.c.

Variable Documentation

gIp6DriverBinding

EFI_DRIVER_BINDING_PROTOCOL gIp6DriverBinding

Initial value:

= {
  Ip6DriverBindingSupported,
  Ip6DriverBindingStart,
  Ip6DriverBindingStop,
  0xa,
  NULL,
  NULL
}

Definition at line 13 of file Ip6Driver.c.

mIpSec2Installed

BOOLEAN mIpSec2Installed = FALSE

Definition at line 22 of file Ip6Driver.c.