]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Universal/Network/UefiPxeBcDxe/PxeBcImpl.h
sync comments, fix function header, rename variable name to follow coding style.
[mirror_edk2.git] / MdeModulePkg / Universal / Network / UefiPxeBcDxe / PxeBcImpl.h
index 6bd7a55531c6eda622d93d082479cd634be41335..17bd863e5fb073d00c123b53116e7d4e40522553 100644 (file)
@@ -1,33 +1,33 @@
-/** @file
-
-Copyright (c) 2007, Intel Corporation
-All rights reserved. This program and the accompanying materials
-are licensed and made available under the terms and conditions of the BSD License
-which accompanies this distribution.  The full text of the license may be found at
-http://opensource.org/licenses/bsd-license.php
-
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
-
-Module Name:
-
-  PxeBcImpl.h
-
-Abstract:
-
-
-**/
-
-#ifndef __EFI_PXEBC_IMPL_H__
-#define __EFI_PXEBC_IMPL_H__
-
-
-typedef struct _PXEBC_PRIVATE_DATA  PXEBC_PRIVATE_DATA;
-
+/** @file\r
+\r
+Copyright (c) 2007 - 2008, Intel Corporation                                                         \r
+All rights reserved. This program and the accompanying materials\r
+are licensed and made available under the terms and conditions of the BSD License\r
+which accompanies this distribution.  The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php\r
+\r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+\r
+Module Name:\r
+\r
+  PxeBcImpl.h\r
+\r
+Abstract:\r
+\r
+\r
+**/\r
+\r
+#ifndef __EFI_PXEBC_IMPL_H__\r
+#define __EFI_PXEBC_IMPL_H__\r
+\r
+\r
+typedef struct _PXEBC_PRIVATE_DATA  PXEBC_PRIVATE_DATA;\r
+\r
 #include <PiDxe.h>\r
 \r
 #include <Guid/SmBios.h>\r
-#include <IndustryStandard/Smbios.h>\r
+#include <IndustryStandard/SmBios.h>\r
 #include <Protocol/Dhcp4.h>\r
 #include <Protocol/PxeBaseCode.h>\r
 #include <Protocol/Mtftp4.h>\r
@@ -35,7 +35,8 @@ typedef struct _PXEBC_PRIVATE_DATA  PXEBC_PRIVATE_DATA;
 #include <Protocol/LoadFile.h>\r
 #include <Protocol/NetworkInterfaceIdentifier.h>\r
 #include <Protocol/PxeBaseCodeCallBack.h>\r
-#include <Protocol/Arp.h>
+#include <Protocol/Arp.h>\r
+#include <Protocol/Ip4.h>\r
 \r
 #include <Library/DebugLib.h>\r
 #include <Library/BaseMemoryLib.h>\r
@@ -43,87 +44,103 @@ typedef struct _PXEBC_PRIVATE_DATA  PXEBC_PRIVATE_DATA;
 #include <Library/UefiBootServicesTableLib.h>\r
 #include <Library/UefiLib.h>\r
 #include <Library/BaseLib.h>\r
