]> git.proxmox.com Git - mirror_edk2.git/blame_incremental - MdeModulePkg/Universal/Network/UefiPxeBcDxe/PxeBcImpl.h
projects / mirror_edk2.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
remove PxeBc->Stop () when EFI_BUFFER_TOO_SMALL, the calling PxeBc->Stop() in Driver...
[mirror_edk2.git] / MdeModulePkg / Universal / Network / UefiPxeBcDxe / PxeBcImpl.h
... / ...
CommitLineData
1/** @file\r
2\r
3Copyright (c) 2007 - 2010, Intel Corporation.<BR>\r
4All rights reserved. This program and the accompanying materials\r
5are licensed and made available under the terms and conditions of the BSD License\r
6which accompanies this distribution. The full text of the license may be found at\r
7http://opensource.org/licenses/bsd-license.php\r
8\r
9THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
10WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
11\r
12**/\r
13\r
14#ifndef __EFI_PXEBC_IMPL_H__\r
15#define __EFI_PXEBC_IMPL_H__\r
16\r
17\r
18typedef struct _PXEBC_PRIVATE_DATA PXEBC_PRIVATE_DATA;\r
19\r
20#include <Uefi.h>\r
21\r
22#include <Guid/SmBios.h>\r
23#include <IndustryStandard/SmBios.h>\r
24#include <Protocol/Dhcp4.h>\r
25#include <Protocol/PxeBaseCode.h>\r
26#include <Protocol/Mtftp4.h>\r
27#include <Protocol/Udp4.h>\r
28#include <Protocol/LoadFile.h>\r
29#include <Protocol/NetworkInterfaceIdentifier.h>\r
30#include <Protocol/PxeBaseCodeCallBack.h>\r
31#include <Protocol/Arp.h>\r
32#include <Protocol/Ip4.h>\r
33\r
34#include <Library/DebugLib.h>\r
35#include <Library/BaseMemoryLib.h>\r
36#include <Library/MemoryAllocationLib.h>\r
37#include <Library/UefiDriverEntryPoint.h>\r
38#include <Library/UefiBootServicesTableLib.h>\r
39#include <Library/UefiLib.h>\r
40#include <Library/BaseLib.h>\r
41#include <Library/NetLib.h>\r
42#include <Library/DpcLib.h>\r
43\r
44#include "PxeBcDriver.h"\r
45#include "PxeBcDhcp.h"\r
46#include "PxeBcMtftp.h"\r
47#include "PxeBcSupport.h"\r
48\r
49#define PXEBC_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('P', 'X', 'E', 'P')\r
50#define PXEBC_MTFTP_TIMEOUT 4\r
51#define PXEBC_MTFTP_RETRIES 6\r
52#define PXEBC_DEFAULT_UDP_OVERHEAD_SIZE 8
53#define PXEBC_DEFAULT_TFTP_OVERHEAD_SIZE 4\r
54#define PXEBC_DEFAULT_PACKET_SIZE 1480\r
55#define PXEBC_DEFAULT_LIFETIME 2000000 // 2 seconds, unit is microsecond\r
56\r
57struct _PXEBC_PRIVATE_DATA {\r
58 UINT32 Signature;\r
59 EFI_HANDLE Controller;\r
60 EFI_HANDLE Image;\r
61 EFI_HANDLE ArpChild;\r
62 EFI_HANDLE Dhcp4Child;\r
63 EFI_HANDLE Ip4Child;\r
64 EFI_HANDLE Mtftp4Child;\r
65 EFI_HANDLE Udp4ReadChild;\r
66 EFI_HANDLE Udp4WriteChild;\r
67\r
68 EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL *Nii;\r
69\r
70 EFI_PXE_BASE_CODE_PROTOCOL PxeBc;\r
71 EFI_LOAD_FILE_PROTOCOL LoadFile;\r
72 EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL LoadFileCallback;\r
73 EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL *PxeBcCallback;\r
74 EFI_ARP_PROTOCOL *Arp;\r
75 EFI_DHCP4_PROTOCOL *Dhcp4;\r
76 EFI_IP4_PROTOCOL *Ip4;\r
77 EFI_IP4_CONFIG_DATA Ip4ConfigData;\r
78 EFI_MTFTP4_PROTOCOL *Mtftp4;\r
79 EFI_UDP4_PROTOCOL *Udp4Read;\r
80 EFI_UDP4_PROTOCOL *Udp4Write;\r
81 UINT16 CurrentUdpSrcPort;\r
82 EFI_UDP4_CONFIG_DATA Udp4CfgData;\r
83\r
84\r
85 EFI_PXE_BASE_CODE_MODE Mode;\r
86 EFI_PXE_BASE_CODE_FUNCTION Function;\r
87\r
88 CHAR8 *BootFileName;\r
89\r
90 EFI_IP_ADDRESS StationIp;\r
91 EFI_IP_ADDRESS SubnetMask;\r
92 EFI_IP_ADDRESS GatewayIp;\r
93 EFI_IP_ADDRESS ServerIp;\r
94 BOOLEAN AddressIsOk;\r
95 UINT32 Ip4MaxPacketSize;\r
96 UINTN BlockSize;\r
97 UINTN FileSize;\r
98\r
99 UINT8 OptionBuffer[PXEBC_DHCP4_MAX_OPTION_SIZE];\r
100 EFI_DHCP4_PACKET SeedPacket;\r
101 EFI_MAC_ADDRESS Mac;\r
102 UINT8 MacLen;\r
103\r
104 BOOLEAN SortOffers;\r
105 BOOLEAN GotProxyOffer;\r
106 UINT32 NumOffers;\r
107 UINT32 SelectedOffer;\r
108 UINT32 ProxyOfferType;\r
109\r
110 //\r
111 // Cached packets as complements of pxe mode data\r
112 //\r
113 PXEBC_CACHED_DHCP4_PACKET ProxyOffer;\r
114 PXEBC_CACHED_DHCP4_PACKET Dhcp4Ack;\r
115 PXEBC_CACHED_DHCP4_PACKET PxeReply;\r
116 PXEBC_CACHED_DHCP4_PACKET Dhcp4Offers[PXEBC_MAX_OFFER_NUM];\r
117\r
118 //\r
119 // Arrays for different types of offers:\r
120 // ServerCount records the count of the servers we got the offers,\r
121 // OfferIndex records the index of the offer sent by the server indexed by ServerCount.\r
122 //\r
123 UINT32 ServerCount[DHCP4_PACKET_TYPE_MAX];\r
124 UINT32 OfferIndex[DHCP4_PACKET_TYPE_MAX][PXEBC_MAX_OFFER_NUM];\r
125 UINT32 BootpIndex;\r
126 UINT32 ProxyIndex[DHCP4_PACKET_TYPE_MAX];\r
127 UINT32 BinlIndex[PXEBC_MAX_OFFER_NUM];\r
128\r
129 EFI_EVENT GetArpCacheEvent;\r
130 //\r
131 // token and event used to get ICMP error data from IP\r
132 //\r
133 EFI_IP4_COMPLETION_TOKEN IcmpErrorRcvToken;\r
134};\r
135\r
136#define PXEBC_PRIVATE_DATA_FROM_PXEBC(a) CR (a, PXEBC_PRIVATE_DATA, PxeBc, PXEBC_PRIVATE_DATA_SIGNATURE)\r
137\r
138#define PXEBC_PRIVATE_DATA_FROM_LOADFILE(a) CR (a, PXEBC_PRIVATE_DATA, LoadFile, PXEBC_PRIVATE_DATA_SIGNATURE)\r
139\r
140#define PXEBC_PRIVATE_DATA_FROM_PXEBCCALLBACK(a) CR (a, PXEBC_PRIVATE_DATA, PxeBcCallback, PXEBC_PRIVATE_DATA_SIGNATURE)\r
141\r
142extern EFI_PXE_BASE_CODE_PROTOCOL mPxeBcProtocolTemplate;\r
143extern EFI_LOAD_FILE_PROTOCOL mLoadFileProtocolTemplate;\r
144\r
145/**\r
146 Causes the driver to load a specified file.\r
147\r
148 @param This Protocol instance pointer.\r
149 @param FilePath The device specific path of the file to load.\r
150 @param BootPolicy If TRUE, indicates that the request originates from the\r
151 boot manager is attempting to load FilePath as a boot\r
152 selection. If FALSE, then FilePath must match as exact file\r
153 to be loaded.\r
154 @param BufferSize On input the size of Buffer in bytes. On output with a return\r
155 code of EFI_SUCCESS, the amount of data transferred to\r
156 Buffer. On output with a return code of EFI_BUFFER_TOO_SMALL,\r
157 the size of Buffer required to retrieve the requested file.\r
158 @param Buffer The memory buffer to transfer the file to. IF Buffer is NULL,\r
159 then no the size of the requested file is returned in\r
160 BufferSize.\r
161\r
162 @retval EFI_SUCCESS The file was loaded.\r
163 @retval EFI_UNSUPPORTED The device does not support the provided BootPolicy\r
164 @retval EFI_INVALID_PARAMETER FilePath is not a valid device path, or\r
165 BufferSize is NULL.\r
166 @retval EFI_NO_MEDIA No medium was present to load the file.\r
167 @retval EFI_DEVICE_ERROR The file was not loaded due to a device error.\r
168 @retval EFI_NO_RESPONSE The remote system did not respond.\r
169 @retval EFI_NOT_FOUND The file was not found.\r
170 @retval EFI_ABORTED The file load process was manually cancelled.\r
171\r
172**/\r
173EFI_STATUS\r
174EFIAPI\r
175EfiPxeLoadFile (\r
176 IN EFI_LOAD_FILE_PROTOCOL * This,\r
177 IN EFI_DEVICE_PATH_PROTOCOL * FilePath,\r
178 IN BOOLEAN BootPolicy,\r
179 IN OUT UINTN *BufferSize,\r
180 IN VOID *Buffer OPTIONAL\r
181 );\r
182\r
183#endif\r
EFI Development Kit II mirror for PVE