sys/dev/disk/nata/atapi-cd.h

   1 /*-
   2  * Copyright (c) 1998 - 2008 Søren Schmidt <sos@FreeBSD.org>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer,
  10  *    without modification, immediately at the beginning of the file.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  *
  26  * $FreeBSD: src/sys/dev/ata/atapi-cd.h,v 1.45 2006/01/05 21:27:19 sos Exp $
  27  */
  28
  29 #include <sys/param.h>
  30 #include <sys/cdio.h>
  31 #include <sys/devicestat.h>
  32
  33 /* CDROM Table Of Contents */
  34 #define MAXTRK 99
  35 struct toc {
  36     struct ioc_toc_header       hdr;
  37     struct cd_toc_entry         tab[MAXTRK + 1];
  38 };
  39
  40 /* DVD CSS authentication */
  41 struct dvd_miscauth {
  42     u_int16_t   length;
  43     u_int16_t   reserved;
  44     u_int8_t    data[2048];
  45 };
  46
  47 /* CDROM Audio Control Parameters Page */
  48 struct audiopage {
  49     /* mode page data header */
  50     u_int16_t   data_length;
  51     u_int8_t    medium_type;
  52     u_int8_t    dev_spec;
  53     u_int8_t    unused[2];
  54     u_int16_t   blk_desc_len;
  55
  56     /* audio control page */
  57     u_int8_t    page_code;
  58 #define ATAPI_CDROM_AUDIO_PAGE      0x0e
  59 #define ATAPI_CDROM_AUDIO_PAGE_MASK 0x4e
  60
  61     u_int8_t    param_len;
  62     u_int8_t    flags;
  63 #define CD_PA_SOTC      0x02
  64 #define CD_PA_IMMED     0x04
  65
  66     u_int8_t    reserved3;
  67     u_int8_t    reserved4;
  68     u_int8_t    reserved5;
  69     u_int16_t   lb_per_sec;
  70     struct port_control {
  71         u_int8_t        channels:4;
  72 #define CHANNEL_0       1
  73 #define CHANNEL_1       2
  74 #define CHANNEL_2       4
  75 #define CHANNEL_3       8
  76
  77         u_int8_t        volume;
  78     } port[4];
  79 };
  80
  81
  82 /* CDROM Capabilities and Mechanical Status Page */
  83 struct cappage {
  84     /* mode page data header */
  85     u_int16_t   data_length;
  86     u_int8_t    medium_type;
  87 #define MST_TYPE_MASK_LOW       0x0f
  88 #define MST_FMT_NONE            0x00
  89 #define MST_DATA_120            0x01
  90 #define MST_AUDIO_120           0x02
  91 #define MST_COMB_120            0x03
  92 #define MST_PHOTO_120           0x04
  93 #define MST_DATA_80             0x05
  94 #define MST_AUDIO_80            0x06
  95 #define MST_COMB_80             0x07
  96 #define MST_PHOTO_80            0x08
  97
  98 #define MST_TYPE_MASK_HIGH      0x70
  99 #define MST_CDROM               0x00
 100 #define MST_CDR                 0x10
 101 #define MST_CDRW                0x20
 102 #define MST_DVD                 0x40
 103
 104 #define MST_NO_DISC             0x70
 105 #define MST_DOOR_OPEN           0x71
 106 #define MST_FMT_ERROR           0x72
 107
 108     u_int8_t    dev_spec;
 109     u_int16_t   unused;
 110     u_int16_t   blk_desc_len;
 111
 112     /* capabilities page */
 113     u_int8_t    page_code;
 114 #define ATAPI_CDROM_CAP_PAGE    0x2a
 115
 116     u_int8_t    param_len;
 117
 118     u_int16_t   media;
 119 #define MST_READ_CDR            0x0001
 120 #define MST_READ_CDRW           0x0002
 121 #define MST_READ_PACKET         0x0004
 122 #define MST_READ_DVDROM         0x0008
 123 #define MST_READ_DVDR           0x0010
 124 #define MST_READ_DVDRAM         0x0020
 125 #define MST_WRITE_CDR           0x0100
 126 #define MST_WRITE_CDRW          0x0200
 127 #define MST_WRITE_TEST          0x0400
 128 #define MST_WRITE_DVDR          0x1000
 129 #define MST_WRITE_DVDRAM        0x2000
 130
 131     u_int16_t   capabilities;
 132 #define MST_AUDIO_PLAY          0x0001
 133 #define MST_COMPOSITE           0x0002
 134 #define MST_AUDIO_P1            0x0004
 135 #define MST_AUDIO_P2            0x0008
 136 #define MST_MODE2_f1            0x0010
 137 #define MST_MODE2_f2            0x0020
 138 #define MST_MULTISESSION        0x0040
 139 #define MST_BURNPROOF           0x0080
 140 #define MST_READ_CDDA           0x0100
 141 #define MST_CDDA_STREAM         0x0200
 142 #define MST_COMBINED_RW         0x0400
 143 #define MST_CORRECTED_RW        0x0800
 144 #define MST_SUPPORT_C2          0x1000
 145 #define MST_ISRC                0x2000
 146 #define MST_UPC                 0x4000
 147
 148     u_int8_t    mechanism;
 149 #define MST_LOCKABLE            0x01
 150 #define MST_LOCKED              0x02
 151 #define MST_PREVENT             0x04
 152 #define MST_EJECT               0x08
 153 #define MST_MECH_MASK           0xe0
 154 #define MST_MECH_CADDY          0x00
 155 #define MST_MECH_TRAY           0x20
 156 #define MST_MECH_POPUP          0x40
 157 #define MST_MECH_CHANGER        0x80
 158 #define MST_MECH_CARTRIDGE      0xa0
 159
 160     uint8_t     audio;
 161 #define MST_SEP_VOL             0x01
 162 #define MST_SEP_MUTE            0x02
 163
 164     u_int16_t   max_read_speed;         /* max raw data rate in bytes/1000 */
 165     u_int16_t   max_vol_levels;         /* number of discrete volume levels */
 166     u_int16_t   buf_size;               /* internal buffer size in bytes/1024 */
 167     u_int16_t   cur_read_speed;         /* current data rate in bytes/1000  */
 168
 169     u_int8_t    reserved3;
 170     u_int8_t    misc;
 171
 172     u_int16_t   max_write_speed;        /* max raw data rate in bytes/1000 */
 173     u_int16_t   cur_write_speed;        /* current data rate in bytes/1000  */
 174     u_int16_t   copy_protect_rev;
 175     u_int16_t   reserved4;
 176 };
 177
 178 /* CDROM Write Parameters Mode Page (Burners ONLY) */
 179 struct write_param {
 180     /* mode page data header */
 181     u_int16_t   data_length;
 182     u_int8_t    medium_type;
 183     u_int8_t    dev_spec;
 184     u_int8_t    unused[2];
 185     u_int16_t   blk_desc_len;
 186
 187     /* write parameters page */
 188     u_int8_t    page_code;
 189 #define ATAPI_CDROM_WRITE_PARAMETERS_PAGE      0x05
 190
 191     u_int8_t    page_length;            /* 0x32 */
 192     u_int8_t    write_type      :4;     /* write stream type */
 193 #define CDR_WTYPE_PACKET        0x00
 194 #define CDR_WTYPE_TRACK         0x01
 195 #define CDR_WTYPE_SESSION       0x02
 196 #define CDR_WTYPE_RAW           0x03
 197
 198     u_int8_t    test_write      :1;     /* test write enable */
 199     u_int8_t    link_size_valid :1;
 200     u_int8_t    burnproof       :1;     /* BurnProof enable */
 201     u_int8_t    reserved2_7     :1;
 202     u_int8_t    track_mode      :4;     /* track mode */
 203 #define CDR_TMODE_AUDIO         0x00
 204 #define CDR_TMODE_AUDIO_PREEMP  0x01
 205 #define CDR_TMODE_ALLOW_COPY    0x02
 206 #define CDR_TMODE_DATA          0x04
 207 #define CDR_TMODE_QUAD_AUDIO    0x08
 208
 209     u_int8_t    copy            :1;     /* generation stamp */
 210     u_int8_t    fp              :1;     /* fixed packet type */
 211     u_int8_t    session_type    :2;     /* session type */
 212 #define CDR_SESS_NONE           0x00
 213 #define CDR_SESS_FINAL          0x01
 214 #define CDR_SESS_RESERVED       0x02
 215 #define CDR_SESS_MULTI          0x03
 216
 217     u_int8_t    datablock_type  :4;     /* data type code (see cdrio.h) */
 218     u_int8_t    reserved4_4567  :4;
 219     u_int8_t    link_size;
 220     u_int8_t    reserved6;
 221     u_int8_t    host_app_code   :6;     /* host application code */
 222     u_int8_t    reserved7_67    :2;
 223     u_int8_t    session_format;         /* session format */
 224 #define CDR_SESS_CDROM          0x00
 225 #define CDR_SESS_CDI            0x10
 226 #define CDR_SESS_CDROM_XA       0x20
 227
 228     u_int8_t    reserved9;
 229     u_int32_t   packet_size;            /* packet size in bytes */
 230     u_int16_t   audio_pause_length;     /* audio pause length in secs */
 231     u_int8_t    media_catalog_number[16];
 232     u_int8_t    isr_code[16];
 233     u_int8_t    sub_hdr_byte0;
 234     u_int8_t    sub_hdr_byte1;
 235     u_int8_t    sub_hdr_byte2;
 236     u_int8_t    sub_hdr_byte3;
 237     u_int8_t    vendor_specific_byte0;
 238     u_int8_t    vendor_specific_byte1;
 239     u_int8_t    vendor_specific_byte2;
 240     u_int8_t    vendor_specific_byte3;
 241 } __packed;
 242
 243 /* CDROM Read Track Information structure */
 244 struct acd_track_info {
 245     u_int16_t   data_length;
 246     u_int8_t    track_number;           /* current track number */
 247     u_int8_t    session_number;         /* current session number */
 248     u_int8_t    reserved4;
 249     u_int8_t    track_mode      :4;     /* mode of this track */
 250     u_int8_t    copy            :1;     /* generation stamp */
 251     u_int8_t    damage          :1;     /* damaged track */
 252     u_int8_t    reserved5_67    :2;
 253     u_int8_t    data_mode       :4;     /* data mode of this disc */
 254     u_int8_t    fp              :1;     /* fixed packet */
 255     u_int8_t    packet          :1;     /* packet track */
 256     u_int8_t    blank           :1;     /* blank (empty) track */
 257     u_int8_t    rt              :1;     /* reserved track */
 258     u_int8_t    nwa_valid       :1;     /* next_writeable_addr field valid */
 259     u_int8_t    reserved7_17    :7;
 260     u_int       track_start_addr;       /* start of this track */
 261     u_int       next_writeable_addr;    /* next writeable addr on this disc */
 262     u_int       free_blocks;            /* free block on this disc */
 263     u_int       fixed_packet_size;      /* size of packets on this track */
 264     u_int       track_length;           /* length of this track */
 265 };
 266
 267 /* Structure holding tracknode data for track devices */
 268 struct acd_tracknode {
 269     cdev_t                      cdev;           /* track device node */
 270 };
 271
 272 /* Structure describing an ATAPI CDROM device */
 273 struct acd_softc {
 274     int                         flags;          /* device state flags */
 275 #define         F_LOCKED                0x0001  /* this unit is locked */
 276
 277     struct toc                  toc;            /* table of disc contents */
 278     struct audiopage            au;             /* audio page info */
 279     struct audiopage            aumask;         /* audio page mask */
 280     struct cappage              cap;            /* capabilities page info */
 281     struct cd_sub_channel_info  subchan;        /* subchannel info */
 282     int                         slot;           /* this instance slot number */
 283     time_t                      timestamp;      /* this instance timestamp */
 284     u_int32_t                   disk_size;      /* size of current media */
 285     u_int32_t                   block_size;     /* blocksize currently used */
 286     u_int32_t                   iomax;          /* Max I/O request (bytes) */
 287     struct disk                 disk;           /* disk management */
 288     struct devstat              stats;          /* devstat entry */
 289     cdev_t                      cdev;           /* device placeholder */
 290     struct acd_tracknode        *track[MAXTRK+1];       /* tracks */
 291 };