-#include <Library/NetLib.h>
-
-#include "PxeBcDriver.h"
-#include "PxeArch.h"
-#include "PxeBcDhcp.h"
-#include "PxeBcMtftp.h"
-#include "PxeBcSupport.h"
-
-#define PXEBC_PRIVATE_DATA_SIGNATURE  EFI_SIGNATURE_32 ('P', 'X', 'E', 'P')
-#define PXEBC_MTFTP_TIMEOUT           4
-#define PXEBC_MTFTP_RETRIES           6
-
-struct _PXEBC_PRIVATE_DATA {
-  UINT32                                    Signature;
-  EFI_HANDLE                                Controller;
-  EFI_HANDLE                                Image;
-  EFI_HANDLE                                ArpChild;
-  EFI_HANDLE                                Dhcp4Child;
-  EFI_HANDLE                                Mtftp4Child;
-  EFI_HANDLE                                Udp4Child;
-
-  EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL *Nii;
-
-  EFI_PXE_BASE_CODE_PROTOCOL                PxeBc;
-  EFI_LOAD_FILE_PROTOCOL                    LoadFile;
-  EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL       LoadFileCallback;
-  EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL       *PxeBcCallback;
-  EFI_ARP_PROTOCOL                          *Arp;
-  EFI_DHCP4_PROTOCOL                        *Dhcp4;
-  EFI_MTFTP4_PROTOCOL                       *Mtftp4;
-  EFI_UDP4_PROTOCOL                         *Udp4;
-  EFI_UDP4_CONFIG_DATA                      Udp4CfgData;
-
-  EFI_PXE_BASE_CODE_MODE                    Mode;
-  EFI_PXE_BASE_CODE_FUNCTION                Function;
-
-  CHAR8                                     *BootFileName;
-
-  EFI_IP_ADDRESS                            StationIp;
-  EFI_IP_ADDRESS                            SubnetMask;
-  EFI_IP_ADDRESS                            GatewayIp;
-  EFI_IP_ADDRESS                            ServerIp;
-  BOOLEAN                                   AddressIsOk;
-
-  UINTN                                     FileSize;
-
-  UINT8                                     OptionBuffer[PXEBC_DHCP4_MAX_OPTION_SIZE];
-  EFI_DHCP4_PACKET                          SeedPacket;
-
-  BOOLEAN                                   SortOffers;
-  UINT32                                    NumOffers;
-  UINT32                                    SelectedOffer;
-  UINT32                                    ProxyOfferType;
-
-  //
-  // Cached packets as complements of pxe mode data
-  //
-  PXEBC_CACHED_DHCP4_PACKET                 ProxyOffer;
-  PXEBC_CACHED_DHCP4_PACKET                 Dhcp4Ack;
-  PXEBC_CACHED_DHCP4_PACKET                 PxeReply;
-  PXEBC_CACHED_DHCP4_PACKET                 Dhcp4Offers[PXEBC_MAX_OFFER_NUM];
-
-  //
-  // Arrays for different types of offers:
-  //   ServerCount records the count of the servers we got the offers,
-  //   OfferIndex records the index of the offer sent by the server indexed by ServerCount.
-  //
-  UINT32                                    ServerCount[DHCP4_PACKET_TYPE_MAX];
-  UINT32                                    OfferIndex[DHCP4_PACKET_TYPE_MAX][PXEBC_MAX_OFFER_NUM];
-  UINT32                                    BootpIndex;
-  UINT32                                    ProxyIndex[DHCP4_PACKET_TYPE_MAX];
-  UINT32                                    BinlIndex[PXEBC_MAX_OFFER_NUM];
-};
-
-#define PXEBC_PRIVATE_DATA_FROM_PXEBC(a)          CR (a, PXEBC_PRIVATE_DATA, PxeBc, PXEBC_PRIVATE_DATA_SIGNATURE)
-
-#define PXEBC_PRIVATE_DATA_FROM_LOADFILE(a)       CR (a, PXEBC_PRIVATE_DATA, LoadFile, PXEBC_PRIVATE_DATA_SIGNATURE)
-
-#define PXEBC_PRIVATE_DATA_FROM_PXEBCCALLBACK(a)  CR (a, PXEBC_PRIVATE_DATA, PxeBcCallback, PXEBC_PRIVATE_DATA_SIGNATURE)
-
-extern EFI_PXE_BASE_CODE_PROTOCOL mPxeBcProtocolTemplate;
-extern EFI_LOAD_FILE_PROTOCOL     mLoadFileProtocolTemplate;
-
-#endif
+#include <Library/NetLib.h>\r
+\r
+#include "PxeBcDriver.h"\r
+#include "PxeArch.h"\r
+#include "PxeBcDhcp.h"\r
+#include "PxeBcMtftp.h"\r
+#include "PxeBcSupport.h"\r
+\r
+#define PXEBC_PRIVATE_DATA_SIGNATURE  EFI_SIGNATURE_32 ('P', 'X', 'E', 'P')\r
+#define PXEBC_MTFTP_TIMEOUT           4\r
+#define PXEBC_MTFTP_RETRIES           6\r
+\r
+struct _PXEBC_PRIVATE_DATA {\r
+  UINT32                                    Signature;\r
+  EFI_HANDLE                                Controller;\r
+  EFI_HANDLE                                Image;\r
+  EFI_HANDLE                                ArpChild;\r
+  EFI_HANDLE                                Dhcp4Child;\r
+  EFI_HANDLE                                Ip4Child;\r
+  EFI_HANDLE                                Mtftp4Child;\r
+  EFI_HANDLE                                Udp4ReadChild;\r
+  EFI_HANDLE                                Udp4WriteChild;\r
+\r
+  EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL *Nii;\r
+\r
+  EFI_PXE_BASE_CODE_PROTOCOL                PxeBc;\r
+  EFI_LOAD_FILE_PROTOCOL                    LoadFile;\r
+  EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL       LoadFileCallback;\r
+  EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL       *PxeBcCallback;\r
+  EFI_ARP_PROTOCOL                          *Arp;\r
+  EFI_DHCP4_PROTOCOL                        *Dhcp4;\r
+  EFI_IP4_PROTOCOL                          *Ip4;\r
+  EFI_IP4_CONFIG_DATA                       Ip4ConfigData;\r
+  EFI_MTFTP4_PROTOCOL                       *Mtftp4;\r
+  EFI_UDP4_PROTOCOL                         *Udp4Read;\r
+  EFI_UDP4_PROTOCOL                         *Udp4Write;\r
+  UINT16                                    CurrentUdpSrcPort;\r
+  EFI_UDP4_CONFIG_DATA                      Udp4CfgData;\r
+\r
+\r
+  EFI_PXE_BASE_CODE_MODE                    Mode;\r
+  EFI_PXE_BASE_CODE_FUNCTION                Function;\r
+\r
+  CHAR8                                     *BootFileName;\r
+\r
+  EFI_IP_ADDRESS                            StationIp;\r
+  EFI_IP_ADDRESS                            SubnetMask;\r
+  EFI_IP_ADDRESS                            GatewayIp;\r
+  EFI_IP_ADDRESS                            ServerIp;\r
+  BOOLEAN                                   AddressIsOk;\r
+\r
+  UINTN                                     FileSize;\r
+\r
+  UINT8                                     OptionBuffer[PXEBC_DHCP4_MAX_OPTION_SIZE];\r
+  EFI_DHCP4_PACKET                          SeedPacket;\r
+  EFI_MAC_ADDRESS                           Mac;\r
+  UINT8                                     MacLen;\r
+\r
+  BOOLEAN                                   SortOffers;\r
+  BOOLEAN                                   GotProxyOffer;\r
+  UINT32                                    NumOffers;\r
+  UINT32                                    SelectedOffer;\r
+  UINT32                                    ProxyOfferType;\r
+\r
+  //\r
+  // Cached packets as complements of pxe mode data\r
+  //\r
+  PXEBC_CACHED_DHCP4_PACKET                 ProxyOffer;\r
+  PXEBC_CACHED_DHCP4_PACKET                 Dhcp4Ack;\r
+  PXEBC_CACHED_DHCP4_PACKET                 PxeReply;\r
+  PXEBC_CACHED_DHCP4_PACKET                 Dhcp4Offers[PXEBC_MAX_OFFER_NUM];\r
+\r
+  //\r
+  // Arrays for different types of offers:\r
+  //   ServerCount records the count of the servers we got the offers,\r
+  //   OfferIndex records the index of the offer sent by the server indexed by ServerCount.\r
+  //\r
+  UINT32                                    ServerCount[DHCP4_PACKET_TYPE_MAX];\r
+  UINT32                                    OfferIndex[DHCP4_PACKET_TYPE_MAX][PXEBC_MAX_OFFER_NUM];\r
+  UINT32                                    BootpIndex;\r
+  UINT32                                    ProxyIndex[DHCP4_PACKET_TYPE_MAX];\r
+  UINT32                                    BinlIndex[PXEBC_MAX_OFFER_NUM];\r
+\r
+  EFI_EVENT                                 GetArpCacheEvent;\r
+  //\r
+  // token and event used to get ICMP error data from IP\r
+  //\r
+  EFI_IP4_COMPLETION_TOKEN                  IcmpErrorRcvToken;\r
+};\r
+\r
+#define PXEBC_PRIVATE_DATA_FROM_PXEBC(a)          CR (a, PXEBC_PRIVATE_DATA, PxeBc, PXEBC_PRIVATE_DATA_SIGNATURE)\r
+\r
+#define PXEBC_PRIVATE_DATA_FROM_LOADFILE(a)       CR (a, PXEBC_PRIVATE_DATA, LoadFile, PXEBC_PRIVATE_DATA_SIGNATURE)\r
+\r
+#define PXEBC_PRIVATE_DATA_FROM_PXEBCCALLBACK(a)  CR (a, PXEBC_PRIVATE_DATA, PxeBcCallback, PXEBC_PRIVATE_DATA_SIGNATURE)\r
+\r
+extern EFI_PXE_BASE_CODE_PROTOCOL mPxeBcProtocolTemplate;\r
+extern EFI_LOAD_FILE_PROTOCOL     mLoadFileProtocolTemplate;\r
+\r
+#endif\r