]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Impl.h
1. Fix a bug in PXE driver that the PXE boot do not restart if a new boot option...
[mirror_edk2.git] / MdeModulePkg / Universal / Network / Ip4Dxe / Ip4Impl.h
index 615e5ae2a8bcda4a2e02d51157bfccd37c060a14..563cf7f91ff28ab505944f5443db43f2451da59b 100644 (file)
@@ -1,8 +1,8 @@
 /** @file\r
   Ip4 internal functions and type defintions.\r
   \r
-Copyright (c) 2005 - 2007, Intel Corporation.<BR>                                                         \r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2005 - 2012, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
 which accompanies this distribution.  The full text of the license may be found at\r
 http://opensource.org/licenses/bsd-license.php\r
@@ -17,6 +17,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 #include <Uefi.h>\r
 \r
+#include <Protocol/IpSec.h>\r
 #include <Protocol/Ip4.h>\r
 #include <Protocol/Ip4Config.h>\r
 #include <Protocol/Arp.h>\r
@@ -43,34 +44,31 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include "Ip4Input.h"\r
 #include "Ip4Output.h"\r
 \r
+#define IP4_PROTOCOL_SIGNATURE  SIGNATURE_32 ('I', 'P', '4', 'P')\r
+#define IP4_SERVICE_SIGNATURE   SIGNATURE_32 ('I', 'P', '4', 'S')\r
+\r
+//\r
+// The state of IP4 protocol. It starts from UNCONFIGED. if it is\r
+// successfully configured, it goes to CONFIGED. if configure NULL\r
+// is called, it becomes UNCONFIGED again. If (partly) destroyed, it\r
+// becomes DESTROY.\r
+//\r
+#define IP4_STATE_UNCONFIGED    0\r
+#define IP4_STATE_CONFIGED      1\r
+#define IP4_STATE_DESTROY       2\r
+\r
+//\r
+// The state of IP4 service. It starts from UNSTARTED. It transits\r
+// to STARTED if autoconfigure is started. If default address is\r
+// configured, it becomes CONFIGED. and if partly destroyed, it goes\r
+// to DESTROY.\r
+//\r
+#define IP4_SERVICE_UNSTARTED   0\r
+#define IP4_SERVICE_STARTED     1\r
+#define IP4_SERVICE_CONFIGED    2\r
+#define IP4_SERVICE_DESTROY     3\r
 \r
 \r
-typedef enum {\r
-  IP4_PROTOCOL_SIGNATURE = SIGNATURE_32 ('I', 'P', '4', 'P'),\r
-  IP4_SERVICE_SIGNATURE  = SIGNATURE_32 ('I', 'P', '4', 'S'),\r
-\r
-  //\r
-  // The state of IP4 protocol. It starts from UNCONFIGED. if it is\r
-  // successfully configured, it goes to CONFIGED. if configure NULL\r
-  // is called, it becomes UNCONFIGED again. If (partly) destoried, it\r
-  // becomes DESTORY.\r
-  //\r
-  IP4_STATE_UNCONFIGED   = 0,\r
-  IP4_STATE_CONFIGED,\r
-  IP4_STATE_DESTORY,\r
-\r
-  //\r
-  // The state of IP4 service. It starts from UNSTARTED. It transits\r
-  // to STARTED if autoconfigure is started. If default address is\r
-  // configured, it becomes CONFIGED. and if partly destoried, it goes\r
-  // to DESTORY.\r
-  //\r
-  IP4_SERVICE_UNSTARTED  = 0,\r
-  IP4_SERVICE_STARTED,\r
-  IP4_SERVICE_CONFIGED,\r
-  IP4_SERVICE_DESTORY\r
-} IP4_IMPL_ENUM_TYPES;\r
-\r
 ///\r
 /// IP4_TXTOKEN_WRAP wraps the upper layer's transmit token.\r
 /// The user's data is kept in the Packet. When fragment is\r
@@ -83,11 +81,23 @@ typedef enum {
 typedef struct {\r
   IP4_PROTOCOL              *IpInstance;\r
   EFI_IP4_COMPLETION_TOKEN  *Token;\r
+  EFI_EVENT                 IpSecRecycleSignal;\r
   NET_BUF                   *Packet;\r
   BOOLEAN                   Sent;\r
   INTN                      Life;\r
 } IP4_TXTOKEN_WRAP;\r
 \r
+///\r
+/// IP4_IPSEC_WRAP wraps the packet received from MNP layer. The packet\r
+/// will be released after it has been processed by the receiver. Upon then,\r
+/// the IP4_IPSEC_WRAP will be released, and the IpSecRecycleSignal will be signaled\r
+/// to notice IPsec to free the resources.\r
+///\r
+typedef struct {\r
+  EFI_EVENT                 IpSecRecycleSignal;\r
+  NET_BUF                   *Packet;\r
+} IP4_IPSEC_WRAP;\r
+\r
 ///\r
 /// IP4_RXDATA_WRAP wraps the data IP4 child delivers to the\r
 /// upper layers. The received packet is kept in the Packet.\r
@@ -113,7 +123,7 @@ struct _IP4_PROTOCOL {
   INTN                      State;\r
 \r
   IP4_SERVICE               *Service;\r
-  LIST_ENTRY                Link; // Link to all the IP protocol from the service\r
+  LIST_ENTRY                Link;       // Link to all the IP protocol from the service\r
 \r
   //\r
   // User's transmit/receive tokens, and received/deliverd packets\r
@@ -139,7 +149,7 @@ struct _IP4_PROTOCOL {
   //\r
   // IGMP data for this instance\r
   //\r
-  IP4_ADDR                  *Groups;  // stored in network byte order\r
+  IP4_ADDR                  *Groups;    // stored in network byte order\r
   UINT32                    GroupCount;\r
 \r
   EFI_IP4_CONFIG_DATA       ConfigData;\r
@@ -150,7 +160,7 @@ struct _IP4_SERVICE {
   UINT32                          Signature;\r
   EFI_SERVICE_BINDING_PROTOCOL    ServiceBinding;\r
   INTN                            State;\r
-  BOOLEAN                         InDestory;\r
+  BOOLEAN                         InDestroy;\r
 \r
   //\r
   // List of all the IP instances and interfaces, and default\r
@@ -197,6 +207,8 @@ struct _IP4_SERVICE {
   // NIC this IP4_SERVICE works on.\r
   //\r
   CHAR16                          *MacString;\r
+  UINT32                          MaxPacketSize;\r
+  UINT32                          OldMaxPacketSize; ///< The MTU before IPsec enable.\r
 };\r
 \r
 #define IP4_INSTANCE_FROM_PROTOCOL(Ip4) \\r
@@ -333,9 +345,40 @@ Ip4TimerTicking (
 \r
 **/\r
 EFI_STATUS\r
