]>
Commit | Line | Data |
---|---|---|
83cbd279 | 1 | /** @file\r |
2 | \r | |
3 | Copyright (c) 2005 - 2007, 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 | \r | |
13 | Module Name:\r | |
14 | \r | |
15 | Ip4Driver.h\r | |
16 | \r | |
17 | Abstract:\r | |
18 | \r | |
19 | \r | |
20 | **/\r | |
21 | \r | |
22 | #ifndef __EFI_IP4_DRIVER_H__\r | |
23 | #define __EFI_IP4_DRIVER_H__\r | |
24 | \r | |
25 | #include <Protocol/ServiceBinding.h>\r | |
26 | \r | |
27 | extern EFI_DRIVER_BINDING_PROTOCOL gIp4DriverBinding;\r | |
28 | extern EFI_COMPONENT_NAME_PROTOCOL gIp4ComponentName;\r | |
29 | extern EFI_COMPONENT_NAME2_PROTOCOL gIp4ComponentName2;\r | |
30 | \r | |
31 | //\r | |
32 | // Function prototype for the driver's entry point\r | |
33 | //\r | |
2ff29212 | 34 | /**\r |
35 | This is the declaration of an EFI image entry point. This entry point is\r | |
36 | the same for UEFI Applications, UEFI OS Loaders, and UEFI Drivers including\r | |
37 | both device drivers and bus drivers.\r | |
38 | \r | |
39 | The entry point for IP4 driver which install the driver\r | |
40 | binding and component name protocol on its image.\r | |
41 | \r | |
42 | @param ImageHandle The firmware allocated handle for the UEFI image.\r | |
43 | @param SystemTable A pointer to the EFI System Table.\r | |
44 | \r | |
45 | @retval EFI_SUCCESS The operation completed successfully.\r | |
46 | @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.\r | |
47 | \r | |
48 | **/\r | |
83cbd279 | 49 | EFI_STATUS\r |
50 | EFIAPI\r | |
51 | Ip4DriverEntryPoint (\r | |
52 | IN EFI_HANDLE ImageHandle,\r | |
53 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
54 | );\r | |
55 | \r | |
56 | //\r | |
57 | // Function prototypes for the Drivr Binding Protocol\r | |
58 | //\r | |
2ff29212 | 59 | /**\r |
60 | Test to see if this driver supports ControllerHandle. This service\r | |
61 | is called by the EFI boot service ConnectController(). In\r | |
62 | order to make drivers as small as possible, there are a few calling\r | |
63 | restrictions for this service. ConnectController() must\r | |
64 | follow these calling restrictions. If any other agent wishes to call\r | |
65 | Supported() it must also follow these calling restrictions.\r | |
66 | \r | |
67 | @param This Protocol instance pointer.\r | |
68 | @param ControllerHandle Handle of device to test\r | |
69 | @param RemainingDevicePath Optional parameter use to pick a specific child\r | |
70 | device to start.\r | |
71 | \r | |
72 | @retval EFI_SUCCESS This driver supports this device\r | |
73 | @retval EFI_ALREADY_STARTED This driver is already running on this device\r | |
74 | @retval other This driver does not support this device\r | |
75 | \r | |
76 | **/\r | |
83cbd279 | 77 | EFI_STATUS\r |
78 | EFIAPI\r | |
79 | Ip4DriverBindingSupported (\r | |
2ff29212 | 80 | IN EFI_DRIVER_BINDING_PROTOCOL * This,\r |
83cbd279 | 81 | IN EFI_HANDLE ControllerHandle,\r |
2ff29212 | 82 | IN EFI_DEVICE_PATH_PROTOCOL * RemainingDevicePath OPTIONAL\r |
83cbd279 | 83 | );\r |
84 | \r | |
2ff29212 | 85 | /**\r |
86 | Start this driver on ControllerHandle. This service is called by the\r | |
87 | EFI boot service ConnectController(). In order to make\r | |
88 | drivers as small as possible, there are a few calling restrictions for\r | |
89 | this service. ConnectController() must follow these\r | |
90 | calling restrictions. If any other agent wishes to call Start() it\r | |
91 | must also follow these calling restrictions.\r | |
92 | \r | |
93 | @param This Protocol instance pointer.\r | |
94 | @param ControllerHandle Handle of device to bind driver to\r | |
95 | @param RemainingDevicePath Optional parameter use to pick a specific child\r | |
96 | device to start.\r | |
97 | \r | |
98 | @retval EFI_SUCCESS This driver is added to ControllerHandle\r | |
99 | @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle\r | |
100 | @retval other This driver does not support this device\r | |
101 | \r | |
102 | **/\r | |
83cbd279 | 103 | EFI_STATUS\r |
104 | EFIAPI\r | |
105 | Ip4DriverBindingStart (\r | |
2ff29212 | 106 | IN EFI_DRIVER_BINDING_PROTOCOL * This,\r |
83cbd279 | 107 | IN EFI_HANDLE ControllerHandle,\r |
2ff29212 | 108 | IN EFI_DEVICE_PATH_PROTOCOL * RemainingDevicePath OPTIONAL\r |
83cbd279 | 109 | );\r |
110 | \r | |
2ff29212 | 111 | /**\r |
112 | Stop this driver on ControllerHandle. This service is called by the\r | |
113 | EFI boot service DisconnectController(). In order to\r | |
114 | make drivers as small as possible, there are a few calling\r | |
115 | restrictions for this service. DisconnectController()\r | |
116 | must follow these calling restrictions. If any other agent wishes\r | |
117 | to call Stop() it must also follow these calling restrictions.\r | |
118 | \r | |
119 | @param This Protocol instance pointer.\r | |
120 | @param ControllerHandle Handle of device to stop driver on\r | |
121 | @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of\r | |
122 | children is zero stop the entire bus driver.\r | |
123 | @param ChildHandleBuffer List of Child Handles to Stop.\r | |
124 | \r | |
125 | @retval EFI_SUCCESS This driver is removed ControllerHandle\r | |
126 | @retval other This driver was not removed from this device\r | |
127 | \r | |
128 | **/\r | |
83cbd279 | 129 | EFI_STATUS\r |
130 | EFIAPI\r | |
131 | Ip4DriverBindingStop (\r | |
132 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
133 | IN EFI_HANDLE ControllerHandle,\r | |
134 | IN UINTN NumberOfChildren,\r | |
135 | IN EFI_HANDLE *ChildHandleBuffer\r | |
136 | );\r | |
137 | \r | |
138 | //\r | |
139 | // Function ptototypes for the ServiceBinding Prococol\r | |
140 | //\r | |
2ff29212 | 141 | /**\r |
142 | Creates a child handle with a set of I/O services.\r | |
143 | \r | |
144 | @param This Protocol instance pointer.\r | |
145 | @param ChildHandle Pointer to the handle of the child to create. If it is NULL,\r | |
146 | then a new handle is created. If it is not NULL, then the\r | |
147 | I/O services are added to the existing child handle.\r | |
148 | \r | |
149 | @retval EFI_SUCCES The child handle was created with the I/O services\r | |
150 | @retval EFI_INVALID_PARAMETER ChildHandle is NULL.\r | |
151 | @retval EFI_OUT_OF_RESOURCES There are not enough resources availabe to create\r | |
152 | the child\r | |
153 | @retval other The child handle was not created\r | |
154 | \r | |
155 | **/\r | |
83cbd279 | 156 | EFI_STATUS\r |
157 | EFIAPI\r | |
158 | Ip4ServiceBindingCreateChild (\r | |
159 | IN EFI_SERVICE_BINDING_PROTOCOL *This,\r | |
2ff29212 | 160 | IN OUT EFI_HANDLE *ChildHandle\r |
83cbd279 | 161 | );\r |
162 | \r | |
2ff29212 | 163 | /**\r |
164 | Destroys a child handle with a set of I/O services.\r | |
165 | \r | |
166 | @param This Protocol instance pointer.\r | |
167 | @param ChildHandle Handle of the child to destroy\r | |
168 | \r | |
169 | @retval EFI_SUCCES The I/O services were removed from the child handle\r | |
170 | @retval EFI_UNSUPPORTED The child handle does not support the I/O services\r | |
171 | that are being removed.\r | |
172 | @retval EFI_INVALID_PARAMETER Child handle is not a valid EFI Handle.\r | |
173 | @retval EFI_ACCESS_DENIED The child handle could not be destroyed because its\r | |
174 | I/O services are being used.\r | |
175 | @retval other The child handle was not destroyed\r | |
176 | \r | |
177 | **/\r | |
83cbd279 | 178 | EFI_STATUS\r |
179 | EFIAPI\r | |
180 | Ip4ServiceBindingDestroyChild (\r | |
181 | IN EFI_SERVICE_BINDING_PROTOCOL *This,\r | |
182 | IN EFI_HANDLE ChildHandle\r | |
183 | );\r | |
184 | #endif\r |