boot.txt 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755
  1. THE LINUX/I386 BOOT PROTOCOL
  2. ----------------------------
  3. H. Peter Anvin <hpa@zytor.com>
  4. Last update 2007-05-23
  5. On the i386 platform, the Linux kernel uses a rather complicated boot
  6. convention. This has evolved partially due to historical aspects, as
  7. well as the desire in the early days to have the kernel itself be a
  8. bootable image, the complicated PC memory model and due to changed
  9. expectations in the PC industry caused by the effective demise of
  10. real-mode DOS as a mainstream operating system.
  11. Currently, the following versions of the Linux/i386 boot protocol exist.
  12. Old kernels: zImage/Image support only. Some very early kernels
  13. may not even support a command line.
  14. Protocol 2.00: (Kernel 1.3.73) Added bzImage and initrd support, as
  15. well as a formalized way to communicate between the
  16. boot loader and the kernel. setup.S made relocatable,
  17. although the traditional setup area still assumed
  18. writable.
  19. Protocol 2.01: (Kernel 1.3.76) Added a heap overrun warning.
  20. Protocol 2.02: (Kernel 2.4.0-test3-pre3) New command line protocol.
  21. Lower the conventional memory ceiling. No overwrite
  22. of the traditional setup area, thus making booting
  23. safe for systems which use the EBDA from SMM or 32-bit
  24. BIOS entry points. zImage deprecated but still
  25. supported.
  26. Protocol 2.03: (Kernel 2.4.18-pre1) Explicitly makes the highest possible
  27. initrd address available to the bootloader.
  28. Protocol 2.04: (Kernel 2.6.14) Extend the syssize field to four bytes.
  29. Protocol 2.05: (Kernel 2.6.20) Make protected mode kernel relocatable.
  30. Introduce relocatable_kernel and kernel_alignment fields.
  31. Protocol 2.06: (Kernel 2.6.22) Added a field that contains the size of
  32. the boot command line
  33. **** MEMORY LAYOUT
  34. The traditional memory map for the kernel loader, used for Image or
  35. zImage kernels, typically looks like:
  36. | |
  37. 0A0000 +------------------------+
  38. | Reserved for BIOS | Do not use. Reserved for BIOS EBDA.
  39. 09A000 +------------------------+
  40. | Command line |
  41. | Stack/heap | For use by the kernel real-mode code.
  42. 098000 +------------------------+
  43. | Kernel setup | The kernel real-mode code.
  44. 090200 +------------------------+
  45. | Kernel boot sector | The kernel legacy boot sector.
  46. 090000 +------------------------+
  47. | Protected-mode kernel | The bulk of the kernel image.
  48. 010000 +------------------------+
  49. | Boot loader | <- Boot sector entry point 0000:7C00
  50. 001000 +------------------------+
  51. | Reserved for MBR/BIOS |
  52. 000800 +------------------------+
  53. | Typically used by MBR |
  54. 000600 +------------------------+
  55. | BIOS use only |
  56. 000000 +------------------------+
  57. When using bzImage, the protected-mode kernel was relocated to
  58. 0x100000 ("high memory"), and the kernel real-mode block (boot sector,
  59. setup, and stack/heap) was made relocatable to any address between
  60. 0x10000 and end of low memory. Unfortunately, in protocols 2.00 and
  61. 2.01 the 0x90000+ memory range is still used internally by the kernel;
  62. the 2.02 protocol resolves that problem.
  63. It is desirable to keep the "memory ceiling" -- the highest point in
  64. low memory touched by the boot loader -- as low as possible, since
  65. some newer BIOSes have begun to allocate some rather large amounts of
  66. memory, called the Extended BIOS Data Area, near the top of low
  67. memory. The boot loader should use the "INT 12h" BIOS call to verify
  68. how much low memory is available.
  69. Unfortunately, if INT 12h reports that the amount of memory is too
  70. low, there is usually nothing the boot loader can do but to report an
  71. error to the user. The boot loader should therefore be designed to
  72. take up as little space in low memory as it reasonably can. For
  73. zImage or old bzImage kernels, which need data written into the
  74. 0x90000 segment, the boot loader should make sure not to use memory
  75. above the 0x9A000 point; too many BIOSes will break above that point.
  76. For a modern bzImage kernel with boot protocol version >= 2.02, a
  77. memory layout like the following is suggested:
  78. ~ ~
  79. | Protected-mode kernel |
  80. 100000 +------------------------+
  81. | I/O memory hole |
  82. 0A0000 +------------------------+
  83. | Reserved for BIOS | Leave as much as possible unused
  84. ~ ~
  85. | Command line | (Can also be below the X+10000 mark)
  86. X+10000 +------------------------+
  87. | Stack/heap | For use by the kernel real-mode code.
  88. X+08000 +------------------------+
  89. | Kernel setup | The kernel real-mode code.
  90. | Kernel boot sector | The kernel legacy boot sector.
  91. X +------------------------+
  92. | Boot loader | <- Boot sector entry point 0000:7C00
  93. 001000 +------------------------+
  94. | Reserved for MBR/BIOS |
  95. 000800 +------------------------+
  96. | Typically used by MBR |
  97. 000600 +------------------------+
  98. | BIOS use only |
  99. 000000 +------------------------+
  100. ... where the address X is as low as the design of the boot loader
  101. permits.
  102. **** THE REAL-MODE KERNEL HEADER
  103. In the following text, and anywhere in the kernel boot sequence, "a
  104. sector" refers to 512 bytes. It is independent of the actual sector
  105. size of the underlying medium.
  106. The first step in loading a Linux kernel should be to load the
  107. real-mode code (boot sector and setup code) and then examine the
  108. following header at offset 0x01f1. The real-mode code can total up to
  109. 32K, although the boot loader may choose to load only the first two
  110. sectors (1K) and then examine the bootup sector size.
  111. The header looks like:
  112. Offset Proto Name Meaning
  113. /Size
  114. 01F1/1 ALL(1 setup_sects The size of the setup in sectors
  115. 01F2/2 ALL root_flags If set, the root is mounted readonly
  116. 01F4/4 2.04+(2 syssize The size of the 32-bit code in 16-byte paras
  117. 01F8/2 ALL ram_size DO NOT USE - for bootsect.S use only
  118. 01FA/2 ALL vid_mode Video mode control
  119. 01FC/2 ALL root_dev Default root device number
  120. 01FE/2 ALL boot_flag 0xAA55 magic number
  121. 0200/2 2.00+ jump Jump instruction
  122. 0202/4 2.00+ header Magic signature "HdrS"
  123. 0206/2 2.00+ version Boot protocol version supported
  124. 0208/4 2.00+ realmode_swtch Boot loader hook (see below)
  125. 020C/2 2.00+ start_sys The load-low segment (0x1000) (obsolete)
  126. 020E/2 2.00+ kernel_version Pointer to kernel version string
  127. 0210/1 2.00+ type_of_loader Boot loader identifier
  128. 0211/1 2.00+ loadflags Boot protocol option flags
  129. 0212/2 2.00+ setup_move_size Move to high memory size (used with hooks)
  130. 0214/4 2.00+ code32_start Boot loader hook (see below)
  131. 0218/4 2.00+ ramdisk_image initrd load address (set by boot loader)
  132. 021C/4 2.00+ ramdisk_size initrd size (set by boot loader)
  133. 0220/4 2.00+ bootsect_kludge DO NOT USE - for bootsect.S use only
  134. 0224/2 2.01+ heap_end_ptr Free memory after setup end
  135. 0226/2 N/A pad1 Unused
  136. 0228/4 2.02+ cmd_line_ptr 32-bit pointer to the kernel command line
  137. 022C/4 2.03+ initrd_addr_max Highest legal initrd address
  138. 0230/4 2.05+ kernel_alignment Physical addr alignment required for kernel
  139. 0234/1 2.05+ relocatable_kernel Whether kernel is relocatable or not
  140. 0235/3 N/A pad2 Unused
  141. 0238/4 2.06+ cmdline_size Maximum size of the kernel command line
  142. (1) For backwards compatibility, if the setup_sects field contains 0, the
  143. real value is 4.
  144. (2) For boot protocol prior to 2.04, the upper two bytes of the syssize
  145. field are unusable, which means the size of a bzImage kernel
  146. cannot be determined.
  147. If the "HdrS" (0x53726448) magic number is not found at offset 0x202,
  148. the boot protocol version is "old". Loading an old kernel, the
  149. following parameters should be assumed:
  150. Image type = zImage
  151. initrd not supported
  152. Real-mode kernel must be located at 0x90000.
  153. Otherwise, the "version" field contains the protocol version,
  154. e.g. protocol version 2.01 will contain 0x0201 in this field. When
  155. setting fields in the header, you must make sure only to set fields
  156. supported by the protocol version in use.
  157. **** DETAILS OF HEADER FIELDS
  158. For each field, some are information from the kernel to the bootloader
  159. ("read"), some are expected to be filled out by the bootloader
  160. ("write"), and some are expected to be read and modified by the
  161. bootloader ("modify").
  162. All general purpose boot loaders should write the fields marked
  163. (obligatory). Boot loaders who want to load the kernel at a
  164. nonstandard address should fill in the fields marked (reloc); other
  165. boot loaders can ignore those fields.
  166. The byte order of all fields is littleendian (this is x86, after all.)
  167. Field name: setup_secs
  168. Type: read
  169. Offset/size: 0x1f1/1
  170. Protocol: ALL
  171. The size of the setup code in 512-byte sectors. If this field is
  172. 0, the real value is 4. The real-mode code consists of the boot
  173. sector (always one 512-byte sector) plus the setup code.
  174. Field name: root_flags
  175. Type: modify (optional)
  176. Offset/size: 0x1f2/2
  177. Protocol: ALL
  178. If this field is nonzero, the root defaults to readonly. The use of
  179. this field is deprecated; use the "ro" or "rw" options on the
  180. command line instead.
  181. Field name: syssize
  182. Type: read
  183. Offset/size: 0x1f4/4 (protocol 2.04+) 0x1f4/2 (protocol ALL)
  184. Protocol: 2.04+
  185. The size of the protected-mode code in units of 16-byte paragraphs.
  186. For protocol versions older than 2.04 this field is only two bytes
  187. wide, and therefore cannot be trusted for the size of a kernel if
  188. the LOAD_HIGH flag is set.
  189. Field name: ram_size
  190. Type: kernel internal
  191. Offset/size: 0x1f8/2
  192. Protocol: ALL
  193. This field is obsolete.
  194. Field name: vid_mode
  195. Type: modify (obligatory)
  196. Offset/size: 0x1fa/2
  197. Please see the section on SPECIAL COMMAND LINE OPTIONS.
  198. Field name: root_dev
  199. Type: modify (optional)
  200. Offset/size: 0x1fc/2
  201. Protocol: ALL
  202. The default root device device number. The use of this field is
  203. deprecated, use the "root=" option on the command line instead.
  204. Field name: boot_flag
  205. Type: read
  206. Offset/size: 0x1fe/2
  207. Protocol: ALL
  208. Contains 0xAA55. This is the closest thing old Linux kernels have
  209. to a magic number.
  210. Field name: jump
  211. Type: read
  212. Offset/size: 0x200/2
  213. Protocol: 2.00+
  214. Contains an x86 jump instruction, 0xEB followed by a signed offset
  215. relative to byte 0x202. This can be used to determine the size of
  216. the header.
  217. Field name: header
  218. Type: read
  219. Offset/size: 0x202/4
  220. Protocol: 2.00+
  221. Contains the magic number "HdrS" (0x53726448).
  222. Field name: version
  223. Type: read
  224. Offset/size: 0x206/2
  225. Protocol: 2.00+
  226. Contains the boot protocol version, in (major << 8)+minor format,
  227. e.g. 0x0204 for version 2.04, and 0x0a11 for a hypothetical version
  228. 10.17.
  229. Field name: readmode_swtch
  230. Type: modify (optional)
  231. Offset/size: 0x208/4
  232. Protocol: 2.00+
  233. Boot loader hook (see ADVANCED BOOT LOADER HOOKS below.)
  234. Field name: start_sys
  235. Type: read
  236. Offset/size: 0x20c/4
  237. Protocol: 2.00+
  238. The load low segment (0x1000). Obsolete.
  239. Field name: kernel_version
  240. Type: read
  241. Offset/size: 0x20e/2
  242. Protocol: 2.00+
  243. If set to a nonzero value, contains a pointer to a NUL-terminated
  244. human-readable kernel version number string, less 0x200. This can
  245. be used to display the kernel version to the user. This value
  246. should be less than (0x200*setup_sects).
  247. For example, if this value is set to 0x1c00, the kernel version
  248. number string can be found at offset 0x1e00 in the kernel file.
  249. This is a valid value if and only if the "setup_sects" field
  250. contains the value 15 or higher, as:
  251. 0x1c00 < 15*0x200 (= 0x1e00) but
  252. 0x1c00 >= 14*0x200 (= 0x1c00)
  253. 0x1c00 >> 9 = 14, so the minimum value for setup_secs is 15.
  254. Field name: type_of_loader
  255. Type: write (obligatory)
  256. Offset/size: 0x210/1
  257. Protocol: 2.00+
  258. If your boot loader has an assigned id (see table below), enter
  259. 0xTV here, where T is an identifier for the boot loader and V is
  260. a version number. Otherwise, enter 0xFF here.
  261. Assigned boot loader ids:
  262. 0 LILO (0x00 reserved for pre-2.00 bootloader)
  263. 1 Loadlin
  264. 2 bootsect-loader (0x20, all other values reserved)
  265. 3 SYSLINUX
  266. 4 EtherBoot
  267. 5 ELILO
  268. 7 GRuB
  269. 8 U-BOOT
  270. 9 Xen
  271. A Gujin
  272. B Qemu
  273. Please contact <hpa@zytor.com> if you need a bootloader ID
  274. value assigned.
  275. Field name: loadflags
  276. Type: modify (obligatory)
  277. Offset/size: 0x211/1
  278. Protocol: 2.00+
  279. This field is a bitmask.
  280. Bit 0 (read): LOADED_HIGH
  281. - If 0, the protected-mode code is loaded at 0x10000.
  282. - If 1, the protected-mode code is loaded at 0x100000.
  283. Bit 7 (write): CAN_USE_HEAP
  284. Set this bit to 1 to indicate that the value entered in the
  285. heap_end_ptr is valid. If this field is clear, some setup code
  286. functionality will be disabled.
  287. Field name: setup_move_size
  288. Type: modify (obligatory)
  289. Offset/size: 0x212/2
  290. Protocol: 2.00-2.01
  291. When using protocol 2.00 or 2.01, if the real mode kernel is not
  292. loaded at 0x90000, it gets moved there later in the loading
  293. sequence. Fill in this field if you want additional data (such as
  294. the kernel command line) moved in addition to the real-mode kernel
  295. itself.
  296. The unit is bytes starting with the beginning of the boot sector.
  297. This field is can be ignored when the protocol is 2.02 or higher, or
  298. if the real-mode code is loaded at 0x90000.
  299. Field name: code32_start
  300. Type: modify (optional, reloc)
  301. Offset/size: 0x214/4
  302. Protocol: 2.00+
  303. The address to jump to in protected mode. This defaults to the load
  304. address of the kernel, and can be used by the boot loader to
  305. determine the proper load address.
  306. This field can be modified for two purposes:
  307. 1. as a boot loader hook (see ADVANCED BOOT LOADER HOOKS below.)
  308. 2. if a bootloader which does not install a hook loads a
  309. relocatable kernel at a nonstandard address it will have to modify
  310. this field to point to the load address.
  311. Field name: ramdisk_image
  312. Type: write (obligatory)
  313. Offset/size: 0x218/4
  314. Protocol: 2.00+
  315. The 32-bit linear address of the initial ramdisk or ramfs. Leave at
  316. zero if there is no initial ramdisk/ramfs.
  317. Field name: ramdisk_size
  318. Type: write (obligatory)
  319. Offset/size: 0x21c/4
  320. Protocol: 2.00+
  321. Size of the initial ramdisk or ramfs. Leave at zero if there is no
  322. initial ramdisk/ramfs.
  323. Field name: bootsect_kludge
  324. Type: kernel internal
  325. Offset/size: 0x220/4
  326. Protocol: 2.00+
  327. This field is obsolete.
  328. Field name: heap_end_ptr
  329. Type: write (obligatory)
  330. Offset/size: 0x224/2
  331. Protocol: 2.01+
  332. Set this field to the offset (from the beginning of the real-mode
  333. code) of the end of the setup stack/heap, minus 0x0200.
  334. Field name: cmd_line_ptr
  335. Type: write (obligatory)
  336. Offset/size: 0x228/4
  337. Protocol: 2.02+
  338. Set this field to the linear address of the kernel command line.
  339. The kernel command line can be located anywhere between the end of
  340. the setup heap and 0xA0000; it does not have to be located in the
  341. same 64K segment as the real-mode code itself.
  342. Fill in this field even if your boot loader does not support a
  343. command line, in which case you can point this to an empty string
  344. (or better yet, to the string "auto".) If this field is left at
  345. zero, the kernel will assume that your boot loader does not support
  346. the 2.02+ protocol.
  347. Field name: initrd_addr_max
  348. Type: read
  349. Offset/size: 0x22c/4
  350. Protocol: 2.03+
  351. The maximum address that may be occupied by the initial
  352. ramdisk/ramfs contents. For boot protocols 2.02 or earlier, this
  353. field is not present, and the maximum address is 0x37FFFFFF. (This
  354. address is defined as the address of the highest safe byte, so if
  355. your ramdisk is exactly 131072 bytes long and this field is
  356. 0x37FFFFFF, you can start your ramdisk at 0x37FE0000.)
  357. Field name: kernel_alignment
  358. Type: read (reloc)
  359. Offset/size: 0x230/4
  360. Protocol: 2.05+
  361. Alignment unit required by the kernel (if relocatable_kernel is true.)
  362. Field name: relocatable_kernel
  363. Type: read (reloc)
  364. Offset/size: 0x234/1
  365. Protocol: 2.05+
  366. If this field is nonzero, the protected-mode part of the kernel can
  367. be loaded at any address that satisfies the kernel_alignment field.
  368. After loading, the boot loader must set the code32_start field to
  369. point to the loaded code, or to a boot loader hook.
  370. Field name: cmdline_size
  371. Type: read
  372. Offset/size: 0x238/4
  373. Protocol: 2.06+
  374. The maximum size of the command line without the terminating
  375. zero. This means that the command line can contain at most
  376. cmdline_size characters. With protocol version 2.05 and earlier, the
  377. maximum size was 255.
  378. **** THE KERNEL COMMAND LINE
  379. The kernel command line has become an important way for the boot
  380. loader to communicate with the kernel. Some of its options are also
  381. relevant to the boot loader itself, see "special command line options"
  382. below.
  383. The kernel command line is a null-terminated string. The maximum
  384. length can be retrieved from the field cmdline_size. Before protocol
  385. version 2.06, the maximum was 255 characters. A string that is too
  386. long will be automatically truncated by the kernel.
  387. If the boot protocol version is 2.02 or later, the address of the
  388. kernel command line is given by the header field cmd_line_ptr (see
  389. above.) This address can be anywhere between the end of the setup
  390. heap and 0xA0000.
  391. If the protocol version is *not* 2.02 or higher, the kernel
  392. command line is entered using the following protocol:
  393. At offset 0x0020 (word), "cmd_line_magic", enter the magic
  394. number 0xA33F.
  395. At offset 0x0022 (word), "cmd_line_offset", enter the offset
  396. of the kernel command line (relative to the start of the
  397. real-mode kernel).
  398. The kernel command line *must* be within the memory region
  399. covered by setup_move_size, so you may need to adjust this
  400. field.
  401. **** MEMORY LAYOUT OF THE REAL-MODE CODE
  402. The real-mode code requires a stack/heap to be set up, as well as
  403. memory allocated for the kernel command line. This needs to be done
  404. in the real-mode accessible memory in bottom megabyte.
  405. It should be noted that modern machines often have a sizable Extended
  406. BIOS Data Area (EBDA). As a result, it is advisable to use as little
  407. of the low megabyte as possible.
  408. Unfortunately, under the following circumstances the 0x90000 memory
  409. segment has to be used:
  410. - When loading a zImage kernel ((loadflags & 0x01) == 0).
  411. - When loading a 2.01 or earlier boot protocol kernel.
  412. -> For the 2.00 and 2.01 boot protocols, the real-mode code
  413. can be loaded at another address, but it is internally
  414. relocated to 0x90000. For the "old" protocol, the
  415. real-mode code must be loaded at 0x90000.
  416. When loading at 0x90000, avoid using memory above 0x9a000.
  417. For boot protocol 2.02 or higher, the command line does not have to be
  418. located in the same 64K segment as the real-mode setup code; it is
  419. thus permitted to give the stack/heap the full 64K segment and locate
  420. the command line above it.
  421. The kernel command line should not be located below the real-mode
  422. code, nor should it be located in high memory.
  423. **** SAMPLE BOOT CONFIGURATION
  424. As a sample configuration, assume the following layout of the real
  425. mode segment:
  426. When loading below 0x90000, use the entire segment:
  427. 0x0000-0x7fff Real mode kernel
  428. 0x8000-0xdfff Stack and heap
  429. 0xe000-0xffff Kernel command line
  430. When loading at 0x90000 OR the protocol version is 2.01 or earlier:
  431. 0x0000-0x7fff Real mode kernel
  432. 0x8000-0x97ff Stack and heap
  433. 0x9800-0x9fff Kernel command line
  434. Such a boot loader should enter the following fields in the header:
  435. unsigned long base_ptr; /* base address for real-mode segment */
  436. if ( setup_sects == 0 ) {
  437. setup_sects = 4;
  438. }
  439. if ( protocol >= 0x0200 ) {
  440. type_of_loader = <type code>;
  441. if ( loading_initrd ) {
  442. ramdisk_image = <initrd_address>;
  443. ramdisk_size = <initrd_size>;
  444. }
  445. if ( protocol >= 0x0202 && loadflags & 0x01 )
  446. heap_end = 0xe000;
  447. else
  448. heap_end = 0x9800;
  449. if ( protocol >= 0x0201 ) {
  450. heap_end_ptr = heap_end - 0x200;
  451. loadflags |= 0x80; /* CAN_USE_HEAP */
  452. }
  453. if ( protocol >= 0x0202 ) {
  454. cmd_line_ptr = base_ptr + heap_end;
  455. strcpy(cmd_line_ptr, cmdline);
  456. } else {
  457. cmd_line_magic = 0xA33F;
  458. cmd_line_offset = heap_end;
  459. setup_move_size = heap_end + strlen(cmdline)+1;
  460. strcpy(base_ptr+cmd_line_offset, cmdline);
  461. }
  462. } else {
  463. /* Very old kernel */
  464. heap_end = 0x9800;
  465. cmd_line_magic = 0xA33F;
  466. cmd_line_offset = heap_end;
  467. /* A very old kernel MUST have its real-mode code
  468. loaded at 0x90000 */
  469. if ( base_ptr != 0x90000 ) {
  470. /* Copy the real-mode kernel */
  471. memcpy(0x90000, base_ptr, (setup_sects+1)*512);
  472. base_ptr = 0x90000; /* Relocated */
  473. }
  474. strcpy(0x90000+cmd_line_offset, cmdline);
  475. /* It is recommended to clear memory up to the 32K mark */
  476. memset(0x90000 + (setup_sects+1)*512, 0,
  477. (64-(setup_sects+1))*512);
  478. }
  479. **** LOADING THE REST OF THE KERNEL
  480. The 32-bit (non-real-mode) kernel starts at offset (setup_sects+1)*512
  481. in the kernel file (again, if setup_sects == 0 the real value is 4.)
  482. It should be loaded at address 0x10000 for Image/zImage kernels and
  483. 0x100000 for bzImage kernels.
  484. The kernel is a bzImage kernel if the protocol >= 2.00 and the 0x01
  485. bit (LOAD_HIGH) in the loadflags field is set:
  486. is_bzImage = (protocol >= 0x0200) && (loadflags & 0x01);
  487. load_address = is_bzImage ? 0x100000 : 0x10000;
  488. Note that Image/zImage kernels can be up to 512K in size, and thus use
  489. the entire 0x10000-0x90000 range of memory. This means it is pretty
  490. much a requirement for these kernels to load the real-mode part at
  491. 0x90000. bzImage kernels allow much more flexibility.
  492. **** SPECIAL COMMAND LINE OPTIONS
  493. If the command line provided by the boot loader is entered by the
  494. user, the user may expect the following command line options to work.
  495. They should normally not be deleted from the kernel command line even
  496. though not all of them are actually meaningful to the kernel. Boot
  497. loader authors who need additional command line options for the boot
  498. loader itself should get them registered in
  499. Documentation/kernel-parameters.txt to make sure they will not
  500. conflict with actual kernel options now or in the future.
  501. vga=<mode>
  502. <mode> here is either an integer (in C notation, either
  503. decimal, octal, or hexadecimal) or one of the strings
  504. "normal" (meaning 0xFFFF), "ext" (meaning 0xFFFE) or "ask"
  505. (meaning 0xFFFD). This value should be entered into the
  506. vid_mode field, as it is used by the kernel before the command
  507. line is parsed.
  508. mem=<size>
  509. <size> is an integer in C notation optionally followed by
  510. (case insensitive) K, M, G, T, P or E (meaning << 10, << 20,
  511. << 30, << 40, << 50 or << 60). This specifies the end of
  512. memory to the kernel. This affects the possible placement of
  513. an initrd, since an initrd should be placed near end of
  514. memory. Note that this is an option to *both* the kernel and
  515. the bootloader!
  516. initrd=<file>
  517. An initrd should be loaded. The meaning of <file> is
  518. obviously bootloader-dependent, and some boot loaders
  519. (e.g. LILO) do not have such a command.
  520. In addition, some boot loaders add the following options to the
  521. user-specified command line:
  522. BOOT_IMAGE=<file>
  523. The boot image which was loaded. Again, the meaning of <file>
  524. is obviously bootloader-dependent.
  525. auto
  526. The kernel was booted without explicit user intervention.
  527. If these options are added by the boot loader, it is highly
  528. recommended that they are located *first*, before the user-specified
  529. or configuration-specified command line. Otherwise, "init=/bin/sh"
  530. gets confused by the "auto" option.
  531. **** RUNNING THE KERNEL
  532. The kernel is started by jumping to the kernel entry point, which is
  533. located at *segment* offset 0x20 from the start of the real mode
  534. kernel. This means that if you loaded your real-mode kernel code at
  535. 0x90000, the kernel entry point is 9020:0000.
  536. At entry, ds = es = ss should point to the start of the real-mode
  537. kernel code (0x9000 if the code is loaded at 0x90000), sp should be
  538. set up properly, normally pointing to the top of the heap, and
  539. interrupts should be disabled. Furthermore, to guard against bugs in
  540. the kernel, it is recommended that the boot loader sets fs = gs = ds =
  541. es = ss.
  542. In our example from above, we would do:
  543. /* Note: in the case of the "old" kernel protocol, base_ptr must
  544. be == 0x90000 at this point; see the previous sample code */
  545. seg = base_ptr >> 4;
  546. cli(); /* Enter with interrupts disabled! */
  547. /* Set up the real-mode kernel stack */
  548. _SS = seg;
  549. _SP = heap_end;
  550. _DS = _ES = _FS = _GS = seg;
  551. jmp_far(seg+0x20, 0); /* Run the kernel */
  552. If your boot sector accesses a floppy drive, it is recommended to
  553. switch off the floppy motor before running the kernel, since the
  554. kernel boot leaves interrupts off and thus the motor will not be
  555. switched off, especially if the loaded kernel has the floppy driver as
  556. a demand-loaded module!
  557. **** ADVANCED BOOT LOADER HOOKS
  558. If the boot loader runs in a particularly hostile environment (such as
  559. LOADLIN, which runs under DOS) it may be impossible to follow the
  560. standard memory location requirements. Such a boot loader may use the
  561. following hooks that, if set, are invoked by the kernel at the
  562. appropriate time. The use of these hooks should probably be
  563. considered an absolutely last resort!
  564. IMPORTANT: All the hooks are required to preserve %esp, %ebp, %esi and
  565. %edi across invocation.
  566. realmode_swtch:
  567. A 16-bit real mode far subroutine invoked immediately before
  568. entering protected mode. The default routine disables NMI, so
  569. your routine should probably do so, too.
  570. code32_start:
  571. A 32-bit flat-mode routine *jumped* to immediately after the
  572. transition to protected mode, but before the kernel is
  573. uncompressed. No segments, except CS, are guaranteed to be
  574. set up (current kernels do, but older ones do not); you should
  575. set them up to BOOT_DS (0x18) yourself.
  576. After completing your hook, you should jump to the address
  577. that was in this field before your boot loader overwrote it
  578. (relocated, if appropriate.)