1 /* 2 * (MPSAFE) 3 * 4 * Copyright (c) 2009 The DragonFly Project. All rights reserved. 5 * 6 * This code is derived from software contributed to The DragonFly Project 7 * by Matthew Dillon <dillon@backplane.com> 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 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 18 * distribution. 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. 22 * 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 34 * SUCH DAMAGE. 35 */ 36 /* 37 * Primary device and CAM interface to OpenBSD AHCI driver, for DragonFly 38 */ 39 40 #include "ahci.h" 41 42 u_int32_t AhciForceGen = 0; 43 u_int32_t AhciNoFeatures = 0; 44 45 /* 46 * Device bus methods 47 */ 48 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); 53 #if 0 54 static int ahci_shutdown (device_t dev); 55 static int ahci_suspend (device_t dev); 56 static int ahci_resume (device_t dev); 57 #endif 58 59 static void ahci_port_thread(void *arg); 60 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), 65 #if 0 66 DEVMETHOD(device_shutdown, ahci_shutdown), 67 DEVMETHOD(device_suspend, ahci_suspend), 68 DEVMETHOD(device_resume, ahci_resume), 69 #endif 70 71 DEVMETHOD(bus_print_child, bus_generic_print_child), 72 DEVMETHOD(bus_driver_added, bus_generic_driver_added), 73 DEVMETHOD_END 74 }; 75 76 static devclass_t ahci_devclass; 77 78 static driver_t ahci_driver = { 79 "ahci", 80 ahci_methods, 81 sizeof(struct ahci_softc) 82 }; 83 84 MODULE_DEPEND(ahci, cam, 1, 1, 1); 85 DRIVER_MODULE(ahci, pci, ahci_driver, ahci_devclass, NULL, NULL); 86 MODULE_VERSION(ahci, 1); 87 88 /* 89 * Device bus method procedures 90 */ 91 static int 92 ahci_probe (device_t dev) 93 { 94 const struct ahci_device *ad; 95 96 if (kgetenv("hint.ahci.disabled")) 97 return(ENXIO); 98 99 ad = ahci_lookup_device(dev); 100 if (ad) { 101 device_set_desc(dev, ad->name); 102 return(-5); /* higher priority the NATA */ 103 } 104 return(ENXIO); 105 } 106 107 static int 108 ahci_attach (device_t dev) 109 { 110 struct ahci_softc *sc = device_get_softc(dev); 111 char name[16]; 112 int error; 113 114 sc->sc_ad = ahci_lookup_device(dev); 115 if (sc->sc_ad == NULL) 116 return(ENXIO); 117 118 /* 119 * Some chipsets do not properly implement the AHCI spec and may 120 * require the link speed to be specifically requested. 121 */ 122 if (kgetenv("hint.ahci.force150")) 123 AhciForceGen = 1; 124 if (kgetenv("hint.ahci.force300")) 125 AhciForceGen = 2; 126 if (kgetenv("hint.ahci.force600")) 127 AhciForceGen = 3; 128 129 if (kgetenv("hint.ahci.nofeatures")) 130 AhciNoFeatures = -1; 131 132 if (kgetenv("hint.ahci.forcefbss")) 133 sc->sc_flags |= AHCI_F_FORCE_FBSS; 134 135 sysctl_ctx_init(&sc->sysctl_ctx); 136 ksnprintf(name, sizeof(name), "%s%d", 137 device_get_name(dev), device_get_unit(dev)); 138 sc->sysctl_tree = SYSCTL_ADD_NODE(&sc->sysctl_ctx, 139 SYSCTL_STATIC_CHILDREN(_hw), 140 OID_AUTO, name, CTLFLAG_RD, 0, ""); 141 142 error = sc->sc_ad->ad_attach(dev); 143 if (error) { 144 sysctl_ctx_free(&sc->sysctl_ctx); 145 sc->sysctl_tree = NULL; 146 } 147 return (error); 148 } 149 150 static int 151 ahci_detach (device_t dev) 152 { 153 struct ahci_softc *sc = device_get_softc(dev); 154 int error = 0; 155 156 if (sc->sysctl_tree) { 157 sysctl_ctx_free(&sc->sysctl_ctx); 158 sc->sysctl_tree = NULL; 159 } 160 if (sc->sc_ad) { 161 error = sc->sc_ad->ad_detach(dev); 162 sc->sc_ad = NULL; 163 } 164 return(error); 165 } 166 167 static int 168 ahci_sysctl_link_pwr_mgmt (SYSCTL_HANDLER_ARGS) 169 { 170 struct ahci_port *ap = arg1; 171 int error, link_pwr_mgmt; 172 173 link_pwr_mgmt = ap->link_pwr_mgmt; 174 error = sysctl_handle_int(oidp, &link_pwr_mgmt, 0, req); 175 if (error || req->newptr == NULL) 176 return error; 177 178 ahci_port_link_pwr_mgmt(ap, link_pwr_mgmt); 179 return 0; 180 } 181 182 static int 183 ahci_sysctl_link_pwr_state (SYSCTL_HANDLER_ARGS) 184 { 185 struct ahci_port *ap = arg1; 186 const char *state_names[] = {"unknown", "active", "partial", "slumber"}; 187 char buf[16]; 188 int state; 189 190 state = ahci_port_link_pwr_state(ap); 191 if (state < 0 || state >= NELEM(state_names)) 192 state = 0; 193 194 ksnprintf(buf, sizeof(buf), "%s", state_names[state]); 195 return sysctl_handle_string(oidp, buf, sizeof(buf), req); 196 } 197 198 #if 0 199 200 static int 201 ahci_shutdown (device_t dev) 202 { 203 return (0); 204 } 205 206 static int 207 ahci_suspend (device_t dev) 208 { 209 return (0); 210 } 211 212 static int 213 ahci_resume (device_t dev) 214 { 215 return (0); 216 } 217 218 #endif 219 220 /* 221 * Sleep (ms) milliseconds, error on the side of caution. 222 */ 223 void 224 ahci_os_sleep(int ms) 225 { 226 int ticks; 227 228 ticks = hz * ms / 1000 + 1; 229 tsleep(&ticks, 0, "ahslp", ticks); 230 } 231 232 /* 233 * Sleep for a minimum interval and return the number of milliseconds 234 * that was. The minimum value returned is 1 235 */ 236 int 237 ahci_os_softsleep(void) 238 { 239 if (hz >= 1000) { 240 tsleep(&ticks, 0, "ahslp", hz / 1000); 241 return(1); 242 } else { 243 tsleep(&ticks, 0, "ahslp", 1); 244 return(1000 / hz); 245 } 246 } 247 248 void 249 ahci_os_hardsleep(int us) 250 { 251 DELAY(us); 252 } 253 254 /* 255 * Create the OS-specific port helper thread and per-port lock. 256 */ 257 void 258 ahci_os_start_port(struct ahci_port *ap) 259 { 260 char name[16]; 261 262 atomic_set_int(&ap->ap_signal, AP_SIGF_INIT | AP_SIGF_THREAD_SYNC); 263 lockinit(&ap->ap_lock, "ahcipo", 0, LK_CANRECURSE); 264 lockinit(&ap->ap_sim_lock, "ahcicam", 0, LK_CANRECURSE); 265 lockinit(&ap->ap_sig_lock, "ahport", 0, 0); 266 sysctl_ctx_init(&ap->sysctl_ctx); 267 ksnprintf(name, sizeof(name), "%d", ap->ap_num); 268 ap->sysctl_tree = SYSCTL_ADD_NODE(&ap->sysctl_ctx, 269 SYSCTL_CHILDREN(ap->ap_sc->sysctl_tree), 270 OID_AUTO, name, CTLFLAG_RD, 0, ""); 271 272 if ((ap->ap_sc->sc_cap & AHCI_REG_CAP_SALP) && 273 (ap->ap_sc->sc_cap & (AHCI_REG_CAP_PSC | AHCI_REG_CAP_SSC))) { 274 SYSCTL_ADD_PROC(&ap->sysctl_ctx, 275 SYSCTL_CHILDREN(ap->sysctl_tree), OID_AUTO, 276 "link_pwr_mgmt", CTLTYPE_INT | CTLFLAG_RW, ap, 0, 277 ahci_sysctl_link_pwr_mgmt, "I", 278 "Link power management policy " 279 "(0 = disabled, 1 = medium, 2 = aggressive)"); 280 SYSCTL_ADD_PROC(&ap->sysctl_ctx, 281 SYSCTL_CHILDREN(ap->sysctl_tree), OID_AUTO, 282 "link_pwr_state", CTLTYPE_STRING | CTLFLAG_RD, ap, 0, 283 ahci_sysctl_link_pwr_state, "A", 284 "Link power management state"); 285 286 } 287 288 kthread_create(ahci_port_thread, ap, &ap->ap_thread, 289 "%s", PORTNAME(ap)); 290 } 291 292 /* 293 * Stop the OS-specific port helper thread and kill the per-port lock. 294 */ 295 void 296 ahci_os_stop_port(struct ahci_port *ap) 297 { 298 if (ap->sysctl_tree) { 299 sysctl_ctx_free(&ap->sysctl_ctx); 300 ap->sysctl_tree = NULL; 301 } 302 303 if (ap->ap_thread) { 304 ahci_os_signal_port_thread(ap, AP_SIGF_STOP); 305 ahci_os_sleep(10); 306 if (ap->ap_thread) { 307 kprintf("%s: Waiting for thread to terminate\n", 308 PORTNAME(ap)); 309 while (ap->ap_thread) 310 ahci_os_sleep(100); 311 kprintf("%s: thread terminated\n", 312 PORTNAME(ap)); 313 } 314 } 315 lockuninit(&ap->ap_lock); 316 } 317 318 /* 319 * Add (mask) to the set of bits being sent to the per-port thread helper 320 * and wake the helper up if necessary. 321 */ 322 void 323 ahci_os_signal_port_thread(struct ahci_port *ap, int mask) 324 { 325 lockmgr(&ap->ap_sig_lock, LK_EXCLUSIVE); 326 atomic_set_int(&ap->ap_signal, mask); 327 lockmgr(&ap->ap_sig_lock, LK_RELEASE); 328 wakeup(&ap->ap_thread); 329 } 330 331 /* 332 * Unconditionally lock the port structure for access. 333 */ 334 void 335 ahci_os_lock_port(struct ahci_port *ap) 336 { 337 lockmgr(&ap->ap_lock, LK_EXCLUSIVE); 338 } 339 340 /* 341 * Conditionally lock the port structure for access. 342 * 343 * Returns 0 on success, non-zero on failure. 344 */ 345 int 346 ahci_os_lock_port_nb(struct ahci_port *ap) 347 { 348 return (lockmgr(&ap->ap_lock, LK_EXCLUSIVE | LK_NOWAIT)); 349 } 350 351 /* 352 * Unlock a previously locked port. 353 */ 354 void 355 ahci_os_unlock_port(struct ahci_port *ap) 356 { 357 lockmgr(&ap->ap_lock, LK_RELEASE); 358 } 359 360 /* 361 * Per-port thread helper. This helper thread is responsible for 362 * atomically retrieving and clearing the signal mask and calling 363 * the machine-independant driver core. 364 * 365 * MPSAFE 366 */ 367 static 368 void 369 ahci_port_thread(void *arg) 370 { 371 struct ahci_port *ap = arg; 372 int mask; 373 374 /* 375 * Sets us up as an interrupt support thread, meaning we are 376 * given a higher priority and we can preempt normal threads. 377 */ 378 lwkt_set_interrupt_support_thread(); 379 380 /* 381 * The helper thread is responsible for the initial port init, 382 * so all the ports can be inited in parallel. 383 * 384 * We also run the state machine which should do all probes. 385 * Since CAM is not attached yet we will not get out-of-order 386 * SCSI attachments. 387 */ 388 ahci_os_lock_port(ap); 389 ahci_port_init(ap); 390 atomic_clear_int(&ap->ap_signal, AP_SIGF_THREAD_SYNC); 391 wakeup(&ap->ap_signal); 392 ahci_port_state_machine(ap, 1); 393 ahci_os_unlock_port(ap); 394 atomic_clear_int(&ap->ap_signal, AP_SIGF_INIT); 395 wakeup(&ap->ap_signal); 396 397 /* 398 * Then loop on the helper core. 399 */ 400 mask = ap->ap_signal; 401 while ((mask & AP_SIGF_STOP) == 0) { 402 ahci_port_thread_core(ap, mask); 403 lockmgr(&ap->ap_sig_lock, LK_EXCLUSIVE); 404 if (ap->ap_signal == 0) { 405 lksleep(&ap->ap_thread, &ap->ap_sig_lock, 0, 406 "ahport", 0); 407 } 408 mask = ap->ap_signal; 409 atomic_clear_int(&ap->ap_signal, mask); 410 lockmgr(&ap->ap_sig_lock, LK_RELEASE); 411 } 412 ap->ap_thread = NULL; 413 } 414