Fix a couple of minor typos.
[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  * Convert CHS address to linear address
69  *
70  * @v drive             Emulated drive
71  * @v ch                Low bits of cylinder number
72  * @v cl (bits 7:6)     High bits of cylinder number
73  * @v cl (bits 5:0)     Sector number
74  * @v dh                Head number
75  * @ret lba             LBA address
76  * 
77  */
78 static unsigned long chs_to_lba ( struct int13_drive *drive,
79                                   struct i386_all_regs *ix86 ) {
80         unsigned int cylinder;
81         unsigned int head;
82         unsigned int sector;
83         unsigned long lba;
84
85         cylinder = ( ( ( ix86->regs.cl & 0xc0 ) << 8 ) | ix86->regs.ch );
86         head = ix86->regs.dh;
87         sector = ( ix86->regs.cl & 0x3f );
88
89         assert ( cylinder < drive->cylinders );
90         assert ( head < drive->heads );
91         assert ( ( sector >= 1 ) && ( sector <= drive->sectors_per_track ) );
92
93         lba = ( ( ( ( cylinder * drive->heads ) + head )
94                   * drive->sectors_per_track ) + sector - 1 );
95
96         DBG ( "C/H/S address %x/%x/%x -> LBA %x\n",
97               cylinder, head, sector, lba );
98
99         return lba;
100 }
101
102 /**
103  * Read from drive to real-mode data buffer
104  *
105  * @v drive             Emulated drive
106  * @v lba               LBA starting sector number
107  * @v data              Data buffer
108  * @v count             Number of sectors to read
109  * @ret status          Status code
110  */
111 static int int13_read ( struct int13_drive *drive, uint64_t lba,
112                         struct segoff data, unsigned long count ) {
113         struct block_device *blockdev = drive->blockdev;
114         size_t blksize = blockdev->blksize;
115         uint8_t buffer[blksize];
116         int rc;
117
118         DBG ( "Read %lx sectors from %llx to %04x:%04x\n", count,
119               ( unsigned long long ) lba, data.segment, data.offset );
120         while ( count-- ) {
121                 if ( ( rc = blockdev->read ( blockdev, lba, buffer ) ) != 0 )
122                         return INT13_STATUS_READ_ERROR;
123                 copy_to_real ( data.segment, data.offset, buffer, blksize );
124                 data.offset += blksize;
125                 lba++;
126         }
127         return 0;
128 }
129
130 /**
131  * Write from real-mode data buffer to drive
132  *
133  * @v drive             Emulated drive
134  * @v lba               LBA starting sector number
135  * @v data              Data buffer
136  * @v count             Number of sectors to read
137  * @ret status          Status code
138  */
139 static int int13_write ( struct int13_drive *drive, uint64_t lba,
140                          struct segoff data, unsigned long count ) {
141         struct block_device *blockdev = drive->blockdev;
142         size_t blksize = blockdev->blksize;
143         uint8_t buffer[blksize];
144         int rc;
145
146         DBG ( "Write %lx sectors from %04x:%04x to %llx\n", count,
147               data.segment, data.offset, ( unsigned long long ) lba );
148         while ( count-- ) {
149                 copy_from_real ( buffer, data.segment, data.offset, blksize );
150                 if ( ( rc = blockdev->write ( blockdev, lba, buffer ) ) != 0 )
151                         return INT13_STATUS_WRITE_ERROR;
152                 data.offset += blksize;
153                 lba++;
154         }
155         return 0;
156 }
157
158 /**
159  * INT 13, 00 - Reset disk system
160  *
161  * @v drive             Emulated drive
162  * @ret status          Status code
163  */
164 static int int13_reset ( struct int13_drive *drive __unused,
165                          struct i386_all_regs *ix86 __unused ) {
166         DBG ( "Reset drive\n" );
167         return 0;
168 }
169
170 /**
171  * INT 13, 01 - Get status of last operation
172  *
173  * @v drive             Emulated drive
174  * @ret status          Status code
175  */
176 static int int13_get_last_status ( struct int13_drive *drive,
177                                    struct i386_all_regs *ix86 __unused ) {
178         DBG ( "Get status of last operation\n" );
179         return drive->last_status;
180 }
181
182 /**
183  * INT 13, 02 - Read sectors
184  *
185  * @v drive             Emulated drive
186  * @v al                Number of sectors to read (must be nonzero)
187  * @v ch                Low bits of cylinder number
188  * @v cl (bits 7:6)     High bits of cylinder number
189  * @v cl (bits 5:0)     Sector number
190  * @v dh                Head number
191  * @v es:bx             Data buffer
192  * @ret status          Status code
193  * @ret al              Number of sectors read
194  */
195 static int int13_read_sectors ( struct int13_drive *drive,
196                                 struct i386_all_regs *ix86 ) {
197         unsigned long lba = chs_to_lba ( drive, ix86 );
198         unsigned int count = ix86->regs.al;
199         struct segoff data = {
200                 .segment = ix86->segs.es,
201                 .offset = ix86->regs.bx,
202         };
203
204         if ( drive->blockdev->blksize != INT13_BLKSIZE ) {
205                 DBG ( "Invalid blocksize (%d) for non-extended read\n",
206                       drive->blockdev->blksize );
207                 return INT13_STATUS_INVALID;
208         }
209
210         return int13_read ( drive, lba, data, count );
211 }
212
213 /**
214  * INT 13, 03 - Write sectors
215  *
216  * @v drive             Emulated drive
217  * @v al                Number of sectors to write (must be nonzero)
218  * @v ch                Low bits of cylinder number
219  * @v cl (bits 7:6)     High bits of cylinder number
220  * @v cl (bits 5:0)     Sector number
221  * @v dh                Head number
222  * @v es:bx             Data buffer
223  * @ret status          Status code
224  * @ret al              Number of sectors written
225  */
226 static int int13_write_sectors ( struct int13_drive *drive,
227                                  struct i386_all_regs *ix86 ) {
228         unsigned long lba = chs_to_lba ( drive, ix86 );
229         unsigned int count = ix86->regs.al;
230         struct segoff data = {
231                 .segment = ix86->segs.es,
232                 .offset = ix86->regs.bx,
233         };
234
235         if ( drive->blockdev->blksize != INT13_BLKSIZE ) {
236                 DBG ( "Invalid blocksize (%d) for non-extended write\n",
237                       drive->blockdev->blksize );
238                 return INT13_STATUS_INVALID;
239         }
240
241         return int13_write ( drive, lba, data, count );
242 }
243
244 /**
245  * INT 13, 08 - Get drive parameters
246  *
247  * @v drive             Emulated drive
248  * @ret status          Status code
249  * @ret ch              Low bits of maximum cylinder number
250  * @ret cl (bits 7:6)   High bits of maximum cylinder number
251  * @ret cl (bits 5:0)   Maximum sector number
252  * @ret dh              Maximum head number
253  * @ret dl              Number of drives
254  */
255 static int int13_get_parameters ( struct int13_drive *drive,
256                                   struct i386_all_regs *ix86 ) {
257         unsigned int max_cylinder = drive->cylinders - 1;
258         unsigned int max_head = drive->heads - 1;
259         unsigned int max_sector = drive->sectors_per_track; /* sic */
260
261         DBG ( "Get drive parameters\n" );
262
263         ix86->regs.ch = ( max_cylinder & 0xff );
264         ix86->regs.cl = ( ( ( max_cylinder >> 8 ) << 6 ) | max_sector );
265         ix86->regs.dh = max_head;
266         get_real ( ix86->regs.dl, BDA_SEG, BDA_NUM_DRIVES );
267         return 0;
268 }
269
270 /**
271  * INT 13, 42 - Extended read
272  *
273  * @v drive             Emulated drive
274  * @v ds:si             Disk address packet
275  * @ret status          Status code
276  */
277 static int int13_extended_read ( struct int13_drive *drive,
278                                  struct i386_all_regs *ix86 ) {
279         struct int13_disk_address addr;
280
281         copy_from_real ( &addr, ix86->segs.ds, ix86->regs.si,
282                          sizeof ( addr ) );
283         return int13_read ( drive, addr.lba, addr.buffer, addr.count );
284 }
285
286 /**
287  * INT 13, 43 - Extended write
288  *
289  * @v drive             Emulated drive
290  * @v ds:si             Disk address packet
291  * @ret status          Status code
292  */
293 static int int13_extended_write ( struct int13_drive *drive,
294                                   struct i386_all_regs *ix86 ) {
295         struct int13_disk_address addr;
296
297         copy_from_real ( &addr, ix86->segs.ds, ix86->regs.si,
298                          sizeof ( addr ) );
299         return int13_write ( drive, addr.lba, addr.buffer, addr.count );
300 }
301
302 /**
303  * INT 13, 48 - Get extended parameters
304  *
305  * @v drive             Emulated drive
306  * @v ds:si             Drive parameter table
307  * @ret status          Status code
308  */
309 static int int13_get_extended_parameters ( struct int13_drive *drive,
310                                            struct i386_all_regs *ix86 ) {
311         struct int13_disk_parameters params = {
312                 .bufsize = sizeof ( params ),
313                 .flags = INT13_FL_DMA_TRANSPARENT,
314                 .cylinders = drive->cylinders,
315                 .heads = drive->heads,
316                 .sectors_per_track = drive->sectors_per_track,
317                 .sectors = drive->blockdev->blocks,
318                 .sector_size = drive->blockdev->blksize,
319         };
320         
321         DBG ( "Get extended drive parameters to %04x:%04x\n",
322               ix86->segs.ds, ix86->regs.si );
323
324         copy_to_real ( ix86->segs.ds, ix86->regs.si, &params,
325                        sizeof ( params ) );
326         return 0;
327 }
328
329 /**
330  * INT 13 handler
331  *
332  */
333 static void int13 ( struct i386_all_regs *ix86 ) {
334         struct int13_drive *drive;
335         int status;
336
337         list_for_each_entry ( drive, &drives, list ) {
338                 if ( drive->drive != ix86->regs.dl )
339                         continue;
340                 
341                 DBG ( "INT 13, %02x on drive %02x\n", ix86->regs.ah,
342                       ix86->regs.dl );
343         
344                 switch ( ix86->regs.ah ) {
345                 case INT13_RESET:
346                         status = int13_reset ( drive, ix86 );
347                         break;
348                 case INT13_GET_LAST_STATUS:
349                         status = int13_get_last_status ( drive, ix86 );
350                         break;
351                 case INT13_READ_SECTORS:
352                         status = int13_read_sectors ( drive, ix86 );
353                         break;
354                 case INT13_WRITE_SECTORS:
355                         status = int13_write_sectors ( drive, ix86 );
356                         break;
357                 case INT13_GET_PARAMETERS:
358                         status = int13_get_parameters ( drive, ix86 );
359                         break;
360                 case INT13_EXTENDED_READ:
361                         status = int13_extended_read ( drive, ix86 );
362                         break;
363                 case INT13_EXTENDED_WRITE:
364                         status = int13_extended_write ( drive, ix86 );
365                         break;
366                 case INT13_GET_EXTENDED_PARAMETERS:
367                         status = int13_get_extended_parameters ( drive, ix86 );
368                         break;
369                 default:
370                         DBG ( "Unrecognised INT 13\n" );
371                         status = INT13_STATUS_INVALID;
372                         break;
373                 }
374
375                 /* Store status for INT 13,01 */
376                 drive->last_status = status;
377                 /* All functions return status via %ah and CF */
378                 ix86->regs.ah = status;
379                 if ( status ) {
380                         ix86->flags |= CF;
381                         DBG ( "INT13 failed with status %x\n", status );
382                 }
383                 /* Set OF to indicate to wrapper not to chain this call */
384                 ix86->flags |= OF;
385         }
386 }
387
388 /**
389  * Hook INT 13 handler
390  *
391  */
392 static void hook_int13 ( void ) {
393         /* Assembly wrapper to call int13().  int13() sets OF if we
394          * should not chain to the previous handler.  (The wrapper
395          * clears CF and OF before calling int13()).
396          */
397         __asm__  __volatile__ ( ".section \".text16\", \"ax\", @progbits\n\t"
398                                 ".code16\n\t"
399                                 "\nint13_wrapper:\n\t"
400                                 "orb $0, %%al\n\t" /* clear CF and OF */
401                                 "pushl %0\n\t" /* call int13() */
402                                 "data32 call prot_call\n\t"
403                                 "jo 1f\n\t" /* chain if OF not set */
404                                 "pushfw\n\t"
405                                 "lcall *%%cs:int13_vector\n\t"
406                                 "\n1:\n\t"
407                                 "call 2f\n\t" /* return with flags intact */
408                                 "lret $2\n\t"
409                                 "\n2:\n\t"
410                                 "ret $4\n\t"
411                                 ".previous\n\t"
412                                 ".code32\n\t" : :
413                                 "i" ( int13 ) );
414
415         hook_bios_interrupt ( 0x13, ( unsigned int ) int13_wrapper,
416                               &int13_vector );
417 }
418
419 /**
420  * Unhook INT 13 handler
421  */
422 static void unhook_int13 ( void ) {
423         unhook_bios_interrupt ( 0x13, ( unsigned int ) int13_wrapper,
424                                 &int13_vector );
425 }
426
427 /**
428  * Register INT 13 emulated drive
429  *
430  * @v drive             Emulated drive
431  *
432  * Registers the drive with the INT 13 emulation subsystem, and hooks
433  * the INT 13 interrupt vector (if not already hooked).
434  *
435  * The underlying block device must be valid.  A drive number and
436  * geometry will be assigned if left blank.
437  */
438 void register_int13_drive ( struct int13_drive *drive ) {
439         uint8_t num_drives;
440         unsigned long blocks;
441         unsigned long blocks_per_cyl;
442
443         /* Give drive a default geometry if none specified */
444         if ( ! drive->heads )
445                 drive->heads = 255;
446         if ( ! drive->sectors_per_track )
447                 drive->sectors_per_track = 63;
448         if ( ! drive->cylinders ) {
449                 /* Avoid attempting a 64-bit divide on a 32-bit system */
450                 blocks = ( ( drive->blockdev->blocks <= ULONG_MAX ) ?
451                            drive->blockdev->blocks : ULONG_MAX );
452                 blocks_per_cyl = ( drive->heads * drive->sectors_per_track );
453                 assert ( blocks_per_cyl != 0 );
454                 drive->cylinders = ( blocks / blocks_per_cyl );
455         }
456
457         /* Assign drive number if none specified, update BIOS drive count */
458         get_real ( num_drives, BDA_SEG, BDA_NUM_DRIVES );
459         if ( ! drive->drive )
460                 drive->drive = ( num_drives | 0x80 );
461         if ( num_drives <= ( drive->drive & 0x7f ) )
462                 num_drives = ( ( drive->drive & 0x7f ) + 1 );
463         put_real ( num_drives, BDA_SEG, BDA_NUM_DRIVES );
464
465         DBG ( "Registered INT13 drive %02x with C/H/S geometry %d/%d/%d\n",
466               drive->drive, drive->cylinders, drive->heads,
467               drive->sectors_per_track );
468
469         /* Hook INT 13 vector if not already hooked */
470         if ( list_empty ( &drives ) )
471                 hook_int13();
472
473         /* Add to list of emulated drives */
474         list_add ( &drive->list, &drives );
475 }
476
477 /**
478  * Unregister INT 13 emulated drive
479  *
480  * @v drive             Emulated drive
481  *
482  * Unregisters the drive from the INT 13 emulation subsystem.  If this
483  * is the last emulated drive, the INT 13 vector is unhooked (if
484  * possible).
485  */
486 void unregister_int13_drive ( struct int13_drive *drive ) {
487         /* Remove from list of emulated drives */
488         list_del ( &drive->list );
489
490         DBG ( "Unregistered INT13 drive %02x\n", drive->drive );
491
492         /* Unhook INT 13 vector if no more drives */
493         if ( list_empty ( &drives ) )
494                 unhook_int13();
495 }
496
497 /**
498  * Attempt to boot from an INT 13 drive
499  *
500  * @v drive             Drive number
501  * @ret rc              Return status code
502  *
503  * This boots from the specified INT 13 drive by loading the Master
504  * Boot Record to 0000:7c00 and jumping to it.  INT 18 is hooked to
505  * capture an attempt by the MBR to boot the next device.  (This is
506  * the closest thing to a return path from an MBR).
507  *
508  * Note that this function can never return success, by definition.
509  */
510 int int13_boot ( unsigned int drive ) {
511         int status, signature;
512         int d0, d1;
513
514         DBG ( "Booting from INT 13 drive %02x\n", drive );
515
516         /* Use INT 13 to read the boot sector */
517         REAL_EXEC ( rm_int13_boot,
518                     "pushw $0\n\t"
519                     "popw %%es\n\t"
520                     "int $0x13\n\t"
521                     "jc 1f\n\t"
522                     "xorl %%eax, %%eax\n\t"
523                     "\n1:\n\t"
524                     "movzwl %%es:0x7dfe, %%ebx\n\t",
525                     4,
526                     OUT_CONSTRAINTS ( "=a" ( status ), "=b" ( signature ),
527                                       "=c" ( d0 ), "=d" ( drive ) ),
528                     IN_CONSTRAINTS ( "0" ( 0x0201 ), "1" ( 0x7c00 ),
529                                      "2" ( 0x0001 ), "3" ( drive ) ),
530                     CLOBBER ( "ebp" ) );
531         if ( status )
532                 return -EIO;
533
534         /* Check signature is correct */
535         if ( signature != be16_to_cpu ( 0x55aa ) ) {
536                 DBG ( "Invalid disk signature %#04x (should be 0x55aa)\n",
537                       cpu_to_be16 ( signature ) );
538                 return -ENOEXEC;
539         }
540
541         /* Hook INTs 18 and 19 to capture failure paths */
542         hook_bios_interrupt ( 0x18, ( unsigned int ) int13_exec_fail,
543                               &int18_vector );
544         hook_bios_interrupt ( 0x19, ( unsigned int ) int13_exec_fail,
545                               &int19_vector );
546
547         /* Boot the loaded sector */
548         REAL_EXEC ( rm_int13_exec,
549                     "movw %%ss, %%ax\n\t" /* Preserve stack pointer */
550                     "movw %%ax, %%cs:int13_exec_saved_ss\n\t"
551                     "movw %%sp, %%cs:int13_exec_saved_sp\n\t"
552                     "ljmp $0, $0x7c00\n\t"
553                     "\nint13_exec_saved_ss: .word 0\n\t"
554                     "\nint13_exec_saved_sp: .word 0\n\t"
555                     "\nint13_exec_fail:\n\t"
556                     "movw %%cs:int13_exec_saved_ss, %%ax\n\t"
557                     "movw %%ax, %%ss\n\t"
558                     "movw %%cs:int13_exec_saved_sp, %%sp\n\t"
559                     "\n99:\n\t",
560                     1,
561                     OUT_CONSTRAINTS ( "=d" ( d1 ) ),
562                     IN_CONSTRAINTS ( "0" ( drive ) ),
563                     CLOBBER ( "eax", "ebx", "ecx", "esi", "edi", "ebp" ) );
564
565         DBG ( "Booted disk returned via INT 18 or 19\n" );
566
567         /* Unhook INTs 18 and 19 */
568         unhook_bios_interrupt ( 0x18, ( unsigned int ) int13_exec_fail,
569                                 &int18_vector );
570         unhook_bios_interrupt ( 0x19, ( unsigned int ) int13_exec_fail,
571                                 &int19_vector );
572         
573         return -ECANCELED;
574 }