Add NetworkPkg (P.UDK2010.UP3.Network.P1)
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10986 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
hhtian
313
NetworkPkg/Udp6Dxe/ComponentName.c
Normal file
313
NetworkPkg/Udp6Dxe/ComponentName.c
Normal file
@@ -0,0 +1,313 @@
|
||||
/** @file
|
||||
UEFI Component Name(2) protocol implementation for UDP6 driver.
|
||||
|
||||
Copyright (c) 2009 - 2010, 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
|
||||
http://opensource.org/licenses/bsd-license.php.
|
||||
|
||||
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 "Udp6Impl.h"
|
||||
|
||||
//
|
||||
// EFI Component Name Functions
|
||||
//
|
||||
/**
|
||||
Retrieves a Unicode string that is the user-readable name of the driver.
|
||||
|
||||
This function retrieves the user-readable name of a driver in the form of a
|
||||
Unicode string. If the driver specified by This has a user-readable name in
|
||||
the language specified by Language, then a pointer to the driver name is
|
||||
returned in DriverName, and EFI_SUCCESS is returned. If the driver specified
|
||||
by This does not support the language specified by Language,
|
||||
then EFI_UNSUPPORTED is returned.
|
||||
|
||||
@param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
|
||||
EFI_COMPONENT_NAME_PROTOCOL instance.
|
||||
|
||||
@param[in] Language A pointer to a Null-terminated ASCII string
|
||||
array indicating the language. This is the
|
||||
language of the driver name that the caller is
|
||||
requesting, and it must match one of the
|
||||
languages specified in SupportedLanguages. The
|
||||
number of languages supported by a driver is up
|
||||
to the driver writer. Language is specified
|
||||
in RFC 4646 or ISO 639-2 language code format.
|
||||
|
||||
@param[out] DriverName A pointer to the Unicode string to return.
|
||||
This Unicode string is the name of the
|
||||
driver specified by This in the language
|
||||
specified by Language.
|
||||
|
||||
@retval EFI_SUCCESS The Unicode string for the Driver specified by
|
||||
This and the language specified by Language was
|
||||
returned in DriverName.
|
||||
|
||||
@retval EFI_INVALID_PARAMETER Language is NULL.
|
||||
|
||||
@retval EFI_INVALID_PARAMETER DriverName is NULL.
|
||||
|
||||
@retval EFI_UNSUPPORTED The driver specified by This does not support
|
||||
the language specified by Language.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
Udp6ComponentNameGetDriverName (
|
||||
IN EFI_COMPONENT_NAME_PROTOCOL *This,
|
||||
IN CHAR8 *Language,
|
||||
OUT CHAR16 **DriverName
|
||||
);
|
||||
|
||||
|
||||
/**
|
||||
Retrieves a Unicode string that is the user-readable name of the controller
|
||||
that is being managed by a driver.
|
||||
|
||||
This function retrieves the user-readable name of the controller specified by
|
||||
ControllerHandle and ChildHandle in the form of a Unicode string. If the
|
||||
driver specified by This has a user-readable name in the language specified by
|
||||
Language, then a pointer to the controller name is returned in ControllerName,
|
||||
and EFI_SUCCESS is returned. If the driver specified by This is not currently
|
||||
managing the controller specified by ControllerHandle and ChildHandle,
|
||||
then EFI_UNSUPPORTED is returned. If the driver specified by This does not
|
||||
support the language specified by Language, then EFI_UNSUPPORTED is returned.
|
||||
|
||||
@param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
|
||||
EFI_COMPONENT_NAME_PROTOCOL instance.
|
||||
|
||||
@param[in] ControllerHandle The handle of a controller that the driver
|
||||
specified by This is managing. This handle
|
||||
specifies the controller whose name is to be
|
||||
returned.
|
||||
|
||||
@param[in] ChildHandle The handle of the child controller to retrieve
|
||||
the name of. This is an optional parameter that
|
||||
may be NULL. It will be NULL for device
|
||||
drivers. It will also be NULL for a bus drivers
|
||||
that wish to retrieve the name of the bus
|
||||
controller. It will not be NULL for a bus
|
||||
driver that wishes to retrieve the name of a
|
||||
child controller.
|
||||
|
||||
@param[in] Language A pointer to a Null-terminated ASCII string
|
||||
array indicating the language. This is the
|
||||
language of the driver name that the caller is
|
||||
requesting, and it must match one of the
|
||||
languages specified in SupportedLanguages. The
|
||||
number of languages supported by a driver is up
|
||||
to the driver writer. Language is specified in
|
||||
RFC 4646 or ISO 639-2 language code format.
|
||||
|
||||
@param[out] ControllerName A pointer to the Unicode string to return.
|
||||
This Unicode string is the name of the
|
||||
controller specified by ControllerHandle and
|
||||
ChildHandle in the language specified by
|
||||
Language from the point of view of the driver
|
||||
specified by This.
|
||||
|
||||
@retval EFI_SUCCESS The Unicode string for the user-readable name in
|
||||
the language specified by Language for the
|
||||
driver specified by This was returned in
|
||||
DriverName.
|
||||
|
||||
@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
|
||||
|
||||
@retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid
|
||||
EFI_HANDLE.
|
||||
|
||||
@retval EFI_INVALID_PARAMETER Language is NULL.
|
||||
|
||||
@retval EFI_INVALID_PARAMETER ControllerName is NULL.
|
||||
|
||||
@retval EFI_UNSUPPORTED The driver specified by This is not currently
|
||||
managing the controller specified by
|
||||
ControllerHandle and ChildHandle.
|
||||
|
||||
@retval EFI_UNSUPPORTED The driver specified by This does not support
|
||||
the language specified by Language.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
Udp6ComponentNameGetControllerName (
|
||||
IN EFI_COMPONENT_NAME_PROTOCOL *This,
|
||||
IN EFI_HANDLE ControllerHandle,
|
||||
IN EFI_HANDLE ChildHandle OPTIONAL,
|
||||
IN CHAR8 *Language,
|
||||
OUT CHAR16 **ControllerName
|
||||
);
|
||||
|
||||
//
|
||||
// EFI Component Name Protocol
|
||||
//
|
||||
GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL gUdp6ComponentName = {
|
||||
Udp6ComponentNameGetDriverName,
|
||||
Udp6ComponentNameGetControllerName,
|
||||
"eng"
|
||||
};
|
||||
|
||||
//
|
||||
// EFI Component Name 2 Protocol
|
||||
//
|
||||
GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gUdp6ComponentName2 = {
|
||||
(EFI_COMPONENT_NAME2_GET_DRIVER_NAME) Udp6ComponentNameGetDriverName,
|
||||
(EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) Udp6ComponentNameGetControllerName,
|
||||
"en"
|
||||
};
|
||||
|
||||
|
||||
GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mUdp6DriverNameTable[] = {
|
||||
{
|
||||
"eng;en",
|
||||
L"UDP6 Network Service Driver"
|
||||
},
|
||||
{
|
||||
NULL,
|
||||
NULL
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
Retrieves a Unicode string that is the user-readable name of the driver.
|
||||
|
||||
This function retrieves the user-readable name of a driver in the form of a
|
||||
Unicode string. If the driver specified by This has a user-readable name in
|
||||
the language specified by Language, then a pointer to the driver name is
|
||||
returned in DriverName, and EFI_SUCCESS is returned. If the driver specified
|
||||
by This does not support the language specified by Language,
|
||||
then EFI_UNSUPPORTED is returned.
|
||||
|
||||
@param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
|
||||
EFI_COMPONENT_NAME_PROTOCOL instance.
|
||||
|
||||
@param[in] Language A pointer to a Null-terminated ASCII string
|
||||
array indicating the language. This is the
|
||||
language of the driver name that the caller is
|
||||
requesting, and it must match one of the
|
||||
languages specified in SupportedLanguages. The
|
||||
number of languages supported by a driver is up
|
||||
to the driver writer. Language is specified
|
||||
in RFC 4646 or ISO 639-2 language code format.
|
||||
|
||||
@param[out] DriverName A pointer to the Unicode string to return.
|
||||
This Unicode string is the name of the
|
||||
driver specified by This in the language
|
||||
specified by Language.
|
||||
|
||||
@retval EFI_SUCCESS The Unicode string for the Driver specified by
|
||||
This and the language specified by Language was
|
||||
returned in DriverName.
|
||||
|
||||
@retval EFI_INVALID_PARAMETER Language is NULL.
|
||||
|
||||
@retval EFI_INVALID_PARAMETER DriverName is NULL.
|
||||
|
||||
@retval EFI_UNSUPPORTED The driver specified by This does not support
|
||||
the language specified by Language.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
Udp6ComponentNameGetDriverName (
|
||||
IN EFI_COMPONENT_NAME_PROTOCOL *This,
|
||||
IN CHAR8 *Language,
|
||||
OUT CHAR16 **DriverName
|
||||
)
|
||||
{
|
||||
return LookupUnicodeString2 (
|
||||
Language,
|
||||
This->SupportedLanguages,
|
||||
mUdp6DriverNameTable,
|
||||
DriverName,
|
||||
(BOOLEAN) (This == &gUdp6ComponentName)
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
Retrieves a Unicode string that is the user-readable name of the controller
|
||||
that is being managed by a driver.
|
||||
|
||||
This function retrieves the user-readable name of the controller specified by
|
||||
ControllerHandle and ChildHandle in the form of a Unicode string. If the
|
||||
driver specified by This has a user-readable name in the language specified by
|
||||
Language, then a pointer to the controller name is returned in ControllerName,
|
||||
and EFI_SUCCESS is returned. If the driver specified by This is not currently
|
||||
managing the controller specified by ControllerHandle and ChildHandle,
|
||||
then EFI_UNSUPPORTED is returned. If the driver specified by This does not
|
||||
support the language specified by Language, then EFI_UNSUPPORTED is returned.
|
||||
|
||||
@param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
|
||||
EFI_COMPONENT_NAME_PROTOCOL instance.
|
||||
|
||||
@param[in] ControllerHandle The handle of a controller that the driver
|
||||
specified by This is managing. This handle
|
||||
specifies the controller whose name is to be
|
||||
returned.
|
||||
|
||||
@param[in] ChildHandle The handle of the child controller to retrieve
|
||||
the name of. This is an optional parameter that
|
||||
may be NULL. It will be NULL for device
|
||||
drivers. It will also be NULL for a bus drivers
|
||||
that wish to retrieve the name of the bus
|
||||
controller. It will not be NULL for a bus
|
||||
driver that wishes to retrieve the name of a
|
||||
child controller.
|
||||
|
||||
@param[in] Language A pointer to a Null-terminated ASCII string
|
||||
array indicating the language. This is the
|
||||
language of the driver name that the caller is
|
||||
requesting, and it must match one of the
|
||||
languages specified in SupportedLanguages. The
|
||||
number of languages supported by a driver is up
|
||||
to the driver writer. Language is specified in
|
||||
RFC 4646 or ISO 639-2 language code format.
|
||||
|
||||
@param[out] ControllerName A pointer to the Unicode string to return.
|
||||
This Unicode string is the name of the
|
||||
controller specified by ControllerHandle and
|
||||
ChildHandle in the language specified by
|
||||
Language from the point of view of the driver
|
||||
specified by This.
|
||||
|
||||
@retval EFI_SUCCESS The Unicode string for the user-readable name in
|
||||
the language specified by Language for the
|
||||
driver specified by This was returned in
|
||||
DriverName.
|
||||
|
||||
@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
|
||||
|
||||
@retval EFI_INVALID_PARAMETER ChildHandle is not NULL, and it is not a valid
|
||||
EFI_HANDLE.
|
||||
|
||||
@retval EFI_INVALID_PARAMETER Language is NULL.
|
||||
|
||||
@retval EFI_INVALID_PARAMETER ControllerName is NULL.
|
||||
|
||||
@retval EFI_UNSUPPORTED The driver specified by This is not currently
|
||||
managing the controller specified by
|
||||
ControllerHandle and ChildHandle.
|
||||
|
||||
@retval EFI_UNSUPPORTED The driver specified by This does not support
|
||||
the language specified by Language.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
Udp6ComponentNameGetControllerName (
|
||||
IN EFI_COMPONENT_NAME_PROTOCOL *This,
|
||||
IN EFI_HANDLE ControllerHandle,
|
||||
IN EFI_HANDLE ChildHandle OPTIONAL,
|
||||
IN CHAR8 *Language,
|
||||
OUT CHAR16 **ControllerName
|
||||
)
|
||||
{
|
||||
return EFI_UNSUPPORTED;
|
||||
}
|
||||
|
||||
556
NetworkPkg/Udp6Dxe/Udp6Driver.c
Normal file
556
NetworkPkg/Udp6Dxe/Udp6Driver.c
Normal file
@@ -0,0 +1,556 @@
|
||||
/** @file
|
||||
Driver Binding functions and Service Binding functions for the Network driver module.
|
||||
|
||||
Copyright (c) 2009 - 2010, 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
|
||||
http://opensource.org/licenses/bsd-license.php.
|
||||
|
||||
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 "Udp6Impl.h"
|
||||
|
||||
EFI_DRIVER_BINDING_PROTOCOL gUdp6DriverBinding = {
|
||||
Udp6DriverBindingSupported,
|
||||
Udp6DriverBindingStart,
|
||||
Udp6DriverBindingStop,
|
||||
0xa,
|
||||
NULL,
|
||||
NULL
|
||||
};
|
||||
|
||||
EFI_SERVICE_BINDING_PROTOCOL mUdp6ServiceBinding = {
|
||||
Udp6ServiceBindingCreateChild,
|
||||
Udp6ServiceBindingDestroyChild
|
||||
};
|
||||
|
||||
/**
|
||||
Tests to see if this driver supports a given controller. If a child device is provided,
|
||||
it further tests to see if this driver supports creating a handle for the specified child device.
|
||||
|
||||
This function checks to see if the driver specified by This supports the device specified by
|
||||
ControllerHandle. Drivers will typically use the device path attached to
|
||||
ControllerHandle and/or the services from the bus I/O abstraction attached to
|
||||
ControllerHandle to determine if the driver supports ControllerHandle. This function
|
||||
may be called many times during platform initialization. In order to reduce boot times, the tests
|
||||
performed by this function must be very small, and take as little time as possible to execute. This
|
||||
function must not change the state of any hardware devices, and this function must be aware that the
|
||||
device specified by ControllerHandle may already be managed by the same driver or a
|
||||
different driver. This function must match its calls to AllocatePages() with FreePages(),
|
||||
AllocatePool() with FreePool(), and OpenProtocol() with CloseProtocol().
|
||||
Because ControllerHandle may have been previously started by the same driver, if a protocol is
|
||||
already in the opened state, then it must not be closed with CloseProtocol(). This is required
|
||||
to guarantee the state of ControllerHandle is not modified by this function.
|
||||
|
||||
@param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
|
||||
@param[in] ControllerHandle The handle of the controller to test. This handle
|
||||
must support a protocol interface that supplies
|
||||
an I/O abstraction to the driver.
|
||||
@param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This
|
||||
parameter is ignored by device drivers, and is optional for bus
|
||||
drivers. For bus drivers, if this parameter is not NULL, then
|
||||
the bus driver must determine if the bus controller specified
|
||||
by ControllerHandle and the child controller specified
|
||||
by RemainingDevicePath are both supported by this
|
||||
bus driver.
|
||||
|
||||
@retval EFI_SUCCESS The device specified by ControllerHandle and
|
||||
RemainingDevicePath is supported by the driver specified by This.
|
||||
@retval EFI_ALREADY_STARTED The device specified by ControllerHandle and
|
||||
RemainingDevicePath is already being managed by the driver
|
||||
specified by This.
|
||||
@retval EFI_ACCESS_DENIED The device specified by ControllerHandle and
|
||||
RemainingDevicePath is already being managed by a different
|
||||
driver or an application that requires exclusive access.
|
||||
Currently not implemented.
|
||||
@retval EFI_UNSUPPORTED The device specified by ControllerHandle and
|
||||
RemainingDevicePath is not supported by the driver specified by This.
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
Udp6DriverBindingSupported (
|
||||
IN EFI_DRIVER_BINDING_PROTOCOL *This,
|
||||
IN EFI_HANDLE ControllerHandle,
|
||||
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL
|
||||
)
|
||||
{
|
||||
EFI_STATUS Status;
|
||||
//
|
||||
// Test for the Udp6ServiceBinding Protocol
|
||||
//
|
||||
Status = gBS->OpenProtocol (
|
||||
ControllerHandle,
|
||||
&gEfiUdp6ServiceBindingProtocolGuid,
|
||||
NULL,
|
||||
This->DriverBindingHandle,
|
||||
ControllerHandle,
|
||||
EFI_OPEN_PROTOCOL_TEST_PROTOCOL
|
||||
);
|
||||
if (!EFI_ERROR (Status)) {
|
||||
return EFI_ALREADY_STARTED;
|
||||
}
|
||||
//
|
||||
// Test for the Ip6ServiceBinding Protocol
|
||||
//
|
||||
Status = gBS->OpenProtocol (
|
||||
ControllerHandle,
|
||||
&gEfiIp6ServiceBindingProtocolGuid,
|
||||
NULL,
|
||||
This->DriverBindingHandle,
|
||||
ControllerHandle,
|
||||
EFI_OPEN_PROTOCOL_TEST_PROTOCOL
|
||||
);
|
||||
|
||||
return Status;
|
||||
}
|
||||
|
||||
/**
|
||||
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 the driver to.
|
||||
@param[in] RemainingDevicePath Optional parameter use to pick a specific child
|
||||
device to start.
|
||||
|
||||
@retval EFI_SUCCES This driver is added to ControllerHandle.
|
||||
@retval EFI_OUT_OF_RESOURCES The required system resource can't be allocated.
|
||||
@retval other This driver does not support this device.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
Udp6DriverBindingStart (
|
||||
IN EFI_DRIVER_BINDING_PROTOCOL *This,
|
||||
IN EFI_HANDLE ControllerHandle,
|
||||
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL
|
||||
)
|
||||
{
|
||||
EFI_STATUS Status;
|
||||
UDP6_SERVICE_DATA *Udp6Service;
|
||||
|
||||
//
|
||||
// Allocate Private Context Data Structure.
|
||||
//
|
||||
Udp6Service = AllocateZeroPool (sizeof (UDP6_SERVICE_DATA));
|
||||
if (Udp6Service == NULL) {
|
||||
Status = EFI_OUT_OF_RESOURCES;
|
||||
goto EXIT;
|
||||
}
|
||||
|
||||
Status = Udp6CreateService (Udp6Service, This->DriverBindingHandle, ControllerHandle);
|
||||
if (EFI_ERROR (Status)) {
|
||||
goto EXIT;
|
||||
}
|
||||
|
||||
//
|
||||
// Install the Udp6ServiceBindingProtocol on the ControllerHandle.
|
||||
//
|
||||
Status = gBS->InstallMultipleProtocolInterfaces (
|
||||
&ControllerHandle,
|
||||
&gEfiUdp6ServiceBindingProtocolGuid,
|
||||
&Udp6Service->ServiceBinding,
|
||||
NULL
|
||||
);
|
||||
if (EFI_ERROR (Status)) {
|
||||
Udp6CleanService (Udp6Service);
|
||||
goto EXIT;
|
||||
} else {
|
||||
Status = Udp6SetVariableData (Udp6Service);
|
||||
}
|
||||
|
||||
EXIT:
|
||||
if (EFI_ERROR (Status)) {
|
||||
if (Udp6Service != NULL) {
|
||||
FreePool (Udp6Service);
|
||||
}
|
||||
}
|
||||
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 the driver on.
|
||||
@param[in] NumberOfChildren Number of Handles in ChildHandleBuffer. If the number
|
||||
of children is zero stop the entire bus driver.
|
||||
@param[in] ChildHandleBuffer List of Child Handles to Stop. It is optional.
|
||||
|
||||
@retval EFI_SUCCES This driver is removed ControllerHandle.
|
||||
@retval EFI_DEVICE_ERROR Can't find the NicHandle from the ControllerHandle and specified GUID.
|
||||
@retval other This driver was not removed from this device.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
Udp6DriverBindingStop (
|
||||
IN EFI_DRIVER_BINDING_PROTOCOL *This,
|
||||
IN EFI_HANDLE ControllerHandle,
|
||||
IN UINTN NumberOfChildren,
|
||||
IN EFI_HANDLE *ChildHandleBuffer OPTIONAL
|
||||
)
|
||||
{
|
||||
EFI_STATUS Status;
|
||||
EFI_HANDLE NicHandle;
|
||||
EFI_SERVICE_BINDING_PROTOCOL *ServiceBinding;
|
||||
UDP6_SERVICE_DATA *Udp6Service;
|
||||
UDP6_INSTANCE_DATA *Instance;
|
||||
|
||||
//
|
||||
// Find the NicHandle where UDP6 ServiceBinding Protocol is installed.
|
||||
//
|
||||
NicHandle = NetLibGetNicHandle (ControllerHandle, &gEfiIp6ProtocolGuid);
|
||||
if (NicHandle == NULL) {
|
||||
return EFI_DEVICE_ERROR;
|
||||
}
|
||||
|
||||
//
|
||||
// Retrieve the UDP6 ServiceBinding Protocol.
|
||||
//
|
||||
Status = gBS->OpenProtocol (
|
||||
NicHandle,
|
||||
&gEfiUdp6ServiceBindingProtocolGuid,
|
||||
(VOID **) &ServiceBinding,
|
||||
This->DriverBindingHandle,
|
||||
NicHandle,
|
||||
EFI_OPEN_PROTOCOL_GET_PROTOCOL
|
||||
);
|
||||
if (EFI_ERROR (Status)) {
|
||||
return EFI_DEVICE_ERROR;
|
||||
}
|
||||
|
||||
Udp6Service = UDP6_SERVICE_DATA_FROM_THIS (ServiceBinding);
|
||||
|
||||
if (NumberOfChildren == 0) {
|
||||
|
||||
gBS->UninstallMultipleProtocolInterfaces (
|
||||
NicHandle,
|
||||
&gEfiUdp6ServiceBindingProtocolGuid,
|
||||
&Udp6Service->ServiceBinding,
|
||||
NULL
|
||||
);
|
||||
|
||||
Udp6ClearVariableData (Udp6Service);
|
||||
|
||||
Udp6CleanService (Udp6Service);
|
||||
|
||||
FreePool (Udp6Service);
|
||||
} else {
|
||||
|
||||
while (!IsListEmpty (&Udp6Service->ChildrenList)) {
|
||||
Instance = NET_LIST_HEAD (&Udp6Service->ChildrenList, UDP6_INSTANCE_DATA, Link);
|
||||
|
||||
Status = ServiceBinding->DestroyChild (ServiceBinding, Instance->ChildHandle);
|
||||
}
|
||||
}
|
||||
|
||||
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[in] This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
|
||||
@param[in, out] 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 This is NULL or 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.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
Udp6ServiceBindingCreateChild (
|
||||
IN EFI_SERVICE_BINDING_PROTOCOL *This,
|
||||
IN OUT EFI_HANDLE *ChildHandle
|
||||
)
|
||||
{
|
||||
EFI_STATUS Status;
|
||||
UDP6_SERVICE_DATA *Udp6Service;
|
||||
UDP6_INSTANCE_DATA *Instance;
|
||||
EFI_TPL OldTpl;
|
||||
VOID *Ip6;
|
||||
|
||||
if ((This == NULL) || (ChildHandle == NULL)) {
|
||||
return EFI_INVALID_PARAMETER;
|
||||
}
|
||||
|
||||
Udp6Service = UDP6_SERVICE_DATA_FROM_THIS (This);
|
||||
|
||||
//
|
||||
// Allocate the instance private data structure.
|
||||
//
|
||||
Instance = AllocateZeroPool (sizeof (UDP6_INSTANCE_DATA));
|
||||
if (Instance == NULL) {
|
||||
return EFI_OUT_OF_RESOURCES;
|
||||
}
|
||||
|
||||
Udp6InitInstance (Udp6Service, Instance);
|
||||
|
||||
//
|
||||
// Add an IpInfo for this instance.
|
||||
//
|
||||
Instance->IpInfo = IpIoAddIp (Udp6Service->IpIo);
|
||||
if (Instance->IpInfo == NULL) {
|
||||
Status = EFI_OUT_OF_RESOURCES;
|
||||
goto ON_ERROR;
|
||||
}
|
||||
|
||||
//
|
||||
// Install the Udp6Protocol for this instance.
|
||||
//
|
||||
Status = gBS->InstallMultipleProtocolInterfaces (
|
||||
ChildHandle,
|
||||
&gEfiUdp6ProtocolGuid,
|
||||
&Instance->Udp6Proto,
|
||||
NULL
|
||||
);
|
||||
if (EFI_ERROR (Status)) {
|
||||
goto ON_ERROR;
|
||||
}
|
||||
|
||||
Instance->ChildHandle = *ChildHandle;
|
||||
|
||||
//
|
||||
// Open the default Ip6 protocol in the IP_IO BY_CHILD.
|
||||
//
|
||||
Status = gBS->OpenProtocol (
|
||||
Udp6Service->IpIo->ChildHandle,
|
||||
&gEfiIp6ProtocolGuid,
|
||||
(VOID **) &Ip6,
|
||||
gUdp6DriverBinding.DriverBindingHandle,
|
||||
Instance->ChildHandle,
|
||||
EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
|
||||
);
|
||||
if (EFI_ERROR (Status)) {
|
||||
goto ON_ERROR;
|
||||
}
|
||||
|
||||
OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
|
||||
|
||||
//
|
||||
// Link this instance into the service context data and increase the ChildrenNumber.
|
||||
//
|
||||
InsertTailList (&Udp6Service->ChildrenList, &Instance->Link);
|
||||
Udp6Service->ChildrenNumber++;
|
||||
|
||||
gBS->RestoreTPL (OldTpl);
|
||||
|
||||
return EFI_SUCCESS;
|
||||
|
||||
ON_ERROR:
|
||||
|
||||
if (Instance->ChildHandle != NULL) {
|
||||
gBS->UninstallMultipleProtocolInterfaces (
|
||||
Instance->ChildHandle,
|
||||
&gEfiUdp6ProtocolGuid,
|
||||
&Instance->Udp6Proto,
|
||||
NULL
|
||||
);
|
||||
}
|
||||
|
||||
if (Instance->IpInfo != NULL) {
|
||||
IpIoRemoveIp (Udp6Service->IpIo, Instance->IpInfo);
|
||||
}
|
||||
|
||||
Udp6CleanInstance (Instance);
|
||||
|
||||
FreePool (Instance);
|
||||
|
||||
return Status;
|
||||
}
|
||||
|
||||
/**
|
||||
Destroys a child handle with a set of I/O services.
|
||||
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[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 not a valid EFI Handle.
|
||||
@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.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
Udp6ServiceBindingDestroyChild (
|
||||
IN EFI_SERVICE_BINDING_PROTOCOL *This,
|
||||
IN EFI_HANDLE ChildHandle
|
||||
)
|
||||
{
|
||||
EFI_STATUS Status;
|
||||
UDP6_SERVICE_DATA *Udp6Service;
|
||||
EFI_UDP6_PROTOCOL *Udp6Proto;
|
||||
UDP6_INSTANCE_DATA *Instance;
|
||||
EFI_TPL OldTpl;
|
||||
|
||||
if ((This == NULL) || (ChildHandle == NULL)) {
|
||||
return EFI_INVALID_PARAMETER;
|
||||
}
|
||||
|
||||
Udp6Service = UDP6_SERVICE_DATA_FROM_THIS (This);
|
||||
|
||||
//
|
||||
// Try to get the Udp6 protocol from the ChildHandle.
|
||||
//
|
||||
Status = gBS->OpenProtocol (
|
||||
ChildHandle,
|
||||
&gEfiUdp6ProtocolGuid,
|
||||
(VOID **) &Udp6Proto,
|
||||
gUdp6DriverBinding.DriverBindingHandle,
|
||||
ChildHandle,
|
||||
EFI_OPEN_PROTOCOL_GET_PROTOCOL
|
||||
);
|
||||
if (EFI_ERROR (Status)) {
|
||||
return EFI_UNSUPPORTED;
|
||||
}
|
||||
|
||||
Instance = UDP6_INSTANCE_DATA_FROM_THIS (Udp6Proto);
|
||||
|
||||
if (Instance->Destroyed) {
|
||||
return EFI_SUCCESS;
|
||||
}
|
||||
|
||||
//
|
||||
// Use the Destroyed flag to avoid the re-entering of the following code.
|
||||
//
|
||||
Instance->Destroyed = TRUE;
|
||||
|
||||
//
|
||||
// Close the Ip6 protocol.
|
||||
//
|
||||
gBS->CloseProtocol (
|
||||
Udp6Service->IpIo->ChildHandle,
|
||||
&gEfiIp6ProtocolGuid,
|
||||
gUdp6DriverBinding.DriverBindingHandle,
|
||||
Instance->ChildHandle
|
||||
);
|
||||
|
||||
//
|
||||
// Uninstall the Udp6Protocol previously installed on the ChildHandle.
|
||||
//
|
||||
Status = gBS->UninstallMultipleProtocolInterfaces (
|
||||
ChildHandle,
|
||||
&gEfiUdp6ProtocolGuid,
|
||||
(VOID *) &Instance->Udp6Proto,
|
||||
NULL
|
||||
);
|
||||
if (EFI_ERROR (Status)) {
|
||||
Instance->Destroyed = FALSE;
|
||||
return Status;
|
||||
}
|
||||
|
||||
//
|
||||
// Reset the configuration in case the instance's consumer forgets to do this.
|
||||
//
|
||||
Udp6Proto->Configure (Udp6Proto, NULL);
|
||||
|
||||
//
|
||||
// Remove the IpInfo this instance consumes.
|
||||
//
|
||||
IpIoRemoveIp (Udp6Service->IpIo, Instance->IpInfo);
|
||||
|
||||
OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
|
||||
|
||||
//
|
||||
// Remove this instance from the service context data's ChildrenList.
|
||||
//
|
||||
RemoveEntryList (&Instance->Link);
|
||||
Udp6Service->ChildrenNumber--;
|
||||
|
||||
//
|
||||
// Clean the instance.
|
||||
//
|
||||
Udp6CleanInstance (Instance);
|
||||
|
||||
gBS->RestoreTPL (OldTpl);
|
||||
|
||||
FreePool (Instance);
|
||||
|
||||
return EFI_SUCCESS;
|
||||
}
|
||||
|
||||
/**
|
||||
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 Udp6 driver that installs the driver binding
|
||||
and component name protocol on its ImageHandle.
|
||||
|
||||
@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.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
Udp6DriverEntryPoint (
|
||||
IN EFI_HANDLE ImageHandle,
|
||||
IN EFI_SYSTEM_TABLE *SystemTable
|
||||
)
|
||||
{
|
||||
EFI_STATUS Status;
|
||||
|
||||
//
|
||||
// Install the Udp6DriverBinding and Udp6ComponentName protocols.
|
||||
//
|
||||
|
||||
Status = EfiLibInstallDriverBindingComponentName2 (
|
||||
ImageHandle,
|
||||
SystemTable,
|
||||
&gUdp6DriverBinding,
|
||||
ImageHandle,
|
||||
&gUdp6ComponentName,
|
||||
&gUdp6ComponentName2
|
||||
);
|
||||
if (!EFI_ERROR (Status)) {
|
||||
//
|
||||
// Initialize the UDP random port.
|
||||
//
|
||||
mUdp6RandomPort = (UINT16)(
|
||||
((UINT16) NetRandomInitSeed ()) %
|
||||
UDP6_PORT_KNOWN +
|
||||
UDP6_PORT_KNOWN
|
||||
);
|
||||
}
|
||||
|
||||
return Status;
|
||||
}
|
||||
|
||||
|
||||
182
NetworkPkg/Udp6Dxe/Udp6Driver.h
Normal file
182
NetworkPkg/Udp6Dxe/Udp6Driver.h
Normal file
@@ -0,0 +1,182 @@
|
||||
/** @file
|
||||
Driver Binding functions and Service Binding functions for the Network driver module.
|
||||
|
||||
Copyright (c) 2009 - 2010, 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
|
||||
http://opensource.org/licenses/bsd-license.php.
|
||||
|
||||
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
||||
|
||||
**/
|
||||
|
||||
#ifndef _UDP6_DRIVER_H_
|
||||
#define _UDP6_DRIVER_H_
|
||||
|
||||
#include <Protocol/DriverBinding.h>
|
||||
#include <Protocol/ServiceBinding.h>
|
||||
#include <Protocol/DevicePath.h>
|
||||
|
||||
/**
|
||||
Tests to see if this driver supports a given controller. If a child device is provided,
|
||||
it further tests to see if this driver supports creating a handle for the specified child device.
|
||||
|
||||
This function checks to see if the driver specified by This supports the device specified by
|
||||
ControllerHandle. Drivers typically use the device path attached to
|
||||
ControllerHandle and/or the services from the bus I/O abstraction attached to
|
||||
ControllerHandle to determine if the driver supports ControllerHandle. This function
|
||||
may be called many times during platform initialization. In order to reduce boot times, the tests
|
||||
performed by this function must be very small, and take as little time as possible to execute. This
|
||||
function must not change the state of any hardware devices, and this function must be aware that the
|
||||
device specified by ControllerHandle may already be managed by the same driver or a
|
||||
different driver. This function must match its calls to AllocatePages() with FreePages(),
|
||||
AllocatePool() with FreePool(), and OpenProtocol() with CloseProtocol().
|
||||
Since ControllerHandle may have been previously started by the same driver, if a protocol is
|
||||
already in the opened state, then it must not be closed with CloseProtocol(). This is required
|
||||
to guarantee the state of ControllerHandle is not modified by this function.
|
||||
|
||||
@param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
|
||||
@param[in] ControllerHandle The handle of the controller to test. This handle
|
||||
must support a protocol interface that supplies
|
||||
an I/O abstraction to the driver.
|
||||
@param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This
|
||||
parameter is ignored by device drivers, and is optional for bus
|
||||
drivers. For bus drivers, if this parameter is not NULL, then
|
||||
the bus driver must determine if the bus controller specified
|
||||
by ControllerHandle and the child controller specified
|
||||
by RemainingDevicePath are both supported by this
|
||||
bus driver.
|
||||
|
||||
@retval EFI_SUCCESS The device specified by ControllerHandle and
|
||||
RemainingDevicePath is supported by the driver specified by This.
|
||||
@retval EFI_ALREADY_STARTED The device specified by ControllerHandle and
|
||||
RemainingDevicePath is already being managed by the driver
|
||||
specified by This.
|
||||
@retval EFI_ACCESS_DENIED The device specified by ControllerHandle and
|
||||
RemainingDevicePath is already being managed by a different
|
||||
driver or an application that requires exclusive access.
|
||||
Currently not implemented.
|
||||
@retval EFI_UNSUPPORTED The device specified by ControllerHandle and
|
||||
RemainingDevicePath is not supported by the driver specified by This.
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
Udp6DriverBindingSupported (
|
||||
IN EFI_DRIVER_BINDING_PROTOCOL *This,
|
||||
IN EFI_HANDLE ControllerHandle,
|
||||
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL
|
||||
);
|
||||
|
||||
/**
|
||||
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 a driver to.
|
||||
@param[in] RemainingDevicePath Optional parameter use to pick a specific child
|
||||
device to start.
|
||||
|
||||
@retval EFI_SUCCES This driver is added to ControllerHandle.
|
||||
@retval EFI_OUT_OF_RESOURCES The required system resource can't be allocated.
|
||||
@retval other This driver does not support this device.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
Udp6DriverBindingStart (
|
||||
IN EFI_DRIVER_BINDING_PROTOCOL *This,
|
||||
IN EFI_HANDLE ControllerHandle,
|
||||
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL
|
||||
);
|
||||
|
||||
/**
|
||||
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 the 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. It is optional.
|
||||
|
||||
@retval EFI_SUCCESS This driver removed ControllerHandle.
|
||||
@retval EFI_DEVICE_ERROR Can't find the NicHandle from the ControllerHandle and specified GUID.
|
||||
@retval other This driver was not removed from this device.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
Udp6DriverBindingStop (
|
||||
IN EFI_DRIVER_BINDING_PROTOCOL *This,
|
||||
IN EFI_HANDLE ControllerHandle,
|
||||
IN UINTN NumberOfChildren,
|
||||
IN EFI_HANDLE *ChildHandleBuffer OPTIONAL
|
||||
);
|
||||
|
||||
/**
|
||||
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[in] This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.
|
||||
@param[in, out] 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 This is NULL or 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.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
Udp6ServiceBindingCreateChild (
|
||||
IN EFI_SERVICE_BINDING_PROTOCOL *This,
|
||||
IN OUT EFI_HANDLE *ChildHandle
|
||||
);
|
||||
|
||||
/**
|
||||
Destroys a child handle with a set of I/O services.
|
||||
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[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 not a valid EFI Handle.
|
||||
@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.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
Udp6ServiceBindingDestroyChild (
|
||||
IN EFI_SERVICE_BINDING_PROTOCOL *This,
|
||||
IN EFI_HANDLE ChildHandle
|
||||
);
|
||||
|
||||
#endif
|
||||
|
||||
63
NetworkPkg/Udp6Dxe/Udp6Dxe.inf
Normal file
63
NetworkPkg/Udp6Dxe/Udp6Dxe.inf
Normal file
@@ -0,0 +1,63 @@
|
||||
## @file Udp6Dxe.inf
|
||||
# Component description file for Udp6 module.
|
||||
#
|
||||
# Copyright (c) 2009 - 2010, 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
|
||||
# http://opensource.org/licenses/bsd-license.php.
|
||||
#
|
||||
# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
||||
#
|
||||
##
|
||||
|
||||
[Defines]
|
||||
INF_VERSION = 0x00010005
|
||||
BASE_NAME = Udp6Dxe
|
||||
FILE_GUID = D912C7BC-F098-4367-92BA-E911083C7B0E
|
||||
MODULE_TYPE = UEFI_DRIVER
|
||||
VERSION_STRING = 1.0
|
||||
|
||||
ENTRY_POINT = Udp6DriverEntryPoint
|
||||
UNLOAD_IMAGE = NetLibDefaultUnload
|
||||
|
||||
#
|
||||
# The following information is for reference only and not required by the build tools.
|
||||
#
|
||||
# VALID_ARCHITECTURES = IA32 X64 IPF EBC
|
||||
#
|
||||
|
||||
[Sources]
|
||||
Udp6Driver.h
|
||||
Udp6Driver.c
|
||||
Udp6Impl.c
|
||||
Udp6Impl.h
|
||||
ComponentName.c
|
||||
Udp6Main.c
|
||||
|
||||
[Packages]
|
||||
MdePkg/MdePkg.dec
|
||||
MdeModulePkg/MdeModulePkg.dec
|
||||
|
||||
[LibraryClasses]
|
||||
BaseLib
|
||||
BaseMemoryLib
|
||||
MemoryAllocationLib
|
||||
UefiBootServicesTableLib
|
||||
UefiDriverEntryPoint
|
||||
UefiRuntimeServicesTableLib
|
||||
UefiLib
|
||||
DebugLib
|
||||
IpIoLib
|
||||
NetLib
|
||||
DpcLib
|
||||
|
||||
|
||||
[Protocols]
|
||||
gEfiIp6ProtocolGuid # PROTOCOL ALWAYS_CONSUMED
|
||||
gEfiIp6ServiceBindingProtocolGuid # PROTOCOL ALWAYS_CONSUMED
|
||||
gEfiUdp6ServiceBindingProtocolGuid # PROTOCOL ALWAYS_CONSUMED
|
||||
gEfiUdp6ProtocolGuid # PROTOCOL ALWAYS_CONSUMED
|
||||
|
||||
2131
NetworkPkg/Udp6Dxe/Udp6Impl.c
Normal file
2131
NetworkPkg/Udp6Dxe/Udp6Impl.c
Normal file
File diff suppressed because it is too large
Load Diff
673
NetworkPkg/Udp6Dxe/Udp6Impl.h
Normal file
673
NetworkPkg/Udp6Dxe/Udp6Impl.h
Normal file
@@ -0,0 +1,673 @@
|
||||
/** @file
|
||||
Udp6 driver's whole implementation and internal data structures.
|
||||
|
||||
Copyright (c) 2009 - 2010, 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
|
||||
http://opensource.org/licenses/bsd-license.php.
|
||||
|
||||
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
||||
|
||||
**/
|
||||
|
||||
#ifndef _UDP6_IMPL_H_
|
||||
#define _UDP6_IMPL_H_
|
||||
|
||||
#include <Uefi.h>
|
||||
|
||||
#include <Protocol/Ip6.h>
|
||||
#include <Protocol/Udp6.h>
|
||||
|
||||
#include <Library/IpIoLib.h>
|
||||
#include <Library/DebugLib.h>
|
||||
#include <Library/UefiRuntimeServicesTableLib.h>
|
||||
#include <Library/UefiBootServicesTableLib.h>
|
||||
#include <Library/BaseLib.h>
|
||||
#include <Library/UefiLib.h>
|
||||
#include <Library/BaseMemoryLib.h>
|
||||
#include <Library/MemoryAllocationLib.h>
|
||||
#include <Library/DpcLib.h>
|
||||
|
||||
#include "Udp6Driver.h"
|
||||
|
||||
extern EFI_COMPONENT_NAME2_PROTOCOL gUdp6ComponentName2;
|
||||
extern EFI_COMPONENT_NAME_PROTOCOL gUdp6ComponentName;
|
||||
extern EFI_SERVICE_BINDING_PROTOCOL mUdp6ServiceBinding;
|
||||
extern EFI_UDP6_PROTOCOL mUdp6Protocol;
|
||||
extern UINT16 mUdp6RandomPort;
|
||||
|
||||
//
|
||||
// Define time out 50 milliseconds
|
||||
//
|
||||
#define UDP6_TIMEOUT_INTERVAL (50 * TICKS_PER_MS)
|
||||
#define UDP6_HEADER_SIZE sizeof (EFI_UDP_HEADER)
|
||||
#define UDP6_MAX_DATA_SIZE 65507
|
||||
#define UDP6_PORT_KNOWN 1024
|
||||
|
||||
#define UDP6_SERVICE_DATA_SIGNATURE SIGNATURE_32 ('U', 'd', 'p', '6')
|
||||
#define UDP6_INSTANCE_DATA_SIGNATURE SIGNATURE_32 ('U', 'd', 'p', 'S')
|
||||
|
||||
#define UDP6_SERVICE_DATA_FROM_THIS(a) \
|
||||
CR ( \
|
||||
(a), \
|
||||
UDP6_SERVICE_DATA, \
|
||||
ServiceBinding, \
|
||||
UDP6_SERVICE_DATA_SIGNATURE \
|
||||
)
|
||||
|
||||
#define UDP6_INSTANCE_DATA_FROM_THIS(a) \
|
||||
CR ( \
|
||||
(a), \
|
||||
UDP6_INSTANCE_DATA, \
|
||||
Udp6Proto, \
|
||||
UDP6_INSTANCE_DATA_SIGNATURE \
|
||||
)
|
||||
//
|
||||
// Udp6 service contest data
|
||||
//
|
||||
typedef struct _UDP6_SERVICE_DATA {
|
||||
UINT32 Signature;
|
||||
EFI_SERVICE_BINDING_PROTOCOL ServiceBinding;
|
||||
EFI_HANDLE ImageHandle;
|
||||
EFI_HANDLE ControllerHandle;
|
||||
LIST_ENTRY ChildrenList;
|
||||
UINTN ChildrenNumber;
|
||||
IP_IO *IpIo;
|
||||
EFI_EVENT TimeoutEvent;
|
||||
CHAR16 *MacString;
|
||||
} UDP6_SERVICE_DATA;
|
||||
|
||||
typedef struct _UDP6_INSTANCE_DATA {
|
||||
UINT32 Signature;
|
||||
LIST_ENTRY Link;
|
||||
UDP6_SERVICE_DATA *Udp6Service;
|
||||
EFI_UDP6_PROTOCOL Udp6Proto;
|
||||
EFI_UDP6_CONFIG_DATA ConfigData;
|
||||
EFI_HANDLE ChildHandle;
|
||||
BOOLEAN Configured;
|
||||
BOOLEAN IsNoMapping;
|
||||
NET_MAP TxTokens;
|
||||
NET_MAP RxTokens;
|
||||
NET_MAP McastIps;
|
||||
LIST_ENTRY RcvdDgramQue;
|
||||
LIST_ENTRY DeliveredDgramQue;
|
||||
UINT16 HeadSum;
|
||||
EFI_STATUS IcmpError;
|
||||
IP_IO_IP_INFO *IpInfo;
|
||||
BOOLEAN Destroyed;
|
||||
} UDP6_INSTANCE_DATA;
|
||||
|
||||
typedef struct _UDP6_RXDATA_WRAP {
|
||||
LIST_ENTRY Link;
|
||||
NET_BUF *Packet;
|
||||
UINT32 TimeoutTick;
|
||||
EFI_UDP6_RECEIVE_DATA RxData;
|
||||
} UDP6_RXDATA_WRAP;
|
||||
|
||||
/**
|
||||
Clean the Udp service context data.
|
||||
|
||||
@param[in, out] Udp6Service Pointer to the UDP6_SERVICE_DATA.
|
||||
|
||||
**/
|
||||
VOID
|
||||
Udp6CleanService (
|
||||
IN OUT UDP6_SERVICE_DATA *Udp6Service
|
||||
);
|
||||
|
||||
/**
|
||||
Create the Udp service context data.
|
||||
|
||||
@param[in] Udp6Service Pointer to the UDP6_SERVICE_DATA.
|
||||
@param[in] ImageHandle The image handle of this udp6 driver.
|
||||
@param[in] ControllerHandle The controller handle this udp6 driver binds on.
|
||||
|
||||
@retval EFI_SUCCESS The udp6 service context data was created and
|
||||
initialized.
|
||||
@retval EFI_OUT_OF_RESOURCES Cannot allocate memory.
|
||||
@retval Others An error condition occurred.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
Udp6CreateService (
|
||||
IN UDP6_SERVICE_DATA *Udp6Service,
|
||||
IN EFI_HANDLE ImageHandle,
|
||||
IN EFI_HANDLE ControllerHandle
|
||||
);
|
||||
|
||||
/**
|
||||
Set the Udp6 variable data.
|
||||
|
||||
@param[in] Udp6Service Udp6 service data.
|
||||
|
||||
@retval EFI_OUT_OF_RESOURCES There are not enough resources to set the
|
||||
variable.
|
||||
@retval other Set variable failed.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
Udp6SetVariableData (
|
||||
IN UDP6_SERVICE_DATA *Udp6Service
|
||||
);
|
||||
|
||||
/**
|
||||
This function cleans the udp instance.
|
||||
|
||||
@param[in, out] Instance Pointer to the UDP6_INSTANCE_DATA to clean.
|
||||
|
||||
**/
|
||||
VOID
|
||||
Udp6CleanInstance (
|
||||
IN OUT UDP6_INSTANCE_DATA *Instance
|
||||
);
|
||||
|
||||
/**
|
||||
Clear the variable and free the resource.
|
||||
|
||||
@param[in, out] Udp6Service Udp6 service data.
|
||||
|
||||
**/
|
||||
VOID
|
||||
Udp6ClearVariableData (
|
||||
IN OUT UDP6_SERVICE_DATA *Udp6Service
|
||||
);
|
||||
|
||||
/**
|
||||
This function intializes the new created udp instance.
|
||||
|
||||
@param[in] Udp6Service Pointer to the UDP6_SERVICE_DATA.
|
||||
@param[in, out] Instance Pointer to the un-initialized UDP6_INSTANCE_DATA.
|
||||
|
||||
**/
|
||||
VOID
|
||||
Udp6InitInstance (
|
||||
IN UDP6_SERVICE_DATA *Udp6Service,
|
||||
IN OUT UDP6_INSTANCE_DATA *Instance
|
||||
);
|
||||
|
||||
/**
|
||||
This function reports the received ICMP error.
|
||||
|
||||
@param[in] Instance Pointer to the udp instance context data.
|
||||
|
||||
**/
|
||||
VOID
|
||||
Udp6ReportIcmpError (
|
||||
IN UDP6_INSTANCE_DATA *Instance
|
||||
);
|
||||
|
||||
/**
|
||||
This function copies the current operational settings of this EFI UDPv6 Protocol
|
||||
instance into user-supplied buffers. This function is used optionally to retrieve
|
||||
the operational mode data of underlying networks or drivers.
|
||||
|
||||
@param[in] This Pointer to the EFI_UDP6_PROTOCOL instance.
|
||||
@param[out] Udp6ConfigData The buffer in which the current UDP configuration
|
||||
data is returned. This parameter is optional and
|
||||
may be NULL.
|
||||
@param[out] Ip6ModeData The buffer in which the current EFI IPv6 Protocol
|
||||
mode data is returned. This parameter is optional
|
||||
and may be NULL.
|
||||
@param[out] MnpConfigData The buffer in which the current managed network
|
||||
configuration data is returned. This parameter
|
||||
is optional and may be NULL.
|
||||
@param[out] SnpModeData The buffer in which the simple network mode data
|
||||
is returned. This parameter is optional and may be NULL.
|
||||
|
||||
@retval EFI_SUCCESS The mode data was read.
|
||||
@retval EFI_NOT_STARTED When Udp6ConfigData is queried, no configuration
|
||||
data is available because this instance has not
|
||||
been started.
|
||||
@retval EFI_INVALID_PARAMETER This is NULL.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
Udp6GetModeData (
|
||||
IN EFI_UDP6_PROTOCOL *This,
|
||||
OUT EFI_UDP6_CONFIG_DATA *Udp6ConfigData OPTIONAL,
|
||||
OUT EFI_IP6_MODE_DATA *Ip6ModeData OPTIONAL,
|
||||
OUT EFI_MANAGED_NETWORK_CONFIG_DATA *MnpConfigData OPTIONAL,
|
||||
OUT EFI_SIMPLE_NETWORK_MODE *SnpModeData OPTIONAL
|
||||
);
|
||||
|
||||
/**
|
||||
This function is used to do the following:
|
||||
Initialize and start this instance of the EFI UDPv6 Protocol.
|
||||
Change the filtering rules and operational parameters.
|
||||
Reset this instance of the EFI UDPv6 Protocol.
|
||||
|
||||
@param[in] This Pointer to the EFI_UDP6_PROTOCOL instance.
|
||||
@param[in] UdpConfigData Pointer to the buffer to set the configuration
|
||||
data. This parameter is optional and may be NULL.
|
||||
|
||||
@retval EFI_SUCCESS The configuration settings were set, changed, or
|
||||
reset successfully.
|
||||
@retval EFI_NO_MAPPING When the UdpConifgData.UseAnyStationAddress is set
|
||||
to true and there is no address available for IP6
|
||||
driver to binding source address to this
|
||||
instance.
|
||||
@retval EFI_INVALID_PARAMETER One or more following conditions are TRUE:
|
||||
This is NULL.
|
||||
UdpConfigData.StationAddress is not a valid
|
||||
unicast IPv6 address.
|
||||
UdpConfigData.RemoteAddress is not a valid unicast
|
||||
IPv6 address, if it is not zero.
|
||||
@retval EFI_ALREADY_STARTED The EFI UDPv6 Protocol instance is already
|
||||
started/configured and must be stopped/reset
|
||||
before it can be reconfigured. Only TrafficClass,
|
||||
HopLimit, ReceiveTimeout, and TransmitTimeout can
|
||||
be reconfigured without stopping the current
|
||||
instance of the EFI UDPv6 Protocol.
|
||||
@retval EFI_ACCESS_DENIED UdpConfigData.AllowDuplicatePort is FALSE, and
|
||||
UdpConfigData.StationPort is already used by another
|
||||
instance.
|
||||
@retval EFI_OUT_OF_RESOURCES The EFI UDPv6 Protocol driver cannot allocate
|
||||
memory for this EFI UDPv6 Protocol instance.
|
||||
@retval EFI_DEVICE_ERROR An unexpected network or system error occurred, and
|
||||
this instance was not opened.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
Udp6Configure (
|
||||
IN EFI_UDP6_PROTOCOL *This,
|
||||
IN EFI_UDP6_CONFIG_DATA *UdpConfigData OPTIONAL
|
||||
);
|
||||
|
||||
/**
|
||||
This function places a sending request to this instance of the EFI UDPv6 Protocol,
|
||||
alongside the transmit data that was filled by the user.
|
||||
|
||||
@param[in] This Pointer to the EFI_UDP6_PROTOCOL instance.
|
||||
@param[in] Token Pointer to the completion token that will be
|
||||
placed into the transmit queue.
|
||||
|
||||
@retval EFI_SUCCESS The data has been queued for transmission.
|
||||
@retval EFI_NOT_STARTED This EFI UDPv6 Protocol instance has not been
|
||||
started.
|
||||
@retval EFI_NO_MAPPING The under-layer IPv6 driver was responsible for
|
||||
choosing a source address for this instance, but
|
||||
no source address was available for use.
|
||||
@retval EFI_INVALID_PARAMETER One or more of the following are TRUE:
|
||||
This is NULL. Token is NULL. Token.Event is NULL.
|
||||
Token.Packet.TxData is NULL.
|
||||
Token.Packet.TxData.FragmentCount is zero.
|
||||
Token.Packet.TxData.DataLength is not equal to the
|
||||
sum of fragment lengths.
|
||||
One or more of the
|
||||
Token.Packet.TxData.FragmentTable[]
|
||||
.FragmentLength fields is zero.
|
||||
One or more of the
|
||||
Token.Packet.TxData.FragmentTable[]
|
||||
.FragmentBuffer fields is NULL.
|
||||
One or more of the
|
||||
Token.Packet.TxData.UdpSessionData.
|
||||
DestinationAddres are not valid unicast IPv6
|
||||
addresses, if the UdpSessionData is not NULL.
|
||||
Token.Packet.TxData.UdpSessionData.
|
||||
DestinationAddres is NULL
|
||||
Token.Packet.TxData.UdpSessionData.
|
||||
DestinatioPort is zero.
|
||||
Token.Packet.TxData.UdpSessionData is
|
||||
NULL and this instance's
|
||||
UdpConfigData.RemoteAddress is unspecified.
|
||||
@retval EFI_ACCESS_DENIED The transmit completion token with the same
|
||||
Token.Event is already in the transmit queue.
|
||||
@retval EFI_NOT_READY The completion token could not be queued because
|
||||
the transmit queue is full.
|
||||
@retval EFI_OUT_OF_RESOURCES Could not queue the transmit data.
|
||||
@retval EFI_NOT_FOUND There is no route to the destination network or
|
||||
address.
|
||||
@retval EFI_BAD_BUFFER_SIZE The data length is greater than the maximum UDP
|
||||
packet size. Or the length of the IP header + UDP
|
||||
header + data length is greater than MTU if
|
||||
DoNotFragment is TRUE.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
Udp6Transmit (
|
||||
IN EFI_UDP6_PROTOCOL *This,
|
||||
IN EFI_UDP6_COMPLETION_TOKEN *Token
|
||||
);
|
||||
|
||||
/**
|
||||
This function places a completion token into the receive packet queue. This function
|
||||
is always asynchronous.
|
||||
|
||||
@param[in] This Pointer to the EFI_UDP6_PROTOCOL instance.
|
||||
@param[in] Token Pointer to a token that is associated with the
|
||||
receive data descriptor.
|
||||
|
||||
@retval EFI_SUCCESS The receive completion token is cached.
|
||||
@retval EFI_NOT_STARTED This EFI UDPv6 Protocol instance has not been
|
||||
started.
|
||||
@retval EFI_NO_MAPPING When using a default address, configuration (DHCP,
|
||||
BOOTP, RARP, etc.) is not finished yet.
|
||||
@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
|
||||
This is NULL.
|
||||
Token is NULL.
|
||||
Token.Event is NULL.
|
||||
@retval EFI_OUT_OF_RESOURCES The receive completion token could not be queued
|
||||
due to a lack of system resources (usually
|
||||
memory).
|
||||
@retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
|
||||
The EFI UDPv6 Protocol instance has been reset to
|
||||
startup defaults.
|
||||
@retval EFI_ACCESS_DENIED A receive completion token with the same
|
||||
Token.Event is already in the receive queue.
|
||||
@retval EFI_NOT_READY The receive request could not be queued because
|
||||
the receive queue is full.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
Udp6Receive (
|
||||
IN EFI_UDP6_PROTOCOL *This,
|
||||
IN EFI_UDP6_COMPLETION_TOKEN *Token
|
||||
);
|
||||
|
||||
/**
|
||||
This function is used to abort a pending transmit or receive request.
|
||||
|
||||
@param[in] This Pointer to the EFI_UDP6_PROTOCOL instance.
|
||||
@param[in] Token Pointer to a token that has been issued by
|
||||
EFI_UDP6_PROTOCOL.Transmit() or
|
||||
EFI_UDP6_PROTOCOL.Receive(). This parameter is
|
||||
optional and may be NULL.
|
||||
|
||||
@retval EFI_SUCCESS The asynchronous I/O request is aborted and
|
||||
Token.Event is signaled. When Token is NULL, all
|
||||
pending requests are aborted and their events are
|
||||
signaled.
|
||||
@retval EFI_INVALID_PARAMETER This is NULL.
|
||||
@retval EFI_NOT_STARTED This instance has not been started.
|
||||
@retval EFI_NO_MAPPING When using the default address, configuration
|
||||
(DHCP, BOOTP, RARP, etc.) is not finished yet.
|
||||
@retval EFI_NOT_FOUND When Token is not NULL, the asynchronous I/O
|
||||
request is not found in the transmit or receive
|
||||
queue. It either completed or was not issued by
|
||||
Transmit() or Receive().
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
Udp6Cancel (
|
||||
IN EFI_UDP6_PROTOCOL *This,
|
||||
IN EFI_UDP6_COMPLETION_TOKEN *Token OPTIONAL
|
||||
);
|
||||
|
||||
/**
|
||||
This function can be used by network drivers and applications to increase the rate that
|
||||
data packets are moved between the communications device and the transmit/receive queues.
|
||||
|
||||
@param[in] This Pointer to the EFI_UDP6_PROTOCOL instance.
|
||||
|
||||
@retval EFI_SUCCESS Incoming or outgoing data was processed.
|
||||
@retval EFI_INVALID_PARAMETER This is NULL.
|
||||
@retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
|
||||
@retval EFI_TIMEOUT Data was dropped out of the transmit and/or
|
||||
receive queue.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
Udp6Poll (
|
||||
IN EFI_UDP6_PROTOCOL *This
|
||||
);
|
||||
|
||||
/**
|
||||
This function is used to enable and disable the multicast group filtering.
|
||||
|
||||
@param[in] This Pointer to the EFI_UDP6_PROTOCOL instance.
|
||||
@param[in] JoinFlag Set to TRUE to join a multicast group. Set to
|
||||
FALSE to leave one or all multicast groups.
|
||||
@param[in] MulticastAddress Pointer to multicast group address to join or
|
||||
leave. This parameter is optional and may be NULL.
|
||||
|
||||
@retval EFI_SUCCESS The operation completed successfully.
|
||||
@retval EFI_NOT_STARTED The EFI UDPv6 Protocol instance has not been
|
||||
started.
|
||||
@retval EFI_OUT_OF_RESOURCES Could not allocate resources to join the group.
|
||||
@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
|
||||
This is NULL. JoinFlag is TRUE and
|
||||
MulticastAddress is NULL. JoinFlag is TRUE and
|
||||
*MulticastAddress is not a valid multicast
|
||||
address.
|
||||
@retval EFI_ALREADY_STARTED The group address is already in the group table
|
||||
(when JoinFlag is TRUE).
|
||||
@retval EFI_NOT_FOUND The group address is not in the group table (when
|
||||
JoinFlag is FALSE).
|
||||
@retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
Udp6Groups (
|
||||
IN EFI_UDP6_PROTOCOL *This,
|
||||
IN BOOLEAN JoinFlag,
|
||||
IN EFI_IPv6_ADDRESS *MulticastAddress OPTIONAL
|
||||
);
|
||||
|
||||
/**
|
||||
This function tries to bind the udp instance according to the configured port
|
||||
allocation stragety.
|
||||
|
||||
@param[in] InstanceList Pointer to the head of the list linking the udp
|
||||
instances.
|
||||
@param[in] ConfigData Pointer to the ConfigData of the instance to be
|
||||
bound.
|
||||
|
||||
@retval EFI_SUCCESS The bound operation completed successfully.
|
||||
@retval EFI_ACCESS_DENIED The <Address, Port> specified by the ConfigData is
|
||||
already used by another instance.
|
||||
@retval EFI_OUT_OF_RESOURCES No available port resources.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
Udp6Bind (
|
||||
IN LIST_ENTRY *InstanceList,
|
||||
IN EFI_UDP6_CONFIG_DATA *ConfigData
|
||||
);
|
||||
|
||||
/**
|
||||
This function builds the Ip6 configdata from the Udp6ConfigData.
|
||||
|
||||
@param[in] Udp6ConfigData Pointer to the EFI_UDP6_CONFIG_DATA.
|
||||
@param[in, out] Ip6ConfigData Pointer to the EFI_IP6_CONFIG_DATA.
|
||||
|
||||
**/
|
||||
VOID
|
||||
Udp6BuildIp6ConfigData (
|
||||
IN EFI_UDP6_CONFIG_DATA *Udp6ConfigData,
|
||||
IN OUT EFI_IP6_CONFIG_DATA *Ip6ConfigData
|
||||
);
|
||||
|
||||
/**
|
||||
This function checks whether the specified Token duplicates with the one in the Map.
|
||||
|
||||
@param[in] Map Pointer to the NET_MAP.
|
||||
@param[in] Item Pointer to the NET_MAP_ITEM contain the pointer to
|
||||
the Token.
|
||||
@param[in] Context Pointer to the Token to be checked.
|
||||
|
||||
@retval EFI_SUCCESS The Token specified by Context differs from the
|
||||
one in the Item.
|
||||
@retval EFI_ACCESS_DENIED The Token duplicates with the one in the Item.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
Udp6TokenExist (
|
||||
IN NET_MAP *Map,
|
||||
IN NET_MAP_ITEM *Item,
|
||||
IN VOID *Context
|
||||
);
|
||||
|
||||
/**
|
||||
This function removes the specified Token from the TokenMap.
|
||||
|
||||
@param[in] TokenMap Pointer to the NET_MAP containing the tokens.
|
||||
@param[in] Token Pointer to the Token to be removed.
|
||||
|
||||
@retval EFI_SUCCESS The specified Token is removed from the TokenMap.
|
||||
@retval EFI_NOT_FOUND The specified Token is not found in the TokenMap.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
Udp6RemoveToken (
|
||||
IN NET_MAP *TokenMap,
|
||||
IN EFI_UDP6_COMPLETION_TOKEN *Token
|
||||
);
|
||||
|
||||
/**
|
||||
This function is used to check whether the NewConfigData has any un-reconfigurable
|
||||
parameters changed compared to the OldConfigData.
|
||||
|
||||
@param[in] OldConfigData Pointer to the current ConfigData the udp instance
|
||||
uses.
|
||||
@param[in] NewConfigData Pointer to the new ConfigData.
|
||||
|
||||
@retval TRUE The instance is reconfigurable according to NewConfigData.
|
||||
@retval FALSE The instance is not reconfigurable according to NewConfigData.
|
||||
|
||||
**/
|
||||
BOOLEAN
|
||||
Udp6IsReconfigurable (
|
||||
IN EFI_UDP6_CONFIG_DATA *OldConfigData,
|
||||
IN EFI_UDP6_CONFIG_DATA *NewConfigData
|
||||
);
|
||||
|
||||
/**
|
||||
This function removes the multicast group specified by Arg from the Map.
|
||||
|
||||
@param[in] Map Pointer to the NET_MAP.
|
||||
@param[in] Item Pointer to the NET_MAP_ITEM.
|
||||
@param[in] Arg Pointer to the Arg. It is the pointer to a
|
||||
multicast IPv6 Address. This parameter is
|
||||
optional and may be NULL.
|
||||
|
||||
@retval EFI_SUCCESS The multicast address is removed.
|
||||
@retval EFI_ABORTED The specified multicast address is removed, and the
|
||||
Arg is not NULL.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
Udp6LeaveGroup (
|
||||
IN NET_MAP *Map,
|
||||
IN NET_MAP_ITEM *Item,
|
||||
IN VOID *Arg OPTIONAL
|
||||
);
|
||||
|
||||
/**
|
||||
This function validates the TxToken, it returns the error code according to the spec.
|
||||
|
||||
@param[in] Instance Pointer to the udp instance context data.
|
||||
@param[in] TxToken Pointer to the token to be checked.
|
||||
|
||||
@retval EFI_SUCCESS The TxToken is valid.
|
||||
@retval EFI_INVALID_PARAMETER One or more of the following are TRUE:
|
||||
Token.Event is NULL.
|
||||
Token.Packet.TxData is NULL.
|
||||
Token.Packet.TxData.FragmentCount is zero.
|
||||
Token.Packet.TxData.DataLength is not equal to the
|
||||
sum of fragment lengths.
|
||||
One or more of the
|
||||
Token.Packet.TxData.FragmentTable[].FragmentLength
|
||||
fields is zero.
|
||||
One or more of the
|
||||
Token.Packet.TxData.FragmentTable[].FragmentBuffer
|
||||
fields is NULL.
|
||||
UdpSessionData.DestinationAddress are not valid
|
||||
unicast IPv6 addresses if the UdpSessionData is
|
||||
not NULL.
|
||||
UdpSessionData.DestinationPort and
|
||||
ConfigData.RemotePort are all zero if the
|
||||
UdpSessionData is not NULL.
|
||||
@retval EFI_BAD_BUFFER_SIZE The data length is greater than the maximum UDP
|
||||
packet size.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
Udp6ValidateTxToken (
|
||||
IN UDP6_INSTANCE_DATA *Instance,
|
||||
IN EFI_UDP6_COMPLETION_TOKEN *TxToken
|
||||
);
|
||||
|
||||
/**
|
||||
This function is a dummy ext-free function for the NET_BUF created for the output
|
||||
udp datagram.
|
||||
|
||||
@param[in] Context Pointer to the context data.
|
||||
|
||||
**/
|
||||
VOID
|
||||
EFIAPI
|
||||
Udp6NetVectorExtFree (
|
||||
IN VOID *Context
|
||||
);
|
||||
|
||||
/**
|
||||
This function calculates the checksum for the Packet, utilizing the pre-calculated
|
||||
pseudo header to reduce overhead.
|
||||
|
||||
@param[in] Packet Pointer to the NET_BUF contains the udp datagram.
|
||||
@param[in] HeadSum Checksum of the pseudo header execpt the length
|
||||
field.
|
||||
|
||||
@return The 16-bit checksum of this udp datagram.
|
||||
|
||||
**/
|
||||
UINT16
|
||||
Udp6Checksum (
|
||||
IN NET_BUF *Packet,
|
||||
IN UINT16 HeadSum
|
||||
);
|
||||
|
||||
/**
|
||||
This function delivers the received datagrams to the specified instance.
|
||||
|
||||
@param[in] Instance Pointer to the instance context data.
|
||||
|
||||
**/
|
||||
VOID
|
||||
Udp6InstanceDeliverDgram (
|
||||
IN UDP6_INSTANCE_DATA *Instance
|
||||
);
|
||||
|
||||
/**
|
||||
Cancel Udp6 tokens from the Udp6 instance.
|
||||
|
||||
@param[in] Instance Pointer to the udp instance context data.
|
||||
@param[in] Token Pointer to the token to be canceled. If NULL, all
|
||||
tokens in this instance will be cancelled.
|
||||
This parameter is optional and may be NULL.
|
||||
|
||||
@retval EFI_SUCCESS The Token is cancelled.
|
||||
@retval EFI_NOT_FOUND The Token is not found.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
Udp6InstanceCancelToken (
|
||||
IN UDP6_INSTANCE_DATA *Instance,
|
||||
IN EFI_UDP6_COMPLETION_TOKEN *Token OPTIONAL
|
||||
);
|
||||
|
||||
/**
|
||||
This function removes all the Wrap datas in the RcvdDgramQue.
|
||||
|
||||
@param[in] Instance Pointer to the Udp6 Instance.
|
||||
|
||||
**/
|
||||
VOID
|
||||
Udp6FlushRcvdDgram (
|
||||
IN UDP6_INSTANCE_DATA *Instance
|
||||
);
|
||||
|
||||
#endif
|
||||
|
||||
855
NetworkPkg/Udp6Dxe/Udp6Main.c
Normal file
855
NetworkPkg/Udp6Dxe/Udp6Main.c
Normal file
@@ -0,0 +1,855 @@
|
||||
/** @file
|
||||
Contains all EFI_UDP6_PROTOCOL interfaces.
|
||||
|
||||
Copyright (c) 2009 - 2010, 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
|
||||
http://opensource.org/licenses/bsd-license.php.
|
||||
|
||||
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 "Udp6Impl.h"
|
||||
|
||||
EFI_UDP6_PROTOCOL mUdp6Protocol = {
|
||||
Udp6GetModeData,
|
||||
Udp6Configure,
|
||||
Udp6Groups,
|
||||
Udp6Transmit,
|
||||
Udp6Receive,
|
||||
Udp6Cancel,
|
||||
Udp6Poll
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
This function copies the current operational settings of this EFI UDPv6 Protocol
|
||||
instance into user-supplied buffers. This function is used optionally to retrieve
|
||||
the operational mode data of underlying networks or drivers.
|
||||
|
||||
@param[in] This Pointer to the EFI_UDP6_PROTOCOL instance.
|
||||
@param[out] Udp6ConfigData The buffer in which the current UDP configuration
|
||||
data is returned. This parameter is optional and
|
||||
may be NULL.
|
||||
@param[out] Ip6ModeData The buffer in which the current EFI IPv6 Protocol
|
||||
mode data is returned. This parameter is optional
|
||||
and may be NULL.
|
||||
@param[out] MnpConfigData The buffer in which the current managed network
|
||||
configuration data is returned. This parameter is
|
||||
optional and may be NULL.
|
||||
@param[out] SnpModeData The buffer in which the simple network mode data
|
||||
is returned. This parameter is optional and may be NULL.
|
||||
|
||||
@retval EFI_SUCCESS The mode data was read.
|
||||
@retval EFI_NOT_STARTED When Udp6ConfigData is queried, no configuration
|
||||
data is available because this instance has not
|
||||
been started.
|
||||
@retval EFI_INVALID_PARAMETER This is NULL.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
Udp6GetModeData (
|
||||
IN EFI_UDP6_PROTOCOL *This,
|
||||
OUT EFI_UDP6_CONFIG_DATA *Udp6ConfigData OPTIONAL,
|
||||
OUT EFI_IP6_MODE_DATA *Ip6ModeData OPTIONAL,
|
||||
OUT EFI_MANAGED_NETWORK_CONFIG_DATA *MnpConfigData OPTIONAL,
|
||||
OUT EFI_SIMPLE_NETWORK_MODE *SnpModeData OPTIONAL
|
||||
)
|
||||
{
|
||||
UDP6_INSTANCE_DATA *Instance;
|
||||
EFI_IP6_PROTOCOL *Ip;
|
||||
EFI_TPL OldTpl;
|
||||
EFI_STATUS Status;
|
||||
|
||||
if (This == NULL) {
|
||||
return EFI_INVALID_PARAMETER;
|
||||
}
|
||||
|
||||
Instance = UDP6_INSTANCE_DATA_FROM_THIS (This);
|
||||
|
||||
if (!Instance->Configured && (Udp6ConfigData != NULL)) {
|
||||
return EFI_NOT_STARTED;
|
||||
}
|
||||
|
||||
OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
|
||||
|
||||
if (Udp6ConfigData != NULL) {
|
||||
//
|
||||
// Set the Udp6ConfigData.
|
||||
//
|
||||
CopyMem (Udp6ConfigData, &Instance->ConfigData, sizeof (EFI_UDP6_CONFIG_DATA));
|
||||
}
|
||||
|
||||
Ip = Instance->IpInfo->Ip.Ip6;
|
||||
|
||||
//
|
||||
// Get the underlying Ip6ModeData, MnpConfigData and SnpModeData.
|
||||
//
|
||||
Status = Ip->GetModeData (Ip, Ip6ModeData, MnpConfigData, SnpModeData);
|
||||
|
||||
gBS->RestoreTPL (OldTpl);
|
||||
|
||||
return Status;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
This function is used to do the following:
|
||||
Initialize and start this instance of the EFI UDPv6 Protocol.
|
||||
Change the filtering rules and operational parameters.
|
||||
Reset this instance of the EFI UDPv6 Protocol.
|
||||
|
||||
@param[in] This Pointer to the EFI_UDP6_PROTOCOL instance.
|
||||
@param[in] UdpConfigData Pointer to the buffer to set the configuration
|
||||
data. This parameter is optional and may be NULL.
|
||||
|
||||
@retval EFI_SUCCESS The configuration settings were set, changed, or
|
||||
reset successfully.
|
||||
@retval EFI_NO_MAPPING When the UdpConifgData.UseAnyStationAddress is set
|
||||
to true and there is no address available for the IP6
|
||||
driver to bind a source address to this instance.
|
||||
@retval EFI_INVALID_PARAMETER One or more following conditions are TRUE:
|
||||
This is NULL.
|
||||
UdpConfigData.StationAddress is not a valid
|
||||
unicast IPv6 address.
|
||||
UdpConfigData.RemoteAddress is not a valid unicast
|
||||
IPv6 address if it is not zero.
|
||||
@retval EFI_ALREADY_STARTED The EFI UDPv6 Protocol instance is already
|
||||
started/configured and must be stopped/reset
|
||||
before it can be reconfigured. Only TrafficClass,
|
||||
HopLimit, ReceiveTimeout, and TransmitTimeout can
|
||||
be reconfigured without stopping the current
|
||||
instance of the EFI UDPv6 Protocol.
|
||||
@retval EFI_ACCESS_DENIED UdpConfigData.AllowDuplicatePort is FALSE and
|
||||
UdpConfigData.StationPort is already used by another
|
||||
instance.
|
||||
@retval EFI_OUT_OF_RESOURCES The EFI UDPv6 Protocol driver cannot allocate
|
||||
memory for this EFI UDPv6 Protocol instance.
|
||||
@retval EFI_DEVICE_ERROR An unexpected network or system error occurred, and
|
||||
this instance was not opened.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
Udp6Configure (
|
||||
IN EFI_UDP6_PROTOCOL *This,
|
||||
IN EFI_UDP6_CONFIG_DATA *UdpConfigData OPTIONAL
|
||||
)
|
||||
{
|
||||
EFI_STATUS Status;
|
||||
UDP6_INSTANCE_DATA *Instance;
|
||||
UDP6_SERVICE_DATA *Udp6Service;
|
||||
EFI_TPL OldTpl;
|
||||
EFI_IPv6_ADDRESS StationAddress;
|
||||
EFI_IPv6_ADDRESS RemoteAddress;
|
||||
EFI_IP6_CONFIG_DATA Ip6ConfigData;
|
||||
EFI_IPv6_ADDRESS LocalAddr;
|
||||
EFI_IPv6_ADDRESS RemoteAddr;
|
||||
|
||||
if (This == NULL) {
|
||||
return EFI_INVALID_PARAMETER;
|
||||
}
|
||||
|
||||
Instance = UDP6_INSTANCE_DATA_FROM_THIS (This);
|
||||
|
||||
if (!Instance->Configured && (UdpConfigData == NULL)) {
|
||||
return EFI_SUCCESS;
|
||||
}
|
||||
|
||||
Udp6Service = Instance->Udp6Service;
|
||||
Status = EFI_SUCCESS;
|
||||
ASSERT (Udp6Service != NULL);
|
||||
|
||||
OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
|
||||
|
||||
if (UdpConfigData != NULL) {
|
||||
|
||||
IP6_COPY_ADDRESS (&StationAddress, &UdpConfigData->StationAddress);
|
||||
IP6_COPY_ADDRESS (&RemoteAddress, &UdpConfigData->RemoteAddress);
|
||||
|
||||
if ((!NetIp6IsUnspecifiedAddr (&StationAddress) && !NetIp6IsValidUnicast (&StationAddress)) ||
|
||||
(!NetIp6IsUnspecifiedAddr (&RemoteAddress) && !NetIp6IsValidUnicast (&RemoteAddress))
|
||||
){
|
||||
//
|
||||
// If not use default address, and StationAddress is not a valid unicast
|
||||
// if it is not IPv6 address or RemoteAddress is not a valid unicast IPv6
|
||||
// address if it is not 0.
|
||||
//
|
||||
Status = EFI_INVALID_PARAMETER;
|
||||
goto ON_EXIT;
|
||||
}
|
||||
|
||||
if (Instance->Configured) {
|
||||
//
|
||||
// The instance is already configured, try to do the re-configuration.
|
||||
//
|
||||
if (!Udp6IsReconfigurable (&Instance->ConfigData, UdpConfigData)) {
|
||||
//
|
||||
// If the new configuration data wants to change some unreconfigurable
|
||||
// settings, return EFI_ALREADY_STARTED.
|
||||
//
|
||||
Status = EFI_ALREADY_STARTED;
|
||||
goto ON_EXIT;
|
||||
}
|
||||
|
||||
//
|
||||
// Save the reconfigurable parameters.
|
||||
//
|
||||
Instance->ConfigData.TrafficClass = UdpConfigData->TrafficClass;
|
||||
Instance->ConfigData.HopLimit = UdpConfigData->HopLimit;
|
||||
Instance->ConfigData.ReceiveTimeout = UdpConfigData->ReceiveTimeout;
|
||||
Instance->ConfigData.TransmitTimeout = UdpConfigData->TransmitTimeout;
|
||||
} else {
|
||||
//
|
||||
// Construct the Ip configuration data from the UdpConfigData.
|
||||
//
|
||||
Udp6BuildIp6ConfigData (UdpConfigData, &Ip6ConfigData);
|
||||
|
||||
//
|
||||
// Configure the Ip instance wrapped in the IpInfo.
|
||||
//
|
||||
Status = IpIoConfigIp (Instance->IpInfo, &Ip6ConfigData);
|
||||
if (EFI_ERROR (Status)) {
|
||||
if (Status == EFI_NO_MAPPING) {
|
||||
Instance->IsNoMapping = TRUE;
|
||||
}
|
||||
|
||||
goto ON_EXIT;
|
||||
}
|
||||
|
||||
Instance->IsNoMapping = FALSE;
|
||||
|
||||
//
|
||||
// Save the configuration data.
|
||||
//
|
||||
CopyMem (
|
||||
&Instance->ConfigData,
|
||||
UdpConfigData,
|
||||
sizeof (EFI_UDP6_CONFIG_DATA)
|
||||
);
|
||||
IP6_COPY_ADDRESS (&Instance->ConfigData.StationAddress, &Ip6ConfigData.StationAddress);
|
||||
//
|
||||
// Try to allocate the required port resource.
|
||||
//
|
||||
Status = Udp6Bind (&Udp6Service->ChildrenList, &Instance->ConfigData);
|
||||
if (EFI_ERROR (Status)) {
|
||||
//
|
||||
// Reset the ip instance if bind fails.
|
||||
//
|
||||
IpIoConfigIp (Instance->IpInfo, NULL);
|
||||
goto ON_EXIT;
|
||||
}
|
||||
|
||||
//
|
||||
// Pre calculate the checksum for the pseudo head, ignore the UDP length first.
|
||||
//
|
||||
IP6_COPY_ADDRESS (&LocalAddr, &Instance->ConfigData.StationAddress);
|
||||
IP6_COPY_ADDRESS (&RemoteAddr, &Instance->ConfigData.RemoteAddress);
|
||||
|
||||
Instance->HeadSum = NetIp6PseudoHeadChecksum (
|
||||
&LocalAddr,
|
||||
&RemoteAddr,
|
||||
EFI_IP_PROTO_UDP,
|
||||
0
|
||||
);
|
||||
|
||||
Instance->Configured = TRUE;
|
||||
}
|
||||
} else {
|
||||
//
|
||||
// UdpConfigData is NULL, reset the instance.
|
||||
//
|
||||
Instance->Configured = FALSE;
|
||||
Instance->IsNoMapping = FALSE;
|
||||
|
||||
//
|
||||
// Reset the Ip instance wrapped in the IpInfo.
|
||||
//
|
||||
IpIoConfigIp (Instance->IpInfo, NULL);
|
||||
|
||||
//
|
||||
// Cancel all the user tokens.
|
||||
//
|
||||
Status = Instance->Udp6Proto.Cancel (&Instance->Udp6Proto, NULL);
|
||||
|
||||
//
|
||||
// Remove the buffered RxData for this instance.
|
||||
//
|
||||
Udp6FlushRcvdDgram (Instance);
|
||||
|
||||
ASSERT (IsListEmpty (&Instance->DeliveredDgramQue));
|
||||
}
|
||||
|
||||
Status = Udp6SetVariableData (Instance->Udp6Service);
|
||||
|
||||
ON_EXIT:
|
||||
|
||||
gBS->RestoreTPL (OldTpl);
|
||||
|
||||
return Status;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
This function is used to enable and disable the multicast group filtering.
|
||||
|
||||
@param[in] This Pointer to the EFI_UDP6_PROTOCOL instance.
|
||||
@param[in] JoinFlag Set to TRUE to join a multicast group. Set to
|
||||
FALSE to leave one or all multicast groups.
|
||||
@param[in] MulticastAddress Pointer to multicast group address to join or
|
||||
leave. This parameter is optional and may be NULL.
|
||||
|
||||
@retval EFI_SUCCESS The operation completed successfully.
|
||||
@retval EFI_NOT_STARTED The EFI UDPv6 Protocol instance has not been
|
||||
started.
|
||||
@retval EFI_OUT_OF_RESOURCES Could not allocate resources to join the group.
|
||||
@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
|
||||
This is NULL.
|
||||
JoinFlag is TRUE and MulticastAddress is NULL.
|
||||
JoinFlag is TRUE and *MulticastAddress is not a
|
||||
valid multicast address.
|
||||
@retval EFI_ALREADY_STARTED The group address is already in the group table
|
||||
(when JoinFlag is TRUE).
|
||||
@retval EFI_NOT_FOUND The group address is not in the group table (when
|
||||
JoinFlag is FALSE).
|
||||
@retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
Udp6Groups (
|
||||
IN EFI_UDP6_PROTOCOL *This,
|
||||
IN BOOLEAN JoinFlag,
|
||||
IN EFI_IPv6_ADDRESS *MulticastAddress OPTIONAL
|
||||
)
|
||||
{
|
||||
EFI_STATUS Status;
|
||||
UDP6_INSTANCE_DATA *Instance;
|
||||
EFI_IP6_PROTOCOL *Ip;
|
||||
EFI_TPL OldTpl;
|
||||
EFI_IPv6_ADDRESS *McastIp;
|
||||
|
||||
if ((This == NULL) || (JoinFlag && (MulticastAddress == NULL))) {
|
||||
return EFI_INVALID_PARAMETER;
|
||||
}
|
||||
|
||||
McastIp = NULL;
|
||||
|
||||
if (JoinFlag) {
|
||||
if (!IP6_IS_MULTICAST (MulticastAddress)) {
|
||||
return EFI_INVALID_PARAMETER;
|
||||
}
|
||||
|
||||
McastIp = AllocateCopyPool (sizeof (EFI_IPv6_ADDRESS), MulticastAddress);
|
||||
if (McastIp == NULL) {
|
||||
return EFI_OUT_OF_RESOURCES;
|
||||
}
|
||||
}
|
||||
|
||||
Instance = UDP6_INSTANCE_DATA_FROM_THIS (This);
|
||||
if (!Instance->Configured) {
|
||||
return EFI_NOT_STARTED;
|
||||
}
|
||||
|
||||
Ip = Instance->IpInfo->Ip.Ip6;
|
||||
|
||||
OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
|
||||
|
||||
//
|
||||
// Invoke the Ip instance the Udp6 instance consumes to do the group operation.
|
||||
//
|
||||
Status = Ip->Groups (Ip, JoinFlag, MulticastAddress);
|
||||
|
||||
if (EFI_ERROR (Status)) {
|
||||
goto ON_EXIT;
|
||||
}
|
||||
|
||||
//
|
||||
// Keep a local copy of the configured multicast IPs because IpIo receives
|
||||
// datagrams from the 0 station address IP instance and then UDP delivers to
|
||||
// the matched instance. This copy of multicast IPs is used to avoid receive
|
||||
// the mutlicast datagrams destinated to multicast IPs the other instances configured.
|
||||
//
|
||||
if (JoinFlag) {
|
||||
|
||||
Status = NetMapInsertTail (&Instance->McastIps, (VOID *) McastIp, NULL);
|
||||
} else {
|
||||
|
||||
NetMapIterate (&Instance->McastIps, Udp6LeaveGroup, MulticastAddress);
|
||||
}
|
||||
|
||||
ON_EXIT:
|
||||
|
||||
gBS->RestoreTPL (OldTpl);
|
||||
|
||||
if (EFI_ERROR (Status)) {
|
||||
if (McastIp != NULL) {
|
||||
FreePool (McastIp);
|
||||
}
|
||||
}
|
||||
|
||||
return Status;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
This function places a sending request to this instance of the EFI UDPv6 Protocol,
|
||||
alongside the transmit data that was filled by the user.
|
||||
|
||||
@param[in] This Pointer to the EFI_UDP6_PROTOCOL instance.
|
||||
@param[in] Token Pointer to the completion token that will be
|
||||
placed into the transmit queue.
|
||||
|
||||
@retval EFI_SUCCESS The data was queued for transmission.
|
||||
@retval EFI_NOT_STARTED This EFI UDPv6 Protocol instance has not been
|
||||
started.
|
||||
@retval EFI_NO_MAPPING The under-layer IPv6 driver was responsible for
|
||||
choosing a source address for this instance, but
|
||||
no source address was available for use.
|
||||
@retval EFI_INVALID_PARAMETER One or more of the following are TRUE:
|
||||
This is NULL.
|
||||
Token is NULL. Token.Event is NULL.
|
||||
Token.Packet.TxData is NULL.
|
||||
Token.Packet.TxData.FragmentCount is zero.
|
||||
Token.Packet.TxData.DataLength is not equal to the
|
||||
sum of fragment lengths.
|
||||
One or more of the
|
||||
Token.Packet.TxData.FragmentTable[].FragmentLength
|
||||
fields is zero.
|
||||
One or more of the
|
||||
Token.Packet.TxData.FragmentTable[].FragmentBuffer
|
||||
fields is NULL. One or more of the
|
||||
Token.Packet.TxData.UdpSessionData.DestinationAddres
|
||||
are not valid unicast IPv6
|
||||
addresses if the UdpSessionData is not NULL.
|
||||
Token.Packet.TxData.UdpSessionData.
|
||||
DestinationAddress is NULL
|
||||
Token.Packet.TxData.UdpSessionData.
|
||||
DestinatioPort
|
||||
is zero.
|
||||
Token.Packet.TxData.UdpSessionData is NULL and this
|
||||
instance's UdpConfigData.RemoteAddress is unspecified.
|
||||
@retval EFI_ACCESS_DENIED The transmit completion token with the same
|
||||
Token.Event is already in the transmit queue.
|
||||
@retval EFI_NOT_READY The completion token could not be queued because
|
||||
the transmit queue is full.
|
||||
@retval EFI_OUT_OF_RESOURCES Could not queue the transmit data.
|
||||
@retval EFI_NOT_FOUND There is no route to the destination network or
|
||||
address.
|
||||
@retval EFI_BAD_BUFFER_SIZE The data length is greater than the maximum UDP
|
||||
packet size. Or, the length of the IP header + UDP
|
||||
header + data length is greater than MTU if
|
||||
DoNotFragment is TRUE.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
Udp6Transmit (
|
||||
IN EFI_UDP6_PROTOCOL *This,
|
||||
IN EFI_UDP6_COMPLETION_TOKEN *Token
|
||||
)
|
||||
{
|
||||
EFI_STATUS Status;
|
||||
UDP6_INSTANCE_DATA *Instance;
|
||||
EFI_TPL OldTpl;
|
||||
NET_BUF *Packet;
|
||||
EFI_UDP_HEADER *Udp6Header;
|
||||
EFI_UDP6_CONFIG_DATA *ConfigData;
|
||||
EFI_IPv6_ADDRESS Source;
|
||||
EFI_IPv6_ADDRESS Destination;
|
||||
EFI_UDP6_TRANSMIT_DATA *TxData;
|
||||
EFI_UDP6_SESSION_DATA *UdpSessionData;
|
||||
UDP6_SERVICE_DATA *Udp6Service;
|
||||
IP_IO_OVERRIDE Override;
|
||||
UINT16 HeadSum;
|
||||
EFI_IP_ADDRESS IpDestAddr;
|
||||
|
||||
if ((This == NULL) || (Token == NULL)) {
|
||||
return EFI_INVALID_PARAMETER;
|
||||
}
|
||||
|
||||
Instance = UDP6_INSTANCE_DATA_FROM_THIS (This);
|
||||
|
||||
if (!Instance->Configured) {
|
||||
return EFI_NOT_STARTED;
|
||||
}
|
||||
|
||||
OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
|
||||
|
||||
//
|
||||
// Validate the Token, if the token is invalid return the error code.
|
||||
//
|
||||
Status = Udp6ValidateTxToken (Instance, Token);
|
||||
if (EFI_ERROR (Status)) {
|
||||
goto ON_EXIT;
|
||||
}
|
||||
|
||||
if (EFI_ERROR (NetMapIterate (&Instance->TxTokens, Udp6TokenExist, Token)) ||
|
||||
EFI_ERROR (NetMapIterate (&Instance->RxTokens, Udp6TokenExist, Token))
|
||||
){
|
||||
//
|
||||
// Try to find a duplicate token in the two token maps, if found, return
|
||||
// EFI_ACCESS_DENIED.
|
||||
//
|
||||
Status = EFI_ACCESS_DENIED;
|
||||
goto ON_EXIT;
|
||||
}
|
||||
|
||||
TxData = Token->Packet.TxData;
|
||||
|
||||
//
|
||||
// Create a net buffer to hold the user buffer and the udp header.
|
||||
//
|
||||
Packet = NetbufFromExt (
|
||||
(NET_FRAGMENT *) TxData->FragmentTable,
|
||||
TxData->FragmentCount,
|
||||
UDP6_HEADER_SIZE,
|
||||
0,
|
||||
Udp6NetVectorExtFree,
|
||||
NULL
|
||||
);
|
||||
if (Packet == NULL) {
|
||||
Status = EFI_OUT_OF_RESOURCES;
|
||||
goto ON_EXIT;
|
||||
}
|
||||
|
||||
//
|
||||
// Store the IpIo in ProtoData.
|
||||
//
|
||||
Udp6Service = Instance->Udp6Service;
|
||||
*((UINTN *) &Packet->ProtoData[0]) = (UINTN) (Udp6Service->IpIo);
|
||||
|
||||
Udp6Header = (EFI_UDP_HEADER *) NetbufAllocSpace (Packet, UDP6_HEADER_SIZE, TRUE);
|
||||
ASSERT (Udp6Header != NULL);
|
||||
ConfigData = &Instance->ConfigData;
|
||||
|
||||
//
|
||||
// Fill the udp header.
|
||||
//
|
||||
Udp6Header->SrcPort = HTONS (ConfigData->StationPort);
|
||||
Udp6Header->DstPort = HTONS (ConfigData->RemotePort);
|
||||
Udp6Header->Length = HTONS ((UINT16) Packet->TotalSize);
|
||||
Udp6Header->Checksum = 0;
|
||||
//
|
||||
// Set the UDP Header in NET_BUF, this UDP header is for IP6 can fast get the
|
||||
// Udp header for pseudoHeadCheckSum.
|
||||
//
|
||||
Packet->Udp = Udp6Header;
|
||||
UdpSessionData = TxData->UdpSessionData;
|
||||
|
||||
if (UdpSessionData != NULL) {
|
||||
//
|
||||
// Set the Destination according to the specified
|
||||
// UdpSessionData.
|
||||
//
|
||||
|
||||
if (UdpSessionData->DestinationPort != 0) {
|
||||
Udp6Header->DstPort = HTONS (UdpSessionData->DestinationPort);
|
||||
}
|
||||
|
||||
IP6_COPY_ADDRESS (&Source, &ConfigData->StationAddress);
|
||||
if (!NetIp6IsUnspecifiedAddr (&UdpSessionData->DestinationAddress)) {
|
||||
IP6_COPY_ADDRESS (&Destination, &UdpSessionData->DestinationAddress);
|
||||
} else {
|
||||
IP6_COPY_ADDRESS (&Destination, &ConfigData->RemoteAddress);
|
||||
}
|
||||
|
||||
//
|
||||
//Calculate the pseudo head checksum using the overridden parameters.
|
||||
//
|
||||
if (!NetIp6IsUnspecifiedAddr (&ConfigData->StationAddress)) {
|
||||
HeadSum = NetIp6PseudoHeadChecksum (
|
||||
&Source,
|
||||
&Destination,
|
||||
EFI_IP_PROTO_UDP,
|
||||
0
|
||||
);
|
||||
|
||||
//
|
||||
// calculate the checksum.
|
||||
//
|
||||
Udp6Header->Checksum = Udp6Checksum (Packet, HeadSum);
|
||||
if (Udp6Header->Checksum == 0) {
|
||||
//
|
||||
// If the calculated checksum is 0, fill the Checksum field with all ones.
|
||||
//
|
||||
Udp6Header->Checksum = 0XFFFF;
|
||||
}
|
||||
} else {
|
||||
//
|
||||
// Set the checksum is zero if the ConfigData->StationAddress is unspcified
|
||||
// and the Ipv6 will fill the correct value of this checksum.
|
||||
//
|
||||
Udp6Header->Checksum = 0;
|
||||
|
||||
}
|
||||
} else {
|
||||
//
|
||||
// UdpSessionData is NULL, use the address and port information previously configured.
|
||||
//
|
||||
IP6_COPY_ADDRESS (&Destination, &ConfigData->RemoteAddress);
|
||||
|
||||
HeadSum = Instance->HeadSum;
|
||||
//
|
||||
// calculate the checksum.
|
||||
//
|
||||
Udp6Header->Checksum = Udp6Checksum (Packet, HeadSum);
|
||||
if (Udp6Header->Checksum == 0) {
|
||||
//
|
||||
// If the calculated checksum is 0, fill the Checksum field with all ones.
|
||||
//
|
||||
Udp6Header->Checksum = 0xffff;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
//
|
||||
// Fill the IpIo Override data.
|
||||
//
|
||||
Override.Ip6OverrideData.Protocol = EFI_IP_PROTO_UDP;
|
||||
Override.Ip6OverrideData.HopLimit = ConfigData->HopLimit;
|
||||
Override.Ip6OverrideData.FlowLabel = 0;
|
||||
|
||||
//
|
||||
// Save the token into the TxToken map.
|
||||
//
|
||||
Status = NetMapInsertTail (&Instance->TxTokens, Token, Packet);
|
||||
if (EFI_ERROR (Status)) {
|
||||
goto FREE_PACKET;
|
||||
}
|
||||
|
||||
//
|
||||
// Send out this datagram through IpIo.
|
||||
//
|
||||
if (UdpSessionData != NULL){
|
||||
IP6_COPY_ADDRESS (&(IpDestAddr.v6), &Destination);
|
||||
} else {
|
||||
ZeroMem (&IpDestAddr.v6, sizeof (EFI_IPv6_ADDRESS));
|
||||
}
|
||||
|
||||
Status = IpIoSend (
|
||||
Udp6Service->IpIo,
|
||||
Packet,
|
||||
Instance->IpInfo,
|
||||
Instance,
|
||||
Token,
|
||||
&IpDestAddr,
|
||||
&Override
|
||||
);
|
||||
if (EFI_ERROR (Status)) {
|
||||
//
|
||||
// Remove this token from the TxTokens.
|
||||
//
|
||||
Udp6RemoveToken (&Instance->TxTokens, Token);
|
||||
}
|
||||
|
||||
FREE_PACKET:
|
||||
|
||||
NetbufFree (Packet);
|
||||
|
||||
ON_EXIT:
|
||||
|
||||
gBS->RestoreTPL (OldTpl);
|
||||
|
||||
return Status;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
This function places a completion token into the receive packet queue. This function
|
||||
is always asynchronous.
|
||||
|
||||
@param[in] This Pointer to the EFI_UDP6_PROTOCOL instance.
|
||||
@param[in] Token Pointer to a token that is associated with the
|
||||
receive data descriptor.
|
||||
|
||||
@retval EFI_SUCCESS The receive completion token was cached.
|
||||
@retval EFI_NOT_STARTED This EFI UDPv6 Protocol instance has not been
|
||||
started.
|
||||
@retval EFI_NO_MAPPING When using a default address, configuration (DHCP,
|
||||
BOOTP, RARP, etc.) is not finished yet.
|
||||
@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
|
||||
This is NULL. Token is NULL. Token.Event is NULL.
|
||||
@retval EFI_OUT_OF_RESOURCES The receive completion token could not be queued
|
||||
due to a lack of system resources (usually
|
||||
memory).
|
||||
@retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
|
||||
The EFI UDPv6 Protocol instance has been reset to
|
||||
startup defaults.
|
||||
@retval EFI_ACCESS_DENIED A receive completion token with the same
|
||||
Token.Event is already in the receive queue.
|
||||
@retval EFI_NOT_READY The receive request could not be queued because
|
||||
the receive queue is full.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
Udp6Receive (
|
||||
IN EFI_UDP6_PROTOCOL *This,
|
||||
IN EFI_UDP6_COMPLETION_TOKEN *Token
|
||||
)
|
||||
{
|
||||
EFI_STATUS Status;
|
||||
UDP6_INSTANCE_DATA *Instance;
|
||||
EFI_TPL OldTpl;
|
||||
|
||||
if ((This == NULL) || (Token == NULL) || (Token->Event == NULL)) {
|
||||
return EFI_INVALID_PARAMETER;
|
||||
}
|
||||
|
||||
Instance = UDP6_INSTANCE_DATA_FROM_THIS (This);
|
||||
|
||||
if (!Instance->Configured) {
|
||||
return EFI_NOT_STARTED;
|
||||
}
|
||||
|
||||
OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
|
||||
|
||||
if (EFI_ERROR (NetMapIterate (&Instance->RxTokens, Udp6TokenExist, Token)) ||
|
||||
EFI_ERROR (NetMapIterate (&Instance->TxTokens, Udp6TokenExist, Token))
|
||||
){
|
||||
//
|
||||
// Return EFI_ACCESS_DENIED if the specified token is already in the TxTokens or
|
||||
// RxTokens map.
|
||||
//
|
||||
Status = EFI_ACCESS_DENIED;
|
||||
goto ON_EXIT;
|
||||
}
|
||||
|
||||
Token->Packet.RxData = NULL;
|
||||
|
||||
//
|
||||
// Save the token into the RxTokens map.
|
||||
//
|
||||
Status = NetMapInsertTail (&Instance->RxTokens, Token, NULL);
|
||||
if (EFI_ERROR (Status)) {
|
||||
Status = EFI_NOT_READY;
|
||||
goto ON_EXIT;
|
||||
}
|
||||
|
||||
//
|
||||
// If there is an icmp error, report it.
|
||||
//
|
||||
Udp6ReportIcmpError (Instance);
|
||||
|
||||
//
|
||||
// Try to delivered the received datagrams.
|
||||
//
|
||||
Udp6InstanceDeliverDgram (Instance);
|
||||
|
||||
//
|
||||
// Dispatch the DPC queued by the NotifyFunction of Token->Event.
|
||||
//
|
||||
DispatchDpc ();
|
||||
|
||||
ON_EXIT:
|
||||
|
||||
gBS->RestoreTPL (OldTpl);
|
||||
|
||||
return Status;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
This function is used to abort a pending transmit or receive request.
|
||||
|
||||
@param[in] This Pointer to the EFI_UDP6_PROTOCOL instance.
|
||||
@param[in] Token Pointer to a token that has been issued by
|
||||
EFI_UDP6_PROTOCOL.Transmit() or
|
||||
EFI_UDP6_PROTOCOL.Receive(). This parameter is
|
||||
optional and may be NULL.
|
||||
|
||||
@retval EFI_SUCCESS The asynchronous I/O request was aborted, and
|
||||
Token.Event was signaled. When Token is NULL, all
|
||||
pending requests are aborted and their events are
|
||||
signaled.
|
||||
@retval EFI_INVALID_PARAMETER This is NULL.
|
||||
@retval EFI_NOT_STARTED This instance has not been started.
|
||||
@retval EFI_NO_MAPPING When using the default address, configuration
|
||||
(DHCP, BOOTP, RARP, etc.) is not finished yet.
|
||||
@retval EFI_NOT_FOUND When Token is not NULL, the asynchronous I/O
|
||||
request is not found in the transmit or receive
|
||||
queue. It is either completed or not issued by
|
||||
Transmit() or Receive().
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
Udp6Cancel (
|
||||
IN EFI_UDP6_PROTOCOL *This,
|
||||
IN EFI_UDP6_COMPLETION_TOKEN *Token OPTIONAL
|
||||
)
|
||||
{
|
||||
EFI_STATUS Status;
|
||||
UDP6_INSTANCE_DATA *Instance;
|
||||
EFI_TPL OldTpl;
|
||||
|
||||
if (This == NULL) {
|
||||
return EFI_INVALID_PARAMETER;
|
||||
}
|
||||
|
||||
Instance = UDP6_INSTANCE_DATA_FROM_THIS (This);
|
||||
|
||||
if (!Instance->Configured) {
|
||||
return EFI_NOT_STARTED;
|
||||
}
|
||||
|
||||
OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
|
||||
|
||||
//
|
||||
// Cancle the tokens specified by Token for this instance.
|
||||
//
|
||||
Status = Udp6InstanceCancelToken (Instance, Token);
|
||||
|
||||
//
|
||||
// Dispatch the DPC queued by the NotifyFunction of the canceled token's events.
|
||||
//
|
||||
DispatchDpc ();
|
||||
|
||||
gBS->RestoreTPL (OldTpl);
|
||||
|
||||
return Status;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
This function can be used by network drivers and applications to increase the rate that
|
||||
data packets are moved between the communications device and the transmit/receive queues.
|
||||
|
||||
@param[in] This Pointer to the EFI_UDP6_PROTOCOL instance.
|
||||
|
||||
@retval EFI_SUCCESS Incoming or outgoing data was processed.
|
||||
@retval EFI_INVALID_PARAMETER This is NULL.
|
||||
@retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
|
||||
@retval EFI_TIMEOUT Data was dropped out of the transmit and/or
|
||||
receive queue.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
Udp6Poll (
|
||||
IN EFI_UDP6_PROTOCOL *This
|
||||
)
|
||||
{
|
||||
UDP6_INSTANCE_DATA *Instance;
|
||||
EFI_IP6_PROTOCOL *Ip;
|
||||
|
||||
if (This == NULL) {
|
||||
return EFI_INVALID_PARAMETER;
|
||||
}
|
||||
|
||||
Instance = UDP6_INSTANCE_DATA_FROM_THIS (This);
|
||||
Ip = Instance->IpInfo->Ip.Ip6;
|
||||
|
||||
//
|
||||
// Invode the Ip instance consumed by the udp instance to do the poll operation.
|
||||
//
|
||||
return Ip->Poll (Ip);
|
||||
}
|
||||
Reference in New Issue
Block a user