EDK2 doxygen online documents - Firmware Encoding Index 1
EDK2 doxygen online documents - Firmware Encoding Index
Data Structures | Defines | Typedefs | Enumerations | Variables

MdePkg/Include/Protocol/PxeBaseCodeCallBack.h File Reference

Go to the source code of this file.

Data Structures

struct  _EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL

Defines

#define EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL_GUID
#define EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL_REVISION   0x00010000
#define EFI_PXE_BASE_CODE_CALLBACK_INTERFACE_REVISION   EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL_REVISION

Typedefs

typedef struct
_EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL 
EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL
typedef
EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL 
EFI_PXE_BASE_CODE_CALLBACK
typedef
EFI_PXE_BASE_CODE_CALLBACK_STATUS(EFIAPI * 
EFI_PXE_CALLBACK )(IN EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL *This, IN EFI_PXE_BASE_CODE_FUNCTION Function, IN BOOLEAN Received, IN UINT32 PacketLen, IN EFI_PXE_BASE_CODE_PACKET *Packet OPTIONAL)

Enumerations

enum  EFI_PXE_BASE_CODE_FUNCTION {
  EFI_PXE_BASE_CODE_FUNCTION_FIRST, EFI_PXE_BASE_CODE_FUNCTION_DHCP, EFI_PXE_BASE_CODE_FUNCTION_DISCOVER, EFI_PXE_BASE_CODE_FUNCTION_MTFTP,
  EFI_PXE_BASE_CODE_FUNCTION_UDP_WRITE, EFI_PXE_BASE_CODE_FUNCTION_UDP_READ, EFI_PXE_BASE_CODE_FUNCTION_ARP, EFI_PXE_BASE_CODE_FUNCTION_IGMP,
  EFI_PXE_BASE_CODE_FUNCTION_TCP_WRITE, EFI_PXE_BASE_CODE_FUNCTION_TCP_READ, EFI_PXE_BASE_CODE_PXE_FUNCTION_LAST, EFI_PXE_BASE_CODE_FUNCTION_FIRST,
  EFI_PXE_BASE_CODE_FUNCTION_DHCP, EFI_PXE_BASE_CODE_FUNCTION_DISCOVER, EFI_PXE_BASE_CODE_FUNCTION_MTFTP, EFI_PXE_BASE_CODE_FUNCTION_UDP_WRITE,
  EFI_PXE_BASE_CODE_FUNCTION_UDP_READ, EFI_PXE_BASE_CODE_FUNCTION_ARP, EFI_PXE_BASE_CODE_FUNCTION_IGMP, EFI_PXE_BASE_CODE_PXE_FUNCTION_LAST
}
enum  EFI_PXE_BASE_CODE_CALLBACK_STATUS {
  EFI_PXE_BASE_CODE_CALLBACK_STATUS_FIRST, EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE, EFI_PXE_BASE_CODE_CALLBACK_STATUS_ABORT, EFI_PXE_BASE_CODE_CALLBACK_STATUS_LAST,
  EFI_PXE_BASE_CODE_CALLBACK_STATUS_FIRST, EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE, EFI_PXE_BASE_CODE_CALLBACK_STATUS_ABORT, EFI_PXE_BASE_CODE_CALLBACK_STATUS_LAST
}

Variables

EFI_GUID gEfiPxeBaseCodeCallbackProtocolGuid

Detailed Description

It is invoked when the PXE Base Code Protocol is about to transmit, has received, or is waiting to receive a packet.

Copyright (c) 2006 - 2010, 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 that 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.

Revision Reference:
This Protocol is introduced in EFI Specification 1.10

Definition in file PxeBaseCodeCallBack.h.


Define Documentation

#define EFI_PXE_BASE_CODE_CALLBACK_INTERFACE_REVISION   EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL_REVISION

EFI 1.1 Revision Number defintion.

Definition at line 38 of file PxeBaseCodeCallBack.h.

