1 ;; -----------------------------------------------------------------------
3 ;; Copyright 1994-2005 H. Peter Anvin - All Rights Reserved
5 ;; This program is free software; you can redistribute it and/or modify
6 ;; it under the terms of the GNU General Public License as published by
7 ;; the Free Software Foundation, Inc., 53 Temple Place Ste 330,
8 ;; Boston MA 02111-1307, USA; either version 2 of the License, or
9 ;; (at your option) any later version; incorporated herein by reference.
11 ;; -----------------------------------------------------------------------
16 ;; Common code for running a COMBOOT image
21 ; Parameter registers definition; this is the definition
22 ; of the stack frame used by INT 21h and INT 22h.
23 %define P_FLAGS word [bp+44]
24 %define P_FLAGSL byte [bp+44]
25 %define P_FLAGSH byte [bp+45]
26 %define P_CS word [bp+42]
27 %define P_IP word [bp+40]
28 %define P_DS word [bp+38]
29 %define P_ES word [bp+36]
30 %define P_FS word [bp+34]
31 %define P_GS word [bp+32]
32 %define P_EAX dword [bp+28]
33 %define P_AX word [bp+28]
34 %define P_HAX word [bp+30]
35 %define P_AL byte [bp+28]
36 %define P_AH byte [bp+29]
37 %define P_ECX dword [bp+24]
38 %define P_CX word [bp+24]
39 %define P_HCX word [bp+26]
40 %define P_CL byte [bp+24]
41 %define P_CH byte [bp+25]
42 %define P_EDX dword [bp+20]
43 %define P_DX word [bp+20]
44 %define P_HDX word [bp+22]
45 %define P_DL byte [bp+20]
46 %define P_DH byte [bp+21]
47 %define P_EBX dword [bp+16]
48 %define P_BX word [bp+16]
49 %define P_HBX word [bp+18]
50 %define P_BL byte [bp+16]
51 %define P_BH byte [bp+17]
52 %define P_EBP dword [bp+8]
53 %define P_BP word [bp+8]
54 %define P_HBP word [bp+10]
55 %define P_ESI dword [bp+4]
56 %define P_SI word [bp+4]
57 %define P_HSI word [bp+6]
58 %define P_EDI dword [bp]
59 %define P_DI word [bp]
60 %define P_HDI word [bp+2]
62 ; Looks like a COMBOOT image but too large
69 ; Load a COMBOOT image. A COMBOOT image is basically a DOS .COM file,
70 ; except that it may, of course, not contain any DOS system calls. We
71 ; do, however, allow the execution of INT 20h to return to SYSLINUX.
76 cmp ax,0ff00h ; Max size in bytes
79 push si ; Save file handle
81 call make_plain_cmdline
83 call comboot_setup_api
89 mov cx,64 ; 256 bytes (size of PSP)
90 xor eax,eax ; Clear PSP
93 mov word [es:0], 020CDh ; INT 20h instruction
94 ; First non-free paragraph
95 ; This is valid because comboot_seg == real_mode_seg
96 ; == the highest segment used by all derivatives
97 int 12h ; Get DOS memory size
98 shl ax,6 ; Kilobytes -> paragraphs
102 %if real_mode_seg != comboot_seg
103 %error "This code assumes real_mode_seg == comboot_seg"
106 ; Copy the command line from high memory
108 mov cx,125 ; Max cmdline len (minus space and CR)
109 mov di,081h ; Offset in PSP for command line
110 mov al,' ' ; DOS command lines begin with a space
120 mov al,0Dh ; CR after last character
123 sub al,82h ; Include space but not CR
124 mov [es:80h],al ; Store command line length
126 ; Now actually load the file...
128 mov bx,100h ; Load at <seg>:0100h
129 mov cx,0FF00h >> SECTOR_SHIFT
130 ; Absolute maximum # of sectors
133 ; And invoke the program...
138 push word 0 ; Return to address 0 -> exit
140 jmp comboot_seg:100h ; Run it
142 ; Proper return vector
143 comboot_return: cli ; Don't trust anyone
147 ; Set up the COMBOOT API interrupt vectors. This is also used
151 mov di,4*0x20 ; DOS interrupt vectors
152 mov eax,comboot_return ; INT 20h = exit
154 mov ax,comboot_int21 ; INT 21h = DOS-compatible syscalls
156 mov ax,comboot_int22 ; INT 22h = proprietary syscalls
159 mov cx,29 ; All remaining DOS vectors
163 ; INT 21h: generic DOS system call
174 mov bp,sp ; Set up stack frame
176 call adjust_screen ; The COMBOOT program might have changed the screen
184 ; The last function in the list is the
185 ; "no such function" function
187 call ax ; Call the invoked function
189 setc P_FLAGSL ; Propagate CF->error
197 ; Attempted to execute non-21h DOS system call
198 comboot_bogus: cli ; Don't trust anyone
201 ; Generic COMBOOT return to command line code
202 ; BX -> where to go next
205 mov bx,enter_command ; Normal return to command prompt
206 comboot_exit_special:
207 RESET_STACK_AND_SEGS AX
208 call adjust_screen ; The COMBOOT program might have changed the screen
212 ; INT 21h system calls
214 comboot_getkey: ; 01 = get key with echo
222 comboot_writechr: ; 02 = writechr
228 comboot_writeserial: ; 04 = write serial port
234 comboot_getkeynoecho: ; 08 = get key w/o echo
239 comboot_writestr: ; 09 = write DOS string
243 cmp al,'$' ; End string with $ - bizarre
250 comboot_checkkey: ; 0B = check keyboard status
251 cmp byte [APIKeyFlag],00h
255 dec al ; AL = 0FFh if present, 0 if not
260 comboot_checkver: ; 30 = check DOS version
261 ; We return 0 in all DOS-compatible version registers,
262 ; but the high part of eax-ebx-ecx-edx spell "SYSLINUX"
270 cmp byte [APIKeyFlag],00h
272 call getchar ; If not queued get input
273 and al,al ; Function key? (CF <- 0)
275 mov [APIKeyWait],ah ; High part of key
276 inc byte [APIKeyFlag] ; Set flag
279 .queued: mov al,[APIKeyWait]
280 dec byte [APIKeyFlag]
284 ; INT 22h - SYSLINUX-specific system calls
285 ; System call number in ax
298 mov bp,sp ; Set up stack frame
300 call adjust_screen ; The COMBOOT program might have changed the screen
304 xor ax,ax ; Function 0 -> unimplemented
308 call [bx+int22_table]
309 jmp comboot_resume ; On return
312 ; INT 22h AX=0000h Unimplemented call
319 ; INT 22h AX=0001h Get SYSLINUX version
322 ; Number of API functions supported
325 mov P_CX,(VER_MAJOR << 8)+VER_MINOR
326 ; SYSLINUX derivative ID byte
329 mov P_BX,cs ; cs == 0
332 ; ES:SI -> version banner
333 mov P_SI,syslinux_banner
334 ; ES:DI -> copyright string
335 mov P_DI,copyright_str
342 ; INT 22h AX=0002h Write string
344 ; Write null-terminated string in ES:BX
354 ; INT 22h AX=0003h Run command
356 ; Terminates the COMBOOT program and executes the command line in
357 ; ES:BX as if it had been entered by the user.
364 mov bx,load_kernel ; Run a new kernel
365 jmp comboot_exit_special ; Terminate task, clean up
368 ; INT 22h AX=0004h Run default command
370 ; Terminates the COMBOOT program and executes the default command line
371 ; as if a timeout had happened or the user pressed <Enter>.
375 jmp comboot_exit_special
378 ; INT 22h AX=0005h Force text mode
380 ; Puts the video in standard text mode
388 ; INT 22h AX=0006h Open file
409 ; INT 22h AX=0007h Read file
418 xor si,si ; SI <- 0 on EOF, CF <- 0
423 ; INT 22h AX=0008h Close file
426 ; Do nothing for now. Eventually implement
427 ; an internal API for this.
432 ; INT 22h AX=0009h Call PXE stack
444 comapi_pxecall equ comapi_err ; Not available
448 ; INT 22h AX=000Ah Get Derivative-Specific Info
452 %if IS_SYSLINUX || IS_MDSLINUX || IS_EXTLINUX
478 ; INT 22h AX=000Bh Get Serial Console Configuration
489 test byte [DisplayCon],01h
498 ; INT 22h AX=000Ch Perform final cleanup
502 ; Unload PXE if requested
505 sub bp,sp ; unload_pxe may move the stack around
507 add bp,sp ; restore frame pointer...
508 %elif IS_SYSLINUX || IS_MDSLINUX || IS_EXTLINUX
509 ; Restore original FDC table
510 mov eax,[OrigFDCTabPtr]
513 ; Reset the floppy disk subsystem
521 ; INT 22h AX=000Dh Clean up then replace bootstrap
526 mov [trackbuf+4],eax ; Copy from
528 mov [trackbuf+8],eax ; Total bytes
530 mov [trackbuf],eax ; Copy to
531 mov [EntryPoint],eax ; CS:IP entry point
535 jmp replace_bootstrap_one
539 ; INT 22h AX=000Eh Get configuration file name
548 ; INT 22h AX=000Fh Get IPAPPEND strings
553 mov P_CX,numIPAppends
560 IPAppends dw IPOption
562 numIPAppends equ ($-IPAppends)/2
565 comapi_ipappend equ comapi_err
571 ; INT 22h AX=0010h Resolve hostname
581 comapi_dnsresolv equ comapi_err
587 ; INT 22h AX=0011h Maximum number of shuffle descriptors
590 mov P_CX,(2*trackbufsize)/12
594 ; INT 22h AX=0012h Cleanup, shuffle and boot
599 cmp cx,(2*trackbufsize)/12
602 push cx ; On stack: descriptor count
604 lea cx,[ecx+ecx*2] ; CX *= 3
609 push di ; On stack: descriptor list address
610 fs rep movsd ; Copy the list
613 mov [EntryPoint],eax ; CS:IP entry point
617 jmp replace_bootstrap
623 ; INT 22h AX=0013h Idle call
627 ; The idle call seems to have detrimental effects on some machines when
628 ; called from a COM32 context (WHY?) -- disable it for now.
630 %if 0 ; def HAVE_IDLE
639 comapi_idle equ comapi_err
644 ; INT 22h AX=0014h Local boot
646 %if IS_PXELINUX || IS_ISOLINUX
651 comapi_localboot equ comapi_err
655 ; INT 22h AX=0015h Feature flags
659 mov P_BX,feature_flags
660 mov P_CX,feature_flags_len
665 ; INT 22h AX=0016h Run kernel image
679 ; The kernel image was found, so we can load it...
682 mov [Kernel_EAX+2],dx
684 ; It's not just possible, but quite likely, that ES:BX
685 ; points into real_mode_seg, so we need to exercise some
686 ; special care here... use xfer_buf_seg as an intermediary
704 jmp comboot_exit_special
707 ; Copy the command line into its proper place
717 mov byte [es:di-1],' ' ; Simulate APPEND
721 mov word [CmdOptPtr],zero_string
722 jmp kernel_good_saved
732 int21 00h, comboot_return
733 int21 01h, comboot_getkey
734 int21 02h, comboot_writechr
735 int21 04h, comboot_writeserial
736 int21 08h, comboot_getkeynoecho
737 int21 09h, comboot_writestr
738 int21 0Bh, comboot_checkkey
739 int21 30h, comboot_checkver
740 int21 4Ch, comboot_return
741 int21 -1, comboot_bogus
742 int21_count equ ($-int21_table)/3
746 dw comapi_err ; 0000 unimplemented syscall
747 dw comapi_get_version ; 0001 get SYSLINUX version
748 dw comapi_writestr ; 0002 write string
749 dw comapi_run ; 0003 run specified command
750 dw comapi_run_default ; 0004 run default command
751 dw comapi_textmode ; 0005 force text mode
752 dw comapi_open ; 0006 open file
753 dw comapi_read ; 0007 read file
754 dw comapi_close ; 0008 close file
755 dw comapi_pxecall ; 0009 call PXE stack
756 dw comapi_derinfo ; 000A derivative-specific info
757 dw comapi_serialcfg ; 000B get serial port config
758 dw comapi_cleanup ; 000C perform final cleanup
759 dw comapi_chainboot ; 000D clean up then bootstrap
760 dw comapi_configfile ; 000E get name of config file
761 dw comapi_ipappend ; 000F get ipappend strings
762 dw comapi_dnsresolv ; 0010 resolve hostname
763 dw comapi_maxshuffle ; 0011 maximum shuffle descriptors
764 dw comapi_shuffle ; 0012 cleanup, shuffle and boot
765 dw comapi_idle ; 0013 idle call
766 dw comapi_localboot ; 0014 local boot
767 dw comapi_features ; 0015 feature flags
768 dw comapi_runkernel ; 0016 run kernel image
769 int22_count equ ($-int22_table)/2
774 zero_string db 0 ; Empty, null-terminated string
777 ; This is the feature flag array for INT 22h AX=0015h
780 db 1 ; Have local boot, idle not noop
782 db 3 ; Have local boot, idle is noop
784 db 2 ; No local boot, idle is noop
786 feature_flags_len equ ($-feature_flags)