4 FILE_LICENCE ( GPL2_OR_LATER );
8 #include <gpxe/device.h>
10 /* Parameter block for pxenv_unknown() */
11 struct s_PXENV_UNKNOWN {
12 PXENV_STATUS_t Status; /**< PXE status code */
15 typedef struct s_PXENV_UNKNOWN PXENV_UNKNOWN_t;
17 /* Union used for PXE API calls; we don't know the type of the
18 * structure until we interpret the opcode. Also, Status is available
19 * in the same location for any opcode, and it's convenient to have
20 * non-specific access to it.
23 /* Make it easy to read status for any operation */
24 PXENV_STATUS_t Status;
25 struct s_PXENV_UNKNOWN unknown;
26 struct s_PXENV_UNLOAD_STACK unload_stack;
27 struct s_PXENV_GET_CACHED_INFO get_cached_info;
28 struct s_PXENV_TFTP_READ_FILE restart_tftp;
29 struct s_PXENV_START_UNDI start_undi;
30 struct s_PXENV_STOP_UNDI stop_undi;
31 struct s_PXENV_START_BASE start_base;
32 struct s_PXENV_STOP_BASE stop_base;
33 struct s_PXENV_TFTP_OPEN tftp_open;
34 struct s_PXENV_TFTP_CLOSE tftp_close;
35 struct s_PXENV_TFTP_READ tftp_read;
36 struct s_PXENV_TFTP_READ_FILE tftp_read_file;
37 struct s_PXENV_TFTP_GET_FSIZE tftp_get_fsize;
38 struct s_PXENV_UDP_OPEN udp_open;
39 struct s_PXENV_UDP_CLOSE udp_close;
40 struct s_PXENV_UDP_WRITE udp_write;
41 struct s_PXENV_UDP_READ udp_read;
42 struct s_PXENV_UNDI_STARTUP undi_startup;
43 struct s_PXENV_UNDI_CLEANUP undi_cleanup;
44 struct s_PXENV_UNDI_INITIALIZE undi_initialize;
45 struct s_PXENV_UNDI_RESET undi_reset_adapter;
46 struct s_PXENV_UNDI_SHUTDOWN undi_shutdown;
47 struct s_PXENV_UNDI_OPEN undi_open;
48 struct s_PXENV_UNDI_CLOSE undi_close;
49 struct s_PXENV_UNDI_TRANSMIT undi_transmit;
50 struct s_PXENV_UNDI_SET_MCAST_ADDRESS undi_set_mcast_address;
51 struct s_PXENV_UNDI_SET_STATION_ADDRESS undi_set_station_address;
52 struct s_PXENV_UNDI_SET_PACKET_FILTER undi_set_packet_filter;
53 struct s_PXENV_UNDI_GET_INFORMATION undi_get_information;
54 struct s_PXENV_UNDI_GET_STATISTICS undi_get_statistics;
55 struct s_PXENV_UNDI_CLEAR_STATISTICS undi_clear_statistics;
56 struct s_PXENV_UNDI_INITIATE_DIAGS undi_initiate_diags;
57 struct s_PXENV_UNDI_FORCE_INTERRUPT undi_force_interrupt;
58 struct s_PXENV_UNDI_GET_MCAST_ADDRESS undi_get_mcast_address;
59 struct s_PXENV_UNDI_GET_NIC_TYPE undi_get_nic_type;
60 struct s_PXENV_UNDI_GET_IFACE_INFO undi_get_iface_info;
61 struct s_PXENV_UNDI_GET_STATE undi_get_state;
62 struct s_PXENV_UNDI_ISR undi_isr;
63 struct s_PXENV_FILE_OPEN file_open;
64 struct s_PXENV_FILE_CLOSE file_close;
65 struct s_PXENV_FILE_SELECT file_select;
66 struct s_PXENV_FILE_READ file_read;
67 struct s_PXENV_GET_FILE_SIZE get_file_size;
68 struct s_PXENV_FILE_EXEC file_exec;
69 struct s_PXENV_FILE_API_CHECK file_api_check;
72 typedef union u_PXENV_ANY PXENV_ANY_t;
74 /** An UNDI expansion ROM header */
75 struct undi_rom_header {
78 * Must be equal to @c ROM_SIGNATURE
81 /** ROM length in 512-byte blocks */
85 /** Offset of the PXE ROM ID structure */
87 /** Offset of the PCI ROM structure */
91 /** Signature for an expansion ROM */
92 #define ROM_SIGNATURE 0xaa55
94 /** An UNDI ROM ID structure */
98 * Must be equal to @c UNDI_ROM_ID_SIGNATURE
101 /** Length of structure */
102 UINT8_t StructLength;
105 /** Structure revision
112 * Version 2.1.0 is encoded as the byte sequence 0x00, 0x01, 0x02.
115 /** Offset to UNDI loader */
117 /** Minimum required stack segment size */
119 /** Minimum required data segment size */
121 /** Minimum required code segment size */
125 /** Signature for an UNDI ROM ID structure */
126 #define UNDI_ROM_ID_SIGNATURE \
127 ( ( 'U' << 0 ) + ( 'N' << 8 ) + ( 'D' << 16 ) + ( 'I' << 24 ) )
129 /** A PCI expansion header */
133 * Must be equal to @c PCIR_SIGNATURE
142 /** Signature for an UNDI ROM ID structure */
143 #define PCIR_SIGNATURE \
144 ( ( 'P' << 0 ) + ( 'C' << 8 ) + ( 'I' << 16 ) + ( 'R' << 24 ) )
147 extern struct net_device *pxe_netdev;
149 extern void pxe_set_netdev ( struct net_device *netdev );
151 extern void pxe_set_cached_filename ( const unsigned char *filename );