2 * Copyright (c) 2000 Alfred Perlstein <alfred@freebsd.org>
4 * Copyright (c) 2000 Paul Saab <ps@freebsd.org>
6 * Copyright (c) 2000 John Baldwin <jhb@freebsd.org>
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * The typedefs and structures declared in this file
35 * clearly violate style(9), the reason for this is to conform to the
36 * typedefs/structure-names used in the Intel literature to avoid confusion.
38 * It's for your own good. :)
41 /* It seems that intel didn't think about ABI,
42 * either that or 16bit ABI != 32bit ABI (which seems reasonable)
43 * I have to thank Intel for the hair loss I incurred trying to figure
44 * out why PXE was mis-reading structures I was passing it (at least
45 * from my point of view)
47 * Solution: use gcc's '__packed' to correctly align
48 * structures passed into PXE
49 * Question: does this really work for PXE's expected ABI?
51 #define PACKED __packed
53 #define S_SIZE(s) s, sizeof(s) - 1
55 #define PXENFSROOTPATH "/pxeroot"
68 typedef uint16_t SEGSEL_t;
69 typedef uint16_t PXENV_STATUS_t;
70 typedef uint32_t IP4_t;
71 typedef uint32_t ADDR32_t;
72 typedef uint16_t UDP_PORT_t;
74 #define MAC_ADDR_LEN 16
75 typedef uint8_t MAC_ADDR[MAC_ADDR_LEN];
79 uint8_t Signature[6]; /* 'PXENV+' */
80 uint16_t Version; /* MSB = major, LSB = minor */
81 uint8_t Length; /* structure length */
82 uint8_t Checksum; /* checksum pad */
83 SEGOFF16_t RMEntry; /* SEG:OFF to PXE entry point */
84 /* don't use PMOffset and PMSelector (from the 2.1 PXE manual) */
85 uint32_t PMOffset; /* Protected mode entry */
86 SEGSEL_t PMSelector; /* Protected mode selector */
87 SEGSEL_t StackSeg; /* Stack segment address */
88 uint16_t StackSize; /* Stack segment size (bytes) */
89 SEGSEL_t BC_CodeSeg; /* BC Code segment address */
90 uint16_t BC_CodeSize; /* BC Code segment size (bytes) */
91 SEGSEL_t BC_DataSeg; /* BC Data segment address */
92 uint16_t BC_DataSize; /* BC Data segment size (bytes) */
93 SEGSEL_t UNDIDataSeg; /* UNDI Data segment address */
94 uint16_t UNDIDataSize; /* UNDI Data segment size (bytes) */
95 SEGSEL_t UNDICodeSeg; /* UNDI Code segment address */
96 uint16_t UNDICodeSize; /* UNDI Code segment size (bytes) */
97 SEGOFF16_t PXEPtr; /* SEG:OFF to !PXE struct,
98 only present when Version > 2.1 */
103 uint8_t Signature[4];
104 uint8_t StructLength;
108 SEGOFF16_t UNDIROMID;
109 SEGOFF16_t BaseROMID;
110 SEGOFF16_t EntryPointSP;
111 SEGOFF16_t EntryPointESP;
112 SEGOFF16_t StatusCallout;
115 SEGSEL_t FirstSelector;
119 SEGDESC_t UNDICodeWrite;
122 SEGDESC_t BC_CodeWrite;
125 #define PXENV_START_UNDI 0x0000
127 PXENV_STATUS_t Status;
133 } PACKED t_PXENV_START_UNDI;
135 #define PXENV_UNDI_STARTUP 0x0001
137 PXENV_STATUS_t Status;
138 } PACKED t_PXENV_UNDI_STARTUP;
140 #define PXENV_UNDI_CLEANUP 0x0002
142 PXENV_STATUS_t Status;
143 } PACKED t_PXENV_UNDI_CLEANUP;
145 #define PXENV_UNDI_INITIALIZE 0x0003
147 PXENV_STATUS_t Status;
148 ADDR32_t ProtocolIni; /* Phys addr of a copy of the driver module */
150 } PACKED t_PXENV_UNDI_INITALIZE;
153 #define MAXNUM_MCADDR 8
155 PXENV_STATUS_t Status;
156 uint16_t MCastAddrCount;
157 MAC_ADDR McastAddr[MAXNUM_MCADDR];
158 } PACKED t_PXENV_UNDI_MCAST_ADDRESS;
160 #define PXENV_UNDI_RESET_ADAPTER 0x0004
162 PXENV_STATUS_t Status;
163 t_PXENV_UNDI_MCAST_ADDRESS R_Mcast_Buf;
164 } PACKED t_PXENV_UNDI_RESET;
166 #define PXENV_UNDI_SHUTDOWN 0x0005
168 PXENV_STATUS_t Status;
169 } PACKED t_PXENV_UNDI_SHUTDOWN;
171 #define PXENV_UNDI_OPEN 0x0006
173 PXENV_STATUS_t Status;
176 # define FLTR_DIRECTED 0x0001
177 # define FLTR_BRDCST 0x0002
178 # define FLTR_PRMSCS 0x0003
179 # define FLTR_SRC_RTG 0x0004
181 t_PXENV_UNDI_MCAST_ADDRESS R_Mcast_Buf;
182 } PACKED t_PXENV_UNDI_OPEN;
184 #define PXENV_UNDI_CLOSE 0x0007
186 PXENV_STATUS_t Status;
187 } PACKED t_PXENV_UNDI_CLOSE;
189 #define PXENV_UNDI_TRANSMIT 0x0008
191 PXENV_STATUS_t Status;
199 # define XMT_DESTADDR 0x0000
200 # define XMT_BROADCAST 0x0001
204 uint32_t Reserved[2];
205 } PACKED t_PXENV_UNDI_TRANSMIT;
207 #define MAX_DATA_BLKS 8
209 uint16_t ImmedLength;
211 uint16_t DataBlkCount;
216 SEGOFF16_t TDDataPtr;
217 } DataBlock[MAX_DATA_BLKS];
218 } PACKED t_PXENV_UNDI_TBD;
220 #define PXENV_UNDI_SET_MCAST_ADDRESS 0x0009
222 PXENV_STATUS_t Status;
223 t_PXENV_UNDI_MCAST_ADDRESS R_Mcast_Buf;
224 } PACKED t_PXENV_UNDI_SET_MCAST_ADDR;
226 #define PXENV_UNDI_SET_STATION_ADDRESS 0x000A
228 PXENV_STATUS_t Status;
229 MAC_ADDR StationAddress; /* Temp MAC addres to use */
230 } PACKED t_PXENV_UNDI_SET_STATION_ADDR;
232 #define PXENV_UNDI_SET_PACKET_FILTER 0x000B
234 PXENV_STATUS_t Status;
235 uint8_t filter; /* see UNDI_OPEN (0x0006) */
236 } PACKED t_PXENV_UNDI_SET_PACKET_FILTER;
238 #define PXENV_UNDI_GET_INFORMATION 0x000C
240 PXENV_STATUS_t Status;
241 uint16_t BaseIo; /* Adapter base I/O address */
242 uint16_t IntNumber; /* Adapter IRQ number */
243 uint16_t MaxTranUnit; /* Adapter maximum transmit unit */
244 uint16_t HwType; /* Type of protocol at the hardware addr */
245 # define ETHER_TYPE 1
246 # define EXP_ETHER_TYPE 2
248 # define ARCNET_TYPE 7
250 uint16_t HwAddrLen; /* Length of hardware address */
251 MAC_ADDR CurrentNodeAddress; /* Current hardware address */
252 MAC_ADDR PermNodeAddress; /* Permanent hardware address */
253 SEGSEL_t ROMAddress; /* Real mode ROM segment address */
254 uint16_t RxBufCt; /* Receive queue length */
255 uint16_t TxBufCt; /* Transmit queue length */
256 } PACKED t_PXENV_UNDI_GET_INFORMATION;
258 #define PXENV_UNDI_GET_STATISTICS 0x000D
260 PXENV_STATUS_t Status;
261 uint32_t XmitGoodFrames; /* Number of successful transmissions */
262 uint32_t RcvGoodFrames; /* Number of good frames received */
263 uint32_t RcvCRCErrors; /* Number of frames with CRC errors */
264 uint32_t RcvResourceErrors; /* Number of frames dropped */
265 } PACKED t_PXENV_UNDI_GET_STATISTICS;
267 #define PXENV_UNDI_CLEAR_STATISTICS 0x000E
269 PXENV_STATUS_t Status;
270 } PACKED t_PXENV_UNDI_CLEAR_STATISTICS;
272 #define PXENV_UNDI_INITIATE_DIAGS 0x000F
274 PXENV_STATUS_t Status;
275 } PACKED t_PXENV_UNDI_INITIATE_DIAGS;
277 #define PXENV_UNDI_FORCE_INTERRUPT 0x0010
279 PXENV_STATUS_t Status;
280 } PACKED t_PXENV_UNDI_FORCE_INTERRUPT;
282 #define PXENV_UNDI_GET_MCAST_ADDRESS 0x0011
284 PXENV_STATUS_t Status;
285 IP4_t InetAddr; /* IP mulicast address */
286 MAC_ADDR MediaAddr; /* MAC multicast address */
287 } PACKED t_PXENV_UNDI_GET_MCAST_ADDR;
289 #define PXENV_UNDI_GET_NIC_TYPE 0x0012
291 PXENV_STATUS_t Status;
292 uint8_t NicType; /* Type of NIC */
295 # define CardBus_NIC 4
306 uint16_t SubVendor_ID;
307 uint16_t SubDevice_ID;
310 uint32_t EISA_Dev_ID;
317 } PACKED t_PXENV_UNDI_GET_NIC_TYPE;
319 #define PXENV_UNDI_GET_IFACE_INFO 0x0013
321 PXENV_STATUS_t Status;
322 uint8_t IfaceType[16]; /* Name of MAC type in ASCII. */
323 uint32_t LinkSpeed; /* Defined in NDIS 2.0 spec */
324 uint32_t ServiceFlags; /* Defined in NDIS 2.0 spec */
325 uint32_t Reserved[4]; /* must be 0 */
326 } PACKED t_PXENV_UNDI_GET_NDIS_INFO;
328 #define PXENV_UNDI_ISR 0x0014
330 PXENV_STATUS_t Status;
331 uint16_t FuncFlag; /* PXENV_UNDI_ISR_OUT_xxx */
332 uint16_t BufferLength; /* Length of Frame */
333 uint16_t FrameLength; /* Total length of reciever frame */
334 uint16_t FrameHeaderLength; /* Length of the media header in Frame */
335 SEGOFF16_t Frame; /* receive buffer */
336 uint8_t ProtType; /* Protocol type */
337 uint8_t PktType; /* Packet Type */
338 # define PXENV_UNDI_ISR_IN_START 1
339 # define PXENV_UNDI_ISR_IN_PROCESS 2
340 # define PXENV_UNDI_ISR_IN_GET_NEXT 3
342 /* one of these will be returned for PXENV_UNDI_ISR_IN_START */
343 # define PXENV_UNDI_ISR_OUT_OURS 0
344 # define PXENV_UNDI_ISR_OUT_NOT_OUTS 1
347 * one of these will bre returnd for PXEND_UNDI_ISR_IN_PROCESS
348 * and PXENV_UNDI_ISR_IN_GET_NEXT
350 # define PXENV_UNDI_ISR_OUT_DONE 0
351 # define PXENV_UNDI_ISR_OUT_TRANSMIT 2
352 # define PXENV_UNDI_ISR_OUT_RECIEVE 3
353 # define PXENV_UNDI_ISR_OUT_BUSY 4
354 } PACKED t_PXENV_UNDI_ISR;
356 #define PXENV_STOP_UNDI 0x0015
358 PXENV_STATUS_t Status;
359 } PACKED t_PXENV_STOP_UNDI;
361 #define PXENV_TFTP_OPEN 0x0020
363 PXENV_STATUS_t Status;
364 IP4_t ServerIPAddress;
365 IP4_t GatewayIPAddress;
366 uint8_t FileName[128];
369 } PACKED t_PXENV_TFTP_OPEN;
371 #define PXENV_TFTP_CLOSE 0x0021
373 PXENV_STATUS_t Status;
374 } PACKED t_PXENV_TFTP_CLOSE;
376 #define PXENV_TFTP_READ 0x0022
378 PXENV_STATUS_t Status;
379 uint16_t PacketNumber;
382 } PACKED t_PXENV_TFTP_READ;
384 #define PXENV_TFTP_READ_FILE 0x0023
386 PXENV_STATUS_t Status;
387 uint8_t FileName[128];
390 IP4_t ServerIPAddress;
391 IP4_t GatewayIPAdress;
393 UDP_PORT_t TFTPClntPort;
394 UDP_PORT_t TFTPSrvPort;
395 uint16_t TFTPOpenTimeOut;
396 uint16_t TFTPReopenDelay;
397 } PACKED t_PXENV_TFTP_READ_FILE;
399 #define PXENV_TFTP_GET_FSIZE 0x0025
401 PXENV_STATUS_t Status;
402 IP4_t ServerIPAddress;
403 IP4_t GatewayIPAdress;
404 uint8_t FileName[128];
406 } PACKED t_PXENV_TFTP_GET_FSIZE;
408 #define PXENV_UDP_OPEN 0x0030
410 PXENV_STATUS_t status;
411 IP4_t src_ip; /* IP address of this station */
412 } PACKED t_PXENV_UDP_OPEN;
414 #define PXENV_UDP_CLOSE 0x0031
416 PXENV_STATUS_t status;
417 } PACKED t_PXENV_UDP_CLOSE;
419 #define PXENV_UDP_READ 0x0032
421 PXENV_STATUS_t status;
422 IP4_t src_ip; /* IP of sender */
423 IP4_t dest_ip; /* Only accept packets sent to this IP */
424 UDP_PORT_t s_port; /* UDP source port of sender */
425 UDP_PORT_t d_port; /* Only accept packets sent to this port */
426 uint16_t buffer_size; /* Size of the packet buffer */
427 SEGOFF16_t buffer; /* SEG:OFF to the packet buffer */
428 } PACKED t_PXENV_UDP_READ;
430 #define PXENV_UDP_WRITE 0x0033
432 PXENV_STATUS_t status;
433 IP4_t ip; /* dest ip addr */
434 IP4_t gw; /* ip gateway */
435 UDP_PORT_t src_port; /* source udp port */
436 UDP_PORT_t dst_port; /* destination udp port */
437 uint16_t buffer_size; /* Size of the packet buffer */
438 SEGOFF16_t buffer; /* SEG:OFF to the packet buffer */
439 } PACKED t_PXENV_UDP_WRITE;
441 #define PXENV_UNLOAD_STACK 0x0070
443 PXENV_STATUS_t Status;
444 uint8_t reserved[10];
445 } PACKED t_PXENV_UNLOAD_STACK;
448 #define PXENV_GET_CACHED_INFO 0x0071
450 PXENV_STATUS_t Status;
451 uint16_t PacketType; /* type (defined right here) */
452 # define PXENV_PACKET_TYPE_DHCP_DISCOVER 1
453 # define PXENV_PACKET_TYPE_DHCP_ACK 2
454 # define PXENV_PACKET_TYPE_BINL_REPLY 3
455 uint16_t BufferSize; /* max to copy, leave at 0 for pointer */
456 SEGOFF16_t Buffer; /* copy to, leave at 0 for pointer */
457 uint16_t BufferLimit; /* max size of buffer in BC dataseg ? */
458 } PACKED t_PXENV_GET_CACHED_INFO;
461 /* structure filled in by PXENV_GET_CACHED_INFO
462 * (how we determine which IP we downloaded the initial bootstrap from)
463 * words can't describe...
469 uint8_t Hardware; /* hardware type */
470 uint8_t Hardlen; /* hardware addr len */
471 uint8_t Gatehops; /* zero it */
472 uint32_t ident; /* random number chosen by client */
473 uint16_t seconds; /* seconds since did initial bootstrap */
474 uint16_t Flags; /* seconds since did initial bootstrap */
475 # define BOOTP_BCAST 0x8000 /* ? */
476 IP4_t cip; /* Client IP */
477 IP4_t yip; /* Your IP */
478 IP4_t sip; /* IP to use for next boot stage */
479 IP4_t gip; /* Relay IP ? */
480 MAC_ADDR CAddr; /* Client hardware address */
481 uint8_t Sname[64]; /* Server's hostname (Optional) */
482 uint8_t bootfile[128]; /* boot filename */
485 # define BOOTP_DHCPVEND 1024 /* DHCP extended vendor field size */
487 # define BOOTP_DHCPVEND 312 /* DHCP standard vendor field size */
489 uint8_t d[BOOTP_DHCPVEND]; /* raw array of vendor/dhcp options */
491 uint8_t magic[4]; /* DHCP magic cookie */
493 # define VM_RFC1048 0x63825363L /* ? */
495 uint32_t flags; /* bootp flags/opcodes */
496 uint8_t pad[56]; /* I don't think intel knows what a
502 #define PXENV_RESTART_TFTP 0x0073
503 #define t_PXENV_RESTART_TFTP t_PXENV_TFTP_READ_FILE
505 #define PXENV_START_BASE 0x0075
507 PXENV_STATUS_t Status;
508 } PACKED t_PXENV_START_BASE;
510 #define PXENV_STOP_BASE 0x0076
512 PXENV_STATUS_t Status;
513 } PACKED t_PXENV_STOP_BASE;