include/linux/ata.h

   1
   2 /*
   3  *  Copyright 2003-2004 Red Hat, Inc.  All rights reserved.
   4  *  Copyright 2003-2004 Jeff Garzik
   5  *
   6  *
   7  *  This program is free software; you can redistribute it and/or modify
   8  *  it under the terms of the GNU General Public License as published by
   9  *  the Free Software Foundation; either version 2, or (at your option)
  10  *  any later version.
  11  *
  12  *  This program is distributed in the hope that it will be useful,
  13  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  *  GNU General Public License for more details.
  16  *
  17  *  You should have received a copy of the GNU General Public License
  18  *  along with this program; see the file COPYING.  If not, write to
  19  *  the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  20  *
  21  *
  22  *  libata documentation is available via 'make {ps|pdf}docs',
  23  *  as Documentation/DocBook/libata.*
  24  *
  25  *  Hardware documentation available from http://www.t13.org/
  26  *
  27  */
  28
  29 #ifndef __LINUX_ATA_H__
  30 #define __LINUX_ATA_H__
  31
  32 #include <linux/types.h>
  33
  34 /* defines only for the constants which don't work well as enums */
  35 #define ATA_DMA_BOUNDARY        0xffffUL
  36 #define ATA_DMA_MASK            0xffffffffULL
  37
  38 enum {
  39         /* various global constants */
  40         ATA_MAX_DEVICES         = 2,    /* per bus/port */
  41         ATA_MAX_PRD             = 256,  /* we could make these 256/256 */
  42         ATA_SECT_SIZE           = 512,
  43         ATA_MAX_SECTORS_128     = 128,
  44         ATA_MAX_SECTORS         = 256,
  45         ATA_MAX_SECTORS_LBA48   = 65535,/* TODO: 65536? */
  46
  47         ATA_ID_WORDS            = 256,
  48         ATA_ID_SERNO            = 10,
  49         ATA_ID_FW_REV           = 23,
  50         ATA_ID_PROD             = 27,
  51         ATA_ID_OLD_PIO_MODES    = 51,
  52         ATA_ID_FIELD_VALID      = 53,
  53         ATA_ID_MWDMA_MODES      = 63,
  54         ATA_ID_PIO_MODES        = 64,
  55         ATA_ID_EIDE_DMA_MIN     = 65,
  56         ATA_ID_EIDE_PIO         = 67,
  57         ATA_ID_EIDE_PIO_IORDY   = 68,
  58         ATA_ID_UDMA_MODES       = 88,
  59         ATA_ID_MAJOR_VER        = 80,
  60         ATA_ID_PIO4             = (1 << 1),
  61
  62         ATA_ID_SERNO_LEN        = 20,
  63         ATA_ID_FW_REV_LEN       = 8,
  64         ATA_ID_PROD_LEN         = 40,
  65
  66         ATA_PCI_CTL_OFS         = 2,
  67
  68         ATA_PIO0                = (1 << 0),
  69         ATA_PIO1                = ATA_PIO0 | (1 << 1),
  70         ATA_PIO2                = ATA_PIO1 | (1 << 2),
  71         ATA_PIO3                = ATA_PIO2 | (1 << 3),
  72         ATA_PIO4                = ATA_PIO3 | (1 << 4),
  73         ATA_PIO5                = ATA_PIO4 | (1 << 5),
  74         ATA_PIO6                = ATA_PIO5 | (1 << 6),
  75
  76         ATA_UDMA0               = (1 << 0),
  77         ATA_UDMA1               = ATA_UDMA0 | (1 << 1),
  78         ATA_UDMA2               = ATA_UDMA1 | (1 << 2),
  79         ATA_UDMA3               = ATA_UDMA2 | (1 << 3),
  80         ATA_UDMA4               = ATA_UDMA3 | (1 << 4),
  81         ATA_UDMA5               = ATA_UDMA4 | (1 << 5),
  82         ATA_UDMA6               = ATA_UDMA5 | (1 << 6),
  83         ATA_UDMA7               = ATA_UDMA6 | (1 << 7),
  84         /* ATA_UDMA7 is just for completeness... doesn't exist (yet?).  */
  85
  86         ATA_UDMA_MASK_40C       = ATA_UDMA2,    /* udma0-2 */
  87
  88         /* DMA-related */
  89         ATA_PRD_SZ              = 8,
  90         ATA_PRD_TBL_SZ          = (ATA_MAX_PRD * ATA_PRD_SZ),
  91         ATA_PRD_EOT             = (1 << 31),    /* end-of-table flag */
  92
  93         ATA_DMA_TABLE_OFS       = 4,
  94         ATA_DMA_STATUS          = 2,
  95         ATA_DMA_CMD             = 0,
  96         ATA_DMA_WR              = (1 << 3),
  97         ATA_DMA_START           = (1 << 0),
  98         ATA_DMA_INTR            = (1 << 2),
  99         ATA_DMA_ERR             = (1 << 1),
 100         ATA_DMA_ACTIVE          = (1 << 0),
 101
 102         /* bits in ATA command block registers */
 103         ATA_HOB                 = (1 << 7),     /* LBA48 selector */
 104         ATA_NIEN                = (1 << 1),     /* disable-irq flag */
 105         ATA_LBA                 = (1 << 6),     /* LBA28 selector */
 106         ATA_DEV1                = (1 << 4),     /* Select Device 1 (slave) */
 107         ATA_DEVICE_OBS          = (1 << 7) | (1 << 5), /* obs bits in dev reg */
 108         ATA_DEVCTL_OBS          = (1 << 3),     /* obsolete bit in devctl reg */
 109         ATA_BUSY                = (1 << 7),     /* BSY status bit */
 110         ATA_DRDY                = (1 << 6),     /* device ready */
 111         ATA_DF                  = (1 << 5),     /* device fault */
 112         ATA_DRQ                 = (1 << 3),     /* data request i/o */
 113         ATA_ERR                 = (1 << 0),     /* have an error */
 114         ATA_SRST                = (1 << 2),     /* software reset */
 115         ATA_ICRC                = (1 << 7),     /* interface CRC error */
 116         ATA_UNC                 = (1 << 6),     /* uncorrectable media error */
 117         ATA_IDNF                = (1 << 4),     /* ID not found */
 118         ATA_ABORTED             = (1 << 2),     /* command aborted */
 119
 120         /* ATA command block registers */
 121         ATA_REG_DATA            = 0x00,
 122         ATA_REG_ERR             = 0x01,
 123         ATA_REG_NSECT           = 0x02,
 124         ATA_REG_LBAL            = 0x03,
 125         ATA_REG_LBAM            = 0x04,
 126         ATA_REG_LBAH            = 0x05,
 127         ATA_REG_DEVICE          = 0x06,
 128         ATA_REG_STATUS          = 0x07,
 129
 130         ATA_REG_FEATURE         = ATA_REG_ERR, /* and their aliases */
 131         ATA_REG_CMD             = ATA_REG_STATUS,
 132         ATA_REG_BYTEL           = ATA_REG_LBAM,
 133         ATA_REG_BYTEH           = ATA_REG_LBAH,
 134         ATA_REG_DEVSEL          = ATA_REG_DEVICE,
 135         ATA_REG_IRQ             = ATA_REG_NSECT,
 136
 137         /* ATA device commands */
 138         ATA_CMD_DEV_RESET       = 0x08, /* ATAPI device reset */
 139         ATA_CMD_CHK_POWER       = 0xE5, /* check power mode */
 140         ATA_CMD_STANDBY         = 0xE2, /* place in standby power mode */
 141         ATA_CMD_IDLE            = 0xE3, /* place in idle power mode */
 142         ATA_CMD_EDD             = 0x90, /* execute device diagnostic */
 143         ATA_CMD_FLUSH           = 0xE7,
 144         ATA_CMD_FLUSH_EXT       = 0xEA,
 145         ATA_CMD_ID_ATA          = 0xEC,
 146         ATA_CMD_ID_ATAPI        = 0xA1,
 147         ATA_CMD_READ            = 0xC8,
 148         ATA_CMD_READ_EXT        = 0x25,
 149         ATA_CMD_WRITE           = 0xCA,
 150         ATA_CMD_WRITE_EXT       = 0x35,
 151         ATA_CMD_WRITE_FUA_EXT   = 0x3D,
 152         ATA_CMD_FPDMA_READ      = 0x60,
 153         ATA_CMD_FPDMA_WRITE     = 0x61,
 154         ATA_CMD_PIO_READ        = 0x20,
 155         ATA_CMD_PIO_READ_EXT    = 0x24,
 156         ATA_CMD_PIO_WRITE       = 0x30,
 157         ATA_CMD_PIO_WRITE_EXT   = 0x34,
 158         ATA_CMD_READ_MULTI      = 0xC4,
 159         ATA_CMD_READ_MULTI_EXT  = 0x29,
 160         ATA_CMD_WRITE_MULTI     = 0xC5,
 161         ATA_CMD_WRITE_MULTI_EXT = 0x39,
 162         ATA_CMD_WRITE_MULTI_FUA_EXT = 0xCE,
 163         ATA_CMD_SET_FEATURES    = 0xEF,
 164         ATA_CMD_SET_MULTI       = 0xC6,
 165         ATA_CMD_PACKET          = 0xA0,
 166         ATA_CMD_VERIFY          = 0x40,
 167         ATA_CMD_VERIFY_EXT      = 0x42,
 168         ATA_CMD_STANDBYNOW1     = 0xE0,
 169         ATA_CMD_IDLEIMMEDIATE   = 0xE1,
 170         ATA_CMD_INIT_DEV_PARAMS = 0x91,
 171         ATA_CMD_READ_NATIVE_MAX = 0xF8,
 172         ATA_CMD_READ_NATIVE_MAX_EXT = 0x27,
 173         ATA_CMD_SET_MAX         = 0xF9,
 174         ATA_CMD_SET_MAX_EXT     = 0x37,
 175         ATA_CMD_READ_LOG_EXT    = 0x2f,
 176         ATA_CMD_PMP_READ        = 0xE4,
 177         ATA_CMD_PMP_WRITE       = 0xE8,
 178
 179         /* READ_LOG_EXT pages */
 180         ATA_LOG_SATA_NCQ        = 0x10,
 181
 182         /* READ/WRITE LONG (obsolete) */
 183         ATA_CMD_READ_LONG       = 0x22,
 184         ATA_CMD_READ_LONG_ONCE  = 0x23,
 185         ATA_CMD_WRITE_LONG      = 0x32,
 186         ATA_CMD_WRITE_LONG_ONCE = 0x33,
 187
 188         /* SETFEATURES stuff */
 189         SETFEATURES_XFER        = 0x03,
 190         XFER_UDMA_7             = 0x47,
 191         XFER_UDMA_6             = 0x46,
 192         XFER_UDMA_5             = 0x45,
 193         XFER_UDMA_4             = 0x44,
 194         XFER_UDMA_3             = 0x43,
 195         XFER_UDMA_2             = 0x42,
 196         XFER_UDMA_1             = 0x41,
 197         XFER_UDMA_0             = 0x40,
 198         XFER_MW_DMA_4           = 0x24, /* CFA only */
 199         XFER_MW_DMA_3           = 0x23, /* CFA only */
 200         XFER_MW_DMA_2           = 0x22,
 201         XFER_MW_DMA_1           = 0x21,
 202         XFER_MW_DMA_0           = 0x20,
 203         XFER_SW_DMA_2           = 0x12,
 204         XFER_SW_DMA_1           = 0x11,
 205         XFER_SW_DMA_0           = 0x10,
 206         XFER_PIO_6              = 0x0E, /* CFA only */
 207         XFER_PIO_5              = 0x0D, /* CFA only */
 208         XFER_PIO_4              = 0x0C,
 209         XFER_PIO_3              = 0x0B,
 210         XFER_PIO_2              = 0x0A,
 211         XFER_PIO_1              = 0x09,
 212         XFER_PIO_0              = 0x08,
 213         XFER_PIO_SLOW           = 0x00,
 214
 215         SETFEATURES_WC_ON       = 0x02, /* Enable write cache */
 216         SETFEATURES_WC_OFF      = 0x82, /* Disable write cache */
 217
 218         SETFEATURES_SPINUP      = 0x07, /* Spin-up drive */
 219
 220         /* ATAPI stuff */
 221         ATAPI_PKT_DMA           = (1 << 0),
 222         ATAPI_DMADIR            = (1 << 2),     /* ATAPI data dir:
 223                                                    0=to device, 1=to host */
 224         ATAPI_CDB_LEN           = 16,
 225
 226         /* PMP stuff */
 227         SATA_PMP_MAX_PORTS      = 15,
 228         SATA_PMP_CTRL_PORT      = 15,
 229
 230         SATA_PMP_GSCR_DWORDS    = 128,
 231         SATA_PMP_GSCR_PROD_ID   = 0,
 232         SATA_PMP_GSCR_REV       = 1,
 233         SATA_PMP_GSCR_PORT_INFO = 2,
 234         SATA_PMP_GSCR_ERROR     = 32,
 235         SATA_PMP_GSCR_ERROR_EN  = 33,
 236         SATA_PMP_GSCR_FEAT      = 64,
 237         SATA_PMP_GSCR_FEAT_EN   = 96,
 238
 239         SATA_PMP_PSCR_STATUS    = 0,
 240         SATA_PMP_PSCR_ERROR     = 1,
 241         SATA_PMP_PSCR_CONTROL   = 2,
 242
 243         SATA_PMP_FEAT_BIST      = (1 << 0),
 244         SATA_PMP_FEAT_PMREQ     = (1 << 1),
 245         SATA_PMP_FEAT_DYNSSC    = (1 << 2),
 246         SATA_PMP_FEAT_NOTIFY    = (1 << 3),
 247
 248         /* cable types */
 249         ATA_CBL_NONE            = 0,
 250         ATA_CBL_PATA40          = 1,
 251         ATA_CBL_PATA80          = 2,
 252         ATA_CBL_PATA40_SHORT    = 3,            /* 40 wire cable to high UDMA spec */
 253         ATA_CBL_PATA_UNK        = 4,
 254         ATA_CBL_SATA            = 5,
 255
 256         /* SATA Status and Control Registers */
 257         SCR_STATUS              = 0,
 258         SCR_ERROR               = 1,
 259         SCR_CONTROL             = 2,
 260         SCR_ACTIVE              = 3,
 261         SCR_NOTIFICATION        = 4,
 262
 263         /* SError bits */
 264         SERR_DATA_RECOVERED     = (1 << 0), /* recovered data error */
 265         SERR_COMM_RECOVERED     = (1 << 1), /* recovered comm failure */
 266         SERR_DATA               = (1 << 8), /* unrecovered data error */
 267         SERR_PERSISTENT         = (1 << 9), /* persistent data/comm error */
 268         SERR_PROTOCOL           = (1 << 10), /* protocol violation */
 269         SERR_INTERNAL           = (1 << 11), /* host internal error */
 270         SERR_PHYRDY_CHG         = (1 << 16), /* PHY RDY changed */
 271         SERR_DEV_XCHG           = (1 << 26), /* device exchanged */
 272
 273         /* struct ata_taskfile flags */
 274         ATA_TFLAG_LBA48         = (1 << 0), /* enable 48-bit LBA and "HOB" */
 275         ATA_TFLAG_ISADDR        = (1 << 1), /* enable r/w to nsect/lba regs */
 276         ATA_TFLAG_DEVICE        = (1 << 2), /* enable r/w to device reg */
 277         ATA_TFLAG_WRITE         = (1 << 3), /* data dir: host->dev==1 (write) */
 278         ATA_TFLAG_LBA           = (1 << 4), /* enable LBA */
 279         ATA_TFLAG_FUA           = (1 << 5), /* enable FUA */
 280         ATA_TFLAG_POLLING       = (1 << 6), /* set nIEN to 1 and use polling */
 281 };
 282
 283 enum ata_tf_protocols {
 284         /* ATA taskfile protocols */
 285         ATA_PROT_UNKNOWN,       /* unknown/invalid */
 286         ATA_PROT_NODATA,        /* no data */
 287         ATA_PROT_PIO,           /* PIO data xfer */
 288         ATA_PROT_DMA,           /* DMA */
 289         ATA_PROT_NCQ,           /* NCQ */
 290         ATA_PROT_ATAPI,         /* packet command, PIO data xfer*/
 291         ATA_PROT_ATAPI_NODATA,  /* packet command, no data */
 292         ATA_PROT_ATAPI_DMA,     /* packet command with special DMA sauce */
 293 };
 294
 295 enum ata_ioctls {
 296         ATA_IOC_GET_IO32        = 0x309,
 297         ATA_IOC_SET_IO32        = 0x324,
 298 };
 299
 300 /* core structures */
 301
 302 struct ata_prd {
 303         u32                     addr;
 304         u32                     flags_len;
 305 };
 306
 307 struct ata_taskfile {
 308         unsigned long           flags;          /* ATA_TFLAG_xxx */
 309         u8                      protocol;       /* ATA_PROT_xxx */
 310
 311         u8                      ctl;            /* control reg */
 312
 313         u8                      hob_feature;    /* additional data */
 314         u8                      hob_nsect;      /* to support LBA48 */
 315         u8                      hob_lbal;
 316         u8                      hob_lbam;
 317         u8                      hob_lbah;
 318
 319         u8                      feature;
 320         u8                      nsect;
 321         u8                      lbal;
 322         u8                      lbam;
 323         u8                      lbah;
 324
 325         u8                      device;
 326
 327         u8                      command;        /* IO operation */
 328 };
 329
 330 #define ata_id_is_ata(id)       (((id)[0] & (1 << 15)) == 0)
 331 #define ata_id_rahead_enabled(id) ((id)[85] & (1 << 6))
 332 #define ata_id_wcache_enabled(id) ((id)[85] & (1 << 5))
 333 #define ata_id_hpa_enabled(id)  ((id)[85] & (1 << 10))
 334 #define ata_id_has_fua(id)      ((id)[84] & (1 << 6))
 335 #define ata_id_has_flush(id)    ((id)[83] & (1 << 12))
 336 #define ata_id_has_flush_ext(id) ((id)[83] & (1 << 13))
 337 #define ata_id_has_lba48(id)    ((id)[83] & (1 << 10))
 338 #define ata_id_has_hpa(id)      ((id)[82] & (1 << 10))
 339 #define ata_id_has_wcache(id)   ((id)[82] & (1 << 5))
 340 #define ata_id_has_pm(id)       ((id)[82] & (1 << 3))
 341 #define ata_id_has_lba(id)      ((id)[49] & (1 << 9))
 342 #define ata_id_has_dma(id)      ((id)[49] & (1 << 8))
 343 #define ata_id_has_ncq(id)      ((id)[76] & (1 << 8))
 344 #define ata_id_queue_depth(id)  (((id)[75] & 0x1f) + 1)
 345 #define ata_id_removeable(id)   ((id)[0] & (1 << 7))
 346 #define ata_id_has_dword_io(id) ((id)[50] & (1 << 0))
 347 #define ata_id_iordy_disable(id) ((id)[49] & (1 << 10))
 348 #define ata_id_has_iordy(id) ((id)[49] & (1 << 9))
 349 #define ata_id_u32(id,n)        \
 350         (((u32) (id)[(n) + 1] << 16) | ((u32) (id)[(n)]))
 351 #define ata_id_u64(id,n)        \
 352         ( ((u64) (id)[(n) + 3] << 48) | \
 353           ((u64) (id)[(n) + 2] << 32) | \
 354           ((u64) (id)[(n) + 1] << 16) | \
 355           ((u64) (id)[(n) + 0]) )
 356
 357 #define ata_id_cdb_intr(id)     (((id)[0] & 0x60) == 0x20)
 358
 359 static inline unsigned int ata_id_major_version(const u16 *id)
 360 {
 361         unsigned int mver;
 362
 363         if (id[ATA_ID_MAJOR_VER] == 0xFFFF)
 364                 return 0;
 365
 366         for (mver = 14; mver >= 1; mver--)
 367                 if (id[ATA_ID_MAJOR_VER] & (1 << mver))
 368                         break;
 369         return mver;
 370 }
 371
 372 static inline int ata_id_is_sata(const u16 *id)
 373 {
 374         return ata_id_major_version(id) >= 5 && id[93] == 0;
 375 }
 376
 377 static inline int ata_id_current_chs_valid(const u16 *id)
 378 {
 379         /* For ATA-1 devices, if the INITIALIZE DEVICE PARAMETERS command
 380            has not been issued to the device then the values of
 381            id[54] to id[56] are vendor specific. */
 382         return (id[53] & 0x01) && /* Current translation valid */
 383                 id[54] &&  /* cylinders in current translation */
 384                 id[55] &&  /* heads in current translation */
 385                 id[55] <= 16 &&
 386                 id[56];    /* sectors in current translation */
 387 }
 388
 389 static inline int ata_id_is_cfa(const u16 *id)
 390 {
 391         u16 v = id[0];
 392         if (v == 0x848A)        /* Standard CF */
 393                 return 1;
 394         /* Could be CF hiding as standard ATA */
 395         if (ata_id_major_version(id) >= 3 &&  id[82] != 0xFFFF &&
 396                         (id[82] & ( 1 << 2)))
 397                 return 1;
 398         return 0;
 399 }
 400
 401 static inline int ata_drive_40wire(const u16 *dev_id)
 402 {
 403         if (ata_id_is_sata(dev_id))
 404                 return 0;       /* SATA */
 405         if ((dev_id[93] & 0xE000) == 0x6000)
 406                 return 0;       /* 80 wire */
 407         return 1;
 408 }
 409
 410 static inline int atapi_cdb_len(const u16 *dev_id)
 411 {
 412         u16 tmp = dev_id[0] & 0x3;
 413         switch (tmp) {
 414         case 0:         return 12;
 415         case 1:         return 16;
 416         default:        return -1;
 417         }
 418 }
 419
 420 static inline int is_atapi_taskfile(const struct ata_taskfile *tf)
 421 {
 422         return (tf->protocol == ATA_PROT_ATAPI) ||
 423                (tf->protocol == ATA_PROT_ATAPI_NODATA) ||
 424                (tf->protocol == ATA_PROT_ATAPI_DMA);
 425 }
 426
 427 static inline int is_multi_taskfile(struct ata_taskfile *tf)
 428 {
 429         return (tf->command == ATA_CMD_READ_MULTI) ||
 430                (tf->command == ATA_CMD_WRITE_MULTI) ||
 431                (tf->command == ATA_CMD_READ_MULTI_EXT) ||
 432                (tf->command == ATA_CMD_WRITE_MULTI_EXT) ||
 433                (tf->command == ATA_CMD_WRITE_MULTI_FUA_EXT);
 434 }
 435
 436 static inline int ata_ok(u8 status)
 437 {
 438         return ((status & (ATA_BUSY | ATA_DRDY | ATA_DF | ATA_DRQ | ATA_ERR))
 439                         == ATA_DRDY);
 440 }
 441
 442 static inline int lba_28_ok(u64 block, u32 n_block)
 443 {
 444         /* check the ending block number */
 445         return ((block + n_block - 1) < ((u64)1 << 28)) && (n_block <= 256);
 446 }
 447
 448 static inline int lba_48_ok(u64 block, u32 n_block)
 449 {
 450         /* check the ending block number */
 451         return ((block + n_block - 1) < ((u64)1 << 48)) && (n_block <= 65536);
 452 }
 453
 454 #define sata_pmp_gscr_vendor(gscr)      ((gscr)[SATA_PMP_GSCR_PROD_ID] & 0xffff)
 455 #define sata_pmp_gscr_devid(gscr)       ((gscr)[SATA_PMP_GSCR_PROD_ID] >> 16)
 456 #define sata_pmp_gscr_rev(gscr)         (((gscr)[SATA_PMP_GSCR_REV] >> 8) & 0xff)
 457 #define sata_pmp_gscr_ports(gscr)       ((gscr)[SATA_PMP_GSCR_PORT_INFO] & 0xf)
 458
 459 #endif /* __LINUX_ATA_H__ */