#include <Protocol/DriverBinding.h>\r
#include <Protocol/ServiceBinding.h>\r
\r
+/**\r
+ Test to see if this driver supports ControllerHandle. This service\r
+ is called by the EFI boot service ConnectController(). In\r
+ order to make drivers as small as possible, there are a few calling\r
+ restrictions for this service. ConnectController() must\r
+ follow these calling restrictions. If any other agent wishes to call\r
+ Supported() it must also follow these calling restrictions.\r
+\r
+ @param This Protocol instance pointer.\r
+ @param ControllerHandle Handle of device to test\r
+ @param RemainingDevicePath Optional parameter use to pick a specific child\r
+ device to start.\r
+\r
+ @retval EFI_SUCCESS This driver supports this device\r
+ @retval EFI_ALREADY_STARTED This driver is already running on this device\r
+ @retval other This driver does not support this device\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
Udp4DriverBindingSupported (\r
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL\r
);\r
\r
+/**\r
+ Start this driver on ControllerHandle. This service is called by the\r
+ EFI boot service ConnectController(). In order to make\r
+ drivers as small as possible, there are a few calling restrictions for\r
+ this service. ConnectController() must follow these\r
+ calling restrictions. If any other agent wishes to call Start() it\r
+ must also follow these calling restrictions.\r
+\r
+ @param This Protocol instance pointer.\r
+ @param ControllerHandle Handle of device to bind driver to\r
+ @param RemainingDevicePath Optional parameter use to pick a specific child\r
+ device to start.\r
+\r
+ @retval EFI_SUCCESS This driver is added to ControllerHandle\r
+ @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle\r
+ @retval other This driver does not support this device\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
Udp4DriverBindingStart (\r
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL\r
);\r
\r
+/**\r
+ Stop this driver on ControllerHandle. This service is called by the\r
+ EFI boot service DisconnectController(). In order to\r
+ make drivers as small as possible, there are a few calling\r
+ restrictions for this service. DisconnectController()\r
+ must follow these calling restrictions. If any other agent wishes\r
+ to call Stop() it must also follow these calling restrictions.\r
+ \r
+ @param This Protocol instance pointer.\r
+ @param ControllerHandle Handle of device to stop driver on\r
+ @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of\r
+ children is zero stop the entire bus driver.\r
+ @param ChildHandleBuffer List of Child Handles to Stop.\r
+\r
+ @retval EFI_SUCCESS This driver is removed ControllerHandle\r
+ @retval other This driver was not removed from this device\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
Udp4DriverBindingStop (\r
IN EFI_HANDLE *ChildHandleBuffer\r
);\r
\r
+/**\r
+ Creates a child handle with a set of I/O services.\r
+\r
+ @param This Protocol instance pointer.\r
+ @param ChildHandle Pointer to the handle of the child to create. If it is NULL,\r
+ then a new handle is created. If it is not NULL, then the\r
+ I/O services are added to the existing child handle.\r
+\r
+ @retval EFI_SUCCES The child handle was created with the I/O services\r
+ @retval EFI_INVALID_PARAMETER ChildHandle is NULL.\r
+ @retval EFI_OUT_OF_RESOURCES There are not enough resources availabe to create\r
+ the child\r
+ @retval other The child handle was not created\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
Udp4ServiceBindingCreateChild (\r
IN EFI_HANDLE *ChildHandle\r
);\r
\r
+/**\r
+ Destroys a child handle with a set of I/O services.\r
+\r
+ @param This Protocol instance pointer.\r
+ @param ChildHandle Handle of the child to destroy\r
+\r
+ @retval EFI_SUCCES The I/O services were removed from the child handle\r
+ @retval EFI_UNSUPPORTED The child handle does not support the I/O services\r
+ that are being removed.\r
+ @retval EFI_INVALID_PARAMETER Child handle is not a valid EFI Handle.\r
+ @retval EFI_ACCESS_DENIED The child handle could not be destroyed because its\r
+ I/O services are being used.\r
+ @retval other The child handle was not destroyed\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
Udp4ServiceBindingDestroyChild (\r
\r
UINT16 mUdp4RandomPort;\r
\r
+/**\r
+ This function checks and timeouts the I/O datagrams holding by the corresponding\r
+ service context.\r
+\r
+ @param Event The event this function registered to.\r
+ @param Context The context data registered during the creation of\r
+ the Event.\r
+\r
+ @return None.\r
+\r
+**/\r
VOID\r
EFIAPI\r
Udp4CheckTimeout (\r
IN VOID *Context\r
);\r
\r
+/**\r
+ This function finds the udp instance by the specified <Address, Port> pair.\r
+\r
+ @param InstanceList Pointer to the head of the list linking the udp\r
+ instances.\r
+ @param Address Pointer to the specified IPv4 address.\r
+ @param Port The udp port number.\r
+\r
+ @retval TRUE The specified <Address, Port> pair is found.\r
+ @retval FALSE Otherwise.\r
+\r
+**/\r
BOOLEAN\r
Udp4FindInstanceByPort (\r
IN LIST_ENTRY *InstanceList,\r
IN UINT16 Port\r
);\r
\r
+/**\r
+ This function is the packet transmitting notify function registered to the IpIo\r
+ interface. It's called to signal the udp TxToken when IpIo layer completes the\r
+ transmitting of the udp datagram.\r
+\r
+ @param Status The completion status of the output udp datagram.\r
+ @param Context Pointer to the context data.\r
+ @param Sender Pointer to the Ip sender of the udp datagram.\r
+ @param NotifyData Pointer to the notify data.\r
+\r
+ @return None.\r
+\r
+**/\r
VOID\r
Udp4DgramSent (\r
IN EFI_STATUS Status,\r
IN VOID *NotifyData\r
);\r
\r
+/**\r
+ This function processes the received datagram passed up by the IpIo layer.\r
+\r
+ @param Status The status of this udp datagram.\r
+ @param IcmpError The IcmpError code, only available when Status is\r
+ EFI_ICMP_ERROR.\r
+ @param NetSession Pointer to the EFI_NET_SESSION_DATA.\r
+ @param Packet Pointer to the NET_BUF containing the received udp\r
+ datagram.\r
+ @param Context Pointer to the context data.\r
+\r
+ @return None.\r
+\r
+**/\r
VOID\r
Udp4DgramRcvd (\r
IN EFI_STATUS Status,\r
IN VOID *Context\r
);\r
\r
+/**\r
+ This function cancels the token specified by Arg in the Map. This is a callback\r
+ used by Udp4InstanceCancelToken().\r
+\r
+ @param Map Pointer to the NET_MAP.\r
+ @param Item Pointer to the NET_MAP_ITEM.\r
+ @param Arg Pointer to the token to be cancelled, if NULL,\r
+ the token specified by Item is cancelled.\r
+\r
+ @retval EFI_SUCCESS The token is cancelled if Arg is NULL or the token\r
+ is not the same as that in the Item if Arg is not\r
+ NULL.\r
+ @retval EFI_ABORTED Arg is not NULL, and the token specified by Arg is\r
+ cancelled.\r
+\r
+**/\r
EFI_STATUS\r
Udp4CancelTokens (\r
IN NET_MAP *Map,\r
IN VOID *Arg OPTIONAL\r
);\r
\r
+/**\r
+ This function matches the received udp datagram with the Instance.\r
+\r
+ @param Instance Pointer to the udp instance context data.\r
+ @param Udp4Session Pointer to the EFI_UDP4_SESSION_DATA abstracted\r
+ from the received udp datagram.\r
+\r
+ @retval TRUE The udp datagram matches the receiving requirments of the\r
+ udp Instance.\r
+ @retval FALSE Otherwise.\r
+\r
+**/\r
BOOLEAN\r
Udp4MatchDgram (\r
IN UDP4_INSTANCE_DATA *Instance,\r
IN EFI_UDP4_SESSION_DATA *Udp4Session\r
);\r
\r
+/**\r
+ This function removes the Wrap specified by Context and release relevant resources.\r
+\r
+ @param Event The Event this notify function registered to.\r
+ @param Context Pointer to the context data.\r
+\r
+ @return None.\r
+\r
+**/\r
VOID\r
EFIAPI\r
Udp4RecycleRxDataWrap (\r
IN VOID *Context\r
);\r
\r
+/**\r
+ This function wraps the Packet and the RxData.\r
+\r
+ @param Instance Pointer to the instance context data.\r
+ @param Packet Pointer to the buffer containing the received\r
+ datagram.\r
+ @param RxData Pointer to the EFI_UDP4_RECEIVE_DATA of this\r
+ datagram.\r
+\r
+ @return Pointer to the structure wrapping the RxData and the Packet.\r
+\r
+**/\r
UDP4_RXDATA_WRAP *\r
Udp4WrapRxData (\r
IN UDP4_INSTANCE_DATA *Instance,\r
IN EFI_UDP4_RECEIVE_DATA *RxData\r
);\r
\r
+/**\r
+ This function enqueues the received datagram into the instances' receiving queues.\r
+\r
+ @param Udp4Service Pointer to the udp service context data.\r
+ @param Packet Pointer to the buffer containing the received\r
+ datagram.\r
+ @param RxData Pointer to the EFI_UDP4_RECEIVE_DATA of this\r
+ datagram.\r
+\r
+ @return The times this datagram is enqueued.\r
+\r
+**/\r
UINTN\r
Udp4EnqueueDgram (\r
IN UDP4_SERVICE_DATA *Udp4Service,\r
IN EFI_UDP4_RECEIVE_DATA *RxData\r
);\r
\r
+/**\r
+ This function delivers the datagrams enqueued in the instances.\r
+\r
+ @param Udp4Service Pointer to the udp service context data.\r
+\r
+ @return None.\r
+\r
+**/\r
VOID\r
Udp4DeliverDgram (\r
IN UDP4_SERVICE_DATA *Udp4Service\r
);\r
\r
+/**\r
+ This function demultiplexes the received udp datagram to the apropriate instances.\r
+\r
+ @param Udp4Service Pointer to the udp service context data.\r
+ @param NetSession Pointer to the EFI_NET_SESSION_DATA abstrated from\r
+ the received datagram.\r
+ @param Packet Pointer to the buffer containing the received udp\r
+ datagram.\r
+\r
+ @return None.\r
+\r
+**/\r
VOID\r
Udp4Demultiplex (\r
IN UDP4_SERVICE_DATA *Udp4Service,\r
IN NET_BUF *Packet\r
);\r
\r
+/**\r
+ This function handles the received Icmp Error message and demultiplexes it to the\r
+ instance.\r
+\r
+ @param Udp4Service Pointer to the udp service context data.\r
+ @param IcmpError The icmp error code.\r
+ @param NetSession Pointer to the EFI_NET_SESSION_DATA abstracted\r
+ from the received Icmp Error packet.\r
+ @param Packet Pointer to the Icmp Error packet.\r
+\r
+ @return None.\r
+\r
+**/\r
VOID\r
Udp4IcmpHandler (\r
IN UDP4_SERVICE_DATA *Udp4Service,\r
IN NET_BUF *Packet\r
);\r
\r
+/**\r
+ This function builds and sends out a icmp port unreachable message.\r
+\r
+ @param IpIo Pointer to the IP_IO instance.\r
+ @param NetSession Pointer to the EFI_NET_SESSION_DATA of the packet\r
+ causes this icmp error message.\r
+ @param Udp4Header Pointer to the udp header of the datagram causes\r
+ this icmp error message.\r
+\r
+ @return None.\r
+\r
+**/\r
VOID\r
Udp4SendPortUnreach (\r
IN IP_IO *IpIo,\r
EFI_UDP4_RECEIVE_DATA RxData;\r
} UDP4_RXDATA_WRAP;\r
\r
+/**\r
+ Reads the current operational settings.\r
+\r
+ The GetModeData() function copies the current operational settings of this EFI\r
+ UDPv4 Protocol instance into user-supplied buffers. This function is used\r
+ optionally to retrieve the operational mode data of underlying networks or\r
+ drivers.\r
+\r
+ @param This Pointer to the EFI_UDP4_PROTOCOL instance.\r
+ @param Udp4ConfigData Pointer to the buffer to receive the current configuration data.\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 mode data was read.\r
+ @retval EFI_NOT_STARTED When Udp4ConfigData is queried, no configuration data is\r
+ available because this instance has not been started.\r
+ @retval EFI_INVALID_PARAMETER This is NULL.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
Udp4GetModeData (\r
OUT EFI_SIMPLE_NETWORK_MODE *SnpModeData OPTIONAL\r
);\r
\r
+/**\r
+ Initializes, changes, or resets the operational parameters for this instance of the EFI UDPv4\r
+ Protocol.\r
+ \r
+ The Configure() function is used to do the following:\r
+ * Initialize and start this instance of the EFI UDPv4 Protocol.\r
+ * Change the filtering rules and operational parameters.\r
+ * Reset this instance of the EFI UDPv4 Protocol.\r
+ Until these parameters are initialized, no network traffic can be sent or\r
+ received by this instance. This instance can be also reset by calling Configure()\r
+ with UdpConfigData set to NULL. Once reset, the receiving queue and transmitting\r
+ queue are flushed and no traffic is allowed through this instance.\r
+ With different parameters in UdpConfigData, Configure() can be used to bind\r
+ this instance to specified port.\r
+\r
+ @param This Pointer to the EFI_UDP4_PROTOCOL instance.\r
+ @param UdpConfigData Pointer to the buffer to receive the current configuration data.\r
+\r
+ @retval EFI_SUCCESS The configuration settings were set, changed, or reset successfully.\r
+ @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP,\r
+ RARP, etc.) is not finished yet.\r
+ @retval EFI_INVALID_PARAMETER One or more following conditions are TRUE:\r
+ @retval EFI_ALREADY_STARTED The EFI UDPv4 Protocol instance is already started/configured\r
+ and must be stopped/reset before it can be reconfigured.\r
+ @retval EFI_ACCESS_DENIED UdpConfigData. AllowDuplicatePort is FALSE\r
+ and UdpConfigData.StationPort is already used by\r
+ other instance.\r
+ @retval EFI_OUT_OF_RESOURCES The EFI UDPv4 Protocol driver cannot allocate memory for this\r
+ EFI UDPv4 Protocol instance.\r
+ @retval EFI_DEVICE_ERROR An unexpected network or system error occurred and this instance\r
+ was not opened. \r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
Udp4Configure (\r
IN EFI_UDP4_CONFIG_DATA *UdpConfigData OPTIONAL\r
);\r
\r
+/**\r
+ Joins and leaves multicast groups.\r
+ \r
+ The Groups() function is used to enable and disable the multicast group\r
+ filtering. If the JoinFlag is FALSE and the MulticastAddress is NULL, then all\r
+ currently joined groups are left.\r
+\r
+ @param This Pointer to the EFI_UDP4_PROTOCOL instance.\r
+ @param JoinFlag Set to TRUE to join a multicast group. Set to FALSE to leave one\r
+ or all multicast groups.\r
+ @param MulticastAddress Pointer to multicast group address to join or leave.\r
+\r
+ @retval EFI_SUCCESS The operation completed successfully.\r
+ @retval EFI_NOT_STARTED The EFI UDPv4 Protocol instance has not been started.\r
+ @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP,\r
+ RARP, etc.) is not finished yet.\r
+ @retval EFI_OUT_OF_RESOURCES Could not allocate resources to join the group.\r
+ @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
+ - This is NULL.\r
+ - JoinFlag is TRUE and MulticastAddress is NULL.\r
+ - JoinFlag is TRUE and *MulticastAddress is not\r
+ a valid multicast address.\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\r
+ FALSE).\r
+ @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
Udp4Groups (\r
IN EFI_IPv4_ADDRESS *MulticastAddress 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
+ Routes are determined by comparing the SubnetAddress with the destination IP\r
+ address and arithmetically AND-ing it with the SubnetMask. The gateway address\r
+ must be on the same subnet as the configured station address.\r
+ The default route is added with SubnetAddress and SubnetMask both set to 0.0.0.0.\r
+ The default route matches all destination IP addresses that do not match any\r
+ other routes.\r
+ A zero GatewayAddress is a nonroute. Packets are sent to the destination IP\r
+ address if it can be found in the Address Resolution Protocol (ARP) cache or\r
+ on the local subnet. One automatic nonroute entry will be inserted into the\r
+ routing table for outgoing packets that are addressed to a local subnet\r
+ (gateway address of 0.0.0.0).\r
+ Each instance of the EFI UDPv4 Protocol has its own independent routing table.\r
+ Instances of the EFI UDPv4 Protocol that use the default IP address will also\r
+ have copies of the routing table provided by the EFI_IP4_CONFIG_PROTOCOL. These\r
+ copies will be updated automatically whenever the IP driver reconfigures its\r
+ instances; as a result, the previous modification to these copies will be lost.\r
+\r
+ @param This Pointer to the EFI_UDP4_PROTOCOL instance.\r
+ @param DeleteRoute Set to TRUE to delete this route from the routing table.\r
+ Set to FALSE to add this route to the routing table.\r
+ @param SubnetAddress The destination network address that needs to be routed.\r
+ @param SubnetMask The subnet mask of SubnetAddress.\r
+ @param GatewayAddress The gateway IP address for this route.\r
+\r
+ @retval EFI_SUCCESS The operation completed successfully.\r
+ @retval EFI_NOT_STARTED The EFI UDPv4 Protocol instance has not been started.\r
+ @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP,\r
+ - RARP, etc.) is not finished yet.\r
+ @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\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.\r
+ @retval EFI_ACCESS_DENIED The route is already defined in the routing table.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
Udp4Routes (\r
IN EFI_IPv4_ADDRESS *GatewayAddress\r
);\r
\r
+/**\r
+ Queues outgoing data packets into the transmit queue.\r
+ \r
+ The Transmit() function places a sending request to this instance of the EFI\r
+ UDPv4 Protocol, alongside the transmit data that was filled by the user. Whenever\r
+ the packet in the token is sent out or some errors occur, the Token.Event will\r
+ be signaled and Token.Status is updated. Providing a proper notification function\r
+ and context for the event will enable the user to receive the notification and\r
+ transmitting status.\r
+\r
+ @param This Pointer to the EFI_UDP4_PROTOCOL instance.\r
+ @param Token Pointer to the completion token that will be placed into the\r
+ transmit queue.\r
+\r
+ @retval EFI_SUCCESS The data has been queued for transmission.\r
+ @retval EFI_NOT_STARTED This EFI UDPv4 Protocol instance has not been started.\r
+ @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP,\r
+ RARP, etc.) is not finished yet.\r
+ @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
+ @retval EFI_ACCESS_DENIED The transmit completion token with the same\r
+ Token.Event was already in the transmit queue.\r
+ @retval EFI_NOT_READY The completion token could not be queued because the\r
+ transmit queue is full.\r
+ @retval EFI_OUT_OF_RESOURCES Could not queue the transmit data.\r
+ @retval EFI_NOT_FOUND There is no route to the destination network or address.\r
+ @retval EFI_BAD_BUFFER_SIZE The data length is greater than the maximum UDP packet\r
+ size. Or the length of the IP header + UDP header + data\r
+ length is greater than MTU if DoNotFragment is TRUE.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
Udp4Transmit (\r
IN EFI_UDP4_COMPLETION_TOKEN *Token\r
);\r
\r
+/**\r
+ Places an asynchronous receive 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
+ The caller must fill in the Token.Event field in the completion token, and this\r
+ field cannot be NULL. When the receive operation completes, the EFI UDPv4 Protocol\r
+ driver updates the Token.Status and Token.Packet.RxData fields and the Token.Event\r
+ is signaled. Providing a proper notification function and context for the event\r
+ will enable the user to receive the notification and receiving status. That\r
+ notification function is guaranteed to not be re-entered.\r
+\r
+ @param This Pointer to the EFI_UDP4_PROTOCOL instance.\r
+ @param Token Pointer to a token that is associated with the receive data\r
+ descriptor.\r
+\r
+ @retval EFI_SUCCESS The receive completion token was cached.\r
+ @retval EFI_NOT_STARTED This EFI UDPv4 Protocol instance has not been started.\r
+ @retval EFI_NO_MAPPING When using a 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
+ @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
+ @retval EFI_ACCESS_DENIED A receive completion token with the same Token.Event was already in\r
+ the receive queue.\r
+ @retval EFI_NOT_READY The receive request could not be queued because the receive queue is full.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
Udp4Receive (\r
IN EFI_UDP4_COMPLETION_TOKEN *Token\r
);\r
\r
+/**\r
+ Aborts 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 be\r
+ signaled. If the token is not in one of the queues, which usually means that\r
+ the asynchronous operation has completed, this function will not signal the\r
+ token and EFI_NOT_FOUND is returned.\r
+\r
+ @param This Pointer to the EFI_UDP4_PROTOCOL instance.\r
+ @param Token Pointer to a token that has been issued by\r
+ EFI_UDP4_PROTOCOL.Transmit() or\r
+ EFI_UDP4_PROTOCOL.Receive().If NULL, all pending\r
+ tokens are aborted.\r
+\r
+ @retval EFI_SUCCESS The asynchronous I/O request was aborted and Token.Event\r
+ was signaled. When Token is NULL, all pending requests are\r
+ aborted and their events are 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
Udp4Cancel (\r
IN EFI_UDP4_COMPLETION_TOKEN *Token OPTIONAL\r
);\r
\r
+/**\r
+ Polls for incoming data packets and processes outgoing data packets.\r
+ \r
+ The Poll() function can be used by network drivers and applications to increase\r
+ the rate that data packets are moved between the communications device and the\r
+ transmit and receive queues.\r
+ In some systems, the periodic timer event in the managed network driver may not\r
+ poll the underlying communications device fast enough to transmit and/or receive\r
+ all data packets without missing incoming packets or dropping outgoing packets.\r
+ Drivers and applications that are experiencing packet loss should try calling\r
+ the Poll() function more often.\r
+\r
+ @param This Pointer to the EFI_UDP4_PROTOCOL instance.\r
+\r
+ @retval EFI_SUCCESS Incoming or outgoing data was processed.\r
+ @retval EFI_INVALID_PARAMETER This is NULL.\r
+ @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r
+ @retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive queue.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
Udp4Poll (\r
IN EFI_UDP4_PROTOCOL *This\r
);\r
\r
+/**\r
+ Create the Udp service context data.\r
+\r
+ @param Udp4Service Pointer to the UDP4_SERVICE_DATA.\r
+ @param ImageHandle The image handle of this udp4 driver.\r
+ @param ControllerHandle The controller handle this udp4 driver binds on.\r
+\r
+ @retval EFI_SUCCESS The udp4 service context data is created and\r
+ initialized.\r
+ @retval EFI_OUT_OF_RESOURCES Cannot allocate memory.\r
+ @retval other Other error occurs.\r
+\r
+**/\r
EFI_STATUS\r
Udp4CreateService (\r
- IN UDP4_SERVICE_DATA *Udp4Service,\r
- IN EFI_HANDLE ImageHandle,\r
- IN EFI_HANDLE ControllerHandle\r
+ IN OUT UDP4_SERVICE_DATA *Udp4Service,\r
+ IN EFI_HANDLE ImageHandle,\r
+ IN EFI_HANDLE ControllerHandle\r
);\r
\r
+/**\r
+ Clean the Udp service context data.\r
+\r
+ @param Udp4Service Pointer to the UDP4_SERVICE_DATA.\r
+\r
+ @return None.\r
+\r
+**/\r
VOID\r
Udp4CleanService (\r
IN UDP4_SERVICE_DATA *Udp4Service\r
);\r
\r
+/**\r
+ This function intializes the new created udp instance.\r
+\r
+ @param Udp4Service Pointer to the UDP4_SERVICE_DATA.\r
+ @param Instance Pointer to the un-initialized UDP4_INSTANCE_DATA.\r
+\r
+ @return None.\r
+\r
+**/\r
VOID\r
Udp4InitInstance (\r
- IN UDP4_SERVICE_DATA *Udp4Service,\r
- IN UDP4_INSTANCE_DATA *Instance\r
+ IN UDP4_SERVICE_DATA *Udp4Service,\r
+ IN OUT UDP4_INSTANCE_DATA *Instance\r
);\r
\r
+/**\r
+ This function cleans the udp instance.\r
+\r
+ @param Instance Pointer to the UDP4_INSTANCE_DATA to clean.\r
+\r
+ @return None.\r
+\r
+**/\r
VOID\r
Udp4CleanInstance (\r
IN UDP4_INSTANCE_DATA *Instance\r
);\r
\r
+/**\r
+ This function tries to bind the udp instance according to the configured port\r
+ allocation strategy.\r
+\r
+ @param InstanceList Pointer to the head of the list linking the udp\r
+ instances.\r
+ @param ConfigData Pointer to the ConfigData of the instance to be\r
+ bound. ConfigData->StationPort will be assigned\r
+ with an available port value on success.\r
+\r
+ @retval EFI_SUCCESS The bound operation is completed successfully.\r
+ @retval EFI_ACCESS_DENIED The <Address, Port> specified by the ConfigData is\r
+ already used by other instance.\r
+ @retval EFI_OUT_OF_RESOURCES No available port resources.\r
+\r
+**/\r
EFI_STATUS\r
Udp4Bind (\r
- IN LIST_ENTRY *InstanceList,\r
- IN EFI_UDP4_CONFIG_DATA *ConfigData\r
+ IN LIST_ENTRY *InstanceList,\r
+ IN OUT EFI_UDP4_CONFIG_DATA *ConfigData\r
);\r
\r
+/**\r
+ This function is used to check whether the NewConfigData has any un-reconfigurable\r
+ parameters changed compared to the OldConfigData.\r
+\r
+ @param OldConfigData Pointer to the current ConfigData the udp instance\r
+ uses.\r
+ @param NewConfigData Pointer to the new ConfigData.\r
+\r
+ @retval TRUE The instance is reconfigurable.\r
+ @retval FALSE Otherwise.\r
+\r
+**/\r
BOOLEAN\r
Udp4IsReconfigurable (\r
IN EFI_UDP4_CONFIG_DATA *OldConfigData,\r
IN EFI_UDP4_CONFIG_DATA *NewConfigData\r
);\r
\r
+/**\r
+ This function builds the Ip4 configdata from the Udp4ConfigData.\r
+\r
+ @param Udp4ConfigData Pointer to the EFI_UDP4_CONFIG_DATA.\r
+ @param Ip4ConfigData Pointer to the EFI_IP4_CONFIG_DATA.\r
+\r
+ @return None.\r
+\r
+**/\r
VOID\r
Udp4BuildIp4ConfigData (\r
- IN EFI_UDP4_CONFIG_DATA *Udp4ConfigData,\r
- IN EFI_IP4_CONFIG_DATA *Ip4ConfigData\r
+ IN EFI_UDP4_CONFIG_DATA *Udp4ConfigData,\r
+ IN OUT EFI_IP4_CONFIG_DATA *Ip4ConfigData\r
);\r
\r
+/**\r
+ This function validates the TxToken, it returns the error code according to the spec.\r
+\r
+ @param Instance Pointer to the udp instance context data.\r
+ @param TxToken Pointer to the token to be checked.\r
+\r
+ @retval EFI_SUCCESS The TxToken is valid.\r
+ @retval EFI_INVALID_PARAMETER One or more of the following are TRUE: This is\r
+ NULL. Token is NULL. Token.Event is NULL.\r
+ Token.Packet.TxData is NULL.\r
+ Token.Packet.TxData.FragmentCount is zero.\r
+ Token.Packet.TxData.DataLength is not equal to the\r
+ sum of fragment lengths. One or more of the\r
+ Token.Packet.TxData.FragmentTable[].\r
+ FragmentLength fields is zero. One or more of the\r
+ Token.Packet.TxData.FragmentTable[].\r
+ FragmentBuffer fields is NULL.\r
+ Token.Packet.TxData. GatewayAddress is not a\r
+ unicast IPv4 address if it is not NULL. One or\r
+ more IPv4 addresses in Token.Packet.TxData.\r
+ UdpSessionData are not valid unicast IPv4\r
+ addresses if the UdpSessionData is not NULL.\r
+ @retval EFI_BAD_BUFFER_SIZE The data length is greater than the maximum UDP\r
+ packet size.\r
+\r
+**/\r
EFI_STATUS\r
Udp4ValidateTxToken (\r
IN UDP4_INSTANCE_DATA *Instance,\r
IN EFI_UDP4_COMPLETION_TOKEN *TxToken\r
);\r
\r
+/**\r
+ This function checks whether the specified Token duplicates with the one in the Map.\r
+\r
+ @param Map Pointer to the NET_MAP.\r
+ @param Item Pointer to the NET_MAP_ITEM contain the pointer to\r
+ the Token.\r
+ @param Context Pointer to the Token to be checked.\r
+\r
+ @retval EFI_SUCCESS The Token specified by Context differs from the\r
+ one in the Item.\r
+ @retval EFI_ACCESS_DENIED The Token duplicates with the one in the Item.\r
+\r
+**/\r
EFI_STATUS\r
Udp4TokenExist (\r
IN NET_MAP *Map,\r
IN VOID *Context\r
);\r
\r
+/**\r
+ This function calculates the checksum for the Packet, utilizing the pre-calculated\r
+ pseudo HeadSum to reduce some overhead.\r
+\r
+ @param Packet Pointer to the NET_BUF contains the udp datagram.\r
+ @param HeadSum Checksum of the pseudo header execpt the length\r
+ field.\r
+\r
+ @return The 16-bit checksum of this udp datagram.\r
+\r
+**/\r
UINT16\r
Udp4Checksum (\r
IN NET_BUF *Packet,\r
IN UINT16 HeadSum\r
);\r
\r
+/**\r
+ This function removes the specified Token from the TokenMap.\r
+\r
+ @param TokenMap Pointer to the NET_MAP containing the tokens.\r
+ @param Token Pointer to the Token to be removed.\r
+\r
+ @retval EFI_SUCCESS The specified Token is removed from the TokenMap.\r
+ @retval EFI_NOT_FOUND The specified Token is not found in the TokenMap.\r
+\r
+**/\r
EFI_STATUS\r
Udp4RemoveToken (\r
- IN NET_MAP *TokenMap,\r
- IN EFI_UDP4_COMPLETION_TOKEN *Token\r
+ IN OUT NET_MAP *TokenMap,\r
+ IN EFI_UDP4_COMPLETION_TOKEN *Token\r
);\r
\r
+/**\r
+ This function removes the multicast group specified by Arg from the Map.\r
+\r
+ @param Map Pointer to the NET_MAP.\r
+ @param Item Pointer to the NET_MAP_ITEM.\r
+ @param Arg Pointer to the Arg, it's the pointer to a\r
+ multicast IPv4 Address.\r
+\r
+ @retval EFI_SUCCESS The multicast address is removed.\r
+ @retval EFI_ABORTED The specified multicast address is removed and the\r
+ Arg is not NULL.\r
+\r
+**/\r
EFI_STATUS\r
Udp4LeaveGroup (\r
- IN NET_MAP *Map,\r
- IN NET_MAP_ITEM *Item,\r
- IN VOID *Arg OPTIONAL\r
+ IN OUT NET_MAP *Map,\r
+ IN NET_MAP_ITEM *Item,\r
+ IN VOID *Arg OPTIONAL\r
);\r
\r
+/**\r
+ This function removes all the Wrap datas in the RcvdDgramQue.\r
+\r
+ @param Instance Pointer to the udp instance context data.\r
+\r
+ @return None.\r
+\r
+**/\r
VOID\r
Udp4FlushRcvdDgram (\r
IN UDP4_INSTANCE_DATA *Instance\r
);\r
\r
+/**\r
+ Cancel Udp4 tokens from the Udp4 instance.\r
+\r
+ @param Instance Pointer to the udp instance context data.\r
+ @param Token Pointer to the token to be canceled, if NULL, all\r
+ tokens in this instance will be cancelled.\r
+\r
+ @retval EFI_SUCCESS The Token is cancelled.\r
+ @retval EFI_NOT_FOUND The Token is not found.\r
+\r
+**/\r
EFI_STATUS\r
Udp4InstanceCancelToken (\r
IN UDP4_INSTANCE_DATA *Instance,\r
IN EFI_UDP4_COMPLETION_TOKEN *Token OPTIONAL\r
);\r
\r
+/**\r
+ This function delivers the received datagrams for the specified instance.\r
+\r
+ @param Instance Pointer to the instance context data.\r
+\r
+ @return None.\r
+\r
+**/\r
VOID\r
Udp4InstanceDeliverDgram (\r
IN UDP4_INSTANCE_DATA *Instance\r
);\r
\r
+/**\r
+ This function reports the received ICMP error.\r
+\r
+ @param Instance Pointer to the udp instance context data.\r
+\r
+ @return None.\r
+\r
+**/\r
VOID\r
Udp4ReportIcmpError (\r
IN UDP4_INSTANCE_DATA *Instance\r
);\r
\r
+/**\r
+ This function is a dummy ext-free function for the NET_BUF created for the output\r
+ udp datagram.\r
+\r
+ @param Context Pointer to the context data.\r
+\r
+ @return None.\r
+\r
+**/\r
VOID\r
Udp4NetVectorExtFree (\r
VOID *Context\r
);\r
\r
+/**\r
+ Set the Udp4 variable data.\r
+\r
+ @param Udp4Service Udp4 service data.\r
+\r
+ @retval EFI_OUT_OF_RESOURCES There are not enough resources to set the\r
+ variable.\r
+ @retval EFI_SUCCESS Set variable successfully.\r
+ @retval other Set variable failed.\r
+\r
+**/\r
EFI_STATUS\r
Udp4SetVariableData (\r
IN UDP4_SERVICE_DATA *Udp4Service\r
);\r
\r
+/**\r
+ Clear the variable and free the resource.\r
+\r
+ @param Udp4Service Udp4 service data.\r
+\r
+ @return None.\r
+\r
+**/\r
VOID\r
Udp4ClearVariableData (\r
IN UDP4_SERVICE_DATA *Udp4Service\r
projects / mirror_edk2.git / commitdiff