Releasing debian version 4.04+dfsg-9.
[syslinux-debian/hramrach.git] / core / ui.inc
blob0a4bb569cf2978f17bfb60b9ef1a6b4d345f1850
1 ;; -----------------------------------------------------------------------
2 ;;
3 ;;   Copyright 1994-2009 H. Peter Anvin - All Rights Reserved
4 ;;   Copyright 2009-2010 Intel Corporation; author: H. Peter Anvin
5 ;;
6 ;;   This program is free software; you can redistribute it and/or modify
7 ;;   it under the terms of the GNU General Public License as published by
8 ;;   the Free Software Foundation, Inc., 53 Temple Place Ste 330,
9 ;;   Boston MA 02111-1307, USA; either version 2 of the License, or
10 ;;   (at your option) any later version; incorporated herein by reference.
12 ;; -----------------------------------------------------------------------
15 ; This file should be entered with the config file open (for getc)
17 load_config_file:
18                 call parse_config               ; Parse configuration file
19 no_config_file:
21                 call adv_init
23 ; Check for an ADV boot-once entry
25                 mov dl,ADV_BOOTONCE
26                 call adv_get
27                 jcxz .no_bootonce
29 .have_bootone:
30                 ; We apparently have a boot-once set; clear it and
31                 ; then execute the boot-once...
33                 ; Save the boot-once data; SI = data, CX = length
34                 mov di,command_line
35                 rep movsb
36                 xor ax,ax
37                 stosb
39                 ; Clear the boot-once data from the ADV
40                 xor cx,cx                       ; Set to zero = delete
41                 call adv_set
42                 jc .err
43                 call adv_write
44 .err:           jmp load_kernel
46 .no_bootonce:
49 ; Check whether or not we are supposed to display the boot prompt.
51 check_for_key:
52                 test byte [KbdFlags],5Bh        ; Shift Alt Caps Scroll
53                 jnz enter_command
54                 cmp word [ForcePrompt],0        ; Force prompt?
55                 jz auto_boot
56                 cmp word [DefaultLevel],1       ; Active UI statement?
57                 ja auto_boot
59 enter_command:
60                 cmp word [NoEscape],0           ; If NOESCAPE, no prompt,
61                 jne auto_boot                   ; always run default cmd
63                 mov si,boot_prompt
64                 call writestr
66                 mov byte [FuncFlag],0           ; <Ctrl-F> not pressed
67                 mov di,command_line
70 ; get the very first character -- we can either time
71 ; out, or receive a character press at this time.  Some dorky BIOSes stuff
72 ; a return in the buffer on bootup, so wipe the keyboard buffer first.
74 clear_buffer:   mov ah,11h                      ; Check for pending char
75                 int 16h
76                 jz get_char_time
77                 mov ah,10h                      ; Get char
78                 int 16h
79                 jmp short clear_buffer
81                 ; For the first character, both KbdTimeout and
82                 ; TotalTimeout apply; after that, only TotalTimeout.
84 get_char_time:
85                 mov eax,[TotalTimeout]
86                 mov [ThisTotalTo],eax
87                 mov eax,[KbdTimeout]
88                 mov [ThisKbdTo],eax
90 get_char:
91                 call getchar_timeout
92                 and dword [ThisKbdTo],0         ; For the next time...
94                 and al,al
95                 jz func_key
97 got_ascii:      cmp al,7Fh                      ; <DEL> == <BS>
98                 je backspace
99                 cmp al,' '                      ; ASCII?
100                 jb not_ascii
101                 ja enter_char
102                 cmp di,command_line             ; Space must not be first
103                 je short get_char
104 enter_char:     test byte [FuncFlag],1
105                 jnz ctrl_f                      ; Keystroke after <Ctrl-F>
106                 cmp di,max_cmd_len+command_line ; Check there's space
107                 jnb short get_char
108                 stosb                           ; Save it
109                 call writechr                   ; Echo to screen
110                 jmp short get_char
111 not_ascii:
112                 cmp al,0Dh                      ; Enter
113                 je command_done
114                 cmp al,09h                      ; Tab
115                 je display_labels
116                 cmp al,'F' & 1Fh                ; <Ctrl-F>
117                 je set_func_flag
118 %if IS_PXELINUX
119                 cmp al,'N' & 1Fh                ; <Ctrl-N>
120                 je show_network_info
121 %endif
122                 cmp al,'U' & 1Fh                ; <Ctrl-U>
123                 je kill_command                 ; Kill input line
124                 cmp al,'V' & 1Fh                ; <Ctrl-V>
125                 je print_version
126                 cmp al,'X' & 1Fh                ; <Ctrl-X>
127                 je force_text_mode
128                 cmp al,08h                      ; Backspace
129                 jne get_char
130 backspace:      cmp di,command_line             ; Make sure there is anything
131                 je get_char                     ; to erase
132                 dec di                          ; Unstore one character
133                 mov si,wipe_char                ; and erase it from the screen
134                 call writestr
135 get_char_2:
136                 jmp short get_char
138 kill_command:
139                 call crlf
140                 jmp enter_command
142 force_text_mode:
143                 call vgaclearmode
144                 jmp enter_command
146 set_func_flag:
147                 mov byte [FuncFlag],1
148                 jmp short get_char_2
150 display_labels:
151                 cmp word [NoComplete],0         ; Label completion enabled?
152                 jne get_char_2
153                 push di                         ; Save pointer
154                 mov cx,di
155                 sub cx,command_line
156                 call crlf
157                 mov esi,[HighMemSize]           ; Start from top of memory
158 .scan:
159                 cmp esi,[VKernelEnd]
160                 jbe .not_vk
162                 push cx                         ; save command line size
164                 mov edi,VKernelBuf
165                 pm_call rllunpack
166                 ; ESI updated on return
168                 sub di,cx                       ; Return to beginning of buf
169                 pop cx                          ; restore command line size
170                 push si                         ; save SI
171                 cmp cx,0
172                 jz .print
173                 push di
174                 push cx
175                 mov si,command_line
176                 es repe cmpsb
177                 pop cx
178                 pop di
179                 jne .next
180 .print:
181                 mov al,' '
182                 call writechr
184                 mov si,di
185                 call writestr
186 .next:
187                 pop si                          ; restore SI
188                 jmp .scan
189 .not_vk:
190                 call crlf
191                 jmp fk_wrcmd
193 ctrl_f:
194                 xor ah,ah
195                 mov [FuncFlag],ah
196                 cmp al,'0'
197                 jb get_char_2
198                 je .zero                        ; <Ctrl-F>0 = F10
199                 or al,20h                       ; Lower case
200                 cmp al,'9'
201                 jna .digit
202                 cmp al,'a'                      ; F10-F12 = <Ctrl-F>A, B, C
203                 jb get_char_2
204                 cmp al,'c'
205                 ja get_char_2
206                 sub al,'a'-10
207                 jmp show_help
208 .zero:
209                 mov al,10
210                 jmp show_help
211 .digit:
212                 sub al,'1'
213                 jmp show_help
215 func_key:
216                 ; AL = 0 if we get here
217                 xchg al,ah
218                 cmp al,44h                      ; F10
219                 ja .f11_f12
220                 sub al,3Bh                      ; F1
221                 jb get_char_2
222                 jmp show_help
223 .f11_f12:
224                 cmp al,85h                      ; F11
225                 jb get_char_2
226                 cmp al,86h                      ; F12
227                 ja get_char_2
228                 sub al,85h-10
230 show_help:      ; AX = func key # (0 = F1, 9 = F10, 11 = F12)
231                 push di                         ; Save end-of-cmdline pointer
232                 shl ax,FILENAME_MAX_LG2         ; Convert to pointer
233                 add ax,FKeyName
234                 xchg di,ax
235                 cmp byte [di+NULLOFFSET],NULLFILE
236                 je short fk_nofile              ; Undefined F-key
237                 call core_open
238                 jz short fk_nofile              ; File not found
239                 call crlf
240                 call get_msg_file
241                 jmp short fk_wrcmd
243 print_version:
244                 push di                         ; Command line write pointer
245                 mov si,syslinux_banner
246                 call writestr
247 %ifdef HAVE_BIOSNAME
248                 mov si,[BIOSName]
249                 call writestr
250 %endif
251                 mov si,copyright_str
252                 call writestr
254                 ; ... fall through ...
256                 ; Write the boot prompt and command line again and
257                 ; wait for input.  Note that this expects the cursor
258                 ; to already have been CRLF'd, and that the old value
259                 ; of DI (the command line write pointer) is on the stack.
260 fk_wrcmd:
261                 mov si,boot_prompt
262                 call writestr
263                 pop di                          ; Command line write pointer
264                 push di
265                 mov byte [di],0                 ; Null-terminate command line
266                 mov si,command_line
267                 call writestr                   ; Write command line so far
268 fk_nofile:      pop di
269                 jmp get_char
272 ; Show network info (in the form of the ipappend strings)
274 %if IS_PXELINUX
275 show_network_info:
276                 push di                         ; Command line write pointer
277                 call crlf
278                 mov si,IPAppends                ; See comboot.doc
279                 mov cx,numIPAppends
280 .loop:
281                 lodsw
282                 push si
283                 mov si,ax
284                 call writestr
285                 call crlf
286                 pop si
287                 loop .loop
288                 jmp fk_wrcmd
289 %endif
292 ; Jump here to run the default command line
294 auto_boot:
295                 cmp word [DefaultLevel],0       ; No UI or DEFAULT?
296                 jne .have_default
297                 mov si,no_default_msg
298                 call writestr
299                 cmp word [NoEscape],0           ; NOESCAPE but no DEFAULT?
300                 jne kaboom                      ; If so, we're stuck!
301                 jmp enter_command
303 .have_default:
304                 mov si,default_cmd
305                 mov di,command_line
306                 mov cx,(max_cmd_len+4) >> 2
307                 rep movsd
308                 jmp short load_kernel
310                 section .data16
311 no_default_msg  db 'No DEFAULT or UI configuration directive found!'
312                 db CR, LF, 0
314                 section .text16
317 ; Jump here when the command line is completed
319 command_done:
320                 call crlf
321                 cmp di,command_line             ; Did we just hit return?
322                 je auto_boot
323                 xor al,al                       ; Store a final null
324                 stosb
326 load_kernel:                                    ; Load the kernel now
328 ; First we need to mangle the kernel name the way DOS would...
330                 mov si,command_line
331                 mov di,KernelName
332                 push si
333                 pm_call pm_mangle_name
334                 pop si
336 ; Fast-forward to first option (we start over from the beginning, since
337 ; pm_mangle_name doesn't necessarily return a consistent ending state.)
339 clin_non_wsp:   lodsb
340                 cmp al,' '
341                 ja clin_non_wsp
342 clin_is_wsp:    and al,al
343                 jz clin_opt_ptr
344                 lodsb
345                 cmp al,' '
346                 jbe clin_is_wsp
347 clin_opt_ptr:   dec si                          ; Point to first nonblank
348                 mov [CmdOptPtr],si              ; Save ptr to first option
350 ; If "allowoptions 0", put a null character here in order to ignore any
351 ; user-specified options.
353                 mov ax,[AllowOptions]
354                 and ax,ax
355                 jnz clin_opt_ok
356                 mov [si],al
357 clin_opt_ok:
360 ; Now check if it is a "virtual kernel"
362 vk_check:
363                 mov esi,[HighMemSize]           ; Start from top of memory
364 .scan:
365                 cmp esi,[VKernelEnd]
366                 jbe .not_vk
368                 mov edi,VKernelBuf
369                 pm_call rllunpack
370                 ; ESI updated on return
372                 sub di,cx                       ; Return to beginning of buf
373                 push si
374                 mov si,command_line
375 .loop:
376                 lodsb
377                 cmp al,' '
378                 jbe .done
379                 scasb
380                 je .loop
381 .nomatch:
382                 pop si
383                 jmp .scan
384 .done:
385                 cmp byte [di],0                 ; Must match end of string
386                 jne .nomatch
387                 pop si
390 ; We *are* using a "virtual kernel"
392 .found:
393                 push es
394                 push word real_mode_seg
395                 pop es
396                 mov di,cmd_line_here
397                 mov si,VKernelBuf+vk_append
398                 mov cx,[VKernelBuf+vk_appendlen]
399                 rep movsb
400                 mov byte [es:di],cl             ; Null-terminate
401                 mov [CmdLinePtr],di             ; Where to add rest of cmd
402                 pop es
403                 mov di,KernelName
404                 push di
405                 mov si,VKernelBuf+vk_rname
406                 mov cx,FILENAME_MAX             ; We need ECX == CX later
407                 rep movsb
408                 pop di
409 %if IS_PXELINUX
410                 mov al,[VKernelBuf+vk_ipappend]
411                 mov [IPAppend],al
412 %endif
413                 xor bx,bx                       ; Try only one version
415                 mov al,[VKernelBuf+vk_type]
416                 mov [KernelType],al
418                 ; Is this a "localboot" pseudo-kernel?
419                 cmp al,VK_LOCALBOOT             ; al == KernelType
420                 mov ax,[VKernelBuf+vk_rname]    ; Possible localboot type
421                 je local_boot
422                 jmp get_kernel
424 .not_vk:
426 ; Not a "virtual kernel" - check that's OK and construct the command line
428                 cmp word [AllowImplicit],byte 0
429                 je bad_implicit
430                 push es
431                 push si
432                 push di
433                 mov di,real_mode_seg
434                 mov es,di
435                 mov si,AppendBuf
436                 mov di,cmd_line_here
437                 mov cx,[AppendLen]
438                 rep movsb
439                 mov byte [es:di],cl             ; Null-terminate
440                 mov [CmdLinePtr],di
441                 pop di
442                 pop si
443                 pop es
445                 mov [KernelType], cl            ; CL == 0 here
448 ; Find the kernel on disk
450 get_kernel:     mov byte [KernelName+FILENAME_MAX],0    ; Zero-terminate filename/extension
451                 mov di,KernelName
452                 cmp byte [di],' '
453                 jbe bad_kernel                  ; Missing kernel name
454                 xor al,al
455                 mov cx,FILENAME_MAX-5           ; Need 4 chars + null
456                 repne scasb                     ; Scan for final null
457                 jne .no_skip
458                 dec di                          ; Point to final null
459 .no_skip:       mov [KernelExtPtr],di
460                 mov bx,exten_table
461 .search_loop:   push bx
462                 mov di,KernelName               ; Search on disk
463                 pm_call pm_searchdir
464                 pop bx
465                 jnz kernel_good
466                 mov eax,[bx]                    ; Try a different extension
467                 mov si,[KernelExtPtr]
468                 mov [si],eax
469                 mov byte [si+4],0
470                 add bx,byte 4
471                 cmp bx,exten_table_end
472                 jna .search_loop                ; allow == case (final case)
473                 ; Fall into bad_kernel
475 ; bad_kernel: Kernel image not found
476 ; bad_implicit: The user entered a nonvirtual kernel name, with "implicit 0"
478 bad_implicit:
479 bad_kernel:
480                 mov cx,[OnerrorLen]
481                 and cx,cx
482                 jnz on_error
483 .really:
484                 mov si,err_notfound             ; Complain about missing kernel
485                 call writestr
486                 mov si,KernelName
487                 call writestr
488                 mov si,crlf_msg
489                 jmp abort_load                  ; Ask user for clue
492 ; on_error: bad kernel, but we have onerror set; CX = OnerrorLen
494 on_error:
495                 mov si,Onerror
496                 mov di,command_line
497                 push si                         ; <A>
498                 push di                         ; <B>
499                 push cx                         ; <C>
500                 push cx                         ; <D>
501                 push di                         ; <E>
502                 repe cmpsb
503                 pop di                          ; <E> di == command_line
504                 pop bx                          ; <D> bx == [OnerrorLen]
505                 je bad_kernel.really            ; Onerror matches command_line already
506                 neg bx                          ; bx == -[OnerrorLen]
507                 lea cx,[max_cmd_len+bx]
508                 ; CX == max_cmd_len-[OnerrorLen]
509                 mov di,command_line+max_cmd_len-1
510                 mov byte [di+1],0               ; Enforce null-termination
511                 lea si,[di+bx]
512                 std
513                 rep movsb                       ; Make space in command_line
514                 cld
515                 pop cx                          ; <C> cx == [OnerrorLen]
516                 pop di                          ; <B> di == command_line
517                 pop si                          ; <A> si  == Onerror
518                 rep movsb
519                 jmp load_kernel
522 ; kernel_corrupt: Called if the kernel file does not seem healthy
524 kernel_corrupt: mov si,err_notkernel
525                 jmp abort_load
528 ; Get a key, observing ThisKbdTO and ThisTotalTO -- those are timeouts
529 ; which can be adjusted by the caller based on the corresponding
530 ; master variables; on return they're updated.
532 ; This cheats.  If we say "no timeout" we actually get a timeout of
533 ; 7.5 years.
535 getchar_timeout:
536                 call vgashowcursor
537                 call reset_idle
539 .loop:
540                 push word [__jiffies]
541                 call pollchar
542                 jnz .got_char
543                 call do_idle
544                 pop ax
545                 cmp ax,[__jiffies]              ; Has the timer advanced?
546                 je .loop
548                 dec dword [ThisKbdTo]
549                 jz .timeout
550                 dec dword [ThisTotalTo]
551                 jnz .loop
553 .timeout:
554                 ; Timeout!!!!
555                 pop cx                          ; Discard return address
556                 call vgahidecursor
557                 mov si,Ontimeout                ; Copy ontimeout command
558                 mov di,command_line
559                 mov cx,[OntimeoutLen]           ; if we have one...
560                 rep movsb
561                 jmp command_done
563 .got_char:
564                 pop cx                          ; Discard
565                 call getchar
566                 call vgahidecursor
567                 ret
570 ; This is it!  We have a name (and location on the disk)... let's load
571 ; that sucker!!  First we have to decide what kind of file this is; base
572 ; that decision on the file extension.  The following extensions are
573 ; recognized; case insensitive:
575 ; .com  - COMBOOT image
576 ; .cbt  - COMBOOT image
577 ; .c32  - COM32 image
578 ; .bs   - Boot sector
579 ; .0    - PXE bootstrap program (PXELINUX only)
580 ; .bin  - Boot sector
581 ; .bss  - Boot sector, but transfer over DOS superblock (SYSLINUX only)
582 ; .img  - Floppy image (ISOLINUX only)
584 ; Anything else is assumed to be a Linux kernel.
586                 section .bss16
587                 alignb 4
588 Kernel_EAX      resd 1
589 Kernel_SI       resw 1
591                 section .text16
592 kernel_good_saved:
593                 ; Alternate entry point for which the return from
594                 ; searchdir is stored in memory.  This is used for
595                 ; COMBOOT function INT 22h, AX=0016h.
596                 mov si,[Kernel_SI]
597                 mov eax,[Kernel_EAX]
599 kernel_good:
600                 pushad
601                 ;
602                 ; Common initialization for all kernel types
603                 ;
604                 xor ax,ax
605                 mov [InitRDPtr],ax
606                 mov [QuietBoot],al
607 %if IS_PXELINUX
608                 mov [KeepPXE],al
609 %endif
611                 ; Default memory limit, can be overridden by image loaders
612                 mov eax,[HighMemRsvd]
613                 mov [MyHighMemSize],eax
615                 popad
617                 push di
618                 push ax
619                 mov di,KernelName
620                 xor al,al
621                 mov cx,FILENAME_MAX
622                 repne scasb
623                 jne .one_step
624                 dec di
625 .one_step:      mov ecx,[di-4]                  ; 4 bytes before end
626                 pop ax
627                 pop di
630 ; At this point, EAX contains the size of the kernel, SI contains
631 ; the file handle/cluster pointer, and ECX contains the extension (if any.)
633                 movzx di,byte [KernelType]
634                 add di,di
635                 jmp [kerneltype_table+di]
637 is_unknown_filetype:
638                 or ecx,20202000h                ; Force lower case (except dot)
640                 cmp ecx,'.com'
641                 je is_comboot_image
642                 cmp ecx,'.cbt'
643                 je is_comboot_image
644                 cmp ecx,'.c32'
645                 je is_com32_image
646 %if IS_ISOLINUX
647                 cmp ecx,'.img'
648                 je is_disk_image
649 %endif
650                 cmp ecx,'.bss'
651                 je is_bss_sector
652                 cmp ecx,'.bin'
653                 je is_bootsector
654                 shr ecx,8
655                 cmp ecx,'.bs'
656                 je is_bootsector
657                 shr ecx,8
658                 cmp cx,'.0'
659                 je is_bootsector
661                 ; Otherwise Linux kernel
662                 jmp is_linux_kernel
664 is_config_file:
665                 push si
666                 call make_plain_cmdline
667                 pm_call pm_is_config_file
668                 pop si
669                 call openfd
670                 call reset_config
671                 jmp load_config_file
673 ; This is an image type we can't deal with
674 is_bad_image:
675                 mov si,err_badimage
676                 call writestr
677                 jmp enter_command
679 %if IS_SYSLINUX
680                 ; ok
681 %else
682 is_bss_sector   equ is_bad_image
683 %endif
684 %if IS_ISOLINUX
685                 ; ok
686 %else
687 is_disk_image   equ is_bad_image
688 %endif
690                 section .data16
691 boot_prompt     db 'boot: ', 0
692 wipe_char       db BS, ' ', BS, 0
693 err_badimage    db 'Invalid image type for this media type!', CR, LF, 0
694 err_notfound    db 'Could not find kernel image: ',0
695 err_notkernel   db CR, LF, 'Invalid or corrupt kernel image.', CR, LF, 0
698                 alignz 2
699 kerneltype_table:
700                 dw is_unknown_filetype  ; VK_KERNEL
701                 dw is_linux_kernel      ; VK_LINUX
702                 dw is_bootsector        ; VK_BOOT
703                 dw is_bss_sector        ; VK_BSS
704                 dw is_bootsector        ; VK_PXE
705                 dw is_disk_image        ; VK_FDIMAGE
706                 dw is_comboot_image     ; VK_COMBOOT
707                 dw is_com32_image       ; VK_COM32
708                 dw is_config_file       ; VK_CONFIG
710                 section .bss16
711                 alignb 4
712 ThisKbdTo       resd 1                  ; Temporary holder for KbdTimeout
713 ThisTotalTo     resd 1                  ; Temporary holder for TotalTimeout
714 KernelExtPtr    resw 1                  ; During search, final null pointer
715 CmdOptPtr       resw 1                  ; Pointer to first option on cmd line
716 KbdFlags        resb 1                  ; Check for keyboard escapes
717 FuncFlag        resb 1                  ; Escape sequences received from keyboard
718 KernelType      resb 1                  ; Kernel type, from vkernel, if known
720                 section .text16
722 ; Linux kernel loading code is common.
724 %include "runkernel.inc"
727 ; COMBOOT-loading code
729 %include "comboot.inc"
730 %include "com32.inc"
731 %include "cmdline.inc"
734 ; Boot sector loading code
736 %include "bootsect.inc"
739 ; Abort loading code
741 %include "abort.inc"
744 ; Hardware cleanup common code
746 %include "cleanup.inc"