/** @file\r
ARP driver functions.\r
- \r
-Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials\r
-are licensed and made available under the terms and conditions of the BSD License\r
-which accompanies this distribution. The full text of the license may be found at<BR>\r
-http://opensource.org/licenses/bsd-license.php\r
\r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
context data.\r
\r
@retval EFI_SUCCESS The arp service context is initialized.\r
- \r
+\r
@retval EFI_UNSUPPORTED The underlayer Snp mode type is not ethernet.\r
Failed to initialize the service context.\r
@retval other Failed to initialize the arp service context.\r
\r
/**\r
Callback function which provided by user to remove one node in NetDestroyLinkList process.\r
- \r
+\r
@param[in] Entry The entry to be removed.\r
@param[in] Context Pointer to the callback context corresponds to the Context in NetDestroyLinkList.\r
\r
\r
**/\r
EFI_STATUS\r
+EFIAPI\r
ArpDestroyChildEntryInHandleBuffer (\r
IN LIST_ENTRY *Entry,\r
IN VOID *Context\r
-)\r
+ )\r
{\r
ARP_INSTANCE_DATA *Instance;\r
EFI_SERVICE_BINDING_PROTOCOL *ServiceBinding;\r
- \r
+\r
if (Entry == NULL || Context == NULL) {\r
return EFI_INVALID_PARAMETER;\r
}\r
}\r
\r
/**\r
- Tests to see if this driver supports a given controller. \r
- \r
- If a child device is provided, it further tests to see if this driver supports \r
+ Tests to see if this driver supports a given controller.\r
+\r
+ If a child device is provided, it further tests to see if this driver supports\r
creating a handle for the specified child device.\r
\r
@param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
- @param[in] ControllerHandle The handle of the controller to test. This handle \r
- must support a protocol interface that supplies \r
+ @param[in] ControllerHandle The handle of the controller to test. This handle\r
+ must support a protocol interface that supplies\r
an I/O abstraction to the driver.\r
- @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. \r
- This parameter is ignored by device drivers, \r
+ @param[in] RemainingDevicePath A pointer to the remaining portion of a device path.\r
+ This parameter is ignored by device drivers,\r
and is optional for bus drivers.\r
\r
@retval EFI_SUCCESS The device specified by ControllerHandle and\r
- RemainingDevicePath is supported by the driver \r
+ RemainingDevicePath is supported by the driver\r
specified by This.\r
@retval EFI_ALREADY_STARTED The device specified by ControllerHandle and\r
- RemainingDevicePath is already being managed \r
+ RemainingDevicePath is already being managed\r
by the driver specified by This.\r
@retval EFI_ACCESS_DENIED The device specified by ControllerHandle and\r
- RemainingDevicePath is already being managed by \r
- a different driver or an application that \r
+ RemainingDevicePath is already being managed by\r
+ a different driver or an application that\r
requires exclusive acces. Currently not implemented.\r
@retval EFI_UNSUPPORTED The device specified by ControllerHandle and\r
- RemainingDevicePath is not supported by the \r
+ RemainingDevicePath is not supported by the\r
driver specified by This.\r
\r
**/\r
\r
\r
/**\r
- Start this driver on ControllerHandle. \r
- \r
- The Start() function is designed to be invoked from the EFI boot service ConnectController(). \r
- As a result, much of the error checking on the parameters to Start() has been \r
- moved into this common boot service. It is legal to call Start() from other locations, \r
- but the following calling restrictions must be followed or the system behavior \r
+ Start this driver on ControllerHandle.\r
+\r
+ The Start() function is designed to be invoked from the EFI boot service ConnectController().\r
+ As a result, much of the error checking on the parameters to Start() has been\r
+ moved into this common boot service. It is legal to call Start() from other locations,\r
+ but the following calling restrictions must be followed or the system behavior\r
will not be deterministic.\r
1. ControllerHandle must be a valid EFI_HANDLE.\r
- 2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally \r
+ 2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally\r
aligned EFI_DEVICE_PATH_PROTOCOL.\r
- 3. Prior to calling Start(), the Supported() function for the driver specified \r
- by This must have been called with the same calling parameters, and Supported() \r
- must have returned EFI_SUCCESS. \r
+ 3. Prior to calling Start(), the Supported() function for the driver specified\r
+ by This must have been called with the same calling parameters, and Supported()\r
+ must have returned EFI_SUCCESS.\r
\r
@param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
- @param[in] ControllerHandle The handle of the controller to start. This handle \r
- must support a protocol interface that supplies \r
+ @param[in] ControllerHandle The handle of the controller to start. This handle\r
+ must support a protocol interface that supplies\r
an I/O abstraction to the driver.\r
- @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. \r
- This parameter is ignored by device drivers, \r
+ @param[in] RemainingDevicePath A pointer to the remaining portion of a device path.\r
+ This parameter is ignored by device drivers,\r
and is optional for bus drivers.\r
\r
@retval EFI_SUCCESS The device was started.\r
@retval EFI_DEVICE_ERROR The device could not be started due to a device error.\r
Currently not implemented.\r
- @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of \r
+ @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of\r
resources.\r
@retval Others The driver failded to start the device.\r
\r
\r
\r
/**\r
- Stop this driver on ControllerHandle. \r
- \r
+ Stop this driver on ControllerHandle.\r
+\r
Release the control of this controller and remove the IScsi functions. The Stop()\r
- function is designed to be invoked from the EFI boot service DisconnectController(). \r
- As a result, much of the error checking on the parameters to Stop() has been moved \r
- into this common boot service. It is legal to call Stop() from other locations, \r
- but the following calling restrictions must be followed or the system behavior \r
+ function is designed to be invoked from the EFI boot service DisconnectController().\r
+ As a result, much of the error checking on the parameters to Stop() has been moved\r
+ into this common boot service. It is legal to call Stop() from other locations,\r
+ but the following calling restrictions must be followed or the system behavior\r
will not be deterministic.\r
1. ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this\r
same driver's Start() function.\r
EFI_HANDLE. In addition, all of these handles must have been created in this driver's\r
Start() function, and the Start() function must have called OpenProtocol() on\r
ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER.\r
- \r
+\r
@param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
- @param[in] ControllerHandle A handle to the device being stopped. The handle must \r
- support a bus specific I/O protocol for the driver \r
+ @param[in] ControllerHandle A handle to the device being stopped. The handle must\r
+ support a bus specific I/O protocol for the driver\r
to use to stop the device.\r
@param[in] NumberOfChildren The number of child device handles in ChildHandleBuffer.\r
Not used.\r
- @param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL \r
+ @param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL\r
if NumberOfChildren is 0.Not used.\r
\r
@retval EFI_SUCCESS The device was stopped.\r
\r
/**\r
Creates a child handle and installs a protocol.\r
- \r
- The CreateChild() function installs a protocol on ChildHandle. \r
- If ChildHandle is a pointer to NULL, then a new handle is created and returned \r
- in ChildHandle. If ChildHandle is not a pointer to NULL, then the protocol \r
+\r
+ The CreateChild() function installs a protocol on ChildHandle.\r
+ If ChildHandle is a pointer to NULL, then a new handle is created and returned\r
+ in ChildHandle. If ChildHandle is not a pointer to NULL, then the protocol\r
installs on the existing ChildHandle.\r
\r
@param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r
@param ChildHandle Pointer to the handle of the child to create. If it is NULL,\r
- then a new handle is created. If it is a pointer to an existing \r
+ then a new handle is created. If it is a pointer to an existing\r
UEFI handle, then the protocol is added to the existing UEFI handle.\r
\r
@retval EFI_SUCCES The protocol was added to ChildHandle.\r
@retval EFI_INVALID_PARAMETER ChildHandle is NULL.\r
- @retval EFI_OUT_OF_RESOURCES There are not enough resources availabe to create\r
+ @retval EFI_OUT_OF_RESOURCES There are not enough resources available to create\r
the child\r
@retval other The child handle was not created\r
\r
\r
/**\r
Destroys a child handle with a protocol installed on it.\r
- \r
- The DestroyChild() function does the opposite of CreateChild(). It removes a protocol \r
- that was installed by CreateChild() from ChildHandle. If the removed protocol is the \r
+\r
+ The DestroyChild() function does the opposite of CreateChild(). It removes a protocol\r
+ that was installed by CreateChild() from ChildHandle. If the removed protocol is the\r
last protocol on ChildHandle, then ChildHandle is destroyed.\r
\r
@param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r
@param ChildHandle Handle of the child to destroy\r
\r
@retval EFI_SUCCES The protocol was removed from ChildHandle.\r
- @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is \r
+ @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is\r
being removed.\r
@retval EFI_INVALID_PARAMETER Child handle is NULL.\r
@retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle\r
@param[in] ImageHandle The image handle of the driver.\r
@param[in] SystemTable The system table.\r
\r
- @retval EFI_SUCCESS if the driver binding and component name protocols \r
+ @retval EFI_SUCCESS if the driver binding and component name protocols\r
are successfully\r
@retval Others Failed to install the protocols.\r
\r
projects / mirror_edk2.git / blobdiff