]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Option.h
Update the copyright notice format
[mirror_edk2.git] / MdeModulePkg / Universal / Network / Tcp4Dxe / Tcp4Option.h
index 727c6f2dd4ba14710b50d5cd4b860b7e069b16a5..9676df015d5fa58bd03d7435c1f8b64efda3bfe9 100644 (file)
@@ -1,7 +1,8 @@
 /** @file\r
+  Tcp option's routine header file.\r
     \r
-Copyright (c) 2005 - 2006, Intel Corporation<BR>\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2005 - 2009, 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<BR>\r
@@ -26,47 +27,44 @@ typedef struct _TCP_OPTION {
   UINT32  TSEcr;    ///< The TSEcr field in a timestamp option\r
 } TCP_OPTION;\r
 \r
-typedef enum {\r
-\r
-  //\r
-  // supported TCP option type and their length\r
-  //\r
-  TCP_OPTION_EOP            = 0,  ///< End Of oPtion\r
-  TCP_OPTION_NOP            = 1,  ///< No-Option.\r
-  TCP_OPTION_MSS            = 2,  ///< Maximum Segment Size\r
-  TCP_OPTION_WS             = 3,  ///< Window scale\r
-  TCP_OPTION_TS             = 8,  ///< Timestamp\r
-  TCP_OPTION_MSS_LEN        = 4,  ///< Length of MSS option\r
-  TCP_OPTION_WS_LEN         = 3,  ///< Length of window scale option\r
-  TCP_OPTION_TS_LEN         = 10, ///< Length of timestamp option\r
-  TCP_OPTION_WS_ALIGNED_LEN = 4,  ///< Length of window scale option, aligned\r
-  TCP_OPTION_TS_ALIGNED_LEN = 12, ///< Length of timestamp option, aligned\r
-\r
-  //\r
-  // recommend format of timestamp window scale\r
-  // option for fast process.\r
-  //\r
-  TCP_OPTION_TS_FAST = ((TCP_OPTION_NOP << 24) |\r
-                        (TCP_OPTION_NOP << 16) |\r
-                        (TCP_OPTION_TS << 8) |\r
-                        TCP_OPTION_TS_LEN),\r
-\r
-  TCP_OPTION_WS_FAST = ((TCP_OPTION_NOP << 24) |\r
-                        (TCP_OPTION_WS << 16) |\r
-                        (TCP_OPTION_WS_LEN << 8)),\r
-\r
-  TCP_OPTION_MSS_FAST = ((TCP_OPTION_MSS << 24) |\r
-                         (TCP_OPTION_MSS_LEN << 16)),\r
-\r
-  //\r
-  // Other misc definations\r
-  //\r
-  TCP_OPTION_RCVD_MSS       = 0x01,\r
-  TCP_OPTION_RCVD_WS        = 0x02,\r
-  TCP_OPTION_RCVD_TS        = 0x04,\r
-  TCP_OPTION_MAX_WS         = 14,     ///< Maxium window scale value\r
-  TCP_OPTION_MAX_WIN        = 0xffff  ///< Max window size in TCP header\r
-} TCP_OPTION_TYPE;\r
+//\r
+// supported TCP option type and their length\r
+//\r
+#define TCP_OPTION_EOP             0  ///< End Of oPtion\r
+#define TCP_OPTION_NOP             1  ///< No-Option.\r
+#define TCP_OPTION_MSS             2  ///< Maximum Segment Size\r
+#define TCP_OPTION_WS              3  ///< Window scale\r
+#define TCP_OPTION_TS              8  ///< Timestamp\r
+#define TCP_OPTION_MSS_LEN         4  ///< Length of MSS option\r
+#define TCP_OPTION_WS_LEN          3  ///< Length of window scale option\r
+#define TCP_OPTION_TS_LEN          10 ///< Length of timestamp option\r
+#define TCP_OPTION_WS_ALIGNED_LEN  4  ///< Length of window scale option, aligned\r
+#define TCP_OPTION_TS_ALIGNED_LEN  12 ///< Length of timestamp option, aligned\r
+\r
+//\r
+// recommend format of timestamp window scale\r
+// option for fast process.\r
+//\r
+#define TCP_OPTION_TS_FAST ((TCP_OPTION_NOP << 24) | \\r
+                            (TCP_OPTION_NOP << 16) | \\r
+                            (TCP_OPTION_TS << 8)   | \\r
+                            (TCP_OPTION_TS_LEN))\r
+\r
+#define TCP_OPTION_WS_FAST   ((TCP_OPTION_NOP << 24) | \\r
+                              (TCP_OPTION_WS << 16)  | \\r
+                              (TCP_OPTION_WS_LEN << 8))\r
+\r
+#define TCP_OPTION_MSS_FAST  ((TCP_OPTION_MSS << 24) | (TCP_OPTION_MSS_LEN << 16))\r
+\r
+//\r
+// Other misc definations\r
+//\r
+#define TCP_OPTION_RCVD_MSS        0x01\r
+#define TCP_OPTION_RCVD_WS         0x02\r
+#define TCP_OPTION_RCVD_TS         0x04\r
+#define TCP_OPTION_MAX_WS          14      ///< Maxium window scale value\r
+#define TCP_OPTION_MAX_WIN         0xffff  ///< Max window size in TCP header\r
+\r
 \r
 /**\r
   Compute the window scale value according to the given buffer size.\r
@@ -124,8 +122,8 @@ TcpBuildOption (
 **/\r
 INTN\r
 TcpParseOption (\r
-  IN TCP_HEAD   *Tcp,\r
-  IN TCP_OPTION *Option\r
+  IN     TCP_HEAD   *Tcp,\r
+  IN OUT TCP_OPTION *Option\r
   );\r
 \r
 /**\r