Add PXE FILE API.
[people/indolent/gpxe.git/.git] / src / include / pxe_api.h
1 #ifndef PXE_API_H
2 #define PXE_API_H
3
4 /*
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License as
7  * published by the Free Software Foundation; either version 2 of the
8  * License, or any later version.
9  *
10  * This program is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18  */
19
20 /** @file
21  *
22  * Preboot eXecution Environment (PXE) API
23  *
24  */
25
26 #include "pxe_types.h"
27
28 /** @addtogroup pxe Preboot eXecution Environment (PXE) API
29  *  @{
30  */
31
32 /** @defgroup pxe_api_call PXE entry points
33  *
34  * PXE entry points and calling conventions
35  *
36  *  @{
37  */
38
39 /** The PXENV+ structure */
40 struct s_PXENV {
41         /** Signature
42          *
43          * Contains the bytes 'P', 'X', 'E', 'N', 'V', '+'.
44          */
45         UINT8_t         Signature[6];
46         /** PXE API version
47          *
48          * MSB is major version number, LSB is minor version number.
49          * If the API version number is 0x0201 or greater, the !PXE
50          * structure pointed to by #PXEPtr should be used instead of
51          * this data structure.
52          */
53         UINT16_t        Version;
54         UINT8_t         Length;         /**< Length of this structure */
55         /** Checksum
56          *
57          * The byte checksum of this structure (using the length in
58          * #Length) must be zero.
59          */
60         UINT8_t         Checksum;
61         SEGOFF16_t      RMEntry;        /**< Real-mode PXENV+ entry point */
62         /** Protected-mode PXENV+ entry point offset
63          *
64          * PXE 2.1 deprecates this entry point.  For protected-mode
65          * API calls, use the !PXE structure pointed to by #PXEPtr
66          * instead.
67          */
68         UINT32_t        PMOffset;
69         /** Protected-mode PXENV+ entry point segment selector
70          *
71          * PXE 2.1 deprecates this entry point.  For protected-mode
72          * API calls, use the !PXE structure pointed to by #PXEPtr
73          * instead.
74          */
75         SEGSEL_t        PMSelector;
76         SEGSEL_t        StackSeg;       /**< Stack segment selector */
77         UINT16_t        StackSize;      /**< Stack segment size */
78         SEGSEL_t        BC_CodeSeg;     /**< Base-code code segment selector */
79         UINT16_t        BC_CodeSize;    /**< Base-code code segment size */
80         SEGSEL_t        BC_DataSeg;     /**< Base-code data segment selector */
81         UINT16_t        BC_DataSize;    /**< Base-code data segment size */
82         SEGSEL_t        UNDIDataSeg;    /**< UNDI data segment selector */
83         UINT16_t        UNDIDataSize;   /**< UNDI data segment size */
84         SEGSEL_t        UNDICodeSeg;    /**< UNDI code segment selector */
85         UINT16_t        UNDICodeSize;   /**< UNDI code segment size */
86         /** Address of the !PXE structure
87          *
88          * This field is present only if #Version is 0x0201 or
89          * greater.  If present, it points to a struct s_PXE.
90          */
91         SEGOFF16_t      PXEPtr;
92 } PACKED;
93
94 typedef struct s_PXENV PXENV_t;
95
96 /** The !PXE structure */
97 struct s_PXE {
98         /** Signature
99          *
100          * Contains the bytes '!', 'P', 'X', 'E'.
101          */
102         UINT8_t         Signature[4];
103         UINT8_t         StructLength;   /**< Length of this structure */
104         /** Checksum
105          *
106          * The byte checksum of this structure (using the length in
107          * #StructLength) must be zero.
108          */
109         UINT8_t         StructCksum;
110         /** Revision of this structure
111          *
112          * For PXE version 2.1, this field must be zero.
113          */
114         UINT8_t         StructRev;
115         UINT8_t         reserved_1;     /**< Must be zero */
116         /** Address of the UNDI ROM ID structure
117          *
118          * This is a pointer to a struct s_UNDI_ROM_ID.
119          */
120         SEGOFF16_t      UNDIROMID;
121         /** Address of the Base Code ROM ID structure
122          *
123          * This is a pointer to a struct s_BC_ROM_ID.
124          */
125         SEGOFF16_t      BaseROMID;
126         /** 16-bit !PXE entry point
127          *
128          * This is the entry point for either real mode, or protected
129          * mode with a 16-bit stack segment.
130          */
131         SEGOFF16_t      EntryPointSP;
132         /** 32-bit !PXE entry point
133          *
134          * This is the entry point for protected mode with a 32-bit
135          * stack segment.
136          */
137         SEGOFF16_t      EntryPointESP;
138         /** Status call-out function
139          *
140          * @v 0         (if in a time-out loop)
141          * @v n         Number of a received TFTP packet
142          * @ret 0       Continue operation
143          * @ret 1       Cancel operation
144          *
145          * This function will be called whenever the PXE stack is in
146          * protected mode, is waiting for an event (e.g. a DHCP reply)
147          * and wishes to allow the user to cancel the operation.
148          * Parameters are passed in register %ax; the return value
149          * must also be placed in register %ax.  All other registers
150          * and flags @b must be preserved.
151          *
152          * In real mode, an internal function (that checks for a
153          * keypress) will be used.
154          *
155          * If this field is set to -1, no status call-out function
156          * will be used and consequently the user will not be allowed
157          * to interrupt operations.
158          *
159          * @note The PXE specification version 2.1 defines the
160          * StatusCallout field, mentions it 11 times, but nowhere
161          * defines what it actually does or how it gets called.
162          * Fortunately, the WfM specification version 1.1a deigns to
163          * inform us of such petty details.
164          */
165         SEGOFF16_t      StatusCallout;
166         UINT8_t         reserved_2;     /**< Must be zero */
167         /** Number of segment descriptors
168          *
169          * If this number is greater than 7, the remaining descriptors
170          * follow immediately after #BC_CodeWrite.
171          */
172         UINT8_t         SegDescCnt;
173         /** First protected-mode selector
174          *
175          * This is the segment selector value for the first segment
176          * assigned to PXE.  Protected-mode selectors must be
177          * consecutive, according to the PXE 2.1 specification, though
178          * no reason is given.  Each #SEGDESC_t includes a field for
179          * the segment selector, so this information is entirely
180          * redundant.
181          */
182         SEGSEL_t        FirstSelector;
183         /** Stack segment descriptor */
184         SEGDESC_t       Stack;
185         /** UNDI data segment descriptor */
186         SEGDESC_t       UNDIData;
187         /** UNDI code segment descriptor */
188         SEGDESC_t       UNDICode;
189         /** UNDI writable code segment descriptor */
190         SEGDESC_t       UNDICodeWrite;
191         /** Base-code data segment descriptor */
192         SEGDESC_t       BC_Data;
193         /** Base-code code segment descriptor */
194         SEGDESC_t       BC_Code;
195         /** Base-code writable code segment descriptor */
196         SEGDESC_t       BC_CodeWrite;
197 } PACKED;
198
199 typedef struct s_PXE PXE_t;
200
201 /** @} */ /* pxe_api_call */
202
203 /** @defgroup pxe_preboot_api PXE Preboot API
204  *
205  * General high-level functions: #PXENV_UNLOAD_STACK, #PXENV_START_UNDI etc.
206  *
207  * @{
208  */
209
210 /** @defgroup pxenv_unload_stack PXENV_UNLOAD_STACK
211  *
212  *  UNLOAD BASE CODE STACK
213  *
214  *  @{
215  */
216
217 /** PXE API function code for pxenv_unload_stack() */
218 #define PXENV_UNLOAD_STACK              0x0070
219
220 /** Parameter block for pxenv_unload_stack() */
221 struct s_PXENV_UNLOAD_STACK {
222         PXENV_STATUS_t Status;                  /**< PXE status code */
223         UINT8_t reserved[10];                   /**< Must be zero */
224 } PACKED;
225
226 typedef struct s_PXENV_UNLOAD_STACK PXENV_UNLOAD_STACK_t;
227
228 extern PXENV_EXIT_t pxenv_unload_stack ( struct s_PXENV_UNLOAD_STACK
229                                          *unload_stack );
230
231 /** @} */ /* pxenv_unload_stack */
232
233 /** @defgroup pxenv_get_cached_info PXENV_GET_CACHED_INFO
234  *
235  *  GET CACHED INFO
236  *
237  *  @{
238  */
239
240 /** PXE API function code for pxenv_get_cached_info() */
241 #define PXENV_GET_CACHED_INFO           0x0071
242
243 /** The client's DHCPDISCOVER packet */
244 #define PXENV_PACKET_TYPE_DHCP_DISCOVER 1
245
246 /** The DHCP server's DHCPACK packet */
247 #define PXENV_PACKET_TYPE_DHCP_ACK      2
248
249 /** The Boot Server's Discover Reply packet
250  *
251  * This packet contains DHCP option 60 set to "PXEClient", a valid
252  * boot file name, and may or may not contain MTFTP options.
253  */
254 #define PXENV_PACKET_TYPE_CACHED_REPLY  3
255
256 /** Parameter block for pxenv_get_cached_info() */
257 struct s_PXENV_GET_CACHED_INFO {
258         PXENV_STATUS_t Status;                  /**< PXE status code */
259         /** Packet type.
260          *
261          * Valid values are #PXENV_PACKET_TYPE_DHCP_DISCOVER,
262          * #PXENV_PACKET_TYPE_DHCP_ACK or #PXENV_PACKET_TYPE_CACHED_REPLY
263          */
264         UINT16_t PacketType;
265         UINT16_t BufferSize;                    /**< Buffer size */
266         SEGOFF16_t Buffer;                      /**< Buffer address */
267         UINT16_t BufferLimit;                   /**< Maximum buffer size */
268 } PACKED;
269
270 typedef struct s_PXENV_GET_CACHED_INFO PXENV_GET_CACHED_INFO_t;
271
272 #define BOOTP_REQ       1       /**< A BOOTP request packet */
273 #define BOOTP_REP       2       /**< A BOOTP reply packet */
274
275 /** DHCP broadcast flag
276  *
277  * Request a broadcast response (DHCPOFFER or DHCPACK) from the DHCP
278  * server.
279  */
280 #define BOOTP_BCAST     0x8000
281
282 #define VM_RFC1048      0x63825363L     /**< DHCP magic cookie */
283
284 /** Maximum length of DHCP options */
285 #define BOOTP_DHCPVEND  1024
286
287 /** Format of buffer filled in by pxenv_get_cached_info()
288  *
289  * This somewhat convoluted data structure simply describes the layout
290  * of a DHCP packet.  Refer to RFC2131 section 2 for a full
291  * description.
292  */
293 struct bootph {
294         /** Message opcode.
295          *
296          * Valid values are #BOOTP_REQ and #BOOTP_REP.
297          */
298         UINT8_t opcode;
299         /** NIC hardware type.
300          *
301          * Valid values are as for s_PXENV_UNDI_GET_INFORMATION::HwType.
302          */
303         UINT8_t Hardware;
304         UINT8_t Hardlen;                /**< MAC address length */
305         /** Gateway hops
306          *
307          * Zero in packets sent by the client.  May be non-zero in
308          * replies from the DHCP server, if the reply comes via a DHCP
309          * relay agent.
310          */
311         UINT8_t Gatehops;
312         UINT32_t ident;                 /**< DHCP transaction id (xid) */
313         /** Elapsed time
314          *
315          * Number of seconds since the client began the DHCP
316          * transaction.
317          */
318         UINT16_t seconds;
319         /** Flags
320          *
321          * This is the bitwise-OR of any of the following values:
322          * #BOOTP_BCAST.
323          */
324         UINT16_t Flags;
325         /** Client IP address
326          *
327          * Set only if the client already has an IP address.
328          */
329         IP4_t cip;
330         /** Your IP address
331          *
332          * This is the IP address that the server assigns to the
333          * client.
334          */
335         IP4_t yip;
336         /** Server IP address
337          *
338          * This is the IP address of the BOOTP/DHCP server.
339          */
340         IP4_t sip;
341         /** Gateway IP address
342          *
343          * This is the IP address of the BOOTP/DHCP relay agent, if
344          * any.  It is @b not (necessarily) the address of the default
345          * gateway for routing purposes.
346          */
347         IP4_t gip;
348         MAC_ADDR_t CAddr;               /**< Client MAC address */
349         UINT8_t Sname[64];              /**< Server host name */
350         UINT8_t bootfile[128];          /**< Boot file name */
351         /** DHCP options
352          *
353          * Don't ask.  Just laugh.  Then burn a copy of the PXE
354          * specification and send Intel an e-mail asking them if
355          * they've figured out what a "union" does in C yet.
356          */
357         union bootph_vendor {
358                 UINT8_t d[BOOTP_DHCPVEND]; /**< DHCP options */
359                 /** DHCP options */
360                 struct bootph_vendor_v {
361                         /** DHCP magic cookie
362                          *
363                          * Should have the value #VM_RFC1048.
364                          */
365                         UINT8_t magic[4];
366                         UINT32_t flags; /**< BOOTP flags/opcodes */
367                         /** "End of BOOTP vendor extensions"
368                          *
369                          * Abandon hope, all ye who consider the
370                          * purpose of this field.
371                          */
372                         UINT8_t pad[56];
373                 } v;
374         } vendor;
375 } PACKED;
376
377 typedef struct bootph BOOTPLAYER_t;
378
379 extern PXENV_EXIT_t pxenv_get_cached_info ( struct s_PXENV_GET_CACHED_INFO
380                                             *get_cached_info );
381
382 /** @} */ /* pxenv_get_cached_info */
383
384 /** @defgroup pxenv_restart_tftp PXENV_RESTART_TFTP
385  *
386  *  RESTART TFTP
387  *
388  *  @{
389  */
390
391 /** PXE API function code for pxenv_restart_tftp() */
392 #define PXENV_RESTART_TFTP              0x0073
393
394 /** Parameter block for pxenv_restart_tftp() */
395 struct s_PXENV_TFTP_READ_FILE;
396
397 typedef struct s_PXENV_RESTART_TFTP PXENV_RESTART_TFTP_t;
398
399 extern PXENV_EXIT_t pxenv_restart_tftp ( struct s_PXENV_TFTP_READ_FILE
400                                          *restart_tftp );
401
402 /** @} */ /* pxenv_restart_tftp */
403
404 /** @defgroup pxenv_start_undi PXENV_START_UNDI
405  *
406  *  START UNDI
407  *
408  *  @{
409  */
410
411 /** PXE API function code for pxenv_start_undi() */
412 #define PXENV_START_UNDI                0x0000
413
414 /** Parameter block for pxenv_start_undi() */
415 struct s_PXENV_START_UNDI {
416         PXENV_STATUS_t Status;                  /**< PXE status code */
417         /** %ax register as passed to the Option ROM initialisation routine.
418          *
419          * For a PCI device, this should contain the bus:dev:fn value
420          * that uniquely identifies the PCI device in the system.  For
421          * a non-PCI device, this field is not defined.
422          */
423         UINT16_t AX;
424         /** %bx register as passed to the Option ROM initialisation routine.
425          *
426          * For an ISAPnP device, this should contain the Card Select
427          * Number assigned to the ISAPnP card.  For non-ISAPnP
428          * devices, this should contain 0xffff.
429          */
430         UINT16_t BX;
431         /** %dx register as passed to the Option ROM initialisation routine.
432          *
433          * For an ISAPnP device, this should contain the ISAPnP Read
434          * Port address as currently set in all ISAPnP cards.  If
435          * there are no ISAPnP cards, this should contain 0xffff.  (If
436          * this is a non-ISAPnP device, but there are ISAPnP cards in
437          * the system, this value is not well defined.)
438          */
439         UINT16_t DX;
440         /** %di register as passed to the Option ROM initialisation routine.
441          *
442          * This contains the #OFF16_t portion of a struct #s_SEGOFF16
443          * that points to the System BIOS Plug and Play Installation
444          * Check Structure.  (Refer to section 4.4 of the Plug and
445          * Play BIOS specification for a description of this
446          * structure.)
447          *
448          * @note The PXE specification defines the type of this field
449          * as #UINT16_t.  For x86, #OFF16_t and #UINT16_t are
450          * equivalent anyway; for other architectures #OFF16_t makes
451          * more sense.
452          */
453         OFF16_t DI;
454         /** %es register as passed to the Option ROM initialisation routine.
455          *
456          * This contains the #SEGSEL_t portion of a struct #s_SEGOFF16
457          * that points to the System BIOS Plug and Play Installation
458          * Check Structure.  (Refer to section 4.4 of the Plug and
459          * Play BIOS specification for a description of this
460          * structure.)
461          *
462          * @note The PXE specification defines the type of this field
463          * as #UINT16_t.  For x86, #SEGSEL_t and #UINT16_t are
464          * equivalent anyway; for other architectures #SEGSEL_t makes
465          * more sense.
466          */
467         SEGSEL_t ES;
468 } PACKED;
469
470 typedef struct s_PXENV_START_UNDI PXENV_START_UNDI_t;
471
472 extern PXENV_EXIT_t pxenv_start_undi ( struct s_PXENV_START_UNDI *start_undi );
473
474 /** @} */ /* pxenv_start_undi */
475
476 /** @defgroup pxenv_stop_undi PXENV_STOP_UNDI
477  *
478  *  STOP UNDI
479  *
480  *  @{
481  */
482
483 /** PXE API function code for pxenv_stop_undi() */
484 #define PXENV_STOP_UNDI                 0x0015
485
486 /** Parameter block for pxenv_stop_undi() */
487 struct s_PXENV_STOP_UNDI {
488         PXENV_STATUS_t Status;                  /**< PXE status code */
489 } PACKED;
490
491 typedef struct s_PXENV_STOP_UNDI PXENV_STOP_UNDI_t;
492
493 extern PXENV_EXIT_t pxenv_stop_undi ( struct s_PXENV_STOP_UNDI *stop_undi );
494
495 /** @} */ /* pxenv_stop_undi */
496
497 /** @defgroup pxenv_start_base PXENV_START_BASE
498  *
499  *  START BASE
500  *
501  *  @{
502  */
503
504 /** PXE API function code for pxenv_start_base() */
505 #define PXENV_START_BASE                0x0075
506
507 /** Parameter block for pxenv_start_base() */
508 struct s_PXENV_START_BASE {
509         PXENV_STATUS_t Status;                  /**< PXE status code */
510 } PACKED;
511
512 typedef struct s_PXENV_START_BASE PXENV_START_BASE_t;
513
514 extern PXENV_EXIT_t pxenv_start_base ( struct s_PXENV_START_BASE *start_base );
515
516 /** @} */ /* pxenv_start_base */
517
518 /** @defgroup pxenv_stop_base PXENV_STOP_BASE
519  *
520  *  STOP BASE
521  *
522  *  @{
523  */
524
525 /** PXE API function code for pxenv_stop_base() */
526 #define PXENV_STOP_BASE                 0x0076
527
528 /** Parameter block for pxenv_stop_base() */
529 struct s_PXENV_STOP_BASE {
530         PXENV_STATUS_t Status;                  /**< PXE status code */
531 } PACKED;
532
533 typedef struct s_PXENV_STOP_BASE PXENV_STOP_BASE_t;
534
535 extern PXENV_EXIT_t pxenv_stop_base ( struct s_PXENV_STOP_BASE *stop_base );
536
537 /** @} */ /* pxenv_stop_base */
538
539 /** @} */ /* pxe_preboot_api */
540
541 /** @defgroup pxe_tftp_api PXE TFTP API
542  *
543  * Download files via TFTP or MTFTP
544  *
545  * @{
546  */
547
548 /** @defgroup pxenv_tftp_open PXENV_TFTP_OPEN
549  *
550  *  TFTP OPEN
551  *
552  *  @{
553  */
554
555 /** PXE API function code for pxenv_tftp_open() */
556 #define PXENV_TFTP_OPEN                 0x0020
557
558 /** Parameter block for pxenv_tftp_open() */
559 struct s_PXENV_TFTP_OPEN {
560         PXENV_STATUS_t Status;                  /**< PXE status code */
561         IP4_t ServerIPAddress;                  /**< TFTP server IP address */
562         IP4_t GatewayIPAddress;                 /**< Relay agent IP address */
563         UINT8_t FileName[128];                  /**< File name */
564         UDP_PORT_t TFTPPort;                    /**< TFTP server UDP port */
565         /** Requested size of TFTP packets
566          *
567          * This is the TFTP "blksize" option.  This must be at least
568          * 512, since servers that do not support TFTP options cannot
569          * negotiate blocksizes smaller than this.
570          */
571         UINT16_t PacketSize;
572 } PACKED;
573
574 typedef struct s_PXENV_TFTP_OPEN PXENV_TFTP_OPEN_t;
575
576 extern PXENV_EXIT_t pxenv_tftp_open ( struct s_PXENV_TFTP_OPEN *tftp_open );
577
578 /** @} */ /* pxenv_tftp_open */
579
580 /** @defgroup pxenv_tftp_close PXENV_TFTP_CLOSE
581  *
582  *  TFTP CLOSE
583  *
584  *  @{
585  */
586
587 /** PXE API function code for pxenv_tftp_close() */
588 #define PXENV_TFTP_CLOSE                0x0021
589
590 /** Parameter block for pxenv_tftp_close() */
591 struct s_PXENV_TFTP_CLOSE {
592         PXENV_STATUS_t Status;                  /**< PXE status code */
593 } PACKED;
594
595 typedef struct s_PXENV_TFTP_CLOSE PXENV_TFTP_CLOSE_t;
596
597 extern PXENV_EXIT_t pxenv_tftp_close ( struct s_PXENV_TFTP_CLOSE *tftp_close );
598
599 /** @} */ /* pxenv_tftp_close */
600
601 /** @defgroup pxenv_tftp_read PXENV_TFTP_READ
602  *
603  *  TFTP READ
604  *
605  *  @{
606  */
607
608 /** PXE API function code for pxenv_tftp_read() */
609 #define PXENV_TFTP_READ                 0x0022
610
611 /** Parameter block for pxenv_tftp_read() */
612 struct s_PXENV_TFTP_READ {
613         PXENV_STATUS_t Status;                  /**< PXE status code */
614         UINT16_t PacketNumber;                  /**< TFTP packet number */
615         UINT16_t BufferSize;                    /**< Size of data buffer */
616         SEGOFF16_t Buffer;                      /**< Address of data buffer */
617 } PACKED;
618
619 typedef struct s_PXENV_TFTP_READ PXENV_TFTP_READ_t;
620
621 extern PXENV_EXIT_t pxenv_tftp_read ( struct s_PXENV_TFTP_READ *tftp_read );
622
623 /** @} */ /* pxenv_tftp_read */
624
625 /** @defgroup pxenv_tftp_read_file PXENV_TFTP_READ_FILE
626  *
627  *  TFTP/MTFTP READ FILE
628  *
629  *  @{
630  */
631
632 /** PXE API function code for pxenv_tftp_read_file() */
633 #define PXENV_TFTP_READ_FILE            0x0023
634
635 /** Parameter block for pxenv_tftp_read_file() */
636 struct s_PXENV_TFTP_READ_FILE {
637         PXENV_STATUS_t Status;                  /**< PXE status code */
638         UINT8_t FileName[128];                  /**< File name */
639         UINT32_t BufferSize;                    /**< Size of data buffer */
640         ADDR32_t Buffer;                        /**< Address of data buffer */
641         IP4_t ServerIPAddress;                  /**< TFTP server IP address */
642         IP4_t GatewayIPAddress;                 /**< Relay agent IP address */
643         /** File multicast IP address */
644         IP4_t McastIPAddress;
645         /** Client multicast listening port */
646         UDP_PORT_t TFTPClntPort;
647         /** Server multicast listening port */
648         UDP_PORT_t TFTPSrvPort;
649         /** TFTP open timeout.
650          *
651          * This is the timeout for receiving the first DATA or ACK
652          * packets during the MTFTP Listen phase.
653          */
654         UINT16_t TFTPOpenTimeOut;
655         /** TFTP reopen timeout.
656          *
657          * This is the timeout for receiving an ACK packet while in
658          * the MTFTP Listen phase (when at least one ACK packet has
659          * already been seen).
660          */
661         UINT16_t TFTPReopenDelay;
662 } PACKED;
663
664 typedef struct s_PXENV_TFTP_READ_FILE PXENV_TFTP_READ_FILE_t;
665
666 extern PXENV_EXIT_t pxenv_tftp_read_file ( struct s_PXENV_TFTP_READ_FILE
667                                            *tftp_read_file );
668
669 /** @} */ /* pxenv_tftp_read_file */
670
671 /** @defgroup pxenv_tftp_get_fsize PXENV_TFTP_GET_FSIZE
672  *
673  *  TFTP GET FILE SIZE
674  *
675  *  @{
676  */
677
678 /** PXE API function code for pxenv_tftp_get_fsize() */
679 #define PXENV_TFTP_GET_FSIZE            0x0025
680
681 /** Parameter block for pxenv_tftp_get_fsize() */
682 struct s_PXENV_TFTP_GET_FSIZE {
683         PXENV_STATUS_t Status;                  /**< PXE status code */
684         IP4_t ServerIPAddress;                  /**< TFTP server IP address */
685         IP4_t GatewayIPAddress;                 /**< Relay agent IP address */
686         UINT8_t FileName[128];                  /**< File name */
687         UINT32_t FileSize;                      /**< Size of the file */
688 } PACKED;
689
690 typedef struct s_PXENV_TFTP_GET_FSIZE PXENV_TFTP_GET_FSIZE_t;
691
692 extern PXENV_EXIT_t pxenv_tftp_get_fsize ( struct s_PXENV_TFTP_GET_FSIZE
693                                            *get_fsize );
694
695 /** @} */ /* pxenv_tftp_get_fsize */
696
697 /** @} */ /* pxe_tftp_api */
698
699 /** @defgroup pxe_udp_api PXE UDP API
700  *
701  * Transmit and receive UDP packets
702  *
703  * @{
704  */
705
706 /** @defgroup pxenv_udp_open PXENV_UDP_OPEN
707  *
708  *  UDP OPEN
709  *
710  *  @{
711  */
712
713 /** PXE API function code for pxenv_udp_open() */
714 #define PXENV_UDP_OPEN                  0x0030
715
716 /** Parameter block for pxenv_udp_open() */
717 struct s_PXENV_UDP_OPEN {
718         PXENV_STATUS_t  Status;         /**< PXE status code */
719         IP4_t           src_ip;         /**< IP address of this station */
720 } PACKED;
721
722 typedef struct s_PXENV_UDP_OPEN PXENV_UDP_OPEN_t;
723
724 extern PXENV_EXIT_t pxenv_udp_open ( struct s_PXENV_UDP_OPEN *udp_open );
725
726 /** @} */ /* pxenv_udp_open */
727
728 /** @defgroup pxenv_udp_close PXENV_UDP_CLOSE
729  *
730  *  UDP CLOSE
731  *
732  *  @{
733  */
734
735 /** PXE API function code for pxenv_udp_close() */
736 #define PXENV_UDP_CLOSE                 0x0031
737
738 /** Parameter block for pxenv_udp_close() */
739 struct s_PXENV_UDP_CLOSE {
740         PXENV_STATUS_t  Status;         /**< PXE status code */
741 } PACKED;
742
743 typedef struct s_PXENV_UDP_CLOSE PXENV_UDP_CLOSE_t;
744
745 extern PXENV_EXIT_t pxenv_udp_close ( struct s_PXENV_UDP_CLOSE *udp_close );
746
747 /** @} */ /* pxenv_udp_close */
748
749 /** @defgroup pxenv_udp_write PXENV_UDP_WRITE
750  *
751  *  UDP WRITE
752  *
753  *  @{
754  */
755
756 /** PXE API function code for pxenv_udp_write() */
757 #define PXENV_UDP_WRITE                 0x0033
758
759 /** Parameter block for pxenv_udp_write() */
760 struct s_PXENV_UDP_WRITE {
761         PXENV_STATUS_t  Status;         /**< PXE status code */
762         IP4_t           ip;             /**< Destination IP address */
763         IP4_t           gw;             /**< Relay agent IP address */
764         UDP_PORT_t      src_port;       /**< Source UDP port */
765         UDP_PORT_t      dst_port;       /**< Destination UDP port */
766         UINT16_t        buffer_size;    /**< UDP payload buffer size */
767         SEGOFF16_t      buffer;         /**< UDP payload buffer address */
768 } PACKED;
769
770 typedef struct s_PXENV_UDP_WRITE PXENV_UDP_WRITE_t;
771
772 extern PXENV_EXIT_t pxenv_udp_write ( struct s_PXENV_UDP_WRITE *udp_write );
773
774 /** @} */ /* pxenv_udp_write */
775
776 /** @defgroup pxenv_udp_read PXENV_UDP_READ
777  *
778  *  UDP READ
779  *
780  *  @{
781  */
782
783 /** PXE API function code for pxenv_udp_read() */
784 #define PXENV_UDP_READ                  0x0032
785
786 /** Parameter block for pxenv_udp_read() */
787 struct s_PXENV_UDP_READ {
788         PXENV_STATUS_t  Status;         /**< PXE status code */
789         IP4_t           src_ip;         /**< Source IP address */
790         IP4_t           dest_ip;        /**< Destination IP address */
791         UDP_PORT_t      s_port;         /**< Source UDP port */
792         UDP_PORT_t      d_port;         /**< Destination UDP port */
793         UINT16_t        buffer_size;    /**< UDP payload buffer size */
794         SEGOFF16_t      buffer;         /**< UDP payload buffer address */
795 } PACKED;
796
797 typedef struct s_PXENV_UDP_READ PXENV_UDP_READ_t;
798
799 extern PXENV_EXIT_t pxenv_udp_read ( struct s_PXENV_UDP_READ *udp_read );
800
801 /** @} */ /* pxenv_udp_read */
802
803 /** @} */ /* pxe_udp_api */
804
805 /** @defgroup pxe_undi_api PXE UNDI API
806  *
807  * Direct control of the network interface card
808  *
809  * @{
810  */
811
812 /** @defgroup pxenv_undi_startup PXENV_UNDI_STARTUP
813  *
814  *  UNDI STARTUP
815  *
816  *  @{
817  */
818
819 /** PXE API function code for pxenv_undi_startup() */
820 #define PXENV_UNDI_STARTUP              0x0001
821
822 #define PXENV_BUS_ISA           0       /**< ISA bus type */
823 #define PXENV_BUS_EISA          1       /**< EISA bus type */
824 #define PXENV_BUS_MCA           2       /**< MCA bus type */
825 #define PXENV_BUS_PCI           3       /**< PCI bus type */
826 #define PXENV_BUS_VESA          4       /**< VESA bus type */
827 #define PXENV_BUS_PCMCIA        5       /**< PCMCIA bus type */
828
829 /** Parameter block for pxenv_undi_startup() */
830 struct s_PXENV_UNDI_STARTUP {
831         PXENV_STATUS_t  Status;         /**< PXE status code */
832 } PACKED;
833
834 typedef struct s_PXENV_UNDI_STARTUP PXENV_UNDI_STARTUP_t;
835
836 extern PXENV_EXIT_t pxenv_undi_startup ( struct s_PXENV_UNDI_STARTUP
837                                          *undi_startup );
838
839 /** @} */ /* pxenv_undi_startup */
840
841 /** @defgroup pxenv_undi_cleanup PXENV_UNDI_CLEANUP
842  *
843  *  UNDI CLEANUP
844  *
845  *  @{
846  */
847
848 /** PXE API function code for pxenv_undi_cleanup() */
849 #define PXENV_UNDI_CLEANUP              0x0002
850
851 /** Parameter block for pxenv_undi_cleanup() */
852 struct s_PXENV_UNDI_CLEANUP {
853         PXENV_STATUS_t  Status;         /**< PXE status code */
854 } PACKED;
855
856 typedef struct s_PXENV_UNDI_CLEANUP PXENV_UNDI_CLEANUP_t;
857
858 extern PXENV_EXIT_t pxenv_undi_cleanup ( struct s_PXENV_UNDI_CLEANUP
859                                          *undi_cleanup );
860
861 /** @} */ /* pxenv_undi_cleanup */
862
863 /** @defgroup pxenv_undi_initialize PXENV_UNDI_INITIALIZE
864  *
865  *  UNDI INITIALIZE
866  *
867  *  @{
868  */
869
870 /** PXE API function code for pxenv_undi_initialize() */
871 #define PXENV_UNDI_INITIALIZE           0x0003
872
873 /** Parameter block for pxenv_undi_initialize() */
874 struct s_PXENV_UNDI_INITIALIZE {
875         PXENV_STATUS_t  Status;         /**< PXE status code */
876         /** NDIS 2.0 configuration information, or NULL
877          *
878          * This is a pointer to the data structure returned by the
879          * NDIS 2.0 GetProtocolManagerInfo() API call.  The data
880          * structure is documented, in a rather haphazard way, in
881          * section 4-17 of the NDIS 2.0 specification.
882          */
883         ADDR32_t ProtocolIni;
884         UINT8_t reserved[8];            /**< Must be zero */
885 } PACKED;
886
887 typedef struct s_PXENV_UNDI_INITIALIZE PXENV_UNDI_INITIALIZE_t;
888
889 extern PXENV_EXIT_t pxenv_undi_initialize ( struct s_PXENV_UNDI_INITIALIZE
890                                             *undi_initialize );
891
892 /** @} */ /* pxenv_undi_initialize */
893
894 /** @defgroup pxenv_undi_reset_adapter PXENV_UNDI_RESET_ADAPTER
895  *
896  *  UNDI RESET ADAPTER
897  *
898  *  @{
899  */
900
901 /** PXE API function code for pxenv_undi_reset_adapter() */
902 #define PXENV_UNDI_RESET_ADAPTER        0x0004
903
904 /** Maximum number of multicast MAC addresses */
905 #define MAXNUM_MCADDR   8
906
907 /** List of multicast MAC addresses */
908 struct s_PXENV_UNDI_MCAST_ADDRESS {
909         /** Number of multicast MAC addresses */
910         UINT16_t MCastAddrCount;
911         /** List of up to #MAXNUM_MCADDR multicast MAC addresses */
912         MAC_ADDR_t McastAddr[MAXNUM_MCADDR];
913 } PACKED;
914
915 typedef struct s_PXENV_UNDI_MCAST_ADDRESS PXENV_UNDI_MCAST_ADDRESS_t;
916
917 /** Parameter block for pxenv_undi_reset_adapter() */
918 struct s_PXENV_UNDI_RESET {
919         PXENV_STATUS_t  Status;         /**< PXE status code */
920         /** Multicast MAC addresses */
921         struct s_PXENV_UNDI_MCAST_ADDRESS R_Mcast_Buf;
922 } PACKED;
923
924 typedef struct s_PXENV_UNDI_RESET PXENV_UNDI_RESET_t;
925
926 extern PXENV_EXIT_t pxenv_undi_reset_adapter ( struct s_PXENV_UNDI_RESET
927                                                *undi_reset_adapter );
928
929 /** @} */ /* pxenv_undi_reset_adapter */
930
931 /** @defgroup pxenv_undi_shutdown PXENV_UNDI_SHUTDOWN
932  *
933  *  UNDI SHUTDOWN
934  *
935  *  @{
936  */
937
938 /** PXE API function code for pxenv_undi_shutdown() */
939 #define PXENV_UNDI_SHUTDOWN             0x0005
940
941 /** Parameter block for pxenv_undi_shutdown() */
942 struct s_PXENV_UNDI_SHUTDOWN {
943         PXENV_STATUS_t  Status;         /**< PXE status code */
944 } PACKED;
945
946 typedef struct s_PXENV_UNDI_SHUTDOWN PXENV_UNDI_SHUTDOWN_t;
947
948 extern PXENV_EXIT_t pxenv_undi_shutdown ( struct s_PXENV_UNDI_SHUTDOWN
949                                           *undi_shutdown );
950
951 /** @} */ /* pxenv_undi_shutdown */
952
953 /** @defgroup pxenv_undi_open PXENV_UNDI_OPEN
954  *
955  *  UNDI OPEN
956  *
957  *  @{
958  */
959
960 /** PXE API function code for pxenv_undi_open() */
961 #define PXENV_UNDI_OPEN                 0x0006
962
963 /** Accept "directed" packets
964  *
965  * These are packets addresses to either this adapter's MAC address or
966  * to any of the configured multicast MAC addresses (see
967  * #s_PXENV_UNDI_MCAST_ADDRESS).
968  */
969 #define FLTR_DIRECTED   0x0001
970 /** Accept broadcast packets */
971 #define FLTR_BRDCST     0x0002
972 /** Accept all packets; listen in promiscuous mode */
973 #define FLTR_PRMSCS     0x0004
974 /** Accept source-routed packets */
975 #define FLTR_SRC_RTG    0x0008
976
977 /** Parameter block for pxenv_undi_open() */
978 struct s_PXENV_UNDI_OPEN {
979         PXENV_STATUS_t  Status;         /**< PXE status code */
980         /** Open flags as defined in NDIS 2.0
981          *
982          * This is the OpenOptions field as passed to the NDIS 2.0
983          * OpenAdapter() API call.  It is defined to be "adapter
984          * specific", though 0 is guaranteed to be a valid value.
985          */
986         UINT16_t OpenFlag;
987         /** Receive packet filter
988          *
989          * This is the bitwise-OR of any of the following flags:
990          * #FLTR_DIRECTED, #FLTR_BRDCST, #FLTR_PRMSCS and
991          * #FLTR_SRC_RTG.
992          */
993         UINT16_t PktFilter;
994         /** Multicast MAC addresses */
995         struct s_PXENV_UNDI_MCAST_ADDRESS R_Mcast_Buf;
996 } PACKED;
997
998 typedef struct s_PXENV_UNDI_OPEN PXENV_UNDI_OPEN_t;
999
1000 extern PXENV_EXIT_t pxenv_undi_open ( struct s_PXENV_UNDI_OPEN *undi_open );
1001
1002 /** @} */ /* pxenv_undi_open */
1003
1004 /** @defgroup pxenv_undi_close PXENV_UNDI_CLOSE
1005  *
1006  *  UNDI CLOSE
1007  *
1008  *  @{
1009  */
1010
1011 /** PXE API function code for pxenv_undi_close() */
1012 #define PXENV_UNDI_CLOSE                0x0007
1013
1014 /** Parameter block for pxenv_undi_close() */
1015 struct s_PXENV_UNDI_CLOSE {
1016         PXENV_STATUS_t  Status;         /**< PXE status code */
1017 } PACKED;
1018
1019 typedef struct s_PXENV_UNDI_CLOSE PXENV_UNDI_CLOSE_t;
1020
1021 extern PXENV_EXIT_t pxenv_undi_close ( struct s_PXENV_UNDI_CLOSE *undi_close );
1022
1023 /** @} */ /* pxenv_undi_close */
1024
1025 /** @defgroup pxenv_undi_transmit PXENV_UNDI_TRANSMIT
1026  *
1027  *  UNDI TRANSMIT PACKET
1028  *
1029  *  @{
1030  */
1031
1032 /** PXE API function code for pxenv_undi_transmit() */
1033 #define PXENV_UNDI_TRANSMIT             0x0008
1034
1035 #define P_UNKNOWN       0               /**< Media header already filled in */
1036 #define P_IP            1               /**< IP protocol */
1037 #define P_ARP           2               /**< ARP protocol */
1038 #define P_RARP          3               /**< RARP protocol */
1039 #define P_OTHER         4               /**< Other protocol */
1040
1041 #define XMT_DESTADDR    0x0000          /**< Unicast packet */
1042 #define XMT_BROADCAST   0x0001          /**< Broadcast packet */
1043
1044 /** Maximum number of data blocks in a transmit buffer descriptor */
1045 #define MAX_DATA_BLKS   8
1046
1047 /** A transmit buffer descriptor, as pointed to by s_PXENV_UNDI_TRANSMIT::TBD
1048  */
1049 struct s_PXENV_UNDI_TBD {
1050         UINT16_t ImmedLength;           /**< Length of the transmit buffer */
1051         SEGOFF16_t Xmit;                /**< Address of the transmit buffer */
1052         UINT16_t DataBlkCount;
1053         /** Array of up to #MAX_DATA_BLKS additional transmit buffers */
1054         struct DataBlk {
1055                 /** Always 1
1056                  *
1057                  * A value of 0 would indicate that #TDDataPtr were an
1058                  * #ADDR32_t rather than a #SEGOFF16_t.  The PXE
1059                  * specification version 2.1 explicitly states that
1060                  * this is not supported; #TDDataPtr will always be a
1061                  * #SEGOFF16_t.
1062                  */
1063                 UINT8_t TDPtrType;
1064                 UINT8_t TDRsvdByte;     /**< Must be zero */
1065                 UINT16_t TDDataLen;     /**< Length of this transmit buffer */
1066                 SEGOFF16_t TDDataPtr;   /**< Address of this transmit buffer */
1067         } DataBlock[MAX_DATA_BLKS];
1068 } PACKED;
1069
1070 typedef struct s_PXENV_UNDI_TBD PXENV_UNDI_TBD_t;
1071
1072 /** Parameter block for pxenv_undi_transmit() */
1073 struct s_PXENV_UNDI_TRANSMIT {
1074         PXENV_STATUS_t  Status;         /**< PXE status code */
1075         /** Protocol
1076          *
1077          * Valid values are #P_UNKNOWN, #P_IP, #P_ARP or #P_RARP.  If
1078          * the caller has already filled in the media header, this
1079          * field must be set to #P_UNKNOWN.
1080          */
1081         UINT8_t Protocol;
1082         /** Unicast/broadcast flag
1083          *
1084          * Valid values are #XMT_DESTADDR or #XMT_BROADCAST.
1085          */
1086         UINT8_t XmitFlag;
1087         SEGOFF16_t DestAddr;            /**< Destination MAC address */
1088         /** Address of the Transmit Buffer Descriptor
1089          *
1090          * This is a pointer to a struct s_PXENV_UNDI_TBD.
1091          */
1092         SEGOFF16_t TBD;
1093         UINT32_t Reserved[2];           /**< Must be zero */
1094 } PACKED;
1095
1096 typedef struct s_PXENV_UNDI_TRANSMIT PXENV_UNDI_TRANSMIT_t;
1097
1098 extern PXENV_EXIT_t pxenv_undi_transmit ( struct s_PXENV_UNDI_TRANSMIT
1099                                           *undi_transmit );
1100
1101 /** @} */ /* pxenv_undi_transmit */
1102
1103 /** @defgroup pxenv_undi_set_mcast_address PXENV_UNDI_SET_MCAST_ADDRESS
1104  *
1105  *  UNDI SET MULTICAST ADDRESS
1106  *
1107  *  @{
1108  */
1109
1110 /** PXE API function code for pxenv_undi_set_mcast_address() */
1111 #define PXENV_UNDI_SET_MCAST_ADDRESS    0x0009
1112
1113 /** Parameter block for pxenv_undi_set_mcast_address() */
1114 struct s_PXENV_UNDI_SET_MCAST_ADDRESS {
1115         PXENV_STATUS_t  Status;         /**< PXE status code */
1116         /** List of multicast addresses */
1117         struct s_PXENV_UNDI_MCAST_ADDRESS R_Mcast_Buf;
1118 } PACKED;
1119
1120 typedef struct s_PXENV_UNDI_SET_MCAST_ADDRESS PXENV_UNDI_SET_MCAST_ADDRESS_t;
1121
1122 extern PXENV_EXIT_t pxenv_undi_set_mcast_address (
1123                struct s_PXENV_UNDI_SET_MCAST_ADDRESS *undi_set_mcast_address );
1124
1125 /** @} */ /* pxenv_undi_set_mcast_address */
1126
1127 /** @defgroup pxenv_undi_set_station_address PXENV_UNDI_SET_STATION_ADDRESS
1128  *
1129  *  UNDI SET STATION ADDRESS
1130  *
1131  *  @{
1132  */
1133
1134 /** PXE API function code for pxenv_undi_set_station_address() */
1135 #define PXENV_UNDI_SET_STATION_ADDRESS  0x000a
1136
1137 /** Parameter block for pxenv_undi_set_station_address() */
1138 struct s_PXENV_UNDI_SET_STATION_ADDRESS {
1139         PXENV_STATUS_t  Status;         /**< PXE status code */
1140         MAC_ADDR_t StationAddress;      /**< Station MAC address */
1141 } PACKED;
1142
1143 typedef struct s_PXENV_UNDI_SET_STATION_ADDRESS PXENV_UNDI_SET_STATION_ADDRESS_t;
1144
1145 extern PXENV_EXIT_t pxenv_undi_set_station_address (
1146            struct s_PXENV_UNDI_SET_STATION_ADDRESS *undi_set_station_address );
1147
1148 /** @} */ /* pxenv_undi_set_station_address */
1149
1150 /** @defgroup pxenv_undi_set_packet_filter PXENV_UNDI_SET_PACKET_FILTER
1151  *
1152  *  UNDI SET PACKET FILTER
1153  *
1154  *  @{
1155  */
1156
1157 /** PXE API function code for pxenv_undi_set_packet_filter() */
1158 #define PXENV_UNDI_SET_PACKET_FILTER    0x000b
1159
1160 /** Parameter block for pxenv_undi_set_packet_filter() */
1161 struct s_PXENV_UNDI_SET_PACKET_FILTER {
1162         PXENV_STATUS_t  Status;         /**< PXE status code */
1163         /** Receive packet filter
1164          *
1165          * This field takes the same values as
1166          * s_PXENV_UNDI_OPEN::PktFilter.
1167          *
1168          * @note Yes, this field is a different size to
1169          * s_PXENV_UNDI_OPEN::PktFilter.  Blame "the managers at Intel
1170          * who apparently let a consultant come up with the spec
1171          * without any kind of adult supervision" (quote from hpa).
1172          */
1173         UINT8_t filter;
1174 } PACKED;
1175
1176 typedef struct s_PXENV_UNDI_SET_PACKET_FILTER PXENV_UNDI_SET_PACKET_FILTER_t;
1177
1178 extern PXENV_EXIT_t pxenv_undi_set_packet_filter (
1179                struct s_PXENV_UNDI_SET_PACKET_FILTER *undi_set_packet_filter );
1180
1181 /** @} */ /* pxenv_undi_set_packet_filter */
1182
1183 /** @defgroup pxenv_undi_get_information PXENV_UNDI_GET_INFORMATION
1184  *
1185  *  UNDI GET INFORMATION
1186  *
1187  *  @{
1188  */
1189
1190 /** PXE API function code for pxenv_undi_get_information() */
1191 #define PXENV_UNDI_GET_INFORMATION      0x000c
1192
1193 #define ETHER_TYPE              1       /**< Ethernet (10Mb) */
1194 #define EXP_ETHER_TYPE          2       /**< Experimental Ethernet (3Mb) */
1195 #define AX25_TYPE               3       /**< Amateur Radio AX.25 */
1196 #define TOKEN_RING_TYPE         4       /**< Proteon ProNET Token Ring */
1197 #define CHAOS_TYPE              5       /**< Chaos */
1198 #define IEEE_TYPE               6       /**< IEEE 802 Networks */
1199 #define ARCNET_TYPE             7       /**< ARCNET */
1200
1201 /** Parameter block for pxenv_undi_get_information() */
1202 struct s_PXENV_UNDI_GET_INFORMATION {
1203         PXENV_STATUS_t  Status;         /**< PXE status code */
1204         UINT16_t BaseIo;                /**< I/O base address */
1205         UINT16_t IntNumber;             /**< IRQ number */
1206         UINT16_t MaxTranUnit;           /**< Adapter MTU */
1207         /** Hardware type
1208          *
1209          * Valid values are defined in RFC1010 ("Assigned numbers"),
1210          * and are #ETHER_TYPE, #EXP_ETHER_TYPE, #AX25_TYPE,
1211          * #TOKEN_RING_TYPE, #CHAOS_TYPE, #IEEE_TYPE or #ARCNET_TYPE.
1212          */
1213         UINT16_t HwType;
1214         UINT16_t HwAddrLen;             /**< MAC address length */
1215         MAC_ADDR_t CurrentNodeAddress;  /**< Current MAC address */
1216         MAC_ADDR_t PermNodeAddress;     /**< Permanent (EEPROM) MAC address */
1217         SEGSEL_t ROMAddress;            /**< Real-mode ROM segment address */
1218         UINT16_t RxBufCt;               /**< Receive queue length */
1219         UINT16_t TxBufCt;               /**< Transmit queue length */
1220 } PACKED;
1221
1222 typedef struct s_PXENV_UNDI_GET_INFORMATION PXENV_UNDI_GET_INFORMATION_t;
1223
1224 extern PXENV_EXIT_t pxenv_undi_get_information (
1225                    struct s_PXENV_UNDI_GET_INFORMATION *undi_get_information );
1226
1227 /** @} */ /* pxenv_undi_get_information */
1228
1229 /** @defgroup pxenv_undi_get_statistics PXENV_UNDI_GET_STATISTICS
1230  *
1231  *  UNDI GET STATISTICS
1232  *
1233  *  @{
1234  */
1235
1236 /** PXE API function code for pxenv_undi_get_statistics() */
1237 #define PXENV_UNDI_GET_STATISTICS       0x000d
1238
1239 /** Parameter block for pxenv_undi_get_statistics() */
1240 struct s_PXENV_UNDI_GET_STATISTICS {
1241         PXENV_STATUS_t  Status;         /**< PXE status code */
1242         UINT32_t XmtGoodFrames;         /**< Successful transmission count */
1243         UINT32_t RcvGoodFrames;         /**< Successful reception count */
1244         UINT32_t RcvCRCErrors;          /**< Receive CRC error count */
1245         UINT32_t RcvResourceErrors;     /**< Receive queue overflow count */
1246 } PACKED;
1247
1248 typedef struct s_PXENV_UNDI_GET_STATISTICS PXENV_UNDI_GET_STATISTICS_t;
1249
1250 extern PXENV_EXIT_t pxenv_undi_get_statistics (
1251                      struct s_PXENV_UNDI_GET_STATISTICS *undi_get_statistics );
1252
1253 /** @} */ /* pxenv_undi_get_statistics */
1254
1255 /** @defgroup pxenv_undi_clear_statistics PXENV_UNDI_CLEAR_STATISTICS
1256  *
1257  *  UNDI CLEAR STATISTICS
1258  *
1259  *  @{
1260  */
1261
1262 /** PXE API function code for pxenv_undi_clear_statistics() */
1263 #define PXENV_UNDI_CLEAR_STATISTICS     0x000e
1264
1265 /** Parameter block for pxenv_undi_clear_statistics() */
1266 struct s_PXENV_UNDI_CLEAR_STATISTICS {
1267         PXENV_STATUS_t  Status;         /**< PXE status code */
1268 } PACKED;
1269
1270 typedef struct s_PXENV_UNDI_CLEAR_STATISTICS PXENV_UNDI_CLEAR_STATISTICS_t;
1271
1272 extern PXENV_EXIT_t pxenv_undi_clear_statistics (
1273                  struct s_PXENV_UNDI_CLEAR_STATISTICS *undi_clear_statistics );
1274
1275 /** @} */ /* pxenv_undi_clear_statistics */
1276
1277 /** @defgroup pxenv_undi_initiate_diags PXENV_UNDI_INITIATE_DIAGS
1278  *
1279  *  UNDI INITIATE DIAGS
1280  *
1281  *  @{
1282  */
1283
1284 /** PXE API function code for pxenv_undi_initiate_diags() */
1285 #define PXENV_UNDI_INITIATE_DIAGS       0x000f
1286
1287 /** Parameter block for pxenv_undi_initiate_diags() */
1288 struct s_PXENV_UNDI_INITIATE_DIAGS {
1289         PXENV_STATUS_t  Status;         /**< PXE status code */
1290 } PACKED;
1291
1292 typedef struct s_PXENV_UNDI_INITIATE_DIAGS PXENV_UNDI_INITIATE_DIAGS_t;
1293
1294 extern PXENV_EXIT_t pxenv_undi_initiate_diags (
1295                      struct s_PXENV_UNDI_INITIATE_DIAGS *undi_initiate_diags );
1296
1297 /** @} */ /* pxenv_undi_initiate_diags */
1298
1299 /** @defgroup pxenv_undi_force_interrupt PXENV_UNDI_FORCE_INTERRUPT
1300  *
1301  *  UNDI FORCE INTERRUPT
1302  *
1303  *  @{
1304  */
1305
1306 /** PXE API function code for pxenv_undi_force_interrupt() */
1307 #define PXENV_UNDI_FORCE_INTERRUPT      0x0010
1308
1309 /** Parameter block for pxenv_undi_force_interrupt() */
1310 struct s_PXENV_UNDI_FORCE_INTERRUPT {
1311         PXENV_STATUS_t  Status;         /**< PXE status code */
1312 } PACKED;
1313
1314 typedef struct s_PXENV_UNDI_FORCE_INTERRUPT PXENV_UNDI_FORCE_INTERRUPT_t;
1315
1316 extern PXENV_EXIT_t pxenv_undi_force_interrupt (
1317                    struct s_PXENV_UNDI_FORCE_INTERRUPT *undi_force_interrupt );
1318
1319 /** @} */ /* pxenv_undi_force_interrupt */
1320
1321 /** @defgroup pxenv_undi_get_mcast_address PXENV_UNDI_GET_MCAST_ADDRESS
1322  *
1323  *  UNDI GET MULTICAST ADDRESS
1324  *
1325  *  @{
1326  */
1327
1328 /** PXE API function code for pxenv_undi_get_mcast_address() */
1329 #define PXENV_UNDI_GET_MCAST_ADDRESS    0x0011
1330
1331 /** Parameter block for pxenv_undi_get_mcast_address() */
1332 struct s_PXENV_UNDI_GET_MCAST_ADDRESS {
1333         PXENV_STATUS_t  Status;         /**< PXE status code */
1334         IP4_t InetAddr;                 /**< Multicast IP address */
1335         MAC_ADDR_t MediaAddr;           /**< Multicast MAC address */
1336 } PACKED;
1337
1338 typedef struct s_PXENV_UNDI_GET_MCAST_ADDRESS PXENV_UNDI_GET_MCAST_ADDRESS_t;
1339
1340 extern PXENV_EXIT_t pxenv_undi_get_mcast_address (
1341                struct s_PXENV_UNDI_GET_MCAST_ADDRESS *undi_get_mcast_address );
1342
1343 /** @} */ /* pxenv_undi_get_mcast_address */
1344
1345 /** @defgroup pxenv_undi_get_nic_type PXENV_UNDI_GET_NIC_TYPE
1346  *
1347  *  UNDI GET NIC TYPE
1348  *
1349  *  @{
1350  */
1351
1352 /** PXE API function code for pxenv_undi_get_nic_type() */
1353 #define PXENV_UNDI_GET_NIC_TYPE         0x0012
1354
1355 #define PCI_NIC         2               /**< PCI network card */
1356 #define PnP_NIC         3               /**< ISAPnP network card */
1357 #define CardBus_NIC     4               /**< CardBus network card */
1358
1359 /** Information for a PCI or equivalent NIC */
1360 struct pci_nic_info {
1361         UINT16_t Vendor_ID;             /**< PCI vendor ID */
1362         UINT16_t Dev_ID;                /**< PCI device ID */
1363         UINT8_t Base_Class;             /**< PCI base class */
1364         UINT8_t Sub_Class;              /**< PCI sub class */
1365         UINT8_t Prog_Intf;              /**< PCI programming interface */
1366         UINT8_t Rev;                    /**< PCI revision */
1367         UINT16_t BusDevFunc;            /**< PCI bus:dev:fn address */
1368         UINT16_t SubVendor_ID;          /**< PCI subvendor ID */
1369         UINT16_t SubDevice_ID;          /**< PCI subdevice ID */
1370 } PACKED;
1371  
1372 /** Information for an ISAPnP or equivalent NIC */
1373 struct pnp_nic_info {
1374         UINT32_t EISA_Dev_ID;           /**< EISA device ID */
1375         UINT8_t Base_Class;             /**< Base class */
1376         UINT8_t Sub_Class;              /**< Sub class */
1377         UINT8_t Prog_Intf;              /**< Programming interface */
1378         /** Card Select Number assigned to card */
1379         UINT16_t CardSelNum;
1380 } PACKED;
1381
1382 /** Parameter block for pxenv_undi_get_nic_type() */
1383 struct s_PXENV_UNDI_GET_NIC_TYPE {
1384         PXENV_STATUS_t  Status;         /**< PXE status code */
1385         /** NIC type
1386          *
1387          * Valid values are #PCI_NIC, #PnP_NIC or #CardBus_NIC.
1388          */
1389         UINT8_t NicType;
1390         /** NIC information */
1391         union nic_type_info {
1392                 /** NIC information (if #NicType==#PCI_NIC) */
1393                 struct pci_nic_info pci;
1394                 /** NIC information (if #NicType==#CardBus_NIC) */
1395                 struct pci_nic_info cardbus;
1396                 /** NIC information (if #NicType==#PnP_NIC) */
1397                 struct pnp_nic_info pnp;
1398         } info;
1399 } PACKED;
1400
1401 typedef struct s_PXENV_UNDI_GET_NIC_TYPE PXENV_UNDI_GET_NIC_TYPE_t;
1402
1403 extern PXENV_EXIT_t pxenv_undi_get_nic_type ( 
1404                          struct s_PXENV_UNDI_GET_NIC_TYPE *undi_get_nic_type );
1405
1406 /** @} */ /* pxenv_undi_get_nic_type */
1407
1408 /** @defgroup pxenv_undi_get_iface_info PXENV_UNDI_GET_IFACE_INFO
1409  *
1410  *  UNDI GET IFACE INFO
1411  *
1412  *  @{
1413  */
1414
1415 /** PXE API function code for pxenv_undi_get_iface_info() */
1416 #define PXENV_UNDI_GET_IFACE_INFO       0x0013
1417
1418 /** Parameter block for pxenv_undi_get_iface_info() */
1419 struct s_PXENV_UNDI_GET_IFACE_INFO {
1420         PXENV_STATUS_t  Status;         /**< PXE status code */
1421         /** Interface type
1422          *
1423          * This is defined in the NDIS 2.0 specification to be one of
1424          * the strings "802.3", "802.4", "802.5", "802.6", "DIX",
1425          * "DIX+802.3", "APPLETALK", "ARCNET", "FDDI", "SDLC", "BSC",
1426          * "HDLC", or "ISDN".
1427          *
1428          * "Normal" Ethernet, for various historical reasons, is
1429          * "DIX+802.3".
1430          */
1431         UINT8_t IfaceType[16];
1432         UINT32_t LinkSpeed;             /**< Link speed, in bits per second */
1433         /** Service flags
1434          *
1435          * These are the "service flags" defined in the "MAC
1436          * Service-Specific Characteristics" table in the NDIS 2.0
1437          * specification.  Almost all of them are irrelevant to PXE.
1438          */
1439         UINT32_t ServiceFlags;
1440         UINT32_t Reserved[4];           /**< Must be zero */
1441 } PACKED;
1442
1443 typedef struct s_PXENV_UNDI_GET_IFACE_INFO PXENV_UNDI_GET_IFACE_INFO_t;
1444
1445 extern PXENV_EXIT_t pxenv_undi_get_iface_info (
1446                      struct s_PXENV_UNDI_GET_IFACE_INFO *undi_get_iface_info );
1447
1448 /** @} */ /* pxenv_undi_get_iface_info */
1449
1450 /** @defgroup pxenv_undi_get_state PXENV_UNDI_GET_STATE
1451  *
1452  *  UNDI GET STATE
1453  *
1454  *  @{
1455  */
1456
1457 /** PXE API function code for pxenv_undi_get_state() */
1458 #define PXENV_UNDI_GET_STATE            0x0015
1459
1460 /** pxenv_start_undi() has been called */
1461 #define PXE_UNDI_GET_STATE_STARTED      1
1462 /** pxenv_undi_initialize() has been called */
1463 #define PXE_UNDI_GET_STATE_INITIALIZED  2
1464 /** pxenv_undi_open() has been called */
1465 #define PXE_UNDI_GET_STATE_OPENED       3
1466
1467 /** Parameter block for pxenv_undi_get_state() */
1468 struct s_PXENV_UNDI_GET_STATE {
1469         PXENV_STATUS_t  Status;         /**< PXE status code */
1470         /** Current state of the UNDI driver
1471          *
1472          * Valid values are #PXE_UNDI_GET_STATE_STARTED,
1473          * #PXE_UNDI_GET_STATE_INITIALIZED or
1474          * #PXE_UNDI_GET_STATE_OPENED.
1475          */
1476         UINT8_t UNDIstate;
1477 } PACKED;
1478
1479 typedef struct s_PXENV_UNDI_GET_STATE PXENV_UNDI_GET_STATE_t;
1480
1481 extern PXENV_EXIT_t pxenv_undi_get_state ( struct s_PXENV_UNDI_GET_STATE
1482                                            *undi_get_state );
1483
1484 /** @} */ /* pxenv_undi_get_state */
1485
1486 /** @defgroup pxenv_undi_isr PXENV_UNDI_ISR
1487  *
1488  *  UNDI ISR
1489  *
1490  *  @{
1491  */
1492
1493 /** PXE API function code for pxenv_undi_isr() */
1494 #define PXENV_UNDI_ISR                  0x0014
1495
1496 /** Determine whether or not this is our interrupt */
1497 #define PXENV_UNDI_ISR_IN_START         1
1498 /** Start processing interrupt */
1499 #define PXENV_UNDI_ISR_IN_PROCESS       2
1500 /** Continue processing interrupt */
1501 #define PXENV_UNDI_ISR_IN_GET_NEXT      3
1502 /** This interrupt was ours */
1503 #define PXENV_UNDI_ISR_OUT_OURS         0
1504 /** This interrupt was not ours */
1505 #define PXENV_UNDI_ISR_OUT_NOT_OURS     1
1506 /** Finished processing interrupt */
1507 #define PXENV_UNDI_ISR_OUT_DONE         0
1508 /** A packet transmission has completed */
1509 #define PXENV_UNDI_ISR_OUT_TRANSMIT     2
1510 /** A packet has been received */
1511 #define PXENV_UNDI_ISR_OUT_RECEIVE      3
1512 /** We are already in the middle of processing an interrupt */
1513 #define PXENV_UNDI_ISR_OUT_BUSY         4
1514
1515 /** Unicast packet (or packet captured in promiscuous mode) */
1516 #define P_DIRECTED      0
1517 /** Broadcast packet */
1518 #define P_BROADCAST     1
1519 /** Multicast packet */
1520 #define P_MULTICAST     2
1521
1522 /** Parameter block for pxenv_undi_isr() */
1523 struct s_PXENV_UNDI_ISR {
1524         PXENV_STATUS_t  Status;         /**< PXE status code */
1525         /** Function flag
1526          *
1527          * Valid values are #PXENV_UNDI_ISR_IN_START,
1528          * #PXENV_UNDI_ISR_IN_PROCESS, #PXENV_UNDI_ISR_IN_GET_NEXT,
1529          * #PXENV_UNDI_ISR_OUT_OURS, #PXENV_UNDI_ISR_OUT_NOT_OURS,
1530          * #PXENV_UNDI_ISR_OUT_DONE, #PXENV_UNDI_ISR_OUT_TRANSMIT,
1531          * #PXENV_UNDI_ISR_OUT_RECEIVE or #PXENV_UNDI_ISR_OUT_BUSY.
1532          */
1533         UINT16_t FuncFlag;
1534         UINT16_t BufferLength;          /**< Data buffer length */
1535         UINT16_t FrameLength;           /**< Total frame length */
1536         UINT16_t FrameHeaderLength;     /**< Frame header length */
1537         SEGOFF16_t Frame;               /**< Data buffer address */
1538         /** Protocol type
1539          *
1540          * Valid values are #P_IP, #P_ARP, #P_RARP or #P_OTHER.
1541          */
1542         UINT8_t ProtType;
1543         /** Packet type
1544          *
1545          * Valid values are #P_DIRECTED, #P_BROADCAST or #P_MULTICAST.
1546          */
1547         UINT8_t PktType;
1548 } PACKED;
1549
1550 typedef struct s_PXENV_UNDI_ISR PXENV_UNDI_ISR_t;
1551
1552 extern PXENV_EXIT_t pxenv_undi_isr ( struct s_PXENV_UNDI_ISR *undi_isr );
1553
1554 /** @} */ /* pxenv_undi_isr */
1555
1556 /** @} */ /* pxe_undi_api */
1557
1558 /** @defgroup pxe_file_api PXE FILE API
1559  *
1560  * POSIX-like file operations
1561  *
1562  * @{
1563  */
1564
1565 /** @defgroup pxenv_file_open PXENV_FILE_OPEN
1566  *
1567  * FILE OPEN
1568  *
1569  * @{
1570  */
1571
1572 /** PXE API function code for pxenv_file_open() */
1573 #define PXENV_FILE_OPEN                 0x00e0
1574
1575 /** Parameter block for pxenv_file_open() */
1576 struct s_PXENV_FILE_OPEN {
1577         PXENV_STATUS_t Status;          /**< PXE status code */
1578         UINT16_t FileHandle;            /**< File handle */
1579         SEGOFF16_t FileName;            /**< File URL */
1580         UINT32_t Reserved;              /**< Reserved */
1581 } PACKED;
1582
1583 typedef struct s_PXENV_FILE_OPEN PXENV_FILE_OPEN_t;
1584
1585 extern PXENV_EXIT_t pxenv_file_open ( struct s_PXENV_FILE_OPEN *file_open );
1586
1587 /** @} */ /* pxenv_file_open */
1588
1589 /** @defgroup pxenv_file_close PXENV_FILE_CLOSE
1590  *
1591  * FILE CLOSE
1592  *
1593  * @{
1594  */
1595
1596 /** PXE API function code for pxenv_file_close() */
1597 #define PXENV_FILE_CLOSE                0x00e1
1598
1599 /** Parameter block for pxenv_file_close() */
1600 struct s_PXENV_FILE_CLOSE {
1601         PXENV_STATUS_t Status;          /**< PXE status code */
1602         UINT16_t FileHandle;            /**< File handle */
1603 } PACKED;
1604
1605 typedef struct s_PXENV_FILE_CLOSE PXENV_FILE_CLOSE_t;
1606
1607 extern PXENV_EXIT_t pxenv_file_close ( struct s_PXENV_FILE_CLOSE
1608                                        *file_close );
1609
1610 /** @} */ /* pxenv_file_close */
1611
1612 /** @defgroup pxenv_file_select PXENV_FILE_SELECT
1613  *
1614  * FILE SELECT
1615  *
1616  * @{
1617  */
1618
1619 /** PXE API function code for pxenv_file_select() */
1620 #define PXENV_FILE_SELECT               0x00e2
1621
1622 /** File is ready for reading */
1623 #define RDY_READ                        0x0001
1624
1625 /** Parameter block for pxenv_file_select() */
1626 struct s_PXENV_FILE_SELECT {
1627         PXENV_STATUS_t Status;          /**< PXE status code */
1628         UINT16_t FileHandle;            /**< File handle */
1629         UINT16_t Ready;                 /**< Indication of readiness */
1630 } PACKED;
1631
1632 typedef struct s_PXENV_FILE_SELECT PXENV_FILE_SELECT_t;
1633
1634 extern PXENV_EXIT_t pxenv_file_select ( struct s_PXENV_FILE_SELECT
1635                                         *file_select );
1636
1637 /** @} */ /* pxenv_file_select */
1638
1639 /** @defgroup pxenv_file_read PXENV_FILE_READ
1640  *
1641  * FILE READ
1642  *
1643  * @{
1644  */
1645
1646 /** PXE API function code for pxenv_file_read() */
1647 #define PXENV_FILE_READ         0x00e3
1648
1649 /** Parameter block for pxenv_file_read() */
1650 struct s_PXENV_FILE_READ {
1651         PXENV_STATUS_t Status;          /**< PXE status code */
1652         UINT16_t FileHandle;            /**< File handle */
1653         UINT16_t BufferSize;            /**< Data buffer size */
1654         SEGOFF16_t Buffer;              /**< Data buffer */
1655 } PACKED;
1656
1657 typedef struct s_PXENV_FILE_READ PXENV_FILE_READ_t;
1658
1659 extern PXENV_EXIT_t pxenv_file_read ( struct s_PXENV_FILE_READ *file_read );
1660
1661 /** @} */ /* pxenv_file_read */
1662
1663 /** @defgroup pxenv_get_file_size PXENV_GET_FILE_SIZE
1664  *
1665  * GET FILE SIZE
1666  *
1667  * @{
1668  */
1669
1670 /** PXE API function code for pxenv_get_file_size() */
1671 #define PXENV_GET_FILE_SIZE             0x00e4
1672
1673 /** Parameter block for pxenv_get_file_size() */
1674 struct s_PXENV_GET_FILE_SIZE {
1675         PXENV_STATUS_t Status;          /**< PXE status code */
1676         UINT16_t FileHandle;            /**< File handle */
1677         UINT32_t FileSize;              /**< File size */
1678 } PACKED;
1679
1680 typedef struct s_PXENV_GET_FILE_SIZE PXENV_GET_FILE_SIZE_t;
1681
1682 extern PXENV_EXIT_t pxenv_get_file_size ( struct s_PXENV_GET_FILE_SIZE
1683                                           *get_file_size );
1684
1685 /** @} */ /* pxenv_get_file_size */
1686
1687 /** @} */ /* pxe_file_api */
1688
1689 /** @defgroup pxe_loader_api PXE Loader API
1690  *
1691  * The UNDI ROM loader API
1692  *
1693  * @{
1694  */
1695
1696 /** Parameter block for undi_loader() */
1697 struct s_UNDI_LOADER {
1698         /** PXE status code */
1699         PXENV_STATUS_t Status;
1700         /** %ax register as for PXENV_START_UNDI */
1701         UINT16_t AX;
1702         /** %bx register as for PXENV_START_UNDI */
1703         UINT16_t BX;
1704         /** %dx register as for PXENV_START_UNDI */
1705         UINT16_t DX;
1706         /** %di register as for PXENV_START_UNDI */
1707         OFF16_t DI;
1708         /** %es register as for PXENV_START_UNDI */
1709         SEGSEL_t ES;
1710         /** UNDI data segment
1711          *
1712          * @note The PXE specification defines the type of this field
1713          * as #UINT16_t.  For x86, #SEGSEL_t and #UINT16_t are
1714          * equivalent anyway; for other architectures #SEGSEL_t makes
1715          * more sense.
1716          */
1717         SEGSEL_t UNDI_DS;
1718         /** UNDI code segment
1719          *
1720          * @note The PXE specification defines the type of this field
1721          * as #UINT16_t.  For x86, #SEGSEL_t and #UINT16_t are
1722          * equivalent anyway; for other architectures #SEGSEL_t makes
1723          * more sense.
1724          */
1725         SEGSEL_t UNDI_CS;
1726         /** Address of the !PXE structure (a struct s_PXE) */
1727         SEGOFF16_t PXEptr;
1728         /** Address of the PXENV+ structure (a struct s_PXENV) */
1729         SEGOFF16_t PXENVptr;
1730 } PACKED;
1731
1732 typedef struct s_UNDI_LOADER UNDI_LOADER_t;
1733
1734 extern PXENV_EXIT_t undi_loader ( struct s_UNDI_LOADER *undi_loader );
1735
1736 /** @} */ /* pxe_loader_api */
1737
1738 /** @} */ /* pxe */
1739
1740 /** @page pxe_notes Etherboot PXE implementation notes
1741
1742 @section pxe_routing IP routing
1743
1744 Several PXE API calls (e.g. pxenv_tftp_open() and pxenv_udp_write())
1745 allow for the caller to specify a "relay agent IP address", often in a
1746 field called "gateway" or similar.  The PXE specification states that
1747 "The IP layer should provide space for a minimum of four routing
1748 entries obtained from the default router and static route DHCP option
1749 tags in the DHCPACK message, plus any non-zero giaddr field from the
1750 DHCPOFFER message(s) accepted by the client".
1751
1752 The DHCP static route option ("option static-routes" in dhcpd.conf)
1753 works only for classed IP routing (i.e. it provides no way to specify
1754 a subnet mask).  Since virtually everything now uses classless IP
1755 routing, the DHCP static route option is almost totally useless, and
1756 is (according to the dhcp-options man page) not implemented by any of
1757 the popular DHCP clients.
1758
1759 This leaves the caller-specified "relay agent IP address", the giaddr
1760 field from the DHCPOFFER message(s) and the default gateway(s)
1761 provided via the routers option ("option routers" in dhcpd.conf) in
1762 the DHCPACK message.  Each of these is a default gateway address.
1763 It's a fair bet that the routers option should take priority over the
1764 giaddr field, since the routers option has to be explicitly specified
1765 by the DHCP server operator.  Similarly, it's fair to assume that the
1766 caller-specified "relay agent IP address", if present, should take
1767 priority over any other routing table entries.
1768
1769 @bug Etherboot currently ignores all potential sources of routing
1770 information other than the first router provided to it by a DHCP
1771 routers option.
1772
1773 @section pxe_x86_modes x86 processor mode restrictions
1774
1775 On the x86 platform, different PXE API calls have different
1776 restrictions on the processor modes (real or protected) that can be
1777 used.  See the individual API call descriptions for the restrictions
1778 that apply to any particular call.
1779
1780 @subsection pxe_x86_pmode16 Real mode, or protected-mode with 16-bit stack
1781
1782 The PXE specification states that the API function can be called in
1783 protected mode only if the s_PXE::StatusCallout field is set to a
1784 non-zero value, and that the API function cannot be called with a
1785 32-bit stack segment.
1786
1787 Etherboot does not enforce either of these restrictions; they seem (as
1788 with so much of the PXE specification) to be artifacts of the Intel
1789 implementation.
1790
1791 */
1792
1793 #endif /* PXE_API_H */