2 * Copyright (c) 2015 Netflix, Inc.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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.
26 * derived from ata_xpt.c: Copyright (c) 2009 Alexander Motin <mav@FreeBSD.org>
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
32 #include <sys/param.h>
34 #include <sys/endian.h>
35 #include <sys/systm.h>
36 #include <sys/types.h>
37 #include <sys/malloc.h>
38 #include <sys/kernel.h>
41 #include <sys/fcntl.h>
42 #include <sys/interrupt.h>
46 #include <sys/mutex.h>
47 #include <sys/sysctl.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>
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 */
66 struct nvme_quirk_entry {
68 #define CAM_QUIRK_MAXTAGS 1
73 /* Not even sure why we need this */
74 static periph_init_t nvme_probe_periph_init;
76 static struct periph_driver nvme_probe_driver =
78 nvme_probe_periph_init, "nvme_probe",
79 TAILQ_HEAD_INITIALIZER(nvme_probe_driver.units), /* generation */ 0,
83 PERIPHDRIVER_DECLARE(nvme_probe, nvme_probe_driver);
92 static char *nvme_probe_action_text[] = {
93 "NVME_PROBE_IDENTIFY",
99 #define NVME_PROBE_SET_ACTION(softc, newaction) \
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); \
110 NVME_PROBE_NO_ANNOUNCE = 0x04
114 TAILQ_HEAD(, ccb_hdr) request_ccbs;
115 nvme_probe_action action;
116 nvme_probe_flags flags;
118 struct cam_periph *periph;
121 static struct nvme_quirk_entry nvme_quirk_table[] =
125 // T_ANY, SIP_MEDIA_REMOVABLE|SIP_MEDIA_FIXED,
126 // /*vendor*/"*", /*product*/"*", /*revision*/"*"
128 .quirks = 0, .mintags = 0, .maxtags = 0
132 static const int nvme_quirk_table_size =
133 sizeof(nvme_quirk_table) / sizeof(*nvme_quirk_table);
135 static cam_status nvme_probe_register(struct cam_periph *periph,
137 static void nvme_probe_schedule(struct cam_periph *nvme_probe_periph);
138 static void nvme_probe_start(struct cam_periph *periph, union ccb *start_ccb);
139 static void nvme_probe_cleanup(struct cam_periph *periph);
140 //static void nvme_find_quirk(struct cam_ed *device);
141 static void nvme_scan_lun(struct cam_periph *periph,
142 struct cam_path *path, cam_flags flags,
144 static struct cam_ed *
145 nvme_alloc_device(struct cam_eb *bus, struct cam_et *target,
147 static void nvme_device_transport(struct cam_path *path);
148 static void nvme_dev_async(u_int32_t async_code,
150 struct cam_et *target,
151 struct cam_ed *device,
153 static void nvme_action(union ccb *start_ccb);
154 static void nvme_announce_periph(struct cam_periph *periph);
155 static void nvme_proto_announce(struct cam_ed *device);
156 static void nvme_proto_denounce(struct cam_ed *device);
157 static void nvme_proto_debug_out(union ccb *ccb);
159 static struct xpt_xport_ops nvme_xport_ops = {
160 .alloc_device = nvme_alloc_device,
161 .action = nvme_action,
162 .async = nvme_dev_async,
163 .announce = nvme_announce_periph,
165 #define NVME_XPT_XPORT(x, X) \
166 static struct xpt_xport nvme_xport_ ## x = { \
167 .xport = XPORT_ ## X, \
169 .ops = &nvme_xport_ops, \
171 CAM_XPT_XPORT(nvme_xport_ ## x);
173 NVME_XPT_XPORT(nvme, NVME);
175 #undef NVME_XPT_XPORT
177 static struct xpt_proto_ops nvme_proto_ops = {
178 .announce = nvme_proto_announce,
179 .denounce = nvme_proto_denounce,
180 .debug_out = nvme_proto_debug_out,
182 static struct xpt_proto nvme_proto = {
185 .ops = &nvme_proto_ops,
187 CAM_XPT_PROTO(nvme_proto);
190 nvme_probe_periph_init()
196 nvme_probe_register(struct cam_periph *periph, void *arg)
198 union ccb *request_ccb; /* CCB representing the probe request */
200 nvme_probe_softc *softc;
202 request_ccb = (union ccb *)arg;
203 if (request_ccb == NULL) {
204 printf("nvme_probe_register: no probe CCB, "
205 "can't register device\n");
206 return(CAM_REQ_CMP_ERR);
209 softc = (nvme_probe_softc *)malloc(sizeof(*softc), M_CAMXPT, M_ZERO | M_NOWAIT);
212 printf("nvme_probe_register: Unable to probe new device. "
213 "Unable to allocate softc\n");
214 return(CAM_REQ_CMP_ERR);
216 TAILQ_INIT(&softc->request_ccbs);
217 TAILQ_INSERT_TAIL(&softc->request_ccbs, &request_ccb->ccb_h,
220 periph->softc = softc;
221 softc->periph = periph;
222 softc->action = NVME_PROBE_INVALID;
223 status = cam_periph_acquire(periph);
224 if (status != CAM_REQ_CMP) {
227 CAM_DEBUG(periph->path, CAM_DEBUG_PROBE, ("Probe started\n"));
229 // nvme_device_transport(periph->path);
230 nvme_probe_schedule(periph);
236 nvme_probe_schedule(struct cam_periph *periph)
239 nvme_probe_softc *softc;
241 softc = (nvme_probe_softc *)periph->softc;
242 ccb = (union ccb *)TAILQ_FIRST(&softc->request_ccbs);
244 NVME_PROBE_SET_ACTION(softc, NVME_PROBE_IDENTIFY);
246 if (ccb->crcn.flags & CAM_EXPECT_INQ_CHANGE)
247 softc->flags |= NVME_PROBE_NO_ANNOUNCE;
249 softc->flags &= ~NVME_PROBE_NO_ANNOUNCE;
251 xpt_schedule(periph, CAM_PRIORITY_XPT);
255 nvme_probe_start(struct cam_periph *periph, union ccb *start_ccb)
257 struct ccb_nvmeio *nvmeio;
258 struct ccb_scsiio *csio;
259 nvme_probe_softc *softc;
260 struct cam_path *path;
261 const struct nvme_namespace_data *nvme_data;
264 CAM_DEBUG(start_ccb->ccb_h.path, CAM_DEBUG_TRACE, ("nvme_probe_start\n"));
266 softc = (nvme_probe_softc *)periph->softc;
267 path = start_ccb->ccb_h.path;
268 nvmeio = &start_ccb->nvmeio;
269 csio = &start_ccb->csio;
270 nvme_data = periph->path->device->nvme_data;
272 if (softc->restart) {
274 if (periph->path->device->flags & CAM_DEV_UNCONFIGURED)
275 NVME_PROBE_SET_ACTION(softc, NVME_PROBE_RESET);
277 NVME_PROBE_SET_ACTION(softc, NVME_PROBE_IDENTIFY);
281 * Other transports have to ask their SIM to do a lot of action.
282 * NVMe doesn't, so don't do the dance. Just do things
285 switch (softc->action) {
286 case NVME_PROBE_RESET:
288 case NVME_PROBE_IDENTIFY:
289 nvme_device_transport(path);
291 * Test for lun == CAM_LUN_WILDCARD is lame, but
292 * appears to be necessary here. XXX
294 lun = xpt_path_lun_id(periph->path);
295 if (lun == CAM_LUN_WILDCARD ||
296 periph->path->device->flags & CAM_DEV_UNCONFIGURED) {
297 path->device->flags &= ~CAM_DEV_UNCONFIGURED;
298 xpt_acquire_device(path->device);
299 start_ccb->ccb_h.func_code = XPT_GDEV_TYPE;
300 xpt_action(start_ccb);
301 xpt_async(AC_FOUND_DEVICE, path, start_ccb);
303 NVME_PROBE_SET_ACTION(softc, NVME_PROBE_DONE);
306 panic("nvme_probe_start: invalid action state 0x%x\n", softc->action);
309 * Probing is now done. We need to complete any lingering items
310 * in the queue, though there shouldn't be any.
312 xpt_release_ccb(start_ccb);
313 CAM_DEBUG(periph->path, CAM_DEBUG_PROBE, ("Probe completed\n"));
314 while ((start_ccb = (union ccb *)TAILQ_FIRST(&softc->request_ccbs))) {
315 TAILQ_REMOVE(&softc->request_ccbs,
316 &start_ccb->ccb_h, periph_links.tqe);
317 start_ccb->ccb_h.status = CAM_REQ_CMP;
320 cam_periph_invalidate(periph);
321 /* Can't release periph since we hit a (possibly bogus) assertion */
322 // cam_periph_release_locked(periph);
326 nvme_probe_cleanup(struct cam_periph *periph)
329 free(periph->softc, M_CAMXPT);
333 /* XXX should be used, don't delete */
335 nvme_find_quirk(struct cam_ed *device)
337 struct nvme_quirk_entry *quirk;
340 match = cam_quirkmatch((caddr_t)&device->nvme_data,
341 (caddr_t)nvme_quirk_table,
342 nvme_quirk_table_size,
343 sizeof(*nvme_quirk_table), nvme_identify_match);
346 panic("xpt_find_quirk: device didn't match wildcard entry!!");
348 quirk = (struct nvme_quirk_entry *)match;
349 device->quirk = quirk;
350 if (quirk->quirks & CAM_QUIRK_MAXTAGS) {
351 device->mintags = quirk->mintags;
352 device->maxtags = quirk->maxtags;
358 nvme_scan_lun(struct cam_periph *periph, struct cam_path *path,
359 cam_flags flags, union ccb *request_ccb)
361 struct ccb_pathinq cpi;
363 struct cam_periph *old_periph;
366 CAM_DEBUG(path, CAM_DEBUG_TRACE, ("nvme_scan_lun\n"));
368 xpt_setup_ccb(&cpi.ccb_h, path, CAM_PRIORITY_NONE);
369 cpi.ccb_h.func_code = XPT_PATH_INQ;
370 xpt_action((union ccb *)&cpi);
372 if (cpi.ccb_h.status != CAM_REQ_CMP) {
373 if (request_ccb != NULL) {
374 request_ccb->ccb_h.status = cpi.ccb_h.status;
375 xpt_done(request_ccb);
380 if (xpt_path_lun_id(path) == CAM_LUN_WILDCARD) {
381 CAM_DEBUG(path, CAM_DEBUG_TRACE, ("nvme_scan_lun ignoring bus\n"));
382 request_ccb->ccb_h.status = CAM_REQ_CMP; /* XXX signal error ? */
383 xpt_done(request_ccb);
387 lock = (xpt_path_owned(path) == 0);
390 if ((old_periph = cam_periph_find(path, "nvme_probe")) != NULL) {
391 if ((old_periph->flags & CAM_PERIPH_INVALID) == 0) {
392 nvme_probe_softc *softc;
394 softc = (nvme_probe_softc *)old_periph->softc;
395 TAILQ_INSERT_TAIL(&softc->request_ccbs,
396 &request_ccb->ccb_h, periph_links.tqe);
398 CAM_DEBUG(path, CAM_DEBUG_TRACE,
399 ("restarting nvme_probe device\n"));
401 request_ccb->ccb_h.status = CAM_REQ_CMP_ERR;
402 CAM_DEBUG(path, CAM_DEBUG_TRACE,
403 ("Failing to restart nvme_probe device\n"));
404 xpt_done(request_ccb);
407 CAM_DEBUG(path, CAM_DEBUG_TRACE,
408 ("Adding nvme_probe device\n"));
409 status = cam_periph_alloc(nvme_probe_register, NULL, nvme_probe_cleanup,
410 nvme_probe_start, "nvme_probe",
412 request_ccb->ccb_h.path, NULL, 0,
415 if (status != CAM_REQ_CMP) {
416 xpt_print(path, "xpt_scan_lun: cam_alloc_periph "
417 "returned an error, can't continue probe\n");
418 request_ccb->ccb_h.status = status;
419 xpt_done(request_ccb);
423 xpt_path_unlock(path);
426 static struct cam_ed *
427 nvme_alloc_device(struct cam_eb *bus, struct cam_et *target, lun_id_t lun_id)
429 struct nvme_quirk_entry *quirk;
430 struct cam_ed *device;
432 device = xpt_alloc_device(bus, target, lun_id);
437 * Take the default quirk entry until we have inquiry
438 * data from nvme and can determine a better quirk to use.
440 quirk = &nvme_quirk_table[nvme_quirk_table_size - 1];
441 device->quirk = (void *)quirk;
444 device->inq_flags = 0;
445 device->queue_flags = 0;
446 device->device_id = NULL; /* XXX Need to set this somewhere */
447 device->device_id_len = 0;
448 device->serial_num = NULL; /* XXX Need to set this somewhere */
449 device->serial_num_len = 0;
454 nvme_device_transport(struct cam_path *path)
456 struct ccb_pathinq cpi;
457 struct ccb_trans_settings cts;
458 /* XXX get data from nvme namespace and other info ??? */
460 /* Get transport information from the SIM */
461 xpt_setup_ccb(&cpi.ccb_h, path, CAM_PRIORITY_NONE);
462 cpi.ccb_h.func_code = XPT_PATH_INQ;
463 xpt_action((union ccb *)&cpi);
465 path->device->transport = cpi.transport;
466 path->device->transport_version = cpi.transport_version;
468 path->device->protocol = cpi.protocol;
469 path->device->protocol_version = cpi.protocol_version;
471 /* Tell the controller what we think */
472 xpt_setup_ccb(&cts.ccb_h, path, CAM_PRIORITY_NONE);
473 cts.ccb_h.func_code = XPT_SET_TRAN_SETTINGS;
474 cts.type = CTS_TYPE_CURRENT_SETTINGS;
475 cts.transport = path->device->transport;
476 cts.transport_version = path->device->transport_version;
477 cts.protocol = path->device->protocol;
478 cts.protocol_version = path->device->protocol_version;
479 cts.proto_specific.valid = 0;
480 cts.xport_specific.valid = 0;
481 xpt_action((union ccb *)&cts);
485 nvme_dev_advinfo(union ccb *start_ccb)
487 struct cam_ed *device;
488 struct ccb_dev_advinfo *cdai;
491 start_ccb->ccb_h.status = CAM_REQ_INVALID;
492 device = start_ccb->ccb_h.path->device;
493 cdai = &start_ccb->cdai;
494 switch(cdai->buftype) {
495 case CDAI_TYPE_SCSI_DEVID:
496 if (cdai->flags & CDAI_FLAG_STORE)
498 cdai->provsiz = device->device_id_len;
499 if (device->device_id_len == 0)
501 amt = device->device_id_len;
502 if (cdai->provsiz > cdai->bufsiz)
504 memcpy(cdai->buf, device->device_id, amt);
506 case CDAI_TYPE_SERIAL_NUM:
507 if (cdai->flags & CDAI_FLAG_STORE)
509 cdai->provsiz = device->serial_num_len;
510 if (device->serial_num_len == 0)
512 amt = device->serial_num_len;
513 if (cdai->provsiz > cdai->bufsiz)
515 memcpy(cdai->buf, device->serial_num, amt);
517 case CDAI_TYPE_PHYS_PATH:
518 if (cdai->flags & CDAI_FLAG_STORE) {
519 if (device->physpath != NULL)
520 free(device->physpath, M_CAMXPT);
521 device->physpath_len = cdai->bufsiz;
522 /* Clear existing buffer if zero length */
523 if (cdai->bufsiz == 0)
525 device->physpath = malloc(cdai->bufsiz, M_CAMXPT, M_NOWAIT);
526 if (device->physpath == NULL) {
527 start_ccb->ccb_h.status = CAM_REQ_ABORTED;
530 memcpy(device->physpath, cdai->buf, cdai->bufsiz);
532 cdai->provsiz = device->physpath_len;
533 if (device->physpath_len == 0)
535 amt = device->physpath_len;
536 if (cdai->provsiz > cdai->bufsiz)
538 memcpy(cdai->buf, device->physpath, amt);
544 start_ccb->ccb_h.status = CAM_REQ_CMP;
546 if (cdai->flags & CDAI_FLAG_STORE) {
547 xpt_async(AC_ADVINFO_CHANGED, start_ccb->ccb_h.path,
548 (void *)(uintptr_t)cdai->buftype);
553 nvme_action(union ccb *start_ccb)
555 CAM_DEBUG(start_ccb->ccb_h.path, CAM_DEBUG_TRACE,
556 ("nvme_action: func= %#x\n", start_ccb->ccb_h.func_code));
558 switch (start_ccb->ccb_h.func_code) {
562 nvme_scan_lun(start_ccb->ccb_h.path->periph,
563 start_ccb->ccb_h.path, start_ccb->crcn.flags,
566 case XPT_DEV_ADVINFO:
567 nvme_dev_advinfo(start_ccb);
571 xpt_action_default(start_ccb);
577 * Handle any per-device event notifications that require action by the XPT.
580 nvme_dev_async(u_int32_t async_code, struct cam_eb *bus, struct cam_et *target,
581 struct cam_ed *device, void *async_arg)
585 * We only need to handle events for real devices.
587 if (target->target_id == CAM_TARGET_WILDCARD
588 || device->lun_id == CAM_LUN_WILDCARD)
591 if (async_code == AC_LOST_DEVICE &&
592 (device->flags & CAM_DEV_UNCONFIGURED) == 0) {
593 device->flags |= CAM_DEV_UNCONFIGURED;
594 xpt_release_device(device);
599 nvme_announce_periph(struct cam_periph *periph)
601 struct ccb_pathinq cpi;
602 struct ccb_trans_settings cts;
603 struct cam_path *path = periph->path;
605 cam_periph_assert(periph, MA_OWNED);
607 xpt_setup_ccb(&cts.ccb_h, path, CAM_PRIORITY_NORMAL);
608 cts.ccb_h.func_code = XPT_GET_TRAN_SETTINGS;
609 cts.type = CTS_TYPE_CURRENT_SETTINGS;
610 xpt_action((union ccb*)&cts);
611 if ((cts.ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_CMP)
613 /* Ask the SIM for its base transfer speed */
614 xpt_setup_ccb(&cpi.ccb_h, path, CAM_PRIORITY_NORMAL);
615 cpi.ccb_h.func_code = XPT_PATH_INQ;
616 xpt_action((union ccb *)&cpi);
617 /* XXX NVME STUFF HERE */
622 nvme_proto_announce(struct cam_ed *device)
624 nvme_print_ident(device->nvme_cdata, device->nvme_data);
628 nvme_proto_denounce(struct cam_ed *device)
630 nvme_print_ident(device->nvme_cdata, device->nvme_data);
634 nvme_proto_debug_out(union ccb *ccb)
636 char cdb_str[(sizeof(struct nvme_command) * 3) + 1];
638 if (ccb->ccb_h.func_code != XPT_NVME_IO)
641 CAM_DEBUG(ccb->ccb_h.path,
642 CAM_DEBUG_CDB,("%s. NCB: %s\n", nvme_op_string(&ccb->nvmeio.cmd),
643 nvme_cmd_string(&ccb->nvmeio.cmd, cdb_str, sizeof(cdb_str))));