1/** @file
2  Driver Binding functions and Service Binding functions
3  declaration for Mtftp6 Driver.
4
5  Copyright (c) 2009 - 2012, Intel Corporation. All rights reserved.<BR>
6
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.
11
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.
14
15**/
16
17#ifndef __EFI_MTFTP6_DRIVER_H__
18#define __EFI_MTFTP6_DRIVER_H__
19
20#include <Protocol/ServiceBinding.h>
21
22extern EFI_COMPONENT_NAME_PROTOCOL  gMtftp6ComponentName;
23extern EFI_COMPONENT_NAME2_PROTOCOL gMtftp6ComponentName2;
24extern EFI_UNICODE_STRING_TABLE     *gMtftp6ControllerNameTable;
25
26/**
27  Test to see if this driver supports Controller. This service
28  is called by the EFI boot service ConnectController(). In
29  order to make drivers as small as possible, there are a few calling
30  restrictions for this service. ConnectController() must
31  follow these calling restrictions. If any other agent wishes to call
32  Supported(), it must also follow these calling restrictions.
33
34  @param[in]  This                Protocol instance pointer.
35  @param[in]  Controller          Handle of device to test.
36  @param[in]  RemainingDevicePath Optional parameter use to pick a specific child
37                                  device to start.
38
39  @retval EFI_SUCCESS         This driver supports this device.
40  @retval Others              This driver does not support this device.
41
42**/
43EFI_STATUS
44EFIAPI
45Mtftp6DriverBindingSupported (
46  IN EFI_DRIVER_BINDING_PROTOCOL  *This,
47  IN EFI_HANDLE                   Controller,
48  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath
49  );
50
51/**
52  Start this driver on Controller. This service is called by the
53  EFI boot service ConnectController(). In order to make
54  drivers as small as possible, there are calling restrictions for
55  this service. ConnectController() must follow these
56  calling restrictions. If any other agent wishes to call Start() it
57  must also follow these calling restrictions.
58
59  @param[in]  This                 Protocol instance pointer.
60  @param[in]  Controller           Handle of device to bind driver to.
61  @param[in]  RemainingDevicePath  Optional parameter use to pick a specific child
62                                   device to start.
63
64  @retval EFI_SUCCESS          This driver is added to Controller.
65  @retval EFI_ALREADY_STARTED  This driver is already running on Controller.
66  @retval Others               This driver does not support this device.
67
68**/
69EFI_STATUS
70EFIAPI
71Mtftp6DriverBindingStart (
72  IN EFI_DRIVER_BINDING_PROTOCOL  *This,
73  IN EFI_HANDLE                   Controller,
74  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath
75  );
76
77/**
78  Stop this driver on Controller. This service is called by the
79  EFI boot service DisconnectController(). In order to
80  make drivers as small as possible, there are calling
81  restrictions for this service. DisconnectController()
82  must follow these calling restrictions. If any other agent wishes
83  to call Stop(), it must also follow these calling restrictions.
84
85  @param[in]  This              Protocol instance pointer.
86  @param[in]  Controller        Handle of device to stop driver on
87  @param[in]  NumberOfChildren  Number of Handles in ChildHandleBuffer. If number of
88                                children is zero, stop the entire bus driver.
89  @param[in]  ChildHandleBuffer List of Child Handles to Stop.
90
91  @retval EFI_SUCCESS       This driver is removed Controller.
92  @retval EFI_DEVICE_ERROR  An unexpected error.
93  @retval Others            This driver was not removed from this device.
94
95**/
96EFI_STATUS
97EFIAPI
98Mtftp6DriverBindingStop (
99  IN  EFI_DRIVER_BINDING_PROTOCOL *This,
100  IN  EFI_HANDLE                  Controller,
101  IN  UINTN                       NumberOfChildren,
102  IN  EFI_HANDLE                  *ChildHandleBuffer
103  );
104
105/**
106  Creates a child handle and installs a protocol.
107
108  The CreateChild() function installs a protocol on ChildHandle.
109  If ChildHandle is a pointer to NULL, then a new handle is created and returned in ChildHandle.
110  If ChildHandle is not a pointer to NULL, then the protocol installs on the existing ChildHandle.
111
112  @param[in]      This        Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
113  @param[in, out] ChildHandle Pointer to the handle of the child to create. If it is NULL,
114                              then a new handle is created. If it is a pointer to an existing
115                              UEFI handle, then the protocol is added to the existing UEFI handle.
116
117  @retval EFI_SUCCES            The protocol was added to ChildHandle.
118  @retval EFI_INVALID_PARAMETER ChildHandle is NULL.
119  @retval Others                The child handle was not created.
120
121**/
122EFI_STATUS
123EFIAPI
124Mtftp6ServiceBindingCreateChild (
125  IN     EFI_SERVICE_BINDING_PROTOCOL *This,
126  IN OUT EFI_HANDLE                   *ChildHandle
127  );
128
129/**
130  Destroys a child handle with a protocol installed on it.
131
132  The DestroyChild() function does the opposite of CreateChild(). It removes a protocol
133  that was installed by CreateChild() from ChildHandle. If the removed protocol is the
134  last protocol on ChildHandle, then ChildHandle is destroyed.
135
136  @param[in]  This        Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
137  @param[in]  ChildHandle Handle of the child to destroy.
138
139  @retval EFI_SUCCES            The protocol was removed from ChildHandle.
140  @retval EFI_UNSUPPORTED       ChildHandle does not support the protocol that is being removed.
141  @retval EFI_INVALID_PARAMETER Child handle is NULL.
142  @retval Others                The child handle was not destroyed
143
144**/
145EFI_STATUS
146EFIAPI
147Mtftp6ServiceBindingDestroyChild (
148  IN EFI_SERVICE_BINDING_PROTOCOL *This,
149  IN EFI_HANDLE                   ChildHandle
150  );
151
152#endif
153