]> git.proxmox.com Git - mirror_edk2.git/blame - NetworkPkg/Mtftp6Dxe/Mtftp6Driver.h
ShellPkg/UefiShellAcpiViewCommandLib: Fix VS2017 compilation errors
[mirror_edk2.git] / NetworkPkg / Mtftp6Dxe / Mtftp6Driver.h
CommitLineData
a3bcde70
HT
1/** @file\r
2 Driver Binding functions and Service Binding functions\r
3 declaration for Mtftp6 Driver.\r
4\r
216f7970 5 Copyright (c) 2009 - 2012, Intel Corporation. All rights reserved.<BR>\r
a3bcde70
HT
6\r
7 This program and the accompanying materials\r
8 are licensed and made available under the terms and conditions of the BSD License\r
9 which accompanies this distribution. The full text of the license may be found at\r
10 http://opensource.org/licenses/bsd-license.php.\r
11\r
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
14\r
15**/\r
16\r
17#ifndef __EFI_MTFTP6_DRIVER_H__\r
18#define __EFI_MTFTP6_DRIVER_H__\r
19\r
20#include <Protocol/ServiceBinding.h>\r
21\r
22extern EFI_COMPONENT_NAME_PROTOCOL gMtftp6ComponentName;\r
23extern EFI_COMPONENT_NAME2_PROTOCOL gMtftp6ComponentName2;\r
216f7970 24extern EFI_UNICODE_STRING_TABLE *gMtftp6ControllerNameTable;\r
a3bcde70
HT
25\r
26/**\r
76389e18 27 Test to see if this driver supports Controller. This service\r
a3bcde70
HT
28 is called by the EFI boot service ConnectController(). In\r
29 order to make drivers as small as possible, there are a few calling\r
30 restrictions for this service. ConnectController() must\r
31 follow these calling restrictions. If any other agent wishes to call\r
32 Supported(), it must also follow these calling restrictions.\r
33\r
34 @param[in] This Protocol instance pointer.\r
76389e18 35 @param[in] Controller Handle of device to test.\r
a3bcde70
HT
36 @param[in] RemainingDevicePath Optional parameter use to pick a specific child\r
37 device to start.\r
38\r
39 @retval EFI_SUCCESS This driver supports this device.\r
40 @retval Others This driver does not support this device.\r
41\r
42**/\r
43EFI_STATUS\r
44EFIAPI\r
45Mtftp6DriverBindingSupported (\r
46 IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
47 IN EFI_HANDLE Controller,\r
48 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
49 );\r
50\r
51/**\r
76389e18 52 Start this driver on Controller. This service is called by the\r
a3bcde70
HT
53 EFI boot service ConnectController(). In order to make\r
54 drivers as small as possible, there are calling restrictions for\r
55 this service. ConnectController() must follow these\r
56 calling restrictions. If any other agent wishes to call Start() it\r
57 must also follow these calling restrictions.\r
58\r
59 @param[in] This Protocol instance pointer.\r
76389e18 60 @param[in] Controller Handle of device to bind driver to.\r
a3bcde70
HT
61 @param[in] RemainingDevicePath Optional parameter use to pick a specific child\r
62 device to start.\r
63\r
76389e18 64 @retval EFI_SUCCESS This driver is added to Controller.\r
65 @retval EFI_ALREADY_STARTED This driver is already running on Controller.\r
a3bcde70
HT
66 @retval Others This driver does not support this device.\r
67\r
68**/\r
69EFI_STATUS\r
70EFIAPI\r
71Mtftp6DriverBindingStart (\r
72 IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
73 IN EFI_HANDLE Controller,\r
74 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
75 );\r
76\r
77/**\r
76389e18 78 Stop this driver on Controller. This service is called by the\r
a3bcde70
HT
79 EFI boot service DisconnectController(). In order to\r
80 make drivers as small as possible, there are calling\r
81 restrictions for this service. DisconnectController()\r
82 must follow these calling restrictions. If any other agent wishes\r
83 to call Stop(), it must also follow these calling restrictions.\r
84\r
85 @param[in] This Protocol instance pointer.\r
76389e18 86 @param[in] Controller Handle of device to stop driver on\r
a3bcde70
HT
87 @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer. If number of\r
88 children is zero, stop the entire bus driver.\r
89 @param[in] ChildHandleBuffer List of Child Handles to Stop.\r
90\r
76389e18 91 @retval EFI_SUCCESS This driver is removed Controller.\r
a3bcde70
HT
92 @retval EFI_DEVICE_ERROR An unexpected error.\r
93 @retval Others This driver was not removed from this device.\r
94\r
95**/\r
96EFI_STATUS\r
97EFIAPI\r
98Mtftp6DriverBindingStop (\r
99 IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
100 IN EFI_HANDLE Controller,\r
101 IN UINTN NumberOfChildren,\r
102 IN EFI_HANDLE *ChildHandleBuffer\r
103 );\r
104\r
105/**\r
106 Creates a child handle and installs a protocol.\r
107\r
108 The CreateChild() function installs a protocol on ChildHandle.\r
109 If ChildHandle is a pointer to NULL, then a new handle is created and returned in ChildHandle.\r
110 If ChildHandle is not a pointer to NULL, then the protocol installs on the existing ChildHandle.\r
111\r
112 @param[in] This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r
113 @param[in, out] ChildHandle Pointer to the handle of the child to create. If it is NULL,\r
114 then a new handle is created. If it is a pointer to an existing\r
115 UEFI handle, then the protocol is added to the existing UEFI handle.\r
116\r
117 @retval EFI_SUCCES The protocol was added to ChildHandle.\r
118 @retval EFI_INVALID_PARAMETER ChildHandle is NULL.\r
119 @retval Others The child handle was not created.\r
120\r
121**/\r
122EFI_STATUS\r
123EFIAPI\r
124Mtftp6ServiceBindingCreateChild (\r
125 IN EFI_SERVICE_BINDING_PROTOCOL *This,\r
126 IN OUT EFI_HANDLE *ChildHandle\r
127 );\r
128\r
129/**\r
130 Destroys a child handle with a protocol installed on it.\r
131\r
132 The DestroyChild() function does the opposite of CreateChild(). It removes a protocol\r
133 that was installed by CreateChild() from ChildHandle. If the removed protocol is the\r
134 last protocol on ChildHandle, then ChildHandle is destroyed.\r
135\r
136 @param[in] This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r
137 @param[in] ChildHandle Handle of the child to destroy.\r
138\r
139 @retval EFI_SUCCES The protocol was removed from ChildHandle.\r
140 @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed.\r
15ee13fc 141 @retval EFI_INVALID_PARAMETER Child handle is NULL.\r
a3bcde70
HT
142 @retval Others The child handle was not destroyed\r
143\r
144**/\r
145EFI_STATUS\r
146EFIAPI\r
147Mtftp6ServiceBindingDestroyChild (\r
148 IN EFI_SERVICE_BINDING_PROTOCOL *This,\r
149 IN EFI_HANDLE ChildHandle\r
150 );\r
151\r
152#endif\r