3 Copyright (c) 2006, 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
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.
16 DHCP and PXE discovery protocol implementations.
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 } };
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
;
48 // option structure for DHCPREQUEST at end of DISCOVER options
49 // and for DHCPDECLINE
51 STATIC
const struct requestopendstr
{
52 DHCPV4_OP_REQUESTED_IP OpReqIP
;
53 DHCPV4_OP_SERVER_IP DhcServerIpPtr
;
60 DHCPV4_OPTION_LENGTH(DHCPV4_OP_REQUESTED_IP
)
66 DHCPV4_OPTION_LENGTH(DHCPV4_OP_SERVER_IP
)
74 #define DHCP_REQ_OPTIONS (*(struct requestopendstr *) DHCPV4_OPTIONS_BUFFER.End)
76 PXE_OP_BOOT_ITEM DefaultBootItem
= {
79 DHCPV4_OPTION_LENGTH(PXE_OP_BOOT_ITEM
)
85 // PXE discovery control default structure
87 STATIC PXE_OP_DISCOVERY_CONTROL DefaultDisCtl
= {
88 { VEND_PXE_DISCOVERY_CONTROL
, DHCPV4_OPTION_LENGTH(PXE_OP_DISCOVERY_CONTROL
) },
93 // PXE credentials option structure
100 DHCPV4_OP_HEADER Header
;
101 PXE_CREDENTIAL Credentials
[1];
102 } PXE_OP_CREDENTIAL_TYPES
;
105 // option structure for PXE discover (without credentials)
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
;
113 #define DISCOVERoptions (*(PXE_DISCOVER_OPTIONS *) DHCPV4_OPTIONS_BUFFER.End)
114 #define DISCREDoptions (*(PXE_OP_CREDENTIAL_TYPES *) DISCOVERoptions.End)
117 // common option beginning for all our DHCP messages except
118 // DHCPDECLINE and DHCPRELEASE
120 STATIC
struct optionsstr
{
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
;
132 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
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
);
198 DHCPOpStart
.DhcpClassIdentifier
.Data
.ClassIdentifier
,
200 sizeof ("PXEClient:")
202 CopyMem (DHCPOpStart
.DhcpClassIdentifier
.Data
.Lit2
, "Arch:", sizeof ("Arch:"));
204 DHCPOpStart
.DhcpClassIdentifier
.Data
.ArchitectureType
,
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
;
216 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
219 // DHCPDECLINE option structure
221 struct opdeclinestr
{
223 DHCPV4_OP_MESSAGE_TYPE DhcpMessageType
;
224 struct requestopendstr OpDeclineEnd
;
227 #define DHCPDECLINEoptions (*(struct opdeclinestr *) DHCPV4_TRANSMIT_BUFFER.options)
230 // DHCPRELEASE option structure
232 struct opreleasestr
{
234 DHCPV4_OP_MESSAGE_TYPE DhcpMessageType
;
235 DHCPV4_OP_SERVER_IP DhcServerIpPtr
;
239 #define DHCPRELEASEoptions (*(struct opreleasestr *) DHCPV4_TRANSMIT_BUFFER.options)
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
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
320 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
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
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
397 #define RxBuf ((DHCP_RECEIVE_BUFFER *) (Private->ReceiveBuffers))
401 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
404 PxeBcLibGetSmbiosString (
405 IN SMBIOS_STRUCTURE_POINTER
*Smbios
,
406 IN UINT16 StringNumber
410 Return SMBIOS string given the string number.
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.
418 Pointer to string, or pointer to next SMBIOS strcuture if StringNumber == 0
425 // Skip over formatted section
427 String
= (CHAR8
*) (Smbios
->Raw
+ Smbios
->Hdr
->Length
);
430 // Look through unformated section
432 for (Index
= 1; Index
<= StringNumber
|| StringNumber
== 0; Index
++) {
433 if (StringNumber
== Index
) {
439 for (; *String
!= 0; String
++)
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
449 Smbios
->Raw
= (UINT8
*)++String
;
458 PxeBcLibGetSmbiosSystemGuidAndSerialNumber (
459 IN EFI_GUID
*SystemGuid
,
460 OUT CHAR8
**SystemSerialNumber
465 This function gets system guid and serial number from the smbios table
468 SystemGuid - The pointer of returned system guid
469 SystemSerialNumber - The pointer of returned system serial number
472 EFI_SUCCESS - Successfully get the system guid and system serial number
473 EFI_NOT_FOUND - Not find the SMBIOS table
477 SMBIOS_STRUCTURE_TABLE
*SmbiosTable
;
478 SMBIOS_STRUCTURE_POINTER Smbios
;
479 SMBIOS_STRUCTURE_POINTER SmbiosEnd
;
482 Status
= EfiGetSystemConfigurationTable (&gEfiSmbiosTableGuid
, (VOID
**) &SmbiosTable
);
484 if (EFI_ERROR (Status
)) {
485 return EFI_NOT_FOUND
;
488 Smbios
.Hdr
= (SMBIOS_HEADER
*) (UINTN
) SmbiosTable
->TableAddress
;
489 SmbiosEnd
.Raw
= (UINT8
*) (UINTN
) (SmbiosTable
->TableAddress
+ SmbiosTable
->TableLength
);
491 for (Index
= 0; Index
< SmbiosTable
->TableLength
; Index
++) {
492 if (Smbios
.Hdr
->Type
== 1) {
493 if (Smbios
.Hdr
->Length
< 0x19) {
495 // Older version did not support Guid and Serial number
500 // SMBIOS tables are byte packed so we need to do a byte copy to
501 // prevend alignment faults on Itanium-based platform.
503 CopyMem (SystemGuid
, &Smbios
.Type1
->Uuid
, sizeof (EFI_GUID
));
504 *SystemSerialNumber
= PxeBcLibGetSmbiosString (&Smbios
, Smbios
.Type1
->SerialNumber
);
509 // Make Smbios point to the next record
511 PxeBcLibGetSmbiosString (&Smbios
, 0);
513 if (Smbios
.Raw
>= SmbiosEnd
.Raw
) {
515 // SMBIOS 2.1 incorrectly stated the length of SmbiosTable as 0x1e.
516 // given this we must double check against the lenght of
526 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
529 // add router list to list
534 PXE_BASECODE_DEVICE
*Private
,
535 DHCPV4_OP_IP_LIST
*IpListPtr
538 EFI_IP_ADDRESS TmpIp
;
542 if (IpListPtr
== NULL
) {
546 for (Index
= 0, num
= IpListPtr
->Header
.Length
>> 2; Index
< num
; ++Index
) {
547 CopyMem (&TmpIp
, &IpListPtr
->IpList
[Index
], 4);
548 Ip4AddRouter (Private
, &TmpIp
);
552 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
555 // send ARP for our IP - fail if someone has it
560 PXE_BASECODE_DEVICE
*Private
563 EFI_MAC_ADDRESS DestMac
;
564 EFI_STATUS EfiStatus
;
566 ZeroMem (&DestMac
, sizeof DestMac
);
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
574 (EFI_IPv4_ADDRESS
*) &Private
->EfiBc
.Mode
->StationIp
,
575 &DHCP_REQ_OPTIONS
.OpReqIP
.Ip
,
576 sizeof (EFI_IPv4_ADDRESS
)
579 Private
->GoodStationIp
= TRUE
;
581 if (!Private
->UseIgmpv1Reporting
) {
585 if (Private
->Igmpv1TimeoutEvent
!= NULL
) {
589 EfiStatus
= gBS
->CreateEvent (
594 &Private
->Igmpv1TimeoutEvent
597 if (EFI_ERROR (EfiStatus
)) {
598 Private
->Igmpv1TimeoutEvent
= NULL
;
602 EfiStatus
= gBS
->SetTimer (
603 Private
->Igmpv1TimeoutEvent
,
605 (UINT64
) V1ROUTER_PRESENT_TIMEOUT
* 10000000
608 if (EFI_ERROR (EfiStatus
)) {
609 gBS
->CloseEvent (Private
->Igmpv1TimeoutEvent
);
610 Private
->Igmpv1TimeoutEvent
= NULL
;
616 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
620 PXE_BASECODE_DEVICE
*Private
,
621 DHCP_RECEIVE_BUFFER
*RxBufPtr
624 Ip4AddRouter (Private
, &RxBufPtr
->u
.Dhcpv4
.giaddr
);
628 (DHCPV4_OP_IP_LIST
*) RxBufPtr
->OpAdds
.PktOptAdds
[OP_ROUTER_LIST_IX
- 1]
632 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
636 PXE_BASECODE_DEVICE
*Private
,
637 EFI_IP_ADDRESS
*ServerIpPtr
,
638 EFI_PXE_BASE_CODE_UDP_PORT
*ServerPortPtr
,
639 EFI_IP_ADDRESS
*ClientIpPtr
,
640 EFI_PXE_BASE_CODE_UDP_PORT
*ClientPortPtr
645 Len
= sizeof DHCPV4_TRANSMIT_BUFFER
;
649 EFI_PXE_BASE_CODE_UDP_OPFLAGS_MAY_FRAGMENT
,
658 Private
->TransmitBuffer
662 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
665 // initialize the DHCP structure
674 PXE_BASECODE_DEVICE
*Private
679 CHAR8
*SystemSerialNumber
;
680 EFI_PXE_BASE_CODE_MODE
*PxebcMode
;
682 PxebcMode
= Private
->EfiBc
.Mode
;
684 ZeroMem (&DHCPV4_TRANSMIT_BUFFER
, sizeof (DHCPV4_STRUCT
));
685 DHCPV4_TRANSMIT_BUFFER
.op
= BOOTP_REQUEST
;
686 DHCPV4_TRANSMIT_BUFFER
.htype
= Private
->SimpleNetwork
->Mode
->IfType
;
687 DHCPV4_TRANSMIT_BUFFER
.flags
= HTONS (DHCP_BROADCAST_FLAG
);
688 CopyMem (&DHCPV4_OPTIONS_BUFFER
, (VOID
*) &DHCPOpStart
, sizeof (DHCPOpStart
));
691 // default to hardware address
693 HwAddrLen
= Private
->SimpleNetwork
->Mode
->HwAddressSize
;
695 if (HwAddrLen
> sizeof DHCPV4_TRANSMIT_BUFFER
.chaddr
) {
696 HwAddrLen
= sizeof DHCPV4_TRANSMIT_BUFFER
.chaddr
;
699 String
= (UINT8
*) &Private
->SimpleNetwork
->Mode
->CurrentAddress
;
701 if (PxeBcLibGetSmbiosSystemGuidAndSerialNumber (
702 (EFI_GUID
*) DHCPV4_OPTIONS_BUFFER
.DhcpPlatformId
.Guid
,
705 if (PxebcMode
->SendGUID
) {
706 HwAddrLen
= sizeof (EFI_GUID
);
707 String
= (UINT8
*) DHCPV4_OPTIONS_BUFFER
.DhcpPlatformId
.Guid
;
711 // GUID not yet set - send all 0xff's to show programable (via SetVariable)
712 // SetMem(DHCPV4_OPTIONS_BUFFER.DhcpPlatformId.Guid, sizeof(EFI_GUID), 0xff);
713 // GUID not yet set - send all 0's to show not programable
715 ZeroMem (DHCPV4_OPTIONS_BUFFER
.DhcpPlatformId
.Guid
, sizeof (EFI_GUID
));
718 DHCPV4_TRANSMIT_BUFFER
.hlen
= (UINT8
) HwAddrLen
;
719 CopyMem (DHCPV4_TRANSMIT_BUFFER
.chaddr
, String
, HwAddrLen
);
723 (UINT8
*) DHCPV4_OPTIONS_BUFFER
.DhcpClassIdentifier
.Data
.ArchitectureType
,
724 sizeof DHCPV4_OPTIONS_BUFFER
.DhcpClassIdentifier
.Data
.ArchitectureType
727 DHCPV4_OPTIONS_BUFFER
.DhcpNetworkInterface
.Type
= Private
->NiiPtr
->Type
;
728 DHCPV4_OPTIONS_BUFFER
.DhcpNetworkInterface
.MajorVersion
= Private
->NiiPtr
->MajorVer
;
729 DHCPV4_OPTIONS_BUFFER
.DhcpNetworkInterface
.MinorVersion
= Private
->NiiPtr
->MinorVer
;
731 *(C4Str
*) DHCPV4_OPTIONS_BUFFER
.DhcpClassIdentifier
.Data
.InterfaceName
= *(C4Str
*) Private
->NiiPtr
->StringId
;
734 DHCPV4_OPTIONS_BUFFER
.DhcpNetworkInterface
.MajorVersion
,
735 (UINT8
*) DHCPV4_OPTIONS_BUFFER
.DhcpClassIdentifier
.Data
.UndiMajor
,
736 sizeof DHCPV4_OPTIONS_BUFFER
.DhcpClassIdentifier
.Data
.UndiMajor
740 DHCPV4_OPTIONS_BUFFER
.DhcpNetworkInterface
.MinorVersion
,
741 (UINT8
*) DHCPV4_OPTIONS_BUFFER
.DhcpClassIdentifier
.Data
.UndiMinor
,
742 sizeof DHCPV4_OPTIONS_BUFFER
.DhcpClassIdentifier
.Data
.UndiMinor
746 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
750 DHCP_RECEIVE_BUFFER
*RxBufPtr
,
763 for (EndPtr
= ptr
+ Len
; ptr
< EndPtr
; ptr
+= Len
+ 2) {
776 LocalPtr
.BytePtr
= ptr
;
777 if (Op
<= MAX_OUR_PXE_OPT
) {
778 Index
= ourPXEopts
[Op
- 1];
780 RxBufPtr
->OpAdds
.PxeOptAdds
[Index
- 1] = LocalPtr
.OpPtr
;
781 status
|= 1 << Index
;
782 if (Index
== VEND_PXE_BOOT_ITEM
&& LocalPtr
.BootItem
->Header
.Length
== 3) {
783 RxBufPtr
->OpAdds
.Status
|= USE_THREE_BYTE
;
794 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
798 DHCP_RECEIVE_BUFFER
*RxBufPtr
,
808 for (EndPtr
= ptr
+ Len
; ptr
< EndPtr
; ptr
+= Len
+ 2) {
821 LocalPtr
.BytePtr
= ptr
;
822 if (Op
<= MAX_OUR_OPT
) {
823 Index
= OurDhcpOptions
[Op
- 1];
825 RxBufPtr
->OpAdds
.PktOptAdds
[Index
- 1] = LocalPtr
.OpPtr
;
826 if (Index
== OP_VENDOR_SPECIFIC_IX
) {
828 status
= DecodePxeOptions (
830 (UINT8
*) LocalPtr
.VendorOptions
->VendorOptions
,
831 LocalPtr
.VendorOptions
->Header
.Length
834 RxBufPtr
->OpAdds
.Status
|= PXE_TYPE
;
836 // check for all the MTFTP info options present - any missing is a nogo
838 if ((status
& WfM11a_OPTS
) == WfM11a_OPTS
) {
839 RxBufPtr
->OpAdds
.Status
|= WfM11a_TYPE
;
842 if (status
& DISCOVER_OPTS
) {
843 RxBufPtr
->OpAdds
.Status
|= DISCOVER_TYPE
;
846 if (status
& CREDENTIALS_OPT
) {
847 RxBufPtr
->OpAdds
.Status
|= CREDENTIALS_TYPE
;
858 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
862 DHCP_RECEIVE_BUFFER
*RxBufPtr
,
871 SetMem (&RxBufPtr
->OpAdds
, sizeof RxBufPtr
->OpAdds
, 0);
875 RxBufPtr
->u
.Dhcpv4
.options
+ 4,
876 Len
- (sizeof RxBufPtr
->u
.Dhcpv4
- sizeof RxBufPtr
->u
.Dhcpv4
.options
+ 4)
879 LocalPtr
.OpPtr
= RxBufPtr
->OpAdds
.PktOptAdds
[OP_DHCP_OPTION_OVERLOAD_IX
- 1];
881 if ((LocalPtr
.OpPtr
) && (LocalPtr
.Overload
->Overload
& OVLD_SRVR_NAME
)) {
882 DecodeOptions (RxBufPtr
, RxBufPtr
->u
.Dhcpv4
.sname
, sizeof RxBufPtr
->u
.Dhcpv4
.sname
);
885 if (LocalPtr
.OpPtr
&& (LocalPtr
.Overload
->Overload
& OVLD_FILE
)) {
886 DecodeOptions (RxBufPtr
, RxBufPtr
->u
.Dhcpv4
.file
, sizeof RxBufPtr
->u
.Dhcpv4
.file
);
887 } else if (!RxBufPtr
->OpAdds
.PktOptAdds
[OP_DHCP_BOOTFILE_IX
- 1] && RxBufPtr
->u
.Dhcpv4
.file
[0]) {
888 RxBufPtr
->OpAdds
.PktOptAdds
[OP_DHCP_BOOTFILE_IX
- 1] = (DHCPV4_OP_STRUCT
*) (RxBufPtr
->u
.Dhcpv4
.file
- sizeof (DHCPV4_OP_HEADER
));
890 RxBufPtr
->OpAdds
.PktOptAdds
[OP_DHCP_BOOTFILE_IX
- 1]->Header
.Length
= (UINT8
) AsciiStrLen ((CHAR8
*)RxBufPtr
->u
.Dhcpv4
.file
);
893 LocalPtr
.OpPtr
= RxBufPtr
->OpAdds
.PktOptAdds
[OP_DHCP_CLASS_IDENTIFIER_IX
- 1];
895 if ((LocalPtr
.OpPtr
) &&
896 LocalPtr
.PxeClassStr
->Header
.Length
>= 9 &&
897 !CompareMem (LocalPtr
.PxeClassStr
->Class
, "PXEClient", 9)
899 RxBufPtr
->OpAdds
.Status
|= PXE_TYPE
;
903 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
907 PXE_BASECODE_DEVICE
*Private
,
912 DHCP_RECEIVE_BUFFER
*RxBufPtr
;
914 RxBufPtr
= &((DHCP_RECEIVE_BUFFER
*) Private
->DhcpPacketBuffer
)[PacketIndex
];
918 &RxBuf
[RxBufIndex
].u
.Dhcpv4
,
919 sizeof (RxBuf
[RxBufIndex
].u
.Dhcpv4
)
922 Parse (RxBufPtr
, sizeof RxBufPtr
->u
.ReceiveBuffer
);
925 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
929 PXE_BASECODE_DEVICE
*Private
,
933 Private
->EfiBc
.Mode
->ProxyOfferReceived
= TRUE
;
934 CopyParseRxBuf (Private
, RxBufIndex
, PXE_OFFER_INDEX
);
937 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
941 PXE_BASECODE_DEVICE
*Private
,
942 EFI_PXE_BASE_CODE_PACKET
*PacketPtr
,
943 EFI_PXE_BASE_CODE_PACKET
*NewPacketPtr
,
947 DHCP_RECEIVE_BUFFER
*DhcpRxBuf
;
949 DhcpRxBuf
= &((DHCP_RECEIVE_BUFFER
*) Private
->DhcpPacketBuffer
)[Index
];
952 (EFI_PXE_BASE_CODE_PACKET
*) &DhcpRxBuf
->u
.Dhcpv4
,
954 sizeof (*NewPacketPtr
)
957 CopyMem (&*PacketPtr
, &*NewPacketPtr
, sizeof (*NewPacketPtr
));
959 Parse (DhcpRxBuf
, sizeof DhcpRxBuf
->u
.ReceiveBuffer
);
962 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
966 DHCP_RECEIVE_BUFFER
*DhcpRxBuf
971 LocalPtr
.OpPtr
= DhcpRxBuf
->OpAdds
.PktOptAdds
[OP_DHCP_MESSAGE_TYPE_IX
- 1];
975 // if a DHCP type, must be DHCPOFFER and must have server id
980 (LocalPtr
.MessageType
->Type
== DHCPACK
) &&
981 DhcpRxBuf
->OpAdds
.PktOptAdds
[OP_DHCP_SERVER_IP_IX
- 1]
985 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
988 // if a discover type packet, make sure all required fields are present
993 DHCP_RECEIVE_BUFFER
*DhcpRxBuf
996 PXE_OP_SERVER_LIST
*BootServerOpPtr
;
999 if ((DhcpRxBuf
->OpAdds
.Status
& DISCOVER_TYPE
) == 0) {
1003 LocalPtr
.OpPtr
= DhcpRxBuf
->OpAdds
.PxeOptAdds
[VEND_PXE_DISCOVERY_CONTROL_IX
- 1];
1005 if (LocalPtr
.OpPtr
== NULL
) {
1006 LocalPtr
.OpPtr
= (DHCPV4_OP_STRUCT
*) &DefaultDisCtl
;
1007 DhcpRxBuf
->OpAdds
.PxeOptAdds
[VEND_PXE_DISCOVERY_CONTROL_IX
- 1] = (DHCPV4_OP_STRUCT
*) &DefaultDisCtl
;
1010 // make sure all required fields are here
1011 // if mucticast enabled, need multicast address
1013 if (!(LocalPtr
.DiscoveryControl
->ControlBits
& DISABLE_MCAST
) &&
1014 (!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
))
1018 // missing required field
1022 // if a list, it better be good
1024 BootServerOpPtr
= (PXE_OP_SERVER_LIST
*) DhcpRxBuf
->OpAdds
.PxeOptAdds
[VEND_PXE_BOOT_SERVERS_IX
- 1];
1026 if (BootServerOpPtr
!= NULL
) {
1027 PXE_SERVER_LIST
*BootServerListPtr
;
1029 INTN ServerEntryLen
;
1031 BootServerListPtr
= BootServerOpPtr
->ServerList
;
1032 ServerListLen
= BootServerOpPtr
->Header
.Length
;
1035 EFI_IPv4_ADDRESS
*IpListPtr
;
1038 IpCnt
= BootServerListPtr
->u
.Ipv4List
.IpCount
;
1040 ServerEntryLen
= sizeof (PXEV4_SERVER_LIST
) + 2 + (IpCnt
- 1) * sizeof (EFI_IPv4_ADDRESS
);
1042 if (ServerListLen
< ServerEntryLen
) {
1044 // missing required field
1049 IpListPtr
= BootServerListPtr
->u
.Ipv4List
.IpList
;
1052 if (IS_MULTICAST (IpListPtr
)) {
1054 // missing required field
1062 BootServerListPtr
= (PXE_SERVER_LIST
*) IpListPtr
;
1063 } while (ServerListLen
-= ServerEntryLen
);
1066 // else there must be a list if use list enabled or multicast and
1067 // broadcast disabled
1069 else if ((LocalPtr
.DiscoveryControl
->ControlBits
& USE_ACCEPT_LIST
) ||
1070 ((LocalPtr
.DiscoveryControl
->ControlBits
& (DISABLE_MCAST
| DISABLE_BCAST
)) == (DISABLE_MCAST
| DISABLE_BCAST
))
1073 // missing required field
1078 // if not USE_BOOTFILE or no bootfile given, must have menu stuff
1080 if (!(LocalPtr
.DiscoveryControl
->ControlBits
& USE_BOOTFILE
) ||
1081 !DhcpRxBuf
->OpAdds
.PktOptAdds
[OP_DHCP_BOOTFILE_IX
- 1]
1085 LocalPtr
.OpPtr
= DhcpRxBuf
->OpAdds
.PxeOptAdds
[VEND_PXE_BOOT_MENU_IX
- 1];
1087 if (LocalPtr
.OpPtr
== NULL
|| !DhcpRxBuf
->OpAdds
.PxeOptAdds
[VEND_PXE_BOOT_PROMPT_IX
- 1]) {
1089 // missing required field
1094 // make sure menu valid
1096 MenuLth
= LocalPtr
.BootMenu
->Header
.Length
;
1097 LocalPtr
.BootMenuItem
= LocalPtr
.BootMenu
->MenuItem
;
1102 MenuItemLen
= LocalPtr
.BootMenuItem
->DataLen
;
1104 if (MenuItemLen
== 0) {
1106 // missing required field
1111 MenuItemLen
+= sizeof (*LocalPtr
.BootMenuItem
) - sizeof (LocalPtr
.BootMenuItem
->Data
);
1113 MenuLth
-= MenuItemLen
;
1114 LocalPtr
.BytePtr
+= MenuItemLen
;
1115 } while (MenuLth
> 0);
1119 // missing required field
1125 if (!DhcpRxBuf
->OpAdds
.PxeOptAdds
[VEND_PXE_BOOT_ITEM_IX
- 1]) {
1126 DhcpRxBuf
->OpAdds
.PxeOptAdds
[VEND_PXE_BOOT_ITEM_IX
- 1] = (DHCPV4_OP_STRUCT
*) &DefaultBootItem
;
1132 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
1136 DHCP_RECEIVE_BUFFER
*RxBufPtr
1139 return (BOOLEAN
) (DHCPOfferAckEdit (RxBufPtr
) ? AckEdit (RxBufPtr
) : FALSE
);
1142 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
1150 PXE_BASECODE_DEVICE
*Private
,
1151 BOOLEAN (*ExtraEdit
)(DHCP_RECEIVE_BUFFER
*DhcpRxBuf
),
1152 UINT16 OpFlags
, // for Udp read
1153 EFI_IP_ADDRESS
*ServerIpPtr
,
1154 EFI_PXE_BASE_CODE_UDP_PORT
*ServerPortPtr
,
1155 EFI_IP_ADDRESS
*ClientIpPtr
,
1156 EFI_PXE_BASE_CODE_UDP_PORT
*ClientPortPtr
,
1157 DHCP_RECEIVE_BUFFER
*DhcpRxBuf
,
1158 EFI_EVENT TimeoutEvent
1161 Routine description:
1162 Wait for an OFFER/ACK packet.
1165 Private := Pointer to PxeBc interface
1166 ExtraEdit := Pointer to extra option checking function
1167 OpFlags := UdpRead() option flags
1178 EFI_IP_ADDRESS ServerIp
;
1179 EFI_STATUS StatCode
;
1184 // Wait until we get a UDP packet.
1186 ZeroMem (&ServerIp
, sizeof (EFI_IP_ADDRESS
));
1187 RxBufLen
= sizeof RxBuf
[0].u
.ReceiveBuffer
;
1189 if ((StatCode
= UdpRead (
1198 (UINTN
*) &RxBufLen
,
1199 &DhcpRxBuf
->u
.Dhcpv4
,
1201 )) != EFI_SUCCESS
) {
1202 if (StatCode
== EFI_TIMEOUT
) {
1203 StatCode
= EFI_NO_RESPONSE
;
1209 // got a packet - see if a good offer
1211 if (DhcpRxBuf
->u
.Dhcpv4
.op
!= BOOTP_REPLY
) {
1215 if (DhcpRxBuf
->u
.Dhcpv4
.xid
!= DHCPV4_TRANSMIT_BUFFER
.xid
) {
1219 if (*(UINT32
*) DHCPV4_TRANSMIT_BUFFER
.options
!= * (UINT32
*) DhcpRxBuf
->u
.Dhcpv4
.options
) {
1223 if (*(UINT8
*) &DhcpRxBuf
->u
.Dhcpv4
.yiaddr
> 223) {
1228 DhcpRxBuf
->u
.Dhcpv4
.chaddr
,
1229 DHCPV4_TRANSMIT_BUFFER
.chaddr
,
1230 sizeof DhcpRxBuf
->u
.Dhcpv4
.chaddr
1238 Parse (DhcpRxBuf
, RxBufLen
);
1240 if (!(*ExtraEdit
) (DhcpRxBuf
)) {
1244 // Good DHCP packet.
1246 StatCode
= EFI_SUCCESS
;
1253 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
1261 PXE_BASECODE_DEVICE
*Private
1264 EFI_IP_ADDRESS ClientIp
;
1265 EFI_IP_ADDRESS ServerIp
;
1266 EFI_STATUS StatCode
;
1267 EFI_EVENT TimeoutEvent
;
1274 ZeroMem (&ServerIp
, sizeof (EFI_IP_ADDRESS
));
1277 for (Index
= 0; Index
< (sizeof Private
->ServerCount
) / sizeof Private
->ServerCount
[0]; ++Index
) {
1278 Private
->ServerCount
[Index
] = 0;
1279 Private
->GotProxy
[Index
] = 0;
1282 Private
->GotBootp
= 0;
1284 // these we throw away
1286 Private
->GotProxy
[DHCP_ONLY_IX
] = 1;
1287 StatCode
= gBS
->CreateEvent (
1295 if (EFI_ERROR (StatCode
)) {
1299 StatCode
= gBS
->SetTimer (
1302 Private
->Timeout
* 10000000 + 1000000
1305 if (EFI_ERROR (StatCode
)) {
1306 gBS
->CloseEvent (TimeoutEvent
);
1313 DHCP_RECEIVE_BUFFER
*DhcpRxBuf
;
1316 DhcpRxBuf
= &RxBuf
[NumOffers
];
1319 StatCode
= GetOfferAck (
1322 EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_IP
|
1323 EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_DEST_IP
|
1324 EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_PORT
,
1337 LocalPtr
.OpPtr
= DhcpRxBuf
->OpAdds
.PktOptAdds
[OP_DHCP_MESSAGE_TYPE_IX
- 1];
1340 // check type of offer
1342 if (LocalPtr
.OpPtr
== NULL
) {
1344 // bootp - we only need one and make sure has bootfile
1346 if (Private
->GotBootp
|| !DhcpRxBuf
->OpAdds
.PktOptAdds
[OP_DHCP_BOOTFILE_IX
- 1]) {
1350 Private
->GotBootp
= (UINT8
) (NumOffers
+ 1);
1353 // if a DHCP type, must be DHCPOFFER and must have server id
1355 else if (LocalPtr
.MessageType
->Type
!= DHCPOFFER
|| !DhcpRxBuf
->OpAdds
.PktOptAdds
[OP_DHCP_SERVER_IP_IX
- 1]) {
1361 // get type - PXE10, WfM11a, or BINL
1363 if (DhcpRxBuf
->OpAdds
.Status
& DISCOVER_TYPE
) {
1365 } else if (DhcpRxBuf
->OpAdds
.Status
& WfM11a_TYPE
) {
1367 // WfM - make sure it has a bootfile
1369 if (!DhcpRxBuf
->OpAdds
.PktOptAdds
[OP_DHCP_BOOTFILE_IX
- 1]) {
1375 TypeIx
= (DhcpRxBuf
->OpAdds
.Status
& PXE_TYPE
) ? BINL_IX
: DHCP_ONLY_IX
;
1378 // check DHCP or proxy
1380 if (DhcpRxBuf
->u
.Dhcpv4
.yiaddr
== 0) {
1382 // proxy - only need one of each type if not BINL
1383 // and must have at least PXE_TYPE
1385 if (TypeIx
== BINL_IX
) {
1386 Private
->BinlProxies
[Private
->GotProxy
[BINL_IX
]++] = (UINT8
) NumOffers
;
1387 } else if (Private
->GotProxy
[TypeIx
]) {
1390 Private
->GotProxy
[TypeIx
] = (UINT8
) (NumOffers
+ 1);
1393 Private
->OfferCount
[TypeIx
][Private
->ServerCount
[TypeIx
]++] = (UINT8
) NumOffers
;
1397 if (++NumOffers
== MAX_OFFERS
) {
1402 gBS
->CloseEvent (TimeoutEvent
);
1403 Private
->NumOffersReceived
= NumOffers
;
1405 return (Private
->NumOffersReceived
) ? EFI_SUCCESS
: EFI_NO_RESPONSE
;
1408 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
1416 PXE_BASECODE_DEVICE
*Private
1419 EFI_PXE_BASE_CODE_MODE
*PxebcMode
;
1422 PxebcMode
= Private
->EfiBc
.Mode
;
1423 SaveSecs
= DHCPV4_TRANSMIT_BUFFER
.secs
;
1425 DHCPV4_TRANSMIT_BUFFER
.secs
= 0;
1426 DHCPV4_TRANSMIT_BUFFER
.flags
= 0;
1428 DHCPV4_TRANSMIT_BUFFER
.options
+ sizeof (struct opdeclinestr
),
1429 sizeof (DHCPOpStart
) - sizeof (struct opdeclinestr
),
1432 DHCPDECLINEoptions
.DhcpMessageType
.Type
= DHCPDECLINE
;
1433 CopyMem (&DHCPDECLINEoptions
.OpDeclineEnd
, &DHCP_REQ_OPTIONS
, sizeof (struct requestopendstr
));
1434 // DHCPDECLINEoptions.OpDeclineEnd = DHCP_REQ_OPTIONS;
1437 EFI_IP_ADDRESS TmpIp
;
1439 CopyMem (&TmpIp
, &DHCP_REQ_OPTIONS
.DhcServerIpPtr
.Ip
, sizeof TmpIp
);
1445 &PxebcMode
->StationIp
,
1450 InitDhcpv4TxBuf (Private
);
1451 DHCPV4_TRANSMIT_BUFFER
.secs
= SaveSecs
;
1452 Private
->GoodStationIp
= FALSE
;
1455 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
1463 PXE_BASECODE_DEVICE
*Private
1466 EFI_PXE_BASE_CODE_MODE
*PxebcMode
;
1468 DHCPV4_OP_SERVER_IP
*Point
;
1470 PxebcMode
= Private
->EfiBc
.Mode
;
1471 SaveSecs
= DHCPV4_TRANSMIT_BUFFER
.secs
;
1472 DHCPV4_TRANSMIT_BUFFER
.secs
= 0;
1475 DHCPV4_TRANSMIT_BUFFER
.options
+ sizeof (struct opreleasestr
),
1476 sizeof (DHCPOpStart
) - sizeof (struct opreleasestr
),
1480 DHCPRELEASEoptions
.DhcpMessageType
.Type
= DHCPRELEASE
;
1481 Point
= (DHCPV4_OP_SERVER_IP
*) DHCPV4_ACK_BUFFER
.OpAdds
.PktOptAdds
[OP_DHCP_SERVER_IP_IX
- 1];
1483 &DHCPRELEASEoptions
.DhcServerIpPtr
,
1485 sizeof DHCPRELEASEoptions
.DhcServerIpPtr
1488 DHCPRELEASEoptions
.End
[0] = OP_END
;
1491 EFI_IP_ADDRESS TmpIp
;
1493 CopyMem (&TmpIp
, &DHCPRELEASEoptions
.DhcServerIpPtr
.Ip
, sizeof TmpIp
);
1499 &PxebcMode
->StationIp
,
1504 InitDhcpv4TxBuf (Private
);
1506 DHCPV4_TRANSMIT_BUFFER
.secs
= SaveSecs
;
1507 Private
->GoodStationIp
= FALSE
;
1511 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
1515 PXE_BASECODE_DEVICE
*Private
,
1516 EFI_IP_ADDRESS
*ServerIpPtr
1519 DHCP_RECEIVE_BUFFER
*DhcpRxBuf
;
1520 EFI_STATUS StatCode
;
1521 EFI_EVENT TimeoutEvent
;
1526 StatCode
= gBS
->CreateEvent (
1534 if (EFI_ERROR (StatCode
)) {
1538 StatCode
= gBS
->SetTimer (
1541 Private
->Timeout
* 10000000 + 1000000
1544 if (EFI_ERROR (StatCode
)) {
1545 gBS
->CloseEvent (TimeoutEvent
);
1551 DhcpRxBuf
= &PXE_BINL_BUFFER
;
1554 EFI_PXE_BASE_CODE_UDP_PORT BINLSrvPort
;
1561 EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_PORT
,
1564 &Private
->EfiBc
.Mode
->StationIp
,
1565 &PSEUDO_DHCP_CLIENT_PORT
,
1572 // make sure from whom we wanted
1574 if (!DhcpRxBuf
->u
.Dhcpv4
.yiaddr
&& !CompareMem (
1576 &((DHCPV4_OP_SERVER_IP
*) DhcpRxBuf
->OpAdds
.PktOptAdds
[OP_DHCP_SERVER_IP_IX
- 1])->Ip
,
1577 sizeof (ServerIpPtr
->v4
)
1579 gBS
->CloseEvent (TimeoutEvent
);
1581 // got an ACK from server
1587 gBS
->CloseEvent (TimeoutEvent
);
1591 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
1594 // make sure we can get BINL
1595 // send DHCPREQUEST to PXE server
1600 PXE_BASECODE_DEVICE
*Private
,
1604 DHCP_RECEIVE_BUFFER
*DhcpRxBuf
;
1605 EFI_IP_ADDRESS ServerIp
;
1609 DhcpRxBuf
= &RxBuf
[OfferIx
];
1612 // send DHCP request
1613 // if fail return false
1616 ((EFI_IPv4_ADDRESS
*) &ServerIp
),
1617 &((DHCPV4_OP_SERVER_IP
*) DhcpRxBuf
->OpAdds
.PktOptAdds
[OP_DHCP_SERVER_IP_IX
- 1])->Ip
,
1618 sizeof (EFI_IPv4_ADDRESS
)
1622 // client IP address - filled in by client if it knows it
1625 ((EFI_IPv4_ADDRESS
*) &DHCPV4_TRANSMIT_BUFFER
.ciaddr
),
1626 &DHCP_REQ_OPTIONS
.OpReqIP
.Ip
,
1627 sizeof (EFI_IPv4_ADDRESS
)
1630 SetMem (&DHCP_REQ_OPTIONS
, sizeof DHCP_REQ_OPTIONS
, OP_PAD
);
1631 DHCPV4_TRANSMIT_BUFFER
.flags
= 0;
1632 DHCPV4_OPTIONS_BUFFER
.End
[0] = OP_END
;
1633 AddRouters (Private
, DhcpRxBuf
);
1634 SaveSecs
= DHCPV4_TRANSMIT_BUFFER
.secs
;
1636 for (Index
= 0; Index
< 3; Private
->TotalSeconds
= (UINT16
) (Private
->TotalSeconds
+ Private
->Timeout
), ++Index
) {
1637 DHCPV4_TRANSMIT_BUFFER
.secs
= HTONS (Private
->TotalSeconds
);
1640 // unicast DHCPREQUEST to PXE server
1645 &PseudoDhcpServerPort
,
1646 (EFI_IP_ADDRESS
*) &DHCPV4_TRANSMIT_BUFFER
.ciaddr
,
1647 &PSEUDO_DHCP_CLIENT_PORT
1652 if (!GetBINLAck (Private
, &ServerIp
)) {
1656 // early exit failures
1657 // make sure a good ACK
1659 if (!DHCPOfferAckEdit (&PXE_BINL_BUFFER
) || (
1660 !(PXE_BINL_BUFFER
.OpAdds
.Status
& DISCOVER_TYPE
) && !PXE_BINL_BUFFER
.OpAdds
.PktOptAdds
[OP_DHCP_BOOTFILE_IX
- 1]
1666 Private
->EfiBc
.Mode
->ProxyOfferReceived
= TRUE
;
1670 // failed - reset seconds field, etc.
1672 Private
->EfiBc
.Mode
->RouteTableEntries
= 0;
1676 DHCPV4_TRANSMIT_BUFFER
.secs
= SaveSecs
;
1680 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
1684 PXE_BASECODE_DEVICE
*Private
,
1688 if (TryBINL (Private
, OfferIx
)) {
1692 return Release (Private
);
1695 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
1698 TryFinishProxyBINL (
1699 PXE_BASECODE_DEVICE
*Private
1704 for (Index
= 0; Index
< Private
->GotProxy
[BINL_IX
]; ++Index
) {
1705 if (TryBINL (Private
, Private
->BinlProxies
[Index
])) {
1710 return Release (Private
);
1713 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
1716 // try to finish DORA - send DHCP request, wait for ACK, check with ARP
1721 PXE_BASECODE_DEVICE
*Private
,
1725 DHCP_RECEIVE_BUFFER
*DhcpRxBuf
;
1726 EFI_IP_ADDRESS ClientIp
;
1727 EFI_IP_ADDRESS ServerIp
;
1728 EFI_STATUS StatCode
;
1730 EFI_EVENT TimeoutEvent
;
1733 // send DHCP request
1734 // if fail return false
1736 DhcpRxBuf
= &DHCPV4_ACK_BUFFER
;
1737 DHCPV4_OPTIONS_BUFFER
.DhcpMessageType
.Type
= DHCPREQUEST
;
1738 CopyMem (&DHCP_REQ_OPTIONS
, &RequestOpEndStr
, sizeof (RequestOpEndStr
));
1739 // DHCP_REQ_OPTIONS = RequestOpEndStr;
1740 DHCP_REQ_OPTIONS
.OpReqIP
.Ip
= *(EFI_IPv4_ADDRESS
*) &RxBuf
[OfferIx
].u
.Dhcpv4
.yiaddr
;
1743 &DHCP_REQ_OPTIONS
.DhcServerIpPtr
.Ip
,
1744 &((DHCPV4_OP_SERVER_IP
*) RxBuf
[OfferIx
].OpAdds
.PktOptAdds
[OP_DHCP_SERVER_IP_IX
- 1])->Ip
,
1745 sizeof DHCP_REQ_OPTIONS
.DhcServerIpPtr
.Ip
1749 Private
->EfiBc
.Mode
->SubnetMask
.Addr
,
1755 // broadcast DHCPREQUEST
1761 (EFI_IP_ADDRESS
*) &DHCPV4_TRANSMIT_BUFFER
.ciaddr
,
1769 StatCode
= gBS
->CreateEvent (
1777 if (EFI_ERROR (StatCode
)) {
1781 StatCode
= gBS
->SetTimer (
1784 Private
->Timeout
* 10000000 + 1000000
1787 if (EFI_ERROR (StatCode
)) {
1788 gBS
->CloseEvent (TimeoutEvent
);
1798 EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_DEST_IP
| EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_IP
,
1809 // check type of response - need DHCPACK
1812 &DHCP_REQ_OPTIONS
.OpReqIP
.Ip
,
1813 &DhcpRxBuf
->u
.Dhcpv4
.yiaddr
,
1814 sizeof (EFI_IPv4_ADDRESS
)
1816 &DHCP_REQ_OPTIONS
.DhcServerIpPtr
.Ip
,
1817 &((DHCPV4_OP_SERVER_IP
*) DhcpRxBuf
->OpAdds
.PktOptAdds
[OP_DHCP_SERVER_IP_IX
- 1])->Ip
,
1818 sizeof (EFI_IPv4_ADDRESS
)
1824 // check with ARP that IP unused - good return true
1826 if (!SetStationIP (Private
)) {
1828 // fail - send DHCPDECLINE and return false
1830 DeclineOffer (Private
);
1834 LocalPtr
.OpPtr
= DHCPV4_ACK_BUFFER
.OpAdds
.PktOptAdds
[OP_SUBNET_MASK_IX
- 1];
1836 if (LocalPtr
.OpPtr
!= NULL
) {
1838 (EFI_IPv4_ADDRESS
*) &Private
->EfiBc
.Mode
->SubnetMask
,
1839 &LocalPtr
.SubnetMaskStr
->Ip
,
1840 sizeof (EFI_IPv4_ADDRESS
)
1844 AddRouters (Private
, DhcpRxBuf
);
1845 gBS
->CloseEvent (TimeoutEvent
);
1849 gBS
->CloseEvent (TimeoutEvent
);
1853 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
1856 // try a DHCP server of appropriate type
1861 PXE_BASECODE_DEVICE
*Private
,
1868 // go through the DHCP servers of the requested type
1870 for (Index
= 0; Index
< Private
->ServerCount
[TypeIx
]; ++Index
) {
1871 if (TryFinishDORA (Private
, Index
= Private
->OfferCount
[TypeIx
][Index
])) {
1872 if (TypeIx
== BINL_IX
&& !TryFinishBINL (Private
, Index
)) {
1883 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
1886 // try a DHCP only server and a proxy of appropriate type
1890 TryProxyFinishDORA (
1891 PXE_BASECODE_DEVICE
*Private
,
1897 if (!Private
->GotProxy
[TypeIx
]) {
1899 // no proxies of the type wanted
1904 // go through the DHCP only servers
1906 for (Index
= 0; Index
< Private
->ServerCount
[DHCP_ONLY_IX
]; ++Index
) {
1907 if (TryFinishDORA (Private
, Private
->OfferCount
[DHCP_ONLY_IX
][Index
])) {
1908 if (TypeIx
!= BINL_IX
) {
1909 CopyProxyRxBuf (Private
, Private
->GotProxy
[TypeIx
] - 1);
1910 } else if (!TryFinishProxyBINL (Private
)) {
1912 // if didn't work with this DHCP, won't work with any
1924 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
1927 // getting to the bottom of the barrel
1931 TryAnyWithBootfileFinishDORA (
1932 PXE_BASECODE_DEVICE
*Private
1936 // try a DHCP only server who has a bootfile
1941 for (Index
= 0; Index
< Private
->ServerCount
[DHCP_ONLY_IX
]; ++Index
) {
1944 offer
= Private
->OfferCount
[DHCP_ONLY_IX
][Index
];
1946 if (RxBuf
[offer
].OpAdds
.PktOptAdds
[OP_DHCP_BOOTFILE_IX
- 1] && TryFinishDORA (Private
, offer
)) {
1951 // really at bottom - see if be have any bootps
1953 if (!Private
->GotBootp
) {
1957 DHCP_REQ_OPTIONS
.OpReqIP
.Ip
= *(EFI_IPv4_ADDRESS
*) &RxBuf
[Private
->GotBootp
- 1].u
.Dhcpv4
.yiaddr
;
1959 if (!SetStationIP (Private
)) {
1963 // treat BOOTP response as DHCP ACK packet
1965 CopyParseRxBuf (Private
, Private
->GotBootp
- 1, DHCPV4_ACK_INDEX
);
1967 LocalPtr
.OpPtr
= RxBuf
[Private
->GotBootp
- 1].OpAdds
.PktOptAdds
[OP_SUBNET_MASK_IX
- 1];
1969 if (LocalPtr
.OpPtr
!= NULL
) {
1970 *(EFI_IPv4_ADDRESS
*) &Private
->EfiBc
.Mode
->SubnetMask
= LocalPtr
.SubnetMaskStr
->Ip
;
1976 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
1983 PXE_BASECODE_DEVICE
*Private
,
1987 EFI_PXE_BASE_CODE_IP_FILTER Filter
;
1988 EFI_STATUS StatCode
;
1991 Filter
.Filters
= EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP
| EFI_PXE_BASE_CODE_IP_FILTER_BROADCAST
;
1994 Filter
.reserved
= 0;
1997 // set filter unicast or broadcast
1999 if ((StatCode
= IpFilter (Private
, &Filter
)) != EFI_SUCCESS
) {
2003 // seed random number with hardware address
2005 SeedRandom (Private
, *(UINT16
*) &Private
->SimpleNetwork
->Mode
->CurrentAddress
);
2007 for (Private
->Timeout
= 1;
2008 Private
->Timeout
< 17;
2009 Private
->TotalSeconds
= (UINT16
) (Private
->TotalSeconds
+ Private
->Timeout
), Private
->Timeout
<<= 1
2013 InitDhcpv4TxBuf (Private
);
2014 DHCPV4_TRANSMIT_BUFFER
.xid
= Random (Private
);
2015 DHCPV4_TRANSMIT_BUFFER
.secs
= HTONS (Private
->TotalSeconds
);
2018 // broadcast DHCPDISCOVER
2020 StatCode
= DoUdpWrite (
2024 (EFI_IP_ADDRESS
*) &DHCPV4_TRANSMIT_BUFFER
.ciaddr
,
2028 if (StatCode
!= EFI_SUCCESS
) {
2033 &Private
->EfiBc
.Mode
->DhcpDiscover
,
2034 (EFI_PXE_BASE_CODE_PACKET
*) &DHCPV4_TRANSMIT_BUFFER
,
2035 sizeof (EFI_PXE_BASE_CODE_PACKET
)
2041 if ((StatCode
= GetOffers (Private
)) != EFI_SUCCESS
) {
2042 if (StatCode
!= EFI_NO_RESPONSE
) {
2049 // select offer and reply DHCPREQUEST
2052 if (TryDHCPFinishDORA(Private
, PXE10_IX
) || // try DHCP with PXE10
2053 TryDHCPFinishDORA(Private
, WfM11a_IX
) || // no - try with WfM
2054 TryProxyFinishDORA(Private
, PXE10_IX
) || // no - try DHCP only and proxy with PXE10
2055 TryProxyFinishDORA(Private
, WfM11a_IX
) || // no - try DHCP only and proxy with WfM
2056 TryDHCPFinishDORA(Private
, BINL_IX
) || // no - try with WfM
2057 TryProxyFinishDORA(Private
, BINL_IX
) || // no - try DHCP only and proxy with PXE10
2058 TryAnyWithBootfileFinishDORA(Private
))
2068 NumOffers
= Private
->NumOffersReceived
;
2070 for (Index
= 0; Index
< NumOffers
; ++Index
) {
2074 if (!RxBuf
[Index
].u
.Dhcpv4
.yiaddr
) {
2078 // check if a bootp server
2080 if (!RxBuf
[Index
].OpAdds
.PktOptAdds
[OP_DHCP_MESSAGE_TYPE_IX
- 1]) {
2082 // it is - just check ARP
2084 if (!SetStationIP (Private
)) {
2089 // else check if a DHCP only server
2091 else if (!(RxBuf
[Index
].OpAdds
.Status
& (DISCOVER_TYPE
| WfM11a_TYPE
| PXE_TYPE
))) {
2093 // it is a normal DHCP offer (without any PXE options), just finish the D.O.R.A by sending DHCP request.
2095 if (!TryFinishDORA (Private
, Index
)) {
2098 } else if (TryFinishDORA (Private
, Index
)) {
2099 if (!(RxBuf
[Index
].OpAdds
.Status
& (DISCOVER_TYPE
| WfM11a_TYPE
)) && !TryFinishBINL (Private
, Index
)) {
2104 DEBUG ((EFI_D_WARN
, "\nDoDhcpDora() Got packets. "));
2108 // now look for DHCP onlys and a Proxy
2110 for (Index
= 0; Index
< NumOffers
; ++Index
) {
2114 // ignore proxies, bootps, non DHCP onlys, and bootable DHCPS
2116 if (!RxBuf
[Index
].u
.Dhcpv4
.yiaddr
||
2117 !RxBuf
[Index
].OpAdds
.PktOptAdds
[OP_DHCP_MESSAGE_TYPE_IX
- 1] ||
2118 RxBuf
[Index
].OpAdds
.Status
& (DISCOVER_TYPE
| WfM11a_TYPE
| PXE_TYPE
) ||
2119 RxBuf
[Index
].OpAdds
.PktOptAdds
[OP_DHCP_BOOTFILE_IX
- 1]
2124 // found non bootable DHCP only - try to find a proxy
2126 for (Index2
= 0; Index2
< NumOffers
; ++Index2
) {
2127 if (!RxBuf
[Index2
].u
.Dhcpv4
.yiaddr
) {
2128 if (!TryFinishDORA (Private
, Index
)) {
2135 if (RxBuf
[Index2
].OpAdds
.Status
& (DISCOVER_TYPE
| WfM11a_TYPE
)) {
2136 CopyProxyRxBuf (Private
, Index2
);
2137 } else if (!TryFinishBINL (Private
, Index2
)) {
2141 DEBUG ((EFI_D_WARN
, "\nDoDhcpDora() Got packets. "));
2148 return EFI_NO_RESPONSE
;
2151 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
2154 // determine if the server ip is in the ip list
2159 EFI_IP_ADDRESS
*ServerIpPtr
,
2160 PXE_SERVER_LISTS
*ServerListPtr
2165 if (!ServerListPtr
|| !ServerListPtr
->Ipv4List
.IpCount
) {
2169 for (Index
= 0; Index
< ServerListPtr
->Ipv4List
.IpCount
; ++Index
) {
2172 &ServerListPtr
->Ipv4List
.IpList
[Index
],
2173 sizeof (EFI_IPv4_ADDRESS
)
2182 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
2185 ExtractBootServerList (
2187 DHCPV4_OP_STRUCT
*ptr
,
2188 PXE_SERVER_LISTS
**ServerListPtr
2194 LocalPtr
.OpPtr
= ptr
;
2195 ServerListLen
= LocalPtr
.BootServersStr
->Header
.Length
;
2200 LocalPtr
.BootServerList
= LocalPtr
.BootServersStr
->ServerList
;
2202 while (ServerListLen
) {
2203 INTN ServerEntryLen
;
2205 ServerEntryLen
= sizeof (PXEV4_SERVER_LIST
) + 2 + (LocalPtr
.BootServerList
->u
.Ipv4List
.IpCount
- 1) *
2206 sizeof (EFI_IPv4_ADDRESS
);
2208 if (NTOHS (LocalPtr
.BootServerList
->Type
) == Type
) {
2209 *ServerListPtr
= &LocalPtr
.BootServerList
->u
;
2213 (LocalPtr
.BytePtr
) += ServerEntryLen
;
2214 ServerListLen
-= ServerEntryLen
;
2220 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
2224 PXE_BASECODE_DEVICE
*Private
2227 if (Private
->TransmitBuffer
!= NULL
) {
2228 gBS
->FreePool (Private
->TransmitBuffer
);
2229 Private
->TransmitBuffer
= NULL
;
2232 if (Private
->ReceiveBuffers
!= NULL
) {
2233 gBS
->FreePool (Private
->ReceiveBuffers
);
2234 Private
->ReceiveBuffers
= NULL
;
2238 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
2242 PXE_BASECODE_DEVICE
*Private
2247 if (Private
->DhcpPacketBuffer
== NULL
) {
2248 Status
= gBS
->AllocatePool (
2249 EfiBootServicesData
,
2250 sizeof (DHCP_RECEIVE_BUFFER
) * (PXE_BIS_INDEX
+ 1),
2251 &Private
->DhcpPacketBuffer
2254 if (EFI_ERROR (Status
) || Private
->DhcpPacketBuffer
== NULL
) {
2255 Private
->DhcpPacketBuffer
= NULL
;
2261 Status
= gBS
->AllocatePool (
2262 EfiBootServicesData
,
2263 sizeof (EFI_PXE_BASE_CODE_PACKET
),
2264 &Private
->TransmitBuffer
2267 if (EFI_ERROR (Status
) || Private
->TransmitBuffer
== NULL
) {
2268 gBS
->FreePool (Private
->DhcpPacketBuffer
);
2269 Private
->DhcpPacketBuffer
= NULL
;
2270 Private
->TransmitBuffer
= NULL
;
2275 Status
= gBS
->AllocatePool (
2276 EfiBootServicesData
,
2277 sizeof (DHCP_RECEIVE_BUFFER
) * (MAX_OFFERS
),
2278 &Private
->ReceiveBuffers
2281 if (EFI_ERROR (Status
) || Private
->ReceiveBuffers
== NULL
) {
2282 gBS
->FreePool (Private
->TransmitBuffer
);
2283 gBS
->FreePool (Private
->DhcpPacketBuffer
);
2284 Private
->DhcpPacketBuffer
= NULL
;
2285 Private
->TransmitBuffer
= NULL
;
2286 Private
->ReceiveBuffers
= NULL
;
2294 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
2298 IN EFI_PXE_BASE_CODE_PROTOCOL
*This
,
2299 IN BOOLEAN SortOffers
2302 Routine description:
2303 standard DHCP Discover/Offer/Request/Ack session
2304 broadcast DHCPDISCOVER
2306 broadcast DHCPREQUEST
2311 This := Pointer to PxeBc interface
2317 EFI_PXE_BASE_CODE_IP_FILTER Filter
;
2318 EFI_PXE_BASE_CODE_MODE
*PxebcMode
;
2319 PXE_BASECODE_DEVICE
*Private
;
2320 EFI_STATUS StatCode
;
2323 // Lock the instance data and make sure started
2325 StatCode
= EFI_SUCCESS
;
2328 DEBUG ((EFI_D_ERROR
, "BC *This pointer == NULL"));
2329 return EFI_INVALID_PARAMETER
;
2332 Private
= CR (This
, PXE_BASECODE_DEVICE
, EfiBc
, PXE_BASECODE_DEVICE_SIGNATURE
);
2334 if (Private
== NULL
) {
2335 DEBUG ((EFI_D_ERROR
, "PXE_BASECODE_DEVICE pointer == NULL"));
2336 return EFI_INVALID_PARAMETER
;
2339 EfiAcquireLock (&Private
->Lock
);
2341 if (This
->Mode
== NULL
|| !This
->Mode
->Started
) {
2342 DEBUG ((EFI_D_ERROR
, "BC was not started."));
2343 EfiReleaseLock (&Private
->Lock
);
2344 return EFI_NOT_STARTED
;
2347 Filter
.Filters
= EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP
;
2349 Filter
.reserved
= 0;
2351 DEBUG ((EFI_D_INFO
, "\nBcDhcp() Enter. "));
2353 PxebcMode
= Private
->EfiBc
.Mode
;
2355 if (!GetMem (Private
)) {
2356 DEBUG ((EFI_D_ERROR
, "\nBcDhcp() GetMem() failed.\n"));
2357 EfiReleaseLock (&Private
->Lock
);
2358 return EFI_OUT_OF_RESOURCES
;
2361 PxebcMode
->DhcpDiscoverValid
= FALSE
;
2362 PxebcMode
->DhcpAckReceived
= FALSE
;
2363 PxebcMode
->ProxyOfferReceived
= FALSE
;
2365 Private
->Function
= EFI_PXE_BASE_CODE_FUNCTION_DHCP
;
2370 if (Private
->TotalSeconds
== 0) {
2372 // put in seconds field of DHCP send packets
2374 Private
->TotalSeconds
= 4;
2377 if ((StatCode
= DoDhcpDora (Private
, SortOffers
)) == EFI_SUCCESS
) {
2379 // success - copy packets
2381 PxebcMode
->DhcpDiscoverValid
= PxebcMode
->DhcpAckReceived
= TRUE
;
2384 &PxebcMode
->DhcpAck
,
2385 (EFI_PXE_BASE_CODE_PACKET
*) &DHCPV4_ACK_PACKET
,
2386 sizeof (EFI_PXE_BASE_CODE_PACKET
)
2389 if (PxebcMode
->ProxyOfferReceived
) {
2391 &PxebcMode
->ProxyOffer
,
2392 (EFI_PXE_BASE_CODE_PACKET
*) &PXE_OFFER_PACKET
,
2393 sizeof (EFI_PXE_BASE_CODE_PACKET
)
2398 // set filter back to unicast
2400 IpFilter (Private
, &Filter
);
2405 // Unlock the instance data
2407 DEBUG ((EFI_D_WARN
, "\nBcDhcp() Exit = %xh ", StatCode
));
2409 EfiReleaseLock (&Private
->Lock
);
2413 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
2416 VerifyCredentialOption (
2424 // Fail verification if either pointer is NULL.
2426 if (tx
== NULL
|| rx
== NULL
) {
2430 // Fail verification if tx[0] is not a credential type option
2431 // or if the length is zero or not a multiple of four.
2433 if (tx
[0] != VEND_PXE_CREDENTIAL_TYPES
|| tx
[1] == 0 || tx
[1] % 4 != 0) {
2437 // Fail verification if rx[0] is not a credential type option
2438 // or if the length is not equal to four.
2440 if (rx
[0] != VEND_PXE_CREDENTIAL_TYPES
|| rx
[1] != 4) {
2444 // Look through transmitted credential types for a copy
2445 // of the received credential type.
2447 for (n
= 0; n
< tx
[1]; n
+= 4) {
2448 if (!CompareMem (&tx
[n
+ 2], &rx
[2], 4)) {
2456 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
2460 PXE_BASECODE_DEVICE
*Private
,
2463 IN UINT16
*LayerPtr
,
2465 EFI_IP_ADDRESS
*DestPtr
,
2466 PXE_SERVER_LISTS
*ServerListPtr
2469 Routine description:
2470 This function tries to complete the PXE Bootserver and/or boot image
2471 discovery sequence. When this command completes successfully, the
2472 PXEdiscover and PXEreply fields in the BC instance data structure are
2473 updated. If the Info pointer is set to NULL, the discovery information
2474 in the DHCPack and ProxyOffer packets must be valid and will be used.
2475 If Info is not set to NULL, the discovery methods in the Info field
2476 must be set and will be used. When discovering any layer number other
2477 than zero (the credential flag does not count), only unicast discovery
2481 Private := Pointer to PxeBc interface
2492 EFI_PXE_BASE_CODE_UDP_PORT ClientPort
;
2493 EFI_PXE_BASE_CODE_UDP_PORT ServerPort
;
2494 EFI_PXE_BASE_CODE_MODE
*PxebcMode
;
2495 EFI_STATUS StatCode
;
2496 EFI_EVENT TimeoutEvent
;
2499 PxebcMode
= Private
->EfiBc
.Mode
;
2501 if (DestPtr
->Addr
[0] == 0) {
2502 DEBUG ((EFI_D_WARN
, "\nDoDiscover() !DestPtr->Addr[0]"));
2503 return EFI_INVALID_PARAMETER
;
2506 // seed random number with hardware address
2508 SeedRandom (Private
, *(UINT16
*) &Private
->SimpleNetwork
->Mode
->CurrentAddress
);
2510 if (DestPtr
->Addr
[0] == BroadcastIP
.Addr
[0]) {
2511 ClientPort
= DHCPClientPort
;
2512 ServerPort
= DhcpServerPort
;
2514 ClientPort
= PSEUDO_DHCP_CLIENT_PORT
;
2515 ServerPort
= PseudoDhcpServerPort
;
2519 *LayerPtr
|= PXE_BOOT_LAYER_CREDENTIAL_FLAG
;
2521 *LayerPtr
&= PXE_BOOT_LAYER_MASK
;
2524 for (Private
->Timeout
= 1;
2525 Private
->Timeout
< 5;
2526 Private
->TotalSeconds
= (UINT16
) (Private
->TotalSeconds
+ Private
->Timeout
), ++Private
->Timeout
2528 InitDhcpv4TxBuf (Private
);
2530 // initialize DHCP message structure
2532 DHCPV4_TRANSMIT_BUFFER
.xid
= Random (Private
);
2533 DHCPV4_TRANSMIT_BUFFER
.secs
= HTONS (Private
->TotalSeconds
);
2535 &DHCPV4_TRANSMIT_BUFFER
.ciaddr
,
2536 &PxebcMode
->StationIp
,
2537 sizeof DHCPV4_TRANSMIT_BUFFER
.ciaddr
2540 DHCPV4_OPTIONS_BUFFER
.DhcpMessageType
.Type
= DHCPREQUEST
;
2541 DISCOVERoptions
.Header
.OpCode
= OP_VENDOR_SPECIFIC
;
2542 DISCOVERoptions
.BootItem
.Header
.OpCode
= VEND_PXE_BOOT_ITEM
;
2543 DISCOVERoptions
.BootItem
.Header
.Length
= DHCPV4_OPTION_LENGTH (PXE_OP_BOOT_ITEM
);
2544 DISCOVERoptions
.BootItem
.Type
= HTONS (Type
);
2545 DISCOVERoptions
.BootItem
.Layer
= HTONS (*LayerPtr
);
2548 EFI_BIS_PROTOCOL
*BisPtr
;
2549 BIS_APPLICATION_HANDLE BisAppHandle
;
2550 EFI_BIS_DATA
*BisDataSigInfo
;
2551 EFI_BIS_SIGNATURE_INFO
*BisSigInfo
;
2555 BisPtr
= PxebcBisStart (
2561 if (BisPtr
== NULL
) {
2563 // %%TBD - In order to get here, BIS must have
2564 // been present when PXEBC.Start() was called.
2565 // BIS had to be shutdown/removed/damaged
2566 // before PXEBC.Discover() was called.
2567 // Do we need to document a specific error
2570 return EFI_OUT_OF_RESOURCES
;
2573 // Compute number of credential types.
2575 Index2
= BisDataSigInfo
->Length
/ sizeof (EFI_BIS_SIGNATURE_INFO
);
2577 DISCREDoptions
.Header
.OpCode
= VEND_PXE_CREDENTIAL_TYPES
;
2579 DISCREDoptions
.Header
.Length
= (UINT8
) (Index2
* sizeof (PXE_CREDENTIAL
));
2581 OpLen
= (UINT8
) (DHCPV4_OPTION_LENGTH (PXE_DISCOVER_OPTIONS
) + sizeof (DHCPV4_OP_HEADER
) + DISCREDoptions
.Header
.Length
);
2583 BisSigInfo
= (EFI_BIS_SIGNATURE_INFO
*) BisDataSigInfo
->Data
;
2585 for (Index
= 0; Index
< Index2
; ++Index
) {
2588 CopyMem (&x
, &BisSigInfo
[Index
], sizeof x
);
2590 CopyMem (&DISCREDoptions
.Credentials
[Index
], &x
, sizeof x
);
2593 PxebcBisStop (BisPtr
, BisAppHandle
, BisDataSigInfo
);
2595 OpLen
= DHCPV4_OPTION_LENGTH (PXE_DISCOVER_OPTIONS
);
2598 DISCOVERoptions
.Header
.Length
= OpLen
;
2600 ((UINT8
*) &DISCOVERoptions
)[sizeof (DHCPV4_OP_HEADER
) + OpLen
- 1] = OP_END
;
2601 ((UINT8
*) &DISCOVERoptions
)[sizeof (DHCPV4_OP_HEADER
) + OpLen
] = OP_END
;
2603 StatCode
= DoUdpWrite (
2607 (EFI_IP_ADDRESS
*) &DHCPV4_TRANSMIT_BUFFER
.ciaddr
,
2611 if (StatCode
!= EFI_SUCCESS
) {
2617 StatCode
= gBS
->CreateEvent (
2625 if (EFI_ERROR (StatCode
)) {
2629 StatCode
= gBS
->SetTimer (
2632 Private
->Timeout
* 10000000 + 1000000
2635 if (EFI_ERROR (StatCode
)) {
2636 gBS
->CloseEvent (TimeoutEvent
);
2643 DHCP_RECEIVE_BUFFER
*RxBufPtr
;
2647 RxBufPtr
= UseBis
? &PXE_BIS_BUFFER
: &PXE_ACK_BUFFER
;
2648 ZeroMem (&Private
->ServerIp
, sizeof (EFI_IP_ADDRESS
));
2654 (EFI_IP_ADDRESS
*) &Private
->ServerIp
,
2656 (EFI_IP_ADDRESS
*) &DHCPV4_TRANSMIT_BUFFER
.ciaddr
,
2664 // check type of response - need PXEClient DHCPACK of proper type with bootfile
2666 if (!(RxBufPtr
->OpAdds
.Status
& PXE_TYPE
) ||
2667 (UseBis
&& (RxBufPtr
->OpAdds
.Status
& USE_THREE_BYTE
)) ||
2668 !RxBufPtr
->OpAdds
.PktOptAdds
[OP_DHCP_BOOTFILE_IX
- 1] ||
2669 !RxBufPtr
->OpAdds
.PktOptAdds
[OP_DHCP_SERVER_IP_IX
- 1] ||
2670 !InServerList((EFI_IP_ADDRESS
*)&((DHCPV4_OP_SERVER_IP
*)RxBufPtr
->OpAdds
.PktOptAdds
[OP_DHCP_SERVER_IP_IX
-1])->Ip
, ServerListPtr
)) {
2675 TmpType
= TmpLayer
= 0;
2677 if (RxBufPtr
->OpAdds
.PxeOptAdds
[VEND_PXE_BOOT_ITEM_IX
- 1]) {
2678 TmpType
= NTOHS (((PXE_OP_BOOT_ITEM
*) RxBufPtr
->OpAdds
.PxeOptAdds
[VEND_PXE_BOOT_ITEM_IX
- 1])->Type
);
2680 if (RxBufPtr
->OpAdds
.Status
& USE_THREE_BYTE
) {
2681 TmpLayer
= (UINT16
) (((PXE_OP_BOOT_ITEM
*) RxBufPtr
->OpAdds
.PxeOptAdds
[VEND_PXE_BOOT_ITEM_IX
- 1])->Layer
>> 8);
2683 TmpLayer
= NTOHS (((PXE_OP_BOOT_ITEM
*) RxBufPtr
->OpAdds
.PxeOptAdds
[VEND_PXE_BOOT_ITEM_IX
- 1])->Layer
);
2687 if (TmpType
!= Type
) {
2692 if (!RxBufPtr
->OpAdds
.PxeOptAdds
[VEND_PXE_CREDENTIAL_TYPES_IX
- 1]) {
2696 if (!VerifyCredentialOption (
2697 (UINT8
*) &DISCREDoptions
.Header
,
2698 (UINT8
*) RxBufPtr
->OpAdds
.PxeOptAdds
[VEND_PXE_CREDENTIAL_TYPES_IX
- 1]
2704 *LayerPtr
= TmpLayer
;
2708 &PxebcMode
->PxeBisReply
,
2709 &RxBufPtr
->u
.Dhcpv4
,
2710 sizeof (EFI_PXE_BASE_CODE_PACKET
)
2713 PxebcMode
->PxeBisReplyReceived
= TRUE
;
2715 StatCode
= DoDiscover (
2717 EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_PORT
,
2725 gBS
->CloseEvent (TimeoutEvent
);
2729 PxebcMode
->PxeDiscoverValid
= PxebcMode
->PxeReplyReceived
= TRUE
;
2732 &PxebcMode
->PxeDiscover
,
2733 &*(EFI_PXE_BASE_CODE_PACKET
*) &DHCPV4_TRANSMIT_BUFFER
,
2734 sizeof (*(EFI_PXE_BASE_CODE_PACKET
*) &DHCPV4_TRANSMIT_BUFFER
)
2738 &PxebcMode
->PxeReply
,
2739 &*(EFI_PXE_BASE_CODE_PACKET
*) &RxBufPtr
->u
.Dhcpv4
,
2740 sizeof (*(EFI_PXE_BASE_CODE_PACKET
*) &RxBufPtr
->u
.Dhcpv4
)
2743 AddRouters (Private
, RxBufPtr
);
2745 gBS
->CloseEvent (TimeoutEvent
);
2749 gBS
->CloseEvent (TimeoutEvent
);
2757 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
2761 PXE_BASECODE_DEVICE
*Private
,
2763 IN UINT16
*LayerPtr
,
2765 IN EFI_PXE_BASE_CODE_DISCOVER_INFO
*DiscoverInfoPtr
,
2766 PXE_SERVER_LISTS
*McastServerListPtr
,
2767 PXE_SERVER_LISTS
*ServerListPtr
2770 Routine Description:
2773 Private := Pointer to PxeBc interface
2778 McastServerListPtr :=
2784 EFI_IP_ADDRESS DestIp
;
2785 EFI_STATUS StatCode
;
2787 DEBUG ((EFI_D_INFO
, "\nDiscover() Type=%d Layer=%d ", Type
, *LayerPtr
));
2790 DEBUG ((EFI_D_INFO
, "BIS "));
2793 // get dest IP addr - mcast, bcast, or unicast
2795 if (DiscoverInfoPtr
->UseMCast
) {
2796 DestIp
.v4
= DiscoverInfoPtr
->ServerMCastIp
.v4
;
2800 "\nDiscover() MCast %d.%d.%d.%d ",
2807 if ((StatCode
= DoDiscover (
2809 EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_IP
| EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_PORT
,
2815 )) != EFI_TIMEOUT
) {
2818 "\nDiscover() status == %r (%Xh)",
2827 if (DiscoverInfoPtr
->UseBCast
) {
2828 DEBUG ((EFI_D_INFO
, "\nDiscver() BCast "));
2830 if ((StatCode
= DoDiscover (
2832 EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_IP
| EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_PORT
,
2838 )) != EFI_TIMEOUT
) {
2840 DEBUG ((EFI_D_WARN
, "\nDiscover() status == %r (%Xh)", StatCode
, StatCode
));
2846 if (DiscoverInfoPtr
->UseUCast
) {
2851 "\nDiscover() UCast IP#=%d ",
2852 ServerListPtr
->Ipv4List
.IpCount
)
2855 for (Index
= 0; Index
< ServerListPtr
->Ipv4List
.IpCount
; ++Index
) {
2856 CopyMem (&DestIp
, &ServerListPtr
->Ipv4List
.IpList
[Index
], 4);
2860 "\nDiscover() UCast %d.%d.%d.%d ",
2867 if ((StatCode
= DoDiscover (
2869 EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_IP
| EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_PORT
,
2875 )) != EFI_TIMEOUT
) {
2878 "\nDiscover() status == %r (%Xh)",
2888 DEBUG ((EFI_D_WARN
, "\nDiscover() TIMEOUT"));
2893 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
2900 IN EFI_PXE_BASE_CODE_PROTOCOL
* This
,
2902 IN UINT16
*LayerPtr
,
2904 IN EFI_PXE_BASE_CODE_DISCOVER_INFO
* DiscoverInfoPtr OPTIONAL
2907 Routine description:
2919 EFI_PXE_BASE_CODE_DISCOVER_INFO DefaultInfo
;
2920 EFI_PXE_BASE_CODE_MODE
*PxebcMode
;
2921 DHCP_RECEIVE_BUFFER
*DhcpRxBuf
;
2922 PXE_SERVER_LISTS DefaultSrvList
;
2923 PXE_SERVER_LISTS
*ServerListPtr
;
2924 PXE_SERVER_LISTS
*McastServerListPtr
;
2929 BOOLEAN AcquiredSrvList
;
2930 EFI_STATUS StatCode
;
2931 PXE_BASECODE_DEVICE
*Private
;
2934 // Lock the instance data and make sure started
2936 StatCode
= EFI_SUCCESS
;
2939 DEBUG ((EFI_D_ERROR
, "BC *This pointer == NULL"));
2940 return EFI_INVALID_PARAMETER
;
2943 Private
= CR (This
, PXE_BASECODE_DEVICE
, EfiBc
, PXE_BASECODE_DEVICE_SIGNATURE
);
2945 if (Private
== NULL
) {
2946 DEBUG ((EFI_D_ERROR
, "PXE_BASECODE_DEVICE poiner == NULL"));
2947 return EFI_INVALID_PARAMETER
;
2950 EfiAcquireLock (&Private
->Lock
);
2952 if (This
->Mode
== NULL
|| !This
->Mode
->Started
) {
2953 DEBUG ((EFI_D_ERROR
, "BC was not started."));
2954 EfiReleaseLock (&Private
->Lock
);
2955 return EFI_NOT_STARTED
;
2958 ServerListPtr
= NULL
;
2959 McastServerListPtr
= NULL
;
2960 AcquiredSrvList
= FALSE
;
2962 PxebcMode
= Private
->EfiBc
.Mode
;
2964 if (!GetMem (Private
)) {
2965 EfiReleaseLock (&Private
->Lock
);
2966 return EFI_OUT_OF_RESOURCES
;
2970 if (!PxebcMode
->BisSupported
) {
2971 EfiReleaseLock (&Private
->Lock
);
2972 return EFI_INVALID_PARAMETER
;
2976 Private
->Function
= EFI_PXE_BASE_CODE_FUNCTION_DISCOVER
;
2978 if (Private
->TotalSeconds
== 0) {
2980 // put in seconds field of DHCP send packets
2982 Private
->TotalSeconds
= 4;
2985 ZeroMem (&DefaultInfo
, sizeof (EFI_PXE_BASE_CODE_DISCOVER_INFO
));
2988 // if layer number not zero, use previous discover
2990 if (*LayerPtr
!= 0) {
2991 DEBUG ((EFI_D_WARN
, "\nBcDiscover() layer != 0"));
2993 if (DiscoverInfoPtr
!= NULL
) {
2994 DEBUG ((EFI_D_WARN
, "\nBcDiscover() layer != 0 && DiscoverInfoPtr != NULL\n"));
2996 EfiReleaseLock (&Private
->Lock
);
2997 return EFI_INVALID_PARAMETER
;
3000 if (!PxebcMode
->PxeDiscoverValid
) {
3001 DEBUG ((EFI_D_WARN
, "\nBcDiscover() layer != 0 && PxeDiscoverValid == 0\n"));
3003 EfiReleaseLock (&Private
->Lock
);
3004 return EFI_INVALID_PARAMETER
;
3007 if (!PxebcMode
->PxeReplyReceived
) {
3008 DEBUG ((EFI_D_WARN
, "\nBcDiscover() layer != 0 && PxeReplyReceived == 0\n"));
3010 EfiReleaseLock (&Private
->Lock
);
3011 return EFI_INVALID_PARAMETER
;
3014 if (UseBis
&& !PxebcMode
->PxeBisReplyReceived
) {
3015 DEBUG ((EFI_D_WARN
, "\nBcDiscover() layer != 0 && PxeBisReplyReceived == 0\n"));
3017 EfiReleaseLock (&Private
->Lock
);
3018 return EFI_INVALID_PARAMETER
;
3021 DefaultInfo
.UseUCast
= TRUE
;
3022 DiscoverInfoPtr
= &DefaultInfo
;
3024 DefaultSrvList
.Ipv4List
.IpCount
= 1;
3025 CopyMem (&DefaultSrvList
.Ipv4List
.IpList
[0], &Private
->ServerIp
, 4);
3027 ServerListPtr
= &DefaultSrvList
;
3030 // layer is zero - see if info is supplied or if we need to use info from a cached offer
3032 else if (!DiscoverInfoPtr
) {
3034 // not supplied - generate it
3035 // make sure that there is cached, appropriate information
3036 // if neither DhcpAck packet nor ProxyOffer packet has pxe info, fail
3038 DhcpRxBuf
= (PxebcMode
->ProxyOfferReceived
) ? &PXE_OFFER_BUFFER
: &DHCPV4_ACK_BUFFER
;
3040 if (!PxebcMode
->DhcpAckReceived
|| !(DhcpRxBuf
->OpAdds
.Status
& DISCOVER_TYPE
)) {
3041 DEBUG ((EFI_D_WARN
, "\nBcDiscover() !ack && !proxy"));
3042 EfiReleaseLock (&Private
->Lock
);
3043 return EFI_INVALID_PARAMETER
;
3046 DiscoverInfoPtr
= &DefaultInfo
;
3048 LocalPtr
.OpPtr
= DhcpRxBuf
->OpAdds
.PxeOptAdds
[VEND_PXE_DISCOVERY_CONTROL_IX
- 1];
3051 // if multicast enabled, need multicast address
3053 if (!(LocalPtr
.DiscoveryControl
->ControlBits
& DISABLE_MCAST
)) {
3054 DefaultInfo
.UseMCast
= TRUE
;
3057 ((EFI_IPv4_ADDRESS
*) &DefaultInfo
.ServerMCastIp
),
3058 &((DHCPV4_OP_IP_ADDRESS
*) DhcpRxBuf
->OpAdds
.PxeOptAdds
[VEND_PXE_DISCOVERY_MCAST_ADDR_IX
- 1])->Ip
,
3059 sizeof (EFI_IPv4_ADDRESS
)
3063 DefaultInfo
.UseBCast
= (BOOLEAN
) ((LocalPtr
.DiscoveryControl
->ControlBits
& DISABLE_BCAST
) == 0);
3065 DefaultInfo
.MustUseList
= (BOOLEAN
) ((LocalPtr
.DiscoveryControl
->ControlBits
& USE_ACCEPT_LIST
) != 0);
3067 DefaultInfo
.UseUCast
= (BOOLEAN
)
3069 (DefaultInfo
.MustUseList
) ||
3070 ((LocalPtr
.DiscoveryControl
->ControlBits
& (DISABLE_MCAST
| DISABLE_BCAST
)) == (DISABLE_MCAST
| DISABLE_BCAST
))
3073 if ((DefaultInfo
.UseUCast
| DefaultInfo
.MustUseList
) && !ExtractBootServerList (
3075 DhcpRxBuf
->OpAdds
.PxeOptAdds
[VEND_PXE_BOOT_SERVERS_IX
- 1],
3078 DEBUG ((EFI_D_WARN
, "\nBcDiscover() type not in list"));
3079 EfiReleaseLock (&Private
->Lock
);
3080 return EFI_INVALID_PARAMETER
;
3084 // Info supplied - make SrvList if required
3085 // if we use ucast discovery or must use list, there better be one
3087 else if (DiscoverInfoPtr
->UseUCast
|| DiscoverInfoPtr
->MustUseList
) {
3089 // there better be a list
3091 if (DiscoverInfoPtr
->IpCnt
== 0) {
3092 DEBUG ((EFI_D_WARN
, "\nBcDiscover() no bootserver list"));
3093 EfiReleaseLock (&Private
->Lock
);
3094 return EFI_INVALID_PARAMETER
;
3099 for (Index
= Index2
= 0; Index
< DiscoverInfoPtr
->IpCnt
; ++Index
) {
3100 if (DiscoverInfoPtr
->SrvList
[Index
].Type
== Type
) {
3101 if (DiscoverInfoPtr
->SrvList
[Index
].AcceptAnyResponse
) {
3103 DEBUG ((EFI_D_WARN
, "\nBcDiscover() accept any?"));
3104 EfiReleaseLock (&Private
->Lock
);
3105 return EFI_INVALID_PARAMETER
;
3108 DefaultSrvList
.Ipv4List
.IpCount
= 0;
3109 ServerListPtr
= &DefaultSrvList
;
3119 DEBUG ((EFI_D_WARN
, "\nBcDiscover() !Index2?"));
3120 EfiReleaseLock (&Private
->Lock
);
3121 return EFI_INVALID_PARAMETER
;
3124 if (ServerListPtr
== NULL
) {
3125 Status
= gBS
->AllocatePool (
3126 EfiBootServicesData
,
3127 sizeof (PXEV4_SERVER_LIST
) + (Index2
- 1) * sizeof (EFI_IPv4_ADDRESS
),
3128 (VOID
**) &ServerListPtr
3131 if (EFI_ERROR (Status
) || ServerListPtr
== NULL
) {
3132 ServerListPtr
= NULL
;
3133 EfiReleaseLock (&Private
->Lock
);
3134 return EFI_OUT_OF_RESOURCES
;
3137 // build an array of IP addresses from the server list
3139 AcquiredSrvList
= TRUE
;
3140 ServerListPtr
->Ipv4List
.IpCount
= (UINT8
) Index2
;
3142 for (Index
= Index2
= 0; Index
< DiscoverInfoPtr
->IpCnt
; ++Index
) {
3143 if (DiscoverInfoPtr
->SrvList
[Index
].Type
== Type
) {
3145 &ServerListPtr
->Ipv4List
.IpList
[Index2
++],
3146 &DiscoverInfoPtr
->SrvList
[Index
].IpAddr
.v4
,
3147 sizeof ServerListPtr
->Ipv4List
.IpList
[0]
3154 if (DiscoverInfoPtr
->MustUseList
) {
3155 McastServerListPtr
= ServerListPtr
;
3158 if (!(DiscoverInfoPtr
->UseMCast
|| DiscoverInfoPtr
->UseBCast
|| DiscoverInfoPtr
->UseUCast
)) {
3159 DEBUG ((EFI_D_WARN
, "\nBcDiscover() Nothing to use!\n"));
3161 EfiReleaseLock (&Private
->Lock
);
3162 return EFI_INVALID_PARAMETER
;
3165 PxebcMode
->PxeDiscoverValid
= PxebcMode
->PxeReplyReceived
= PxebcMode
->PxeBisReplyReceived
= FALSE
;
3167 StatCode
= Discover (
3177 if (AcquiredSrvList
) {
3178 gBS
->FreePool (ServerListPtr
);
3184 // Unlock the instance data
3188 "\nBcDiscover() status == %r (%Xh)\n",
3193 EfiReleaseLock (&Private
->Lock
);
3197 /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
3201 IN EFI_PXE_BASE_CODE_PROTOCOL
* This
,
3202 BOOLEAN
*NewDhcpDiscoverValid
, OPTIONAL
3203 BOOLEAN
*NewDhcpAckReceived
, OPTIONAL
3204 BOOLEAN
*NewProxyOfferReceived
, OPTIONAL
3205 BOOLEAN
*NewPxeDiscoverValid
, OPTIONAL
3206 BOOLEAN
*NewPxeReplyReceived
, OPTIONAL
3207 BOOLEAN
*NewPxeBisReplyReceived
, OPTIONAL
3208 IN EFI_PXE_BASE_CODE_PACKET
* NewDhcpDiscover
, OPTIONAL
3209 IN EFI_PXE_BASE_CODE_PACKET
* NewDhcpAck
, OPTIONAL
3210 IN EFI_PXE_BASE_CODE_PACKET
* NewProxyOffer
, OPTIONAL
3211 IN EFI_PXE_BASE_CODE_PACKET
* NewPxeDiscover
, OPTIONAL
3212 IN EFI_PXE_BASE_CODE_PACKET
* NewPxeReply
, OPTIONAL
3213 IN EFI_PXE_BASE_CODE_PACKET
* NewPxeBisReply OPTIONAL
3216 Routine description:
3223 EFI_PXE_BASE_CODE_MODE
*PxebcMode
;
3225 PXE_BASECODE_DEVICE
*Private
;
3228 // Lock the instance data and make sure started
3232 DEBUG ((EFI_D_ERROR
, "BC *This pointer == NULL"));
3233 return EFI_INVALID_PARAMETER
;
3236 Private
= CR (This
, PXE_BASECODE_DEVICE
, EfiBc
, PXE_BASECODE_DEVICE_SIGNATURE
);
3238 if (Private
== NULL
) {
3239 DEBUG ((EFI_D_ERROR
, "PXE_BASECODE_DEVICE poiner == NULL"));
3240 return EFI_INVALID_PARAMETER
;
3243 EfiAcquireLock (&Private
->Lock
);
3245 if (This
->Mode
== NULL
|| !This
->Mode
->Started
) {
3246 DEBUG ((EFI_D_ERROR
, "BC was not started."));
3247 EfiReleaseLock (&Private
->Lock
);
3248 return EFI_NOT_STARTED
;
3251 PxebcMode
= Private
->EfiBc
.Mode
;
3253 if (Private
->DhcpPacketBuffer
== NULL
) {
3254 Status
= gBS
->AllocatePool (
3255 EfiBootServicesData
,
3256 sizeof (DHCP_RECEIVE_BUFFER
) * (PXE_BIS_INDEX
+ 1),
3257 &Private
->DhcpPacketBuffer
3260 if (EFI_ERROR (Status
) || Private
->DhcpPacketBuffer
== NULL
) {
3261 Private
->DhcpPacketBuffer
= NULL
;
3262 EfiReleaseLock (&Private
->Lock
);
3263 return EFI_OUT_OF_RESOURCES
;
3272 Private
->FileSize
= 0;
3273 if (NewDhcpDiscoverValid
!= NULL
) {
3274 PxebcMode
->DhcpDiscoverValid
= *NewDhcpDiscoverValid
;
3277 if (NewDhcpAckReceived
!= NULL
) {
3278 PxebcMode
->DhcpAckReceived
= *NewDhcpAckReceived
;
3281 if (NewProxyOfferReceived
!= NULL
) {
3282 PxebcMode
->ProxyOfferReceived
= *NewProxyOfferReceived
;
3285 if (NewPxeDiscoverValid
!= NULL
) {
3286 PxebcMode
->PxeDiscoverValid
= *NewPxeDiscoverValid
;
3289 if (NewPxeReplyReceived
!= NULL
) {
3290 PxebcMode
->PxeReplyReceived
= *NewPxeReplyReceived
;
3293 if (NewPxeBisReplyReceived
!= NULL
) {
3294 PxebcMode
->PxeBisReplyReceived
= *NewPxeBisReplyReceived
;
3297 if (NewDhcpDiscover
!= NULL
) {
3299 &PxebcMode
->DhcpDiscover
,
3301 sizeof *NewDhcpDiscover
3305 if (NewDhcpAck
!= NULL
) {
3306 CopyParse (Private
, &PxebcMode
->DhcpAck
, NewDhcpAck
, DHCPV4_ACK_INDEX
);
3309 if (NewProxyOffer
!= NULL
) {
3310 CopyParse (Private
, &PxebcMode
->ProxyOffer
, NewProxyOffer
, PXE_OFFER_INDEX
);
3313 if (NewPxeDiscover
!= NULL
) {
3315 &PxebcMode
->PxeDiscover
,
3317 sizeof *NewPxeDiscover
3321 if (NewPxeReply
!= NULL
) {
3322 CopyParse (Private
, &PxebcMode
->PxeReply
, NewPxeReply
, PXE_ACK_INDEX
);
3325 if (NewPxeBisReply
!= NULL
) {
3326 CopyParse (Private
, &PxebcMode
->PxeBisReply
, NewPxeBisReply
, PXE_BIS_INDEX
);
3329 // Unlock the instance data
3331 EfiReleaseLock (&Private
->Lock
);
3335 /* eof - pxe_bc_dhcp.c */