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