Set CF by default, clear on success (rather than clearing and setting
[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 <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 struct int13_cdrom_specification {
321         /** Size of packet in bytes */
322         uint8_t size;
323         /** Boot media type */
324         uint8_t media_type;
325         /** Drive number */
326         uint8_t drive;
327 };
328
329 /**
330  * INT 13, 4b - Get CD-ROM status / terminate emulation
331  *
332  * @v drive             Emulated drive
333  * @v ds:si             El Torito specification packet to fill in
334  * @ret status          Status code
335  */
336 static int int13_cdrom_status_terminate ( struct int13_drive *drive,
337                                           struct i386_all_regs *ix86 ) {
338         struct int13_cdrom_specification specification;
339
340         DBG ( "Get CD-ROM emulation parameters to %04x:%04x\n",
341               ix86->segs.ds, ix86->regs.di );
342
343         memset ( &specification, 0, sizeof ( specification ) );
344         specification.size = sizeof ( specification );
345         specification.drive = drive->drive;
346
347         copy_to_real ( ix86->segs.ds, ix86->regs.si, &specification,
348                        sizeof ( specification ) );
349         return 0;
350 }
351
352 /**
353  * INT 13 handler
354  *
355  */
356 static void int13 ( struct i386_all_regs *ix86 ) {
357         int command = ix86->regs.ah;
358         struct int13_drive *drive;
359         int status;
360
361         list_for_each_entry ( drive, &drives, list ) {
362                 if ( drive->drive != ix86->regs.dl )
363                         continue;
364                 
365                 DBG ( "INT 13,%04x (%02x): ", ix86->regs.ax, drive->drive );
366
367                 switch ( command ) {
368                 case INT13_RESET:
369                         status = int13_reset ( drive, ix86 );
370                         break;
371                 case INT13_GET_LAST_STATUS:
372                         status = int13_get_last_status ( drive, ix86 );
373                         break;
374                 case INT13_READ_SECTORS:
375                         status = int13_read_sectors ( drive, ix86 );
376                         break;
377                 case INT13_WRITE_SECTORS:
378                         status = int13_write_sectors ( drive, ix86 );
379                         break;
380                 case INT13_GET_PARAMETERS:
381                         status = int13_get_parameters ( drive, ix86 );
382                         break;
383                 case INT13_GET_DISK_TYPE:
384                         status = int13_get_disk_type ( drive, ix86 );
385                         break;
386                 case INT13_EXTENSION_CHECK:
387                         status = int13_extension_check ( drive, ix86 );
388                         break;
389                 case INT13_EXTENDED_READ:
390                         status = int13_extended_read ( drive, ix86 );
391                         break;
392                 case INT13_EXTENDED_WRITE:
393                         status = int13_extended_write ( drive, ix86 );
394                         break;
395                 case INT13_GET_EXTENDED_PARAMETERS:
396                         status = int13_get_extended_parameters ( drive, ix86 );
397                         break;
398                 case INT13_CDROM_STATUS_TERMINATE:
399                         status = int13_cdrom_status_terminate ( drive, ix86 );
400                         break;
401                 default:
402                         DBG ( "*** Unrecognised INT 13 ***\n" );
403                         status = -INT13_STATUS_INVALID;
404                         break;
405                 }
406
407                 /* Store status for INT 13,01 */
408                 drive->last_status = status;
409
410                 /* Negative status indicates an error */
411                 if ( status < 0 ) {
412                         status = -status;
413                         DBG ( "INT13 failed with status %x\n", status );
414                 } else {
415                         ix86->flags &= ~CF;
416                 }
417                 ix86->regs.ah = status;
418
419                 /* Set OF to indicate to wrapper not to chain this call */
420                 ix86->flags |= OF;
421
422                 break;
423         }
424 }
425
426 /**
427  * Hook INT 13 handler
428  *
429  */
430 static void hook_int13 ( void ) {
431         /* Assembly wrapper to call int13().  int13() sets OF if we
432          * should not chain to the previous handler.  (The wrapper
433          * clears CF and OF before calling int13()).
434          */
435         __asm__  __volatile__ (
436                TEXT16_CODE ( "\nint13_wrapper:\n\t"
437                              "orb $0, %%al\n\t" /* clear OF */
438                              "stc\n\t"
439                              "pushl %0\n\t" /* call int13() */
440                              "pushw %%cs\n\t"
441                              "call prot_call\n\t"
442                              "jo 1f\n\t" /* chain if OF not set */
443                              "pushfw\n\t"
444                              "lcall *%%cs:int13_vector\n\t"
445                              "\n1:\n\t"
446                              "call 2f\n\t" /* return with flags intact */
447                              "lret $2\n\t"
448                              "\n2:\n\t"
449                              "ret $4\n\t" ) : : "i" ( int13 ) );
450
451         hook_bios_interrupt ( 0x13, ( unsigned int ) int13_wrapper,
452                               &int13_vector );
453 }
454
455 /**
456  * Unhook INT 13 handler
457  */
458 static void unhook_int13 ( void ) {
459         unhook_bios_interrupt ( 0x13, ( unsigned int ) int13_wrapper,
460                                 &int13_vector );
461 }
462
463 /**
464  * Guess INT 13 drive geometry
465  *
466  * @v drive             Emulated drive
467  *
468  * Guesses the drive geometry by inspecting the partition table.
469  */
470 static void guess_int13_geometry ( struct int13_drive *drive ) {
471         struct master_boot_record mbr;
472         struct partition_table_entry *partition;
473         unsigned int guessed_heads = 255;
474         unsigned int guessed_sectors_per_track = 63;
475         unsigned long blocks;
476         unsigned long blocks_per_cyl;
477         unsigned int i;
478
479         /* Don't even try when the blksize is invalid for C/H/S access */
480         if ( drive->blockdev->blksize != INT13_BLKSIZE )
481                 return;
482
483         /* Scan through partition table and modify guesses for heads
484          * and sectors_per_track if we find any used partitions.
485          */
486         if ( drive->blockdev->read ( drive->blockdev, 0, 1,
487                                      virt_to_user ( &mbr ) ) == 0 ) {
488                 for ( i = 0 ; i < 4 ; i++ ) {
489                         partition = &mbr.partitions[i];
490                         if ( ! partition->type )
491                                 continue;
492                         guessed_heads =
493                                 ( PART_HEAD ( partition->chs_end ) + 1 );
494                         guessed_sectors_per_track = 
495                                 PART_SECTOR ( partition->chs_end );
496                         DBG ( "Guessing C/H/S xx/%d/%d based on partition "
497                               "%d\n", guessed_heads,
498                               guessed_sectors_per_track, ( i + 1 ) );
499                 }
500         } else {
501                 DBG ( "Could not read partition table to guess geometry\n" );
502         }
503
504         /* Apply guesses if no geometry already specified */
505         if ( ! drive->heads )
506                 drive->heads = guessed_heads;
507         if ( ! drive->sectors_per_track )
508                 drive->sectors_per_track = guessed_sectors_per_track;
509         if ( ! drive->cylinders ) {
510                 /* Avoid attempting a 64-bit divide on a 32-bit system */
511                 blocks = ( ( drive->blockdev->blocks <= ULONG_MAX ) ?
512                            drive->blockdev->blocks : ULONG_MAX );
513                 blocks_per_cyl = ( drive->heads * drive->sectors_per_track );
514                 assert ( blocks_per_cyl != 0 );
515                 drive->cylinders = ( blocks / blocks_per_cyl );
516                 if ( drive->cylinders > 1024 )
517                         drive->cylinders = 1024;
518         }
519 }
520
521 /**
522  * Register INT 13 emulated drive
523  *
524  * @v drive             Emulated drive
525  *
526  * Registers the drive with the INT 13 emulation subsystem, and hooks
527  * the INT 13 interrupt vector (if not already hooked).
528  *
529  * The underlying block device must be valid.  A drive number and
530  * geometry will be assigned if left blank.
531  */
532 void register_int13_drive ( struct int13_drive *drive ) {
533         uint8_t num_drives;
534
535         /* Give drive a default geometry if none specified */
536         guess_int13_geometry ( drive );
537
538         /* Assign drive number if none specified, update BIOS drive count */
539         get_real ( num_drives, BDA_SEG, BDA_NUM_DRIVES );
540         if ( ! drive->drive )
541                 drive->drive = ( num_drives | 0x80 );
542         if ( num_drives <= ( drive->drive & 0x7f ) )
543                 num_drives = ( ( drive->drive & 0x7f ) + 1 );
544         put_real ( num_drives, BDA_SEG, BDA_NUM_DRIVES );
545
546         DBG ( "Registered INT13 drive %02x with C/H/S geometry %d/%d/%d\n",
547               drive->drive, drive->cylinders, drive->heads,
548               drive->sectors_per_track );
549
550         /* Hook INT 13 vector if not already hooked */
551         if ( list_empty ( &drives ) )
552                 hook_int13();
553
554         /* Add to list of emulated drives */
555         list_add ( &drive->list, &drives );
556 }
557
558 /**
559  * Unregister INT 13 emulated drive
560  *
561  * @v drive             Emulated drive
562  *
563  * Unregisters the drive from the INT 13 emulation subsystem.  If this
564  * is the last emulated drive, the INT 13 vector is unhooked (if
565  * possible).
566  */
567 void unregister_int13_drive ( struct int13_drive *drive ) {
568         /* Remove from list of emulated drives */
569         list_del ( &drive->list );
570
571         DBG ( "Unregistered INT13 drive %02x\n", drive->drive );
572
573         /* Unhook INT 13 vector if no more drives */
574         if ( list_empty ( &drives ) )
575                 unhook_int13();
576 }
577
578 /**
579  * Attempt to boot from an INT 13 drive
580  *
581  * @v drive             Drive number
582  * @ret rc              Return status code
583  *
584  * This boots from the specified INT 13 drive by loading the Master
585  * Boot Record to 0000:7c00 and jumping to it.  INT 18 is hooked to
586  * capture an attempt by the MBR to boot the next device.  (This is
587  * the closest thing to a return path from an MBR).
588  *
589  * Note that this function can never return success, by definition.
590  */
591 int int13_boot ( unsigned int drive ) {
592         int status, signature;
593         int discard_c, discard_d;
594         int rc;
595
596         DBG ( "Booting from INT 13 drive %02x\n", drive );
597
598         /* Use INT 13 to read the boot sector */
599         __asm__ __volatile__ ( REAL_CODE ( "pushw %%es\n\t"
600                                            "pushw $0\n\t"
601                                            "popw %%es\n\t"
602                                            "stc\n\t"
603                                            "int $0x13\n\t"
604                                            "sti\n\t" /* BIOS bugs */
605                                            "jc 1f\n\t"
606                                            "xorl %%eax, %%eax\n\t"
607                                            "\n1:\n\t"
608                                            "movzwl %%es:0x7dfe, %%ebx\n\t"
609                                            "popw %%es\n\t" )
610                                : "=a" ( status ), "=b" ( signature ),
611                                  "=c" ( discard_c ), "=d" ( discard_d )
612                                : "a" ( 0x0201 ), "b" ( 0x7c00 ),
613                                  "c" ( 1 ), "d" ( drive ) );
614         if ( status )
615                 return -EIO;
616
617         /* Check signature is correct */
618         if ( signature != be16_to_cpu ( 0x55aa ) ) {
619                 DBG ( "Invalid disk signature %#04x (should be 0x55aa)\n",
620                       cpu_to_be16 ( signature ) );
621                 return -ENOEXEC;
622         }
623
624         /* Jump to boot sector */
625         if ( ( rc = call_bootsector ( 0x0, 0x7c00, drive ) ) != 0 ) {
626                 DBG ( "INT 13 drive %02x boot returned\n", drive );
627                 return rc;
628         }
629
630         return -ECANCELED; /* -EIMPOSSIBLE */
631 }