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_RW,
 597            &ada_legacy_aliases, 0, "Create legacy-like device aliases");
 598 TUNABLE_INT("kern.cam.ada.legacy_aliases", &ada_legacy_aliases);
 599 SYSCTL_INT(_kern_cam_ada, OID_AUTO, retry_count, CTLFLAG_RW,
 600            &ada_retry_count, 0, "Normal I/O retry count");
 601 TUNABLE_INT("kern.cam.ada.retry_count", &ada_retry_count);
 602 SYSCTL_INT(_kern_cam_ada, OID_AUTO, default_timeout, CTLFLAG_RW,
 603            &ada_default_timeout, 0, "Normal I/O timeout (in seconds)");
 604 TUNABLE_INT("kern.cam.ada.default_timeout", &ada_default_timeout);
 605 SYSCTL_INT(_kern_cam_ada, OID_AUTO, send_ordered, CTLFLAG_RW,
 606            &ada_send_ordered, 0, "Send Ordered Tags");
 607 TUNABLE_INT("kern.cam.ada.send_ordered", &ada_send_ordered);
 608 SYSCTL_INT(_kern_cam_ada, OID_AUTO, spindown_shutdown, CTLFLAG_RW,
 609            &ada_spindown_shutdown, 0, "Spin down upon shutdown");
 610 TUNABLE_INT("kern.cam.ada.spindown_shutdown", &ada_spindown_shutdown);
 611 SYSCTL_INT(_kern_cam_ada, OID_AUTO, spindown_suspend, CTLFLAG_RW,
 612            &ada_spindown_suspend, 0, "Spin down upon suspend");
 613 TUNABLE_INT("kern.cam.ada.spindown_suspend", &ada_spindown_suspend);
 614 SYSCTL_INT(_kern_cam_ada, OID_AUTO, read_ahead, CTLFLAG_RW,
 615            &ada_read_ahead, 0, "Enable disk read-ahead");
 616 TUNABLE_INT("kern.cam.ada.read_ahead", &ada_read_ahead);
 617 SYSCTL_INT(_kern_cam_ada, OID_AUTO, write_cache, CTLFLAG_RW,
 618            &ada_write_cache, 0, "Enable disk write cache");
 619 TUNABLE_INT("kern.cam.ada.write_cache", &ada_write_cache);
 620
 621 /*
 622  * ADA_ORDEREDTAG_INTERVAL determines how often, relative
 623  * to the default timeout, we check to see whether an ordered
 624  * tagged transaction is appropriate to prevent simple tag
 625  * starvation.  Since we'd like to ensure that there is at least
 626  * 1/2 of the timeout length left for a starved transaction to
 627  * complete after we've sent an ordered tag, we must poll at least
 628  * four times in every timeout period.  This takes care of the worst
 629  * case where a starved transaction starts during an interval that
 630  * meets the requirement "don't send an ordered tag" test so it takes
 631  * us two intervals to determine that a tag must be sent.
 632  */
 633 #ifndef ADA_ORDEREDTAG_INTERVAL
 634 #define ADA_ORDEREDTAG_INTERVAL 4
 635 #endif
 636
 637 static struct periph_driver adadriver =
 638 {
 639         adainit, "ada",
 640         TAILQ_HEAD_INITIALIZER(adadriver.units), /* generation */ 0
 641 };
 642
 643 PERIPHDRIVER_DECLARE(ada, adadriver);
 644
 645 static int
 646 adaopen(struct disk *dp)
 647 {
 648         struct cam_periph *periph;
 649         struct ada_softc *softc;
 650         int error;
 651
 652         periph = (struct cam_periph *)dp->d_drv1;
 653         if (cam_periph_acquire(periph) != CAM_REQ_CMP) {
 654                 return(ENXIO);
 655         }
 656
 657         cam_periph_lock(periph);
 658         if ((error = cam_periph_hold(periph, PRIBIO|PCATCH)) != 0) {
 659                 cam_periph_unlock(periph);
 660                 cam_periph_release(periph);
 661                 return (error);
 662         }
 663
 664         CAM_DEBUG(periph->path, CAM_DEBUG_TRACE | CAM_DEBUG_PERIPH,
 665             ("adaopen\n"));
 666
 667         softc = (struct ada_softc *)periph->softc;
 668         softc->flags |= ADA_FLAG_OPEN;
 669
 670         cam_periph_unhold(periph);
 671         cam_periph_unlock(periph);
 672         return (0);
 673 }
 674
 675 static int
 676 adaclose(struct disk *dp)
 677 {
 678         struct  cam_periph *periph;
 679         struct  ada_softc *softc;
 680         union ccb *ccb;
 681         int error;
 682
 683         periph = (struct cam_periph *)dp->d_drv1;
 684         softc = (struct ada_softc *)periph->softc;
 685         cam_periph_lock(periph);
 686
 687         CAM_DEBUG(periph->path, CAM_DEBUG_TRACE | CAM_DEBUG_PERIPH,
 688             ("adaclose\n"));
 689
 690         /* We only sync the cache if the drive is capable of it. */
 691         if ((softc->flags & ADA_FLAG_DIRTY) != 0 &&
 692             (softc->flags & ADA_FLAG_CAN_FLUSHCACHE) != 0 &&
 693             (periph->flags & CAM_PERIPH_INVALID) == 0 &&
 694             cam_periph_hold(periph, PRIBIO) == 0) {
 695
 696                 ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
 697                 cam_fill_ataio(&ccb->ataio,
 698                                     1,
 699                                     adadone,
 700                                     CAM_DIR_NONE,
 701                                     0,
 702                                     NULL,
 703                                     0,
 704                                     ada_default_timeout*1000);
 705
 706                 if (softc->flags & ADA_FLAG_CAN_48BIT)
 707                         ata_48bit_cmd(&ccb->ataio, ATA_FLUSHCACHE48, 0, 0, 0);
 708                 else
 709                         ata_28bit_cmd(&ccb->ataio, ATA_FLUSHCACHE, 0, 0, 0);
 710                 error = cam_periph_runccb(ccb, adaerror, /*cam_flags*/0,
 711                     /*sense_flags*/0, softc->disk->d_devstat);
 712
 713                 if (error != 0)
 714                         xpt_print(periph->path, "Synchronize cache failed\n");
 715                 else
 716                         softc->flags &= ~ADA_FLAG_DIRTY;
 717                 xpt_release_ccb(ccb);
 718                 cam_periph_unhold(periph);
 719         }
 720
 721         softc->flags &= ~ADA_FLAG_OPEN;
 722
 723         while (softc->refcount != 0)
 724                 cam_periph_sleep(periph, &softc->refcount, PRIBIO, "adaclose", 1);
 725         cam_periph_unlock(periph);
 726         cam_periph_release(periph);
 727         return (0);
 728 }
 729
 730 static void
 731 adaschedule(struct cam_periph *periph)
 732 {
 733         struct ada_softc *softc = (struct ada_softc *)periph->softc;
 734
 735         if (softc->state != ADA_STATE_NORMAL)
 736                 return;
 737
 738         /* Check if we have more work to do. */
 739         if (bioq_first(&softc->bio_queue) ||
 740             (!softc->trim_running && bioq_first(&softc->trim_queue))) {
 741                 xpt_schedule(periph, CAM_PRIORITY_NORMAL);
 742         }
 743 }
 744
 745 /*
 746  * Actually translate the requested transfer into one the physical driver
 747  * can understand.  The transfer is described by a buf and will include
 748  * only one physical transfer.
 749  */
 750 static void
 751 adastrategy(struct bio *bp)
 752 {
 753         struct cam_periph *periph;
 754         struct ada_softc *softc;
 755
 756         periph = (struct cam_periph *)bp->bio_disk->d_drv1;
 757         softc = (struct ada_softc *)periph->softc;
 758
 759         cam_periph_lock(periph);
 760
 761         CAM_DEBUG(periph->path, CAM_DEBUG_TRACE, ("adastrategy(%p)\n", bp));
 762
 763         /*
 764          * If the device has been made invalid, error out
 765          */
 766         if ((periph->flags & CAM_PERIPH_INVALID) != 0) {
 767                 cam_periph_unlock(periph);
 768                 biofinish(bp, NULL, ENXIO);
 769                 return;
 770         }
 771
 772         /*
 773          * Place it in the queue of disk activities for this disk
 774          */
 775         if (bp->bio_cmd == BIO_DELETE) {
 776                 bioq_disksort(&softc->trim_queue, bp);
 777         } else {
 778                 if (ADA_SIO)
 779                     bioq_disksort(&softc->bio_queue, bp);
 780                 else
 781                     bioq_insert_tail(&softc->bio_queue, bp);
 782         }
 783
 784         /*
 785          * Schedule ourselves for performing the work.
 786          */
 787         adaschedule(periph);
 788         cam_periph_unlock(periph);
 789
 790         return;
 791 }
 792
 793 static int
 794 adadump(void *arg, void *virtual, vm_offset_t physical, off_t offset, size_t length)
 795 {
 796         struct      cam_periph *periph;
 797         struct      ada_softc *softc;
 798         u_int       secsize;
 799         union       ccb ccb;
 800         struct      disk *dp;
 801         uint64_t    lba;
 802         uint16_t    count;
 803         int         error = 0;
 804
 805         dp = arg;
 806         periph = dp->d_drv1;
 807         softc = (struct ada_softc *)periph->softc;
 808         cam_periph_lock(periph);
 809         secsize = softc->params.secsize;
 810         lba = offset / secsize;
 811         count = length / secsize;
 812
 813         if ((periph->flags & CAM_PERIPH_INVALID) != 0) {
 814                 cam_periph_unlock(periph);
 815                 return (ENXIO);
 816         }
 817
 818         if (length > 0) {
 819                 xpt_setup_ccb(&ccb.ccb_h, periph->path, CAM_PRIORITY_NORMAL);
 820                 ccb.ccb_h.ccb_state = ADA_CCB_DUMP;
 821                 cam_fill_ataio(&ccb.ataio,
 822                     0,
 823                     adadone,
 824                     CAM_DIR_OUT,
 825                     0,
 826                     (u_int8_t *) virtual,
 827                     length,
 828                     ada_default_timeout*1000);
 829                 if ((softc->flags & ADA_FLAG_CAN_48BIT) &&
 830                     (lba + count >= ATA_MAX_28BIT_LBA ||
 831                     count >= 256)) {
 832                         ata_48bit_cmd(&ccb.ataio, ATA_WRITE_DMA48,
 833                             0, lba, count);
 834                 } else {
 835                         ata_28bit_cmd(&ccb.ataio, ATA_WRITE_DMA,
 836                             0, lba, count);
 837                 }
 838                 xpt_polled_action(&ccb);
 839
 840                 error = cam_periph_error(&ccb,
 841                     0, SF_NO_RECOVERY | SF_NO_RETRY, NULL);
 842                 if ((ccb.ccb_h.status & CAM_DEV_QFRZN) != 0)
 843                         cam_release_devq(ccb.ccb_h.path, /*relsim_flags*/0,
 844                             /*reduction*/0, /*timeout*/0, /*getcount_only*/0);
 845                 if (error != 0)
 846                         printf("Aborting dump due to I/O error.\n");
 847
 848                 cam_periph_unlock(periph);
 849                 return (error);
 850         }
 851
 852         if (softc->flags & ADA_FLAG_CAN_FLUSHCACHE) {
 853                 xpt_setup_ccb(&ccb.ccb_h, periph->path, CAM_PRIORITY_NORMAL);
 854
 855                 ccb.ccb_h.ccb_state = ADA_CCB_DUMP;
 856                 cam_fill_ataio(&ccb.ataio,
 857                                     0,
 858                                     adadone,
 859                                     CAM_DIR_NONE,
 860                                     0,
 861                                     NULL,
 862                                     0,
 863                                     ada_default_timeout*1000);
 864
 865                 if (softc->flags & ADA_FLAG_CAN_48BIT)
 866                         ata_48bit_cmd(&ccb.ataio, ATA_FLUSHCACHE48, 0, 0, 0);
 867                 else
 868                         ata_28bit_cmd(&ccb.ataio, ATA_FLUSHCACHE, 0, 0, 0);
 869                 xpt_polled_action(&ccb);
 870
 871                 error = cam_periph_error(&ccb,
 872                     0, SF_NO_RECOVERY | SF_NO_RETRY, NULL);
 873                 if ((ccb.ccb_h.status & CAM_DEV_QFRZN) != 0)
 874                         cam_release_devq(ccb.ccb_h.path, /*relsim_flags*/0,
 875                             /*reduction*/0, /*timeout*/0, /*getcount_only*/0);
 876                 if (error != 0)
 877                         xpt_print(periph->path, "Synchronize cache failed\n");
 878         }
 879         cam_periph_unlock(periph);
 880         return (error);
 881 }
 882
 883 static void
 884 adainit(void)
 885 {
 886         cam_status status;
 887
 888         /*
 889          * Install a global async callback.  This callback will
 890          * receive async callbacks like "new device found".
 891          */
 892         status = xpt_register_async(AC_FOUND_DEVICE, adaasync, NULL, NULL);
 893
 894         if (status != CAM_REQ_CMP) {
 895                 printf("ada: Failed to attach master async callback "
 896                        "due to status 0x%x!\n", status);
 897         } else if (ada_send_ordered) {
 898
 899                 /* Register our event handlers */
 900                 if ((EVENTHANDLER_REGISTER(power_suspend, adasuspend,
 901                                            NULL, EVENTHANDLER_PRI_LAST)) == NULL)
 902                     printf("adainit: power event registration failed!\n");
 903                 if ((EVENTHANDLER_REGISTER(power_resume, adaresume,
 904                                            NULL, EVENTHANDLER_PRI_LAST)) == NULL)
 905                     printf("adainit: power event registration failed!\n");
 906                 if ((EVENTHANDLER_REGISTER(shutdown_post_sync, adashutdown,
 907                                            NULL, SHUTDOWN_PRI_DEFAULT)) == NULL)
 908                     printf("adainit: shutdown event registration failed!\n");
 909         }
 910 }
 911
 912 /*
 913  * Callback from GEOM, called when it has finished cleaning up its
 914  * resources.
 915  */
 916 static void
 917 adadiskgonecb(struct disk *dp)
 918 {
 919         struct cam_periph *periph;
 920
 921         periph = (struct cam_periph *)dp->d_drv1;
 922
 923         cam_periph_release(periph);
 924 }
 925
 926 static void
 927 adaoninvalidate(struct cam_periph *periph)
 928 {
 929         struct ada_softc *softc;
 930
 931         softc = (struct ada_softc *)periph->softc;
 932
 933         /*
 934          * De-register any async callbacks.
 935          */
 936         xpt_register_async(0, adaasync, periph, periph->path);
 937
 938         /*
 939          * Return all queued I/O with ENXIO.
 940          * XXX Handle any transactions queued to the card
 941          *     with XPT_ABORT_CCB.
 942          */
 943         bioq_flush(&softc->bio_queue, NULL, ENXIO);
 944         bioq_flush(&softc->trim_queue, NULL, ENXIO);
 945
 946         disk_gone(softc->disk);
 947 }
 948
 949 static void
 950 adacleanup(struct cam_periph *periph)
 951 {
 952         struct ada_softc *softc;
 953
 954         softc = (struct ada_softc *)periph->softc;
 955
 956         cam_periph_unlock(periph);
 957
 958         /*
 959          * If we can't free the sysctl tree, oh well...
 960          */
 961         if ((softc->flags & ADA_FLAG_SCTX_INIT) != 0
 962             && sysctl_ctx_free(&softc->sysctl_ctx) != 0) {
 963                 xpt_print(periph->path, "can't remove sysctl context\n");
 964         }
 965
 966         disk_destroy(softc->disk);
 967         callout_drain(&softc->sendordered_c);
 968         free(softc, M_DEVBUF);
 969         cam_periph_lock(periph);
 970 }
 971
 972 static void
 973 adaasync(void *callback_arg, u_int32_t code,
 974         struct cam_path *path, void *arg)
 975 {
 976         struct ccb_getdev cgd;
 977         struct cam_periph *periph;
 978         struct ada_softc *softc;
 979
 980         periph = (struct cam_periph *)callback_arg;
 981         switch (code) {
 982         case AC_FOUND_DEVICE:
 983         {
 984                 struct ccb_getdev *cgd;
 985                 cam_status status;
 986
 987                 cgd = (struct ccb_getdev *)arg;
 988                 if (cgd == NULL)
 989                         break;
 990
 991                 if (cgd->protocol != PROTO_ATA)
 992                         break;
 993
 994                 /*
 995                  * Allocate a peripheral instance for
 996                  * this device and start the probe
 997                  * process.
 998                  */
 999                 status = cam_periph_alloc(adaregister, adaoninvalidate,
1000                                           adacleanup, adastart,
1001                                           "ada", CAM_PERIPH_BIO,
1002                                           path, adaasync,
1003                                           AC_FOUND_DEVICE, cgd);
1004
1005                 if (status != CAM_REQ_CMP
1006                  && status != CAM_REQ_INPROG)
1007                         printf("adaasync: Unable to attach to new device "
1008                                 "due to status 0x%x\n", status);
1009                 break;
1010         }
1011         case AC_GETDEV_CHANGED:
1012         {
1013                 softc = (struct ada_softc *)periph->softc;
1014                 xpt_setup_ccb(&cgd.ccb_h, periph->path, CAM_PRIORITY_NORMAL);
1015                 cgd.ccb_h.func_code = XPT_GDEV_TYPE;
1016                 xpt_action((union ccb *)&cgd);
1017
1018                 if ((cgd.ident_data.capabilities1 & ATA_SUPPORT_DMA) &&
1019                     (cgd.inq_flags & SID_DMA))
1020                         softc->flags |= ADA_FLAG_CAN_DMA;
1021                 else
1022                         softc->flags &= ~ADA_FLAG_CAN_DMA;
1023                 if (cgd.ident_data.support.command2 & ATA_SUPPORT_ADDRESS48) {
1024                         softc->flags |= ADA_FLAG_CAN_48BIT;
1025                         if (cgd.inq_flags & SID_DMA48)
1026                                 softc->flags |= ADA_FLAG_CAN_DMA48;
1027                         else
1028                                 softc->flags &= ~ADA_FLAG_CAN_DMA48;
1029                 } else
1030                         softc->flags &= ~(ADA_FLAG_CAN_48BIT |
1031                             ADA_FLAG_CAN_DMA48);
1032                 if ((cgd.ident_data.satacapabilities & ATA_SUPPORT_NCQ) &&
1033                     (cgd.inq_flags & SID_DMA) && (cgd.inq_flags & SID_CmdQue))
1034                         softc->flags |= ADA_FLAG_CAN_NCQ;
1035                 else
1036                         softc->flags &= ~ADA_FLAG_CAN_NCQ;
1037                 if ((cgd.ident_data.support_dsm & ATA_SUPPORT_DSM_TRIM) &&
1038                     (cgd.inq_flags & SID_DMA))
1039                         softc->flags |= ADA_FLAG_CAN_TRIM;
1040                 else
1041                         softc->flags &= ~ADA_FLAG_CAN_TRIM;
1042
1043                 cam_periph_async(periph, code, path, arg);
1044                 break;
1045         }
1046         case AC_ADVINFO_CHANGED:
1047         {
1048                 uintptr_t buftype;
1049
1050                 buftype = (uintptr_t)arg;
1051                 if (buftype == CDAI_TYPE_PHYS_PATH) {
1052                         struct ada_softc *softc;
1053
1054                         softc = periph->softc;
1055                         disk_attr_changed(softc->disk, "GEOM::physpath",
1056                                           M_NOWAIT);
1057                 }
1058                 break;
1059         }
1060         case AC_SENT_BDR:
1061         case AC_BUS_RESET:
1062         {
1063                 softc = (struct ada_softc *)periph->softc;
1064                 cam_periph_async(periph, code, path, arg);
1065                 if (softc->state != ADA_STATE_NORMAL)
1066                         break;
1067                 xpt_setup_ccb(&cgd.ccb_h, periph->path, CAM_PRIORITY_NORMAL);
1068                 cgd.ccb_h.func_code = XPT_GDEV_TYPE;
1069                 xpt_action((union ccb *)&cgd);
1070                 if (ADA_RA >= 0 &&
1071                     cgd.ident_data.support.command1 & ATA_SUPPORT_LOOKAHEAD)
1072                         softc->state = ADA_STATE_RAHEAD;
1073                 else if (ADA_WC >= 0 &&
1074                     cgd.ident_data.support.command1 & ATA_SUPPORT_WRITECACHE)
1075                         softc->state = ADA_STATE_WCACHE;
1076                 else
1077                     break;
1078                 if (cam_periph_acquire(periph) != CAM_REQ_CMP)
1079                         softc->state = ADA_STATE_NORMAL;
1080                 else
1081                         xpt_schedule(periph, CAM_PRIORITY_DEV);
1082         }
1083         default:
1084                 cam_periph_async(periph, code, path, arg);
1085                 break;
1086         }
1087 }
1088
1089 static void
1090 adasysctlinit(void *context, int pending)
1091 {
1092         struct cam_periph *periph;
1093         struct ada_softc *softc;
1094         char tmpstr[80], tmpstr2[80];
1095
1096         periph = (struct cam_periph *)context;
1097
1098         /* periph was held for us when this task was enqueued */
1099         if ((periph->flags & CAM_PERIPH_INVALID) != 0) {
1100                 cam_periph_release(periph);
1101                 return;
1102         }
1103
1104         softc = (struct ada_softc *)periph->softc;
1105         snprintf(tmpstr, sizeof(tmpstr), "CAM ADA unit %d", periph->unit_number);
1106         snprintf(tmpstr2, sizeof(tmpstr2), "%d", periph->unit_number);
1107
1108         sysctl_ctx_init(&softc->sysctl_ctx);
1109         softc->flags |= ADA_FLAG_SCTX_INIT;
1110         softc->sysctl_tree = SYSCTL_ADD_NODE(&softc->sysctl_ctx,
1111                 SYSCTL_STATIC_CHILDREN(_kern_cam_ada), OID_AUTO, tmpstr2,
1112                 CTLFLAG_RD, 0, tmpstr);
1113         if (softc->sysctl_tree == NULL) {
1114                 printf("adasysctlinit: unable to allocate sysctl tree\n");
1115                 cam_periph_release(periph);
1116                 return;
1117         }
1118
1119         SYSCTL_ADD_INT(&softc->sysctl_ctx, SYSCTL_CHILDREN(softc->sysctl_tree),
1120                 OID_AUTO, "read_ahead", CTLFLAG_RW | CTLFLAG_MPSAFE,
1121                 &softc->read_ahead, 0, "Enable disk read ahead.");
1122         SYSCTL_ADD_INT(&softc->sysctl_ctx, SYSCTL_CHILDREN(softc->sysctl_tree),
1123                 OID_AUTO, "write_cache", CTLFLAG_RW | CTLFLAG_MPSAFE,
1124                 &softc->write_cache, 0, "Enable disk write cache.");
1125         SYSCTL_ADD_INT(&softc->sysctl_ctx, SYSCTL_CHILDREN(softc->sysctl_tree),
1126                 OID_AUTO, "sort_io_queue", CTLFLAG_RW | CTLFLAG_MPSAFE,
1127                 &softc->sort_io_queue, 0,
1128                 "Sort IO queue to try and optimise disk access patterns");
1129 #ifdef ADA_TEST_FAILURE
1130         /*
1131          * Add a 'door bell' sysctl which allows one to set it from userland
1132          * and cause something bad to happen.  For the moment, we only allow
1133          * whacking the next read or write.
1134          */
1135         SYSCTL_ADD_INT(&softc->sysctl_ctx, SYSCTL_CHILDREN(softc->sysctl_tree),
1136                 OID_AUTO, "force_read_error", CTLFLAG_RW | CTLFLAG_MPSAFE,
1137                 &softc->force_read_error, 0,
1138                 "Force a read error for the next N reads.");
1139         SYSCTL_ADD_INT(&softc->sysctl_ctx, SYSCTL_CHILDREN(softc->sysctl_tree),
1140                 OID_AUTO, "force_write_error", CTLFLAG_RW | CTLFLAG_MPSAFE,
1141                 &softc->force_write_error, 0,
1142                 "Force a write error for the next N writes.");
1143         SYSCTL_ADD_INT(&softc->sysctl_ctx, SYSCTL_CHILDREN(softc->sysctl_tree),
1144                 OID_AUTO, "periodic_read_error", CTLFLAG_RW | CTLFLAG_MPSAFE,
1145                 &softc->periodic_read_error, 0,
1146                 "Force a read error every N reads (don't set too low).");
1147 #endif
1148         cam_periph_release(periph);
1149 }
1150
1151 static int
1152 adagetattr(struct bio *bp)
1153 {
1154         int ret;
1155         struct cam_periph *periph;
1156
1157         periph = (struct cam_periph *)bp->bio_disk->d_drv1;
1158         cam_periph_lock(periph);
1159         ret = xpt_getattr(bp->bio_data, bp->bio_length, bp->bio_attribute,
1160             periph->path);
1161         cam_periph_unlock(periph);
1162         if (ret == 0)
1163                 bp->bio_completed = bp->bio_length;
1164         return ret;
1165 }
1166
1167 static cam_status
1168 adaregister(struct cam_periph *periph, void *arg)
1169 {
1170         struct ada_softc *softc;
1171         struct ccb_pathinq cpi;
1172         struct ccb_getdev *cgd;
1173         char   announce_buf[80], buf1[32];
1174         struct disk_params *dp;
1175         caddr_t match;
1176         u_int maxio;
1177         int legacy_id, quirks;
1178
1179         cgd = (struct ccb_getdev *)arg;
1180         if (cgd == NULL) {
1181                 printf("adaregister: no getdev CCB, can't register device\n");
1182                 return(CAM_REQ_CMP_ERR);
1183         }
1184
1185         softc = (struct ada_softc *)malloc(sizeof(*softc), M_DEVBUF,
1186             M_NOWAIT|M_ZERO);
1187
1188         if (softc == NULL) {
1189                 printf("adaregister: Unable to probe new device. "
1190                     "Unable to allocate softc\n");
1191                 return(CAM_REQ_CMP_ERR);
1192         }
1193
1194         bioq_init(&softc->bio_queue);
1195         bioq_init(&softc->trim_queue);
1196
1197         if ((cgd->ident_data.capabilities1 & ATA_SUPPORT_DMA) &&
1198             (cgd->inq_flags & SID_DMA))
1199                 softc->flags |= ADA_FLAG_CAN_DMA;
1200         if (cgd->ident_data.support.command2 & ATA_SUPPORT_ADDRESS48) {
1201                 softc->flags |= ADA_FLAG_CAN_48BIT;
1202                 if (cgd->inq_flags & SID_DMA48)
1203                         softc->flags |= ADA_FLAG_CAN_DMA48;
1204         }
1205         if (cgd->ident_data.support.command2 & ATA_SUPPORT_FLUSHCACHE)
1206                 softc->flags |= ADA_FLAG_CAN_FLUSHCACHE;
1207         if (cgd->ident_data.support.command1 & ATA_SUPPORT_POWERMGT)
1208                 softc->flags |= ADA_FLAG_CAN_POWERMGT;
1209         if ((cgd->ident_data.satacapabilities & ATA_SUPPORT_NCQ) &&
1210             (cgd->inq_flags & SID_DMA) && (cgd->inq_flags & SID_CmdQue))
1211                 softc->flags |= ADA_FLAG_CAN_NCQ;
1212         if ((cgd->ident_data.support_dsm & ATA_SUPPORT_DSM_TRIM) &&
1213             (cgd->inq_flags & SID_DMA)) {
1214                 softc->flags |= ADA_FLAG_CAN_TRIM;
1215                 softc->trim_max_ranges = TRIM_MAX_RANGES;
1216                 if (cgd->ident_data.max_dsm_blocks != 0) {
1217                         softc->trim_max_ranges =
1218                             min(cgd->ident_data.max_dsm_blocks *
1219                                 ATA_DSM_BLK_RANGES, softc->trim_max_ranges);
1220                 }
1221         }
1222         if (cgd->ident_data.support.command2 & ATA_SUPPORT_CFA)
1223                 softc->flags |= ADA_FLAG_CAN_CFA;
1224
1225         periph->softc = softc;
1226
1227         /*
1228          * See if this device has any quirks.
1229          */
1230         match = cam_quirkmatch((caddr_t)&cgd->ident_data,
1231                                (caddr_t)ada_quirk_table,
1232                                sizeof(ada_quirk_table)/sizeof(*ada_quirk_table),
1233                                sizeof(*ada_quirk_table), ata_identify_match);
1234         if (match != NULL)
1235                 softc->quirks = ((struct ada_quirk_entry *)match)->quirks;
1236         else
1237                 softc->quirks = ADA_Q_NONE;
1238
1239         bzero(&cpi, sizeof(cpi));
1240         xpt_setup_ccb(&cpi.ccb_h, periph->path, CAM_PRIORITY_NONE);
1241         cpi.ccb_h.func_code = XPT_PATH_INQ;
1242         xpt_action((union ccb *)&cpi);
1243
1244         TASK_INIT(&softc->sysctl_task, 0, adasysctlinit, periph);
1245
1246         /*
1247          * Register this media as a disk
1248          */
1249         (void)cam_periph_hold(periph, PRIBIO);
1250         cam_periph_unlock(periph);
1251         snprintf(announce_buf, sizeof(announce_buf),
1252             "kern.cam.ada.%d.quirks", periph->unit_number);
1253         quirks = softc->quirks;
1254         TUNABLE_INT_FETCH(announce_buf, &quirks);
1255         softc->quirks = quirks;
1256         softc->read_ahead = -1;
1257         snprintf(announce_buf, sizeof(announce_buf),
1258             "kern.cam.ada.%d.read_ahead", periph->unit_number);
1259         TUNABLE_INT_FETCH(announce_buf, &softc->read_ahead);
1260         softc->write_cache = -1;
1261         snprintf(announce_buf, sizeof(announce_buf),
1262             "kern.cam.ada.%d.write_cache", periph->unit_number);
1263         TUNABLE_INT_FETCH(announce_buf, &softc->write_cache);
1264         /* Disable queue sorting for non-rotational media by default. */
1265         if (cgd->ident_data.media_rotation_rate == ATA_RATE_NON_ROTATING)
1266                 softc->sort_io_queue = 0;
1267         else
1268                 softc->sort_io_queue = -1;
1269         adagetparams(periph, cgd);
1270         softc->disk = disk_alloc();
1271         softc->disk->d_rotation_rate = cgd->ident_data.media_rotation_rate;
1272         softc->disk->d_devstat = devstat_new_entry(periph->periph_name,
1273                           periph->unit_number, softc->params.secsize,
1274                           DEVSTAT_ALL_SUPPORTED,
1275                           DEVSTAT_TYPE_DIRECT |
1276                           XPORT_DEVSTAT_TYPE(cpi.transport),
1277                           DEVSTAT_PRIORITY_DISK);
1278         softc->disk->d_open = adaopen;
1279         softc->disk->d_close = adaclose;
1280         softc->disk->d_strategy = adastrategy;
1281         softc->disk->d_getattr = adagetattr;
1282         softc->disk->d_dump = adadump;
1283         softc->disk->d_gone = adadiskgonecb;
1284         softc->disk->d_name = "ada";
1285         softc->disk->d_drv1 = periph;
1286         maxio = cpi.maxio;              /* Honor max I/O size of SIM */
1287         if (maxio == 0)
1288                 maxio = DFLTPHYS;       /* traditional default */
1289         else if (maxio > MAXPHYS)
1290                 maxio = MAXPHYS;        /* for safety */
1291         if (softc->flags & ADA_FLAG_CAN_48BIT)
1292                 maxio = min(maxio, 65536 * softc->params.secsize);
1293         else                                    /* 28bit ATA command limit */
1294                 maxio = min(maxio, 256 * softc->params.secsize);
1295         softc->disk->d_maxsize = maxio;
1296         softc->disk->d_unit = periph->unit_number;
1297         softc->disk->d_flags = DISKFLAG_DIRECT_COMPLETION;
1298         if (softc->flags & ADA_FLAG_CAN_FLUSHCACHE)
1299                 softc->disk->d_flags |= DISKFLAG_CANFLUSHCACHE;
1300         if (softc->flags & ADA_FLAG_CAN_TRIM) {
1301                 softc->disk->d_flags |= DISKFLAG_CANDELETE;
1302                 softc->disk->d_delmaxsize = softc->params.secsize *
1303                                             ATA_DSM_RANGE_MAX *
1304                                             softc->trim_max_ranges;
1305         } else if ((softc->flags & ADA_FLAG_CAN_CFA) &&
1306             !(softc->flags & ADA_FLAG_CAN_48BIT)) {
1307                 softc->disk->d_flags |= DISKFLAG_CANDELETE;
1308                 softc->disk->d_delmaxsize = 256 * softc->params.secsize;
1309         } else
1310                 softc->disk->d_delmaxsize = maxio;
1311         if ((cpi.hba_misc & PIM_UNMAPPED) != 0)
1312                 softc->disk->d_flags |= DISKFLAG_UNMAPPED_BIO;
1313         strlcpy(softc->disk->d_descr, cgd->ident_data.model,
1314             MIN(sizeof(softc->disk->d_descr), sizeof(cgd->ident_data.model)));
1315         strlcpy(softc->disk->d_ident, cgd->ident_data.serial,
1316             MIN(sizeof(softc->disk->d_ident), sizeof(cgd->ident_data.serial)));
1317         softc->disk->d_hba_vendor = cpi.hba_vendor;
1318         softc->disk->d_hba_device = cpi.hba_device;
1319         softc->disk->d_hba_subvendor = cpi.hba_subvendor;
1320         softc->disk->d_hba_subdevice = cpi.hba_subdevice;
1321
1322         softc->disk->d_sectorsize = softc->params.secsize;
1323         softc->disk->d_mediasize = (off_t)softc->params.sectors *
1324             softc->params.secsize;
1325         if (ata_physical_sector_size(&cgd->ident_data) !=
1326             softc->params.secsize) {
1327                 softc->disk->d_stripesize =
1328                     ata_physical_sector_size(&cgd->ident_data);
1329                 softc->disk->d_stripeoffset = (softc->disk->d_stripesize -
1330                     ata_logical_sector_offset(&cgd->ident_data)) %
1331                     softc->disk->d_stripesize;
1332         } else if (softc->quirks & ADA_Q_4K) {
1333                 softc->disk->d_stripesize = 4096;
1334                 softc->disk->d_stripeoffset = 0;
1335         }
1336         softc->disk->d_fwsectors = softc->params.secs_per_track;
1337         softc->disk->d_fwheads = softc->params.heads;
1338         ata_disk_firmware_geom_adjust(softc->disk);
1339
1340         if (ada_legacy_aliases) {
1341 #ifdef ATA_STATIC_ID
1342                 legacy_id = xpt_path_legacy_ata_id(periph->path);
1343 #else
1344                 legacy_id = softc->disk->d_unit;
1345 #endif
1346                 if (legacy_id >= 0) {
1347                         snprintf(announce_buf, sizeof(announce_buf),
1348                             "kern.devalias.%s%d",
1349                             softc->disk->d_name, softc->disk->d_unit);
1350                         snprintf(buf1, sizeof(buf1),
1351                             "ad%d", legacy_id);
1352                         setenv(announce_buf, buf1);
1353                 }
1354         } else
1355                 legacy_id = -1;
1356         /*
1357          * Acquire a reference to the periph before we register with GEOM.
1358          * We'll release this reference once GEOM calls us back (via
1359          * adadiskgonecb()) telling us that our provider has been freed.
1360          */
1361         if (cam_periph_acquire(periph) != CAM_REQ_CMP) {
1362                 xpt_print(periph->path, "%s: lost periph during "
1363                           "registration!\n", __func__);
1364                 cam_periph_lock(periph);
1365                 return (CAM_REQ_CMP_ERR);
1366         }
1367         disk_create(softc->disk, DISK_VERSION);
1368         cam_periph_lock(periph);
1369         cam_periph_unhold(periph);
1370
1371         dp = &softc->params;
1372         snprintf(announce_buf, sizeof(announce_buf),
1373             "%juMB (%ju %u byte sectors)",
1374             ((uintmax_t)dp->secsize * dp->sectors) / (1024 * 1024),
1375             (uintmax_t)dp->sectors, dp->secsize);
1376         xpt_announce_periph(periph, announce_buf);
1377         xpt_announce_quirks(periph, softc->quirks, ADA_Q_BIT_STRING);
1378         if (legacy_id >= 0)
1379                 printf("%s%d: Previously was known as ad%d\n",
1380                        periph->periph_name, periph->unit_number, legacy_id);
1381
1382         /*
1383          * Create our sysctl variables, now that we know
1384          * we have successfully attached.
1385          */
1386         if (cam_periph_acquire(periph) == CAM_REQ_CMP)
1387                 taskqueue_enqueue(taskqueue_thread, &softc->sysctl_task);
1388
1389         /*
1390          * Add async callbacks for bus reset and
1391          * bus device reset calls.  I don't bother
1392          * checking if this fails as, in most cases,
1393          * the system will function just fine without
1394          * them and the only alternative would be to
1395          * not attach the device on failure.
1396          */
1397         xpt_register_async(AC_SENT_BDR | AC_BUS_RESET | AC_LOST_DEVICE |
1398             AC_GETDEV_CHANGED | AC_ADVINFO_CHANGED,
1399             adaasync, periph, periph->path);
1400
1401         /*
1402          * Schedule a periodic event to occasionally send an
1403          * ordered tag to a device.
1404          */
1405         callout_init_mtx(&softc->sendordered_c, cam_periph_mtx(periph), 0);
1406         callout_reset(&softc->sendordered_c,
1407             (ada_default_timeout * hz) / ADA_ORDEREDTAG_INTERVAL,
1408             adasendorderedtag, softc);
1409
1410         if (ADA_RA >= 0 &&
1411             cgd->ident_data.support.command1 & ATA_SUPPORT_LOOKAHEAD) {
1412                 softc->state = ADA_STATE_RAHEAD;
1413         } else if (ADA_WC >= 0 &&
1414             cgd->ident_data.support.command1 & ATA_SUPPORT_WRITECACHE) {
1415                 softc->state = ADA_STATE_WCACHE;
1416         } else {
1417                 softc->state = ADA_STATE_NORMAL;
1418                 return(CAM_REQ_CMP);
1419         }
1420         if (cam_periph_acquire(periph) != CAM_REQ_CMP)
1421                 softc->state = ADA_STATE_NORMAL;
1422         else
1423                 xpt_schedule(periph, CAM_PRIORITY_DEV);
1424         return(CAM_REQ_CMP);
1425 }
1426
1427 static void
1428 ada_dsmtrim(struct ada_softc *softc, struct bio *bp, struct ccb_ataio *ataio)
1429 {
1430         struct trim_request *req = &softc->trim_req;
1431         uint64_t lastlba = (uint64_t)-1;
1432         int c, lastcount = 0, off, ranges = 0;
1433
1434         bzero(req, sizeof(*req));
1435         TAILQ_INIT(&req->bps);
1436         do {
1437                 uint64_t lba = bp->bio_pblkno;
1438                 int count = bp->bio_bcount / softc->params.secsize;
1439
1440                 bioq_remove(&softc->trim_queue, bp);
1441
1442                 /* Try to extend the previous range. */
1443                 if (lba == lastlba) {
1444                         c = min(count, ATA_DSM_RANGE_MAX - lastcount);
1445                         lastcount += c;
1446                         off = (ranges - 1) * ATA_DSM_RANGE_SIZE;
1447                         req->data[off + 6] = lastcount & 0xff;
1448                         req->data[off + 7] =
1449                                 (lastcount >> 8) & 0xff;
1450                         count -= c;
1451                         lba += c;
1452                 }
1453
1454                 while (count > 0) {
1455                         c = min(count, ATA_DSM_RANGE_MAX);
1456                         off = ranges * ATA_DSM_RANGE_SIZE;
1457                         req->data[off + 0] = lba & 0xff;
1458                         req->data[off + 1] = (lba >> 8) & 0xff;
1459                         req->data[off + 2] = (lba >> 16) & 0xff;
1460                         req->data[off + 3] = (lba >> 24) & 0xff;
1461                         req->data[off + 4] = (lba >> 32) & 0xff;
1462                         req->data[off + 5] = (lba >> 40) & 0xff;
1463                         req->data[off + 6] = c & 0xff;
1464                         req->data[off + 7] = (c >> 8) & 0xff;
1465                         lba += c;
1466                         count -= c;
1467                         lastcount = c;
1468                         ranges++;
1469                         /*
1470                          * Its the caller's responsibility to ensure the
1471                          * request will fit so we don't need to check for
1472                          * overrun here
1473                          */
1474                 }
1475                 lastlba = lba;
1476                 TAILQ_INSERT_TAIL(&req->bps, bp, bio_queue);
1477                 bp = bioq_first(&softc->trim_queue);
1478                 if (bp == NULL ||
1479                     bp->bio_bcount / softc->params.secsize >
1480                     (softc->trim_max_ranges - ranges) * ATA_DSM_RANGE_MAX)
1481                         break;
1482         } while (1);
1483         cam_fill_ataio(ataio,
1484             ada_retry_count,
1485             adadone,
1486             CAM_DIR_OUT,
1487             0,
1488             req->data,
1489             ((ranges + ATA_DSM_BLK_RANGES - 1) /
1490             ATA_DSM_BLK_RANGES) * ATA_DSM_BLK_SIZE,
1491             ada_default_timeout * 1000);
1492         ata_48bit_cmd(ataio, ATA_DATA_SET_MANAGEMENT,
1493             ATA_DSM_TRIM, 0, (ranges + ATA_DSM_BLK_RANGES -
1494             1) / ATA_DSM_BLK_RANGES);
1495 }
1496
1497 static void
1498 ada_cfaerase(struct ada_softc *softc, struct bio *bp, struct ccb_ataio *ataio)
1499 {
1500         struct trim_request *req = &softc->trim_req;
1501         uint64_t lba = bp->bio_pblkno;
1502         uint16_t count = bp->bio_bcount / softc->params.secsize;
1503
1504         bzero(req, sizeof(*req));
1505         TAILQ_INIT(&req->bps);
1506         bioq_remove(&softc->trim_queue, bp);
1507         TAILQ_INSERT_TAIL(&req->bps, bp, bio_queue);
1508
1509         cam_fill_ataio(ataio,
1510             ada_retry_count,
1511             adadone,
1512             CAM_DIR_NONE,
1513             0,
1514             NULL,
1515             0,
1516             ada_default_timeout*1000);
1517
1518         if (count >= 256)
1519                 count = 0;
1520         ata_28bit_cmd(ataio, ATA_CFA_ERASE, 0, lba, count);
1521 }
1522
1523 static void
1524 adastart(struct cam_periph *periph, union ccb *start_ccb)
1525 {
1526         struct ada_softc *softc = (struct ada_softc *)periph->softc;
1527         struct ccb_ataio *ataio = &start_ccb->ataio;
1528
1529         CAM_DEBUG(periph->path, CAM_DEBUG_TRACE, ("adastart\n"));
1530
1531         switch (softc->state) {
1532         case ADA_STATE_NORMAL:
1533         {
1534                 struct bio *bp;
1535                 u_int8_t tag_code;
1536
1537                 /* Run TRIM if not running yet. */
1538                 if (!softc->trim_running &&
1539                     (bp = bioq_first(&softc->trim_queue)) != 0) {
1540                         if (softc->flags & ADA_FLAG_CAN_TRIM) {
1541                                 ada_dsmtrim(softc, bp, ataio);
1542                         } else if ((softc->flags & ADA_FLAG_CAN_CFA) &&
1543                             !(softc->flags & ADA_FLAG_CAN_48BIT)) {
1544                                 ada_cfaerase(softc, bp, ataio);
1545                         } else {
1546                                 /* This can happen if DMA was disabled. */
1547                                 bioq_remove(&softc->trim_queue, bp);
1548                                 biofinish(bp, NULL, EOPNOTSUPP);
1549                                 xpt_release_ccb(start_ccb);
1550                                 adaschedule(periph);
1551                                 return;
1552                         }
1553                         softc->trim_running = 1;
1554                         start_ccb->ccb_h.ccb_state = ADA_CCB_TRIM;
1555                         start_ccb->ccb_h.flags |= CAM_UNLOCKED;
1556                         goto out;
1557                 }
1558                 /* Run regular command. */
1559                 bp = bioq_first(&softc->bio_queue);
1560                 if (bp == NULL) {
1561                         xpt_release_ccb(start_ccb);
1562                         break;
1563                 }
1564                 bioq_remove(&softc->bio_queue, bp);
1565
1566                 if ((bp->bio_flags & BIO_ORDERED) != 0
1567                  || (softc->flags & ADA_FLAG_NEED_OTAG) != 0) {
1568                         softc->flags &= ~ADA_FLAG_NEED_OTAG;
1569                         softc->flags |= ADA_FLAG_WAS_OTAG;
1570                         tag_code = 0;
1571                 } else {
1572                         tag_code = 1;
1573                 }
1574                 switch (bp->bio_cmd) {
1575                 case BIO_WRITE:
1576                 case BIO_READ:
1577                 {
1578                         uint64_t lba = bp->bio_pblkno;
1579                         uint16_t count = bp->bio_bcount / softc->params.secsize;
1580                         void *data_ptr;
1581                         int rw_op;
1582
1583                         if (bp->bio_cmd == BIO_WRITE) {
1584                                 softc->flags |= ADA_FLAG_DIRTY;
1585                                 rw_op = CAM_DIR_OUT;
1586                         } else {
1587                                 rw_op = CAM_DIR_IN;
1588                         }
1589
1590                         data_ptr = bp->bio_data;
1591                         if ((bp->bio_flags & (BIO_UNMAPPED|BIO_VLIST)) != 0) {
1592                                 rw_op |= CAM_DATA_BIO;
1593                                 data_ptr = bp;
1594                         }
1595
1596 #ifdef ADA_TEST_FAILURE
1597                         int fail = 0;
1598
1599                         /*
1600                          * Support the failure ioctls.  If the command is a
1601                          * read, and there are pending forced read errors, or
1602                          * if a write and pending write errors, then fail this
1603                          * operation with EIO.  This is useful for testing
1604                          * purposes.  Also, support having every Nth read fail.
1605                          *
1606                          * This is a rather blunt tool.
1607                          */
1608                         if (bp->bio_cmd == BIO_READ) {
1609                                 if (softc->force_read_error) {
1610                                         softc->force_read_error--;
1611                                         fail = 1;
1612                                 }
1613                                 if (softc->periodic_read_error > 0) {
1614                                         if (++softc->periodic_read_count >=
1615                                             softc->periodic_read_error) {
1616                                                 softc->periodic_read_count = 0;
1617                                                 fail = 1;
1618                                         }
1619                                 }
1620                         } else {
1621                                 if (softc->force_write_error) {
1622                                         softc->force_write_error--;
1623                                         fail = 1;
1624                                 }
1625                         }
1626                         if (fail) {
1627                                 biofinish(bp, NULL, EIO);
1628                                 xpt_release_ccb(start_ccb);
1629                                 adaschedule(periph);
1630                                 return;
1631                         }
1632 #endif
1633                         KASSERT((bp->bio_flags & BIO_UNMAPPED) == 0 ||
1634                             round_page(bp->bio_bcount + bp->bio_ma_offset) /
1635                             PAGE_SIZE == bp->bio_ma_n,
1636                             ("Short bio %p", bp));
1637                         cam_fill_ataio(ataio,
1638                             ada_retry_count,
1639                             adadone,
1640                             rw_op,
1641                             tag_code,
1642                             data_ptr,
1643                             bp->bio_bcount,
1644                             ada_default_timeout*1000);
1645
1646                         if ((softc->flags & ADA_FLAG_CAN_NCQ) && tag_code) {
1647                                 if (bp->bio_cmd == BIO_READ) {
1648                                         ata_ncq_cmd(ataio, ATA_READ_FPDMA_QUEUED,
1649                                             lba, count);
1650                                 } else {
1651                                         ata_ncq_cmd(ataio, ATA_WRITE_FPDMA_QUEUED,
1652                                             lba, count);
1653                                 }
1654                         } else if ((softc->flags & ADA_FLAG_CAN_48BIT) &&
1655                             (lba + count >= ATA_MAX_28BIT_LBA ||
1656                             count > 256)) {
1657                                 if (softc->flags & ADA_FLAG_CAN_DMA48) {
1658                                         if (bp->bio_cmd == BIO_READ) {
1659                                                 ata_48bit_cmd(ataio, ATA_READ_DMA48,
1660                                                     0, lba, count);
1661                                         } else {
1662                                                 ata_48bit_cmd(ataio, ATA_WRITE_DMA48,
1663                                                     0, lba, count);
1664                                         }
1665                                 } else {
1666                                         if (bp->bio_cmd == BIO_READ) {
1667                                                 ata_48bit_cmd(ataio, ATA_READ_MUL48,
1668                                                     0, lba, count);
1669                                         } else {
1670                                                 ata_48bit_cmd(ataio, ATA_WRITE_MUL48,
1671                                                     0, lba, count);
1672                                         }
1673                                 }
1674                         } else {
1675                                 if (count == 256)
1676                                         count = 0;
1677                                 if (softc->flags & ADA_FLAG_CAN_DMA) {
1678                                         if (bp->bio_cmd == BIO_READ) {
1679                                                 ata_28bit_cmd(ataio, ATA_READ_DMA,
1680                                                     0, lba, count);
1681                                         } else {
1682                                                 ata_28bit_cmd(ataio, ATA_WRITE_DMA,
1683                                                     0, lba, count);
1684                                         }
1685                                 } else {
1686                                         if (bp->bio_cmd == BIO_READ) {
1687                                                 ata_28bit_cmd(ataio, ATA_READ_MUL,
1688                                                     0, lba, count);
1689                                         } else {
1690                                                 ata_28bit_cmd(ataio, ATA_WRITE_MUL,
1691                                                     0, lba, count);
1692                                         }
1693                                 }
1694                         }
1695                         break;
1696                 }
1697                 case BIO_FLUSH:
1698                         cam_fill_ataio(ataio,
1699                             1,
1700                             adadone,
1701                             CAM_DIR_NONE,
1702                             0,
1703                             NULL,
1704                             0,
1705                             ada_default_timeout*1000);
1706
1707                         if (softc->flags & ADA_FLAG_CAN_48BIT)
1708                                 ata_48bit_cmd(ataio, ATA_FLUSHCACHE48, 0, 0, 0);
1709                         else
1710                                 ata_28bit_cmd(ataio, ATA_FLUSHCACHE, 0, 0, 0);
1711                         break;
1712                 }
1713                 start_ccb->ccb_h.ccb_state = ADA_CCB_BUFFER_IO;
1714                 start_ccb->ccb_h.flags |= CAM_UNLOCKED;
1715 out:
1716                 start_ccb->ccb_h.ccb_bp = bp;
1717                 softc->outstanding_cmds++;
1718                 softc->refcount++;
1719                 cam_periph_unlock(periph);
1720                 xpt_action(start_ccb);
1721                 cam_periph_lock(periph);
1722                 softc->refcount--;
1723
1724                 /* May have more work to do, so ensure we stay scheduled */
1725                 adaschedule(periph);
1726                 break;
1727         }
1728         case ADA_STATE_RAHEAD:
1729         case ADA_STATE_WCACHE:
1730         {
1731                 cam_fill_ataio(ataio,
1732                     1,
1733                     adadone,
1734                     CAM_DIR_NONE,
1735                     0,
1736                     NULL,
1737                     0,
1738                     ada_default_timeout*1000);
1739
1740                 if (softc->state == ADA_STATE_RAHEAD) {
1741                         ata_28bit_cmd(ataio, ATA_SETFEATURES, ADA_RA ?
1742                             ATA_SF_ENAB_RCACHE : ATA_SF_DIS_RCACHE, 0, 0);
1743                         start_ccb->ccb_h.ccb_state = ADA_CCB_RAHEAD;
1744                 } else {
1745                         ata_28bit_cmd(ataio, ATA_SETFEATURES, ADA_WC ?
1746                             ATA_SF_ENAB_WCACHE : ATA_SF_DIS_WCACHE, 0, 0);
1747                         start_ccb->ccb_h.ccb_state = ADA_CCB_WCACHE;
1748                 }
1749                 start_ccb->ccb_h.flags |= CAM_DEV_QFREEZE;
1750                 xpt_action(start_ccb);
1751                 break;
1752         }
1753         }
1754 }
1755
1756 static void
1757 adadone(struct cam_periph *periph, union ccb *done_ccb)
1758 {
1759         struct ada_softc *softc;
1760         struct ccb_ataio *ataio;
1761         struct ccb_getdev *cgd;
1762         struct cam_path *path;
1763         int state;
1764
1765         softc = (struct ada_softc *)periph->softc;
1766         ataio = &done_ccb->ataio;
1767         path = done_ccb->ccb_h.path;
1768
1769         CAM_DEBUG(path, CAM_DEBUG_TRACE, ("adadone\n"));
1770
1771         state = ataio->ccb_h.ccb_state & ADA_CCB_TYPE_MASK;
1772         switch (state) {
1773         case ADA_CCB_BUFFER_IO:
1774         case ADA_CCB_TRIM:
1775         {
1776                 struct bio *bp;
1777                 int error;
1778
1779                 cam_periph_lock(periph);
1780                 if ((done_ccb->ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
1781                         error = adaerror(done_ccb, 0, 0);
1782                         if (error == ERESTART) {
1783                                 /* A retry was scheduled, so just return. */
1784                                 cam_periph_unlock(periph);
1785                                 return;
1786                         }
1787                         if ((done_ccb->ccb_h.status & CAM_DEV_QFRZN) != 0)
1788                                 cam_release_devq(path,
1789                                                  /*relsim_flags*/0,
1790                                                  /*reduction*/0,
1791                                                  /*timeout*/0,
1792                                                  /*getcount_only*/0);
1793                 } else {
1794                         if ((done_ccb->ccb_h.status & CAM_DEV_QFRZN) != 0)
1795                                 panic("REQ_CMP with QFRZN");
1796                         error = 0;
1797                 }
1798                 bp = (struct bio *)done_ccb->ccb_h.ccb_bp;
1799                 bp->bio_error = error;
1800                 if (error != 0) {
1801                         bp->bio_resid = bp->bio_bcount;
1802                         bp->bio_flags |= BIO_ERROR;
1803                 } else {
1804                         if (state == ADA_CCB_TRIM)
1805                                 bp->bio_resid = 0;
1806                         else
1807                                 bp->bio_resid = ataio->resid;
1808                         if (bp->bio_resid > 0)
1809                                 bp->bio_flags |= BIO_ERROR;
1810                 }
1811                 softc->outstanding_cmds--;
1812                 if (softc->outstanding_cmds == 0)
1813                         softc->flags |= ADA_FLAG_WAS_OTAG;
1814                 xpt_release_ccb(done_ccb);
1815                 if (state == ADA_CCB_TRIM) {
1816                         TAILQ_HEAD(, bio) queue;
1817                         struct bio *bp1;
1818
1819                         TAILQ_INIT(&queue);
1820                         TAILQ_CONCAT(&queue, &softc->trim_req.bps, bio_queue);
1821                         /*
1822                          * Normally, the xpt_release_ccb() above would make sure
1823                          * that when we have more work to do, that work would
1824                          * get kicked off. However, we specifically keep
1825                          * trim_running set to 0 before the call above to allow
1826                          * other I/O to progress when many BIO_DELETE requests
1827                          * are pushed down. We set trim_running to 0 and call
1828                          * daschedule again so that we don't stall if there are
1829                          * no other I/Os pending apart from BIO_DELETEs.
1830                          */
1831                         softc->trim_running = 0;
1832                         adaschedule(periph);
1833                         cam_periph_unlock(periph);
1834                         while ((bp1 = TAILQ_FIRST(&queue)) != NULL) {
1835                                 TAILQ_REMOVE(&queue, bp1, bio_queue);
1836                                 bp1->bio_error = error;
1837                                 if (error != 0) {
1838                                         bp1->bio_flags |= BIO_ERROR;
1839                                         bp1->bio_resid = bp1->bio_bcount;
1840                                 } else
1841                                         bp1->bio_resid = 0;
1842                                 biodone(bp1);
1843                         }
1844                 } else {
1845                         cam_periph_unlock(periph);
1846                         biodone(bp);
1847                 }
1848                 return;
1849         }
1850         case ADA_CCB_RAHEAD:
1851         {
1852                 if ((done_ccb->ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
1853                         if (adaerror(done_ccb, 0, 0) == ERESTART) {
1854 out:
1855                                 /* Drop freeze taken due to CAM_DEV_QFREEZE */
1856                                 cam_release_devq(path, 0, 0, 0, FALSE);
1857                                 return;
1858                         } else if ((done_ccb->ccb_h.status & CAM_DEV_QFRZN) != 0) {
1859                                 cam_release_devq(path,
1860                                     /*relsim_flags*/0,
1861                                     /*reduction*/0,
1862                                     /*timeout*/0,
1863                                     /*getcount_only*/0);
1864                         }
1865                 }
1866
1867                 /*
1868                  * Since our peripheral may be invalidated by an error
1869                  * above or an external event, we must release our CCB
1870                  * before releasing the reference on the peripheral.
1871                  * The peripheral will only go away once the last reference
1872                  * is removed, and we need it around for the CCB release
1873                  * operation.
1874                  */
1875                 cgd = (struct ccb_getdev *)done_ccb;
1876                 xpt_setup_ccb(&cgd->ccb_h, path, CAM_PRIORITY_NORMAL);
1877                 cgd->ccb_h.func_code = XPT_GDEV_TYPE;
1878                 xpt_action((union ccb *)cgd);
1879                 if (ADA_WC >= 0 &&
1880                     cgd->ident_data.support.command1 & ATA_SUPPORT_WRITECACHE) {
1881                         softc->state = ADA_STATE_WCACHE;
1882                         xpt_release_ccb(done_ccb);
1883                         xpt_schedule(periph, CAM_PRIORITY_DEV);
1884                         goto out;
1885                 }
1886                 softc->state = ADA_STATE_NORMAL;
1887                 xpt_release_ccb(done_ccb);
1888                 /* Drop freeze taken due to CAM_DEV_QFREEZE */
1889                 cam_release_devq(path, 0, 0, 0, FALSE);
1890                 adaschedule(periph);
1891                 cam_periph_release_locked(periph);
1892                 return;
1893         }
1894         case ADA_CCB_WCACHE:
1895         {
1896                 if ((done_ccb->ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
1897                         if (adaerror(done_ccb, 0, 0) == ERESTART) {
1898                                 goto out;
1899                         } else if ((done_ccb->ccb_h.status & CAM_DEV_QFRZN) != 0) {
1900                                 cam_release_devq(path,
1901                                     /*relsim_flags*/0,
1902                                     /*reduction*/0,
1903                                     /*timeout*/0,
1904                                     /*getcount_only*/0);
1905                         }
1906                 }
1907
1908                 softc->state = ADA_STATE_NORMAL;
1909                 /*
1910                  * Since our peripheral may be invalidated by an error
1911                  * above or an external event, we must release our CCB
1912                  * before releasing the reference on the peripheral.
1913                  * The peripheral will only go away once the last reference
1914                  * is removed, and we need it around for the CCB release
1915                  * operation.
1916                  */
1917                 xpt_release_ccb(done_ccb);
1918                 /* Drop freeze taken due to CAM_DEV_QFREEZE */
1919                 cam_release_devq(path, 0, 0, 0, FALSE);
1920                 adaschedule(periph);
1921                 cam_periph_release_locked(periph);
1922                 return;
1923         }
1924         case ADA_CCB_DUMP:
1925                 /* No-op.  We're polling */
1926                 return;
1927         default:
1928                 break;
1929         }
1930         xpt_release_ccb(done_ccb);
1931 }
1932
1933 static int
1934 adaerror(union ccb *ccb, u_int32_t cam_flags, u_int32_t sense_flags)
1935 {
1936
1937         return(cam_periph_error(ccb, cam_flags, sense_flags, NULL));
1938 }
1939
1940 static void
1941 adagetparams(struct cam_periph *periph, struct ccb_getdev *cgd)
1942 {
1943         struct ada_softc *softc = (struct ada_softc *)periph->softc;
1944         struct disk_params *dp = &softc->params;
1945         u_int64_t lbasize48;
1946         u_int32_t lbasize;
1947
1948         dp->secsize = ata_logical_sector_size(&cgd->ident_data);
1949         if ((cgd->ident_data.atavalid & ATA_FLAG_54_58) &&
1950                 cgd->ident_data.current_heads && cgd->ident_data.current_sectors) {
1951                 dp->heads = cgd->ident_data.current_heads;
1952                 dp->secs_per_track = cgd->ident_data.current_sectors;
1953                 dp->cylinders = cgd->ident_data.cylinders;
1954                 dp->sectors = (u_int32_t)cgd->ident_data.current_size_1 |
1955                           ((u_int32_t)cgd->ident_data.current_size_2 << 16);
1956         } else {
1957                 dp->heads = cgd->ident_data.heads;
1958                 dp->secs_per_track = cgd->ident_data.sectors;
1959                 dp->cylinders = cgd->ident_data.cylinders;
1960                 dp->sectors = cgd->ident_data.cylinders * dp->heads * dp->secs_per_track;
1961         }
1962         lbasize = (u_int32_t)cgd->ident_data.lba_size_1 |
1963                   ((u_int32_t)cgd->ident_data.lba_size_2 << 16);
1964
1965         /* use the 28bit LBA size if valid or bigger than the CHS mapping */
1966         if (cgd->ident_data.cylinders == 16383 || dp->sectors < lbasize)
1967                 dp->sectors = lbasize;
1968
1969         /* use the 48bit LBA size if valid */
1970         lbasize48 = ((u_int64_t)cgd->ident_data.lba_size48_1) |
1971                     ((u_int64_t)cgd->ident_data.lba_size48_2 << 16) |
1972                     ((u_int64_t)cgd->ident_data.lba_size48_3 << 32) |
1973                     ((u_int64_t)cgd->ident_data.lba_size48_4 << 48);
1974         if ((cgd->ident_data.support.command2 & ATA_SUPPORT_ADDRESS48) &&
1975             lbasize48 > ATA_MAX_28BIT_LBA)
1976                 dp->sectors = lbasize48;
1977 }
1978
1979 static void
1980 adasendorderedtag(void *arg)
1981 {
1982         struct ada_softc *softc = arg;
1983
1984         if (ada_send_ordered) {
1985                 if (softc->outstanding_cmds > 0) {
1986                         if ((softc->flags & ADA_FLAG_WAS_OTAG) == 0)
1987                                 softc->flags |= ADA_FLAG_NEED_OTAG;
1988                         softc->flags &= ~ADA_FLAG_WAS_OTAG;
1989                 }
1990         }
1991         /* Queue us up again */
1992         callout_reset(&softc->sendordered_c,
1993             (ada_default_timeout * hz) / ADA_ORDEREDTAG_INTERVAL,
1994             adasendorderedtag, softc);
1995 }
1996
1997 /*
1998  * Step through all ADA peripheral drivers, and if the device is still open,
1999  * sync the disk cache to physical media.
2000  */
2001 static void
2002 adaflush(void)
2003 {
2004         struct cam_periph *periph;
2005         struct ada_softc *softc;
2006         union ccb *ccb;
2007         int error;
2008
2009         CAM_PERIPH_FOREACH(periph, &adadriver) {
2010                 softc = (struct ada_softc *)periph->softc;
2011                 if (SCHEDULER_STOPPED()) {
2012                         /* If we paniced with the lock held, do not recurse. */
2013                         if (!cam_periph_owned(periph) &&
2014                             (softc->flags & ADA_FLAG_OPEN)) {
2015                                 adadump(softc->disk, NULL, 0, 0, 0);
2016                         }
2017                         continue;
2018                 }
2019                 cam_periph_lock(periph);
2020                 /*
2021                  * We only sync the cache if the drive is still open, and
2022                  * if the drive is capable of it..
2023                  */
2024                 if (((softc->flags & ADA_FLAG_OPEN) == 0) ||
2025                     (softc->flags & ADA_FLAG_CAN_FLUSHCACHE) == 0) {
2026                         cam_periph_unlock(periph);
2027                         continue;
2028                 }
2029
2030                 ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
2031                 cam_fill_ataio(&ccb->ataio,
2032                                     0,
2033                                     adadone,
2034                                     CAM_DIR_NONE,
2035                                     0,
2036                                     NULL,
2037                                     0,
2038                                     ada_default_timeout*1000);
2039                 if (softc->flags & ADA_FLAG_CAN_48BIT)
2040                         ata_48bit_cmd(&ccb->ataio, ATA_FLUSHCACHE48, 0, 0, 0);
2041                 else
2042                         ata_28bit_cmd(&ccb->ataio, ATA_FLUSHCACHE, 0, 0, 0);
2043
2044                 error = cam_periph_runccb(ccb, adaerror, /*cam_flags*/0,
2045                     /*sense_flags*/ SF_NO_RECOVERY | SF_NO_RETRY,
2046                     softc->disk->d_devstat);
2047                 if (error != 0)
2048                         xpt_print(periph->path, "Synchronize cache failed\n");
2049                 xpt_release_ccb(ccb);
2050                 cam_periph_unlock(periph);
2051         }
2052 }
2053
2054 static void
2055 adaspindown(uint8_t cmd, int flags)
2056 {
2057         struct cam_periph *periph;
2058         struct ada_softc *softc;
2059         union ccb *ccb;
2060         int error;
2061
2062         CAM_PERIPH_FOREACH(periph, &adadriver) {
2063                 /* If we paniced with lock held - not recurse here. */
2064                 if (cam_periph_owned(periph))
2065                         continue;
2066                 cam_periph_lock(periph);
2067                 softc = (struct ada_softc *)periph->softc;
2068                 /*
2069                  * We only spin-down the drive if it is capable of it..
2070                  */
2071                 if ((softc->flags & ADA_FLAG_CAN_POWERMGT) == 0) {
2072                         cam_periph_unlock(periph);
2073                         continue;
2074                 }
2075
2076                 if (bootverbose)
2077                         xpt_print(periph->path, "spin-down\n");
2078
2079                 ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
2080                 cam_fill_ataio(&ccb->ataio,
2081                                     0,
2082                                     adadone,
2083                                     CAM_DIR_NONE | flags,
2084                                     0,
2085                                     NULL,
2086                                     0,
2087                                     ada_default_timeout*1000);
2088                 ata_28bit_cmd(&ccb->ataio, cmd, 0, 0, 0);
2089
2090                 error = cam_periph_runccb(ccb, adaerror, /*cam_flags*/0,
2091                     /*sense_flags*/ SF_NO_RECOVERY | SF_NO_RETRY,
2092                     softc->disk->d_devstat);
2093                 if (error != 0)
2094                         xpt_print(periph->path, "Spin-down disk failed\n");
2095                 xpt_release_ccb(ccb);
2096                 cam_periph_unlock(periph);
2097         }
2098 }
2099
2100 static void
2101 adashutdown(void *arg, int howto)
2102 {
2103
2104         adaflush();
2105         if (ada_spindown_shutdown != 0 &&
2106             (howto & (RB_HALT | RB_POWEROFF)) != 0)
2107                 adaspindown(ATA_STANDBY_IMMEDIATE, 0);
2108 }
2109
2110 static void
2111 adasuspend(void *arg)
2112 {
2113
2114         adaflush();
2115         if (ada_spindown_suspend != 0)
2116                 adaspindown(ATA_SLEEP, CAM_DEV_QFREEZE);
2117 }
2118
2119 static void
2120 adaresume(void *arg)
2121 {
2122         struct cam_periph *periph;
2123         struct ada_softc *softc;
2124
2125         if (ada_spindown_suspend == 0)
2126                 return;
2127
2128         CAM_PERIPH_FOREACH(periph, &adadriver) {
2129                 cam_periph_lock(periph);
2130                 softc = (struct ada_softc *)periph->softc;
2131                 /*
2132                  * We only spin-down the drive if it is capable of it..
2133                  */
2134                 if ((softc->flags & ADA_FLAG_CAN_POWERMGT) == 0) {
2135                         cam_periph_unlock(periph);
2136                         continue;
2137                 }
2138
2139                 if (bootverbose)
2140                         xpt_print(periph->path, "resume\n");
2141
2142                 /*
2143                  * Drop freeze taken due to CAM_DEV_QFREEZE flag set on
2144                  * sleep request.
2145                  */
2146                 cam_release_devq(periph->path,
2147                          /*relsim_flags*/0,
2148                          /*openings*/0,
2149                          /*timeout*/0,
2150                          /*getcount_only*/0);
2151
2152                 cam_periph_unlock(periph);
2153         }
2154 }
2155
2156 #endif /* _KERNEL */