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