From 30368135ac7264c028b0d69fa7183ed398cf0cf5 Mon Sep 17 00:00:00 2001 From: qhuang8 Date: Fri, 31 Oct 2008 04:40:51 +0000 Subject: Update to use DOS format git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6340 6f19259b-4bc3-4df7-8a09-765794883524 --- .../Universal/Network/UefiPxeBcDxe/Ia32/PxeArch.h | 52 +- .../Universal/Network/UefiPxeBcDxe/Ipf/PxeArch.h | 52 +- .../Universal/Network/UefiPxeBcDxe/PxeBcDhcp.h | 1084 ++++++++++---------- .../Universal/Network/UefiPxeBcDxe/PxeBcDriver.h | 206 ++-- .../Universal/Network/UefiPxeBcDxe/PxeBcImpl.h | 292 +++--- .../Universal/Network/UefiPxeBcDxe/PxeBcMtftp.h | 288 +++--- .../Universal/Network/UefiPxeBcDxe/PxeBcSupport.h | 196 ++-- .../Universal/Network/UefiPxeBcDxe/X64/PxeArch.h | 52 +- 8 files changed, 1111 insertions(+), 1111 deletions(-) (limited to 'MdeModulePkg/Universal/Network') diff --git a/MdeModulePkg/Universal/Network/UefiPxeBcDxe/Ia32/PxeArch.h b/MdeModulePkg/Universal/Network/UefiPxeBcDxe/Ia32/PxeArch.h index cc878d8..d032f62 100644 --- a/MdeModulePkg/Universal/Network/UefiPxeBcDxe/Ia32/PxeArch.h +++ b/MdeModulePkg/Universal/Network/UefiPxeBcDxe/Ia32/PxeArch.h @@ -1,26 +1,26 @@ -/** @file - -Copyright (c) 2006, 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: - PxeArch.h - -Abstract: - Defines PXE Arch type - - -**/ - -#ifndef _EFI_PXE_ARCH_H_ -#define _EFI_PXE_ARCH_H_ - -#define SYS_ARCH 0x6 - -#endif +/** @file + +Copyright (c) 2006, 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: + PxeArch.h + +Abstract: + Defines PXE Arch type + + +**/ + +#ifndef _EFI_PXE_ARCH_H_ +#define _EFI_PXE_ARCH_H_ + +#define SYS_ARCH 0x6 + +#endif diff --git a/MdeModulePkg/Universal/Network/UefiPxeBcDxe/Ipf/PxeArch.h b/MdeModulePkg/Universal/Network/UefiPxeBcDxe/Ipf/PxeArch.h index 6d06045..866f486 100644 --- a/MdeModulePkg/Universal/Network/UefiPxeBcDxe/Ipf/PxeArch.h +++ b/MdeModulePkg/Universal/Network/UefiPxeBcDxe/Ipf/PxeArch.h @@ -1,26 +1,26 @@ -/** @file - -Copyright (c) 2006, 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: - PxeArch.h - -Abstract: - Defines PXE Arch type - - -**/ - -#ifndef _EFI_PXE_ARCH_H_ -#define _EFI_PXE_ARCH_H_ - -#define SYS_ARCH 0x2 - -#endif +/** @file + +Copyright (c) 2006, 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: + PxeArch.h + +Abstract: + Defines PXE Arch type + + +**/ + +#ifndef _EFI_PXE_ARCH_H_ +#define _EFI_PXE_ARCH_H_ + +#define SYS_ARCH 0x2 + +#endif diff --git a/MdeModulePkg/Universal/Network/UefiPxeBcDxe/PxeBcDhcp.h b/MdeModulePkg/Universal/Network/UefiPxeBcDxe/PxeBcDhcp.h index ec26406..fcc2272 100644 --- a/MdeModulePkg/Universal/Network/UefiPxeBcDxe/PxeBcDhcp.h +++ b/MdeModulePkg/Universal/Network/UefiPxeBcDxe/PxeBcDhcp.h @@ -1,542 +1,542 @@ -/** @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: - - PxeBcDhcp.h - -Abstract: - - Dhcp and Discover routines for PxeBc - - -**/ - -#ifndef __EFI_PXEBC_DHCP_H__ -#define __EFI_PXEBC_DHCP_H__ - -enum { - PXEBC_DHCP4_MAX_OPTION_NUM = 16, - PXEBC_DHCP4_MAX_OPTION_SIZE = 312, - PXEBC_DHCP4_MAX_PACKET_SIZE = 1472, - - PXEBC_DHCP4_S_PORT = 67, - PXEBC_DHCP4_C_PORT = 68, - PXEBC_BS_DOWNLOAD_PORT = 69, - PXEBC_BS_DISCOVER_PORT = 4011, - - PXEBC_DHCP4_OPCODE_REQUEST = 1, - PXEBC_DHCP4_OPCODE_REPLY = 2, - PXEBC_DHCP4_MSG_TYPE_REQUEST = 3, - PXEBC_DHCP4_MAGIC = 0x63538263, // network byte order - // - // Dhcp Options - // - PXEBC_DHCP4_TAG_PAD = 0, // Pad Option - PXEBC_DHCP4_TAG_EOP = 255, // End Option - PXEBC_DHCP4_TAG_NETMASK = 1, // Subnet Mask - PXEBC_DHCP4_TAG_TIME_OFFSET = 2, // Time Offset from UTC - PXEBC_DHCP4_TAG_ROUTER = 3, // Router option, - PXEBC_DHCP4_TAG_TIME_SERVER = 4, // Time Server - PXEBC_DHCP4_TAG_NAME_SERVER = 5, // Name Server - PXEBC_DHCP4_TAG_DNS_SERVER = 6, // Domain Name Server - PXEBC_DHCP4_TAG_HOSTNAME = 12, // Host Name - PXEBC_DHCP4_TAG_BOOTFILE_LEN = 13, // Boot File Size - PXEBC_DHCP4_TAG_DUMP = 14, // Merit Dump File - PXEBC_DHCP4_TAG_DOMAINNAME = 15, // Domain Name - PXEBC_DHCP4_TAG_ROOTPATH = 17, // Root path - PXEBC_DHCP4_TAG_EXTEND_PATH = 18, // Extensions Path - PXEBC_DHCP4_TAG_EMTU = 22, // Maximum Datagram Reassembly Size - PXEBC_DHCP4_TAG_TTL = 23, // Default IP Time-to-live - PXEBC_DHCP4_TAG_BROADCAST = 28, // Broadcast Address - PXEBC_DHCP4_TAG_NIS_DOMAIN = 40, // Network Information Service Domain - PXEBC_DHCP4_TAG_NIS_SERVER = 41, // Network Information Servers - PXEBC_DHCP4_TAG_NTP_SERVER = 42, // Network Time Protocol Servers - PXEBC_DHCP4_TAG_VENDOR = 43, // Vendor Specific Information - PXEBC_DHCP4_TAG_REQUEST_IP = 50, // Requested IP Address - PXEBC_DHCP4_TAG_LEASE = 51, // IP Address Lease Time - PXEBC_DHCP4_TAG_OVERLOAD = 52, // Option Overload - PXEBC_DHCP4_TAG_MSG_TYPE = 53, // DHCP Message Type - PXEBC_DHCP4_TAG_SERVER_ID = 54, // Server Identifier - PXEBC_DHCP4_TAG_PARA_LIST = 55, // Parameter Request List - PXEBC_DHCP4_TAG_MAXMSG = 57, // Maximum DHCP Message Size - PXEBC_DHCP4_TAG_T1 = 58, // Renewal (T1) Time Value - PXEBC_DHCP4_TAG_T2 = 59, // Rebinding (T2) Time Value - PXEBC_DHCP4_TAG_CLASS_ID = 60, // Vendor class identifier - PXEBC_DHCP4_TAG_CLIENT_ID = 61, // Client-identifier - PXEBC_DHCP4_TAG_TFTP = 66, // TFTP server name - PXEBC_DHCP4_TAG_BOOTFILE = 67, // Bootfile name - PXEBC_PXE_DHCP4_TAG_ARCH = 93, - PXEBC_PXE_DHCP4_TAG_UNDI = 94, - PXEBC_PXE_DHCP4_TAG_UUID = 97, - // - // Sub-Options in Dhcp Vendor Option - // - PXEBC_VENDOR_TAG_MTFTP_IP = 1, - PXEBC_VENDOR_TAG_MTFTP_CPORT = 2, - PXEBC_VENDOR_TAG_MTFTP_SPORT = 3, - PXEBC_VENDOR_TAG_MTFTP_TIMEOUT = 4, - PXEBC_VENDOR_TAG_MTFTP_DELAY = 5, - PXEBC_VENDOR_TAG_DISCOVER_CTRL = 6, - PXEBC_VENDOR_TAG_DISCOVER_MCAST = 7, - PXEBC_VENDOR_TAG_BOOT_SERVERS = 8, - PXEBC_VENDOR_TAG_BOOT_MENU = 9, - PXEBC_VENDOR_TAG_MENU_PROMPT = 10, - PXEBC_VENDOR_TAG_MCAST_ALLOC = 11, - PXEBC_VENDOR_TAG_CREDENTIAL_TYPES = 12, - PXEBC_VENDOR_TAG_BOOT_ITEM = 71, - - PXEBC_DHCP4_DISCOVER_INIT_TIMEOUT = 4, - PXEBC_DHCP4_DISCOVER_RETRIES = 4, - - PXEBC_MAX_MENU_NUM = 24, - PXEBC_MAX_OFFER_NUM = 16, - - PXEBC_BOOT_REQUEST_TIMEOUT = 1, - PXEBC_BOOT_REQUEST_RETRIES = 4, - - PXEBC_DHCP4_OVERLOAD_FILE = 1, - PXEBC_DHCP4_OVERLOAD_SERVER_NAME = 2 -}; - -// -// The array index of the DHCP4 option tag interested -// -enum { - PXEBC_DHCP4_TAG_INDEX_BOOTFILE_LEN, - PXEBC_DHCP4_TAG_INDEX_VENDOR, - PXEBC_DHCP4_TAG_INDEX_OVERLOAD, - PXEBC_DHCP4_TAG_INDEX_MSG_TYPE, - PXEBC_DHCP4_TAG_INDEX_SERVER_ID, - PXEBC_DHCP4_TAG_INDEX_CLASS_ID, - PXEBC_DHCP4_TAG_INDEX_BOOTFILE, - PXEBC_DHCP4_TAG_INDEX_MAX -}; - -// -// The type of DHCP OFFER, arranged by priority, PXE10 has the highest priority. -// -enum { - DHCP4_PACKET_TYPE_PXE10, - DHCP4_PACKET_TYPE_WFM11A, - DHCP4_PACKET_TYPE_BINL, - DHCP4_PACKET_TYPE_DHCP_ONLY, - DHCP4_PACKET_TYPE_MAX, - DHCP4_PACKET_TYPE_BOOTP = DHCP4_PACKET_TYPE_MAX -}; - -#define BIT(x) (1 << x) -#define CTRL(x) (0x1F & (x)) - -// -// WfM11a options -// -#define MTFTP_VENDOR_OPTION_BIT_MAP (BIT (PXEBC_VENDOR_TAG_MTFTP_IP) | \ - BIT (PXEBC_VENDOR_TAG_MTFTP_CPORT) | \ - BIT (PXEBC_VENDOR_TAG_MTFTP_SPORT) | \ - BIT (PXEBC_VENDOR_TAG_MTFTP_TIMEOUT) | \ - BIT (PXEBC_VENDOR_TAG_MTFTP_DELAY)) -// -// Discoverty options -// -#define DISCOVER_VENDOR_OPTION_BIT_MAP (BIT (PXEBC_VENDOR_TAG_DISCOVER_CTRL) | \ - BIT (PXEBC_VENDOR_TAG_DISCOVER_MCAST) | \ - BIT (PXEBC_VENDOR_TAG_BOOT_SERVERS) | \ - BIT (PXEBC_VENDOR_TAG_BOOT_MENU) | \ - BIT (PXEBC_VENDOR_TAG_MENU_PROMPT)) - -#define IS_VALID_BOOT_PROMPT(x) \ - ((((x)[0]) & BIT (PXEBC_VENDOR_TAG_MENU_PROMPT)) == BIT (PXEBC_VENDOR_TAG_MENU_PROMPT)) - -#define IS_VALID_BOOT_MENU(x) \ - ((((x)[0]) & BIT (PXEBC_VENDOR_TAG_BOOT_MENU)) == BIT (PXEBC_VENDOR_TAG_BOOT_MENU)) - -#define IS_VALID_MTFTP_VENDOR_OPTION(x) \ - (((UINT32) ((x)[0]) & MTFTP_VENDOR_OPTION_BIT_MAP) == MTFTP_VENDOR_OPTION_BIT_MAP) - -#define IS_VALID_DISCOVER_VENDOR_OPTION(x) (((UINT32) ((x)[0]) & DISCOVER_VENDOR_OPTION_BIT_MAP) != 0) - -#define IS_VALID_CREDENTIAL_VENDOR_OPTION(x) \ - (((UINT32) ((x)[0]) & BIT (PXEBC_VENDOR_TAG_CREDENTIAL_TYPES)) == BIT (PXEBC_VENDOR_TAG_CREDENTIAL_TYPES)) - -#define IS_VALID_BOOTITEM_VENDOR_OPTION(x) \ - (((UINT32) ((x)[PXEBC_VENDOR_TAG_BOOT_ITEM / 32]) & BIT (PXEBC_VENDOR_TAG_BOOT_ITEM % 32)) \ - == BIT (PXEBC_VENDOR_TAG_BOOT_ITEM % 32)) - -#define IS_DISABLE_BCAST_DISCOVER(x) (((x) & BIT (0)) == BIT (0)) -#define IS_DISABLE_MCAST_DISCOVER(x) (((x) & BIT (1)) == BIT (1)) -#define IS_ENABLE_USE_SERVER_LIST(x) (((x) & BIT (2)) == BIT (2)) -#define IS_ENABLE_BOOT_FILE_NAME(x) (((x) & BIT (3)) == BIT (3)) - -#define SET_VENDOR_OPTION_BIT_MAP(x, y) (((x)[(y) / 32]) = (UINT32) ((x)[(y) / 32]) | BIT ((y) % 32)) - -#pragma pack(1) -typedef struct { - UINT8 ParaList[135]; -} PXEBC_DHCP4_OPTION_PARA; - -typedef struct { - UINT16 Size; -} PXEBC_DHCP4_OPTION_MAX_MESG_SIZE; - -typedef struct { - UINT8 Type; - UINT8 MajorVer; - UINT8 MinorVer; -} PXEBC_DHCP4_OPTION_UNDI; - -typedef struct { - UINT8 Type; -} PXEBC_DHCP4_OPTION_MESG; - -typedef struct { - UINT16 Type; -} PXEBC_DHCP4_OPTION_ARCH; - -#define DEFAULT_CLASS_ID_DATA "PXEClient:Arch:?????:????:??????" - -typedef struct { - UINT8 ClassIdentifier[10]; - UINT8 ArchitecturePrefix[5]; - UINT8 ArchitectureType[5]; - UINT8 Lit3[1]; - UINT8 InterfaceName[4]; - UINT8 Lit4[1]; - UINT8 UndiMajor[3]; - UINT8 UndiMinor[3]; -} PXEBC_DHCP4_OPTION_CLID; - -typedef struct { - UINT8 Type; - UINT8 Guid[16]; -} PXEBC_DHCP4_OPTION_UUID; - -typedef struct { - UINT16 Type; - UINT16 Layer; -} PXEBC_OPTION_BOOT_ITEM; - -#pragma pack() - -typedef union { - PXEBC_DHCP4_OPTION_PARA *Para; - PXEBC_DHCP4_OPTION_UNDI *Undi; - PXEBC_DHCP4_OPTION_ARCH *Arch; - PXEBC_DHCP4_OPTION_CLID *Clid; - PXEBC_DHCP4_OPTION_UUID *Uuid; - PXEBC_DHCP4_OPTION_MESG *Mesg; - PXEBC_DHCP4_OPTION_MAX_MESG_SIZE *MaxMesgSize; -} PXEBC_DHCP4_OPTION_ENTRY; - -typedef struct { - UINT16 Type; - UINT8 IpCnt; - EFI_IPv4_ADDRESS IpAddr[1]; -} PXEBC_BOOT_SVR_ENTRY; - -typedef struct { - UINT16 Type; - UINT8 DescLen; - UINT8 DescStr[1]; -} PXEBC_BOOT_MENU_ENTRY; - -typedef struct { - UINT8 Timeout; - UINT8 Prompt[1]; -} PXEBC_MENU_PROMPT; - -typedef struct { - UINT32 BitMap[8]; - EFI_IPv4_ADDRESS MtftpIp; - UINT16 MtftpCPort; - UINT16 MtftpSPort; - UINT8 MtftpTimeout; - UINT8 MtftpDelay; - UINT8 DiscoverCtrl; - EFI_IPv4_ADDRESS DiscoverMcastIp; - EFI_IPv4_ADDRESS McastIpBase; - UINT16 McastIpBlock; - UINT16 McastIpRange; - UINT16 BootSrvType; - UINT16 BootSrvLayer; - PXEBC_BOOT_SVR_ENTRY *BootSvr; - UINT8 BootSvrLen; - PXEBC_BOOT_MENU_ENTRY *BootMenu; - UINT8 BootMenuLen; - PXEBC_MENU_PROMPT *MenuPrompt; - UINT8 MenuPromptLen; - UINT32 *CredType; - UINT8 CredTypeLen; -} PXEBC_VENDOR_OPTION; - -#define PXEBC_CACHED_DHCP4_PACKET_MAX_SIZE (EFI_FIELD_OFFSET (EFI_DHCP4_PACKET, Dhcp4) + PXEBC_DHCP4_MAX_PACKET_SIZE) - -typedef struct { - union { - EFI_DHCP4_PACKET Offer; - EFI_DHCP4_PACKET Ack; - UINT8 Buffer[PXEBC_CACHED_DHCP4_PACKET_MAX_SIZE]; - } Packet; - - BOOLEAN IsPxeOffer; - UINT8 OfferType; - EFI_DHCP4_PACKET_OPTION *Dhcp4Option[PXEBC_DHCP4_TAG_INDEX_MAX]; - PXEBC_VENDOR_OPTION PxeVendorOption; -} PXEBC_CACHED_DHCP4_PACKET; - -#define GET_NEXT_DHCP_OPTION(Opt) \ - (EFI_DHCP4_PACKET_OPTION *) ((UINT8 *) (Opt) + sizeof (EFI_DHCP4_PACKET_OPTION) + (Opt)->Length - 1) - -#define GET_OPTION_BUFFER_LEN(Pkt) ((Pkt)->Length - sizeof (EFI_DHCP4_HEADER) - 4) -#define IS_PROXY_DHCP_OFFER(Offer) EFI_IP4_EQUAL (&((Offer)->Dhcp4.Header.YourAddr), &mZeroIp4Addr) - -#define GET_NEXT_BOOT_SVR_ENTRY(Ent) \ - (PXEBC_BOOT_SVR_ENTRY *) ((UINT8 *) Ent + sizeof (*(Ent)) + ((Ent)->IpCnt - 1) * sizeof (EFI_IPv4_ADDRESS)) - -VOID -PxeBcInitSeedPacket ( - IN EFI_DHCP4_PACKET *Seed, - IN EFI_UDP4_PROTOCOL *Udp4 - ) -/*++ - -Routine Description: - - GC_NOTO: Add function description - -Arguments: - - Seed - GC_NOTO: add argument description - Udp4 - GC_NOTO: add argument description - -Returns: - - GC_NOTO: add return values - ---*/ -; - - -/** - GC_NOTO: Add function description - - @param CachedPacket GC_NOTO: add argument description - - @return GC_NOTO: add return values - -**/ -BOOLEAN -PxeBcParseCachedDhcpPacket ( - IN PXEBC_CACHED_DHCP4_PACKET *CachedPacket - ) -; - - -/** - GC_NOTO: Add function description - - @param Private GC_NOTO: add argument description - - @return GC_NOTO: add return values - -**/ -EFI_STATUS -PxeBcCheckSelectedOffer ( - IN PXEBC_PRIVATE_DATA *Private - ) -; - - -/** - GC_NOTO: Add function description - - @param This GC_NOTO: add argument description - @param Context GC_NOTO: add argument description - @param CurrentState GC_NOTO: add argument description - @param Dhcp4Event GC_NOTO: add argument description - @param Packet GC_NOTO: add argument description - @param NewPacket GC_NOTO: add argument description - - @return GC_NOTO: add return values - -**/ -EFI_STATUS -PxeBcDhcpCallBack ( - IN EFI_DHCP4_PROTOCOL * This, - IN VOID *Context, - IN EFI_DHCP4_STATE CurrentState, - IN EFI_DHCP4_EVENT Dhcp4Event, - IN EFI_DHCP4_PACKET * Packet OPTIONAL, - OUT EFI_DHCP4_PACKET **NewPacket OPTIONAL - ) -; - - -/** - GC_NOTO: Add function description - - @param Private GC_NOTO: add argument description - @param Type GC_NOTO: add argument description - @param Layer GC_NOTO: add argument description - @param UseBis GC_NOTO: add argument description - @param DestIp GC_NOTO: add argument description - @param IpCount GC_NOTO: add argument description - @param SrvList GC_NOTO: add argument description - @param IsDiscv GC_NOTO: add argument description - @param Reply GC_NOTO: add argument description - - @return GC_NOTO: add return values - -**/ -EFI_STATUS -PxeBcDiscvBootService ( - IN PXEBC_PRIVATE_DATA * Private, - IN UINT16 Type, - IN UINT16 *Layer, - IN BOOLEAN UseBis, - IN EFI_IP_ADDRESS * DestIp, - IN UINT16 IpCount, - IN EFI_PXE_BASE_CODE_SRVLIST * SrvList, - IN BOOLEAN IsDiscv, - OUT EFI_DHCP4_PACKET * Reply OPTIONAL - ) -; - - -/** - GC_NOTO: Add function description - - @param Private GC_NOTO: add argument description - @param OptList GC_NOTO: add argument description - @param IsDhcpDiscover GC_NOTO: add argument description - - @return GC_NOTO: add return values - -**/ -UINT32 -PxeBcBuildDhcpOptions ( - IN PXEBC_PRIVATE_DATA *Private, - IN EFI_DHCP4_PACKET_OPTION **OptList, - IN BOOLEAN IsDhcpDiscover - ) -; - - -/** - GC_NOTO: Add function description - - @param OptList GC_NOTO: add argument description - @param Type GC_NOTO: add argument description - @param Layer GC_NOTO: add argument description - @param OptLen GC_NOTO: add argument description - - @return GC_NOTO: add return values - -**/ -VOID -PxeBcCreateBootOptions ( - IN EFI_DHCP4_PACKET_OPTION *OptList, - IN UINT16 Type, - IN UINT16 *Layer, - OUT UINT32 *OptLen - ) -; - - -/** - GC_NOTO: Add function description - - @param Buffer GC_NOTO: add argument description - @param Length GC_NOTO: add argument description - @param OptTag GC_NOTO: add argument description - - @return GC_NOTO: add return values - -**/ -EFI_DHCP4_PACKET_OPTION * -PxeBcParseExtendOptions ( - IN UINT8 *Buffer, - IN UINT32 Length, - IN UINT8 OptTag - ) -; - - -/** - GC_NOTO: Add function description - - @param Dhcp4Option GC_NOTO: add argument description - @param VendorOption GC_NOTO: add argument description - - @return GC_NOTO: add return values - -**/ -BOOLEAN -PxeBcParseVendorOptions ( - IN EFI_DHCP4_PACKET_OPTION *Dhcp4Option, - IN PXEBC_VENDOR_OPTION *VendorOption - ) -; - - -/** - GC_NOTO: Add function description - - @param Private GC_NOTO: add argument description - @param Info GC_NOTO: add argument description - @param Type GC_NOTO: add argument description - - @return GC_NOTO: add return values - -**/ -EFI_STATUS -PxeBcSelectBootServers ( - IN PXEBC_PRIVATE_DATA *Private, - OUT EFI_PXE_BASE_CODE_DISCOVER_INFO **Info, - OUT UINT16 *Type - ) -; - - -/** - GC_NOTO: Add function description - - @param Private GC_NOTO: add argument description - - @return GC_NOTO: add return values - -**/ -EFI_STATUS -PxeBcSelectBootPrompt ( - IN PXEBC_PRIVATE_DATA *Private - ) -; - - -/** - GC_NOTO: Add function description - - @param Private GC_NOTO: add argument description - @param Type GC_NOTO: add argument description - - @return GC_NOTO: add return values - -**/ -EFI_STATUS -PxeBcSelectBootMenu ( - IN PXEBC_PRIVATE_DATA *Private, - OUT UINT16 *Type, - IN BOOLEAN UseDefaultItem - ) -; - -#endif - +/** @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: + + PxeBcDhcp.h + +Abstract: + + Dhcp and Discover routines for PxeBc + + +**/ + +#ifndef __EFI_PXEBC_DHCP_H__ +#define __EFI_PXEBC_DHCP_H__ + +enum { + PXEBC_DHCP4_MAX_OPTION_NUM = 16, + PXEBC_DHCP4_MAX_OPTION_SIZE = 312, + PXEBC_DHCP4_MAX_PACKET_SIZE = 1472, + + PXEBC_DHCP4_S_PORT = 67, + PXEBC_DHCP4_C_PORT = 68, + PXEBC_BS_DOWNLOAD_PORT = 69, + PXEBC_BS_DISCOVER_PORT = 4011, + + PXEBC_DHCP4_OPCODE_REQUEST = 1, + PXEBC_DHCP4_OPCODE_REPLY = 2, + PXEBC_DHCP4_MSG_TYPE_REQUEST = 3, + PXEBC_DHCP4_MAGIC = 0x63538263, // network byte order + // + // Dhcp Options + // + PXEBC_DHCP4_TAG_PAD = 0, // Pad Option + PXEBC_DHCP4_TAG_EOP = 255, // End Option + PXEBC_DHCP4_TAG_NETMASK = 1, // Subnet Mask + PXEBC_DHCP4_TAG_TIME_OFFSET = 2, // Time Offset from UTC + PXEBC_DHCP4_TAG_ROUTER = 3, // Router option, + PXEBC_DHCP4_TAG_TIME_SERVER = 4, // Time Server + PXEBC_DHCP4_TAG_NAME_SERVER = 5, // Name Server + PXEBC_DHCP4_TAG_DNS_SERVER = 6, // Domain Name Server + PXEBC_DHCP4_TAG_HOSTNAME = 12, // Host Name + PXEBC_DHCP4_TAG_BOOTFILE_LEN = 13, // Boot File Size + PXEBC_DHCP4_TAG_DUMP = 14, // Merit Dump File + PXEBC_DHCP4_TAG_DOMAINNAME = 15, // Domain Name + PXEBC_DHCP4_TAG_ROOTPATH = 17, // Root path + PXEBC_DHCP4_TAG_EXTEND_PATH = 18, // Extensions Path + PXEBC_DHCP4_TAG_EMTU = 22, // Maximum Datagram Reassembly Size + PXEBC_DHCP4_TAG_TTL = 23, // Default IP Time-to-live + PXEBC_DHCP4_TAG_BROADCAST = 28, // Broadcast Address + PXEBC_DHCP4_TAG_NIS_DOMAIN = 40, // Network Information Service Domain + PXEBC_DHCP4_TAG_NIS_SERVER = 41, // Network Information Servers + PXEBC_DHCP4_TAG_NTP_SERVER = 42, // Network Time Protocol Servers + PXEBC_DHCP4_TAG_VENDOR = 43, // Vendor Specific Information + PXEBC_DHCP4_TAG_REQUEST_IP = 50, // Requested IP Address + PXEBC_DHCP4_TAG_LEASE = 51, // IP Address Lease Time + PXEBC_DHCP4_TAG_OVERLOAD = 52, // Option Overload + PXEBC_DHCP4_TAG_MSG_TYPE = 53, // DHCP Message Type + PXEBC_DHCP4_TAG_SERVER_ID = 54, // Server Identifier + PXEBC_DHCP4_TAG_PARA_LIST = 55, // Parameter Request List + PXEBC_DHCP4_TAG_MAXMSG = 57, // Maximum DHCP Message Size + PXEBC_DHCP4_TAG_T1 = 58, // Renewal (T1) Time Value + PXEBC_DHCP4_TAG_T2 = 59, // Rebinding (T2) Time Value + PXEBC_DHCP4_TAG_CLASS_ID = 60, // Vendor class identifier + PXEBC_DHCP4_TAG_CLIENT_ID = 61, // Client-identifier + PXEBC_DHCP4_TAG_TFTP = 66, // TFTP server name + PXEBC_DHCP4_TAG_BOOTFILE = 67, // Bootfile name + PXEBC_PXE_DHCP4_TAG_ARCH = 93, + PXEBC_PXE_DHCP4_TAG_UNDI = 94, + PXEBC_PXE_DHCP4_TAG_UUID = 97, + // + // Sub-Options in Dhcp Vendor Option + // + PXEBC_VENDOR_TAG_MTFTP_IP = 1, + PXEBC_VENDOR_TAG_MTFTP_CPORT = 2, + PXEBC_VENDOR_TAG_MTFTP_SPORT = 3, + PXEBC_VENDOR_TAG_MTFTP_TIMEOUT = 4, + PXEBC_VENDOR_TAG_MTFTP_DELAY = 5, + PXEBC_VENDOR_TAG_DISCOVER_CTRL = 6, + PXEBC_VENDOR_TAG_DISCOVER_MCAST = 7, + PXEBC_VENDOR_TAG_BOOT_SERVERS = 8, + PXEBC_VENDOR_TAG_BOOT_MENU = 9, + PXEBC_VENDOR_TAG_MENU_PROMPT = 10, + PXEBC_VENDOR_TAG_MCAST_ALLOC = 11, + PXEBC_VENDOR_TAG_CREDENTIAL_TYPES = 12, + PXEBC_VENDOR_TAG_BOOT_ITEM = 71, + + PXEBC_DHCP4_DISCOVER_INIT_TIMEOUT = 4, + PXEBC_DHCP4_DISCOVER_RETRIES = 4, + + PXEBC_MAX_MENU_NUM = 24, + PXEBC_MAX_OFFER_NUM = 16, + + PXEBC_BOOT_REQUEST_TIMEOUT = 1, + PXEBC_BOOT_REQUEST_RETRIES = 4, + + PXEBC_DHCP4_OVERLOAD_FILE = 1, + PXEBC_DHCP4_OVERLOAD_SERVER_NAME = 2 +}; + +// +// The array index of the DHCP4 option tag interested +// +enum { + PXEBC_DHCP4_TAG_INDEX_BOOTFILE_LEN, + PXEBC_DHCP4_TAG_INDEX_VENDOR, + PXEBC_DHCP4_TAG_INDEX_OVERLOAD, + PXEBC_DHCP4_TAG_INDEX_MSG_TYPE, + PXEBC_DHCP4_TAG_INDEX_SERVER_ID, + PXEBC_DHCP4_TAG_INDEX_CLASS_ID, + PXEBC_DHCP4_TAG_INDEX_BOOTFILE, + PXEBC_DHCP4_TAG_INDEX_MAX +}; + +// +// The type of DHCP OFFER, arranged by priority, PXE10 has the highest priority. +// +enum { + DHCP4_PACKET_TYPE_PXE10, + DHCP4_PACKET_TYPE_WFM11A, + DHCP4_PACKET_TYPE_BINL, + DHCP4_PACKET_TYPE_DHCP_ONLY, + DHCP4_PACKET_TYPE_MAX, + DHCP4_PACKET_TYPE_BOOTP = DHCP4_PACKET_TYPE_MAX +}; + +#define BIT(x) (1 << x) +#define CTRL(x) (0x1F & (x)) + +// +// WfM11a options +// +#define MTFTP_VENDOR_OPTION_BIT_MAP (BIT (PXEBC_VENDOR_TAG_MTFTP_IP) | \ + BIT (PXEBC_VENDOR_TAG_MTFTP_CPORT) | \ + BIT (PXEBC_VENDOR_TAG_MTFTP_SPORT) | \ + BIT (PXEBC_VENDOR_TAG_MTFTP_TIMEOUT) | \ + BIT (PXEBC_VENDOR_TAG_MTFTP_DELAY)) +// +// Discoverty options +// +#define DISCOVER_VENDOR_OPTION_BIT_MAP (BIT (PXEBC_VENDOR_TAG_DISCOVER_CTRL) | \ + BIT (PXEBC_VENDOR_TAG_DISCOVER_MCAST) | \ + BIT (PXEBC_VENDOR_TAG_BOOT_SERVERS) | \ + BIT (PXEBC_VENDOR_TAG_BOOT_MENU) | \ + BIT (PXEBC_VENDOR_TAG_MENU_PROMPT)) + +#define IS_VALID_BOOT_PROMPT(x) \ + ((((x)[0]) & BIT (PXEBC_VENDOR_TAG_MENU_PROMPT)) == BIT (PXEBC_VENDOR_TAG_MENU_PROMPT)) + +#define IS_VALID_BOOT_MENU(x) \ + ((((x)[0]) & BIT (PXEBC_VENDOR_TAG_BOOT_MENU)) == BIT (PXEBC_VENDOR_TAG_BOOT_MENU)) + +#define IS_VALID_MTFTP_VENDOR_OPTION(x) \ + (((UINT32) ((x)[0]) & MTFTP_VENDOR_OPTION_BIT_MAP) == MTFTP_VENDOR_OPTION_BIT_MAP) + +#define IS_VALID_DISCOVER_VENDOR_OPTION(x) (((UINT32) ((x)[0]) & DISCOVER_VENDOR_OPTION_BIT_MAP) != 0) + +#define IS_VALID_CREDENTIAL_VENDOR_OPTION(x) \ + (((UINT32) ((x)[0]) & BIT (PXEBC_VENDOR_TAG_CREDENTIAL_TYPES)) == BIT (PXEBC_VENDOR_TAG_CREDENTIAL_TYPES)) + +#define IS_VALID_BOOTITEM_VENDOR_OPTION(x) \ + (((UINT32) ((x)[PXEBC_VENDOR_TAG_BOOT_ITEM / 32]) & BIT (PXEBC_VENDOR_TAG_BOOT_ITEM % 32)) \ + == BIT (PXEBC_VENDOR_TAG_BOOT_ITEM % 32)) + +#define IS_DISABLE_BCAST_DISCOVER(x) (((x) & BIT (0)) == BIT (0)) +#define IS_DISABLE_MCAST_DISCOVER(x) (((x) & BIT (1)) == BIT (1)) +#define IS_ENABLE_USE_SERVER_LIST(x) (((x) & BIT (2)) == BIT (2)) +#define IS_ENABLE_BOOT_FILE_NAME(x) (((x) & BIT (3)) == BIT (3)) + +#define SET_VENDOR_OPTION_BIT_MAP(x, y) (((x)[(y) / 32]) = (UINT32) ((x)[(y) / 32]) | BIT ((y) % 32)) + +#pragma pack(1) +typedef struct { + UINT8 ParaList[135]; +} PXEBC_DHCP4_OPTION_PARA; + +typedef struct { + UINT16 Size; +} PXEBC_DHCP4_OPTION_MAX_MESG_SIZE; + +typedef struct { + UINT8 Type; + UINT8 MajorVer; + UINT8 MinorVer; +} PXEBC_DHCP4_OPTION_UNDI; + +typedef struct { + UINT8 Type; +} PXEBC_DHCP4_OPTION_MESG; + +typedef struct { + UINT16 Type; +} PXEBC_DHCP4_OPTION_ARCH; + +#define DEFAULT_CLASS_ID_DATA "PXEClient:Arch:?????:????:??????" + +typedef struct { + UINT8 ClassIdentifier[10]; + UINT8 ArchitecturePrefix[5]; + UINT8 ArchitectureType[5]; + UINT8 Lit3[1]; + UINT8 InterfaceName[4]; + UINT8 Lit4[1]; + UINT8 UndiMajor[3]; + UINT8 UndiMinor[3]; +} PXEBC_DHCP4_OPTION_CLID; + +typedef struct { + UINT8 Type; + UINT8 Guid[16]; +} PXEBC_DHCP4_OPTION_UUID; + +typedef struct { + UINT16 Type; + UINT16 Layer; +} PXEBC_OPTION_BOOT_ITEM; + +#pragma pack() + +typedef union { + PXEBC_DHCP4_OPTION_PARA *Para; + PXEBC_DHCP4_OPTION_UNDI *Undi; + PXEBC_DHCP4_OPTION_ARCH *Arch; + PXEBC_DHCP4_OPTION_CLID *Clid; + PXEBC_DHCP4_OPTION_UUID *Uuid; + PXEBC_DHCP4_OPTION_MESG *Mesg; + PXEBC_DHCP4_OPTION_MAX_MESG_SIZE *MaxMesgSize; +} PXEBC_DHCP4_OPTION_ENTRY; + +typedef struct { + UINT16 Type; + UINT8 IpCnt; + EFI_IPv4_ADDRESS IpAddr[1]; +} PXEBC_BOOT_SVR_ENTRY; + +typedef struct { + UINT16 Type; + UINT8 DescLen; + UINT8 DescStr[1]; +} PXEBC_BOOT_MENU_ENTRY; + +typedef struct { + UINT8 Timeout; + UINT8 Prompt[1]; +} PXEBC_MENU_PROMPT; + +typedef struct { + UINT32 BitMap[8]; + EFI_IPv4_ADDRESS MtftpIp; + UINT16 MtftpCPort; + UINT16 MtftpSPort; + UINT8 MtftpTimeout; + UINT8 MtftpDelay; + UINT8 DiscoverCtrl; + EFI_IPv4_ADDRESS DiscoverMcastIp; + EFI_IPv4_ADDRESS McastIpBase; + UINT16 McastIpBlock; + UINT16 McastIpRange; + UINT16 BootSrvType; + UINT16 BootSrvLayer; + PXEBC_BOOT_SVR_ENTRY *BootSvr; + UINT8 BootSvrLen; + PXEBC_BOOT_MENU_ENTRY *BootMenu; + UINT8 BootMenuLen; + PXEBC_MENU_PROMPT *MenuPrompt; + UINT8 MenuPromptLen; + UINT32 *CredType; + UINT8 CredTypeLen; +} PXEBC_VENDOR_OPTION; + +#define PXEBC_CACHED_DHCP4_PACKET_MAX_SIZE (EFI_FIELD_OFFSET (EFI_DHCP4_PACKET, Dhcp4) + PXEBC_DHCP4_MAX_PACKET_SIZE) + +typedef struct { + union { + EFI_DHCP4_PACKET Offer; + EFI_DHCP4_PACKET Ack; + UINT8 Buffer[PXEBC_CACHED_DHCP4_PACKET_MAX_SIZE]; + } Packet; + + BOOLEAN IsPxeOffer; + UINT8 OfferType; + EFI_DHCP4_PACKET_OPTION *Dhcp4Option[PXEBC_DHCP4_TAG_INDEX_MAX]; + PXEBC_VENDOR_OPTION PxeVendorOption; +} PXEBC_CACHED_DHCP4_PACKET; + +#define GET_NEXT_DHCP_OPTION(Opt) \ + (EFI_DHCP4_PACKET_OPTION *) ((UINT8 *) (Opt) + sizeof (EFI_DHCP4_PACKET_OPTION) + (Opt)->Length - 1) + +#define GET_OPTION_BUFFER_LEN(Pkt) ((Pkt)->Length - sizeof (EFI_DHCP4_HEADER) - 4) +#define IS_PROXY_DHCP_OFFER(Offer) EFI_IP4_EQUAL (&((Offer)->Dhcp4.Header.YourAddr), &mZeroIp4Addr) + +#define GET_NEXT_BOOT_SVR_ENTRY(Ent) \ + (PXEBC_BOOT_SVR_ENTRY *) ((UINT8 *) Ent + sizeof (*(Ent)) + ((Ent)->IpCnt - 1) * sizeof (EFI_IPv4_ADDRESS)) + +VOID +PxeBcInitSeedPacket ( + IN EFI_DHCP4_PACKET *Seed, + IN EFI_UDP4_PROTOCOL *Udp4 + ) +/*++ + +Routine Description: + + GC_NOTO: Add function description + +Arguments: + + Seed - GC_NOTO: add argument description + Udp4 - GC_NOTO: add argument description + +Returns: + + GC_NOTO: add return values + +--*/ +; + + +/** + GC_NOTO: Add function description + + @param CachedPacket GC_NOTO: add argument description + + @return GC_NOTO: add return values + +**/ +BOOLEAN +PxeBcParseCachedDhcpPacket ( + IN PXEBC_CACHED_DHCP4_PACKET *CachedPacket + ) +; + + +/** + GC_NOTO: Add function description + + @param Private GC_NOTO: add argument description + + @return GC_NOTO: add return values + +**/ +EFI_STATUS +PxeBcCheckSelectedOffer ( + IN PXEBC_PRIVATE_DATA *Private + ) +; + + +/** + GC_NOTO: Add function description + + @param This GC_NOTO: add argument description + @param Context GC_NOTO: add argument description + @param CurrentState GC_NOTO: add argument description + @param Dhcp4Event GC_NOTO: add argument description + @param Packet GC_NOTO: add argument description + @param NewPacket GC_NOTO: add argument description + + @return GC_NOTO: add return values + +**/ +EFI_STATUS +PxeBcDhcpCallBack ( + IN EFI_DHCP4_PROTOCOL * This, + IN VOID *Context, + IN EFI_DHCP4_STATE CurrentState, + IN EFI_DHCP4_EVENT Dhcp4Event, + IN EFI_DHCP4_PACKET * Packet OPTIONAL, + OUT EFI_DHCP4_PACKET **NewPacket OPTIONAL + ) +; + + +/** + GC_NOTO: Add function description + + @param Private GC_NOTO: add argument description + @param Type GC_NOTO: add argument description + @param Layer GC_NOTO: add argument description + @param UseBis GC_NOTO: add argument description + @param DestIp GC_NOTO: add argument description + @param IpCount GC_NOTO: add argument description + @param SrvList GC_NOTO: add argument description + @param IsDiscv GC_NOTO: add argument description + @param Reply GC_NOTO: add argument description + + @return GC_NOTO: add return values + +**/ +EFI_STATUS +PxeBcDiscvBootService ( + IN PXEBC_PRIVATE_DATA * Private, + IN UINT16 Type, + IN UINT16 *Layer, + IN BOOLEAN UseBis, + IN EFI_IP_ADDRESS * DestIp, + IN UINT16 IpCount, + IN EFI_PXE_BASE_CODE_SRVLIST * SrvList, + IN BOOLEAN IsDiscv, + OUT EFI_DHCP4_PACKET * Reply OPTIONAL + ) +; + + +/** + GC_NOTO: Add function description + + @param Private GC_NOTO: add argument description + @param OptList GC_NOTO: add argument description + @param IsDhcpDiscover GC_NOTO: add argument description + + @return GC_NOTO: add return values + +**/ +UINT32 +PxeBcBuildDhcpOptions ( + IN PXEBC_PRIVATE_DATA *Private, + IN EFI_DHCP4_PACKET_OPTION **OptList, + IN BOOLEAN IsDhcpDiscover + ) +; + + +/** + GC_NOTO: Add function description + + @param OptList GC_NOTO: add argument description + @param Type GC_NOTO: add argument description + @param Layer GC_NOTO: add argument description + @param OptLen GC_NOTO: add argument description + + @return GC_NOTO: add return values + +**/ +VOID +PxeBcCreateBootOptions ( + IN EFI_DHCP4_PACKET_OPTION *OptList, + IN UINT16 Type, + IN UINT16 *Layer, + OUT UINT32 *OptLen + ) +; + + +/** + GC_NOTO: Add function description + + @param Buffer GC_NOTO: add argument description + @param Length GC_NOTO: add argument description + @param OptTag GC_NOTO: add argument description + + @return GC_NOTO: add return values + +**/ +EFI_DHCP4_PACKET_OPTION * +PxeBcParseExtendOptions ( + IN UINT8 *Buffer, + IN UINT32 Length, + IN UINT8 OptTag + ) +; + + +/** + GC_NOTO: Add function description + + @param Dhcp4Option GC_NOTO: add argument description + @param VendorOption GC_NOTO: add argument description + + @return GC_NOTO: add return values + +**/ +BOOLEAN +PxeBcParseVendorOptions ( + IN EFI_DHCP4_PACKET_OPTION *Dhcp4Option, + IN PXEBC_VENDOR_OPTION *VendorOption + ) +; + + +/** + GC_NOTO: Add function description + + @param Private GC_NOTO: add argument description + @param Info GC_NOTO: add argument description + @param Type GC_NOTO: add argument description + + @return GC_NOTO: add return values + +**/ +EFI_STATUS +PxeBcSelectBootServers ( + IN PXEBC_PRIVATE_DATA *Private, + OUT EFI_PXE_BASE_CODE_DISCOVER_INFO **Info, + OUT UINT16 *Type + ) +; + + +/** + GC_NOTO: Add function description + + @param Private GC_NOTO: add argument description + + @return GC_NOTO: add return values + +**/ +EFI_STATUS +PxeBcSelectBootPrompt ( + IN PXEBC_PRIVATE_DATA *Private + ) +; + + +/** + GC_NOTO: Add function description + + @param Private GC_NOTO: add argument description + @param Type GC_NOTO: add argument description + + @return GC_NOTO: add return values + +**/ +EFI_STATUS +PxeBcSelectBootMenu ( + IN PXEBC_PRIVATE_DATA *Private, + OUT UINT16 *Type, + IN BOOLEAN UseDefaultItem + ) +; + +#endif + diff --git a/MdeModulePkg/Universal/Network/UefiPxeBcDxe/PxeBcDriver.h b/MdeModulePkg/Universal/Network/UefiPxeBcDxe/PxeBcDriver.h index 4cb1e2b..8e5bc7d 100644 --- a/MdeModulePkg/Universal/Network/UefiPxeBcDxe/PxeBcDriver.h +++ b/MdeModulePkg/Universal/Network/UefiPxeBcDxe/PxeBcDriver.h @@ -1,103 +1,103 @@ -/** @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: - - PxeBcDriver.h - -Abstract: - - -**/ - -#ifndef __EFI_PXEBC_DRIVER_H__ -#define __EFI_PXEBC_DRIVER_H__ - -EFI_STATUS -PxeBcDriverBindingSupported ( - IN EFI_DRIVER_BINDING_PROTOCOL *This, - IN EFI_HANDLE Controller, - IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath - ) -/*++ - - Routine Description: - Test to see if this driver supports ControllerHandle. - - Arguments: - This - Protocol instance pointer. - ControllerHandle - Handle of device to test - RemainingDevicePath - Optional parameter use to pick a specific child - device to start. - - Returns: - EFI_SUCCES - EFI_ALREADY_STARTED - Others - ---*/ -// GC_NOTO: Controller - add argument and description to function comment -; - - -/** - Start this driver on ControllerHandle. - - @param This Protocol instance pointer. - @param ControllerHandle Handle of device to bind driver to - @param RemainingDevicePath Optional parameter use to pick a specific child - device to start. - - @return EFI_SUCCES - @return EFI_ALREADY_STARTED - @return EFI_OUT_OF_RESOURCES - @return Others - -**/ -// GC_NOTO: Controller - add argument and description to function comment -EFI_STATUS -PxeBcDriverBindingStart ( - IN EFI_DRIVER_BINDING_PROTOCOL *This, - IN EFI_HANDLE Controller, - IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath - ) -; - - -/** - Stop this driver on ControllerHandle. - - @param This Protocol instance pointer. - @param ControllerHandle Handle of device to stop driver on - @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of - children is zero stop the entire bus driver. - @param ChildHandleBuffer List of Child Handles to Stop. - - @return EFI_SUCCESS - @return EFI_DEVICE_ERROR - @return Others - -**/ -// GC_NOTO: Controller - add argument and description to function comment -EFI_STATUS -PxeBcDriverBindingStop ( - IN EFI_DRIVER_BINDING_PROTOCOL *This, - IN EFI_HANDLE Controller, - IN UINTN NumberOfChildren, - IN EFI_HANDLE *ChildHandleBuffer - ) -; - -extern EFI_COMPONENT_NAME2_PROTOCOL gPxeBcComponentName2; -extern EFI_COMPONENT_NAME_PROTOCOL gPxeBcComponentName; -extern EFI_DRIVER_BINDING_PROTOCOL gPxeBcDriverBinding; -#endif - +/** @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: + + PxeBcDriver.h + +Abstract: + + +**/ + +#ifndef __EFI_PXEBC_DRIVER_H__ +#define __EFI_PXEBC_DRIVER_H__ + +EFI_STATUS +PxeBcDriverBindingSupported ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE Controller, + IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath + ) +/*++ + + Routine Description: + Test to see if this driver supports ControllerHandle. + + Arguments: + This - Protocol instance pointer. + ControllerHandle - Handle of device to test + RemainingDevicePath - Optional parameter use to pick a specific child + device to start. + + Returns: + EFI_SUCCES + EFI_ALREADY_STARTED + Others + +--*/ +// GC_NOTO: Controller - add argument and description to function comment +; + + +/** + Start this driver on ControllerHandle. + + @param This Protocol instance pointer. + @param ControllerHandle Handle of device to bind driver to + @param RemainingDevicePath Optional parameter use to pick a specific child + device to start. + + @return EFI_SUCCES + @return EFI_ALREADY_STARTED + @return EFI_OUT_OF_RESOURCES + @return Others + +**/ +// GC_NOTO: Controller - add argument and description to function comment +EFI_STATUS +PxeBcDriverBindingStart ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE Controller, + IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath + ) +; + + +/** + Stop this driver on ControllerHandle. + + @param This Protocol instance pointer. + @param ControllerHandle Handle of device to stop driver on + @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of + children is zero stop the entire bus driver. + @param ChildHandleBuffer List of Child Handles to Stop. + + @return EFI_SUCCESS + @return EFI_DEVICE_ERROR + @return Others + +**/ +// GC_NOTO: Controller - add argument and description to function comment +EFI_STATUS +PxeBcDriverBindingStop ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE Controller, + IN UINTN NumberOfChildren, + IN EFI_HANDLE *ChildHandleBuffer + ) +; + +extern EFI_COMPONENT_NAME2_PROTOCOL gPxeBcComponentName2; +extern EFI_COMPONENT_NAME_PROTOCOL gPxeBcComponentName; +extern EFI_DRIVER_BINDING_PROTOCOL gPxeBcDriverBinding; +#endif + diff --git a/MdeModulePkg/Universal/Network/UefiPxeBcDxe/PxeBcImpl.h b/MdeModulePkg/Universal/Network/UefiPxeBcDxe/PxeBcImpl.h index 028adcd..17bd863 100644 --- a/MdeModulePkg/Universal/Network/UefiPxeBcDxe/PxeBcImpl.h +++ b/MdeModulePkg/Universal/Network/UefiPxeBcDxe/PxeBcImpl.h @@ -1,146 +1,146 @@ -/** @file - -Copyright (c) 2007 - 2008, 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; - -#include - -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include - -#include -#include -#include -#include -#include -#include -#include - -#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 Ip4Child; - EFI_HANDLE Mtftp4Child; - EFI_HANDLE Udp4ReadChild; - EFI_HANDLE Udp4WriteChild; - - 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_IP4_PROTOCOL *Ip4; - EFI_IP4_CONFIG_DATA Ip4ConfigData; - EFI_MTFTP4_PROTOCOL *Mtftp4; - EFI_UDP4_PROTOCOL *Udp4Read; - EFI_UDP4_PROTOCOL *Udp4Write; - UINT16 CurrentUdpSrcPort; - 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; - EFI_MAC_ADDRESS Mac; - UINT8 MacLen; - - BOOLEAN SortOffers; - BOOLEAN GotProxyOffer; - 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]; - - EFI_EVENT GetArpCacheEvent; - // - // token and event used to get ICMP error data from IP - // - EFI_IP4_COMPLETION_TOKEN IcmpErrorRcvToken; -}; - -#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 +/** @file + +Copyright (c) 2007 - 2008, 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; + +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include + +#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 Ip4Child; + EFI_HANDLE Mtftp4Child; + EFI_HANDLE Udp4ReadChild; + EFI_HANDLE Udp4WriteChild; + + 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_IP4_PROTOCOL *Ip4; + EFI_IP4_CONFIG_DATA Ip4ConfigData; + EFI_MTFTP4_PROTOCOL *Mtftp4; + EFI_UDP4_PROTOCOL *Udp4Read; + EFI_UDP4_PROTOCOL *Udp4Write; + UINT16 CurrentUdpSrcPort; + 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; + EFI_MAC_ADDRESS Mac; + UINT8 MacLen; + + BOOLEAN SortOffers; + BOOLEAN GotProxyOffer; + 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]; + + EFI_EVENT GetArpCacheEvent; + // + // token and event used to get ICMP error data from IP + // + EFI_IP4_COMPLETION_TOKEN IcmpErrorRcvToken; +}; + +#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 diff --git a/MdeModulePkg/Universal/Network/UefiPxeBcDxe/PxeBcMtftp.h b/MdeModulePkg/Universal/Network/UefiPxeBcDxe/PxeBcMtftp.h index ac8dd2f..85598cb 100644 --- a/MdeModulePkg/Universal/Network/UefiPxeBcDxe/PxeBcMtftp.h +++ b/MdeModulePkg/Universal/Network/UefiPxeBcDxe/PxeBcMtftp.h @@ -1,144 +1,144 @@ -/** @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: - - PxeBcMtftp.h - -Abstract: - - Mtftp routines for PxeBc - - -**/ - -#ifndef __EFI_PXEBC_MTFTP_H__ -#define __EFI_PXEBC_MTFTP_H__ - -enum { - PXE_MTFTP_OPTION_BLKSIZE_INDEX, - PXE_MTFTP_OPTION_TIMEOUT_INDEX, - PXE_MTFTP_OPTION_TSIZE_INDEX, - PXE_MTFTP_OPTION_MULTICAST_INDEX, - PXE_MTFTP_OPTION_MAXIMUM_INDEX -}; - - -/** - This function is to get size of a file by Tftp. - - @param Private Pointer to PxeBc private data - @param Config Pointer to Mtftp configuration data - @param Filename Pointer to file name - @param BlockSize Pointer to block size - @param BufferSize Pointer to buffer size - - @return EFI_SUCCESS - @return EFI_NOT_FOUND - @return EFI_DEVICE_ERROR - -**/ -EFI_STATUS -PxeBcTftpGetFileSize ( - IN PXEBC_PRIVATE_DATA *Private, - IN EFI_MTFTP4_CONFIG_DATA *Config, - IN UINT8 *Filename, - IN UINTN *BlockSize, - IN OUT UINT64 *BufferSize - ) -; - - -/** - This function is to get data of a file by Tftp. - - @param Private Pointer to PxeBc private data - @param Config Pointer to Mtftp configuration data - @param Filename Pointer to file name - @param BlockSize Pointer to block size - @param BufferPtr Pointer to buffer - @param BufferSize Pointer to buffer size - @param DontUseBuffer Indicate whether with a receive buffer - - @return EFI_SUCCESS - @return EFI_DEVICE_ERROR - -**/ -EFI_STATUS -PxeBcTftpReadFile ( - IN PXEBC_PRIVATE_DATA *Private, - IN EFI_MTFTP4_CONFIG_DATA *Config, - IN UINT8 *Filename, - IN UINTN *BlockSize, - IN UINT8 *BufferPtr, - IN OUT UINT64 *BufferSize, - IN BOOLEAN DontUseBuffer - ) -; - - -/** - This function is put data of a file by Tftp. - - @param Private Pointer to PxeBc private data - @param Config Pointer to Mtftp configuration data - @param Filename Pointer to file name - @param Overwrite Indicate whether with overwrite attribute - @param BlockSize Pointer to block size - @param BufferPtr Pointer to buffer - @param BufferSize Pointer to buffer size - - @return EFI_SUCCESS - @return EFI_DEVICE_ERROR - -**/ -EFI_STATUS -PxeBcTftpWriteFile ( - IN PXEBC_PRIVATE_DATA *Private, - IN EFI_MTFTP4_CONFIG_DATA *Config, - IN UINT8 *Filename, - IN BOOLEAN Overwrite, - IN UINTN *BlockSize, - IN UINT8 *BufferPtr, - IN OUT UINT64 *BufferSize - ) -; - - -/** - This function is to get data of a directory by Tftp. - - @param Private Pointer to PxeBc private data - @param Config Pointer to Mtftp configuration data - @param Filename Pointer to file name - @param BlockSize Pointer to block size - @param BufferPtr Pointer to buffer - @param BufferSize Pointer to buffer size - @param DontUseBuffer Indicate whether with a receive buffer - - @return EFI_SUCCES - @return EFI_DEVICE_ERROR - -**/ -EFI_STATUS -PxeBcTftpReadDirectory ( - IN PXEBC_PRIVATE_DATA *Private, - IN EFI_MTFTP4_CONFIG_DATA *Config, - IN UINT8 *Filename, - IN UINTN *BlockSize, - IN UINT8 *BufferPtr, - IN OUT UINT64 *BufferSize, - IN BOOLEAN DontUseBuffer - ) -; - -#endif - +/** @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: + + PxeBcMtftp.h + +Abstract: + + Mtftp routines for PxeBc + + +**/ + +#ifndef __EFI_PXEBC_MTFTP_H__ +#define __EFI_PXEBC_MTFTP_H__ + +enum { + PXE_MTFTP_OPTION_BLKSIZE_INDEX, + PXE_MTFTP_OPTION_TIMEOUT_INDEX, + PXE_MTFTP_OPTION_TSIZE_INDEX, + PXE_MTFTP_OPTION_MULTICAST_INDEX, + PXE_MTFTP_OPTION_MAXIMUM_INDEX +}; + + +/** + This function is to get size of a file by Tftp. + + @param Private Pointer to PxeBc private data + @param Config Pointer to Mtftp configuration data + @param Filename Pointer to file name + @param BlockSize Pointer to block size + @param BufferSize Pointer to buffer size + + @return EFI_SUCCESS + @return EFI_NOT_FOUND + @return EFI_DEVICE_ERROR + +**/ +EFI_STATUS +PxeBcTftpGetFileSize ( + IN PXEBC_PRIVATE_DATA *Private, + IN EFI_MTFTP4_CONFIG_DATA *Config, + IN UINT8 *Filename, + IN UINTN *BlockSize, + IN OUT UINT64 *BufferSize + ) +; + + +/** + This function is to get data of a file by Tftp. + + @param Private Pointer to PxeBc private data + @param Config Pointer to Mtftp configuration data + @param Filename Pointer to file name + @param BlockSize Pointer to block size + @param BufferPtr Pointer to buffer + @param BufferSize Pointer to buffer size + @param DontUseBuffer Indicate whether with a receive buffer + + @return EFI_SUCCESS + @return EFI_DEVICE_ERROR + +**/ +EFI_STATUS +PxeBcTftpReadFile ( + IN PXEBC_PRIVATE_DATA *Private, + IN EFI_MTFTP4_CONFIG_DATA *Config, + IN UINT8 *Filename, + IN UINTN *BlockSize, + IN UINT8 *BufferPtr, + IN OUT UINT64 *BufferSize, + IN BOOLEAN DontUseBuffer + ) +; + + +/** + This function is put data of a file by Tftp. + + @param Private Pointer to PxeBc private data + @param Config Pointer to Mtftp configuration data + @param Filename Pointer to file name + @param Overwrite Indicate whether with overwrite attribute + @param BlockSize Pointer to block size + @param BufferPtr Pointer to buffer + @param BufferSize Pointer to buffer size + + @return EFI_SUCCESS + @return EFI_DEVICE_ERROR + +**/ +EFI_STATUS +PxeBcTftpWriteFile ( + IN PXEBC_PRIVATE_DATA *Private, + IN EFI_MTFTP4_CONFIG_DATA *Config, + IN UINT8 *Filename, + IN BOOLEAN Overwrite, + IN UINTN *BlockSize, + IN UINT8 *BufferPtr, + IN OUT UINT64 *BufferSize + ) +; + + +/** + This function is to get data of a directory by Tftp. + + @param Private Pointer to PxeBc private data + @param Config Pointer to Mtftp configuration data + @param Filename Pointer to file name + @param BlockSize Pointer to block size + @param BufferPtr Pointer to buffer + @param BufferSize Pointer to buffer size + @param DontUseBuffer Indicate whether with a receive buffer + + @return EFI_SUCCES + @return EFI_DEVICE_ERROR + +**/ +EFI_STATUS +PxeBcTftpReadDirectory ( + IN PXEBC_PRIVATE_DATA *Private, + IN EFI_MTFTP4_CONFIG_DATA *Config, + IN UINT8 *Filename, + IN UINTN *BlockSize, + IN UINT8 *BufferPtr, + IN OUT UINT64 *BufferSize, + IN BOOLEAN DontUseBuffer + ) +; + +#endif + diff --git a/MdeModulePkg/Universal/Network/UefiPxeBcDxe/PxeBcSupport.h b/MdeModulePkg/Universal/Network/UefiPxeBcDxe/PxeBcSupport.h index 47c2a06..6ca661e 100644 --- a/MdeModulePkg/Universal/Network/UefiPxeBcDxe/PxeBcSupport.h +++ b/MdeModulePkg/Universal/Network/UefiPxeBcDxe/PxeBcSupport.h @@ -1,98 +1,98 @@ -/** @file - -Copyright (c) 2007 - 2008, 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: - - PxeBcSupport.h - -Abstract: - - Support routines for PxeBc - - -**/ - -#ifndef __EFI_PXEBC_SUPPORT_H__ -#define __EFI_PXEBC_SUPPORT_H__ - -EFI_STATUS -GetSmbiosSystemGuidAndSerialNumber ( - IN EFI_GUID *SystemGuid, - OUT CHAR8 **SystemSerialNumber - ); - - -/** - GC_NOTO: Add function description - - @param Event GC_NOTO: add argument description - @param Context GC_NOTO: add argument description - - @return GC_NOTO: add return values - -**/ -VOID -PxeBcCommonNotify ( - IN EFI_EVENT Event, - IN VOID *Context - ) -; - -EFI_STATUS -PxeBcConfigureUdpWriteInstance ( - IN EFI_UDP4_PROTOCOL *Udp4, - IN EFI_IPv4_ADDRESS *StationIp, - IN EFI_IPv4_ADDRESS *SubnetMask, - IN EFI_IPv4_ADDRESS *Gateway, - IN OUT UINT16 *SrcPort - ); -VOID -CvtNum ( - IN UINTN Number, - IN UINT8 *Buffer, - IN INTN Length - ); - - -/** - GC_NOTO: Add function description - - @param Number GC_NOTO: add argument description - @param BufferPtr GC_NOTO: add argument description - - @return GC_NOTO: add return values - -**/ -UINTN -UtoA10 ( - UINTN Number, - CHAR8 *BufferPtr - ) -; - - -/** - GC_NOTO: Add function description - - @param BufferPtr GC_NOTO: add argument description - - @return GC_NOTO: add return values - -**/ -UINT64 -AtoU64 ( - UINT8 *BufferPtr - ) -; - - -#endif - +/** @file + +Copyright (c) 2007 - 2008, 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: + + PxeBcSupport.h + +Abstract: + + Support routines for PxeBc + + +**/ + +#ifndef __EFI_PXEBC_SUPPORT_H__ +#define __EFI_PXEBC_SUPPORT_H__ + +EFI_STATUS +GetSmbiosSystemGuidAndSerialNumber ( + IN EFI_GUID *SystemGuid, + OUT CHAR8 **SystemSerialNumber + ); + + +/** + GC_NOTO: Add function description + + @param Event GC_NOTO: add argument description + @param Context GC_NOTO: add argument description + + @return GC_NOTO: add return values + +**/ +VOID +PxeBcCommonNotify ( + IN EFI_EVENT Event, + IN VOID *Context + ) +; + +EFI_STATUS +PxeBcConfigureUdpWriteInstance ( + IN EFI_UDP4_PROTOCOL *Udp4, + IN EFI_IPv4_ADDRESS *StationIp, + IN EFI_IPv4_ADDRESS *SubnetMask, + IN EFI_IPv4_ADDRESS *Gateway, + IN OUT UINT16 *SrcPort + ); +VOID +CvtNum ( + IN UINTN Number, + IN UINT8 *Buffer, + IN INTN Length + ); + + +/** + GC_NOTO: Add function description + + @param Number GC_NOTO: add argument description + @param BufferPtr GC_NOTO: add argument description + + @return GC_NOTO: add return values + +**/ +UINTN +UtoA10 ( + UINTN Number, + CHAR8 *BufferPtr + ) +; + + +/** + GC_NOTO: Add function description + + @param BufferPtr GC_NOTO: add argument description + + @return GC_NOTO: add return values + +**/ +UINT64 +AtoU64 ( + UINT8 *BufferPtr + ) +; + + +#endif + diff --git a/MdeModulePkg/Universal/Network/UefiPxeBcDxe/X64/PxeArch.h b/MdeModulePkg/Universal/Network/UefiPxeBcDxe/X64/PxeArch.h index a8fa293..33a7b26 100644 --- a/MdeModulePkg/Universal/Network/UefiPxeBcDxe/X64/PxeArch.h +++ b/MdeModulePkg/Universal/Network/UefiPxeBcDxe/X64/PxeArch.h @@ -1,26 +1,26 @@ -/** @file - -Copyright (c) 2006, 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: - PxeArch.h - -Abstract: - Defines PXE Arch type - - -**/ - -#ifndef _EFI_PXE_ARCH_H_ -#define _EFI_PXE_ARCH_H_ - -#define SYS_ARCH 0x7 - -#endif +/** @file + +Copyright (c) 2006, 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: + PxeArch.h + +Abstract: + Defines PXE Arch type + + +**/ + +#ifndef _EFI_PXE_ARCH_H_ +#define _EFI_PXE_ARCH_H_ + +#define SYS_ARCH 0x7 + +#endif -- cgit v1.1