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.
23 #define EFI_MIN(_a, _b) ((_a) < (_b) ? (_a) : (_b))
26 #define CALLBACK_INTERVAL 100 // ten times a second
27 #define FILTER_BITS (EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP | \
28 EFI_PXE_BASE_CODE_IP_FILTER_BROADCAST | \
29 EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS | \
30 EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS_MULTICAST \
33 #define WAIT_TX_TIMEOUT 1000
35 #define SUPPORT_IPV6 0
37 #define PXE_BASECODE_DEVICE_SIGNATURE EFI_SIGNATURE_32('p','x','e','d')
40 // Determine the classes of IPv4 address
42 #define IS_CLASSA_IPADDR(x) ((((EFI_IP_ADDRESS*)x)->v4.Addr[0] & 0x80) == 0x00)
43 #define IS_CLASSB_IPADDR(x) ((((EFI_IP_ADDRESS*)x)->v4.Addr[0] & 0xc0) == 0x80)
44 #define IS_CLASSC_IPADDR(x) ((((EFI_IP_ADDRESS*)x)->v4.Addr[0] & 0xe0) == 0xc0)
45 #define IS_INADDR_UNICAST(x) ((IS_CLASSA_IPADDR(x) || IS_CLASSB_IPADDR(x) || IS_CLASSC_IPADDR(x)) && (((EFI_IP_ADDRESS*)x)->Addr[0] != 0) )
48 // Definitions for internet group management protocol version 2 message
50 // Per RFC 2236, November 1997
56 UINT8 MaxRespTime
; // in tenths of a second
57 UINT16 Checksum
; // ones complement of ones complement sum of
58 // 16 bit words of message
59 UINT32 GroupAddress
; // for general query, all systems group,
60 // for group specific, the group
63 #define IGMP_TYPE_QUERY 0x11
64 #define IGMP_TYPE_REPORT 0x16
65 #define IGMP_TYPE_V1REPORT 0x12
66 #define IGMP_TYPE_LEAVE_GROUP 0x17
68 #define IGMP_DEFAULT_MAX_RESPONSE_TIME 10 // 10 second default
71 #define MAX_MCAST_GROUPS 8 // most we allow ourselves to join at once
77 BOOLEAN ShowErrorMessages
;
78 EFI_PXE_BASE_CODE_PROTOCOL EfiBc
;
79 EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL
*CallbackProtocolPtr
;
82 EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL
*NiiPtr
;
83 EFI_SIMPLE_NETWORK_PROTOCOL
*SimpleNetwork
;
84 UINT8
*TransmitBufferPtr
;
85 UINT8
*ReceiveBufferPtr
;
86 EFI_PXE_BASE_CODE_FUNCTION Function
;
89 UINTN MCastGroupCount
;
90 EFI_EVENT Igmpv1TimeoutEvent
;
91 BOOLEAN UseIgmpv1Reporting
;
92 EFI_EVENT IgmpGroupEvent
[MAX_MCAST_GROUPS
];
100 UINT32 MCastGroup
[MAX_MCAST_GROUPS
];
103 BOOLEAN GoodStationIp
;
106 VOID
*DhcpPacketBuffer
;
108 VOID
*BootServerReceiveBuffer
;
109 EFI_IP_ADDRESS ServerIp
;
115 VOID
*ReceiveBuffers
;
116 VOID
*TransmitBuffer
;
117 UINTN NumOffersReceived
;
121 // arrays for different types of offers
123 UINT8 ServerCount
[4];
124 UINT8 OfferCount
[4][MAX_OFFERS
];
127 UINT8 BinlProxies
[MAX_OFFERS
];
130 UINT8
*TftpAckBuffer
;
131 UINT8
*TftpErrorBuffer
;
132 IGMPV2_MESSAGE IgmpMessage
;
133 BOOLEAN BigBlkNumFlag
;
136 } PXE_BASECODE_DEVICE
;
141 #define DHCP_ONLY_IX 0
146 #define PXE_RND_PORT_LOW 2070
148 #define PXE_MAX_PRINT_BUFFER 128
153 #define LOADFILE_DEVICE_SIGNATURE EFI_SIGNATURE_32('p','x','e','l')
158 EFI_LOAD_FILE_PROTOCOL LoadFile
;
159 PXE_BASECODE_DEVICE
*Private
;
162 #define EFI_BASE_CODE_DEV_FROM_THIS(a) CR (a, PXE_BASECODE_DEVICE, efi_bc, PXE_BASECODE_DEVICE_SIGNATURE);
164 #define EFI_LOAD_FILE_DEV_FROM_THIS(a) CR (a, LOADFILE_DEVICE, LoadFile, LOADFILE_DEVICE_SIGNATURE)
168 PXE_BASECODE_DEVICE
*Private
,
169 BIS_APPLICATION_HANDLE
*BisAppHandle
,
170 EFI_BIS_DATA
**BisDataSigInfo
176 EFI_BIS_PROTOCOL
*Bis
,
177 BIS_APPLICATION_HANDLE BisAppHandle
,
178 EFI_BIS_DATA
*BisDataSigInfo
184 PXE_BASECODE_DEVICE
*Private
,
186 UINTN FileBufferLength
,
187 VOID
*CredentialBuffer
,
188 UINTN CredentialBufferLength
194 PXE_BASECODE_DEVICE
*Private
201 extern EFI_DRIVER_BINDING_PROTOCOL gPxeBcDriverBinding
;
202 extern EFI_COMPONENT_NAME_PROTOCOL gPxeBcComponentName
;
205 // //////////////////////////////////////////////////////////
212 IN EFI_HANDLE ImageHandle
,
213 IN EFI_SYSTEM_TABLE
*SystemTable
220 IN EFI_PXE_BASE_CODE_PROTOCOL
*This
,
228 IN EFI_PXE_BASE_CODE_PROTOCOL
*This
235 IN EFI_PXE_BASE_CODE_PROTOCOL
*This
,
236 IN BOOLEAN SortOffers
243 IN EFI_PXE_BASE_CODE_PROTOCOL
* This
,
247 IN EFI_PXE_BASE_CODE_DISCOVER_INFO
* Info OPTIONAL
254 IN EFI_PXE_BASE_CODE_PROTOCOL
* This
,
255 IN EFI_PXE_BASE_CODE_TFTP_OPCODE Operation
,
256 IN OUT VOID
*BufferPtr
,
257 IN BOOLEAN Overwrite
,
258 IN OUT UINT64
*BufferSize
,
259 IN UINTN
*BlockSize OPTIONAL
,
260 IN EFI_IP_ADDRESS
* ServerIp
,
262 IN EFI_PXE_BASE_CODE_MTFTP_INFO
* Info OPTIONAL
,
263 IN BOOLEAN DontUseBuffer
270 IN EFI_PXE_BASE_CODE_PROTOCOL
*This
,
272 IN EFI_IP_ADDRESS
*DestIp
,
273 IN EFI_PXE_BASE_CODE_UDP_PORT
*DestPort
,
274 IN EFI_IP_ADDRESS
*GatewayIp
, OPTIONAL
275 IN EFI_IP_ADDRESS
*SrcIp
, OPTIONAL
276 IN OUT EFI_PXE_BASE_CODE_UDP_PORT
*SrcPort
, OPTIONAL
277 IN UINTN
*HeaderSize
, OPTIONAL
278 IN VOID
*HeaderPtr
, OPTIONAL
279 IN UINTN
*BufferSize
,
287 IN EFI_PXE_BASE_CODE_PROTOCOL
*This
,
289 IN OUT EFI_IP_ADDRESS
*DestIp
, OPTIONAL
290 IN OUT EFI_PXE_BASE_CODE_UDP_PORT
*DestPort
, OPTIONAL
291 IN OUT EFI_IP_ADDRESS
*SrcIp
, OPTIONAL
292 IN OUT EFI_PXE_BASE_CODE_UDP_PORT
*SrcPort
, OPTIONAL
293 IN UINTN
*HeaderSize
, OPTIONAL
294 IN VOID
*HeaderPtr
, OPTIONAL
295 IN OUT UINTN
*BufferSize
,
303 IN EFI_PXE_BASE_CODE_PROTOCOL
* This
,
304 IN EFI_IP_ADDRESS
* IpAddr
,
305 IN EFI_MAC_ADDRESS
* MacAddr OPTIONAL
312 IN EFI_PXE_BASE_CODE_PROTOCOL
*This
,
313 IN EFI_PXE_BASE_CODE_IP_FILTER
*NewFilter
320 IN EFI_PXE_BASE_CODE_PROTOCOL
* This
,
321 IN BOOLEAN
*NewAutoArp
, OPTIONAL
322 IN BOOLEAN
*NewSendGUID
, OPTIONAL
323 IN UINT8
*NewTTL
, OPTIONAL
324 IN UINT8
*NewToS
, OPTIONAL
325 IN BOOLEAN
*NewMakeCallback OPTIONAL
332 IN EFI_PXE_BASE_CODE_PROTOCOL
* This
,
333 IN EFI_IP_ADDRESS
* NewStationIp
, OPTIONAL
334 IN EFI_IP_ADDRESS
* NewSubnetMask OPTIONAL
341 IN EFI_PXE_BASE_CODE_PROTOCOL
* This
,
342 BOOLEAN
*NewDhcpDiscoverValid
, OPTIONAL
343 BOOLEAN
*NewDhcpAckReceived
, OPTIONAL
344 BOOLEAN
*NewProxyOfferReceived
, OPTIONAL
345 BOOLEAN
*NewPxeDiscoverValid
, OPTIONAL
346 BOOLEAN
*NewPxeReplyReceived
, OPTIONAL
347 BOOLEAN
*NewPxeBisReplyReceived
, OPTIONAL
348 IN EFI_PXE_BASE_CODE_PACKET
* NewDhcpDiscover
, OPTIONAL
349 IN EFI_PXE_BASE_CODE_PACKET
* NewDhcpAck
, OPTIONAL
350 IN EFI_PXE_BASE_CODE_PACKET
* NewProxyOffer
, OPTIONAL
351 IN EFI_PXE_BASE_CODE_PACKET
* NewPxeDiscover
, OPTIONAL
352 IN EFI_PXE_BASE_CODE_PACKET
* NewPxeReply
, OPTIONAL
353 IN EFI_PXE_BASE_CODE_PACKET
* NewPxeBisReply OPTIONAL
360 IN EFI_LOAD_FILE_PROTOCOL
*This
,
361 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
,
362 IN BOOLEAN BootPolicy
,
363 IN OUT UINTN
*BufferSize
,
369 PxeBcLibGetSmbiosSystemGuidAndSerialNumber (
370 IN EFI_GUID
*SystemGuid
,
371 OUT CHAR8
**SystemSerialNumber
378 IN CONST CHAR8
*Format
,
384 // Define SMBIOS tables.
388 UINT8 AnchorString
[4];
389 UINT8 EntryPointStructureChecksum
;
390 UINT8 EntryPointLength
;
393 UINT16 MaxStructureSize
;
394 UINT8 EntryPointRevision
;
395 UINT8 FormattedArea
[5];
396 UINT8 IntermediateAnchorString
[5];
397 UINT8 IntermediateChecksum
;
400 UINT16 NumberOfSmbiosStructures
;
401 UINT8 SmbiosBcdRevision
;
402 } SMBIOS_STRUCTURE_TABLE
;
405 // Please note that SMBIOS structures can be odd byte aligned since the
406 // unformated section of each record is a set of arbitrary size strings.
414 typedef UINT8 SMBIOS_STRING
;
418 SMBIOS_STRING Vendor
;
419 SMBIOS_STRING BiosVersion
;
420 UINT8 BiosSegment
[2];
421 SMBIOS_STRING BiosReleaseDate
;
423 UINT8 BiosCharacteristics
[8];
428 SMBIOS_STRING Manufacturer
;
429 SMBIOS_STRING ProductName
;
430 SMBIOS_STRING Version
;
431 SMBIOS_STRING SerialNumber
;
434 // always byte copy this data to prevent alignment faults!
443 SMBIOS_STRING Manufacturer
;
444 SMBIOS_STRING ProductName
;
445 SMBIOS_STRING Version
;
446 SMBIOS_STRING SerialNumber
;
451 SMBIOS_STRING Manufacturer
;
453 SMBIOS_STRING Version
;
454 SMBIOS_STRING SerialNumber
;
455 SMBIOS_STRING AssetTag
;
457 UINT8 PowerSupplyState
;
459 UINT8 SecurityStatus
;
467 UINT8 ProcessorFamily
;
468 SMBIOS_STRING ProcessorManufacture
;
469 UINT8 ProcessorId
[8];
470 SMBIOS_STRING ProcessorVersion
;
472 UINT8 ExternalClock
[2];
474 UINT8 CurrentSpeed
[2];
476 UINT8 ProcessorUpgrade
;
477 UINT8 L1CacheHandle
[2];
478 UINT8 L2CacheHandle
[2];
479 UINT8 L3CacheHandle
[2];
490 } SMBIOS_STRUCTURE_POINTER
;
503 Initialize ARP packet header.