1 ;; -----------------------------------------------------------------------
3 ;; Copyright 1994-2008 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.
74 cmp eax,0ff00h ; Max size in bytes
77 push si ; Save file handle
79 call make_plain_cmdline
81 call comboot_setup_api
87 mov cx,64 ; 256 bytes (size of PSP)
88 xor eax,eax ; Clear PSP
91 mov word [es:0], 020CDh ; INT 20h instruction
92 ; First non-free paragraph
93 ; This is valid because comboot_seg == real_mode_seg
94 ; == the highest segment used by all derivatives
95 int 12h ; Get DOS memory size
96 shl ax,6 ; Kilobytes -> paragraphs
100 %if real_mode_seg != comboot_seg
101 %error "This code assumes real_mode_seg == comboot_seg"
104 ; Copy the command line from high memory
106 mov cx,125 ; Max cmdline len (minus space and CR)
107 mov di,081h ; Offset in PSP for command line
108 mov al,' ' ; DOS command lines begin with a space
118 mov al,0Dh ; CR after last character
121 sub al,82h ; Include space but not CR
122 mov [es:80h],al ; Store command line length
124 ; Now actually load the file...
126 mov bx,100h ; Load at <seg>:0100h
127 mov cx,0FF00h >> SECTOR_SHIFT
128 ; Absolute maximum # of sectors
131 ; And invoke the program...
136 push word 0 ; Return to address 0 -> exit
138 jmp comboot_seg:100h ; Run it
140 ; Proper return vector
141 comboot_return: cli ; Don't trust anyone
142 push enter_command ; Normal return to command prompt
146 ; Set up the COMBOOT API interrupt vectors. This is also used
150 mov di,4*0x20 ; DOS interrupt vectors
151 mov eax,comboot_return ; INT 20h = exit
153 mov ax,comboot_int21 ; INT 21h = DOS-compatible syscalls
155 mov ax,comboot_int22 ; INT 22h = proprietary syscalls
158 mov cx,29 ; All remaining DOS vectors
162 ; INT 21h: generic DOS system call
173 mov bp,sp ; Set up stack frame
175 call adjust_screen ; The COMBOOT program might have changed the screen
183 ; The last function in the list is the
184 ; "no such function" function
186 call ax ; Call the invoked function
188 mov bp,sp ; In case the function clobbers BP
189 setc P_FLAGSL ; Propagate CF->error
197 ; Attempted to execute non-21h DOS system call
198 comboot_bogus: cli ; Don't trust anyone
204 ; Generic COMBOOT return to command line code
205 ; stack -> where to go next
206 ; CX -> message (for _msg version)
211 pop bx ; Return address
212 RESET_STACK_AND_SEGS AX
213 call adjust_screen ; The COMBOOT program might have changed the screen
223 ; INT 21h system calls
225 comboot_getkey: ; 01 = get key with echo
233 comboot_writechr: ; 02 = writechr
239 comboot_writeserial: ; 04 = write serial port
245 comboot_getkeynoecho: ; 08 = get key w/o echo
250 comboot_writestr: ; 09 = write DOS string
254 cmp al,'$' ; End string with $ - bizarre
261 comboot_checkkey: ; 0B = check keyboard status
262 cmp byte [APIKeyFlag],00h
266 dec al ; AL = 0FFh if present, 0 if not
271 comboot_checkver: ; 30 = check DOS version
272 ; We return 0 in all DOS-compatible version registers,
273 ; but the high part of eax-ebx-ecx-edx spell "SYSLINUX"
281 cmp byte [APIKeyFlag],00h
283 call getchar ; If not queued get input
284 and al,al ; Function key? (CF <- 0)
286 mov [APIKeyWait],ah ; High part of key
287 inc byte [APIKeyFlag] ; Set flag
290 .queued: mov al,[APIKeyWait]
291 dec byte [APIKeyFlag]
295 ; INT 22h - SYSLINUX-specific system calls
296 ; System call number in ax
309 mov bp,sp ; Set up stack frame
311 call adjust_screen ; The COMBOOT program might have changed the screen
315 xor ax,ax ; Function 0 -> unimplemented
319 call [bx+int22_table]
320 jmp comboot_resume ; On return
323 ; INT 22h AX=0000h Unimplemented call
330 ; INT 22h AX=0001h Get SYSLINUX version
333 ; Number of API functions supported
336 mov P_CX,(VER_MAJOR << 8)+VER_MINOR
337 ; SYSLINUX derivative ID byte
340 mov P_BX,cs ; cs == 0
343 ; ES:SI -> version banner
344 mov P_SI,syslinux_banner
345 ; ES:DI -> copyright string
346 mov P_DI,copyright_str
353 ; INT 22h AX=0002h Write string
355 ; Write null-terminated string in ES:BX
365 ; INT 22h AX=0003h Run command
367 ; Terminates the COMBOOT program and executes the command line in
368 ; ES:BX as if it had been entered by the user.
375 push load_kernel ; Run a new kernel
376 jmp comboot_exit ; Terminate task, clean up
379 ; INT 22h AX=0004h Run default command
381 ; Terminates the COMBOOT program and executes the default command line
382 ; as if a timeout had happened or the user pressed <Enter>.
389 ; INT 22h AX=0005h Force text mode
391 ; Puts the video in standard text mode
399 ; INT 22h AX=0006h Open file
417 ; INT 22h AX=0007h Read file
426 xor si,si ; SI <- 0 on EOF, CF <- 0
431 ; INT 22h AX=0008h Close file
440 ; INT 22h AX=0009h Call PXE stack
452 comapi_pxecall equ comapi_err ; Not available
456 ; INT 22h AX=000Ah Get Derivative-Specific Info
474 mov P_CL,SECTOR_SHIFT
479 %if IS_SYSLINUX || IS_MDSLINUX || IS_EXTLINUX
491 ; INT 22h AX=000Bh Get Serial Console Configuration
502 test byte [DisplayCon],01h
511 ; INT 22h AX=000Ch Perform final cleanup
515 ; Unload PXE if requested
518 sub bp,sp ; unload_pxe may move the stack around
520 add bp,sp ; restore frame pointer...
521 %elif IS_SYSLINUX || IS_MDSLINUX || IS_EXTLINUX
522 ; Restore original FDC table
523 mov eax,[OrigFDCTabPtr]
526 ; Reset the floppy disk subsystem
534 ; INT 22h AX=000Dh Clean up then replace bootstrap
539 mov [trackbuf+4],eax ; Copy from
541 mov [trackbuf+8],eax ; Total bytes
543 mov [trackbuf],eax ; Copy to
544 mov [EntryPoint],eax ; CS:IP entry point
548 jmp replace_bootstrap_one
552 ; INT 22h AX=000Eh Get configuration file name
561 ; INT 22h AX=000Fh Get IPAPPEND strings
566 mov P_CX,numIPAppends
573 IPAppends dw IPOption
575 numIPAppends equ ($-IPAppends)/2
578 comapi_ipappend equ comapi_err
584 ; INT 22h AX=0010h Resolve hostname
595 comapi_dnsresolv equ comapi_err
601 ; INT 22h AX=0011h Maximum number of shuffle descriptors
604 mov P_CX,trackbufsize/12
608 ; INT 22h AX=0012h Cleanup, shuffle and boot
611 cmp P_CX,(2*trackbufsize)/12
617 push cx ; On stack: descriptor count
619 lea cx,[ecx+ecx*2] ; CX *= 3
624 push di ; On stack: descriptor list address
625 fs rep movsd ; Copy the list
628 mov [EntryPoint],eax ; CS:IP entry point
632 jmp replace_bootstrap
638 ; INT 22h AX=0013h Idle call
642 ; The idle call seems to have detrimental effects on some machines when
643 ; called from a COM32 context (WHY?) -- disable it for now.
645 %if 0 ; def HAVE_IDLE
654 comapi_idle equ comapi_err
659 ; INT 22h AX=0014h Local boot
661 %if IS_PXELINUX || IS_ISOLINUX
666 comapi_localboot equ comapi_err
670 ; INT 22h AX=0015h Feature flags
674 mov P_BX,feature_flags
675 mov P_CX,feature_flags_len
680 ; INT 22h AX=0016h Run kernel image
696 ; The kernel image was found, so we can load it...
700 ; It's not just possible, but quite likely, that ES:BX
701 ; points into real_mode_seg, so we need to exercise some
702 ; special care here... use xfer_buf_seg as an intermediary
722 ; Copy the command line into its proper place
732 mov byte [es:di-1],' ' ; Simulate APPEND
736 mov word [CmdOptPtr],zero_string
737 jmp kernel_good_saved
739 .error equ comapi_shuffle.error
742 ; INT 22h AX=0017h Report video mode change
746 cmp ax,0Fh ; Unknown flags = failure
764 ; INT 22h AX=0018h Query custom font
779 ; INT 22h AX=0019h Read disk
781 %if IS_SYSLINUX || IS_MDSLINUX || IS_ISOLINUX || IS_EXTLINUX
783 mov esi,P_ESI ; Enforce ESI == EDI == 0, these
784 or esi,P_EDI ; are reserved for future expansion
789 mov bp,P_CX ; WE CANNOT use P_* after touching bp!
797 comapi_readdisk equ comapi_err
801 ; INT 22h AX=001Ah Cleanup, shuffle and boot to flat protected mode
804 cmp P_CX,(2*trackbufsize)/12
810 push cx ; On stack: descriptor count
812 lea cx,[ecx+ecx*2] ; CX *= 3
817 push di ; On stack: descriptor list address
818 fs rep movsd ; Copy the list
822 mov edi,TrampolineBuf
823 mov al,0B8h ; MOV EAX opcode
827 inc ax ; Next register opcode
828 fs movsd ; immediate value
830 mov byte [di-5],0E9h ; Last opcode is JMP
831 sub [di-4],edi ; Make JMP target relative
833 mov dword [EntryPoint],trampoline_to_pm
834 xor bx,bx ; DS on entry
835 jmp replace_bootstrap
841 ; INT 22h AX=001Bh Cleanup, shuffle and boot with register setting
844 cmp P_CX,(2*trackbufsize)/12
850 push cx ; On stack: descriptor count
852 lea cx,[ecx+ecx*2] ; CX *= 3
857 push di ; On stack: descriptor list address
858 fs rep movsd ; Copy the list
864 ; Generate segment-loading instructions
865 mov bx,0C08Eh ; MOV ES,AX
866 mov cl,6 ; 6 segment registers (incl CS)
869 stosb ; MOV AX,imm16 opcode
876 ; Clobber the MOV CS,AX instruction.
877 mov word [di-22], 9090h ; NOP NOP
879 ; Generate GPR-loading instructions
880 mov ax,0B866h ; MOV EAX,imm32
883 stosw ; MOV ExX,imm32 opcode
888 mov al,0EAh ; JMP FAR imm16:imm16 opcode
892 mov dword [EntryPoint],TrampolineBuf
893 jmp replace_bootstrap
899 ; INT 22h AX=001Ch Get pointer to auxillary data vector
908 ; INT 22h AX=001Dh Write auxillary data vector
910 comapi_writeadv equ adv_write
920 int21 00h, comboot_return
921 int21 01h, comboot_getkey
922 int21 02h, comboot_writechr
923 int21 04h, comboot_writeserial
924 int21 08h, comboot_getkeynoecho
925 int21 09h, comboot_writestr
926 int21 0Bh, comboot_checkkey
927 int21 30h, comboot_checkver
928 int21 4Ch, comboot_return
929 int21 -1, comboot_bogus
930 int21_count equ ($-int21_table)/3
934 dw comapi_err ; 0000 unimplemented syscall
935 dw comapi_get_version ; 0001 get SYSLINUX version
936 dw comapi_writestr ; 0002 write string
937 dw comapi_run ; 0003 run specified command
938 dw comapi_run_default ; 0004 run default command
939 dw comapi_textmode ; 0005 force text mode
940 dw comapi_open ; 0006 open file
941 dw comapi_read ; 0007 read file
942 dw comapi_close ; 0008 close file
943 dw comapi_pxecall ; 0009 call PXE stack
944 dw comapi_derinfo ; 000A derivative-specific info
945 dw comapi_serialcfg ; 000B get serial port config
946 dw comapi_cleanup ; 000C perform final cleanup
947 dw comapi_chainboot ; 000D clean up then bootstrap
948 dw comapi_configfile ; 000E get name of config file
949 dw comapi_ipappend ; 000F get ipappend strings
950 dw comapi_dnsresolv ; 0010 resolve hostname
951 dw comapi_maxshuffle ; 0011 maximum shuffle descriptors
952 dw comapi_shuffle ; 0012 cleanup, shuffle and boot
953 dw comapi_idle ; 0013 idle call
954 dw comapi_localboot ; 0014 local boot
955 dw comapi_features ; 0015 feature flags
956 dw comapi_runkernel ; 0016 run kernel image
957 dw comapi_usingvga ; 0017 report video mode change
958 dw comapi_userfont ; 0018 query custom font
959 dw comapi_readdisk ; 0019 read disk
960 dw comapi_shufflepm ; 001A cleanup, shuffle and boot to pm
961 dw comapi_shufflerm ; 001B cleanup, shuffle and boot to rm
962 dw comapi_getadv ; 001C get pointer to ADV
963 dw comapi_writeadv ; 001D write ADV to disk
964 int22_count equ ($-int22_table)/2
969 zero_string db 0 ; Empty, null-terminated string
972 ; This is the feature flag array for INT 22h AX=0015h
975 db 1 ; Have local boot, idle not noop
977 db 3 ; Have local boot, idle is noop
979 db 2 ; No local boot, idle is noop
981 feature_flags_len equ ($-feature_flags)
983 err_notdos db ': attempted DOS system call', CR, LF, 0
984 err_comlarge db 'COMBOOT image too large.', CR, LF, 0
987 ConfigName resb FILENAME_MAX