xref: /netbsd-src/sys/dev/ata/sata_subr.c (revision 7fa608457b817eca6e0977b37f758ae064f3c99c)
1 /*	$NetBSD: sata_subr.c,v 1.8 2006/11/30 23:07:31 bouyer Exp $	*/
2 
3 /*-
4  * Copyright (c) 2004 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Jason R. Thorpe of Wasabi Systems, Inc.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. All advertising materials mentioning features or use of this software
19  *    must display the following acknowledgement:
20  *	This product includes software developed by the NetBSD
21  *	Foundation, Inc. and its contributors.
22  * 4. Neither the name of The NetBSD Foundation nor the names of its
23  *    contributors may be used to endorse or promote products derived
24  *    from this software without specific prior written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
27  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
30  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36  * POSSIBILITY OF SUCH DAMAGE.
37  */
38 
39 /*
40  * Common functions for Serial ATA.
41  */
42 
43 #include <sys/param.h>
44 #include <sys/kernel.h>
45 #include <sys/proc.h>
46 
47 #include <dev/ata/satareg.h>
48 #include <dev/ata/satavar.h>
49 
50 /*
51  * sata_speed:
52  *
53  *	Return a string describing the port speed reported by
54  *	the port's SStatus register.
55  */
56 const char *
57 sata_speed(uint32_t sstatus)
58 {
59 	static const char *sata_speedtab[] = {
60 		"no negotiated speed",
61 		"1.5Gb/s",
62 		"3.0Gb/s",
63 		"<unknown 3>",
64 		"<unknown 4>",
65 		"<unknown 5>",
66 		"<unknown 6>",
67 		"<unknown 7>",
68 		"<unknown 8>",
69 		"<unknown 9>",
70 		"<unknown 10>",
71 		"<unknown 11>",
72 		"<unknown 12>",
73 		"<unknown 13>",
74 		"<unknown 14>",
75 		"<unknown 15>",
76 	};
77 
78 	return (sata_speedtab[(sstatus & SStatus_SPD_mask) >>
79 			      SStatus_SPD_shift]);
80 }
81 
82 /*
83  * reset the PHY and bring it online
84  */
85 uint32_t
86 sata_reset_interface(struct ata_channel *chp, bus_space_tag_t sata_t,
87     bus_space_handle_t scontrol_r, bus_space_handle_t sstatus_r)
88 {
89 	uint32_t scontrol, sstatus;
90 	int i;
91 
92 	/* bring the PHYs online.
93 	 * The work-around for errata #1 for the 31244 says that we must
94 	 * write 0 to the port first to be sure of correctly initializing
95 	 * the device. It doesn't hurt for other devices.
96 	 */
97 	bus_space_write_4(sata_t, scontrol_r, 0, 0);
98 	scontrol = SControl_IPM_NONE | SControl_SPD_ANY | SControl_DET_INIT;
99 	bus_space_write_4 (sata_t, scontrol_r, 0, scontrol);
100 
101 	tsleep(chp, PRIBIO, "sataup", mstohz(50));
102 	scontrol &= ~SControl_DET_INIT;
103 	bus_space_write_4(sata_t, scontrol_r, 0, scontrol);
104 
105 	tsleep(chp, PRIBIO, "sataup", mstohz(50));
106 	/* wait up to 1s for device to come up */
107 	for (i = 0; i < 100; i++) {
108 		sstatus = bus_space_read_4(sata_t, sstatus_r, 0);
109 		if ((sstatus & SStatus_DET_mask) == SStatus_DET_DEV)
110 			break;
111 		tsleep(chp, PRIBIO, "sataup", mstohz(10));
112 	}
113 
114 	switch (sstatus & SStatus_DET_mask) {
115 	case SStatus_DET_NODEV:
116 		/* No Device; be silent.  */
117 		break;
118 
119 	case SStatus_DET_DEV_NE:
120 		aprint_error("%s port %d: device connected, but "
121 		    "communication not established\n",
122 		    chp->ch_atac->atac_dev.dv_xname, chp->ch_channel);
123 		break;
124 
125 	case SStatus_DET_OFFLINE:
126 		aprint_error("%s port %d: PHY offline\n",
127 		    chp->ch_atac->atac_dev.dv_xname, chp->ch_channel);
128 		break;
129 
130 	case SStatus_DET_DEV:
131 		aprint_normal("%s port %d: device present, speed: %s\n",
132 		    chp->ch_atac->atac_dev.dv_xname, chp->ch_channel,
133 		    sata_speed(sstatus));
134 		break;
135 	default:
136 		aprint_error("%s port %d: unknown SStatus: 0x%08x\n",
137 		    chp->ch_atac->atac_dev.dv_xname, chp->ch_channel,
138 		    sstatus);
139 	}
140 	return(sstatus & SStatus_DET_mask);
141 }
142