4 * Copyright (c) 2009 The DragonFly Project. All rights reserved.
6 * This code is derived from software contributed to The DragonFly Project
7 * by Matthew Dillon <dillon@backplane.com>
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
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
17 * the documentation and/or other materials provided with the
19 * 3. Neither the name of The DragonFly Project nor the names of its
20 * contributors may be used to endorse or promote products derived
21 * from this software without specific, prior written permission.
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
26 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
27 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
28 * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
29 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
30 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
31 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
33 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37 * Primary device and CAM interface to OpenBSD AHCI driver, for DragonFly
42 u_int32_t AhciForceGen = 0;
43 u_int32_t AhciNoFeatures = 0;
49 static int ahci_probe (device_t dev);
50 static int ahci_attach (device_t dev);
51 static int ahci_detach (device_t dev);
52 static int ahci_sysctl_link_pwr_mgmt (SYSCTL_HANDLER_ARGS);
54 static int ahci_shutdown (device_t dev);
55 static int ahci_suspend (device_t dev);
56 static int ahci_resume (device_t dev);
59 static void ahci_port_thread(void *arg);
61 static device_method_t ahci_methods[] = {
62 DEVMETHOD(device_probe, ahci_probe),
63 DEVMETHOD(device_attach, ahci_attach),
64 DEVMETHOD(device_detach, ahci_detach),
66 DEVMETHOD(device_shutdown, ahci_shutdown),
67 DEVMETHOD(device_suspend, ahci_suspend),
68 DEVMETHOD(device_resume, ahci_resume),
71 DEVMETHOD(bus_print_child, bus_generic_print_child),
72 DEVMETHOD(bus_driver_added, bus_generic_driver_added),
76 static devclass_t ahci_devclass;
78 static driver_t ahci_driver = {
81 sizeof(struct ahci_softc)
84 MODULE_DEPEND(ahci, cam, 1, 1, 1);
85 DRIVER_MODULE(ahci, pci, ahci_driver, ahci_devclass, 0, 0);
88 * Device bus method procedures
91 ahci_probe (device_t dev)
93 const struct ahci_device *ad;
95 if (kgetenv("hint.ahci.disabled"))
98 ad = ahci_lookup_device(dev);
100 device_set_desc(dev, ad->name);
101 return(-5); /* higher priority the NATA */
107 ahci_attach (device_t dev)
109 struct ahci_softc *sc = device_get_softc(dev);
113 sc->sc_ad = ahci_lookup_device(dev);
114 if (sc->sc_ad == NULL)
118 * Some chipsets do not properly implement the AHCI spec and may
119 * require the link speed to be specifically requested.
121 if (kgetenv("hint.ahci.force150"))
123 if (kgetenv("hint.ahci.force300"))
125 if (kgetenv("hint.ahci.force600"))
128 if (kgetenv("hint.ahci.nofeatures"))
131 sysctl_ctx_init(&sc->sysctl_ctx);
132 ksnprintf(name, sizeof(name), "%s%d",
133 device_get_name(dev), device_get_unit(dev));
134 sc->sysctl_tree = SYSCTL_ADD_NODE(&sc->sysctl_ctx,
135 SYSCTL_STATIC_CHILDREN(_hw),
136 OID_AUTO, name, CTLFLAG_RD, 0, "");
138 error = sc->sc_ad->ad_attach(dev);
140 sysctl_ctx_free(&sc->sysctl_ctx);
141 sc->sysctl_tree = NULL;
147 ahci_detach (device_t dev)
149 struct ahci_softc *sc = device_get_softc(dev);
152 if (sc->sysctl_tree) {
153 sysctl_ctx_free(&sc->sysctl_ctx);
154 sc->sysctl_tree = NULL;
157 error = sc->sc_ad->ad_detach(dev);
164 ahci_sysctl_link_pwr_mgmt (SYSCTL_HANDLER_ARGS)
166 struct ahci_port *ap = arg1;
167 int error, link_pwr_mgmt;
169 link_pwr_mgmt = ap->link_pwr_mgmt;
170 error = sysctl_handle_int(oidp, &link_pwr_mgmt, 0, req);
171 if (error || req->newptr == NULL)
174 ahci_port_link_pwr_mgmt(ap, link_pwr_mgmt);
179 ahci_sysctl_link_pwr_state (SYSCTL_HANDLER_ARGS)
181 struct ahci_port *ap = arg1;
182 const char *state_names[] = {"unknown", "active", "partial", "slumber"};
186 state = ahci_port_link_pwr_state(ap);
187 if (state < 0 || state >= NELEM(state_names))
190 ksnprintf(buf, sizeof(buf), "%s", state_names[state]);
191 return sysctl_handle_string(oidp, buf, sizeof(buf), req);
197 ahci_shutdown (device_t dev)
203 ahci_suspend (device_t dev)
209 ahci_resume (device_t dev)
217 * Sleep (ms) milliseconds, error on the side of caution.
220 ahci_os_sleep(int ms)
224 ticks = hz * ms / 1000 + 1;
225 tsleep(&ticks, 0, "ahslp", ticks);
229 * Sleep for a minimum interval and return the number of milliseconds
230 * that was. The minimum value returned is 1
233 ahci_os_softsleep(void)
236 tsleep(&ticks, 0, "ahslp", hz / 1000);
239 tsleep(&ticks, 0, "ahslp", 1);
245 ahci_os_hardsleep(int us)
251 * Create the OS-specific port helper thread and per-port lock.
254 ahci_os_start_port(struct ahci_port *ap)
258 atomic_set_int(&ap->ap_signal, AP_SIGF_INIT | AP_SIGF_THREAD_SYNC);
259 lockinit(&ap->ap_lock, "ahcipo", 0, 0);
260 lockinit(&ap->ap_sim_lock, "ahcicam", 0, LK_CANRECURSE);
261 lockinit(&ap->ap_sig_lock, "ahport", 0, 0);
262 sysctl_ctx_init(&ap->sysctl_ctx);
263 ksnprintf(name, sizeof(name), "%d", ap->ap_num);
264 ap->sysctl_tree = SYSCTL_ADD_NODE(&ap->sysctl_ctx,
265 SYSCTL_CHILDREN(ap->ap_sc->sysctl_tree),
266 OID_AUTO, name, CTLFLAG_RD, 0, "");
268 if ((ap->ap_sc->sc_cap & AHCI_REG_CAP_SALP) &&
269 (ap->ap_sc->sc_cap & (AHCI_REG_CAP_PSC | AHCI_REG_CAP_SSC))) {
270 SYSCTL_ADD_PROC(&ap->sysctl_ctx,
271 SYSCTL_CHILDREN(ap->sysctl_tree), OID_AUTO,
272 "link_pwr_mgmt", CTLTYPE_INT | CTLFLAG_RW, ap, 0,
273 ahci_sysctl_link_pwr_mgmt, "I",
274 "Link power management policy "
275 "(0 = disabled, 1 = medium, 2 = aggressive)");
276 SYSCTL_ADD_PROC(&ap->sysctl_ctx,
277 SYSCTL_CHILDREN(ap->sysctl_tree), OID_AUTO,
278 "link_pwr_state", CTLTYPE_STRING | CTLFLAG_RD, ap, 0,
279 ahci_sysctl_link_pwr_state, "A",
280 "Link power management state");
284 kthread_create(ahci_port_thread, ap, &ap->ap_thread,
289 * Stop the OS-specific port helper thread and kill the per-port lock.
292 ahci_os_stop_port(struct ahci_port *ap)
294 if (ap->sysctl_tree) {
295 sysctl_ctx_free(&ap->sysctl_ctx);
296 ap->sysctl_tree = NULL;
300 ahci_os_signal_port_thread(ap, AP_SIGF_STOP);
303 kprintf("%s: Waiting for thread to terminate\n",
305 while (ap->ap_thread)
307 kprintf("%s: thread terminated\n",
311 lockuninit(&ap->ap_lock);
315 * Add (mask) to the set of bits being sent to the per-port thread helper
316 * and wake the helper up if necessary.
319 ahci_os_signal_port_thread(struct ahci_port *ap, int mask)
321 lockmgr(&ap->ap_sig_lock, LK_EXCLUSIVE);
322 atomic_set_int(&ap->ap_signal, mask);
323 wakeup(&ap->ap_thread);
324 lockmgr(&ap->ap_sig_lock, LK_RELEASE);
328 * Unconditionally lock the port structure for access.
331 ahci_os_lock_port(struct ahci_port *ap)
333 lockmgr(&ap->ap_lock, LK_EXCLUSIVE);
337 * Conditionally lock the port structure for access.
339 * Returns 0 on success, non-zero on failure.
342 ahci_os_lock_port_nb(struct ahci_port *ap)
344 return (lockmgr(&ap->ap_lock, LK_EXCLUSIVE | LK_NOWAIT));
348 * Unlock a previously locked port.
351 ahci_os_unlock_port(struct ahci_port *ap)
353 lockmgr(&ap->ap_lock, LK_RELEASE);
357 * Per-port thread helper. This helper thread is responsible for
358 * atomically retrieving and clearing the signal mask and calling
359 * the machine-independant driver core.
365 ahci_port_thread(void *arg)
367 struct ahci_port *ap = arg;
371 * The helper thread is responsible for the initial port init,
372 * so all the ports can be inited in parallel.
374 * We also run the state machine which should do all probes.
375 * Since CAM is not attached yet we will not get out-of-order
378 ahci_os_lock_port(ap);
380 atomic_clear_int(&ap->ap_signal, AP_SIGF_THREAD_SYNC);
381 wakeup(&ap->ap_signal);
382 ahci_port_state_machine(ap, 1);
383 ahci_os_unlock_port(ap);
384 atomic_clear_int(&ap->ap_signal, AP_SIGF_INIT);
385 wakeup(&ap->ap_signal);
388 * Then loop on the helper core.
390 mask = ap->ap_signal;
391 while ((mask & AP_SIGF_STOP) == 0) {
392 atomic_clear_int(&ap->ap_signal, mask);
393 ahci_port_thread_core(ap, mask);
394 lockmgr(&ap->ap_sig_lock, LK_EXCLUSIVE);
395 if (ap->ap_signal == 0) {
396 lksleep(&ap->ap_thread, &ap->ap_sig_lock, 0,
399 lockmgr(&ap->ap_sig_lock, LK_RELEASE);
400 mask = ap->ap_signal;
402 ap->ap_thread = NULL;