mirror of
https://git.proxmox.com/git/mirror_edk2
synced 2025-11-03 07:25:03 +00:00
f737cfb953
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@7452 6f19259b-4bc3-4df7-8a09-765794883524
129 lines
5.4 KiB
C
129 lines
5.4 KiB
C
/** @file
|
|
EFI PXE Base Code CallBack Protocol is as defined in UEFI specification.
|
|
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 - 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.
|
|
|
|
**/
|
|
|
|
#ifndef _PXE_BASE_CODE_CALLBACK_H_
|
|
#define _PXE_BASE_CODE_CALLBACK_H_
|
|
|
|
///
|
|
/// Call Back Definitions
|
|
///
|
|
#define EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL_GUID \
|
|
{ \
|
|
0x245dca21, 0xfb7b, 0x11d3, {0x8f, 0x01, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \
|
|
}
|
|
|
|
///
|
|
/// UEFI Revision Number Definition
|
|
///
|
|
#define EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL_REVISION 0x00010000
|
|
|
|
///
|
|
/// EFI 1.1 Revision Number defintion
|
|
///
|
|
#define EFI_PXE_BASE_CODE_CALLBACK_INTERFACE_REVISION \
|
|
EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL_REVISION
|
|
|
|
///
|
|
/// UEFI Protocol name
|
|
///
|
|
typedef struct _EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL;
|
|
|
|
///
|
|
/// EFI1.1 Protocol name
|
|
///
|
|
typedef EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL EFI_PXE_BASE_CODE_CALLBACK;
|
|
|
|
///
|
|
/// Event type list for PXE Base Code Protocol function
|
|
///
|
|
typedef enum {
|
|
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
|
|
} EFI_PXE_BASE_CODE_FUNCTION;
|
|
|
|
///
|
|
/// Callback status type
|
|
///
|
|
typedef enum {
|
|
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;
|
|
|
|
/**
|
|
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.
|
|
|
|
@param This Pointer to the EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL instance.
|
|
@param Function The PXE Base Code Protocol function that is waiting for an event.
|
|
@param Received TRUE if the callback is being invoked due to a receive event. FALSE if
|
|
the callback is being invoked due to a transmit event.
|
|
@param PacketLen The length, in bytes, of Packet. This field will have a value of zero if
|
|
this is a wait for receive event.
|
|
@param Packet If Received is TRUE, a pointer to the packet that was just received;
|
|
otherwise a pointer to the packet that is about to be transmitted.
|
|
|
|
@retval EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE if Function specifies a continue operation
|
|
@retval EFI_PXE_BASE_CODE_CALLBACK_STATUS_ABORT if Function specifies an abort operation
|
|
|
|
**/
|
|
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
|
|
);
|
|
|
|
///
|
|
/// Protocol that is invoked when the PXE Base Code Protocol is about
|
|
/// to transmit, has received, or is waiting to receive a packet.
|
|
///
|
|
struct _EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL {
|
|
///
|
|
/// The revision of the EFI_PXE_BASE_CODE_PROTOCOL. All future revisions must
|
|
/// be backwards compatible. If a future version is not backwards compatible
|
|
/// it is not the same GUID.
|
|
///
|
|
UINT64 Revision;
|
|
EFI_PXE_CALLBACK Callback;
|
|
};
|
|
|
|
extern EFI_GUID gEfiPxeBaseCodeCallbackProtocolGuid;
|
|
|
|
#endif
|
|
|