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 --- 11 unchanged lines hidden (view full) --- 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: head/sys/dev/ata/ata-all.h 66070 2000-09-19 11:08:39Z sos $ |
29 */ 30 31/* ATA register defines */ 32#define ATA_DATA 0x00 /* data register */ 33#define ATA_ERROR 0x01 /* (R) error register */ 34#define ATA_E_NM 0x02 /* no media */ 35#define ATA_E_ABORT 0x04 /* command aborted */ 36#define ATA_E_MCR 0x08 /* media change request */ --- 16 unchanged lines hidden (view full) --- 53#define ATA_SECTOR 0x03 /* sector # */ 54#define ATA_CYL_LSB 0x04 /* cylinder# LSB */ 55#define ATA_CYL_MSB 0x05 /* cylinder# MSB */ 56#define ATA_DRIVE 0x06 /* Sector/Drive/Head register */ 57#define ATA_D_LBA 0x40 /* use LBA adressing */ 58#define ATA_D_IBM 0xa0 /* 512 byte sectors, ECC */ 59 60#define ATA_CMD 0x07 /* command register */ |
61#define ATA_C_NOP 0x00 /* NOP command */ 62#define ATA_C_F_FLUSHQUEUE 0x00 /* flush queued cmd's */ 63#define ATA_C_F_AUTOPOLL 0x01 /* start autopoll function */ |
64#define ATA_C_ATAPI_RESET 0x08 /* reset ATAPI device */ 65#define ATA_C_READ 0x20 /* read command */ 66#define ATA_C_WRITE 0x30 /* write command */ 67#define ATA_C_PACKET_CMD 0xa0 /* packet command */ 68#define ATA_C_ATAPI_IDENTIFY 0xa1 /* get ATAPI params*/ |
69#define ATA_C_SERVICE 0xa2 /* service command */ |
70#define ATA_C_READ_MUL 0xc4 /* read multi command */ 71#define ATA_C_WRITE_MUL 0xc5 /* write multi command */ 72#define ATA_C_SET_MULTI 0xc6 /* set multi size command */ |
73#define ATA_C_READ_DMA_QUEUED 0xc7 /* read w/DMA QUEUED command */ |
74#define ATA_C_READ_DMA 0xc8 /* read w/DMA command */ 75#define ATA_C_WRITE_DMA 0xca /* write w/DMA command */ |
76#define ATA_C_WRITE_DMA_QUEUED 0xcc /* write w/DMA QUEUED command */ |
77#define ATA_C_ATA_IDENTIFY 0xec /* get ATA params */ 78#define ATA_C_SETFEATURES 0xef /* features command */ 79#define ATA_C_F_SETXFER 0x03 /* set transfer mode */ |
80#define ATA_C_F_ENAB_WCACHE 0x02 /* enable write cache */ |
81#define ATA_C_F_ENAB_SRVIRQ 0x5e /* enable service interrupt */ 82#define ATA_C_F_ENAB_RCACHE 0xaa /* enable readahead cache */ 83#define ATA_C_F_DIS_RELIRQ 0xdd /* disable release interrupt */ 84#define ATA_C_F_DIS_SRVIRQ 0xde /* disable service interrupt */ |
85 86#define ATA_STATUS 0x07 /* status register */ 87#define ATA_S_ERROR 0x01 /* error */ 88#define ATA_S_INDEX 0x02 /* index */ 89#define ATA_S_CORR 0x04 /* data corrected */ 90#define ATA_S_DRQ 0x08 /* data request */ 91#define ATA_S_DSC 0x10 /* drive seek completed */ 92#define ATA_S_SERVICE 0x10 /* drive needs service */ 93#define ATA_S_DWF 0x20 /* drive write fault */ 94#define ATA_S_DMA 0x20 /* DMA ready */ 95#define ATA_S_READY 0x40 /* drive ready */ 96#define ATA_S_BUSY 0x80 /* busy */ 97 |
98#define ATA_ALTSTAT 0x02 /* alternate status register */ 99#define ATA_ALTCTRL 0X02 /* alternate device control */ |
100#define ATA_A_IDS 0x02 /* disable interrupts */ 101#define ATA_A_RESET 0x04 /* RESET controller */ 102#define ATA_A_4BIT 0x08 /* 4 head bits */ 103 |
104#define ATA_ALTPORT 0x204 /* alternate registers offset */ 105#define ATA_ALTIOSIZE 0x01 /* alternate registers size */ |
106 107/* misc defines */ 108#define ATA_MASTER 0x00 109#define ATA_SLAVE 0x10 110#define ATA_IOSIZE 0x08 111#define ATA_OP_FINISHED 0x00 112#define ATA_OP_CONTINUES 0x01 113#define ATA_DEV(unit) ((unit == ATA_MASTER) ? 0 : 1) |
114#define ATA_PARAM(scp, unit) (scp->dev_param[ATA_DEV(unit)]) |
115 |
116/* busmaster DMA related defines */ 117#define ATA_BM_OFFSET1 0x08 118#define ATA_DMA_ENTRIES 256 119#define ATA_DMA_EOT 0x80000000 120 121#define ATA_BMCMD_PORT 0x00 122#define ATA_BMCMD_START_STOP 0x01 123#define ATA_BMCMD_WRITE_READ 0x08 --- 36 unchanged lines hidden (view full) --- 160#define ATAPI_TYPE_CDROM 5 /* CD-ROM device */ 161#define ATAPI_TYPE_OPTICAL 7 /* optical disk */ 162 163 u_int8_t :1; 164 u_int8_t proto :2; /* command protocol */ 165#define ATAPI_PROTO_ATAPI 2 166 167 u_int16_t cylinders; /* number of cylinders */ |
168 u_int16_t reserved2; |
169 u_int16_t heads; /* # heads */ |
170 u_int16_t unfbytespertrk; /* # unformatted bytes/track */ 171 u_int16_t unfbytes; /* # unformatted bytes/sector */ |
172 u_int16_t sectors; /* # sectors/track */ |
173 u_int16_t vendorunique0[3]; 174 u_int8_t serial[20]; /* serial number */ 175 u_int16_t buffertype; /* buffer type */ |
176#define ATA_BT_SINGLEPORTSECTOR 1 /* 1 port, 1 sector buffer */ 177#define ATA_BT_DUALPORTMULTI 2 /* 2 port, mult sector buffer */ 178#define ATA_BT_DUALPORTMULTICACHE 3 /* above plus track cache */ 179 |
180 u_int16_t buffersize; /* buf size, 512-byte units */ 181 u_int16_t necc; /* ecc bytes appended */ 182 u_int8_t revision[8]; /* firmware revision */ 183 u_int8_t model[40]; /* model name */ 184 u_int8_t nsecperint; /* sectors per interrupt */ 185 u_int8_t vendorunique1; 186 u_int16_t usedmovsd; /* double word read/write? */ |
187 188 u_int8_t vendorcap; /* vendor capabilities */ 189 u_int8_t dmaflag :1; /* DMA supported - always 1 */ 190 u_int8_t lbaflag :1; /* LBA supported - always 1 */ 191 u_int8_t iordydis :1; /* IORDY may be disabled */ 192 u_int8_t iordyflag :1; /* IORDY supported */ 193 u_int8_t softreset :1; /* needs softreset when busy */ 194 u_int8_t stdby_ovlap :1; /* standby/overlap supported */ |
195 u_int8_t queueing :1; /* supports queuing overlap */ |
196 u_int8_t idmaflag :1; /* interleaved DMA supported */ |
197 u_int16_t capvalidate; /* validation for above */ |
198 |
199 u_int8_t vendorunique3; 200 u_int8_t opiomode; /* PIO modes 0-2 */ 201 u_int8_t vendorunique4; 202 u_int8_t odmamode; /* old DMA modes, not ATA-3 */ |
203 |
204 u_int16_t atavalid; /* fields valid */ |
205#define ATA_FLAG_54_58 1 /* words 54-58 valid */ 206#define ATA_FLAG_64_70 2 /* words 64-70 valid */ 207#define ATA_FLAG_88 4 /* word 88 valid */ 208 |
209 u_int16_t currcyls; 210 u_int16_t currheads; 211 u_int16_t currsectors; 212 u_int16_t currsize0; 213 u_int16_t currsize1; 214 u_int8_t currmultsect; 215 u_int8_t multsectvalid; 216 u_int32_t lbasize; |
217 |
218 u_int16_t sdmamodes; /* singleword DMA modes */ 219 u_int16_t wdmamodes; /* multiword DMA modes */ 220 u_int16_t apiomodes; /* advanced PIO modes */ |
221 222 u_int16_t mwdmamin; /* min. M/W DMA time/word ns */ 223 u_int16_t mwdmarec; /* rec. M/W DMA time ns */ 224 u_int16_t pioblind; /* min. PIO cycle w/o flow */ 225 u_int16_t pioiordy; /* min. PIO cycle IORDY flow */ 226 |
227 u_int16_t reserved69; 228 u_int16_t reserved70; |
229 u_int16_t rlsovlap; /* rel time (us) for overlap */ 230 u_int16_t rlsservice; /* rel time (us) for service */ |
231 u_int16_t reserved73; 232 u_int16_t reserved74; 233 u_int16_t queuelen:5; 234 u_int16_t :11; 235 u_int16_t reserved76; 236 u_int16_t reserved77; 237 u_int16_t reserved78; 238 u_int16_t reserved79; 239 u_int16_t versmajor; 240 u_int16_t versminor; 241 u_int16_t featsupp1; /* 82 */ 242 u_int16_t supmicrocode:1; 243 u_int16_t supqueued:1; 244 u_int16_t supcfa:1; 245 u_int16_t supapm:1; 246 u_int16_t suprmsn:1; 247 u_int16_t :11; 248 u_int16_t featsupp3; /* 84 */ 249 u_int16_t featenab1; /* 85 */ 250 u_int16_t enabmicrocode:1; 251 u_int16_t enabqueued:1; 252 u_int16_t enabcfa:1; 253 u_int16_t enabapm:1; 254 u_int16_t enabrmsn:1; 255 u_int16_t :11; 256 u_int16_t featenab3; /* 87 */ 257 u_int16_t udmamodes; /* UltraDMA modes */ 258 u_int16_t erasetime; 259 u_int16_t enherasetime; 260 u_int16_t apmlevel; 261 u_int16_t masterpasswdrev; |
262 u_int16_t masterhwres :8; 263 u_int16_t slavehwres :5; 264 u_int16_t cblid :1; 265 u_int16_t reserved93_1415 :2; |
266 u_int16_t reserved94[32]; 267 u_int16_t rmvstat; 268 u_int16_t securstat; 269 u_int16_t reserved129[30]; 270 u_int16_t cfapwrmode; 271 u_int16_t reserved161[84]; 272 u_int16_t integrity; |
273}; 274 275/* structure describing an ATA device */ 276struct ata_softc { 277 struct device *dev; /* device handle */ |
278 int unit; /* unit on this controller */ |
279 struct resource *r_io; /* io addr resource handle */ 280 struct resource *r_altio; /* altio addr resource handle */ 281 struct resource *r_bmio; /* bmio addr resource handle */ 282 struct resource *r_irq; /* interrupt of this channel */ 283 void *ih; /* interrupt handle */ |
284 u_int32_t ioaddr; /* physical port addr */ 285 u_int32_t altioaddr; /* physical alt port addr */ 286 u_int32_t bmaddr; /* physical bus master port */ 287 u_int32_t chiptype; /* pciid of controller chip */ 288 u_int32_t alignment; /* dma engine min alignment */ |
289 struct ata_params *dev_param[2]; /* ptr to devices params */ 290 void *dev_softc[2]; /* ptr to devices softc's */ |
291 int mode[2]; /* transfer mode for devices */ |
292#define ATA_PIO 0x00 293#define ATA_PIO0 0x08 294#define ATA_PIO1 0x09 295#define ATA_PIO2 0x0a 296#define ATA_PIO3 0x0b 297#define ATA_PIO4 0x0c 298#define ATA_DMA 0x10 299#define ATA_WDMA2 0x22 300#define ATA_UDMA2 0x42 301#define ATA_UDMA4 0x44 302#define ATA_UDMA5 0x45 303 |
304 int flags; /* controller flags */ |
305#define ATA_DMA_ACTIVE 0x01 306#define ATA_ATAPI_DMA_RO 0x02 307#define ATA_USE_16BIT 0x04 308#define ATA_ATTACHED 0x08 |
309#define ATA_QUEUED 0x10 |
310 |
311 int devices; /* what is present */ |
312#define ATA_ATA_MASTER 0x01 313#define ATA_ATA_SLAVE 0x02 314#define ATA_ATAPI_MASTER 0x04 315#define ATA_ATAPI_SLAVE 0x08 316 317 u_int8_t status; /* last controller status */ 318 u_int8_t error; /* last controller error */ |
319 int active; /* active processing request */ |
320#define ATA_IDLE 0x0 321#define ATA_IMMEDIATE 0x1 322#define ATA_WAIT_INTR 0x2 323#define ATA_WAIT_READY 0x3 324#define ATA_ACTIVE 0x4 325#define ATA_ACTIVE_ATA 0x5 326#define ATA_ACTIVE_ATAPI 0x6 327#define ATA_REINITING 0x7 328 329 TAILQ_HEAD(, ad_request) ata_queue; /* head of ATA queue */ 330 TAILQ_HEAD(, atapi_request) atapi_queue; /* head of ATAPI queue */ 331 void *running; /* currently running request */ 332}; 333 334/* To convert unit numbers to devices */ 335extern devclass_t ata_devclass; 336 337/* public prototypes */ 338void ata_start(struct ata_softc *); |
339void ata_reset(struct ata_softc *, int *); 340int ata_reinit(struct ata_softc *); 341int ata_wait(struct ata_softc *, int, u_int8_t); 342int ata_command(struct ata_softc *, int, u_int8_t, u_int16_t, u_int8_t, u_int8_t, u_int8_t, u_int8_t, int); 343int ata_printf(struct ata_softc *, int, const char *, ...) __printflike(3, 4); |
344int ata_get_lun(u_int32_t *); 345void ata_free_lun(u_int32_t *, int); |
346char *ata_mode2str(int); 347int ata_pio2mode(int); |
348int ata_pmode(struct ata_params *); 349int ata_wmode(struct ata_params *); 350int ata_umode(struct ata_params *); 351#if NPCI > 0 |
352int ata_find_dev(device_t, u_int32_t, u_int32_t); |
353#endif 354 |
355void *ata_dmaalloc(struct ata_softc *, int); 356void ata_dmainit(struct ata_softc *, int, int, int, int); 357int ata_dmasetup(struct ata_softc *, int, struct ata_dmaentry *, caddr_t, int); 358void ata_dmastart(struct ata_softc *, int, struct ata_dmaentry *, int); 359int ata_dmastatus(struct ata_softc *); 360int ata_dmadone(struct ata_softc *); |