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