4 * GD-Rom image-file common functions.
6 * Copyright (c) 2005 Nathan Keynes.
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.
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.
22 #include <sys/types.h>
23 #include <netinet/in.h>
25 #include "gdrom/gddriver.h"
26 #include "gdrom/packet.h"
28 #include "bootstrap.h"
30 static void gdrom_image_destroy( gdrom_disc_t disc );
31 static gdrom_error_t gdrom_image_read_sector( gdrom_disc_t disc, uint32_t lba, int mode,
32 unsigned char *buf, uint32_t *readlength );
33 static gdrom_error_t gdrom_image_read_toc( gdrom_disc_t disc, unsigned char *buf );
34 static gdrom_error_t gdrom_image_read_session( gdrom_disc_t disc, int session, unsigned char *buf );
35 static gdrom_error_t gdrom_image_read_position( gdrom_disc_t disc, uint32_t lba, unsigned char *buf );
36 static int gdrom_image_drive_status( gdrom_disc_t disc );
38 static uint8_t gdrom_default_sync[12] = { 0, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 0 };
40 #define SECTOR_HEADER_SIZE 16
41 #define SECTOR_SUBHEADER_SIZE 8
43 /* Data offset (from start of raw sector) by sector mode */
44 static int gdrom_data_offset[] = { 16, 16, 16, 24, 24, 0, 8, 0, 0 };
48 struct cdrom_sector_header {
52 uint8_t subhead[8]; // Mode-2 XA sectors only
56 * Initialize a gdrom_disc structure with the gdrom_image_* methods
58 void gdrom_image_init( gdrom_disc_t disc )
60 memset( disc, 0, sizeof(struct gdrom_disc) ); /* safety */
61 disc->read_sector = gdrom_image_read_sector;
62 disc->read_toc = gdrom_image_read_toc;
63 disc->read_session = gdrom_image_read_session;
64 disc->read_position = gdrom_image_read_position;
65 disc->drive_status = gdrom_image_drive_status;
66 disc->play_audio = NULL; /* not supported yet */
67 disc->run_time_slice = NULL; /* not needed */
68 disc->close = gdrom_image_destroy;
71 gdrom_disc_t gdrom_image_new( const gchar *filename, FILE *f )
73 gdrom_image_t image = (gdrom_image_t)g_malloc0(sizeof(struct gdrom_image));
77 image->disc_type = IDE_DISC_CDROMXA;
79 gdrom_disc_t disc = (gdrom_disc_t)image;
80 gdrom_image_init(disc);
81 if( filename == NULL ) {
84 disc->name = g_strdup(filename);
90 static void gdrom_image_destroy( gdrom_disc_t disc )
93 FILE *lastfile = NULL;
94 gdrom_image_t img = (gdrom_image_t)disc;
95 if( img->file != NULL ) {
99 for( i=0; i<img->track_count; i++ ) {
100 if( img->track[i].file != NULL && img->track[i].file != lastfile ) {
101 lastfile = img->track[i].file;
103 img->track[i].file = NULL;
106 if( disc->name != NULL ) {
107 g_free( (gpointer)disc->name );
113 void gdrom_image_destroy_no_close( gdrom_disc_t disc )
116 FILE *lastfile = NULL;
117 gdrom_image_t img = (gdrom_image_t)disc;
118 if( img->file != NULL ) {
121 for( i=0; i<img->track_count; i++ ) {
122 if( img->track[i].file != NULL && img->track[i].file != lastfile ) {
123 lastfile = img->track[i].file;
125 img->track[i].file = NULL;
128 if( disc->name != NULL ) {
129 g_free( (gpointer)disc->name );
135 int gdrom_image_get_track_by_lba( gdrom_image_t image, uint32_t lba )
138 for( i=0; i<image->track_count; i++ ) {
139 if( image->track[i].lba <= lba &&
140 lba < (image->track[i].lba + image->track[i].sector_count) ) {
148 * Read a block from an image file, handling negative file offsets
151 static gboolean gdrom_read_block( unsigned char *buf, int file_offset, int length, FILE *f )
153 if( file_offset < 0 ) {
154 int size = -file_offset;
155 if( size >= length ) {
156 memset( buf, 0, length );
159 memset( buf, 0, size );
164 fseek( f, file_offset, SEEK_SET );
165 return fread( buf, length, 1, f ) == 1;
168 static void gdrom_build_sector_header( unsigned char *buf, uint32_t lba,
169 gdrom_track_mode_t sector_mode )
171 memcpy( buf, gdrom_default_sync, 12 );
172 cd_build_address( buf, sector_mode, lba );
176 * Return TRUE if the given read mode + track modes are compatible,
178 * @param track_mode one of the GDROM_MODE* constants
179 * @param read_mode the READ_CD_MODE from the read request
181 static gboolean gdrom_is_compatible_read_mode( int track_mode, int read_mode )
183 switch( read_mode ) {
184 case READ_CD_MODE_ANY:
186 case READ_CD_MODE_CDDA:
187 return track_mode == GDROM_CDDA;
189 return track_mode == GDROM_MODE1 || track_mode == GDROM_MODE2_FORM1;
190 case READ_CD_MODE_2_FORM_1:
191 return track_mode == GDROM_MODE1 || track_mode == GDROM_MODE2_FORM1;
192 case READ_CD_MODE_2_FORM_2:
193 return track_mode == GDROM_MODE2_FORM2;
195 return track_mode == GDROM_MODE2_FORMLESS;
202 * Determine the start position in a raw sector, and the amount of data to read
203 * in bytes, for a given combination of sector mode and read mode.
205 static void gdrom_get_read_bounds( int sector_mode, int read_mode, int *start, int *size )
207 if( READ_CD_RAW(read_mode) ) {
213 if( READ_CD_DATA(read_mode) ) {
214 *start = gdrom_data_offset[sector_mode];
215 *size = gdrom_sector_size[sector_mode];
218 if( READ_CD_SUBHEAD(read_mode) &&
219 (sector_mode == GDROM_MODE2_FORM1 || sector_mode == GDROM_MODE2_FORM2) ) {
220 *start = SECTOR_HEADER_SIZE;
221 *size += SECTOR_SUBHEADER_SIZE;
224 if( READ_CD_HEADER(read_mode) ) {
225 *size += SECTOR_HEADER_SIZE;
232 void gdrom_extract_raw_data_sector( char *sector_data, int channels, unsigned char *buf, uint32_t *length )
236 struct cdrom_sector_header *secthead = (struct cdrom_sector_header *)sector_data;
237 if( secthead->mode == 1 ) {
238 sector_mode = GDROM_MODE1;
240 sector_mode = ((secthead->subhead[2] & 0x20) == 0 ) ? GDROM_MODE2_FORM1 : GDROM_MODE2_FORM2;
242 gdrom_get_read_bounds( sector_mode, channels, &start, &size );
244 memcpy( buf, sector_data+start, size );
249 * Read a single sector from a disc image. If you thought this would be simple,
250 * I have just one thing to say to you: Bwahahahahahahahah.
252 * Once we've decided that there's a real sector at the requested lba, there's
253 * really two things we need to care about:
254 * 1. Is the sector mode compatible with the requested read mode
255 * 2. Which parts of the sector do we need to return?
256 * (header/subhead/data/raw sector)
258 * Also note that the disc image may supply us with just the data (most common
259 * case), or may have the full raw sector. In the former case we may need to
260 * generate the missing data on the fly, for which we use libedc to compute the
261 * data correction codes.
263 static gdrom_error_t gdrom_image_read_sector( gdrom_disc_t disc, uint32_t lba,
264 int mode, unsigned char *buf, uint32_t *length )
266 gdrom_image_t image = (gdrom_image_t)disc;
267 struct cdrom_sector_header secthead;
268 int file_offset, read_len, track_no;
272 track_no = gdrom_image_get_track_by_lba( image, lba );
273 if( track_no == -1 ) {
274 return PKT_ERR_BADREAD;
276 struct gdrom_track *track = &image->track[track_no-1];
277 file_offset = track->offset + track->sector_size * (lba - track->lba);
278 read_len = track->sector_size;
279 if( track->file != NULL ) {
285 /* First figure out what the real sector mode is for raw/semiraw sectors */
287 switch( track->mode ) {
288 case GDROM_RAW_NONXA:
289 gdrom_read_block( (unsigned char *)(§head), file_offset, sizeof(secthead), f );
290 sector_mode = (secthead.mode == 1) ? GDROM_MODE1 : GDROM_MODE2_FORMLESS;
293 gdrom_read_block( (unsigned char *)(§head), file_offset, sizeof(secthead), f );
294 if( secthead.mode == 1 ) {
295 sector_mode = GDROM_MODE1;
297 sector_mode = ((secthead.subhead[2] & 0x20) == 0 ) ? GDROM_MODE2_FORM1 : GDROM_MODE2_FORM2;
300 case GDROM_SEMIRAW_MODE2:
301 gdrom_read_block( secthead.subhead, file_offset, 8, f );
302 sector_mode = ((secthead.subhead[2] & 0x20) == 0 ) ? GDROM_MODE2_FORM1 : GDROM_MODE2_FORM2;
305 /* In the other cases, the track mode completely defines the sector mode */
306 sector_mode = track->mode;
310 if( !gdrom_is_compatible_read_mode(sector_mode, READ_CD_MODE(mode)) ) {
311 return PKT_ERR_BADREADMODE;
314 /* Ok, we've got a valid sector, check what parts of the sector we need to
315 * return - header | subhead | data | everything
317 int channels = READ_CD_CHANNELS(mode);
319 if( channels == 0 ) {
323 } else if( channels == 0xA0 &&
324 (sector_mode == GDROM_MODE2_FORM1 || sector_mode == GDROM_MODE2_FORM2 )) {
325 // caller requested a non-contiguous region
326 return PKT_ERR_BADFIELD;
327 } else if( READ_CD_RAW(channels) ) {
328 channels = 0xF0; // implies everything
333 switch( track->mode ) {
335 // audio is nice and simple (assume perfect reads for now)
337 gdrom_read_block( buf, file_offset, track->sector_size, f );
340 case GDROM_RAW_NONXA:
341 gdrom_get_read_bounds( sector_mode, channels, &start, &size );
342 gdrom_read_block( buf, file_offset+start, size, f );
345 case GDROM_SEMIRAW_MODE2:
346 gdrom_get_read_bounds( sector_mode, channels, &start, &size );
347 if( READ_CD_HEADER(channels) ) {
348 gdrom_build_sector_header( buf, lba, sector_mode );
349 read_len += SECTOR_HEADER_SIZE;
350 size -= SECTOR_HEADER_SIZE;
352 start -= SECTOR_HEADER_SIZE;
354 gdrom_read_block( buf + read_len, file_offset+start, size, f );
357 default: // Data track w/ data only in file
358 if( READ_CD_RAW(channels) ) {
359 gdrom_read_block( buf + gdrom_data_offset[track->mode], file_offset,
360 track->sector_size, f );
361 do_encode_L2( buf, sector_mode, lba );
364 if( READ_CD_HEADER(channels) ) {
365 gdrom_build_sector_header( buf, lba, sector_mode );
366 read_len += SECTOR_HEADER_SIZE;
368 if( READ_CD_SUBHEAD(channels) &&
369 (sector_mode == GDROM_MODE2_FORM1 || sector_mode == GDROM_MODE2_FORM2) ) {
370 if( sector_mode == GDROM_MODE2_FORM1 ) {
371 *((uint32_t *)(buf+read_len)) = 0;
372 *((uint32_t *)(buf+read_len+4)) = 0;
374 *((uint32_t *)(buf+read_len)) = 0x00200000;
375 *((uint32_t *)(buf+read_len+4)) = 0x00200000;
379 if( READ_CD_DATA(channels) ) {
380 gdrom_read_block( buf+read_len, file_offset, track->sector_size, f );
381 read_len += track->sector_size;
389 static gdrom_error_t gdrom_image_read_toc( gdrom_disc_t disc, unsigned char *buf )
391 gdrom_image_t image = (gdrom_image_t)disc;
392 struct gdrom_toc *toc = (struct gdrom_toc *)buf;
395 for( i=0; i<image->track_count; i++ ) {
396 toc->track[i] = htonl( image->track[i].lba ) | image->track[i].flags;
398 toc->first = 0x0100 | image->track[0].flags;
399 toc->last = (image->track_count<<8) | image->track[i-1].flags;
400 toc->leadout = htonl(image->track[i-1].lba + image->track[i-1].sector_count) |
401 image->track[i-1].flags;
403 toc->track[i] = 0xFFFFFFFF;
407 static gdrom_error_t gdrom_image_read_session( gdrom_disc_t disc, int session, unsigned char *buf )
409 gdrom_image_t image = (gdrom_image_t)disc;
410 struct gdrom_track *last_track = &image->track[image->track_count-1];
411 unsigned int end_of_disc = last_track->lba + last_track->sector_count;
413 buf[0] = 0x01; /* Disc status? */
417 buf[2] = last_track->session+1; /* last session */
418 buf[3] = (end_of_disc >> 16) & 0xFF;
419 buf[4] = (end_of_disc >> 8) & 0xFF;
420 buf[5] = end_of_disc & 0xFF;
424 for( i=0; i<image->track_count; i++ ) {
425 if( image->track[i].session == session ) {
426 buf[2] = i+1; /* first track of session */
427 buf[3] = (image->track[i].lba >> 16) & 0xFF;
428 buf[4] = (image->track[i].lba >> 8) & 0xFF;
429 buf[5] = image->track[i].lba & 0xFF;
433 return PKT_ERR_BADFIELD; /* No such session */
437 static gdrom_error_t gdrom_image_read_position( gdrom_disc_t disc, uint32_t lba, unsigned char *buf )
439 gdrom_image_t image = (gdrom_image_t)disc;
440 int track_no = gdrom_image_get_track_by_lba( image, lba );
441 if( track_no == -1 ) {
445 struct gdrom_track *track = &image->track[track_no-1];
446 uint32_t offset = lba - track->lba;
447 buf[4] = track->flags;
449 buf[6] = 0x01; /* ?? */
450 buf[7] = (offset >> 16) & 0xFF;
451 buf[8] = (offset >> 8) & 0xFF;
452 buf[9] = offset & 0xFF;
454 buf[11] = (lba >> 16) & 0xFF;
455 buf[12] = (lba >> 8) & 0xFF;
456 buf[13] = lba & 0xFF;
460 static int gdrom_image_drive_status( gdrom_disc_t disc )
462 gdrom_image_t image = (gdrom_image_t)disc;
463 if( image->disc_type == IDE_DISC_NONE ) {
464 return IDE_DISC_NONE;
466 return image->disc_type | IDE_DISC_READY;
470 void gdrom_image_dump_info( gdrom_disc_t d ) {
471 gdrom_image_t disc = (gdrom_image_t)d;
473 int last_session = disc->track[disc->track_count-1].session;
474 gboolean is_bootable = FALSE;
476 INFO( "Disc ID: %s, %d tracks in %d sessions", disc->mcn, disc->track_count,
477 disc->track[disc->track_count-1].session + 1 );
478 if( last_session > 0 ) {
479 /* Boot track is the first data track of the last session, provided that it
480 * cannot be a single-session disc.
483 for( i=disc->track_count-1; i>=0 && disc->track[i].session == last_session; i-- ) {
484 if( disc->track[i].flags & TRACK_DATA ) {
488 if( boot_track != -1 ) {
489 unsigned char boot_sector[MAX_SECTOR_SIZE];
490 uint32_t length = sizeof(boot_sector);
491 if( d->read_sector( d, disc->track[boot_track].lba, 0x28,
492 boot_sector, &length ) == PKT_ERR_OK ) {
493 bootstrap_dump(boot_sector, FALSE);
499 WARN( "Disc does not appear to be bootable" );
503 gdrom_device_t gdrom_device_new( const gchar *name, const gchar *dev_name )
505 struct gdrom_device *dev = g_malloc0( sizeof(struct gdrom_device) );
506 dev->name = g_strdup(name);
507 dev->device_name = g_strdup(dev_name);
511 void gdrom_device_destroy( gdrom_device_t dev )
513 if( dev->name != NULL ) {
517 if( dev->device_name != NULL ) {
518 g_free( dev->device_name );
519 dev->device_name = NULL;
.