MAJOR BOOT CODE REVAMP / 30 hour+ hacking session (50 if you include the
[dragonfly.git] / sys / boot / i386 / bootasm.h
1 /* 
2  * Copyright (c) 2004 The DragonFly Project.  All rights reserved.
3  * 
4  * This code is derived from software contributed to The DragonFly Project
5  * by Matthew Dillon <dillon@backplane.com>
6  * 
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in
15  *    the documentation and/or other materials provided with the
16  *    distribution.
17  * 3. Neither the name of The DragonFly Project nor the names of its
18  *    contributors may be used to endorse or promote products derived
19  *    from this software without specific, prior written permission.
20  * 
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
25  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
31  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  *
34  * $DragonFly: src/sys/boot/i386/Attic/bootasm.h,v 1.3 2004/07/19 23:30:29 dillon Exp $
35  */
36
37 /* 
38  * Set the bootloader address set.
39  *
40  * UNSET - default backwards compatible boot blocks
41  *   1   - experimental move addresses above 0x1000 and hardwire the user
42  *         stack.
43  *   2   - experimental move addresses abobe 0x2000 and hardwire the user
44  *         stack.
45  */
46 /* #define BOOT_NEWBOOTLOADER 2 */
47
48 /*
49  * Various fixed constants that do not change
50  */
51
52 #define BDA_MEM         0x413           /* Free memory          */
53 #define BDA_KEYFLAGS    0x417           /* Keyboard shift-state flags   */
54 #define BDA_SCR         0x449           /* Video mode           */
55 #define BDA_POS         0x450           /* Cursor position      */
56 #define BDA_BOOT        0x472           /* Boot howto flag      */
57 #define BDA_NHRDRV      0x475
58 #define BDA_KEYBOARD    0x496           /* BDA byte with keyboard bit */
59
60 /*
61  * Structural equivalences
62  */
63 #define BOOTINFO_SIZE   0x48            /* bootinfo structure size */
64 #define MEM_ARG_SIZE    0x18
65 #define MEM_PAGE_SIZE   0x1000
66 #define MEM_BTX_LDR_OFF MEM_PAGE_SIZE   /* offset of btx in the loader */
67 #define USR_ARGOFFSET   (BOOTINFO_SIZE+MEM_ARG_SIZE)
68
69 /* -------- WARNING, BOOT0 STACK BELOW MEM_BIOS_LADDR -------- */
70 #define MEM_BIOS_LADDR  0x7c00          /* Load address (static/BIOS) */
71
72 /*
73  * NOTE: BOOT0_ORIGIN is extracted from this file and used in boot0/Makefile
74  *       BOOT1_ORIGIN is extracted from this file and used in boot2/Makefile
75  *
76  *       NOTE: boot0 has a variable space after its sector which contains
77  *       the fake partition and other variables.  ~128 bytes should be reserved
78  *       for this variable space, but it may overlap BOOT1's data space.
79  */
80
81 #if !defined(BOOT_NEWBOOTLOADER)
82
83 /************************************************************************
84  *                      STANDARD BOOTLOADER ADDRESS SET                 *
85  ************************************************************************
86  *
87  *
88  */
89
90 #define USR_ARGSPACE    0x1000          /* BTX loader / ttl argspace reserved */
91
92 #define BOOT0_ORIGIN    0x600           /* boot0 relocated to (512+128 bytes) */
93 /* -------- WARNING, BOOT1 STACK BELOW BOOT1_ORIGIN ------- */
94 #define BOOT1_ORIGIN    0x700           /* boot1 relocated to (512 bytes) */
95 #define MEM_ARG         0x900           /* tmp arg store cdboot/pxeboot */
96
97 #define MEM_BTX_ESP     0x1000          /* btxldr top of stack? */
98 #define MEM_BTX_START   0x1000          /* start of BTX memory */
99 #define MEM_BTX_ESP0    0x1800          /* Supervisor stack */
100 #define MEM_BTX_BUF     0x1800          /* Scratch buffer stack */
101 #define MEM_BTX_ESP1    0x1e00          /* Link stack */
102 #define MEM_BTX_IDT     0x1e00          /* IDT */
103 #define MEM_BTX_TSS     0x1f98          /* TSS */
104 #define MEM_BTX_MAP     0x2000          /* I/O bit map */
105 #define MEM_BTX_DIR     0x4000          /* Page directory */
106
107 /*
108  * NOTE: page table location is hardwired in /usr/src/usr.sbin/btxld/btx.h
109  */
110 #define MEM_BTX_TBL     0x5000          /* Page tables */
111 #define MEM_BTX_ZEND    0x7000          /* Zero from IDT to here in btx.S */
112
113 /********************   0x7c00 BIOS LOAD ADDRESS (512 bytes) **********/
114
115 /*
116  * NOTE: BOOT2_LOAD_BUF also determines where the btx loader and boot2.bin
117  *       code are loaded, since they are all in the boot2 file.
118  */
119 #define BOOT2_LOAD_BUF  0x8c00          /* boot1 loads boot2    */
120 #define MEM_BTX_ORG     0x9000          /* base of BTX code */
121 #define MEM_BTX_ENTRY   0x9010          /* BTX starts execution here */
122 /*
123  * WARNING!  The USR area may be messed around with in 16 bit code mode,
124  *           data loaded should probably not cross 0xffff (e.g. boot2 loads
125  *           ~8K at MEM_BTX_USR).
126  *
127  *           MEM_BTX_USR is basically the segment offset BTX uses when
128  *           running 'client' code.  So address 0 in the client code will
129  *           actually be physical address MEM_BTX_USR.
130  */
131 #define MEM_BTX_USR     0xa000          /* base of BTX client/user memory */
132 #define MEM_BTX_USR_ARG 0xa100
133
134 #elif defined(BOOT_NEWBOOTLOADER) && BOOT_NEWBOOTLOADER == 1
135
136 /************************************************************************
137  *              EXPERIMENTAL BOOTLOADER ADDRESS SET 1                   *
138  ************************************************************************
139  *
140  *
141  */
142
143 #define USR_ARGSPACE    0x1000          /* BTX loader / ttl argspace reserved */
144 #define MEM_BTX_USR_STK 0x90000         /* (phys addr) btx client usr stack */
145
146 #define MEM_BTX_START   0x1000          /* (unchanged)          */
147 #define MEM_BTX_ESP0    0x1800          /* (unchanged)          */
148 #define MEM_BTX_BUF     0x1800          /* (unchanged)          */
149 #define MEM_BTX_ESP1    0x1e00          /* (unchanged)          */
150 #define MEM_BTX_IDT     0x1e00          /* (unchanged)          */
151 #define MEM_BTX_TSS     0x1f98          /* (unchanged)          */
152 #define MEM_BTX_MAP     0x2000          /* (unchanged)          */
153 #define MEM_BTX_DIR     0x4000          /* (unchanged)          */
154 #define MEM_BTX_TBL     0x5000          /* (unchanged)          */
155 #define MEM_BTX_ZEND    0x7000          /* (unchanged)          */
156
157 #define MEM_BTX_ESP     0x7800          /* don't use 0x1000             */
158 #define BOOT0_ORIGIN    0x7800          /* boot0 relocated              */
159 #define BOOT1_ORIGIN    0x7900          /* boot1 relocated (data only?) */
160 #define MEM_ARG         0x7b00          /* cdboot/pxeboot disk/slice xfer */
161 /********************   0x7c00 BIOS LOAD ADDRESS (512 bytes) **********/
162
163 #define BOOT2_LOAD_BUF  0x8c00          /* (unchanged)          */
164 #define MEM_BTX_ORG     0x9000          /* (unchanged)          */
165 #define MEM_BTX_ENTRY   0x9010          /* (unchanged)          */
166
167 #define MEM_BTX_USR     0xa000          /* (unchanged)          */
168 #define MEM_BTX_USR_ARG 0xa100          /* (unchanged)          */
169
170
171 #elif defined(BOOT_NEWBOOTLOADER) && BOOT_NEWBOOTLOADER == 2
172
173 /************************************************************************
174  *              EXPERIMENTAL BOOTLOADER ADDRESS SET 2                   *
175  ************************************************************************
176  *
177  *
178  */
179 #define USR_ARGSPACE    0x1000          /* BTX loader / ttl argspace reserved */
180 #define MEM_BTX_USR_STK 0x90000         /* (phys addr) btx client usr stack */
181
182 #define MEM_BTX_START   0x2000          /* (unchanged)          */
183 #define MEM_BTX_ESP0    0x2800          /* (unchanged)          */
184 #define MEM_BTX_BUF     0x2800          /* (unchanged)          */
185 #define MEM_BTX_ESP1    0x2e00          /* (unchanged)          */
186 #define MEM_BTX_IDT     0x2e00          /* (unchanged)          */
187 #define MEM_BTX_TSS     0x2f98          /* (unchanged)          */
188 #define MEM_BTX_MAP     0x3000          /* (unchanged)          */
189 #define MEM_BTX_DIR     0x5000          /* (unchanged)          */
190 /****** MEM_BTX_TBL (16K) SUPPORT REMOVED ***********************/
191 #define MEM_BTX_ZEND    0x6000          /* (unchanged)          */
192
193 #define MEM_BTX_ESP     0x7800          /* don't use 0x1000             */
194 #define BOOT0_ORIGIN    0x7800          /* boot0 relocated              */
195 #define BOOT1_ORIGIN    0x7900          /* boot1 relocated (data only?) */
196 #define MEM_ARG         0x7b00          /* cdboot/pxeboot disk/slice xfer */
197 /********************   0x7c00 BIOS LOAD ADDRESS (512 bytes) **********/
198
199 #define BOOT2_LOAD_BUF  0x8c00          /* (unchanged)          */
200 #define MEM_BTX_ORG     0x9000          /* (unchanged)          */
201 #define MEM_BTX_ENTRY   0x9010          /* (unchanged)          */
202
203 #define MEM_BTX_USR     0xa000          /* base of BTX client/user memory */
204 #define MEM_BTX_USR_ARG 0xa100          /* boot1->boot2 disk/slice xfer */
205
206 #else
207
208 #error "BAD BOOT_NEWBOOTLOADER SETTING.  UNSET TO GET DEFAULT"
209
210 #endif  /* BOOT_NEWBOOTLOADER */
211