da604625ae56137e87390efb95eb248ea884d9c5
[people/lynusvaz/gpxe.git] / src / arch / i386 / image / com32.c
1 /*
2  * Copyright (C) 2008 Daniel Verkamp <daniel@drv.nu>.
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 /**
20  * @file
21  *
22  * SYSLINUX COM32 image format
23  *
24  */
25
26 #include <stdint.h>
27 #include <stdlib.h>
28 #include <string.h>
29 #include <strings.h>
30 #include <errno.h>
31 #include <assert.h>
32 #include <realmode.h>
33 #include <basemem.h>
34 #include <comboot.h>
35 #include <gpxe/uaccess.h>
36 #include <gpxe/image.h>
37 #include <gpxe/segment.h>
38 #include <gpxe/init.h>
39 #include <gpxe/memmap.h>
40
41 struct image_type com32_image_type __image_type ( PROBE_NORMAL );
42
43 /**
44  * Execute COMBOOT image
45  *
46  * @v image             COM32 image
47  * @ret rc              Return status code
48  */
49 static int com32_exec ( struct image *image ) {
50         struct memory_map memmap;
51         unsigned int i;
52         int state;
53         uint32_t avail_mem_top;
54
55         state = setjmp ( comboot_return );
56
57         switch ( state ) {
58         case 0: /* First time through; invoke COM32 program */
59
60                 /* Get memory map */
61                 get_memmap ( &memmap );
62
63                 /* Find end of block covering COM32 image loading area */
64                 for ( i = 0, avail_mem_top = 0 ; i < memmap.count ; i++ ) {
65                         if ( (memmap.regions[i].start <= COM32_START_PHYS) &&
66                              (memmap.regions[i].end > COM32_START_PHYS + image->len) ) {
67                                 avail_mem_top = memmap.regions[i].end;
68                                 break;
69                         }
70                 }
71
72                 DBGC ( image, "COM32 %p: available memory top = 0x%x\n",
73                          image, (int)avail_mem_top );
74
75                 assert ( avail_mem_top != 0 );
76
77                 com32_external_esp = phys_to_virt ( avail_mem_top );
78
79                 /* Hook COMBOOT API interrupts */
80                 hook_comboot_interrupts( );
81
82                 /* Temporarily de-register image, so that a "boot" command
83                  * doesn't throw us into an execution loop.  Hold a reference
84                  * to avoid the image's being freed.
85                  */
86                 image_get ( image );
87                 unregister_image ( image );
88
89                 __asm__ __volatile__ (
90                         "movl %%esp, (com32_internal_esp)\n\t" /* Save internal virtual address space ESP */
91                         "movl (com32_external_esp), %%esp\n\t" /* Switch to COM32 ESP (top of available memory) */
92                         "call _virt_to_phys\n\t"               /* Switch to flat physical address space */
93                         "pushl %0\n\t"                         /* Pointer to CDECL helper function */
94                         "pushl %1\n\t"                         /* Pointer to FAR call helper function */
95                         "pushl %2\n\t"                         /* Size of low memory bounce buffer */
96                         "pushl %3\n\t"                         /* Pointer to low memory bounce buffer */
97                         "pushl %4\n\t"                         /* Pointer to INT call helper function */
98                         "pushl %5\n\t"                         /* Pointer to the command line arguments */
99                         "pushl $6\n\t"                         /* Number of additional arguments */
100                         "call *%6\n\t"                         /* Execute image */
101                         "call _phys_to_virt\n\t"               /* Switch back to internal virtual address space */
102                         "movl (com32_internal_esp), %%esp\n\t" /* Switch back to internal stack */
103                 :
104                 :
105                         /* %0 */ "r" ( virt_to_phys ( com32_cfarcall_wrapper ) ),
106                         /* %1 */ "r" ( virt_to_phys ( com32_farcall_wrapper ) ),
107                         /* %2 */ "r" ( get_fbms() * 1024 - (COM32_BOUNCE_SEG << 4) ),
108                         /* %3 */ "i" ( COM32_BOUNCE_SEG << 4 ),
109                         /* %4 */ "r" ( virt_to_phys ( com32_intcall_wrapper ) ),
110                         /* %5 */ "r" ( virt_to_phys ( image->cmdline ) ),
111                         /* %6 */ "r" ( COM32_START_PHYS )
112                 :
113                         "memory" );
114                 break;
115
116         case COMBOOT_RETURN_RUN_KERNEL:
117                 DBGC ( image, "COM32 %p: returned to run kernel...\n", image );
118                 comboot_run_kernel ( );
119                 break;
120
121         case COMBOOT_RETURN_EXIT:
122                 break;
123
124         }
125
126         comboot_force_text_mode ( );
127
128         DBGC ( image, "COM32 %p returned\n", image );
129
130         /* Re-register image and return */
131         register_image ( image );
132         image_put ( image );
133
134         return 0;
135 }
136
137 /**
138  * Check image name extension
139  * 
140  * @v image             COM32 image
141  * @ret rc              Return status code
142  */
143 static int com32_identify ( struct image *image ) {
144         const char *ext;
145         static const uint8_t magic[] = { 0xB8, 0xFF, 0x4C, 0xCD, 0x21 };
146         uint8_t buf[5];
147         
148         if ( image->len >= 5 ) {
149                 /* Check for magic number
150                  * mov eax,21cd4cffh
151                  * B8 FF 4C CD 21
152                  */
153                 copy_from_user ( buf, image->data, 0, sizeof(buf) );
154                 if ( ! memcmp ( buf, magic, sizeof(buf) ) ) {
155                         DBGC ( image, "COM32 %p: found magic number\n",
156                                image );
157                         return 0;
158                 }
159         }
160
161         /* Magic number not found; check filename extension */
162
163         ext = strrchr( image->name, '.' );
164
165         if ( ! ext ) {
166                 DBGC ( image, "COM32 %p: no extension\n",
167                        image );
168                 return -ENOEXEC;
169         }
170
171         ++ext;
172
173         if ( strcasecmp( ext, "c32" ) ) {
174                 DBGC ( image, "COM32 %p: unrecognized extension %s\n",
175                        image, ext );
176                 return -ENOEXEC;
177         }
178
179         return 0;
180 }
181
182
183 /**
184  * Load COM32 image into memory
185  * @v image             COM32 image
186  * @ret rc              Return status code
187  */
188 static int comboot_load_image ( struct image *image ) {
189         size_t filesz, memsz;
190         userptr_t buffer;
191         int rc;
192
193         filesz = image->len;
194         memsz = filesz;
195         buffer = phys_to_user ( COM32_START_PHYS );
196         if ( ( rc = prep_segment ( buffer, filesz, memsz ) ) != 0 ) {
197                 DBGC ( image, "COM32 %p: could not prepare segment: %s\n",
198                        image, strerror ( rc ) );
199                 return rc;
200         }
201
202         /* Copy image to segment */
203         memcpy_user ( buffer, 0, image->data, 0, filesz );
204
205         return 0;
206 }
207
208 /**
209  * Prepare COM32 low memory bounce buffer
210  * @v image             COM32 image
211  * @ret rc              Return status code
212  */
213 static int comboot_prepare_bounce_buffer ( struct image * image ) {
214         unsigned int seg;
215         userptr_t seg_userptr;
216         size_t filesz, memsz;
217         int rc;
218
219         seg = COM32_BOUNCE_SEG;
220         seg_userptr = real_to_user ( seg, 0 );
221
222         /* Ensure the entire 64k segment is free */
223         memsz = 0xFFFF;
224         filesz = 0;
225
226         /* Prepare, verify, and load the real-mode segment */
227         if ( ( rc = prep_segment ( seg_userptr, filesz, memsz ) ) != 0 ) {
228                 DBGC ( image, "COM32 %p: could not prepare bounce buffer segment: %s\n",
229                        image, strerror ( rc ) );
230                 return rc;
231         }
232
233         return 0;
234 }
235
236 /**
237  * Load COM32 image into memory
238  *
239  * @v image             COM32 image
240  * @ret rc              Return status code
241  */
242 static int com32_load ( struct image *image ) {
243         int rc;
244
245         DBGC ( image, "COM32 %p: name '%s', cmdline '%s'\n",
246                image, image->name, image->cmdline );
247
248         /* Check if this is a COMBOOT image */
249         if ( ( rc = com32_identify ( image ) ) != 0 ) {
250                 return rc;
251         }
252
253         /* This is a COM32 image, valid or otherwise */
254         if ( ! image->type )
255                 image->type = &com32_image_type;
256
257         /* Load image */
258         if ( ( rc = comboot_load_image ( image ) ) != 0 ) {
259                 return rc;
260         }
261
262         /* Prepare bounce buffer segment */
263         if ( ( rc = comboot_prepare_bounce_buffer ( image ) ) != 0 ) {
264                 return rc;
265         }
266
267         return 0;
268 }
269
270 /** SYSLINUX COM32 image type */
271 struct image_type com32_image_type __image_type ( PROBE_NORMAL ) = {
272         .name = "COM32",
273         .load = com32_load,
274         .exec = com32_exec,
275 };