2 EFI PXE Base Code CallBack Protocol is as defined in UEFI specification.
3 It is invoked when the PXE Base Code Protocol is about to transmit, has received,
4 or is waiting to receive a packet.
6 Copyright (c) 2006 - 2008, Intel Corporation
7 All rights reserved. This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
17 #ifndef _PXE_BASE_CODE_CALLBACK_H_
18 #define _PXE_BASE_CODE_CALLBACK_H_
21 /// Call Back Definitions
23 #define EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL_GUID \
25 0x245dca21, 0xfb7b, 0x11d3, {0x8f, 0x01, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \
29 /// UEFI Revision Number Definition
31 #define EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL_REVISION 0x00010000
34 /// EFI 1.1 Revision Number defintion
36 #define EFI_PXE_BASE_CODE_CALLBACK_INTERFACE_REVISION \
37 EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL_REVISION
40 /// UEFI Protocol name
42 typedef struct _EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL
;
45 /// EFI1.1 Protocol name
47 typedef EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL EFI_PXE_BASE_CODE_CALLBACK
;
50 /// Event type list for PXE Base Code Protocol function
53 EFI_PXE_BASE_CODE_FUNCTION_FIRST
,
54 EFI_PXE_BASE_CODE_FUNCTION_DHCP
,
55 EFI_PXE_BASE_CODE_FUNCTION_DISCOVER
,
56 EFI_PXE_BASE_CODE_FUNCTION_MTFTP
,
57 EFI_PXE_BASE_CODE_FUNCTION_UDP_WRITE
,
58 EFI_PXE_BASE_CODE_FUNCTION_UDP_READ
,
59 EFI_PXE_BASE_CODE_FUNCTION_ARP
,
60 EFI_PXE_BASE_CODE_FUNCTION_IGMP
,
61 EFI_PXE_BASE_CODE_PXE_FUNCTION_LAST
62 } EFI_PXE_BASE_CODE_FUNCTION
;
65 /// Callback status type
68 EFI_PXE_BASE_CODE_CALLBACK_STATUS_FIRST
,
69 EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE
,
70 EFI_PXE_BASE_CODE_CALLBACK_STATUS_ABORT
,
71 EFI_PXE_BASE_CODE_CALLBACK_STATUS_LAST
72 } EFI_PXE_BASE_CODE_CALLBACK_STATUS
;
75 Callback function that is invoked when the PXE Base Code Protocol is about to transmit, has
76 received, or is waiting to receive a packet.
78 @param This Pointer to the EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL instance.
79 @param Function The PXE Base Code Protocol function that is waiting for an event.
80 @param Received TRUE if the callback is being invoked due to a receive event. FALSE if
81 the callback is being invoked due to a transmit event.
82 @param PacketLen The length, in bytes, of Packet. This field will have a value of zero if
83 this is a wait for receive event.
84 @param Packet If Received is TRUE, a pointer to the packet that was just received;
85 otherwise a pointer to the packet that is about to be transmitted.
87 @retval EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE if Function specifies a continue operation
88 @retval EFI_PXE_BASE_CODE_CALLBACK_STATUS_ABORT if Function specifies an abort operation
92 EFI_PXE_BASE_CODE_CALLBACK_STATUS
93 (EFIAPI
*EFI_PXE_CALLBACK
)(
94 IN EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL
*This
,
95 IN EFI_PXE_BASE_CODE_FUNCTION Function
,
98 IN EFI_PXE_BASE_CODE_PACKET
*Packet OPTIONAL
102 /// Protocol that is invoked when the PXE Base Code Protocol is about
103 /// to transmit, has received, or is waiting to receive a packet.
105 struct _EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL
{
107 /// The revision of the EFI_PXE_BASE_CODE_PROTOCOL. All future revisions must
108 /// be backwards compatible. If a future version is not backwards compatible
109 /// it is not the same GUID.
112 EFI_PXE_CALLBACK Callback
;
115 extern EFI_GUID gEfiPxeBaseCodeCallbackProtocolGuid
;