Ip4Config.c revision 4fd606d1f5abe38e1f42c38de1d2e895166bd0f4
/** @file
This code implements the IP4Config and NicIp4Config protocols.
Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at<BR>
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 "Ip4Config.h"
#include "NicIp4Variable.h"
//
// Ip4 Config Protocol
//
};
/**
Get the NIC's configure information from the IP4 configure variable.
It will remove the invalid variable.
@param Instance The IP4 CONFIG instance.
@return NULL if no configure for the NIC in the variable, or it is invalid.
Otherwise the pointer to the NIC's IP configure parameter will be returned.
**/
)
{
//
// Read the configuration parameter for this NIC from
// the EFI variable
//
return NULL;
}
//
// Validate the configuration, if the configuration is invalid,
// remove it from the variable.
//
if (!Ip4ConfigIsValid (NicConfig)) {
}
return NicConfig;
}
/**
Set the IP configure parameters for this NIC.
If Reconfig is TRUE, the IP driver will be informed to discard current
auto configure parameter and restart the auto configuration process.
If current there is a pending auto configuration, EFI_ALREADY_STARTED is
returned. You can only change the configure setting when either
the configure has finished or not started yet. If NicConfig, the
NIC's configure parameter is removed from the variable.
@param Instance The IP4 CONFIG instance.
@param NicConfig The new NIC IP4 configure parameter.
@param Reconfig Inform the IP4 driver to restart the auto
configuration.
@retval EFI_SUCCESS The configure parameter for this NIC was
set successfully.
@retval EFI_INVALID_PARAMETER This is NULL or the configure parameter is
invalid.
@retval EFI_ALREADY_STARTED There is a pending auto configuration.
@retval EFI_NOT_FOUND No auto configure parameter is found.
**/
)
{
//
// Validate the parameters
//
return EFI_INVALID_PARAMETER;
}
return EFI_INVALID_PARAMETER;
}
return EFI_ALREADY_STARTED;
}
//
// Update the parameter in the configure variable
//
return Status;
}
//
// Signal the IP4 to run the auto configuration again
//
DispatchDpc ();
}
return Status;
}
//
// A dedicated timer is used to poll underlying media status.In case of
// cable swap, a new round auto configuration will be initiated. The timer
// starts in DHCP policy only. STATIC policy stops the timer.
//
}
return Status;
}
/**
Callback function when DHCP process finished. It will save the
retrieved IP configure parameter from DHCP to the NVRam.
@param Event The callback event
@param Context Opaque context to the callback
@return None
**/
)
{
//
// Get the DHCP retrieved parameters
//
goto ON_EXIT;
}
//
// Save the new configuration retrieved by DHCP both in
// the instance and to NVRam. So, both the IP4 driver and
// other user can get that address.
//
}
Instance->NicConfig = AllocatePool (sizeof (NIC_IP4_CONFIG_INFO) + 2* sizeof (EFI_IP4_ROUTE_TABLE));
goto ON_EXIT;
}
//
// Create a route for the connected network
//
//
// Create a route if there is a default router.
//
CopyMem (&Ip4Config->RouteTable[1].GatewayAddress, &Dhcp4Mode.RouterAddress, sizeof (EFI_IPv4_ADDRESS));
}
//
// ignore the return status of EfiNicIp4ConfigSetInfo. Network
// stack can operate even that failed.
//
}
DispatchDpc ();
return ;
}
/**
Starts running the configuration policy for the EFI IPv4 Protocol driver.
The Start() function is called to determine and to begin the platform
configuration policy by the EFI IPv4 Protocol driver. This determination may
be as simple as returning EFI_UNSUPPORTED if there is no EFI IPv4 Protocol
driver configuration policy. It may be as involved as loading some defaults
from nonvolatile storage, downloading dynamic data from a DHCP server, and
checking permissions with a site policy server.
Starting the configuration policy is just the beginning. It may finish almost
instantly or it may take several minutes before it fails to retrieve configuration
information from one or more servers. Once the policy is started, drivers
should use the DoneEvent parameter to determine when the configuration policy
has completed. EFI_IP4_CONFIG_PROTOCOL.GetData() must then be called to
determine if the configuration succeeded or failed.
Until the configuration completes successfully, EFI IPv4 Protocol driver instances
that are attempting to use default configurations must return EFI_NO_MAPPING.
Once the configuration is complete, the EFI IPv4 Configuration Protocol driver
signals DoneEvent. The configuration may need to be updated in the future,
however; in this case, the EFI IPv4 Configuration Protocol driver must signal
ReconfigEvent, and all EFI IPv4 Protocol driver instances that are using default
configurations must return EFI_NO_MAPPING until the configuration policy has
been rerun.
@param This Pointer to the EFI_IP4_CONFIG_PROTOCOL instance.
@param DoneEvent Event that will be signaled when the EFI IPv4
Protocol driver configuration policy completes
execution. This event must be of type EVT_NOTIFY_SIGNAL.
@param ReconfigEvent Event that will be signaled when the EFI IPv4
Protocol driver configuration needs to be updated.
This event must be of type EVT_NOTIFY_SIGNAL.
@retval EFI_SUCCESS The configuration policy for the EFI IPv4 Protocol
driver is now running.
@retval EFI_INVALID_PARAMETER One or more of the following parameters is NULL:
This
DoneEvent
ReconfigEvent
@retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.
@retval EFI_ALREADY_STARTED The configuration policy for the EFI IPv4 Protocol
driver was already started.
@retval EFI_DEVICE_ERROR An unexpected system error or network error occurred.
@retval EFI_UNSUPPORTED This interface does not support the EFI IPv4 Protocol
driver configuration.
**/
)
{
return EFI_INVALID_PARAMETER;
}
goto ON_EXIT;
}
} else {
}
//
// If the source is static, the auto configuration is done.
// return now.
//
if (Source == IP4_CONFIG_SOURCE_STATIC) {
goto ON_EXIT;
}
//
// Start the dhcp process
//
);
goto ON_ERROR;
}
);
goto ON_ERROR;
}
//
// Check the current DHCP status, if the DHCP process has
// already finished, return now.
//
goto ON_ERROR;
}
goto ON_EXIT;
}
//
// Try to start the DHCP process. Use most of the current
// DHCP configuration to avoid problems if some DHCP client
// yields the control of this DHCP service to us.
//
goto ON_ERROR;
}
//
// Start the DHCP process
//
);
goto ON_ERROR;
}
goto ON_ERROR;
}
}
DispatchDpc ();
return Status;
}
/**
Stops running the configuration policy for the EFI IPv4 Protocol driver.
The Stop() function stops the configuration policy for the EFI IPv4 Protocol driver.
All configuration data will be lost after calling Stop().
@param This Pointer to the EFI_IP4_CONFIG_PROTOCOL instance.
@retval EFI_SUCCESS The configuration policy for the EFI IPv4 Protocol
driver has been stopped.
@retval EFI_INVALID_PARAMETER This is NULL.
@retval EFI_NOT_STARTED The configuration policy for the EFI IPv4 Protocol
driver was not started.
**/
)
{
return EFI_INVALID_PARAMETER;
}
goto ON_EXIT;
}
//
// Release all the configure parameters. Don't signal the user
// event. The user wants to abort the configuration, this isn't
// the configuration done or reconfiguration.
//
return Status;
}
/**
Returns the default configuration data (if any) for the EFI IPv4 Protocol driver.
The GetData() function returns the current configuration data for the EFI IPv4
Protocol driver after the configuration policy has completed.
@param This Pointer to the EFI_IP4_CONFIG_PROTOCOL instance.
@param ConfigDataSize On input, the size of the ConfigData buffer.
On output, the count of bytes that were written
into the ConfigData buffer.
@param ConfigData Pointer to the EFI IPv4 Configuration Protocol
driver configuration data structure.
Type EFI_IP4_IPCONFIG_DATA is defined in
"Related Definitions" below.
@retval EFI_SUCCESS The EFI IPv4 Protocol driver configuration has been returned.
@retval EFI_INVALID_PARAMETER This is NULL.
@retval EFI_NOT_STARTED The configuration policy for the EFI IPv4 Protocol
driver is not running.
@retval EFI_NOT_READY EFI IPv4 Protocol driver configuration is still running.
@retval EFI_ABORTED EFI IPv4 Protocol driver configuration could not complete.
Currently not implemented.
@retval EFI_BUFFER_TOO_SMALL *ConfigDataSize is smaller than the configuration
data buffer or ConfigData is NULL.
**/
)
{
return EFI_INVALID_PARAMETER;
}
}
goto ON_EXIT;
}
//
// Copy the configure data if auto configuration succeeds.
//
if (Status == EFI_SUCCESS) {
} else {
}
*ConfigDataSize = Len;
}
return Status;
}
/**
Release all the DHCP related resources.
@param This The IP4 configure instance
@return None
**/
)
{
gBS->CloseProtocol (
);
}
);
}
}
}
/**
Clean up all the configuration parameters.
@param Instance The IP4 configure instance
@return None
**/
)
{
}
}
/**
A dedicated timer is used to poll underlying media status. In case of
cable swap, a new round auto configuration will be initiated. The timer
will signal the IP4 to run the auto configuration again. IP4 driver will free
old IP address related resource, such as route table and Interface, then
initiate a DHCP process by IP4Config->Start to acquire new IP, eventually
create route table for new IP address.
@param[in] Event The IP4 service instance's heart beat timer.
@param[in] Context The IP4 service instance.
**/
)
{
//
// Get fresh mode data from MNP, since underlying media status may change
//
return;
}
//
// Media transimit Unpresent to Present means new link movement is detected.
//
//
// Signal the IP4 to run the auto configuration again. IP4 driver will free
// old IP address related resource, such as route table and Interface, then
// initiate a DHCP round by IP4Config->Start to acquire new IP, eventually
// create route table for new IP address.
//
DispatchDpc ();
}
}
}