1baabaca3SWarner Losh /*- 2f24882ecSPedro F. Giffuni * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3f24882ecSPedro F. Giffuni * 4baabaca3SWarner Losh * Copyright (c) 2015 Netflix, Inc. 5baabaca3SWarner Losh * All rights reserved. 6baabaca3SWarner Losh * 7baabaca3SWarner Losh * Redistribution and use in source and binary forms, with or without 8baabaca3SWarner Losh * modification, are permitted provided that the following conditions 9baabaca3SWarner Losh * are met: 10baabaca3SWarner Losh * 1. Redistributions of source code must retain the above copyright 11baabaca3SWarner Losh * notice, this list of conditions and the following disclaimer, 12baabaca3SWarner Losh * without modification, immediately at the beginning of the file. 13baabaca3SWarner Losh * 2. Redistributions in binary form must reproduce the above copyright 14baabaca3SWarner Losh * notice, this list of conditions and the following disclaimer in the 15baabaca3SWarner Losh * documentation and/or other materials provided with the distribution. 16baabaca3SWarner Losh * 17baabaca3SWarner Losh * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 18baabaca3SWarner Losh * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 19baabaca3SWarner Losh * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 20baabaca3SWarner Losh * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 21baabaca3SWarner Losh * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 22baabaca3SWarner Losh * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 23baabaca3SWarner Losh * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 24baabaca3SWarner Losh * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 25baabaca3SWarner Losh * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 26baabaca3SWarner Losh * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 27baabaca3SWarner Losh * 28baabaca3SWarner Losh * derived from ata_xpt.c: Copyright (c) 2009 Alexander Motin <mav@FreeBSD.org> 29baabaca3SWarner Losh */ 30baabaca3SWarner Losh 31baabaca3SWarner Losh #include <sys/cdefs.h> 32baabaca3SWarner Losh __FBSDID("$FreeBSD$"); 33baabaca3SWarner Losh 34baabaca3SWarner Losh #include <sys/param.h> 35baabaca3SWarner Losh #include <sys/bus.h> 36baabaca3SWarner Losh #include <sys/endian.h> 37baabaca3SWarner Losh #include <sys/systm.h> 38baabaca3SWarner Losh #include <sys/types.h> 39baabaca3SWarner Losh #include <sys/malloc.h> 40baabaca3SWarner Losh #include <sys/kernel.h> 41baabaca3SWarner Losh #include <sys/time.h> 42baabaca3SWarner Losh #include <sys/conf.h> 43baabaca3SWarner Losh #include <sys/fcntl.h> 44baabaca3SWarner Losh #include <sys/interrupt.h> 45baabaca3SWarner Losh #include <sys/sbuf.h> 46baabaca3SWarner Losh 47baabaca3SWarner Losh #include <sys/lock.h> 48baabaca3SWarner Losh #include <sys/mutex.h> 49baabaca3SWarner Losh #include <sys/sysctl.h> 50baabaca3SWarner Losh 51baabaca3SWarner Losh #include <cam/cam.h> 52baabaca3SWarner Losh #include <cam/cam_ccb.h> 53baabaca3SWarner Losh #include <cam/cam_queue.h> 54baabaca3SWarner Losh #include <cam/cam_periph.h> 55baabaca3SWarner Losh #include <cam/cam_sim.h> 56baabaca3SWarner Losh #include <cam/cam_xpt.h> 57baabaca3SWarner Losh #include <cam/cam_xpt_sim.h> 58baabaca3SWarner Losh #include <cam/cam_xpt_periph.h> 59baabaca3SWarner Losh #include <cam/cam_xpt_internal.h> 60baabaca3SWarner Losh #include <cam/cam_debug.h> 61baabaca3SWarner Losh 62baabaca3SWarner Losh #include <cam/scsi/scsi_all.h> 63baabaca3SWarner Losh #include <cam/scsi/scsi_message.h> 64baabaca3SWarner Losh #include <cam/nvme/nvme_all.h> 65baabaca3SWarner Losh #include <machine/stdarg.h> /* for xpt_print below */ 66baabaca3SWarner Losh #include "opt_cam.h" 67baabaca3SWarner Losh 68baabaca3SWarner Losh struct nvme_quirk_entry { 69baabaca3SWarner Losh u_int quirks; 70baabaca3SWarner Losh #define CAM_QUIRK_MAXTAGS 1 71baabaca3SWarner Losh u_int mintags; 72baabaca3SWarner Losh u_int maxtags; 73baabaca3SWarner Losh }; 74baabaca3SWarner Losh 75baabaca3SWarner Losh /* Not even sure why we need this */ 76baabaca3SWarner Losh static periph_init_t nvme_probe_periph_init; 77baabaca3SWarner Losh 78baabaca3SWarner Losh static struct periph_driver nvme_probe_driver = 79baabaca3SWarner Losh { 80baabaca3SWarner Losh nvme_probe_periph_init, "nvme_probe", 81baabaca3SWarner Losh TAILQ_HEAD_INITIALIZER(nvme_probe_driver.units), /* generation */ 0, 82baabaca3SWarner Losh CAM_PERIPH_DRV_EARLY 83baabaca3SWarner Losh }; 84baabaca3SWarner Losh 85baabaca3SWarner Losh PERIPHDRIVER_DECLARE(nvme_probe, nvme_probe_driver); 86baabaca3SWarner Losh 87baabaca3SWarner Losh typedef enum { 88baabaca3SWarner Losh NVME_PROBE_IDENTIFY, 89baabaca3SWarner Losh NVME_PROBE_DONE, 90baabaca3SWarner Losh NVME_PROBE_INVALID, 91baabaca3SWarner Losh NVME_PROBE_RESET 92baabaca3SWarner Losh } nvme_probe_action; 93baabaca3SWarner Losh 94baabaca3SWarner Losh static char *nvme_probe_action_text[] = { 95baabaca3SWarner Losh "NVME_PROBE_IDENTIFY", 96baabaca3SWarner Losh "NVME_PROBE_DONE", 97baabaca3SWarner Losh "NVME_PROBE_INVALID", 98baabaca3SWarner Losh "NVME_PROBE_RESET", 99baabaca3SWarner Losh }; 100baabaca3SWarner Losh 101baabaca3SWarner Losh #define NVME_PROBE_SET_ACTION(softc, newaction) \ 102baabaca3SWarner Losh do { \ 103baabaca3SWarner Losh char **text; \ 104baabaca3SWarner Losh text = nvme_probe_action_text; \ 105baabaca3SWarner Losh CAM_DEBUG((softc)->periph->path, CAM_DEBUG_PROBE, \ 106baabaca3SWarner Losh ("Probe %s to %s\n", text[(softc)->action], \ 107baabaca3SWarner Losh text[(newaction)])); \ 108baabaca3SWarner Losh (softc)->action = (newaction); \ 109baabaca3SWarner Losh } while(0) 110baabaca3SWarner Losh 111baabaca3SWarner Losh typedef enum { 112baabaca3SWarner Losh NVME_PROBE_NO_ANNOUNCE = 0x04 113baabaca3SWarner Losh } nvme_probe_flags; 114baabaca3SWarner Losh 115baabaca3SWarner Losh typedef struct { 116baabaca3SWarner Losh TAILQ_HEAD(, ccb_hdr) request_ccbs; 117baabaca3SWarner Losh nvme_probe_action action; 118baabaca3SWarner Losh nvme_probe_flags flags; 119baabaca3SWarner Losh int restart; 120baabaca3SWarner Losh struct cam_periph *periph; 121baabaca3SWarner Losh } nvme_probe_softc; 122baabaca3SWarner Losh 123baabaca3SWarner Losh static struct nvme_quirk_entry nvme_quirk_table[] = 124baabaca3SWarner Losh { 125baabaca3SWarner Losh { 126baabaca3SWarner Losh // { 127baabaca3SWarner Losh // T_ANY, SIP_MEDIA_REMOVABLE|SIP_MEDIA_FIXED, 128baabaca3SWarner Losh // /*vendor*/"*", /*product*/"*", /*revision*/"*" 129baabaca3SWarner Losh // }, 130baabaca3SWarner Losh .quirks = 0, .mintags = 0, .maxtags = 0 131baabaca3SWarner Losh }, 132baabaca3SWarner Losh }; 133baabaca3SWarner Losh 134baabaca3SWarner Losh static const int nvme_quirk_table_size = 135baabaca3SWarner Losh sizeof(nvme_quirk_table) / sizeof(*nvme_quirk_table); 136baabaca3SWarner Losh 137baabaca3SWarner Losh static cam_status nvme_probe_register(struct cam_periph *periph, 138baabaca3SWarner Losh void *arg); 139baabaca3SWarner Losh static void nvme_probe_schedule(struct cam_periph *nvme_probe_periph); 140baabaca3SWarner Losh static void nvme_probe_start(struct cam_periph *periph, union ccb *start_ccb); 141baabaca3SWarner Losh static void nvme_probe_cleanup(struct cam_periph *periph); 142f24c011bSWarner Losh //static void nvme_find_quirk(struct cam_ed *device); 143baabaca3SWarner Losh static void nvme_scan_lun(struct cam_periph *periph, 144baabaca3SWarner Losh struct cam_path *path, cam_flags flags, 145baabaca3SWarner Losh union ccb *ccb); 146baabaca3SWarner Losh static struct cam_ed * 147baabaca3SWarner Losh nvme_alloc_device(struct cam_eb *bus, struct cam_et *target, 148baabaca3SWarner Losh lun_id_t lun_id); 149baabaca3SWarner Losh static void nvme_device_transport(struct cam_path *path); 150baabaca3SWarner Losh static void nvme_dev_async(u_int32_t async_code, 151baabaca3SWarner Losh struct cam_eb *bus, 152baabaca3SWarner Losh struct cam_et *target, 153baabaca3SWarner Losh struct cam_ed *device, 154baabaca3SWarner Losh void *async_arg); 155baabaca3SWarner Losh static void nvme_action(union ccb *start_ccb); 156baabaca3SWarner Losh static void nvme_announce_periph(struct cam_periph *periph); 15708f13879SWarner Losh static void nvme_proto_announce(struct cam_ed *device); 15808f13879SWarner Losh static void nvme_proto_denounce(struct cam_ed *device); 15908f13879SWarner Losh static void nvme_proto_debug_out(union ccb *ccb); 160baabaca3SWarner Losh 161ded2b706SWarner Losh static struct xpt_xport_ops nvme_xport_ops = { 162baabaca3SWarner Losh .alloc_device = nvme_alloc_device, 163baabaca3SWarner Losh .action = nvme_action, 164baabaca3SWarner Losh .async = nvme_dev_async, 165baabaca3SWarner Losh .announce = nvme_announce_periph, 166baabaca3SWarner Losh }; 167ded2b706SWarner Losh #define NVME_XPT_XPORT(x, X) \ 168ded2b706SWarner Losh static struct xpt_xport nvme_xport_ ## x = { \ 169ded2b706SWarner Losh .xport = XPORT_ ## X, \ 170ded2b706SWarner Losh .name = #x, \ 171ded2b706SWarner Losh .ops = &nvme_xport_ops, \ 172ded2b706SWarner Losh }; \ 173ded2b706SWarner Losh CAM_XPT_XPORT(nvme_xport_ ## x); 174baabaca3SWarner Losh 175ded2b706SWarner Losh NVME_XPT_XPORT(nvme, NVME); 176e0ce51cbSWarner Losh 177ded2b706SWarner Losh #undef NVME_XPT_XPORT 178baabaca3SWarner Losh 17908f13879SWarner Losh static struct xpt_proto_ops nvme_proto_ops = { 18008f13879SWarner Losh .announce = nvme_proto_announce, 18108f13879SWarner Losh .denounce = nvme_proto_denounce, 18208f13879SWarner Losh .debug_out = nvme_proto_debug_out, 18308f13879SWarner Losh }; 18408f13879SWarner Losh static struct xpt_proto nvme_proto = { 18508f13879SWarner Losh .proto = PROTO_NVME, 18608f13879SWarner Losh .name = "nvme", 18708f13879SWarner Losh .ops = &nvme_proto_ops, 18808f13879SWarner Losh }; 18908f13879SWarner Losh CAM_XPT_PROTO(nvme_proto); 19008f13879SWarner Losh 191baabaca3SWarner Losh static void 192baabaca3SWarner Losh nvme_probe_periph_init() 193baabaca3SWarner Losh { 194e0ce51cbSWarner Losh 195baabaca3SWarner Losh } 196baabaca3SWarner Losh 197baabaca3SWarner Losh static cam_status 198baabaca3SWarner Losh nvme_probe_register(struct cam_periph *periph, void *arg) 199baabaca3SWarner Losh { 200baabaca3SWarner Losh union ccb *request_ccb; /* CCB representing the probe request */ 201baabaca3SWarner Losh cam_status status; 202baabaca3SWarner Losh nvme_probe_softc *softc; 203baabaca3SWarner Losh 204baabaca3SWarner Losh request_ccb = (union ccb *)arg; 205baabaca3SWarner Losh if (request_ccb == NULL) { 206baabaca3SWarner Losh printf("nvme_probe_register: no probe CCB, " 207baabaca3SWarner Losh "can't register device\n"); 208baabaca3SWarner Losh return(CAM_REQ_CMP_ERR); 209baabaca3SWarner Losh } 210baabaca3SWarner Losh 211baabaca3SWarner Losh softc = (nvme_probe_softc *)malloc(sizeof(*softc), M_CAMXPT, M_ZERO | M_NOWAIT); 212baabaca3SWarner Losh 213baabaca3SWarner Losh if (softc == NULL) { 214baabaca3SWarner Losh printf("nvme_probe_register: Unable to probe new device. " 215baabaca3SWarner Losh "Unable to allocate softc\n"); 216baabaca3SWarner Losh return(CAM_REQ_CMP_ERR); 217baabaca3SWarner Losh } 218baabaca3SWarner Losh TAILQ_INIT(&softc->request_ccbs); 219baabaca3SWarner Losh TAILQ_INSERT_TAIL(&softc->request_ccbs, &request_ccb->ccb_h, 220baabaca3SWarner Losh periph_links.tqe); 221baabaca3SWarner Losh softc->flags = 0; 222baabaca3SWarner Losh periph->softc = softc; 223baabaca3SWarner Losh softc->periph = periph; 224baabaca3SWarner Losh softc->action = NVME_PROBE_INVALID; 225baabaca3SWarner Losh status = cam_periph_acquire(periph); 226baabaca3SWarner Losh if (status != CAM_REQ_CMP) { 227baabaca3SWarner Losh return (status); 228baabaca3SWarner Losh } 229baabaca3SWarner Losh CAM_DEBUG(periph->path, CAM_DEBUG_PROBE, ("Probe started\n")); 230baabaca3SWarner Losh 231baabaca3SWarner Losh // nvme_device_transport(periph->path); 232baabaca3SWarner Losh nvme_probe_schedule(periph); 233baabaca3SWarner Losh 234baabaca3SWarner Losh return(CAM_REQ_CMP); 235baabaca3SWarner Losh } 236baabaca3SWarner Losh 237baabaca3SWarner Losh static void 238baabaca3SWarner Losh nvme_probe_schedule(struct cam_periph *periph) 239baabaca3SWarner Losh { 240baabaca3SWarner Losh union ccb *ccb; 241baabaca3SWarner Losh nvme_probe_softc *softc; 242baabaca3SWarner Losh 243baabaca3SWarner Losh softc = (nvme_probe_softc *)periph->softc; 244baabaca3SWarner Losh ccb = (union ccb *)TAILQ_FIRST(&softc->request_ccbs); 245baabaca3SWarner Losh 246baabaca3SWarner Losh NVME_PROBE_SET_ACTION(softc, NVME_PROBE_IDENTIFY); 247baabaca3SWarner Losh 248baabaca3SWarner Losh if (ccb->crcn.flags & CAM_EXPECT_INQ_CHANGE) 249baabaca3SWarner Losh softc->flags |= NVME_PROBE_NO_ANNOUNCE; 250baabaca3SWarner Losh else 251baabaca3SWarner Losh softc->flags &= ~NVME_PROBE_NO_ANNOUNCE; 252baabaca3SWarner Losh 253baabaca3SWarner Losh xpt_schedule(periph, CAM_PRIORITY_XPT); 254baabaca3SWarner Losh } 255baabaca3SWarner Losh 256baabaca3SWarner Losh static void 257baabaca3SWarner Losh nvme_probe_start(struct cam_periph *periph, union ccb *start_ccb) 258baabaca3SWarner Losh { 259baabaca3SWarner Losh struct ccb_nvmeio *nvmeio; 260baabaca3SWarner Losh struct ccb_scsiio *csio; 261baabaca3SWarner Losh nvme_probe_softc *softc; 262baabaca3SWarner Losh struct cam_path *path; 263baabaca3SWarner Losh const struct nvme_namespace_data *nvme_data; 264baabaca3SWarner Losh lun_id_t lun; 265baabaca3SWarner Losh 266baabaca3SWarner Losh CAM_DEBUG(start_ccb->ccb_h.path, CAM_DEBUG_TRACE, ("nvme_probe_start\n")); 267baabaca3SWarner Losh 268baabaca3SWarner Losh softc = (nvme_probe_softc *)periph->softc; 269baabaca3SWarner Losh path = start_ccb->ccb_h.path; 270baabaca3SWarner Losh nvmeio = &start_ccb->nvmeio; 271baabaca3SWarner Losh csio = &start_ccb->csio; 272baabaca3SWarner Losh nvme_data = periph->path->device->nvme_data; 273baabaca3SWarner Losh 274baabaca3SWarner Losh if (softc->restart) { 275baabaca3SWarner Losh softc->restart = 0; 276baabaca3SWarner Losh if (periph->path->device->flags & CAM_DEV_UNCONFIGURED) 277baabaca3SWarner Losh NVME_PROBE_SET_ACTION(softc, NVME_PROBE_RESET); 278baabaca3SWarner Losh else 279baabaca3SWarner Losh NVME_PROBE_SET_ACTION(softc, NVME_PROBE_IDENTIFY); 280baabaca3SWarner Losh } 281baabaca3SWarner Losh 282baabaca3SWarner Losh /* 283baabaca3SWarner Losh * Other transports have to ask their SIM to do a lot of action. 284baabaca3SWarner Losh * NVMe doesn't, so don't do the dance. Just do things 285baabaca3SWarner Losh * directly. 286baabaca3SWarner Losh */ 287baabaca3SWarner Losh switch (softc->action) { 288baabaca3SWarner Losh case NVME_PROBE_RESET: 289baabaca3SWarner Losh /* FALLTHROUGH */ 290baabaca3SWarner Losh case NVME_PROBE_IDENTIFY: 291baabaca3SWarner Losh nvme_device_transport(path); 292baabaca3SWarner Losh /* 293baabaca3SWarner Losh * Test for lun == CAM_LUN_WILDCARD is lame, but 294baabaca3SWarner Losh * appears to be necessary here. XXX 295baabaca3SWarner Losh */ 296baabaca3SWarner Losh lun = xpt_path_lun_id(periph->path); 297baabaca3SWarner Losh if (lun == CAM_LUN_WILDCARD || 298baabaca3SWarner Losh periph->path->device->flags & CAM_DEV_UNCONFIGURED) { 299baabaca3SWarner Losh path->device->flags &= ~CAM_DEV_UNCONFIGURED; 300baabaca3SWarner Losh xpt_acquire_device(path->device); 301baabaca3SWarner Losh start_ccb->ccb_h.func_code = XPT_GDEV_TYPE; 302baabaca3SWarner Losh xpt_action(start_ccb); 303baabaca3SWarner Losh xpt_async(AC_FOUND_DEVICE, path, start_ccb); 304baabaca3SWarner Losh } 305baabaca3SWarner Losh NVME_PROBE_SET_ACTION(softc, NVME_PROBE_DONE); 306baabaca3SWarner Losh break; 307baabaca3SWarner Losh default: 308baabaca3SWarner Losh panic("nvme_probe_start: invalid action state 0x%x\n", softc->action); 309baabaca3SWarner Losh } 310baabaca3SWarner Losh /* 311baabaca3SWarner Losh * Probing is now done. We need to complete any lingering items 312baabaca3SWarner Losh * in the queue, though there shouldn't be any. 313baabaca3SWarner Losh */ 314baabaca3SWarner Losh xpt_release_ccb(start_ccb); 315baabaca3SWarner Losh CAM_DEBUG(periph->path, CAM_DEBUG_PROBE, ("Probe completed\n")); 316baabaca3SWarner Losh while ((start_ccb = (union ccb *)TAILQ_FIRST(&softc->request_ccbs))) { 317baabaca3SWarner Losh TAILQ_REMOVE(&softc->request_ccbs, 318baabaca3SWarner Losh &start_ccb->ccb_h, periph_links.tqe); 319baabaca3SWarner Losh start_ccb->ccb_h.status = CAM_REQ_CMP; 320baabaca3SWarner Losh xpt_done(start_ccb); 321baabaca3SWarner Losh } 322baabaca3SWarner Losh cam_periph_invalidate(periph); 323876f6a6aSScott Long cam_periph_release_locked(periph); 324baabaca3SWarner Losh } 325baabaca3SWarner Losh 326baabaca3SWarner Losh static void 327baabaca3SWarner Losh nvme_probe_cleanup(struct cam_periph *periph) 328baabaca3SWarner Losh { 329e0ce51cbSWarner Losh 330baabaca3SWarner Losh free(periph->softc, M_CAMXPT); 331baabaca3SWarner Losh } 332baabaca3SWarner Losh 333f24c011bSWarner Losh #if 0 334baabaca3SWarner Losh /* XXX should be used, don't delete */ 335baabaca3SWarner Losh static void 336baabaca3SWarner Losh nvme_find_quirk(struct cam_ed *device) 337baabaca3SWarner Losh { 338baabaca3SWarner Losh struct nvme_quirk_entry *quirk; 339baabaca3SWarner Losh caddr_t match; 340baabaca3SWarner Losh 341baabaca3SWarner Losh match = cam_quirkmatch((caddr_t)&device->nvme_data, 342baabaca3SWarner Losh (caddr_t)nvme_quirk_table, 343baabaca3SWarner Losh nvme_quirk_table_size, 344baabaca3SWarner Losh sizeof(*nvme_quirk_table), nvme_identify_match); 345baabaca3SWarner Losh 346baabaca3SWarner Losh if (match == NULL) 347baabaca3SWarner Losh panic("xpt_find_quirk: device didn't match wildcard entry!!"); 348baabaca3SWarner Losh 349baabaca3SWarner Losh quirk = (struct nvme_quirk_entry *)match; 350baabaca3SWarner Losh device->quirk = quirk; 351baabaca3SWarner Losh if (quirk->quirks & CAM_QUIRK_MAXTAGS) { 352baabaca3SWarner Losh device->mintags = quirk->mintags; 353baabaca3SWarner Losh device->maxtags = quirk->maxtags; 354baabaca3SWarner Losh } 355baabaca3SWarner Losh } 356f24c011bSWarner Losh #endif 357baabaca3SWarner Losh 358baabaca3SWarner Losh static void 359baabaca3SWarner Losh nvme_scan_lun(struct cam_periph *periph, struct cam_path *path, 360baabaca3SWarner Losh cam_flags flags, union ccb *request_ccb) 361baabaca3SWarner Losh { 362baabaca3SWarner Losh struct ccb_pathinq cpi; 363baabaca3SWarner Losh cam_status status; 364baabaca3SWarner Losh struct cam_periph *old_periph; 365baabaca3SWarner Losh int lock; 366baabaca3SWarner Losh 367baabaca3SWarner Losh CAM_DEBUG(path, CAM_DEBUG_TRACE, ("nvme_scan_lun\n")); 368baabaca3SWarner Losh 369762a7f4fSWarner Losh xpt_path_inq(&cpi, path); 370baabaca3SWarner Losh 371baabaca3SWarner Losh if (cpi.ccb_h.status != CAM_REQ_CMP) { 372baabaca3SWarner Losh if (request_ccb != NULL) { 373baabaca3SWarner Losh request_ccb->ccb_h.status = cpi.ccb_h.status; 374baabaca3SWarner Losh xpt_done(request_ccb); 375baabaca3SWarner Losh } 376baabaca3SWarner Losh return; 377baabaca3SWarner Losh } 378baabaca3SWarner Losh 379baabaca3SWarner Losh if (xpt_path_lun_id(path) == CAM_LUN_WILDCARD) { 380baabaca3SWarner Losh CAM_DEBUG(path, CAM_DEBUG_TRACE, ("nvme_scan_lun ignoring bus\n")); 381baabaca3SWarner Losh request_ccb->ccb_h.status = CAM_REQ_CMP; /* XXX signal error ? */ 382baabaca3SWarner Losh xpt_done(request_ccb); 383baabaca3SWarner Losh return; 384baabaca3SWarner Losh } 385baabaca3SWarner Losh 386baabaca3SWarner Losh lock = (xpt_path_owned(path) == 0); 387baabaca3SWarner Losh if (lock) 388baabaca3SWarner Losh xpt_path_lock(path); 389baabaca3SWarner Losh if ((old_periph = cam_periph_find(path, "nvme_probe")) != NULL) { 390baabaca3SWarner Losh if ((old_periph->flags & CAM_PERIPH_INVALID) == 0) { 391baabaca3SWarner Losh nvme_probe_softc *softc; 392baabaca3SWarner Losh 393baabaca3SWarner Losh softc = (nvme_probe_softc *)old_periph->softc; 394baabaca3SWarner Losh TAILQ_INSERT_TAIL(&softc->request_ccbs, 395baabaca3SWarner Losh &request_ccb->ccb_h, periph_links.tqe); 396baabaca3SWarner Losh softc->restart = 1; 397baabaca3SWarner Losh CAM_DEBUG(path, CAM_DEBUG_TRACE, 398baabaca3SWarner Losh ("restarting nvme_probe device\n")); 399baabaca3SWarner Losh } else { 400baabaca3SWarner Losh request_ccb->ccb_h.status = CAM_REQ_CMP_ERR; 401baabaca3SWarner Losh CAM_DEBUG(path, CAM_DEBUG_TRACE, 402baabaca3SWarner Losh ("Failing to restart nvme_probe device\n")); 403baabaca3SWarner Losh xpt_done(request_ccb); 404baabaca3SWarner Losh } 405baabaca3SWarner Losh } else { 406baabaca3SWarner Losh CAM_DEBUG(path, CAM_DEBUG_TRACE, 407baabaca3SWarner Losh ("Adding nvme_probe device\n")); 408baabaca3SWarner Losh status = cam_periph_alloc(nvme_probe_register, NULL, nvme_probe_cleanup, 409baabaca3SWarner Losh nvme_probe_start, "nvme_probe", 410baabaca3SWarner Losh CAM_PERIPH_BIO, 411baabaca3SWarner Losh request_ccb->ccb_h.path, NULL, 0, 412baabaca3SWarner Losh request_ccb); 413baabaca3SWarner Losh 414baabaca3SWarner Losh if (status != CAM_REQ_CMP) { 415baabaca3SWarner Losh xpt_print(path, "xpt_scan_lun: cam_alloc_periph " 416baabaca3SWarner Losh "returned an error, can't continue probe\n"); 417baabaca3SWarner Losh request_ccb->ccb_h.status = status; 418baabaca3SWarner Losh xpt_done(request_ccb); 419baabaca3SWarner Losh } 420baabaca3SWarner Losh } 421baabaca3SWarner Losh if (lock) 422baabaca3SWarner Losh xpt_path_unlock(path); 423baabaca3SWarner Losh } 424baabaca3SWarner Losh 425baabaca3SWarner Losh static struct cam_ed * 426baabaca3SWarner Losh nvme_alloc_device(struct cam_eb *bus, struct cam_et *target, lun_id_t lun_id) 427baabaca3SWarner Losh { 428baabaca3SWarner Losh struct nvme_quirk_entry *quirk; 429baabaca3SWarner Losh struct cam_ed *device; 430baabaca3SWarner Losh 431baabaca3SWarner Losh device = xpt_alloc_device(bus, target, lun_id); 432baabaca3SWarner Losh if (device == NULL) 433baabaca3SWarner Losh return (NULL); 434baabaca3SWarner Losh 435baabaca3SWarner Losh /* 436baabaca3SWarner Losh * Take the default quirk entry until we have inquiry 437baabaca3SWarner Losh * data from nvme and can determine a better quirk to use. 438baabaca3SWarner Losh */ 439baabaca3SWarner Losh quirk = &nvme_quirk_table[nvme_quirk_table_size - 1]; 440baabaca3SWarner Losh device->quirk = (void *)quirk; 441baabaca3SWarner Losh device->mintags = 0; 442baabaca3SWarner Losh device->maxtags = 0; 443baabaca3SWarner Losh device->inq_flags = 0; 444baabaca3SWarner Losh device->queue_flags = 0; 445baabaca3SWarner Losh device->device_id = NULL; /* XXX Need to set this somewhere */ 446baabaca3SWarner Losh device->device_id_len = 0; 447baabaca3SWarner Losh device->serial_num = NULL; /* XXX Need to set this somewhere */ 448baabaca3SWarner Losh device->serial_num_len = 0; 449baabaca3SWarner Losh return (device); 450baabaca3SWarner Losh } 451baabaca3SWarner Losh 452baabaca3SWarner Losh static void 453baabaca3SWarner Losh nvme_device_transport(struct cam_path *path) 454baabaca3SWarner Losh { 455baabaca3SWarner Losh struct ccb_pathinq cpi; 456baabaca3SWarner Losh struct ccb_trans_settings cts; 457baabaca3SWarner Losh /* XXX get data from nvme namespace and other info ??? */ 458baabaca3SWarner Losh 459baabaca3SWarner Losh /* Get transport information from the SIM */ 460762a7f4fSWarner Losh xpt_path_inq(&cpi, path); 461baabaca3SWarner Losh 462baabaca3SWarner Losh path->device->transport = cpi.transport; 463baabaca3SWarner Losh path->device->transport_version = cpi.transport_version; 464baabaca3SWarner Losh 465baabaca3SWarner Losh path->device->protocol = cpi.protocol; 466baabaca3SWarner Losh path->device->protocol_version = cpi.protocol_version; 467baabaca3SWarner Losh 468baabaca3SWarner Losh /* Tell the controller what we think */ 469baabaca3SWarner Losh xpt_setup_ccb(&cts.ccb_h, path, CAM_PRIORITY_NONE); 470baabaca3SWarner Losh cts.ccb_h.func_code = XPT_SET_TRAN_SETTINGS; 471baabaca3SWarner Losh cts.type = CTS_TYPE_CURRENT_SETTINGS; 472baabaca3SWarner Losh cts.transport = path->device->transport; 473baabaca3SWarner Losh cts.transport_version = path->device->transport_version; 474baabaca3SWarner Losh cts.protocol = path->device->protocol; 475baabaca3SWarner Losh cts.protocol_version = path->device->protocol_version; 476baabaca3SWarner Losh cts.proto_specific.valid = 0; 477baabaca3SWarner Losh cts.xport_specific.valid = 0; 478baabaca3SWarner Losh xpt_action((union ccb *)&cts); 479baabaca3SWarner Losh } 480baabaca3SWarner Losh 481baabaca3SWarner Losh static void 482baabaca3SWarner Losh nvme_dev_advinfo(union ccb *start_ccb) 483baabaca3SWarner Losh { 484baabaca3SWarner Losh struct cam_ed *device; 485baabaca3SWarner Losh struct ccb_dev_advinfo *cdai; 486baabaca3SWarner Losh off_t amt; 487baabaca3SWarner Losh 488baabaca3SWarner Losh start_ccb->ccb_h.status = CAM_REQ_INVALID; 489baabaca3SWarner Losh device = start_ccb->ccb_h.path->device; 490baabaca3SWarner Losh cdai = &start_ccb->cdai; 491baabaca3SWarner Losh switch(cdai->buftype) { 492baabaca3SWarner Losh case CDAI_TYPE_SCSI_DEVID: 493baabaca3SWarner Losh if (cdai->flags & CDAI_FLAG_STORE) 494baabaca3SWarner Losh return; 495baabaca3SWarner Losh cdai->provsiz = device->device_id_len; 496baabaca3SWarner Losh if (device->device_id_len == 0) 497baabaca3SWarner Losh break; 498baabaca3SWarner Losh amt = device->device_id_len; 499baabaca3SWarner Losh if (cdai->provsiz > cdai->bufsiz) 500baabaca3SWarner Losh amt = cdai->bufsiz; 501baabaca3SWarner Losh memcpy(cdai->buf, device->device_id, amt); 502baabaca3SWarner Losh break; 503baabaca3SWarner Losh case CDAI_TYPE_SERIAL_NUM: 504baabaca3SWarner Losh if (cdai->flags & CDAI_FLAG_STORE) 505baabaca3SWarner Losh return; 506baabaca3SWarner Losh cdai->provsiz = device->serial_num_len; 507baabaca3SWarner Losh if (device->serial_num_len == 0) 508baabaca3SWarner Losh break; 509baabaca3SWarner Losh amt = device->serial_num_len; 510baabaca3SWarner Losh if (cdai->provsiz > cdai->bufsiz) 511baabaca3SWarner Losh amt = cdai->bufsiz; 512baabaca3SWarner Losh memcpy(cdai->buf, device->serial_num, amt); 513baabaca3SWarner Losh break; 514baabaca3SWarner Losh case CDAI_TYPE_PHYS_PATH: 515baabaca3SWarner Losh if (cdai->flags & CDAI_FLAG_STORE) { 516baabaca3SWarner Losh if (device->physpath != NULL) 517baabaca3SWarner Losh free(device->physpath, M_CAMXPT); 518baabaca3SWarner Losh device->physpath_len = cdai->bufsiz; 519baabaca3SWarner Losh /* Clear existing buffer if zero length */ 520baabaca3SWarner Losh if (cdai->bufsiz == 0) 521baabaca3SWarner Losh break; 522baabaca3SWarner Losh device->physpath = malloc(cdai->bufsiz, M_CAMXPT, M_NOWAIT); 523baabaca3SWarner Losh if (device->physpath == NULL) { 524baabaca3SWarner Losh start_ccb->ccb_h.status = CAM_REQ_ABORTED; 525baabaca3SWarner Losh return; 526baabaca3SWarner Losh } 527baabaca3SWarner Losh memcpy(device->physpath, cdai->buf, cdai->bufsiz); 528baabaca3SWarner Losh } else { 529baabaca3SWarner Losh cdai->provsiz = device->physpath_len; 530baabaca3SWarner Losh if (device->physpath_len == 0) 531baabaca3SWarner Losh break; 532baabaca3SWarner Losh amt = device->physpath_len; 533baabaca3SWarner Losh if (cdai->provsiz > cdai->bufsiz) 534baabaca3SWarner Losh amt = cdai->bufsiz; 535baabaca3SWarner Losh memcpy(cdai->buf, device->physpath, amt); 536baabaca3SWarner Losh } 537baabaca3SWarner Losh break; 5389f8ed7e4SWarner Losh case CDAI_TYPE_NVME_CNTRL: 5399f8ed7e4SWarner Losh if (cdai->flags & CDAI_FLAG_STORE) 5409f8ed7e4SWarner Losh return; 5419f8ed7e4SWarner Losh amt = sizeof(struct nvme_controller_data); 5429f8ed7e4SWarner Losh cdai->provsiz = amt; 5439f8ed7e4SWarner Losh if (amt > cdai->bufsiz) 5449f8ed7e4SWarner Losh amt = cdai->bufsiz; 5459f8ed7e4SWarner Losh memcpy(cdai->buf, device->nvme_cdata, amt); 5469f8ed7e4SWarner Losh break; 5479f8ed7e4SWarner Losh case CDAI_TYPE_NVME_NS: 5489f8ed7e4SWarner Losh if (cdai->flags & CDAI_FLAG_STORE) 5499f8ed7e4SWarner Losh return; 5509f8ed7e4SWarner Losh amt = sizeof(struct nvme_namespace_data); 5519f8ed7e4SWarner Losh cdai->provsiz = amt; 5529f8ed7e4SWarner Losh if (amt > cdai->bufsiz) 5539f8ed7e4SWarner Losh amt = cdai->bufsiz; 5549f8ed7e4SWarner Losh memcpy(cdai->buf, device->nvme_data, amt); 5559f8ed7e4SWarner Losh break; 556baabaca3SWarner Losh default: 557baabaca3SWarner Losh return; 558baabaca3SWarner Losh } 559baabaca3SWarner Losh start_ccb->ccb_h.status = CAM_REQ_CMP; 560baabaca3SWarner Losh 561baabaca3SWarner Losh if (cdai->flags & CDAI_FLAG_STORE) { 562baabaca3SWarner Losh xpt_async(AC_ADVINFO_CHANGED, start_ccb->ccb_h.path, 563baabaca3SWarner Losh (void *)(uintptr_t)cdai->buftype); 564baabaca3SWarner Losh } 565baabaca3SWarner Losh } 566baabaca3SWarner Losh 567baabaca3SWarner Losh static void 568baabaca3SWarner Losh nvme_action(union ccb *start_ccb) 569baabaca3SWarner Losh { 570baabaca3SWarner Losh CAM_DEBUG(start_ccb->ccb_h.path, CAM_DEBUG_TRACE, 571baabaca3SWarner Losh ("nvme_action: func= %#x\n", start_ccb->ccb_h.func_code)); 572baabaca3SWarner Losh 573baabaca3SWarner Losh switch (start_ccb->ccb_h.func_code) { 574baabaca3SWarner Losh case XPT_SCAN_BUS: 575baabaca3SWarner Losh case XPT_SCAN_TGT: 576baabaca3SWarner Losh case XPT_SCAN_LUN: 577baabaca3SWarner Losh nvme_scan_lun(start_ccb->ccb_h.path->periph, 578baabaca3SWarner Losh start_ccb->ccb_h.path, start_ccb->crcn.flags, 579baabaca3SWarner Losh start_ccb); 580baabaca3SWarner Losh break; 581baabaca3SWarner Losh case XPT_DEV_ADVINFO: 582baabaca3SWarner Losh nvme_dev_advinfo(start_ccb); 583baabaca3SWarner Losh break; 584baabaca3SWarner Losh 585baabaca3SWarner Losh default: 586baabaca3SWarner Losh xpt_action_default(start_ccb); 587baabaca3SWarner Losh break; 588baabaca3SWarner Losh } 589baabaca3SWarner Losh } 590baabaca3SWarner Losh 591baabaca3SWarner Losh /* 592baabaca3SWarner Losh * Handle any per-device event notifications that require action by the XPT. 593baabaca3SWarner Losh */ 594baabaca3SWarner Losh static void 595baabaca3SWarner Losh nvme_dev_async(u_int32_t async_code, struct cam_eb *bus, struct cam_et *target, 596baabaca3SWarner Losh struct cam_ed *device, void *async_arg) 597baabaca3SWarner Losh { 598baabaca3SWarner Losh 599baabaca3SWarner Losh /* 600baabaca3SWarner Losh * We only need to handle events for real devices. 601baabaca3SWarner Losh */ 602baabaca3SWarner Losh if (target->target_id == CAM_TARGET_WILDCARD 603baabaca3SWarner Losh || device->lun_id == CAM_LUN_WILDCARD) 604baabaca3SWarner Losh return; 605baabaca3SWarner Losh 606baabaca3SWarner Losh if (async_code == AC_LOST_DEVICE && 607baabaca3SWarner Losh (device->flags & CAM_DEV_UNCONFIGURED) == 0) { 608baabaca3SWarner Losh device->flags |= CAM_DEV_UNCONFIGURED; 609baabaca3SWarner Losh xpt_release_device(device); 610baabaca3SWarner Losh } 611baabaca3SWarner Losh } 612baabaca3SWarner Losh 613baabaca3SWarner Losh static void 614baabaca3SWarner Losh nvme_announce_periph(struct cam_periph *periph) 615baabaca3SWarner Losh { 616baabaca3SWarner Losh struct ccb_pathinq cpi; 617baabaca3SWarner Losh struct ccb_trans_settings cts; 618baabaca3SWarner Losh struct cam_path *path = periph->path; 6195e8a39f6SWarner Losh struct ccb_trans_settings_nvme *nvmex; 620baabaca3SWarner Losh 621baabaca3SWarner Losh cam_periph_assert(periph, MA_OWNED); 622baabaca3SWarner Losh 6235e8a39f6SWarner Losh /* Ask the SIM for connection details */ 624baabaca3SWarner Losh xpt_setup_ccb(&cts.ccb_h, path, CAM_PRIORITY_NORMAL); 625baabaca3SWarner Losh cts.ccb_h.func_code = XPT_GET_TRAN_SETTINGS; 626baabaca3SWarner Losh cts.type = CTS_TYPE_CURRENT_SETTINGS; 627baabaca3SWarner Losh xpt_action((union ccb*)&cts); 628baabaca3SWarner Losh if ((cts.ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_CMP) 629baabaca3SWarner Losh return; 6305e8a39f6SWarner Losh nvmex = &cts.xport_specific.nvme; 6315e8a39f6SWarner Losh 632baabaca3SWarner Losh /* Ask the SIM for its base transfer speed */ 633762a7f4fSWarner Losh xpt_path_inq(&cpi, periph->path); 6345e8a39f6SWarner Losh printf("%s%d: nvme version %d.%d x%d (max x%d) lanes PCIe Gen%d (max Gen%d) link", 6355e8a39f6SWarner Losh periph->periph_name, periph->unit_number, 6365e8a39f6SWarner Losh NVME_MAJOR(nvmex->spec), 6375e8a39f6SWarner Losh NVME_MINOR(nvmex->spec), 6385e8a39f6SWarner Losh nvmex->lanes, nvmex->max_lanes, 6395e8a39f6SWarner Losh nvmex->speed, nvmex->max_speed); 640baabaca3SWarner Losh printf("\n"); 641baabaca3SWarner Losh } 64208f13879SWarner Losh 64308f13879SWarner Losh static void 64408f13879SWarner Losh nvme_proto_announce(struct cam_ed *device) 64508f13879SWarner Losh { 6465e8a39f6SWarner Losh struct sbuf sb; 6475e8a39f6SWarner Losh char buffer[120]; 6484e3b2744SWarner Losh 6495e8a39f6SWarner Losh sbuf_new(&sb, buffer, sizeof(buffer), SBUF_FIXEDLEN); 6505e8a39f6SWarner Losh nvme_print_ident(device->nvme_cdata, device->nvme_data, &sb); 6515e8a39f6SWarner Losh sbuf_finish(&sb); 6525e8a39f6SWarner Losh sbuf_putbuf(&sb); 65308f13879SWarner Losh } 65408f13879SWarner Losh 65508f13879SWarner Losh static void 65608f13879SWarner Losh nvme_proto_denounce(struct cam_ed *device) 65708f13879SWarner Losh { 6584e3b2744SWarner Losh 6595e8a39f6SWarner Losh nvme_proto_announce(device); 66008f13879SWarner Losh } 66108f13879SWarner Losh 66208f13879SWarner Losh static void 66308f13879SWarner Losh nvme_proto_debug_out(union ccb *ccb) 66408f13879SWarner Losh { 66508f13879SWarner Losh char cdb_str[(sizeof(struct nvme_command) * 3) + 1]; 66608f13879SWarner Losh 66708f13879SWarner Losh if (ccb->ccb_h.func_code != XPT_NVME_IO) 66808f13879SWarner Losh return; 66908f13879SWarner Losh 67008f13879SWarner Losh CAM_DEBUG(ccb->ccb_h.path, 67108f13879SWarner Losh CAM_DEBUG_CDB,("%s. NCB: %s\n", nvme_op_string(&ccb->nvmeio.cmd), 67208f13879SWarner Losh nvme_cmd_string(&ccb->nvmeio.cmd, cdb_str, sizeof(cdb_str)))); 67308f13879SWarner Losh } 67408f13879SWarner Losh 675