xref: /freebsd/sys/dev/ata/ata-all.h (revision 6e8394b8baa7d5d9153ab90de6824bcd19b3b4e1)
1 /*-
2  * Copyright (c) 1998,1999 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  *	$Id: ata-all.h,v 1.5 1999/03/28 18:57:18 sos Exp $
29  */
30 
31 /* ATA register defines */
32 #define ATA_DATA			0x00	/* data register */
33 #define	ATA_ERROR			0x01	/* (R) error register */
34 #define ATA_FEATURE			0x01	/* (W) feature register */
35 #define		ATA_F_DMA		0x01	/* enable DMA */
36 #define		ATA_F_OVL		0x02	/* enable overlap */
37 
38 #define ATA_COUNT			0x02	/* (W) sector count */
39 #define ATA_IREASON			0x02	/* (R) interrupt reason */
40 #define		ATA_I_CMD		0x01	/* cmd (1) | data (0) */
41 #define		ATA_I_IN		0x02	/* read (1) | write (0) */
42 #define		ATA_I_RELEASE		0x04	/* released bus (1) */
43 #define		ATA_I_TAGMASK		0xf8	/* tag mask */
44 
45 #define	ATA_SECTOR			0x03	/* sector # */
46 #define	ATA_CYL_LSB			0x04	/* cylinder# LSB */
47 #define	ATA_CYL_MSB			0x05	/* cylinder# MSB */
48 #define ATA_DRIVE			0x06	/* Sector/Drive/Head register */
49 #define		ATA_D_LBA		0x40	/* use LBA adressing */
50 #define		ATA_D_IBM		0xa0	/* 512 byte sectors, ECC */
51 
52 #define ATA_CMD				0x07	/* command register */
53 #define		ATA_C_ATA_IDENTIFY	0xec	/* get ATA params */
54 #define		ATA_C_ATAPI_IDENTIFY	0xa1	/* get ATAPI params*/
55 #define		ATA_C_READ		0x20	/* read command */
56 #define		ATA_C_WRITE		0x30	/* write command */
57 #define		ATA_C_READ_MULTI	0xc4	/* read multi command */
58 #define		ATA_C_WRITE_MULTI	0xc5	/* write multi command */
59 #define		ATA_C_SET_MULTI		0xc6	/* set multi size command */
60 #define		ATA_C_READ_DMA		0xc8	/* read w/DMA command */
61 #define		ATA_C_WRITE_DMA		0xca	/* write w/DMA command */
62 #define		ATA_C_PACKET_CMD	0xa0	/* packet command */
63 #define		ATA_C_SETFEATURES	0xef	/* features command */
64 #define		    ATA_C_FEA_SETXFER	0x03	/* set transfer mode */
65 
66 #define ATA_STATUS			0x07	/* status register */
67 #define		ATA_S_ERROR		0x01	/* error */
68 #define		ATA_S_INDEX		0x02	/* index */
69 #define		ATA_S_CORR		0x04	/* data corrected */
70 #define		ATA_S_DRQ		0x08	/* data request */
71 #define		ATA_S_DSC		0x10	/* drive seek completed */
72 #define		ATA_S_SERV		0x10	/* drive needs service */
73 #define		ATA_S_DWF		0x20	/* drive write fault */
74 #define		ATA_S_DMRD		0x20	/* DMA ready */
75 #define		ATA_S_DRDY		0x40	/* drive ready */
76 #define		ATA_S_BSY		0x80	/* busy */
77 
78 #define ATA_ALTPORT			0x206	/* alternate Status register */
79 #define 	ATA_A_IDS		0x02	/* disable interrupts */
80 #define		ATA_A_RESET		0x04	/* RESET controller */
81 #define 	ATA_A_4BIT		0x08	/* 4 head bits */
82 
83 /* misc defines */
84 #define	ATA_MASTER			0x00
85 #define	ATA_SLAVE			0x10
86 #define	ATA_IOSIZE			0x08
87 #define ATA_OP_FINISHED			0x00
88 #define ATA_OP_CONTINUES		0x01
89 
90 /* devices types */
91 #define ATA_ATA_MASTER			0x01
92 #define ATA_ATA_SLAVE			0x02
93 #define ATA_ATAPI_MASTER		0x04
94 #define ATA_ATAPI_SLAVE			0x08
95 
96 /* busmaster DMA related defines */
97 #define ATA_BM_OFFSET1			0x08
98 #define ATA_DMA_ENTRIES			256
99 #define ATA_DMA_EOT			0x80000000
100 
101 #define ATA_BMCMD_PORT			0x00
102 #define ATA_BMCMD_START_STOP		0x01
103 #define ATA_BMCMD_WRITE_READ		0x08
104 
105 #define ATA_BMSTAT_PORT			0x02
106 #define ATA_BMSTAT_MASK			0x07
107 #define ATA_BMSTAT_ACTIVE		0x01
108 #define ATA_BMSTAT_ERROR		0x02
109 #define ATA_BMSTAT_INTERRUPT		0x04
110 #define ATA_BMSTAT_DMA_MASTER		0x20
111 #define ATA_BMSTAT_DMA_SLAVE		0x40
112 
113 #define ATA_BMDTP_PORT			0x04
114 
115 #define ATA_WDMA2			0x22
116 #define ATA_UDMA2			0x42
117 
118 /* structure for holding DMA address data */
119 struct ata_dmaentry {
120         u_int32_t base;
121         u_int32_t count;
122 };
123 
124 /* structure describing an ATA device */
125 struct ata_softc {
126     int32_t			unit;		/* unit on this controller */
127     int32_t			lun;		/* logical unit # */
128     struct device		*dev;		/* device handle */
129     int32_t			ioaddr;		/* port addr */
130     int32_t			altioaddr;	/* alternate port addr */
131     int32_t			bmaddr;		/* bus master DMA port */
132     struct ata_dmaentry		*dmatab[2];	/* DMA transfer tables */
133     int32_t			flags;		/* controller flags */
134     int32_t			devices;	/* what is present */
135     u_int8_t			status;		/* last controller status */
136     u_int8_t			error;		/* last controller error */
137     int32_t			active;		/* active processing request */
138 #define		ATA_IDLE		0x0
139 #define		ATA_IMMEDIATE		0x0
140 #define		ATA_WAIT_INTR		0x1
141 #define		ATA_IGNORE_INTR		0x2
142 #define		ATA_ACTIVE_ATA		0x3
143 #define		ATA_ACTIVE_ATAPI	0x4
144 
145     struct buf_queue_head       ata_queue;      /* head of ATA queue */
146     TAILQ_HEAD(, atapi_request) atapi_queue;    /* head of ATAPI queue */
147 };
148 
149 #define MAXATA	8
150 
151 extern struct ata_softc *atadevices[];
152 
153 /* public prototypes */
154 void ata_start(struct ata_softc *);
155 int32_t ata_wait(struct ata_softc *, int32_t, u_int8_t);
156 int32_t ata_command(struct ata_softc *, int32_t, u_int32_t, u_int32_t, u_int32_t, u_int32_t, u_int32_t, u_int32_t, int32_t);
157 int32_t ata_dmainit(struct ata_softc *, int32_t, int32_t, int32_t, int32_t);
158 int32_t ata_dmasetup(struct ata_softc *, int32_t, int8_t *, int32_t, int32_t);
159 void ata_dmastart(struct ata_softc *, int32_t);
160 int32_t ata_dmastatus(struct ata_softc *, int32_t);
161 int32_t ata_dmadone(struct ata_softc *, int32_t);
162 void bswap(int8_t *, int32_t);
163 void btrim(int8_t *, int32_t);
164 void bpack(int8_t *, int8_t *, int32_t);
165 
166