2 The driver binding and service binding protocol for IP6 driver.
4 Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php.
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16 #ifndef __EFI_IP6_DRIVER_H__
17 #define __EFI_IP6_DRIVER_H__
19 extern EFI_DRIVER_BINDING_PROTOCOL gIp6DriverBinding
;
20 extern EFI_COMPONENT_NAME_PROTOCOL gIp6ComponentName
;
21 extern EFI_COMPONENT_NAME2_PROTOCOL gIp6ComponentName2
;
24 Clean up an IP6 service binding instance. It releases all
25 the resource allocated by the instance. The instance may be
26 partly initialized, or partly destroyed. If a resource is
27 destroyed, it is marked as that in case the destory failed and
28 being called again later.
30 @param[in] IpSb The IP6 service binding instance to clean up.
32 @retval EFI_SUCCESS The resource used by the instance are cleaned up.
33 @retval Others Failed to clean up some of the resources.
42 // Function prototype for the driver's entry point
46 This is the declaration of an EFI image entry point. This entry point is
47 the same for UEFI Applications, UEFI OS Loaders, and UEFI Drivers including
48 both device drivers and bus drivers.
50 The entry point for IP6 driver which installs the driver
51 binding and component name protocol on its image.
53 @param[in] ImageHandle The firmware allocated handle for the UEFI image.
54 @param[in] SystemTable A pointer to the EFI System Table.
56 @retval EFI_SUCCESS The operation completed successfully.
57 @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
63 IN EFI_HANDLE ImageHandle
,
64 IN EFI_SYSTEM_TABLE
*SystemTable
68 // Function prototypes for the Drivr Binding Protocol
72 Test to see if this driver supports ControllerHandle.
74 @param[in] This Protocol instance pointer.
75 @param[in] ControllerHandle Handle of device to test.
76 @param[in] RemainingDevicePath Optional parameter use to pick a specific child
79 @retval EFI_SUCCESS This driver supports this device.
80 @retval EFI_ALREADY_STARTED This driver is already running on this device.
81 @retval other This driver does not support this device.
86 Ip6DriverBindingSupported (
87 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
88 IN EFI_HANDLE ControllerHandle
,
89 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath OPTIONAL
93 Start this driver on ControllerHandle.
95 @param[in] This Protocol instance pointer.
96 @param[in] ControllerHandle Handle of device to bind driver to.
97 @param[in] RemainingDevicePath Optional parameter used to pick a specific child
100 @retval EFI_SUCCES This driver is added to ControllerHandle.
101 @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle.
102 @retval other This driver does not support this device.
107 Ip6DriverBindingStart (
108 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
109 IN EFI_HANDLE ControllerHandle
,
110 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath OPTIONAL
114 Stop this driver on ControllerHandle.
116 @param[in] This Protocol instance pointer.
117 @param[in] ControllerHandle Handle of device to stop driver on.
118 @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer. If number
119 of children is zero, stop the entire bus driver.
120 @param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL
121 if NumberOfChildren is 0.
123 @retval EFI_SUCCESS The device was stopped.
124 @retval EFI_DEVICE_ERROR The device could not be stopped due to a device error.
129 Ip6DriverBindingStop (
130 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
131 IN EFI_HANDLE ControllerHandle
,
132 IN UINTN NumberOfChildren
,
133 IN EFI_HANDLE
*ChildHandleBuffer OPTIONAL
137 // Function ptototypes for the ServiceBinding Prococol
141 Creates a child handle with a set of I/O services.
143 @param[in] This Protocol instance pointer.
144 @param[in] ChildHandle Pointer to the handle of the child to create. If
145 it is NULL, then a new handle is created. If it
146 is not NULL, then the I/O services are added to
147 the existing child handle.
149 @retval EFI_SUCCES The child handle was created with the I/O services.
150 @retval EFI_OUT_OF_RESOURCES There are not enough resources availabe to create
152 @retval other The child handle was not created.
157 Ip6ServiceBindingCreateChild (
158 IN EFI_SERVICE_BINDING_PROTOCOL
*This
,
159 IN EFI_HANDLE
*ChildHandle
163 Destroys a child handle with a set of I/O services.
165 @param[in] This Protocol instance pointer.
166 @param[in] ChildHandle Handle of the child to destroy.
168 @retval EFI_SUCCES The I/O services were removed from the child
170 @retval EFI_UNSUPPORTED The child handle does not support the I/O services
171 that are being removed.
172 @retval EFI_INVALID_PARAMETER Child handle is not a valid EFI Handle.
173 @retval EFI_ACCESS_DENIED The child handle could not be destroyed because
174 its I/O services are being used.
175 @retval other The child handle was not destroyed.
180 Ip6ServiceBindingDestroyChild (
181 IN EFI_SERVICE_BINDING_PROTOCOL
*This
,
182 IN EFI_HANDLE ChildHandle