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