sys/cam/nvme/nvme_xpt.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2015 Netflix, Inc.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer,
  11  *    without modification, immediately at the beginning of the file.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  18  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  19  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  21  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  22  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  23  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  *
  27  * derived from ata_xpt.c: Copyright (c) 2009 Alexander Motin <mav@FreeBSD.org>
  28  */
  29
  30 #include <sys/cdefs.h>
  31 __FBSDID("$FreeBSD$");
  32
  33 #include <sys/param.h>
  34 #include <sys/bus.h>
  35 #include <sys/endian.h>
  36 #include <sys/systm.h>
  37 #include <sys/types.h>
  38 #include <sys/malloc.h>
  39 #include <sys/kernel.h>
  40 #include <sys/time.h>
  41 #include <sys/conf.h>
  42 #include <sys/fcntl.h>
  43 #include <sys/sbuf.h>
  44
  45 #include <sys/lock.h>
  46 #include <sys/mutex.h>
  47 #include <sys/sysctl.h>
  48
  49 #include <cam/cam.h>
  50 #include <cam/cam_ccb.h>
  51 #include <cam/cam_queue.h>
  52 #include <cam/cam_periph.h>
  53 #include <cam/cam_sim.h>
  54 #include <cam/cam_xpt.h>
  55 #include <cam/cam_xpt_sim.h>
  56 #include <cam/cam_xpt_periph.h>
  57 #include <cam/cam_xpt_internal.h>
  58 #include <cam/cam_debug.h>
  59
  60 #include <cam/scsi/scsi_all.h>
  61 #include <cam/scsi/scsi_message.h>
  62 #include <cam/nvme/nvme_all.h>
  63 #include <machine/stdarg.h>     /* for xpt_print below */
  64 #include "opt_cam.h"
  65
  66 struct nvme_quirk_entry {
  67         u_int quirks;
  68 #define CAM_QUIRK_MAXTAGS 1
  69         u_int mintags;
  70         u_int maxtags;
  71 };
  72
  73 /* Not even sure why we need this */
  74 static periph_init_t nvme_probe_periph_init;
  75
  76 static struct periph_driver nvme_probe_driver =
  77 {
  78         nvme_probe_periph_init, "nvme_probe",
  79         TAILQ_HEAD_INITIALIZER(nvme_probe_driver.units), /* generation */ 0,
  80         CAM_PERIPH_DRV_EARLY
  81 };
  82
  83 PERIPHDRIVER_DECLARE(nvme_probe, nvme_probe_driver);
  84
  85 typedef enum {
  86         NVME_PROBE_IDENTIFY_CD,
  87         NVME_PROBE_IDENTIFY_NS,
  88         NVME_PROBE_DONE,
  89         NVME_PROBE_INVALID
  90 } nvme_probe_action;
  91
  92 static char *nvme_probe_action_text[] = {
  93         "NVME_PROBE_IDENTIFY_CD",
  94         "NVME_PROBE_IDENTIFY_NS",
  95         "NVME_PROBE_DONE",
  96         "NVME_PROBE_INVALID"
  97 };
  98
  99 #define NVME_PROBE_SET_ACTION(softc, newaction) \
 100 do {                                                                    \
 101         char **text;                                                    \
 102         text = nvme_probe_action_text;                                  \
 103         CAM_DEBUG((softc)->periph->path, CAM_DEBUG_PROBE,               \
 104             ("Probe %s to %s\n", text[(softc)->action],                 \
 105             text[(newaction)]));                                        \
 106         (softc)->action = (newaction);                                  \
 107 } while(0)
 108
 109 typedef enum {
 110         NVME_PROBE_NO_ANNOUNCE  = 0x04
 111 } nvme_probe_flags;
 112
 113 typedef struct {
 114         TAILQ_HEAD(, ccb_hdr) request_ccbs;
 115         union {
 116                 struct nvme_controller_data     cd;
 117                 struct nvme_namespace_data      ns;
 118         };
 119         nvme_probe_action       action;
 120         nvme_probe_flags        flags;
 121         int             restart;
 122         struct cam_periph *periph;
 123 } nvme_probe_softc;
 124
 125 static struct nvme_quirk_entry nvme_quirk_table[] =
 126 {
 127         {
 128 //              {
 129 //                T_ANY, SIP_MEDIA_REMOVABLE|SIP_MEDIA_FIXED,
 130 //                /*vendor*/"*", /*product*/"*", /*revision*/"*"
 131 //              },
 132                 .quirks = 0, .mintags = 0, .maxtags = 0
 133         },
 134 };
 135
 136 static const int nvme_quirk_table_size =
 137         sizeof(nvme_quirk_table) / sizeof(*nvme_quirk_table);
 138
 139 static cam_status       nvme_probe_register(struct cam_periph *periph,
 140                                       void *arg);
 141 static void      nvme_probe_schedule(struct cam_periph *nvme_probe_periph);
 142 static void      nvme_probe_start(struct cam_periph *periph, union ccb *start_ccb);
 143 static void      nvme_probe_done(struct cam_periph *periph, union ccb *done_ccb);
 144 static void      nvme_probe_cleanup(struct cam_periph *periph);
 145 //static void    nvme_find_quirk(struct cam_ed *device);
 146 static void      nvme_scan_lun(struct cam_periph *periph,
 147                                struct cam_path *path, cam_flags flags,
 148                                union ccb *ccb);
 149 static struct cam_ed *
 150                  nvme_alloc_device(struct cam_eb *bus, struct cam_et *target,
 151                                    lun_id_t lun_id);
 152 static void      nvme_device_transport(struct cam_path *path);
 153 static void      nvme_dev_async(u_int32_t async_code,
 154                                 struct cam_eb *bus,
 155                                 struct cam_et *target,
 156                                 struct cam_ed *device,
 157                                 void *async_arg);
 158 static void      nvme_action(union ccb *start_ccb);
 159 static void      nvme_announce_periph(struct cam_periph *periph);
 160 static void      nvme_proto_announce(struct cam_ed *device);
 161 static void      nvme_proto_denounce(struct cam_ed *device);
 162 static void      nvme_proto_debug_out(union ccb *ccb);
 163
 164 static struct xpt_xport_ops nvme_xport_ops = {
 165         .alloc_device = nvme_alloc_device,
 166         .action = nvme_action,
 167         .async = nvme_dev_async,
 168         .announce = nvme_announce_periph,
 169 };
 170 #define NVME_XPT_XPORT(x, X)                    \
 171 static struct xpt_xport nvme_xport_ ## x = {    \
 172         .xport = XPORT_ ## X,                   \
 173         .name = #x,                             \
 174         .ops = &nvme_xport_ops,                 \
 175 };                                              \
 176 CAM_XPT_XPORT(nvme_xport_ ## x);
 177
 178 NVME_XPT_XPORT(nvme, NVME);
 179
 180 #undef NVME_XPT_XPORT
 181
 182 static struct xpt_proto_ops nvme_proto_ops = {
 183         .announce = nvme_proto_announce,
 184         .denounce = nvme_proto_denounce,
 185         .debug_out = nvme_proto_debug_out,
 186 };
 187 static struct xpt_proto nvme_proto = {
 188         .proto = PROTO_NVME,
 189         .name = "nvme",
 190         .ops = &nvme_proto_ops,
 191 };
 192 CAM_XPT_PROTO(nvme_proto);
 193
 194 static void
 195 nvme_probe_periph_init(void)
 196 {
 197 }
 198
 199 static cam_status
 200 nvme_probe_register(struct cam_periph *periph, void *arg)
 201 {
 202         union ccb *request_ccb; /* CCB representing the probe request */
 203         nvme_probe_softc *softc;
 204
 205         request_ccb = (union ccb *)arg;
 206         if (request_ccb == NULL) {
 207                 printf("nvme_probe_register: no probe CCB, "
 208                        "can't register device\n");
 209                 return(CAM_REQ_CMP_ERR);
 210         }
 211
 212         softc = (nvme_probe_softc *)malloc(sizeof(*softc), M_CAMXPT, M_ZERO | M_NOWAIT);
 213
 214         if (softc == NULL) {
 215                 printf("nvme_probe_register: Unable to probe new device. "
 216                        "Unable to allocate softc\n");
 217                 return(CAM_REQ_CMP_ERR);
 218         }
 219         TAILQ_INIT(&softc->request_ccbs);
 220         TAILQ_INSERT_TAIL(&softc->request_ccbs, &request_ccb->ccb_h,
 221                           periph_links.tqe);
 222         softc->flags = 0;
 223         periph->softc = softc;
 224         softc->periph = periph;
 225         softc->action = NVME_PROBE_INVALID;
 226         if (cam_periph_acquire(periph) != 0)
 227                 return (CAM_REQ_CMP_ERR);
 228
 229         CAM_DEBUG(periph->path, CAM_DEBUG_PROBE, ("Probe started\n"));
 230
 231 //      nvme_device_transport(periph->path);
 232         nvme_probe_schedule(periph);
 233
 234         return(CAM_REQ_CMP);
 235 }
 236
 237 static void
 238 nvme_probe_schedule(struct cam_periph *periph)
 239 {
 240         union ccb *ccb;
 241         nvme_probe_softc *softc;
 242
 243         softc = (nvme_probe_softc *)periph->softc;
 244         ccb = (union ccb *)TAILQ_FIRST(&softc->request_ccbs);
 245
 246         NVME_PROBE_SET_ACTION(softc, NVME_PROBE_IDENTIFY_CD);
 247
 248         if (ccb->crcn.flags & CAM_EXPECT_INQ_CHANGE)
 249                 softc->flags |= NVME_PROBE_NO_ANNOUNCE;
 250         else
 251                 softc->flags &= ~NVME_PROBE_NO_ANNOUNCE;
 252
 253         xpt_schedule(periph, CAM_PRIORITY_XPT);
 254 }
 255
 256 static void
 257 nvme_probe_start(struct cam_periph *periph, union ccb *start_ccb)
 258 {
 259         struct ccb_nvmeio *nvmeio;
 260         nvme_probe_softc *softc;
 261         struct cam_path *path;
 262         lun_id_t lun;
 263
 264         CAM_DEBUG(start_ccb->ccb_h.path, CAM_DEBUG_TRACE, ("nvme_probe_start\n"));
 265
 266         softc = (nvme_probe_softc *)periph->softc;
 267         path = start_ccb->ccb_h.path;
 268         nvmeio = &start_ccb->nvmeio;
 269         lun = xpt_path_lun_id(periph->path);
 270
 271         if (softc->restart) {
 272                 softc->restart = 0;
 273                 NVME_PROBE_SET_ACTION(softc, NVME_PROBE_IDENTIFY_CD);
 274         }
 275
 276         switch (softc->action) {
 277         case NVME_PROBE_IDENTIFY_CD:
 278                 cam_fill_nvmeadmin(nvmeio,
 279                     0,                  /* retries */
 280                     nvme_probe_done,    /* cbfcnp */
 281                     CAM_DIR_IN,         /* flags */
 282                     (uint8_t *)&softc->cd,      /* data_ptr */
 283                     sizeof(softc->cd),          /* dxfer_len */
 284                     30 * 1000); /* timeout 30s */
 285                 nvme_ns_cmd(nvmeio, NVME_OPC_IDENTIFY, 0,
 286                     1, 0, 0, 0, 0, 0);
 287                 break;
 288         case NVME_PROBE_IDENTIFY_NS:
 289                 cam_fill_nvmeadmin(nvmeio,
 290                     0,                  /* retries */
 291                     nvme_probe_done,    /* cbfcnp */
 292                     CAM_DIR_IN,         /* flags */
 293                     (uint8_t *)&softc->ns,      /* data_ptr */
 294                     sizeof(softc->ns),          /* dxfer_len */
 295                     30 * 1000); /* timeout 30s */
 296                 nvme_ns_cmd(nvmeio, NVME_OPC_IDENTIFY, lun,
 297                     0, 0, 0, 0, 0, 0);
 298                 break;
 299         default:
 300                 panic("nvme_probe_start: invalid action state 0x%x\n", softc->action);
 301         }
 302         start_ccb->ccb_h.flags |= CAM_DEV_QFREEZE;
 303         xpt_action(start_ccb);
 304 }
 305
 306 static void
 307 nvme_probe_done(struct cam_periph *periph, union ccb *done_ccb)
 308 {
 309         struct nvme_namespace_data *nvme_data;
 310         struct nvme_controller_data *nvme_cdata;
 311         nvme_probe_softc *softc;
 312         struct cam_path *path;
 313         struct scsi_vpd_device_id *did;
 314         struct scsi_vpd_id_descriptor *idd;
 315         cam_status status;
 316         u_int32_t  priority;
 317         int found = 1, e, g, len;
 318
 319         CAM_DEBUG(done_ccb->ccb_h.path, CAM_DEBUG_TRACE, ("nvme_probe_done\n"));
 320
 321         softc = (nvme_probe_softc *)periph->softc;
 322         path = done_ccb->ccb_h.path;
 323         priority = done_ccb->ccb_h.pinfo.priority;
 324
 325         if ((done_ccb->ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
 326                 if (cam_periph_error(done_ccb,
 327                         0, softc->restart ? (SF_NO_RECOVERY | SF_NO_RETRY) : 0
 328                     ) == ERESTART) {
 329 out:
 330                         /* Drop freeze taken due to CAM_DEV_QFREEZE flag set. */
 331                         cam_release_devq(path, 0, 0, 0, FALSE);
 332                         return;
 333                 }
 334                 if ((done_ccb->ccb_h.status & CAM_DEV_QFRZN) != 0) {
 335                         /* Don't wedge the queue */
 336                         xpt_release_devq(path, /*count*/1, /*run_queue*/TRUE);
 337                 }
 338                 status = done_ccb->ccb_h.status & CAM_STATUS_MASK;
 339
 340                 /*
 341                  * If we get to this point, we got an error status back
 342                  * from the inquiry and the error status doesn't require
 343                  * automatically retrying the command.  Therefore, the
 344                  * inquiry failed.  If we had inquiry information before
 345                  * for this device, but this latest inquiry command failed,
 346                  * the device has probably gone away.  If this device isn't
 347                  * already marked unconfigured, notify the peripheral
 348                  * drivers that this device is no more.
 349                  */
 350 device_fail:    if ((path->device->flags & CAM_DEV_UNCONFIGURED) == 0)
 351                         xpt_async(AC_LOST_DEVICE, path, NULL);
 352                 NVME_PROBE_SET_ACTION(softc, NVME_PROBE_INVALID);
 353                 found = 0;
 354                 goto done;
 355         }
 356         if (softc->restart)
 357                 goto done;
 358         switch (softc->action) {
 359         case NVME_PROBE_IDENTIFY_CD:
 360                 nvme_controller_data_swapbytes(&softc->cd);
 361
 362                 nvme_cdata = path->device->nvme_cdata;
 363                 if (nvme_cdata == NULL) {
 364                         nvme_cdata = malloc(sizeof(*nvme_cdata), M_CAMXPT,
 365                             M_NOWAIT);
 366                         if (nvme_cdata == NULL) {
 367                                 xpt_print(path, "Can't allocate memory");
 368                                 goto device_fail;
 369                         }
 370                 }
 371                 bcopy(&softc->cd, nvme_cdata, sizeof(*nvme_cdata));
 372                 path->device->nvme_cdata = nvme_cdata;
 373
 374                 /* Save/update serial number. */
 375                 if (path->device->serial_num != NULL) {
 376                         free(path->device->serial_num, M_CAMXPT);
 377                         path->device->serial_num = NULL;
 378                         path->device->serial_num_len = 0;
 379                 }
 380                 path->device->serial_num = (u_int8_t *)
 381                     malloc(NVME_SERIAL_NUMBER_LENGTH + 1, M_CAMXPT, M_NOWAIT);
 382                 if (path->device->serial_num != NULL) {
 383                         cam_strvis(path->device->serial_num, nvme_cdata->sn,
 384                             NVME_SERIAL_NUMBER_LENGTH, NVME_SERIAL_NUMBER_LENGTH + 1);
 385                         path->device->serial_num_len =
 386                             strlen(path->device->serial_num);
 387                 }
 388
 389 //              nvme_find_quirk(path->device);
 390                 nvme_device_transport(path);
 391                 NVME_PROBE_SET_ACTION(softc, NVME_PROBE_IDENTIFY_NS);
 392                 xpt_release_ccb(done_ccb);
 393                 xpt_schedule(periph, priority);
 394                 goto out;
 395         case NVME_PROBE_IDENTIFY_NS:
 396                 nvme_namespace_data_swapbytes(&softc->ns);
 397
 398                 /* Check that the namespace exists. */
 399                 if (softc->ns.nsze == 0)
 400                         goto device_fail;
 401
 402                 nvme_data = path->device->nvme_data;
 403                 if (nvme_data == NULL) {
 404                         nvme_data = malloc(sizeof(*nvme_data), M_CAMXPT,
 405                             M_NOWAIT);
 406                         if (nvme_data == NULL) {
 407                                 xpt_print(path, "Can't allocate memory");
 408                                 goto device_fail;
 409                         }
 410                 }
 411                 bcopy(&softc->ns, nvme_data, sizeof(*nvme_data));
 412                 path->device->nvme_data = nvme_data;
 413
 414                 /* Save/update device_id based on NGUID and/or EUI64. */
 415                 if (path->device->device_id != NULL) {
 416                         free(path->device->device_id, M_CAMXPT);
 417                         path->device->device_id = NULL;
 418                         path->device->device_id_len = 0;
 419                 }
 420                 len = 0;
 421                 for (g = 0; g < sizeof(nvme_data->nguid); g++) {
 422                         if (nvme_data->nguid[g] != 0)
 423                                 break;
 424                 }
 425                 if (g < sizeof(nvme_data->nguid))
 426                         len += sizeof(struct scsi_vpd_id_descriptor) + 16;
 427                 for (e = 0; e < sizeof(nvme_data->eui64); e++) {
 428                         if (nvme_data->eui64[e] != 0)
 429                                 break;
 430                 }
 431                 if (e < sizeof(nvme_data->eui64))
 432                         len += sizeof(struct scsi_vpd_id_descriptor) + 8;
 433                 if (len > 0) {
 434                         path->device->device_id = (u_int8_t *)
 435                             malloc(SVPD_DEVICE_ID_HDR_LEN + len,
 436                             M_CAMXPT, M_NOWAIT);
 437                 }
 438                 if (path->device->device_id != NULL) {
 439                         did = (struct scsi_vpd_device_id *)path->device->device_id;
 440                         did->device = SID_QUAL_LU_CONNECTED | T_DIRECT;
 441                         did->page_code = SVPD_DEVICE_ID;
 442                         scsi_ulto2b(len, did->length);
 443                         idd = (struct scsi_vpd_id_descriptor *)(did + 1);
 444                         if (g < sizeof(nvme_data->nguid)) {
 445                                 idd->proto_codeset = SVPD_ID_CODESET_BINARY;
 446                                 idd->id_type = SVPD_ID_ASSOC_LUN | SVPD_ID_TYPE_EUI64;
 447                                 idd->length = 16;
 448                                 bcopy(nvme_data->nguid, idd->identifier, 16);
 449                                 idd = (struct scsi_vpd_id_descriptor *)
 450                                     &idd->identifier[16];
 451                         }
 452                         if (e < sizeof(nvme_data->eui64)) {
 453                                 idd->proto_codeset = SVPD_ID_CODESET_BINARY;
 454                                 idd->id_type = SVPD_ID_ASSOC_LUN | SVPD_ID_TYPE_EUI64;
 455                                 idd->length = 8;
 456                                 bcopy(nvme_data->eui64, idd->identifier, 8);
 457                         }
 458                         path->device->device_id_len = SVPD_DEVICE_ID_HDR_LEN + len;
 459                 }
 460
 461                 if (periph->path->device->flags & CAM_DEV_UNCONFIGURED) {
 462                         path->device->flags &= ~CAM_DEV_UNCONFIGURED;
 463                         xpt_acquire_device(path->device);
 464                         done_ccb->ccb_h.func_code = XPT_GDEV_TYPE;
 465                         xpt_action(done_ccb);
 466                         xpt_async(AC_FOUND_DEVICE, path, done_ccb);
 467                 }
 468                 NVME_PROBE_SET_ACTION(softc, NVME_PROBE_DONE);
 469                 break;
 470         default:
 471                 panic("nvme_probe_done: invalid action state 0x%x\n", softc->action);
 472         }
 473 done:
 474         if (softc->restart) {
 475                 softc->restart = 0;
 476                 xpt_release_ccb(done_ccb);
 477                 nvme_probe_schedule(periph);
 478                 goto out;
 479         }
 480         xpt_release_ccb(done_ccb);
 481         CAM_DEBUG(periph->path, CAM_DEBUG_PROBE, ("Probe completed\n"));
 482         while ((done_ccb = (union ccb *)TAILQ_FIRST(&softc->request_ccbs))) {
 483                 TAILQ_REMOVE(&softc->request_ccbs,
 484                     &done_ccb->ccb_h, periph_links.tqe);
 485                 done_ccb->ccb_h.status = found ? CAM_REQ_CMP : CAM_REQ_CMP_ERR;
 486                 xpt_done(done_ccb);
 487         }
 488         /* Drop freeze taken due to CAM_DEV_QFREEZE flag set. */
 489         cam_release_devq(path, 0, 0, 0, FALSE);
 490         cam_periph_invalidate(periph);
 491         cam_periph_release_locked(periph);
 492 }
 493
 494 static void
 495 nvme_probe_cleanup(struct cam_periph *periph)
 496 {
 497
 498         free(periph->softc, M_CAMXPT);
 499 }
 500
 501 #if 0
 502 /* XXX should be used, don't delete */
 503 static void
 504 nvme_find_quirk(struct cam_ed *device)
 505 {
 506         struct nvme_quirk_entry *quirk;
 507         caddr_t match;
 508
 509         match = cam_quirkmatch((caddr_t)&device->nvme_data,
 510                                (caddr_t)nvme_quirk_table,
 511                                nvme_quirk_table_size,
 512                                sizeof(*nvme_quirk_table), nvme_identify_match);
 513
 514         if (match == NULL)
 515                 panic("xpt_find_quirk: device didn't match wildcard entry!!");
 516
 517         quirk = (struct nvme_quirk_entry *)match;
 518         device->quirk = quirk;
 519         if (quirk->quirks & CAM_QUIRK_MAXTAGS) {
 520                 device->mintags = quirk->mintags;
 521                 device->maxtags = quirk->maxtags;
 522         }
 523 }
 524 #endif
 525
 526 static void
 527 nvme_scan_lun(struct cam_periph *periph, struct cam_path *path,
 528              cam_flags flags, union ccb *request_ccb)
 529 {
 530         struct ccb_pathinq cpi;
 531         cam_status status;
 532         struct cam_periph *old_periph;
 533         int lock;
 534
 535         CAM_DEBUG(path, CAM_DEBUG_TRACE, ("nvme_scan_lun\n"));
 536
 537         xpt_path_inq(&cpi, path);
 538
 539         if (cpi.ccb_h.status != CAM_REQ_CMP) {
 540                 if (request_ccb != NULL) {
 541                         request_ccb->ccb_h.status = cpi.ccb_h.status;
 542                         xpt_done(request_ccb);
 543                 }
 544                 return;
 545         }
 546
 547         if (xpt_path_lun_id(path) == CAM_LUN_WILDCARD) {
 548                 CAM_DEBUG(path, CAM_DEBUG_TRACE, ("nvme_scan_lun ignoring bus\n"));
 549                 request_ccb->ccb_h.status = CAM_REQ_CMP;        /* XXX signal error ? */
 550                 xpt_done(request_ccb);
 551                 return;
 552         }
 553
 554         lock = (xpt_path_owned(path) == 0);
 555         if (lock)
 556                 xpt_path_lock(path);
 557         if ((old_periph = cam_periph_find(path, "nvme_probe")) != NULL) {
 558                 if ((old_periph->flags & CAM_PERIPH_INVALID) == 0) {
 559                         nvme_probe_softc *softc;
 560
 561                         softc = (nvme_probe_softc *)old_periph->softc;
 562                         TAILQ_INSERT_TAIL(&softc->request_ccbs,
 563                                 &request_ccb->ccb_h, periph_links.tqe);
 564                         softc->restart = 1;
 565                         CAM_DEBUG(path, CAM_DEBUG_TRACE,
 566                             ("restarting nvme_probe device\n"));
 567                 } else {
 568                         request_ccb->ccb_h.status = CAM_REQ_CMP_ERR;
 569                         CAM_DEBUG(path, CAM_DEBUG_TRACE,
 570                             ("Failing to restart nvme_probe device\n"));
 571                         xpt_done(request_ccb);
 572                 }
 573         } else {
 574                 CAM_DEBUG(path, CAM_DEBUG_TRACE,
 575                     ("Adding nvme_probe device\n"));
 576                 status = cam_periph_alloc(nvme_probe_register, NULL, nvme_probe_cleanup,
 577                                           nvme_probe_start, "nvme_probe",
 578                                           CAM_PERIPH_BIO,
 579                                           request_ccb->ccb_h.path, NULL, 0,
 580                                           request_ccb);
 581
 582                 if (status != CAM_REQ_CMP) {
 583                         xpt_print(path, "xpt_scan_lun: cam_alloc_periph "
 584                             "returned an error, can't continue probe\n");
 585                         request_ccb->ccb_h.status = status;
 586                         xpt_done(request_ccb);
 587                 }
 588         }
 589         if (lock)
 590                 xpt_path_unlock(path);
 591 }
 592
 593 static struct cam_ed *
 594 nvme_alloc_device(struct cam_eb *bus, struct cam_et *target, lun_id_t lun_id)
 595 {
 596         struct nvme_quirk_entry *quirk;
 597         struct cam_ed *device;
 598
 599         device = xpt_alloc_device(bus, target, lun_id);
 600         if (device == NULL)
 601                 return (NULL);
 602
 603         /*
 604          * Take the default quirk entry until we have inquiry
 605          * data from nvme and can determine a better quirk to use.
 606          */
 607         quirk = &nvme_quirk_table[nvme_quirk_table_size - 1];
 608         device->quirk = (void *)quirk;
 609         device->mintags = 0;
 610         device->maxtags = 0;
 611         device->inq_flags = 0;
 612         device->queue_flags = 0;
 613         device->device_id = NULL;
 614         device->device_id_len = 0;
 615         device->serial_num = NULL;
 616         device->serial_num_len = 0;
 617         return (device);
 618 }
 619
 620 static void
 621 nvme_device_transport(struct cam_path *path)
 622 {
 623         struct ccb_pathinq cpi;
 624         struct ccb_trans_settings cts;
 625         /* XXX get data from nvme namespace and other info ??? */
 626
 627         /* Get transport information from the SIM */
 628         xpt_path_inq(&cpi, path);
 629
 630         path->device->transport = cpi.transport;
 631         path->device->transport_version = cpi.transport_version;
 632
 633         path->device->protocol = cpi.protocol;
 634         path->device->protocol_version = cpi.protocol_version;
 635
 636         /* Tell the controller what we think */
 637         xpt_setup_ccb(&cts.ccb_h, path, CAM_PRIORITY_NONE);
 638         cts.ccb_h.func_code = XPT_SET_TRAN_SETTINGS;
 639         cts.type = CTS_TYPE_CURRENT_SETTINGS;
 640         cts.transport = path->device->transport;
 641         cts.transport_version = path->device->transport_version;
 642         cts.protocol = path->device->protocol;
 643         cts.protocol_version = path->device->protocol_version;
 644         cts.proto_specific.valid = 0;
 645         cts.xport_specific.valid = 0;
 646         xpt_action((union ccb *)&cts);
 647 }
 648
 649 static void
 650 nvme_dev_advinfo(union ccb *start_ccb)
 651 {
 652         struct cam_ed *device;
 653         struct ccb_dev_advinfo *cdai;
 654         off_t amt;
 655
 656         xpt_path_assert(start_ccb->ccb_h.path, MA_OWNED);
 657         start_ccb->ccb_h.status = CAM_REQ_INVALID;
 658         device = start_ccb->ccb_h.path->device;
 659         cdai = &start_ccb->cdai;
 660         switch(cdai->buftype) {
 661         case CDAI_TYPE_SCSI_DEVID:
 662                 if (cdai->flags & CDAI_FLAG_STORE)
 663                         return;
 664                 cdai->provsiz = device->device_id_len;
 665                 if (device->device_id_len == 0)
 666                         break;
 667                 amt = device->device_id_len;
 668                 if (cdai->provsiz > cdai->bufsiz)
 669                         amt = cdai->bufsiz;
 670                 memcpy(cdai->buf, device->device_id, amt);
 671                 break;
 672         case CDAI_TYPE_SERIAL_NUM:
 673                 if (cdai->flags & CDAI_FLAG_STORE)
 674                         return;
 675                 cdai->provsiz = device->serial_num_len;
 676                 if (device->serial_num_len == 0)
 677                         break;
 678                 amt = device->serial_num_len;
 679                 if (cdai->provsiz > cdai->bufsiz)
 680                         amt = cdai->bufsiz;
 681                 memcpy(cdai->buf, device->serial_num, amt);
 682                 break;
 683         case CDAI_TYPE_PHYS_PATH:
 684                 if (cdai->flags & CDAI_FLAG_STORE) {
 685                         if (device->physpath != NULL)
 686                                 free(device->physpath, M_CAMXPT);
 687                         device->physpath_len = cdai->bufsiz;
 688                         /* Clear existing buffer if zero length */
 689                         if (cdai->bufsiz == 0)
 690                                 break;
 691                         device->physpath = malloc(cdai->bufsiz, M_CAMXPT, M_NOWAIT);
 692                         if (device->physpath == NULL) {
 693                                 start_ccb->ccb_h.status = CAM_REQ_ABORTED;
 694                                 return;
 695                         }
 696                         memcpy(device->physpath, cdai->buf, cdai->bufsiz);
 697                 } else {
 698                         cdai->provsiz = device->physpath_len;
 699                         if (device->physpath_len == 0)
 700                                 break;
 701                         amt = device->physpath_len;
 702                         if (cdai->provsiz > cdai->bufsiz)
 703                                 amt = cdai->bufsiz;
 704                         memcpy(cdai->buf, device->physpath, amt);
 705                 }
 706                 break;
 707         case CDAI_TYPE_NVME_CNTRL:
 708                 if (cdai->flags & CDAI_FLAG_STORE)
 709                         return;
 710                 amt = sizeof(struct nvme_controller_data);
 711                 cdai->provsiz = amt;
 712                 if (amt > cdai->bufsiz)
 713                         amt = cdai->bufsiz;
 714                 memcpy(cdai->buf, device->nvme_cdata, amt);
 715                 break;
 716         case CDAI_TYPE_NVME_NS:
 717                 if (cdai->flags & CDAI_FLAG_STORE)
 718                         return;
 719                 amt = sizeof(struct nvme_namespace_data);
 720                 cdai->provsiz = amt;
 721                 if (amt > cdai->bufsiz)
 722                         amt = cdai->bufsiz;
 723                 memcpy(cdai->buf, device->nvme_data, amt);
 724                 break;
 725         default:
 726                 return;
 727         }
 728         start_ccb->ccb_h.status = CAM_REQ_CMP;
 729
 730         if (cdai->flags & CDAI_FLAG_STORE) {
 731                 xpt_async(AC_ADVINFO_CHANGED, start_ccb->ccb_h.path,
 732                           (void *)(uintptr_t)cdai->buftype);
 733         }
 734 }
 735
 736 static void
 737 nvme_action(union ccb *start_ccb)
 738 {
 739         CAM_DEBUG(start_ccb->ccb_h.path, CAM_DEBUG_TRACE,
 740             ("nvme_action: func= %#x\n", start_ccb->ccb_h.func_code));
 741
 742         switch (start_ccb->ccb_h.func_code) {
 743         case XPT_SCAN_BUS:
 744         case XPT_SCAN_TGT:
 745         case XPT_SCAN_LUN:
 746                 nvme_scan_lun(start_ccb->ccb_h.path->periph,
 747                               start_ccb->ccb_h.path, start_ccb->crcn.flags,
 748                               start_ccb);
 749                 break;
 750         case XPT_DEV_ADVINFO:
 751                 nvme_dev_advinfo(start_ccb);
 752                 break;
 753
 754         default:
 755                 xpt_action_default(start_ccb);
 756                 break;
 757         }
 758 }
 759
 760 /*
 761  * Handle any per-device event notifications that require action by the XPT.
 762  */
 763 static void
 764 nvme_dev_async(u_int32_t async_code, struct cam_eb *bus, struct cam_et *target,
 765               struct cam_ed *device, void *async_arg)
 766 {
 767
 768         /*
 769          * We only need to handle events for real devices.
 770          */
 771         if (target->target_id == CAM_TARGET_WILDCARD
 772          || device->lun_id == CAM_LUN_WILDCARD)
 773                 return;
 774
 775         if (async_code == AC_LOST_DEVICE &&
 776             (device->flags & CAM_DEV_UNCONFIGURED) == 0) {
 777                 device->flags |= CAM_DEV_UNCONFIGURED;
 778                 xpt_release_device(device);
 779         }
 780 }
 781
 782 static void
 783 nvme_announce_periph(struct cam_periph *periph)
 784 {
 785         struct  ccb_pathinq cpi;
 786         struct  ccb_trans_settings cts;
 787         struct  cam_path *path = periph->path;
 788         struct ccb_trans_settings_nvme  *nvmex;
 789         struct sbuf     sb;
 790         char            buffer[120];
 791
 792         cam_periph_assert(periph, MA_OWNED);
 793
 794         /* Ask the SIM for connection details */
 795         xpt_setup_ccb(&cts.ccb_h, path, CAM_PRIORITY_NORMAL);
 796         cts.ccb_h.func_code = XPT_GET_TRAN_SETTINGS;
 797         cts.type = CTS_TYPE_CURRENT_SETTINGS;
 798         xpt_action((union ccb*)&cts);
 799         if ((cts.ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_CMP)
 800                 return;
 801         nvmex = &cts.xport_specific.nvme;
 802
 803         /* Ask the SIM for its base transfer speed */
 804         xpt_path_inq(&cpi, periph->path);
 805         sbuf_new(&sb, buffer, sizeof(buffer), SBUF_FIXEDLEN);
 806         sbuf_printf(&sb, "%s%d: nvme version %d.%d",
 807             periph->periph_name, periph->unit_number,
 808             NVME_MAJOR(nvmex->spec),
 809             NVME_MINOR(nvmex->spec));
 810         if (nvmex->valid & CTS_NVME_VALID_LINK)
 811                 sbuf_printf(&sb, " x%d (max x%d) lanes PCIe Gen%d (max Gen%d) link",
 812                     nvmex->lanes, nvmex->max_lanes,
 813                     nvmex->speed, nvmex->max_speed);
 814         sbuf_printf(&sb, "\n");
 815         sbuf_finish(&sb);
 816         sbuf_putbuf(&sb);
 817 }
 818
 819 static void
 820 nvme_proto_announce(struct cam_ed *device)
 821 {
 822         struct sbuf     sb;
 823         char            buffer[120];
 824
 825         sbuf_new(&sb, buffer, sizeof(buffer), SBUF_FIXEDLEN);
 826         nvme_print_ident(device->nvme_cdata, device->nvme_data, &sb);
 827         sbuf_finish(&sb);
 828         sbuf_putbuf(&sb);
 829 }
 830
 831 static void
 832 nvme_proto_denounce(struct cam_ed *device)
 833 {
 834
 835         nvme_proto_announce(device);
 836 }
 837
 838 static void
 839 nvme_proto_debug_out(union ccb *ccb)
 840 {
 841         char cdb_str[(sizeof(struct nvme_command) * 3) + 1];
 842
 843         if (ccb->ccb_h.func_code != XPT_NVME_IO &&
 844             ccb->ccb_h.func_code != XPT_NVME_ADMIN)
 845                 return;
 846
 847         CAM_DEBUG(ccb->ccb_h.path,
 848             CAM_DEBUG_CDB,("%s. NCB: %s\n", nvme_op_string(&ccb->nvmeio.cmd,
 849                 ccb->ccb_h.func_code == XPT_NVME_ADMIN),
 850                 nvme_cmd_string(&ccb->nvmeio.cmd, cdb_str, sizeof(cdb_str))));
 851 }