#define EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL_GUID
Value:
{ \
    0x245dca21, 0xfb7b, 0x11d3, {0x8f, 0x01, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \
  }

Call Back Definitions.

Definition at line 25 of file PxeBaseCodeCallBack.h.

#define EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL_REVISION   0x00010000

UEFI Revision Number Definition.

Definition at line 33 of file PxeBaseCodeCallBack.h.


Typedef Documentation

EFI1.1 Protocol name.

Definition at line 49 of file PxeBaseCodeCallBack.h.

UEFI Protocol name.

Definition at line 44 of file PxeBaseCodeCallBack.h.

Callback function that is invoked when the PXE Base Code Protocol is about to transmit, has received, or is waiting to receive a packet.

This function is invoked when the PXE Base Code Protocol is about to transmit, has received, or is waiting to receive a packet. Parameters Function and Received specify the type of event. Parameters PacketLen and Packet specify the packet that generated the event. If these fields are zero and NULL respectively, then this is a status update callback. If the operation specified by Function is to continue, then CALLBACK_STATUS_CONTINUE should be returned. If the operation specified by Function should be aborted, then CALLBACK_STATUS_ABORT should be returned. Due to the polling nature of UEFI device drivers, a callback function should not execute for more than 5 ms. The SetParameters() function must be called after a Callback Protocol is installed to enable the use of callbacks.

Parameters:
ThisThe pointer to the EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL instance.
FunctionThe PXE Base Code Protocol function that is waiting for an event.
ReceivedTRUE if the callback is being invoked due to a receive event. FALSE if the callback is being invoked due to a transmit event.
PacketLenThe length, in bytes, of Packet. This field will have a value of zero if this is a wait for receive event.
PacketIf Received is TRUE, a pointer to the packet that was just received; otherwise a pointer to the packet that is about to be transmitted.
Return values:
EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUEif Function specifies a continue operation
EFI_PXE_BASE_CODE_CALLBACK_STATUS_ABORTif Function specifies an abort operation

Definition at line 105 of file PxeBaseCodeCallBack.h.


Enumeration Type Documentation

Callback status type.

Enumerator:
EFI_PXE_BASE_CODE_CALLBACK_STATUS_FIRST 
EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE 
EFI_PXE_BASE_CODE_CALLBACK_STATUS_ABORT 
EFI_PXE_BASE_CODE_CALLBACK_STATUS_LAST 
EFI_PXE_BASE_CODE_CALLBACK_STATUS_FIRST 
EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE 
EFI_PXE_BASE_CODE_CALLBACK_STATUS_ABORT 
EFI_PXE_BASE_CODE_CALLBACK_STATUS_LAST 

Definition at line 69 of file PxeBaseCodeCallBack.h.

Event type list for PXE Base Code Protocol function.

Enumerator:
EFI_PXE_BASE_CODE_FUNCTION_FIRST 
EFI_PXE_BASE_CODE_FUNCTION_DHCP 
EFI_PXE_BASE_CODE_FUNCTION_DISCOVER 
EFI_PXE_BASE_CODE_FUNCTION_MTFTP 
EFI_PXE_BASE_CODE_FUNCTION_UDP_WRITE 
EFI_PXE_BASE_CODE_FUNCTION_UDP_READ 
EFI_PXE_BASE_CODE_FUNCTION_ARP 
EFI_PXE_BASE_CODE_FUNCTION_IGMP 
EFI_PXE_BASE_CODE_FUNCTION_TCP_WRITE 
EFI_PXE_BASE_CODE_FUNCTION_TCP_READ 
EFI_PXE_BASE_CODE_PXE_FUNCTION_LAST 
EFI_PXE_BASE_CODE_FUNCTION_FIRST 
EFI_PXE_BASE_CODE_FUNCTION_DHCP 
EFI_PXE_BASE_CODE_FUNCTION_DISCOVER 
EFI_PXE_BASE_CODE_FUNCTION_MTFTP 
EFI_PXE_BASE_CODE_FUNCTION_UDP_WRITE 
EFI_PXE_BASE_CODE_FUNCTION_UDP_READ 
EFI_PXE_BASE_CODE_FUNCTION_ARP 
EFI_PXE_BASE_CODE_FUNCTION_IGMP 
EFI_PXE_BASE_CODE_PXE_FUNCTION_LAST 

Definition at line 54 of file PxeBaseCodeCallBack.h.


Variable Documentation

Definition at line 24 of file PxeBaseCodeCallBack.c.

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Defines