]>
Commit | Line | Data |
---|---|---|
3eb9473e | 1 | /*++\r |
2 | \r | |
f57387d5 HT |
3 | Copyright (c) 2005 - 2006, Intel Corporation. All rights reserved.<BR>\r |
4 | This program and the accompanying materials \r | |
3eb9473e | 5 | are licensed and made available under the terms and conditions of the BSD License \r |
6 | which accompanies this distribution. The full text of the license may be found at \r | |
7 | http://opensource.org/licenses/bsd-license.php \r | |
8 | \r | |
9 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
10 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
11 | \r | |
12 | Module Name:\r | |
13 | \r | |
14 | Tcp4.h\r | |
15 | \r | |
16 | Abstract:\r | |
17 | \r | |
18 | UEFI TCPv4 Protocol Definition\r | |
19 | \r | |
20 | --*/\r | |
21 | \r | |
22 | #ifndef _TCP4_H_\r | |
23 | #define _TCP4_H_\r | |
24 | \r | |
25 | #include EFI_PROTOCOL_DEFINITION (ServiceBinding)\r | |
26 | #include EFI_PROTOCOL_DEFINITION (Ip4)\r | |
27 | \r | |
28 | #define EFI_TCP4_SERVICE_BINDING_PROTOCOL_GUID \\r | |
29 | { \\r | |
7ccf38a3 | 30 | 0x00720665, 0x67EB, 0x4a99, {0xBA, 0xF7, 0xD3, 0xC3, 0x3A, 0x1C, 0x7C, 0xC9} \\r |
3eb9473e | 31 | }\r |
32 | \r | |
33 | extern EFI_GUID gEfiTcp4ServiceBindingProtocolGuid;\r | |
34 | \r | |
35 | #define EFI_TCP4_PROTOCOL_GUID \\r | |
36 | { \\r | |
7ccf38a3 | 37 | 0x65530BC7, 0xA359, 0x410f, {0xB0, 0x10, 0x5A, 0xAD, 0xC7, 0xEC, 0x2B, 0x62} \\r |
3eb9473e | 38 | }\r |
39 | \r | |
40 | extern EFI_GUID gEfiTcp4ProtocolGuid;\r | |
41 | \r | |
42 | EFI_FORWARD_DECLARATION (EFI_TCP4_PROTOCOL);\r | |
43 | \r | |
44 | typedef struct {\r | |
45 | EFI_HANDLE InstanceHandle;\r | |
46 | EFI_IPv4_ADDRESS LocalAddress;\r | |
47 | UINT16 LocalPort;\r | |
48 | EFI_IPv4_ADDRESS RemoteAddress;\r | |
49 | UINT16 RemotePort;\r | |
50 | } EFI_TCP4_SERVICE_POINT;\r | |
51 | \r | |
52 | typedef struct {\r | |
53 | EFI_HANDLE DriverHandle;\r | |
54 | UINT32 ServiceCount;\r | |
55 | EFI_TCP4_SERVICE_POINT Services[1];\r | |
56 | } EFI_TCP4_VARIABLE_DATA;\r | |
57 | \r | |
58 | typedef struct {\r | |
59 | BOOLEAN UseDefaultAddress;\r | |
60 | EFI_IPv4_ADDRESS StationAddress;\r | |
61 | EFI_IPv4_ADDRESS SubnetMask;\r | |
62 | UINT16 StationPort;\r | |
63 | EFI_IPv4_ADDRESS RemoteAddress;\r | |
64 | UINT16 RemotePort;\r | |
65 | BOOLEAN ActiveFlag;\r | |
66 | } EFI_TCP4_ACCESS_POINT;\r | |
67 | \r | |
68 | typedef struct {\r | |
69 | UINT32 ReceiveBufferSize;\r | |
70 | UINT32 SendBufferSize;\r | |
71 | UINT32 MaxSynBackLog;\r | |
72 | UINT32 ConnectionTimeout;\r | |
73 | UINT32 DataRetries;\r | |
74 | UINT32 FinTimeout;\r | |
75 | UINT32 TimeWaitTimeout;\r | |
76 | UINT32 KeepAliveProbes;\r | |
77 | UINT32 KeepAliveTime;\r | |
78 | UINT32 KeepAliveInterval;\r | |
79 | BOOLEAN EnableNagle;\r | |
80 | BOOLEAN EnableTimeStamp;\r | |
81 | BOOLEAN EnableWindowScaling;\r | |
82 | BOOLEAN EnableSelectiveAck;\r | |
83 | BOOLEAN EnablePathMtuDiscovery;\r | |
84 | } EFI_TCP4_OPTION;\r | |
85 | \r | |
86 | typedef struct {\r | |
87 | UINT8 TypeOfService;\r | |
88 | UINT8 TimeToLive;\r | |
89 | EFI_TCP4_ACCESS_POINT AccessPoint;\r | |
90 | EFI_TCP4_OPTION *ControlOption;\r | |
91 | } EFI_TCP4_CONFIG_DATA;\r | |
92 | \r | |
93 | typedef enum {\r | |
94 | Tcp4StateClosed = 0,\r | |
95 | Tcp4StateListen = 1,\r | |
96 | Tcp4StateSynSent = 2,\r | |
97 | Tcp4StateSynReceived= 3,\r | |
98 | Tcp4StateEstablished= 4,\r | |
99 | Tcp4StateFinWait1 = 5,\r | |
100 | Tcp4StateFinWait2 = 6,\r | |
101 | Tcp4StateClosing = 7,\r | |
102 | Tcp4StateTimeWait = 8,\r | |
103 | Tcp4StateCloseWait = 9,\r | |
104 | Tcp4StateLastAck = 10\r | |
105 | } EFI_TCP4_CONNECTION_STATE;\r | |
106 | \r | |
107 | typedef struct {\r | |
108 | EFI_EVENT Event;\r | |
109 | EFI_STATUS Status;\r | |
110 | } EFI_TCP4_COMPLETION_TOKEN;\r | |
111 | \r | |
112 | typedef struct {\r | |
113 | EFI_TCP4_COMPLETION_TOKEN CompletionToken;\r | |
114 | } EFI_TCP4_CONNECTION_TOKEN;\r | |
115 | \r | |
116 | typedef struct {\r | |
117 | EFI_TCP4_COMPLETION_TOKEN CompletionToken;\r | |
118 | EFI_HANDLE NewChildHandle;\r | |
119 | } EFI_TCP4_LISTEN_TOKEN;\r | |
120 | \r | |
121 | typedef struct {\r | |
122 | UINT32 FragmentLength;\r | |
123 | VOID *FragmentBuffer;\r | |
124 | } EFI_TCP4_FRAGMENT_DATA;\r | |
125 | \r | |
126 | typedef struct {\r | |
127 | BOOLEAN UrgentFlag;\r | |
128 | UINT32 DataLength;\r | |
129 | UINT32 FragmentCount;\r | |
130 | EFI_TCP4_FRAGMENT_DATA FragmentTable[1];\r | |
131 | } EFI_TCP4_RECEIVE_DATA;\r | |
132 | \r | |
133 | typedef struct {\r | |
134 | BOOLEAN Push;\r | |
135 | BOOLEAN Urgent;\r | |
136 | UINT32 DataLength;\r | |
137 | UINT32 FragmentCount;\r | |
138 | EFI_TCP4_FRAGMENT_DATA FragmentTable[1];\r | |
139 | } EFI_TCP4_TRANSMIT_DATA;\r | |
140 | \r | |
141 | typedef struct {\r | |
142 | EFI_TCP4_COMPLETION_TOKEN CompletionToken;\r | |
143 | union {\r | |
144 | EFI_TCP4_RECEIVE_DATA *RxData;\r | |
145 | EFI_TCP4_TRANSMIT_DATA *TxData;\r | |
146 | } Packet;\r | |
147 | } EFI_TCP4_IO_TOKEN;\r | |
148 | \r | |
149 | typedef struct {\r | |
150 | EFI_TCP4_COMPLETION_TOKEN CompletionToken;\r | |
151 | BOOLEAN AbortOnClose;\r | |
152 | } EFI_TCP4_CLOSE_TOKEN;\r | |
153 | \r | |
154 | typedef\r | |
155 | EFI_STATUS\r | |
156 | (EFIAPI *EFI_TCP4_GET_MODE_DATA) (\r | |
157 | IN EFI_TCP4_PROTOCOL *This,\r | |
158 | OUT EFI_TCP4_CONNECTION_STATE *Tcp4State OPTIONAL,\r | |
159 | OUT EFI_TCP4_CONFIG_DATA *Tcp4ConfigData OPTIONAL,\r | |
160 | OUT EFI_IP4_MODE_DATA *Ip4ModeData OPTIONAL,\r | |
161 | OUT EFI_MANAGED_NETWORK_CONFIG_DATA *MnpConfigData OPTIONAL,\r | |
162 | OUT EFI_SIMPLE_NETWORK_MODE *SnpModeData OPTIONAL\r | |
163 | );\r | |
164 | \r | |
165 | typedef\r | |
166 | EFI_STATUS\r | |
167 | (EFIAPI *EFI_TCP4_CONFIGURE) (\r | |
168 | IN EFI_TCP4_PROTOCOL *This,\r | |
169 | IN EFI_TCP4_CONFIG_DATA *TcpConfigData OPTIONAL\r | |
170 | );\r | |
171 | \r | |
172 | typedef\r | |
173 | EFI_STATUS\r | |
174 | (EFIAPI *EFI_TCP4_ROUTES) (\r | |
175 | IN EFI_TCP4_PROTOCOL *This,\r | |
176 | IN BOOLEAN DeleteRoute,\r | |
177 | IN EFI_IPv4_ADDRESS *SubnetAddress,\r | |
178 | IN EFI_IPv4_ADDRESS *SubnetMask,\r | |
179 | IN EFI_IPv4_ADDRESS *GatewayAddress\r | |
180 | );\r | |
181 | \r | |
182 | typedef\r | |
183 | EFI_STATUS\r | |
184 | (EFIAPI *EFI_TCP4_CONNECT) (\r | |
185 | IN EFI_TCP4_PROTOCOL *This,\r | |
186 | IN EFI_TCP4_CONNECTION_TOKEN *ConnectionToken\r | |
187 | );\r | |
188 | \r | |
189 | typedef\r | |
190 | EFI_STATUS\r | |
191 | (EFIAPI *EFI_TCP4_ACCEPT) (\r | |
192 | IN EFI_TCP4_PROTOCOL *This,\r | |
193 | IN EFI_TCP4_LISTEN_TOKEN *ListenToken\r | |
194 | );\r | |
195 | \r | |
196 | typedef\r | |
197 | EFI_STATUS\r | |
198 | (EFIAPI *EFI_TCP4_TRANSMIT) (\r | |
199 | IN EFI_TCP4_PROTOCOL *This,\r | |
200 | IN EFI_TCP4_IO_TOKEN *Token\r | |
201 | );\r | |
202 | \r | |
203 | typedef\r | |
204 | EFI_STATUS\r | |
205 | (EFIAPI *EFI_TCP4_RECEIVE) (\r | |
206 | IN EFI_TCP4_PROTOCOL *This,\r | |
207 | IN EFI_TCP4_IO_TOKEN *Token\r | |
208 | );\r | |
209 | \r | |
210 | typedef\r | |
211 | EFI_STATUS\r | |
212 | (EFIAPI *EFI_TCP4_CLOSE) (\r | |
213 | IN EFI_TCP4_PROTOCOL *This,\r | |
214 | IN EFI_TCP4_CLOSE_TOKEN *CloseToken\r | |
215 | );\r | |
216 | \r | |
217 | typedef\r | |
218 | EFI_STATUS\r | |
219 | (EFIAPI *EFI_TCP4_CANCEL) (\r | |
220 | IN EFI_TCP4_PROTOCOL *This,\r | |
221 | IN EFI_TCP4_COMPLETION_TOKEN *Token OPTIONAL\r | |
222 | );\r | |
223 | \r | |
224 | typedef\r | |
225 | EFI_STATUS\r | |
226 | (EFIAPI *EFI_TCP4_POLL) (\r | |
227 | IN EFI_TCP4_PROTOCOL *This\r | |
228 | );\r | |
229 | \r | |
e5bce275 | 230 | struct _EFI_TCP4_PROTOCOL {\r |
3eb9473e | 231 | EFI_TCP4_GET_MODE_DATA GetModeData;\r |
232 | EFI_TCP4_CONFIGURE Configure;\r | |
233 | EFI_TCP4_ROUTES Routes;\r | |
234 | EFI_TCP4_CONNECT Connect;\r | |
235 | EFI_TCP4_ACCEPT Accept;\r | |
236 | EFI_TCP4_TRANSMIT Transmit;\r | |
237 | EFI_TCP4_RECEIVE Receive;\r | |
238 | EFI_TCP4_CLOSE Close;\r | |
239 | EFI_TCP4_CANCEL Cancel;\r | |
240 | EFI_TCP4_POLL Poll;\r | |
e5bce275 | 241 | };\r |
3eb9473e | 242 | \r |
243 | #define EFI_CONNECTION_FIN EFIERR (104)\r | |
244 | #define EFI_CONNECTION_RESET EFIERR (105)\r | |
245 | #define EFI_CONNECTION_REFUSED EFIERR (106)\r | |
246 | \r | |
247 | #endif\r |