Provide {get,set}_fbms() in basemem.h.
[people/xl0/gpxe.git] / src / arch / i386 / firmware / pcbios / hidemem.c
1 /* Copyright (C) 2006 Michael Brown <mbrown@fensystems.co.uk>.
2  *
3  * This program is free software; you can redistribute it and/or
4  * modify it under the terms of the GNU General Public License as
5  * published by the Free Software Foundation; either version 2 of the
6  * License, or any later version.
7  *
8  * This program is distributed in the hope that it will be useful, but
9  * WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11  * General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with this program; if not, write to the Free Software
15  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
16  */
17
18 #include <realmode.h>
19 #include <biosint.h>
20 #include <basemem.h>
21 #include <gpxe/hidemem.h>
22
23 /** Alignment for hidden memory regions */
24 #define ALIGN_HIDDEN 4096   /* 4kB page alignment should be enough */
25
26 /**
27  * A hidden region of Etherboot
28  *
29  * This represents a region that will be edited out of the system's
30  * memory map.
31  *
32  * This structure is accessed by assembly code, so must not be
33  * changed.
34  */
35 struct hidden_region {
36         /* Physical start address */
37         physaddr_t start;
38         /* Physical end address */
39         physaddr_t end;
40 };
41
42 /**
43  * List of hidden regions
44  *
45  * Must be terminated by a zero entry.
46  */
47 struct hidden_region __data16_array ( hidden_regions, [] ) = {
48         [TEXT] = { 0, 0 },
49         [BASEMEM] = { ( 640 * 1024 ), ( 640 * 1024 ) },
50         [EXTMEM] = { 0, 0 },
51         { 0, 0, } /* Terminator */
52 };
53 #define hidden_regions __use_data16 ( hidden_regions )
54
55 /** Assembly routine in e820mangler.S */
56 extern void int15();
57
58 /** Vector for storing original INT 15 handler */
59 extern struct segoff __text16 ( int15_vector );
60 #define int15_vector __use_text16 ( int15_vector )
61
62 /**
63  * Hide region of memory from system memory map
64  *
65  * @v start             Start of region
66  * @v end               End of region
67  */
68 void hide_region ( unsigned int region_id, physaddr_t start, physaddr_t end ) {
69         struct hidden_region *region = &hidden_regions[region_id];
70
71         /* Some operating systems get a nasty shock if a region of the
72          * E820 map seems to start on a non-page boundary.  Make life
73          * safer by rounding out our edited region.
74          */
75         region->start = ( start & ~( ALIGN_HIDDEN - 1 ) );
76         region->end = ( ( end + ALIGN_HIDDEN - 1 ) & ~( ALIGN_HIDDEN - 1 ) );
77
78         DBG ( "Hiding region %d [%lx,%lx)\n",
79               region_id, region->start, region->end );
80 }
81
82 /**
83  * Hide Etherboot text
84  *
85  */
86 static void hide_text ( void ) {
87
88         /* The linker defines these symbols for us */
89         extern char _text[];
90         extern char _end[];
91
92         hide_region ( TEXT, virt_to_phys ( _text ), virt_to_phys ( _end ) );
93 }
94
95 /**
96  * Hide used base memory
97  *
98  */
99 void hide_basemem ( void ) {
100         /* Hide from the top of free base memory to 640kB.  Don't use
101          * hide_region(), because we don't want this rounded to the
102          * nearest page boundary.
103          */
104         hidden_regions[BASEMEM].start = ( get_fbms() * 1024 );
105 }
106
107 /**
108  * Hide Etherboot
109  *
110  * Installs an INT 15 handler to edit Etherboot out of the memory map
111  * returned by the BIOS.
112  */
113 void hide_etherboot ( void ) {
114
115         /* Initialise the hidden regions */
116         hide_text();
117         hide_basemem();
118
119         /* Hook INT 15 */
120         hook_bios_interrupt ( 0x15, ( unsigned int ) int15,
121                               &int15_vector );
122 }
123
124 /**
125  * Unhide Etherboot
126  *
127  * Uninstalls the INT 15 handler installed by hide_etherboot(), if
128  * possible.
129  */
130 void unhide_etherboot ( void ) {
131         unhook_bios_interrupt ( 0x15, ( unsigned int ) int15,
132                                 &int15_vector );
133 }