nkeynes@125 | 1 | /**
|
nkeynes@492 | 2 | * $Id: gdrom.h,v 1.16 2007-11-06 08:35:16 nkeynes Exp $
|
nkeynes@125 | 3 | *
|
nkeynes@125 | 4 | * This file defines the structures and functions used by the GD-Rom
|
nkeynes@125 | 5 | * disc driver. (ie, the modules that supply a CD image to be used by the
|
nkeynes@125 | 6 | * system).
|
nkeynes@125 | 7 | *
|
nkeynes@125 | 8 | * Copyright (c) 2005 Nathan Keynes.
|
nkeynes@125 | 9 | *
|
nkeynes@125 | 10 | * This program is free software; you can redistribute it and/or modify
|
nkeynes@125 | 11 | * it under the terms of the GNU General Public License as published by
|
nkeynes@125 | 12 | * the Free Software Foundation; either version 2 of the License, or
|
nkeynes@125 | 13 | * (at your option) any later version.
|
nkeynes@125 | 14 | *
|
nkeynes@125 | 15 | * This program is distributed in the hope that it will be useful,
|
nkeynes@125 | 16 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
|
nkeynes@125 | 17 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
nkeynes@125 | 18 | * GNU General Public License for more details.
|
nkeynes@125 | 19 | */
|
nkeynes@125 | 20 |
|
nkeynes@125 | 21 | #ifndef dream_gdrom_H
|
nkeynes@125 | 22 | #define dream_gdrom_H 1
|
nkeynes@125 | 23 |
|
nkeynes@125 | 24 | #include "dream.h"
|
nkeynes@464 | 25 | #include <glib.h>
|
nkeynes@125 | 26 |
|
nkeynes@342 | 27 | #define MAX_SECTOR_SIZE 2352
|
nkeynes@342 | 28 |
|
nkeynes@149 | 29 | typedef uint16_t gdrom_error_t;
|
nkeynes@149 | 30 |
|
nkeynes@138 | 31 | struct gdrom_toc {
|
nkeynes@142 | 32 | uint32_t track[99];
|
nkeynes@125 | 33 | uint32_t first, last, leadout;
|
nkeynes@138 | 34 | };
|
nkeynes@138 | 35 |
|
nkeynes@138 | 36 | #define GDROM_PREGAP 150 /* Sectors */
|
nkeynes@138 | 37 |
|
nkeynes@138 | 38 | extern uint32_t gdrom_sector_size[];
|
nkeynes@138 | 39 | #define GDROM_SECTOR_SIZE(x) gdrom_sector_size[x]
|
nkeynes@138 | 40 | typedef enum {
|
nkeynes@138 | 41 | GDROM_MODE1,
|
nkeynes@138 | 42 | GDROM_MODE2,
|
nkeynes@138 | 43 | GDROM_MODE2_XA1,
|
nkeynes@138 | 44 | GDROM_MODE2_XA2,
|
nkeynes@138 | 45 | GDROM_CDDA,
|
nkeynes@143 | 46 | GDROM_GD,
|
nkeynes@143 | 47 | GDROM_RAW
|
nkeynes@138 | 48 | } gdrom_track_mode_t;
|
nkeynes@138 | 49 |
|
nkeynes@138 | 50 | /* The disc register indicates the current contents of the drive. When open
|
nkeynes@138 | 51 | * contains 0x06.
|
nkeynes@138 | 52 | */
|
nkeynes@138 | 53 | #define IDE_DISC_AUDIO 0x00
|
nkeynes@138 | 54 | #define IDE_DISC_NONE 0x06
|
nkeynes@138 | 55 | #define IDE_DISC_CDROM 0x20
|
nkeynes@138 | 56 | #define IDE_DISC_GDROM 0x80
|
nkeynes@138 | 57 | #define IDE_DISC_READY 0x01 /* ored with above */
|
nkeynes@138 | 58 | #define IDE_DISC_IDLE 0x02 /* ie spun-down */
|
nkeynes@138 | 59 |
|
nkeynes@142 | 60 | #define TRACK_PRE_EMPHASIS 0x10
|
nkeynes@142 | 61 | #define TRACK_COPY_PERMITTED 0x20
|
nkeynes@142 | 62 | #define TRACK_DATA 0x40
|
nkeynes@142 | 63 | #define TRACK_FOUR_CHANNEL 0x80
|
nkeynes@142 | 64 |
|
nkeynes@245 | 65 | typedef struct gdrom_track {
|
nkeynes@138 | 66 | gdrom_track_mode_t mode;
|
nkeynes@142 | 67 | uint8_t flags; /* Track flags */
|
nkeynes@138 | 68 | int session; /* session # containing this track */
|
nkeynes@138 | 69 | uint32_t lba; /* start sector address */
|
nkeynes@138 | 70 | uint32_t sector_size; /* For convenience, determined by mode */
|
nkeynes@138 | 71 | uint32_t sector_count;
|
nkeynes@138 | 72 | uint32_t offset; /* File offset of start of track - image files only */
|
nkeynes@492 | 73 | FILE *file;
|
nkeynes@245 | 74 | } *gdrom_track_t;
|
nkeynes@125 | 75 |
|
nkeynes@342 | 76 | typedef struct gdrom_disc {
|
nkeynes@342 | 77 | /**
|
nkeynes@342 | 78 | * Read a single sector from the disc at the specified logical address.
|
nkeynes@342 | 79 | * @param disc pointer to the disc structure
|
nkeynes@342 | 80 | * @param lba logical address to read from
|
nkeynes@342 | 81 | * @param mode mode field from the read command
|
nkeynes@342 | 82 | * @param buf buffer to receive data (at least MAX_SECTOR_SIZE bytes)
|
nkeynes@342 | 83 | * @param length unsigned int to receive the number of bytes actually read.
|
nkeynes@342 | 84 | * @return PKT_ERR_OK on success, or another PKT_ERR_* code on failure.
|
nkeynes@342 | 85 | */
|
nkeynes@342 | 86 | gdrom_error_t (*read_sector)( struct gdrom_disc *disc,
|
nkeynes@342 | 87 | uint32_t lba, int mode,
|
nkeynes@422 | 88 | unsigned char *buf, uint32_t *length );
|
nkeynes@342 | 89 |
|
nkeynes@342 | 90 | /**
|
nkeynes@342 | 91 | * Read the TOC from the disc and write it into the specified buffer.
|
nkeynes@342 | 92 | * The method is responsible for returning the data in gd-rom
|
nkeynes@342 | 93 | * format.
|
nkeynes@342 | 94 | * @param disc pointer to the disc structure
|
nkeynes@342 | 95 | * @param buf buffer to receive data (0x198 bytes long)
|
nkeynes@342 | 96 | */
|
nkeynes@422 | 97 | gdrom_error_t (*read_toc)(struct gdrom_disc *disc, unsigned char *buf);
|
nkeynes@125 | 98 |
|
nkeynes@342 | 99 | /**
|
nkeynes@342 | 100 | * Read the information for the specified sector and return it in the
|
nkeynes@342 | 101 | * supplied buffer.
|
nkeynes@342 | 102 | * @param disc pointer to the disc structure
|
nkeynes@342 | 103 | * @param session of interest. If 0, return end of disc information.
|
nkeynes@342 | 104 | * @param buf buffer to receive data (6 bytes)
|
nkeynes@342 | 105 | */
|
nkeynes@422 | 106 | gdrom_error_t (*read_session)(struct gdrom_disc *disc, int session, unsigned char *buf);
|
nkeynes@342 | 107 |
|
nkeynes@342 | 108 | /**
|
nkeynes@342 | 109 | * Read the position information (subchannel) for the specified sector
|
nkeynes@342 | 110 | * and return it in the supplied buffer. This method does not need to
|
nkeynes@342 | 111 | * write the first 4 bytes of the buffer.
|
nkeynes@342 | 112 | * @param disc pointer to the disc structure
|
nkeynes@342 | 113 | * @param lba sector to get position information for
|
nkeynes@342 | 114 | * @param buf buffer to receive data (14 bytes)
|
nkeynes@342 | 115 | */
|
nkeynes@422 | 116 | gdrom_error_t (*read_position)(struct gdrom_disc *disc, uint32_t lba, unsigned char *buf);
|
nkeynes@342 | 117 |
|
nkeynes@342 | 118 | /**
|
nkeynes@342 | 119 | * Return the current disc status, expressed as a combination of the
|
nkeynes@342 | 120 | * IDE_DISC_* flags above.
|
nkeynes@342 | 121 | * @param disc pointer to the disc structure
|
nkeynes@342 | 122 | * @return an integer status value.
|
nkeynes@342 | 123 | */
|
nkeynes@342 | 124 | int (*drive_status)(struct gdrom_disc *disc);
|
nkeynes@342 | 125 |
|
nkeynes@342 | 126 | /**
|
nkeynes@342 | 127 | * Begin playing audio from the given lba address on the disc.
|
nkeynes@342 | 128 | */
|
nkeynes@433 | 129 | gdrom_error_t (*play_audio)(struct gdrom_disc *disc, uint32_t lba, uint32_t endlba);
|
nkeynes@342 | 130 |
|
nkeynes@342 | 131 | /**
|
nkeynes@342 | 132 | * Executed once per time slice to perform house-keeping operations
|
nkeynes@342 | 133 | * (checking disc status, media changed, etc).
|
nkeynes@342 | 134 | */
|
nkeynes@342 | 135 | uint32_t (*run_time_slice)( struct gdrom_disc *disc, uint32_t nanosecs );
|
nkeynes@342 | 136 |
|
nkeynes@342 | 137 | /**
|
nkeynes@342 | 138 | * Close the disc and release any storage or resources allocated including
|
nkeynes@342 | 139 | * the disc structure itself.
|
nkeynes@342 | 140 | */
|
nkeynes@342 | 141 | void (*close)( struct gdrom_disc *disc );
|
nkeynes@464 | 142 | const gchar *name; /* Device name / Image filename */
|
nkeynes@342 | 143 | } *gdrom_disc_t;
|
nkeynes@342 | 144 |
|
nkeynes@342 | 145 |
|
nkeynes@342 | 146 | typedef struct gdrom_image {
|
nkeynes@342 | 147 | struct gdrom_disc disc;
|
nkeynes@138 | 148 | int disc_type;
|
nkeynes@138 | 149 | int track_count;
|
nkeynes@138 | 150 | struct gdrom_track track[99];
|
nkeynes@138 | 151 | gchar mcn[14]; /* Media catalogue number */
|
nkeynes@342 | 152 | FILE *file; /* Open file stream */
|
nkeynes@342 | 153 | } *gdrom_image_t;
|
nkeynes@125 | 154 |
|
nkeynes@138 | 155 | /**
|
nkeynes@168 | 156 | *
|
nkeynes@168 | 157 | */
|
nkeynes@168 | 158 | typedef struct gdrom_image_class {
|
nkeynes@168 | 159 | const gchar *name;
|
nkeynes@168 | 160 | const gchar *extension;
|
nkeynes@168 | 161 | gboolean (*is_valid_file)(FILE *f);
|
nkeynes@168 | 162 | gdrom_disc_t (*open_image_file)(const gchar *filename, FILE *f);
|
nkeynes@168 | 163 | } *gdrom_image_class_t;
|
nkeynes@168 | 164 |
|
nkeynes@168 | 165 | extern struct gdrom_image_class nrg_image_class;
|
nkeynes@168 | 166 | extern struct gdrom_image_class cdi_image_class;
|
nkeynes@492 | 167 | extern struct gdrom_image_class gdi_image_class;
|
nkeynes@489 | 168 | extern struct gdrom_image_class cdrom_device_class;
|
nkeynes@168 | 169 |
|
nkeynes@168 | 170 | /**
|
nkeynes@138 | 171 | * Construct a new image file using the default methods.
|
nkeynes@138 | 172 | */
|
nkeynes@464 | 173 | gdrom_disc_t gdrom_image_new( const gchar *filename, FILE *f );
|
nkeynes@125 | 174 |
|
nkeynes@138 | 175 | /**
|
nkeynes@138 | 176 | * Open an image file
|
nkeynes@138 | 177 | */
|
nkeynes@138 | 178 | gdrom_disc_t gdrom_image_open( const gchar *filename );
|
nkeynes@138 | 179 |
|
nkeynes@138 | 180 | /**
|
nkeynes@422 | 181 | * Dump image info
|
nkeynes@422 | 182 | */
|
nkeynes@422 | 183 | void gdrom_image_dump_info( gdrom_disc_t d );
|
nkeynes@422 | 184 |
|
nkeynes@422 | 185 | /**
|
nkeynes@468 | 186 | * Destroy an image data structure without closing the file
|
nkeynes@468 | 187 | * (Intended for use from image loaders only)
|
nkeynes@468 | 188 | */
|
nkeynes@468 | 189 | void gdrom_image_destroy_no_close( gdrom_disc_t d );
|
nkeynes@468 | 190 |
|
nkeynes@468 | 191 | /**
|
nkeynes@138 | 192 | * Retrieve the disc table of contents, and write it into the buffer in the
|
nkeynes@138 | 193 | * format expected by the DC.
|
nkeynes@149 | 194 | * @return 0 on success, error code on failure (eg no disc mounted)
|
nkeynes@138 | 195 | */
|
nkeynes@422 | 196 | gdrom_error_t gdrom_get_toc( unsigned char *buf );
|
nkeynes@149 | 197 |
|
nkeynes@149 | 198 | /**
|
nkeynes@152 | 199 | * Retrieve the short (6-byte) session info, and write it into the buffer.
|
nkeynes@149 | 200 | * @return 0 on success, error code on failure.
|
nkeynes@149 | 201 | */
|
nkeynes@422 | 202 | gdrom_error_t gdrom_get_info( unsigned char *buf, int session );
|
nkeynes@138 | 203 |
|
nkeynes@245 | 204 | gdrom_track_t gdrom_get_track( int track_no );
|
nkeynes@245 | 205 |
|
nkeynes@245 | 206 | uint8_t gdrom_get_track_no_by_lba( uint32_t lba );
|
nkeynes@245 | 207 |
|
nkeynes@138 | 208 | /**
|
nkeynes@138 | 209 | * Shortcut to open and mount an image file
|
nkeynes@433 | 210 | * @return true on success
|
nkeynes@138 | 211 | */
|
nkeynes@433 | 212 | gboolean gdrom_mount_image( const gchar *filename );
|
nkeynes@138 | 213 |
|
nkeynes@138 | 214 | void gdrom_mount_disc( gdrom_disc_t disc );
|
nkeynes@138 | 215 |
|
nkeynes@138 | 216 | void gdrom_unmount_disc( void );
|
nkeynes@138 | 217 |
|
nkeynes@138 | 218 | gboolean gdrom_is_mounted( void );
|
nkeynes@138 | 219 |
|
nkeynes@464 | 220 | gdrom_disc_t gdrom_get_current_disc();
|
nkeynes@464 | 221 |
|
nkeynes@464 | 222 | GList *gdrom_get_native_devices();
|
nkeynes@464 | 223 |
|
nkeynes@138 | 224 | uint32_t gdrom_read_sectors( uint32_t sector, uint32_t sector_count,
|
nkeynes@422 | 225 | int mode, unsigned char *buf, uint32_t *length );
|
nkeynes@125 | 226 |
|
nkeynes@125 | 227 | #endif
|