2 * Copyright (C) 2012 Intel Corporation
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 * 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.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
30 #include <sys/param.h>
35 #include <sys/fcntl.h>
36 #include <sys/ioccom.h>
37 #include <sys/module.h>
40 #include <dev/pci/pcivar.h>
42 #include "nvme_private.h"
45 nvme_ns_ioctl(struct cdev *cdev, u_long cmd, caddr_t arg, int flag,
48 struct nvme_completion_poll_status status;
49 struct nvme_namespace *ns;
50 struct nvme_controller *ctrlr;
56 case NVME_IDENTIFY_NAMESPACE:
59 * Don't refresh data on Chatham, since Chatham returns
60 * garbage on IDENTIFY anyways.
62 if (pci_get_devid(ctrlr->dev) == CHATHAM_PCI_ID) {
63 memcpy(arg, &ns->data, sizeof(ns->data));
67 /* Refresh data before returning to user. */
69 nvme_ctrlr_cmd_identify_namespace(ctrlr, ns->id, &ns->data,
70 nvme_completion_poll_cb, &status);
71 while (status.done == FALSE)
73 if (nvme_completion_is_error(&status.cpl))
75 memcpy(arg, &ns->data, sizeof(ns->data));
79 nvme_ns_test(ns, cmd, arg);
82 *(off_t *)arg = (off_t)nvme_ns_get_size(ns);
85 *(u_int *)arg = nvme_ns_get_sector_size(ns);
95 nvme_ns_open(struct cdev *dev __unused, int flags, int fmt __unused,
101 error = securelevel_gt(td->td_ucred, 0);
107 nvme_ns_close(struct cdev *dev __unused, int flags, int fmt __unused,
115 nvme_ns_strategy_done(void *arg, const struct nvme_completion *cpl)
117 struct bio *bp = arg;
120 * TODO: add more extensive translation of NVMe status codes
121 * to different bio error codes (i.e. EIO, EINVAL, etc.)
123 if (nvme_completion_is_error(cpl)) {
125 bp->bio_flags |= BIO_ERROR;
126 bp->bio_resid = bp->bio_bcount;
134 nvme_ns_strategy(struct bio *bp)
136 struct nvme_namespace *ns;
139 ns = bp->bio_dev->si_drv1;
140 err = nvme_ns_bio_process(ns, bp, nvme_ns_strategy_done);
144 bp->bio_flags |= BIO_ERROR;
145 bp->bio_resid = bp->bio_bcount;
151 static struct cdevsw nvme_ns_cdevsw = {
152 .d_version = D_VERSION,
153 #ifdef NVME_UNMAPPED_BIO_SUPPORT
154 .d_flags = D_DISK | D_UNMAPPED_IO,
156 .d_write = physwrite,
159 .d_read = nvme_ns_physio,
160 .d_write = nvme_ns_physio,
162 .d_open = nvme_ns_open,
163 .d_close = nvme_ns_close,
164 .d_strategy = nvme_ns_strategy,
165 .d_ioctl = nvme_ns_ioctl
169 nvme_ns_get_max_io_xfer_size(struct nvme_namespace *ns)
171 return ns->ctrlr->max_xfer_size;
175 nvme_ns_get_sector_size(struct nvme_namespace *ns)
177 return (1 << ns->data.lbaf[0].lbads);
181 nvme_ns_get_num_sectors(struct nvme_namespace *ns)
183 return (ns->data.nsze);
187 nvme_ns_get_size(struct nvme_namespace *ns)
189 return (nvme_ns_get_num_sectors(ns) * nvme_ns_get_sector_size(ns));
193 nvme_ns_get_flags(struct nvme_namespace *ns)
199 nvme_ns_get_serial_number(struct nvme_namespace *ns)
201 return ((const char *)ns->ctrlr->cdata.sn);
205 nvme_ns_get_model_number(struct nvme_namespace *ns)
207 return ((const char *)ns->ctrlr->cdata.mn);
210 const struct nvme_namespace_data *
211 nvme_ns_get_data(struct nvme_namespace *ns)
218 nvme_ns_bio_done(void *arg, const struct nvme_completion *status)
220 struct bio *bp = arg;
221 nvme_cb_fn_t bp_cb_fn;
223 bp_cb_fn = bp->bio_driver1;
226 free(bp->bio_driver2, M_NVME);
228 bp_cb_fn(bp, status);
232 nvme_ns_bio_process(struct nvme_namespace *ns, struct bio *bp,
235 struct nvme_dsm_range *dsm_range;
238 bp->bio_driver1 = cb_fn;
240 switch (bp->bio_cmd) {
242 err = nvme_ns_cmd_read_bio(ns, bp, nvme_ns_bio_done, bp);
245 err = nvme_ns_cmd_write_bio(ns, bp, nvme_ns_bio_done, bp);
248 err = nvme_ns_cmd_flush(ns, nvme_ns_bio_done, bp);
252 malloc(sizeof(struct nvme_dsm_range), M_NVME,
255 bp->bio_bcount/nvme_ns_get_sector_size(ns);
256 dsm_range->starting_lba =
257 bp->bio_offset/nvme_ns_get_sector_size(ns);
258 bp->bio_driver2 = dsm_range;
259 err = nvme_ns_cmd_deallocate(ns, dsm_range, 1,
260 nvme_ns_bio_done, bp);
262 free(dsm_range, M_NVME);
274 nvme_ns_populate_chatham_data(struct nvme_namespace *ns)
276 struct nvme_controller *ctrlr;
277 struct nvme_namespace_data *nsdata;
282 nsdata->nsze = ctrlr->chatham_lbas;
283 nsdata->ncap = ctrlr->chatham_lbas;
284 nsdata->nuse = ctrlr->chatham_lbas;
286 /* Chatham2 doesn't support thin provisioning. */
287 nsdata->nsfeat.thin_prov = 0;
289 /* Set LBA size to 512 bytes. */
290 nsdata->lbaf[0].lbads = 9;
292 #endif /* CHATHAM2 */
295 nvme_ns_construct(struct nvme_namespace *ns, uint16_t id,
296 struct nvme_controller *ctrlr)
298 struct nvme_completion_poll_status status;
304 if (pci_get_devid(ctrlr->dev) == CHATHAM_PCI_ID)
305 nvme_ns_populate_chatham_data(ns);
309 nvme_ctrlr_cmd_identify_namespace(ctrlr, id, &ns->data,
310 nvme_completion_poll_cb, &status);
311 while (status.done == FALSE)
313 if (nvme_completion_is_error(&status.cpl)) {
314 nvme_printf(ctrlr, "nvme_identify_namespace failed\n");
321 if (ctrlr->cdata.oncs.dsm)
322 ns->flags |= NVME_NS_DEALLOCATE_SUPPORTED;
324 if (ctrlr->cdata.vwc.present)
325 ns->flags |= NVME_NS_FLUSH_SUPPORTED;
328 * cdev may have already been created, if we are reconstructing the
329 * namespace after a controller-level reset.
331 if (ns->cdev != NULL)
335 * MAKEDEV_ETERNAL was added in r210923, for cdevs that will never
336 * be destroyed. This avoids refcounting on the cdev object.
337 * That should be OK case here, as long as we're not supporting PCIe
338 * surprise removal nor namespace deletion.
340 #ifdef MAKEDEV_ETERNAL_KLD
341 ns->cdev = make_dev_credf(MAKEDEV_ETERNAL_KLD, &nvme_ns_cdevsw, 0,
342 NULL, UID_ROOT, GID_WHEEL, 0600, "nvme%dns%d",
343 device_get_unit(ctrlr->dev), ns->id);
345 ns->cdev = make_dev_credf(0, &nvme_ns_cdevsw, 0,
346 NULL, UID_ROOT, GID_WHEEL, 0600, "nvme%dns%d",
347 device_get_unit(ctrlr->dev), ns->id);
350 if (ns->cdev != NULL)
351 ns->cdev->si_drv1 = ns;
356 void nvme_ns_destruct(struct nvme_namespace *ns)
359 if (ns->cdev != NULL)
360 destroy_dev(ns->cdev);