[mirror_edk2.git] / MdeModulePkg / Universal / Network / UefiPxeBcDxe / PxeBcImpl.h

/** @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;

#include <PiDxe.h>

#include <Guid/SmBios.h>
#include <IndustryStandard/SmBios.h>
#include <Protocol/Dhcp4.h>
#include <Protocol/PxeBaseCode.h>
#include <Protocol/Mtftp4.h>
#include <Protocol/Udp4.h>
#include <Protocol/LoadFile.h>
#include <Protocol/NetworkInterfaceIdentifier.h>
#include <Protocol/PxeBaseCodeCallBack.h>
#include <Protocol/Arp.h>
#include <Protocol/Ip4.h>

#include <Library/DebugLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/UefiDriverEntryPoint.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/UefiLib.h>
#include <Library/BaseLib.h>
#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                                Ip4Child;
  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_IP4_PROTOCOL                          *Ip4;
  EFI_IP4_CONFIG_DATA                       Ip4ConfigData;
  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;
  EFI_MAC_ADDRESS                           Mac;
  UINT8                                     MacLen;

  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];

  EFI_EVENT                                 GetArpCacheEvent;
  //\r
  // token and event used to get ICMP error data from IP\r
  //\r
  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
Commit	Line	Data
	1	/** @file
	2
	3	Copyright (c) 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
	8
	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.
	11
	12	Module Name:
	13
	14	PxeBcImpl.h
	15
	16	Abstract:
	17
	18
	19	**/
	20
	21	#ifndef __EFI_PXEBC_IMPL_H__
	22	#define __EFI_PXEBC_IMPL_H__
	23
	24
	25	typedef struct _PXEBC_PRIVATE_DATA PXEBC_PRIVATE_DATA;
	26
	27	#include <PiDxe.h>
	28
	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>
	40
	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>
	48
	49	#include "PxeBcDriver.h"
	50	#include "PxeArch.h"
	51	#include "PxeBcDhcp.h"
	52	#include "PxeBcMtftp.h"
	53	#include "PxeBcSupport.h"
	54
	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
	58
	59	struct _PXEBC_PRIVATE_DATA {
	60	UINT32 Signature;
	61	EFI_HANDLE Controller;
	62	EFI_HANDLE Image;
	63	EFI_HANDLE ArpChild;
	64	EFI_HANDLE Dhcp4Child;
	65	EFI_HANDLE Ip4Child;
	66	EFI_HANDLE Mtftp4Child;
	67	EFI_HANDLE Udp4Child;
	68
	69
	70	EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL *Nii;
	71
	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 *Udp4;
	82	EFI_UDP4_CONFIG_DATA Udp4CfgData;
	83
	84
	85	EFI_PXE_BASE_CODE_MODE Mode;
	86	EFI_PXE_BASE_CODE_FUNCTION Function;
	87
	88	CHAR8 *BootFileName;
	89
	90	EFI_IP_ADDRESS StationIp;
	91	EFI_IP_ADDRESS SubnetMask;
	92	EFI_IP_ADDRESS GatewayIp;
	93	EFI_IP_ADDRESS ServerIp;
	94	BOOLEAN AddressIsOk;
	95
	96	UINTN FileSize;
	97
	98	UINT8 OptionBuffer[PXEBC_DHCP4_MAX_OPTION_SIZE];
	99	EFI_DHCP4_PACKET SeedPacket;
	100	EFI_MAC_ADDRESS Mac;
	101	UINT8 MacLen;
	102
	103	BOOLEAN SortOffers;
	104	UINT32 NumOffers;
	105	UINT32 SelectedOffer;
	106	UINT32 ProxyOfferType;
	107
	108	//
	109	// Cached packets as complements of pxe mode data
	110	//
	111	PXEBC_CACHED_DHCP4_PACKET ProxyOffer;
	112	PXEBC_CACHED_DHCP4_PACKET Dhcp4Ack;
	113	PXEBC_CACHED_DHCP4_PACKET PxeReply;
	114	PXEBC_CACHED_DHCP4_PACKET Dhcp4Offers[PXEBC_MAX_OFFER_NUM];
	115
	116	//
	117	// Arrays for different types of offers:
	118	// ServerCount records the count of the servers we got the offers,
	119	// OfferIndex records the index of the offer sent by the server indexed by ServerCount.
	120	//
	121	UINT32 ServerCount[DHCP4_PACKET_TYPE_MAX];
	122	UINT32 OfferIndex[DHCP4_PACKET_TYPE_MAX][PXEBC_MAX_OFFER_NUM];
	123	UINT32 BootpIndex;
	124	UINT32 ProxyIndex[DHCP4_PACKET_TYPE_MAX];
	125	UINT32 BinlIndex[PXEBC_MAX_OFFER_NUM];
	126
	127	EFI_EVENT GetArpCacheEvent;
	128	//\r
	129	// token and event used to get ICMP error data from IP\r
	130	//\r
	131	EFI_IP4_COMPLETION_TOKEN IcmpErrorRcvToken;
	132	};
	133
	134	#define PXEBC_PRIVATE_DATA_FROM_PXEBC(a) CR (a, PXEBC_PRIVATE_DATA, PxeBc, PXEBC_PRIVATE_DATA_SIGNATURE)
	135
	136	#define PXEBC_PRIVATE_DATA_FROM_LOADFILE(a) CR (a, PXEBC_PRIVATE_DATA, LoadFile, PXEBC_PRIVATE_DATA_SIGNATURE)
	137
	138	#define PXEBC_PRIVATE_DATA_FROM_PXEBCCALLBACK(a) CR (a, PXEBC_PRIVATE_DATA, PxeBcCallback, PXEBC_PRIVATE_DATA_SIGNATURE)
	139
	140	extern EFI_PXE_BASE_CODE_PROTOCOL mPxeBcProtocolTemplate;
	141	extern EFI_LOAD_FILE_PROTOCOL mLoadFileProtocolTemplate;
	142
	143	#endif