9fdda657f10eeaa061e0c93558284bc2aed61d48
[people/lynusvaz/gpxe.git] / src / include / etherboot.h
1 #ifndef ETHERBOOT_H
2 #define ETHERBOOT_H
3
4 #include <stdarg.h>
5 #include "osdep.h"
6
7 #ifndef BOOT_FIRST
8 #define BOOT_FIRST      BOOT_NIC
9 #endif
10 #ifndef BOOT_SECOND
11 #define BOOT_SECOND     BOOT_NOTHING
12 #endif
13 #ifndef BOOT_THIRD
14 #define BOOT_THIRD      BOOT_NOTHING
15 #endif
16
17 #define DEFAULT_BOOT_ORDER ( \
18         (BOOT_FIRST   << (0*BOOT_BITS)) | \
19         (BOOT_SECOND  << (1*BOOT_BITS)) | \
20         (BOOT_THIRD   << (2*BOOT_BITS)) | \
21         (BOOT_NOTHING << (3*BOOT_BITS)) | \
22         0)
23
24 #ifdef BOOT_INDEX
25 #define DEFAULT_BOOT_INDEX BOOT_INDEX
26 #else
27 #define DEFAULT_BOOT_INDEX 0
28 #endif
29
30 #if     !defined(TAGGED_IMAGE) && !defined(AOUT_IMAGE) && !defined(ELF_IMAGE) && !defined(ELF64_IMAGE) && !defined(COFF_IMAGE) && !defined(RAW_IMAGE)
31 #define TAGGED_IMAGE            /* choose at least one */
32 #endif
33
34 #define K_ESC           '\033'
35 #define K_EOF           '\04'  /* Ctrl-D */
36 #define K_INTR          '\03'  /* Ctrl-C */
37
38 /*  Edit this to change the path to hostspecific kernel image
39     kernel.<client_ip_address> in RARP boot */
40 #ifndef DEFAULT_KERNELPATH
41 #define DEFAULT_KERNELPATH      "/tftpboot/kernel.%@"
42 #endif
43
44 #ifdef FREEBSD_PXEEMU
45 #undef DEFAULT_BOOTFILE
46 #ifndef PXENFSROOTPATH
47 #define PXENFSROOTPATH ""
48 #endif
49 #define DEFAULT_BOOTFILE        PXENFSROOTPATH "/boot/pxeboot"
50 #endif
51
52 #if     !defined(DOWNLOAD_PROTO_TFTP) && !defined(DOWNLOAD_PROTO_NFS) && !defined(DOWNLOAD_PROTO_SLAM) && !defined(DOWNLOAD_PROTO_TFTM) && !defined(DOWNLOAD_PROTO_DISK) && !defined(DOWNLOAD_PROTO_HTTP)
53 #error No download protocol defined!
54 #endif
55
56 #ifndef MAX_TFTP_RETRIES
57 #define MAX_TFTP_RETRIES        20
58 #endif
59
60 #ifndef MAX_BOOTP_RETRIES
61 #define MAX_BOOTP_RETRIES       20
62 #endif
63
64 #define MAX_BOOTP_EXTLEN        (ETH_MAX_MTU-sizeof(struct bootpip_t))
65
66 #ifndef MAX_ARP_RETRIES
67 #define MAX_ARP_RETRIES         20
68 #endif
69
70 #ifndef MAX_RPC_RETRIES
71 #define MAX_RPC_RETRIES         20
72 #endif
73
74 /* Link configuration time in tenths of a second */
75 #ifndef VALID_LINK_TIMEOUT
76 #define VALID_LINK_TIMEOUT      100 /* 10.0 seconds */
77 #endif
78
79 /* Inter-packet retry in ticks */
80 #ifndef TIMEOUT
81 #define TIMEOUT                 (10*TICKS_PER_SEC)
82 #endif
83
84 #ifndef BOOTP_TIMEOUT
85 #define BOOTP_TIMEOUT           (2*TICKS_PER_SEC)
86 #endif
87
88 /* Max interval between IGMP packets */
89 #define IGMP_INTERVAL                   (10*TICKS_PER_SEC)
90 #define IGMPv1_ROUTER_PRESENT_TIMEOUT   (400*TICKS_PER_SEC)
91
92 /* These settings have sense only if compiled with -DCONGESTED */
93 /* total retransmission timeout in ticks */
94 #define TFTP_TIMEOUT            (30*TICKS_PER_SEC)
95 /* packet retransmission timeout in ticks */
96 #ifdef CONGESTED
97 #define TFTP_REXMT              (3*TICKS_PER_SEC)
98 #else
99 #define TFTP_REXMT              TIMEOUT
100 #endif
101
102 #ifndef NULL
103 #define NULL    ((void *)0)
104 #endif
105
106 #include        "if_ether.h"
107
108 enum {
109         ARP_CLIENT, ARP_SERVER, ARP_GATEWAY,
110         ARP_NAMESERVER,
111 #ifdef PXE_EXPORT
112         ARP_PROXYDHCP,
113 #endif
114         MAX_ARP
115 };
116
117 #define IGMP_SERVER     0
118 #define MAX_IGMP        IGMP_SERVER+1
119
120 #define RARP_REQUEST    3
121 #define RARP_REPLY      4
122
123 #include        "in.h"
124
125 #define MULTICAST_MASK    0xF0000000
126 #define MULTICAST_NETWORK 0xE0000000
127
128 /* Helper macros used to identify when DHCP options are valid/invalid in/outside of encapsulation */
129 #define NON_ENCAP_OPT in_encapsulated_options == 0 &&
130 #ifdef ALLOW_ONLY_ENCAPSULATED
131 #define ENCAP_OPT in_encapsulated_options == 1 &&
132 #else
133 #define ENCAP_OPT
134 #endif
135
136 #include        "if_arp.h"
137 #include        "ip.h"
138 #include        "udp.h"
139 #include        "tcp.h"
140 #include        "bootp.h"
141 #include        "tftp.h"
142 #include        "igmp.h"
143 #include        "nfs.h"
144 #include        "console.h"
145 #include        "stdlib.h"
146
147 struct arptable_t {
148         struct in_addr ipaddr;
149         uint8_t node[6];
150 } PACKED;
151
152 struct igmptable_t {
153         in_addr group;
154         unsigned long time;
155 } PACKED;
156
157 #define KERNEL_BUF      (BOOTP_DATA_ADDR->bootp_reply.bp_file)
158
159 #define FLOPPY_BOOT_LOCATION    0x7c00
160
161 struct rom_info {
162         unsigned short  rom_segment;
163         unsigned short  rom_length;
164 };
165
166 extern inline int rom_address_ok(struct rom_info *rom, int assigned_rom_segment)
167 {
168         return (assigned_rom_segment < 0xC000
169                 || assigned_rom_segment == rom->rom_segment);
170 }
171
172 /* Define a type for passing info to a loaded program */
173 struct ebinfo {
174         uint8_t  major, minor;  /* Version */
175         uint16_t flags;         /* Bit flags */
176 };
177
178 /***************************************************************************
179 External prototypes
180 ***************************************************************************/
181 /* main.c */
182 struct Elf_Bhdr;
183 extern int main();
184 extern char as_main_program;
185 /* nic.c */
186 extern void rx_qdrain P((void));
187 extern int ip_transmit P((int len, const void *buf));
188 extern void build_ip_hdr P((unsigned long destip, int ttl, int protocol, 
189         int option_len, int len, const void *buf));
190 extern void build_udp_hdr P((unsigned long destip, 
191         unsigned int srcsock, unsigned int destsock, int ttl,
192         int len, const void *buf));
193 extern int udp_transmit P((unsigned long destip, unsigned int srcsock,
194         unsigned int destsock, int len, const void *buf));
195 extern int tcp_transmit(unsigned long destip, unsigned int srcsock,
196                        unsigned int destsock, long send_seq, long recv_seq,
197                        int window, int flags, int len, const void *buf);
198 int tcp_reset(struct iphdr *ip);
199 typedef int (*reply_t)(int ival, void *ptr, unsigned short ptype, struct iphdr *ip, struct udphdr *udp, struct tcphdr *tcp);
200 extern int await_reply P((reply_t reply,        int ival, void *ptr, long timeout));
201 extern int decode_rfc1533 P((unsigned char *, unsigned int, unsigned int, int));
202 extern void join_group(int slot, unsigned long group);
203 extern void leave_group(int slot);
204 #define RAND_MAX 2147483647L
205 extern uint16_t ipchksum P((const void *ip, unsigned long len));
206 extern uint16_t add_ipchksums P((unsigned long offset, uint16_t sum, uint16_t new));
207 extern int32_t random P((void));
208 extern long rfc2131_sleep_interval P((long base, int exp));
209 extern long rfc1112_sleep_interval P((long base, int exp));
210 #ifndef DOWNLOAD_PROTO_TFTP
211 #define tftp(fname, load_block) 0
212 #endif
213 extern void cleanup P((void));
214
215 /* nfs.c */
216 extern void rpc_init(void);
217 extern int nfs P((const char *name, int (*)(unsigned char *, unsigned int, unsigned int, int)));
218 extern void nfs_umountall P((int));
219
220 /* proto_slam.c */
221 extern int url_slam P((const char *name, int (*fnc)(unsigned char *, unsigned int, unsigned int, int)));
222
223 /* proto_tftm.c */
224 extern int url_tftm P((const char *name, int (*fnc)(unsigned char *, unsigned int, unsigned int, int)));
225
226 /* config.c */
227 extern void print_config(void);
228
229 /* isa_probe.c and pci_probe.c */
230 struct dev;
231 extern void isa_enumerate(void);
232 extern int isa_probe(struct dev *, const char *);
233 extern void pci_enumerate(void);
234 extern int pci_probe(struct dev *, const char *);
235
236 /* heap.c */
237 extern void init_heap(void);
238 extern void *allot(size_t size);
239 void forget(void *ptr);
240 extern void *allot2(size_t size, uint32_t mask);
241 void forget2(void *ptr);
242 /* Physical address of the heap */
243 extern size_t heap_ptr, heap_top, heap_bot;
244
245 /* osloader.c */
246 /* Be careful with sector_t it is an unsigned long long on x86 */
247 typedef uint64_t sector_t;
248 typedef sector_t (*os_download_t)(unsigned char *data, unsigned int len, int eof);
249 extern os_download_t probe_image(unsigned char *data, unsigned int len);
250 extern int load_block P((unsigned char *, unsigned int, unsigned int, int ));
251
252 /* misc.c */
253 extern void twiddle P((void));
254 extern void sleep P((int secs));
255 extern void interruptible_sleep P((int secs));
256 extern void poll_interruptions P((void));
257 extern int strcasecmp P((const char *a, const char *b));
258 extern char *substr P((const char *a, const char *b));
259
260 extern unsigned long get_boot_order(unsigned long order, unsigned *index);
261 extern void disk_init P((void));
262 extern unsigned int pcbios_disk_read P((int drv,int c,int h,int s,char *buf));
263
264 /* start32.S */
265 struct os_entry_regs {
266         /* Be careful changing this structure
267          * as it is used by assembly language code.
268          */
269         uint32_t  edi; /*  0 */
270         uint32_t  esi; /*  4 */
271         uint32_t  ebp; /*  8 */
272         uint32_t  esp; /* 12 */
273         uint32_t  ebx; /* 16 */
274         uint32_t  edx; /* 20 */
275         uint32_t  ecx; /* 24 */
276         uint32_t  eax; /* 28 */
277         
278         uint32_t saved_ebp; /* 32 */
279         uint32_t saved_esi; /* 36 */
280         uint32_t saved_edi; /* 40 */
281         uint32_t saved_ebx; /* 44 */
282         uint32_t saved_eip; /* 48 */
283         uint32_t saved_esp; /* 52 */
284 };
285 struct regs {
286         /* Be careful changing this structure
287          * as it is used by assembly language code.
288          */
289         uint32_t  edi; /*  0 */
290         uint32_t  esi; /*  4 */
291         uint32_t  ebp; /*  8 */
292         uint32_t  esp; /* 12 */
293         uint32_t  ebx; /* 16 */
294         uint32_t  edx; /* 20 */
295         uint32_t  ecx; /* 24 */
296         uint32_t  eax; /* 28 */
297 };
298 extern struct os_entry_regs os_regs;
299 extern struct regs initial_regs;
300 extern int xstart32(unsigned long entry_point, ...);
301 extern int xstart_lm(unsigned long entry_point, unsigned long params);
302 extern void xend32 P((void));
303 struct Elf_Bhdr *prepare_boot_params(void *header);
304 extern int elf_start(unsigned long machine, unsigned long entry, unsigned long params);
305 extern unsigned long currticks P((void));
306 extern void exit P((int status));
307
308 /* serial.c */
309 extern int serial_getc P((void));
310 extern void serial_putc P((int));
311 extern int serial_ischar P((void));
312 extern int serial_init P((void));
313 extern void serial_fini P((void));
314
315 /* floppy.c */
316 extern int bootdisk P((int dev,int part));
317
318 /***************************************************************************
319 External variables
320 ***************************************************************************/
321 /* main.c */
322 extern struct rom_info rom;
323 extern char *hostname;
324 extern int hostnamelen;
325 extern jmp_buf restart_etherboot;
326 extern int url_port;
327 extern struct arptable_t arptable[MAX_ARP];
328 extern struct igmptable_t igmptable[MAX_IGMP];
329 #ifdef  IMAGE_MENU
330 extern int menutmo,menudefault;
331 extern unsigned char *defparams;
332 extern int defparams_max;
333 #endif
334 #ifdef  MOTD
335 extern unsigned char *motd[RFC1533_VENDOR_NUMOFMOTD];
336 #endif
337 extern struct bootpd_t bootp_data;
338 #define BOOTP_DATA_ADDR (&bootp_data)
339 extern unsigned char *end_of_rfc1533;
340 #ifdef  IMAGE_FREEBSD
341 extern int freebsd_howto;
342 #define FREEBSD_KERNEL_ENV_SIZE 256
343 extern char freebsd_kernel_env[FREEBSD_KERNEL_ENV_SIZE];
344 #endif
345
346 /* bootmenu.c */
347
348 /* osloader.c */
349
350 /* created by linker */
351 extern char _virt_start[], _text[], _etext[], _text16[], _etext16[];
352 extern char _data[], _edata[], _bss[], _ebss[], _end[];
353
354
355 /*
356  * Local variables:
357  *  c-basic-offset: 8
358  * End:
359  */
360
361 #endif /* ETHERBOOT_H */