\r
#include "Ip4Impl.h"\r
\r
+/**\r
+ Gets the current operational settings for this instance of the EFI IPv4 Protocol driver.\r
+ \r
+ The GetModeData() function returns the current operational mode data for this\r
+ driver instance. The data fields in EFI_IP4_MODE_DATA are read only. This\r
+ function is used optionally to retrieve the operational mode data of underlying\r
+ networks or drivers.\r
+\r
+ @param This Pointer to the EFI_IP4_PROTOCOL instance.\r
+ @param Ip4ModeData Pointer to the EFI IPv4 Protocol mode data structure.\r
+ @param MnpConfigData Pointer to the managed network configuration data structure.\r
+ @param SnpModeData Pointer to the simple network mode data structure.\r
+\r
+ @retval EFI_SUCCESS The operation completed successfully.\r
+ @retval EFI_INVALID_PARAMETER This is NULL.\r
+ @retval EFI_OUT_OF_RESOURCES The required mode data could not be allocated.\r
\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+EfiIp4GetModeData (\r
+ IN CONST EFI_IP4_PROTOCOL *This,\r
+ OUT EFI_IP4_MODE_DATA *Ip4ModeData, OPTIONAL\r
+ OUT EFI_MANAGED_NETWORK_CONFIG_DATA *MnpConfigData, OPTIONAL\r
+ OUT EFI_SIMPLE_NETWORK_MODE *SnpModeData OPTIONAL\r
+ );\r
+ \r
/**\r
- Get the IP child's current operational data. This can\r
- all be used to get the underlying MNP and SNP data.\r
+ Assigns an IPv4 address and subnet mask to this EFI IPv4 Protocol driver instance.\r
+ \r
+ The Configure() function is used to set, change, or reset the operational\r
+ parameters and filter settings for this EFI IPv4 Protocol instance. Until these\r
+ parameters have been set, no network traffic can be sent or received by this\r
+ instance. Once the parameters have been reset (by calling this function with\r
+ IpConfigData set to NULL), no more traffic can be sent or received until these\r
+ parameters have been set again. Each EFI IPv4 Protocol instance can be started\r
+ and stopped independently of each other by enabling or disabling their receive\r
+ filter settings with the Configure() function.\r
+ \r
+ When IpConfigData.UseDefaultAddress is set to FALSE, the new station address will\r
+ be appended as an alias address into the addresses list in the EFI IPv4 Protocol\r
+ driver. While set to TRUE, Configure() will trigger the EFI_IP4_CONFIG_PROTOCOL\r
+ to retrieve the default IPv4 address if it is not available yet. Clients could\r
+ frequently call GetModeData() to check the status to ensure that the default IPv4\r
+ address is ready.\r
+ \r
+ If operational parameters are reset or changed, any pending transmit and receive\r
+ requests will be cancelled. Their completion token status will be set to EFI_ABORTED\r
+ and their events will be signaled.\r
+\r
+ @param This Pointer to the EFI_IP4_PROTOCOL instance.\r
+ @param IpConfigData Pointer to the EFI IPv4 Protocol configuration data structure.\r
+\r
+ @retval EFI_SUCCESS The driver instance was successfully opened.\r
+ @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r
+ RARP, etc.) is not finished yet.\r
+ @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
+ @retval EFI_UNSUPPORTED One or more of the following conditions is TRUE:\r
+ A configuration protocol (DHCP, BOOTP, RARP, etc.) could\r
+ not be located when clients choose to use the default IPv4\r
+ address. This EFI IPv4 Protocol implementation does not\r
+ support this requested filter or timeout setting.\r
+ @retval EFI_OUT_OF_RESOURCES The EFI IPv4 Protocol driver instance data could not be allocated.\r
+ @retval EFI_ALREADY_STARTED The interface is already open and must be stopped before the\r
+ IPv4 address or subnet mask can be changed. The interface must\r
+ also be stopped when switching to/from raw packet mode.\r
+ @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. The EFI IPv4\r
+ Protocol driver instance is not opened.\r
\r
- @param This The IP4 protocol instance\r
- @param Ip4ModeData The IP4 operation data\r
- @param MnpConfigData The MNP configure data\r
- @param SnpModeData The SNP operation data\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+EfiIp4Configure (\r
+ IN EFI_IP4_PROTOCOL *This,\r
+ IN EFI_IP4_CONFIG_DATA *IpConfigData OPTIONAL\r
+ );\r
+ \r
+/**\r
+ Joins and leaves multicast groups.\r
+ \r
+ The Groups() function is used to join and leave multicast group sessions. Joining\r
+ a group will enable reception of matching multicast packets. Leaving a group will\r
+ disable the multicast packet reception.\r
+ \r
+ If JoinFlag is FALSE and GroupAddress is NULL, all joined groups will be left.\r
+\r
+ @param This Pointer to the EFI_IP4_PROTOCOL instance.\r
+ @param JoinFlag Set to TRUE to join the multicast group session and FALSE to leave.\r
+ @param GroupAddress Pointer to the IPv4 multicast address.\r
+\r
+ @retval EFI_SUCCESS The operation completed successfully.\r
+ @retval EFI_INVALID_PARAMETER One or more of the following is TRUE:\r
+ - This is NULL.\r
+ - JoinFlag is TRUE and GroupAddress is NULL.\r
+ - GroupAddress is not NULL and *GroupAddress is\r
+ not a multicast IPv4 address.\r
+ @retval EFI_NOT_STARTED This instance has not been started.\r
+ @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r
+ RARP, etc.) is not finished yet.\r
+ @retval EFI_OUT_OF_RESOURCES System resources could not be allocated.\r
+ @retval EFI_UNSUPPORTED This EFI IPv4 Protocol implementation does not support multicast groups.\r
+ @retval EFI_ALREADY_STARTED The group address is already in the group table (when\r
+ JoinFlag is TRUE).\r
+ @retval EFI_NOT_FOUND The group address is not in the group table (when JoinFlag is FALSE).\r
+ @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r
\r
- @retval EFI_INVALID_PARAMETER The parameter is invalid because This == NULL\r
- @retval EFI_SUCCESS The operational parameter is returned.\r
- @retval Others Failed to retrieve the IP4 route table.\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+EfiIp4Groups (\r
+ IN EFI_IP4_PROTOCOL *This,\r
+ IN BOOLEAN JoinFlag,\r
+ IN EFI_IPv4_ADDRESS *GroupAddress OPTIONAL\r
+ );\r
+ \r
+/**\r
+ Adds and deletes routing table entries.\r
+\r
+ The Routes() function adds a route to or deletes a route from the routing table.\r
+ \r
+ Routes are determined by comparing the SubnetAddress with the destination IPv4\r
+ address arithmetically AND-ed with the SubnetMask. The gateway address must be\r
+ on the same subnet as the configured station address.\r
+ \r
+ The default route is added with SubnetAddress and SubnetMask both set to 0.0.0.0.\r
+ The default route matches all destination IPv4 addresses that do not match any\r
+ other routes.\r
+ \r
+ A GatewayAddress that is zero is a nonroute. Packets are sent to the destination\r
+ IP address if it can be found in the ARP cache or on the local subnet. One automatic\r
+ nonroute entry will be inserted into the routing table for outgoing packets that\r
+ are addressed to a local subnet (gateway address of 0.0.0.0).\r
+ \r
+ Each EFI IPv4 Protocol instance has its own independent routing table. Those EFI\r
+ IPv4 Protocol instances that use the default IPv4 address will also have copies\r
+ of the routing table that was provided by the EFI_IP4_CONFIG_PROTOCOL, and these\r
+ copies will be updated whenever the EIF IPv4 Protocol driver reconfigures its\r
+ instances. As a result, client modification to the routing table will be lost.\r
+\r
+ @param This Pointer to the EFI_IP4_PROTOCOL instance.\r
+ @param DeleteRoute Set to TRUE to delete this route from the routing table. Set to\r
+ FALSE to add this route to the routing table. SubnetAddress\r
+ and SubnetMask are used as the key to each route entry.\r
+ @param SubnetAddress The address of the subnet that needs to be routed.\r
+ @param SubnetMask The subnet mask of SubnetAddress.\r
+ @param GatewayAddress The unicast gateway IPv4 address for this route.\r
+\r
+ @retval EFI_SUCCESS The operation completed successfully.\r
+ @retval EFI_NOT_STARTED The driver instance has not been started.\r
+ @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r
+ RARP, etc.) is not finished yet.\r
+ @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
+ - This is NULL.\r
+ - SubnetAddress is NULL.\r
+ - SubnetMask is NULL.\r
+ - GatewayAddress is NULL.\r
+ - *SubnetAddress is not a valid subnet address.\r
+ - *SubnetMask is not a valid subnet mask.\r
+ - *GatewayAddress is not a valid unicast IPv4 address.\r
+ @retval EFI_OUT_OF_RESOURCES Could not add the entry to the routing table.\r
+ @retval EFI_NOT_FOUND This route is not in the routing table (when DeleteRoute is TRUE).\r
+ @retval EFI_ACCESS_DENIED The route is already defined in the routing table (when\r
+ DeleteRoute is FALSE).\r
+ \r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+EfiIp4Routes (\r
+ IN EFI_IP4_PROTOCOL *This,\r
+ IN BOOLEAN DeleteRoute,\r
+ IN EFI_IPv4_ADDRESS *SubnetAddress,\r
+ IN EFI_IPv4_ADDRESS *SubnetMask,\r
+ IN EFI_IPv4_ADDRESS *GatewayAddress\r
+ );\r
+ \r
+/**\r
+ Places outgoing data packets into the transmit queue.\r
+\r
+ The Transmit() function places a sending request in the transmit queue of this\r
+ EFI IPv4 Protocol instance. Whenever the packet in the token is sent out or some\r
+ errors occur, the event in the token will be signaled and the status is updated.\r
+\r
+ @param This Pointer to the EFI_IP4_PROTOCOL instance.\r
+ @param Token Pointer to the transmit token.\r
+\r
+ @retval EFI_SUCCESS The data has been queued for transmission.\r
+ @retval EFI_NOT_STARTED This instance has not been started.\r
+ @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r
+ RARP, etc.) is not finished yet.\r
+ @retval EFI_INVALID_PARAMETER One or more pameters are invalid.\r
+ @retval EFI_ACCESS_DENIED The transmit completion token with the same Token.Event\r
+ was already in the transmit queue.\r
+ @retval EFI_NOT_READY The completion token could not be queued because the transmit\r
+ queue is full. \r
+ @retval EFI_NOT_FOUND Not route is found to destination address.\r
+ @retval EFI_OUT_OF_RESOURCES Could not queue the transmit data.\r
+ @retval EFI_BUFFER_TOO_SMALL Token.Packet.TxData.TotalDataLength is too\r
+ short to transmit.\r
+ @retval EFI_BAD_BUFFER_SIZE The length of the IPv4 header + option length + total data length is\r
+ greater than MTU (or greater than the maximum packet size if\r
+ Token.Packet.TxData.OverrideData.\r
+ DoNotFragment is TRUE.)\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+EfiIp4Transmit (\r
+ IN EFI_IP4_PROTOCOL *This,\r
+ IN EFI_IP4_COMPLETION_TOKEN *Token\r
+ );\r
+ \r
+/**\r
+ Places a receiving request into the receiving queue.\r
+ \r
+ The Receive() function places a completion token into the receive packet queue.\r
+ This function is always asynchronous.\r
+ \r
+ The Token.Event field in the completion token must be filled in by the caller\r
+ and cannot be NULL. When the receive operation completes, the EFI IPv4 Protocol\r
+ driver updates the Token.Status and Token.Packet.RxData fields and the Token.Event\r
+ is signaled.\r
+\r
+ @param This Pointer to the EFI_IP4_PROTOCOL instance.\r
+ @param Token Pointer to a token that is associated with the receive data descriptor.\r
+\r
+ @retval EFI_SUCCESS The receive completion token was cached.\r
+ @retval EFI_NOT_STARTED This EFI IPv4 Protocol instance has not been started.\r
+ @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP, RARP, etc.)\r
+ is not finished yet.\r
+ @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
+ - This is NULL.\r
+ - Token is NULL.\r
+ - Token.Event is NULL.\r
+ @retval EFI_OUT_OF_RESOURCES The receive completion token could not be queued due to a lack of system\r
+ resources (usually memory).\r
+ @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r
+ The EFI IPv4 Protocol instance has been reset to startup defaults.\r
+ EFI_ACCESS_DENIED The receive completion token with the same Token.Event was already\r
+ in the receive queue.\r
+ @retval EFI_NOT_READY The receive request could not be queued because the receive queue is full.\r
+ @retval EFI_ICMP_ERROR An ICMP error packet was received.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+EfiIp4Receive (\r
+ IN EFI_IP4_PROTOCOL *This,\r
+ IN EFI_IP4_COMPLETION_TOKEN *Token\r
+ );\r
+ \r
+/**\r
+ Abort an asynchronous transmit or receive request.\r
+ \r
+ The Cancel() function is used to abort a pending transmit or receive request.\r
+ If the token is in the transmit or receive request queues, after calling this\r
+ function, Token->Status will be set to EFI_ABORTED and then Token->Event will\r
+ be signaled. If the token is not in one of the queues, which usually means the\r
+ asynchronous operation has completed, this function will not signal the token\r
+ and EFI_NOT_FOUND is returned.\r
+\r
+ @param This Pointer to the EFI_IP4_PROTOCOL instance.\r
+ @param Token Pointer to a token that has been issued by\r
+ EFI_IP4_PROTOCOL.Transmit() or\r
+ EFI_IP4_PROTOCOL.Receive(). If NULL, all pending\r
+ tokens are aborted. Type EFI_IP4_COMPLETION_TOKEN is\r
+ defined in EFI_IP4_PROTOCOL.Transmit().\r
+\r
+ @retval EFI_SUCCESS The asynchronous I/O request was aborted and\r
+ Token.->Event was signaled. When Token is NULL, all\r
+ pending requests were aborted and their events were signaled.\r
+ @retval EFI_INVALID_PARAMETER This is NULL.\r
+ @retval EFI_NOT_STARTED This instance has not been started.\r
+ @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r
+ RARP, etc.) is not finished yet.\r
+ @retval EFI_NOT_FOUND When Token is not NULL, the asynchronous I/O request was\r
+ not found in the transmit or receive queue. It has either completed\r
+ or was not issued by Transmit() and Receive().\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+EfiIp4Cancel (\r
+ IN EFI_IP4_PROTOCOL *This,\r
+ IN EFI_IP4_COMPLETION_TOKEN *Token OPTIONAL\r
+ );\r
+ \r
+/**\r
+ Polls for incoming data packets and processes outgoing data packets.\r
+ \r
+ The Poll() function polls for incoming data packets and processes outgoing data\r
+ packets. Network drivers and applications can call the EFI_IP4_PROTOCOL.Poll()\r
+ function to increase the rate that data packets are moved between the communications\r
+ device and the transmit and receive queues.\r
+ \r
+ In some systems the periodic timer event may not poll the underlying communications\r
+ device fast enough to transmit and/or receive all data packets without missing\r
+ incoming packets or dropping outgoing packets. Drivers and applications that are\r
+ experiencing packet loss should try calling the EFI_IP4_PROTOCOL.Poll() function\r
+ more often.\r
+\r
+ @param This Pointer to the EFI_IP4_PROTOCOL instance.\r
+\r
+ @retval EFI_SUCCESS Incoming or outgoing data was processed.\r
+ @retval EFI_NOT_STARTED This EFI IPv4 Protocol instance has not been started.\r
+ @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r
+ RARP, etc.) is not finished yet.\r
+ @retval EFI_INVALID_PARAMETER This is NULL.\r
+ @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r
+ @retval EFI_NOT_READY No incoming or outgoing data is processed.\r
+ @retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive queue.\r
+ Consider increasing the polling rate.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+EfiIp4Poll (\r
+ IN EFI_IP4_PROTOCOL *This\r
+ );\r
+\r
+EFI_IP4_PROTOCOL\r
+mEfiIp4ProtocolTemplete = {\r
+ EfiIp4GetModeData,\r
+ EfiIp4Configure,\r
+ EfiIp4Groups,\r
+ EfiIp4Routes,\r
+ EfiIp4Transmit,\r
+ EfiIp4Receive,\r
+ EfiIp4Cancel,\r
+ EfiIp4Poll\r
+};\r
+\r
+/**\r
+ Gets the current operational settings for this instance of the EFI IPv4 Protocol driver.\r
+ \r
+ The GetModeData() function returns the current operational mode data for this\r
+ driver instance. The data fields in EFI_IP4_MODE_DATA are read only. This\r
+ function is used optionally to retrieve the operational mode data of underlying\r
+ networks or drivers.\r
+\r
+ @param This Pointer to the EFI_IP4_PROTOCOL instance.\r
+ @param Ip4ModeData Pointer to the EFI IPv4 Protocol mode data structure.\r
+ @param MnpConfigData Pointer to the managed network configuration data structure.\r
+ @param SnpModeData Pointer to the simple network mode data structure.\r
+\r
+ @retval EFI_SUCCESS The operation completed successfully.\r
+ @retval EFI_INVALID_PARAMETER This is NULL.\r
+ @retval EFI_OUT_OF_RESOURCES The required mode data could not be allocated.\r
\r
**/\r
EFI_STATUS\r
child to transmit/receive frames. By default, it configures MNP\r
to receive unicast/multicast/broadcast. And it will enable/disable\r
the promiscous receive according to whether there is IP child\r
- enable that or not. If Force isn't false, it will iterate through\r
+ enable that or not. If Force is FALSE, it will iterate through\r
all the IP children to check whether the promiscuous receive\r
setting has been changed. If it hasn't been changed, it won't\r
- reconfigure the MNP. If Force is true, the MNP is configured no\r
+ reconfigure the MNP. If Force is TRUE, the MNP is configured no\r
matter whether that is changed or not.\r
\r
@param IpSb The IP4 service instance that is to be changed.\r
gBS->FreePool (Data);\r
}\r
\r
+/*++\r
+ Request Ip4AutoConfigCallBackDpc as a DPC at TPL_CALLBACK.\r
+ \r
+ @param Event The event that is signalled.\r
+ @param Context The IP4 service binding instance.\r
+ \r
+ @return None.\r
+\r
+++*/\r
VOID\r
EFIAPI\r
Ip4AutoConfigCallBack (\r
IN EFI_EVENT Event,\r
IN VOID *Context\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Request Ip4AutoConfigCallBackDpc as a DPC at TPL_CALLBACK\r
-\r
-Arguments:\r
-\r
- Event - The event that is signalled.\r
- Context - The IP4 service binding instance.\r
-\r
-Returns:\r
-\r
- None\r
-\r
---*/\r
{\r
IP4_SERVICE *IpSb;\r
\r
**/\r
VOID\r
Ip4InitProtocol (\r
- IN IP4_SERVICE *IpSb,\r
- IN IP4_PROTOCOL *IpInstance\r
+ IN IP4_SERVICE *IpSb,\r
+ IN OUT IP4_PROTOCOL *IpInstance\r
)\r
{\r
ASSERT ((IpSb != NULL) && (IpInstance != NULL));\r
address, but the default address hasn't been\r
configured. The IP4 child doesn't need to be\r
reconfigured when default address is configured.\r
+ @retval EFI_OUT_OF_RESOURCES No more memory space is available.\r
+ @retval other Other error occurs.\r
\r
**/\r
EFI_STATUS\r
Ip4ConfigProtocol (\r
- IN IP4_PROTOCOL *IpInstance,\r
- IN EFI_IP4_CONFIG_DATA *Config\r
+ IN OUT IP4_PROTOCOL *IpInstance,\r
+ IN EFI_IP4_CONFIG_DATA *Config\r
)\r
{\r
IP4_SERVICE *IpSb;\r
@param Netmask The netmaks of the IP\r
\r
@retval TRUE The Ip/Netmask pair is valid\r
- @retval FALSE The\r
+ @retval FALSE The Ip/Netmask pair is invalid\r
\r
**/\r
BOOLEAN\r
\r
\r
/**\r
- Configure the EFI_IP4_PROTOCOL instance. If IpConfigData is NULL,\r
- the instance is cleaned up. If the instance hasn't been configure\r
- before, it will be initialized. Otherwise, the filter setting of\r
- the instance is updated.\r
-\r
- @param This The IP4 child to configure\r
- @param IpConfigData The configuration to apply. If NULL, clean it up.\r
-\r
- @retval EFI_INVALID_PARAMETER The parameter is invalid\r
- @retval EFI_NO_MAPPING The default address hasn't been configured and the\r
- instance wants to use it.\r
- @retval EFI_SUCCESS The instance is configured.\r
+ Assigns an IPv4 address and subnet mask to this EFI IPv4 Protocol driver instance.\r
+ \r
+ The Configure() function is used to set, change, or reset the operational\r
+ parameters and filter settings for this EFI IPv4 Protocol instance. Until these\r
+ parameters have been set, no network traffic can be sent or received by this\r
+ instance. Once the parameters have been reset (by calling this function with\r
+ IpConfigData set to NULL), no more traffic can be sent or received until these\r
+ parameters have been set again. Each EFI IPv4 Protocol instance can be started\r
+ and stopped independently of each other by enabling or disabling their receive\r
+ filter settings with the Configure() function.\r
+ \r
+ When IpConfigData.UseDefaultAddress is set to FALSE, the new station address will\r
+ be appended as an alias address into the addresses list in the EFI IPv4 Protocol\r
+ driver. While set to TRUE, Configure() will trigger the EFI_IP4_CONFIG_PROTOCOL\r
+ to retrieve the default IPv4 address if it is not available yet. Clients could\r
+ frequently call GetModeData() to check the status to ensure that the default IPv4\r
+ address is ready.\r
+ \r
+ If operational parameters are reset or changed, any pending transmit and receive\r
+ requests will be cancelled. Their completion token status will be set to EFI_ABORTED\r
+ and their events will be signaled.\r
+\r
+ @param This Pointer to the EFI_IP4_PROTOCOL instance.\r
+ @param IpConfigData Pointer to the EFI IPv4 Protocol configuration data structure.\r
+\r
+ @retval EFI_SUCCESS The driver instance was successfully opened.\r
+ @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r
+ RARP, etc.) is not finished yet.\r
+ @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
+ @retval EFI_UNSUPPORTED One or more of the following conditions is TRUE:\r
+ A configuration protocol (DHCP, BOOTP, RARP, etc.) could\r
+ not be located when clients choose to use the default IPv4\r
+ address. This EFI IPv4 Protocol implementation does not\r
+ support this requested filter or timeout setting.\r
+ @retval EFI_OUT_OF_RESOURCES The EFI IPv4 Protocol driver instance data could not be allocated.\r
+ @retval EFI_ALREADY_STARTED The interface is already open and must be stopped before the\r
+ IPv4 address or subnet mask can be changed. The interface must\r
+ also be stopped when switching to/from raw packet mode.\r
+ @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. The EFI IPv4\r
+ Protocol driver instance is not opened.\r
\r
**/\r
EFI_STATUS\r
\r
\r
/**\r
- Change the IP4 child's multicast setting. If JoinFlag is true,\r
- the child wants to join the group. Otherwise it wants to leave\r
- the group. If JoinFlag is false, and GroupAddress is NULL,\r
- it will leave all the groups which is a member.\r
-\r
- @param This The IP4 child to change the setting.\r
- @param JoinFlag TRUE to join the group, otherwise leave it.\r
- @param GroupAddress The target group address\r
-\r
- @retval EFI_INVALID_PARAMETER The parameters are invalid\r
- @retval EFI_SUCCESS The group setting has been changed.\r
- @retval Otherwise It failed to change the setting.\r
+ Joins and leaves multicast groups.\r
+ \r
+ The Groups() function is used to join and leave multicast group sessions. Joining\r
+ a group will enable reception of matching multicast packets. Leaving a group will\r
+ disable the multicast packet reception.\r
+ \r
+ If JoinFlag is FALSE and GroupAddress is NULL, all joined groups will be left.\r
+\r
+ @param This Pointer to the EFI_IP4_PROTOCOL instance.\r
+ @param JoinFlag Set to TRUE to join the multicast group session and FALSE to leave.\r
+ @param GroupAddress Pointer to the IPv4 multicast address.\r
+\r
+ @retval EFI_SUCCESS The operation completed successfully.\r
+ @retval EFI_INVALID_PARAMETER One or more of the following is TRUE:\r
+ - This is NULL.\r
+ - JoinFlag is TRUE and GroupAddress is NULL.\r
+ - GroupAddress is not NULL and *GroupAddress is\r
+ not a multicast IPv4 address.\r
+ @retval EFI_NOT_STARTED This instance has not been started.\r
+ @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r
+ RARP, etc.) is not finished yet.\r
+ @retval EFI_OUT_OF_RESOURCES System resources could not be allocated.\r
+ @retval EFI_UNSUPPORTED This EFI IPv4 Protocol implementation does not support multicast groups.\r
+ @retval EFI_ALREADY_STARTED The group address is already in the group table (when\r
+ JoinFlag is TRUE).\r
+ @retval EFI_NOT_FOUND The group address is not in the group table (when JoinFlag is FALSE).\r
+ @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r
\r
**/\r
EFI_STATUS\r
\r
\r
/**\r
- Modify the IP child's route table. Each instance has its own\r
- route table.\r
-\r
- @param This The IP4 child to modify the route\r
- @param DeleteRoute TRUE to delete the route, otherwise add it\r
- @param SubnetAddress The destination network\r
- @param SubnetMask The destination network's mask\r
- @param GatewayAddress The next hop address.\r
-\r
- @retval EFI_INVALID_PARAMETER The parameter is invalid.\r
- @retval EFI_SUCCESS The route table is successfully modified.\r
- @retval Others Failed to modify the route table\r
-\r
+ Adds and deletes routing table entries.\r
+\r
+ The Routes() function adds a route to or deletes a route from the routing table.\r
+ \r
+ Routes are determined by comparing the SubnetAddress with the destination IPv4\r
+ address arithmetically AND-ed with the SubnetMask. The gateway address must be\r
+ on the same subnet as the configured station address.\r
+ \r
+ The default route is added with SubnetAddress and SubnetMask both set to 0.0.0.0.\r
+ The default route matches all destination IPv4 addresses that do not match any\r
+ other routes.\r
+ \r
+ A GatewayAddress that is zero is a nonroute. Packets are sent to the destination\r
+ IP address if it can be found in the ARP cache or on the local subnet. One automatic\r
+ nonroute entry will be inserted into the routing table for outgoing packets that\r
+ are addressed to a local subnet (gateway address of 0.0.0.0).\r
+ \r
+ Each EFI IPv4 Protocol instance has its own independent routing table. Those EFI\r
+ IPv4 Protocol instances that use the default IPv4 address will also have copies\r
+ of the routing table that was provided by the EFI_IP4_CONFIG_PROTOCOL, and these\r
+ copies will be updated whenever the EIF IPv4 Protocol driver reconfigures its\r
+ instances. As a result, client modification to the routing table will be lost.\r
+\r
+ @param This Pointer to the EFI_IP4_PROTOCOL instance.\r
+ @param DeleteRoute Set to TRUE to delete this route from the routing table. Set to\r
+ FALSE to add this route to the routing table. SubnetAddress\r
+ and SubnetMask are used as the key to each route entry.\r
+ @param SubnetAddress The address of the subnet that needs to be routed.\r
+ @param SubnetMask The subnet mask of SubnetAddress.\r
+ @param GatewayAddress The unicast gateway IPv4 address for this route.\r
+\r
+ @retval EFI_SUCCESS The operation completed successfully.\r
+ @retval EFI_NOT_STARTED The driver instance has not been started.\r
+ @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r
+ RARP, etc.) is not finished yet.\r
+ @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
+ - This is NULL.\r
+ - SubnetAddress is NULL.\r
+ - SubnetMask is NULL.\r
+ - GatewayAddress is NULL.\r
+ - *SubnetAddress is not a valid subnet address.\r
+ - *SubnetMask is not a valid subnet mask.\r
+ - *GatewayAddress is not a valid unicast IPv4 address.\r
+ @retval EFI_OUT_OF_RESOURCES Could not add the entry to the routing table.\r
+ @retval EFI_NOT_FOUND This route is not in the routing table (when DeleteRoute is TRUE).\r
+ @retval EFI_ACCESS_DENIED The route is already defined in the routing table (when\r
+ DeleteRoute is FALSE).\r
+ \r
**/\r
EFI_STATUS\r
EFIAPI\r
\r
/**\r
Check whether the user's token or event has already\r
- been enqueue on IP4's list.\r
+ been enqueued on IP4's list.\r
\r
@param Map The container of either user's transmit or receive\r
token.\r
\r
\r
/**\r
- Transmit the user's data asynchronously. When transmission\r
- completed,the Token's status is updated and its event signalled.\r
-\r
- @param This The IP4 child instance\r
- @param Token The user's transmit token, which contains user's\r
- data, the result and an event to signal when\r
- completed.\r
-\r
- @retval EFI_INVALID_PARAMETER The parameter is invalid.\r
- @retval EFI_NOT_STARTED The IP4 child hasn't been started.\r
- @retval EFI_SUCCESS The user's data has been successfully enqueued\r
- for transmission.\r
+ Places outgoing data packets into the transmit queue.\r
+\r
+ The Transmit() function places a sending request in the transmit queue of this\r
+ EFI IPv4 Protocol instance. Whenever the packet in the token is sent out or some\r
+ errors occur, the event in the token will be signaled and the status is updated.\r
+\r
+ @param This Pointer to the EFI_IP4_PROTOCOL instance.\r
+ @param Token Pointer to the transmit token.\r
+\r
+ @retval EFI_SUCCESS The data has been queued for transmission.\r
+ @retval EFI_NOT_STARTED This instance has not been started.\r
+ @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r
+ RARP, etc.) is not finished yet.\r
+ @retval EFI_INVALID_PARAMETER One or more pameters are invalid.\r
+ @retval EFI_ACCESS_DENIED The transmit completion token with the same Token.Event\r
+ was already in the transmit queue.\r
+ @retval EFI_NOT_READY The completion token could not be queued because the transmit\r
+ queue is full. \r
+ @retval EFI_NOT_FOUND Not route is found to destination address.\r
+ @retval EFI_OUT_OF_RESOURCES Could not queue the transmit data.\r
+ @retval EFI_BUFFER_TOO_SMALL Token.Packet.TxData.TotalDataLength is too\r
+ short to transmit.\r
+ @retval EFI_BAD_BUFFER_SIZE The length of the IPv4 header + option length + total data length is\r
+ greater than MTU (or greater than the maximum packet size if\r
+ Token.Packet.TxData.OverrideData.\r
+ DoNotFragment is TRUE.)\r
\r
**/\r
EFI_STATUS\r
\r
\r
/**\r
- Receive a packet for the upper layer. If there are packets\r
- pending on the child's receive queue, the receive request\r
- will be fulfilled immediately. Otherwise, the request is\r
- enqueued. When receive request is completed, the status in\r
- the Token is updated and its event is signalled.\r
-\r
- @param This The IP4 child to receive packet.\r
- @param Token The user's receive token\r
-\r
- @retval EFI_INVALID_PARAMETER The token is invalid.\r
- @retval EFI_NOT_STARTED The IP4 child hasn't been started\r
- @retval EFI_ACCESS_DENIED The token or event is already queued.\r
- @retval EFI_SUCCESS The receive request has been issued.\r
+ Places a receiving request into the receiving queue.\r
+ \r
+ The Receive() function places a completion token into the receive packet queue.\r
+ This function is always asynchronous.\r
+ \r
+ The Token.Event field in the completion token must be filled in by the caller\r
+ and cannot be NULL. When the receive operation completes, the EFI IPv4 Protocol\r
+ driver updates the Token.Status and Token.Packet.RxData fields and the Token.Event\r
+ is signaled.\r
+\r
+ @param This Pointer to the EFI_IP4_PROTOCOL instance.\r
+ @param Token Pointer to a token that is associated with the receive data descriptor.\r
+\r
+ @retval EFI_SUCCESS The receive completion token was cached.\r
+ @retval EFI_NOT_STARTED This EFI IPv4 Protocol instance has not been started.\r
+ @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP, RARP, etc.)\r
+ is not finished yet.\r
+ @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
+ - This is NULL.\r
+ - Token is NULL.\r
+ - Token.Event is NULL.\r
+ @retval EFI_OUT_OF_RESOURCES The receive completion token could not be queued due to a lack of system\r
+ resources (usually memory).\r
+ @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r
+ The EFI IPv4 Protocol instance has been reset to startup defaults.\r
+ EFI_ACCESS_DENIED The receive completion token with the same Token.Event was already\r
+ in the receive queue.\r
+ @retval EFI_NOT_READY The receive request could not be queued because the receive queue is full.\r
+ @retval EFI_ICMP_ERROR An ICMP error packet was received.\r
\r
**/\r
EFI_STATUS\r
\r
\r
/**\r
- Cancel the queued receive/transmit requests. If Token is NULL,\r
- all the queued requests will be cancelled. It just validate\r
- the parameter then pass them to Ip4Cancel.\r
-\r
- @param This The IP4 child to cancel the request\r
- @param Token The token to cancel, if NULL, cancel all.\r
-\r
- @retval EFI_INVALID_PARAMETER This is NULL\r
- @retval EFI_NOT_STARTED The IP4 child hasn't been configured.\r
- @retval EFI_NO_MAPPING The IP4 child is configured to use the default,\r
- but the default address hasn't been acquired.\r
- @retval EFI_SUCCESS The Token is cancelled.\r
+ Abort an asynchronous transmit or receive request.\r
+ \r
+ The Cancel() function is used to abort a pending transmit or receive request.\r
+ If the token is in the transmit or receive request queues, after calling this\r
+ function, Token->Status will be set to EFI_ABORTED and then Token->Event will\r
+ be signaled. If the token is not in one of the queues, which usually means the\r
+ asynchronous operation has completed, this function will not signal the token\r
+ and EFI_NOT_FOUND is returned.\r
+\r
+ @param This Pointer to the EFI_IP4_PROTOCOL instance.\r
+ @param Token Pointer to a token that has been issued by\r
+ EFI_IP4_PROTOCOL.Transmit() or\r
+ EFI_IP4_PROTOCOL.Receive(). If NULL, all pending\r
+ tokens are aborted. Type EFI_IP4_COMPLETION_TOKEN is\r
+ defined in EFI_IP4_PROTOCOL.Transmit().\r
+\r
+ @retval EFI_SUCCESS The asynchronous I/O request was aborted and\r
+ Token.->Event was signaled. When Token is NULL, all\r
+ pending requests were aborted and their events were signaled.\r
+ @retval EFI_INVALID_PARAMETER This is NULL.\r
+ @retval EFI_NOT_STARTED This instance has not been started.\r
+ @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r
+ RARP, etc.) is not finished yet.\r
+ @retval EFI_NOT_FOUND When Token is not NULL, the asynchronous I/O request was\r
+ not found in the transmit or receive queue. It has either completed\r
+ or was not issued by Transmit() and Receive().\r
\r
**/\r
EFI_STATUS\r
\r
\r
/**\r
- Poll the network stack. The EFI network stack is poll based. There\r
- is no interrupt support for the network interface card.\r
-\r
- @param This The IP4 child to poll through\r
-\r
- @retval EFI_INVALID_PARAMETER The parameter is invalid\r
- @retval EFI_NOT_STARTED The IP4 child hasn't been configured.\r
+ Polls for incoming data packets and processes outgoing data packets.\r
+ \r
+ The Poll() function polls for incoming data packets and processes outgoing data\r
+ packets. Network drivers and applications can call the EFI_IP4_PROTOCOL.Poll()\r
+ function to increase the rate that data packets are moved between the communications\r
+ device and the transmit and receive queues.\r
+ \r
+ In some systems the periodic timer event may not poll the underlying communications\r
+ device fast enough to transmit and/or receive all data packets without missing\r
+ incoming packets or dropping outgoing packets. Drivers and applications that are\r
+ experiencing packet loss should try calling the EFI_IP4_PROTOCOL.Poll() function\r
+ more often.\r
+\r
+ @param This Pointer to the EFI_IP4_PROTOCOL instance.\r
+\r
+ @retval EFI_SUCCESS Incoming or outgoing data was processed.\r
+ @retval EFI_NOT_STARTED This EFI IPv4 Protocol instance has not been started.\r
+ @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r
+ RARP, etc.) is not finished yet.\r
+ @retval EFI_INVALID_PARAMETER This is NULL.\r
+ @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r
+ @retval EFI_NOT_READY No incoming or outgoing data is processed.\r
+ @retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive queue.\r
+ Consider increasing the polling rate.\r
\r
**/\r
EFI_STATUS\r
return Mnp->Poll (Mnp);\r
}\r
\r
-EFI_IP4_PROTOCOL\r
-mEfiIp4ProtocolTemplete = {\r
- EfiIp4GetModeData,\r
- EfiIp4Configure,\r
- EfiIp4Groups,\r
- EfiIp4Routes,\r
- EfiIp4Transmit,\r
- EfiIp4Receive,\r
- EfiIp4Cancel,\r
- EfiIp4Poll\r
-};\r
-\r
-\r
/**\r
Decrease the life of the transmitted packets. If it is\r
decreased to zero, cancel the packet. This function is\r
projects / mirror_edk2.git / blobdiff