+EFIAPI\r
 Ip4SentPacketTicking (\r
   IN NET_MAP                *Map,\r
   IN NET_MAP_ITEM           *Item,\r
   IN VOID                   *Context\r
   );\r
+\r
+/**\r
+  The callback function for the net buffer which wraps the user's\r
+  transmit token. Although it seems this function is pretty simple,\r
+  there are some subtle things.\r
+  When user requests the IP to transmit a packet by passing it a\r
+  token, the token is wrapped in an IP4_TXTOKEN_WRAP and the data\r
+  is wrapped in an net buffer. the net buffer's Free function is\r
+  set to Ip4FreeTxToken. The Token and token wrap are added to the\r
+  IP child's TxToken map. Then the buffer is passed to Ip4Output for\r
+  transmission. If something error happened before that, the buffer\r
+  is freed, which in turn will free the token wrap. The wrap may\r
+  have been added to the TxToken map or not, and the user's event\r
+  shouldn't be fired because we are still in the EfiIp4Transmit. If\r
+  the buffer has been sent by Ip4Output, it should be removed from\r
+  the TxToken map and user's event signaled. The token wrap and buffer\r
+  are bound together. Check the comments in Ip4Output for information\r
+  about IP fragmentation.\r
+\r
+  @param[in]  Context                The token's wrap\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+Ip4FreeTxToken (\r
+  IN VOID                   *Context\r
+  );\r
+\r
+extern EFI_IPSEC2_PROTOCOL   *mIpSec;\r
+\r
 #endif\r