]>
Commit | Line | Data |
---|---|---|
878ddf1f | 1 | /** @file\r |
2 | EFI PXE Base Code CallBack Protocol\r | |
3 | \r | |
4 | Copyright (c) 2006, Intel Corporation \r | |
5 | All rights reserved. This program and the accompanying materials \r | |
6 | are licensed and made available under the terms and conditions of the BSD License \r | |
7 | which accompanies this distribution. The full text of the license may be found at \r | |
8 | http://opensource.org/licenses/bsd-license.php \r | |
9 | \r | |
10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
12 | \r | |
13 | Module Name: PxeBaseCodeCallBack.h\r | |
14 | \r | |
15 | **/\r | |
16 | \r | |
17 | #ifndef _PXE_BASE_CODE_CALLBACK_H_\r | |
18 | #define _PXE_BASE_CODE_CALLBACK_H_\r | |
19 | \r | |
20 | //\r | |
21 | // Call Back Definitions\r | |
22 | //\r | |
23 | #define EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL_GUID \\r | |
24 | { \\r | |
25 | 0x245dca21, 0xfb7b, 0x11d3, {0x8f, 0x01, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \\r | |
26 | }\r | |
27 | \r | |
28 | //\r | |
29 | // Revision Number\r | |
30 | //\r | |
31 | #define EFI_PXE_BASE_CODE_CALLBACK_INTERFACE_REVISION 0x00010000\r | |
32 | #define EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL_REVISION \\r | |
33 | EFI_PXE_BASE_CODE_CALLBACK_INTERFACE_REVISION\r | |
34 | \r | |
35 | //\r | |
36 | // Protocol definition\r | |
37 | //\r | |
38 | typedef struct _EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL;\r | |
39 | \r | |
40 | typedef enum {\r | |
41 | EFI_PXE_BASE_CODE_FUNCTION_FIRST,\r | |
42 | EFI_PXE_BASE_CODE_FUNCTION_DHCP,\r | |
43 | EFI_PXE_BASE_CODE_FUNCTION_DISCOVER,\r | |
44 | EFI_PXE_BASE_CODE_FUNCTION_MTFTP,\r | |
45 | EFI_PXE_BASE_CODE_FUNCTION_UDP_WRITE,\r | |
46 | EFI_PXE_BASE_CODE_FUNCTION_UDP_READ,\r | |
47 | EFI_PXE_BASE_CODE_FUNCTION_ARP,\r | |
48 | EFI_PXE_BASE_CODE_FUNCTION_IGMP,\r | |
49 | EFI_PXE_BASE_CODE_PXE_FUNCTION_LAST\r | |
50 | } EFI_PXE_BASE_CODE_FUNCTION;\r | |
51 | \r | |
52 | typedef enum {\r | |
53 | EFI_PXE_BASE_CODE_CALLBACK_STATUS_FIRST,\r | |
54 | EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE,\r | |
55 | EFI_PXE_BASE_CODE_CALLBACK_STATUS_ABORT,\r | |
56 | EFI_PXE_BASE_CODE_CALLBACK_STATUS_LAST\r | |
57 | } EFI_PXE_BASE_CODE_CALLBACK_STATUS;\r | |
58 | \r | |
59 | /** \r | |
60 | Callback function that is invoked when the PXE Base Code Protocol is about to transmit, has\r | |
61 | received, or is waiting to receive a packet. \r | |
62 | \r | |
63 | @param This Pointer to the EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL instance.\r | |
64 | @param Function The PXE Base Code Protocol function that is waiting for an event. \r | |
65 | @param Received TRUE if the callback is being invoked due to a receive event. FALSE if\r | |
66 | the callback is being invoked due to a transmit event. \r | |
67 | @param PacketLen The length, in bytes, of Packet. This field will have a value of zero if\r | |
68 | this is a wait for receive event. \r | |
69 | @param Packet If Received is TRUE, a pointer to the packet that was just received;\r | |
70 | otherwise a pointer to the packet that is about to be transmitted. \r | |
71 | \r | |
72 | @retval EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE if Function specifies a continue operation \r | |
73 | @retval EFI_PXE_BASE_CODE_CALLBACK_STATUS_ABORT if Function specifies an abort operation\r | |
74 | \r | |
75 | **/\r | |
76 | typedef \r | |
77 | EFI_PXE_BASE_CODE_CALLBACK_STATUS \r | |
78 | (EFIAPI *EFI_PXE_CALLBACK)(\r | |
79 | IN EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL *This,\r | |
80 | IN EFI_PXE_BASE_CODE_FUNCTION Function,\r | |
81 | IN BOOLEAN Received,\r | |
82 | IN UINT32 PacketLen,\r | |
83 | IN EFI_PXE_BASE_CODE_PACKET *Packet OPTIONAL\r | |
84 | );\r | |
85 | \r | |
86 | struct _EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL {\r | |
87 | UINT64 Revision;\r | |
88 | EFI_PXE_CALLBACK Callback;\r | |
89 | };\r | |
90 | \r | |
91 | extern EFI_GUID gEfiPxeBaseCodeCallbackProtocolGuid;\r | |
92 | \r | |
93 | #endif \r | |
94 | \r |