1 /* shared.h - definitions used in all GRUB-specific code */ 2 /* 3 * GRUB -- GRand Unified Bootloader 4 * Copyright (C) 1999,2000,2001,2002,2003,2004 Free Software Foundation, Inc. 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; either version 2 of the License, or 9 * (at your option) any later version. 10 * 11 * This program is distributed in the hope that it will be useful, 12 * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 * GNU General Public License for more details. 15 * 16 * You should have received a copy of the GNU General Public License 17 * along with this program; if not, write to the Free Software 18 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 19 */ 20 /* 21 * Copyright 2008 Sun Microsystems, Inc. All rights reserved. 22 * Use is subject to license terms. 23 */ 24 25 /* 26 * Generic defines to use anywhere 27 */ 28 29 #ifndef GRUB_SHARED_HEADER 30 #define GRUB_SHARED_HEADER 1 31 32 #include <config.h> 33 34 /* Add an underscore to a C symbol in assembler code if needed. */ 35 #ifdef HAVE_ASM_USCORE 36 # define EXT_C(sym) _ ## sym 37 #else 38 # define EXT_C(sym) sym 39 #endif 40 41 /* Maybe redirect memory requests through grub_scratch_mem. */ 42 #ifdef GRUB_UTIL 43 extern char *grub_scratch_mem; 44 # define RAW_ADDR(x) ((x) + (int) grub_scratch_mem) 45 # define RAW_SEG(x) (RAW_ADDR ((x) << 4) >> 4) 46 #else 47 # define RAW_ADDR(x) (x) 48 # define RAW_SEG(x) (x) 49 #endif 50 51 /* ZFS will use the top 4 Meg of physical memory (below 4Gig) for sratch */ 52 #define ZFS_SCRATCH_SIZE 0x400000 53 54 #ifndef MAXPATHLEN 55 #define MAXPATHLEN 1024 56 #endif 57 58 #define MAXNAMELEN 256 59 #define MIN(x, y) ((x) < (y) ? (x) : (y)) 60 61 /* Boot signature related defines for the findroot command */ 62 #define BOOTSIGN_DIR "/boot/grub/bootsign" 63 #define BOOTSIGN_ARGLEN (MAXNAMELEN + 10) /* (<sign>,0,d) */ 64 #define BOOTSIGN_LEN (sizeof (BOOTSIGN_DIR) + 1 + BOOTSIGN_ARGLEN) 65 #define BOOTSIGN_BACKUP "/etc/bootsign" 66 67 /* 68 * Integer sizes 69 */ 70 71 #define MAXINT 0x7FFFFFFF 72 73 /* Maximum command line size. Before you blindly increase this value, 74 see the comment in char_io.c (get_cmdline). */ 75 #define MAX_CMDLINE 1600 76 #define NEW_HEAPSIZE 1500 77 78 /* 512-byte scratch area */ 79 #define SCRATCHADDR RAW_ADDR (0x77e00) 80 #define SCRATCHSEG RAW_SEG (0x77e0) 81 82 /* 83 * This is the location of the raw device buffer. It is 31.5K 84 * in size. 85 */ 86 87 #define BUFFERLEN 0x7e00 88 #define BUFFERADDR RAW_ADDR (0x70000) 89 #define BUFFERSEG RAW_SEG (0x7000) 90 91 #define BOOT_PART_TABLE RAW_ADDR (0x07be) 92 93 /* 94 * BIOS disk defines 95 */ 96 #define BIOSDISK_READ 0x0 97 #define BIOSDISK_WRITE 0x1 98 #define BIOSDISK_ERROR_GEOMETRY 0x100 99 #define BIOSDISK_ERROR_SHORT_IO 0x101 100 #define BIOSDISK_FLAG_LBA_EXTENSION 0x1 101 #define BIOSDISK_FLAG_CDROM 0x2 102 103 /* 104 * This is the filesystem (not raw device) buffer. 105 * It is 32K in size, do not overrun! 106 */ 107 108 #define FSYS_BUFLEN 0x8000 109 #define FSYS_BUF RAW_ADDR (0x68000) 110 111 /* Command-line buffer for Multiboot kernels and modules. This area 112 includes the area into which Stage 1.5 and Stage 1 are loaded, but 113 that's no problem. */ 114 #define MB_CMDLINE_BUF RAW_ADDR (0x2000) 115 #define MB_CMDLINE_BUFLEN 0x6000 116 117 /* The buffer for the password. */ 118 #define PASSWORD_BUF RAW_ADDR (0x78000) 119 #define PASSWORD_BUFLEN 0x200 120 121 /* THe buffer for the filename of "/boot/grub/default". */ 122 #define DEFAULT_FILE_BUF (PASSWORD_BUF + PASSWORD_BUFLEN) 123 #define DEFAULT_FILE_BUFLEN 0x60 124 125 /* The buffer for the command-line. */ 126 #define CMDLINE_BUF (DEFAULT_FILE_BUF + DEFAULT_FILE_BUFLEN) 127 #define CMDLINE_BUFLEN MAX_CMDLINE 128 129 /* The kill buffer for the command-line. */ 130 #define KILL_BUF (CMDLINE_BUF + CMDLINE_BUFLEN) 131 #define KILL_BUFLEN MAX_CMDLINE 132 133 /* The history buffer for the command-line. */ 134 #define HISTORY_BUF (KILL_BUF + KILL_BUFLEN) 135 #define HISTORY_SIZE 5 136 #define HISTORY_BUFLEN (MAX_CMDLINE * HISTORY_SIZE) 137 138 /* The buffer for the completion. */ 139 #define COMPLETION_BUF (HISTORY_BUF + HISTORY_BUFLEN) 140 #define COMPLETION_BUFLEN MAX_CMDLINE 141 142 /* The buffer for the unique string. */ 143 #define UNIQUE_BUF (COMPLETION_BUF + COMPLETION_BUFLEN) 144 #define UNIQUE_BUFLEN MAX_CMDLINE 145 146 /* The buffer for the menu entries. */ 147 #define MENU_BUF (UNIQUE_BUF + UNIQUE_BUFLEN) 148 #define MENU_BUFLEN (0x8000 + PASSWORD_BUF - MENU_BUF) 149 150 /* The size of the drive map. */ 151 #define DRIVE_MAP_SIZE 8 152 153 /* The size of the key map. */ 154 #define KEY_MAP_SIZE 128 155 156 /* The size of the io map. */ 157 #define IO_MAP_SIZE 128 158 159 /* 160 * Linux setup parameters 161 */ 162 163 #define LINUX_MAGIC_SIGNATURE 0x53726448 /* "HdrS" */ 164 #define LINUX_DEFAULT_SETUP_SECTS 4 165 #define LINUX_FLAG_CAN_USE_HEAP 0x80 166 #define LINUX_INITRD_MAX_ADDRESS 0x38000000 167 #define LINUX_MAX_SETUP_SECTS 64 168 #define LINUX_BOOT_LOADER_TYPE 0x71 169 #define LINUX_HEAP_END_OFFSET (0x9000 - 0x200) 170 171 #define LINUX_BZIMAGE_ADDR RAW_ADDR (0x100000) 172 #define LINUX_ZIMAGE_ADDR RAW_ADDR (0x10000) 173 #define LINUX_OLD_REAL_MODE_ADDR RAW_ADDR (0x90000) 174 #define LINUX_SETUP_STACK 0x9000 175 176 #define LINUX_FLAG_BIG_KERNEL 0x1 177 178 /* Linux's video mode selection support. Actually I hate it! */ 179 #define LINUX_VID_MODE_NORMAL 0xFFFF 180 #define LINUX_VID_MODE_EXTENDED 0xFFFE 181 #define LINUX_VID_MODE_ASK 0xFFFD 182 183 #define LINUX_CL_OFFSET 0x9000 184 #define LINUX_CL_END_OFFSET 0x90FF 185 #define LINUX_SETUP_MOVE_SIZE 0x9100 186 #define LINUX_CL_MAGIC 0xA33F 187 188 /* 189 * General disk stuff 190 */ 191 192 #define SECTOR_SIZE 0x200 193 #define SECTOR_BITS 9 194 #define BIOS_FLAG_FIXED_DISK 0x80 195 196 #define BOOTSEC_LOCATION RAW_ADDR (0x7C00) 197 #define BOOTSEC_SIGNATURE 0xAA55 198 #define BOOTSEC_BPB_OFFSET 0x3 199 #define BOOTSEC_BPB_LENGTH 0x3B 200 #define BOOTSEC_BPB_SYSTEM_ID 0x3 201 #define BOOTSEC_BPB_HIDDEN_SECTORS 0x1C 202 #define BOOTSEC_PART_OFFSET 0x1BE 203 #define BOOTSEC_PART_LENGTH 0x40 204 #define BOOTSEC_SIG_OFFSET 0x1FE 205 #define BOOTSEC_LISTSIZE 8 206 207 /* Not bad, perhaps. */ 208 #define NETWORK_DRIVE 0x20 209 210 /* 211 * GRUB specific information 212 * (in LSB order) 213 */ 214 215 #include <stage1.h> 216 217 #define STAGE2_VER_MAJ_OFFS 0x6 218 #define STAGE2_INSTALLPART 0x8 219 #define STAGE2_SAVED_ENTRYNO 0xc 220 #define STAGE2_STAGE2_ID 0x10 221 #define STAGE2_FORCE_LBA 0x11 222 #define STAGE2_VER_STR_OFFS 0x12 223 224 /* Stage 2 identifiers */ 225 #define STAGE2_ID_STAGE2 0 226 #define STAGE2_ID_FFS_STAGE1_5 1 227 #define STAGE2_ID_E2FS_STAGE1_5 2 228 #define STAGE2_ID_FAT_STAGE1_5 3 229 #define STAGE2_ID_MINIX_STAGE1_5 4 230 #define STAGE2_ID_REISERFS_STAGE1_5 5 231 #define STAGE2_ID_VSTAFS_STAGE1_5 6 232 #define STAGE2_ID_JFS_STAGE1_5 7 233 #define STAGE2_ID_XFS_STAGE1_5 8 234 #define STAGE2_ID_ISO9660_STAGE1_5 9 235 #define STAGE2_ID_UFS2_STAGE1_5 10 236 #define STAGE2_ID_UFS_STAGE1_5 11 237 #define STAGE2_ID_ZFS_STAGE1_5 12 238 239 #ifndef STAGE1_5 240 # define STAGE2_ID STAGE2_ID_STAGE2 241 #else 242 # if defined(FSYS_FFS) 243 # define STAGE2_ID STAGE2_ID_FFS_STAGE1_5 244 # elif defined(FSYS_EXT2FS) 245 # define STAGE2_ID STAGE2_ID_E2FS_STAGE1_5 246 # elif defined(FSYS_FAT) 247 # define STAGE2_ID STAGE2_ID_FAT_STAGE1_5 248 # elif defined(FSYS_MINIX) 249 # define STAGE2_ID STAGE2_ID_MINIX_STAGE1_5 250 # elif defined(FSYS_REISERFS) 251 # define STAGE2_ID STAGE2_ID_REISERFS_STAGE1_5 252 # elif defined(FSYS_VSTAFS) 253 # define STAGE2_ID STAGE2_ID_VSTAFS_STAGE1_5 254 # elif defined(FSYS_JFS) 255 # define STAGE2_ID STAGE2_ID_JFS_STAGE1_5 256 # elif defined(FSYS_XFS) 257 # define STAGE2_ID STAGE2_ID_XFS_STAGE1_5 258 # elif defined(FSYS_ISO9660) 259 # define STAGE2_ID STAGE2_ID_ISO9660_STAGE1_5 260 # elif defined(FSYS_UFS2) 261 # define STAGE2_ID STAGE2_ID_UFS2_STAGE1_5 262 # elif defined(FSYS_UFS) 263 # define STAGE2_ID STAGE2_ID_UFS_STAGE1_5 264 # elif defined(FSYS_ZFS) 265 # define STAGE2_ID STAGE2_ID_ZFS_STAGE1_5 266 # else 267 # error "unknown Stage 2" 268 # endif 269 #endif 270 271 /* 272 * defines for use when switching between real and protected mode 273 */ 274 275 #define CR0_PE_ON 0x1 276 #define CR0_PE_OFF 0xfffffffe 277 #define PROT_MODE_CSEG 0x8 278 #define PROT_MODE_DSEG 0x10 279 #define PSEUDO_RM_CSEG 0x18 280 #define PSEUDO_RM_DSEG 0x20 281 #define STACKOFF (0x2000 - 0x10) 282 #define PROTSTACKINIT (FSYS_BUF - 0x10) 283 284 285 /* 286 * Assembly code defines 287 * 288 * "EXT_C" is assumed to be defined in the Makefile by the configure 289 * command. 290 */ 291 292 #define ENTRY(x) .globl EXT_C(x) ; EXT_C(x): 293 #define VARIABLE(x) ENTRY(x) 294 295 296 #define K_RDWR 0x60 /* keyboard data & cmds (read/write) */ 297 #define K_STATUS 0x64 /* keyboard status */ 298 #define K_CMD 0x64 /* keybd ctlr command (write-only) */ 299 300 #define K_OBUF_FUL 0x01 /* output buffer full */ 301 #define K_IBUF_FUL 0x02 /* input buffer full */ 302 303 #define KC_CMD_WIN 0xd0 /* read output port */ 304 #define KC_CMD_WOUT 0xd1 /* write output port */ 305 #define KB_OUTPUT_MASK 0xdd /* enable output buffer full interrupt 306 enable data line 307 enable clock line */ 308 #define KB_A20_ENABLE 0x02 309 310 /* Codes for getchar. */ 311 #define ASCII_CHAR(x) ((x) & 0xFF) 312 #if !defined(GRUB_UTIL) || !defined(HAVE_LIBCURSES) 313 # define KEY_LEFT 0x4B00 314 # define KEY_RIGHT 0x4D00 315 # define KEY_UP 0x4800 316 # define KEY_DOWN 0x5000 317 # define KEY_IC 0x5200 /* insert char */ 318 # define KEY_DC 0x5300 /* delete char */ 319 # define KEY_BACKSPACE 0x0008 320 # define KEY_HOME 0x4700 321 # define KEY_END 0x4F00 322 # define KEY_NPAGE 0x5100 323 # define KEY_PPAGE 0x4900 324 # define A_NORMAL 0x7 325 # define A_REVERSE 0x70 326 #elif defined(HAVE_NCURSES_CURSES_H) 327 # include <ncurses/curses.h> 328 #elif defined(HAVE_NCURSES_H) 329 # include <ncurses.h> 330 #elif defined(HAVE_CURSES_H) 331 # include <curses.h> 332 #endif 333 334 /* In old BSD curses, A_NORMAL and A_REVERSE are not defined, so we 335 define them here if they are undefined. */ 336 #ifndef A_NORMAL 337 # define A_NORMAL 0 338 #endif /* ! A_NORMAL */ 339 #ifndef A_REVERSE 340 # ifdef A_STANDOUT 341 # define A_REVERSE A_STANDOUT 342 # else /* ! A_STANDOUT */ 343 # define A_REVERSE 0 344 # endif /* ! A_STANDOUT */ 345 #endif /* ! A_REVERSE */ 346 347 /* Define ACS_* ourselves, since the definitions are not consistent among 348 various curses implementations. */ 349 #undef ACS_ULCORNER 350 #undef ACS_URCORNER 351 #undef ACS_LLCORNER 352 #undef ACS_LRCORNER 353 #undef ACS_HLINE 354 #undef ACS_VLINE 355 #undef ACS_LARROW 356 #undef ACS_RARROW 357 #undef ACS_UARROW 358 #undef ACS_DARROW 359 360 #define ACS_ULCORNER '+' 361 #define ACS_URCORNER '+' 362 #define ACS_LLCORNER '+' 363 #define ACS_LRCORNER '+' 364 #define ACS_HLINE '-' 365 #define ACS_VLINE '|' 366 #define ACS_LARROW '<' 367 #define ACS_RARROW '>' 368 #define ACS_UARROW '^' 369 #define ACS_DARROW 'v' 370 371 /* Special graphics characters for IBM displays. */ 372 #define DISP_UL 218 373 #define DISP_UR 191 374 #define DISP_LL 192 375 #define DISP_LR 217 376 #define DISP_HORIZ 196 377 #define DISP_VERT 179 378 #define DISP_LEFT 0x1b 379 #define DISP_RIGHT 0x1a 380 #define DISP_UP 0x18 381 #define DISP_DOWN 0x19 382 383 /* Remap some libc-API-compatible function names so that we prevent 384 circularararity. */ 385 #ifndef WITHOUT_LIBC_STUBS 386 #define memmove grub_memmove 387 #define memcpy grub_memmove /* we don't need a separate memcpy */ 388 #define memset grub_memset 389 #undef isspace 390 #define isspace grub_isspace 391 #define printf grub_printf 392 #define sprintf grub_sprintf 393 #undef putchar 394 #define putchar grub_putchar 395 #define strncat grub_strncat 396 #define strstr grub_strstr 397 #define memcmp grub_memcmp 398 #define strcmp grub_strcmp 399 #define tolower grub_tolower 400 #define strlen grub_strlen 401 #define strcpy grub_strcpy 402 #endif /* WITHOUT_LIBC_STUBS */ 403 404 #define UNDI_STACK (512 + 64) << 10 405 #define UNDI_STACK_SEG (UNDI_STACK >> 4) /* PXE load GRUB here */ 406 #define UNDI_STACK_OFF (0x10000 - 0x10) 407 408 #ifndef ASM_FILE 409 /* 410 * Below this should be ONLY defines and other constructs for C code. 411 */ 412 413 /* multiboot stuff */ 414 415 #include "mb_header.h" 416 #include "mb_info.h" 417 418 /* For the Linux/i386 boot protocol version 2.03. */ 419 struct linux_kernel_header 420 { 421 char code1[0x0020]; 422 unsigned short cl_magic; /* Magic number 0xA33F */ 423 unsigned short cl_offset; /* The offset of command line */ 424 char code2[0x01F1 - 0x0020 - 2 - 2]; 425 unsigned char setup_sects; /* The size of the setup in sectors */ 426 unsigned short root_flags; /* If the root is mounted readonly */ 427 unsigned short syssize; /* obsolete */ 428 unsigned short swap_dev; /* obsolete */ 429 unsigned short ram_size; /* obsolete */ 430 unsigned short vid_mode; /* Video mode control */ 431 unsigned short root_dev; /* Default root device number */ 432 unsigned short boot_flag; /* 0xAA55 magic number */ 433 unsigned short jump; /* Jump instruction */ 434 unsigned long header; /* Magic signature "HdrS" */ 435 unsigned short version; /* Boot protocol version supported */ 436 unsigned long realmode_swtch; /* Boot loader hook */ 437 unsigned long start_sys; /* Points to kernel version string */ 438 unsigned char type_of_loader; /* Boot loader identifier */ 439 unsigned char loadflags; /* Boot protocol option flags */ 440 unsigned short setup_move_size; /* Move to high memory size */ 441 unsigned long code32_start; /* Boot loader hook */ 442 unsigned long ramdisk_image; /* initrd load address */ 443 unsigned long ramdisk_size; /* initrd size */ 444 unsigned long bootsect_kludge; /* obsolete */ 445 unsigned short heap_end_ptr; /* Free memory after setup end */ 446 unsigned short pad1; /* Unused */ 447 char *cmd_line_ptr; /* Points to the kernel command line */ 448 unsigned long initrd_addr_max; /* The highest address of initrd */ 449 } __attribute__ ((packed)); 450 451 /* Memory map address range descriptor used by GET_MMAP_ENTRY. */ 452 struct mmar_desc 453 { 454 unsigned long desc_len; /* Size of this descriptor. */ 455 unsigned long long addr; /* Base address. */ 456 unsigned long long length; /* Length in bytes. */ 457 unsigned long type; /* Type of address range. */ 458 } __attribute__ ((packed)); 459 460 /* VBE controller information. */ 461 struct vbe_controller 462 { 463 unsigned char signature[4]; 464 unsigned short version; 465 unsigned long oem_string; 466 unsigned long capabilities; 467 unsigned long video_mode; 468 unsigned short total_memory; 469 unsigned short oem_software_rev; 470 unsigned long oem_vendor_name; 471 unsigned long oem_product_name; 472 unsigned long oem_product_rev; 473 unsigned char reserved[222]; 474 unsigned char oem_data[256]; 475 } __attribute__ ((packed)); 476 477 /* VBE mode information. */ 478 struct vbe_mode 479 { 480 unsigned short mode_attributes; 481 unsigned char win_a_attributes; 482 unsigned char win_b_attributes; 483 unsigned short win_granularity; 484 unsigned short win_size; 485 unsigned short win_a_segment; 486 unsigned short win_b_segment; 487 unsigned long win_func; 488 unsigned short bytes_per_scanline; 489 490 /* >=1.2 */ 491 unsigned short x_resolution; 492 unsigned short y_resolution; 493 unsigned char x_char_size; 494 unsigned char y_char_size; 495 unsigned char number_of_planes; 496 unsigned char bits_per_pixel; 497 unsigned char number_of_banks; 498 unsigned char memory_model; 499 unsigned char bank_size; 500 unsigned char number_of_image_pages; 501 unsigned char reserved0; 502 503 /* direct color */ 504 unsigned char red_mask_size; 505 unsigned char red_field_position; 506 unsigned char green_mask_size; 507 unsigned char green_field_position; 508 unsigned char blue_mask_size; 509 unsigned char blue_field_position; 510 unsigned char reserved_mask_size; 511 unsigned char reserved_field_position; 512 unsigned char direct_color_mode_info; 513 514 /* >=2.0 */ 515 unsigned long phys_base; 516 unsigned long reserved1; 517 unsigned short reversed2; 518 519 /* >=3.0 */ 520 unsigned short linear_bytes_per_scanline; 521 unsigned char banked_number_of_image_pages; 522 unsigned char linear_number_of_image_pages; 523 unsigned char linear_red_mask_size; 524 unsigned char linear_red_field_position; 525 unsigned char linear_green_mask_size; 526 unsigned char linear_green_field_position; 527 unsigned char linear_blue_mask_size; 528 unsigned char linear_blue_field_position; 529 unsigned char linear_reserved_mask_size; 530 unsigned char linear_reserved_field_position; 531 unsigned long max_pixel_clock; 532 533 unsigned char reserved3[189]; 534 } __attribute__ ((packed)); 535 536 537 #undef NULL 538 #define NULL ((void *) 0) 539 540 /* Error codes (descriptions are in common.c) */ 541 typedef enum 542 { 543 ERR_NONE = 0, 544 ERR_BAD_FILENAME, 545 ERR_BAD_FILETYPE, 546 ERR_BAD_GZIP_DATA, 547 ERR_BAD_GZIP_HEADER, 548 ERR_BAD_PART_TABLE, 549 ERR_BAD_VERSION, 550 ERR_BELOW_1MB, 551 ERR_BOOT_COMMAND, 552 ERR_BOOT_FAILURE, 553 ERR_BOOT_FEATURES, 554 ERR_DEV_FORMAT, 555 ERR_DEV_VALUES, 556 ERR_EXEC_FORMAT, 557 ERR_FILELENGTH, 558 ERR_FILE_NOT_FOUND, 559 ERR_FSYS_CORRUPT, 560 ERR_FSYS_MOUNT, 561 ERR_GEOM, 562 ERR_NEED_LX_KERNEL, 563 ERR_NEED_MB_KERNEL, 564 ERR_NO_DISK, 565 ERR_NO_PART, 566 ERR_NUMBER_PARSING, 567 ERR_OUTSIDE_PART, 568 ERR_READ, 569 ERR_SYMLINK_LOOP, 570 ERR_UNRECOGNIZED, 571 ERR_WONT_FIT, 572 ERR_WRITE, 573 ERR_BAD_ARGUMENT, 574 ERR_UNALIGNED, 575 ERR_PRIVILEGED, 576 ERR_DEV_NEED_INIT, 577 ERR_NO_DISK_SPACE, 578 ERR_NUMBER_OVERFLOW, 579 ERR_BAD_GZIP_CRC, 580 ERR_FILESYSTEM_NOT_FOUND, 581 ERR_NO_BOOTPATH, 582 ERR_NEWER_VERSION, 583 ERR_NOTXPM, 584 ERR_TOOMANYCOLORS, 585 ERR_CORRUPTXPM, 586 587 MAX_ERR_NUM 588 } grub_error_t; 589 590 extern unsigned long install_partition; 591 extern unsigned long boot_drive; 592 extern unsigned long install_second_sector; 593 extern struct apm_info apm_bios_info; 594 extern unsigned long boot_part_addr; 595 extern int saved_entryno; 596 extern unsigned char force_lba; 597 extern char version_string[]; 598 extern char config_file[]; 599 extern unsigned char md5hash[]; 600 extern char pkg_version[]; 601 extern unsigned long linux_text_len; 602 extern char *linux_data_tmp_addr; 603 extern char *linux_data_real_addr; 604 605 #ifdef GRUB_UTIL 606 /* If not using config file, this variable is set to zero, 607 otherwise non-zero. */ 608 extern int use_config_file; 609 /* If using the preset menu, this variable is set to non-zero, 610 otherwise zero. */ 611 extern int use_preset_menu; 612 /* If not using curses, this variable is set to zero, otherwise non-zero. */ 613 extern int use_curses; 614 /* The flag for verbose messages. */ 615 extern int verbose; 616 /* The flag for read-only. */ 617 extern int read_only; 618 /* The number of floppies to be probed. */ 619 extern int floppy_disks; 620 /* The map between BIOS drives and UNIX device file names. */ 621 extern char **device_map; 622 /* The filename which stores the information about a device map. */ 623 extern char *device_map_file; 624 /* The array of geometries. */ 625 extern struct geometry *disks; 626 /* Assign DRIVE to a device name DEVICE. */ 627 extern void assign_device_name (int drive, const char *device); 628 #endif 629 630 #ifndef STAGE1_5 631 /* GUI interface variables. */ 632 # define MAX_FALLBACK_ENTRIES 8 633 extern int fallback_entries[MAX_FALLBACK_ENTRIES]; 634 extern int fallback_entryno; 635 extern int default_entry; 636 extern int current_entryno; 637 638 /* The constants for password types. */ 639 typedef enum 640 { 641 PASSWORD_PLAIN, 642 PASSWORD_MD5, 643 PASSWORD_UNSUPPORTED 644 } 645 password_t; 646 647 extern char *password; 648 extern password_t password_type; 649 extern int auth; 650 extern char commands[]; 651 652 /* For `more'-like feature. */ 653 extern int max_lines; 654 extern int count_lines; 655 extern int use_pager; 656 #endif 657 658 #ifndef NO_DECOMPRESSION 659 extern int no_decompression; 660 extern int compressed_file; 661 #endif 662 663 /* instrumentation variables */ 664 extern void (*disk_read_hook) (unsigned int, int, int); 665 extern void (*disk_read_func) (unsigned int, int, int); 666 667 #ifndef STAGE1_5 668 /* The flag for debug mode. */ 669 extern int debug; 670 #endif /* STAGE1_5 */ 671 672 extern unsigned long current_drive; 673 extern unsigned long current_partition; 674 extern char current_rootpool[MAXNAMELEN]; 675 extern char current_bootfs[MAXNAMELEN]; 676 extern unsigned long long current_bootfs_obj; 677 extern char current_bootpath[MAXPATHLEN]; 678 extern char current_devid[MAXPATHLEN]; 679 extern int is_zfs_mount; 680 extern unsigned long best_drive; 681 extern unsigned long best_part; 682 extern int find_best_root; 683 684 extern int fsys_type; 685 686 /* The information for a disk geometry. The CHS information is only for 687 DOS/Partition table compatibility, and the real number of sectors is 688 stored in TOTAL_SECTORS. */ 689 struct geometry 690 { 691 /* The number of cylinders */ 692 unsigned long cylinders; 693 /* The number of heads */ 694 unsigned long heads; 695 /* The number of sectors */ 696 unsigned long sectors; 697 /* The total number of sectors */ 698 unsigned long total_sectors; 699 /* Device sector size */ 700 unsigned long sector_size; 701 /* Flags */ 702 unsigned long flags; 703 }; 704 705 extern unsigned long part_start; 706 extern unsigned long part_length; 707 708 extern int current_slice; 709 710 extern int buf_drive; 711 #define BUF_CACHE_INVALID 0xffffffff 712 extern unsigned int buf_track; 713 extern struct geometry buf_geom; 714 715 /* these are the current file position and maximum file position */ 716 extern int filepos; 717 extern int filemax; 718 719 /* 720 * Common BIOS/boot data. 721 */ 722 723 extern struct multiboot_info mbi; 724 extern unsigned long saved_drive; 725 extern unsigned long saved_partition; 726 extern unsigned long cdrom_drive; 727 #ifndef STAGE1_5 728 #ifdef SOLARIS_NETBOOT 729 extern unsigned long dhcpack_length; 730 extern unsigned long dhcpack_buf; 731 #endif 732 extern unsigned long saved_mem_upper; 733 extern unsigned long extended_memory; 734 #endif 735 736 /* 737 * Error variables. 738 */ 739 740 extern grub_error_t errnum; 741 extern char *err_list[]; 742 743 /* don't print geeky noise */ 744 typedef enum 745 { 746 SILENT, 747 VERBOSE, 748 DEFER_SILENT, 749 DEFER_VERBOSE 750 } silent_status; 751 752 /* one screen worth of messages 80x24 = 1920 chars -- more with newlines */ 753 #define SCREENBUF 2000 754 755 struct silentbuf { 756 silent_status status; 757 int looped; 758 char buffer[SCREENBUF]; 759 char *buffer_start; 760 }; 761 762 extern struct silentbuf silent; 763 extern int reset_term; 764 765 /* Simplify declaration of entry_addr. */ 766 typedef void (*entry_func) (int, int, int, int, int, int) 767 __attribute__ ((noreturn)); 768 769 extern entry_func entry_addr; 770 771 /* Enter the stage1.5/stage2 C code after the stack is set up. */ 772 void cmain (void); 773 774 /* Halt the processor (called after an unrecoverable error). */ 775 void stop (void) __attribute__ ((noreturn)); 776 777 /* Reboot the system. */ 778 void grub_reboot (void) __attribute__ ((noreturn)); 779 780 /* Halt the system, using APM if possible. If NO_APM is true, don't use 781 APM even if it is available. */ 782 void grub_halt (int no_apm) __attribute__ ((noreturn)); 783 784 /* Copy MAP to the drive map and set up int13_handler. */ 785 void set_int13_handler (unsigned short *map); 786 787 /* Set up int15_handler. */ 788 void set_int15_handler (void); 789 790 /* Restore the original int15 handler. */ 791 void unset_int15_handler (void); 792 793 /* Track the int13 handler to probe I/O address space. */ 794 void track_int13 (int drive); 795 796 /* The key map. */ 797 extern unsigned short bios_key_map[]; 798 extern unsigned short ascii_key_map[]; 799 extern unsigned short io_map[]; 800 801 /* calls for direct boot-loader chaining */ 802 void chain_stage1 (unsigned long segment, unsigned long offset, 803 unsigned long part_table_addr) 804 __attribute__ ((noreturn)); 805 void chain_stage2 (unsigned long segment, unsigned long offset, 806 int second_sector) 807 __attribute__ ((noreturn)); 808 809 /* do some funky stuff, then boot linux */ 810 void linux_boot (void) __attribute__ ((noreturn)); 811 812 /* do some funky stuff, then boot bzImage linux */ 813 void big_linux_boot (void) __attribute__ ((noreturn)); 814 815 /* booting a multiboot executable */ 816 void multi_boot (int start, int mb_info) __attribute__ ((noreturn)); 817 818 /* If LINEAR is nonzero, then set the Intel processor to linear mode. 819 Otherwise, bit 20 of all memory accesses is always forced to zero, 820 causing a wraparound effect for bugwards compatibility with the 821 8086 CPU. */ 822 void gateA20 (int linear); 823 824 /* memory probe routines */ 825 int get_memsize (int type); 826 int get_eisamemsize (void); 827 828 /* Fetch the next entry in the memory map and return the continuation 829 value. DESC is a pointer to the descriptor buffer, and CONT is the 830 previous continuation value (0 to get the first entry in the 831 map). */ 832 int get_mmap_entry (struct mmar_desc *desc, int cont); 833 834 /* Get the linear address of a ROM configuration table. Return zero, 835 if fails. */ 836 unsigned long get_rom_config_table (void); 837 838 /* Get APM BIOS information. */ 839 void get_apm_info (void); 840 841 /* Get VBE controller information. */ 842 int get_vbe_controller_info (struct vbe_controller *controller); 843 844 /* Get VBE mode information. */ 845 int get_vbe_mode_info (int mode_number, struct vbe_mode *mode); 846 847 /* Set VBE mode. */ 848 int set_vbe_mode (int mode_number); 849 850 /* Return the data area immediately following our code. */ 851 int get_code_end (void); 852 853 /* low-level timing info */ 854 int getrtsecs (void); 855 int currticks (void); 856 857 /* Clear the screen. */ 858 void cls (void); 859 860 /* Turn on/off cursor. */ 861 int setcursor (int on); 862 863 /* Get the current cursor position (where 0,0 is the top left hand 864 corner of the screen). Returns packed values, (RET >> 8) is x, 865 (RET & 0xff) is y. */ 866 int getxy (void); 867 868 /* Set the cursor position. */ 869 void gotoxy (int x, int y); 870 871 /* Displays an ASCII character. IBM displays will translate some 872 characters to special graphical ones (see the DISP_* constants). */ 873 void grub_putchar (int c); 874 875 /* Wait for a keypress, and return its packed BIOS/ASCII key code. 876 Use ASCII_CHAR(ret) to extract the ASCII code. */ 877 int getkey (void); 878 879 /* Like GETKEY, but doesn't block, and returns -1 if no keystroke is 880 available. */ 881 int checkkey (void); 882 883 /* Low-level disk I/O */ 884 int get_diskinfo (int drive, struct geometry *geometry); 885 int biosdisk (int subfunc, int drive, struct geometry *geometry, 886 unsigned int sector, int nsec, int segment); 887 void stop_floppy (void); 888 889 /* Command-line interface functions. */ 890 #ifndef STAGE1_5 891 892 /* The flags for the builtins. */ 893 #define BUILTIN_CMDLINE 0x1 /* Run in the command-line. */ 894 #define BUILTIN_MENU 0x2 /* Run in the menu. */ 895 #define BUILTIN_TITLE 0x4 /* Only for the command title. */ 896 #define BUILTIN_SCRIPT 0x8 /* Run in the script. */ 897 #define BUILTIN_NO_ECHO 0x10 /* Don't print command on booting. */ 898 #define BUILTIN_HELP_LIST 0x20 /* Show help in listing. */ 899 900 /* The table for a builtin. */ 901 struct builtin 902 { 903 /* The command name. */ 904 char *name; 905 /* The callback function. */ 906 int (*func) (char *, int); 907 /* The combination of the flags defined above. */ 908 int flags; 909 /* The short version of the documentation. */ 910 char *short_doc; 911 /* The long version of the documentation. */ 912 char *long_doc; 913 }; 914 915 /* All the builtins are registered in this. */ 916 extern struct builtin *builtin_table[]; 917 918 /* The constants for kernel types. */ 919 typedef enum 920 { 921 KERNEL_TYPE_NONE, /* None is loaded. */ 922 KERNEL_TYPE_MULTIBOOT, /* Multiboot. */ 923 KERNEL_TYPE_LINUX, /* Linux. */ 924 KERNEL_TYPE_BIG_LINUX, /* Big Linux. */ 925 KERNEL_TYPE_FREEBSD, /* FreeBSD. */ 926 KERNEL_TYPE_NETBSD, /* NetBSD. */ 927 KERNEL_TYPE_CHAINLOADER /* Chainloader. */ 928 } 929 kernel_t; 930 931 extern kernel_t kernel_type; 932 extern int show_menu; 933 extern int grub_timeout; 934 935 void init_builtins (void); 936 void init_config (void); 937 char *skip_to (int after_equal, char *cmdline); 938 struct builtin *find_command (char *command); 939 void print_cmdline_message (int forever); 940 void enter_cmdline (char *heap, int forever); 941 int run_script (char *script, char *heap); 942 #endif 943 944 /* C library replacement functions with identical semantics. */ 945 void grub_printf (const char *format,...); 946 int grub_sprintf (char *buffer, const char *format, ...); 947 int grub_tolower (int c); 948 int grub_isspace (int c); 949 int grub_strncat (char *s1, const char *s2, int n); 950 void grub_memcpy(void *dest, const void *src, int len); 951 void *grub_memmove (void *to, const void *from, int len); 952 void *grub_memset (void *start, int c, int len); 953 int grub_strncat (char *s1, const char *s2, int n); 954 char *grub_strstr (const char *s1, const char *s2); 955 int grub_memcmp (const char *s1, const char *s2, int n); 956 int grub_strcmp (const char *s1, const char *s2); 957 int grub_strlen (const char *str); 958 char *grub_strcpy (char *dest, const char *src); 959 char *grub_strchr (char *str, char c); 960 961 void noisy_printf (const char *format,...); 962 963 #ifndef GRUB_UTIL 964 typedef unsigned long grub_jmp_buf[6]; 965 #else 966 /* In the grub shell, use the libc jmp_buf instead. */ 967 # include <setjmp.h> 968 # define grub_jmp_buf jmp_buf 969 #endif 970 971 #ifdef GRUB_UTIL 972 # define grub_setjmp setjmp 973 # define grub_longjmp longjmp 974 #else /* ! GRUB_UTIL */ 975 int grub_setjmp (grub_jmp_buf env); 976 void grub_longjmp (grub_jmp_buf env, int val); 977 #endif /* ! GRUB_UTIL */ 978 979 /* The environment for restarting Stage 2. */ 980 extern grub_jmp_buf restart_env; 981 /* The environment for restarting the command-line interface. */ 982 extern grub_jmp_buf restart_cmdline_env; 983 984 /* misc */ 985 void init_page (void); 986 void print_error (void); 987 char *convert_to_ascii (char *buf, int c, ...); 988 int get_cmdline (char *prompt, char *cmdline, int maxlen, 989 int echo_char, int history); 990 int substring (const char *s1, const char *s2); 991 int nul_terminate (char *str); 992 int get_based_digit (int c, int base); 993 int safe_parse_maxint (char **str_ptr, int *myint_ptr); 994 int memcheck (unsigned long start, unsigned long len); 995 void grub_putstr (const char *str); 996 997 #ifndef NO_DECOMPRESSION 998 /* Compression support. */ 999 int gunzip_test_header (void); 1000 int gunzip_read (char *buf, int len); 1001 #endif /* NO_DECOMPRESSION */ 1002 1003 int rawread (int drive, unsigned int sector, int byte_offset, int byte_len, 1004 char *buf); 1005 int devread (unsigned int sector, int byte_offset, int byte_len, char *buf); 1006 int rawwrite (int drive, unsigned int sector, char *buf); 1007 int devwrite (unsigned int sector, int sector_len, char *buf); 1008 1009 /* Parse a device string and initialize the global parameters. */ 1010 char *set_device (char *device); 1011 int open_device (void); 1012 int real_open_partition (int flags); 1013 int open_partition (void); 1014 int next_partition (unsigned long drive, unsigned long dest, 1015 unsigned long *partition, int *type, 1016 unsigned long *start, unsigned long *len, 1017 unsigned long *offset, int *entry, 1018 unsigned long *ext_offset, char *buf); 1019 1020 /* Sets device to the one represented by the SAVED_* parameters. */ 1021 int make_saved_active (void); 1022 1023 /* Set or clear the current root partition's hidden flag. */ 1024 int set_partition_hidden_flag (int hidden); 1025 1026 /* Open a file or directory on the active device, using GRUB's 1027 internal filesystem support. */ 1028 int grub_open (char *filename); 1029 1030 /* Read LEN bytes into BUF from the file that was opened with 1031 GRUB_OPEN. If LEN is -1, read all the remaining data in the file. */ 1032 int grub_read (char *buf, int len); 1033 1034 /* Reposition a file offset. */ 1035 int grub_seek (int offset); 1036 1037 /* Close a file. */ 1038 void grub_close (void); 1039 1040 /* List the contents of the directory that was opened with GRUB_OPEN, 1041 printing all completions. */ 1042 int dir (char *dirname); 1043 1044 int set_bootdev (int hdbias); 1045 1046 /* Display statistics on the current active device. */ 1047 void print_fsys_type (void); 1048 1049 /* Display device and filename completions. */ 1050 void print_a_completion (char *filename); 1051 int print_completions (int is_filename, int is_completion); 1052 1053 /* Copies the current partition data to the desired address. */ 1054 void copy_current_part_entry (char *buf); 1055 1056 #ifndef STAGE1_5 1057 void bsd_boot (kernel_t type, int bootdev, char *arg) 1058 __attribute__ ((noreturn)); 1059 1060 /* Define flags for load_image here. */ 1061 /* Don't pass a Linux's mem option automatically. */ 1062 #define KERNEL_LOAD_NO_MEM_OPTION (1 << 0) 1063 1064 kernel_t load_image (char *kernel, char *arg, kernel_t suggested_type, 1065 unsigned long load_flags); 1066 1067 int load_module (char *module, char *arg); 1068 int load_initrd (char *initrd); 1069 1070 int check_password(char *entered, char* expected, password_t type); 1071 #endif 1072 1073 void init_bios_info (void); 1074 1075 #endif /* ASM_FILE */ 1076 1077 #endif /* ! GRUB_SHARED_HEADER */ 1078