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