1 /*- 2 * Copyright (c) 2016 Netflix, Inc. 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions 6 * are met: 7 * 1. Redistributions of source code must retain the above copyright 8 * notice, this list of conditions and the following disclaimer, 9 * without modification, immediately at the beginning of the file. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 15 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 16 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 17 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 18 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 19 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 20 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 21 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 23 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 24 */ 25 26 #include <sys/cdefs.h> 27 __FBSDID("$FreeBSD$"); 28 29 #include <sys/param.h> 30 #include <sys/systm.h> 31 #include <sys/buf.h> 32 #include <sys/bus.h> 33 #include <sys/conf.h> 34 #include <sys/ioccom.h> 35 #include <sys/malloc.h> 36 #include <sys/proc.h> 37 #include <sys/smp.h> 38 39 #include <cam/cam.h> 40 #include <cam/cam_ccb.h> 41 #include <cam/cam_sim.h> 42 #include <cam/cam_xpt_sim.h> 43 #include <cam/cam_debug.h> 44 45 #include <dev/pci/pcivar.h> 46 #include <dev/pci/pcireg.h> 47 48 #include "nvme_private.h" 49 50 #define ccb_accb_ptr spriv_ptr0 51 #define ccb_ctrlr_ptr spriv_ptr1 52 static void nvme_sim_action(struct cam_sim *sim, union ccb *ccb); 53 static void nvme_sim_poll(struct cam_sim *sim); 54 55 #define sim2softc(sim) ((struct nvme_sim_softc *)cam_sim_softc(sim)) 56 #define sim2ctrlr(sim) (sim2softc(sim)->s_ctrlr) 57 58 struct nvme_sim_softc 59 { 60 struct nvme_controller *s_ctrlr; 61 struct cam_sim *s_sim; 62 struct cam_path *s_path; 63 }; 64 65 static void 66 nvme_sim_nvmeio_done(void *ccb_arg, const struct nvme_completion *cpl) 67 { 68 union ccb *ccb = (union ccb *)ccb_arg; 69 70 /* 71 * Let the periph know the completion, and let it sort out what 72 * it means. Make our best guess, though for the status code. 73 */ 74 memcpy(&ccb->nvmeio.cpl, cpl, sizeof(*cpl)); 75 ccb->ccb_h.status &= ~CAM_SIM_QUEUED; 76 if (nvme_completion_is_error(cpl)) { 77 ccb->ccb_h.status = CAM_REQ_CMP_ERR; 78 xpt_done(ccb); 79 } else { 80 ccb->ccb_h.status = CAM_REQ_CMP; 81 xpt_done_direct(ccb); 82 } 83 } 84 85 static void 86 nvme_sim_nvmeio(struct cam_sim *sim, union ccb *ccb) 87 { 88 struct ccb_nvmeio *nvmeio = &ccb->nvmeio; 89 struct nvme_request *req; 90 void *payload; 91 uint32_t size; 92 struct nvme_controller *ctrlr; 93 94 ctrlr = sim2ctrlr(sim); 95 payload = nvmeio->data_ptr; 96 size = nvmeio->dxfer_len; 97 /* SG LIST ??? */ 98 if ((nvmeio->ccb_h.flags & CAM_DATA_MASK) == CAM_DATA_BIO) 99 req = nvme_allocate_request_bio((struct bio *)payload, 100 nvme_sim_nvmeio_done, ccb); 101 else if ((nvmeio->ccb_h.flags & CAM_DATA_SG) == CAM_DATA_SG) 102 req = nvme_allocate_request_ccb(ccb, nvme_sim_nvmeio_done, ccb); 103 else if (payload == NULL) 104 req = nvme_allocate_request_null(nvme_sim_nvmeio_done, ccb); 105 else 106 req = nvme_allocate_request_vaddr(payload, size, 107 nvme_sim_nvmeio_done, ccb); 108 109 if (req == NULL) { 110 nvmeio->ccb_h.status = CAM_RESRC_UNAVAIL; 111 xpt_done(ccb); 112 return; 113 } 114 ccb->ccb_h.status |= CAM_SIM_QUEUED; 115 116 memcpy(&req->cmd, &ccb->nvmeio.cmd, sizeof(ccb->nvmeio.cmd)); 117 118 if (ccb->ccb_h.func_code == XPT_NVME_IO) 119 nvme_ctrlr_submit_io_request(ctrlr, req); 120 else 121 nvme_ctrlr_submit_admin_request(ctrlr, req); 122 } 123 124 static uint32_t 125 nvme_link_kBps(struct nvme_controller *ctrlr) 126 { 127 uint32_t speed, lanes, link[] = { 1, 250000, 500000, 985000, 1970000 }; 128 uint32_t status; 129 130 status = pcie_read_config(ctrlr->dev, PCIER_LINK_STA, 2); 131 speed = status & PCIEM_LINK_STA_SPEED; 132 lanes = (status & PCIEM_LINK_STA_WIDTH) >> 4; 133 /* 134 * Failsafe on link speed indicator. If it is insane report the number of 135 * lanes as the speed. Not 100% accurate, but may be diagnostic. 136 */ 137 if (speed >= nitems(link)) 138 speed = 0; 139 return link[speed] * lanes; 140 } 141 142 static void 143 nvme_sim_action(struct cam_sim *sim, union ccb *ccb) 144 { 145 struct nvme_controller *ctrlr; 146 147 CAM_DEBUG(ccb->ccb_h.path, CAM_DEBUG_TRACE, 148 ("nvme_sim_action: func= %#x\n", 149 ccb->ccb_h.func_code)); 150 151 ctrlr = sim2ctrlr(sim); 152 153 switch (ccb->ccb_h.func_code) { 154 case XPT_CALC_GEOMETRY: /* Calculate Geometry Totally nuts ? XXX */ 155 /* 156 * Only meaningful for old-school SCSI disks since only the SCSI 157 * da driver generates them. Reject all these that slip through. 158 */ 159 /*FALLTHROUGH*/ 160 case XPT_ABORT: /* Abort the specified CCB */ 161 ccb->ccb_h.status = CAM_REQ_INVALID; 162 break; 163 case XPT_SET_TRAN_SETTINGS: 164 /* 165 * NVMe doesn't really have different transfer settings, but 166 * other parts of CAM think failure here is a big deal. 167 */ 168 ccb->ccb_h.status = CAM_REQ_CMP; 169 break; 170 case XPT_PATH_INQ: /* Path routing inquiry */ 171 { 172 struct ccb_pathinq *cpi = &ccb->cpi; 173 device_t dev = ctrlr->dev; 174 175 /* 176 * For devices that are reported as children of the AHCI 177 * controller, which has no access to the config space for this 178 * controller, report the AHCI controller's data. 179 */ 180 if (ctrlr->quirks & QUIRK_AHCI) 181 dev = device_get_parent(dev); 182 cpi->version_num = 1; 183 cpi->hba_inquiry = 0; 184 cpi->target_sprt = 0; 185 cpi->hba_misc = PIM_UNMAPPED | PIM_NOSCAN; 186 cpi->hba_eng_cnt = 0; 187 cpi->max_target = 0; 188 cpi->max_lun = ctrlr->cdata.nn; 189 cpi->maxio = ctrlr->max_xfer_size; 190 cpi->initiator_id = 0; 191 cpi->bus_id = cam_sim_bus(sim); 192 cpi->base_transfer_speed = nvme_link_kBps(ctrlr); 193 strlcpy(cpi->sim_vid, "FreeBSD", SIM_IDLEN); 194 strlcpy(cpi->hba_vid, "NVMe", HBA_IDLEN); 195 strlcpy(cpi->dev_name, cam_sim_name(sim), DEV_IDLEN); 196 cpi->unit_number = cam_sim_unit(sim); 197 cpi->transport = XPORT_NVME; /* XXX XPORT_PCIE ? */ 198 cpi->transport_version = nvme_mmio_read_4(ctrlr, vs); 199 cpi->protocol = PROTO_NVME; 200 cpi->protocol_version = nvme_mmio_read_4(ctrlr, vs); 201 cpi->xport_specific.nvme.nsid = xpt_path_lun_id(ccb->ccb_h.path); 202 cpi->xport_specific.nvme.domain = pci_get_domain(dev); 203 cpi->xport_specific.nvme.bus = pci_get_bus(dev); 204 cpi->xport_specific.nvme.slot = pci_get_slot(dev); 205 cpi->xport_specific.nvme.function = pci_get_function(dev); 206 cpi->xport_specific.nvme.extra = 0; 207 strncpy(cpi->xport_specific.nvme.dev_name, device_get_nameunit(dev), 208 sizeof(cpi->xport_specific.nvme.dev_name)); 209 cpi->hba_vendor = pci_get_vendor(dev); 210 cpi->hba_device = pci_get_device(dev); 211 cpi->hba_subvendor = pci_get_subvendor(dev); 212 cpi->hba_subdevice = pci_get_subdevice(dev); 213 cpi->ccb_h.status = CAM_REQ_CMP; 214 break; 215 } 216 case XPT_GET_TRAN_SETTINGS: /* Get transport settings */ 217 { 218 struct ccb_trans_settings *cts; 219 struct ccb_trans_settings_nvme *nvmep; 220 struct ccb_trans_settings_nvme *nvmex; 221 device_t dev; 222 uint32_t status, caps, flags; 223 224 dev = ctrlr->dev; 225 cts = &ccb->cts; 226 nvmex = &cts->xport_specific.nvme; 227 nvmep = &cts->proto_specific.nvme; 228 229 nvmex->spec = nvme_mmio_read_4(ctrlr, vs); 230 nvmex->valid = CTS_NVME_VALID_SPEC; 231 if ((ctrlr->quirks & QUIRK_AHCI) == 0) { 232 /* AHCI redirect makes it impossible to query */ 233 status = pcie_read_config(dev, PCIER_LINK_STA, 2); 234 caps = pcie_read_config(dev, PCIER_LINK_CAP, 2); 235 flags = pcie_read_config(dev, PCIER_FLAGS, 2); 236 if ((flags & PCIEM_FLAGS_TYPE) == PCIEM_TYPE_ENDPOINT) { 237 nvmex->valid |= CTS_NVME_VALID_LINK; 238 nvmex->speed = status & PCIEM_LINK_STA_SPEED; 239 nvmex->lanes = (status & PCIEM_LINK_STA_WIDTH) >> 4; 240 nvmex->max_speed = caps & PCIEM_LINK_CAP_MAX_SPEED; 241 nvmex->max_lanes = (caps & PCIEM_LINK_CAP_MAX_WIDTH) >> 4; 242 } 243 } 244 245 /* XXX these should be something else maybe ? */ 246 nvmep->valid = 1; 247 nvmep->spec = nvmex->spec; 248 249 cts->transport = XPORT_NVME; 250 cts->protocol = PROTO_NVME; 251 cts->ccb_h.status = CAM_REQ_CMP; 252 break; 253 } 254 case XPT_TERM_IO: /* Terminate the I/O process */ 255 /* 256 * every driver handles this, but nothing generates it. Assume 257 * it's OK to just say 'that worked'. 258 */ 259 /*FALLTHROUGH*/ 260 case XPT_RESET_DEV: /* Bus Device Reset the specified device */ 261 case XPT_RESET_BUS: /* Reset the specified bus */ 262 /* 263 * NVMe doesn't really support physically resetting the bus. It's part 264 * of the bus scanning dance, so return sucess to tell the process to 265 * proceed. 266 */ 267 ccb->ccb_h.status = CAM_REQ_CMP; 268 break; 269 case XPT_NVME_IO: /* Execute the requested I/O operation */ 270 case XPT_NVME_ADMIN: /* or Admin operation */ 271 if (ctrlr->is_failed) { 272 ccb->ccb_h.status = CAM_DEV_NOT_THERE; 273 break; 274 } 275 nvme_sim_nvmeio(sim, ccb); 276 return; /* no done */ 277 default: 278 ccb->ccb_h.status = CAM_REQ_INVALID; 279 break; 280 } 281 xpt_done(ccb); 282 } 283 284 static void 285 nvme_sim_poll(struct cam_sim *sim) 286 { 287 288 nvme_ctrlr_poll(sim2ctrlr(sim)); 289 } 290 291 static void * 292 nvme_sim_new_controller(struct nvme_controller *ctrlr) 293 { 294 struct nvme_sim_softc *sc; 295 struct cam_devq *devq; 296 int max_trans; 297 298 max_trans = ctrlr->max_hw_pend_io; 299 devq = cam_simq_alloc(max_trans); 300 if (devq == NULL) 301 return (NULL); 302 303 sc = malloc(sizeof(*sc), M_NVME, M_ZERO | M_WAITOK); 304 sc->s_ctrlr = ctrlr; 305 306 sc->s_sim = cam_sim_alloc(nvme_sim_action, nvme_sim_poll, 307 "nvme", sc, device_get_unit(ctrlr->dev), 308 NULL, max_trans, max_trans, devq); 309 if (sc->s_sim == NULL) { 310 printf("Failed to allocate a sim\n"); 311 cam_simq_free(devq); 312 goto err1; 313 } 314 if (xpt_bus_register(sc->s_sim, ctrlr->dev, 0) != CAM_SUCCESS) { 315 printf("Failed to create a bus\n"); 316 goto err2; 317 } 318 if (xpt_create_path(&sc->s_path, /*periph*/NULL, cam_sim_path(sc->s_sim), 319 CAM_TARGET_WILDCARD, CAM_LUN_WILDCARD) != CAM_REQ_CMP) { 320 printf("Failed to create a path\n"); 321 goto err3; 322 } 323 324 return (sc); 325 326 err3: 327 xpt_bus_deregister(cam_sim_path(sc->s_sim)); 328 err2: 329 cam_sim_free(sc->s_sim, /*free_devq*/TRUE); 330 err1: 331 free(sc, M_NVME); 332 return (NULL); 333 } 334 335 static void * 336 nvme_sim_ns_change(struct nvme_namespace *ns, void *sc_arg) 337 { 338 struct nvme_sim_softc *sc = sc_arg; 339 union ccb *ccb; 340 341 ccb = xpt_alloc_ccb_nowait(); 342 if (ccb == NULL) { 343 printf("unable to alloc CCB for rescan\n"); 344 return (NULL); 345 } 346 347 /* 348 * We map the NVMe namespace idea onto the CAM unit LUN. For 349 * each new namespace, we create a new CAM path for it. We then 350 * rescan the path to get it to enumerate. 351 */ 352 if (xpt_create_path(&ccb->ccb_h.path, /*periph*/NULL, 353 cam_sim_path(sc->s_sim), 0, ns->id) != CAM_REQ_CMP) { 354 printf("unable to create path for rescan\n"); 355 xpt_free_ccb(ccb); 356 return (NULL); 357 } 358 xpt_rescan(ccb); 359 360 return (sc_arg); 361 } 362 363 static void 364 nvme_sim_controller_fail(void *ctrlr_arg) 365 { 366 struct nvme_sim_softc *sc = ctrlr_arg; 367 368 xpt_async(AC_LOST_DEVICE, sc->s_path, NULL); 369 xpt_free_path(sc->s_path); 370 xpt_bus_deregister(cam_sim_path(sc->s_sim)); 371 cam_sim_free(sc->s_sim, /*free_devq*/TRUE); 372 free(sc, M_NVME); 373 } 374 375 struct nvme_consumer *consumer_cookie; 376 377 static void 378 nvme_sim_init(void) 379 { 380 if (nvme_use_nvd) 381 return; 382 383 consumer_cookie = nvme_register_consumer(nvme_sim_ns_change, 384 nvme_sim_new_controller, NULL, nvme_sim_controller_fail); 385 } 386 387 SYSINIT(nvme_sim_register, SI_SUB_DRIVERS, SI_ORDER_ANY, 388 nvme_sim_init, NULL); 389 390 static void 391 nvme_sim_uninit(void) 392 { 393 if (nvme_use_nvd) 394 return; 395 /* XXX Cleanup */ 396 397 nvme_unregister_consumer(consumer_cookie); 398 } 399 400 SYSUNINIT(nvme_sim_unregister, SI_SUB_DRIVERS, SI_ORDER_ANY, 401 nvme_sim_uninit, NULL); 402