Add int13_boot(), to allow booting from INT 13 emulated drives.
[people/xl0/gpxe-arm.git] / src / arch / i386 / interface / pcbios / int13.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 <limits.h>
21 #include <byteswap.h>
22 #include <errno.h>
23 #include <assert.h>
24 #include <gpxe/list.h>
25 #include <gpxe/blockdev.h>
26 #include <realmode.h>
27 #include <bios.h>
28 #include <biosint.h>
29 #include <int13.h>
30
31 /** @file
32  *
33  * INT 13 emulation
34  *
35  * This module provides a mechanism for exporting block devices via
36  * the BIOS INT 13 disk interrupt interface.  
37  *
38  */
39
40 /** Vector for chaining to other INT 13 handlers */
41 static struct segoff __text16 ( int13_vector );
42 #define int13_vector __use_text16 ( int13_vector )
43
44 /** Assembly wrapper */
45 extern void int13_wrapper ( void );
46
47 /** Vector for storing original INT 18 handler
48  *
49  * We do not chain to this vector, so there is no need to place it in
50  * .text16.
51  */
52 static struct segoff int18_vector;
53
54 /** Restart point for INT 18 */
55 extern void int13_exec_fail ( void );
56
57 /** List of registered emulated drives */
58 static LIST_HEAD ( drives );
59
60 /**
61  * Convert CHS address to linear address
62  *
63  * @v drive             Emulated drive
64  * @v ch                Low bits of cylinder number
65  * @v cl (bits 7:6)     High bits of cylinder number
66  * @v cl (bits 5:0)     Sector number
67  * @v dh                Head number
68  * @ret lba             LBA address
69  * 
70  */
71 static unsigned long chs_to_lba ( struct int13_drive *drive,
72                                   struct i386_all_regs *ix86 ) {
73         unsigned int cylinder;
74         unsigned int head;
75         unsigned int sector;
76         unsigned long lba;
77
78         cylinder = ( ( ( ix86->regs.cl & 0xc0 ) << 8 ) | ix86->regs.ch );
79         head = ix86->regs.dh;
80         sector = ( ix86->regs.cl & 0x3f );
81
82         assert ( cylinder < drive->cylinders );
83         assert ( head < drive->heads );
84         assert ( ( sector >= 1 ) && ( sector <= drive->sectors_per_track ) );
85
86         lba = ( ( ( ( cylinder * drive->heads ) + head )
87                   * drive->sectors_per_track ) + sector - 1 );
88
89         DBG ( "C/H/S address %x/%x/%x -> LBA %x\n",
90               cylinder, head, sector, lba );
91
92         return lba;
93 }
94
95 /**
96  * Read from drive to real-mode data buffer
97  *
98  * @v drive             Emulated drive
99  * @v lba               LBA starting sector number
100  * @v data              Data buffer
101  * @v count             Number of sectors to read
102  * @ret status          Status code
103  */
104 static int int13_read ( struct int13_drive *drive, uint64_t lba,
105                         struct segoff data, unsigned long count ) {
106         struct block_device *blockdev = drive->blockdev;
107         size_t blksize = blockdev->blksize;
108         uint8_t buffer[blksize];
109         int rc;
110
111         DBG ( "Read %lx sectors from %llx to %04x:%04x\n", count,
112               ( unsigned long long ) lba, data.segment, data.offset );
113         while ( count-- ) {
114                 if ( ( rc = blockdev->read ( blockdev, lba, buffer ) ) != 0 )
115                         return INT13_STATUS_READ_ERROR;
116                 copy_to_real ( data.segment, data.offset, buffer, blksize );
117                 data.offset += blksize;
118                 lba++;
119         }
120         return 0;
121 }
122
123 /**
124  * Write from real-mode data buffer to drive
125  *
126  * @v drive             Emulated drive
127  * @v lba               LBA starting sector number
128  * @v data              Data buffer
129  * @v count             Number of sectors to read
130  * @ret status          Status code
131  */
132 static int int13_write ( struct int13_drive *drive, uint64_t lba,
133                          struct segoff data, unsigned long count ) {
134         struct block_device *blockdev = drive->blockdev;
135         size_t blksize = blockdev->blksize;
136         uint8_t buffer[blksize];
137         int rc;
138
139         DBG ( "Write %lx sectors from %04x:%04x to %llx\n", count,
140               data.segment, data.offset, ( unsigned long long ) lba );
141         while ( count-- ) {
142                 copy_from_real ( buffer, data.segment, data.offset, blksize );
143                 if ( ( rc = blockdev->write ( blockdev, lba, buffer ) ) != 0 )
144                         return INT13_STATUS_WRITE_ERROR;
145                 data.offset += blksize;
146                 lba++;
147         }
148         return 0;
149 }
150
151 /**
152  * INT 13, 00 - Reset disk system
153  *
154  * @v drive             Emulated drive
155  * @ret status          Status code
156  */
157 static int int13_reset ( struct int13_drive *drive __unused,
158                          struct i386_all_regs *ix86 __unused ) {
159         DBG ( "Reset drive\n" );
160         return 0;
161 }
162
163 /**
164  * INT 13, 01 - Get status of last operation
165  *
166  * @v drive             Emulated drive
167  * @ret status          Status code
168  */
169 static int int13_get_last_status ( struct int13_drive *drive,
170                                    struct i386_all_regs *ix86 __unused ) {
171         DBG ( "Get status of last operation\n" );
172         return drive->last_status;
173 }
174
175 /**
176  * INT 13, 02 - Read sectors
177  *
178  * @v drive             Emulated drive
179  * @v al                Number of sectors to read (must be nonzero)
180  * @v ch                Low bits of cylinder number
181  * @v cl (bits 7:6)     High bits of cylinder number
182  * @v cl (bits 5:0)     Sector number
183  * @v dh                Head number
184  * @v es:bx             Data buffer
185  * @ret status          Status code
186  * @ret al              Number of sectors read
187  */
188 static int int13_read_sectors ( struct int13_drive *drive,
189                                 struct i386_all_regs *ix86 ) {
190         unsigned long lba = chs_to_lba ( drive, ix86 );
191         unsigned int count = ix86->regs.al;
192         struct segoff data = {
193                 .segment = ix86->segs.es,
194                 .offset = ix86->regs.bx,
195         };
196
197         if ( drive->blockdev->blksize != INT13_BLKSIZE ) {
198                 DBG ( "Invalid blocksize (%d) for non-extended read\n",
199                       drive->blockdev->blksize );
200                 return INT13_STATUS_INVALID;
201         }
202
203         return int13_read ( drive, lba, data, count );
204 }
205
206 /**
207  * INT 13, 03 - Write sectors
208  *
209  * @v drive             Emulated drive
210  * @v al                Number of sectors to write (must be nonzero)
211  * @v ch                Low bits of cylinder number
212  * @v cl (bits 7:6)     High bits of cylinder number
213  * @v cl (bits 5:0)     Sector number
214  * @v dh                Head number
215  * @v es:bx             Data buffer
216  * @ret status          Status code
217  * @ret al              Number of sectors written
218  */
219 static int int13_write_sectors ( struct int13_drive *drive,
220                                  struct i386_all_regs *ix86 ) {
221         unsigned long lba = chs_to_lba ( drive, ix86 );
222         unsigned int count = ix86->regs.al;
223         struct segoff data = {
224                 .segment = ix86->segs.es,
225                 .offset = ix86->regs.bx,
226         };
227
228         if ( drive->blockdev->blksize != INT13_BLKSIZE ) {
229                 DBG ( "Invalid blocksize (%d) for non-extended write\n",
230                       drive->blockdev->blksize );
231                 return INT13_STATUS_INVALID;
232         }
233
234         return int13_write ( drive, lba, data, count );
235 }
236
237 /**
238  * INT 13, 08 - Get drive parameters
239  *
240  * @v drive             Emulated drive
241  * @ret status          Status code
242  * @ret ch              Low bits of maximum cylinder number
243  * @ret cl (bits 7:6)   High bits of maximum cylinder number
244  * @ret cl (bits 5:0)   Maximum sector number
245  * @ret dh              Maximum head number
246  * @ret dl              Number of drives
247  */
248 static int int13_get_parameters ( struct int13_drive *drive,
249                                   struct i386_all_regs *ix86 ) {
250         unsigned int max_cylinder = drive->cylinders - 1;
251         unsigned int max_head = drive->heads - 1;
252         unsigned int max_sector = drive->sectors_per_track; /* sic */
253
254         DBG ( "Get drive parameters\n" );
255
256         ix86->regs.ch = ( max_cylinder & 0xff );
257         ix86->regs.cl = ( ( ( max_cylinder >> 8 ) << 6 ) | max_sector );
258         ix86->regs.dh = max_head;
259         get_real ( ix86->regs.dl, BDA_SEG, BDA_NUM_DRIVES );
260         return 0;
261 }
262
263 /**
264  * INT 13, 42 - Extended read
265  *
266  * @v drive             Emulated drive
267  * @v ds:si             Disk address packet
268  * @ret status          Status code
269  */
270 static int int13_extended_read ( struct int13_drive *drive,
271                                  struct i386_all_regs *ix86 ) {
272         struct int13_disk_address addr;
273
274         copy_from_real ( &addr, ix86->segs.ds, ix86->regs.si,
275                          sizeof ( addr ) );
276         return int13_read ( drive, addr.lba, addr.buffer, addr.count );
277 }
278
279 /**
280  * INT 13, 43 - Extended write
281  *
282  * @v drive             Emulated drive
283  * @v ds:si             Disk address packet
284  * @ret status          Status code
285  */
286 static int int13_extended_write ( struct int13_drive *drive,
287                                   struct i386_all_regs *ix86 ) {
288         struct int13_disk_address addr;
289
290         copy_from_real ( &addr, ix86->segs.ds, ix86->regs.si,
291                          sizeof ( addr ) );
292         return int13_write ( drive, addr.lba, addr.buffer, addr.count );
293 }
294
295 /**
296  * INT 13, 48 - Get extended parameters
297  *
298  * @v drive             Emulated drive
299  * @v ds:si             Drive parameter table
300  * @ret status          Status code
301  */
302 static int int13_get_extended_parameters ( struct int13_drive *drive,
303                                            struct i386_all_regs *ix86 ) {
304         struct int13_disk_parameters params = {
305                 .bufsize = sizeof ( params ),
306                 .flags = INT13_FL_DMA_TRANSPARENT,
307                 .cylinders = drive->cylinders,
308                 .heads = drive->heads,
309                 .sectors_per_track = drive->sectors_per_track,
310                 .sectors = drive->blockdev->blocks,
311                 .sector_size = drive->blockdev->blksize,
312         };
313         
314         DBG ( "Get extended drive parameters to %04x:%04x\n",
315               ix86->segs.ds, ix86->regs.si );
316
317         copy_to_real ( ix86->segs.ds, ix86->regs.si, &params,
318                        sizeof ( params ) );
319         return 0;
320 }
321
322 /**
323  * INT 13 handler
324  *
325  */
326 static void int13 ( struct i386_all_regs *ix86 ) {
327         struct int13_drive *drive;
328         int status;
329
330         list_for_each_entry ( drive, &drives, list ) {
331                 if ( drive->drive != ix86->regs.dl )
332                         continue;
333                 
334                 DBG ( "INT 13, %02x on drive %02x\n", ix86->regs.ah,
335                       ix86->regs.dl );
336         
337                 switch ( ix86->regs.ah ) {
338                 case INT13_RESET:
339                         status = int13_reset ( drive, ix86 );
340                         break;
341                 case INT13_GET_LAST_STATUS:
342                         status = int13_get_last_status ( drive, ix86 );
343                         break;
344                 case INT13_READ_SECTORS:
345                         status = int13_read_sectors ( drive, ix86 );
346                         break;
347                 case INT13_WRITE_SECTORS:
348                         status = int13_write_sectors ( drive, ix86 );
349                         break;
350                 case INT13_GET_PARAMETERS:
351                         status = int13_get_parameters ( drive, ix86 );
352                         break;
353                 case INT13_EXTENDED_READ:
354                         status = int13_extended_read ( drive, ix86 );
355                         break;
356                 case INT13_EXTENDED_WRITE:
357                         status = int13_extended_write ( drive, ix86 );
358                         break;
359                 case INT13_GET_EXTENDED_PARAMETERS:
360                         status = int13_get_extended_parameters ( drive, ix86 );
361                         break;
362                 default:
363                         DBG ( "Unrecognised INT 13\n" );
364                         status = INT13_STATUS_INVALID;
365                         break;
366                 }
367
368                 /* Store status for INT 13,01 */
369                 drive->last_status = status;
370                 /* All functions return status via %ah and CF */
371                 ix86->regs.ah = status;
372                 if ( status ) {
373                         ix86->flags |= CF;
374                         DBG ( "INT13 failed with status %x\n", status );
375                 }
376                 /* Set OF to indicate to wrapper not to chain this call */
377                 ix86->flags |= OF;
378         }
379 }
380
381 /**
382  * Hook INT 13 handler
383  *
384  */
385 static void hook_int13 ( void ) {
386         /* Assembly wrapper to call int13().  int13() sets OF if we
387          * should not chain to the previous handler.  (The wrapper
388          * clears CF and OF before calling int13()).
389          */
390         __asm__  __volatile__ ( ".section \".text16\", \"ax\", @progbits\n\t"
391                                 ".code16\n\t"
392                                 "\nint13_wrapper:\n\t"
393                                 "orb $0, %%al\n\t" /* clear CF and OF */
394                                 "pushl %0\n\t" /* call int13() */
395                                 "data32 call prot_call\n\t"
396                                 "jo 1f\n\t" /* chain if OF not set */
397                                 "pushfw\n\t"
398                                 "lcall *%%cs:int13_vector\n\t"
399                                 "\n1:\n\t"
400                                 "call 2f\n\t" /* return with flags intact */
401                                 "lret $2\n\t"
402                                 "\n2:\n\t"
403                                 "ret $4\n\t"
404                                 ".previous\n\t"
405                                 ".code32\n\t" : :
406                                 "i" ( int13 ) );
407
408         hook_bios_interrupt ( 0x13, ( unsigned int ) int13_wrapper,
409                               &int13_vector );
410 }
411
412 /**
413  * Unhook INT 13 handler
414  */
415 static void unhook_int13 ( void ) {
416         unhook_bios_interrupt ( 0x13, ( unsigned int ) int13_wrapper,
417                                 &int13_vector );
418 }
419
420 /**
421  * Register INT 13 emulated drive
422  *
423  * @v drive             Emulated drive
424  *
425  * Registers the drive with the INT 13 emulation subsystem, and hooks
426  * the INT 13 interrupt vector (if not already hooked).
427  *
428  * The underlying block device must be valid.  A drive number and
429  * geometry will be assigned if left blank.
430  */
431 void register_int13_drive ( struct int13_drive *drive ) {
432         uint8_t num_drives;
433         unsigned long blocks;
434         unsigned long blocks_per_cyl;
435
436         /* Give drive a default geometry if none specified */
437         if ( ! drive->heads )
438                 drive->heads = 255;
439         if ( ! drive->sectors_per_track )
440                 drive->sectors_per_track = 63;
441         if ( ! drive->cylinders ) {
442                 /* Avoid attempting a 64-bit divide on a 32-bit system */
443                 blocks = ( ( drive->blockdev->blocks <= ULONG_MAX ) ?
444                            drive->blockdev->blocks : ULONG_MAX );
445                 blocks_per_cyl = ( drive->heads * drive->sectors_per_track );
446                 assert ( blocks_per_cyl != 0 );
447                 drive->cylinders = ( blocks / blocks_per_cyl );
448         }
449
450         /* Assign drive number if none specified, update BIOS drive count */
451         get_real ( num_drives, BDA_SEG, BDA_NUM_DRIVES );
452         if ( ! drive->drive )
453                 drive->drive = ( num_drives | 0x80 );
454         if ( num_drives <= ( drive->drive & 0x7f ) )
455                 num_drives = ( ( drive->drive & 0x7f ) + 1 );
456         put_real ( num_drives, BDA_SEG, BDA_NUM_DRIVES );
457
458         DBG ( "Registered INT13 drive %02x with C/H/S geometry %d/%d/%d\n",
459               drive->drive, drive->cylinders, drive->heads,
460               drive->sectors_per_track );
461
462         /* Hook INT 13 vector if not already hooked */
463         if ( list_empty ( &drives ) )
464                 hook_int13();
465
466         /* Add to list of emulated drives */
467         list_add ( &drive->list, &drives );
468 }
469
470 /**
471  * Unregister INT 13 emulated drive
472  *
473  * @v drive             Emulated drive
474  *
475  * Unregisters the drive from the INT 13 emulation subsystem.  If this
476  * is the last emulated drive, the INT 13 vector is unhooked (if
477  * possible).
478  */
479 void unregister_int13_drive ( struct int13_drive *drive ) {
480         /* Remove from list of emulated drives */
481         list_del ( &drive->list );
482
483         DBG ( "Unregistered INT13 drive %02x\n", drive->drive );
484
485         /* Unhook INT 13 vector if no more drives */
486         if ( list_empty ( &drives ) )
487                 unhook_int13();
488 }
489
490 /**
491  * Attempt to boot from an INT 13 drive
492  *
493  * @v drive             Drive number
494  * @ret rc              Return status code
495  *
496  * This boots from the specified INT 13 drive by loading the Master
497  * Boot Record to 0000:7c00 and jumping to it.  INT 18 is hooked to
498  * capture an attempt by the MBR to boot the next device.  (This is
499  * the closest thing to a return path from an MBR).
500  *
501  * Note that this function can never return success, by definition.
502  */
503 int int13_boot ( unsigned int drive ) {
504         int status, signature;
505         int d0, d1;
506
507         DBG ( "Booting from INT 13 drive %02x\n", drive );
508
509         /* Use INT 13 to read the boot sector */
510         REAL_EXEC ( rm_int13_boot,
511                     "pushw $0\n\t"
512                     "popw %%es\n\t"
513                     "int $0x13\n\t"
514                     "jc 1f\n\t"
515                     "xorl %%eax, %%eax\n\t"
516                     "\n1:\n\t"
517                     "movzwl %%es:0x7dfe, %%ebx\n\t",
518                     4,
519                     OUT_CONSTRAINTS ( "=a" ( status ), "=b" ( signature ),
520                                       "=c" ( d0 ), "=d" ( drive ) ),
521                     IN_CONSTRAINTS ( "0" ( 0x0201 ), "1" ( 0x7c00 ),
522                                      "2" ( 0x0001 ), "3" ( drive ) ),
523                     CLOBBER ( "ebp" ) );
524         if ( status )
525                 return -EIO;
526
527         /* Check signature is correct */
528         if ( signature != be16_to_cpu ( 0x55aa ) ) {
529                 DBG ( "Invalid disk signature %#04x (should be 0x55aa)\n",
530                       cpu_to_be16 ( signature ) );
531                 return -ENOEXEC;
532         }
533
534         /* Hook INT 18 to capture failure path */
535         hook_bios_interrupt ( 0x18, ( unsigned int ) int13_exec_fail,
536                               &int18_vector );
537
538         /* Boot the loaded sector */
539         REAL_EXEC ( rm_int13_exec,
540                     "movw %%ss, %%ax\n\t" /* Preserve stack pointer */
541                     "movw %%ax, %%cs:int13_exec_saved_ss\n\t"
542                     "movw %%sp, %%cs:int13_exec_saved_sp\n\t"
543                     "ljmp $0, $0x7c00\n\t"
544                     "\nint13_exec_saved_ss: .word 0\n\t"
545                     "\nint13_exec_saved_sp: .word 0\n\t"
546                     "\nint13_exec_fail:\n\t"
547                     "movw %%cs:int13_exec_saved_ss, %%ax\n\t"
548                     "movw %%ax, %%ss\n\t"
549                     "movw %%cs:int13_exec_saved_sp, %%sp\n\t"
550                     "\n99:\n\t",
551                     1,
552                     OUT_CONSTRAINTS ( "=d" ( d1 ) ),
553                     IN_CONSTRAINTS ( "d" ( drive ) ),
554                     CLOBBER ( "eax", "ebx", "ecx", "esi", "edi", "ebp" ) );
555
556         DBG ( "Booted disk returned via INT 18\n" );
557
558         /* Unhook INT 18 */
559         unhook_bios_interrupt ( 0x18, ( unsigned int ) int13_exec_fail,
560                                 &int18_vector );
561         
562         return -ECANCELED;
563 }