2 Driver Binding functions and Service Binding functions
3 declaration for Mtftp6 Driver.
5 Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>
7 This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php.
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
17 #ifndef __EFI_MTFTP6_DRIVER_H__
18 #define __EFI_MTFTP6_DRIVER_H__
20 #include <Protocol/ServiceBinding.h>
22 extern EFI_COMPONENT_NAME_PROTOCOL gMtftp6ComponentName
;
23 extern EFI_COMPONENT_NAME2_PROTOCOL gMtftp6ComponentName2
;
26 Test to see if this driver supports Controller. This service
27 is called by the EFI boot service ConnectController(). In
28 order to make drivers as small as possible, there are a few calling
29 restrictions for this service. ConnectController() must
30 follow these calling restrictions. If any other agent wishes to call
31 Supported(), it must also follow these calling restrictions.
33 @param[in] This Protocol instance pointer.
34 @param[in] Controller Handle of device to test.
35 @param[in] RemainingDevicePath Optional parameter use to pick a specific child
38 @retval EFI_SUCCESS This driver supports this device.
39 @retval Others This driver does not support this device.
44 Mtftp6DriverBindingSupported (
45 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
46 IN EFI_HANDLE Controller
,
47 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
51 Start this driver on Controller. This service is called by the
52 EFI boot service ConnectController(). In order to make
53 drivers as small as possible, there are calling restrictions for
54 this service. ConnectController() must follow these
55 calling restrictions. If any other agent wishes to call Start() it
56 must also follow these calling restrictions.
58 @param[in] This Protocol instance pointer.
59 @param[in] Controller Handle of device to bind driver to.
60 @param[in] RemainingDevicePath Optional parameter use to pick a specific child
63 @retval EFI_SUCCESS This driver is added to Controller.
64 @retval EFI_ALREADY_STARTED This driver is already running on Controller.
65 @retval Others This driver does not support this device.
70 Mtftp6DriverBindingStart (
71 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
72 IN EFI_HANDLE Controller
,
73 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
77 Stop this driver on Controller. This service is called by the
78 EFI boot service DisconnectController(). In order to
79 make drivers as small as possible, there are calling
80 restrictions for this service. DisconnectController()
81 must follow these calling restrictions. If any other agent wishes
82 to call Stop(), it must also follow these calling restrictions.
84 @param[in] This Protocol instance pointer.
85 @param[in] Controller Handle of device to stop driver on
86 @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
87 children is zero, stop the entire bus driver.
88 @param[in] ChildHandleBuffer List of Child Handles to Stop.
90 @retval EFI_SUCCESS This driver is removed Controller.
91 @retval EFI_DEVICE_ERROR An unexpected error.
92 @retval Others This driver was not removed from this device.
97 Mtftp6DriverBindingStop (
98 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
99 IN EFI_HANDLE Controller
,
100 IN UINTN NumberOfChildren
,
101 IN EFI_HANDLE
*ChildHandleBuffer
105 Creates a child handle and installs a protocol.
107 The CreateChild() function installs a protocol on ChildHandle.
108 If ChildHandle is a pointer to NULL, then a new handle is created and returned in ChildHandle.
109 If ChildHandle is not a pointer to NULL, then the protocol installs on the existing ChildHandle.
111 @param[in] This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
112 @param[in, out] ChildHandle Pointer to the handle of the child to create. If it is NULL,
113 then a new handle is created. If it is a pointer to an existing
114 UEFI handle, then the protocol is added to the existing UEFI handle.
116 @retval EFI_SUCCES The protocol was added to ChildHandle.
117 @retval EFI_INVALID_PARAMETER ChildHandle is NULL.
118 @retval Others The child handle was not created.
123 Mtftp6ServiceBindingCreateChild (
124 IN EFI_SERVICE_BINDING_PROTOCOL
*This
,
125 IN OUT EFI_HANDLE
*ChildHandle
129 Destroys a child handle with a protocol installed on it.
131 The DestroyChild() function does the opposite of CreateChild(). It removes a protocol
132 that was installed by CreateChild() from ChildHandle. If the removed protocol is the
133 last protocol on ChildHandle, then ChildHandle is destroyed.
135 @param[in] This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
136 @param[in] ChildHandle Handle of the child to destroy.
138 @retval EFI_SUCCES The protocol was removed from ChildHandle.
139 @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed.
140 @retval EFI_INVALID_PARAMETER Child handle is NULL.
141 @retval Others The child handle was not destroyed
146 Mtftp6ServiceBindingDestroyChild (
147 IN EFI_SERVICE_BINDING_PROTOCOL
*This
,
148 IN EFI_HANDLE ChildHandle