/* $Id: mmc.h,v 1.3 2005/02/07 17:09:31 rocky Exp $ Copyright (C) 2003, 2004, 2005 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 */ /*! * \file mmc.h * * \brief Common definitions for MMC (Multimedia Commands). Applications * include this for direct MMC access. */ #ifndef __CDIO_MMC_H__ #define __CDIO_MMC_H__ #include #include #include /*! \brief The opcode-portion (generic packet commands) of an MMC command. In general, those opcodes that end in 6 take a 6-byte command descriptor, those that end in 10 take a 10-byte descriptor and those that in in 12 take a 12-byte descriptor. (Not that you need to know that, but it seems to be a big deal in the MMC specification.) */ typedef enum { CDIO_MMC_GPCMD_INQUIRY = 0x12, /**< Request drive information. */ CDIO_MMC_GPCMD_MODE_SELECT_6 = 0x15, /**< Select medium (6 bytes). */ CDIO_MMC_GPCMD_MODE_SENSE_6 = 0x1a, /**< Get medium or device information. Should be issued before MODE SELECT to get mode support or save current settings. (6 bytes). */ CDIO_MMC_GPCMD_START_STOP = 0x1b, /**< Enable/disable Disc operations. (6 bytes). */ CDIO_MMC_GPCMD_ALLOW_MEDIUM_REMOVAL = 0x1e, /**< Enable/disable Disc removal. (6 bytes). */ /** Group 2 Commands (CDB's here are 10-bytes) */ CDIO_MMC_GPCMD_READ_10 = 0x28, /**< Read data from drive (10 bytes). */ CDIO_MMC_GPCMD_READ_SUBCHANNEL = 0x42, /**< Read Sub-Channel data. (10 bytes). */ CDIO_MMC_GPCMD_READ_TOC = 0x43, /**< READ TOC/PMA/ATIP. (10 bytes). */ CDIO_MMC_GPCMD_READ_HEADER = 0x44, CDIO_MMC_GPCMD_PLAY_AUDIO_10 = 0x45, /**< Begin audio playing at current position (10 bytes). */ CDIO_MMC_GPCMD_GET_CONFIGURATION = 0x46, /**< Get drive Capabilities (10 bytes) */ CDIO_MMC_GPCMD_PLAY_AUDIO_MSF = 0x47, /**< Begin audio playing at specified MSF (10 bytes). */ CDIO_MMC_GPCMD_PLAY_AUDIO_TI = 0x48, CDIO_MMC_GPCMD_PLAY_TRACK_REL_10 = 0x49, /**< Play audio at the track relative LBA. (10 bytes). Doesn't seem to be part of MMC standards but is handled by Plextor drives. */ CDIO_MMC_GPCMD_GET_EVENT_STATUS = 0x4a, /**< Report events and Status. */ CDIO_MMC_GPCMD_PAUSE_RESUME = 0x4b, /**< Stop or restart audio playback. (10 bytes). Used with a PLAY command. */ CDIO_MMC_GPCMD_READ_DISC_INFO = 0x51, /**< Get CD information. (10 bytes). */ CDIO_MMC_GPCMD_MODE_SELECT_10 = 0x55, /**< Select medium (10-bytes). */ CDIO_MMC_GPCMD_MODE_SENSE_10 = 0x5a, /**< Get medium or device information. Should be issued before MODE SELECT to get mode support or save current settings. (6 bytes). */ /** Group 5 Commands (CDB's here are 12-bytes) */ CDIO_MMC_GPCMD_PLAY_AUDIO_12 = 0xa5, /**< Begin audio playing at current position (12 bytes) */ CDIO_MMC_GPCMD_LOAD_UNLOAD = 0xa6, /**< Load/unload a Disc (12 bytes) */ CDIO_MMC_GPCMD_READ_12 = 0xa8, /**< Read data from drive (12 bytes). */ CDIO_MMC_GPCMD_PLAY_TRACK_REL_12 = 0xa9, /**< Play audio at the track relative LBA. (12 bytes). Doesn't seem to be part of MMC standards but is handled by Plextor drives. */ CDIO_MMC_GPCMD_READ_DVD_STRUCTURE = 0xad, /**< Get DVD structure info from media (12 bytes). */ CDIO_MMC_GPCMD_READ_MSF = 0xb9, /**< Read almost any field of a CD sector at specified MSF. (12 bytes). */ CDIO_MMC_GPCMD_SET_SPEED = 0xbb, /**< Set drive speed (12 bytes). This is listed as optional in ATAPI 2.6, but is (curiously) missing from Mt. Fuji, Table 57. It is mentioned in Mt. Fuji Table 377 as an MMC command for SCSI devices though... Most ATAPI drives support it. */ CDIO_MMC_GPCMD_READ_CD = 0xbe, /**< Read almost any field of a CD sector at current location. (12 bytes). */ /** Vendor-unique Commands */ CDIO_MMC_GPCMD_CD_PLAYBACK_STATUS = 0xc4 /**< SONY unique = command */, CDIO_MMC_GPCMD_PLAYBACK_CONTROL = 0xc9 /**< SONY unique = command */, CDIO_MMC_GPCMD_READ_CDDA = 0xd8 /**< Vendor unique = command */, CDIO_MMC_GPCMD_READ_CDXA = 0xdb /**< Vendor unique = command */, CDIO_MMC_GPCMD_READ_ALL_SUBCODES = 0xdf /**< Vendor unique = command */ } cdio_mmc_gpcmd_t; /*! Level values that can go into READ_CD */ #define CDIO_MMC_READ_TYPE_ANY 0 /**< All types */ #define CDIO_MMC_READ_TYPE_CDDA 1 /**< Only CD-DA sectors */ #define CDIO_MMC_READ_TYPE_MODE1 2 /**< mode1 sectors (user data = 2048) */ #define CDIO_MMC_READ_TYPE_MODE2 3 /**< mode2 sectors form1 or form2 */ #define CDIO_MMC_READ_TYPE_M2F1 4 /**< mode2 sectors form1 */ #define CDIO_MMC_READ_TYPE_M2F2 5 /**< mode2 sectors form2 */ /*! Format values for READ_TOC */ #define CDIO_MMC_READTOC_FMT_TOC 0 #define CDIO_MMC_READTOC_FMT_SESSION 1 #define CDIO_MMC_READTOC_FMT_FULTOC 2 #define CDIO_MMC_READTOC_FMT_PMA 3 /**< Q subcode data */ #define CDIO_MMC_READTOC_FMT_ATIP 4 /**< includes media type */ #define CDIO_MMC_READTOC_FMT_CDTEXT 5 /**< CD-TEXT info */ /*! Page codes for MODE SENSE and MODE SET. */ #define CDIO_MMC_R_W_ERROR_PAGE 0x01 #define CDIO_MMC_WRITE_PARMS_PAGE 0x05 #define CDIO_MMC_AUDIO_CTL_PAGE 0x0e #define CDIO_MMC_CDR_PARMS_PAGE 0x0d #define CDIO_MMC_POWER_PAGE 0x1a #define CDIO_MMC_FAULT_FAIL_PAGE 0x1c #define CDIO_MMC_TO_PROTECT_PAGE 0x1d #define CDIO_MMC_CAPABILITIES_PAGE 0x2a #define CDIO_MMC_ALL_PAGES 0x3f /*! Return type codes for GET_CONFIGURATION. */ #define CDIO_MMC_GET_CONF_ALL_FEATURES 0 /**< all features without regard to currency. */ #define CDIO_MMC_GET_CONF_CURRENT_FEATURES 1 /**< features which are currently in effect (e.g. based on medium inserted). */ #define CDIO_MMC_GET_CONF_NAMED_FEATURE 2 /**< just the feature named in the GET_CONFIGURATION cdb. */ /*! FEATURE codes used in GET CONFIGURATION. */ typedef enum { CDIO_MMC_FEATURE_PROFILE_LIST = 0x000, /**< Profile List Feature */ CDIO_MMC_FEATURE_CORE = 0x001, CDIO_MMC_FEATURE_MORPHING = 0x002, /**< Report/prevent operational changes */ CDIO_MMC_FEATURE_REMOVABLE_MEDIUM = 0x003, /**< Removable Medium Feature */ CDIO_MMC_FEATURE_WRITE_PROTECT = 0x004, /**< Write Protect Feature */ CDIO_MMC_FEATURE_RANDOM_READABLE = 0x010, /**< Random Readable Feature */ CDIO_MMC_FEATURE_MULTI_READ = 0x01D, /**< Multi-Read Feature */ CDIO_MMC_FEATURE_CD_READ = 0x01E, /**< CD Read Feature */ CDIO_MMC_FEATURE_DVD_READ = 0x01F, /**< DVD Read Feature */ CDIO_MMC_FEATURE_RANDOM_WRITABLE = 0x020, /**< Random Writable Feature */ CDIO_MMC_FEATURE_INCR_WRITE = 0x021, /**< Incremental Streaming Writable Feature */ CDIO_MMC_FEATURE_SECTOR_ERASE = 0x022, /**< Sector Erasable Feature */ CDIO_MMC_FEATURE_FORMATABLE = 0x023, /**< Formattable Feature */ CDIO_MMC_FEATURE_DEFECT_MGMT = 0x024, /**< Management Ability of the Logical Unit/media system to provide an apparently defect-free space.*/ CDIO_MMC_FEATURE_WRITE_ONCE = 0x025, /**< Write Once Feature */ CDIO_MMC_FEATURE_RESTRICT_OVERW = 0x026, /**< Restricted Overwrite Feature */ CDIO_MMC_FEATURE_CD_RW_CAV = 0x027, /**< CD-RW CAV Write Feature */ CDIO_MMC_FEATURE_MRW = 0x028, /**< MRW Feature */ CDIO_MMC_FEATURE_ENHANCED_DEFECT = 0x029, /**< Enhanced Defect Reporting */ CDIO_MMC_FEATURE_DVD_PRW = 0x02A, /**< DVD+RW Feature */ CDIO_MMC_FEATURE_DVD_PR = 0x02B, /**< DVD+R Feature */ CDIO_MMC_FEATURE_RIGID_RES_OVERW = 0x02C, /**< Rigid Restricted Overwrite */ CDIO_MMC_FEATURE_CD_TAO = 0x02D, /**< CD Track at Once */ CDIO_MMC_FEATURE_CD_SAO = 0x02E, /**< CD Mastering (Session at Once) */ CDIO_MMC_FEATURE_DVD_R_RW_WRITE = 0x02F, /**< DVD-R/RW Write */ CDIO_MMC_FEATURE_CD_RW_MEDIA_WRITE= 0x037, /**< CD-RW Media Write Support */ CDIO_MMC_FEATURE_DVD_PR_2_LAYER = 0x03B, /**< DVD+R Double Layer */ CDIO_MMC_FEATURE_POWER_MGMT = 0x100, /**< Initiator and device directed power management */ CDIO_MMC_FEATURE_CDDA_EXT_PLAY = 0x103, /**< Ability to play audio CDs via the Logical Unit's own analog output */ CDIO_MMC_FEATURE_MCODE_UPGRADE = 0x104, /* Ability for the device to accept new microcode via the interface */ CDIO_MMC_FEATURE_TIME_OUT = 0x105, /**< Ability to respond to all commands within a specific time */ CDIO_MMC_FEATURE_DVD_CSS = 0x106, /**< Ability to perform DVD CSS/CPPM authentication and RPC */ CDIO_MMC_FEATURE_RT_STREAMING = 0x107, /**< Ability to read and write using Initiator requested performance parameters */ CDIO_MMC_FEATURE_LU_SN = 0x108, /**< The Logical Unit has a unique identifier. */ CDIO_MMC_FEATURE_FIRMWARE_DATE = 0x1FF, /**< Firmware creation date report */ /*! Profile codes used in GET_CONFIGURATION - PROFILE LIST. */ CDIO_MMC_FEATURE_PROF_NON_REMOVABLE = 0x0001, /**< Re-writable disk, capable of changing behavior */ CDIO_MMC_FEATURE_PROF_REMOVABLE = 0x0002, /**< disk Re-writable; with removable media */ CDIO_MMC_FEATURE_PROF_MO_ERASABLE = 0x0003, /**< Erasable Magneto-Optical disk with sector erase capability */ CDIO_MMC_FEATURE_PROF_MO_WRITE_ONCE = 0x0004, /**< Write Once Magneto-Optical write once */ CDIO_MMC_FEATURE_PROF_AS_MO = 0x0005, /**< Advance Storage Magneto-Optical */ CDIO_MMC_FEATURE_PROF_CD_ROM = 0x0008, /**< Read only Compact Disc capable */ CDIO_MMC_FEATURE_PROF_CD_R = 0x0009, /**< Write once Compact Disc capable */ CDIO_MMC_FEATURE_PROF_CD_RW = 0x000A, /**< CD-RW Re-writable Compact Disc capable */ CDIO_MMC_FEATURE_PROF_DVD_ROM = 0x0010, /**< Read only DVD */ CDIO_MMC_FEATURE_PROF_DVD_R_SEQ = 0x0011, /**< Re-recordable DVD using Sequential recording */ CDIO_MMC_FEATURE_PROF_DVD_RAM = 0x0012, /**< Re-writable DVD */ CDIO_MMC_FEATURE_PROF_DVD_RW_RO = 0x0013, /**< Re-recordable DVD using Restricted Overwrite */ CDIO_MMC_FEATURE_PROF_DVD_RW_SEQ = 0x0014, /**< Re-recordable DVD using Sequential recording */ CDIO_MMC_FEATURE_PROF_DVD_PRW = 0x001A, /**< DVD+RW - DVD ReWritable */ CDIO_MMC_FEATURE_PROF_DVD_PR = 0x001B, /**< DVD+R - DVD Recordable */ CDIO_MMC_FEATURE_PROF_DDCD_ROM = 0x0020, /**< Read only DDCD */ CDIO_MMC_FEATURE_PROF_DDCD_R = 0x0021, /**< DDCD-R Write only DDCD */ CDIO_MMC_FEATURE_PROF_DDCD_RW = 0x0022, /**< Re-Write only DDCD */ CDIO_MMC_FEATURE_PROF_DVD_PR2 = 0x002B, /**< DVD+R - DVD Recordable double layer */ CDIO_MMC_FEATURE_PROF_NON_CONFORM = 0xFFFF, /**< The Logical Unit does not conform to any Profile. */ } mmc_feature_t; typedef enum { CDIO_MMC_FEATURE_INTERFACE_UNSPECIFIED = 0, CDIO_MMC_FEATURE_INTERFACE_SCSI = 1, CDIO_MMC_FEATURE_INTERFACE_ATAPI = 2, CDIO_MMC_FEATURE_INTERFACE_IEEE_1394 = 3, CDIO_MMC_FEATURE_INTERFACE_IEEE_1394A = 4, CDIO_MMC_FEATURE_INTERFACE_FIBRE_CH = 5 } mmc_feature_interface_t; /*! The largest Command Descriptor Buffer (CDB) size. The possible sizes are 6, 10, and 12 bytes. */ #define MAX_CDB_LEN 12 /*! \brief A Command Descriptor Buffer (CDB) used in sending MMC commands. */ typedef struct scsi_mmc_cdb { uint8_t field[MAX_CDB_LEN]; } scsi_mmc_cdb_t; /*! \brief Format of header block in data returned from an MMC GET_CONFIGURATION command. */ typedef struct scsi_mmc_feature_list_header { unsigned char length_msb; unsigned char length_1sb; unsigned char length_2sb; unsigned char length_lsb; unsigned char reserved1; unsigned char reserved2; unsigned char profile_msb; unsigned char profile_lsb; } scs_mmc_feature_list_header_t; /*! An enumeration indicating whether an MMC command is sending data or getting data. */ typedef enum scsi_mmc_direction { SCSI_MMC_DATA_READ, SCSI_MMC_DATA_WRITE } scsi_mmc_direction_t; #define CDIO_MMC_SET_COMMAND(cdb, command) \ cdb[0] = command #define CDIO_MMC_SET_READ_TYPE(cdb, sector_type) \ cdb[1] = (sector_type << 2) #define CDIO_MMC_GET_LEN16(p) \ (p[0]<<8) + p[1] #define CDIO_MMC_GET_LEN32(p) \ (p[0] << 24) + (p[1] << 16) + (p[2] << 8) + p[3]; #define CDIO_MMC_SET_LEN16(cdb, pos, len) \ cdb[pos ] = (len >> 8) & 0xff; \ cdb[pos+1] = (len ) & 0xff #define CDIO_MMC_SET_READ_LBA(cdb, lba) \ cdb[2] = (lba >> 24) & 0xff; \ cdb[3] = (lba >> 16) & 0xff; \ cdb[4] = (lba >> 8) & 0xff; \ cdb[5] = (lba ) & 0xff #define CDIO_MMC_SET_START_TRACK(cdb, command) \ cdb[6] = command #define CDIO_MMC_SET_READ_LENGTH24(cdb, len) \ cdb[6] = (len >> 16) & 0xff; \ cdb[7] = (len >> 8) & 0xff; \ cdb[8] = (len ) & 0xff #define CDIO_MMC_SET_READ_LENGTH16(cdb, len) \ CDIO_MMC_SET_LEN16(cdb, 7, len) #define CDIO_MMC_SET_READ_LENGTH8(cdb, len) \ cdb[8] = (len ) & 0xff #define CDIO_MMC_MCSB_ALL_HEADERS 0x78 #define CDIO_MMC_SET_MAIN_CHANNEL_SELECTION_BITS(cdb, val) \ cdb[9] = val; /*! * Eject using MMC commands. @return 0 if successful. */ int mmc_eject_media( const CdIo_t *p_cdio ); /*! Return the length in bytes of the Command Descriptor Buffer (CDB) for a given MMC command. The length will be either 6, 10, or 12. */ uint8_t mmc_get_cmd_len(uint8_t scsi_cmd); /*! Set the block size for subsequest read requests, via an MMC MODE_SENSE 6 command. */ int mmc_get_blocksize ( const CdIo_t *p_cdio ); /*! Get the lsn of the end of the CD @return the lsn. On error return CDIO_INVALID_LSN. */ lsn_t mmc_get_disc_last_lsn( const CdIo_t *p_cdio ); /*! Return the discmode as reported by the MMC Read (FULL) TOC command. Information was obtained from Section 5.1.13 (Read TOC/PMA/ATIP) pages 56-62 from the MMC draft specification, revision 10a at http://www.t10.org/ftp/t10/drafts/mmc/mmc-r10a.pdf See especially tables 72, 73 and 75. */ discmode_t mmc_get_discmode( const CdIo_t *p_cdio ); /*! Get drive capabilities for a device. @return the drive capabilities. */ void mmc_get_drive_cap (const CdIo_t *p_cdio, /*out*/ cdio_drive_read_cap_t *p_read_cap, /*out*/ cdio_drive_write_cap_t *p_write_cap, /*out*/ cdio_drive_misc_cap_t *p_misc_cap); /*! Get the DVD type associated with cd object. @return the DVD discmode. */ discmode_t mmc_get_dvd_struct_physical ( const CdIo_t *p_cdio, cdio_dvd_struct_t *s); /*! Get the CD-ROM hardware info via an MMC INQUIRY command. @return true if we were able to get hardware info, false if we had an error. */ bool mmc_get_hwinfo ( const CdIo_t *p_cdio, /* out*/ cdio_hwinfo_t *p_hw_info ); /*! Find out if media has changed since the last call. @param p_cdio the CD object to be acted upon. @return 1 if media has changed since last call, 0 if not. Error return codes are the same as driver_return_code_t */ int mmc_get_media_changed(const CdIo_t *p_cdio); /*! Get the media catalog number (MCN) from the CD via MMC. @return the media catalog number r NULL if there is none or we don't have the ability to get it. Note: string is malloc'd so caller has to free() the returned string when done with it. */ char * mmc_get_mcn ( const CdIo_t *p_cdio ); /*! Report if CD-ROM has a praticular kind of interface (ATAPI, SCSCI, ...) Is it possible for an interface to have serveral? If not this routine could probably return the sincle mmc_feature_interface_t. @return true if we have the interface and false if not. */ bool mmc_have_interface( const CdIo_t *p_cdio, mmc_feature_interface_t e_interface ); /*! Packet driver to read mode2 sectors. Can read only up to 25 blocks. */ int mmc_read_sectors ( const CdIo_t *p_cdio, void *p_buf, lba_t lba, int sector_type, unsigned int i_blocks); /*! Run an MMC command. @param p_cdio CD structure set by cdio_open(). @param i_timeout_ms time in milliseconds we will wait for the command to complete. @param p_cdb CDB bytes. All values that are needed should be set on input. We'll figure out what the right CDB length should be. @param e_direction direction the transfer is to go. @param i_buf Size of buffer @param p_buf Buffer for data, both sending and receiving. @return 0 if command completed successfully. */ int mmc_run_cmd( const CdIo_t *p_cdio, unsigned int i_timeout_ms, const scsi_mmc_cdb_t *p_cdb, scsi_mmc_direction_t e_direction, unsigned int i_buf, /*in/out*/ void *p_buf ); /*! Set the block size for subsequest read requests, via an MMC MODE_SELECT 6 command. */ int mmc_set_blocksize ( const CdIo_t *p_cdio, unsigned int i_bsize); /*! Set the drive speed. @return -1 if we had an error. is -2 returned if this is not implemented for the current driver. @see scsi_mmc_get_speed */ int mmc_set_speed( const CdIo_t *p_cdio, int i_speed ); /** For backward compatibility. */ #define scsi_mmc_get_cmd_len mmc_get_cmd_len #define scsi_mmc_run_cmd mmc_run_cmd #define scsi_mmc_eject_media mmc_eject_media #define scsi_mmc_get_disc_last_lsn mmc_get_disc_last_lsn #define scsi_mmc_get_discmode mmc_get_discmode #define scsi_mmc_get_drive_cap mmc_get_drive_cap #define scsi_mmc_get_dvd_struct_physical mmc_get_dvd_struct_physical #define scsi_mmc_get_hwinfo mmc_get_hwinfo #define scsi_mmc_get_mcn mmc_get_mcn #define scsi_mmc_read_sectors mmc_read_sectors #define scsi_mmc_set_blocksize mmc_set_blocksize #define scsi_mmc_get_blocksize mmc_get_blocksize #define scsi_mmc_set_speed mmc_set_speed #endif /* __SCSI_MMC_H__ */