7e09fb5f90d31a148eee023596486862e2186025
[people/mcb30/gpxe.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 <gpxe/memmap.h>
27 #include <realmode.h>
28 #include <bios.h>
29 #include <biosint.h>
30 #include <bootsector.h>
31 #include <int13.h>
32
33 /** @file
34  *
35  * INT 13 emulation
36  *
37  * This module provides a mechanism for exporting block devices via
38  * the BIOS INT 13 disk interrupt interface.  
39  *
40  */
41
42 /** Vector for chaining to other INT 13 handlers */
43 static struct segoff __text16 ( int13_vector );
44 #define int13_vector __use_text16 ( int13_vector )
45
46 /** Assembly wrapper */
47 extern void int13_wrapper ( void );
48
49 /** List of registered emulated drives */
50 static LIST_HEAD ( drives );
51
52 /**
53  * INT 13, 00 - Reset disk system
54  *
55  * @v drive             Emulated drive
56  * @ret status          Status code
57  */
58 static int int13_reset ( struct int13_drive *drive __unused,
59                          struct i386_all_regs *ix86 __unused ) {
60         DBG ( "Reset drive\n" );
61         return 0;
62 }
63
64 /**
65  * INT 13, 01 - Get status of last operation
66  *
67  * @v drive             Emulated drive
68  * @ret status          Status code
69  */
70 static int int13_get_last_status ( struct int13_drive *drive,
71                                    struct i386_all_regs *ix86 __unused ) {
72         DBG ( "Get status of last operation\n" );
73         return drive->last_status;
74 }
75
76 /**
77  * Read / write sectors
78  *
79  * @v drive             Emulated drive
80  * @v al                Number of sectors to read or write (must be nonzero)
81  * @v ch                Low bits of cylinder number
82  * @v cl (bits 7:6)     High bits of cylinder number
83  * @v cl (bits 5:0)     Sector number
84  * @v dh                Head number
85  * @v es:bx             Data buffer
86  * @v io                Read / write method
87  * @ret status          Status code
88  * @ret al              Number of sectors read or written
89  */
90 static int int13_rw_sectors ( struct int13_drive *drive,
91                               struct i386_all_regs *ix86,
92                               int ( * io ) ( struct block_device *blockdev,
93                                              uint64_t block,
94                                              unsigned long count,
95                                              userptr_t buffer ) ) {
96         struct block_device *blockdev = drive->blockdev;
97         unsigned int cylinder, head, sector;
98         unsigned long lba;
99         unsigned int count;
100         userptr_t buffer;
101
102         /* Validate blocksize */
103         if ( blockdev->blksize != INT13_BLKSIZE ) {
104                 DBG ( "Invalid blocksize (%zd) for non-extended read/write\n",
105                       blockdev->blksize );
106                 return -INT13_STATUS_INVALID;
107         }
108         
109         /* Calculate parameters */
110         cylinder = ( ( ( ix86->regs.cl & 0xc0 ) << 2 ) | ix86->regs.ch );
111         assert ( cylinder < drive->cylinders );
112         head = ix86->regs.dh;
113         assert ( head < drive->heads );
114         sector = ( ix86->regs.cl & 0x3f );
115         assert ( ( sector >= 1 ) && ( sector <= drive->sectors_per_track ) );
116         lba = ( ( ( ( cylinder * drive->heads ) + head )
117                   * drive->sectors_per_track ) + sector - 1 );
118         count = ix86->regs.al;
119         buffer = real_to_user ( ix86->segs.es, ix86->regs.bx );
120
121         DBG ( "C/H/S %d/%d/%d = LBA %#lx <-> %04x:%04x (count %d)\n", cylinder,
122               head, sector, lba, ix86->segs.es, ix86->regs.bx, count );
123
124         /* Read from / write to block device */
125         if ( io ( blockdev, lba, count, buffer ) != 0 )
126                 return -INT13_STATUS_READ_ERROR;
127
128         return 0;
129 }
130
131 /**
132  * INT 13, 02 - Read sectors
133  *
134  * @v drive             Emulated drive
135  * @v al                Number of sectors to read (must be nonzero)
136  * @v ch                Low bits of cylinder number
137  * @v cl (bits 7:6)     High bits of cylinder number
138  * @v cl (bits 5:0)     Sector number
139  * @v dh                Head number
140  * @v es:bx             Data buffer
141  * @ret status          Status code
142  * @ret al              Number of sectors read
143  */
144 static int int13_read_sectors ( struct int13_drive *drive,
145                                 struct i386_all_regs *ix86 ) {
146         DBG ( "Read: " );
147         return int13_rw_sectors ( drive, ix86, drive->blockdev->read );
148 }
149
150 /**
151  * INT 13, 03 - Write sectors
152  *
153  * @v drive             Emulated drive
154  * @v al                Number of sectors to write (must be nonzero)
155  * @v ch                Low bits of cylinder number
156  * @v cl (bits 7:6)     High bits of cylinder number
157  * @v cl (bits 5:0)     Sector number
158  * @v dh                Head number
159  * @v es:bx             Data buffer
160  * @ret status          Status code
161  * @ret al              Number of sectors written
162  */
163 static int int13_write_sectors ( struct int13_drive *drive,
164                                  struct i386_all_regs *ix86 ) {
165         DBG ( "Write: " );
166         return int13_rw_sectors ( drive, ix86, drive->blockdev->write );
167 }
168
169 /**
170  * INT 13, 08 - Get drive parameters
171  *
172  * @v drive             Emulated drive
173  * @ret status          Status code
174  * @ret ch              Low bits of maximum cylinder number
175  * @ret cl (bits 7:6)   High bits of maximum cylinder number
176  * @ret cl (bits 5:0)   Maximum sector number
177  * @ret dh              Maximum head number
178  * @ret dl              Number of drives
179  */
180 static int int13_get_parameters ( struct int13_drive *drive,
181                                   struct i386_all_regs *ix86 ) {
182         unsigned int max_cylinder = drive->cylinders - 1;
183         unsigned int max_head = drive->heads - 1;
184         unsigned int max_sector = drive->sectors_per_track; /* sic */
185
186         DBG ( "Get drive parameters\n" );
187
188         ix86->regs.ch = ( max_cylinder & 0xff );
189         ix86->regs.cl = ( ( ( max_cylinder >> 8 ) << 6 ) | max_sector );
190         ix86->regs.dh = max_head;
191         get_real ( ix86->regs.dl, BDA_SEG, BDA_NUM_DRIVES );
192         return 0;
193 }
194
195 /**
196  * INT 13, 15 - Get disk type
197  *
198  * @v drive             Emulated drive
199  * @ret ah              Type code
200  * @ret cx:dx           Sector count
201  * @ret status          Status code / disk type
202  */
203 static int int13_get_disk_type ( struct int13_drive *drive,
204                                  struct i386_all_regs *ix86 ) {
205         DBG ( "Get disk type\n" );
206         ix86->regs.cx = ( drive->cylinders >> 16 );
207         ix86->regs.dx = ( drive->cylinders & 0xffff );
208         return INT13_DISK_TYPE_HDD;
209 }
210
211 /**
212  * INT 13, 41 - Extensions installation check
213  *
214  * @v drive             Emulated drive
215  * @v bx                0x55aa
216  * @ret bx              0xaa55
217  * @ret cx              Extensions API support bitmap
218  * @ret status          Status code / API version
219  */
220 static int int13_extension_check ( struct int13_drive *drive __unused,
221                                    struct i386_all_regs *ix86 ) {
222         if ( ix86->regs.bx == 0x55aa ) {
223                 DBG ( "INT 13 extensions installation check\n" );
224                 ix86->regs.bx = 0xaa55;
225                 ix86->regs.cx = INT13_EXTENSION_LINEAR;
226                 return INT13_EXTENSION_VER_1_X;
227         } else {
228                 return -INT13_STATUS_INVALID;
229         }
230 }
231
232 /**
233  * Extended read / write
234  *
235  * @v drive             Emulated drive
236  * @v ds:si             Disk address packet
237  * @v io                Read / write method
238  * @ret status          Status code
239  */
240 static int int13_extended_rw ( struct int13_drive *drive,
241                                struct i386_all_regs *ix86,
242                                int ( * io ) ( struct block_device *blockdev,
243                                               uint64_t block,
244                                               unsigned long count,
245                                               userptr_t buffer ) ) {
246         struct block_device *blockdev = drive->blockdev;
247         struct int13_disk_address addr;
248         uint64_t lba;
249         unsigned long count;
250         userptr_t buffer;
251
252         /* Read parameters from disk address structure */
253         copy_from_real ( &addr, ix86->segs.ds, ix86->regs.si, sizeof ( addr ));
254         lba = addr.lba;
255         count = addr.count;
256         buffer = real_to_user ( addr.buffer.segment, addr.buffer.offset );
257
258         DBG ( "LBA %#llx <-> %04x:%04x (count %ld)\n", (unsigned long long)lba,
259               addr.buffer.segment, addr.buffer.offset, count );
260         
261         /* Read from / write to block device */
262         if ( io ( blockdev, lba, count, buffer ) != 0 )
263                 return -INT13_STATUS_READ_ERROR;
264
265         return 0;
266 }
267
268 /**
269  * INT 13, 42 - Extended read
270  *
271  * @v drive             Emulated drive
272  * @v ds:si             Disk address packet
273  * @ret status          Status code
274  */
275 static int int13_extended_read ( struct int13_drive *drive,
276                                  struct i386_all_regs *ix86 ) {
277         DBG ( "Extended read: " );
278         return int13_extended_rw ( drive, ix86, drive->blockdev->read );
279 }
280
281 /**
282  * INT 13, 43 - Extended write
283  *
284  * @v drive             Emulated drive
285  * @v ds:si             Disk address packet
286  * @ret status          Status code
287  */
288 static int int13_extended_write ( struct int13_drive *drive,
289                                   struct i386_all_regs *ix86 ) {
290         DBG ( "Extended write: " );
291         return int13_extended_rw ( drive, ix86, drive->blockdev->write );
292 }
293
294 /**
295  * INT 13, 48 - Get extended parameters
296  *
297  * @v drive             Emulated drive
298  * @v ds:si             Drive parameter table
299  * @ret status          Status code
300  */
301 static int int13_get_extended_parameters ( struct int13_drive *drive,
302                                            struct i386_all_regs *ix86 ) {
303         struct int13_disk_parameters params = {
304                 .bufsize = sizeof ( params ),
305                 .flags = INT13_FL_DMA_TRANSPARENT,
306                 .cylinders = drive->cylinders,
307                 .heads = drive->heads,
308                 .sectors_per_track = drive->sectors_per_track,
309                 .sectors = drive->blockdev->blocks,
310                 .sector_size = drive->blockdev->blksize,
311         };
312         
313         DBG ( "Get extended drive parameters to %04x:%04x\n",
314               ix86->segs.ds, ix86->regs.si );
315
316         copy_to_real ( ix86->segs.ds, ix86->regs.si, &params,
317                        sizeof ( params ) );
318         return 0;
319 }
320
321 /**
322  * INT 13 handler
323  *
324  */
325 static __cdecl void int13 ( struct i386_all_regs *ix86 ) {
326         int command = ix86->regs.ah;
327         unsigned int bios_drive = ix86->regs.dl;
328         unsigned int original_bios_drive = bios_drive;
329         struct int13_drive *drive;
330         int status;
331
332         list_for_each_entry ( drive, &drives, list ) {
333                 if ( drive->drive > bios_drive )
334                         continue;
335                 if ( drive->drive < bios_drive ) {
336                         original_bios_drive--;
337                         continue;
338                 }
339                 
340                 DBG ( "INT 13,%04x (%02x): ", ix86->regs.ax, drive->drive );
341
342                 switch ( command ) {
343                 case INT13_RESET:
344                         status = int13_reset ( drive, ix86 );
345                         break;
346                 case INT13_GET_LAST_STATUS:
347                         status = int13_get_last_status ( drive, ix86 );
348                         break;
349                 case INT13_READ_SECTORS:
350                         status = int13_read_sectors ( drive, ix86 );
351                         break;
352                 case INT13_WRITE_SECTORS:
353                         status = int13_write_sectors ( drive, ix86 );
354                         break;
355                 case INT13_GET_PARAMETERS:
356                         status = int13_get_parameters ( drive, ix86 );
357                         break;
358                 case INT13_GET_DISK_TYPE:
359                         status = int13_get_disk_type ( drive, ix86 );
360                         break;
361                 case INT13_EXTENSION_CHECK:
362                         status = int13_extension_check ( drive, ix86 );
363                         break;
364                 case INT13_EXTENDED_READ:
365                         status = int13_extended_read ( drive, ix86 );
366                         break;
367                 case INT13_EXTENDED_WRITE:
368                         status = int13_extended_write ( drive, ix86 );
369                         break;
370                 case INT13_GET_EXTENDED_PARAMETERS:
371                         status = int13_get_extended_parameters ( drive, ix86 );
372                         break;
373                 default:
374                         DBG ( "*** Unrecognised INT 13 ***\n" );
375                         status = -INT13_STATUS_INVALID;
376                         break;
377                 }
378
379                 /* Store status for INT 13,01 */
380                 drive->last_status = status;
381
382                 /* Negative status indicates an error */
383                 if ( status < 0 ) {
384                         status = -status;
385                         DBG ( "INT13 failed with status %x\n", status );
386                 } else {
387                         ix86->flags &= ~CF;
388                 }
389                 ix86->regs.ah = status;
390
391                 /* Set OF to indicate to wrapper not to chain this call */
392                 ix86->flags |= OF;
393
394                 return;
395         }
396
397         /* Remap BIOS drive */
398         if ( bios_drive != original_bios_drive ) {
399                 DBG ( "INT 13,%04x (%02x) remapped to (%02x)\n",
400                       ix86->regs.ax, bios_drive, original_bios_drive );
401         }
402         ix86->regs.dl = original_bios_drive;
403 }
404
405 /**
406  * Hook INT 13 handler
407  *
408  */
409 static void hook_int13 ( void ) {
410         /* Assembly wrapper to call int13().  int13() sets OF if we
411          * should not chain to the previous handler.  (The wrapper
412          * clears CF and OF before calling int13()).
413          */
414         __asm__  __volatile__ (
415                TEXT16_CODE ( "\nint13_wrapper:\n\t"
416                              /* Preserve %ax and %dx for future reference */
417                              "pushw %%bp\n\t"
418                              "movw %%sp, %%bp\n\t"                           
419                              "pushw %%ax\n\t"
420                              "pushw %%dx\n\t"
421                              /* Clear OF, set CF, call int13() */
422                              "orb $0, %%al\n\t" 
423                              "stc\n\t"
424                              "pushl %0\n\t"
425                              "pushw %%cs\n\t"
426                              "call prot_call\n\t"
427                              /* Chain if OF not set */
428                              "jo 1f\n\t"
429                              "pushfw\n\t"
430                              "lcall *%%cs:int13_vector\n\t"
431                              "\n1:\n\t"
432                              /* Overwrite flags for iret */
433                              "pushfw\n\t"
434                              "popw 6(%%bp)\n\t"
435                              /* Fix up %dl:
436                               *
437                               * INT 13,15 : do nothing
438                               * INT 13,08 : load with number of drives
439                               * all others: restore original value
440                               */
441                              "cmpb $0x15, -1(%%bp)\n\t"
442                              "je 2f\n\t"
443                              "movb -4(%%bp), %%dl\n\t"
444                              "cmpb $0x08, -1(%%bp)\n\t"
445                              "jne 2f\n\t"
446                              "pushw %%ds\n\t"
447                              "pushw %1\n\t"
448                              "popw %%ds\n\t"
449                              "movb %c2, %%dl\n\t"
450                              "popw %%ds\n\t"
451                              /* Return */
452                              "\n2:\n\t"
453                              "movw %%bp, %%sp\n\t"
454                              "popw %%bp\n\t"
455                              "iret\n\t" )
456                : : "i" ( int13 ), "i" ( BDA_SEG ), "i" ( BDA_NUM_DRIVES ) );
457
458         hook_bios_interrupt ( 0x13, ( unsigned int ) int13_wrapper,
459                               &int13_vector );
460 }
461
462 /**
463  * Unhook INT 13 handler
464  */
465 static void unhook_int13 ( void ) {
466         unhook_bios_interrupt ( 0x13, ( unsigned int ) int13_wrapper,
467                                 &int13_vector );
468 }
469
470 /**
471  * Guess INT 13 drive geometry
472  *
473  * @v drive             Emulated drive
474  *
475  * Guesses the drive geometry by inspecting the partition table.
476  */
477 static void guess_int13_geometry ( struct int13_drive *drive ) {
478         struct master_boot_record mbr;
479         struct partition_table_entry *partition;
480         unsigned int guessed_heads = 255;
481         unsigned int guessed_sectors_per_track = 63;
482         unsigned long blocks;
483         unsigned long blocks_per_cyl;
484         unsigned int i;
485
486         /* Don't even try when the blksize is invalid for C/H/S access */
487         if ( drive->blockdev->blksize != INT13_BLKSIZE )
488                 return;
489
490         /* Scan through partition table and modify guesses for heads
491          * and sectors_per_track if we find any used partitions.
492          */
493         if ( drive->blockdev->read ( drive->blockdev, 0, 1,
494                                      virt_to_user ( &mbr ) ) == 0 ) {
495                 for ( i = 0 ; i < 4 ; i++ ) {
496                         partition = &mbr.partitions[i];
497                         if ( ! partition->type )
498                                 continue;
499                         guessed_heads =
500                                 ( PART_HEAD ( partition->chs_end ) + 1 );
501                         guessed_sectors_per_track = 
502                                 PART_SECTOR ( partition->chs_end );
503                         DBG ( "Guessing C/H/S xx/%d/%d based on partition "
504                               "%d\n", guessed_heads,
505                               guessed_sectors_per_track, ( i + 1 ) );
506                 }
507         } else {
508                 DBG ( "Could not read partition table to guess geometry\n" );
509         }
510
511         /* Apply guesses if no geometry already specified */
512         if ( ! drive->heads )
513                 drive->heads = guessed_heads;
514         if ( ! drive->sectors_per_track )
515                 drive->sectors_per_track = guessed_sectors_per_track;
516         if ( ! drive->cylinders ) {
517                 /* Avoid attempting a 64-bit divide on a 32-bit system */
518                 blocks = ( ( drive->blockdev->blocks <= ULONG_MAX ) ?
519                            drive->blockdev->blocks : ULONG_MAX );
520                 blocks_per_cyl = ( drive->heads * drive->sectors_per_track );
521                 assert ( blocks_per_cyl != 0 );
522                 drive->cylinders = ( blocks / blocks_per_cyl );
523                 if ( drive->cylinders > 1024 )
524                         drive->cylinders = 1024;
525         }
526 }
527
528 /**
529  * Register INT 13 emulated drive
530  *
531  * @v drive             Emulated drive
532  *
533  * Registers the drive with the INT 13 emulation subsystem, and hooks
534  * the INT 13 interrupt vector (if not already hooked).
535  *
536  * The underlying block device must be valid.  A drive number and
537  * geometry will be assigned if left blank.
538  */
539 void register_int13_drive ( struct int13_drive *drive ) {
540         uint8_t num_drives;
541
542         /* Give drive a default geometry if none specified */
543         guess_int13_geometry ( drive );
544
545         /* Assign drive number if none specified, update BIOS drive count */
546         get_real ( num_drives, BDA_SEG, BDA_NUM_DRIVES );
547         if ( ( drive->drive & 0xff ) == 0xff )
548                 drive->drive = num_drives;
549         drive->drive |= 0x80;
550         num_drives++;
551         if ( num_drives <= ( drive->drive & 0x7f ) )
552                 num_drives = ( ( drive->drive & 0x7f ) + 1 );
553         put_real ( num_drives, BDA_SEG, BDA_NUM_DRIVES );
554
555         DBG ( "Registered INT13 drive %02x with C/H/S geometry %d/%d/%d\n",
556               drive->drive, drive->cylinders, drive->heads,
557               drive->sectors_per_track );
558
559         /* Hook INT 13 vector if not already hooked */
560         if ( list_empty ( &drives ) )
561                 hook_int13();
562
563         /* Add to list of emulated drives */
564         list_add ( &drive->list, &drives );
565 }
566
567 /**
568  * Unregister INT 13 emulated drive
569  *
570  * @v drive             Emulated drive
571  *
572  * Unregisters the drive from the INT 13 emulation subsystem.  If this
573  * is the last emulated drive, the INT 13 vector is unhooked (if
574  * possible).
575  */
576 void unregister_int13_drive ( struct int13_drive *drive ) {
577         /* Remove from list of emulated drives */
578         list_del ( &drive->list );
579
580         /* Should adjust BIOS drive count, but it's difficult to do so
581          * reliably.
582          */
583
584         DBG ( "Unregistered INT13 drive %02x\n", drive->drive );
585
586         /* Unhook INT 13 vector if no more drives */
587         if ( list_empty ( &drives ) )
588                 unhook_int13();
589 }
590
591 /**
592  * Attempt to boot from an INT 13 drive
593  *
594  * @v drive             Drive number
595  * @ret rc              Return status code
596  *
597  * This boots from the specified INT 13 drive by loading the Master
598  * Boot Record to 0000:7c00 and jumping to it.  INT 18 is hooked to
599  * capture an attempt by the MBR to boot the next device.  (This is
600  * the closest thing to a return path from an MBR).
601  *
602  * Note that this function can never return success, by definition.
603  */
604 int int13_boot ( unsigned int drive ) {
605         struct memory_map memmap;
606         int status, signature;
607         int discard_c, discard_d;
608         int rc;
609
610         DBG ( "Booting from INT 13 drive %02x\n", drive );
611
612         /* Use INT 13 to read the boot sector */
613         __asm__ __volatile__ ( REAL_CODE ( "pushw %%es\n\t"
614                                            "pushw $0\n\t"
615                                            "popw %%es\n\t"
616                                            "stc\n\t"
617                                            "sti\n\t"
618                                            "int $0x13\n\t"
619                                            "sti\n\t" /* BIOS bugs */
620                                            "jc 1f\n\t"
621                                            "xorl %%eax, %%eax\n\t"
622                                            "\n1:\n\t"
623                                            "movzwl %%es:0x7dfe, %%ebx\n\t"
624                                            "popw %%es\n\t" )
625                                : "=a" ( status ), "=b" ( signature ),
626                                  "=c" ( discard_c ), "=d" ( discard_d )
627                                : "a" ( 0x0201 ), "b" ( 0x7c00 ),
628                                  "c" ( 1 ), "d" ( drive ) );
629         if ( status )
630                 return -EIO;
631
632         /* Check signature is correct */
633         if ( signature != be16_to_cpu ( 0x55aa ) ) {
634                 DBG ( "Invalid disk signature %#04x (should be 0x55aa)\n",
635                       cpu_to_be16 ( signature ) );
636                 return -ENOEXEC;
637         }
638
639         /* Dump out memory map prior to boot, if memmap debugging is
640          * enabled.  Not required for program flow, but we have so
641          * many problems that turn out to be memory-map related that
642          * it's worth doing.
643          */
644         get_memmap ( &memmap );
645
646         /* Jump to boot sector */
647         if ( ( rc = call_bootsector ( 0x0, 0x7c00, drive ) ) != 0 ) {
648                 DBG ( "INT 13 drive %02x boot returned\n", drive );
649                 return rc;
650         }
651
652         return -ECANCELED; /* -EIMPOSSIBLE */
653 }