xref: /freebsd/sys/dev/ata/ata-sata.c (revision 066f913a94b134b6d5e32b6af88f297c7da9c031)
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 
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
29 
30 #include "opt_ata.h"
31 #include <sys/param.h>
32 #include <sys/systm.h>
33 #include <sys/kernel.h>
34 #include <sys/ata.h>
35 #include <sys/bus.h>
36 #include <sys/endian.h>
37 #include <sys/malloc.h>
38 #include <sys/lock.h>
39 #include <sys/mutex.h>
40 #include <sys/sema.h>
41 #include <sys/taskqueue.h>
42 #include <vm/uma.h>
43 #include <machine/stdarg.h>
44 #include <machine/resource.h>
45 #include <machine/bus.h>
46 #include <sys/rman.h>
47 #include <dev/ata/ata-all.h>
48 #include <ata_if.h>
49 
50 void
51 ata_sata_phy_check_events(device_t dev)
52 {
53     struct ata_channel *ch = device_get_softc(dev);
54     u_int32_t error = ATA_IDX_INL(ch, ATA_SERROR);
55 
56     /* clear error bits/interrupt */
57     ATA_IDX_OUTL(ch, ATA_SERROR, error);
58 
59     /* if we have a connection event deal with it */
60     if ((error & ATA_SE_PHY_CHANGED) && (ch->pm_level == 0)) {
61 	if (bootverbose) {
62 	    u_int32_t status = ATA_IDX_INL(ch, ATA_SSTATUS);
63 	    if (((status & ATA_SS_CONWELL_MASK) == ATA_SS_CONWELL_GEN1) ||
64 		((status & ATA_SS_CONWELL_MASK) == ATA_SS_CONWELL_GEN2)) {
65 		    device_printf(dev, "CONNECT requested\n");
66 	    } else
67 		    device_printf(dev, "DISCONNECT requested\n");
68 	}
69 	taskqueue_enqueue(taskqueue_thread, &ch->conntask);
70     }
71 }
72 
73 int
74 ata_sata_scr_read(struct ata_channel *ch, int port, int reg, uint32_t *val)
75 {
76     int r;
77 
78     if (port < 0) {
79 	*val = ATA_IDX_INL(ch, reg);
80 	return (0);
81     } else {
82 	switch (reg) {
83 	    case ATA_SSTATUS:
84 		r = 0;
85 		break;
86 	    case ATA_SERROR:
87 		r = 1;
88 		break;
89 	    case ATA_SCONTROL:
90 		r = 2;
91 		break;
92 	    default:
93 		return (EINVAL);
94 	}
95 	return (ch->hw.pm_read(ch->dev, port, r, val));
96     }
97 }
98 
99 int
100 ata_sata_scr_write(struct ata_channel *ch, int port, int reg, uint32_t val)
101 {
102     int r;
103 
104     if (port < 0) {
105 	ATA_IDX_OUTL(ch, reg, val);
106 	return (0);
107     } else {
108 	switch (reg) {
109 	    case ATA_SERROR:
110 		r = 1;
111 		break;
112 	    case ATA_SCONTROL:
113 		r = 2;
114 		break;
115 	    default:
116 		return (EINVAL);
117 	}
118 	return (ch->hw.pm_write(ch->dev, port, r, val));
119     }
120 }
121 
122 static int
123 ata_sata_connect(struct ata_channel *ch, int port)
124 {
125     u_int32_t status;
126     int timeout;
127 
128     /* wait up to 1 second for "connect well" */
129     for (timeout = 0; timeout < 100 ; timeout++) {
130 	if (ata_sata_scr_read(ch, port, ATA_SSTATUS, &status))
131 	    return (0);
132 	if ((status & ATA_SS_CONWELL_MASK) == ATA_SS_CONWELL_GEN1 ||
133 	    (status & ATA_SS_CONWELL_MASK) == ATA_SS_CONWELL_GEN2)
134 	    break;
135 	ata_udelay(10000);
136     }
137     if (timeout >= 100) {
138 	if (bootverbose) {
139 	    if (port < 0) {
140 		device_printf(ch->dev, "SATA connect timeout status=%08x\n",
141 		    status);
142 	    } else {
143 		device_printf(ch->dev, "p%d: SATA connect timeout status=%08x\n",
144 		    port, status);
145 	    }
146 	}
147 	return 0;
148     }
149     if (bootverbose) {
150 	if (port < 0) {
151 	    device_printf(ch->dev, "SATA connect time=%dms status=%08x\n",
152 		timeout * 10, status);
153 	} else {
154 	    device_printf(ch->dev, "p%d: SATA connect time=%dms status=%08x\n",
155 		port, timeout * 10, status);
156 	}
157     }
158 
159     /* clear SATA error register */
160     ata_sata_scr_write(ch, port, ATA_SERROR, 0xffffffff);
161 
162     return 1;
163 }
164 
165 int
166 ata_sata_phy_reset(device_t dev, int port, int quick)
167 {
168     struct ata_channel *ch = device_get_softc(dev);
169     int loop, retry;
170     uint32_t val;
171 
172     if (quick) {
173 	if (ata_sata_scr_read(ch, port, ATA_SCONTROL, &val))
174 	    return (0);
175 	if ((val & ATA_SC_DET_MASK) == ATA_SC_DET_IDLE)
176 	    return ata_sata_connect(ch, port);
177     }
178 
179     if (bootverbose) {
180 	if (port < 0) {
181 	    device_printf(dev, "hardware reset ...\n");
182 	} else {
183 	    device_printf(dev, "p%d: hardware reset ...\n", port);
184 	}
185     }
186     for (retry = 0; retry < 10; retry++) {
187 	for (loop = 0; loop < 10; loop++) {
188 	    if (ata_sata_scr_write(ch, port, ATA_SCONTROL, ATA_SC_DET_RESET))
189 		return (0);
190 	    ata_udelay(100);
191 	    if (ata_sata_scr_read(ch, port, ATA_SCONTROL, &val))
192 		return (0);
193 	    if ((val & ATA_SC_DET_MASK) == ATA_SC_DET_RESET)
194 		break;
195 	}
196 	ata_udelay(5000);
197 	for (loop = 0; loop < 10; loop++) {
198 	    if (ata_sata_scr_write(ch, port, ATA_SCONTROL,
199 		    ATA_SC_DET_IDLE | ((ch->pm_level > 0) ? 0 :
200 		    ATA_SC_IPM_DIS_PARTIAL | ATA_SC_IPM_DIS_SLUMBER)))
201 		return (0);
202 	    ata_udelay(100);
203 	    if (ata_sata_scr_read(ch, port, ATA_SCONTROL, &val))
204 		return (0);
205 	    if ((val & ATA_SC_DET_MASK) == 0)
206 		return ata_sata_connect(ch, port);
207 	}
208     }
209     return 0;
210 }
211 
212 int
213 ata_sata_setmode(device_t dev, int target, int mode)
214 {
215 
216 	return (min(mode, ATA_UDMA5));
217 }
218 
219 int
220 ata_sata_getrev(device_t dev, int target)
221 {
222 	struct ata_channel *ch = device_get_softc(dev);
223 
224 	if (ch->r_io[ATA_SSTATUS].res)
225 		return ((ATA_IDX_INL(ch, ATA_SSTATUS) & 0x0f0) >> 4);
226 	return (0);
227 }
228 
229 int
230 ata_request2fis_h2d(struct ata_request *request, u_int8_t *fis)
231 {
232 
233     if (request->flags & ATA_R_ATAPI) {
234 	fis[0] = 0x27;  		/* host to device */
235 	fis[1] = 0x80 | (request->unit & 0x0f);
236 	fis[2] = ATA_PACKET_CMD;
237 	if (request->flags & (ATA_R_READ | ATA_R_WRITE))
238 	    fis[3] = ATA_F_DMA;
239 	else {
240 	    fis[5] = request->transfersize;
241 	    fis[6] = request->transfersize >> 8;
242 	}
243 	fis[7] = ATA_D_LBA;
244 	fis[15] = ATA_A_4BIT;
245 	return 20;
246     }
247     else {
248 	fis[0] = 0x27;			/* host to device */
249 	fis[1] = 0x80 | (request->unit & 0x0f);
250 	fis[2] = request->u.ata.command;
251 	fis[3] = request->u.ata.feature;
252 	fis[4] = request->u.ata.lba;
253 	fis[5] = request->u.ata.lba >> 8;
254 	fis[6] = request->u.ata.lba >> 16;
255 	fis[7] = ATA_D_LBA;
256 	if (!(request->flags & ATA_R_48BIT))
257 	    fis[7] |= (ATA_D_IBM | (request->u.ata.lba >> 24 & 0x0f));
258 	fis[8] = request->u.ata.lba >> 24;
259 	fis[9] = request->u.ata.lba >> 32;
260 	fis[10] = request->u.ata.lba >> 40;
261 	fis[11] = request->u.ata.feature >> 8;
262 	fis[12] = request->u.ata.count;
263 	fis[13] = request->u.ata.count >> 8;
264 	fis[15] = ATA_A_4BIT;
265 	return 20;
266     }
267     return 0;
268 }
269 
270 void
271 ata_pm_identify(device_t dev)
272 {
273     struct ata_channel *ch = device_get_softc(dev);
274     u_int32_t pm_chipid, pm_revision, pm_ports;
275     int port;
276 
277     /* get PM vendor & product data */
278     if (ch->hw.pm_read(dev, ATA_PM, 0, &pm_chipid)) {
279 	device_printf(dev, "error getting PM vendor data\n");
280 	return;
281     }
282 
283     /* get PM revision data */
284     if (ch->hw.pm_read(dev, ATA_PM, 1, &pm_revision)) {
285 	device_printf(dev, "error getting PM revison data\n");
286 	return;
287     }
288 
289     /* get number of HW ports on the PM */
290     if (ch->hw.pm_read(dev, ATA_PM, 2, &pm_ports)) {
291 	device_printf(dev, "error getting PM port info\n");
292 	return;
293     }
294     pm_ports &= 0x0000000f;
295 
296     /* chip specific quirks */
297     switch (pm_chipid) {
298     case 0x37261095:
299 	/* This PM declares 6 ports, while only 5 of them are real.
300 	 * Port 5 is enclosure management bridge port, which has implementation
301 	 * problems, causing probe faults. Hide it for now. */
302 	device_printf(dev, "SiI 3726 (rev=%x) Port Multiplier with %d (5) ports\n",
303 		      pm_revision, pm_ports);
304 	pm_ports = 5;
305 	break;
306 
307     case 0x47261095:
308 	/* This PM declares 7 ports, while only 5 of them are real.
309 	 * Port 5 is some fake "Config  Disk" with 640 sectors size,
310 	 * port 6 is enclosure management bridge port.
311 	 * Both fake ports has implementation problems, causing
312 	 * probe faults. Hide them for now. */
313 	device_printf(dev, "SiI 4726 (rev=%x) Port Multiplier with %d (5) ports\n",
314 		      pm_revision, pm_ports);
315 	pm_ports = 5;
316 	break;
317 
318     default:
319 	device_printf(dev, "Port Multiplier (id=%08x rev=%x) with %d ports\n",
320 		      pm_chipid, pm_revision, pm_ports);
321     }
322 
323     /* reset all ports and register if anything connected */
324     for (port=0; port < pm_ports; port++) {
325 	u_int32_t signature;
326 
327 	if (!ata_sata_phy_reset(dev, port, 1))
328 	    continue;
329 
330 	/*
331 	 * XXX: I have no idea how to properly wait for PMP port hardreset
332 	 * completion. Without this delay soft reset does not completes
333 	 * successfully.
334 	 */
335 	DELAY(1000000);
336 
337 	signature = ch->hw.softreset(dev, port);
338 
339 	if (bootverbose)
340 	    device_printf(dev, "p%d: SIGNATURE=%08x\n", port, signature);
341 
342 	/* figure out whats there */
343 	switch (signature >> 16) {
344 	case 0x0000:
345 	    ch->devices |= (ATA_ATA_MASTER << port);
346 	    continue;
347 	case 0xeb14:
348 	    ch->devices |= (ATA_ATAPI_MASTER << port);
349 	    continue;
350 	}
351     }
352 }
353