2 * Copyright (c) 2009 The DragonFly Project. All rights reserved.
4 * This code is derived from software contributed to The DragonFly Project
5 * by Matthew Dillon <dillon@backplane.com>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * 3. Neither the name of The DragonFly Project nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific, prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
27 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
31 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 * Primary device and CAM interface to OpenBSD AHCI driver, for DragonFly
44 static int ahci_probe (device_t dev);
45 static int ahci_attach (device_t dev);
46 static int ahci_detach (device_t dev);
48 static int ahci_shutdown (device_t dev);
49 static int ahci_suspend (device_t dev);
50 static int ahci_resume (device_t dev);
53 static void ahci_port_thread(void *arg);
55 static device_method_t ahci_methods[] = {
56 DEVMETHOD(device_probe, ahci_probe),
57 DEVMETHOD(device_attach, ahci_attach),
58 DEVMETHOD(device_detach, ahci_detach),
60 DEVMETHOD(device_shutdown, ahci_shutdown),
61 DEVMETHOD(device_suspend, ahci_suspend),
62 DEVMETHOD(device_resume, ahci_resume),
65 DEVMETHOD(bus_print_child, bus_generic_print_child),
66 DEVMETHOD(bus_driver_added, bus_generic_driver_added),
70 static devclass_t ahci_devclass;
72 static driver_t ahci_driver = {
75 sizeof(struct ahci_softc)
78 MODULE_DEPEND(ahci, cam, 1, 1, 1);
79 DRIVER_MODULE(ahci, pci, ahci_driver, ahci_devclass, 0, 0);
82 * Device bus method procedures
85 ahci_probe (device_t dev)
87 const struct ahci_device *ad;
89 if (kgetenv("hint.ahci.disabled"))
92 ad = ahci_lookup_device(dev);
94 device_set_desc(dev, ad->name);
95 return(-5); /* higher priority the NATA */
101 ahci_attach (device_t dev)
103 struct ahci_softc *sc = device_get_softc(dev);
106 sc->sc_ad = ahci_lookup_device(dev);
107 if (sc->sc_ad == NULL)
109 error = sc->sc_ad->ad_attach(dev);
114 ahci_detach (device_t dev)
116 struct ahci_softc *sc = device_get_softc(dev);
120 error = sc->sc_ad->ad_detach(dev);
129 ahci_shutdown (device_t dev)
135 ahci_suspend (device_t dev)
141 ahci_resume (device_t dev)
149 * Sleep (ms) milliseconds, error on the side of caution.
152 ahci_os_sleep(int ms)
156 ticks = hz * ms / 1000 + 1;
157 tsleep(&ticks, 0, "ahslp", ticks);
161 * Sleep for a minimum interval and return the number of milliseconds
162 * that was. The minimum value returned is 1
165 ahci_os_softsleep(void)
168 tsleep(&ticks, 0, "ahslp", hz / 1000);
171 tsleep(&ticks, 0, "ahslp", 1);
177 ahci_os_hardsleep(int us)
183 * Create the OS-specific port helper thread and per-port lock.
186 ahci_os_start_port(struct ahci_port *ap)
188 atomic_set_int(&ap->ap_signal, AP_SIGF_INIT);
189 lockinit(&ap->ap_lock, "ahcipo", 0, 0);
190 kthread_create(ahci_port_thread, ap, &ap->ap_thread,
195 * Stop the OS-specific port helper thread and kill the per-port lock.
198 ahci_os_stop_port(struct ahci_port *ap)
201 ahci_os_signal_port_thread(ap, AP_SIGF_STOP);
204 kprintf("%s: Waiting for thread to terminate\n",
206 while (ap->ap_thread)
208 kprintf("%s: thread terminated\n",
212 lockuninit(&ap->ap_lock);
216 * Add (mask) to the set of bits being sent to the per-port thread helper
217 * and wake the helper up if necessary.
220 ahci_os_signal_port_thread(struct ahci_port *ap, int mask)
222 atomic_set_int(&ap->ap_signal, mask);
223 wakeup(&ap->ap_thread);
227 * Unconditionally lock the port structure for access.
230 ahci_os_lock_port(struct ahci_port *ap)
232 lockmgr(&ap->ap_lock, LK_EXCLUSIVE);
236 * Conditionally lock the port structure for access.
238 * Returns 0 on success, non-zero on failure.
241 ahci_os_lock_port_nb(struct ahci_port *ap)
243 return (lockmgr(&ap->ap_lock, LK_EXCLUSIVE | LK_NOWAIT));
247 * Unlock a previously locked port.
250 ahci_os_unlock_port(struct ahci_port *ap)
252 lockmgr(&ap->ap_lock, LK_RELEASE);
256 * Per-port thread helper. This helper thread is responsible for
257 * atomically retrieving and clearing the signal mask and calling
258 * the machine-independant driver core.
262 ahci_port_thread(void *arg)
264 struct ahci_port *ap = arg;
268 * The helper thread is responsible for the initial port init,
269 * so all the ports can be inited in parallel.
271 * We also run the state machine which should do all probes.
272 * Since CAM is not attached yet we will not get out-of-order
275 ahci_os_lock_port(ap);
276 ahci_port_init(ap, NULL);
277 ahci_port_state_machine(ap, 1);
278 ahci_os_unlock_port(ap);
279 atomic_clear_int(&ap->ap_signal, AP_SIGF_INIT);
280 wakeup(&ap->ap_signal);
283 * Then loop on the helper core.
285 mask = ap->ap_signal;
286 while ((mask & AP_SIGF_STOP) == 0) {
287 atomic_clear_int(&ap->ap_signal, mask);
288 ahci_port_thread_core(ap, mask);
290 tsleep_interlock(&ap->ap_thread);
291 if (ap->ap_signal == 0)
292 tsleep(&ap->ap_thread, 0, "ahport", 0);
294 mask = ap->ap_signal;
296 ap->ap_thread = NULL;