Update to REAL_CODE()
[people/xl0/gpxe.git] / src / arch / i386 / firmware / pcbios / memmap.c
1 /*
2  * Copyright (C) 2006 Michael Brown <mbrown@fensystems.co.uk>.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License as
6  * published by the Free Software Foundation; either version 2 of the
7  * License, or any later version.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17  */
18
19 #include <stdint.h>
20 #include <errno.h>
21 #include <realmode.h>
22 #include <bios.h>
23 #include <memmap.h>
24
25 /**
26  * @file
27  *
28  * Memory mapping
29  *
30  */
31
32 /** Magic value for INT 15,e820 calls */
33 #define SMAP ( 0x534d4150 )
34
35 /** An INT 15,e820 memory map entry */
36 struct e820_entry {
37         /** Start of region */
38         uint64_t start;
39         /** Length of region */
40         uint64_t len;
41         /** Type of region */
42         uint32_t type;
43 } __attribute__ (( packed ));
44
45 #define E820_TYPE_RAM           1 /**< Normal memory */
46 #define E820_TYPE_RESERVED      2 /**< Reserved and unavailable */
47 #define E820_TYPE_ACPI          3 /**< ACPI reclaim memory */
48 #define E820_TYPE_NVS           4 /**< ACPI NVS memory */
49
50 /** Buffer for INT 15,e820 calls */
51 static struct e820_entry __data16 ( e820buf );
52 #define e820buf __use_data16 ( e820buf )
53
54 /**
55  * Get size of base memory from BIOS free base memory counter
56  *
57  * @ret basemem         Base memory size, in kB
58  */
59 static unsigned int basememsize ( void ) {
60         uint16_t basemem;
61
62         get_real ( basemem, BDA_SEG, 0x0013 );
63         DBG ( "Base memory size %dkB\n", basemem );
64         return basemem;
65 }
66
67 /**
68  * Get size of extended memory via INT 15,e801
69  *
70  * @ret extmem          Extended memory size, in kB, or 0
71  */
72 static unsigned int extmemsize_e801 ( void ) {
73         uint16_t extmem_1m_to_16m_k, extmem_16m_plus_64k;
74         uint16_t confmem_1m_to_16m_k, confmem_16m_plus_64k;
75         unsigned int flags;
76         unsigned int extmem;
77
78         __asm__ __volatile__ ( REAL_CODE ( "stc\n\t"
79                                            "int $0x15\n\t"
80                                            "pushfw\n\t"
81                                            "popw %w0\n\t" )
82                                : "=r" ( flags ),
83                                  "=a" ( extmem_1m_to_16m_k ),
84                                  "=b" ( extmem_16m_plus_64k ),
85                                  "=c" ( confmem_1m_to_16m_k ),
86                                  "=d" ( confmem_16m_plus_64k )
87                                : "a" ( 0xe801 ) );
88
89         if ( flags & CF )
90                 return 0;
91
92         if ( ! ( extmem_1m_to_16m_k | extmem_16m_plus_64k ) ) {
93                 extmem_1m_to_16m_k = confmem_1m_to_16m_k;
94                 extmem_16m_plus_64k = confmem_16m_plus_64k;
95         }
96
97         extmem = ( extmem_1m_to_16m_k + ( extmem_16m_plus_64k * 64 ) );
98         DBG ( "Extended memory size %d+64*%d=%d kB\n",
99               extmem_1m_to_16m_k, extmem_16m_plus_64k, extmem );
100         return extmem;
101 }
102
103 /**
104  * Get size of extended memory via INT 15,88
105  *
106  * @ret extmem          Extended memory size, in kB
107  */
108 static unsigned int extmemsize_88 ( void ) {
109         uint16_t extmem;
110
111         /* Ignore CF; it is not reliable for this call */
112         __asm__ __volatile__ ( REAL_CODE ( "int $0x15" )
113                                : "=a" ( extmem ) : "a" ( 0x8800 ) );
114
115         DBG ( "Extended memory size %d kB\n", extmem );
116         return extmem;
117 }
118
119 /**
120  * Get size of extended memory
121  *
122  * @ret extmem          Extended memory size, in kB
123  */
124 static unsigned int extmemsize ( void ) {
125         unsigned int extmem;
126
127         /* Try INT 15,e801 first, then fall back to INT 15,88 */
128         extmem = extmemsize_e801();
129         if ( ! extmem )
130                 extmem = extmemsize_88();
131         return extmem;
132 }
133
134 /**
135  * Get e820 memory map
136  *
137  * @v memmap            Memory map to fill in
138  * @v entries           Maximum number of entries in memory map
139  * @ret rc              Return status code
140  */
141 static int meme820 ( struct memory_region *memmap, unsigned int entries ) {
142         unsigned int index = 0;
143         uint32_t next = 0;
144         uint32_t smap;
145         unsigned int flags;
146         unsigned int discard_c, discard_d, discard_D;
147
148         do {
149                 __asm__ __volatile__ ( REAL_CODE ( "stc\n\t"
150                                                    "int $0x15\n\t"
151                                                    "pushfw\n\t"
152                                                    "popw %w0\n\t" )
153                                        : "=r" ( flags ), "=a" ( smap ),
154                                          "=b" ( next ), "=D" ( discard_D ),
155                                          "=c" ( discard_c ), "=d" ( discard_d )
156                                        : "a" ( 0xe820 ), "b" ( next ),
157                                          "D" ( &__from_data16 ( e820buf ) ),
158                                          "c" ( sizeof ( e820buf ) ),
159                                          "d" ( SMAP )
160                                        : "memory" );
161
162                 if ( smap != SMAP )
163                         return -ENOTSUP;
164
165                 if ( flags & CF )
166                         break;
167
168                 DBG ( "E820 region [%llx,%llx) type %d\n", e820buf.start,
169                       ( e820buf.start + e820buf.len ), ( int ) e820buf.type );
170                 if ( e820buf.type != E820_TYPE_RAM )
171                         continue;
172
173                 memmap[index].start = e820buf.start;
174                 memmap[index].end = e820buf.start + e820buf.len;
175                 index++;
176         } while ( ( index < entries ) && ( next != 0 ) );
177         return 0;
178 }
179
180 /**
181  * Get memory map
182  *
183  * @v memmap            Memory map to fill in
184  * @v entries           Maximum number of entries in memory map (minimum 2)
185  */
186 void get_memmap ( struct memory_region *memmap, unsigned int entries ) {
187         unsigned int basemem, extmem;
188         int rc;
189
190         /* Clear memory map */
191         memset ( memmap, 0, ( entries * sizeof ( *memmap ) ) );
192
193         /* Get base and extended memory sizes */
194         basemem = basememsize();
195         extmem = extmemsize();
196         
197         /* Try INT 15,e820 first */
198         if ( ( rc = meme820 ( memmap, entries ) ) == 0 )
199                 return;
200
201         /* Fall back to constructing a map from basemem and extmem sizes */
202         memmap[0].end = ( basemem * 1024 );
203         memmap[1].start = 0x100000;
204         memmap[1].end = 0x100000 + ( extmem * 1024 );
205 }