sys/cam/ata/ata_da.c

   1 /*-
   2  * Copyright (c) 2009 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_ada.h"
  31 #include "opt_ata.h"
  32
  33 #include <sys/param.h>
  34
  35 #ifdef _KERNEL
  36 #include <sys/systm.h>
  37 #include <sys/kernel.h>
  38 #include <sys/bio.h>
  39 #include <sys/sysctl.h>
  40 #include <sys/taskqueue.h>
  41 #include <sys/lock.h>
  42 #include <sys/mutex.h>
  43 #include <sys/conf.h>
  44 #include <sys/devicestat.h>
  45 #include <sys/eventhandler.h>
  46 #include <sys/malloc.h>
  47 #include <sys/cons.h>
  48 #include <sys/proc.h>
  49 #include <sys/reboot.h>
  50 #include <geom/geom_disk.h>
  51 #endif /* _KERNEL */
  52
  53 #ifndef _KERNEL
  54 #include <stdio.h>
  55 #include <string.h>
  56 #endif /* _KERNEL */
  57
  58 #include <cam/cam.h>
  59 #include <cam/cam_ccb.h>
  60 #include <cam/cam_periph.h>
  61 #include <cam/cam_xpt_periph.h>
  62 #include <cam/cam_sim.h>
  63
  64 #include <cam/ata/ata_all.h>
  65
  66 #include <machine/md_var.h>     /* geometry translation */
  67
  68 #ifdef _KERNEL
  69
  70 #define ATA_MAX_28BIT_LBA               268435455UL
  71
  72 typedef enum {
  73         ADA_STATE_RAHEAD,
  74         ADA_STATE_WCACHE,
  75         ADA_STATE_NORMAL
  76 } ada_state;
  77
  78 typedef enum {
  79         ADA_FLAG_CAN_48BIT      = 0x0002,
  80         ADA_FLAG_CAN_FLUSHCACHE = 0x0004,
  81         ADA_FLAG_CAN_NCQ        = 0x0008,
  82         ADA_FLAG_CAN_DMA        = 0x0010,
  83         ADA_FLAG_NEED_OTAG      = 0x0020,
  84         ADA_FLAG_WENT_IDLE      = 0x0040,
  85         ADA_FLAG_CAN_TRIM       = 0x0080,
  86         ADA_FLAG_OPEN           = 0x0100,
  87         ADA_FLAG_SCTX_INIT      = 0x0200,
  88         ADA_FLAG_CAN_CFA        = 0x0400,
  89         ADA_FLAG_CAN_POWERMGT   = 0x0800,
  90         ADA_FLAG_CAN_DMA48      = 0x1000,
  91         ADA_FLAG_DIRTY          = 0x2000
  92 } ada_flags;
  93
  94 typedef enum {
  95         ADA_Q_NONE              = 0x00,
  96         ADA_Q_4K                = 0x01,
  97 } ada_quirks;
  98
  99 #define ADA_Q_BIT_STRING        \
 100         "\020"                  \
 101         "\0014K"
 102
 103 typedef enum {
 104         ADA_CCB_RAHEAD          = 0x01,
 105         ADA_CCB_WCACHE          = 0x02,
 106         ADA_CCB_BUFFER_IO       = 0x03,
 107         ADA_CCB_WAITING         = 0x04,
 108         ADA_CCB_DUMP            = 0x05,
 109         ADA_CCB_TRIM            = 0x06,
 110         ADA_CCB_TYPE_MASK       = 0x0F,
 111 } ada_ccb_state;
 112
 113 /* Offsets into our private area for storing information */
 114 #define ccb_state       ppriv_field0
 115 #define ccb_bp          ppriv_ptr1
 116
 117 struct disk_params {
 118         u_int8_t  heads;
 119         u_int8_t  secs_per_track;
 120         u_int32_t cylinders;
 121         u_int32_t secsize;      /* Number of bytes/logical sector */
 122         u_int64_t sectors;      /* Total number sectors */
 123 };
 124
 125 #define TRIM_MAX_BLOCKS 8
 126 #define TRIM_MAX_RANGES (TRIM_MAX_BLOCKS * ATA_DSM_BLK_RANGES)
 127 #define TRIM_MAX_BIOS   (TRIM_MAX_RANGES * 4)
 128 struct trim_request {
 129         uint8_t         data[TRIM_MAX_RANGES * ATA_DSM_RANGE_SIZE];
 130         struct bio      *bps[TRIM_MAX_BIOS];
 131 };
 132
 133 struct ada_softc {
 134         struct   bio_queue_head bio_queue;
 135         struct   bio_queue_head trim_queue;
 136         ada_state state;
 137         ada_flags flags;
 138         ada_quirks quirks;
 139         int      sort_io_queue;
 140         int      ordered_tag_count;
 141         int      outstanding_cmds;
 142         int      trim_max_ranges;
 143         int      trim_running;
 144         int      read_ahead;
 145         int      write_cache;
 146 #ifdef ADA_TEST_FAILURE
 147         int      force_read_error;
 148         int      force_write_error;
 149         int      periodic_read_error;
 150         int      periodic_read_count;
 151 #endif
 152         struct   disk_params params;
 153         struct   disk *disk;
 154         struct task             sysctl_task;
 155         struct sysctl_ctx_list  sysctl_ctx;
 156         struct sysctl_oid       *sysctl_tree;
 157         struct callout          sendordered_c;
 158         struct trim_request     trim_req;
 159 };
 160
 161 struct ada_quirk_entry {
 162         struct scsi_inquiry_pattern inq_pat;
 163         ada_quirks quirks;
 164 };
 165
 166 static struct ada_quirk_entry ada_quirk_table[] =
 167 {
 168         {
 169                 /* Hitachi Advanced Format (4k) drives */
 170                 { T_DIRECT, SIP_MEDIA_FIXED, "*", "Hitachi H??????????E3*", "*" },
 171                 /*quirks*/ADA_Q_4K
 172         },
 173         {
 174                 /* Samsung Advanced Format (4k) drives */
 175                 { T_DIRECT, SIP_MEDIA_FIXED, "*", "SAMSUNG HD155UI*", "*" },
 176                 /*quirks*/ADA_Q_4K
 177         },
 178         {
 179                 /* Samsung Advanced Format (4k) drives */
 180                 { T_DIRECT, SIP_MEDIA_FIXED, "*", "SAMSUNG HD204UI*", "*" },
 181                 /*quirks*/ADA_Q_4K
 182         },
 183         {
 184                 /* Seagate Barracuda Green Advanced Format (4k) drives */
 185                 { T_DIRECT, SIP_MEDIA_FIXED, "*", "ST????DL*", "*" },
 186                 /*quirks*/ADA_Q_4K
 187         },
 188         {
 189                 /* Seagate Barracuda Advanced Format (4k) drives */
 190                 { T_DIRECT, SIP_MEDIA_FIXED, "*", "ST???DM*", "*" },
 191                 /*quirks*/ADA_Q_4K
 192         },
 193         {
 194                 /* Seagate Barracuda Advanced Format (4k) drives */
 195                 { T_DIRECT, SIP_MEDIA_FIXED, "*", "ST????DM*", "*" },
 196                 /*quirks*/ADA_Q_4K
 197         },
 198         {
 199                 /* Seagate Momentus Advanced Format (4k) drives */
 200                 { T_DIRECT, SIP_MEDIA_FIXED, "*", "ST9500423AS*", "*" },
 201                 /*quirks*/ADA_Q_4K
 202         },
 203         {
 204                 /* Seagate Momentus Advanced Format (4k) drives */
 205                 { T_DIRECT, SIP_MEDIA_FIXED, "*", "ST9500424AS*", "*" },
 206                 /*quirks*/ADA_Q_4K
 207         },
 208         {
 209                 /* Seagate Momentus Advanced Format (4k) drives */
 210                 { T_DIRECT, SIP_MEDIA_FIXED, "*", "ST9640423AS*", "*" },
 211                 /*quirks*/ADA_Q_4K
 212         },
 213         {
 214                 /* Seagate Momentus Advanced Format (4k) drives */
 215                 { T_DIRECT, SIP_MEDIA_FIXED, "*", "ST9640424AS*", "*" },
 216                 /*quirks*/ADA_Q_4K
 217         },
 218         {
 219                 /* Seagate Momentus Advanced Format (4k) drives */
 220                 { T_DIRECT, SIP_MEDIA_FIXED, "*", "ST9750420AS*", "*" },
 221                 /*quirks*/ADA_Q_4K
 222         },
 223         {
 224                 /* Seagate Momentus Advanced Format (4k) drives */
 225                 { T_DIRECT, SIP_MEDIA_FIXED, "*", "ST9750422AS*", "*" },
 226                 /*quirks*/ADA_Q_4K
 227         },
 228         {
 229                 /* Seagate Momentus Advanced Format (4k) drives */
 230                 { T_DIRECT, SIP_MEDIA_FIXED, "*", "ST9750423AS*", "*" },
 231                 /*quirks*/ADA_Q_4K
 232         },
 233         {
 234                 /* Seagate Momentus Thin Advanced Format (4k) drives */
 235                 { T_DIRECT, SIP_MEDIA_FIXED, "*", "ST???LT*", "*" },
 236                 /*quirks*/ADA_Q_4K
 237         },
 238         {
 239                 /* WDC Caviar Green Advanced Format (4k) drives */
 240                 { T_DIRECT, SIP_MEDIA_FIXED, "*", "WDC WD????RS*", "*" },
 241                 /*quirks*/ADA_Q_4K
 242         },
 243         {
 244                 /* WDC Caviar Green Advanced Format (4k) drives */
 245                 { T_DIRECT, SIP_MEDIA_FIXED, "*", "WDC WD????RX*", "*" },
 246                 /*quirks*/ADA_Q_4K
 247         },
 248         {
 249                 /* WDC Caviar Green Advanced Format (4k) drives */
 250                 { T_DIRECT, SIP_MEDIA_FIXED, "*", "WDC WD??????RS*", "*" },
 251                 /*quirks*/ADA_Q_4K
 252         },
 253         {
 254                 /* WDC Caviar Green Advanced Format (4k) drives */
 255                 { T_DIRECT, SIP_MEDIA_FIXED, "*", "WDC WD??????RX*", "*" },
 256                 /*quirks*/ADA_Q_4K
 257         },
 258         {
 259                 /* WDC Scorpio Black Advanced Format (4k) drives */
 260                 { T_DIRECT, SIP_MEDIA_FIXED, "*", "WDC WD???PKT*", "*" },
 261                 /*quirks*/ADA_Q_4K
 262         },
 263         {
 264                 /* WDC Scorpio Black Advanced Format (4k) drives */
 265                 { T_DIRECT, SIP_MEDIA_FIXED, "*", "WDC WD?????PKT*", "*" },
 266                 /*quirks*/ADA_Q_4K
 267         },
 268         {
 269                 /* WDC Scorpio Blue Advanced Format (4k) drives */
 270                 { T_DIRECT, SIP_MEDIA_FIXED, "*", "WDC WD???PVT*", "*" },
 271                 /*quirks*/ADA_Q_4K
 272         },
 273         {
 274                 /* WDC Scorpio Blue Advanced Format (4k) drives */
 275                 { T_DIRECT, SIP_MEDIA_FIXED, "*", "WDC WD?????PVT*", "*" },
 276                 /*quirks*/ADA_Q_4K
 277         },
 278         /* SSDs */
 279         {
 280                 /*
 281                  * Corsair Force 2 SSDs
 282                  * 4k optimised & trim only works in 4k requests + 4k aligned
 283                  */
 284                 { T_DIRECT, SIP_MEDIA_FIXED, "*", "Corsair CSSD-F*", "*" },
 285                 /*quirks*/ADA_Q_4K
 286         },
 287         {
 288                 /*
 289                  * Corsair Force 3 SSDs
 290                  * 4k optimised & trim only works in 4k requests + 4k aligned
 291                  */
 292                 { T_DIRECT, SIP_MEDIA_FIXED, "*", "Corsair Force 3*", "*" },
 293                 /*quirks*/ADA_Q_4K
 294         },
 295         {
 296                 /*
 297                  * Corsair Force GT SSDs
 298                  * 4k optimised & trim only works in 4k requests + 4k aligned
 299                  */
 300                 { T_DIRECT, SIP_MEDIA_FIXED, "*", "Corsair Force GT*", "*" },
 301                 /*quirks*/ADA_Q_4K
 302         },
 303         {
 304                 /*
 305                  * Crucial M4 SSDs
 306                  * 4k optimised & trim only works in 4k requests + 4k aligned
 307                  */
 308                 { T_DIRECT, SIP_MEDIA_FIXED, "*", "M4-CT???M4SSD2*", "*" },
 309                 /*quirks*/ADA_Q_4K
 310         },
 311         {
 312                 /*
 313                  * Crucial RealSSD C300 SSDs
 314                  * 4k optimised
 315                  */
 316                 { T_DIRECT, SIP_MEDIA_FIXED, "*", "C300-CTFDDAC???MAG*",
 317                 "*" }, /*quirks*/ADA_Q_4K
 318         },
 319         {
 320                 /*
 321                  * Intel 320 Series SSDs
 322                  * 4k optimised & trim only works in 4k requests + 4k aligned
 323                  */
 324                 { T_DIRECT, SIP_MEDIA_FIXED, "*", "INTEL SSDSA2CW*", "*" },
 325                 /*quirks*/ADA_Q_4K
 326         },
 327         {
 328                 /*
 329                  * Intel 330 Series SSDs
 330                  * 4k optimised & trim only works in 4k requests + 4k aligned
 331                  */
 332                 { T_DIRECT, SIP_MEDIA_FIXED, "*", "INTEL SSDSC2CT*", "*" },
 333                 /*quirks*/ADA_Q_4K
 334         },
 335         {
 336                 /*
 337                  * Intel 510 Series SSDs
 338                  * 4k optimised & trim only works in 4k requests + 4k aligned
 339                  */
 340                 { T_DIRECT, SIP_MEDIA_FIXED, "*", "INTEL SSDSC2MH*", "*" },
 341                 /*quirks*/ADA_Q_4K
 342         },
 343         {
 344                 /*
 345                  * Intel 520 Series SSDs
 346                  * 4k optimised & trim only works in 4k requests + 4k aligned
 347                  */
 348                 { T_DIRECT, SIP_MEDIA_FIXED, "*", "INTEL SSDSC2BW*", "*" },
 349                 /*quirks*/ADA_Q_4K
 350         },
 351         {
 352                 /*
 353                  * Kingston E100 Series SSDs
 354                  * 4k optimised & trim only works in 4k requests + 4k aligned
 355                  */
 356                 { T_DIRECT, SIP_MEDIA_FIXED, "*", "KINGSTON SE100S3*", "*" },
 357                 /*quirks*/ADA_Q_4K
 358         },
 359         {
 360                 /*
 361                  * Kingston HyperX 3k SSDs
 362                  * 4k optimised & trim only works in 4k requests + 4k aligned
 363                  */
 364                 { T_DIRECT, SIP_MEDIA_FIXED, "*", "KINGSTON SH103S3*", "*" },
 365                 /*quirks*/ADA_Q_4K
 366         },
 367         {
 368                 /*
 369                  * OCZ Agility 3 SSDs
 370                  * 4k optimised & trim only works in 4k requests + 4k aligned
 371                  */
 372                 { T_DIRECT, SIP_MEDIA_FIXED, "*", "OCZ-AGILITY3*", "*" },
 373                 /*quirks*/ADA_Q_4K
 374         },
 375         {
 376                 /*
 377                  * OCZ Deneva R Series SSDs
 378                  * 4k optimised & trim only works in 4k requests + 4k aligned
 379                  */
 380                 { T_DIRECT, SIP_MEDIA_FIXED, "*", "DENRSTE251M45*", "*" },
 381                 /*quirks*/ADA_Q_4K
 382         },
 383         {
 384                 /*
 385                  * OCZ Vertex 2 SSDs (inc pro series)
 386                  * 4k optimised & trim only works in 4k requests + 4k aligned
 387                  */
 388                 { T_DIRECT, SIP_MEDIA_FIXED, "*", "OCZ?VERTEX2*", "*" },
 389                 /*quirks*/ADA_Q_4K
 390         },
 391         {
 392                 /*
 393                  * OCZ Vertex 3 SSDs
 394                  * 4k optimised & trim only works in 4k requests + 4k aligned
 395                  */
 396                 { T_DIRECT, SIP_MEDIA_FIXED, "*", "OCZ-VERTEX3*", "*" },
 397                 /*quirks*/ADA_Q_4K
 398         },
 399         {
 400                 /*
 401                  * OCZ Vertex 4 SSDs
 402                  * 4k optimised & trim only works in 4k requests + 4k aligned
 403                  */
 404                 { T_DIRECT, SIP_MEDIA_FIXED, "*", "OCZ-VERTEX4*", "*" },
 405                 /*quirks*/ADA_Q_4K
 406         },
 407         {
 408                 /*
 409                  * Samsung 830 Series SSDs
 410                  * 4k optimised
 411                  */
 412                 { T_DIRECT, SIP_MEDIA_FIXED, "*", "SAMSUNG SSD 830 Series*", "*" },
 413                 /*quirks*/ADA_Q_4K
 414         },
 415         {
 416                 /*
 417                  * SuperTalent TeraDrive CT SSDs
 418                  * 4k optimised & trim only works in 4k requests + 4k aligned
 419                  */
 420                 { T_DIRECT, SIP_MEDIA_FIXED, "*", "FTM??CT25H*", "*" },
 421                 /*quirks*/ADA_Q_4K
 422         },
 423         {
 424                 /*
 425                  * XceedIOPS SATA SSDs
 426                  * 4k optimised
 427                  */
 428                 { T_DIRECT, SIP_MEDIA_FIXED, "*", "SG9XCS2D*", "*" },
 429                 /*quirks*/ADA_Q_4K
 430         },
 431         {
 432                 /* Default */
 433                 {
 434                   T_ANY, SIP_MEDIA_REMOVABLE|SIP_MEDIA_FIXED,
 435                   /*vendor*/"*", /*product*/"*", /*revision*/"*"
 436                 },
 437                 /*quirks*/0
 438         },
 439 };
 440
 441 static  disk_strategy_t adastrategy;
 442 static  dumper_t        adadump;
 443 static  periph_init_t   adainit;
 444 static  void            adaasync(void *callback_arg, u_int32_t code,
 445                                 struct cam_path *path, void *arg);
 446 static  void            adasysctlinit(void *context, int pending);
 447 static  periph_ctor_t   adaregister;
 448 static  periph_dtor_t   adacleanup;
 449 static  periph_start_t  adastart;
 450 static  periph_oninv_t  adaoninvalidate;
 451 static  void            adadone(struct cam_periph *periph,
 452                                union ccb *done_ccb);
 453 static  int             adaerror(union ccb *ccb, u_int32_t cam_flags,
 454                                 u_int32_t sense_flags);
 455 static void             adagetparams(struct cam_periph *periph,
 456                                 struct ccb_getdev *cgd);
 457 static timeout_t        adasendorderedtag;
 458 static void             adashutdown(void *arg, int howto);
 459 static void             adasuspend(void *arg);
 460 static void             adaresume(void *arg);
 461
 462 #ifndef ADA_DEFAULT_LEGACY_ALIASES
 463 #ifdef ATA_CAM
 464 #define ADA_DEFAULT_LEGACY_ALIASES      1
 465 #else
 466 #define ADA_DEFAULT_LEGACY_ALIASES      0
 467 #endif
 468 #endif
 469
 470 #ifndef ADA_DEFAULT_TIMEOUT
 471 #define ADA_DEFAULT_TIMEOUT 30  /* Timeout in seconds */
 472 #endif
 473
 474 #ifndef ADA_DEFAULT_RETRY
 475 #define ADA_DEFAULT_RETRY       4
 476 #endif
 477
 478 #ifndef ADA_DEFAULT_SEND_ORDERED
 479 #define ADA_DEFAULT_SEND_ORDERED        1
 480 #endif
 481
 482 #ifndef ADA_DEFAULT_SPINDOWN_SHUTDOWN
 483 #define ADA_DEFAULT_SPINDOWN_SHUTDOWN   1
 484 #endif
 485
 486 #ifndef ADA_DEFAULT_SPINDOWN_SUSPEND
 487 #define ADA_DEFAULT_SPINDOWN_SUSPEND    1
 488 #endif
 489
 490 #ifndef ADA_DEFAULT_READ_AHEAD
 491 #define ADA_DEFAULT_READ_AHEAD  1
 492 #endif
 493
 494 #ifndef ADA_DEFAULT_WRITE_CACHE
 495 #define ADA_DEFAULT_WRITE_CACHE 1
 496 #endif
 497
 498 #define ADA_RA  (softc->read_ahead >= 0 ? \
 499                  softc->read_ahead : ada_read_ahead)
 500 #define ADA_WC  (softc->write_cache >= 0 ? \
 501                  softc->write_cache : ada_write_cache)
 502 #define ADA_SIO (softc->sort_io_queue >= 0 ? \
 503                  softc->sort_io_queue : cam_sort_io_queues)
 504
 505 /*
 506  * Most platforms map firmware geometry to actual, but some don't.  If
 507  * not overridden, default to nothing.
 508  */
 509 #ifndef ata_disk_firmware_geom_adjust
 510 #define ata_disk_firmware_geom_adjust(disk)
 511 #endif
 512
 513 static int ada_legacy_aliases = ADA_DEFAULT_LEGACY_ALIASES;
 514 static int ada_retry_count = ADA_DEFAULT_RETRY;
 515 static int ada_default_timeout = ADA_DEFAULT_TIMEOUT;
 516 static int ada_send_ordered = ADA_DEFAULT_SEND_ORDERED;
 517 static int ada_spindown_shutdown = ADA_DEFAULT_SPINDOWN_SHUTDOWN;
 518 static int ada_spindown_suspend = ADA_DEFAULT_SPINDOWN_SUSPEND;
 519 static int ada_read_ahead = ADA_DEFAULT_READ_AHEAD;
 520 static int ada_write_cache = ADA_DEFAULT_WRITE_CACHE;
 521
 522 static SYSCTL_NODE(_kern_cam, OID_AUTO, ada, CTLFLAG_RD, 0,
 523             "CAM Direct Access Disk driver");
 524 SYSCTL_INT(_kern_cam_ada, OID_AUTO, legacy_aliases, CTLFLAG_RW,
 525            &ada_legacy_aliases, 0, "Create legacy-like device aliases");
 526 TUNABLE_INT("kern.cam.ada.legacy_aliases", &ada_legacy_aliases);
 527 SYSCTL_INT(_kern_cam_ada, OID_AUTO, retry_count, CTLFLAG_RW,
 528            &ada_retry_count, 0, "Normal I/O retry count");
 529 TUNABLE_INT("kern.cam.ada.retry_count", &ada_retry_count);
 530 SYSCTL_INT(_kern_cam_ada, OID_AUTO, default_timeout, CTLFLAG_RW,
 531            &ada_default_timeout, 0, "Normal I/O timeout (in seconds)");
 532 TUNABLE_INT("kern.cam.ada.default_timeout", &ada_default_timeout);
 533 SYSCTL_INT(_kern_cam_ada, OID_AUTO, send_ordered, CTLFLAG_RW,
 534            &ada_send_ordered, 0, "Send Ordered Tags");
 535 TUNABLE_INT("kern.cam.ada.send_ordered", &ada_send_ordered);
 536 SYSCTL_INT(_kern_cam_ada, OID_AUTO, spindown_shutdown, CTLFLAG_RW,
 537            &ada_spindown_shutdown, 0, "Spin down upon shutdown");
 538 TUNABLE_INT("kern.cam.ada.spindown_shutdown", &ada_spindown_shutdown);
 539 SYSCTL_INT(_kern_cam_ada, OID_AUTO, spindown_suspend, CTLFLAG_RW,
 540            &ada_spindown_suspend, 0, "Spin down upon suspend");
 541 TUNABLE_INT("kern.cam.ada.spindown_suspend", &ada_spindown_suspend);
 542 SYSCTL_INT(_kern_cam_ada, OID_AUTO, read_ahead, CTLFLAG_RW,
 543            &ada_read_ahead, 0, "Enable disk read-ahead");
 544 TUNABLE_INT("kern.cam.ada.read_ahead", &ada_read_ahead);
 545 SYSCTL_INT(_kern_cam_ada, OID_AUTO, write_cache, CTLFLAG_RW,
 546            &ada_write_cache, 0, "Enable disk write cache");
 547 TUNABLE_INT("kern.cam.ada.write_cache", &ada_write_cache);
 548
 549 /*
 550  * ADA_ORDEREDTAG_INTERVAL determines how often, relative
 551  * to the default timeout, we check to see whether an ordered
 552  * tagged transaction is appropriate to prevent simple tag
 553  * starvation.  Since we'd like to ensure that there is at least
 554  * 1/2 of the timeout length left for a starved transaction to
 555  * complete after we've sent an ordered tag, we must poll at least
 556  * four times in every timeout period.  This takes care of the worst
 557  * case where a starved transaction starts during an interval that
 558  * meets the requirement "don't send an ordered tag" test so it takes
 559  * us two intervals to determine that a tag must be sent.
 560  */
 561 #ifndef ADA_ORDEREDTAG_INTERVAL
 562 #define ADA_ORDEREDTAG_INTERVAL 4
 563 #endif
 564
 565 static struct periph_driver adadriver =
 566 {
 567         adainit, "ada",
 568         TAILQ_HEAD_INITIALIZER(adadriver.units), /* generation */ 0
 569 };
 570
 571 PERIPHDRIVER_DECLARE(ada, adadriver);
 572
 573 static MALLOC_DEFINE(M_ATADA, "ata_da", "ata_da buffers");
 574
 575 static int
 576 adaopen(struct disk *dp)
 577 {
 578         struct cam_periph *periph;
 579         struct ada_softc *softc;
 580         int error;
 581
 582         periph = (struct cam_periph *)dp->d_drv1;
 583         if (cam_periph_acquire(periph) != CAM_REQ_CMP) {
 584                 return(ENXIO);
 585         }
 586
 587         cam_periph_lock(periph);
 588         if ((error = cam_periph_hold(periph, PRIBIO|PCATCH)) != 0) {
 589                 cam_periph_unlock(periph);
 590                 cam_periph_release(periph);
 591                 return (error);
 592         }
 593
 594         CAM_DEBUG(periph->path, CAM_DEBUG_TRACE | CAM_DEBUG_PERIPH,
 595             ("adaopen\n"));
 596
 597         softc = (struct ada_softc *)periph->softc;
 598         softc->flags |= ADA_FLAG_OPEN;
 599
 600         cam_periph_unhold(periph);
 601         cam_periph_unlock(periph);
 602         return (0);
 603 }
 604
 605 static int
 606 adaclose(struct disk *dp)
 607 {
 608         struct  cam_periph *periph;
 609         struct  ada_softc *softc;
 610         union ccb *ccb;
 611         int error;
 612
 613         periph = (struct cam_periph *)dp->d_drv1;
 614         cam_periph_lock(periph);
 615         if (cam_periph_hold(periph, PRIBIO) != 0) {
 616                 cam_periph_unlock(periph);
 617                 cam_periph_release(periph);
 618                 return (0);
 619         }
 620
 621         softc = (struct ada_softc *)periph->softc;
 622
 623         CAM_DEBUG(periph->path, CAM_DEBUG_TRACE | CAM_DEBUG_PERIPH,
 624             ("adaclose\n"));
 625
 626         /* We only sync the cache if the drive is capable of it. */
 627         if ((softc->flags & ADA_FLAG_DIRTY) != 0 &&
 628             (softc->flags & ADA_FLAG_CAN_FLUSHCACHE) != 0 &&
 629             (periph->flags & CAM_PERIPH_INVALID) == 0) {
 630
 631                 ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
 632                 cam_fill_ataio(&ccb->ataio,
 633                                     1,
 634                                     adadone,
 635                                     CAM_DIR_NONE,
 636                                     0,
 637                                     NULL,
 638                                     0,
 639                                     ada_default_timeout*1000);
 640
 641                 if (softc->flags & ADA_FLAG_CAN_48BIT)
 642                         ata_48bit_cmd(&ccb->ataio, ATA_FLUSHCACHE48, 0, 0, 0);
 643                 else
 644                         ata_28bit_cmd(&ccb->ataio, ATA_FLUSHCACHE, 0, 0, 0);
 645                 error = cam_periph_runccb(ccb, adaerror, /*cam_flags*/0,
 646                     /*sense_flags*/0, softc->disk->d_devstat);
 647
 648                 if (error != 0)
 649                         xpt_print(periph->path, "Synchronize cache failed\n");
 650                 else
 651                         softc->flags &= ~ADA_FLAG_DIRTY;
 652                 xpt_release_ccb(ccb);
 653         }
 654
 655         softc->flags &= ~ADA_FLAG_OPEN;
 656         cam_periph_unhold(periph);
 657         cam_periph_unlock(periph);
 658         cam_periph_release(periph);
 659         return (0);
 660 }
 661
 662 static void
 663 adaschedule(struct cam_periph *periph)
 664 {
 665         struct ada_softc *softc = (struct ada_softc *)periph->softc;
 666         uint32_t prio;
 667
 668         if (softc->state != ADA_STATE_NORMAL)
 669                 return;
 670
 671         /* Check if cam_periph_getccb() was called. */
 672         prio = periph->immediate_priority;
 673
 674         /* Check if we have more work to do. */
 675         if (bioq_first(&softc->bio_queue) ||
 676             (!softc->trim_running && bioq_first(&softc->trim_queue))) {
 677                 prio = CAM_PRIORITY_NORMAL;
 678         }
 679
 680         /* Schedule CCB if any of above is true. */
 681         if (prio != CAM_PRIORITY_NONE)
 682                 xpt_schedule(periph, prio);
 683 }
 684
 685 /*
 686  * Actually translate the requested transfer into one the physical driver
 687  * can understand.  The transfer is described by a buf and will include
 688  * only one physical transfer.
 689  */
 690 static void
 691 adastrategy(struct bio *bp)
 692 {
 693         struct cam_periph *periph;
 694         struct ada_softc *softc;
 695
 696         periph = (struct cam_periph *)bp->bio_disk->d_drv1;
 697         softc = (struct ada_softc *)periph->softc;
 698
 699         cam_periph_lock(periph);
 700
 701         CAM_DEBUG(periph->path, CAM_DEBUG_TRACE, ("adastrategy(%p)\n", bp));
 702
 703         /*
 704          * If the device has been made invalid, error out
 705          */
 706         if ((periph->flags & CAM_PERIPH_INVALID) != 0) {
 707                 cam_periph_unlock(periph);
 708                 biofinish(bp, NULL, ENXIO);
 709                 return;
 710         }
 711
 712         /*
 713          * Place it in the queue of disk activities for this disk
 714          */
 715         if (bp->bio_cmd == BIO_DELETE &&
 716             (softc->flags & ADA_FLAG_CAN_TRIM)) {
 717                 if (ADA_SIO)
 718                     bioq_disksort(&softc->trim_queue, bp);
 719                 else
 720                     bioq_insert_tail(&softc->trim_queue, bp);
 721         } else {
 722                 if (ADA_SIO)
 723                     bioq_disksort(&softc->bio_queue, bp);
 724                 else
 725                     bioq_insert_tail(&softc->bio_queue, bp);
 726         }
 727
 728         /*
 729          * Schedule ourselves for performing the work.
 730          */
 731         adaschedule(periph);
 732         cam_periph_unlock(periph);
 733
 734         return;
 735 }
 736
 737 static int
 738 adadump(void *arg, void *virtual, vm_offset_t physical, off_t offset, size_t length)
 739 {
 740         struct      cam_periph *periph;
 741         struct      ada_softc *softc;
 742         u_int       secsize;
 743         union       ccb ccb;
 744         struct      disk *dp;
 745         uint64_t    lba;
 746         uint16_t    count;
 747         int         error = 0;
 748
 749         dp = arg;
 750         periph = dp->d_drv1;
 751         softc = (struct ada_softc *)periph->softc;
 752         cam_periph_lock(periph);
 753         secsize = softc->params.secsize;
 754         lba = offset / secsize;
 755         count = length / secsize;
 756
 757         if ((periph->flags & CAM_PERIPH_INVALID) != 0) {
 758                 cam_periph_unlock(periph);
 759                 return (ENXIO);
 760         }
 761
 762         if (length > 0) {
 763                 xpt_setup_ccb(&ccb.ccb_h, periph->path, CAM_PRIORITY_NORMAL);
 764                 ccb.ccb_h.ccb_state = ADA_CCB_DUMP;
 765                 cam_fill_ataio(&ccb.ataio,
 766                     0,
 767                     adadone,
 768                     CAM_DIR_OUT,
 769                     0,
 770                     (u_int8_t *) virtual,
 771                     length,
 772                     ada_default_timeout*1000);
 773                 if ((softc->flags & ADA_FLAG_CAN_48BIT) &&
 774                     (lba + count >= ATA_MAX_28BIT_LBA ||
 775                     count >= 256)) {
 776                         ata_48bit_cmd(&ccb.ataio, ATA_WRITE_DMA48,
 777                             0, lba, count);
 778                 } else {
 779                         ata_28bit_cmd(&ccb.ataio, ATA_WRITE_DMA,
 780                             0, lba, count);
 781                 }
 782                 xpt_polled_action(&ccb);
 783
 784                 error = cam_periph_error(&ccb,
 785                     0, SF_NO_RECOVERY | SF_NO_RETRY, NULL);
 786                 if ((ccb.ccb_h.status & CAM_DEV_QFRZN) != 0)
 787                         cam_release_devq(ccb.ccb_h.path, /*relsim_flags*/0,
 788                             /*reduction*/0, /*timeout*/0, /*getcount_only*/0);
 789                 if (error != 0)
 790                         printf("Aborting dump due to I/O error.\n");
 791
 792                 cam_periph_unlock(periph);
 793                 return (error);
 794         }
 795
 796         if (softc->flags & ADA_FLAG_CAN_FLUSHCACHE) {
 797                 xpt_setup_ccb(&ccb.ccb_h, periph->path, CAM_PRIORITY_NORMAL);
 798
 799                 ccb.ccb_h.ccb_state = ADA_CCB_DUMP;
 800                 cam_fill_ataio(&ccb.ataio,
 801                                     0,
 802                                     adadone,
 803                                     CAM_DIR_NONE,
 804                                     0,
 805                                     NULL,
 806                                     0,
 807                                     ada_default_timeout*1000);
 808
 809                 if (softc->flags & ADA_FLAG_CAN_48BIT)
 810                         ata_48bit_cmd(&ccb.ataio, ATA_FLUSHCACHE48, 0, 0, 0);
 811                 else
 812                         ata_28bit_cmd(&ccb.ataio, ATA_FLUSHCACHE, 0, 0, 0);
 813                 xpt_polled_action(&ccb);
 814
 815                 error = cam_periph_error(&ccb,
 816                     0, SF_NO_RECOVERY | SF_NO_RETRY, NULL);
 817                 if ((ccb.ccb_h.status & CAM_DEV_QFRZN) != 0)
 818                         cam_release_devq(ccb.ccb_h.path, /*relsim_flags*/0,
 819                             /*reduction*/0, /*timeout*/0, /*getcount_only*/0);
 820                 if (error != 0)
 821                         xpt_print(periph->path, "Synchronize cache failed\n");
 822         }
 823         cam_periph_unlock(periph);
 824         return (error);
 825 }
 826
 827 static void
 828 adainit(void)
 829 {
 830         cam_status status;
 831
 832         /*
 833          * Install a global async callback.  This callback will
 834          * receive async callbacks like "new device found".
 835          */
 836         status = xpt_register_async(AC_FOUND_DEVICE, adaasync, NULL, NULL);
 837
 838         if (status != CAM_REQ_CMP) {
 839                 printf("ada: Failed to attach master async callback "
 840                        "due to status 0x%x!\n", status);
 841         } else if (ada_send_ordered) {
 842
 843                 /* Register our event handlers */
 844                 if ((EVENTHANDLER_REGISTER(power_suspend, adasuspend,
 845                                            NULL, EVENTHANDLER_PRI_LAST)) == NULL)
 846                     printf("adainit: power event registration failed!\n");
 847                 if ((EVENTHANDLER_REGISTER(power_resume, adaresume,
 848                                            NULL, EVENTHANDLER_PRI_LAST)) == NULL)
 849                     printf("adainit: power event registration failed!\n");
 850                 if ((EVENTHANDLER_REGISTER(shutdown_post_sync, adashutdown,
 851                                            NULL, SHUTDOWN_PRI_DEFAULT)) == NULL)
 852                     printf("adainit: shutdown event registration failed!\n");
 853         }
 854 }
 855
 856 /*
 857  * Callback from GEOM, called when it has finished cleaning up its
 858  * resources.
 859  */
 860 static void
 861 adadiskgonecb(struct disk *dp)
 862 {
 863         struct cam_periph *periph;
 864
 865         periph = (struct cam_periph *)dp->d_drv1;
 866
 867         cam_periph_release(periph);
 868 }
 869
 870 static void
 871 adaoninvalidate(struct cam_periph *periph)
 872 {
 873         struct ada_softc *softc;
 874
 875         softc = (struct ada_softc *)periph->softc;
 876
 877         /*
 878          * De-register any async callbacks.
 879          */
 880         xpt_register_async(0, adaasync, periph, periph->path);
 881
 882         /*
 883          * Return all queued I/O with ENXIO.
 884          * XXX Handle any transactions queued to the card
 885          *     with XPT_ABORT_CCB.
 886          */
 887         bioq_flush(&softc->bio_queue, NULL, ENXIO);
 888         bioq_flush(&softc->trim_queue, NULL, ENXIO);
 889
 890         disk_gone(softc->disk);
 891         xpt_print(periph->path, "lost device\n");
 892 }
 893
 894 static void
 895 adacleanup(struct cam_periph *periph)
 896 {
 897         struct ada_softc *softc;
 898
 899         softc = (struct ada_softc *)periph->softc;
 900
 901         xpt_print(periph->path, "removing device entry\n");
 902         cam_periph_unlock(periph);
 903
 904         /*
 905          * If we can't free the sysctl tree, oh well...
 906          */
 907         if ((softc->flags & ADA_FLAG_SCTX_INIT) != 0
 908             && sysctl_ctx_free(&softc->sysctl_ctx) != 0) {
 909                 xpt_print(periph->path, "can't remove sysctl context\n");
 910         }
 911
 912         disk_destroy(softc->disk);
 913         callout_drain(&softc->sendordered_c);
 914         free(softc, M_DEVBUF);
 915         cam_periph_lock(periph);
 916 }
 917
 918 static void
 919 adaasync(void *callback_arg, u_int32_t code,
 920         struct cam_path *path, void *arg)
 921 {
 922         struct ccb_getdev cgd;
 923         struct cam_periph *periph;
 924         struct ada_softc *softc;
 925
 926         periph = (struct cam_periph *)callback_arg;
 927         switch (code) {
 928         case AC_FOUND_DEVICE:
 929         {
 930                 struct ccb_getdev *cgd;
 931                 cam_status status;
 932
 933                 cgd = (struct ccb_getdev *)arg;
 934                 if (cgd == NULL)
 935                         break;
 936
 937                 if (cgd->protocol != PROTO_ATA)
 938                         break;
 939
 940                 /*
 941                  * Allocate a peripheral instance for
 942                  * this device and start the probe
 943                  * process.
 944                  */
 945                 status = cam_periph_alloc(adaregister, adaoninvalidate,
 946                                           adacleanup, adastart,
 947                                           "ada", CAM_PERIPH_BIO,
 948                                           cgd->ccb_h.path, adaasync,
 949                                           AC_FOUND_DEVICE, cgd);
 950
 951                 if (status != CAM_REQ_CMP
 952                  && status != CAM_REQ_INPROG)
 953                         printf("adaasync: Unable to attach to new device "
 954                                 "due to status 0x%x\n", status);
 955                 break;
 956         }
 957         case AC_GETDEV_CHANGED:
 958         {
 959                 softc = (struct ada_softc *)periph->softc;
 960                 xpt_setup_ccb(&cgd.ccb_h, periph->path, CAM_PRIORITY_NORMAL);
 961                 cgd.ccb_h.func_code = XPT_GDEV_TYPE;
 962                 xpt_action((union ccb *)&cgd);
 963
 964                 if ((cgd.ident_data.capabilities1 & ATA_SUPPORT_DMA) &&
 965                     (cgd.inq_flags & SID_DMA))
 966                         softc->flags |= ADA_FLAG_CAN_DMA;
 967                 else
 968                         softc->flags &= ~ADA_FLAG_CAN_DMA;
 969                 if (cgd.ident_data.support.command2 & ATA_SUPPORT_ADDRESS48) {
 970                         softc->flags |= ADA_FLAG_CAN_48BIT;
 971                         if (cgd.inq_flags & SID_DMA48)
 972                                 softc->flags |= ADA_FLAG_CAN_DMA48;
 973                         else
 974                                 softc->flags &= ~ADA_FLAG_CAN_DMA48;
 975                 } else
 976                         softc->flags &= ~(ADA_FLAG_CAN_48BIT |
 977                             ADA_FLAG_CAN_DMA48);
 978                 if ((cgd.ident_data.satacapabilities & ATA_SUPPORT_NCQ) &&
 979                     (cgd.inq_flags & SID_DMA) && (cgd.inq_flags & SID_CmdQue))
 980                         softc->flags |= ADA_FLAG_CAN_NCQ;
 981                 else
 982                         softc->flags &= ~ADA_FLAG_CAN_NCQ;
 983                 if ((cgd.ident_data.support_dsm & ATA_SUPPORT_DSM_TRIM) &&
 984                     (cgd.inq_flags & SID_DMA))
 985                         softc->flags |= ADA_FLAG_CAN_TRIM;
 986                 else
 987                         softc->flags &= ~ADA_FLAG_CAN_TRIM;
 988
 989                 cam_periph_async(periph, code, path, arg);
 990                 break;
 991         }
 992         case AC_ADVINFO_CHANGED:
 993         {
 994                 uintptr_t buftype;
 995
 996                 buftype = (uintptr_t)arg;
 997                 if (buftype == CDAI_TYPE_PHYS_PATH) {
 998                         struct ada_softc *softc;
 999
1000                         softc = periph->softc;
1001                         disk_attr_changed(softc->disk, "GEOM::physpath",
1002                                           M_NOWAIT);
1003                 }
1004                 break;
1005         }
1006         case AC_SENT_BDR:
1007         case AC_BUS_RESET:
1008         {
1009                 softc = (struct ada_softc *)periph->softc;
1010                 cam_periph_async(periph, code, path, arg);
1011                 if (softc->state != ADA_STATE_NORMAL)
1012                         break;
1013                 xpt_setup_ccb(&cgd.ccb_h, periph->path, CAM_PRIORITY_NORMAL);
1014                 cgd.ccb_h.func_code = XPT_GDEV_TYPE;
1015                 xpt_action((union ccb *)&cgd);
1016                 if (ADA_RA >= 0 &&
1017                     cgd.ident_data.support.command1 & ATA_SUPPORT_LOOKAHEAD)
1018                         softc->state = ADA_STATE_RAHEAD;
1019                 else if (ADA_WC >= 0 &&
1020                     cgd.ident_data.support.command1 & ATA_SUPPORT_WRITECACHE)
1021                         softc->state = ADA_STATE_WCACHE;
1022                 else
1023                     break;
1024                 cam_periph_acquire(periph);
1025                 cam_freeze_devq_arg(periph->path,
1026                     RELSIM_RELEASE_RUNLEVEL, CAM_RL_DEV + 1);
1027                 xpt_schedule(periph, CAM_PRIORITY_DEV);
1028         }
1029         default:
1030                 cam_periph_async(periph, code, path, arg);
1031                 break;
1032         }
1033 }
1034
1035 static void
1036 adasysctlinit(void *context, int pending)
1037 {
1038         struct cam_periph *periph;
1039         struct ada_softc *softc;
1040         char tmpstr[80], tmpstr2[80];
1041
1042         periph = (struct cam_periph *)context;
1043
1044         /* periph was held for us when this task was enqueued */
1045         if ((periph->flags & CAM_PERIPH_INVALID) != 0) {
1046                 cam_periph_release(periph);
1047                 return;
1048         }
1049
1050         softc = (struct ada_softc *)periph->softc;
1051         snprintf(tmpstr, sizeof(tmpstr), "CAM ADA unit %d", periph->unit_number);
1052         snprintf(tmpstr2, sizeof(tmpstr2), "%d", periph->unit_number);
1053
1054         sysctl_ctx_init(&softc->sysctl_ctx);
1055         softc->flags |= ADA_FLAG_SCTX_INIT;
1056         softc->sysctl_tree = SYSCTL_ADD_NODE(&softc->sysctl_ctx,
1057                 SYSCTL_STATIC_CHILDREN(_kern_cam_ada), OID_AUTO, tmpstr2,
1058                 CTLFLAG_RD, 0, tmpstr);
1059         if (softc->sysctl_tree == NULL) {
1060                 printf("adasysctlinit: unable to allocate sysctl tree\n");
1061                 cam_periph_release(periph);
1062                 return;
1063         }
1064
1065         SYSCTL_ADD_INT(&softc->sysctl_ctx, SYSCTL_CHILDREN(softc->sysctl_tree),
1066                 OID_AUTO, "read_ahead", CTLFLAG_RW | CTLFLAG_MPSAFE,
1067                 &softc->read_ahead, 0, "Enable disk read ahead.");
1068         SYSCTL_ADD_INT(&softc->sysctl_ctx, SYSCTL_CHILDREN(softc->sysctl_tree),
1069                 OID_AUTO, "write_cache", CTLFLAG_RW | CTLFLAG_MPSAFE,
1070                 &softc->write_cache, 0, "Enable disk write cache.");
1071         SYSCTL_ADD_INT(&softc->sysctl_ctx, SYSCTL_CHILDREN(softc->sysctl_tree),
1072                 OID_AUTO, "sort_io_queue", CTLFLAG_RW | CTLFLAG_MPSAFE,
1073                 &softc->sort_io_queue, 0,
1074                 "Sort IO queue to try and optimise disk access patterns");
1075 #ifdef ADA_TEST_FAILURE
1076         /*
1077          * Add a 'door bell' sysctl which allows one to set it from userland
1078          * and cause something bad to happen.  For the moment, we only allow
1079          * whacking the next read or write.
1080          */
1081         SYSCTL_ADD_INT(&softc->sysctl_ctx, SYSCTL_CHILDREN(softc->sysctl_tree),
1082                 OID_AUTO, "force_read_error", CTLFLAG_RW | CTLFLAG_MPSAFE,
1083                 &softc->force_read_error, 0,
1084                 "Force a read error for the next N reads.");
1085         SYSCTL_ADD_INT(&softc->sysctl_ctx, SYSCTL_CHILDREN(softc->sysctl_tree),
1086                 OID_AUTO, "force_write_error", CTLFLAG_RW | CTLFLAG_MPSAFE,
1087                 &softc->force_write_error, 0,
1088                 "Force a write error for the next N writes.");
1089         SYSCTL_ADD_INT(&softc->sysctl_ctx, SYSCTL_CHILDREN(softc->sysctl_tree),
1090                 OID_AUTO, "periodic_read_error", CTLFLAG_RW | CTLFLAG_MPSAFE,
1091                 &softc->periodic_read_error, 0,
1092                 "Force a read error every N reads (don't set too low).");
1093 #endif
1094         cam_periph_release(periph);
1095 }
1096
1097 static int
1098 adagetattr(struct bio *bp)
1099 {
1100         int ret;
1101         struct cam_periph *periph;
1102
1103         periph = (struct cam_periph *)bp->bio_disk->d_drv1;
1104         cam_periph_lock(periph);
1105         ret = xpt_getattr(bp->bio_data, bp->bio_length, bp->bio_attribute,
1106             periph->path);
1107         cam_periph_unlock(periph);
1108         if (ret == 0)
1109                 bp->bio_completed = bp->bio_length;
1110         return ret;
1111 }
1112
1113 static cam_status
1114 adaregister(struct cam_periph *periph, void *arg)
1115 {
1116         struct ada_softc *softc;
1117         struct ccb_pathinq cpi;
1118         struct ccb_getdev *cgd;
1119         char   announce_buf[80], buf1[32];
1120         struct disk_params *dp;
1121         caddr_t match;
1122         u_int maxio;
1123         int legacy_id, quirks;
1124
1125         cgd = (struct ccb_getdev *)arg;
1126         if (cgd == NULL) {
1127                 printf("adaregister: no getdev CCB, can't register device\n");
1128                 return(CAM_REQ_CMP_ERR);
1129         }
1130
1131         softc = (struct ada_softc *)malloc(sizeof(*softc), M_DEVBUF,
1132             M_NOWAIT|M_ZERO);
1133
1134         if (softc == NULL) {
1135                 printf("adaregister: Unable to probe new device. "
1136                     "Unable to allocate softc\n");
1137                 return(CAM_REQ_CMP_ERR);
1138         }
1139
1140         bioq_init(&softc->bio_queue);
1141         bioq_init(&softc->trim_queue);
1142
1143         if ((cgd->ident_data.capabilities1 & ATA_SUPPORT_DMA) &&
1144             (cgd->inq_flags & SID_DMA))
1145                 softc->flags |= ADA_FLAG_CAN_DMA;
1146         if (cgd->ident_data.support.command2 & ATA_SUPPORT_ADDRESS48) {
1147                 softc->flags |= ADA_FLAG_CAN_48BIT;
1148                 if (cgd->inq_flags & SID_DMA48)
1149                         softc->flags |= ADA_FLAG_CAN_DMA48;
1150         }
1151         if (cgd->ident_data.support.command2 & ATA_SUPPORT_FLUSHCACHE)
1152                 softc->flags |= ADA_FLAG_CAN_FLUSHCACHE;
1153         if (cgd->ident_data.support.command1 & ATA_SUPPORT_POWERMGT)
1154                 softc->flags |= ADA_FLAG_CAN_POWERMGT;
1155         if ((cgd->ident_data.satacapabilities & ATA_SUPPORT_NCQ) &&
1156             (cgd->inq_flags & SID_DMA) && (cgd->inq_flags & SID_CmdQue))
1157                 softc->flags |= ADA_FLAG_CAN_NCQ;
1158         if ((cgd->ident_data.support_dsm & ATA_SUPPORT_DSM_TRIM) &&
1159             (cgd->inq_flags & SID_DMA)) {
1160                 softc->flags |= ADA_FLAG_CAN_TRIM;
1161                 softc->trim_max_ranges = TRIM_MAX_RANGES;
1162                 if (cgd->ident_data.max_dsm_blocks != 0) {
1163                         softc->trim_max_ranges =
1164                             min(cgd->ident_data.max_dsm_blocks *
1165                                 ATA_DSM_BLK_RANGES, softc->trim_max_ranges);
1166                 }
1167         }
1168         if (cgd->ident_data.support.command2 & ATA_SUPPORT_CFA)
1169                 softc->flags |= ADA_FLAG_CAN_CFA;
1170
1171         periph->softc = softc;
1172
1173         /*
1174          * See if this device has any quirks.
1175          */
1176         match = cam_quirkmatch((caddr_t)&cgd->ident_data,
1177                                (caddr_t)ada_quirk_table,
1178                                sizeof(ada_quirk_table)/sizeof(*ada_quirk_table),
1179                                sizeof(*ada_quirk_table), ata_identify_match);
1180         if (match != NULL)
1181                 softc->quirks = ((struct ada_quirk_entry *)match)->quirks;
1182         else
1183                 softc->quirks = ADA_Q_NONE;
1184
1185         bzero(&cpi, sizeof(cpi));
1186         xpt_setup_ccb(&cpi.ccb_h, periph->path, CAM_PRIORITY_NONE);
1187         cpi.ccb_h.func_code = XPT_PATH_INQ;
1188         xpt_action((union ccb *)&cpi);
1189
1190         TASK_INIT(&softc->sysctl_task, 0, adasysctlinit, periph);
1191
1192         /*
1193          * Register this media as a disk
1194          */
1195         (void)cam_periph_hold(periph, PRIBIO);
1196         cam_periph_unlock(periph);
1197         snprintf(announce_buf, sizeof(announce_buf),
1198             "kern.cam.ada.%d.quirks", periph->unit_number);
1199         quirks = softc->quirks;
1200         TUNABLE_INT_FETCH(announce_buf, &quirks);
1201         softc->quirks = quirks;
1202         softc->read_ahead = -1;
1203         snprintf(announce_buf, sizeof(announce_buf),
1204             "kern.cam.ada.%d.read_ahead", periph->unit_number);
1205         TUNABLE_INT_FETCH(announce_buf, &softc->read_ahead);
1206         softc->write_cache = -1;
1207         snprintf(announce_buf, sizeof(announce_buf),
1208             "kern.cam.ada.%d.write_cache", periph->unit_number);
1209         TUNABLE_INT_FETCH(announce_buf, &softc->write_cache);
1210         /* Disable queue sorting for non-rotational media by default. */
1211         if (cgd->ident_data.media_rotation_rate == 1)
1212                 softc->sort_io_queue = 0;
1213         else
1214                 softc->sort_io_queue = -1;
1215         adagetparams(periph, cgd);
1216         softc->disk = disk_alloc();
1217         softc->disk->d_devstat = devstat_new_entry(periph->periph_name,
1218                           periph->unit_number, softc->params.secsize,
1219                           DEVSTAT_ALL_SUPPORTED,
1220                           DEVSTAT_TYPE_DIRECT |
1221                           XPORT_DEVSTAT_TYPE(cpi.transport),
1222                           DEVSTAT_PRIORITY_DISK);
1223         softc->disk->d_open = adaopen;
1224         softc->disk->d_close = adaclose;
1225         softc->disk->d_strategy = adastrategy;
1226         softc->disk->d_getattr = adagetattr;
1227         softc->disk->d_dump = adadump;
1228         softc->disk->d_gone = adadiskgonecb;
1229         softc->disk->d_name = "ada";
1230         softc->disk->d_drv1 = periph;
1231         maxio = cpi.maxio;              /* Honor max I/O size of SIM */
1232         if (maxio == 0)
1233                 maxio = DFLTPHYS;       /* traditional default */
1234         else if (maxio > MAXPHYS)
1235                 maxio = MAXPHYS;        /* for safety */
1236         if (softc->flags & ADA_FLAG_CAN_48BIT)
1237                 maxio = min(maxio, 65536 * softc->params.secsize);
1238         else                                    /* 28bit ATA command limit */
1239                 maxio = min(maxio, 256 * softc->params.secsize);
1240         softc->disk->d_maxsize = maxio;
1241         softc->disk->d_unit = periph->unit_number;
1242         softc->disk->d_flags = 0;
1243         if (softc->flags & ADA_FLAG_CAN_FLUSHCACHE)
1244                 softc->disk->d_flags |= DISKFLAG_CANFLUSHCACHE;
1245         if (softc->flags & ADA_FLAG_CAN_TRIM) {
1246                 softc->disk->d_flags |= DISKFLAG_CANDELETE;
1247                 softc->disk->d_delmaxsize = softc->params.secsize *
1248                                             ATA_DSM_RANGE_MAX *
1249                                             softc->trim_max_ranges;
1250         } else if ((softc->flags & ADA_FLAG_CAN_CFA) &&
1251             !(softc->flags & ADA_FLAG_CAN_48BIT)) {
1252                 softc->disk->d_flags |= DISKFLAG_CANDELETE;
1253                 softc->disk->d_delmaxsize = 256 * softc->params.secsize;
1254         } else
1255                 softc->disk->d_delmaxsize = maxio;
1256         if ((cpi.hba_misc & PIM_UNMAPPED) != 0)
1257                 softc->disk->d_flags |= DISKFLAG_UNMAPPED_BIO;
1258         strlcpy(softc->disk->d_descr, cgd->ident_data.model,
1259             MIN(sizeof(softc->disk->d_descr), sizeof(cgd->ident_data.model)));
1260         strlcpy(softc->disk->d_ident, cgd->ident_data.serial,
1261             MIN(sizeof(softc->disk->d_ident), sizeof(cgd->ident_data.serial)));
1262         softc->disk->d_hba_vendor = cpi.hba_vendor;
1263         softc->disk->d_hba_device = cpi.hba_device;
1264         softc->disk->d_hba_subvendor = cpi.hba_subvendor;
1265         softc->disk->d_hba_subdevice = cpi.hba_subdevice;
1266
1267         softc->disk->d_sectorsize = softc->params.secsize;
1268         softc->disk->d_mediasize = (off_t)softc->params.sectors *
1269             softc->params.secsize;
1270         if (ata_physical_sector_size(&cgd->ident_data) !=
1271             softc->params.secsize) {
1272                 softc->disk->d_stripesize =
1273                     ata_physical_sector_size(&cgd->ident_data);
1274                 softc->disk->d_stripeoffset = (softc->disk->d_stripesize -
1275                     ata_logical_sector_offset(&cgd->ident_data)) %
1276                     softc->disk->d_stripesize;
1277         } else if (softc->quirks & ADA_Q_4K) {
1278                 softc->disk->d_stripesize = 4096;
1279                 softc->disk->d_stripeoffset = 0;
1280         }
1281         softc->disk->d_fwsectors = softc->params.secs_per_track;
1282         softc->disk->d_fwheads = softc->params.heads;
1283         ata_disk_firmware_geom_adjust(softc->disk);
1284
1285         if (ada_legacy_aliases) {
1286 #ifdef ATA_STATIC_ID
1287                 legacy_id = xpt_path_legacy_ata_id(periph->path);
1288 #else
1289                 legacy_id = softc->disk->d_unit;
1290 #endif
1291                 if (legacy_id >= 0) {
1292                         snprintf(announce_buf, sizeof(announce_buf),
1293                             "kern.devalias.%s%d",
1294                             softc->disk->d_name, softc->disk->d_unit);
1295                         snprintf(buf1, sizeof(buf1),
1296                             "ad%d", legacy_id);
1297                         setenv(announce_buf, buf1);
1298                 }
1299         } else
1300                 legacy_id = -1;
1301         /*
1302          * Acquire a reference to the periph before we register with GEOM.
1303          * We'll release this reference once GEOM calls us back (via
1304          * adadiskgonecb()) telling us that our provider has been freed.
1305          */
1306         if (cam_periph_acquire(periph) != CAM_REQ_CMP) {
1307                 xpt_print(periph->path, "%s: lost periph during "
1308                           "registration!\n", __func__);
1309                 cam_periph_lock(periph);
1310                 return (CAM_REQ_CMP_ERR);
1311         }
1312         disk_create(softc->disk, DISK_VERSION);
1313         cam_periph_lock(periph);
1314         cam_periph_unhold(periph);
1315
1316         dp = &softc->params;
1317         snprintf(announce_buf, sizeof(announce_buf),
1318                 "%juMB (%ju %u byte sectors: %dH %dS/T %dC)",
1319                 (uintmax_t)(((uintmax_t)dp->secsize *
1320                 dp->sectors) / (1024*1024)),
1321                 (uintmax_t)dp->sectors,
1322                 dp->secsize, dp->heads,
1323                 dp->secs_per_track, dp->cylinders);
1324         xpt_announce_periph(periph, announce_buf);
1325         xpt_announce_quirks(periph, softc->quirks, ADA_Q_BIT_STRING);
1326         if (legacy_id >= 0)
1327                 printf("%s%d: Previously was known as ad%d\n",
1328                        periph->periph_name, periph->unit_number, legacy_id);
1329
1330         /*
1331          * Create our sysctl variables, now that we know
1332          * we have successfully attached.
1333          */
1334         cam_periph_acquire(periph);
1335         taskqueue_enqueue(taskqueue_thread, &softc->sysctl_task);
1336
1337         /*
1338          * Add async callbacks for bus reset and
1339          * bus device reset calls.  I don't bother
1340          * checking if this fails as, in most cases,
1341          * the system will function just fine without
1342          * them and the only alternative would be to
1343          * not attach the device on failure.
1344          */
1345         xpt_register_async(AC_SENT_BDR | AC_BUS_RESET | AC_LOST_DEVICE |
1346             AC_GETDEV_CHANGED | AC_ADVINFO_CHANGED,
1347             adaasync, periph, periph->path);
1348
1349         /*
1350          * Schedule a periodic event to occasionally send an
1351          * ordered tag to a device.
1352          */
1353         callout_init_mtx(&softc->sendordered_c, periph->sim->mtx, 0);
1354         callout_reset(&softc->sendordered_c,
1355             (ada_default_timeout * hz) / ADA_ORDEREDTAG_INTERVAL,
1356             adasendorderedtag, softc);
1357
1358         if (ADA_RA >= 0 &&
1359             cgd->ident_data.support.command1 & ATA_SUPPORT_LOOKAHEAD) {
1360                 softc->state = ADA_STATE_RAHEAD;
1361                 cam_periph_acquire(periph);
1362                 cam_freeze_devq_arg(periph->path,
1363                     RELSIM_RELEASE_RUNLEVEL, CAM_RL_DEV + 1);
1364                 xpt_schedule(periph, CAM_PRIORITY_DEV);
1365         } else if (ADA_WC >= 0 &&
1366             cgd->ident_data.support.command1 & ATA_SUPPORT_WRITECACHE) {
1367                 softc->state = ADA_STATE_WCACHE;
1368                 cam_periph_acquire(periph);
1369                 cam_freeze_devq_arg(periph->path,
1370                     RELSIM_RELEASE_RUNLEVEL, CAM_RL_DEV + 1);
1371                 xpt_schedule(periph, CAM_PRIORITY_DEV);
1372         } else
1373                 softc->state = ADA_STATE_NORMAL;
1374
1375         return(CAM_REQ_CMP);
1376 }
1377
1378 static void
1379 adastart(struct cam_periph *periph, union ccb *start_ccb)
1380 {
1381         struct ada_softc *softc = (struct ada_softc *)periph->softc;
1382         struct ccb_ataio *ataio = &start_ccb->ataio;
1383
1384         CAM_DEBUG(periph->path, CAM_DEBUG_TRACE, ("adastart\n"));
1385
1386         switch (softc->state) {
1387         case ADA_STATE_NORMAL:
1388         {
1389                 struct bio *bp;
1390                 u_int8_t tag_code;
1391
1392                 /* Execute immediate CCB if waiting. */
1393                 if (periph->immediate_priority <= periph->pinfo.priority) {
1394                         CAM_DEBUG(periph->path, CAM_DEBUG_SUBTRACE,
1395                                         ("queuing for immediate ccb\n"));
1396                         start_ccb->ccb_h.ccb_state = ADA_CCB_WAITING;
1397                         SLIST_INSERT_HEAD(&periph->ccb_list, &start_ccb->ccb_h,
1398                                           periph_links.sle);
1399                         periph->immediate_priority = CAM_PRIORITY_NONE;
1400                         wakeup(&periph->ccb_list);
1401                         /* Have more work to do, so ensure we stay scheduled */
1402                         adaschedule(periph);
1403                         break;
1404                 }
1405                 /* Run TRIM if not running yet. */
1406                 if (!softc->trim_running &&
1407                     (bp = bioq_first(&softc->trim_queue)) != 0) {
1408                         struct trim_request *req = &softc->trim_req;
1409                         struct bio *bp1;
1410                         uint64_t lastlba = (uint64_t)-1;
1411                         int bps = 0, c, lastcount = 0, off, ranges = 0;
1412
1413                         softc->trim_running = 1;
1414                         bzero(req, sizeof(*req));
1415                         bp1 = bp;
1416                         do {
1417                                 uint64_t lba = bp1->bio_pblkno;
1418                                 int count = bp1->bio_bcount /
1419                                     softc->params.secsize;
1420
1421                                 bioq_remove(&softc->trim_queue, bp1);
1422
1423                                 /* Try to extend the previous range. */
1424                                 if (lba == lastlba) {
1425                                         c = min(count, ATA_DSM_RANGE_MAX - lastcount);
1426                                         lastcount += c;
1427                                         off = (ranges - 1) * ATA_DSM_RANGE_SIZE;
1428                                         req->data[off + 6] = lastcount & 0xff;
1429                                         req->data[off + 7] =
1430                                             (lastcount >> 8) & 0xff;
1431                                         count -= c;
1432                                         lba += c;
1433                                 }
1434
1435                                 while (count > 0) {
1436                                         c = min(count, ATA_DSM_RANGE_MAX);
1437                                         off = ranges * ATA_DSM_RANGE_SIZE;
1438                                         req->data[off + 0] = lba & 0xff;
1439                                         req->data[off + 1] = (lba >> 8) & 0xff;
1440                                         req->data[off + 2] = (lba >> 16) & 0xff;
1441                                         req->data[off + 3] = (lba >> 24) & 0xff;
1442                                         req->data[off + 4] = (lba >> 32) & 0xff;
1443                                         req->data[off + 5] = (lba >> 40) & 0xff;
1444                                         req->data[off + 6] = c & 0xff;
1445                                         req->data[off + 7] = (c >> 8) & 0xff;
1446                                         lba += c;
1447                                         count -= c;
1448                                         lastcount = c;
1449                                         ranges++;
1450                                         /*
1451                                          * Its the caller's responsibility to ensure the
1452                                          * request will fit so we don't need to check for
1453                                          * overrun here
1454                                          */
1455                                 }
1456                                 lastlba = lba;
1457                                 req->bps[bps++] = bp1;
1458                                 bp1 = bioq_first(&softc->trim_queue);
1459                                 if (bps >= TRIM_MAX_BIOS ||
1460                                     bp1 == NULL ||
1461                                     bp1->bio_bcount / softc->params.secsize >
1462                                     (softc->trim_max_ranges - ranges) *
1463                                     ATA_DSM_RANGE_MAX)
1464                                         break;
1465                         } while (1);
1466                         cam_fill_ataio(ataio,
1467                             ada_retry_count,
1468                             adadone,
1469                             CAM_DIR_OUT,
1470                             0,
1471                             req->data,
1472                             ((ranges + ATA_DSM_BLK_RANGES - 1) /
1473                                 ATA_DSM_BLK_RANGES) * ATA_DSM_BLK_SIZE,
1474                             ada_default_timeout * 1000);
1475                         ata_48bit_cmd(ataio, ATA_DATA_SET_MANAGEMENT,
1476                             ATA_DSM_TRIM, 0, (ranges + ATA_DSM_BLK_RANGES -
1477                             1) / ATA_DSM_BLK_RANGES);
1478                         start_ccb->ccb_h.ccb_state = ADA_CCB_TRIM;
1479                         goto out;
1480                 }
1481                 /* Run regular command. */
1482                 bp = bioq_first(&softc->bio_queue);
1483                 if (bp == NULL) {
1484                         xpt_release_ccb(start_ccb);
1485                         break;
1486                 }
1487                 bioq_remove(&softc->bio_queue, bp);
1488
1489                 if ((bp->bio_flags & BIO_ORDERED) != 0
1490                  || (softc->flags & ADA_FLAG_NEED_OTAG) != 0) {
1491                         softc->flags &= ~ADA_FLAG_NEED_OTAG;
1492                         softc->ordered_tag_count++;
1493                         tag_code = 0;
1494                 } else {
1495                         tag_code = 1;
1496                 }
1497                 switch (bp->bio_cmd) {
1498                 case BIO_WRITE:
1499                         softc->flags |= ADA_FLAG_DIRTY;
1500                         /* FALLTHROUGH */
1501                 case BIO_READ:
1502                 {
1503                         uint64_t lba = bp->bio_pblkno;
1504                         uint16_t count = bp->bio_bcount / softc->params.secsize;
1505 #ifdef ADA_TEST_FAILURE
1506                         int fail = 0;
1507
1508                         /*
1509                          * Support the failure ioctls.  If the command is a
1510                          * read, and there are pending forced read errors, or
1511                          * if a write and pending write errors, then fail this
1512                          * operation with EIO.  This is useful for testing
1513                          * purposes.  Also, support having every Nth read fail.
1514                          *
1515                          * This is a rather blunt tool.
1516                          */
1517                         if (bp->bio_cmd == BIO_READ) {
1518                                 if (softc->force_read_error) {
1519                                         softc->force_read_error--;
1520                                         fail = 1;
1521                                 }
1522                                 if (softc->periodic_read_error > 0) {
1523                                         if (++softc->periodic_read_count >=
1524                                             softc->periodic_read_error) {
1525                                                 softc->periodic_read_count = 0;
1526                                                 fail = 1;
1527                                         }
1528                                 }
1529                         } else {
1530                                 if (softc->force_write_error) {
1531                                         softc->force_write_error--;
1532                                         fail = 1;
1533                                 }
1534                         }
1535                         if (fail) {
1536                                 bp->bio_error = EIO;
1537                                 bp->bio_flags |= BIO_ERROR;
1538                                 biodone(bp);
1539                                 xpt_release_ccb(start_ccb);
1540                                 adaschedule(periph);
1541                                 return;
1542                         }
1543 #endif
1544                         KASSERT((bp->bio_flags & BIO_UNMAPPED) == 0 ||
1545                             round_page(bp->bio_bcount + bp->bio_ma_offset) /
1546                             PAGE_SIZE == bp->bio_ma_n,
1547                             ("Short bio %p", bp));
1548                         cam_fill_ataio(ataio,
1549                             ada_retry_count,
1550                             adadone,
1551                             (bp->bio_cmd == BIO_READ ? CAM_DIR_IN :
1552                                 CAM_DIR_OUT) | ((bp->bio_flags & BIO_UNMAPPED)
1553                                 != 0 ? CAM_DATA_BIO : 0),
1554                             tag_code,
1555                             ((bp->bio_flags & BIO_UNMAPPED) != 0) ? (void *)bp :
1556                                 bp->bio_data,
1557                             bp->bio_bcount,
1558                             ada_default_timeout*1000);
1559
1560                         if ((softc->flags & ADA_FLAG_CAN_NCQ) && tag_code) {
1561                                 if (bp->bio_cmd == BIO_READ) {
1562                                         ata_ncq_cmd(ataio, ATA_READ_FPDMA_QUEUED,
1563                                             lba, count);
1564                                 } else {
1565                                         ata_ncq_cmd(ataio, ATA_WRITE_FPDMA_QUEUED,
1566                                             lba, count);
1567                                 }
1568                         } else if ((softc->flags & ADA_FLAG_CAN_48BIT) &&
1569                             (lba + count >= ATA_MAX_28BIT_LBA ||
1570                             count > 256)) {
1571                                 if (softc->flags & ADA_FLAG_CAN_DMA48) {
1572                                         if (bp->bio_cmd == BIO_READ) {
1573                                                 ata_48bit_cmd(ataio, ATA_READ_DMA48,
1574                                                     0, lba, count);
1575                                         } else {
1576                                                 ata_48bit_cmd(ataio, ATA_WRITE_DMA48,
1577                                                     0, lba, count);
1578                                         }
1579                                 } else {
1580                                         if (bp->bio_cmd == BIO_READ) {
1581                                                 ata_48bit_cmd(ataio, ATA_READ_MUL48,
1582                                                     0, lba, count);
1583                                         } else {
1584                                                 ata_48bit_cmd(ataio, ATA_WRITE_MUL48,
1585                                                     0, lba, count);
1586                                         }
1587                                 }
1588                         } else {
1589                                 if (count == 256)
1590                                         count = 0;
1591                                 if (softc->flags & ADA_FLAG_CAN_DMA) {
1592                                         if (bp->bio_cmd == BIO_READ) {
1593                                                 ata_28bit_cmd(ataio, ATA_READ_DMA,
1594                                                     0, lba, count);
1595                                         } else {
1596                                                 ata_28bit_cmd(ataio, ATA_WRITE_DMA,
1597                                                     0, lba, count);
1598                                         }
1599                                 } else {
1600                                         if (bp->bio_cmd == BIO_READ) {
1601                                                 ata_28bit_cmd(ataio, ATA_READ_MUL,
1602                                                     0, lba, count);
1603                                         } else {
1604                                                 ata_28bit_cmd(ataio, ATA_WRITE_MUL,
1605                                                     0, lba, count);
1606                                         }
1607                                 }
1608                         }
1609                         break;
1610                 }
1611                 case BIO_DELETE:
1612                 {
1613                         uint64_t lba = bp->bio_pblkno;
1614                         uint16_t count = bp->bio_bcount / softc->params.secsize;
1615
1616                         cam_fill_ataio(ataio,
1617                             ada_retry_count,
1618                             adadone,
1619                             CAM_DIR_NONE,
1620                             0,
1621                             NULL,
1622                             0,
1623                             ada_default_timeout*1000);
1624
1625                         if (count >= 256)
1626                                 count = 0;
1627                         ata_28bit_cmd(ataio, ATA_CFA_ERASE, 0, lba, count);
1628                         break;
1629                 }
1630                 case BIO_FLUSH:
1631                         cam_fill_ataio(ataio,
1632                             1,
1633                             adadone,
1634                             CAM_DIR_NONE,
1635                             0,
1636                             NULL,
1637                             0,
1638                             ada_default_timeout*1000);
1639
1640                         if (softc->flags & ADA_FLAG_CAN_48BIT)
1641                                 ata_48bit_cmd(ataio, ATA_FLUSHCACHE48, 0, 0, 0);
1642                         else
1643                                 ata_28bit_cmd(ataio, ATA_FLUSHCACHE, 0, 0, 0);
1644                         break;
1645                 }
1646                 start_ccb->ccb_h.ccb_state = ADA_CCB_BUFFER_IO;
1647 out:
1648                 start_ccb->ccb_h.ccb_bp = bp;
1649                 softc->outstanding_cmds++;
1650                 xpt_action(start_ccb);
1651
1652                 /* May have more work to do, so ensure we stay scheduled */
1653                 adaschedule(periph);
1654                 break;
1655         }
1656         case ADA_STATE_RAHEAD:
1657         case ADA_STATE_WCACHE:
1658         {
1659                 if ((periph->flags & CAM_PERIPH_INVALID) != 0) {
1660                         softc->state = ADA_STATE_NORMAL;
1661                         xpt_release_ccb(start_ccb);
1662                         cam_release_devq(periph->path,
1663                             RELSIM_RELEASE_RUNLEVEL, 0, CAM_RL_DEV + 1, FALSE);
1664                         adaschedule(periph);
1665                         cam_periph_release_locked(periph);
1666                         return;
1667                 }
1668
1669                 cam_fill_ataio(ataio,
1670                     1,
1671                     adadone,
1672                     CAM_DIR_NONE,
1673                     0,
1674                     NULL,
1675                     0,
1676                     ada_default_timeout*1000);
1677
1678                 if (softc->state == ADA_STATE_RAHEAD) {
1679                         ata_28bit_cmd(ataio, ATA_SETFEATURES, ADA_RA ?
1680                             ATA_SF_ENAB_RCACHE : ATA_SF_DIS_RCACHE, 0, 0);
1681                         start_ccb->ccb_h.ccb_state = ADA_CCB_RAHEAD;
1682                 } else {
1683                         ata_28bit_cmd(ataio, ATA_SETFEATURES, ADA_WC ?
1684                             ATA_SF_ENAB_WCACHE : ATA_SF_DIS_WCACHE, 0, 0);
1685                         start_ccb->ccb_h.ccb_state = ADA_CCB_WCACHE;
1686                 }
1687                 xpt_action(start_ccb);
1688                 break;
1689         }
1690         }
1691 }
1692
1693 static void
1694 adadone(struct cam_periph *periph, union ccb *done_ccb)
1695 {
1696         struct ada_softc *softc;
1697         struct ccb_ataio *ataio;
1698         struct ccb_getdev *cgd;
1699
1700         softc = (struct ada_softc *)periph->softc;
1701         ataio = &done_ccb->ataio;
1702
1703         CAM_DEBUG(periph->path, CAM_DEBUG_TRACE, ("adadone\n"));
1704
1705         switch (ataio->ccb_h.ccb_state & ADA_CCB_TYPE_MASK) {
1706         case ADA_CCB_BUFFER_IO:
1707         case ADA_CCB_TRIM:
1708         {
1709                 struct bio *bp;
1710
1711                 bp = (struct bio *)done_ccb->ccb_h.ccb_bp;
1712                 if ((done_ccb->ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
1713                         int error;
1714
1715                         error = adaerror(done_ccb, 0, 0);
1716                         if (error == ERESTART) {
1717                                 /* A retry was scheduled, so just return. */
1718                                 return;
1719                         }
1720                         if (error != 0) {
1721                                 bp->bio_error = error;
1722                                 bp->bio_resid = bp->bio_bcount;
1723                                 bp->bio_flags |= BIO_ERROR;
1724                         } else {
1725                                 bp->bio_resid = ataio->resid;
1726                                 bp->bio_error = 0;
1727                                 if (bp->bio_resid != 0)
1728                                         bp->bio_flags |= BIO_ERROR;
1729                         }
1730                         if ((done_ccb->ccb_h.status & CAM_DEV_QFRZN) != 0)
1731                                 cam_release_devq(done_ccb->ccb_h.path,
1732                                                  /*relsim_flags*/0,
1733                                                  /*reduction*/0,
1734                                                  /*timeout*/0,
1735                                                  /*getcount_only*/0);
1736                 } else {
1737                         if ((done_ccb->ccb_h.status & CAM_DEV_QFRZN) != 0)
1738                                 panic("REQ_CMP with QFRZN");
1739                         bp->bio_resid = ataio->resid;
1740                         if (ataio->resid > 0)
1741                                 bp->bio_flags |= BIO_ERROR;
1742                 }
1743                 softc->outstanding_cmds--;
1744                 if (softc->outstanding_cmds == 0)
1745                         softc->flags |= ADA_FLAG_WENT_IDLE;
1746                 if ((ataio->ccb_h.ccb_state & ADA_CCB_TYPE_MASK) ==
1747                     ADA_CCB_TRIM) {
1748                         struct trim_request *req =
1749                             (struct trim_request *)ataio->data_ptr;
1750                         int i;
1751
1752                         for (i = 1; i < TRIM_MAX_BIOS && req->bps[i]; i++) {
1753                                 struct bio *bp1 = req->bps[i];
1754
1755                                 bp1->bio_resid = bp->bio_resid;
1756                                 bp1->bio_error = bp->bio_error;
1757                                 if (bp->bio_flags & BIO_ERROR)
1758                                         bp1->bio_flags |= BIO_ERROR;
1759                                 biodone(bp1);
1760                         }
1761                         softc->trim_running = 0;
1762                         biodone(bp);
1763                         adaschedule(periph);
1764                 } else
1765                         biodone(bp);
1766                 break;
1767         }
1768         case ADA_CCB_RAHEAD:
1769         {
1770                 if ((done_ccb->ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
1771                         if (adaerror(done_ccb, 0, 0) == ERESTART) {
1772                                 return;
1773                         } else if ((done_ccb->ccb_h.status & CAM_DEV_QFRZN) != 0) {
1774                                 cam_release_devq(done_ccb->ccb_h.path,
1775                                     /*relsim_flags*/0,
1776                                     /*reduction*/0,
1777                                     /*timeout*/0,
1778                                     /*getcount_only*/0);
1779                         }
1780                 }
1781
1782                 /*
1783                  * Since our peripheral may be invalidated by an error
1784                  * above or an external event, we must release our CCB
1785                  * before releasing the reference on the peripheral.
1786                  * The peripheral will only go away once the last reference
1787                  * is removed, and we need it around for the CCB release
1788                  * operation.
1789                  */
1790                 cgd = (struct ccb_getdev *)done_ccb;
1791                 xpt_setup_ccb(&cgd->ccb_h, periph->path, CAM_PRIORITY_NORMAL);
1792                 cgd->ccb_h.func_code = XPT_GDEV_TYPE;
1793                 xpt_action((union ccb *)cgd);
1794                 if (ADA_WC >= 0 &&
1795                     cgd->ident_data.support.command1 & ATA_SUPPORT_WRITECACHE) {
1796                         softc->state = ADA_STATE_WCACHE;
1797                         xpt_release_ccb(done_ccb);
1798                         xpt_schedule(periph, CAM_PRIORITY_DEV);
1799                         return;
1800                 }
1801                 softc->state = ADA_STATE_NORMAL;
1802                 xpt_release_ccb(done_ccb);
1803                 cam_release_devq(periph->path,
1804                     RELSIM_RELEASE_RUNLEVEL, 0, CAM_RL_DEV + 1, FALSE);
1805                 adaschedule(periph);
1806                 cam_periph_release_locked(periph);
1807                 return;
1808         }
1809         case ADA_CCB_WCACHE:
1810         {
1811                 if ((done_ccb->ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
1812                         if (adaerror(done_ccb, 0, 0) == ERESTART) {
1813                                 return;
1814                         } else if ((done_ccb->ccb_h.status & CAM_DEV_QFRZN) != 0) {
1815                                 cam_release_devq(done_ccb->ccb_h.path,
1816                                     /*relsim_flags*/0,
1817                                     /*reduction*/0,
1818                                     /*timeout*/0,
1819                                     /*getcount_only*/0);
1820                         }
1821                 }
1822
1823                 softc->state = ADA_STATE_NORMAL;
1824                 /*
1825                  * Since our peripheral may be invalidated by an error
1826                  * above or an external event, we must release our CCB
1827                  * before releasing the reference on the peripheral.
1828                  * The peripheral will only go away once the last reference
1829                  * is removed, and we need it around for the CCB release
1830                  * operation.
1831                  */
1832                 xpt_release_ccb(done_ccb);
1833                 cam_release_devq(periph->path,
1834                     RELSIM_RELEASE_RUNLEVEL, 0, CAM_RL_DEV + 1, FALSE);
1835                 adaschedule(periph);
1836                 cam_periph_release_locked(periph);
1837                 return;
1838         }
1839         case ADA_CCB_WAITING:
1840         {
1841                 /* Caller will release the CCB */
1842                 wakeup(&done_ccb->ccb_h.cbfcnp);
1843                 return;
1844         }
1845         case ADA_CCB_DUMP:
1846                 /* No-op.  We're polling */
1847                 return;
1848         default:
1849                 break;
1850         }
1851         xpt_release_ccb(done_ccb);
1852 }
1853
1854 static int
1855 adaerror(union ccb *ccb, u_int32_t cam_flags, u_int32_t sense_flags)
1856 {
1857
1858         return(cam_periph_error(ccb, cam_flags, sense_flags, NULL));
1859 }
1860
1861 static void
1862 adagetparams(struct cam_periph *periph, struct ccb_getdev *cgd)
1863 {
1864         struct ada_softc *softc = (struct ada_softc *)periph->softc;
1865         struct disk_params *dp = &softc->params;
1866         u_int64_t lbasize48;
1867         u_int32_t lbasize;
1868
1869         dp->secsize = ata_logical_sector_size(&cgd->ident_data);
1870         if ((cgd->ident_data.atavalid & ATA_FLAG_54_58) &&
1871                 cgd->ident_data.current_heads && cgd->ident_data.current_sectors) {
1872                 dp->heads = cgd->ident_data.current_heads;
1873                 dp->secs_per_track = cgd->ident_data.current_sectors;
1874                 dp->cylinders = cgd->ident_data.cylinders;
1875                 dp->sectors = (u_int32_t)cgd->ident_data.current_size_1 |
1876                           ((u_int32_t)cgd->ident_data.current_size_2 << 16);
1877         } else {
1878                 dp->heads = cgd->ident_data.heads;
1879                 dp->secs_per_track = cgd->ident_data.sectors;
1880                 dp->cylinders = cgd->ident_data.cylinders;
1881                 dp->sectors = cgd->ident_data.cylinders * dp->heads * dp->secs_per_track;
1882         }
1883         lbasize = (u_int32_t)cgd->ident_data.lba_size_1 |
1884                   ((u_int32_t)cgd->ident_data.lba_size_2 << 16);
1885
1886         /* use the 28bit LBA size if valid or bigger than the CHS mapping */
1887         if (cgd->ident_data.cylinders == 16383 || dp->sectors < lbasize)
1888                 dp->sectors = lbasize;
1889
1890         /* use the 48bit LBA size if valid */
1891         lbasize48 = ((u_int64_t)cgd->ident_data.lba_size48_1) |
1892                     ((u_int64_t)cgd->ident_data.lba_size48_2 << 16) |
1893                     ((u_int64_t)cgd->ident_data.lba_size48_3 << 32) |
1894                     ((u_int64_t)cgd->ident_data.lba_size48_4 << 48);
1895         if ((cgd->ident_data.support.command2 & ATA_SUPPORT_ADDRESS48) &&
1896             lbasize48 > ATA_MAX_28BIT_LBA)
1897                 dp->sectors = lbasize48;
1898 }
1899
1900 static void
1901 adasendorderedtag(void *arg)
1902 {
1903         struct ada_softc *softc = arg;
1904
1905         if (ada_send_ordered) {
1906                 if ((softc->ordered_tag_count == 0)
1907                  && ((softc->flags & ADA_FLAG_WENT_IDLE) == 0)) {
1908                         softc->flags |= ADA_FLAG_NEED_OTAG;
1909                 }
1910                 if (softc->outstanding_cmds > 0)
1911                         softc->flags &= ~ADA_FLAG_WENT_IDLE;
1912
1913                 softc->ordered_tag_count = 0;
1914         }
1915         /* Queue us up again */
1916         callout_reset(&softc->sendordered_c,
1917             (ada_default_timeout * hz) / ADA_ORDEREDTAG_INTERVAL,
1918             adasendorderedtag, softc);
1919 }
1920
1921 /*
1922  * Step through all ADA peripheral drivers, and if the device is still open,
1923  * sync the disk cache to physical media.
1924  */
1925 static void
1926 adaflush(void)
1927 {
1928         struct cam_periph *periph;
1929         struct ada_softc *softc;
1930         union ccb *ccb;
1931         int error;
1932
1933         CAM_PERIPH_FOREACH(periph, &adadriver) {
1934                 softc = (struct ada_softc *)periph->softc;
1935                 if (SCHEDULER_STOPPED()) {
1936                         /* If we paniced with the lock held, do not recurse. */
1937                         if (!cam_periph_owned(periph) &&
1938                             (softc->flags & ADA_FLAG_OPEN)) {
1939                                 adadump(softc->disk, NULL, 0, 0, 0);
1940                         }
1941                         continue;
1942                 }
1943                 cam_periph_lock(periph);
1944                 /*
1945                  * We only sync the cache if the drive is still open, and
1946                  * if the drive is capable of it..
1947                  */
1948                 if (((softc->flags & ADA_FLAG_OPEN) == 0) ||
1949                     (softc->flags & ADA_FLAG_CAN_FLUSHCACHE) == 0) {
1950                         cam_periph_unlock(periph);
1951                         continue;
1952                 }
1953
1954                 ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
1955                 cam_fill_ataio(&ccb->ataio,
1956                                     0,
1957                                     adadone,
1958                                     CAM_DIR_NONE,
1959                                     0,
1960                                     NULL,
1961                                     0,
1962                                     ada_default_timeout*1000);
1963                 if (softc->flags & ADA_FLAG_CAN_48BIT)
1964                         ata_48bit_cmd(&ccb->ataio, ATA_FLUSHCACHE48, 0, 0, 0);
1965                 else
1966                         ata_28bit_cmd(&ccb->ataio, ATA_FLUSHCACHE, 0, 0, 0);
1967
1968                 error = cam_periph_runccb(ccb, adaerror, /*cam_flags*/0,
1969                     /*sense_flags*/ SF_NO_RECOVERY | SF_NO_RETRY,
1970                     softc->disk->d_devstat);
1971                 if (error != 0)
1972                         xpt_print(periph->path, "Synchronize cache failed\n");
1973                 xpt_release_ccb(ccb);
1974                 cam_periph_unlock(periph);
1975         }
1976 }
1977
1978 static void
1979 adaspindown(uint8_t cmd, int flags)
1980 {
1981         struct cam_periph *periph;
1982         struct ada_softc *softc;
1983         union ccb *ccb;
1984         int error;
1985
1986         CAM_PERIPH_FOREACH(periph, &adadriver) {
1987                 /* If we paniced with lock held - not recurse here. */
1988                 if (cam_periph_owned(periph))
1989                         continue;
1990                 cam_periph_lock(periph);
1991                 softc = (struct ada_softc *)periph->softc;
1992                 /*
1993                  * We only spin-down the drive if it is capable of it..
1994                  */
1995                 if ((softc->flags & ADA_FLAG_CAN_POWERMGT) == 0) {
1996                         cam_periph_unlock(periph);
1997                         continue;
1998                 }
1999
2000                 if (bootverbose)
2001                         xpt_print(periph->path, "spin-down\n");
2002
2003                 ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
2004                 cam_fill_ataio(&ccb->ataio,
2005                                     0,
2006                                     adadone,
2007                                     CAM_DIR_NONE | flags,
2008                                     0,
2009                                     NULL,
2010                                     0,
2011                                     ada_default_timeout*1000);
2012                 ata_28bit_cmd(&ccb->ataio, cmd, 0, 0, 0);
2013
2014                 error = cam_periph_runccb(ccb, adaerror, /*cam_flags*/0,
2015                     /*sense_flags*/ SF_NO_RECOVERY | SF_NO_RETRY,
2016                     softc->disk->d_devstat);
2017                 if (error != 0)
2018                         xpt_print(periph->path, "Spin-down disk failed\n");
2019                 xpt_release_ccb(ccb);
2020                 cam_periph_unlock(periph);
2021         }
2022 }
2023
2024 static void
2025 adashutdown(void *arg, int howto)
2026 {
2027
2028         adaflush();
2029         if (ada_spindown_shutdown != 0 &&
2030             (howto & (RB_HALT | RB_POWEROFF)) != 0)
2031                 adaspindown(ATA_STANDBY_IMMEDIATE, 0);
2032 }
2033
2034 static void
2035 adasuspend(void *arg)
2036 {
2037
2038         adaflush();
2039         if (ada_spindown_suspend != 0)
2040                 adaspindown(ATA_SLEEP, CAM_DEV_QFREEZE);
2041 }
2042
2043 static void
2044 adaresume(void *arg)
2045 {
2046         struct cam_periph *periph;
2047         struct ada_softc *softc;
2048
2049         if (ada_spindown_suspend == 0)
2050                 return;
2051
2052         CAM_PERIPH_FOREACH(periph, &adadriver) {
2053                 cam_periph_lock(periph);
2054                 softc = (struct ada_softc *)periph->softc;
2055                 /*
2056                  * We only spin-down the drive if it is capable of it..
2057                  */
2058                 if ((softc->flags & ADA_FLAG_CAN_POWERMGT) == 0) {
2059                         cam_periph_unlock(periph);
2060                         continue;
2061                 }
2062
2063                 if (bootverbose)
2064                         xpt_print(periph->path, "resume\n");
2065
2066                 /*
2067                  * Drop freeze taken due to CAM_DEV_QFREEZE flag set on
2068                  * sleep request.
2069                  */
2070                 cam_release_devq(periph->path,
2071                          /*relsim_flags*/0,
2072                          /*openings*/0,
2073                          /*timeout*/0,
2074                          /*getcount_only*/0);
2075
2076                 cam_periph_unlock(periph);
2077         }
2078 }
2079
2080 #endif /* _KERNEL */