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 extern void cleanup P((void));
 211
 212 /* config.c */
 213 extern void print_config(void);
 214
 215 /* heap.c */
 216 extern void *allot(size_t size);
 217 void forget(void *ptr);
 218 extern void *allot2(size_t size, uint32_t mask);
 219 void forget2(void *ptr);
 220 /* Physical address of the heap */
 221 extern size_t heap_ptr, heap_top, heap_bot;
 222
 223 /* osloader.c */
 224 /* Be careful with sector_t it is an unsigned long long on x86 */
 225 typedef uint64_t sector_t;
 226 typedef sector_t (*os_download_t)(unsigned char *data, unsigned int len, int eof);
 227 extern os_download_t probe_image(unsigned char *data, unsigned int len);
 228 extern int load_block P((unsigned char *, unsigned int, unsigned int, int ));
 229
 230 /* misc.c */
 231 extern void twiddle P((void));
 232 extern void sleep P((int secs));
 233 extern void interruptible_sleep P((int secs));
 234 extern void poll_interruptions P((void));
 235 extern int strcasecmp P((const char *a, const char *b));
 236 extern char *substr P((const char *a, const char *b));
 237
 238 extern unsigned long get_boot_order(unsigned long order, unsigned *index);
 239 extern void disk_init P((void));
 240 extern unsigned int pcbios_disk_read P((int drv,int c,int h,int s,char *buf));
 241
 242 /* start32.S */
 243 struct os_entry_regs {
 244         /* Be careful changing this structure
 245          * as it is used by assembly language code.
 246          */
 247         uint32_t  edi; /*  0 */
 248         uint32_t  esi; /*  4 */
 249         uint32_t  ebp; /*  8 */
 250         uint32_t  esp; /* 12 */
 251         uint32_t  ebx; /* 16 */
 252         uint32_t  edx; /* 20 */
 253         uint32_t  ecx; /* 24 */
 254         uint32_t  eax; /* 28 */
 255
 256         uint32_t saved_ebp; /* 32 */
 257         uint32_t saved_esi; /* 36 */
 258         uint32_t saved_edi; /* 40 */
 259         uint32_t saved_ebx; /* 44 */
 260         uint32_t saved_eip; /* 48 */
 261         uint32_t saved_esp; /* 52 */
 262 };
 263 struct regs {
 264         /* Be careful changing this structure
 265          * as it is used by assembly language code.
 266          */
 267         uint32_t  edi; /*  0 */
 268         uint32_t  esi; /*  4 */
 269         uint32_t  ebp; /*  8 */
 270         uint32_t  esp; /* 12 */
 271         uint32_t  ebx; /* 16 */
 272         uint32_t  edx; /* 20 */
 273         uint32_t  ecx; /* 24 */
 274         uint32_t  eax; /* 28 */
 275 };
 276 extern struct os_entry_regs os_regs;
 277 extern struct regs initial_regs;
 278 extern int xstart32(unsigned long entry_point, ...);
 279 extern int xstart_lm(unsigned long entry_point, unsigned long params);
 280 extern void xend32 P((void));
 281 struct Elf_Bhdr *prepare_boot_params(void *header);
 282 extern int elf_start(unsigned long machine, unsigned long entry, unsigned long params);
 283 extern unsigned long currticks P((void));
 284 extern void exit P((int status));
 285
 286 /* serial.c */
 287 extern int serial_getc P((void));
 288 extern void serial_putc P((int));
 289 extern int serial_ischar P((void));
 290 extern int serial_init P((void));
 291 extern void serial_fini P((void));
 292
 293 /* floppy.c */
 294 extern int bootdisk P((int dev,int part));
 295
 296 /***************************************************************************
 297 External variables
 298 ***************************************************************************/
 299 /* main.c */
 300 extern struct rom_info rom;
 301 extern char *hostname;
 302 extern int hostnamelen;
 303 extern jmp_buf restart_etherboot;
 304 extern int url_port;
 305 extern struct arptable_t arptable[MAX_ARP];
 306 extern struct igmptable_t igmptable[MAX_IGMP];
 307 #ifdef  IMAGE_MENU
 308 extern int menutmo,menudefault;
 309 extern unsigned char *defparams;
 310 extern int defparams_max;
 311 #endif
 312 #ifdef  MOTD
 313 extern unsigned char *motd[RFC1533_VENDOR_NUMOFMOTD];
 314 #endif
 315 extern struct bootpd_t bootp_data;
 316 #define BOOTP_DATA_ADDR (&bootp_data)
 317 extern unsigned char *end_of_rfc1533;
 318 #ifdef  IMAGE_FREEBSD
 319 extern int freebsd_howto;
 320 #define FREEBSD_KERNEL_ENV_SIZE 256
 321 extern char freebsd_kernel_env[FREEBSD_KERNEL_ENV_SIZE];
 322 #endif
 323
 324 /* bootmenu.c */
 325
 326 /* osloader.c */
 327
 328 /* created by linker */
 329 extern char _virt_start[], _text[], _etext[], _text16[], _etext16[];
 330 extern char _data[], _edata[], _bss[], _ebss[], _end[];
 331
 332
 333 /*
 334  * Local variables:
 335  *  c-basic-offset: 8
 336  * End:
 337  */
 338
 339 #endif /* ETHERBOOT_H */