Ip4Config.h revision 4fd606d1f5abe38e1f42c38de1d2e895166bd0f4
2N/A Header file for IP4Config driver. 2N/ACopyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR> 2N/AThis program and the accompanying materials 2N/Aare licensed and made available under the terms and conditions of the BSD License 2N/Awhich accompanies this distribution. The full text of the license may be found at<BR> 2N/ATHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, 2N/AWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. 2N/A// Configure the DHCP to request the routers and netmask 2N/A// from server. The DHCP_TAG_NETMASK is included in Head. 2N/A // NicConfig's state, such as IP4_CONFIG_STATE_IDLE 2N/A // Mnp child to keep the connection with MNP. 2N/A // User's requests data // Identity of this interface and some configuration info. // DHCP handles to access DHCP // A dedicated timer is used to poll underlying media status // Underlying media present status. 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 @retval EFI_SUCCESS The configure parameter for this NIC was @retval EFI_INVALID_PARAMETER This is NULL or the configure parameter is @retval EFI_ALREADY_STARTED There is a pending auto configuration. @retval EFI_NOT_FOUND No auto configure parameter is found. 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. Release all the DHCP related resources. @param This The IP4 configure instance Clean up all the configuration parameters. @param Instance The IP4 configure instance // 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 This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or EFI_COMPONENT_NAME_PROTOCOL instance. @param Language[in] 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 3066 or ISO 639-2 language code format. @param DriverName[out] A pointer to the Unicode string to return. This Unicode string is the name of the driver specified by This in the language @retval EFI_SUCCESS The Unicode string for the Driver specified by This and the language specified by Language was @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. 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 This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or EFI_COMPONENT_NAME_PROTOCOL instance. @param ControllerHandle[in] The handle of a controller that the driver specified by This is managing. This handle specifies the controller whose name is to be @param ChildHandle[in] 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 @param Language[in] 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 3066 or ISO 639-2 language code format. @param ControllerName[out] 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 @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 @retval EFI_INVALID_PARAMETER ControllerHandle is NULL. @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid @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. Test to see if this driver supports ControllerHandle. @param This Protocol instance pointer. @param ControllerHandle Handle of device to test @param RemainingDevicePath Optional parameter use to pick a specific child @retval EFI_SUCCES This driver supports this device @retval EFI_ALREADY_STARTED This driver is already running on this device @retval other This driver does not support this device Start this driver on ControllerHandle. @param This Protocol instance pointer. @param ControllerHandle Handle of device to bind driver to @param RemainingDevicePath Optional parameter use to pick a specific child @retval EFI_SUCCES This driver is added to ControllerHandle @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle @retval other This driver does not support this device Stop this driver on ControllerHandle. @param This Protocol instance pointer. @param ControllerHandle Handle of device to stop driver on @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of children is zero stop the entire bus driver. @param ChildHandleBuffer List of Child Handles to Stop. @retval EFI_SUCCES This driver is removed ControllerHandle @retval other This driver was not removed from this device 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 @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 @retval EFI_INVALID_PARAMETER One or more of the following parameters is NULL: @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 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 @retval EFI_INVALID_PARAMETER This is NULL. @retval EFI_NOT_STARTED The configuration policy for the EFI IPv4 Protocol 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 @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. 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 round 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.