Ip4Driver.c revision 4fd606d1f5abe38e1f42c38de1d2e895166bd0f4
/** @file
The driver binding and service binding protocol for IP4 driver.
Copyright (c) 2005 - 2011, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#include "Ip4Impl.h"
0xa,
NULL,
};
/**
This is the declaration of an EFI image entry point. This entry point is
the same for UEFI Applications, UEFI OS Loaders, and UEFI Drivers including
both device drivers and bus drivers.
The entry point for IP4 driver which install the driver
binding and component name protocol on its image.
@param[in] ImageHandle The firmware allocated handle for the UEFI image.
@param[in] SystemTable A pointer to the EFI System Table.
@retval EFI_SUCCESS The operation completed successfully.
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
**/
)
{
);
}
/**
Test to see if this driver supports ControllerHandle. This service
is called by the EFI boot service ConnectController(). In
order to make drivers as small as possible, there are a few calling
restrictions for this service. ConnectController() must
follow these calling restrictions. If any other agent wishes to call
Supported() it must also follow these calling restrictions.
@param[in] This Protocol instance pointer.
@param[in] ControllerHandle Handle of device to test
@param[in] RemainingDevicePath Optional parameter use to pick a specific child
device to start.
@retval EFI_SUCCESS This driver supports this device
@retval EFI_ALREADY_STARTED This driver is already running on this device
@retval other This driver does not support this device
**/
)
{
//
// Test for the MNP service binding Protocol
//
NULL,
);
return Status;
}
//
// Test for the Arp service binding Protocol
//
NULL,
);
return Status;
}
/**
Clean up a IP4 service binding instance. It will release all
the resource allocated by the instance. The instance may be
partly initialized, or partly destroyed. If a resource is
destroyed, it is marked as that in case the destory failed and
being called again later.
@param[in] IpSb The IP4 serviceing binding instance to clean up
@retval EFI_SUCCESS The resource used by the instance are cleaned up
@retval other Failed to clean up some of the resources.
**/
);
/**
Create a new IP4 driver service binding private instance.
@param Controller The controller that has MNP service binding
installed
@param ImageHandle The IP4 driver's image handle
@param Service The variable to receive the newly created IP4
service.
@retval EFI_OUT_OF_RESOURCES Failed to allocate some resource
@retval EFI_SUCCESS A new IP4 service binding private is created.
@retval other Other error occurs.
**/
)
{
//
// allocate a service private data then initialize all the filed to
// empty resources, so if any thing goes wrong when allocating
// resources, Ip4CleanService can be called to clean it up.
//
return EFI_OUT_OF_RESOURCES;
}
IpSb->NumChildren = 0;
//
// Create various resources. First create the route table, timer
// event and MNP child. IGMP, interface's initialization depend
// on the MNP child.
//
goto ON_ERROR;
}
IpSb,
);
goto ON_ERROR;
}
);
goto ON_ERROR;
}
);
goto ON_ERROR;
}
goto ON_ERROR;
}
goto ON_ERROR;
}
goto ON_ERROR;
}
goto ON_ERROR;
}
//
// This is a VLAN device, reduce MTU by VLAN tag length
//
}
return EFI_SUCCESS;
return Status;
}
/**
Clean up a IP4 service binding instance. It will release all
the resource allocated by the instance. The instance may be
partly initialized, or partly destroyed. If a resource is
destroyed, it is marked as that in case the destory failed and
being called again later.
@param[in] IpSb The IP4 serviceing binding instance to clean up
@retval EFI_SUCCESS The resource used by the instance are cleaned up
@retval other Failed to clean up some of the resources.
**/
)
{
return Status;
}
}
}
gBS->CloseProtocol (
);
}
);
}
}
gBS->CloseProtocol (
);
}
return EFI_SUCCESS;
}
/**
Start this driver on ControllerHandle. This service is called by the
EFI boot service ConnectController(). In order to make
drivers as small as possible, there are a few calling restrictions for
this service. ConnectController() must follow these
calling restrictions. If any other agent wishes to call Start() it
must also follow these calling restrictions.
@param[in] This Protocol instance pointer.
@param[in] ControllerHandle Handle of device to bind driver to
@param[in] RemainingDevicePath Optional parameter use to pick a specific child
device to start.
@retval EFI_SUCCESS This driver is added to ControllerHandle
@retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle
@retval other This driver does not support this device
**/
)
{
//
// Test for the Ip4 service binding protocol
//
NULL,
);
if (Status == EFI_SUCCESS) {
return EFI_ALREADY_STARTED;
}
return Status;
}
//
// Install the Ip4ServiceBinding Protocol onto ControlerHandle
//
);
goto FREE_SERVICE;
}
//
// ready to go: start the receiving and timer
//
goto UNINSTALL_PROTOCOL;
}
goto UNINSTALL_PROTOCOL;
}
//
// Initialize the IP4 ID
//
return Status;
);
return Status;
}
/**
Stop this driver on ControllerHandle. This service is called by the
EFI boot service DisconnectController(). In order to
make drivers as small as possible, there are a few calling
restrictions for this service. DisconnectController()
must follow these calling restrictions. If any other agent wishes
to call Stop() it must also follow these calling restrictions.
@param[in] This Protocol instance pointer.
@param[in] ControllerHandle Handle of device to stop driver on
@param[in] NumberOfChildren Number of Handles in ChildHandleBuffer. If number
of children is zero stop the entire bus driver.
@param[in] ChildHandleBuffer List of Child Handles to Stop.
@retval EFI_SUCCESS This driver is removed ControllerHandle
@retval other This driver was not removed from this device
**/
)
{
//
// IP4 driver opens the MNP child, ARP children or the IP4_CONFIG protocol
// by driver. So the ControllerHandle may be the MNP child handle, ARP child
// handle, or the NIC (UNDI) handle because IP4_CONFIG protocol is installed
// in the NIC handle.
//
//
// First, check whether it is the IP4_CONFIG protocol being uninstalled.
// IP4_CONFIG protocol is installed on the NIC handle. It isn't necessary
// to clean up the default configuration if IP4_CONFIG is being stopped.
//
NULL,
);
if (Status == EFI_SUCCESS) {
//
// Retrieve the IP4 service binding protocol. If failed, it is
// likely that Ip4 ServiceBinding is uninstalled already. In this
// case, return immediately.
//
(VOID **) &ServiceBinding,
);
return EFI_DEVICE_ERROR;
}
);
return Status;
}
//
// If the auto configure hasn't complete, mark it as not started.
//
}
}
return EFI_SUCCESS;
}
//
// Either MNP or ARP protocol is being uninstalled. The controller
// handle is either the MNP child or ARP child. But, the IP4's
// service binding is installed on the NIC handle. So, need to open
// the protocol info to find the NIC handle.
//
}
return EFI_DEVICE_ERROR;
}
//
// Retrieve the IP4 service binding protocol
//
(VOID **) &ServiceBinding,
);
return EFI_DEVICE_ERROR;
}
return EFI_SUCCESS;
}
if (IsArp) {
}
if (IpSb->NumChildren != 0) {
goto ON_ERROR;
}
//
// Clear the variable data.
//
//
// OK, clean other resources then uninstall the service binding protocol.
//
goto ON_ERROR;
}
);
} else if (NumberOfChildren == 0) {
//
// Clear the variable data.
//
//
// OK, clean other resources then uninstall the service binding protocol.
//
goto ON_ERROR;
}
);
} else {
}
if (IpSb->NumChildren != 0) {
}
}
return Status;
}
/**
Creates a child handle and installs a protocol.
The CreateChild() function installs a protocol on ChildHandle.
If ChildHandle is a pointer to NULL, then a new handle is created and returned in ChildHandle.
If ChildHandle is not a pointer to NULL, then the protocol installs on the existing ChildHandle.
@param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
@param ChildHandle Pointer to the handle of the child to create. If it is NULL,
then a new handle is created. If it is a pointer to an existing UEFI handle,
then the protocol is added to the existing UEFI handle.
@retval EFI_SUCCES The protocol was added to ChildHandle.
@retval EFI_INVALID_PARAMETER ChildHandle is NULL.
@retval EFI_OUT_OF_RESOURCES There are not enough resources availabe to create
the child
@retval other The child handle was not created
**/
)
{
return EFI_INVALID_PARAMETER;
}
if (IpInstance == NULL) {
return EFI_OUT_OF_RESOURCES;
}
//
// Install Ip4 onto ChildHandle
//
);
goto ON_ERROR;
}
//
// Open the Managed Network protocol BY_CHILD.
//
);
);
goto ON_ERROR;
}
//
// Insert it into the service binding instance.
//
IpSb->NumChildren++;
}
return Status;
}
/**
Destroys a child handle with a protocol installed on it.
The DestroyChild() function does the opposite of CreateChild(). It removes a protocol
that was installed by CreateChild() from ChildHandle. If the removed protocol is the
last protocol on ChildHandle, then ChildHandle is destroyed.
@param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
@param ChildHandle Handle of the child to destroy
@retval EFI_SUCCES The protocol was removed from ChildHandle.
@retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed.
@retval EFI_INVALID_PARAMETER Child handle is NULL.
@retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle
because its services are being used.
@retval other The child handle was not destroyed
**/
)
{
return EFI_INVALID_PARAMETER;
}
//
// Retrieve the private context data structures
//
);
return EFI_UNSUPPORTED;
}
return EFI_INVALID_PARAMETER;
}
//
// A child can be destoried more than once. For example,
// Ip4DriverBindingStop will destory all of its children.
// when UDP driver is being stopped, it will destory all
// the IP child it opens.
//
return EFI_SUCCESS;
}
//
// Close the Managed Network protocol.
//
gBS->CloseProtocol (
);
//
// Uninstall the IP4 protocol first. Many thing happens during
// this:
// 1. The consumer of the IP4 protocol will be stopped if it
// opens the protocol BY_DRIVER. For eaxmple, if MNP driver is
// stopped, IP driver's stop function will be called, and uninstall
// EFI_IP4_PROTOCOL will trigger the UDP's stop function. This
// makes it possible to create the network stack bottom up, and
// stop it top down.
// 2. the upper layer will recycle the received packet. The recycle
// event's TPL is higher than this function. The recycle events
// will be called back before preceeding. If any packets not recycled,
// that means there is a resource leak.
//
);
goto ON_ERROR;
}
Ip4,
);
goto ON_ERROR;
}
IpSb->NumChildren--;
return EFI_SUCCESS;
return Status;
}