sys/dev/ata/atapi-all.h

   1 /*-
   2  * Copyright (c) 1998,1999,2000 Søren Schmidt
   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  * 3. The name of the author may not be used to endorse or promote products
  15  *    derived from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  *
  28  * $FreeBSD$
  29  */
  30
  31 /* ATAPI misc defines */
  32 #define ATAPI_MAGIC_LSB                 0x14
  33 #define ATAPI_MAGIC_MSB                 0xeb
  34 #define ATAPI_P_READ                    (ATA_S_DRQ | ATA_I_IN)
  35 #define ATAPI_P_WRITE                   (ATA_S_DRQ)
  36 #define ATAPI_P_CMDOUT                  (ATA_S_DRQ | ATA_I_CMD)
  37 #define ATAPI_P_DONEDRQ                 (ATA_S_DRQ | ATA_I_CMD | ATA_I_IN)
  38 #define ATAPI_P_DONE                    (ATA_I_CMD | ATA_I_IN)
  39 #define ATAPI_P_ABORT                   0
  40
  41 /* error register bits */
  42 #define ATAPI_E_MASK                    0x0f    /* error mask */
  43 #define ATAPI_E_ILI                     0x01    /* illegal length indication */
  44 #define ATAPI_E_EOM                     0x02    /* end of media detected */
  45 #define ATAPI_E_ABRT                    0x04    /* command aborted */
  46 #define ATAPI_E_MCR                     0x08    /* media change requested */
  47 #define ATAPI_SK_MASK                   0xf0    /* sense key mask */
  48 #define ATAPI_SK_NO_SENSE               0x00    /* no specific sense key info */
  49 #define ATAPI_SK_RECOVERED_ERROR        0x10    /* command OK, data recovered */
  50 #define ATAPI_SK_NOT_READY              0x20    /* no access to drive */
  51 #define ATAPI_SK_MEDIUM_ERROR           0x30    /* non-recovered data error */
  52 #define ATAPI_SK_HARDWARE_ERROR         0x40    /* non-recoverable HW failure */
  53 #define ATAPI_SK_ILLEGAL_REQUEST        0x50    /* invalid command param(s) */
  54 #define ATAPI_SK_UNIT_ATTENTION         0x60    /* media changed */
  55 #define ATAPI_SK_DATA_PROTECT           0x70    /* write protect */
  56 #define ATAPI_SK_BLANK_CHECK            0x80    /* blank check */
  57 #define ATAPI_SK_VENDOR_SPECIFIC        0x90    /* vendor specific skey */
  58 #define ATAPI_SK_COPY_ABORTED           0xa0    /* copy aborted */
  59 #define ATAPI_SK_ABORTED_COMMAND        0xb0    /* command aborted, try again */
  60 #define ATAPI_SK_EQUAL                  0xc0    /* equal */
  61 #define ATAPI_SK_VOLUME_OVERFLOW        0xd0    /* volume overflow */
  62 #define ATAPI_SK_MISCOMPARE             0xe0    /* data dont match the medium */
  63 #define ATAPI_SK_RESERVED               0xf0
  64
  65 /* ATAPI commands */
  66 #define ATAPI_TEST_UNIT_READY           0x00    /* check if device is ready */
  67 #define ATAPI_REWIND                    0x01    /* rewind */
  68 #define ATAPI_REQUEST_SENSE             0x03    /* get sense data */
  69 #define ATAPI_READ                      0x08    /* read data */
  70 #define ATAPI_WRITE                     0x0a    /* write data */
  71 #define ATAPI_WEOF                      0x10    /* write filemark */
  72 #define     WF_WRITE                            0x01
  73 #define ATAPI_SPACE                     0x11    /* space command */
  74 #define     SP_FM                               0x01
  75 #define     SP_EOD                              0x03
  76 #define ATAPI_MODE_SELECT               0x15    /* mode select */
  77 #define ATAPI_ERASE                     0x19    /* erase */
  78 #define ATAPI_MODE_SENSE                0x1a    /* mode sense */
  79 #define ATAPI_START_STOP                0x1b    /* start/stop unit */
  80 #define     SS_LOAD                             0x01
  81 #define     SS_RETENSION                        0x02
  82 #define     SS_EJECT                            0x04
  83 #define ATAPI_PREVENT_ALLOW             0x1e    /* media removal */
  84 #define ATAPI_READ_CAPACITY             0x25    /* get volume capacity */
  85 #define ATAPI_READ_BIG                  0x28    /* read data */
  86 #define ATAPI_WRITE_BIG                 0x2a    /* write data */
  87 #define ATAPI_LOCATE                    0x2b    /* locate to position */
  88 #define ATAPI_READ_POSITION             0x34    /* read position */
  89 #define ATAPI_SYNCHRONIZE_CACHE         0x35    /* flush buf, close channel */
  90 #define ATAPI_WRITE_BUFFER              0x3b    /* write device buffer */
  91 #define ATAPI_READ_BUFFER               0x3c    /* read device buffer */
  92 #define ATAPI_READ_SUBCHANNEL           0x42    /* get subchannel info */
  93 #define ATAPI_READ_TOC                  0x43    /* get table of contents */
  94 #define ATAPI_PLAY_MSF                  0x47    /* play by MSF address */
  95 #define ATAPI_PLAY_TRACK                0x48    /* play by track number */
  96 #define ATAPI_PAUSE                     0x4b    /* pause audio operation */
  97 #define ATAPI_READ_TRACK_INFO           0x52    /* get track info structure */
  98 #define ATAPI_MODE_SELECT_BIG           0x55    /* set device parameters */
  99 #define ATAPI_MODE_SENSE_BIG            0x5a    /* get device parameters */
 100 #define ATAPI_CLOSE_TRACK               0x5b    /* close track/session */
 101 #define ATAPI_BLANK                     0xa1    /* blank the media */
 102 #define ATAPI_SEND_KEY                  0xa3
 103 #define ATAPI_REPORT_KEY                0xa4
 104 #define ATAPI_PLAY_BIG                  0xa5    /* play by lba */
 105 #define ATAPI_LOAD_UNLOAD               0xa6    /* changer control command */
 106 #define ATAPI_READ_STRUCTURE            0xad
 107 #define ATAPI_PLAY_CD                   0xb4    /* universal play command */
 108 #define ATAPI_SET_SPEED                 0xbb    /* set drive speed */
 109 #define ATAPI_MECH_STATUS               0xbd    /* get changer status */
 110 #define ATAPI_READ_CD                   0xbe    /* read data */
 111
 112 /* ATAPI device parameter information */
 113 struct atapi_params {
 114     u_int8_t    cmdsize         :2;             /* packet command size */
 115 #define         ATAPI_PSIZE_12          0       /* 12 bytes */
 116 #define         ATAPI_PSIZE_16          1       /* 16 bytes */
 117
 118     u_int8_t                    :3;
 119     u_int8_t    drqtype         :2;             /* DRQ type */
 120 #define         ATAPI_DRQT_MPROC        0       /* cpu    3 ms delay */
 121 #define         ATAPI_DRQT_INTR         1       /* intr  10 ms delay */
 122 #define         ATAPI_DRQT_ACCEL        2       /* accel 50 us delay */
 123
 124     u_int8_t    removable       :1;             /* device is removable */
 125     u_int8_t    device_type     :5;             /* device type */
 126 #define         ATAPI_TYPE_DIRECT       0       /* disk/floppy */
 127 #define         ATAPI_TYPE_TAPE         1       /* streaming tape */
 128 #define         ATAPI_TYPE_CDROM        5       /* CD-ROM device */
 129 #define         ATAPI_TYPE_OPTICAL      7       /* optical disk */
 130
 131     u_int8_t                    :1;
 132     u_int8_t    proto           :2;             /* command protocol */
 133 #define         ATAPI_PROTO_ATAPI       2
 134
 135     int16_t     reserved1;
 136     int16_t     reserved2;
 137     int16_t     reserved3;
 138     int16_t     reserved4;
 139     int16_t     reserved5;
 140     int16_t     reserved6;
 141     int16_t     reserved7;
 142     int16_t     reserved8;
 143     int16_t     reserved9;
 144     int8_t      serial[20];                     /* serial number */
 145     int16_t     reserved20;
 146     int16_t     reserved21;
 147     int16_t     reserved22;
 148     int8_t      revision[8];                    /* firmware revision */
 149     int8_t      model[40];                      /* model name */
 150     int16_t     reserved47;
 151     int16_t     reserved48;
 152
 153     u_int8_t    vendorcap;                      /* vendor capabilities */
 154     u_int8_t    dmaflag         :1;             /* DMA supported */
 155     u_int8_t    lbaflag         :1;             /* LBA supported - always 1 */
 156     u_int8_t    iordydis        :1;             /* IORDY can be disabled */
 157     u_int8_t    iordyflag       :1;             /* IORDY supported */
 158     u_int8_t                    :1;
 159     u_int8_t    ovlapflag       :1;             /* overlap supported */
 160     u_int8_t                    :1;
 161     u_int8_t    idmaflag        :1;             /* interleaved DMA supported */
 162     int16_t     capvalidate;                    /* validation for above */
 163
 164     u_int16_t   piotiming;                      /* PIO cycle timing */
 165     u_int16_t   dmatiming;                      /* DMA cycle timing */
 166
 167     u_int16_t   atavalid;                       /* fields valid */
 168 #define         ATAPI_FLAG_54_58        1       /* words 54-58 valid */
 169 #define         ATAPI_FLAG_64_70        2       /* words 64-70 valid */
 170
 171     int16_t     reserved54[8];
 172
 173     int16_t     sdmamodes;                      /* singleword DMA modes */
 174     int16_t     wdmamodes;                      /* multiword DMA modes */
 175     int16_t     apiomodes;                      /* advanced PIO modes */
 176
 177     u_int16_t   mwdmamin;                       /* min. M/W DMA time/word ns */
 178     u_int16_t   mwdmarec;                       /* rec. M/W DMA time ns */
 179     u_int16_t   pioblind;                       /* min. PIO cycle w/o flow */
 180     u_int16_t   pioiordy;                       /* min. PIO cycle IORDY flow */
 181
 182     int16_t     reserved69;
 183     int16_t     reserved70;
 184     u_int16_t   rlsovlap;                       /* rel time (us) for overlap */
 185     u_int16_t   rlsservice;                     /* rel time (us) for service */
 186     int16_t     reserved73;
 187     int16_t     reserved74;
 188     int16_t     queuelen;
 189     int16_t     reserved76;
 190     int16_t     reserved77;
 191     int16_t     reserved78;
 192     int16_t     reserved79;
 193     int16_t     versmajor;
 194     int16_t     versminor;
 195     int16_t     featsupp1;
 196     int16_t     featsupp2;
 197     int16_t     featsupp3;
 198     int16_t     featenab1;
 199     int16_t     featenab2;
 200     int16_t     featenab3;
 201     int16_t     udmamodes;                      /* UltraDMA modes */
 202     int16_t     erasetime;
 203     int16_t     enherasetime;
 204     int16_t     apmlevel;
 205     int16_t     reserved92[34];
 206     int16_t     rmvcap;
 207     int16_t     securelevel;
 208 };
 209
 210 /* ATAPI request sense structure */
 211 struct atapi_reqsense {
 212     u_int8_t    error_code      :7;             /* current or deferred errors */
 213     u_int8_t    valid           :1;             /* follows ATAPI spec */
 214     u_int8_t    segment;                        /* Segment number */
 215     u_int8_t    sense_key       :4;             /* sense key */
 216     u_int8_t    reserved2_4     :1;             /* reserved */
 217     u_int8_t    ili             :1;             /* incorrect length indicator */
 218     u_int8_t    eom             :1;             /* end of medium */
 219     u_int8_t    filemark        :1;             /* filemark */
 220                                                 /* cmd information */
 221     u_int32_t   cmd_info __attribute__((packed));
 222     u_int8_t    sense_length;                   /* additional sense len (n-7) */
 223                                                 /* additional cmd spec info */
 224     u_int32_t   cmd_specific_info __attribute__((packed));
 225     u_int8_t    asc;                            /* additional sense code */
 226     u_int8_t    ascq;                           /* additional sense code qual */
 227     u_int8_t    replaceable_unit_code;          /* replaceable unit code */
 228     u_int8_t    sk_specific1    :7;             /* sense key specific */
 229     u_int8_t    sksv            :1;             /* sense key specific info OK */
 230     u_int8_t    sk_specific2;                   /* sense key specific */
 231     u_int8_t    sk_specific3;                   /* sense key specific */
 232 };
 233
 234 struct atapi_softc {
 235     struct ata_softc            *controller;    /* ptr to parent ctrl */
 236     struct atapi_params         *atapi_parm;    /* ata device params */
 237     int32_t                     unit;           /* ATA_MASTER or ATA_SLAVE */
 238     int8_t                      *devname;       /* this devices name */
 239     int8_t                      cmd;            /* last cmd executed */
 240     u_int32_t                   flags;          /* drive flags */
 241 #define         ATAPI_F_DMA_ENABLED     0x0001
 242 #define         ATAPI_F_DMA_USED        0x0002
 243 #define         ATAPI_F_DSC_USED        0x0004
 244 #define         ATAPI_F_MEDIA_CHANGED   0x0008
 245
 246 };
 247
 248 typedef int32_t atapi_callback_t(struct atapi_request *);
 249
 250 struct atapi_request {
 251     struct atapi_softc          *device;        /* ptr to parent device */
 252     void                        *driver;        /* ptr to calling driver */
 253     u_int8_t                    ccb[16];        /* command control block */
 254     int32_t                     ccbsize;        /* size of ccb (12 | 16) */
 255     u_int32_t                   bytecount;      /* bytes to transfer */
 256     int32_t                     timeout;        /* timeout for this cmd */
 257     struct callout_handle       timeout_handle; /* handle for untimeout */
 258     int32_t                     retries;        /* retry count */
 259     int32_t                     result;         /* result of this cmd */
 260     int32_t                     error;          /* result translated to errno */
 261     struct atapi_reqsense       sense;          /* sense data if error */
 262     int32_t                     flags;
 263 #define         A_READ                  0x0001
 264
 265     int8_t                      *data;          /* pointer to data buf */
 266     struct buf                  *bp;            /* associated buf ptr */
 267     atapi_callback_t            *callback;      /* ptr to callback func */
 268     TAILQ_ENTRY(atapi_request)  chain;          /* list management */
 269 };
 270
 271 void atapi_transfer(struct atapi_request *);
 272 int32_t atapi_interrupt(struct atapi_request *);
 273 int32_t atapi_queue_cmd(struct atapi_softc *, int8_t [], void *, int32_t, int32_t, int32_t,  atapi_callback_t, void *, struct buf *);
 274 void atapi_reinit(struct atapi_softc *);
 275 int32_t atapi_test_ready(struct atapi_softc *);
 276 int32_t atapi_wait_ready(struct atapi_softc *, int32_t);
 277 void atapi_request_sense(struct atapi_softc *, struct atapi_reqsense *);
 278 void atapi_dump(int8_t *, void *, int32_t);
 279