3 Copyright (c) 2007 - 2008, 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.
21 #ifndef __EFI_PXEBC_IMPL_H__
22 #define __EFI_PXEBC_IMPL_H__
25 typedef struct _PXEBC_PRIVATE_DATA PXEBC_PRIVATE_DATA
;
29 #include <Guid/SmBios.h>
30 #include <IndustryStandard/SmBios.h>
31 #include <Protocol/Dhcp4.h>
32 #include <Protocol/PxeBaseCode.h>
33 #include <Protocol/Mtftp4.h>
34 #include <Protocol/Udp4.h>
35 #include <Protocol/LoadFile.h>
36 #include <Protocol/NetworkInterfaceIdentifier.h>
37 #include <Protocol/PxeBaseCodeCallBack.h>
38 #include <Protocol/Arp.h>
39 #include <Protocol/Ip4.h>
41 #include <Library/DebugLib.h>
42 #include <Library/BaseMemoryLib.h>
43 #include <Library/UefiDriverEntryPoint.h>
44 #include <Library/UefiBootServicesTableLib.h>
45 #include <Library/UefiLib.h>
46 #include <Library/BaseLib.h>
47 #include <Library/NetLib.h>
49 #include "PxeBcDriver.h"
51 #include "PxeBcDhcp.h"
52 #include "PxeBcMtftp.h"
53 #include "PxeBcSupport.h"
55 #define PXEBC_PRIVATE_DATA_SIGNATURE EFI_SIGNATURE_32 ('P', 'X', 'E', 'P')
56 #define PXEBC_MTFTP_TIMEOUT 4
57 #define PXEBC_MTFTP_RETRIES 6
59 struct _PXEBC_PRIVATE_DATA
{
61 EFI_HANDLE Controller
;
64 EFI_HANDLE Dhcp4Child
;
66 EFI_HANDLE Mtftp4Child
;
67 EFI_HANDLE Udp4ReadChild
;
68 EFI_HANDLE Udp4WriteChild
;
70 EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL
*Nii
;
72 EFI_PXE_BASE_CODE_PROTOCOL PxeBc
;
73 EFI_LOAD_FILE_PROTOCOL LoadFile
;
74 EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL LoadFileCallback
;
75 EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL
*PxeBcCallback
;
76 EFI_ARP_PROTOCOL
*Arp
;
77 EFI_DHCP4_PROTOCOL
*Dhcp4
;
78 EFI_IP4_PROTOCOL
*Ip4
;
79 EFI_IP4_CONFIG_DATA Ip4ConfigData
;
80 EFI_MTFTP4_PROTOCOL
*Mtftp4
;
81 EFI_UDP4_PROTOCOL
*Udp4Read
;
82 EFI_UDP4_PROTOCOL
*Udp4Write
;
83 UINT16 CurrentUdpSrcPort
;
84 EFI_UDP4_CONFIG_DATA Udp4CfgData
;
87 EFI_PXE_BASE_CODE_MODE Mode
;
88 EFI_PXE_BASE_CODE_FUNCTION Function
;
92 EFI_IP_ADDRESS StationIp
;
93 EFI_IP_ADDRESS SubnetMask
;
94 EFI_IP_ADDRESS GatewayIp
;
95 EFI_IP_ADDRESS ServerIp
;
100 UINT8 OptionBuffer
[PXEBC_DHCP4_MAX_OPTION_SIZE
];
101 EFI_DHCP4_PACKET SeedPacket
;
106 BOOLEAN GotProxyOffer
;
108 UINT32 SelectedOffer
;
109 UINT32 ProxyOfferType
;
112 // Cached packets as complements of pxe mode data
114 PXEBC_CACHED_DHCP4_PACKET ProxyOffer
;
115 PXEBC_CACHED_DHCP4_PACKET Dhcp4Ack
;
116 PXEBC_CACHED_DHCP4_PACKET PxeReply
;
117 PXEBC_CACHED_DHCP4_PACKET Dhcp4Offers
[PXEBC_MAX_OFFER_NUM
];
120 // Arrays for different types of offers:
121 // ServerCount records the count of the servers we got the offers,
122 // OfferIndex records the index of the offer sent by the server indexed by ServerCount.
124 UINT32 ServerCount
[DHCP4_PACKET_TYPE_MAX
];
125 UINT32 OfferIndex
[DHCP4_PACKET_TYPE_MAX
][PXEBC_MAX_OFFER_NUM
];
127 UINT32 ProxyIndex
[DHCP4_PACKET_TYPE_MAX
];
128 UINT32 BinlIndex
[PXEBC_MAX_OFFER_NUM
];
130 EFI_EVENT GetArpCacheEvent
;
132 // token and event used to get ICMP error data from IP
134 EFI_IP4_COMPLETION_TOKEN IcmpErrorRcvToken
;
137 #define PXEBC_PRIVATE_DATA_FROM_PXEBC(a) CR (a, PXEBC_PRIVATE_DATA, PxeBc, PXEBC_PRIVATE_DATA_SIGNATURE)
139 #define PXEBC_PRIVATE_DATA_FROM_LOADFILE(a) CR (a, PXEBC_PRIVATE_DATA, LoadFile, PXEBC_PRIVATE_DATA_SIGNATURE)
141 #define PXEBC_PRIVATE_DATA_FROM_PXEBCCALLBACK(a) CR (a, PXEBC_PRIVATE_DATA, PxeBcCallback, PXEBC_PRIVATE_DATA_SIGNATURE)
143 extern EFI_PXE_BASE_CODE_PROTOCOL mPxeBcProtocolTemplate
;
144 extern EFI_LOAD_FILE_PROTOCOL mLoadFileProtocolTemplate
;