Search
lxdream.org :: lxdream/src/gdrom/gdimage.c
lxdream 0.9.1
released Jun 29
Download Now
filename src/gdrom/gdimage.c
changeset 736:a02d1475ccfd
prev720:b5594d1ac80a
next759:f16975739abc
author nkeynes
date Mon Jul 14 07:44:42 2008 +0000 (14 years ago)
permissions -rw-r--r--
last change Re-indent everything consistently
Fix include guards for consistency as well
view annotate diff log raw
     1 /**
     2  * $Id$
     3  *
     4  * GD-Rom image-file common functions. 
     5  *
     6  * Copyright (c) 2005 Nathan Keynes.
     7  *
     8  * This program is free software; you can redistribute it and/or modify
     9  * it under the terms of the GNU General Public License as published by
    10  * the Free Software Foundation; either version 2 of the License, or
    11  * (at your option) any later version.
    12  *
    13  * This program is distributed in the hope that it will be useful,
    14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
    15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    16  * GNU General Public License for more details.
    17  */
    19 #include <assert.h>
    20 #include <string.h>
    21 #include <netinet/in.h>
    23 #include "gdrom/gddriver.h"
    24 #include "gdrom/packet.h"
    25 #include "ecc.h"
    26 #include "bootstrap.h"
    28 static void gdrom_image_destroy( gdrom_disc_t disc );
    29 static gdrom_error_t gdrom_image_read_sector( gdrom_disc_t disc, uint32_t lba, int mode, 
    30                                               unsigned char *buf, uint32_t *readlength );
    31 static gdrom_error_t gdrom_image_read_toc( gdrom_disc_t disc, unsigned char *buf );
    32 static gdrom_error_t gdrom_image_read_session( gdrom_disc_t disc, int session, unsigned char *buf );
    33 static gdrom_error_t gdrom_image_read_position( gdrom_disc_t disc, uint32_t lba, unsigned char *buf );
    34 static int gdrom_image_drive_status( gdrom_disc_t disc );
    36 static uint8_t gdrom_default_sync[12] = { 0, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 0 };
    38 #define SECTOR_HEADER_SIZE 16
    39 #define SECTOR_SUBHEADER_SIZE 8
    41 /* Data offset (from start of raw sector) by sector mode */
    42 static int gdrom_data_offset[] = { 16, 16, 16, 24, 24, 0, 8, 0, 0 };
    46 struct cdrom_sector_header {
    47     uint8_t sync[12];
    48     uint8_t msf[3];
    49     uint8_t mode;
    50     uint8_t subhead[8]; // Mode-2 XA sectors only
    51 };
    53 /**
    54  * Initialize a gdrom_disc structure with the gdrom_image_* methods
    55  */
    56 void gdrom_image_init( gdrom_disc_t disc )
    57 {
    58     memset( disc, 0, sizeof(struct gdrom_disc) ); /* safety */
    59     disc->read_sector = gdrom_image_read_sector;
    60     disc->read_toc = gdrom_image_read_toc;
    61     disc->read_session = gdrom_image_read_session;
    62     disc->read_position = gdrom_image_read_position;
    63     disc->drive_status = gdrom_image_drive_status;
    64     disc->play_audio = NULL; /* not supported yet */
    65     disc->run_time_slice = NULL; /* not needed */
    66     disc->close = gdrom_image_destroy;
    67 }
    69 gdrom_disc_t gdrom_image_new( const gchar *filename, FILE *f )
    70 {
    71     gdrom_image_t image = (gdrom_image_t)g_malloc0(sizeof(struct gdrom_image));
    72     if( image == NULL ) {
    73         return NULL;
    74     }
    75     image->disc_type = IDE_DISC_CDROMXA;
    76     image->file = f;
    77     gdrom_disc_t disc = (gdrom_disc_t)image;
    78     gdrom_image_init(disc);
    79     if( filename == NULL ) {
    80         disc->name = NULL;
    81     } else {
    82         disc->name = g_strdup(filename);
    83     }
    85     return disc;
    86 }
    88 static void gdrom_image_destroy( gdrom_disc_t disc )
    89 {
    90     int i;
    91     FILE *lastfile = NULL;
    92     gdrom_image_t img = (gdrom_image_t)disc;
    93     if( img->file != NULL ) {
    94         fclose(img->file);
    95         img->file = NULL;
    96     }
    97     for( i=0; i<img->track_count; i++ ) {
    98         if( img->track[i].file != NULL && img->track[i].file != lastfile ) {
    99             lastfile = img->track[i].file;
   100             fclose(lastfile);
   101             img->track[i].file = NULL;
   102         }
   103     }
   104     if( disc->name != NULL ) {
   105         g_free( (gpointer)disc->name );
   106         disc->name = NULL;
   107     }
   108     free( disc );
   109 }
   111 void gdrom_image_destroy_no_close( gdrom_disc_t disc )
   112 {
   113     int i;
   114     FILE *lastfile = NULL;
   115     gdrom_image_t img = (gdrom_image_t)disc;
   116     if( img->file != NULL ) {
   117         img->file = NULL;
   118     }
   119     for( i=0; i<img->track_count; i++ ) {
   120         if( img->track[i].file != NULL && img->track[i].file != lastfile ) {
   121             lastfile = img->track[i].file;
   122             fclose(lastfile);
   123             img->track[i].file = NULL;
   124         }
   125     }
   126     if( disc->name != NULL ) {
   127         g_free( (gpointer)disc->name );
   128         disc->name = NULL;
   129     }
   130     free( disc );
   131 }
   133 static int gdrom_image_get_track_by_lba( gdrom_image_t image, uint32_t lba )
   134 {
   135     int i;
   136     for( i=0; i<image->track_count; i++ ) {
   137         if( image->track[i].lba <= lba && 
   138                 lba < (image->track[i].lba + image->track[i].sector_count) ) {
   139             return i+1;
   140         }
   141     }
   142     return -1;
   143 }
   145 /**
   146  * Read a block from an image file, handling negative file offsets
   147  * with 0-fill.
   148  */
   149 static gboolean gdrom_read_block( unsigned char *buf, int file_offset, int length, FILE *f )
   150 {
   151     if( file_offset < 0 ) {
   152         int size = -file_offset;
   153         if( size >= length ) {
   154             memset( buf, 0, length );
   155             return TRUE;
   156         } else {
   157             memset( buf, 0, size );
   158             file_offset = 0;
   159             length -= size;
   160         }
   161     }
   162     fseek( f, file_offset, SEEK_SET );
   163     return fread( buf, length, 1, f ) == 1;
   164 }
   166 static void gdrom_build_sector_header( unsigned char *buf, uint32_t lba, 
   167                                        gdrom_track_mode_t sector_mode )
   168 {
   169     memcpy( buf, gdrom_default_sync, 12 );
   170     cd_build_address( buf, sector_mode, lba );
   171 }
   173 /**
   174  * Return TRUE if the given read mode + track modes are compatible,
   175  * otherwise FALSE.
   176  * @param track_mode one of the GDROM_MODE* constants
   177  * @param read_mode the READ_CD_MODE from the read request
   178  */
   179 static gboolean gdrom_is_compatible_read_mode( int track_mode, int read_mode )
   180 {
   181     switch( read_mode ) {
   182     case READ_CD_MODE_ANY:
   183         return TRUE;
   184     case READ_CD_MODE_CDDA:
   185         return track_mode == GDROM_CDDA;
   186     case READ_CD_MODE_1:
   187         return track_mode == GDROM_MODE1 || track_mode == GDROM_MODE2_FORM1;
   188     case READ_CD_MODE_2_FORM_1:
   189         return track_mode == GDROM_MODE1 || track_mode == GDROM_MODE2_FORM1;
   190     case READ_CD_MODE_2_FORM_2:
   191         return track_mode == GDROM_MODE2_FORM2;
   192     case READ_CD_MODE_2:
   193         return track_mode == GDROM_MODE2_FORMLESS;
   194     default:
   195         return FALSE;
   196     }
   197 }
   199 /**
   200  * Determine the start position in a raw sector, and the amount of data to read
   201  * in bytes, for a given combination of sector mode and read mode.
   202  */ 
   203 static void gdrom_get_read_bounds( int sector_mode, int read_mode, int *start, int *size )
   204 {
   205     if( READ_CD_RAW(read_mode) ) {
   206         // whole sector
   207         *start = 0;
   208         *size = 2352;
   209     } else {
   210         *size = 0;
   211         if( READ_CD_DATA(read_mode) ) {
   212             *start = gdrom_data_offset[sector_mode];
   213             *size = gdrom_sector_size[sector_mode];
   214         }
   216         if( READ_CD_SUBHEAD(read_mode) && 
   217                 (sector_mode == GDROM_MODE2_FORM1 || sector_mode == GDROM_MODE2_FORM2) ) {
   218             *start = SECTOR_HEADER_SIZE;
   219             *size += SECTOR_SUBHEADER_SIZE;
   220         }
   222         if( READ_CD_HEADER(read_mode) ) {
   223             *size += SECTOR_HEADER_SIZE;
   224             *start = 0;
   225         }
   227     }
   228 }
   230 /**
   231  * Read a single sector from a disc image. If you thought this would be simple, 
   232  * I have just one thing to say to you: Bwahahahahahahahah.
   233  *
   234  * Once we've decided that there's a real sector at the requested lba, there's 
   235  * really two things we need to care about:
   236  *   1. Is the sector mode compatible with the requested read mode
   237  *   2. Which parts of the sector do we need to return? 
   238  *      (header/subhead/data/raw sector)
   239  *
   240  * Also note that the disc image may supply us with just the data (most common 
   241  * case), or may have the full raw sector. In the former case we may need to 
   242  * generate the missing data on the fly, for which we use libedc to compute the
   243  * data correction codes.
   244  */
   245 static gdrom_error_t gdrom_image_read_sector( gdrom_disc_t disc, uint32_t lba,
   246                                               int mode, unsigned char *buf, uint32_t *length )
   247 {
   248     gdrom_image_t image = (gdrom_image_t)disc;
   249     struct cdrom_sector_header secthead;
   250     int file_offset, read_len, track_no;
   252     FILE *f;
   254     track_no = gdrom_image_get_track_by_lba( image, lba );
   255     if( track_no == -1 ) {
   256         return PKT_ERR_BADREAD;
   257     }
   258     struct gdrom_track *track = &image->track[track_no-1];
   259     file_offset = track->offset + track->sector_size * (lba - track->lba);
   260     read_len = track->sector_size;
   261     if( track->file != NULL ) {
   262         f = track->file;
   263     } else {
   264         f = image->file;
   265     }
   267     /* First figure out what the real sector mode is for raw/semiraw sectors */
   268     int sector_mode;
   269     switch( track->mode ) {
   270     case GDROM_RAW_NONXA:
   271         gdrom_read_block( (unsigned char *)(&secthead), file_offset, sizeof(secthead), f );
   272         sector_mode = (secthead.mode == 1) ? GDROM_MODE1 : GDROM_MODE2_FORMLESS;
   273         break;
   274     case GDROM_RAW_XA:
   275         gdrom_read_block( (unsigned char *)(&secthead), file_offset, sizeof(secthead), f );
   276         if( secthead.mode == 1 ) {
   277             sector_mode = GDROM_MODE1;
   278         } else {
   279             sector_mode = ((secthead.subhead[2] & 0x20) == 0 ) ? GDROM_MODE2_FORM1 : GDROM_MODE2_FORM2;
   280         }
   281         break;
   282     case GDROM_SEMIRAW_MODE2:
   283         gdrom_read_block( secthead.subhead, file_offset, 8, f );
   284         sector_mode = ((secthead.subhead[2] & 0x20) == 0 ) ? GDROM_MODE2_FORM1 : GDROM_MODE2_FORM2;
   285         break;
   286     default:
   287         /* In the other cases, the track mode completely defines the sector mode */
   288         sector_mode = track->mode;
   289         break;
   290     }
   292     if( !gdrom_is_compatible_read_mode(sector_mode, READ_CD_MODE(mode)) ) {
   293         return PKT_ERR_BADREADMODE;
   294     }
   296     /* Ok, we've got a valid sector, check what parts of the sector we need to
   297      * return - header | subhead | data | everything
   298      */
   299     int channels = READ_CD_CHANNELS(mode);
   301     if( channels == 0 ) {
   302         // legal, if weird
   303         *length = 0;
   304         return PKT_ERR_OK;
   305     } else if( channels == 0xA0 && 
   306             (sector_mode == GDROM_MODE2_FORM1 || sector_mode == GDROM_MODE2_FORM2 )) {
   307         // caller requested a non-contiguous region
   308         return PKT_ERR_BADFIELD;
   309     } else if( READ_CD_RAW(channels) ) {
   310         channels = 0xF0; // implies everything
   311     }
   313     read_len = 0;
   314     int start, size;
   315     switch( track->mode ) {
   316     case GDROM_CDDA:
   317         // audio is nice and simple (assume perfect reads for now)
   318         *length = 2352;
   319         gdrom_read_block( buf, file_offset, track->sector_size, f );
   320         return PKT_ERR_OK;
   321     case GDROM_RAW_XA:
   322     case GDROM_RAW_NONXA:
   323         gdrom_get_read_bounds( sector_mode, channels, &start, &size );
   324         gdrom_read_block( buf, file_offset+start, size, f );
   325         read_len = size;
   326         break;
   327     case GDROM_SEMIRAW_MODE2:
   328         gdrom_get_read_bounds( sector_mode, channels, &start, &size );
   329         if( READ_CD_HEADER(channels) ) {
   330             gdrom_build_sector_header( buf, lba, sector_mode );
   331             read_len += SECTOR_HEADER_SIZE;
   332             size -= SECTOR_HEADER_SIZE;
   333         } else {
   334             start -= SECTOR_HEADER_SIZE;
   335         }
   336         gdrom_read_block( buf + read_len, file_offset+start, size, f );
   337         read_len += size;
   338         break;
   339     default: // Data track w/ data only in file
   340         if( READ_CD_RAW(channels) ) {
   341             gdrom_read_block( buf + gdrom_data_offset[track->mode], file_offset, 
   342                     track->sector_size, f );
   343             do_encode_L2( buf, sector_mode, lba );
   344             read_len = 2352;
   345         } else {
   346             if( READ_CD_HEADER(channels) ) {
   347                 gdrom_build_sector_header( buf, lba, sector_mode );
   348                 read_len += SECTOR_HEADER_SIZE;
   349             }
   350             if( READ_CD_SUBHEAD(channels) && 
   351                     (sector_mode == GDROM_MODE2_FORM1 || sector_mode == GDROM_MODE2_FORM2) ) {
   352                 if( sector_mode == GDROM_MODE2_FORM1 ) {
   353                     *((uint32_t *)(buf+read_len)) = 0;
   354                     *((uint32_t *)(buf+read_len+4)) = 0;
   355                 } else {
   356                     *((uint32_t *)(buf+read_len)) = 0x00200000;
   357                     *((uint32_t *)(buf+read_len+4)) = 0x00200000;
   358                 }
   359                 read_len += 8;
   360             }
   361             if( READ_CD_DATA(channels) ) {
   362                 gdrom_read_block( buf+read_len, file_offset, track->sector_size, f );
   363                 read_len += track->sector_size;
   364             }
   365         }
   366     }
   367     *length = read_len;
   368     return PKT_ERR_OK;
   369 }
   371 static gdrom_error_t gdrom_image_read_toc( gdrom_disc_t disc, unsigned char *buf ) 
   372 {
   373     gdrom_image_t image = (gdrom_image_t)disc;
   374     struct gdrom_toc *toc = (struct gdrom_toc *)buf;
   375     int i;
   377     for( i=0; i<image->track_count; i++ ) {
   378         toc->track[i] = htonl( image->track[i].lba ) | image->track[i].flags;
   379     }
   380     toc->first = 0x0100 | image->track[0].flags;
   381     toc->last = (image->track_count<<8) | image->track[i-1].flags;
   382     toc->leadout = htonl(image->track[i-1].lba + image->track[i-1].sector_count) |
   383     image->track[i-1].flags;
   384     for( ;i<99; i++ )
   385         toc->track[i] = 0xFFFFFFFF;
   386     return PKT_ERR_OK;
   387 }
   389 static gdrom_error_t gdrom_image_read_session( gdrom_disc_t disc, int session, unsigned char *buf )
   390 {
   391     gdrom_image_t image = (gdrom_image_t)disc;
   392     struct gdrom_track *last_track = &image->track[image->track_count-1];
   393     unsigned int end_of_disc = last_track->lba + last_track->sector_count;
   394     int i;
   395     buf[0] = 0x01; /* Disc status? */
   396     buf[1] = 0;
   398     if( session == 0 ) {
   399         buf[2] = last_track->session+1; /* last session */
   400         buf[3] = (end_of_disc >> 16) & 0xFF;
   401         buf[4] = (end_of_disc >> 8) & 0xFF;
   402         buf[5] = end_of_disc & 0xFF;
   403         return PKT_ERR_OK;
   404     } else {
   405         session--;
   406         for( i=0; i<image->track_count; i++ ) {
   407             if( image->track[i].session == session ) {
   408                 buf[2] = i+1; /* first track of session */
   409                 buf[3] = (image->track[i].lba >> 16) & 0xFF;
   410                 buf[4] = (image->track[i].lba >> 8) & 0xFF;
   411                 buf[5] = image->track[i].lba & 0xFF;
   412                 return PKT_ERR_OK;
   413             }
   414         }
   415         return PKT_ERR_BADFIELD; /* No such session */
   416     }
   417 }
   419 static gdrom_error_t gdrom_image_read_position( gdrom_disc_t disc, uint32_t lba, unsigned char *buf )
   420 {
   421     gdrom_image_t image = (gdrom_image_t)disc;
   422     int track_no = gdrom_image_get_track_by_lba( image, lba );
   423     if( track_no == -1 ) {
   424         track_no = 1;
   425         lba = 150;
   426     }
   427     struct gdrom_track *track = &image->track[track_no-1];
   428     uint32_t offset = lba - track->lba;
   429     buf[4] = track->flags;
   430     buf[5] = track_no;
   431     buf[6] = 0x01; /* ?? */
   432     buf[7] = (offset >> 16) & 0xFF;
   433     buf[8] = (offset >> 8) & 0xFF;
   434     buf[9] = offset & 0xFF;
   435     buf[10] = 0;
   436     buf[11] = (lba >> 16) & 0xFF;
   437     buf[12] = (lba >> 8) & 0xFF;
   438     buf[13] = lba & 0xFF;
   439     return PKT_ERR_OK;
   440 }
   442 static int gdrom_image_drive_status( gdrom_disc_t disc ) 
   443 {
   444     gdrom_image_t image = (gdrom_image_t)disc;
   445     if( image->disc_type == IDE_DISC_NONE ) {
   446         return IDE_DISC_NONE;
   447     } else {
   448         return image->disc_type | IDE_DISC_READY;
   449     }
   450 }
   452 void gdrom_image_dump_info( gdrom_disc_t d ) {
   453     gdrom_image_t disc = (gdrom_image_t)d;
   454     int i;
   455     int last_session = disc->track[disc->track_count-1].session;
   456     gboolean is_bootable = FALSE;
   458     INFO( "Disc ID: %s, %d tracks in %d sessions", disc->mcn, disc->track_count, 
   459           disc->track[disc->track_count-1].session + 1 );
   460     if( last_session > 0 ) {
   461         /* Boot track is the first data track of the last session, provided that it 
   462          * cannot be a single-session disc.
   463          */
   464         int boot_track = -1;
   465         for( i=disc->track_count-1; i>=0 && disc->track[i].session == last_session; i-- ) {
   466             if( disc->track[i].flags & TRACK_DATA ) {
   467                 boot_track = i;
   468             }
   469         }
   470         if( boot_track != -1 ) {
   471             unsigned char boot_sector[MAX_SECTOR_SIZE];
   472             uint32_t length = sizeof(boot_sector);
   473             if( d->read_sector( d, disc->track[boot_track].lba, 0x28,
   474                     boot_sector, &length ) == PKT_ERR_OK ) {
   475                 bootstrap_dump(boot_sector, FALSE);
   476                 is_bootable = TRUE;
   477             }
   478         }
   479     }
   480     if( !is_bootable ) {
   481         WARN( "Disc does not appear to be bootable" );
   482     }
   483 }
   485 gdrom_device_t gdrom_device_new( const gchar *name, const gchar *dev_name )
   486 {
   487     struct gdrom_device *dev = g_malloc0( sizeof(struct gdrom_device) );
   488     dev->name = g_strdup(name);
   489     dev->device_name = g_strdup(dev_name);
   490     return dev;
   491 }
   493 void gdrom_device_destroy( gdrom_device_t dev )
   494 {
   495     if( dev->name != NULL ) {
   496         g_free( dev->name );
   497         dev->name = NULL;
   498     }
   499     if( dev->device_name != NULL ) {
   500         g_free( dev->device_name );
   501         dev->device_name = NULL;
   502     }
   503     g_free( dev );
   504 }
.