sys/dev/ata/ata-all.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$
  27  */
  28
  29 /* ATA register defines */
  30 #define ATA_DATA                        0       /* (RW) data */
  31
  32 #define ATA_FEATURE                     1       /* (W) feature */
  33 #define         ATA_F_DMA               0x01    /* enable DMA */
  34 #define         ATA_F_OVL               0x02    /* enable overlap */
  35
  36 #define ATA_COUNT                       2       /* (W) sector count */
  37
  38 #define ATA_SECTOR                      3       /* (RW) sector # */
  39 #define ATA_CYL_LSB                     4       /* (RW) cylinder# LSB */
  40 #define ATA_CYL_MSB                     5       /* (RW) cylinder# MSB */
  41 #define ATA_DRIVE                       6       /* (W) Sector/Drive/Head */
  42 #define         ATA_D_LBA               0x40    /* use LBA addressing */
  43 #define         ATA_D_IBM               0xa0    /* 512 byte sectors, ECC */
  44
  45 #define ATA_COMMAND                     7       /* (W) command */
  46
  47 #define ATA_ERROR                       8       /* (R) error */
  48 #define         ATA_E_ILI               0x01    /* illegal length */
  49 #define         ATA_E_NM                0x02    /* no media */
  50 #define         ATA_E_ABORT             0x04    /* command aborted */
  51 #define         ATA_E_MCR               0x08    /* media change request */
  52 #define         ATA_E_IDNF              0x10    /* ID not found */
  53 #define         ATA_E_MC                0x20    /* media changed */
  54 #define         ATA_E_UNC               0x40    /* uncorrectable data */
  55 #define         ATA_E_ICRC              0x80    /* UDMA crc error */
  56 #define         ATA_E_ATAPI_SENSE_MASK  0xf0    /* ATAPI sense key mask */
  57
  58 #define ATA_IREASON                     9       /* (R) interrupt reason */
  59 #define         ATA_I_CMD               0x01    /* cmd (1) | data (0) */
  60 #define         ATA_I_IN                0x02    /* read (1) | write (0) */
  61 #define         ATA_I_RELEASE           0x04    /* released bus (1) */
  62 #define         ATA_I_TAGMASK           0xf8    /* tag mask */
  63
  64 #define ATA_STATUS                      10      /* (R) status */
  65 #define ATA_ALTSTAT                     11      /* (R) alternate status */
  66 #define         ATA_S_ERROR             0x01    /* error */
  67 #define         ATA_S_INDEX             0x02    /* index */
  68 #define         ATA_S_CORR              0x04    /* data corrected */
  69 #define         ATA_S_DRQ               0x08    /* data request */
  70 #define         ATA_S_DSC               0x10    /* drive seek completed */
  71 #define         ATA_S_SERVICE           0x10    /* drive needs service */
  72 #define         ATA_S_DWF               0x20    /* drive write fault */
  73 #define         ATA_S_DMA               0x20    /* DMA ready */
  74 #define         ATA_S_READY             0x40    /* drive ready */
  75 #define         ATA_S_BUSY              0x80    /* busy */
  76
  77 #define ATA_CONTROL                     12      /* (W) control */
  78
  79 #define ATA_CTLOFFSET                   0x206   /* control register offset */
  80 #define ATA_PCCARD_CTLOFFSET            0x0e    /* do for PCCARD devices */
  81 #define ATA_PC98_CTLOFFSET              0x10c   /* do for PC98 devices */
  82 #define         ATA_A_IDS               0x02    /* disable interrupts */
  83 #define         ATA_A_RESET             0x04    /* RESET controller */
  84 #define         ATA_A_4BIT              0x08    /* 4 head bits */
  85 #define         ATA_A_HOB               0x80    /* High Order Byte enable */
  86
  87 /* SATA register defines */
  88 #define ATA_SSTATUS                     13
  89 #define         ATA_SS_DET_MASK         0x0000000f
  90 #define         ATA_SS_DET_NO_DEVICE    0x00000000
  91 #define         ATA_SS_DET_DEV_PRESENT  0x00000001
  92 #define         ATA_SS_DET_PHY_ONLINE   0x00000003
  93 #define         ATA_SS_DET_PHY_OFFLINE  0x00000004
  94
  95 #define         ATA_SS_SPD_MASK         0x000000f0
  96 #define         ATA_SS_SPD_NO_SPEED     0x00000000
  97 #define         ATA_SS_SPD_GEN1         0x00000010
  98 #define         ATA_SS_SPD_GEN2         0x00000020
  99
 100 #define         ATA_SS_IPM_MASK         0x00000f00
 101 #define         ATA_SS_IPM_NO_DEVICE    0x00000000
 102 #define         ATA_SS_IPM_ACTIVE       0x00000100
 103 #define         ATA_SS_IPM_PARTIAL      0x00000200
 104 #define         ATA_SS_IPM_SLUMBER      0x00000600
 105
 106 #define         ATA_SS_CONWELL_MASK \
 107                     (ATA_SS_DET_MASK|ATA_SS_SPD_MASK|ATA_SS_IPM_MASK)
 108 #define         ATA_SS_CONWELL_GEN1 \
 109                     (ATA_SS_DET_PHY_ONLINE|ATA_SS_SPD_GEN1|ATA_SS_IPM_ACTIVE)
 110 #define         ATA_SS_CONWELL_GEN2 \
 111                     (ATA_SS_DET_PHY_ONLINE|ATA_SS_SPD_GEN2|ATA_SS_IPM_ACTIVE)
 112
 113 #define ATA_SERROR                      14
 114 #define         ATA_SE_DATA_CORRECTED   0x00000001
 115 #define         ATA_SE_COMM_CORRECTED   0x00000002
 116 #define         ATA_SE_DATA_ERR         0x00000100
 117 #define         ATA_SE_COMM_ERR         0x00000200
 118 #define         ATA_SE_PROT_ERR         0x00000400
 119 #define         ATA_SE_HOST_ERR         0x00000800
 120 #define         ATA_SE_PHY_CHANGED      0x00010000
 121 #define         ATA_SE_PHY_IERROR       0x00020000
 122 #define         ATA_SE_COMM_WAKE        0x00040000
 123 #define         ATA_SE_DECODE_ERR       0x00080000
 124 #define         ATA_SE_PARITY_ERR       0x00100000
 125 #define         ATA_SE_CRC_ERR          0x00200000
 126 #define         ATA_SE_HANDSHAKE_ERR    0x00400000
 127 #define         ATA_SE_LINKSEQ_ERR      0x00800000
 128 #define         ATA_SE_TRANSPORT_ERR    0x01000000
 129 #define         ATA_SE_UNKNOWN_FIS      0x02000000
 130
 131 #define ATA_SCONTROL                    15
 132 #define         ATA_SC_DET_MASK         0x0000000f
 133 #define         ATA_SC_DET_IDLE         0x00000000
 134 #define         ATA_SC_DET_RESET        0x00000001
 135 #define         ATA_SC_DET_DISABLE      0x00000004
 136
 137 #define         ATA_SC_SPD_MASK         0x000000f0
 138 #define         ATA_SC_SPD_NO_SPEED     0x00000000
 139 #define         ATA_SC_SPD_SPEED_GEN1   0x00000010
 140 #define         ATA_SC_SPD_SPEED_GEN2   0x00000020
 141
 142 #define         ATA_SC_IPM_MASK         0x00000f00
 143 #define         ATA_SC_IPM_NONE         0x00000000
 144 #define         ATA_SC_IPM_DIS_PARTIAL  0x00000100
 145 #define         ATA_SC_IPM_DIS_SLUMBER  0x00000200
 146
 147 #define ATA_SACTIVE                     16
 148
 149 /* SATA AHCI v1.0 register defines */
 150 #define ATA_AHCI_CAP                    0x00
 151 #define         ATA_AHCI_NPMASK         0x1f
 152 #define         ATA_AHCI_CAP_SPM        0x00020000
 153 #define         ATA_AHCI_CAP_CLO        0x01000000
 154 #define         ATA_AHCI_CAP_64BIT      0x80000000
 155
 156 #define ATA_AHCI_GHC                    0x04
 157 #define         ATA_AHCI_GHC_AE         0x80000000
 158 #define         ATA_AHCI_GHC_IE         0x00000002
 159 #define         ATA_AHCI_GHC_HR         0x00000001
 160
 161 #define ATA_AHCI_IS                     0x08
 162 #define ATA_AHCI_PI                     0x0c
 163 #define ATA_AHCI_VS                     0x10
 164
 165 #define ATA_AHCI_OFFSET                 0x80
 166
 167 #define ATA_AHCI_P_CLB                  0x100
 168 #define ATA_AHCI_P_CLBU                 0x104
 169 #define ATA_AHCI_P_FB                   0x108
 170 #define ATA_AHCI_P_FBU                  0x10c
 171 #define ATA_AHCI_P_IS                   0x110
 172 #define ATA_AHCI_P_IE                   0x114
 173 #define         ATA_AHCI_P_IX_DHR       0x00000001
 174 #define         ATA_AHCI_P_IX_PS        0x00000002
 175 #define         ATA_AHCI_P_IX_DS        0x00000004
 176 #define         ATA_AHCI_P_IX_SDB       0x00000008
 177 #define         ATA_AHCI_P_IX_UF        0x00000010
 178 #define         ATA_AHCI_P_IX_DP        0x00000020
 179 #define         ATA_AHCI_P_IX_PC        0x00000040
 180 #define         ATA_AHCI_P_IX_DI        0x00000080
 181
 182 #define         ATA_AHCI_P_IX_PRC       0x00400000
 183 #define         ATA_AHCI_P_IX_IPM       0x00800000
 184 #define         ATA_AHCI_P_IX_OF        0x01000000
 185 #define         ATA_AHCI_P_IX_INF       0x04000000
 186 #define         ATA_AHCI_P_IX_IF        0x08000000
 187 #define         ATA_AHCI_P_IX_HBD       0x10000000
 188 #define         ATA_AHCI_P_IX_HBF       0x20000000
 189 #define         ATA_AHCI_P_IX_TFE       0x40000000
 190 #define         ATA_AHCI_P_IX_CPD       0x80000000
 191
 192 #define ATA_AHCI_P_CMD                  0x118
 193 #define         ATA_AHCI_P_CMD_ST       0x00000001
 194 #define         ATA_AHCI_P_CMD_SUD      0x00000002
 195 #define         ATA_AHCI_P_CMD_POD      0x00000004
 196 #define         ATA_AHCI_P_CMD_CLO      0x00000008
 197 #define         ATA_AHCI_P_CMD_FRE      0x00000010
 198 #define         ATA_AHCI_P_CMD_CCS_MASK 0x00001f00
 199 #define         ATA_AHCI_P_CMD_ISS      0x00002000
 200 #define         ATA_AHCI_P_CMD_FR       0x00004000
 201 #define         ATA_AHCI_P_CMD_CR       0x00008000
 202 #define         ATA_AHCI_P_CMD_CPS      0x00010000
 203 #define         ATA_AHCI_P_CMD_PMA      0x00020000
 204 #define         ATA_AHCI_P_CMD_HPCP     0x00040000
 205 #define         ATA_AHCI_P_CMD_ISP      0x00080000
 206 #define         ATA_AHCI_P_CMD_CPD      0x00100000
 207 #define         ATA_AHCI_P_CMD_ATAPI    0x01000000
 208 #define         ATA_AHCI_P_CMD_DLAE     0x02000000
 209 #define         ATA_AHCI_P_CMD_ALPE     0x04000000
 210 #define         ATA_AHCI_P_CMD_ASP      0x08000000
 211 #define         ATA_AHCI_P_CMD_ICC_MASK 0xf0000000
 212 #define         ATA_AHCI_P_CMD_NOOP     0x00000000
 213 #define         ATA_AHCI_P_CMD_ACTIVE   0x10000000
 214 #define         ATA_AHCI_P_CMD_PARTIAL  0x20000000
 215 #define         ATA_AHCI_P_CMD_SLUMPER  0x60000000
 216
 217 #define ATA_AHCI_P_TFD                  0x120
 218 #define ATA_AHCI_P_SIG                  0x124
 219 #define ATA_AHCI_P_SSTS                 0x128
 220 #define ATA_AHCI_P_SCTL                 0x12c
 221 #define ATA_AHCI_P_SERR                 0x130
 222 #define ATA_AHCI_P_SACT                 0x134
 223 #define ATA_AHCI_P_CI                   0x138
 224 #define ATA_AHCI_P_SNTF                 0x13C
 225 #define ATA_AHCI_P_FBS                  0x140
 226
 227 #define ATA_AHCI_CL_SIZE                32
 228 #define ATA_AHCI_CL_OFFSET              0
 229 #define ATA_AHCI_FB_OFFSET              1024
 230 #define ATA_AHCI_CT_OFFSET              1024+4096
 231 #define ATA_AHCI_CT_SG_OFFSET           128
 232 #define ATA_AHCI_CT_SIZE                256
 233
 234 struct ata_ahci_dma_prd {
 235     u_int64_t                   dba;
 236     u_int32_t                   reserved;
 237     u_int32_t                   dbc;            /* 0 based */
 238 #define ATA_AHCI_PRD_MASK       0x003fffff      /* max 4MB */
 239 #define ATA_AHCI_PRD_IPC        (1<<31)
 240 } __packed;
 241
 242 struct ata_ahci_cmd_tab {
 243     u_int8_t                    cfis[64];
 244     u_int8_t                    acmd[32];
 245     u_int8_t                    reserved[32];
 246     struct ata_ahci_dma_prd     prd_tab[16];
 247 } __packed;
 248
 249 struct ata_ahci_cmd_list {
 250     u_int16_t                   cmd_flags;
 251 #define ATA_AHCI_CMD_ATAPI              0x0020
 252 #define ATA_AHCI_CMD_WRITE              0x0040
 253 #define ATA_AHCI_CMD_PREFETCH           0x0080
 254 #define ATA_AHCI_CMD_RESET              0x0100
 255 #define ATA_AHCI_CMD_BIST               0x0200
 256 #define ATA_AHCI_CMD_CLR_BUSY           0x0400
 257
 258     u_int16_t                   prd_length;     /* PRD entries */
 259     u_int32_t                   bytecount;
 260     u_int64_t                   cmd_table_phys; /* 128byte aligned */
 261 } __packed;
 262
 263
 264 /* DMA register defines */
 265 #define ATA_DMA_ENTRIES                 256
 266 #define ATA_DMA_EOT                     0x80000000
 267
 268 #define ATA_BMCMD_PORT                  17
 269 #define         ATA_BMCMD_START_STOP    0x01
 270 #define         ATA_BMCMD_WRITE_READ    0x08
 271
 272 #define ATA_BMDEVSPEC_0                 18
 273 #define ATA_BMSTAT_PORT                 19
 274 #define         ATA_BMSTAT_ACTIVE       0x01
 275 #define         ATA_BMSTAT_ERROR        0x02
 276 #define         ATA_BMSTAT_INTERRUPT    0x04
 277 #define         ATA_BMSTAT_MASK         0x07
 278 #define         ATA_BMSTAT_DMA_MASTER   0x20
 279 #define         ATA_BMSTAT_DMA_SLAVE    0x40
 280 #define         ATA_BMSTAT_DMA_SIMPLEX  0x80
 281
 282 #define ATA_BMDEVSPEC_1                 20
 283 #define ATA_BMDTP_PORT                  21
 284
 285 #define ATA_IDX_ADDR                    22
 286 #define ATA_IDX_DATA                    23
 287 #define ATA_MAX_RES                     24
 288
 289 /* misc defines */
 290 #define ATA_PRIMARY                     0x1f0
 291 #define ATA_SECONDARY                   0x170
 292 #define ATA_PC98_BANK                   0x432
 293 #define ATA_IOSIZE                      0x08
 294 #define ATA_PC98_IOSIZE                 0x10
 295 #define ATA_CTLIOSIZE                   0x01
 296 #define ATA_BMIOSIZE                    0x08
 297 #define ATA_PC98_BANKIOSIZE             0x01
 298 #define ATA_IOADDR_RID                  0
 299 #define ATA_CTLADDR_RID                 1
 300 #define ATA_BMADDR_RID                  0x20
 301 #define ATA_PC98_CTLADDR_RID            8
 302 #define ATA_PC98_BANKADDR_RID           9
 303 #define ATA_IRQ_RID                     0
 304 #define ATA_DEV(unit)                   ((unit == ATA_ATA_SLAVE) ? 0x10 : 0)
 305 #define ATA_CFA_MAGIC1                  0x844A
 306 #define ATA_CFA_MAGIC2                  0x848A
 307 #define ATA_CFA_MAGIC3                  0x8400
 308 #define ATAPI_MAGIC_LSB                 0x14
 309 #define ATAPI_MAGIC_MSB                 0xeb
 310 #define ATAPI_P_READ                    (ATA_S_DRQ | ATA_I_IN)
 311 #define ATAPI_P_WRITE                   (ATA_S_DRQ)
 312 #define ATAPI_P_CMDOUT                  (ATA_S_DRQ | ATA_I_CMD)
 313 #define ATAPI_P_DONEDRQ                 (ATA_S_DRQ | ATA_I_CMD | ATA_I_IN)
 314 #define ATAPI_P_DONE                    (ATA_I_CMD | ATA_I_IN)
 315 #define ATAPI_P_ABORT                   0
 316 #define ATA_INTR_FLAGS                  (INTR_MPSAFE|INTR_TYPE_BIO|INTR_ENTROPY)
 317 #define ATA_OP_CONTINUES                0
 318 #define ATA_OP_FINISHED                 1
 319 #define ATA_MAX_28BIT_LBA               268435455UL
 320
 321 /* structure used for composite atomic operations */
 322 #define MAX_COMPOSITES          32              /* u_int32_t bits */
 323 struct ata_composite {
 324     struct mtx          lock;                   /* control lock */
 325     u_int32_t           rd_needed;              /* needed read subdisks */
 326     u_int32_t           rd_done;                /* done read subdisks */
 327     u_int32_t           wr_needed;              /* needed write subdisks */
 328     u_int32_t           wr_depend;              /* write depends on subdisks */
 329     u_int32_t           wr_done;                /* done write subdisks */
 330     struct ata_request  *request[MAX_COMPOSITES];
 331     u_int32_t           residual;               /* bytes still to transfer */
 332     caddr_t             data_1;
 333     caddr_t             data_2;
 334 };
 335
 336 /* structure used to queue an ATA/ATAPI request */
 337 struct ata_request {
 338     device_t                    dev;            /* device handle */
 339     device_t                    parent;         /* channel handle */
 340     union {
 341         struct {
 342             u_int8_t            command;        /* command reg */
 343             u_int16_t           feature;        /* feature reg */
 344             u_int16_t           count;          /* count reg */
 345             u_int64_t           lba;            /* lba reg */
 346         } ata;
 347         struct {
 348             u_int8_t            ccb[16];        /* ATAPI command block */
 349             struct atapi_sense  sense;          /* ATAPI request sense data */
 350             u_int8_t            saved_cmd;      /* ATAPI saved command */
 351         } atapi;
 352     } u;
 353     u_int32_t                   bytecount;      /* bytes to transfer */
 354     u_int32_t                   transfersize;   /* bytes pr transfer */
 355     caddr_t                     data;           /* pointer to data buf */
 356     u_int32_t                   tag;            /* HW tag of this request */
 357     int                         flags;
 358 #define         ATA_R_CONTROL           0x00000001
 359 #define         ATA_R_READ              0x00000002
 360 #define         ATA_R_WRITE             0x00000004
 361 #define         ATA_R_ATAPI             0x00000008
 362 #define         ATA_R_DMA               0x00000010
 363 #define         ATA_R_QUIET             0x00000020
 364 #define         ATA_R_TIMEOUT           0x00000040
 365
 366 #define         ATA_R_ORDERED           0x00000100
 367 #define         ATA_R_AT_HEAD           0x00000200
 368 #define         ATA_R_REQUEUE           0x00000400
 369 #define         ATA_R_THREAD            0x00000800
 370 #define         ATA_R_DIRECT            0x00001000
 371
 372 #define         ATA_R_DEBUG             0x10000000
 373 #define         ATA_R_DANGER1           0x20000000
 374 #define         ATA_R_DANGER2           0x40000000
 375
 376     u_int8_t                    status;         /* ATA status */
 377     u_int8_t                    error;          /* ATA error */
 378     struct {
 379         u_int8_t                status;         /* DMA status */
 380         bus_dma_tag_t           sg_tag;         /* SG list DMA tag */
 381         bus_dmamap_t            sg_map;         /* SG list DMA map */
 382         void                    *sg;            /* DMA transfer table */
 383         bus_addr_t              sg_bus;         /* bus address of dmatab */
 384         bus_dma_tag_t           data_tag;       /* data DMA tag */
 385         bus_dmamap_t            data_map;       /* data DMA map */
 386         u_int32_t               cur_iosize;     /* DMA data current IO size */
 387     } dma;
 388     u_int32_t                   donecount;      /* bytes transferred */
 389     int                         result;         /* result error code */
 390     void                        (*callback)(struct ata_request *request);
 391     struct sema                 done;           /* request done sema */
 392     int                         retries;        /* retry count */
 393     int                         timeout;        /* timeout for this cmd */
 394     struct callout              callout;        /* callout management */
 395     struct task                 task;           /* task management */
 396     struct bio                  *bio;           /* bio for this request */
 397     int                         this;           /* this request ID */
 398     struct ata_composite        *composite;     /* for composite atomic ops */
 399     void                        *driver;        /* driver specific */
 400     TAILQ_ENTRY(ata_request)    chain;          /* list management */
 401 };
 402
 403 /* define this for debugging request processing */
 404 #if 0
 405 #define ATA_DEBUG_RQ(request, string) \
 406     { \
 407     if (request->flags & ATA_R_DEBUG) \
 408         device_printf(request->dev, "req=%p %s " string "\n", \
 409                       request, ata_cmd2str(request)); \
 410     }
 411 #else
 412 #define ATA_DEBUG_RQ(request, string)
 413 #endif
 414
 415
 416 /* structure describing an ATA/ATAPI device */
 417 struct ata_device {
 418     device_t                    dev;            /* device handle */
 419     int                         unit;           /* physical unit */
 420 #define         ATA_MASTER              0x00
 421 #define         ATA_PM                  0x0f
 422 #define         ATA_SLAVE               0x10
 423
 424     struct ata_params           param;          /* ata param structure */
 425     int                         mode;           /* current transfermode */
 426     u_int32_t                   max_iosize;     /* max IO size */
 427     int                         spindown;       /* idle spindown timeout */
 428     struct callout              spindown_timer;
 429     int                         spindown_state;
 430     int                         flags;
 431 #define         ATA_D_USE_CHS           0x0001
 432 #define         ATA_D_MEDIA_CHANGED     0x0002
 433 #define         ATA_D_ENC_PRESENT       0x0004
 434 #define         ATA_D_48BIT_ACTIVE      0x0008
 435 };
 436
 437 /* structure for holding DMA Physical Region Descriptors (PRD) entries */
 438 struct ata_dma_prdentry {
 439     u_int32_t addr;
 440     u_int32_t count;
 441 };
 442
 443 /* structure used by the setprd function */
 444 struct ata_dmasetprd_args {
 445     void *dmatab;
 446     int nsegs;
 447     int error;
 448 };
 449
 450 /* structure holding DMA related information */
 451 struct ata_dma {
 452     bus_dma_tag_t               dmatag;         /* parent DMA tag */
 453     bus_dma_tag_t               work_tag;       /* workspace DMA tag */
 454     bus_dmamap_t                work_map;       /* workspace DMA map */
 455     u_int8_t                    *work;          /* workspace */
 456     bus_addr_t                  work_bus;       /* bus address of dmatab */
 457     u_int32_t                   alignment;      /* DMA SG list alignment */
 458     u_int32_t                   boundary;       /* DMA SG list boundary */
 459     u_int32_t                   segsize;        /* DMA SG list segment size */
 460     u_int32_t                   max_iosize;     /* DMA data max IO size */
 461     u_int64_t                   max_address;    /* highest DMA'able address */
 462     int                         flags;
 463 #define ATA_DMA_ACTIVE                  0x01    /* DMA transfer in progress */
 464
 465     void (*alloc)(device_t dev);
 466     void (*free)(device_t dev);
 467     void (*setprd)(void *xsc, bus_dma_segment_t *segs, int nsegs, int error);
 468     int (*load)(struct ata_request *request, void *addr, int *nsegs);
 469     int (*unload)(struct ata_request *request);
 470     int (*start)(struct ata_request *request);
 471     int (*stop)(struct ata_request *request);
 472     void (*reset)(device_t dev);
 473 };
 474
 475 /* structure holding lowlevel functions */
 476 struct ata_lowlevel {
 477     u_int32_t (*softreset)(device_t dev, int pmport);
 478     int (*pm_read)(device_t dev, int port, int reg, u_int32_t *result);
 479     int (*pm_write)(device_t dev, int port, int reg, u_int32_t value);
 480     int (*status)(device_t dev);
 481     int (*begin_transaction)(struct ata_request *request);
 482     int (*end_transaction)(struct ata_request *request);
 483     int (*command)(struct ata_request *request);
 484     void (*tf_read)(struct ata_request *request);
 485     void (*tf_write)(struct ata_request *request);
 486 };
 487
 488 /* structure holding resources for an ATA channel */
 489 struct ata_resource {
 490     struct resource             *res;
 491     int                         offset;
 492 };
 493
 494 /* structure describing an ATA channel */
 495 struct ata_channel {
 496     device_t                    dev;            /* device handle */
 497     int                         unit;           /* physical channel */
 498     struct ata_resource         r_io[ATA_MAX_RES];/* I/O resources */
 499     struct resource             *r_irq;         /* interrupt of this channel */
 500     void                        *ih;            /* interrupt handle */
 501     struct ata_lowlevel         hw;             /* lowlevel HW functions */
 502     struct ata_dma              dma;           /* DMA data / functions */
 503     int                         flags;          /* channel flags */
 504 #define         ATA_NO_SLAVE            0x01
 505 #define         ATA_USE_16BIT           0x02
 506 #define         ATA_ATAPI_DMA_RO        0x04
 507 #define         ATA_NO_48BIT_DMA        0x08
 508 #define         ATA_ALWAYS_DMASTAT      0x10
 509
 510     int                         devices;        /* what is present */
 511 #define         ATA_ATA_MASTER          0x00000001
 512 #define         ATA_ATA_SLAVE           0x00000002
 513 #define         ATA_PORTMULTIPLIER      0x00008000
 514 #define         ATA_ATAPI_MASTER        0x00010000
 515 #define         ATA_ATAPI_SLAVE         0x00020000
 516
 517     struct mtx                  state_mtx;      /* state lock */
 518     int                         state;          /* ATA channel state */
 519 #define         ATA_IDLE                0x0000
 520 #define         ATA_ACTIVE              0x0001
 521 #define         ATA_STALL_QUEUE         0x0002
 522
 523     struct mtx                  queue_mtx;      /* queue lock */
 524     TAILQ_HEAD(, ata_request)   ata_queue;      /* head of ATA queue */
 525     struct ata_request          *freezepoint;   /* composite freezepoint */
 526     struct ata_request          *running;       /* currently running request */
 527 };
 528
 529 /* disk bay/enclosure related */
 530 #define         ATA_LED_OFF             0x00
 531 #define         ATA_LED_RED             0x01
 532 #define         ATA_LED_GREEN           0x02
 533 #define         ATA_LED_ORANGE          0x03
 534 #define         ATA_LED_MASK            0x03
 535
 536 /* externs */
 537 extern int (*ata_raid_ioctl_func)(u_long cmd, caddr_t data);
 538 extern struct intr_config_hook *ata_delayed_attach;
 539 extern devclass_t ata_devclass;
 540 extern int ata_wc;
 541 extern int ata_setmax;
 542
 543 /* public prototypes */
 544 /* ata-all.c: */
 545 int ata_probe(device_t dev);
 546 int ata_attach(device_t dev);
 547 int ata_detach(device_t dev);
 548 int ata_reinit(device_t dev);
 549 int ata_suspend(device_t dev);
 550 int ata_resume(device_t dev);
 551 int ata_interrupt(void *data);
 552 int ata_device_ioctl(device_t dev, u_long cmd, caddr_t data);
 553 int ata_getparam(struct ata_device *atadev, int init);
 554 int ata_identify(device_t dev);
 555 void ata_default_registers(device_t dev);
 556 void ata_modify_if_48bit(struct ata_request *request);
 557 void ata_udelay(int interval);
 558 char *ata_unit2str(struct ata_device *atadev);
 559 char *ata_mode2str(int mode);
 560 int ata_pmode(struct ata_params *ap);
 561 int ata_wmode(struct ata_params *ap);
 562 int ata_umode(struct ata_params *ap);
 563 int ata_limit_mode(device_t dev, int mode, int maxmode);
 564
 565 /* ata-queue.c: */
 566 int ata_controlcmd(device_t dev, u_int8_t command, u_int16_t feature, u_int64_t lba, u_int16_t count);
 567 int ata_atapicmd(device_t dev, u_int8_t *ccb, caddr_t data, int count, int flags, int timeout);
 568 void ata_queue_request(struct ata_request *request);
 569 void ata_start(device_t dev);
 570 void ata_finish(struct ata_request *request);
 571 void ata_timeout(struct ata_request *);
 572 void ata_catch_inflight(device_t dev);
 573 void ata_fail_requests(device_t dev);
 574 char *ata_cmd2str(struct ata_request *request);
 575
 576 /* ata-lowlevel.c: */
 577 void ata_generic_hw(device_t dev);
 578 int ata_begin_transaction(struct ata_request *);
 579 int ata_end_transaction(struct ata_request *);
 580 void ata_generic_reset(device_t dev);
 581 int ata_generic_command(struct ata_request *request);
 582
 583 /* macros for alloc/free of struct ata_request */
 584 struct ata_request *ata_alloc_request(device_t dev);
 585 void ata_free_request(struct ata_request *request);
 586
 587 /* macros for alloc/free of struct ata_composite */
 588 extern uma_zone_t ata_composite_zone;
 589 #define ata_alloc_composite() uma_zalloc(ata_composite_zone, M_NOWAIT | M_ZERO)
 590 #define ata_free_composite(composite) uma_zfree(ata_composite_zone, composite)
 591
 592 MALLOC_DECLARE(M_ATA);
 593
 594 /* misc newbus defines */
 595 #define GRANDPARENT(dev)        device_get_parent(device_get_parent(dev))
 596
 597 /* macros to hide busspace uglyness */
 598 #define ATA_INB(res, offset) \
 599         bus_read_1((res), (offset))
 600
 601 #define ATA_INW(res, offset) \
 602         bus_read_2((res), (offset))
 603 #define ATA_INL(res, offset) \
 604         bus_read_4((res), (offset))
 605 #define ATA_INSW(res, offset, addr, count) \
 606         bus_read_multi_2((res), (offset), (addr), (count))
 607 #define ATA_INSW_STRM(res, offset, addr, count) \
 608         bus_read_multi_stream_2((res), (offset), (addr), (count))
 609 #define ATA_INSL(res, offset, addr, count) \
 610         bus_read_multi_4((res), (offset), (addr), (count))
 611 #define ATA_INSL_STRM(res, offset, addr, count) \
 612         bus_read_multi_stream_4((res), (offset), (addr), (count))
 613 #define ATA_OUTB(res, offset, value) \
 614         bus_write_1((res), (offset), (value))
 615 #define ATA_OUTW(res, offset, value) \
 616         bus_write_2((res), (offset), (value))
 617 #define ATA_OUTL(res, offset, value) \
 618         bus_write_4((res), (offset), (value))
 619 #define ATA_OUTSW(res, offset, addr, count) \
 620         bus_write_multi_2((res), (offset), (addr), (count))
 621 #define ATA_OUTSW_STRM(res, offset, addr, count) \
 622         bus_write_multi_stream_2((res), (offset), (addr), (count))
 623 #define ATA_OUTSL(res, offset, addr, count) \
 624         bus_write_multi_4((res), (offset), (addr), (count))
 625 #define ATA_OUTSL_STRM(res, offset, addr, count) \
 626         bus_write_multi_stream_4((res), (offset), (addr), (count))
 627
 628 #define ATA_IDX_INB(ch, idx) \
 629         ATA_INB(ch->r_io[idx].res, ch->r_io[idx].offset)
 630
 631 #define ATA_IDX_INW(ch, idx) \
 632         ATA_INW(ch->r_io[idx].res, ch->r_io[idx].offset)
 633
 634 #define ATA_IDX_INL(ch, idx) \
 635         ATA_INL(ch->r_io[idx].res, ch->r_io[idx].offset)
 636
 637 #define ATA_IDX_INSW(ch, idx, addr, count) \
 638         ATA_INSW(ch->r_io[idx].res, ch->r_io[idx].offset, addr, count)
 639
 640 #define ATA_IDX_INSW_STRM(ch, idx, addr, count) \
 641         ATA_INSW_STRM(ch->r_io[idx].res, ch->r_io[idx].offset, addr, count)
 642
 643 #define ATA_IDX_INSL(ch, idx, addr, count) \
 644         ATA_INSL(ch->r_io[idx].res, ch->r_io[idx].offset, addr, count)
 645
 646 #define ATA_IDX_INSL_STRM(ch, idx, addr, count) \
 647         ATA_INSL_STRM(ch->r_io[idx].res, ch->r_io[idx].offset, addr, count)
 648
 649 #define ATA_IDX_OUTB(ch, idx, value) \
 650         ATA_OUTB(ch->r_io[idx].res, ch->r_io[idx].offset, value)
 651
 652 #define ATA_IDX_OUTW(ch, idx, value) \
 653         ATA_OUTW(ch->r_io[idx].res, ch->r_io[idx].offset, value)
 654
 655 #define ATA_IDX_OUTL(ch, idx, value) \
 656         ATA_OUTL(ch->r_io[idx].res, ch->r_io[idx].offset, value)
 657
 658 #define ATA_IDX_OUTSW(ch, idx, addr, count) \
 659         ATA_OUTSW(ch->r_io[idx].res, ch->r_io[idx].offset, addr, count)
 660
 661 #define ATA_IDX_OUTSW_STRM(ch, idx, addr, count) \
 662         ATA_OUTSW_STRM(ch->r_io[idx].res, ch->r_io[idx].offset, addr, count)
 663
 664 #define ATA_IDX_OUTSL(ch, idx, addr, count) \
 665         ATA_OUTSL(ch->r_io[idx].res, ch->r_io[idx].offset, addr, count)
 666
 667 #define ATA_IDX_OUTSL_STRM(ch, idx, addr, count) \
 668         ATA_OUTSL_STRM(ch->r_io[idx].res, ch->r_io[idx].offset, addr, count)