/* $Id: freebsd.c,v 1.1 2005/01/01 02:43:57 rockyb Exp $ Copyright (C) 2003, 2004 Rocky Bernstein This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ /* This file contains FreeBSD-specific code and implements low-level control of the CD drive. Culled initially I think from xine's or mplayer's FreeBSD code with lots of modifications. */ #ifdef HAVE_CONFIG_H # include "config.h" #endif static const char _rcsid[] = "$Id: freebsd.c,v 1.1 2005/01/01 02:43:57 rockyb Exp $"; #include #include "freebsd.h" #ifdef HAVE_FREEBSD_CDROM #include static access_mode_t str_to_access_mode_freebsd(const char *psz_access_mode) { const access_mode_t default_access_mode = DEFAULT_FREEBSD_AM; if (NULL==psz_access_mode) return default_access_mode; if (!strcmp(psz_access_mode, "ioctl")) return _AM_IOCTL; else if (!strcmp(psz_access_mode, "CAM")) return _AM_CAM; else { cdio_warn ("unknown access type: %s. Default ioctl used.", psz_access_mode); return default_access_mode; } } static void _free_freebsd (void *obj) { _img_private_t *env = obj; if (NULL == env) return; if (NULL != env->device) free(env->device); if (_AM_CAM == env->access_mode) return free_freebsd_cam(env); else return cdio_generic_free(obj); } /* Check a drive to see if it is a CD-ROM Return 1 if a CD-ROM. 0 if it exists but isn't a CD-ROM drive and -1 if no device exists . */ static bool cdio_is_cdrom(char *drive, char *mnttype) { return cdio_is_cdrom_freebsd_ioctl(drive, mnttype); } /*! Reads nblocks of audio sectors from cd device into data starting from lsn. Returns 0 if no error. */ static int _read_audio_sectors_freebsd (void *user_data, void *data, lsn_t lsn, unsigned int nblocks) { return read_audio_sectors_freebsd_ioctl(user_data, data, lsn, nblocks); } /*! Reads a single mode2 sector from cd device into data starting from lsn. Returns 0 if no error. */ static int _read_mode2_sector_freebsd (void *user_data, void *data, lsn_t lsn, bool b_form2) { _img_private_t *env = user_data; if ( env->access_mode == _AM_CAM ) return read_mode2_sector_freebsd_cam(env, data, lsn, b_form2); else return read_mode2_sector_freebsd_ioctl(env, data, lsn, b_form2); } /*! Reads nblocks of mode2 sectors from cd device into data starting from lsn. Returns 0 if no error. */ static int _read_mode2_sectors_freebsd (void *user_data, void *data, lsn_t lsn, bool b_form2, unsigned int nblocks) { _img_private_t *env = user_data; if ( env->access_mode == _AM_CAM && b_form2) { /* We have a routine that covers this case without looping. */ return read_mode2_sectors_freebsd_cam(env, data, lsn, nblocks); } else { unsigned int i; unsigned int i_blocksize = b_form2 ? M2RAW_SECTOR_SIZE : CDIO_CD_FRAMESIZE; /* For each frame, pick out the data part we need */ for (i = 0; i < nblocks; i++) { int retval = _read_mode2_sector_freebsd (env, ((char *)data) + (i_blocksize * i), lsn + i, b_form2); if (retval) return retval; } } return 0; } /*! Return the size of the CD in logical block address (LBA) units. */ static uint32_t _stat_size_freebsd (void *obj) { _img_private_t *env = obj; if (NULL == env) return CDIO_INVALID_LBA; if (_AM_CAM == env->access_mode) return stat_size_freebsd_cam(env); else return stat_size_freebsd_ioctl(env); } /*! Set the key "arg" to "value" in source device. */ static int _set_arg_freebsd (void *user_data, const char key[], const char value[]) { _img_private_t *env = user_data; if (!strcmp (key, "source")) { if (!value) return -2; free (env->gen.source_name); env->gen.source_name = strdup (value); } else if (!strcmp (key, "access-mode")) { env->access_mode = str_to_access_mode_freebsd(value); if (env->access_mode == _AM_CAM && !env->b_cam_init) return init_freebsd_cam(env) ? 1 : -3; return 0; } else return -1; return 0; } /*! Read and cache the CD's Track Table of Contents and track info. Return false if unsuccessful; */ static bool read_toc_freebsd (void *p_user_data) { _img_private_t *p_env = p_user_data; track_t i, j; /* read TOC header */ if ( ioctl(p_env->gen.fd, CDIOREADTOCHEADER, &p_env->tochdr) == -1 ) { cdio_warn("error in ioctl(CDIOREADTOCHEADER): %s\n", strerror(errno)); return false; } p_env->gen.i_first_track = p_env->tochdr.starting_track; p_env->gen.i_tracks = p_env->tochdr.ending_track - p_env->gen.i_first_track + 1; j=0; for (i=p_env->gen.i_first_track; i<=p_env->gen.i_tracks; i++, j++) { p_env->tocent[j].track = i; p_env->tocent[j].address_format = CD_LBA_FORMAT; if ( ioctl(p_env->gen.fd, CDIOREADTOCENTRY, &(p_env->tocent[j]) ) ) { cdio_warn("%s %d: %s\n", "error in ioctl CDROMREADTOCENTRY for track", i, strerror(errno)); return false; } } p_env->tocent[j].track = CDIO_CDROM_LEADOUT_TRACK; p_env->tocent[j].address_format = CD_LBA_FORMAT; if ( ioctl(p_env->gen.fd, CDIOREADTOCENTRY, &(p_env->tocent[j]) ) ){ cdio_warn("%s: %s\n", "error in ioctl CDROMREADTOCENTRY for leadout track", strerror(errno)); return false; } p_env->gen.toc_init = true; return true; } /*! Eject media. Return 1 if successful, 0 otherwise. */ static int _eject_media_freebsd (void *user_data) { _img_private_t *p_env = user_data; return (p_env->access_mode == _AM_IOCTL) ? eject_media_freebsd_ioctl(p_env) : eject_media_freebsd_cam(p_env); } /*! Return the value associated with the key "arg". */ static const char * _get_arg_freebsd (void *user_data, const char key[]) { _img_private_t *env = user_data; if (!strcmp (key, "source")) { return env->gen.source_name; } else if (!strcmp (key, "access-mode")) { switch (env->access_mode) { case _AM_IOCTL: return "ioctl"; case _AM_CAM: return "CAM"; case _AM_NONE: return "no access method"; } } return NULL; } /*! Return the media catalog number MCN. Note: string is malloc'd so caller should free() then returned string when done with it. FIXME: This is just a guess. */ static char * _get_mcn_freebsd (const void *p_user_data) { const _img_private_t *p_env = p_user_data; return (p_env->access_mode == _AM_IOCTL) ? get_mcn_freebsd_ioctl(p_env) : scsi_mmc_get_mcn(p_env->gen.cdio); } static void get_drive_cap_freebsd (const void *p_user_data, cdio_drive_read_cap_t *p_read_cap, cdio_drive_write_cap_t *p_write_cap, cdio_drive_misc_cap_t *p_misc_cap) { const _img_private_t *p_env = p_user_data; if (p_env->access_mode == _AM_CAM) scsi_mmc_get_drive_cap_generic (p_user_data, p_read_cap, p_write_cap, p_misc_cap); } /*! Run a SCSI MMC command. p_user_data internal CD structure. i_timeout_ms time in milliseconds we will wait for the command to complete. If this value is -1, use the default time-out value. i_cdb Size of p_cdb p_cdb CDB bytes. e_direction direction the transfer is to go. i_buf Size of buffer p_buf Buffer for data, both sending and receiving Return 0 if no error. */ static int run_scsi_cmd_freebsd( const void *p_user_data, unsigned int i_timeout_ms, unsigned int i_cdb, const scsi_mmc_cdb_t *p_cdb, scsi_mmc_direction_t e_direction, unsigned int i_buf, /*in/out*/ void *p_buf ) { const _img_private_t *p_env = p_user_data; if (p_env->access_mode == _AM_CAM) return run_scsi_cmd_freebsd_cam( p_user_data, i_timeout_ms, i_cdb, p_cdb, e_direction, i_buf, p_buf ); else return 2; } /*! Get format of track. FIXME: We're just guessing this from the GNU/Linux code. */ static track_format_t _get_track_format_freebsd(void *p_user_data, track_t i_track) { _img_private_t *p_env = p_user_data; if (!p_env->gen.toc_init) read_toc_freebsd (p_user_data) ; if (i_track > TOTAL_TRACKS || i_track == 0) return TRACK_FORMAT_ERROR; i_track -= FIRST_TRACK_NUM; /* This is pretty much copied from the "badly broken" cdrom_count_tracks in linux/cdrom.c. */ if (p_env->tocent[i_track].entry.control & CDIO_CDROM_DATA_TRACK) { if (p_env->tocent[i_track].address_format == CDIO_CDROM_CDI_TRACK) return TRACK_FORMAT_CDI; else if (p_env->tocent[i_track].address_format == CDIO_CDROM_XA_TRACK) return TRACK_FORMAT_XA; else return TRACK_FORMAT_DATA; } else return TRACK_FORMAT_AUDIO; } /*! Return true if we have XA data (green, mode2 form1) or XA data (green, mode2 form2). That is track begins: sync - header - subheader 12 4 - 8 FIXME: there's gotta be a better design for this and get_track_format? */ static bool _get_track_green_freebsd(void *user_data, track_t i_track) { _img_private_t *p_env = user_data; if (i_track == CDIO_CDROM_LEADOUT_TRACK) i_track = TOTAL_TRACKS+1; if (i_track > TOTAL_TRACKS+1 || i_track == 0) return false; /* FIXME: Dunno if this is the right way, but it's what I was using in cdinfo for a while. */ return ((p_env->tocent[i_track-FIRST_TRACK_NUM].entry.control & 2) != 0); } /*! Return the starting LSN track number i_track in obj. Track numbers start at 1. The "leadout" track is specified either by using i_track LEADOUT_TRACK or the total tracks+1. CDIO_INVALID_LBA is returned if there is no track entry. */ static lba_t _get_track_lba_freebsd(void *user_data, track_t i_track) { _img_private_t *p_env = user_data; if (!p_env->gen.toc_init) read_toc_freebsd (p_env) ; if (i_track == CDIO_CDROM_LEADOUT_TRACK) i_track = TOTAL_TRACKS+1; if (i_track > TOTAL_TRACKS+1 || i_track == 0 || !p_env->gen.toc_init) { return CDIO_INVALID_LBA; } else { return cdio_lsn_to_lba(ntohl(p_env->tocent[i_track-FIRST_TRACK_NUM].entry.addr.lba)); } } #endif /* HAVE_FREEBSD_CDROM */ /*! Return an array of strings giving possible CD devices. */ char ** cdio_get_devices_freebsd (void) { #ifndef HAVE_FREEBSD_CDROM return NULL; #else char drive[40]; char **drives = NULL; unsigned int num_drives=0; bool exists=true; char c; /* Scan the system for CD-ROM drives. */ #ifdef USE_ETC_FSTAB struct fstab *fs; setfsent(); /* Check what's in /etc/fstab... */ while ( (fs = getfsent()) ) { if (strncmp(fs->fs_spec, "/dev/sr", 7)) cdio_add_device_list(&drives, fs->fs_spec, &num_drives); } #endif /* Scan the system for CD-ROM drives. Not always 100% reliable, so use the USE_MNTENT code above first. */ /* Scan SCSI and CAM devices */ for ( c='0'; exists && c <='9'; c++ ) { sprintf(drive, "/dev/cd%c%s", c, DEVICE_POSTFIX); exists = cdio_is_cdrom(drive, NULL); if ( exists ) { cdio_add_device_list(&drives, drive, &num_drives); } } /* Scan are ATAPI devices */ for ( c='0'; exists && c <='9'; c++ ) { sprintf(drive, "/dev/acd%c%s", c, DEVICE_POSTFIX); exists = cdio_is_cdrom(drive, NULL); if ( exists ) { cdio_add_device_list(&drives, drive, &num_drives); } } cdio_add_device_list(&drives, NULL, &num_drives); return drives; #endif /*HAVE_FREEBSD_CDROM*/ } /*! Return a string containing the default CD device if none is specified. */ char * cdio_get_default_device_freebsd() { #ifndef HAVE_FREEBSD_CDROM return NULL; #else char drive[40]; bool exists=true; char c; /* Scan the system for CD-ROM drives. */ #ifdef USE_ETC_FSTAB struct fstab *fs; setfsent(); /* Check what's in /etc/fstab... */ while ( (fs = getfsent()) ) { if (strncmp(fs->fs_spec, "/dev/sr", 7)) return strdup(fs->fs_spec); } #endif /* Scan the system for CD-ROM drives. Not always 100% reliable, so use the USE_MNTENT code above first. */ /* Scan SCSI and CAM devices */ for ( c='0'; exists && c <='9'; c++ ) { sprintf(drive, "/dev/cd%c%s", c, DEVICE_POSTFIX); exists = cdio_is_cdrom(drive, NULL); if ( exists ) { return strdup(drive); } } /* Scan are ATAPI devices */ for ( c='0'; exists && c <='9'; c++ ) { sprintf(drive, "/dev/acd%c%s", c, DEVICE_POSTFIX); exists = cdio_is_cdrom(drive, NULL); if ( exists ) { return strdup(drive); } } return NULL; #endif /*HAVE_FREEBSD_CDROM*/ } /*! Initialization routine. This is the only thing that doesn't get called via a function pointer. In fact *we* are the ones to set that up. */ CdIo * cdio_open_freebsd (const char *psz_source_name) { return cdio_open_am_freebsd(psz_source_name, NULL); } /*! Initialization routine. This is the only thing that doesn't get called via a function pointer. In fact *we* are the ones to set that up. */ CdIo * cdio_open_am_freebsd (const char *psz_orig_source_name, const char *psz_access_mode) { #ifdef HAVE_FREEBSD_CDROM CdIo *ret; _img_private_t *_data; char *psz_source_name; cdio_funcs _funcs = { .eject_media = _eject_media_freebsd, .free = _free_freebsd, .get_arg = _get_arg_freebsd, .get_cdtext = get_cdtext_generic, .get_default_device = cdio_get_default_device_freebsd, .get_devices = cdio_get_devices_freebsd, .get_discmode = get_discmode_generic, .get_drive_cap = get_drive_cap_freebsd, .get_first_track_num= get_first_track_num_generic, .get_mcn = _get_mcn_freebsd, .get_num_tracks = get_num_tracks_generic, .get_track_format = _get_track_format_freebsd, .get_track_green = _get_track_green_freebsd, .get_track_lba = _get_track_lba_freebsd, .get_track_msf = NULL, .lseek = cdio_generic_lseek, .read = cdio_generic_read, .read_audio_sectors = _read_audio_sectors_freebsd, .read_mode2_sector = _read_mode2_sector_freebsd, .read_mode2_sectors = _read_mode2_sectors_freebsd, .read_toc = read_toc_freebsd, .run_scsi_mmc_cmd = run_scsi_cmd_freebsd, .set_arg = _set_arg_freebsd, .stat_size = _stat_size_freebsd }; _data = _cdio_malloc (sizeof (_img_private_t)); _data->access_mode = str_to_access_mode_freebsd(psz_access_mode); _data->gen.init = false; _data->gen.fd = -1; _data->gen.toc_init = false; _data->gen.b_cdtext_init = false; _data->gen.b_cdtext_error = false; if (NULL == psz_orig_source_name) { psz_source_name=cdio_get_default_device_freebsd(); if (NULL == psz_source_name) return NULL; _data->device = psz_source_name; _set_arg_freebsd(_data, "source", psz_source_name); } else { if (cdio_is_device_generic(psz_orig_source_name)) { _set_arg_freebsd(_data, "source", psz_orig_source_name); _data->device = strdup(psz_orig_source_name); } else { /* The below would be okay if all device drivers worked this way. */ #if 0 cdio_info ("source %s is a not a device", psz_orig_source_name); #endif return NULL; } } ret = cdio_new ((void *)_data, &_funcs); if (ret == NULL) return NULL; if (cdio_generic_init(_data)) if ( _data->access_mode == _AM_IOCTL ) { return ret; } else { if (init_freebsd_cam(_data)) return ret; else { cdio_generic_free (_data); return NULL; } } else { cdio_generic_free (_data); return NULL; } #else return NULL; #endif /* HAVE_FREEBSD_CDROM */ } bool cdio_have_freebsd (void) { #ifdef HAVE_FREEBSD_CDROM return true; #else return false; #endif /* HAVE_FREEBSD_CDROM */ }