/** @file
The driver binding and service binding protocol for IP6 driver.
Copyright (c) 2009 - 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 "Ip6Impl.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 IP6 driver which installs 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.
@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
//
return gBS->OpenProtocol (
NULL,
);
}
/**
Clean up an IP6 service binding instance. It releases 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 IP6 service binding instance to clean up.
@retval EFI_SUCCESS The resource used by the instance are cleaned up.
@retval Others Failed to clean up some of the resources.
**/
)
{
//
// Leave link-scope all-nodes multicast address (FF02::1)
//
return Status;
}
}
}
}
gBS->CloseProtocol (
);
}
);
}
}
}
}
//
// Free the Neighbor Discovery resources
//
}
return EFI_SUCCESS;
}
/**
Create a new IP6 driver service binding protocol.
@param[in] Controller The controller that has MNP service binding
installed.
@param[in] ImageHandle The IP6 driver's image handle.
@param[out] Service The variable to receive the newly created IP6
service.
@retval EFI_OUT_OF_RESOURCES Failed to allocate some resources.
@retval EFI_SUCCESS A new IP6 service binding private is created.
**/
)
{
//
// allocate a service private data then initialize all the filed to
// empty resources, so if any thing goes wrong when allocating
// resources, Ip6CleanService can be called to clean it up.
//
return EFI_OUT_OF_RESOURCES;
}
IpSb->NumChildren = 0;
//
// RFC4861 RETRANS_TIMER: 1,000 milliseconds
//
IpSb->RoundRobin = 0;
//
// Create various resources. First create the route table, timer
// event, MNP token event and MNP child.
//
goto ON_ERROR;
}
IpSb,
);
goto ON_ERROR;
}
IpSb,
);
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
//
}
//
// Currently only ETHERNET is supported in IPv6 stack, since
// link local address requires an IEEE 802 48-bit MACs for
// EUI-64 format interface identifier mapping.
//
goto ON_ERROR;
}
goto ON_ERROR;
}
//
// The timer expires every 100 (IP6_TIMER_INTERVAL_IN_MS) milliseconds.
//
goto ON_ERROR;
}
//
// The timer expires every 1000 (IP6_ONE_SECOND_IN_MS) milliseconds.
//
goto ON_ERROR;
}
&IpSb->RecvRequest,
);
goto ON_ERROR;
}
goto ON_ERROR;
}
goto ON_ERROR;
}
goto ON_ERROR;
}
goto ON_ERROR;
}
//
// If there is any manual address, set it.
//
);
}
return EFI_SUCCESS;
return Status;
}
/**
Start this driver on ControllerHandle.
@param[in] This Protocol instance pointer.
@param[in] ControllerHandle Handle of device to bind driver to.
@param[in] RemainingDevicePath Optional parameter used to pick a specific child
device to start.
@retval EFI_SUCCES 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 Ip6 service binding protocol
//
NULL,
);
if (Status == EFI_SUCCESS) {
return EFI_ALREADY_STARTED;
}
return Status;
}
//
// Install the Ip6ServiceBinding Protocol onto ControlerHandle
//
);
} else {
//
// Initialize the IP6 ID
//
}
return Status;
}
/**
Stop this driver on ControllerHandle.
@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 An array of child handles to be freed. May be NULL
if NumberOfChildren is 0.
@retval EFI_SUCCESS The device was stopped.
@retval EFI_DEVICE_ERROR The device could not be stopped due to a device error.
**/
)
{
//
// DriverBindingStop is triggered by the uninstallation of the EFI DHCPv6
// Protocol used by Ip6Config.
//
} else {
return EFI_DEVICE_ERROR;
}
}
(VOID **) &ServiceBinding,
);
return EFI_DEVICE_ERROR;
}
goto Exit;
}
if (IsDhcp6) {
} else if (NumberOfChildren == 0) {
//
// Clear the variable data.
//
goto Exit;
}
);
} else {
//
// NumberOfChildren is not zero, destroy all IP6 children instances.
//
}
if (IpSb->NumChildren != 0) {
}
}
Exit:
return Status;
}
/**
Creates a child handle with a set of I/O services.
@param[in] This Protocol instance pointer.
@param[in] ChildHandle Pointer to the handle of the child to create. If
it is NULL, then a new handle is created. If it
is not NULL, then the I/O services are added to
the existing child handle.
@retval EFI_SUCCES The child handle was created with the I/O services.
@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 (IpSb->LinkLocalDadFail) {
return EFI_DEVICE_ERROR;
}
if (IpInstance == NULL) {
return EFI_OUT_OF_RESOURCES;
}
//
// Install Ip6 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 set of I/O services.
@param[in] This Protocol instance pointer.
@param[in] ChildHandle Handle of the child to destroy.
@retval EFI_SUCCES The I/O services were removed from the child
handle.
@retval EFI_UNSUPPORTED The child handle does not support the I/O services
that are being removed.
@retval EFI_INVALID_PARAMETER Child handle is NULL.
@retval EFI_ACCESS_DENIED The child handle could not be destroyed because
its I/O 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 destroyed more than once. For example,
// Ip6DriverBindingStop 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 IP6 protocol first. Many thing happens during
// this:
// 1. The consumer of the IP6 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_IP6_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;
}
Ip6,
);
goto ON_ERROR;
}
IpSb->NumChildren--;
return EFI_SUCCESS;
return Status;
}