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
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
];
95 UINT32 MCastGroup
[MAX_MCAST_GROUPS
];
96 BOOLEAN GoodStationIp
;
99 VOID
*DhcpPacketBuffer
;
101 VOID
*BootServerReceiveBuffer
;
102 EFI_IP_ADDRESS ServerIp
;
108 VOID
*ReceiveBuffers
;
109 VOID
*TransmitBuffer
;
110 UINTN NumOffersReceived
;
114 // arrays for different types of offers
116 UINT8 ServerCount
[4];
117 UINT8 OfferCount
[4][MAX_OFFERS
];
120 UINT8 BinlProxies
[MAX_OFFERS
];
123 UINT8
*TftpAckBuffer
;
124 UINT8
*TftpErrorBuffer
;
125 IGMPV2_MESSAGE IgmpMessage
;
126 BOOLEAN BigBlkNumFlag
;
129 } PXE_BASECODE_DEVICE
;
134 #define DHCP_ONLY_IX 0
139 #define PXE_RND_PORT_LOW 2070
141 #define PXE_MAX_PRINT_BUFFER 128
146 #define LOADFILE_DEVICE_SIGNATURE EFI_SIGNATURE_32('p','x','e','l')
151 EFI_LOAD_FILE_PROTOCOL LoadFile
;
152 PXE_BASECODE_DEVICE
*Private
;
155 #define EFI_BASE_CODE_DEV_FROM_THIS(a) CR (a, PXE_BASECODE_DEVICE, efi_bc, PXE_BASECODE_DEVICE_SIGNATURE);
157 #define EFI_LOAD_FILE_DEV_FROM_THIS(a) CR (a, LOADFILE_DEVICE, LoadFile, LOADFILE_DEVICE_SIGNATURE)
161 PxeBcDriverSupported (
162 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
163 IN EFI_HANDLE Controller
,
164 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
170 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
171 IN EFI_HANDLE Controller
,
172 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
178 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
179 IN EFI_HANDLE Controller
,
180 IN UINTN NumberOfChildren
,
181 IN EFI_HANDLE
*ChildHandleBuffer
185 // EFI Component Name Functions
189 PxeBcComponentNameGetDriverName (
190 IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
192 OUT CHAR16
**DriverName
197 PxeBcComponentNameGetControllerName (
198 IN EFI_COMPONENT_NAME_PROTOCOL
*This
,
199 IN EFI_HANDLE ControllerHandle
,
200 IN EFI_HANDLE ChildHandle OPTIONAL
,
202 OUT CHAR16
**ControllerName
207 PXE_BASECODE_DEVICE
*Private
,
208 BIS_APPLICATION_HANDLE
*BisAppHandle
,
209 EFI_BIS_DATA
**BisDataSigInfo
215 EFI_BIS_PROTOCOL
*Bis
,
216 BIS_APPLICATION_HANDLE BisAppHandle
,
217 EFI_BIS_DATA
*BisDataSigInfo
223 PXE_BASECODE_DEVICE
*Private
,
225 UINTN FileBufferLength
,
226 VOID
*CredentialBuffer
,
227 UINTN CredentialBufferLength
233 PXE_BASECODE_DEVICE
*Private
240 extern EFI_DRIVER_BINDING_PROTOCOL gPxeBcDriverBinding
;
241 extern EFI_COMPONENT_NAME_PROTOCOL gPxeBcComponentName
;
244 // //////////////////////////////////////////////////////////
251 IN EFI_HANDLE ImageHandle
,
252 IN EFI_SYSTEM_TABLE
*SystemTable
259 IN EFI_PXE_BASE_CODE_PROTOCOL
*This
,
267 IN EFI_PXE_BASE_CODE_PROTOCOL
*This
274 IN EFI_PXE_BASE_CODE_PROTOCOL
*This
,
275 IN BOOLEAN SortOffers
282 IN EFI_PXE_BASE_CODE_PROTOCOL
* This
,
286 IN EFI_PXE_BASE_CODE_DISCOVER_INFO
* Info OPTIONAL
293 IN EFI_PXE_BASE_CODE_PROTOCOL
* This
,
294 IN EFI_PXE_BASE_CODE_TFTP_OPCODE Operation
,
295 IN OUT VOID
*BufferPtr
,
296 IN BOOLEAN Overwrite
,
297 IN OUT UINT64
*BufferSize
,
298 IN UINTN
*BlockSize OPTIONAL
,
299 IN EFI_IP_ADDRESS
* ServerIp
,
301 IN EFI_PXE_BASE_CODE_MTFTP_INFO
* Info OPTIONAL
,
302 IN BOOLEAN DontUseBuffer
309 IN EFI_PXE_BASE_CODE_PROTOCOL
*This
,
311 IN EFI_IP_ADDRESS
*DestIp
,
312 IN EFI_PXE_BASE_CODE_UDP_PORT
*DestPort
,
313 IN EFI_IP_ADDRESS
*GatewayIp
, OPTIONAL
314 IN EFI_IP_ADDRESS
*SrcIp
, OPTIONAL
315 IN OUT EFI_PXE_BASE_CODE_UDP_PORT
*SrcPort
, OPTIONAL
316 IN UINTN
*HeaderSize
, OPTIONAL
317 IN VOID
*HeaderPtr
, OPTIONAL
318 IN UINTN
*BufferSize
,
326 IN EFI_PXE_BASE_CODE_PROTOCOL
*This
,
328 IN OUT EFI_IP_ADDRESS
*DestIp
, OPTIONAL
329 IN OUT EFI_PXE_BASE_CODE_UDP_PORT
*DestPort
, OPTIONAL
330 IN OUT EFI_IP_ADDRESS
*SrcIp
, OPTIONAL
331 IN OUT EFI_PXE_BASE_CODE_UDP_PORT
*SrcPort
, OPTIONAL
332 IN UINTN
*HeaderSize
, OPTIONAL
333 IN VOID
*HeaderPtr
, OPTIONAL
334 IN OUT UINTN
*BufferSize
,
342 IN EFI_PXE_BASE_CODE_PROTOCOL
* This
,
343 IN EFI_IP_ADDRESS
* IpAddr
,
344 IN EFI_MAC_ADDRESS
* MacAddr OPTIONAL
351 IN EFI_PXE_BASE_CODE_PROTOCOL
*This
,
352 IN EFI_PXE_BASE_CODE_IP_FILTER
*NewFilter
359 IN EFI_PXE_BASE_CODE_PROTOCOL
* This
,
360 IN BOOLEAN
*NewAutoArp
, OPTIONAL
361 IN BOOLEAN
*NewSendGUID
, OPTIONAL
362 IN UINT8
*NewTTL
, OPTIONAL
363 IN UINT8
*NewToS
, OPTIONAL
364 IN BOOLEAN
*NewMakeCallback OPTIONAL
371 IN EFI_PXE_BASE_CODE_PROTOCOL
* This
,
372 IN EFI_IP_ADDRESS
* NewStationIp
, OPTIONAL
373 IN EFI_IP_ADDRESS
* NewSubnetMask OPTIONAL
380 IN EFI_PXE_BASE_CODE_PROTOCOL
* This
,
381 BOOLEAN
*NewDhcpDiscoverValid
, OPTIONAL
382 BOOLEAN
*NewDhcpAckReceived
, OPTIONAL
383 BOOLEAN
*NewProxyOfferReceived
, OPTIONAL
384 BOOLEAN
*NewPxeDiscoverValid
, OPTIONAL
385 BOOLEAN
*NewPxeReplyReceived
, OPTIONAL
386 BOOLEAN
*NewPxeBisReplyReceived
, OPTIONAL
387 IN EFI_PXE_BASE_CODE_PACKET
* NewDhcpDiscover
, OPTIONAL
388 IN EFI_PXE_BASE_CODE_PACKET
* NewDhcpAck
, OPTIONAL
389 IN EFI_PXE_BASE_CODE_PACKET
* NewProxyOffer
, OPTIONAL
390 IN EFI_PXE_BASE_CODE_PACKET
* NewPxeDiscover
, OPTIONAL
391 IN EFI_PXE_BASE_CODE_PACKET
* NewPxeReply
, OPTIONAL
392 IN EFI_PXE_BASE_CODE_PACKET
* NewPxeBisReply OPTIONAL
399 IN EFI_LOAD_FILE_PROTOCOL
*This
,
400 IN EFI_DEVICE_PATH_PROTOCOL
*FilePath
,
401 IN BOOLEAN BootPolicy
,
402 IN OUT UINTN
*BufferSize
,
408 PxeBcLibGetSmbiosSystemGuidAndSerialNumber (
409 IN EFI_GUID
*SystemGuid
,
410 OUT CHAR8
**SystemSerialNumber
415 // Define SMBIOS tables.
419 UINT8 AnchorString
[4];
420 UINT8 EntryPointStructureChecksum
;
421 UINT8 EntryPointLength
;
424 UINT16 MaxStructureSize
;
425 UINT8 EntryPointRevision
;
426 UINT8 FormattedArea
[5];
427 UINT8 IntermediateAnchorString
[5];
428 UINT8 IntermediateChecksum
;
431 UINT16 NumberOfSmbiosStructures
;
432 UINT8 SmbiosBcdRevision
;
433 } SMBIOS_STRUCTURE_TABLE
;
436 // Please note that SMBIOS structures can be odd byte aligned since the
437 // unformated section of each record is a set of arbitrary size strings.
445 typedef UINT8 SMBIOS_STRING
;
449 SMBIOS_STRING Vendor
;
450 SMBIOS_STRING BiosVersion
;
451 UINT8 BiosSegment
[2];
452 SMBIOS_STRING BiosReleaseDate
;
454 UINT8 BiosCharacteristics
[8];
459 SMBIOS_STRING Manufacturer
;
460 SMBIOS_STRING ProductName
;
461 SMBIOS_STRING Version
;
462 SMBIOS_STRING SerialNumber
;
465 // always byte copy this data to prevent alignment faults!
474 SMBIOS_STRING Manufacturer
;
475 SMBIOS_STRING ProductName
;
476 SMBIOS_STRING Version
;
477 SMBIOS_STRING SerialNumber
;
482 SMBIOS_STRING Manufacturer
;
484 SMBIOS_STRING Version
;
485 SMBIOS_STRING SerialNumber
;
486 SMBIOS_STRING AssetTag
;
488 UINT8 PowerSupplyState
;
490 UINT8 SecurityStatus
;
498 UINT8 ProcessorFamily
;
499 SMBIOS_STRING ProcessorManufacture
;
500 UINT8 ProcessorId
[8];
501 SMBIOS_STRING ProcessorVersion
;
503 UINT8 ExternalClock
[2];
505 UINT8 CurrentSpeed
[2];
507 UINT8 ProcessorUpgrade
;
508 UINT8 L1CacheHandle
[2];
509 UINT8 L2CacheHandle
[2];
510 UINT8 L3CacheHandle
[2];
521 } SMBIOS_STRUCTURE_POINTER
;
534 Initialize ARP packet header.