core/pxelinux.asm

   1 ; -*- fundamental -*- (asm-mode sucks)
   2 ; ****************************************************************************
   3 ;
   4 ;  pxelinux.asm
   5 ;
   6 ;  A program to boot Linux kernels off a TFTP server using the Intel PXE
   7 ;  network booting API.  It is based on the SYSLINUX boot loader for
   8 ;  MS-DOS floppies.
   9 ;
  10 ;   Copyright 1994-2009 H. Peter Anvin - All Rights Reserved
  11 ;   Copyright 2009 Intel Corporation; author: H. Peter Anvin
  12 ;
  13 ;  This program is free software; you can redistribute it and/or modify
  14 ;  it under the terms of the GNU General Public License as published by
  15 ;  the Free Software Foundation, Inc., 53 Temple Place Ste 330,
  16 ;  Boston MA 02111-1307, USA; either version 2 of the License, or
  17 ;  (at your option) any later version; incorporated herein by reference.
  18 ;
  19 ; ****************************************************************************
  20
  21 %define IS_PXELINUX 1
  22 %include "head.inc"
  23 %include "pxe.inc"
  24
  25 ; gPXE extensions support
  26 %define GPXE    1
  27
  28 ;
  29 ; Some semi-configurable constants... change on your own risk.
  30 ;
  31 my_id           equ pxelinux_id
  32 NULLFILE        equ 0                   ; Zero byte == null file name
  33 NULLOFFSET      equ 0                   ; Position in which to look
  34 REBOOT_TIME     equ 5*60                ; If failure, time until full reset
  35 %assign HIGHMEM_SLOP 128*1024           ; Avoid this much memory near the top
  36 TFTP_BLOCKSIZE_LG2 equ 9                ; log2(bytes/block)
  37 TFTP_BLOCKSIZE  equ (1 << TFTP_BLOCKSIZE_LG2)
  38
  39 SECTOR_SHIFT    equ TFTP_BLOCKSIZE_LG2
  40 SECTOR_SIZE     equ TFTP_BLOCKSIZE
  41
  42 ;
  43 ; The following structure is used for "virtual kernels"; i.e. LILO-style
  44 ; option labels.  The options we permit here are `kernel' and `append
  45 ; Since there is no room in the bottom 64K for all of these, we
  46 ; stick them in high memory and copy them down before we need them.
  47 ;
  48                 struc vkernel
  49 vk_vname:       resb FILENAME_MAX       ; Virtual name **MUST BE FIRST!**
  50 vk_rname:       resb FILENAME_MAX       ; Real name
  51 vk_ipappend:    resb 1                  ; "IPAPPEND" flag
  52 vk_type:        resb 1                  ; Type of file
  53 vk_appendlen:   resw 1
  54                 alignb 4
  55 vk_append:      resb max_cmd_len+1      ; Command line
  56                 alignb 4
  57 vk_end:         equ $                   ; Should be <= vk_size
  58                 endstruc
  59
  60
  61 ; ---------------------------------------------------------------------------
  62 ;   BEGIN CODE
  63 ; ---------------------------------------------------------------------------
  64
  65 ;
  66 ; Memory below this point is reserved for the BIOS and the MBR
  67 ;
  68                 section .earlybss
  69                 global trackbuf
  70 trackbufsize    equ 8192
  71 trackbuf        resb trackbufsize       ; Track buffer goes here
  72                 ; ends at 2800h
  73
  74                 ; These fields save information from before the time
  75                 ; .bss is zeroed... must be in .earlybss
  76                 global InitStack
  77 InitStack       resd 1
  78
  79                 section .bss16
  80                 alignb FILENAME_MAX
  81 PXEStack        resd 1                  ; Saved stack during PXE call
  82
  83                 alignb 4
  84                 global DHCPMagic, RebootTime, APIVer
  85 RebootTime      resd 1                  ; Reboot timeout, if set by option
  86 StrucPtr        resw 2                  ; Pointer to PXENV+ or !PXE structure
  87 APIVer          resw 1                  ; PXE API version found
  88 LocalBootType   resw 1                  ; Local boot return code
  89 DHCPMagic       resb 1                  ; PXELINUX magic flags
  90
  91                 section .text16
  92 StackBuf        equ STACK_TOP-44        ; Base of stack if we use our own
  93 StackHome       equ StackBuf
  94
  95                 ; PXE loads the whole file, but assume it can't be more
  96                 ; than (384-31)K in size.
  97 MaxLMA          equ 384*1024
  98
  99 ;
 100 ; Primary entry point.
 101 ;
 102 bootsec         equ $
 103 _start:
 104                 jmp 0:_start1           ; Canonicalize the address and skip
 105                                         ; the patch header
 106
 107 ;
 108 ; Patch area for adding hardwired DHCP options
 109 ;
 110                 align 4
 111
 112 hcdhcp_magic    dd 0x2983c8ac           ; Magic number
 113 hcdhcp_len      dd 7*4                  ; Size of this structure
 114 hcdhcp_flags    dd 0                    ; Reserved for the future
 115                 ; Parameters to be parsed before the ones from PXE
 116 bdhcp_offset    dd 0                    ; Offset (entered by patcher)
 117 bdhcp_len       dd 0                    ; Length (entered by patcher)
 118                 ; Parameters to be parsed *after* the ones from PXE
 119 adhcp_offset    dd 0                    ; Offset (entered by patcher)
 120 adhcp_len       dd 0                    ; Length (entered by patcher)
 121
 122 _start1:
 123                 pushfd                  ; Paranoia... in case of return to PXE
 124                 pushad                  ; ... save as much state as possible
 125                 push ds
 126                 push es
 127                 push fs
 128                 push gs
 129
 130                 cld                     ; Copy upwards
 131                 xor ax,ax
 132                 mov ds,ax
 133                 mov es,ax
 134
 135 %if 0 ; debugging code only... not intended for production use
 136                 ; Clobber the stack segment, to test for specific pathologies
 137                 mov di,STACK_BASE
 138                 mov cx,STACK_LEN >> 1
 139                 mov ax,0xf4f4
 140                 rep stosw
 141
 142                 ; Clobber the tail of the 64K segment, too
 143                 extern __bss1_end
 144                 mov di,__bss1_end
 145                 sub cx,di               ; CX = 0 previously
 146                 shr cx,1
 147                 rep stosw
 148 %endif
 149
 150                 ; That is all pushed onto the PXE stack.  Save the pointer
 151                 ; to it and switch to an internal stack.
 152                 mov [InitStack],sp
 153                 mov [InitStack+2],ss
 154
 155                 lss esp,[BaseStack]
 156                 sti                     ; Stack set up and ready
 157 ;
 158 ; Move the hardwired DHCP options (if present) to a safe place...
 159 ;
 160 bdhcp_copy:
 161                 mov cx,[bdhcp_len]
 162                 mov ax,trackbufsize/2
 163                 jcxz .none
 164                 cmp cx,ax
 165                 jbe .oksize
 166                 mov cx,ax
 167                 mov [bdhcp_len],ax
 168 .oksize:
 169                 mov eax,[bdhcp_offset]
 170                 add eax,_start
 171                 mov si,ax
 172                 and si,000Fh
 173                 shr eax,4
 174                 push ds
 175                 mov ds,ax
 176                 mov di,trackbuf
 177                 add cx,3
 178                 shr cx,2
 179                 rep movsd
 180                 pop ds
 181 .none:
 182
 183 adhcp_copy:
 184                 mov cx,[adhcp_len]
 185                 mov ax,trackbufsize/2
 186                 jcxz .none
 187                 cmp cx,ax
 188                 jbe .oksize
 189                 mov cx,ax
 190                 mov [adhcp_len],ax
 191 .oksize:
 192                 mov eax,[adhcp_offset]
 193                 add eax,_start
 194                 mov si,ax
 195                 and si,000Fh
 196                 shr eax,4
 197                 push ds
 198                 mov ds,ax
 199                 mov di,trackbuf+trackbufsize/2
 200                 add cx,3
 201                 shr cx,2
 202                 rep movsd
 203                 pop ds
 204 .none:
 205
 206 ;
 207 ; Initialize screen (if we're using one)
 208 ;
 209 %include "init.inc"
 210
 211 ;
 212 ; Tell the user we got this far
 213 ;
 214                 mov si,syslinux_banner
 215                 call writestr_early
 216
 217                 mov si,copyright_str
 218                 call writestr_early
 219
 220 ;
 221 ; do fs initialize
 222 ;
 223                 mov eax,ROOT_FS_OPS
 224                 xor ebp,ebp
 225                 pm_call fs_init
 226
 227                 section .rodata
 228                 alignz 4
 229 ROOT_FS_OPS:
 230                 extern pxe_fs_ops
 231                 dd pxe_fs_ops
 232                 dd 0
 233
 234
 235                 section .text16
 236 ;
 237 ; Initialize the idle mechanism
 238 ;
 239                 call reset_idle
 240
 241 ;
 242 ; Now we're all set to start with our *real* business.  First load the
 243 ; configuration file (if any) and parse it.
 244 ;
 245 ; In previous versions I avoided using 32-bit registers because of a
 246 ; rumour some BIOSes clobbered the upper half of 32-bit registers at
 247 ; random.  I figure, though, that if there are any of those still left
 248 ; they probably won't be trying to install Linux on them...
 249 ;
 250 ; The code is still ripe with 16-bitisms, though.  Not worth the hassle
 251 ; to take'm out.  In fact, we may want to put them back if we're going
 252 ; to boot ELKS at some point.
 253 ;
 254
 255 ;
 256 ; Load configuration file
 257 ;
 258                 pm_call load_config
 259
 260 ;
 261 ; Linux kernel loading code is common.  However, we need to define
 262 ; a couple of helper macros...
 263 ;
 264
 265 ; Unload PXE stack
 266 %define HAVE_UNLOAD_PREP
 267 %macro  UNLOAD_PREP 0
 268                 pm_call unload_pxe
 269 %endmacro
 270
 271 ;
 272 ; Now we have the config file open.  Parse the config file and
 273 ; run the user interface.
 274 ;
 275 %include "ui.inc"
 276
 277 ;
 278 ; Boot to the local disk by returning the appropriate PXE magic.
 279 ; AX contains the appropriate return code.
 280 ;
 281 local_boot:
 282                 push cs
 283                 pop ds
 284                 mov [LocalBootType],ax
 285                 call vgaclearmode
 286                 mov si,localboot_msg
 287                 call writestr_early
 288                 ; Restore the environment we were called with
 289                 pm_call reset_pxe
 290                 call cleanup_hardware
 291                 lss sp,[InitStack]
 292                 pop gs
 293                 pop fs
 294                 pop es
 295                 pop ds
 296                 popad
 297                 mov ax,[cs:LocalBootType]
 298                 cmp ax,-1                       ; localboot -1 == INT 18h
 299                 je .int18
 300                 popfd
 301                 retf                            ; Return to PXE
 302 .int18:
 303                 popfd
 304                 int 18h
 305                 jmp 0F000h:0FFF0h
 306                 hlt
 307
 308 ;
 309 ; kaboom: write a message and bail out.  Wait for quite a while,
 310 ;         or a user keypress, then do a hard reboot.
 311 ;
 312 ;         Note: use BIOS_timer here; we may not have jiffies set up.
 313 ;
 314                 global kaboom
 315 kaboom:
 316                 RESET_STACK_AND_SEGS AX
 317 .patch:         mov si,bailmsg
 318                 call writestr_early             ; Returns with AL = 0
 319 .drain:         call pollchar
 320                 jz .drained
 321                 call getchar
 322                 jmp short .drain
 323 .drained:
 324                 mov edi,[RebootTime]
 325                 mov al,[DHCPMagic]
 326                 and al,09h              ; Magic+Timeout
 327                 cmp al,09h
 328                 je .time_set
 329                 mov edi,REBOOT_TIME
 330 .time_set:
 331                 mov cx,18
 332 .wait1:         push cx
 333                 mov ecx,edi
 334 .wait2:         mov dx,[BIOS_timer]
 335 .wait3:         call pollchar
 336                 jnz .keypress
 337                 call do_idle
 338                 cmp dx,[BIOS_timer]
 339                 je .wait3
 340                 loop .wait2,ecx
 341                 mov al,'.'
 342                 call writechr
 343                 pop cx
 344                 loop .wait1
 345 .keypress:
 346                 call crlf
 347                 mov word [BIOS_magic],0 ; Cold reboot
 348                 jmp 0F000h:0FFF0h       ; Reset vector address
 349
 350
 351 ;
 352 ; pxenv
 353 ;
 354 ; This is the main PXENV+/!PXE entry point, using the PXENV+
 355 ; calling convention.  This is a separate local routine so
 356 ; we can hook special things from it if necessary.  In particular,
 357 ; some PXE stacks seem to not like being invoked from anything but
 358 ; the initial stack, so humour it.
 359 ;
 360 ; While we're at it, save and restore all registers.
 361 ;
 362                 global pxenv
 363 pxenv:
 364                 pushfd
 365                 pushad
 366
 367                 mov [cs:PXEStack],sp
 368                 mov [cs:PXEStack+2],ss
 369                 lss sp,[cs:InitStack]
 370
 371                 ; Pre-clear the Status field
 372                 mov word [es:di],cs
 373
 374                 ; This works either for the PXENV+ or the !PXE calling
 375                 ; convention, as long as we ignore CF (which is redundant
 376                 ; with AX anyway.)
 377                 push es
 378                 push di
 379                 push bx
 380 .jump:          call 0:0
 381                 add sp,6
 382                 mov [cs:PXEStatus],ax
 383
 384                 lss sp,[cs:PXEStack]
 385
 386                 mov bp,sp
 387                 and ax,ax
 388                 setnz [bp+32]                   ; If AX != 0 set CF on return
 389
 390                 ; This clobbers the AX return, but we already saved it into
 391                 ; the PXEStatus variable.
 392                 popad
 393                 popfd                           ; Restore flags (incl. IF, DF)
 394                 ret
 395
 396 ; Must be after function def due to NASM bug
 397                 global PXEEntry
 398 PXEEntry        equ pxenv.jump+1
 399
 400                 section .bss16
 401                 alignb 2
 402 PXEStatus       resb 2
 403
 404
 405                 section .text16
 406 ;
 407 ; Invoke INT 1Ah on the PXE stack.  This is used by the "Plan C" method
 408 ; for finding the PXE entry point.
 409 ;
 410                 global pxe_int1a
 411 pxe_int1a:
 412                 mov [cs:PXEStack],sp
 413                 mov [cs:PXEStack+2],ss
 414                 lss sp,[cs:InitStack]
 415
 416                 int 1Ah                 ; May trash registers
 417
 418                 lss sp,[cs:PXEStack]
 419                 ret
 420
 421 ;
 422 ; Special unload for gPXE: this switches the InitStack from
 423 ; gPXE to the ROM PXE stack.
 424 ;
 425 %if GPXE
 426                 global gpxe_unload
 427 gpxe_unload:
 428                 mov bx,PXENV_FILE_EXIT_HOOK
 429                 mov di,pxe_file_exit_hook
 430                 call pxenv
 431                 jc .plain
 432
 433                 ; Now we actually need to exit back to gPXE, which will
 434                 ; give control back to us on the *new* "original stack"...
 435                 pushfd
 436                 push ds
 437                 push es
 438                 mov [PXEStack],sp
 439                 mov [PXEStack+2],ss
 440                 lss sp,[InitStack]
 441                 pop gs
 442                 pop fs
 443                 pop es
 444                 pop ds
 445                 popad
 446                 popfd
 447                 xor ax,ax
 448                 retf
 449 .resume:
 450                 cli
 451
 452                 ; gPXE will have a stack frame looking much like our
 453                 ; InitStack, except it has a magic cookie at the top,
 454                 ; and the segment registers are in reverse order.
 455                 pop eax
 456                 pop ax
 457                 pop bx
 458                 pop cx
 459                 pop dx
 460                 push ax
 461                 push bx
 462                 push cx
 463                 push dx
 464                 mov [cs:InitStack],sp
 465                 mov [cs:InitStack+2],ss
 466                 lss sp,[cs:PXEStack]
 467                 pop es
 468                 pop ds
 469                 popfd
 470
 471 .plain:
 472                 ret
 473
 474                 section .data16
 475                 alignz 4
 476 pxe_file_exit_hook:
 477 .status:        dw 0
 478 .offset:        dw gpxe_unload.resume
 479 .seg:           dw 0
 480 %endif
 481
 482                 section .text16
 483
 484 ; -----------------------------------------------------------------------------
 485 ;  Common modules
 486 ; -----------------------------------------------------------------------------
 487
 488 %include "common.inc"           ; Universal modules
 489 %include "writestr.inc"         ; String output
 490 writestr_early  equ writestr
 491 %include "writehex.inc"         ; Hexadecimal output
 492 %include "rawcon.inc"           ; Console I/O w/o using the console functions
 493
 494 ; -----------------------------------------------------------------------------
 495 ;  Begin data section
 496 ; -----------------------------------------------------------------------------
 497
 498                 section .data16
 499
 500 copyright_str   db ' Copyright (C) 1994-'
 501                 asciidec YEAR
 502                 db ' H. Peter Anvin et al', CR, LF, 0
 503 err_bootfailed  db CR, LF, 'Boot failed: press a key to retry, or wait for reset...', CR, LF, 0
 504 bailmsg         equ err_bootfailed
 505 localboot_msg   db 'Booting from local disk...', CR, LF, 0
 506 syslinux_banner db CR, LF, MY_NAME, ' ', VERSION_STR, ' ', DATE_STR, ' ', 0
 507
 508 ;
 509 ; Config file keyword table
 510 ;
 511 %include "keywords.inc"
 512
 513 ;
 514 ; Extensions to search for (in *forward* order).
 515 ; (.bs and .bss16 are disabled for PXELINUX, since they are not supported)
 516 ;
 517                 alignz 4
 518 exten_table:    db '.cbt'               ; COMBOOT (specific)
 519                 db '.0', 0, 0           ; PXE bootstrap program
 520                 db '.com'               ; COMBOOT (same as DOS)
 521                 db '.c32'               ; COM32
 522 exten_table_end:
 523                 dd 0, 0                 ; Need 8 null bytes here
 524
 525 ;
 526 ; Misc initialized (data) variables
 527 ;
 528                 section .data16
 529                 global KeepPXE
 530 KeepPXE         db 0                    ; Should PXE be kept around?
 531
 532 ;
 533 ; IP information.  Note that the field are in the same order as the
 534 ; Linux kernel expects in the ip= option.
 535 ;
 536                 section .bss16
 537                 alignb 4
 538                 global IPInfo
 539 IPInfo:
 540 .IPv4           resd 1                  ; IPv4 information
 541 .MyIP           resd 1                  ; My IP address
 542 .ServerIP       resd 1
 543 .GatewayIP      resd 1
 544 .Netmask        resd 1