Add PXE FILE API.
[people/indolent/gpxe.git/.git] / src / include / pxe.h
1 #ifndef PXE_H
2 #define PXE_H
3
4 #include "pxe_types.h"
5 #include "pxe_api.h"
6 #include <gpxe/device.h>
7
8 /* Parameter block for pxenv_unknown() */
9 struct s_PXENV_UNKNOWN {
10         PXENV_STATUS_t Status;                  /**< PXE status code */
11 } PACKED;
12
13 typedef struct s_PXENV_UNKNOWN PXENV_UNKNOWN_t;
14
15 /* Union used for PXE API calls; we don't know the type of the
16  * structure until we interpret the opcode.  Also, Status is available
17  * in the same location for any opcode, and it's convenient to have
18  * non-specific access to it.
19  */
20 union u_PXENV_ANY {
21         /* Make it easy to read status for any operation */
22         PXENV_STATUS_t                          Status;
23         struct s_PXENV_UNKNOWN                  unknown;
24         struct s_PXENV_UNLOAD_STACK             unload_stack;
25         struct s_PXENV_GET_CACHED_INFO          get_cached_info;
26         struct s_PXENV_TFTP_READ_FILE           restart_tftp;
27         struct s_PXENV_START_UNDI               start_undi;
28         struct s_PXENV_STOP_UNDI                stop_undi;
29         struct s_PXENV_START_BASE               start_base;
30         struct s_PXENV_STOP_BASE                stop_base;
31         struct s_PXENV_TFTP_OPEN                tftp_open;
32         struct s_PXENV_TFTP_CLOSE               tftp_close;
33         struct s_PXENV_TFTP_READ                tftp_read;
34         struct s_PXENV_TFTP_READ_FILE           tftp_read_file;
35         struct s_PXENV_TFTP_GET_FSIZE           tftp_get_fsize;
36         struct s_PXENV_UDP_OPEN                 udp_open;
37         struct s_PXENV_UDP_CLOSE                udp_close;
38         struct s_PXENV_UDP_WRITE                udp_write;
39         struct s_PXENV_UDP_READ                 udp_read;
40         struct s_PXENV_UNDI_STARTUP             undi_startup;
41         struct s_PXENV_UNDI_CLEANUP             undi_cleanup;
42         struct s_PXENV_UNDI_INITIALIZE          undi_initialize;
43         struct s_PXENV_UNDI_RESET               undi_reset_adapter;
44         struct s_PXENV_UNDI_SHUTDOWN            undi_shutdown;
45         struct s_PXENV_UNDI_OPEN                undi_open;
46         struct s_PXENV_UNDI_CLOSE               undi_close;
47         struct s_PXENV_UNDI_TRANSMIT            undi_transmit;
48         struct s_PXENV_UNDI_SET_MCAST_ADDRESS   undi_set_mcast_address;
49         struct s_PXENV_UNDI_SET_STATION_ADDRESS undi_set_station_address;
50         struct s_PXENV_UNDI_SET_PACKET_FILTER   undi_set_packet_filter;
51         struct s_PXENV_UNDI_GET_INFORMATION     undi_get_information;
52         struct s_PXENV_UNDI_GET_STATISTICS      undi_get_statistics;
53         struct s_PXENV_UNDI_CLEAR_STATISTICS    undi_clear_statistics;
54         struct s_PXENV_UNDI_INITIATE_DIAGS      undi_initiate_diags;
55         struct s_PXENV_UNDI_FORCE_INTERRUPT     undi_force_interrupt;
56         struct s_PXENV_UNDI_GET_MCAST_ADDRESS   undi_get_mcast_address;
57         struct s_PXENV_UNDI_GET_NIC_TYPE        undi_get_nic_type;
58         struct s_PXENV_UNDI_GET_IFACE_INFO      undi_get_iface_info;
59         struct s_PXENV_UNDI_GET_STATE           undi_get_state;
60         struct s_PXENV_UNDI_ISR                 undi_isr;
61         struct s_PXENV_FILE_OPEN                file_open;
62         struct s_PXENV_FILE_CLOSE               file_close;
63         struct s_PXENV_FILE_SELECT              file_select;
64         struct s_PXENV_FILE_READ                file_read;
65         struct s_PXENV_GET_FILE_SIZE            get_file_size;
66 };
67
68 typedef union u_PXENV_ANY PXENV_ANY_t;
69
70 /** An UNDI expansion ROM header */
71 struct undi_rom_header {
72         /** Signature
73          *
74          * Must be equal to @c ROM_SIGNATURE
75          */
76         UINT16_t Signature;
77         /** ROM length in 512-byte blocks */
78         UINT8_t ROMLength;
79         /** Unused */
80         UINT8_t unused[0x13];
81         /** Offset of the PXE ROM ID structure */
82         UINT16_t PXEROMID;
83         /** Offset of the PCI ROM structure */
84         UINT16_t PCIRHeader;
85 } PACKED;
86
87 /** Signature for an expansion ROM */
88 #define ROM_SIGNATURE 0xaa55
89
90 /** An UNDI ROM ID structure */
91 struct undi_rom_id {
92         /** Signature
93          *
94          * Must be equal to @c UNDI_ROM_ID_SIGNATURE
95          */
96         UINT32_t Signature;
97         /** Length of structure */
98         UINT8_t StructLength;
99         /** Checksum */
100         UINT8_t StructCksum;
101         /** Structure revision
102          *
103          * Must be zero.
104          */
105         UINT8_t StructRev;
106         /** UNDI revision
107          *
108          * Version 2.1.0 is encoded as the byte sequence 0x00, 0x01, 0x02.
109          */
110         UINT8_t UNDIRev[3];
111         /** Offset to UNDI loader */
112         UINT16_t UNDILoader;
113         /** Minimum required stack segment size */
114         UINT16_t StackSize;
115         /** Minimum required data segment size */
116         UINT16_t DataSize;
117         /** Minimum required code segment size */
118         UINT16_t CodeSize;
119 } PACKED;
120
121 /** Signature for an UNDI ROM ID structure */
122 #define UNDI_ROM_ID_SIGNATURE \
123         ( ( 'U' << 0 ) + ( 'N' << 8 ) + ( 'D' << 16 ) + ( 'I' << 24 ) )
124
125 /** A PCI expansion header */
126 struct pcir_header {
127         /** Signature
128          *
129          * Must be equal to @c PCIR_SIGNATURE
130          */
131         uint32_t signature;
132         /** PCI vendor ID */
133         uint16_t vendor_id;
134         /** PCI device ID */
135         uint16_t device_id;
136 } PACKED;
137
138 /** Signature for an UNDI ROM ID structure */
139 #define PCIR_SIGNATURE \
140         ( ( 'P' << 0 ) + ( 'C' << 8 ) + ( 'I' << 16 ) + ( 'R' << 24 ) )
141
142
143 extern struct net_device *pxe_netdev;
144
145 extern void pxe_set_netdev ( struct net_device *netdev );
146
147 #endif /* PXE_H */