xref: /freebsd/sys/dev/ahci/ahci_generic.c (revision 6be3386466ab79a84b48429ae66244f21526d3df)
1 /*-
2  * Copyright (c) 2009-2012 Alexander Motin <mav@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_acpi.h"
31 #include "opt_platform.h"
32 
33 #include <sys/param.h>
34 #include <sys/module.h>
35 #include <sys/systm.h>
36 #include <sys/kernel.h>
37 #include <sys/bus.h>
38 #include <sys/conf.h>
39 #include <sys/endian.h>
40 #include <sys/malloc.h>
41 #include <sys/lock.h>
42 #include <sys/mutex.h>
43 #include <sys/rman.h>
44 
45 #include <machine/bus.h>
46 #include <machine/resource.h>
47 
48 #include <dev/ahci/ahci.h>
49 
50 #ifdef DEV_ACPI
51 #include <contrib/dev/acpica/include/acpi.h>
52 #include <dev/acpica/acpivar.h>
53 
54 #include <dev/pci/pcivar.h>
55 #include <dev/pci/pcireg.h>
56 #endif
57 
58 #ifdef FDT
59 #include <dev/ofw/ofw_bus.h>
60 #include <dev/ofw/ofw_bus_subr.h>
61 
62 static struct ofw_compat_data compat_data[] = {
63 	{"generic-ahci", 		1},
64 	{"snps,dwc-ahci",		1},
65 	{"marvell,armada-3700-ahci",	1},
66 	{NULL,				0}
67 };
68 
69 static int
70 ahci_fdt_probe(device_t dev)
71 {
72 	struct ahci_controller *ctlr = device_get_softc(dev);
73 	phandle_t node;
74 
75 	if (!ofw_bus_status_okay(dev))
76 		return (ENXIO);
77 
78 	if (!ofw_bus_search_compatible(dev, compat_data)->ocd_data)
79 		return (ENXIO);
80 
81 	device_set_desc_copy(dev, "AHCI SATA controller");
82 	node = ofw_bus_get_node(dev);
83 	ctlr->dma_coherent = OF_hasprop(node, "dma-coherent");
84 	return (BUS_PROBE_DEFAULT);
85 }
86 #endif
87 
88 #ifdef DEV_ACPI
89 
90 static const struct ahci_acpi_quirk {
91 	const char*	hid;
92 	u_int		quirks;
93 } ahci_acpi_quirks[] = {
94 	{ "NXP0004", AHCI_Q_NOPMP },
95 	{ NULL, 0 }
96 };
97 
98 
99 static int
100 ahci_acpi_probe(device_t dev)
101 {
102 	struct ahci_controller *ctlr = device_get_softc(dev);
103 	ACPI_HANDLE h;
104 	int i;
105 
106 	if ((h = acpi_get_handle(dev)) == NULL)
107 		return (ENXIO);
108 
109 	if (pci_get_class(dev) == PCIC_STORAGE &&
110 	    pci_get_subclass(dev) == PCIS_STORAGE_SATA &&
111 	    pci_get_progif(dev) == PCIP_STORAGE_SATA_AHCI_1_0) {
112 		device_set_desc_copy(dev, "AHCI SATA controller");
113 		if (ACPI_FAILURE(acpi_GetInteger(h, "_CCA",
114 		      &ctlr->dma_coherent)))
115 			ctlr->dma_coherent = 0;
116 		if (bootverbose)
117 			device_printf(dev, "Bus is%s cache-coherent\n",
118 			  ctlr->dma_coherent ? "" : " not");
119 		for (i = 0; ahci_acpi_quirks[i].hid != NULL; i++) {
120 			if (acpi_MatchHid(h, ahci_acpi_quirks[i].hid) != ACPI_MATCHHID_NOMATCH) {
121 				ctlr->quirks = ahci_acpi_quirks[i].quirks;
122 				break;
123 			}
124 		}
125 		return (BUS_PROBE_DEFAULT);
126 	}
127 
128 	return (ENXIO);
129 }
130 #endif
131 
132 static int
133 ahci_gen_ctlr_reset(device_t dev)
134 {
135 
136 	return ahci_ctlr_reset(dev);
137 }
138 
139 static int
140 ahci_gen_attach(device_t dev)
141 {
142 	struct ahci_controller *ctlr = device_get_softc(dev);
143 	int	error;
144 
145 	ctlr->r_rid = 0;
146 	ctlr->r_mem = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &ctlr->r_rid,
147 	    RF_ACTIVE);
148 	if (ctlr->r_mem == NULL)
149 		return (ENXIO);
150 
151 	/* Setup controller defaults. */
152 	ctlr->numirqs = 1;
153 
154 	/* Reset controller */
155 	if ((error = ahci_gen_ctlr_reset(dev)) == 0)
156 		error = ahci_attach(dev);
157 
158 	if (error != 0) {
159 		if (ctlr->r_mem != NULL)
160 			bus_release_resource(dev, SYS_RES_MEMORY, ctlr->r_rid,
161 			    ctlr->r_mem);
162 	}
163 	return error;
164 }
165 
166 static int
167 ahci_gen_detach(device_t dev)
168 {
169 
170 	ahci_detach(dev);
171 	return (0);
172 }
173 
174 #ifdef FDT
175 static devclass_t ahci_gen_fdt_devclass;
176 static device_method_t ahci_fdt_methods[] = {
177 	DEVMETHOD(device_probe,     ahci_fdt_probe),
178 	DEVMETHOD(device_attach,    ahci_gen_attach),
179 	DEVMETHOD(device_detach,    ahci_gen_detach),
180 	DEVMETHOD(bus_print_child,  ahci_print_child),
181 	DEVMETHOD(bus_alloc_resource,       ahci_alloc_resource),
182 	DEVMETHOD(bus_release_resource,     ahci_release_resource),
183 	DEVMETHOD(bus_setup_intr,   ahci_setup_intr),
184 	DEVMETHOD(bus_teardown_intr,ahci_teardown_intr),
185 	DEVMETHOD(bus_child_location_str, ahci_child_location_str),
186 	DEVMETHOD(bus_get_dma_tag,  ahci_get_dma_tag),
187 	DEVMETHOD_END
188 };
189 static driver_t ahci_fdt_driver = {
190 	"ahci",
191 	ahci_fdt_methods,
192 	sizeof(struct ahci_controller)
193 };
194 DRIVER_MODULE(ahci_fdt, simplebus, ahci_fdt_driver, ahci_gen_fdt_devclass,
195     NULL, NULL);
196 #endif
197 
198 #ifdef DEV_ACPI
199 static devclass_t ahci_gen_acpi_devclass;
200 static device_method_t ahci_acpi_methods[] = {
201 	DEVMETHOD(device_probe,     ahci_acpi_probe),
202 	DEVMETHOD(device_attach,    ahci_gen_attach),
203 	DEVMETHOD(device_detach,    ahci_gen_detach),
204 	DEVMETHOD(bus_print_child,  ahci_print_child),
205 	DEVMETHOD(bus_alloc_resource,       ahci_alloc_resource),
206 	DEVMETHOD(bus_release_resource,     ahci_release_resource),
207 	DEVMETHOD(bus_setup_intr,   ahci_setup_intr),
208 	DEVMETHOD(bus_teardown_intr,ahci_teardown_intr),
209 	DEVMETHOD(bus_child_location_str, ahci_child_location_str),
210 	DEVMETHOD(bus_get_dma_tag,  ahci_get_dma_tag),
211 	DEVMETHOD_END
212 };
213 static driver_t ahci_acpi_driver = {
214 	"ahci",
215 	ahci_acpi_methods,
216 	sizeof(struct ahci_controller)
217 };
218 DRIVER_MODULE(ahci_acpi, acpi, ahci_acpi_driver, ahci_gen_acpi_devclass,
219     NULL, NULL);
220 #endif
221