sys/dev/disk/ahci/ahci_dragonfly.c

   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
 112         sc->sc_ad = ahci_lookup_device(dev);
 113         if (sc->sc_ad == NULL)
 114                 return(ENXIO);
 115
 116         /*
 117          * Some chipsets do not properly implement the AHCI spec and may
 118          * require the link speed to be specifically requested.
 119          */
 120         if (kgetenv("hint.ahci.force150"))
 121                 AhciForceGen = 1;
 122         if (kgetenv("hint.ahci.force300"))
 123                 AhciForceGen = 2;
 124         if (kgetenv("hint.ahci.force600"))
 125                 AhciForceGen = 3;
 126
 127         if (kgetenv("hint.ahci.nofeatures"))
 128                 AhciNoFeatures = -1;
 129
 130         if (kgetenv("hint.ahci.forcefbss"))
 131                 sc->sc_flags |= AHCI_F_FORCE_FBSS;
 132
 133         return (sc->sc_ad->ad_attach(dev));
 134 }
 135
 136 static int
 137 ahci_detach (device_t dev)
 138 {
 139         struct ahci_softc *sc = device_get_softc(dev);
 140         int error = 0;
 141
 142         if (sc->sc_ad) {
 143                 error = sc->sc_ad->ad_detach(dev);
 144                 sc->sc_ad = NULL;
 145         }
 146         return(error);
 147 }
 148
 149 static int
 150 ahci_sysctl_link_pwr_mgmt (SYSCTL_HANDLER_ARGS)
 151 {
 152         struct ahci_port *ap = arg1;
 153         int error, link_pwr_mgmt;
 154
 155         link_pwr_mgmt = ap->link_pwr_mgmt;
 156         error = sysctl_handle_int(oidp, &link_pwr_mgmt, 0, req);
 157         if (error || req->newptr == NULL)
 158                 return error;
 159
 160         ahci_port_link_pwr_mgmt(ap, link_pwr_mgmt);
 161         return 0;
 162 }
 163
 164 static int
 165 ahci_sysctl_link_pwr_state (SYSCTL_HANDLER_ARGS)
 166 {
 167         struct ahci_port *ap = arg1;
 168         const char *state_names[] = {"unknown", "active", "partial", "slumber"};
 169         char buf[16];
 170         int state;
 171
 172         state = ahci_port_link_pwr_state(ap);
 173         if (state < 0 || state >= NELEM(state_names))
 174                 state = 0;
 175
 176         ksnprintf(buf, sizeof(buf), "%s", state_names[state]);
 177         return sysctl_handle_string(oidp, buf, sizeof(buf), req);
 178 }
 179
 180 #if 0
 181
 182 static int
 183 ahci_shutdown (device_t dev)
 184 {
 185         return (0);
 186 }
 187
 188 static int
 189 ahci_suspend (device_t dev)
 190 {
 191         return (0);
 192 }
 193
 194 static int
 195 ahci_resume (device_t dev)
 196 {
 197         return (0);
 198 }
 199
 200 #endif
 201
 202 /*
 203  * Sleep (ms) milliseconds, error on the side of caution.
 204  */
 205 void
 206 ahci_os_sleep(int ms)
 207 {
 208         int ticks;
 209
 210         ticks = hz * ms / 1000 + 1;
 211         tsleep(&ticks, 0, "ahslp", ticks);
 212 }
 213
 214 /*
 215  * Sleep for a minimum interval and return the number of milliseconds
 216  * that was.  The minimum value returned is 1
 217  */
 218 int
 219 ahci_os_softsleep(void)
 220 {
 221         if (hz >= 1000) {
 222                 tsleep(&ticks, 0, "ahslp", hz / 1000);
 223                 return(1);
 224         } else {
 225                 tsleep(&ticks, 0, "ahslp", 1);
 226                 return(1000 / hz);
 227         }
 228 }
 229
 230 void
 231 ahci_os_hardsleep(int us)
 232 {
 233         DELAY(us);
 234 }
 235
 236 /*
 237  * Create the OS-specific port helper thread and per-port lock.
 238  */
 239 void
 240 ahci_os_start_port(struct ahci_port *ap)
 241 {
 242         struct sysctl_oid *soid;
 243         char name[16];
 244
 245         atomic_set_int(&ap->ap_signal, AP_SIGF_INIT | AP_SIGF_THREAD_SYNC);
 246         lockinit(&ap->ap_lock, "ahcipo", 0, LK_CANRECURSE);
 247         lockinit(&ap->ap_sim_lock, "ahcicam", 0, LK_CANRECURSE);
 248         lockinit(&ap->ap_sig_lock, "ahport", 0, 0);
 249         sysctl_ctx_init(&ap->sysctl_ctx);
 250         ksnprintf(name, sizeof(name), "%d", ap->ap_num);
 251         soid = device_get_sysctl_tree(ap->ap_sc->sc_dev);
 252         ap->sysctl_tree = SYSCTL_ADD_NODE(&ap->sysctl_ctx,
 253                                 SYSCTL_CHILDREN(soid),
 254                                 OID_AUTO, name, CTLFLAG_RD, 0, "");
 255
 256         if ((ap->ap_sc->sc_cap & AHCI_REG_CAP_SALP) &&
 257             (ap->ap_sc->sc_cap & (AHCI_REG_CAP_PSC | AHCI_REG_CAP_SSC))) {
 258                 SYSCTL_ADD_PROC(&ap->sysctl_ctx,
 259                         SYSCTL_CHILDREN(ap->sysctl_tree), OID_AUTO,
 260                         "link_pwr_mgmt", CTLTYPE_INT | CTLFLAG_RW, ap, 0,
 261                         ahci_sysctl_link_pwr_mgmt, "I",
 262                         "Link power management policy "
 263                         "(0 = disabled, 1 = medium, 2 = aggressive)");
 264                 SYSCTL_ADD_PROC(&ap->sysctl_ctx,
 265                         SYSCTL_CHILDREN(ap->sysctl_tree), OID_AUTO,
 266                         "link_pwr_state", CTLTYPE_STRING | CTLFLAG_RD, ap, 0,
 267                         ahci_sysctl_link_pwr_state, "A",
 268                         "Link power management state");
 269
 270         }
 271
 272         kthread_create(ahci_port_thread, ap, &ap->ap_thread,
 273                        "%s", PORTNAME(ap));
 274 }
 275
 276 /*
 277  * Stop the OS-specific port helper thread and kill the per-port lock.
 278  */
 279 void
 280 ahci_os_stop_port(struct ahci_port *ap)
 281 {
 282         if (ap->sysctl_tree) {
 283                 sysctl_ctx_free(&ap->sysctl_ctx);
 284                 ap->sysctl_tree = NULL;
 285         }
 286
 287         if (ap->ap_thread) {
 288                 ahci_os_signal_port_thread(ap, AP_SIGF_STOP);
 289                 ahci_os_sleep(10);
 290                 if (ap->ap_thread) {
 291                         kprintf("%s: Waiting for thread to terminate\n",
 292                                 PORTNAME(ap));
 293                         while (ap->ap_thread)
 294                                 ahci_os_sleep(100);
 295                         kprintf("%s: thread terminated\n",
 296                                 PORTNAME(ap));
 297                 }
 298         }
 299         lockuninit(&ap->ap_lock);
 300 }
 301
 302 /*
 303  * Add (mask) to the set of bits being sent to the per-port thread helper
 304  * and wake the helper up if necessary.
 305  */
 306 void
 307 ahci_os_signal_port_thread(struct ahci_port *ap, int mask)
 308 {
 309         lockmgr(&ap->ap_sig_lock, LK_EXCLUSIVE);
 310         atomic_set_int(&ap->ap_signal, mask);
 311         lockmgr(&ap->ap_sig_lock, LK_RELEASE);
 312         wakeup(&ap->ap_thread);
 313 }
 314
 315 /*
 316  * Unconditionally lock the port structure for access.
 317  */
 318 void
 319 ahci_os_lock_port(struct ahci_port *ap)
 320 {
 321         lockmgr(&ap->ap_lock, LK_EXCLUSIVE);
 322 }
 323
 324 /*
 325  * Conditionally lock the port structure for access.
 326  *
 327  * Returns 0 on success, non-zero on failure.
 328  */
 329 int
 330 ahci_os_lock_port_nb(struct ahci_port *ap)
 331 {
 332         return (lockmgr(&ap->ap_lock, LK_EXCLUSIVE | LK_NOWAIT));
 333 }
 334
 335 /*
 336  * Unlock a previously locked port.
 337  */
 338 void
 339 ahci_os_unlock_port(struct ahci_port *ap)
 340 {
 341         lockmgr(&ap->ap_lock, LK_RELEASE);
 342 }
 343
 344 /*
 345  * Per-port thread helper.  This helper thread is responsible for
 346  * atomically retrieving and clearing the signal mask and calling
 347  * the machine-independant driver core.
 348  *
 349  * MPSAFE
 350  */
 351 static
 352 void
 353 ahci_port_thread(void *arg)
 354 {
 355         struct ahci_port *ap = arg;
 356         int mask;
 357
 358         /*
 359          * Sets us up as an interrupt support thread, meaning we are
 360          * given a higher priority and we can preempt normal threads.
 361          */
 362         lwkt_set_interrupt_support_thread();
 363
 364         /*
 365          * The helper thread is responsible for the initial port init,
 366          * so all the ports can be inited in parallel.
 367          *
 368          * We also run the state machine which should do all probes.
 369          * Since CAM is not attached yet we will not get out-of-order
 370          * SCSI attachments.
 371          */
 372         ahci_os_lock_port(ap);
 373         ahci_port_init(ap);
 374         atomic_clear_int(&ap->ap_signal, AP_SIGF_THREAD_SYNC);
 375         wakeup(&ap->ap_signal);
 376         ahci_port_state_machine(ap, 1);
 377         ahci_os_unlock_port(ap);
 378         atomic_clear_int(&ap->ap_signal, AP_SIGF_INIT);
 379         wakeup(&ap->ap_signal);
 380
 381         /*
 382          * Then loop on the helper core.
 383          */
 384         mask = ap->ap_signal;
 385         while ((mask & AP_SIGF_STOP) == 0) {
 386                 ahci_port_thread_core(ap, mask);
 387                 lockmgr(&ap->ap_sig_lock, LK_EXCLUSIVE);
 388                 if (ap->ap_signal == 0) {
 389                         lksleep(&ap->ap_thread, &ap->ap_sig_lock, 0,
 390                                 "ahport", 0);
 391                 }
 392                 mask = ap->ap_signal;
 393                 atomic_clear_int(&ap->ap_signal, mask);
 394                 lockmgr(&ap->ap_sig_lock, LK_RELEASE);
 395         }
 396         ap->ap_thread = NULL;
 397 }