]> git.proxmox.com Git - mirror_edk2.git/blob - EdkModulePkg/Universal/Network/PxeBc/Dxe/pxe_bc_dhcp.c
projects / mirror_edk2.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Clean up the following module msa files, they are three networt and two PCD modules.
[mirror_edk2.git] / EdkModulePkg / Universal / Network / PxeBc / Dxe / pxe_bc_dhcp.c
1 /*++
2
3 Copyright (c) 2006 - 2007, Intel Corporation
4 All rights reserved. This program and the accompanying materials
5 are licensed and made available under the terms and conditions of the BSD License
6 which accompanies this distribution. The full text of the license may be found at
7 http://opensource.org/licenses/bsd-license.php
8
9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
11
12 Module Name:
13 pxe_bc_dhcp.c
14
15 Abstract:
16 DHCP and PXE discovery protocol implementations.
17
18 --*/
19
20
21 #include "Bc.h"
22
23 STATIC EFI_PXE_BASE_CODE_UDP_PORT DhcpServerPort = DHCP_SERVER_PORT;
24 STATIC EFI_PXE_BASE_CODE_UDP_PORT DHCPClientPort = DHCP_CLIENT_PORT;
25 STATIC EFI_PXE_BASE_CODE_UDP_PORT PseudoDhcpServerPort = PXE_DISCOVERY_PORT;
26 #define PSEUDO_DHCP_CLIENT_PORT PseudoDhcpServerPort
27 STATIC EFI_IP_ADDRESS BroadcastIP = { { 0xffffffff } };
28 STATIC EFI_IP_ADDRESS DefaultSubnetMask = { { 0xffffff00 } };
29
30 typedef union {
31 DHCPV4_OP_STRUCT *OpPtr;
32 PXE_OP_SERVER_LIST *BootServersStr;
33 PXE_SERVER_LIST *BootServerList;
34 PXE_BOOT_MENU_ENTRY *BootMenuItem;
35 PXE_OP_DISCOVERY_CONTROL *DiscoveryControl;
36 PXE_OP_BOOT_MENU *BootMenu;
37 PXE_OP_BOOT_ITEM *BootItem;
38 DHCPV4_OP_VENDOR_OPTIONS *VendorOptions;
39 DHCPV4_OP_OVERLOAD *Overload;
40 DHCPV4_OP_CLASS *PxeClassStr;
41 DHCPV4_OP_SUBNET_MASK *SubnetMaskStr;
42 DHCPV4_OP_MESSAGE_TYPE *MessageType;
43 UINT8 *BytePtr;
44 } UNION_PTR;
45
46 #pragma pack(1)
47 //
48 // option structure for DHCPREQUEST at end of DISCOVER options
49 // and for DHCPDECLINE
50 //
51 STATIC const struct requestopendstr {
52 DHCPV4_OP_REQUESTED_IP OpReqIP;
53 DHCPV4_OP_SERVER_IP DhcServerIpPtr;
54 UINT8 End[1];
55 }
56 RequestOpEndStr = {
57 {
58 {
59 OP_DHCP_REQ_IP_ADD,
60 DHCPV4_OPTION_LENGTH(DHCPV4_OP_REQUESTED_IP)
61 }
62 },
63 {
64 {
65 OP_DHCP_SERVER_IP,
66 DHCPV4_OPTION_LENGTH(DHCPV4_OP_SERVER_IP)
67 }
68 },
69 {
70 OP_END
71 }
72 };
73
74 #define DHCP_REQ_OPTIONS (*(struct requestopendstr *) DHCPV4_OPTIONS_BUFFER.End)
75
76 PXE_OP_BOOT_ITEM DefaultBootItem = {
77 {
78 VEND_PXE_BOOT_ITEM,
79 DHCPV4_OPTION_LENGTH(PXE_OP_BOOT_ITEM)
80 },
81 0, 0,
82 };
83
84 //
85 // PXE discovery control default structure
86 //
87 STATIC PXE_OP_DISCOVERY_CONTROL DefaultDisCtl = {
88 { VEND_PXE_DISCOVERY_CONTROL, DHCPV4_OPTION_LENGTH(PXE_OP_DISCOVERY_CONTROL) },
89 0
90 };
91
92 //
93 // PXE credentials option structure
94 //
95 typedef struct {
96 UINT8 c[4];
97 } PXE_CREDENTIAL;
98
99 typedef struct {
100 DHCPV4_OP_HEADER Header;
101 PXE_CREDENTIAL Credentials[1];
102 } PXE_OP_CREDENTIAL_TYPES;
103
104 //
105 // option structure for PXE discover (without credentials)
106 //
107 typedef struct { // discoveropendstr {
108 DHCPV4_OP_HEADER Header; // vendor options
109 PXE_OP_BOOT_ITEM BootItem;
110 UINT8 End[1]; // if credentials option, it starts here
111 } PXE_DISCOVER_OPTIONS;
112
113 #define DISCOVERoptions (*(PXE_DISCOVER_OPTIONS *) DHCPV4_OPTIONS_BUFFER.End)
114 #define DISCREDoptions (*(PXE_OP_CREDENTIAL_TYPES *) DISCOVERoptions.End)
115
116 //
117 // common option beginning for all our DHCP messages except
118 // DHCPDECLINE and DHCPRELEASE
119 //
120 STATIC struct optionsstr {
121 UINT8 DhcpCookie[4];
122 DHCPV4_OP_MESSAGE_TYPE DhcpMessageType;
123 DHCPV4_OP_MAX_MESSAGE_SIZE DhcpMaxMessageSize;
124 DHCPV4_OP_REQUESTED_OPTIONS DhcpRequestedOptions;
125 DHCPV4_OP_PLATFORM_ID DhcpPlatformId;
126 DHCPV4_OP_NETWORK_INTERFACE DhcpNetworkInterface;
127 DHCPV4_OP_ARCHITECTURE_TYPE DhcpClientArchitecture;
128 DHCPV4_OP_CLASS_ID DhcpClassIdentifier;
129 UINT8 End[1];
130 } DHCPOpStart;
131
132 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
133 VOID
134 OptionsStrucInit (
135 VOID
136 )
137 {
138 DHCPOpStart.DhcpCookie[0] = 99;
139 DHCPOpStart.DhcpCookie[1] = 130;
140 DHCPOpStart.DhcpCookie[2] = 83;
141 DHCPOpStart.DhcpCookie[3] = 99;
142 DHCPOpStart.DhcpMessageType.Header.OpCode = OP_DHCP_MESSAGE_TYPE;
143 DHCPOpStart.DhcpMessageType.Header.Length = 1;
144 DHCPOpStart.DhcpMessageType.Type = DHCPDISCOVER;
145 DHCPOpStart.DhcpMaxMessageSize.Header.OpCode = OP_DHCP_MAX_MESSAGE_SZ;
146 DHCPOpStart.DhcpMaxMessageSize.Header.Length = 2;
147 DHCPOpStart.DhcpMaxMessageSize.MaxSize[0] = MAX_DHCP_MSG_SZ >> 8;
148 DHCPOpStart.DhcpMaxMessageSize.MaxSize[1] = MAX_DHCP_MSG_SZ & 0xff;
149 DHCPOpStart.DhcpRequestedOptions.Header.OpCode = OP_DHCP_PARM_REQ_LIST;
150 DHCPOpStart.DhcpRequestedOptions.Header.Length = sizeof (DHCPV4_REQUESTED_OPTIONS_DATA);
151 DHCPOpStart.DhcpRequestedOptions.Data._OP_SUBNET_MASK = OP_SUBNET_MASK; /* 1 */
152 DHCPOpStart.DhcpRequestedOptions.Data._OP_TIME_OFFSET = OP_TIME_OFFSET; /* 2 */
153 DHCPOpStart.DhcpRequestedOptions.Data._OP_ROUTER_LIST = OP_ROUTER_LIST; /* 3 */
154 DHCPOpStart.DhcpRequestedOptions.Data._OP_TIME_SERVERS = OP_TIME_SERVERS; /* 4 */
155 DHCPOpStart.DhcpRequestedOptions.Data._OP_NAME_SERVERS = OP_NAME_SERVERS; /* 5 */
156 DHCPOpStart.DhcpRequestedOptions.Data._OP_DNS_SERVERS = OP_DNS_SERVERS; /* 6 */
157 DHCPOpStart.DhcpRequestedOptions.Data._OP_HOST_NAME = OP_HOST_NAME; /* 12 */
158 DHCPOpStart.DhcpRequestedOptions.Data._OP_BOOT_FILE_SZ = OP_BOOT_FILE_SZ; /* 13 */
159 DHCPOpStart.DhcpRequestedOptions.Data._OP_DOMAIN_NAME = OP_DOMAIN_NAME; /* 15 */
160 DHCPOpStart.DhcpRequestedOptions.Data._OP_ROOT_PATH = OP_ROOT_PATH; /* 17 */
161 DHCPOpStart.DhcpRequestedOptions.Data._OP_EXTENSION_PATH = OP_EXTENSION_PATH; /* 18 */
162 DHCPOpStart.DhcpRequestedOptions.Data._OP_MAX_DATAGRAM_SZ = OP_MAX_DATAGRAM_SZ; /* 22 */
163 DHCPOpStart.DhcpRequestedOptions.Data._OP_DEFAULT_TTL = OP_DEFAULT_TTL; /* 23 */
164 DHCPOpStart.DhcpRequestedOptions.Data._OP_BROADCAST_ADD = OP_BROADCAST_ADD; /* 28 */
165 DHCPOpStart.DhcpRequestedOptions.Data._OP_NIS_DOMAIN_NAME = OP_NIS_DOMAIN_NAME; /* 40 */
166 DHCPOpStart.DhcpRequestedOptions.Data._OP_NIS_SERVERS = OP_NIS_SERVERS; /* 41 */
167 DHCPOpStart.DhcpRequestedOptions.Data._OP_NTP_SERVERS = OP_NTP_SERVERS; /* 42 */
168 DHCPOpStart.DhcpRequestedOptions.Data._OP_VENDOR_SPECIFIC = OP_VENDOR_SPECIFIC; /* 43 */
169 DHCPOpStart.DhcpRequestedOptions.Data._OP_DHCP_REQ_IP_ADD = OP_DHCP_REQ_IP_ADD; /* 50 */
170 DHCPOpStart.DhcpRequestedOptions.Data._OP_DHCP_LEASE_TIME = OP_DHCP_LEASE_TIME; /* 51 */
171 DHCPOpStart.DhcpRequestedOptions.Data._OP_DHCP_SERVER_IP = OP_DHCP_SERVER_IP; /* 54 */
172 DHCPOpStart.DhcpRequestedOptions.Data._OP_DHCP_RENEWAL_TIME = OP_DHCP_RENEWAL_TIME; /* 58 */
173 DHCPOpStart.DhcpRequestedOptions.Data._OP_DHCP_REBINDING_TIME = OP_DHCP_REBINDING_TIME; /* 59 */
174 DHCPOpStart.DhcpRequestedOptions.Data._OP_DHCP_CLASS_IDENTIFIER = OP_DHCP_CLASS_IDENTIFIER; /* 60 */
175 DHCPOpStart.DhcpRequestedOptions.Data._OP_DHCP_TFTP_SERVER_NAME = OP_DHCP_TFTP_SERVER_NAME; /* 66 */
176 DHCPOpStart.DhcpRequestedOptions.Data._OP_DHCP_BOOTFILE = OP_DHCP_BOOTFILE; /* 67 */
177 DHCPOpStart.DhcpRequestedOptions.Data._OP_DHCP_PLATFORM_ID = OP_DHCP_PLATFORM_ID; /* 97 */
178 DHCPOpStart.DhcpRequestedOptions.Data.VendorOption128 = 128;
179 DHCPOpStart.DhcpRequestedOptions.Data.VendorOption129 = 129;
180 DHCPOpStart.DhcpRequestedOptions.Data.VendorOption130 = 130;
181 DHCPOpStart.DhcpRequestedOptions.Data.VendorOption131 = 131;
182 DHCPOpStart.DhcpRequestedOptions.Data.VendorOption132 = 132;
183 DHCPOpStart.DhcpRequestedOptions.Data.VendorOption133 = 133, DHCPOpStart.DhcpRequestedOptions.Data.VendorOption134 = 134;
184 DHCPOpStart.DhcpRequestedOptions.Data.VendorOption135 = 135;
185 DHCPOpStart.DhcpPlatformId.Header.OpCode = OP_DHCP_PLATFORM_ID;
186 DHCPOpStart.DhcpPlatformId.Header.Length = DHCPV4_OPTION_LENGTH (DHCPV4_OP_PLATFORM_ID);
187 DHCPOpStart.DhcpNetworkInterface.Header.OpCode = OP_DHCP_NETWORK_ARCH;
188 DHCPOpStart.DhcpNetworkInterface.Header.Length = DHCPV4_OPTION_LENGTH (DHCPV4_OP_NETWORK_INTERFACE);
189 DHCPOpStart.DhcpNetworkInterface.Type = 0;
190 DHCPOpStart.DhcpNetworkInterface.MajorVersion = 0;
191 DHCPOpStart.DhcpNetworkInterface.MinorVersion = 0;
192 DHCPOpStart.DhcpClientArchitecture.Header.OpCode = OP_DHCP_SYSTEM_ARCH;
193 DHCPOpStart.DhcpClientArchitecture.Header.Length = DHCPV4_OPTION_LENGTH (DHCPV4_OP_ARCHITECTURE_TYPE);
194 DHCPOpStart.DhcpClientArchitecture.Type = HTONS (SYS_ARCH);
195 DHCPOpStart.DhcpClassIdentifier.Header.OpCode = OP_DHCP_CLASS_IDENTIFIER;
196 DHCPOpStart.DhcpClassIdentifier.Header.Length = sizeof (DHCPV4_CLASS_ID_DATA);
197 CopyMem (
198 DHCPOpStart.DhcpClassIdentifier.Data.ClassIdentifier,
199 "PXEClient:",
200 sizeof ("PXEClient:")
201 );
202 CopyMem (DHCPOpStart.DhcpClassIdentifier.Data.Lit2, "Arch:", sizeof ("Arch:"));
203 CopyMem (
204 DHCPOpStart.DhcpClassIdentifier.Data.ArchitectureType,
205 "xxxxx",
206 sizeof ("xxxxx")
207 );
208 CopyMem (DHCPOpStart.DhcpClassIdentifier.Data.Lit3, ":", sizeof (":"));
209 CopyMem (DHCPOpStart.DhcpClassIdentifier.Data.InterfaceName, "XXXX", sizeof ("XXXX"));
210 CopyMem (DHCPOpStart.DhcpClassIdentifier.Data.Lit4, ":", sizeof (":"));
211 CopyMem (DHCPOpStart.DhcpClassIdentifier.Data.UndiMajor, "yyy", sizeof ("yyy"));
212 CopyMem (DHCPOpStart.DhcpClassIdentifier.Data.UndiMinor, "xxx", sizeof ("xxx"));
213 DHCPOpStart.End[0] = OP_END;
214 }
215
216 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
217
218 //
219 // DHCPDECLINE option structure
220 //
221 struct opdeclinestr {
222 UINT8 DhcpCookie[4];
223 DHCPV4_OP_MESSAGE_TYPE DhcpMessageType;
224 struct requestopendstr OpDeclineEnd;
225 };
226
227 #define DHCPDECLINEoptions (*(struct opdeclinestr *) DHCPV4_TRANSMIT_BUFFER.options)
228
229 //
230 // DHCPRELEASE option structure
231 //
232 struct opreleasestr {
233 UINT8 DhcpCookie[4];
234 DHCPV4_OP_MESSAGE_TYPE DhcpMessageType;
235 DHCPV4_OP_SERVER_IP DhcServerIpPtr;
236 UINT8 End[1];
237 };
238
239 #define DHCPRELEASEoptions (*(struct opreleasestr *) DHCPV4_TRANSMIT_BUFFER.options)
240
241 //
242 // array of PXE vendor options in which we are interested
243 // value 0 -> not of interest, else value is index into PXE OPTION array
244 // option values from 1 to MAX_OUR_PXE_OPT
245 //
246 STATIC UINT8 ourPXEopts[MAX_OUR_PXE_OPT] = {
247 VEND_PXE_MTFTP_IP_IX, // multicast IP address of bootfile for MTFTP listen
248 VEND_PXE_MTFTP_CPORT_IX, // UDP Port to monitor for MTFTP responses - Intel order
249 VEND_PXE_MTFTP_SPORT_IX, // Server UDP Port for MTFTP open - Intel order
250 VEND_PXE_MTFTP_TMOUT_IX, // Listen timeout - secs
251 VEND_PXE_MTFTP_DELAY_IX, // Transmission timeout - secs
252 VEND_PXE_DISCOVERY_CONTROL_IX, // bit field
253 VEND_PXE_DISCOVERY_MCAST_ADDR_IX, // boot server discovery multicast address
254 VEND_PXE_BOOT_SERVERS_IX, // list of boot servers of form tp(2) cnt(1) ips[cnt]
255 VEND_PXE_BOOT_MENU_IX,
256 VEND_PXE_BOOT_PROMPT_IX,
257 VEND_PXE_MCAST_ADDRS_ALLOC_IX, // not used by client
258 VEND_PXE_CREDENTIAL_TYPES_IX,
259 VEND_13_IX, // not used by client
260 VEND_14_IX, // not used by client
261 VEND_15_IX, // not used by client
262 VEND_16_IX, // not used by client
263 VEND_17_IX, // not used by client
264 VEND_18_IX, // not used by client
265 VEND_19_IX, // not used by client
266 VEND_20_IX, // not used by client
267 VEND_21_IX, // not used by client
268 VEND_22_IX, // not used by client
269 VEND_23_IX, // not used by client
270 VEND_24_IX, // not used by client
271 VEND_25_IX, // not used by client
272 VEND_26_IX, // not used by client
273 VEND_27_IX, // not used by client
274 VEND_28_IX, // not used by client
275 VEND_29_IX, // not used by client
276 VEND_30_IX, // not used by client
277 VEND_31_IX, // not used by client
278 VEND_32_IX, // not used by client
279 VEND_33_IX, // not used by client
280 VEND_34_IX, // not used by client
281 VEND_35_IX, // not used by client
282 VEND_36_IX, // not used by client
283 VEND_37_IX, // not used by client
284 VEND_38_IX, // not used by client
285 VEND_39_IX, // not used by client
286 VEND_40_IX, // not used by client
287 VEND_41_IX, // not used by client
288 VEND_42_IX, // not used by client
289 VEND_43_IX, // not used by client
290 VEND_44_IX, // not used by client
291 VEND_45_IX, // not used by client
292 VEND_46_IX, // not used by client
293 VEND_47_IX, // not used by client
294 VEND_48_IX, // not used by client
295 VEND_49_IX, // not used by client
296 VEND_50_IX, // not used by client
297 VEND_51_IX, // not used by client
298 VEND_52_IX, // not used by client
299 VEND_53_IX, // not used by client
300 VEND_54_IX, // not used by client
301 VEND_55_IX, // not used by client
302 VEND_56_IX, // not used by client
303 VEND_57_IX, // not used by client
304 VEND_58_IX, // not used by client
305 VEND_59_IX, // not used by client
306 VEND_60_IX, // not used by client
307 VEND_61_IX, // not used by client
308 VEND_62_IX, // not used by client
309 VEND_63_IX, // not used by client
310 VEND_64_IX, // not used by client
311 VEND_65_IX, // not used by client
312 VEND_66_IX, // not used by client
313 VEND_67_IX, // not used by client
314 VEND_68_IX, // not used by client
315 VEND_69_IX, // not used by client
316 VEND_70_IX, // not used by client
317 VEND_PXE_BOOT_ITEM_IX
318 };
319
320 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
321
322 //
323 // array of options in which we are interested
324 // value 0 -> not of interest, else value is index into OPTION array
325 // option values from 1 to MAX_OUR_OPT
326 //
327 STATIC UINT8 OurDhcpOptions[MAX_OUR_OPT] = {
328 OP_SUBNET_MASK_IX, // OP_SUBNET_MASK 1 // data is the subnet mask
329 OP_TIME_OFFSET_IX, // OP_TIME_OFFSET 2 // data is the time offset of subnet to UTC in seconds
330 OP_ROUTER_LIST_IX, // OP_ROUTER_LIST 3 // list of routers on subnet
331 OP_TIME_SERVERS_IX, // OP_TIME_SERVERS 4 // list of time servers available
332 OP_NAME_SERVERS_IX, // OP_NAME_SERVERS 5 // list of name servers available
333 OP_DNS_SERVERS_IX, // OP_DNS_SERVERS 6 // list of DNS servers available
334 OP_LOG_SERVERS_IX, // OP_LOG_SERVERS 7
335 OP_COOKIE_SERVERS_IX, // OP_COOKIE_SERVERS 8
336 OP_LPR_SREVERS_IX, // OP_LPR_SREVERS 9
337 OP_IMPRESS_SERVERS_IX, // OP_IMPRESS_SERVERS 10
338 OP_RES_LOC_SERVERS_IX, // OP_RES_LOC_SERVERS 11
339 OP_HOST_NAME_IX, // OP_HOST_NAME 12 // client name
340 OP_BOOT_FILE_SZ_IX, // OP_BOOT_FILE_SZ 13 // number of 512 blocks of boot file
341 OP_DUMP_FILE_IX, // OP_DUMP_FILE 14 // path name of dump file if client crashes
342 OP_DOMAIN_NAME_IX, // OP_DOMAIN_NAME 15 // domain name to use
343 OP_SWAP_SERVER_IX, // OP_SWAP_SERVER 16
344 OP_ROOT_PATH_IX, // OP_ROOT_PATH 17 // path name containing root disk
345 OP_EXTENSION_PATH_IX, // OP_EXTENSION_PATH 18 // name of TFTP downloadable file of form of OP
346 OP_IP_FORWARDING_IX, // OP_IP_FORWARDING 19 // enable/disable IP packet forwarding
347 OP_NON_LOCAL_SRC_RTE_IX, // OP_NON_LOCAL_SRC_RTE 20 // enable/disable non local source routing
348 OP_POLICY_FILTER_IX, // OP_POLICY_FILTER 21 // policy filters for non local source routing
349 OP_MAX_DATAGRAM_SZ_IX, // OP_MAX_DATAGRAM_SZ 22 // maximum datagram reassembly size
350 OP_DEFAULT_TTL_IX, // OP_DEFAULT_TTL 23 // default IP time to live
351 OP_MTU_AGING_TIMEOUT_IX, // OP_MTU_AGING_TIMEOUT 24
352 OP_MTU_SIZES_IX, // OP_MTU_SIZES 25
353 OP_MTU_TO_USE_IX, // OP_MTU_TO_USE 26
354 OP_ALL_SUBNETS_LOCAL_IX, // OP_ALL_SUBNETS_LOCAL 27
355 OP_BROADCAST_ADD_IX, // OP_BROADCAST_ADD 28 // broadcast address used on subnet
356 OP_PERFORM_MASK_DISCOVERY_IX, // OP_PERFORM_MASK_DISCOVERY 29 // perform mask discovery using ICMP
357 OP_RESPOND_TO_MASK_REQ_IX, // OP_RESPOND_TO_MASK_REQ 30 // respond to subnet mask requests using ICMP
358 OP_PERFORM_ROUTER_DISCOVERY_IX, // OP_PERFORM_ROUTER_DISCOVERY 31
359 OP_ROUTER_SOLICIT_ADDRESS_IX, // OP_ROUTER_SOLICIT_ADDRESS 32
360 OP_STATIC_ROUTER_LIST_IX, // OP_STATIC_ROUTER_LIST 33 // list of dest/route pairs
361 OP_USE_ARP_TRAILERS_IX, // OP_USE_ARP_TRAILERS 34
362 OP_ARP_CACHE_TIMEOUT_IX, // OP_ARP_CACHE_TIMEOUT 35
363 OP_ETHERNET_ENCAPSULATION_IX, // OP_ETHERNET_ENCAPSULATION 36 // 0 -> RFC 894, 1 -> IEEE 802.3 (RFC 1042)
364 OP_TCP_DEFAULT_TTL_IX, // OP_TCP_DEFAULT_TTL 37 // default time to live when sending TCP segments
365 OP_TCP_KEEP_ALIVE_INT_IX, // OP_TCP_KEEP_ALIVE_INT 38 // keep alive interval in seconds
366 OP_KEEP_ALIVE_GARBAGE_IX, // OP_KEEP_ALIVE_GARBAGE 39
367 OP_NIS_DOMAIN_NAME_IX, // OP_NIS_DOMAIN_NAME 40
368 OP_NIS_SERVERS_IX, // OP_NIS_SERVERS 41
369 OP_NTP_SERVERS_IX, // OP_NTP_SERVERS 42
370 OP_VENDOR_SPECIFIC_IX, // OP_VENDOR_SPECIFIC 43
371 OP_NBNS_SERVERS_IX, // OP_NBNS_SERVERS 44
372 OP_NBDD_SERVERS_IX, // OP_NBDD_SERVERS 45
373 OP_NETBIOS_NODE_TYPE_IX, // OP_NETBIOS_NODE_TYPE 46
374 OP_NETBIOS_SCOPE_IX, // OP_NETBIOS_SCOPE 47
375 OP_XWINDOW_SYSTEM_FONT_SERVERS_IX, // OP_XWINDOW_SYSTEM_FONT_SERVERS 48
376 OP_XWINDOW_SYSTEM_DISPLAY_MANAGERS_IX, // OP_XWINDOW_SYSTEM_DISPLAY_MANAGERS 49
377 OP_DHCP_REQ_IP_ADD_IX, // OP_DHCP_REQ_IP_ADD 50 // requested IP address - in DHCPDISCOVER
378 OP_DHCP_LEASE_TIME_IX, // OP_DHCP_LEASE_TIME 51 // lease time requested/granted
379 OP_DHCP_OPTION_OVERLOAD_IX, // OP_DHCP_OPTION_OVERLOAD 52 // file/server name/both used to hold options
380 OP_DHCP_MESSAGE_TYPE_IX, // OP_DHCP_MESSAGE_TYPE 53 // message type
381 OP_DHCP_SERVER_IP_IX, // OP_DHCP_SERVER_IP 54 // IP of server
382 OP_DHCP_PARM_REQ_LIST_IX, // OP_DHCP_PARM_REQ_LIST 55 // list of requested parameters
383 OP_DHCP_ERROR_MESSAGE_IX, // OP_DHCP_ERROR_MESSAGE 56 // in DHCPNAK or DECLINE messages
384 OP_DHCP_MAX_MESSAGE_SZ_IX, // OP_DHCP_MAX_MESSAGE_SZ 57 // maximum DHCP message size client will accept
385 OP_DHCP_RENEWAL_TIME_IX, // OP_DHCP_RENEWAL_TIME 58 // time in seconds before transitioning to RENEWING state
386 OP_DHCP_REBINDING_TIME_IX, // OP_DHCP_REBINDING_TIME 59 // time in seconds before transitioning to REBINDING state
387 OP_DHCP_CLASS_IDENTIFIER_IX, // OP_DHCP_CLASS_IDENTIFIER 60
388 OP_DHCP_CLIENT_IDENTIFIER_IX, // OP_DHCP_CLIENT_IDENTIFIER 61
389 OP_RESERVED62_IX, // OP_RESERVED62
390 OP_RESERVED63_IX, // OP_RESERVED63
391 OP_NISPLUS_DOMAIN_NAME_IX, // OP_NISPLUS_DOMAIN_NAME 64
392 OP_NISPLUS_SERVERS_IX, // OP_NISPLUS_SERVERS 65
393 OP_DHCP_TFTP_SERVER_NAME_IX, // OP_DHCP_TFTP_SERVER_NAME 66
394 OP_DHCP_BOOTFILE_IX // OP_DHCP_BOOTFILE 67
395 };
396
397 #define RxBuf ((DHCP_RECEIVE_BUFFER *) (Private->ReceiveBuffers))
398
399 #pragma pack()
400
401 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
402 STATIC
403 CHAR8 *
404 PxeBcLibGetSmbiosString (
405 IN SMBIOS_STRUCTURE_POINTER *Smbios,
406 IN UINT16 StringNumber
407 )
408 /*++
409 Routine description:
410 Return SMBIOS string given the string number.
411
412 Arguments:
413 Smbios - Pointer to SMBIOS structure
414 StringNumber - String number to return. 0 is used to skip all strings and
415 point to the next SMBIOS structure.
416
417 Returns:
418 Pointer to string, or pointer to next SMBIOS strcuture if StringNumber == 0
419 --*/
420 {
421 UINT16 Index;
422 CHAR8 *String;
423
424 //
425 // Skip over formatted section
426 //
427 String = (CHAR8 *) (Smbios->Raw + Smbios->Hdr->Length);
428
429 //
430 // Look through unformated section
431 //
432 for (Index = 1; Index <= StringNumber || StringNumber == 0; Index++) {
433 if (StringNumber == Index) {
434 return String;
435 }
436 //
437 // Skip string
438 //
439 for (; *String != 0; String++)
440 ;
441 String++;
442
443 if (*String == 0) {
444 //
445 // If double NULL then we are done.
446 // Return pointer to next structure in Smbios.
447 // if you pass in a 0 you will always get here
448 //
449 Smbios->Raw = (UINT8 *)++String;
450 return NULL;
451 }
452 }
453
454 return NULL;
455 }
456
457 EFI_STATUS
458 PxeBcLibGetSmbiosSystemGuidAndSerialNumber (
459 IN EFI_GUID *SystemGuid,
460 OUT CHAR8 **SystemSerialNumber
461 )
462 /*++
463
464 Routine Description:
465 This function gets system guid and serial number from the smbios table
466
467 Arguments:
468 SystemGuid - The pointer of returned system guid
469 SystemSerialNumber - The pointer of returned system serial number
470
471 Returns:
472 EFI_SUCCESS - Successfully get the system guid and system serial number
473 EFI_NOT_FOUND - Not find the SMBIOS table
474 --*/
475 {
476 EFI_STATUS Status;
477 SMBIOS_STRUCTURE_TABLE *SmbiosTable;
478 SMBIOS_STRUCTURE_POINTER Smbios;
479 SMBIOS_STRUCTURE_POINTER SmbiosEnd;
480 UINT16 Index;
481
482 Status = EfiGetSystemConfigurationTable (&gEfiSmbiosTableGuid, (VOID **) &SmbiosTable);
483
484 if (EFI_ERROR (Status)) {
485 return EFI_NOT_FOUND;
486 }
487
488 Smbios.Hdr = (SMBIOS_HEADER *) (UINTN) SmbiosTable->TableAddress;
489 SmbiosEnd.Raw = (UINT8 *) (UINTN) (SmbiosTable->TableAddress + SmbiosTable->TableLength);
490
491 for (Index = 0; Index < SmbiosTable->TableLength; Index++) {
492 if (Smbios.Hdr->Type == 1) {
493 if (Smbios.Hdr->Length < 0x19) {
494 //
495 // Older version did not support Guid and Serial number
496 //
497 continue;
498 }
499 //
500 // SMBIOS tables are byte packed so we need to do a byte copy to
501 // prevend alignment faults on Itanium-based platform.
502 //
503 CopyMem (SystemGuid, &Smbios.Type1->Uuid, sizeof (EFI_GUID));
504 *SystemSerialNumber = PxeBcLibGetSmbiosString (&Smbios, Smbios.Type1->SerialNumber);
505
506 return EFI_SUCCESS;
507 }
508 //
509 // Make Smbios point to the next record
510 //
511 PxeBcLibGetSmbiosString (&Smbios, 0);
512
513 if (Smbios.Raw >= SmbiosEnd.Raw) {
514 //
515 // SMBIOS 2.1 incorrectly stated the length of SmbiosTable as 0x1e.
516 // given this we must double check against the lenght of
517 // the structure.
518 //
519 return EFI_SUCCESS;
520 }
521 }
522
523 return EFI_SUCCESS;
524 }
525
526 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
527
528 //
529 // add router list to list
530 //
531 STATIC
532 VOID
533 Ip4AddRouterList (
534 PXE_BASECODE_DEVICE *Private,
535 DHCPV4_OP_IP_LIST *IpListPtr
536 )
537 {
538 EFI_IP_ADDRESS TmpIp;
539 INTN Index;
540 INTN num;
541
542 if (IpListPtr == NULL) {
543 return ;
544 }
545
546 for (Index = 0, num = IpListPtr->Header.Length >> 2; Index < num; ++Index) {
547 CopyMem (&TmpIp, &IpListPtr->IpList[Index], 4);
548 Ip4AddRouter (Private, &TmpIp);
549 }
550 }
551
552 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
553
554 //
555 // send ARP for our IP - fail if someone has it
556 //
557 STATIC
558 BOOLEAN
559 SetStationIP (
560 PXE_BASECODE_DEVICE *Private
561 )
562 {
563 EFI_MAC_ADDRESS DestMac;
564 EFI_STATUS EfiStatus;
565
566 ZeroMem (&DestMac, sizeof DestMac);
567
568 if (GetHwAddr(Private, (EFI_IP_ADDRESS *)&DHCP_REQ_OPTIONS.OpReqIP.Ip, (EFI_MAC_ADDRESS *)&DestMac)
569 || DoArp(Private, (EFI_IP_ADDRESS *)&DHCP_REQ_OPTIONS.OpReqIP.Ip, (EFI_MAC_ADDRESS *)&DestMac) == EFI_SUCCESS) {
570 return FALSE; // somebody else has this IP
571 }
572
573 CopyMem (
574 (EFI_IPv4_ADDRESS *) &Private->EfiBc.Mode->StationIp,
575 &DHCP_REQ_OPTIONS.OpReqIP.Ip,
576 sizeof (EFI_IPv4_ADDRESS)
577 );
578
579 Private->GoodStationIp = TRUE;
580
581 if (!Private->UseIgmpv1Reporting) {
582 return TRUE;
583 }
584
585 if (Private->Igmpv1TimeoutEvent != NULL) {
586 return TRUE;
587 }
588
589 EfiStatus = gBS->CreateEvent (
590 EFI_EVENT_TIMER,
591 EFI_TPL_CALLBACK,
592 NULL,
593 NULL,
594 &Private->Igmpv1TimeoutEvent
595 );
596
597 if (EFI_ERROR (EfiStatus)) {
598 Private->Igmpv1TimeoutEvent = NULL;
599 return TRUE;
600 }
601
602 EfiStatus = gBS->SetTimer (
603 Private->Igmpv1TimeoutEvent,
604 TimerRelative,
605 (UINT64) V1ROUTER_PRESENT_TIMEOUT * 10000000
606 ); /* 400 seconds */
607
608 if (EFI_ERROR (EfiStatus)) {
609 gBS->CloseEvent (Private->Igmpv1TimeoutEvent);
610 Private->Igmpv1TimeoutEvent = NULL;
611 }
612
613 return TRUE;
614 }
615
616 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
617 STATIC
618 VOID
619 AddRouters (
620 PXE_BASECODE_DEVICE *Private,
621 DHCP_RECEIVE_BUFFER *RxBufPtr
622 )
623 {
624 Ip4AddRouterList (
625 Private,
626 (DHCPV4_OP_IP_LIST *) RxBufPtr->OpAdds.PktOptAdds[OP_ROUTER_LIST_IX - 1]
627 );
628 }
629
630 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
631 STATIC
632 EFI_STATUS
633 DoUdpWrite (
634 PXE_BASECODE_DEVICE *Private,
635 EFI_IP_ADDRESS *ServerIpPtr,
636 EFI_PXE_BASE_CODE_UDP_PORT *ServerPortPtr,
637 EFI_IP_ADDRESS *ClientIpPtr,
638 EFI_PXE_BASE_CODE_UDP_PORT *ClientPortPtr
639 )
640 {
641 UINTN Len;
642
643 Len = sizeof DHCPV4_TRANSMIT_BUFFER;
644
645 return UdpWrite (
646 Private,
647 EFI_PXE_BASE_CODE_UDP_OPFLAGS_MAY_FRAGMENT,
648 ServerIpPtr,
649 ServerPortPtr,
650 0,
651 ClientIpPtr,
652 ClientPortPtr,
653 0,
654 0,
655 &Len,
656 Private->TransmitBuffer
657 );
658 }
659
660 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
661
662 //
663 // initialize the DHCP structure
664 //
665 typedef struct {
666 UINT8 x[4];
667 } C4Str;
668
669 STATIC
670 VOID
671 InitDhcpv4TxBuf (
672 PXE_BASECODE_DEVICE *Private
673 )
674 {
675 UINTN HwAddrLen;
676 UINT8 *String;
677 CHAR8 *SystemSerialNumber;
678 EFI_PXE_BASE_CODE_MODE *PxebcMode;
679
680 PxebcMode = Private->EfiBc.Mode;
681
682 ZeroMem (&DHCPV4_TRANSMIT_BUFFER, sizeof (DHCPV4_STRUCT));
683 DHCPV4_TRANSMIT_BUFFER.op = BOOTP_REQUEST;
684 DHCPV4_TRANSMIT_BUFFER.htype = Private->SimpleNetwork->Mode->IfType;
685 DHCPV4_TRANSMIT_BUFFER.flags = HTONS (DHCP_BROADCAST_FLAG);
686 CopyMem (&DHCPV4_OPTIONS_BUFFER, (VOID *) &DHCPOpStart, sizeof (DHCPOpStart));
687
688 //
689 // default to hardware address
690 //
691 HwAddrLen = Private->SimpleNetwork->Mode->HwAddressSize;
692
693 if (HwAddrLen > sizeof DHCPV4_TRANSMIT_BUFFER.chaddr) {
694 HwAddrLen = sizeof DHCPV4_TRANSMIT_BUFFER.chaddr;
695 }
696
697 String = (UINT8 *) &Private->SimpleNetwork->Mode->CurrentAddress;
698
699 if (PxeBcLibGetSmbiosSystemGuidAndSerialNumber (
700 (EFI_GUID *) DHCPV4_OPTIONS_BUFFER.DhcpPlatformId.Guid,
701 &SystemSerialNumber
702 ) == EFI_SUCCESS) {
703 if (PxebcMode->SendGUID) {
704 HwAddrLen = sizeof (EFI_GUID);
705 String = (UINT8 *) DHCPV4_OPTIONS_BUFFER.DhcpPlatformId.Guid;
706 }
707 } else {
708 //
709 // GUID not yet set - send all 0xff's to show programable (via SetVariable)
710 // SetMem(DHCPV4_OPTIONS_BUFFER.DhcpPlatformId.Guid, sizeof(EFI_GUID), 0xff);
711 // GUID not yet set - send all 0's to show not programable
712 //
713 ZeroMem (DHCPV4_OPTIONS_BUFFER.DhcpPlatformId.Guid, sizeof (EFI_GUID));
714 }
715
716 DHCPV4_TRANSMIT_BUFFER.hlen = (UINT8) HwAddrLen;
717 CopyMem (DHCPV4_TRANSMIT_BUFFER.chaddr, String, HwAddrLen);
718
719 CvtNum (
720 SYS_ARCH,
721 (UINT8 *) DHCPV4_OPTIONS_BUFFER.DhcpClassIdentifier.Data.ArchitectureType,
722 sizeof DHCPV4_OPTIONS_BUFFER.DhcpClassIdentifier.Data.ArchitectureType
723 );
724
725 DHCPV4_OPTIONS_BUFFER.DhcpNetworkInterface.Type = Private->NiiPtr->Type;
726 DHCPV4_OPTIONS_BUFFER.DhcpNetworkInterface.MajorVersion = Private->NiiPtr->MajorVer;
727 DHCPV4_OPTIONS_BUFFER.DhcpNetworkInterface.MinorVersion = Private->NiiPtr->MinorVer;
728
729 *(C4Str *) DHCPV4_OPTIONS_BUFFER.DhcpClassIdentifier.Data.InterfaceName = *(C4Str *) Private->NiiPtr->StringId;
730
731 CvtNum (
732 DHCPV4_OPTIONS_BUFFER.DhcpNetworkInterface.MajorVersion,
733 (UINT8 *) DHCPV4_OPTIONS_BUFFER.DhcpClassIdentifier.Data.UndiMajor,
734 sizeof DHCPV4_OPTIONS_BUFFER.DhcpClassIdentifier.Data.UndiMajor
735 );
736
737 CvtNum (
738 DHCPV4_OPTIONS_BUFFER.DhcpNetworkInterface.MinorVersion,
739 (UINT8 *) DHCPV4_OPTIONS_BUFFER.DhcpClassIdentifier.Data.UndiMinor,
740 sizeof DHCPV4_OPTIONS_BUFFER.DhcpClassIdentifier.Data.UndiMinor
741 );
742 }
743
744 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
745 STATIC
746 UINT32
747 DecodePxeOptions (
748 DHCP_RECEIVE_BUFFER *RxBufPtr,
749 UINT8 *ptr,
750 INTN Len
751 )
752 {
753 UINT8 Op;
754 UINT8 *EndPtr;
755 INTN Index;
756 UNION_PTR LocalPtr;
757 UINT32 status;
758
759 status = 0;
760
761 for (EndPtr = ptr + Len; ptr < EndPtr; ptr += Len + 2) {
762 Op = ptr[0];
763 Len = ptr[1];
764
765 switch (Op) {
766 case OP_PAD:
767 Len = -1;
768 break;
769
770 case OP_END:
771 return status;
772
773 default:
774 LocalPtr.BytePtr = ptr;
775 if (Op <= MAX_OUR_PXE_OPT) {
776 Index = ourPXEopts[Op - 1];
777 if (Index) {
778 RxBufPtr->OpAdds.PxeOptAdds[Index - 1] = LocalPtr.OpPtr;
779 status |= 1 << Index;
780 if (Index == VEND_PXE_BOOT_ITEM && LocalPtr.BootItem->Header.Length == 3) {
781 RxBufPtr->OpAdds.Status |= USE_THREE_BYTE;
782 }
783 }
784 }
785 break;
786 }
787 }
788
789 return status;
790 }
791
792 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
793 STATIC
794 VOID
795 DecodeOptions (
796 DHCP_RECEIVE_BUFFER *RxBufPtr,
797 UINT8 *ptr,
798 INTN Len
799 )
800 {
801 UINT8 Op;
802 UINT8 *EndPtr;
803 INTN Index;
804 UNION_PTR LocalPtr;
805
806 for (EndPtr = ptr + Len; ptr < EndPtr; ptr += Len + 2) {
807 Op = ptr[0];
808 Len = ptr[1];
809
810 switch (Op) {
811 case OP_PAD:
812 Len = -1;
813 break;
814
815 case OP_END:
816 return ;
817
818 default:
819 LocalPtr.BytePtr = ptr;
820 if (Op <= MAX_OUR_OPT) {
821 Index = OurDhcpOptions[Op - 1];
822 if (Index) {
823 RxBufPtr->OpAdds.PktOptAdds[Index - 1] = LocalPtr.OpPtr;
824 if (Index == OP_VENDOR_SPECIFIC_IX) {
825 UINT32 status;
826 status = DecodePxeOptions (
827 RxBufPtr,
828 (UINT8 *) LocalPtr.VendorOptions->VendorOptions,
829 LocalPtr.VendorOptions->Header.Length
830 );
831 if (status) {
832 RxBufPtr->OpAdds.Status |= PXE_TYPE;
833 //
834 // check for all the MTFTP info options present - any missing is a nogo
835 //
836 if ((status & WfM11a_OPTS) == WfM11a_OPTS) {
837 RxBufPtr->OpAdds.Status |= WfM11a_TYPE;
838 }
839
840 if (status & DISCOVER_OPTS) {
841 RxBufPtr->OpAdds.Status |= DISCOVER_TYPE;
842 }
843
844 if (status & CREDENTIALS_OPT) {
845 RxBufPtr->OpAdds.Status |= CREDENTIALS_TYPE;
846 }
847 }
848 }
849 }
850 }
851 break;
852 }
853 }
854 }
855
856 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
857 STATIC
858 VOID
859 Parse (
860 DHCP_RECEIVE_BUFFER *RxBufPtr,
861 INTN Len
862 )
863 {
864 UNION_PTR LocalPtr;
865
866 //
867 // initialize
868 //
869 SetMem (&RxBufPtr->OpAdds, sizeof RxBufPtr->OpAdds, 0);
870
871 DecodeOptions (
872 RxBufPtr,
873 RxBufPtr->u.Dhcpv4.options + 4,
874 Len - (sizeof RxBufPtr->u.Dhcpv4 - sizeof RxBufPtr->u.Dhcpv4.options + 4)
875 );
876
877 LocalPtr.OpPtr = RxBufPtr->OpAdds.PktOptAdds[OP_DHCP_OPTION_OVERLOAD_IX - 1];
878
879 if ((LocalPtr.OpPtr) && (LocalPtr.Overload->Overload & OVLD_SRVR_NAME)) {
880 DecodeOptions (RxBufPtr, RxBufPtr->u.Dhcpv4.sname, sizeof RxBufPtr->u.Dhcpv4.sname);
881 }
882
883 if (LocalPtr.OpPtr && (LocalPtr.Overload->Overload & OVLD_FILE)) {
884 DecodeOptions (RxBufPtr, RxBufPtr->u.Dhcpv4.file, sizeof RxBufPtr->u.Dhcpv4.file);
885 } else if (!RxBufPtr->OpAdds.PktOptAdds[OP_DHCP_BOOTFILE_IX - 1] && RxBufPtr->u.Dhcpv4.file[0]) {
886 RxBufPtr->OpAdds.PktOptAdds[OP_DHCP_BOOTFILE_IX - 1] = (DHCPV4_OP_STRUCT *) (RxBufPtr->u.Dhcpv4.file - sizeof (DHCPV4_OP_HEADER));
887
888 RxBufPtr->OpAdds.PktOptAdds[OP_DHCP_BOOTFILE_IX - 1]->Header.Length = (UINT8) AsciiStrLen ((CHAR8 *)RxBufPtr->u.Dhcpv4.file);
889 }
890
891 LocalPtr.OpPtr = RxBufPtr->OpAdds.PktOptAdds[OP_DHCP_CLASS_IDENTIFIER_IX - 1];
892
893 if ((LocalPtr.OpPtr) &&
894 LocalPtr.PxeClassStr->Header.Length >= 9 &&
895 !CompareMem (LocalPtr.PxeClassStr->Class, "PXEClient", 9)
896 ) {
897 RxBufPtr->OpAdds.Status |= PXE_TYPE;
898 }
899 }
900
901 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
902 STATIC
903 VOID
904 CopyParseRxBuf (
905 PXE_BASECODE_DEVICE *Private,
906 INTN RxBufIndex,
907 INTN PacketIndex
908 )
909 {
910 DHCP_RECEIVE_BUFFER *RxBufPtr;
911
912 RxBufPtr = &((DHCP_RECEIVE_BUFFER *) Private->DhcpPacketBuffer)[PacketIndex];
913
914 CopyMem (
915 &RxBufPtr->u.Dhcpv4,
916 &RxBuf[RxBufIndex].u.Dhcpv4,
917 sizeof (RxBuf[RxBufIndex].u.Dhcpv4)
918 );
919
920 Parse (RxBufPtr, sizeof RxBufPtr->u.ReceiveBuffer);
921 }
922
923 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
924 STATIC
925 VOID
926 CopyProxyRxBuf (
927 PXE_BASECODE_DEVICE *Private,
928 INTN RxBufIndex
929 )
930 {
931 Private->EfiBc.Mode->ProxyOfferReceived = TRUE;
932 CopyParseRxBuf (Private, RxBufIndex, PXE_OFFER_INDEX);
933 }
934
935 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
936 STATIC
937 VOID
938 CopyParse (
939 PXE_BASECODE_DEVICE *Private,
940 EFI_PXE_BASE_CODE_PACKET *PacketPtr,
941 EFI_PXE_BASE_CODE_PACKET *NewPacketPtr,
942 INTN Index
943 )
944 {
945 DHCP_RECEIVE_BUFFER *DhcpRxBuf;
946
947 DhcpRxBuf = &((DHCP_RECEIVE_BUFFER *) Private->DhcpPacketBuffer)[Index];
948
949 CopyMem (
950 (EFI_PXE_BASE_CODE_PACKET *) &DhcpRxBuf->u.Dhcpv4,
951 NewPacketPtr,
952 sizeof (*NewPacketPtr)
953 );
954
955 CopyMem (&*PacketPtr, &*NewPacketPtr, sizeof (*NewPacketPtr));
956
957 Parse (DhcpRxBuf, sizeof DhcpRxBuf->u.ReceiveBuffer);
958 }
959
960 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
961 STATIC
962 BOOLEAN
963 AckEdit (
964 DHCP_RECEIVE_BUFFER *DhcpRxBuf
965 )
966 {
967 UNION_PTR LocalPtr;
968
969 LocalPtr.OpPtr = DhcpRxBuf->OpAdds.PktOptAdds[OP_DHCP_MESSAGE_TYPE_IX - 1];
970
971 //
972 // check that an ACK
973 // if a DHCP type, must be DHCPOFFER and must have server id
974 //
975 return (BOOLEAN)
976 (
977 (LocalPtr.OpPtr) &&
978 (LocalPtr.MessageType->Type == DHCPACK) &&
979 DhcpRxBuf->OpAdds.PktOptAdds[OP_DHCP_SERVER_IP_IX - 1]
980 );
981 }
982
983 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
984
985 //
986 // if a discover type packet, make sure all required fields are present
987 //
988 STATIC
989 BOOLEAN
990 DHCPOfferAckEdit (
991 DHCP_RECEIVE_BUFFER *DhcpRxBuf
992 )
993 {
994 PXE_OP_SERVER_LIST *BootServerOpPtr;
995 UNION_PTR LocalPtr;
996
997 if ((DhcpRxBuf->OpAdds.Status & DISCOVER_TYPE) == 0) {
998 return TRUE;
999 }
1000
1001 LocalPtr.OpPtr = DhcpRxBuf->OpAdds.PxeOptAdds[VEND_PXE_DISCOVERY_CONTROL_IX - 1];
1002
1003 if (LocalPtr.OpPtr == NULL) {
1004 LocalPtr.OpPtr = (DHCPV4_OP_STRUCT *) &DefaultDisCtl;
1005 DhcpRxBuf->OpAdds.PxeOptAdds[VEND_PXE_DISCOVERY_CONTROL_IX - 1] = (DHCPV4_OP_STRUCT *) &DefaultDisCtl;
1006 }
1007 //
1008 // make sure all required fields are here
1009 // if mucticast enabled, need multicast address
1010 //
1011 if (!(LocalPtr.DiscoveryControl->ControlBits & DISABLE_MCAST) &&
1012 (!DhcpRxBuf->OpAdds.PxeOptAdds[VEND_PXE_DISCOVERY_MCAST_ADDR_IX - 1] || !IS_MULTICAST (((DHCPV4_OP_STRUCT *) DhcpRxBuf->OpAdds.PxeOptAdds[VEND_PXE_DISCOVERY_MCAST_ADDR_IX - 1])->Data))
1013 ) {
1014 return FALSE;
1015 //
1016 // missing required field
1017 //
1018 }
1019 //
1020 // if a list, it better be good
1021 //
1022 BootServerOpPtr = (PXE_OP_SERVER_LIST *) DhcpRxBuf->OpAdds.PxeOptAdds[VEND_PXE_BOOT_SERVERS_IX - 1];
1023
1024 if (BootServerOpPtr != NULL) {
1025 PXE_SERVER_LIST *BootServerListPtr;
1026 INTN ServerListLen;
1027 INTN ServerEntryLen;
1028
1029 BootServerListPtr = BootServerOpPtr->ServerList;
1030 ServerListLen = BootServerOpPtr->Header.Length;
1031
1032 do {
1033 EFI_IPv4_ADDRESS *IpListPtr;
1034 INTN IpCnt;
1035
1036 IpCnt = BootServerListPtr->u.Ipv4List.IpCount;
1037
1038 ServerEntryLen = sizeof (PXEV4_SERVER_LIST) + 2 + (IpCnt - 1) * sizeof (EFI_IPv4_ADDRESS);
1039
1040 if (ServerListLen < ServerEntryLen) {
1041 //
1042 // missing required field
1043 //
1044 return FALSE;
1045 }
1046
1047 IpListPtr = BootServerListPtr->u.Ipv4List.IpList;
1048
1049 while (IpCnt--) {
1050 if (IS_MULTICAST (IpListPtr)) {
1051 //
1052 // missing required field
1053 //
1054 return FALSE;
1055 } else {
1056 ++IpListPtr;
1057 }
1058 }
1059
1060 BootServerListPtr = (PXE_SERVER_LIST *) IpListPtr;
1061 } while (ServerListLen -= ServerEntryLen);
1062 }
1063 //
1064 // else there must be a list if use list enabled or multicast and
1065 // broadcast disabled
1066 //
1067 else if ((LocalPtr.DiscoveryControl->ControlBits & USE_ACCEPT_LIST) ||
1068 ((LocalPtr.DiscoveryControl->ControlBits & (DISABLE_MCAST | DISABLE_BCAST)) == (DISABLE_MCAST | DISABLE_BCAST))
1069 ) {
1070 //
1071 // missing required field
1072 //
1073 return FALSE;
1074 }
1075 //
1076 // if not USE_BOOTFILE or no bootfile given, must have menu stuff
1077 //
1078 if (!(LocalPtr.DiscoveryControl->ControlBits & USE_BOOTFILE) ||
1079 !DhcpRxBuf->OpAdds.PktOptAdds[OP_DHCP_BOOTFILE_IX - 1]
1080 ) {
1081 INTN MenuLth;
1082
1083 LocalPtr.OpPtr = DhcpRxBuf->OpAdds.PxeOptAdds[VEND_PXE_BOOT_MENU_IX - 1];
1084
1085 if (LocalPtr.OpPtr == NULL || !DhcpRxBuf->OpAdds.PxeOptAdds[VEND_PXE_BOOT_PROMPT_IX - 1]) {
1086 //
1087 // missing required field
1088 //
1089 return FALSE;
1090 }
1091 //
1092 // make sure menu valid
1093 //
1094 MenuLth = LocalPtr.BootMenu->Header.Length;
1095 LocalPtr.BootMenuItem = LocalPtr.BootMenu->MenuItem;
1096
1097 do {
1098 INTN MenuItemLen;
1099
1100 MenuItemLen = LocalPtr.BootMenuItem->DataLen;
1101
1102 if (MenuItemLen == 0) {
1103 //
1104 // missing required field
1105 //
1106 return FALSE;
1107 }
1108
1109 MenuItemLen += sizeof (*LocalPtr.BootMenuItem) - sizeof (LocalPtr.BootMenuItem->Data);
1110
1111 MenuLth -= MenuItemLen;
1112 LocalPtr.BytePtr += MenuItemLen;
1113 } while (MenuLth > 0);
1114
1115 if (MenuLth != 0) {
1116 //
1117 // missing required field
1118 //
1119 return FALSE;
1120 }
1121 }
1122
1123 if (!DhcpRxBuf->OpAdds.PxeOptAdds[VEND_PXE_BOOT_ITEM_IX - 1]) {
1124 DhcpRxBuf->OpAdds.PxeOptAdds[VEND_PXE_BOOT_ITEM_IX - 1] = (DHCPV4_OP_STRUCT *) &DefaultBootItem;
1125 }
1126
1127 return TRUE;
1128 }
1129
1130 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
1131 STATIC
1132 BOOLEAN
1133 DHCPAckEdit (
1134 DHCP_RECEIVE_BUFFER *RxBufPtr
1135 )
1136 {
1137 return (BOOLEAN) (DHCPOfferAckEdit (RxBufPtr) ? AckEdit (RxBufPtr) : FALSE);
1138 }
1139
1140 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
1141
1142 //
1143 // get an offer/ack
1144 //
1145 STATIC
1146 EFI_STATUS
1147 GetOfferAck (
1148 PXE_BASECODE_DEVICE *Private,
1149 BOOLEAN (*ExtraEdit)(DHCP_RECEIVE_BUFFER *DhcpRxBuf),
1150 UINT16 OpFlags, // for Udp read
1151 EFI_IP_ADDRESS *ServerIpPtr,
1152 EFI_PXE_BASE_CODE_UDP_PORT *ServerPortPtr,
1153 EFI_IP_ADDRESS *ClientIpPtr,
1154 EFI_PXE_BASE_CODE_UDP_PORT *ClientPortPtr,
1155 DHCP_RECEIVE_BUFFER *DhcpRxBuf,
1156 EFI_EVENT TimeoutEvent
1157 )
1158 /*++
1159 Routine description:
1160 Wait for an OFFER/ACK packet.
1161
1162 Parameters:
1163 Private := Pointer to PxeBc interface
1164 ExtraEdit := Pointer to extra option checking function
1165 OpFlags := UdpRead() option flags
1166 ServerIpPtr :=
1167 ServerPortPtr :=
1168 ClientIpPtr :=
1169 ClientPortPtr :=
1170 DhcpRxBuf :=
1171 TimeoutEvent :=
1172
1173 Returns:
1174 --*/
1175 {
1176 EFI_IP_ADDRESS ServerIp;
1177 EFI_STATUS StatCode;
1178 INTN RxBufLen;
1179
1180 for (;;) {
1181 //
1182 // Wait until we get a UDP packet.
1183 //
1184 ZeroMem (&ServerIp, sizeof (EFI_IP_ADDRESS));
1185 RxBufLen = sizeof RxBuf[0].u.ReceiveBuffer;
1186
1187 if ((StatCode = UdpRead (
1188 Private,
1189 OpFlags,
1190 ClientIpPtr,
1191 ClientPortPtr,
1192 ServerIpPtr,
1193 ServerPortPtr,
1194 0,
1195 0,
1196 (UINTN *) &RxBufLen,
1197 &DhcpRxBuf->u.Dhcpv4,
1198 TimeoutEvent
1199 )) != EFI_SUCCESS) {
1200 if (StatCode == EFI_TIMEOUT) {
1201 StatCode = EFI_NO_RESPONSE;
1202 }
1203
1204 break;
1205 }
1206 //
1207 // got a packet - see if a good offer
1208 //
1209 if (DhcpRxBuf->u.Dhcpv4.op != BOOTP_REPLY) {
1210 continue;
1211 }
1212
1213 if (DhcpRxBuf->u.Dhcpv4.xid != DHCPV4_TRANSMIT_BUFFER.xid) {
1214 continue;
1215 }
1216
1217 if (*(UINT32 *) DHCPV4_TRANSMIT_BUFFER.options != * (UINT32 *) DhcpRxBuf->u.Dhcpv4.options) {
1218 continue;
1219 }
1220
1221 if (*(UINT8 *) &DhcpRxBuf->u.Dhcpv4.yiaddr > 223) {
1222 continue;
1223 }
1224
1225 if (CompareMem (
1226 DhcpRxBuf->u.Dhcpv4.chaddr,
1227 DHCPV4_TRANSMIT_BUFFER.chaddr,
1228 sizeof DhcpRxBuf->u.Dhcpv4.chaddr
1229 )) {
1230 //
1231 // no good
1232 //
1233 continue;
1234 }
1235
1236 Parse (DhcpRxBuf, RxBufLen);
1237
1238 if (!(*ExtraEdit) (DhcpRxBuf)) {
1239 continue;
1240 }
1241 //
1242 // Good DHCP packet.
1243 //
1244 StatCode = EFI_SUCCESS;
1245 break;
1246 }
1247
1248 return StatCode;
1249 }
1250
1251 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
1252
1253 //
1254 // get DHCPOFFER's
1255 //
1256 STATIC
1257 EFI_STATUS
1258 GetOffers (
1259 PXE_BASECODE_DEVICE *Private
1260 )
1261 {
1262 EFI_IP_ADDRESS ClientIp;
1263 EFI_IP_ADDRESS ServerIp;
1264 EFI_STATUS StatCode;
1265 EFI_EVENT TimeoutEvent;
1266 INTN NumOffers;
1267 INTN Index;
1268
1269 //
1270 //
1271 //
1272 ZeroMem (&ServerIp, sizeof (EFI_IP_ADDRESS));
1273 NumOffers = 0;
1274
1275 for (Index = 0; Index < (sizeof Private->ServerCount) / sizeof Private->ServerCount[0]; ++Index) {
1276 Private->ServerCount[Index] = 0;
1277 Private->GotProxy[Index] = 0;
1278 }
1279
1280 Private->GotBootp = 0;
1281 //
1282 // these we throw away
1283 //
1284 Private->GotProxy[DHCP_ONLY_IX] = 1;
1285 StatCode = gBS->CreateEvent (
1286 EFI_EVENT_TIMER,
1287 EFI_TPL_CALLBACK,
1288 NULL,
1289 NULL,
1290 &TimeoutEvent
1291 );
1292
1293 if (EFI_ERROR (StatCode)) {
1294 return StatCode;
1295 }
1296
1297 StatCode = gBS->SetTimer (
1298 TimeoutEvent,
1299 TimerRelative,
1300 Private->Timeout * 10000000 + 1000000
1301 );
1302
1303 if (EFI_ERROR (StatCode)) {
1304 gBS->CloseEvent (TimeoutEvent);
1305 return StatCode;
1306 }
1307 //
1308 // get offers
1309 //
1310 for (;;) {
1311 DHCP_RECEIVE_BUFFER *DhcpRxBuf;
1312 UNION_PTR LocalPtr;
1313
1314 DhcpRxBuf = &RxBuf[NumOffers];
1315
1316 if ((
1317 StatCode = GetOfferAck (
1318 Private,
1319 DHCPOfferAckEdit,
1320 EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_IP |
1321 EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_DEST_IP |
1322 EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_PORT,
1323 &ServerIp,
1324 &DhcpServerPort,
1325 &ClientIp,
1326 &DHCPClientPort,
1327 DhcpRxBuf,
1328 TimeoutEvent
1329 )
1330 ) != EFI_SUCCESS
1331 ) {
1332 break;
1333 }
1334
1335 LocalPtr.OpPtr = DhcpRxBuf->OpAdds.PktOptAdds[OP_DHCP_MESSAGE_TYPE_IX - 1];
1336
1337 //
1338 // check type of offer
1339 //
1340 if (LocalPtr.OpPtr == NULL) {
1341 //
1342 // bootp - we only need one and make sure has bootfile
1343 //
1344 if (Private->GotBootp || !DhcpRxBuf->OpAdds.PktOptAdds[OP_DHCP_BOOTFILE_IX - 1]) {
1345 continue;
1346 }
1347
1348 Private->GotBootp = (UINT8) (NumOffers + 1);
1349 }
1350 //
1351 // if a DHCP type, must be DHCPOFFER and must have server id
1352 //
1353 else if (LocalPtr.MessageType->Type != DHCPOFFER || !DhcpRxBuf->OpAdds.PktOptAdds[OP_DHCP_SERVER_IP_IX - 1]) {
1354 continue;
1355 } else {
1356 INTN TypeIx;
1357
1358 //
1359 // get type - PXE10, WfM11a, or BINL
1360 //
1361 if (DhcpRxBuf->OpAdds.Status & DISCOVER_TYPE) {
1362 TypeIx = PXE10_IX;
1363 } else if (DhcpRxBuf->OpAdds.Status & WfM11a_TYPE) {
1364 //
1365 // WfM - make sure it has a bootfile
1366 //
1367 if (!DhcpRxBuf->OpAdds.PktOptAdds[OP_DHCP_BOOTFILE_IX - 1]) {
1368 continue;
1369 }
1370
1371 TypeIx = WfM11a_IX;
1372 } else {
1373 TypeIx = (DhcpRxBuf->OpAdds.Status & PXE_TYPE) ? BINL_IX : DHCP_ONLY_IX;
1374 }
1375 //
1376 // check DHCP or proxy
1377 //
1378 if (DhcpRxBuf->u.Dhcpv4.yiaddr == 0) {
1379 //
1380 // proxy - only need one of each type if not BINL
1381 // and must have at least PXE_TYPE
1382 //
1383 if (TypeIx == BINL_IX) {
1384 Private->BinlProxies[Private->GotProxy[BINL_IX]++] = (UINT8) NumOffers;
1385 } else if (Private->GotProxy[TypeIx]) {
1386 continue;
1387 } else {
1388 Private->GotProxy[TypeIx] = (UINT8) (NumOffers + 1);
1389 }
1390 } else {
1391 Private->OfferCount[TypeIx][Private->ServerCount[TypeIx]++] = (UINT8) NumOffers;
1392 }
1393 }
1394
1395 if (++NumOffers == MAX_OFFERS) {
1396 break;
1397 }
1398 }
1399
1400 gBS->CloseEvent (TimeoutEvent);
1401 Private->NumOffersReceived = NumOffers;
1402
1403 return (Private->NumOffersReceived) ? EFI_SUCCESS : EFI_NO_RESPONSE;
1404 }
1405
1406 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
1407
1408 //
1409 // send DHCPDECLINE
1410 //
1411 STATIC
1412 VOID
1413 DeclineOffer (
1414 PXE_BASECODE_DEVICE *Private
1415 )
1416 {
1417 EFI_PXE_BASE_CODE_MODE *PxebcMode;
1418 UINT16 SaveSecs;
1419
1420 PxebcMode = Private->EfiBc.Mode;
1421 SaveSecs = DHCPV4_TRANSMIT_BUFFER.secs;
1422
1423 DHCPV4_TRANSMIT_BUFFER.secs = 0;
1424 DHCPV4_TRANSMIT_BUFFER.flags = 0;
1425 SetMem (
1426 DHCPV4_TRANSMIT_BUFFER.options + sizeof (struct opdeclinestr),
1427 sizeof (DHCPOpStart) - sizeof (struct opdeclinestr),
1428 OP_PAD
1429 );
1430 DHCPDECLINEoptions.DhcpMessageType.Type = DHCPDECLINE;
1431 CopyMem (&DHCPDECLINEoptions.OpDeclineEnd, &DHCP_REQ_OPTIONS, sizeof (struct requestopendstr));
1432 // DHCPDECLINEoptions.OpDeclineEnd = DHCP_REQ_OPTIONS;
1433
1434 {
1435 EFI_IP_ADDRESS TmpIp;
1436
1437 CopyMem (&TmpIp, &DHCP_REQ_OPTIONS.DhcServerIpPtr.Ip, sizeof TmpIp);
1438
1439 DoUdpWrite (
1440 Private,
1441 &TmpIp,
1442 &DhcpServerPort,
1443 &PxebcMode->StationIp,
1444 &DHCPClientPort
1445 );
1446 }
1447
1448 InitDhcpv4TxBuf (Private);
1449 DHCPV4_TRANSMIT_BUFFER.secs = SaveSecs;
1450 Private->GoodStationIp = FALSE;
1451 }
1452
1453 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
1454
1455 //
1456 // send DHCPRELEASE
1457 //
1458 STATIC
1459 BOOLEAN
1460 Release (
1461 PXE_BASECODE_DEVICE *Private
1462 )
1463 {
1464 EFI_PXE_BASE_CODE_MODE *PxebcMode;
1465 UINT16 SaveSecs;
1466 DHCPV4_OP_SERVER_IP *Point;
1467
1468 PxebcMode = Private->EfiBc.Mode;
1469 SaveSecs = DHCPV4_TRANSMIT_BUFFER.secs;
1470 DHCPV4_TRANSMIT_BUFFER.secs = 0;
1471
1472 SetMem (
1473 DHCPV4_TRANSMIT_BUFFER.options + sizeof (struct opreleasestr),
1474 sizeof (DHCPOpStart) - sizeof (struct opreleasestr),
1475 OP_PAD
1476 );
1477
1478 DHCPRELEASEoptions.DhcpMessageType.Type = DHCPRELEASE;
1479 Point = (DHCPV4_OP_SERVER_IP *) DHCPV4_ACK_BUFFER.OpAdds.PktOptAdds[OP_DHCP_SERVER_IP_IX - 1];
1480 CopyMem (
1481 &DHCPRELEASEoptions.DhcServerIpPtr,
1482 &Point,
1483 sizeof DHCPRELEASEoptions.DhcServerIpPtr
1484 );
1485
1486 DHCPRELEASEoptions.End[0] = OP_END;
1487
1488 {
1489 EFI_IP_ADDRESS TmpIp;
1490
1491 CopyMem (&TmpIp, &DHCPRELEASEoptions.DhcServerIpPtr.Ip, sizeof TmpIp);
1492
1493 DoUdpWrite (
1494 Private,
1495 &TmpIp,
1496 &DhcpServerPort,
1497 &PxebcMode->StationIp,
1498 &DHCPClientPort
1499 );
1500 }
1501
1502 InitDhcpv4TxBuf (Private);
1503
1504 DHCPV4_TRANSMIT_BUFFER.secs = SaveSecs;
1505 Private->GoodStationIp = FALSE;
1506 return FALSE;
1507 }
1508
1509 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
1510 STATIC
1511 BOOLEAN
1512 GetBINLAck (
1513 PXE_BASECODE_DEVICE *Private,
1514 EFI_IP_ADDRESS *ServerIpPtr
1515 )
1516 {
1517 DHCP_RECEIVE_BUFFER *DhcpRxBuf;
1518 EFI_STATUS StatCode;
1519 EFI_EVENT TimeoutEvent;
1520
1521 //
1522 //
1523 //
1524 StatCode = gBS->CreateEvent (
1525 EFI_EVENT_TIMER,
1526 EFI_TPL_CALLBACK,
1527 NULL,
1528 NULL,
1529 &TimeoutEvent
1530 );
1531
1532 if (EFI_ERROR (StatCode)) {
1533 return FALSE;
1534 }
1535
1536 StatCode = gBS->SetTimer (
1537 TimeoutEvent,
1538 TimerRelative,
1539 Private->Timeout * 10000000 + 1000000
1540 );
1541
1542 if (EFI_ERROR (StatCode)) {
1543 gBS->CloseEvent (TimeoutEvent);
1544 return FALSE;
1545 }
1546 //
1547 //
1548 //
1549 DhcpRxBuf = &PXE_BINL_BUFFER;
1550
1551 for (;;) {
1552 EFI_PXE_BASE_CODE_UDP_PORT BINLSrvPort;
1553
1554 BINLSrvPort = 0;
1555
1556 if (GetOfferAck (
1557 Private,
1558 AckEdit,
1559 EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_PORT,
1560 ServerIpPtr,
1561 &BINLSrvPort,
1562 &Private->EfiBc.Mode->StationIp,
1563 &PSEUDO_DHCP_CLIENT_PORT,
1564 DhcpRxBuf,
1565 TimeoutEvent
1566 ) != EFI_SUCCESS) {
1567 break;
1568 }
1569 //
1570 // make sure from whom we wanted
1571 //
1572 if (!DhcpRxBuf->u.Dhcpv4.yiaddr && !CompareMem (
1573 &ServerIpPtr->v4,
1574 &((DHCPV4_OP_SERVER_IP *) DhcpRxBuf->OpAdds.PktOptAdds[OP_DHCP_SERVER_IP_IX - 1])->Ip,
1575 sizeof (ServerIpPtr->v4)
1576 )) {
1577 gBS->CloseEvent (TimeoutEvent);
1578 //
1579 // got an ACK from server
1580 //
1581 return TRUE;
1582 }
1583 }
1584
1585 gBS->CloseEvent (TimeoutEvent);
1586 return FALSE;
1587 }
1588
1589 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
1590
1591 //
1592 // make sure we can get BINL
1593 // send DHCPREQUEST to PXE server
1594 //
1595 STATIC
1596 BOOLEAN
1597 TryBINL (
1598 PXE_BASECODE_DEVICE *Private,
1599 INTN OfferIx
1600 )
1601 {
1602 DHCP_RECEIVE_BUFFER *DhcpRxBuf;
1603 EFI_IP_ADDRESS ServerIp;
1604 UINT16 SaveSecs;
1605 INTN Index;
1606
1607 DhcpRxBuf = &RxBuf[OfferIx];
1608
1609 //
1610 // send DHCP request
1611 // if fail return false
1612 //
1613 CopyMem (
1614 ((EFI_IPv4_ADDRESS *) &ServerIp),
1615 &((DHCPV4_OP_SERVER_IP *) DhcpRxBuf->OpAdds.PktOptAdds[OP_DHCP_SERVER_IP_IX - 1])->Ip,
1616 sizeof (EFI_IPv4_ADDRESS)
1617 );
1618
1619 //
1620 // client IP address - filled in by client if it knows it
1621 //
1622 CopyMem (
1623 ((EFI_IPv4_ADDRESS *) &DHCPV4_TRANSMIT_BUFFER.ciaddr),
1624 &DHCP_REQ_OPTIONS.OpReqIP.Ip,
1625 sizeof (EFI_IPv4_ADDRESS)
1626 );
1627
1628 SetMem (&DHCP_REQ_OPTIONS, sizeof DHCP_REQ_OPTIONS, OP_PAD);
1629 DHCPV4_TRANSMIT_BUFFER.flags = 0;
1630 DHCPV4_OPTIONS_BUFFER.End[0] = OP_END;
1631 AddRouters (Private, DhcpRxBuf);
1632 SaveSecs = DHCPV4_TRANSMIT_BUFFER.secs;
1633
1634 for (Index = 0; Index < 3; Private->TotalSeconds = (UINT16) (Private->TotalSeconds + Private->Timeout), ++Index) {
1635 DHCPV4_TRANSMIT_BUFFER.secs = HTONS (Private->TotalSeconds);
1636
1637 //
1638 // unicast DHCPREQUEST to PXE server
1639 //
1640 if (DoUdpWrite (
1641 Private,
1642 &ServerIp,
1643 &PseudoDhcpServerPort,
1644 (EFI_IP_ADDRESS *) &DHCPV4_TRANSMIT_BUFFER.ciaddr,
1645 &PSEUDO_DHCP_CLIENT_PORT
1646 ) != EFI_SUCCESS) {
1647 break;
1648 }
1649
1650 if (!GetBINLAck (Private, &ServerIp)) {
1651 continue;
1652 }
1653 //
1654 // early exit failures
1655 // make sure a good ACK
1656 //
1657 if (!DHCPOfferAckEdit (&PXE_BINL_BUFFER) || (
1658 !(PXE_BINL_BUFFER.OpAdds.Status & DISCOVER_TYPE) && !PXE_BINL_BUFFER.OpAdds.PktOptAdds[OP_DHCP_BOOTFILE_IX - 1]
1659 )
1660 ) {
1661 break;
1662 }
1663
1664 Private->EfiBc.Mode->ProxyOfferReceived = TRUE;
1665 return TRUE;
1666 }
1667 //
1668 // failed - reset seconds field, etc.
1669 //
1670 Private->EfiBc.Mode->RouteTableEntries = 0;
1671 //
1672 // reset
1673 //
1674 DHCPV4_TRANSMIT_BUFFER.secs = SaveSecs;
1675 return FALSE;
1676 }
1677
1678 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
1679 STATIC
1680 BOOLEAN
1681 TryFinishBINL (
1682 PXE_BASECODE_DEVICE *Private,
1683 INTN OfferIx
1684 )
1685 {
1686 if (TryBINL (Private, OfferIx)) {
1687 return TRUE;
1688 }
1689
1690 return Release (Private);
1691 }
1692
1693 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
1694 STATIC
1695 BOOLEAN
1696 TryFinishProxyBINL (
1697 PXE_BASECODE_DEVICE *Private
1698 )
1699 {
1700 INTN Index;
1701
1702 for (Index = 0; Index < Private->GotProxy[BINL_IX]; ++Index) {
1703 if (TryBINL (Private, Private->BinlProxies[Index])) {
1704 return TRUE;
1705 }
1706 }
1707
1708 return Release (Private);
1709 }
1710
1711 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
1712
1713 //
1714 // try to finish DORA - send DHCP request, wait for ACK, check with ARP
1715 //
1716 STATIC
1717 BOOLEAN
1718 TryFinishDORA (
1719 PXE_BASECODE_DEVICE *Private,
1720 INTN OfferIx
1721 )
1722 {
1723 DHCP_RECEIVE_BUFFER *DhcpRxBuf;
1724 EFI_IP_ADDRESS ClientIp;
1725 EFI_IP_ADDRESS ServerIp;
1726 EFI_STATUS StatCode;
1727 UNION_PTR LocalPtr;
1728 EFI_EVENT TimeoutEvent;
1729
1730 //
1731 // send DHCP request
1732 // if fail return false
1733 //
1734 DhcpRxBuf = &DHCPV4_ACK_BUFFER;
1735 DHCPV4_OPTIONS_BUFFER.DhcpMessageType.Type = DHCPREQUEST;
1736 CopyMem (&DHCP_REQ_OPTIONS, &RequestOpEndStr, sizeof (RequestOpEndStr));
1737 // DHCP_REQ_OPTIONS = RequestOpEndStr;
1738 DHCP_REQ_OPTIONS.OpReqIP.Ip = *(EFI_IPv4_ADDRESS *) &RxBuf[OfferIx].u.Dhcpv4.yiaddr;
1739
1740 CopyMem (
1741 &DHCP_REQ_OPTIONS.DhcServerIpPtr.Ip,
1742 &((DHCPV4_OP_SERVER_IP *) RxBuf[OfferIx].OpAdds.PktOptAdds[OP_DHCP_SERVER_IP_IX - 1])->Ip,
1743 sizeof DHCP_REQ_OPTIONS.DhcServerIpPtr.Ip
1744 );
1745
1746 CopyMem (
1747 Private->EfiBc.Mode->SubnetMask.Addr,
1748 &DefaultSubnetMask,
1749 4
1750 );
1751
1752 //
1753 // broadcast DHCPREQUEST
1754 //
1755 if (DoUdpWrite (
1756 Private,
1757 &BroadcastIP,
1758 &DhcpServerPort,
1759 (EFI_IP_ADDRESS *) &DHCPV4_TRANSMIT_BUFFER.ciaddr,
1760 &DHCPClientPort
1761 ) != EFI_SUCCESS) {
1762 return FALSE;
1763 }
1764 //
1765 //
1766 //
1767 StatCode = gBS->CreateEvent (
1768 EFI_EVENT_TIMER,
1769 EFI_TPL_CALLBACK,
1770 NULL,
1771 NULL,
1772 &TimeoutEvent
1773 );
1774
1775 if (EFI_ERROR (StatCode)) {
1776 return FALSE;
1777 }
1778
1779 StatCode = gBS->SetTimer (
1780 TimeoutEvent,
1781 TimerPeriodic,
1782 Private->Timeout * 10000000 + 1000000
1783 );
1784
1785 if (EFI_ERROR (StatCode)) {
1786 gBS->CloseEvent (TimeoutEvent);
1787 return FALSE;
1788 }
1789 //
1790 // wait for ACK
1791 //
1792 for (;;) {
1793 if (GetOfferAck (
1794 Private,
1795 DHCPAckEdit,
1796 EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_DEST_IP | EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_IP,
1797 &ServerIp,
1798 &DhcpServerPort,
1799 &ClientIp,
1800 &DHCPClientPort,
1801 DhcpRxBuf,
1802 TimeoutEvent
1803 ) != EFI_SUCCESS) {
1804 break;
1805 }
1806 //
1807 // check type of response - need DHCPACK
1808 //
1809 if (CompareMem (
1810 &DHCP_REQ_OPTIONS.OpReqIP.Ip,
1811 &DhcpRxBuf->u.Dhcpv4.yiaddr,
1812 sizeof (EFI_IPv4_ADDRESS)
1813 ) || CompareMem (
1814 &DHCP_REQ_OPTIONS.DhcServerIpPtr.Ip,
1815 &((DHCPV4_OP_SERVER_IP *) DhcpRxBuf->OpAdds.PktOptAdds[OP_DHCP_SERVER_IP_IX - 1])->Ip,
1816 sizeof (EFI_IPv4_ADDRESS)
1817 )) {
1818 continue;
1819 }
1820 //
1821 // got ACK
1822 // check with ARP that IP unused - good return true
1823 //
1824 if (!SetStationIP (Private)) {
1825 //
1826 // fail - send DHCPDECLINE and return false
1827 //
1828 DeclineOffer (Private);
1829 break;
1830 }
1831
1832 LocalPtr.OpPtr = DHCPV4_ACK_BUFFER.OpAdds.PktOptAdds[OP_SUBNET_MASK_IX - 1];
1833
1834 if (LocalPtr.OpPtr != NULL) {
1835 CopyMem (
1836 (EFI_IPv4_ADDRESS *) &Private->EfiBc.Mode->SubnetMask,
1837 &LocalPtr.SubnetMaskStr->Ip,
1838 sizeof (EFI_IPv4_ADDRESS)
1839 );
1840 }
1841
1842 AddRouters (Private, DhcpRxBuf);
1843 gBS->CloseEvent (TimeoutEvent);
1844 return TRUE;
1845 }
1846
1847 gBS->CloseEvent (TimeoutEvent);
1848 return FALSE;
1849 }
1850
1851 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
1852
1853 //
1854 // try a DHCP server of appropriate type
1855 //
1856 STATIC
1857 BOOLEAN
1858 TryDHCPFinishDORA (
1859 PXE_BASECODE_DEVICE *Private,
1860 INTN TypeIx
1861 )
1862 {
1863 INTN Index;
1864
1865 //
1866 // go through the DHCP servers of the requested type
1867 //
1868 for (Index = 0; Index < Private->ServerCount[TypeIx]; ++Index) {
1869 if (TryFinishDORA (Private, Index = Private->OfferCount[TypeIx][Index])) {
1870 if (TypeIx == BINL_IX && !TryFinishBINL (Private, Index)) {
1871 continue;
1872 }
1873
1874 return TRUE;
1875 }
1876 }
1877
1878 return FALSE;
1879 }
1880
1881 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
1882
1883 //
1884 // try a DHCP only server and a proxy of appropriate type
1885 //
1886 STATIC
1887 BOOLEAN
1888 TryProxyFinishDORA (
1889 PXE_BASECODE_DEVICE *Private,
1890 INTN TypeIx
1891 )
1892 {
1893 INTN Index;
1894
1895 if (!Private->GotProxy[TypeIx]) {
1896 //
1897 // no proxies of the type wanted
1898 //
1899 return FALSE;
1900 }
1901 //
1902 // go through the DHCP only servers
1903 //
1904 for (Index = 0; Index < Private->ServerCount[DHCP_ONLY_IX]; ++Index) {
1905 if (TryFinishDORA (Private, Private->OfferCount[DHCP_ONLY_IX][Index])) {
1906 if (TypeIx != BINL_IX) {
1907 CopyProxyRxBuf (Private, Private->GotProxy[TypeIx] - 1);
1908 } else if (!TryFinishProxyBINL (Private)) {
1909 //
1910 // if didn't work with this DHCP, won't work with any
1911 //
1912 return FALSE;
1913 }
1914
1915 return TRUE;
1916 }
1917 }
1918
1919 return FALSE;
1920 }
1921
1922 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
1923
1924 //
1925 // getting to the bottom of the barrel
1926 //
1927 STATIC
1928 BOOLEAN
1929 TryAnyWithBootfileFinishDORA (
1930 PXE_BASECODE_DEVICE *Private
1931 )
1932 {
1933 //
1934 // try a DHCP only server who has a bootfile
1935 //
1936 UNION_PTR LocalPtr;
1937 INTN Index;
1938
1939 for (Index = 0; Index < Private->ServerCount[DHCP_ONLY_IX]; ++Index) {
1940 INTN offer;
1941
1942 offer = Private->OfferCount[DHCP_ONLY_IX][Index];
1943
1944 if (RxBuf[offer].OpAdds.PktOptAdds[OP_DHCP_BOOTFILE_IX - 1] && TryFinishDORA (Private, offer)) {
1945 return TRUE;
1946 }
1947 }
1948 //
1949 // really at bottom - see if be have any bootps
1950 //
1951 if (!Private->GotBootp) {
1952 return FALSE;
1953 }
1954
1955 DHCP_REQ_OPTIONS.OpReqIP.Ip = *(EFI_IPv4_ADDRESS *) &RxBuf[Private->GotBootp - 1].u.Dhcpv4.yiaddr;
1956
1957 if (!SetStationIP (Private)) {
1958 return FALSE;
1959 }
1960 //
1961 // treat BOOTP response as DHCP ACK packet
1962 //
1963 CopyParseRxBuf (Private, Private->GotBootp - 1, DHCPV4_ACK_INDEX);
1964
1965 LocalPtr.OpPtr = RxBuf[Private->GotBootp - 1].OpAdds.PktOptAdds[OP_SUBNET_MASK_IX - 1];
1966
1967 if (LocalPtr.OpPtr != NULL) {
1968 *(EFI_IPv4_ADDRESS *) &Private->EfiBc.Mode->SubnetMask = LocalPtr.SubnetMaskStr->Ip;
1969 }
1970
1971 return TRUE;
1972 }
1973
1974 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
1975
1976 /* DoDhcpDora()
1977 */
1978 STATIC
1979 EFI_STATUS
1980 DoDhcpDora (
1981 PXE_BASECODE_DEVICE *Private,
1982 BOOLEAN SortOffers
1983 )
1984 {
1985 EFI_PXE_BASE_CODE_IP_FILTER Filter;
1986 EFI_STATUS StatCode;
1987 INTN NumOffers;
1988
1989 Filter.Filters = EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP | EFI_PXE_BASE_CODE_IP_FILTER_BROADCAST;
1990
1991 Filter.IpCnt = 0;
1992 Filter.reserved = 0;
1993
1994 //
1995 // set filter unicast or broadcast
1996 //
1997 if ((StatCode = IpFilter (Private, &Filter)) != EFI_SUCCESS) {
1998 return StatCode;
1999 }
2000 //
2001 // seed random number with hardware address
2002 //
2003 SeedRandom (Private, *(UINT16 *) &Private->SimpleNetwork->Mode->CurrentAddress);
2004
2005 for (Private->Timeout = 1;
2006 Private->Timeout < 17;
2007 Private->TotalSeconds = (UINT16) (Private->TotalSeconds + Private->Timeout), Private->Timeout <<= 1
2008 ) {
2009 INTN Index;
2010
2011 InitDhcpv4TxBuf (Private);
2012 DHCPV4_TRANSMIT_BUFFER.xid = Random (Private);
2013 DHCPV4_TRANSMIT_BUFFER.secs = HTONS (Private->TotalSeconds);
2014
2015 //
2016 // broadcast DHCPDISCOVER
2017 //
2018 StatCode = DoUdpWrite (
2019 Private,
2020 &BroadcastIP,
2021 &DhcpServerPort,
2022 (EFI_IP_ADDRESS *) &DHCPV4_TRANSMIT_BUFFER.ciaddr,
2023 &DHCPClientPort
2024 );
2025
2026 if (StatCode != EFI_SUCCESS) {
2027 return StatCode;
2028 }
2029
2030 CopyMem (
2031 &Private->EfiBc.Mode->DhcpDiscover,
2032 (EFI_PXE_BASE_CODE_PACKET *) &DHCPV4_TRANSMIT_BUFFER,
2033 sizeof (EFI_PXE_BASE_CODE_PACKET)
2034 );
2035
2036 //
2037 // get DHCPOFFER's
2038 //
2039 if ((StatCode = GetOffers (Private)) != EFI_SUCCESS) {
2040 if (StatCode != EFI_NO_RESPONSE) {
2041 return StatCode;
2042 }
2043
2044 continue;
2045 }
2046 //
2047 // select offer and reply DHCPREQUEST
2048 //
2049 if (SortOffers) {
2050 if (TryDHCPFinishDORA(Private, PXE10_IX) || // try DHCP with PXE10
2051 TryDHCPFinishDORA(Private, WfM11a_IX) || // no - try with WfM
2052 TryProxyFinishDORA(Private, PXE10_IX) || // no - try DHCP only and proxy with PXE10
2053 TryProxyFinishDORA(Private, WfM11a_IX) || // no - try DHCP only and proxy with WfM
2054 TryDHCPFinishDORA(Private, BINL_IX) || // no - try with WfM
2055 TryProxyFinishDORA(Private, BINL_IX) || // no - try DHCP only and proxy with PXE10
2056 TryAnyWithBootfileFinishDORA(Private))
2057 {
2058 return EFI_SUCCESS;
2059 }
2060
2061 continue;
2062 }
2063 //
2064 // FIFO order
2065 //
2066 NumOffers = Private->NumOffersReceived;
2067
2068 for (Index = 0; Index < NumOffers; ++Index) {
2069 //
2070 // ignore proxies
2071 //
2072 if (!RxBuf[Index].u.Dhcpv4.yiaddr) {
2073 continue;
2074 }
2075 //
2076 // check if a bootp server
2077 //
2078 if (!RxBuf[Index].OpAdds.PktOptAdds[OP_DHCP_MESSAGE_TYPE_IX - 1]) {
2079 //
2080 // it is - just check ARP
2081 //
2082 if (!SetStationIP (Private)) {
2083 continue;
2084 }
2085 }
2086 //
2087 // else check if a DHCP only server
2088 //
2089 else if (!(RxBuf[Index].OpAdds.Status & (DISCOVER_TYPE | WfM11a_TYPE | PXE_TYPE))) {
2090 //
2091 // it is a normal DHCP offer (without any PXE options), just finish the D.O.R.A by sending DHCP request.
2092 //
2093 if (!TryFinishDORA (Private, Index)) {
2094 continue;
2095 }
2096 } else if (TryFinishDORA (Private, Index)) {
2097 if (!(RxBuf[Index].OpAdds.Status & (DISCOVER_TYPE | WfM11a_TYPE)) && !TryFinishBINL (Private, Index)) {
2098 continue;
2099 }
2100 }
2101
2102 DEBUG ((EFI_D_WARN, "\nDoDhcpDora() Got packets. "));
2103 return EFI_SUCCESS;
2104 }
2105 //
2106 // now look for DHCP onlys and a Proxy
2107 //
2108 for (Index = 0; Index < NumOffers; ++Index) {
2109 UINT8 Index2;
2110
2111 //
2112 // ignore proxies, bootps, non DHCP onlys, and bootable DHCPS
2113 //
2114 if (!RxBuf[Index].u.Dhcpv4.yiaddr ||
2115 !RxBuf[Index].OpAdds.PktOptAdds[OP_DHCP_MESSAGE_TYPE_IX - 1] ||
2116 RxBuf[Index].OpAdds.Status & (DISCOVER_TYPE | WfM11a_TYPE | PXE_TYPE) ||
2117 RxBuf[Index].OpAdds.PktOptAdds[OP_DHCP_BOOTFILE_IX - 1]
2118 ) {
2119 continue;
2120 }
2121 //
2122 // found non bootable DHCP only - try to find a proxy
2123 //
2124 for (Index2 = 0; Index2 < NumOffers; ++Index2) {
2125 if (!RxBuf[Index2].u.Dhcpv4.yiaddr) {
2126 if (!TryFinishDORA (Private, Index)) {
2127 //
2128 // DHCP no ACK
2129 //
2130 break;
2131 }
2132
2133 if (RxBuf[Index2].OpAdds.Status & (DISCOVER_TYPE | WfM11a_TYPE)) {
2134 CopyProxyRxBuf (Private, Index2);
2135 } else if (!TryFinishBINL (Private, Index2)) {
2136 continue;
2137 }
2138
2139 DEBUG ((EFI_D_WARN, "\nDoDhcpDora() Got packets. "));
2140 return EFI_SUCCESS;
2141 }
2142 }
2143 }
2144 }
2145
2146 return EFI_NO_RESPONSE;
2147 }
2148
2149 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
2150
2151 //
2152 // determine if the server ip is in the ip list
2153 //
2154 STATIC
2155 BOOLEAN
2156 InServerList (
2157 EFI_IP_ADDRESS *ServerIpPtr,
2158 PXE_SERVER_LISTS *ServerListPtr
2159 )
2160 {
2161 UINTN Index;
2162
2163 if (!ServerListPtr || !ServerListPtr->Ipv4List.IpCount) {
2164 return TRUE;
2165 }
2166
2167 for (Index = 0; Index < ServerListPtr->Ipv4List.IpCount; ++Index) {
2168 if (!CompareMem (
2169 ServerIpPtr,
2170 &ServerListPtr->Ipv4List.IpList[Index],
2171 sizeof (EFI_IPv4_ADDRESS)
2172 )) {
2173 return TRUE;
2174 }
2175 }
2176
2177 return FALSE;
2178 }
2179
2180 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
2181 STATIC
2182 BOOLEAN
2183 ExtractBootServerList (
2184 UINT16 Type,
2185 DHCPV4_OP_STRUCT *ptr,
2186 PXE_SERVER_LISTS **ServerListPtr
2187 )
2188 {
2189 UNION_PTR LocalPtr;
2190 INTN ServerListLen;
2191
2192 LocalPtr.OpPtr = ptr;
2193 ServerListLen = LocalPtr.BootServersStr->Header.Length;
2194
2195 //
2196 // find type
2197 //
2198 LocalPtr.BootServerList = LocalPtr.BootServersStr->ServerList;
2199
2200 while (ServerListLen) {
2201 INTN ServerEntryLen;
2202
2203 ServerEntryLen = sizeof (PXEV4_SERVER_LIST) + 2 + (LocalPtr.BootServerList->u.Ipv4List.IpCount - 1) *
2204 sizeof (EFI_IPv4_ADDRESS);
2205
2206 if (NTOHS (LocalPtr.BootServerList->Type) == Type) {
2207 *ServerListPtr = &LocalPtr.BootServerList->u;
2208 return TRUE;
2209 }
2210
2211 (LocalPtr.BytePtr) += ServerEntryLen;
2212 ServerListLen -= ServerEntryLen;
2213 }
2214
2215 return FALSE;
2216 }
2217
2218 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
2219 STATIC
2220 VOID
2221 FreeMem (
2222 PXE_BASECODE_DEVICE *Private
2223 )
2224 {
2225 if (Private->TransmitBuffer != NULL) {
2226 FreePool (Private->TransmitBuffer);
2227 Private->TransmitBuffer = NULL;
2228 }
2229
2230 if (Private->ReceiveBuffers != NULL) {
2231 FreePool (Private->ReceiveBuffers);
2232 Private->ReceiveBuffers = NULL;
2233 }
2234 }
2235
2236 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
2237 STATIC
2238 BOOLEAN
2239 GetMem (
2240 PXE_BASECODE_DEVICE *Private
2241 )
2242 {
2243
2244 if (Private->DhcpPacketBuffer == NULL) {
2245 Private->DhcpPacketBuffer = AllocatePool (sizeof (DHCP_RECEIVE_BUFFER) * (PXE_BIS_INDEX + 1));
2246 if (Private->DhcpPacketBuffer == NULL) {
2247 FreeMem (Private);
2248 return FALSE;
2249 }
2250 }
2251
2252 Private->TransmitBuffer = AllocatePool (sizeof (EFI_PXE_BASE_CODE_PACKET));
2253 if (Private->TransmitBuffer == NULL) {
2254 FreePool (Private->DhcpPacketBuffer);
2255 Private->DhcpPacketBuffer = NULL;
2256 FreeMem (Private);
2257 return FALSE;
2258 }
2259
2260 Private->ReceiveBuffers = AllocatePool (sizeof (DHCP_RECEIVE_BUFFER) * (MAX_OFFERS));
2261 if (Private->ReceiveBuffers == NULL) {
2262 FreePool (Private->TransmitBuffer);
2263 FreePool (Private->DhcpPacketBuffer);
2264 Private->DhcpPacketBuffer = NULL;
2265 Private->TransmitBuffer = NULL;
2266 FreeMem (Private);
2267 return FALSE;
2268 }
2269
2270 return TRUE;
2271 }
2272
2273 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
2274 EFI_STATUS
2275 EFIAPI
2276 BcDhcp (
2277 IN EFI_PXE_BASE_CODE_PROTOCOL *This,
2278 IN BOOLEAN SortOffers
2279 )
2280 /*++
2281 Routine description:
2282 standard DHCP Discover/Offer/Request/Ack session
2283 broadcast DHCPDISCOVER
2284 receive DHCPOFFER's
2285 broadcast DHCPREQUEST
2286 receive DHCPACK
2287 check (ARP) good IP
2288
2289 Parameters:
2290 This := Pointer to PxeBc interface
2291 SortOffers :=
2292
2293 Returns:
2294 --*/
2295 {
2296 EFI_PXE_BASE_CODE_IP_FILTER Filter;
2297 EFI_PXE_BASE_CODE_MODE *PxebcMode;
2298 PXE_BASECODE_DEVICE *Private;
2299 EFI_STATUS StatCode;
2300
2301 //
2302 // Lock the instance data and make sure started
2303 //
2304 StatCode = EFI_SUCCESS;
2305
2306 if (This == NULL) {
2307 DEBUG ((EFI_D_ERROR, "BC *This pointer == NULL"));
2308 return EFI_INVALID_PARAMETER;
2309 }
2310
2311 Private = CR (This, PXE_BASECODE_DEVICE, EfiBc, PXE_BASECODE_DEVICE_SIGNATURE);
2312
2313 if (Private == NULL) {
2314 DEBUG ((EFI_D_ERROR, "PXE_BASECODE_DEVICE pointer == NULL"));
2315 return EFI_INVALID_PARAMETER;
2316 }
2317
2318 EfiAcquireLock (&Private->Lock);
2319
2320 if (This->Mode == NULL || !This->Mode->Started) {
2321 DEBUG ((EFI_D_ERROR, "BC was not started."));
2322 EfiReleaseLock (&Private->Lock);
2323 return EFI_NOT_STARTED;
2324 }
2325
2326 Filter.Filters = EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP;
2327 Filter.IpCnt = 0;
2328 Filter.reserved = 0;
2329
2330 DEBUG ((EFI_D_INFO, "\nBcDhcp() Enter. "));
2331
2332 PxebcMode = Private->EfiBc.Mode;
2333
2334 if (!GetMem (Private)) {
2335 DEBUG ((EFI_D_ERROR, "\nBcDhcp() GetMem() failed.\n"));
2336 EfiReleaseLock (&Private->Lock);
2337 return EFI_OUT_OF_RESOURCES;
2338 }
2339
2340 PxebcMode->DhcpDiscoverValid = FALSE;
2341 PxebcMode->DhcpAckReceived = FALSE;
2342 PxebcMode->ProxyOfferReceived = FALSE;
2343
2344 Private->Function = EFI_PXE_BASE_CODE_FUNCTION_DHCP;
2345
2346 //
2347 // Issue BC command
2348 //
2349 if (Private->TotalSeconds == 0) {
2350 //
2351 // put in seconds field of DHCP send packets
2352 //
2353 Private->TotalSeconds = 4;
2354 }
2355
2356 if ((StatCode = DoDhcpDora (Private, SortOffers)) == EFI_SUCCESS) {
2357 //
2358 // success - copy packets
2359 //
2360 PxebcMode->DhcpDiscoverValid = PxebcMode->DhcpAckReceived = TRUE;
2361
2362 CopyMem (
2363 &PxebcMode->DhcpAck,
2364 (EFI_PXE_BASE_CODE_PACKET *) &DHCPV4_ACK_PACKET,
2365 sizeof (EFI_PXE_BASE_CODE_PACKET)
2366 );
2367
2368 if (PxebcMode->ProxyOfferReceived) {
2369 CopyMem (
2370 &PxebcMode->ProxyOffer,
2371 (EFI_PXE_BASE_CODE_PACKET *) &PXE_OFFER_PACKET,
2372 sizeof (EFI_PXE_BASE_CODE_PACKET)
2373 );
2374 }
2375 }
2376 //
2377 // set filter back to unicast
2378 //
2379 IpFilter (Private, &Filter);
2380
2381 FreeMem (Private);
2382
2383 //
2384 // Unlock the instance data
2385 //
2386 DEBUG ((EFI_D_WARN, "\nBcDhcp() Exit = %xh ", StatCode));
2387
2388 EfiReleaseLock (&Private->Lock);
2389 return StatCode;
2390 }
2391
2392 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
2393 STATIC
2394 BOOLEAN
2395 VerifyCredentialOption (
2396 UINT8 *tx,
2397 UINT8 *rx
2398 )
2399 {
2400 UINTN n;
2401
2402 //
2403 // Fail verification if either pointer is NULL.
2404 //
2405 if (tx == NULL || rx == NULL) {
2406 return FALSE;
2407 }
2408 //
2409 // Fail verification if tx[0] is not a credential type option
2410 // or if the length is zero or not a multiple of four.
2411 //
2412 if (tx[0] != VEND_PXE_CREDENTIAL_TYPES || tx[1] == 0 || tx[1] % 4 != 0) {
2413 return FALSE;
2414 }
2415 //
2416 // Fail verification if rx[0] is not a credential type option
2417 // or if the length is not equal to four.
2418 //
2419 if (rx[0] != VEND_PXE_CREDENTIAL_TYPES || rx[1] != 4) {
2420 return FALSE;
2421 }
2422 //
2423 // Look through transmitted credential types for a copy
2424 // of the received credential type.
2425 //
2426 for (n = 0; n < tx[1]; n += 4) {
2427 if (!CompareMem (&tx[n + 2], &rx[2], 4)) {
2428 return TRUE;
2429 }
2430 }
2431
2432 return FALSE;
2433 }
2434
2435 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
2436 STATIC
2437 EFI_STATUS
2438 DoDiscover (
2439 PXE_BASECODE_DEVICE *Private,
2440 UINT16 OpFlags,
2441 IN UINT16 Type,
2442 IN UINT16 *LayerPtr,
2443 IN BOOLEAN UseBis,
2444 EFI_IP_ADDRESS *DestPtr,
2445 PXE_SERVER_LISTS *ServerListPtr
2446 )
2447 /*++
2448 Routine description:
2449 This function tries to complete the PXE Bootserver and/or boot image
2450 discovery sequence. When this command completes successfully, the
2451 PXEdiscover and PXEreply fields in the BC instance data structure are
2452 updated. If the Info pointer is set to NULL, the discovery information
2453 in the DHCPack and ProxyOffer packets must be valid and will be used.
2454 If Info is not set to NULL, the discovery methods in the Info field
2455 must be set and will be used. When discovering any layer number other
2456 than zero (the credential flag does not count), only unicast discovery
2457 is used.
2458
2459 Parameters:
2460 Private := Pointer to PxeBc interface
2461 OpFlags :=
2462 Type :=
2463 LayerPtr :=
2464 UseBis :=
2465 DestPtr :=
2466 ServerListPtr :=
2467
2468 Returns:
2469 --*/
2470 {
2471 EFI_PXE_BASE_CODE_UDP_PORT ClientPort;
2472 EFI_PXE_BASE_CODE_UDP_PORT ServerPort;
2473 EFI_PXE_BASE_CODE_MODE *PxebcMode;
2474 EFI_STATUS StatCode;
2475 EFI_EVENT TimeoutEvent;
2476 UINT8 OpLen;
2477
2478 PxebcMode = Private->EfiBc.Mode;
2479
2480 if (DestPtr->Addr[0] == 0) {
2481 DEBUG ((EFI_D_WARN, "\nDoDiscover() !DestPtr->Addr[0]"));
2482 return EFI_INVALID_PARAMETER;
2483 }
2484 //
2485 // seed random number with hardware address
2486 //
2487 SeedRandom (Private, *(UINT16 *) &Private->SimpleNetwork->Mode->CurrentAddress);
2488
2489 if (DestPtr->Addr[0] == BroadcastIP.Addr[0]) {
2490 ClientPort = DHCPClientPort;
2491 ServerPort = DhcpServerPort;
2492 } else {
2493 ClientPort = PSEUDO_DHCP_CLIENT_PORT;
2494 ServerPort = PseudoDhcpServerPort;
2495 }
2496
2497 if (UseBis) {
2498 *LayerPtr |= PXE_BOOT_LAYER_CREDENTIAL_FLAG;
2499 } else {
2500 *LayerPtr &= PXE_BOOT_LAYER_MASK;
2501 }
2502
2503 for (Private->Timeout = 1;
2504 Private->Timeout < 5;
2505 Private->TotalSeconds = (UINT16) (Private->TotalSeconds + Private->Timeout), ++Private->Timeout
2506 ) {
2507 InitDhcpv4TxBuf (Private);
2508 //
2509 // initialize DHCP message structure
2510 //
2511 DHCPV4_TRANSMIT_BUFFER.xid = Random (Private);
2512 DHCPV4_TRANSMIT_BUFFER.secs = HTONS (Private->TotalSeconds);
2513 CopyMem (
2514 &DHCPV4_TRANSMIT_BUFFER.ciaddr,
2515 &PxebcMode->StationIp,
2516 sizeof DHCPV4_TRANSMIT_BUFFER.ciaddr
2517 );
2518
2519 DHCPV4_OPTIONS_BUFFER.DhcpMessageType.Type = DHCPREQUEST;
2520 DISCOVERoptions.Header.OpCode = OP_VENDOR_SPECIFIC;
2521 DISCOVERoptions.BootItem.Header.OpCode = VEND_PXE_BOOT_ITEM;
2522 DISCOVERoptions.BootItem.Header.Length = DHCPV4_OPTION_LENGTH (PXE_OP_BOOT_ITEM);
2523 DISCOVERoptions.BootItem.Type = HTONS (Type);
2524 DISCOVERoptions.BootItem.Layer = HTONS (*LayerPtr);
2525
2526 if (UseBis) {
2527 EFI_BIS_PROTOCOL *BisPtr;
2528 BIS_APPLICATION_HANDLE BisAppHandle;
2529 EFI_BIS_DATA *BisDataSigInfo;
2530 EFI_BIS_SIGNATURE_INFO *BisSigInfo;
2531 UINTN Index;
2532 UINTN Index2;
2533
2534 BisPtr = PxebcBisStart (
2535 Private,
2536 &BisAppHandle,
2537 &BisDataSigInfo
2538 );
2539
2540 if (BisPtr == NULL) {
2541 //
2542 // %%TBD - In order to get here, BIS must have
2543 // been present when PXEBC.Start() was called.
2544 // BIS had to be shutdown/removed/damaged
2545 // before PXEBC.Discover() was called.
2546 // Do we need to document a specific error
2547 // for this case?
2548 //
2549 return EFI_OUT_OF_RESOURCES;
2550 }
2551 //
2552 // Compute number of credential types.
2553 //
2554 Index2 = BisDataSigInfo->Length / sizeof (EFI_BIS_SIGNATURE_INFO);
2555
2556 DISCREDoptions.Header.OpCode = VEND_PXE_CREDENTIAL_TYPES;
2557
2558 DISCREDoptions.Header.Length = (UINT8) (Index2 * sizeof (PXE_CREDENTIAL));
2559
2560 OpLen = (UINT8) (DHCPV4_OPTION_LENGTH (PXE_DISCOVER_OPTIONS) + sizeof (DHCPV4_OP_HEADER) + DISCREDoptions.Header.Length);
2561
2562 BisSigInfo = (EFI_BIS_SIGNATURE_INFO *) BisDataSigInfo->Data;
2563
2564 for (Index = 0; Index < Index2; ++Index) {
2565 UINT32 x;
2566
2567 CopyMem (&x, &BisSigInfo[Index], sizeof x);
2568 x = HTONL (x);
2569 CopyMem (&DISCREDoptions.Credentials[Index], &x, sizeof x);
2570 }
2571
2572 PxebcBisStop (BisPtr, BisAppHandle, BisDataSigInfo);
2573 } else {
2574 OpLen = DHCPV4_OPTION_LENGTH (PXE_DISCOVER_OPTIONS);
2575 }
2576
2577 DISCOVERoptions.Header.Length = OpLen;
2578
2579 ((UINT8 *) &DISCOVERoptions)[sizeof (DHCPV4_OP_HEADER) + OpLen - 1] = OP_END;
2580 ((UINT8 *) &DISCOVERoptions)[sizeof (DHCPV4_OP_HEADER) + OpLen] = OP_END;
2581
2582 StatCode = DoUdpWrite (
2583 Private,
2584 DestPtr,
2585 &ServerPort,
2586 (EFI_IP_ADDRESS *) &DHCPV4_TRANSMIT_BUFFER.ciaddr,
2587 &ClientPort
2588 );
2589
2590 if (StatCode != EFI_SUCCESS) {
2591 return StatCode;
2592 }
2593 //
2594 //
2595 //
2596 StatCode = gBS->CreateEvent (
2597 EFI_EVENT_TIMER,
2598 EFI_TPL_CALLBACK,
2599 NULL,
2600 NULL,
2601 &TimeoutEvent
2602 );
2603
2604 if (EFI_ERROR (StatCode)) {
2605 return StatCode;
2606 }
2607
2608 StatCode = gBS->SetTimer (
2609 TimeoutEvent,
2610 TimerRelative,
2611 Private->Timeout * 10000000 + 1000000
2612 );
2613
2614 if (EFI_ERROR (StatCode)) {
2615 gBS->CloseEvent (TimeoutEvent);
2616 return StatCode;
2617 }
2618 //
2619 // wait for ACK
2620 //
2621 for (;;) {
2622 DHCP_RECEIVE_BUFFER *RxBufPtr;
2623 UINT16 TmpType;
2624 UINT16 TmpLayer;
2625
2626 RxBufPtr = UseBis ? &PXE_BIS_BUFFER : &PXE_ACK_BUFFER;
2627 ZeroMem (&Private->ServerIp, sizeof (EFI_IP_ADDRESS));
2628
2629 if (GetOfferAck (
2630 Private,
2631 AckEdit,
2632 OpFlags,
2633 (EFI_IP_ADDRESS *) &Private->ServerIp,
2634 0,
2635 (EFI_IP_ADDRESS *) &DHCPV4_TRANSMIT_BUFFER.ciaddr,
2636 &ClientPort,
2637 RxBufPtr,
2638 TimeoutEvent
2639 ) != EFI_SUCCESS) {
2640 break;
2641 }
2642 //
2643 // check type of response - need PXEClient DHCPACK of proper type with bootfile
2644 //
2645 if (!(RxBufPtr->OpAdds.Status & PXE_TYPE) ||
2646 (UseBis && (RxBufPtr->OpAdds.Status & USE_THREE_BYTE)) ||
2647 !RxBufPtr->OpAdds.PktOptAdds[OP_DHCP_BOOTFILE_IX - 1] ||
2648 !RxBufPtr->OpAdds.PktOptAdds[OP_DHCP_SERVER_IP_IX - 1] ||
2649 !InServerList((EFI_IP_ADDRESS *)&((DHCPV4_OP_SERVER_IP *)RxBufPtr->OpAdds.PktOptAdds[OP_DHCP_SERVER_IP_IX-1])->Ip, ServerListPtr)) {
2650
2651 continue;
2652 }
2653
2654 TmpType = TmpLayer = 0;
2655
2656 if (RxBufPtr->OpAdds.PxeOptAdds[VEND_PXE_BOOT_ITEM_IX - 1]) {
2657 TmpType = NTOHS (((PXE_OP_BOOT_ITEM *) RxBufPtr->OpAdds.PxeOptAdds[VEND_PXE_BOOT_ITEM_IX - 1])->Type);
2658
2659 if (RxBufPtr->OpAdds.Status & USE_THREE_BYTE) {
2660 TmpLayer = (UINT16) (((PXE_OP_BOOT_ITEM *) RxBufPtr->OpAdds.PxeOptAdds[VEND_PXE_BOOT_ITEM_IX - 1])->Layer >> 8);
2661 } else {
2662 TmpLayer = NTOHS (((PXE_OP_BOOT_ITEM *) RxBufPtr->OpAdds.PxeOptAdds[VEND_PXE_BOOT_ITEM_IX - 1])->Layer);
2663 }
2664 }
2665
2666 if (TmpType != Type) {
2667 continue;
2668 }
2669
2670 if (UseBis) {
2671 if (!RxBufPtr->OpAdds.PxeOptAdds[VEND_PXE_CREDENTIAL_TYPES_IX - 1]) {
2672 continue;
2673 }
2674
2675 if (!VerifyCredentialOption (
2676 (UINT8 *) &DISCREDoptions.Header,
2677 (UINT8 *) RxBufPtr->OpAdds.PxeOptAdds[VEND_PXE_CREDENTIAL_TYPES_IX - 1]
2678 )) {
2679 continue;
2680 }
2681 }
2682
2683 *LayerPtr = TmpLayer;
2684
2685 if (UseBis) {
2686 CopyMem (
2687 &PxebcMode->PxeBisReply,
2688 &RxBufPtr->u.Dhcpv4,
2689 sizeof (EFI_PXE_BASE_CODE_PACKET)
2690 );
2691
2692 PxebcMode->PxeBisReplyReceived = TRUE;
2693
2694 StatCode = DoDiscover (
2695 Private,
2696 EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_PORT,
2697 Type,
2698 LayerPtr,
2699 FALSE,
2700 &Private->ServerIp,
2701 0
2702 );
2703
2704 gBS->CloseEvent (TimeoutEvent);
2705 return StatCode;
2706 }
2707
2708 PxebcMode->PxeDiscoverValid = PxebcMode->PxeReplyReceived = TRUE;
2709
2710 CopyMem (
2711 &PxebcMode->PxeDiscover,
2712 &*(EFI_PXE_BASE_CODE_PACKET *) &DHCPV4_TRANSMIT_BUFFER,
2713 sizeof (*(EFI_PXE_BASE_CODE_PACKET *) &DHCPV4_TRANSMIT_BUFFER)
2714 );
2715
2716 CopyMem (
2717 &PxebcMode->PxeReply,
2718 &*(EFI_PXE_BASE_CODE_PACKET *) &RxBufPtr->u.Dhcpv4,
2719 sizeof (*(EFI_PXE_BASE_CODE_PACKET *) &RxBufPtr->u.Dhcpv4)
2720 );
2721
2722 AddRouters (Private, RxBufPtr);
2723
2724 gBS->CloseEvent (TimeoutEvent);
2725 return EFI_SUCCESS;
2726 }
2727
2728 gBS->CloseEvent (TimeoutEvent);
2729 }
2730 //
2731 // end for loop
2732 //
2733 return EFI_TIMEOUT;
2734 }
2735
2736 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
2737 STATIC
2738 EFI_STATUS
2739 Discover (
2740 PXE_BASECODE_DEVICE *Private,
2741 IN UINT16 Type,
2742 IN UINT16 *LayerPtr,
2743 IN BOOLEAN UseBis,
2744 IN EFI_PXE_BASE_CODE_DISCOVER_INFO *DiscoverInfoPtr,
2745 PXE_SERVER_LISTS *McastServerListPtr,
2746 PXE_SERVER_LISTS *ServerListPtr
2747 )
2748 /*++
2749 Routine Description:
2750
2751 Parameters:
2752 Private := Pointer to PxeBc interface
2753 Type :=
2754 LayerPtr :=
2755 UseBis :=
2756 DiscoverInfoPtr :=
2757 McastServerListPtr :=
2758 ServerListPtr :=
2759
2760 Returns:
2761 --*/
2762 {
2763 EFI_IP_ADDRESS DestIp;
2764 EFI_STATUS StatCode;
2765
2766 DEBUG ((EFI_D_INFO, "\nDiscover() Type=%d Layer=%d ", Type, *LayerPtr));
2767
2768 if (UseBis) {
2769 DEBUG ((EFI_D_INFO, "BIS "));
2770 }
2771 //
2772 // get dest IP addr - mcast, bcast, or unicast
2773 //
2774 if (DiscoverInfoPtr->UseMCast) {
2775 DestIp.v4 = DiscoverInfoPtr->ServerMCastIp.v4;
2776
2777 DEBUG (
2778 (EFI_D_INFO,
2779 "\nDiscover() MCast %d.%d.%d.%d ",
2780 DestIp.v4.Addr[0],
2781 DestIp.v4.Addr[1],
2782 DestIp.v4.Addr[2],
2783 DestIp.v4.Addr[3])
2784 );
2785
2786 if ((StatCode = DoDiscover (
2787 Private,
2788 EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_IP | EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_PORT,
2789 Type,
2790 LayerPtr,
2791 UseBis,
2792 &DestIp,
2793 McastServerListPtr
2794 )) != EFI_TIMEOUT) {
2795 DEBUG (
2796 (EFI_D_WARN,
2797 "\nDiscover() status == %r (%Xh)",
2798 StatCode,
2799 StatCode)
2800 );
2801
2802 return StatCode;
2803 }
2804 }
2805
2806 if (DiscoverInfoPtr->UseBCast) {
2807 DEBUG ((EFI_D_INFO, "\nDiscver() BCast "));
2808
2809 if ((StatCode = DoDiscover (
2810 Private,
2811 EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_IP | EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_PORT,
2812 Type,
2813 LayerPtr,
2814 UseBis,
2815 &BroadcastIP,
2816 McastServerListPtr
2817 )) != EFI_TIMEOUT) {
2818
2819 DEBUG ((EFI_D_WARN, "\nDiscover() status == %r (%Xh)", StatCode, StatCode));
2820
2821 return StatCode;
2822 }
2823 }
2824
2825 if (DiscoverInfoPtr->UseUCast) {
2826 UINTN Index;
2827
2828 DEBUG (
2829 (EFI_D_INFO,
2830 "\nDiscover() UCast IP#=%d ",
2831 ServerListPtr->Ipv4List.IpCount)
2832 );
2833
2834 for (Index = 0; Index < ServerListPtr->Ipv4List.IpCount; ++Index) {
2835 CopyMem (&DestIp, &ServerListPtr->Ipv4List.IpList[Index], 4);
2836
2837 DEBUG (
2838 (EFI_D_INFO,
2839 "\nDiscover() UCast %d.%d.%d.%d ",
2840 DestIp.v4.Addr[0],
2841 DestIp.v4.Addr[1],
2842 DestIp.v4.Addr[2],
2843 DestIp.v4.Addr[3])
2844 );
2845
2846 if ((StatCode = DoDiscover (
2847 Private,
2848 EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_IP | EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_PORT,
2849 Type,
2850 LayerPtr,
2851 UseBis,
2852 &DestIp,
2853 0
2854 )) != EFI_TIMEOUT) {
2855 DEBUG (
2856 (EFI_D_WARN,
2857 "\nDiscover() status == %r (%Xh)",
2858 StatCode,
2859 StatCode)
2860 );
2861
2862 return StatCode;
2863 }
2864 }
2865 }
2866
2867 DEBUG ((EFI_D_WARN, "\nDiscover() TIMEOUT"));
2868
2869 return EFI_TIMEOUT;
2870 }
2871
2872 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
2873
2874 /* BcDiscover()
2875 */
2876 EFI_STATUS
2877 EFIAPI
2878 BcDiscover (
2879 IN EFI_PXE_BASE_CODE_PROTOCOL * This,
2880 IN UINT16 Type,
2881 IN UINT16 *LayerPtr,
2882 IN BOOLEAN UseBis,
2883 IN EFI_PXE_BASE_CODE_DISCOVER_INFO * DiscoverInfoPtr OPTIONAL
2884 )
2885 /*++
2886 Routine description:
2887
2888 Parameters:
2889 This :=
2890 Type :=
2891 LayerPtr :=
2892 UseBis :=
2893 DiscoverInfoPtr :=
2894
2895 Returns:
2896 --*/
2897 {
2898 EFI_PXE_BASE_CODE_DISCOVER_INFO DefaultInfo;
2899 EFI_PXE_BASE_CODE_MODE *PxebcMode;
2900 DHCP_RECEIVE_BUFFER *DhcpRxBuf;
2901 PXE_SERVER_LISTS DefaultSrvList;
2902 PXE_SERVER_LISTS *ServerListPtr;
2903 PXE_SERVER_LISTS *McastServerListPtr;
2904 UNION_PTR LocalPtr;
2905 UINTN Index;
2906 UINTN Index2;
2907 BOOLEAN AcquiredSrvList;
2908 EFI_STATUS StatCode;
2909 PXE_BASECODE_DEVICE *Private;
2910
2911 //
2912 // Lock the instance data and make sure started
2913 //
2914 StatCode = EFI_SUCCESS;
2915
2916 if (This == NULL) {
2917 DEBUG ((EFI_D_ERROR, "BC *This pointer == NULL"));
2918 return EFI_INVALID_PARAMETER;
2919 }
2920
2921 Private = CR (This, PXE_BASECODE_DEVICE, EfiBc, PXE_BASECODE_DEVICE_SIGNATURE);
2922
2923 if (Private == NULL) {
2924 DEBUG ((EFI_D_ERROR, "PXE_BASECODE_DEVICE poiner == NULL"));
2925 return EFI_INVALID_PARAMETER;
2926 }
2927
2928 EfiAcquireLock (&Private->Lock);
2929
2930 if (This->Mode == NULL || !This->Mode->Started) {
2931 DEBUG ((EFI_D_ERROR, "BC was not started."));
2932 EfiReleaseLock (&Private->Lock);
2933 return EFI_NOT_STARTED;
2934 }
2935
2936 ServerListPtr = NULL;
2937 McastServerListPtr = NULL;
2938 AcquiredSrvList = FALSE;
2939
2940 PxebcMode = Private->EfiBc.Mode;
2941
2942 if (!GetMem (Private)) {
2943 EfiReleaseLock (&Private->Lock);
2944 return EFI_OUT_OF_RESOURCES;
2945 }
2946
2947 if (UseBis) {
2948 if (!PxebcMode->BisSupported) {
2949 EfiReleaseLock (&Private->Lock);
2950 return EFI_INVALID_PARAMETER;
2951 }
2952 }
2953
2954 Private->Function = EFI_PXE_BASE_CODE_FUNCTION_DISCOVER;
2955
2956 if (Private->TotalSeconds == 0) {
2957 //
2958 // put in seconds field of DHCP send packets
2959 //
2960 Private->TotalSeconds = 4;
2961 }
2962
2963 ZeroMem (&DefaultInfo, sizeof (EFI_PXE_BASE_CODE_DISCOVER_INFO));
2964
2965 //
2966 // if layer number not zero, use previous discover
2967 //
2968 if (*LayerPtr != 0) {
2969 DEBUG ((EFI_D_WARN, "\nBcDiscover() layer != 0"));
2970
2971 if (DiscoverInfoPtr != NULL) {
2972 DEBUG ((EFI_D_WARN, "\nBcDiscover() layer != 0 && DiscoverInfoPtr != NULL\n"));
2973
2974 EfiReleaseLock (&Private->Lock);
2975 return EFI_INVALID_PARAMETER;
2976 }
2977
2978 if (!PxebcMode->PxeDiscoverValid) {
2979 DEBUG ((EFI_D_WARN, "\nBcDiscover() layer != 0 && PxeDiscoverValid == 0\n"));
2980
2981 EfiReleaseLock (&Private->Lock);
2982 return EFI_INVALID_PARAMETER;
2983 }
2984
2985 if (!PxebcMode->PxeReplyReceived) {
2986 DEBUG ((EFI_D_WARN, "\nBcDiscover() layer != 0 && PxeReplyReceived == 0\n"));
2987
2988 EfiReleaseLock (&Private->Lock);
2989 return EFI_INVALID_PARAMETER;
2990 }
2991
2992 if (UseBis && !PxebcMode->PxeBisReplyReceived) {
2993 DEBUG ((EFI_D_WARN, "\nBcDiscover() layer != 0 && PxeBisReplyReceived == 0\n"));
2994
2995 EfiReleaseLock (&Private->Lock);
2996 return EFI_INVALID_PARAMETER;
2997 }
2998
2999 DefaultInfo.UseUCast = TRUE;
3000 DiscoverInfoPtr = &DefaultInfo;
3001
3002 DefaultSrvList.Ipv4List.IpCount = 1;
3003 CopyMem (&DefaultSrvList.Ipv4List.IpList[0], &Private->ServerIp, 4);
3004
3005 ServerListPtr = &DefaultSrvList;
3006 }
3007 //
3008 // layer is zero - see if info is supplied or if we need to use info from a cached offer
3009 //
3010 else if (!DiscoverInfoPtr) {
3011 //
3012 // not supplied - generate it
3013 // make sure that there is cached, appropriate information
3014 // if neither DhcpAck packet nor ProxyOffer packet has pxe info, fail
3015 //
3016 DhcpRxBuf = (PxebcMode->ProxyOfferReceived) ? &PXE_OFFER_BUFFER : &DHCPV4_ACK_BUFFER;
3017
3018 if (!PxebcMode->DhcpAckReceived || !(DhcpRxBuf->OpAdds.Status & DISCOVER_TYPE)) {
3019 DEBUG ((EFI_D_WARN, "\nBcDiscover() !ack && !proxy"));
3020 EfiReleaseLock (&Private->Lock);
3021 return EFI_INVALID_PARAMETER;
3022 }
3023
3024 DiscoverInfoPtr = &DefaultInfo;
3025
3026 LocalPtr.OpPtr = DhcpRxBuf->OpAdds.PxeOptAdds[VEND_PXE_DISCOVERY_CONTROL_IX - 1];
3027
3028 //
3029 // if multicast enabled, need multicast address
3030 //
3031 if (!(LocalPtr.DiscoveryControl->ControlBits & DISABLE_MCAST)) {
3032 DefaultInfo.UseMCast = TRUE;
3033
3034 CopyMem (
3035 ((EFI_IPv4_ADDRESS *) &DefaultInfo.ServerMCastIp),
3036 &((DHCPV4_OP_IP_ADDRESS *) DhcpRxBuf->OpAdds.PxeOptAdds[VEND_PXE_DISCOVERY_MCAST_ADDR_IX - 1])->Ip,
3037 sizeof (EFI_IPv4_ADDRESS)
3038 );
3039 }
3040
3041 DefaultInfo.UseBCast = (BOOLEAN) ((LocalPtr.DiscoveryControl->ControlBits & DISABLE_BCAST) == 0);
3042
3043 DefaultInfo.MustUseList = (BOOLEAN) ((LocalPtr.DiscoveryControl->ControlBits & USE_ACCEPT_LIST) != 0);
3044
3045 DefaultInfo.UseUCast = (BOOLEAN)
3046 (
3047 (DefaultInfo.MustUseList) ||
3048 ((LocalPtr.DiscoveryControl->ControlBits & (DISABLE_MCAST | DISABLE_BCAST)) == (DISABLE_MCAST | DISABLE_BCAST))
3049 );
3050
3051 if ((DefaultInfo.UseUCast | DefaultInfo.MustUseList) && !ExtractBootServerList (
3052 Type,
3053 DhcpRxBuf->OpAdds.PxeOptAdds[VEND_PXE_BOOT_SERVERS_IX - 1],
3054 &ServerListPtr
3055 )) {
3056 DEBUG ((EFI_D_WARN, "\nBcDiscover() type not in list"));
3057 EfiReleaseLock (&Private->Lock);
3058 return EFI_INVALID_PARAMETER;
3059 }
3060 }
3061 //
3062 // Info supplied - make SrvList if required
3063 // if we use ucast discovery or must use list, there better be one
3064 //
3065 else if (DiscoverInfoPtr->UseUCast || DiscoverInfoPtr->MustUseList) {
3066 //
3067 // there better be a list
3068 //
3069 if (DiscoverInfoPtr->IpCnt == 0) {
3070 DEBUG ((EFI_D_WARN, "\nBcDiscover() no bootserver list"));
3071 EfiReleaseLock (&Private->Lock);
3072 return EFI_INVALID_PARAMETER;
3073 }
3074 //
3075 // get its size
3076 //
3077 for (Index = Index2 = 0; Index < DiscoverInfoPtr->IpCnt; ++Index) {
3078 if (DiscoverInfoPtr->SrvList[Index].Type == Type) {
3079 if (DiscoverInfoPtr->SrvList[Index].AcceptAnyResponse) {
3080 if (Index2 != 0) {
3081 DEBUG ((EFI_D_WARN, "\nBcDiscover() accept any?"));
3082 EfiReleaseLock (&Private->Lock);
3083 return EFI_INVALID_PARAMETER;
3084 } else {
3085 Index2 = 1;
3086 DefaultSrvList.Ipv4List.IpCount = 0;
3087 ServerListPtr = &DefaultSrvList;
3088 break;
3089 }
3090 } else {
3091 ++Index2;
3092 }
3093 }
3094 }
3095
3096 if (Index2 == 0) {
3097 DEBUG ((EFI_D_WARN, "\nBcDiscover() !Index2?"));
3098 EfiReleaseLock (&Private->Lock);
3099 return EFI_INVALID_PARAMETER;
3100 }
3101
3102 if (ServerListPtr == NULL) {
3103 ServerListPtr = AllocatePool (
3104 sizeof (PXEV4_SERVER_LIST) + (Index2 - 1) * sizeof (EFI_IPv4_ADDRESS)
3105 );
3106
3107 if (ServerListPtr == NULL) {
3108 EfiReleaseLock (&Private->Lock);
3109 return EFI_OUT_OF_RESOURCES;
3110 }
3111 //
3112 // build an array of IP addresses from the server list
3113 //
3114 AcquiredSrvList = TRUE;
3115 ServerListPtr->Ipv4List.IpCount = (UINT8) Index2;
3116
3117 for (Index = Index2 = 0; Index < DiscoverInfoPtr->IpCnt; ++Index) {
3118 if (DiscoverInfoPtr->SrvList[Index].Type == Type) {
3119 CopyMem (
3120 &ServerListPtr->Ipv4List.IpList[Index2++],
3121 &DiscoverInfoPtr->SrvList[Index].IpAddr.v4,
3122 sizeof ServerListPtr->Ipv4List.IpList[0]
3123 );
3124 }
3125 }
3126 }
3127 }
3128
3129 if (DiscoverInfoPtr->MustUseList) {
3130 McastServerListPtr = ServerListPtr;
3131 }
3132
3133 if (!(DiscoverInfoPtr->UseMCast || DiscoverInfoPtr->UseBCast || DiscoverInfoPtr->UseUCast)) {
3134 DEBUG ((EFI_D_WARN, "\nBcDiscover() Nothing to use!\n"));
3135
3136 EfiReleaseLock (&Private->Lock);
3137 return EFI_INVALID_PARAMETER;
3138 }
3139
3140 PxebcMode->PxeDiscoverValid = PxebcMode->PxeReplyReceived = PxebcMode->PxeBisReplyReceived = FALSE;
3141
3142 StatCode = Discover (
3143 Private,
3144 Type,
3145 LayerPtr,
3146 UseBis,
3147 DiscoverInfoPtr,
3148 McastServerListPtr,
3149 ServerListPtr
3150 );
3151
3152 if (AcquiredSrvList) {
3153 FreePool (ServerListPtr);
3154 }
3155
3156 FreeMem (Private);
3157
3158 //
3159 // Unlock the instance data
3160 //
3161 DEBUG (
3162 (EFI_D_INFO,
3163 "\nBcDiscover() status == %r (%Xh)\n",
3164 StatCode,
3165 StatCode)
3166 );
3167
3168 EfiReleaseLock (&Private->Lock);
3169 return StatCode;
3170 }
3171
3172 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
3173 EFI_STATUS
3174 EFIAPI
3175 BcSetPackets (
3176 IN EFI_PXE_BASE_CODE_PROTOCOL * This,
3177 BOOLEAN *NewDhcpDiscoverValid, OPTIONAL
3178 BOOLEAN *NewDhcpAckReceived, OPTIONAL
3179 BOOLEAN *NewProxyOfferReceived, OPTIONAL
3180 BOOLEAN *NewPxeDiscoverValid, OPTIONAL
3181 BOOLEAN *NewPxeReplyReceived, OPTIONAL
3182 BOOLEAN *NewPxeBisReplyReceived, OPTIONAL
3183 IN EFI_PXE_BASE_CODE_PACKET * NewDhcpDiscover, OPTIONAL
3184 IN EFI_PXE_BASE_CODE_PACKET * NewDhcpAck, OPTIONAL
3185 IN EFI_PXE_BASE_CODE_PACKET * NewProxyOffer, OPTIONAL
3186 IN EFI_PXE_BASE_CODE_PACKET * NewPxeDiscover, OPTIONAL
3187 IN EFI_PXE_BASE_CODE_PACKET * NewPxeReply, OPTIONAL
3188 IN EFI_PXE_BASE_CODE_PACKET * NewPxeBisReply OPTIONAL
3189 )
3190 /*++
3191 Routine description:
3192
3193 Parameters:
3194
3195 Returns:
3196 --*/
3197 {
3198 EFI_PXE_BASE_CODE_MODE *PxebcMode;
3199 PXE_BASECODE_DEVICE *Private;
3200
3201 //
3202 // Lock the instance data and make sure started
3203 //
3204
3205 if (This == NULL) {
3206 DEBUG ((EFI_D_ERROR, "BC *This pointer == NULL"));
3207 return EFI_INVALID_PARAMETER;
3208 }
3209
3210 Private = CR (This, PXE_BASECODE_DEVICE, EfiBc, PXE_BASECODE_DEVICE_SIGNATURE);
3211
3212 if (Private == NULL) {
3213 DEBUG ((EFI_D_ERROR, "PXE_BASECODE_DEVICE poiner == NULL"));
3214 return EFI_INVALID_PARAMETER;
3215 }
3216
3217 EfiAcquireLock (&Private->Lock);
3218
3219 if (This->Mode == NULL || !This->Mode->Started) {
3220 DEBUG ((EFI_D_ERROR, "BC was not started."));
3221 EfiReleaseLock (&Private->Lock);
3222 return EFI_NOT_STARTED;
3223 }
3224
3225 PxebcMode = Private->EfiBc.Mode;
3226
3227 if (Private->DhcpPacketBuffer == NULL) {
3228 Private->DhcpPacketBuffer = AllocatePool (sizeof (DHCP_RECEIVE_BUFFER) * (PXE_BIS_INDEX + 1));
3229 if (Private->DhcpPacketBuffer == NULL) {
3230 EfiReleaseLock (&Private->Lock);
3231 return EFI_OUT_OF_RESOURCES;
3232 }
3233 }
3234 //
3235 // Issue BC command
3236 //
3237 //
3238 // reset
3239 //
3240 Private->FileSize = 0;
3241 if (NewDhcpDiscoverValid != NULL) {
3242 PxebcMode->DhcpDiscoverValid = *NewDhcpDiscoverValid;
3243 }
3244
3245 if (NewDhcpAckReceived != NULL) {
3246 PxebcMode->DhcpAckReceived = *NewDhcpAckReceived;
3247 }
3248
3249 if (NewProxyOfferReceived != NULL) {
3250 PxebcMode->ProxyOfferReceived = *NewProxyOfferReceived;
3251 }
3252
3253 if (NewPxeDiscoverValid != NULL) {
3254 PxebcMode->PxeDiscoverValid = *NewPxeDiscoverValid;
3255 }
3256
3257 if (NewPxeReplyReceived != NULL) {
3258 PxebcMode->PxeReplyReceived = *NewPxeReplyReceived;
3259 }
3260
3261 if (NewPxeBisReplyReceived != NULL) {
3262 PxebcMode->PxeBisReplyReceived = *NewPxeBisReplyReceived;
3263 }
3264
3265 if (NewDhcpDiscover != NULL) {
3266 CopyMem (
3267 &PxebcMode->DhcpDiscover,
3268 NewDhcpDiscover,
3269 sizeof *NewDhcpDiscover
3270 );
3271 }
3272
3273 if (NewDhcpAck != NULL) {
3274 CopyParse (Private, &PxebcMode->DhcpAck, NewDhcpAck, DHCPV4_ACK_INDEX);
3275 }
3276
3277 if (NewProxyOffer != NULL) {
3278 CopyParse (Private, &PxebcMode->ProxyOffer, NewProxyOffer, PXE_OFFER_INDEX);
3279 }
3280
3281 if (NewPxeDiscover != NULL) {
3282 CopyMem (
3283 &PxebcMode->PxeDiscover,
3284 NewPxeDiscover,
3285 sizeof *NewPxeDiscover
3286 );
3287 }
3288
3289 if (NewPxeReply != NULL) {
3290 CopyParse (Private, &PxebcMode->PxeReply, NewPxeReply, PXE_ACK_INDEX);
3291 }
3292
3293 if (NewPxeBisReply != NULL) {
3294 CopyParse (Private, &PxebcMode->PxeBisReply, NewPxeBisReply, PXE_BIS_INDEX);
3295 }
3296 //
3297 // Unlock the instance data
3298 //
3299 EfiReleaseLock (&Private->Lock);
3300 return EFI_SUCCESS;
3301 }
3302
3303 /* eof - pxe_bc_dhcp.c */
EFI Development Kit II mirror for PVE