2 # Copyright (c) 2001 John Baldwin <jhb@FreeBSD.org>
5 # Redistribution and use in source and binary forms, with or without
6 # modification, are permitted provided that the following conditions
8 # 1. Redistributions of source code must retain the above copyright
9 # notice, this list of conditions and the following disclaimer.
10 # 2. Redistributions in binary form must reproduce the above copyright
11 # notice, this list of conditions and the following disclaimer in the
12 # documentation and/or other materials provided with the distribution.
14 # THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 # ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 # OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 # HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 # This program is a freestanding boot program to load an a.out binary
31 # from a CD-ROM booted with no emulation mode as described by the El
32 # Torito standard. Due to broken BIOSen that do not load the desired
33 # number of sectors, we try to fit this in as small a space as possible.
35 # Basically, we first create a set of boot arguments to pass to the loaded
36 # binary. Then we attempt to load /boot/loader from the CD we were booted
45 .set MEM_PAGE_SIZE,0x1000 # memory page size, 4k
46 .set MEM_ARG,0x900 # Arguments at start
47 .set MEM_ARG_BTX,0xa100 # Where we move them to so the
48 # BTX client can see them
49 .set MEM_ARG_SIZE,0x18 # Size of the arguments
50 .set MEM_BTX_ADDRESS,0x9000 # where BTX lives
51 .set MEM_BTX_ENTRY,0x9010 # where BTX starts to execute
52 .set MEM_BTX_OFFSET,MEM_PAGE_SIZE # offset of BTX in the loader
53 .set MEM_BTX_CLIENT,0xa000 # where BTX clients live
57 .set AOUT_TEXT,0x04 # text segment size
58 .set AOUT_DATA,0x08 # data segment size
59 .set AOUT_BSS,0x0c # zero'd BSS size
60 .set AOUT_SYMBOLS,0x10 # symbol table
61 .set AOUT_ENTRY,0x14 # entry point
62 .set AOUT_HEADER,MEM_PAGE_SIZE # size of the a.out header
66 .set SEL_SDATA,0x8 # Supervisor data
67 .set SEL_RDATA,0x10 # Real mode data
68 .set SEL_SCODE,0x18 # PM-32 code
69 .set SEL_SCODE16,0x20 # PM-16 code
73 .set INT_SYS,0x30 # BTX syscall interrupt
75 # Constants for reading from the CD.
77 .set ERROR_TIMEOUT,0x80 # BIOS timeout on read
78 .set NUM_RETRIES,3 # Num times to retry
79 .set SECTOR_SIZE,0x800 # size of a sector
80 .set SECTOR_SHIFT,11 # number of place to shift
81 .set BUFFER_LEN,0x100 # number of sectors in buffer
82 .set MAX_READ,0x10000 # max we can read at a time
83 .set MAX_READ_SEC,MAX_READ >> SECTOR_SHIFT
84 .set MEM_READ_BUFFER,0x9000 # buffer to read from CD
85 .set MEM_VOLDESC,MEM_READ_BUFFER # volume descriptor
86 .set MEM_DIR,MEM_VOLDESC+SECTOR_SIZE # Lookup buffer
87 .set VOLDESC_LBA,0x10 # LBA of vol descriptor
88 .set VD_PRIMARY,1 # Primary VD
89 .set VD_END,255 # VD Terminator
90 .set VD_ROOTDIR,156 # Offset of Root Dir Record
91 .set DIR_LEN,0 # Offset of Dir Record length
92 .set DIR_EA_LEN,1 # Offset of EA length
93 .set DIR_EXTENT,2 # Offset of 64-bit LBA
94 .set DIR_SIZE,10 # Offset of 64-bit length
95 .set DIR_NAMELEN,32 # Offset of 8-bit name len
96 .set DIR_NAME,33 # Offset of dir name
98 # We expect to be loaded by the BIOS at 0x7c00 (standard boot loader entry
107 start: cld # string ops inc
108 xor %ax,%ax # zero %ax
109 mov %ax,%ss # setup the
110 mov $start,%sp # stack
111 mov %ax,%ds # setup the
112 mov %ax,%es # data segments
113 mov %dl,drive # Save BIOS boot device
114 mov $msg_welcome,%si # %ds:(%si) -> welcome message
115 call putstr # display the welcome message
117 # Setup the arguments that the loader is expecting from boot[12]
119 mov $msg_bootinfo,%si # %ds:(%si) -> boot args message
120 call putstr # display the message
121 mov $MEM_ARG,%bx # %ds:(%bx) -> boot args
122 mov %bx,%di # %es:(%di) -> boot args
123 xor %eax,%eax # zero %eax
124 mov $(MEM_ARG_SIZE/4),%cx # Size of arguments in 32-bit
126 rep # Clear the arguments
128 mov drive,%dl # Store BIOS boot device
129 mov %dl,0x4(%bx) # in kargs->bootdev
130 or $KARGS_FLAGS_CD,0x8(%bx) # kargs->bootflags |=
133 # Load Volume Descriptor
135 mov $VOLDESC_LBA,%eax # Set LBA of first VD
136 load_vd: push %eax # Save %eax
137 mov $1,%dh # One sector
138 mov $MEM_VOLDESC,%ebx # Destination
139 call read # Read it in
140 cmpb $VD_PRIMARY,(%bx) # Primary VD?
142 pop %eax # Prepare to
144 cmpb $VD_END,(%bx) # Last VD?
145 jne load_vd # No, read next
146 mov $msg_novd,%si # No VD
148 have_vd: # Have Primary VD
150 # Try to look up the loader binary using the paths in the loader_paths
153 mov $loader_paths,%si # Point to start of array
154 lookup_path: push %si # Save file name pointer
155 call lookup # Try to find file
156 pop %di # Restore file name pointer
157 jnc lookup_found # Found this file
158 xor %al,%al # Look for next
159 mov $0xffff,%cx # path name by
162 mov %di,%si # Point %si at next path
163 mov (%si),%al # Get first char of next path
164 or %al,%al # Is it double nul?
165 jnz lookup_path # No, try it.
166 mov $msg_failed,%si # Failed message
168 lookup_found: # Found a loader file
170 # Load the binary into the buffer. Due to real mode addressing limitations
171 # we have to read it in 64k chunks.
173 mov DIR_SIZE(%bx),%eax # Read file length
174 add $SECTOR_SIZE-1,%eax # Convert length to sectors
175 shr $SECTOR_SHIFT,%eax
178 mov $msg_load2big,%si # Error message
180 load_sizeok: movzbw %al,%cx # Num sectors to read
181 mov DIR_EXTENT(%bx),%eax # Load extent
183 mov DIR_EA_LEN(%bx),%dl
184 add %edx,%eax # Skip extended
185 mov $MEM_READ_BUFFER,%ebx # Read into the buffer
186 load_loop: mov %cl,%dh
187 cmp $MAX_READ_SEC,%cl # Truncate to max read size
189 mov $MAX_READ_SEC,%dh
190 load_notrunc: sub %dh,%cl # Update count
192 call read # Read it in
194 add $MAX_READ_SEC,%eax # Update LBA
195 add $MAX_READ,%ebx # Update dest addr
196 jcxz load_done # Done?
197 jmp load_loop # Keep going
200 # Turn on the A20 address line
202 call seta20 # Turn A20 on
204 # Relocate the loader and BTX using a very lazy protected mode
206 mov $msg_relocate,%si # Display the
207 call putstr # relocation message
208 mov MEM_READ_BUFFER+AOUT_ENTRY,%edi # %edi is the destination
209 mov $(MEM_READ_BUFFER+AOUT_HEADER),%esi # %esi is
210 # the start of the text
212 mov MEM_READ_BUFFER+AOUT_TEXT,%ecx # %ecx = length of the text
214 push %edi # Save entry point for later
215 lgdt gdtdesc # setup our own gdt
216 cli # turn off interrupts
217 mov %cr0,%eax # Turn on
218 or $0x1,%al # protected
220 ljmp $SEL_SCODE,$pm_start # long jump to clear the
221 # instruction pre-fetch queue
223 pm_start: mov $SEL_SDATA,%ax # Initialize
224 mov %ax,%ds # %ds and
225 mov %ax,%es # %es to a flat selector
228 add $(MEM_PAGE_SIZE - 1),%edi # pad %edi out to a new page
229 and $~(MEM_PAGE_SIZE - 1),%edi # for the data segment
230 mov MEM_READ_BUFFER+AOUT_DATA,%ecx # size of the data segment
233 mov MEM_READ_BUFFER+AOUT_BSS,%ecx # size of the bss
234 xor %eax,%eax # zero %eax
235 add $3,%cl # round %ecx up to
236 shr $2,%ecx # a multiple of 4
239 mov MEM_READ_BUFFER+AOUT_ENTRY,%esi # %esi -> relocated loader
240 add $MEM_BTX_OFFSET,%esi # %esi -> BTX in the loader
241 mov $MEM_BTX_ADDRESS,%edi # %edi -> where BTX needs to go
242 movzwl 0xa(%esi),%ecx # %ecx -> length of BTX
245 ljmp $SEL_SCODE16,$pm_16 # Jump to 16-bit PM
247 pm_16: mov $SEL_RDATA,%ax # Initialize
248 mov %ax,%ds # %ds and
249 mov %ax,%es # %es to a real mode selector
250 mov %cr0,%eax # Turn off
251 and $~0x1,%al # protected
253 ljmp $0,$pm_end # Long jump to clear the
254 # instruction pre-fetch queue
255 pm_end: sti # Turn interrupts back on now
257 # Copy the BTX client to MEM_BTX_CLIENT
259 xor %ax,%ax # zero %ax and set
260 mov %ax,%ds # %ds and %es
261 mov %ax,%es # to segment 0
262 mov $MEM_BTX_CLIENT,%di # Prepare to relocate
263 mov $btx_client,%si # the simple btx client
264 mov $(btx_client_end-btx_client),%cx # length of btx client
266 movsb # simple BTX client
268 # Copy the boot[12] args to where the BTX client can see them
270 mov $MEM_ARG,%si # where the args are at now
271 mov $MEM_ARG_BTX,%di # where the args are moving to
272 mov $(MEM_ARG_SIZE/4),%cx # size of the arguments in longs
276 # Save the entry point so the client can get to it later on
278 pop %eax # Restore saved entry point
279 stosl # and add it to the end of
282 # Now we just start up BTX and let it do the rest
284 mov $msg_jump,%si # Display the
285 call putstr # jump message
286 ljmp $0,$MEM_BTX_ENTRY # Jump to the BTX entry point
289 # Lookup the file in the path at [SI] from the root directory.
291 # Trashes: All but BX
292 # Returns: CF = 0 (success), BX = pointer to record
295 lookup: mov $VD_ROOTDIR+MEM_VOLDESC,%bx # Root directory record
297 mov $msg_lookup,%si # Display lookup message
305 lookup_dir: lodsb # Get first char of path
306 cmp $0,%al # Are we done?
308 cmp $'/',%al # Skip path separator.
310 dec %si # Undo lodsb side effect
311 call find_file # Lookup first path item
312 jnc lookup_dir # Try next component
313 mov $msg_lookupfail,%si # Not found message
318 lookup_done: mov $msg_lookupok,%si # Success message
324 # Lookup file at [SI] in directory whose record is at [BX].
326 # Trashes: All but returns
327 # Returns: CF = 0 (success), BX = pointer to record, SI = next path item
328 # CF = 1 (not found), SI = preserved
330 find_file: mov DIR_EXTENT(%bx),%eax # Load extent
332 mov DIR_EA_LEN(%bx),%dl
333 add %edx,%eax # Skip extended attributes
334 mov %eax,rec_lba # Save LBA
335 mov DIR_SIZE(%bx),%eax # Save size
337 xor %cl,%cl # Zero length
339 ff.namelen: inc %cl # Update length
343 cmp $'/',%al # Path separator?
344 jnz ff.namelen # No, keep going
345 ff.namedone: dec %cl # Adjust length and save
348 ff.load: mov rec_lba,%eax # Load LBA
349 mov $MEM_DIR,%ebx # Address buffer
350 mov $1,%dh # One sector
351 call read # Read directory block
352 incl rec_lba # Update LBA to next block
353 ff.scan: mov %ebx,%edx # Check for EOF
359 ff.scan.1: cmpb $0,DIR_LEN(%bx) # Last record in block?
362 movzbw DIR_NAMELEN(%bx),%si # Find end of string
363 ff.checkver: cmpb $'0',DIR_NAME-1(%bx,%si) # Less than '0'?
365 cmpb $'9',DIR_NAME-1(%bx,%si) # Greater than '9'?
369 jmp ff.checklen # All numbers in name, so
371 ff.checkver.1: movzbw DIR_NAMELEN(%bx),%cx
372 cmp %cx,%si # Did we find any digits?
374 cmpb $';',DIR_NAME-1(%bx,%si) # Check for semicolon
376 dec %si # Skip semicolon
378 mov %cl,DIR_NAMELEN(%bx) # Adjust length
380 ff.checkver.2: mov %cx,%si # Restore %si to end of string
381 ff.checkdot: cmpb $'.',DIR_NAME-1(%bx,%si) # Trailing dot?
383 decb DIR_NAMELEN(%bx) # Adjust length
384 ff.checklen: pop %si # Restore
385 movzbw name_len,%cx # Load length of name
386 cmp %cl,DIR_NAMELEN(%bx) # Does length match?
387 je ff.checkname # Yes, check name
388 ff.nextrec: add DIR_LEN(%bx),%bl # Next record
391 ff.nextblock: subl $SECTOR_SIZE,rec_size # Adjust size
392 jnc ff.load # If subtract ok, keep going
393 ret # End of file, so not found
394 ff.checkname: lea DIR_NAME(%bx),%di # Address name in record
396 repe cmpsb # Compare name
397 je ff.match # We have a winner!
399 jmp ff.nextrec # Keep looking.
400 ff.match: add $2,%sp # Discard saved %si
405 # Load DH sectors starting at LBA EAX into [EBX].
409 read: push %si # Save
410 push %cx # Save since some BIOSs trash
411 mov %eax,edd_lba # LBA to read from
412 mov %ebx,%eax # Convert address
413 shr $4,%eax # to segment
414 mov %ax,edd_addr+0x2 # and store
415 read.retry: call twiddle # Entertain the user
417 mov $edd_packet,%si # Address Packet
418 mov %dh,edd_len # Set length
419 mov drive,%dl # BIOS Device
420 mov $0x42,%ah # BIOS: Extended Read
421 int $0x13 # Call BIOS
423 jc read.fail # Worked?
427 read.fail: cmp $ERROR_TIMEOUT,%ah # Timeout?
428 je read.retry # Yes, Retry.
429 read.error: mov %ah,%al # Save error
430 mov $hex_error,%di # Format it
432 mov $msg_badread,%si # Display Read error message
435 # Display error message at [SI] and halt.
437 error: call putstr # Display message
442 # Display a null-terminated string.
446 putstr: push %bx # Save
447 putstr.load: lodsb # load %al from %ds:(%si)
448 test %al,%al # stop at null
449 jnz putstr.putc # if the char != null, output it
451 ret # return when null is hit
452 putstr.putc: call putc # output char
453 jmp putstr.load # next char
456 # Display a single char.
458 putc: mov $0x7,%bx # attribute for output
459 mov $0xe,%ah # BIOS: put_char
460 int $0x10 # call BIOS, print char in %al
461 ret # Return to caller
464 # Output the "twiddle"
466 twiddle: push %ax # Save
468 mov twiddle_index,%al # Load index
469 mov $twiddle_chars,%bx # Address table
472 mov %al,twiddle_index # Save index for next call
474 call putc # Output it
475 mov $8,%al # Backspace
476 call putc # Output it
482 # Enable A20. Put an upper limit on the amount of time we wait for the
483 # keyboard controller to get ready (65K x ISA access time). If
484 # we wait more than that amount, the hardware is probably
485 # legacy-free and simply doesn't have a keyboard controller.
486 # Thus, the A20 line is already enabled.
488 seta20: cli # Disable interrupts
490 seta20.1: inc %cx # Increment, overflow?
492 in $0x64,%al # Get status
493 test $0x2,%al # Busy?
495 mov $0xd1,%al # Command: Write
496 out %al,$0x64 # output port
497 seta20.2: in $0x64,%al # Get status
498 test $0x2,%al # Busy?
500 mov $0xdf,%al # Enable
502 seta20.3: sti # Enable interrupts
506 # Convert AL to hex, saving the result to [EDI].
508 hex8: pushl %eax # Save
509 shrb $0x4,%al # Do upper
512 hex8.1: andb $0xf,%al # Get lower 4
513 cmpb $0xa,%al # Convert
514 sbbb $0x69,%al # to hex
516 orb $0x20,%al # To lower case
521 # BTX client to start btxldr
524 btx_client: mov $(MEM_ARG_BTX-MEM_BTX_CLIENT+MEM_ARG_SIZE-4), %esi
527 mov $(MEM_ARG_SIZE/4),%ecx # Number of words to push
529 push_arg: lodsl # Read argument
530 push %eax # Push it onto the stack
531 loop push_arg # Push all of the arguments
532 cld # In case anyone depends on this
533 pushl MEM_ARG_BTX-MEM_BTX_CLIENT+MEM_ARG_SIZE # Entry point of
535 push %eax # Emulate a near call
536 mov $0x1,%eax # 'exec' system call
537 int $INT_SYS # BTX system call
543 # Global descriptor table.
545 gdt: .word 0x0,0x0,0x0,0x0 # Null entry
546 .word 0xffff,0x0,0x9200,0xcf # SEL_SDATA
547 .word 0xffff,0x0,0x9200,0x0 # SEL_RDATA
548 .word 0xffff,0x0,0x9a00,0xcf # SEL_SCODE (32-bit)
549 .word 0xffff,0x0,0x9a00,0x8f # SEL_SCODE16 (16-bit)
552 # Pseudo-descriptors.
554 gdtdesc: .word gdt.1-gdt-1 # Limit
559 edd_packet: .byte 0x10 # Length
561 edd_len: .byte 0x0 # Num to read
563 edd_addr: .word 0x0,0x0 # Seg:Off
564 edd_lba: .quad 0x0 # LBA
569 # State for searching dir
571 rec_lba: .long 0x0 # LBA (adjusted for EA)
572 rec_size: .long 0x0 # File size
573 name_len: .byte 0x0 # Length of current name
575 twiddle_index: .byte 0x0
577 msg_welcome: .asciz "CD Loader 1.2\r\n\n"
578 msg_bootinfo: .asciz "Building the boot loader arguments\r\n"
579 msg_relocate: .asciz "Relocating the loader and the BTX\r\n"
580 msg_jump: .asciz "Starting the BTX loader\r\n"
581 msg_badread: .ascii "Read Error: 0x"
582 hex_error: .asciz "00\r\n"
583 msg_novd: .asciz "Could not find Primary Volume Descriptor\r\n"
584 msg_lookup: .asciz "Looking up "
585 msg_lookup2: .asciz "... "
586 msg_lookupok: .asciz "Found\r\n"
587 msg_lookupfail: .asciz "File not found\r\n"
588 msg_load2big: .asciz "File too big\r\n"
589 msg_failed: .asciz "Boot failed\r\n"
590 twiddle_chars: .ascii "|/-\\"
591 loader_paths: .asciz "/BOOT/LOADER"
592 .asciz "/boot/loader"