]>
Commit | Line | Data |
---|---|---|
83cbd279 | 1 | /** @file\r |
2 | \r | |
3 | Copyright (c) 2006, Intel Corporation\r | |
4 | All rights reserved. This program and the accompanying materials\r | |
5 | are licensed and made available under the terms and conditions of the BSD License\r | |
6 | which accompanies this distribution. The full text of the license may be found at\r | |
7 | http://opensource.org/licenses/bsd-license.php\r | |
8 | \r | |
9 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
10 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
11 | \r | |
12 | Module Name:\r | |
13 | \r | |
14 | Udp4Driver.h\r | |
15 | \r | |
16 | Abstract:\r | |
17 | \r | |
18 | \r | |
19 | **/\r | |
20 | \r | |
21 | #ifndef _UDP4_DRIVER_H_\r | |
22 | #define _UDP4_DRIVER_H_\r | |
23 | \r | |
24 | #include <PiDxe.h>\r | |
25 | #include <Library/BaseLib.h>\r | |
26 | #include <Library/NetLib.h>\r | |
27 | #include <Protocol/DriverBinding.h>\r | |
28 | #include <Protocol/ServiceBinding.h>\r | |
29 | \r | |
ce904bae | 30 | /**\r |
31 | Test to see if this driver supports ControllerHandle. This service\r | |
32 | is called by the EFI boot service ConnectController(). In\r | |
33 | order to make drivers as small as possible, there are a few calling\r | |
34 | restrictions for this service. ConnectController() must\r | |
35 | follow these calling restrictions. If any other agent wishes to call\r | |
36 | Supported() it must also follow these calling restrictions.\r | |
37 | \r | |
38 | @param This Protocol instance pointer.\r | |
39 | @param ControllerHandle Handle of device to test\r | |
40 | @param RemainingDevicePath Optional parameter use to pick a specific child\r | |
41 | device to start.\r | |
42 | \r | |
43 | @retval EFI_SUCCESS This driver supports this device\r | |
44 | @retval EFI_ALREADY_STARTED This driver is already running on this device\r | |
45 | @retval other This driver does not support this device\r | |
46 | \r | |
47 | **/\r | |
83cbd279 | 48 | EFI_STATUS\r |
49 | EFIAPI\r | |
50 | Udp4DriverBindingSupported (\r | |
51 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
52 | IN EFI_HANDLE ControllerHandle,\r | |
53 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL\r | |
54 | );\r | |
55 | \r | |
ce904bae | 56 | /**\r |
57 | Start this driver on ControllerHandle. This service is called by the\r | |
58 | EFI boot service ConnectController(). In order to make\r | |
59 | drivers as small as possible, there are a few calling restrictions for\r | |
60 | this service. ConnectController() must follow these\r | |
61 | calling restrictions. If any other agent wishes to call Start() it\r | |
62 | must also follow these calling restrictions.\r | |
63 | \r | |
64 | @param This Protocol instance pointer.\r | |
65 | @param ControllerHandle Handle of device to bind driver to\r | |
66 | @param RemainingDevicePath Optional parameter use to pick a specific child\r | |
67 | device to start.\r | |
68 | \r | |
69 | @retval EFI_SUCCESS This driver is added to ControllerHandle\r | |
70 | @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle\r | |
71 | @retval other This driver does not support this device\r | |
72 | \r | |
73 | **/\r | |
83cbd279 | 74 | EFI_STATUS\r |
75 | EFIAPI\r | |
76 | Udp4DriverBindingStart (\r | |
77 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
78 | IN EFI_HANDLE ControllerHandle,\r | |
79 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL\r | |
80 | );\r | |
81 | \r | |
ce904bae | 82 | /**\r |
83 | Stop this driver on ControllerHandle. This service is called by the\r | |
84 | EFI boot service DisconnectController(). In order to\r | |
85 | make drivers as small as possible, there are a few calling\r | |
86 | restrictions for this service. DisconnectController()\r | |
87 | must follow these calling restrictions. If any other agent wishes\r | |
88 | to call Stop() it must also follow these calling restrictions.\r | |
89 | \r | |
90 | @param This Protocol instance pointer.\r | |
91 | @param ControllerHandle Handle of device to stop driver on\r | |
92 | @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of\r | |
93 | children is zero stop the entire bus driver.\r | |
94 | @param ChildHandleBuffer List of Child Handles to Stop.\r | |
95 | \r | |
96 | @retval EFI_SUCCESS This driver is removed ControllerHandle\r | |
97 | @retval other This driver was not removed from this device\r | |
98 | \r | |
99 | **/\r | |
83cbd279 | 100 | EFI_STATUS\r |
101 | EFIAPI\r | |
102 | Udp4DriverBindingStop (\r | |
103 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
104 | IN EFI_HANDLE ControllerHandle,\r | |
105 | IN UINTN NumberOfChildren,\r | |
106 | IN EFI_HANDLE *ChildHandleBuffer\r | |
107 | );\r | |
108 | \r | |
ce904bae | 109 | /**\r |
110 | Creates a child handle with a set of I/O services.\r | |
111 | \r | |
112 | @param This Protocol instance pointer.\r | |
113 | @param 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 not NULL, then the\r | |
115 | I/O services are added to the existing child handle.\r | |
116 | \r | |
117 | @retval EFI_SUCCES The child handle was created with the I/O services\r | |
118 | @retval EFI_INVALID_PARAMETER ChildHandle is NULL.\r | |
119 | @retval EFI_OUT_OF_RESOURCES There are not enough resources availabe to create\r | |
120 | the child\r | |
121 | @retval other The child handle was not created\r | |
122 | \r | |
123 | **/\r | |
83cbd279 | 124 | EFI_STATUS\r |
125 | EFIAPI\r | |
126 | Udp4ServiceBindingCreateChild (\r | |
127 | IN EFI_SERVICE_BINDING_PROTOCOL *This,\r | |
128 | IN EFI_HANDLE *ChildHandle\r | |
129 | );\r | |
130 | \r | |
ce904bae | 131 | /**\r |
132 | Destroys a child handle with a set of I/O services.\r | |
133 | \r | |
134 | @param This Protocol instance pointer.\r | |
135 | @param ChildHandle Handle of the child to destroy\r | |
136 | \r | |
137 | @retval EFI_SUCCES The I/O services were removed from the child handle\r | |
138 | @retval EFI_UNSUPPORTED The child handle does not support the I/O services\r | |
139 | that are being removed.\r | |
140 | @retval EFI_INVALID_PARAMETER Child handle is not a valid EFI Handle.\r | |
141 | @retval EFI_ACCESS_DENIED The child handle could not be destroyed because its\r | |
142 | I/O services are being used.\r | |
143 | @retval other The child handle was not destroyed\r | |
144 | \r | |
145 | **/\r | |
83cbd279 | 146 | EFI_STATUS\r |
147 | EFIAPI\r | |
148 | Udp4ServiceBindingDestroyChild (\r | |
149 | IN EFI_SERVICE_BINDING_PROTOCOL *This,\r | |
150 | IN EFI_HANDLE ChildHandle\r | |
151 | );\r | |
152 | \r | |
153 | #endif\r | |
154 | \r |