TianoCore EDK2 master
Loading...
Searching...
No Matches
Ip6Driver.h File Reference

Go to the source code of this file.

Data Structures

struct  IP6_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT
 

Functions

EFI_STATUS Ip6CleanService (IN IP6_SERVICE *IpSb)
 
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 EFIAPI Ip6DriverBindingStart (IN EFI_DRIVER_BINDING_PROTOCOL *This, IN EFI_HANDLE ControllerHandle, IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL)
 
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
 
EFI_COMPONENT_NAME_PROTOCOL gIp6ComponentName
 
EFI_COMPONENT_NAME2_PROTOCOL gIp6ComponentName2
 
EFI_UNICODE_STRING_TABLEgIp6ControllerNameTable
 

Detailed Description

The driver binding and service binding protocol for IP6 driver.

Copyright (c) 2009 - 2016, Intel Corporation. All rights reserved.

SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file Ip6Driver.h.

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]IpSbThe IP6 service binding instance to clean up.
Return values
EFI_SUCCESSThe resource used by the instance are cleaned up.
OthersFailed to clean up some of the resources.

Definition at line 145 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]ThisProtocol instance pointer.
[in]ControllerHandleHandle of device to bind driver to.
[in]RemainingDevicePathOptional parameter used to pick a specific child device to start.
Return values
EFI_SUCCESSThis driver is added to ControllerHandle.
EFI_ALREADY_STARTEDThis driver is already running on ControllerHandle.
otherThis 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]ThisProtocol instance pointer.
[in]ControllerHandleHandle of device to stop driver on.
[in]NumberOfChildrenNumber of Handles in ChildHandleBuffer. If number of children is zero, stop the entire bus driver.
[in]ChildHandleBufferAn array of child handles to be freed. May be NULL if NumberOfChildren is 0.
Return values
EFI_SUCCESSThe device was stopped.
EFI_DEVICE_ERRORThe 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]ThisProtocol instance pointer.
[in]ControllerHandleHandle of device to test.
[in]RemainingDevicePathOptional parameter use to pick a specific child device to start.
Return values
EFI_SUCCESSThis driver supports this device.
EFI_ALREADY_STARTEDThis driver is already running on this device.
otherThis 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]ImageHandleThe firmware allocated handle for the UEFI image.
[in]SystemTableA pointer to the EFI System Table.
Return values
EFI_SUCCESSThe operation completed successfully.
EFI_OUT_OF_RESOURCESThe 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]ThisProtocol instance pointer.
[in]ChildHandlePointer 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_SUCCESSThe child handle was created with the I/O services.
EFI_OUT_OF_RESOURCESThere are not enough resources available to create the child.
otherThe 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]ThisProtocol instance pointer.
[in]ChildHandleHandle of the child to destroy.
Return values
EFI_SUCCESSThe I/O services were removed from the child handle.
EFI_UNSUPPORTEDThe child handle does not support the I/O services that are being removed.
EFI_INVALID_PARAMETERChild handle is NULL.
EFI_ACCESS_DENIEDThe child handle could not be destroyed because its I/O services are being used.
otherThe child handle was not destroyed.

Definition at line 950 of file Ip6Driver.c.

Variable Documentation

◆ gIp6ComponentName

EFI_COMPONENT_NAME_PROTOCOL gIp6ComponentName
extern

Definition at line 145 of file ComponentName.c.

◆ gIp6ComponentName2

EFI_COMPONENT_NAME2_PROTOCOL gIp6ComponentName2
extern

Definition at line 154 of file ComponentName.c.

◆ gIp6ControllerNameTable

EFI_UNICODE_STRING_TABLE* gIp6ControllerNameTable
extern

Definition at line 171 of file ComponentName.c.

◆ gIp6DriverBinding

EFI_DRIVER_BINDING_PROTOCOL gIp6DriverBinding
extern

Definition at line 13 of file Ip6Driver.c.