]> git.proxmox.com Git - mirror_edk2.git/blame - MdeModulePkg/Universal/Network/ArpDxe/ArpDriver.h
Remove some useless EDK_RELEASE_VERSION, EFI_SPECIFICATION_VERSION definition.
[mirror_edk2.git] / MdeModulePkg / Universal / Network / ArpDxe / ArpDriver.h
CommitLineData
83cbd279 1/** @file\r
2\r
7bce0c5a 3Copyright (c) 2006 - 2008, Intel Corporation\r
83cbd279 4All rights reserved. This program and the accompanying materials\r
5are licensed and made available under the terms and conditions of the BSD License\r
6which accompanies this distribution. The full text of the license may be found at\r
7http://opensource.org/licenses/bsd-license.php\r
8\r
9THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
10WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
11\r
12Module Name:\r
13\r
14 ArpDriver.c\r
15\r
16Abstract:\r
17\r
18\r
19**/\r
20\r
21#ifndef _ARP_DRIVER_H_\r
22#define _ARP_DRIVER_H_\r
23\r
772db4bb 24\r
25#include <PiDxe.h>\r
26\r
27#include <Protocol/Arp.h>\r
83cbd279 28#include <Protocol/ManagedNetwork.h>\r
772db4bb 29#include <Protocol/ServiceBinding.h>\r
30\r
31#include <Library/DebugLib.h>\r
32#include <Library/UefiDriverEntryPoint.h>\r
33#include <Library/UefiBootServicesTableLib.h>\r
83cbd279 34#include <Library/UefiLib.h>\r
35\r
83cbd279 36\r
37//\r
38// Global variables\r
39//\r
40extern EFI_DRIVER_BINDING_PROTOCOL gArpDriverBinding;\r
41extern EFI_COMPONENT_NAME_PROTOCOL gArpComponentName;\r
42extern EFI_COMPONENT_NAME2_PROTOCOL gArpComponentName2;\r
43\r
7bce0c5a 44/**\r
45 Test to see if this driver supports ControllerHandle.\r
46\r
47 @param This Protocol instance pointer.\r
48 @param ControllerHandle Handle of device to test.\r
49 @param RemainingDevicePath Optional parameter use to pick a specific child\r
50 device to start.\r
51\r
52 @retval EFI_SUCCES This driver supports this device\r
53 @retval EFI_ALREADY_STARTED This driver is already running on this device.\r
54 @retval other This driver does not support this device.\r
55\r
56**/\r
83cbd279 57EFI_STATUS\r
58EFIAPI\r
59ArpDriverBindingSupported (\r
60 IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
61 IN EFI_HANDLE ControllerHandle,\r
62 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL\r
63 );\r
64\r
7bce0c5a 65/**\r
66 Start this driver on ControllerHandle.\r
67\r
68 @param This Protocol instance pointer.\r
69 @param ControllerHandle Handle of device to bind driver to\r
70 @param RemainingDevicePath Optional parameter use to pick a specific child\r
71 device to start.\r
72\r
73 @retval EFI_SUCCES This driver is added to ControllerHandle\r
74 @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle\r
75 @retval other This driver does not support this device\r
76\r
77**/\r
83cbd279 78EFI_STATUS\r
79EFIAPI\r
80ArpDriverBindingStart (\r
81 IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
82 IN EFI_HANDLE ControllerHandle,\r
83 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL\r
84 );\r
85\r
7bce0c5a 86/**\r
87 Stop this driver on ControllerHandle.\r
88\r
89 @param This Protocol instance pointer.\r
90 @param ControllerHandle Handle of device to stop driver on\r
91 @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number\r
92 of children is zero stop the entire bus driver.\r
93 @param ChildHandleBuffer List of Child Handles to Stop.\r
94\r
95 @retval EFI_SUCCES This driver is removed ControllerHandle\r
96 @retval other This driver was not removed from this device\r
97\r
98**/\r
83cbd279 99EFI_STATUS\r
100EFIAPI\r
101ArpDriverBindingStop (\r
102 IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
103 IN EFI_HANDLE ControllerHandle,\r
104 IN UINTN NumberOfChildren,\r
105 IN EFI_HANDLE *ChildHandleBuffer\r
106 );\r
107\r
7bce0c5a 108/**\r
109 Creates a child handle with a set of I/O services.\r
110\r
111 @param This Protocol instance pointer.\r
112 @param ChildHandle Pointer to the handle of the child to create. If\r
113 it is NULL, then a new handle is created. If it is\r
114 not NULL, then the I/O services are added to the\r
115 existing child handle.\r
116\r
117 @retval EFI_SUCCES The child handle was created with the I/O\r
118 services.\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 124EFI_STATUS\r
125EFIAPI\r
126ArpServiceBindingCreateChild (\r
127 IN EFI_SERVICE_BINDING_PROTOCOL *This,\r
128 IN EFI_HANDLE *ChildHandle\r
129 );\r
130\r
7bce0c5a 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\r
138 handle.\r
139 @retval EFI_UNSUPPORTED The child handle does not support the I/O services\r
140 that are being removed.\r
141 @retval EFI_INVALID_PARAMETER Child handle is not a valid EFI Handle.\r
142 @retval EFI_ACCESS_DENIED The child handle could not be destroyed because\r
143 its I/O services are being used.\r
144 @retval other The child handle was not destroyed.\r
145\r
146**/\r
83cbd279 147EFI_STATUS\r
148EFIAPI\r
149ArpServiceBindingDestroyChild (\r
150 IN EFI_SERVICE_BINDING_PROTOCOL *This,\r
151 IN EFI_HANDLE ChildHandle\r
152 );\r
153\r
154#endif\r
155\r