2 * NVM Express device driver
3 * Copyright (c) 2011-2014, Intel Corporation.
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms and conditions of the GNU General Public License,
7 * version 2, as published by the Free Software Foundation.
9 * This program is distributed in the hope it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15 #include <linux/blkdev.h>
16 #include <linux/blk-mq.h>
17 #include <linux/delay.h>
18 #include <linux/errno.h>
19 #include <linux/hdreg.h>
20 #include <linux/kernel.h>
21 #include <linux/module.h>
22 #include <linux/list_sort.h>
23 #include <linux/slab.h>
24 #include <linux/types.h>
26 #include <linux/ptrace.h>
27 #include <linux/nvme_ioctl.h>
28 #include <linux/t10-pi.h>
29 #include <linux/pm_qos.h>
30 #include <asm/unaligned.h>
35 #define NVME_MINORS (1U << MINORBITS)
37 unsigned char admin_timeout = 60;
38 module_param(admin_timeout, byte, 0644);
39 MODULE_PARM_DESC(admin_timeout, "timeout in seconds for admin commands");
40 EXPORT_SYMBOL_GPL(admin_timeout);
42 unsigned char nvme_io_timeout = 30;
43 module_param_named(io_timeout, nvme_io_timeout, byte, 0644);
44 MODULE_PARM_DESC(io_timeout, "timeout in seconds for I/O");
45 EXPORT_SYMBOL_GPL(nvme_io_timeout);
47 static unsigned char shutdown_timeout = 5;
48 module_param(shutdown_timeout, byte, 0644);
49 MODULE_PARM_DESC(shutdown_timeout, "timeout in seconds for controller shutdown");
51 static u8 nvme_max_retries = 5;
52 module_param_named(max_retries, nvme_max_retries, byte, 0644);
53 MODULE_PARM_DESC(max_retries, "max number of retries a command may have");
55 static int nvme_char_major;
56 module_param(nvme_char_major, int, 0);
58 static unsigned long default_ps_max_latency_us = 100000;
59 module_param(default_ps_max_latency_us, ulong, 0644);
60 MODULE_PARM_DESC(default_ps_max_latency_us,
61 "max power saving latency for new devices; use PM QOS to change per device");
63 static bool force_apst;
64 module_param(force_apst, bool, 0644);
65 MODULE_PARM_DESC(force_apst, "allow APST for newly enumerated devices even if quirked off");
68 module_param(streams, bool, 0644);
69 MODULE_PARM_DESC(streams, "turn on support for Streams write directives");
71 struct workqueue_struct *nvme_wq;
72 EXPORT_SYMBOL_GPL(nvme_wq);
74 static LIST_HEAD(nvme_ctrl_list);
75 static DEFINE_SPINLOCK(dev_list_lock);
77 static struct class *nvme_class;
79 int nvme_reset_ctrl(struct nvme_ctrl *ctrl)
81 if (!nvme_change_ctrl_state(ctrl, NVME_CTRL_RESETTING))
83 if (!queue_work(nvme_wq, &ctrl->reset_work))
87 EXPORT_SYMBOL_GPL(nvme_reset_ctrl);
89 static int nvme_reset_ctrl_sync(struct nvme_ctrl *ctrl)
93 ret = nvme_reset_ctrl(ctrl);
95 flush_work(&ctrl->reset_work);
99 static blk_status_t nvme_error_status(struct request *req)
101 switch (nvme_req(req)->status & 0x7ff) {
102 case NVME_SC_SUCCESS:
104 case NVME_SC_CAP_EXCEEDED:
105 return BLK_STS_NOSPC;
106 case NVME_SC_ONCS_NOT_SUPPORTED:
107 return BLK_STS_NOTSUPP;
108 case NVME_SC_WRITE_FAULT:
109 case NVME_SC_READ_ERROR:
110 case NVME_SC_UNWRITTEN_BLOCK:
111 return BLK_STS_MEDIUM;
113 return BLK_STS_IOERR;
117 static inline bool nvme_req_needs_retry(struct request *req)
119 if (blk_noretry_request(req))
121 if (nvme_req(req)->status & NVME_SC_DNR)
123 if (jiffies - req->start_time >= req->timeout)
125 if (nvme_req(req)->retries >= nvme_max_retries)
130 void nvme_complete_rq(struct request *req)
132 if (unlikely(nvme_req(req)->status && nvme_req_needs_retry(req))) {
133 nvme_req(req)->retries++;
134 blk_mq_requeue_request(req, true);
138 blk_mq_end_request(req, nvme_error_status(req));
140 EXPORT_SYMBOL_GPL(nvme_complete_rq);
142 void nvme_cancel_request(struct request *req, void *data, bool reserved)
146 if (!blk_mq_request_started(req))
149 dev_dbg_ratelimited(((struct nvme_ctrl *) data)->device,
150 "Cancelling I/O %d", req->tag);
152 status = NVME_SC_ABORT_REQ;
153 if (blk_queue_dying(req->q))
154 status |= NVME_SC_DNR;
155 nvme_req(req)->status = status;
156 blk_mq_complete_request(req);
159 EXPORT_SYMBOL_GPL(nvme_cancel_request);
161 bool nvme_change_ctrl_state(struct nvme_ctrl *ctrl,
162 enum nvme_ctrl_state new_state)
164 enum nvme_ctrl_state old_state;
165 bool changed = false;
167 spin_lock_irq(&ctrl->lock);
169 old_state = ctrl->state;
174 case NVME_CTRL_RESETTING:
175 case NVME_CTRL_RECONNECTING:
182 case NVME_CTRL_RESETTING:
192 case NVME_CTRL_RECONNECTING:
201 case NVME_CTRL_DELETING:
204 case NVME_CTRL_RESETTING:
205 case NVME_CTRL_RECONNECTING:
214 case NVME_CTRL_DELETING:
226 ctrl->state = new_state;
228 spin_unlock_irq(&ctrl->lock);
232 EXPORT_SYMBOL_GPL(nvme_change_ctrl_state);
234 static void nvme_free_ns(struct kref *kref)
236 struct nvme_ns *ns = container_of(kref, struct nvme_ns, kref);
239 nvme_nvm_unregister(ns);
242 spin_lock(&dev_list_lock);
243 ns->disk->private_data = NULL;
244 spin_unlock(&dev_list_lock);
248 ida_simple_remove(&ns->ctrl->ns_ida, ns->instance);
249 nvme_put_ctrl(ns->ctrl);
253 static void nvme_put_ns(struct nvme_ns *ns)
255 kref_put(&ns->kref, nvme_free_ns);
258 static struct nvme_ns *nvme_get_ns_from_disk(struct gendisk *disk)
262 spin_lock(&dev_list_lock);
263 ns = disk->private_data;
265 if (!kref_get_unless_zero(&ns->kref))
267 if (!try_module_get(ns->ctrl->ops->module))
270 spin_unlock(&dev_list_lock);
275 kref_put(&ns->kref, nvme_free_ns);
277 spin_unlock(&dev_list_lock);
281 struct request *nvme_alloc_request(struct request_queue *q,
282 struct nvme_command *cmd, unsigned int flags, int qid)
284 unsigned op = nvme_is_write(cmd) ? REQ_OP_DRV_OUT : REQ_OP_DRV_IN;
287 if (qid == NVME_QID_ANY) {
288 req = blk_mq_alloc_request(q, op, flags);
290 req = blk_mq_alloc_request_hctx(q, op, flags,
296 req->cmd_flags |= REQ_FAILFAST_DRIVER;
297 nvme_req(req)->cmd = cmd;
301 EXPORT_SYMBOL_GPL(nvme_alloc_request);
303 static int nvme_toggle_streams(struct nvme_ctrl *ctrl, bool enable)
305 struct nvme_command c;
307 memset(&c, 0, sizeof(c));
309 c.directive.opcode = nvme_admin_directive_send;
310 c.directive.nsid = cpu_to_le32(0xffffffff);
311 c.directive.doper = NVME_DIR_SND_ID_OP_ENABLE;
312 c.directive.dtype = NVME_DIR_IDENTIFY;
313 c.directive.tdtype = NVME_DIR_STREAMS;
314 c.directive.endir = enable ? NVME_DIR_ENDIR : 0;
316 return nvme_submit_sync_cmd(ctrl->admin_q, &c, NULL, 0);
319 static int nvme_disable_streams(struct nvme_ctrl *ctrl)
321 return nvme_toggle_streams(ctrl, false);
324 static int nvme_enable_streams(struct nvme_ctrl *ctrl)
326 return nvme_toggle_streams(ctrl, true);
329 static int nvme_get_stream_params(struct nvme_ctrl *ctrl,
330 struct streams_directive_params *s, u32 nsid)
332 struct nvme_command c;
334 memset(&c, 0, sizeof(c));
335 memset(s, 0, sizeof(*s));
337 c.directive.opcode = nvme_admin_directive_recv;
338 c.directive.nsid = cpu_to_le32(nsid);
339 c.directive.numd = cpu_to_le32((sizeof(*s) >> 2) - 1);
340 c.directive.doper = NVME_DIR_RCV_ST_OP_PARAM;
341 c.directive.dtype = NVME_DIR_STREAMS;
343 return nvme_submit_sync_cmd(ctrl->admin_q, &c, s, sizeof(*s));
346 static int nvme_configure_directives(struct nvme_ctrl *ctrl)
348 struct streams_directive_params s;
351 if (!(ctrl->oacs & NVME_CTRL_OACS_DIRECTIVES))
356 ret = nvme_enable_streams(ctrl);
360 ret = nvme_get_stream_params(ctrl, &s, 0xffffffff);
364 ctrl->nssa = le16_to_cpu(s.nssa);
365 if (ctrl->nssa < BLK_MAX_WRITE_HINTS - 1) {
366 dev_info(ctrl->device, "too few streams (%u) available\n",
368 nvme_disable_streams(ctrl);
372 ctrl->nr_streams = min_t(unsigned, ctrl->nssa, BLK_MAX_WRITE_HINTS - 1);
373 dev_info(ctrl->device, "Using %u streams\n", ctrl->nr_streams);
378 * Check if 'req' has a write hint associated with it. If it does, assign
379 * a valid namespace stream to the write.
381 static void nvme_assign_write_stream(struct nvme_ctrl *ctrl,
382 struct request *req, u16 *control,
385 enum rw_hint streamid = req->write_hint;
387 if (streamid == WRITE_LIFE_NOT_SET || streamid == WRITE_LIFE_NONE)
391 if (WARN_ON_ONCE(streamid > ctrl->nr_streams))
394 *control |= NVME_RW_DTYPE_STREAMS;
395 *dsmgmt |= streamid << 16;
398 if (streamid < ARRAY_SIZE(req->q->write_hints))
399 req->q->write_hints[streamid] += blk_rq_bytes(req) >> 9;
402 static inline void nvme_setup_flush(struct nvme_ns *ns,
403 struct nvme_command *cmnd)
405 memset(cmnd, 0, sizeof(*cmnd));
406 cmnd->common.opcode = nvme_cmd_flush;
407 cmnd->common.nsid = cpu_to_le32(ns->ns_id);
410 static blk_status_t nvme_setup_discard(struct nvme_ns *ns, struct request *req,
411 struct nvme_command *cmnd)
413 unsigned short segments = blk_rq_nr_discard_segments(req), n = 0;
414 struct nvme_dsm_range *range;
417 range = kmalloc_array(segments, sizeof(*range), GFP_ATOMIC);
419 return BLK_STS_RESOURCE;
421 __rq_for_each_bio(bio, req) {
422 u64 slba = nvme_block_nr(ns, bio->bi_iter.bi_sector);
423 u32 nlb = bio->bi_iter.bi_size >> ns->lba_shift;
425 range[n].cattr = cpu_to_le32(0);
426 range[n].nlb = cpu_to_le32(nlb);
427 range[n].slba = cpu_to_le64(slba);
431 if (WARN_ON_ONCE(n != segments)) {
433 return BLK_STS_IOERR;
436 memset(cmnd, 0, sizeof(*cmnd));
437 cmnd->dsm.opcode = nvme_cmd_dsm;
438 cmnd->dsm.nsid = cpu_to_le32(ns->ns_id);
439 cmnd->dsm.nr = cpu_to_le32(segments - 1);
440 cmnd->dsm.attributes = cpu_to_le32(NVME_DSMGMT_AD);
442 req->special_vec.bv_page = virt_to_page(range);
443 req->special_vec.bv_offset = offset_in_page(range);
444 req->special_vec.bv_len = sizeof(*range) * segments;
445 req->rq_flags |= RQF_SPECIAL_PAYLOAD;
450 static inline blk_status_t nvme_setup_rw(struct nvme_ns *ns,
451 struct request *req, struct nvme_command *cmnd)
453 struct nvme_ctrl *ctrl = ns->ctrl;
458 * If formated with metadata, require the block layer provide a buffer
459 * unless this namespace is formated such that the metadata can be
460 * stripped/generated by the controller with PRACT=1.
463 (!ns->pi_type || ns->ms != sizeof(struct t10_pi_tuple)) &&
464 !blk_integrity_rq(req) && !blk_rq_is_passthrough(req))
465 return BLK_STS_NOTSUPP;
467 if (req->cmd_flags & REQ_FUA)
468 control |= NVME_RW_FUA;
469 if (req->cmd_flags & (REQ_FAILFAST_DEV | REQ_RAHEAD))
470 control |= NVME_RW_LR;
472 if (req->cmd_flags & REQ_RAHEAD)
473 dsmgmt |= NVME_RW_DSM_FREQ_PREFETCH;
475 memset(cmnd, 0, sizeof(*cmnd));
476 cmnd->rw.opcode = (rq_data_dir(req) ? nvme_cmd_write : nvme_cmd_read);
477 cmnd->rw.nsid = cpu_to_le32(ns->ns_id);
478 cmnd->rw.slba = cpu_to_le64(nvme_block_nr(ns, blk_rq_pos(req)));
479 cmnd->rw.length = cpu_to_le16((blk_rq_bytes(req) >> ns->lba_shift) - 1);
481 if (req_op(req) == REQ_OP_WRITE && ctrl->nr_streams)
482 nvme_assign_write_stream(ctrl, req, &control, &dsmgmt);
485 switch (ns->pi_type) {
486 case NVME_NS_DPS_PI_TYPE3:
487 control |= NVME_RW_PRINFO_PRCHK_GUARD;
489 case NVME_NS_DPS_PI_TYPE1:
490 case NVME_NS_DPS_PI_TYPE2:
491 control |= NVME_RW_PRINFO_PRCHK_GUARD |
492 NVME_RW_PRINFO_PRCHK_REF;
493 cmnd->rw.reftag = cpu_to_le32(
494 nvme_block_nr(ns, blk_rq_pos(req)));
497 if (!blk_integrity_rq(req))
498 control |= NVME_RW_PRINFO_PRACT;
501 cmnd->rw.control = cpu_to_le16(control);
502 cmnd->rw.dsmgmt = cpu_to_le32(dsmgmt);
506 blk_status_t nvme_setup_cmd(struct nvme_ns *ns, struct request *req,
507 struct nvme_command *cmd)
509 blk_status_t ret = BLK_STS_OK;
511 if (!(req->rq_flags & RQF_DONTPREP)) {
512 nvme_req(req)->retries = 0;
513 nvme_req(req)->flags = 0;
514 req->rq_flags |= RQF_DONTPREP;
517 switch (req_op(req)) {
520 memcpy(cmd, nvme_req(req)->cmd, sizeof(*cmd));
523 nvme_setup_flush(ns, cmd);
525 case REQ_OP_WRITE_ZEROES:
526 /* currently only aliased to deallocate for a few ctrls: */
528 ret = nvme_setup_discard(ns, req, cmd);
532 ret = nvme_setup_rw(ns, req, cmd);
536 return BLK_STS_IOERR;
539 cmd->common.command_id = req->tag;
542 EXPORT_SYMBOL_GPL(nvme_setup_cmd);
545 * Returns 0 on success. If the result is negative, it's a Linux error code;
546 * if the result is positive, it's an NVM Express status code
548 int __nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
549 union nvme_result *result, void *buffer, unsigned bufflen,
550 unsigned timeout, int qid, int at_head, int flags)
555 req = nvme_alloc_request(q, cmd, flags, qid);
559 req->timeout = timeout ? timeout : ADMIN_TIMEOUT;
561 if (buffer && bufflen) {
562 ret = blk_rq_map_kern(q, req, buffer, bufflen, GFP_KERNEL);
567 blk_execute_rq(req->q, NULL, req, at_head);
569 *result = nvme_req(req)->result;
570 if (nvme_req(req)->flags & NVME_REQ_CANCELLED)
573 ret = nvme_req(req)->status;
575 blk_mq_free_request(req);
578 EXPORT_SYMBOL_GPL(__nvme_submit_sync_cmd);
580 int nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
581 void *buffer, unsigned bufflen)
583 return __nvme_submit_sync_cmd(q, cmd, NULL, buffer, bufflen, 0,
586 EXPORT_SYMBOL_GPL(nvme_submit_sync_cmd);
588 int __nvme_submit_user_cmd(struct request_queue *q, struct nvme_command *cmd,
589 void __user *ubuffer, unsigned bufflen,
590 void __user *meta_buffer, unsigned meta_len, u32 meta_seed,
591 u32 *result, unsigned timeout)
593 bool write = nvme_is_write(cmd);
594 struct nvme_ns *ns = q->queuedata;
595 struct gendisk *disk = ns ? ns->disk : NULL;
597 struct bio *bio = NULL;
601 req = nvme_alloc_request(q, cmd, 0, NVME_QID_ANY);
605 req->timeout = timeout ? timeout : ADMIN_TIMEOUT;
607 if (ubuffer && bufflen) {
608 ret = blk_rq_map_user(q, req, NULL, ubuffer, bufflen,
618 if (meta_buffer && meta_len) {
619 struct bio_integrity_payload *bip;
621 meta = kmalloc(meta_len, GFP_KERNEL);
628 if (copy_from_user(meta, meta_buffer,
635 bip = bio_integrity_alloc(bio, GFP_KERNEL, 1);
641 bip->bip_iter.bi_size = meta_len;
642 bip->bip_iter.bi_sector = meta_seed;
644 ret = bio_integrity_add_page(bio, virt_to_page(meta),
645 meta_len, offset_in_page(meta));
646 if (ret != meta_len) {
653 blk_execute_rq(req->q, disk, req, 0);
654 if (nvme_req(req)->flags & NVME_REQ_CANCELLED)
657 ret = nvme_req(req)->status;
659 *result = le32_to_cpu(nvme_req(req)->result.u32);
660 if (meta && !ret && !write) {
661 if (copy_to_user(meta_buffer, meta, meta_len))
668 blk_rq_unmap_user(bio);
670 blk_mq_free_request(req);
674 int nvme_submit_user_cmd(struct request_queue *q, struct nvme_command *cmd,
675 void __user *ubuffer, unsigned bufflen, u32 *result,
678 return __nvme_submit_user_cmd(q, cmd, ubuffer, bufflen, NULL, 0, 0,
682 static void nvme_keep_alive_end_io(struct request *rq, blk_status_t status)
684 struct nvme_ctrl *ctrl = rq->end_io_data;
686 blk_mq_free_request(rq);
689 dev_err(ctrl->device,
690 "failed nvme_keep_alive_end_io error=%d\n",
695 schedule_delayed_work(&ctrl->ka_work, ctrl->kato * HZ);
698 static int nvme_keep_alive(struct nvme_ctrl *ctrl)
700 struct nvme_command c;
703 memset(&c, 0, sizeof(c));
704 c.common.opcode = nvme_admin_keep_alive;
706 rq = nvme_alloc_request(ctrl->admin_q, &c, BLK_MQ_REQ_RESERVED,
711 rq->timeout = ctrl->kato * HZ;
712 rq->end_io_data = ctrl;
714 blk_execute_rq_nowait(rq->q, NULL, rq, 0, nvme_keep_alive_end_io);
719 static void nvme_keep_alive_work(struct work_struct *work)
721 struct nvme_ctrl *ctrl = container_of(to_delayed_work(work),
722 struct nvme_ctrl, ka_work);
724 if (nvme_keep_alive(ctrl)) {
725 /* allocation failure, reset the controller */
726 dev_err(ctrl->device, "keep-alive failed\n");
727 nvme_reset_ctrl(ctrl);
732 void nvme_start_keep_alive(struct nvme_ctrl *ctrl)
734 if (unlikely(ctrl->kato == 0))
737 INIT_DELAYED_WORK(&ctrl->ka_work, nvme_keep_alive_work);
738 schedule_delayed_work(&ctrl->ka_work, ctrl->kato * HZ);
740 EXPORT_SYMBOL_GPL(nvme_start_keep_alive);
742 void nvme_stop_keep_alive(struct nvme_ctrl *ctrl)
744 if (unlikely(ctrl->kato == 0))
747 cancel_delayed_work_sync(&ctrl->ka_work);
749 EXPORT_SYMBOL_GPL(nvme_stop_keep_alive);
751 static int nvme_identify_ctrl(struct nvme_ctrl *dev, struct nvme_id_ctrl **id)
753 struct nvme_command c = { };
756 /* gcc-4.4.4 (at least) has issues with initializers and anon unions */
757 c.identify.opcode = nvme_admin_identify;
758 c.identify.cns = NVME_ID_CNS_CTRL;
760 *id = kmalloc(sizeof(struct nvme_id_ctrl), GFP_KERNEL);
764 error = nvme_submit_sync_cmd(dev->admin_q, &c, *id,
765 sizeof(struct nvme_id_ctrl));
771 static int nvme_identify_ns_descs(struct nvme_ns *ns, unsigned nsid)
773 struct nvme_command c = { };
779 c.identify.opcode = nvme_admin_identify;
780 c.identify.nsid = cpu_to_le32(nsid);
781 c.identify.cns = NVME_ID_CNS_NS_DESC_LIST;
783 data = kzalloc(NVME_IDENTIFY_DATA_SIZE, GFP_KERNEL);
787 status = nvme_submit_sync_cmd(ns->ctrl->admin_q, &c, data,
788 NVME_IDENTIFY_DATA_SIZE);
792 for (pos = 0; pos < NVME_IDENTIFY_DATA_SIZE; pos += len) {
793 struct nvme_ns_id_desc *cur = data + pos;
799 case NVME_NIDT_EUI64:
800 if (cur->nidl != NVME_NIDT_EUI64_LEN) {
801 dev_warn(ns->ctrl->device,
802 "ctrl returned bogus length: %d for NVME_NIDT_EUI64\n",
806 len = NVME_NIDT_EUI64_LEN;
807 memcpy(ns->eui, data + pos + sizeof(*cur), len);
809 case NVME_NIDT_NGUID:
810 if (cur->nidl != NVME_NIDT_NGUID_LEN) {
811 dev_warn(ns->ctrl->device,
812 "ctrl returned bogus length: %d for NVME_NIDT_NGUID\n",
816 len = NVME_NIDT_NGUID_LEN;
817 memcpy(ns->nguid, data + pos + sizeof(*cur), len);
820 if (cur->nidl != NVME_NIDT_UUID_LEN) {
821 dev_warn(ns->ctrl->device,
822 "ctrl returned bogus length: %d for NVME_NIDT_UUID\n",
826 len = NVME_NIDT_UUID_LEN;
827 uuid_copy(&ns->uuid, data + pos + sizeof(*cur));
830 /* Skip unnkown types */
842 static int nvme_identify_ns_list(struct nvme_ctrl *dev, unsigned nsid, __le32 *ns_list)
844 struct nvme_command c = { };
846 c.identify.opcode = nvme_admin_identify;
847 c.identify.cns = NVME_ID_CNS_NS_ACTIVE_LIST;
848 c.identify.nsid = cpu_to_le32(nsid);
849 return nvme_submit_sync_cmd(dev->admin_q, &c, ns_list, 0x1000);
852 static int nvme_identify_ns(struct nvme_ctrl *dev, unsigned nsid,
853 struct nvme_id_ns **id)
855 struct nvme_command c = { };
858 /* gcc-4.4.4 (at least) has issues with initializers and anon unions */
859 c.identify.opcode = nvme_admin_identify;
860 c.identify.nsid = cpu_to_le32(nsid);
861 c.identify.cns = NVME_ID_CNS_NS;
863 *id = kmalloc(sizeof(struct nvme_id_ns), GFP_KERNEL);
867 error = nvme_submit_sync_cmd(dev->admin_q, &c, *id,
868 sizeof(struct nvme_id_ns));
874 static int nvme_set_features(struct nvme_ctrl *dev, unsigned fid, unsigned dword11,
875 void *buffer, size_t buflen, u32 *result)
877 struct nvme_command c;
878 union nvme_result res;
881 memset(&c, 0, sizeof(c));
882 c.features.opcode = nvme_admin_set_features;
883 c.features.fid = cpu_to_le32(fid);
884 c.features.dword11 = cpu_to_le32(dword11);
886 ret = __nvme_submit_sync_cmd(dev->admin_q, &c, &res,
887 buffer, buflen, 0, NVME_QID_ANY, 0, 0);
888 if (ret >= 0 && result)
889 *result = le32_to_cpu(res.u32);
893 int nvme_set_queue_count(struct nvme_ctrl *ctrl, int *count)
895 u32 q_count = (*count - 1) | ((*count - 1) << 16);
897 int status, nr_io_queues;
899 status = nvme_set_features(ctrl, NVME_FEAT_NUM_QUEUES, q_count, NULL, 0,
905 * Degraded controllers might return an error when setting the queue
906 * count. We still want to be able to bring them online and offer
907 * access to the admin queue, as that might be only way to fix them up.
910 dev_err(ctrl->device, "Could not set queue count (%d)\n", status);
913 nr_io_queues = min(result & 0xffff, result >> 16) + 1;
914 *count = min(*count, nr_io_queues);
919 EXPORT_SYMBOL_GPL(nvme_set_queue_count);
921 static int nvme_submit_io(struct nvme_ns *ns, struct nvme_user_io __user *uio)
923 struct nvme_user_io io;
924 struct nvme_command c;
925 unsigned length, meta_len;
926 void __user *metadata;
928 if (copy_from_user(&io, uio, sizeof(io)))
936 case nvme_cmd_compare:
942 length = (io.nblocks + 1) << ns->lba_shift;
943 meta_len = (io.nblocks + 1) * ns->ms;
944 metadata = (void __user *)(uintptr_t)io.metadata;
949 } else if (meta_len) {
950 if ((io.metadata & 3) || !io.metadata)
954 memset(&c, 0, sizeof(c));
955 c.rw.opcode = io.opcode;
956 c.rw.flags = io.flags;
957 c.rw.nsid = cpu_to_le32(ns->ns_id);
958 c.rw.slba = cpu_to_le64(io.slba);
959 c.rw.length = cpu_to_le16(io.nblocks);
960 c.rw.control = cpu_to_le16(io.control);
961 c.rw.dsmgmt = cpu_to_le32(io.dsmgmt);
962 c.rw.reftag = cpu_to_le32(io.reftag);
963 c.rw.apptag = cpu_to_le16(io.apptag);
964 c.rw.appmask = cpu_to_le16(io.appmask);
966 return __nvme_submit_user_cmd(ns->queue, &c,
967 (void __user *)(uintptr_t)io.addr, length,
968 metadata, meta_len, io.slba, NULL, 0);
971 static int nvme_user_cmd(struct nvme_ctrl *ctrl, struct nvme_ns *ns,
972 struct nvme_passthru_cmd __user *ucmd)
974 struct nvme_passthru_cmd cmd;
975 struct nvme_command c;
976 unsigned timeout = 0;
979 if (!capable(CAP_SYS_ADMIN))
981 if (copy_from_user(&cmd, ucmd, sizeof(cmd)))
986 memset(&c, 0, sizeof(c));
987 c.common.opcode = cmd.opcode;
988 c.common.flags = cmd.flags;
989 c.common.nsid = cpu_to_le32(cmd.nsid);
990 c.common.cdw2[0] = cpu_to_le32(cmd.cdw2);
991 c.common.cdw2[1] = cpu_to_le32(cmd.cdw3);
992 c.common.cdw10[0] = cpu_to_le32(cmd.cdw10);
993 c.common.cdw10[1] = cpu_to_le32(cmd.cdw11);
994 c.common.cdw10[2] = cpu_to_le32(cmd.cdw12);
995 c.common.cdw10[3] = cpu_to_le32(cmd.cdw13);
996 c.common.cdw10[4] = cpu_to_le32(cmd.cdw14);
997 c.common.cdw10[5] = cpu_to_le32(cmd.cdw15);
1000 timeout = msecs_to_jiffies(cmd.timeout_ms);
1002 status = nvme_submit_user_cmd(ns ? ns->queue : ctrl->admin_q, &c,
1003 (void __user *)(uintptr_t)cmd.addr, cmd.data_len,
1004 &cmd.result, timeout);
1006 if (put_user(cmd.result, &ucmd->result))
1013 static int nvme_ioctl(struct block_device *bdev, fmode_t mode,
1014 unsigned int cmd, unsigned long arg)
1016 struct nvme_ns *ns = bdev->bd_disk->private_data;
1020 force_successful_syscall_return();
1022 case NVME_IOCTL_ADMIN_CMD:
1023 return nvme_user_cmd(ns->ctrl, NULL, (void __user *)arg);
1024 case NVME_IOCTL_IO_CMD:
1025 return nvme_user_cmd(ns->ctrl, ns, (void __user *)arg);
1026 case NVME_IOCTL_SUBMIT_IO:
1027 return nvme_submit_io(ns, (void __user *)arg);
1031 return nvme_nvm_ioctl(ns, cmd, arg);
1033 if (is_sed_ioctl(cmd))
1034 return sed_ioctl(ns->ctrl->opal_dev, cmd,
1035 (void __user *) arg);
1040 #ifdef CONFIG_COMPAT
1041 static int nvme_compat_ioctl(struct block_device *bdev, fmode_t mode,
1042 unsigned int cmd, unsigned long arg)
1044 return nvme_ioctl(bdev, mode, cmd, arg);
1047 #define nvme_compat_ioctl NULL
1050 static int nvme_open(struct block_device *bdev, fmode_t mode)
1052 return nvme_get_ns_from_disk(bdev->bd_disk) ? 0 : -ENXIO;
1055 static void nvme_release(struct gendisk *disk, fmode_t mode)
1057 struct nvme_ns *ns = disk->private_data;
1059 module_put(ns->ctrl->ops->module);
1063 static int nvme_getgeo(struct block_device *bdev, struct hd_geometry *geo)
1065 /* some standard values */
1066 geo->heads = 1 << 6;
1067 geo->sectors = 1 << 5;
1068 geo->cylinders = get_capacity(bdev->bd_disk) >> 11;
1072 #ifdef CONFIG_BLK_DEV_INTEGRITY
1073 static void nvme_prep_integrity(struct gendisk *disk, struct nvme_id_ns *id,
1076 struct nvme_ns *ns = disk->private_data;
1077 u16 old_ms = ns->ms;
1080 ns->ms = le16_to_cpu(id->lbaf[id->flbas & NVME_NS_FLBAS_LBA_MASK].ms);
1081 ns->ext = ns->ms && (id->flbas & NVME_NS_FLBAS_META_EXT);
1083 /* PI implementation requires metadata equal t10 pi tuple size */
1084 if (ns->ms == sizeof(struct t10_pi_tuple))
1085 pi_type = id->dps & NVME_NS_DPS_PI_MASK;
1087 if (blk_get_integrity(disk) &&
1088 (ns->pi_type != pi_type || ns->ms != old_ms ||
1089 bs != queue_logical_block_size(disk->queue) ||
1090 (ns->ms && ns->ext)))
1091 blk_integrity_unregister(disk);
1093 ns->pi_type = pi_type;
1096 static void nvme_init_integrity(struct nvme_ns *ns)
1098 struct blk_integrity integrity;
1100 memset(&integrity, 0, sizeof(integrity));
1101 switch (ns->pi_type) {
1102 case NVME_NS_DPS_PI_TYPE3:
1103 integrity.profile = &t10_pi_type3_crc;
1104 integrity.tag_size = sizeof(u16) + sizeof(u32);
1105 integrity.flags |= BLK_INTEGRITY_DEVICE_CAPABLE;
1107 case NVME_NS_DPS_PI_TYPE1:
1108 case NVME_NS_DPS_PI_TYPE2:
1109 integrity.profile = &t10_pi_type1_crc;
1110 integrity.tag_size = sizeof(u16);
1111 integrity.flags |= BLK_INTEGRITY_DEVICE_CAPABLE;
1114 integrity.profile = NULL;
1117 integrity.tuple_size = ns->ms;
1118 blk_integrity_register(ns->disk, &integrity);
1119 blk_queue_max_integrity_segments(ns->queue, 1);
1122 static void nvme_prep_integrity(struct gendisk *disk, struct nvme_id_ns *id,
1126 static void nvme_init_integrity(struct nvme_ns *ns)
1129 #endif /* CONFIG_BLK_DEV_INTEGRITY */
1131 static void nvme_set_chunk_size(struct nvme_ns *ns)
1133 u32 chunk_size = (((u32)ns->noiob) << (ns->lba_shift - 9));
1134 blk_queue_chunk_sectors(ns->queue, rounddown_pow_of_two(chunk_size));
1137 static void nvme_config_discard(struct nvme_ns *ns)
1139 struct nvme_ctrl *ctrl = ns->ctrl;
1140 u32 logical_block_size = queue_logical_block_size(ns->queue);
1142 BUILD_BUG_ON(PAGE_SIZE / sizeof(struct nvme_dsm_range) <
1143 NVME_DSM_MAX_RANGES);
1145 if (ctrl->nr_streams && ns->sws && ns->sgs) {
1146 unsigned int sz = logical_block_size * ns->sws * ns->sgs;
1148 ns->queue->limits.discard_alignment = sz;
1149 ns->queue->limits.discard_granularity = sz;
1151 ns->queue->limits.discard_alignment = logical_block_size;
1152 ns->queue->limits.discard_granularity = logical_block_size;
1154 blk_queue_max_discard_sectors(ns->queue, UINT_MAX);
1155 blk_queue_max_discard_segments(ns->queue, NVME_DSM_MAX_RANGES);
1156 queue_flag_set_unlocked(QUEUE_FLAG_DISCARD, ns->queue);
1158 if (ctrl->quirks & NVME_QUIRK_DEALLOCATE_ZEROES)
1159 blk_queue_max_write_zeroes_sectors(ns->queue, UINT_MAX);
1162 static int nvme_revalidate_ns(struct nvme_ns *ns, struct nvme_id_ns **id)
1164 if (nvme_identify_ns(ns->ctrl, ns->ns_id, id)) {
1165 dev_warn(ns->ctrl->dev, "%s: Identify failure\n", __func__);
1169 if ((*id)->ncap == 0) {
1174 if (ns->ctrl->vs >= NVME_VS(1, 1, 0))
1175 memcpy(ns->eui, (*id)->eui64, sizeof(ns->eui));
1176 if (ns->ctrl->vs >= NVME_VS(1, 2, 0))
1177 memcpy(ns->nguid, (*id)->nguid, sizeof(ns->nguid));
1178 if (ns->ctrl->vs >= NVME_VS(1, 3, 0)) {
1179 /* Don't treat error as fatal we potentially
1180 * already have a NGUID or EUI-64
1182 if (nvme_identify_ns_descs(ns, ns->ns_id))
1183 dev_warn(ns->ctrl->device,
1184 "%s: Identify Descriptors failed\n", __func__);
1190 static void __nvme_revalidate_disk(struct gendisk *disk, struct nvme_id_ns *id)
1192 struct nvme_ns *ns = disk->private_data;
1193 struct nvme_ctrl *ctrl = ns->ctrl;
1197 * If identify namespace failed, use default 512 byte block size so
1198 * block layer can use before failing read/write for 0 capacity.
1200 ns->lba_shift = id->lbaf[id->flbas & NVME_NS_FLBAS_LBA_MASK].ds;
1201 if (ns->lba_shift == 0)
1203 bs = 1 << ns->lba_shift;
1204 ns->noiob = le16_to_cpu(id->noiob);
1206 blk_mq_freeze_queue(disk->queue);
1208 if (ctrl->ops->flags & NVME_F_METADATA_SUPPORTED)
1209 nvme_prep_integrity(disk, id, bs);
1210 blk_queue_logical_block_size(ns->queue, bs);
1212 nvme_set_chunk_size(ns);
1213 if (ns->ms && !blk_get_integrity(disk) && !ns->ext)
1214 nvme_init_integrity(ns);
1215 if (ns->ms && !(ns->ms == 8 && ns->pi_type) && !blk_get_integrity(disk))
1216 set_capacity(disk, 0);
1218 set_capacity(disk, le64_to_cpup(&id->nsze) << (ns->lba_shift - 9));
1220 if (ctrl->oncs & NVME_CTRL_ONCS_DSM)
1221 nvme_config_discard(ns);
1222 blk_mq_unfreeze_queue(disk->queue);
1225 static int nvme_revalidate_disk(struct gendisk *disk)
1227 struct nvme_ns *ns = disk->private_data;
1228 struct nvme_id_ns *id = NULL;
1231 if (test_bit(NVME_NS_DEAD, &ns->flags)) {
1232 set_capacity(disk, 0);
1236 ret = nvme_revalidate_ns(ns, &id);
1240 __nvme_revalidate_disk(disk, id);
1246 static char nvme_pr_type(enum pr_type type)
1249 case PR_WRITE_EXCLUSIVE:
1251 case PR_EXCLUSIVE_ACCESS:
1253 case PR_WRITE_EXCLUSIVE_REG_ONLY:
1255 case PR_EXCLUSIVE_ACCESS_REG_ONLY:
1257 case PR_WRITE_EXCLUSIVE_ALL_REGS:
1259 case PR_EXCLUSIVE_ACCESS_ALL_REGS:
1266 static int nvme_pr_command(struct block_device *bdev, u32 cdw10,
1267 u64 key, u64 sa_key, u8 op)
1269 struct nvme_ns *ns = bdev->bd_disk->private_data;
1270 struct nvme_command c;
1271 u8 data[16] = { 0, };
1273 put_unaligned_le64(key, &data[0]);
1274 put_unaligned_le64(sa_key, &data[8]);
1276 memset(&c, 0, sizeof(c));
1277 c.common.opcode = op;
1278 c.common.nsid = cpu_to_le32(ns->ns_id);
1279 c.common.cdw10[0] = cpu_to_le32(cdw10);
1281 return nvme_submit_sync_cmd(ns->queue, &c, data, 16);
1284 static int nvme_pr_register(struct block_device *bdev, u64 old,
1285 u64 new, unsigned flags)
1289 if (flags & ~PR_FL_IGNORE_KEY)
1292 cdw10 = old ? 2 : 0;
1293 cdw10 |= (flags & PR_FL_IGNORE_KEY) ? 1 << 3 : 0;
1294 cdw10 |= (1 << 30) | (1 << 31); /* PTPL=1 */
1295 return nvme_pr_command(bdev, cdw10, old, new, nvme_cmd_resv_register);
1298 static int nvme_pr_reserve(struct block_device *bdev, u64 key,
1299 enum pr_type type, unsigned flags)
1303 if (flags & ~PR_FL_IGNORE_KEY)
1306 cdw10 = nvme_pr_type(type) << 8;
1307 cdw10 |= ((flags & PR_FL_IGNORE_KEY) ? 1 << 3 : 0);
1308 return nvme_pr_command(bdev, cdw10, key, 0, nvme_cmd_resv_acquire);
1311 static int nvme_pr_preempt(struct block_device *bdev, u64 old, u64 new,
1312 enum pr_type type, bool abort)
1314 u32 cdw10 = nvme_pr_type(type) << 8 | abort ? 2 : 1;
1315 return nvme_pr_command(bdev, cdw10, old, new, nvme_cmd_resv_acquire);
1318 static int nvme_pr_clear(struct block_device *bdev, u64 key)
1320 u32 cdw10 = 1 | (key ? 1 << 3 : 0);
1321 return nvme_pr_command(bdev, cdw10, key, 0, nvme_cmd_resv_register);
1324 static int nvme_pr_release(struct block_device *bdev, u64 key, enum pr_type type)
1326 u32 cdw10 = nvme_pr_type(type) << 8 | key ? 1 << 3 : 0;
1327 return nvme_pr_command(bdev, cdw10, key, 0, nvme_cmd_resv_release);
1330 static const struct pr_ops nvme_pr_ops = {
1331 .pr_register = nvme_pr_register,
1332 .pr_reserve = nvme_pr_reserve,
1333 .pr_release = nvme_pr_release,
1334 .pr_preempt = nvme_pr_preempt,
1335 .pr_clear = nvme_pr_clear,
1338 #ifdef CONFIG_BLK_SED_OPAL
1339 int nvme_sec_submit(void *data, u16 spsp, u8 secp, void *buffer, size_t len,
1342 struct nvme_ctrl *ctrl = data;
1343 struct nvme_command cmd;
1345 memset(&cmd, 0, sizeof(cmd));
1347 cmd.common.opcode = nvme_admin_security_send;
1349 cmd.common.opcode = nvme_admin_security_recv;
1350 cmd.common.nsid = 0;
1351 cmd.common.cdw10[0] = cpu_to_le32(((u32)secp) << 24 | ((u32)spsp) << 8);
1352 cmd.common.cdw10[1] = cpu_to_le32(len);
1354 return __nvme_submit_sync_cmd(ctrl->admin_q, &cmd, NULL, buffer, len,
1355 ADMIN_TIMEOUT, NVME_QID_ANY, 1, 0);
1357 EXPORT_SYMBOL_GPL(nvme_sec_submit);
1358 #endif /* CONFIG_BLK_SED_OPAL */
1360 static const struct block_device_operations nvme_fops = {
1361 .owner = THIS_MODULE,
1362 .ioctl = nvme_ioctl,
1363 .compat_ioctl = nvme_compat_ioctl,
1365 .release = nvme_release,
1366 .getgeo = nvme_getgeo,
1367 .revalidate_disk= nvme_revalidate_disk,
1368 .pr_ops = &nvme_pr_ops,
1371 static int nvme_wait_ready(struct nvme_ctrl *ctrl, u64 cap, bool enabled)
1373 unsigned long timeout =
1374 ((NVME_CAP_TIMEOUT(cap) + 1) * HZ / 2) + jiffies;
1375 u32 csts, bit = enabled ? NVME_CSTS_RDY : 0;
1378 while ((ret = ctrl->ops->reg_read32(ctrl, NVME_REG_CSTS, &csts)) == 0) {
1381 if ((csts & NVME_CSTS_RDY) == bit)
1385 if (fatal_signal_pending(current))
1387 if (time_after(jiffies, timeout)) {
1388 dev_err(ctrl->device,
1389 "Device not ready; aborting %s\n", enabled ?
1390 "initialisation" : "reset");
1399 * If the device has been passed off to us in an enabled state, just clear
1400 * the enabled bit. The spec says we should set the 'shutdown notification
1401 * bits', but doing so may cause the device to complete commands to the
1402 * admin queue ... and we don't know what memory that might be pointing at!
1404 int nvme_disable_ctrl(struct nvme_ctrl *ctrl, u64 cap)
1408 ctrl->ctrl_config &= ~NVME_CC_SHN_MASK;
1409 ctrl->ctrl_config &= ~NVME_CC_ENABLE;
1411 ret = ctrl->ops->reg_write32(ctrl, NVME_REG_CC, ctrl->ctrl_config);
1415 if (ctrl->quirks & NVME_QUIRK_DELAY_BEFORE_CHK_RDY)
1416 msleep(NVME_QUIRK_DELAY_AMOUNT);
1418 return nvme_wait_ready(ctrl, cap, false);
1420 EXPORT_SYMBOL_GPL(nvme_disable_ctrl);
1422 int nvme_enable_ctrl(struct nvme_ctrl *ctrl, u64 cap)
1425 * Default to a 4K page size, with the intention to update this
1426 * path in the future to accomodate architectures with differing
1427 * kernel and IO page sizes.
1429 unsigned dev_page_min = NVME_CAP_MPSMIN(cap) + 12, page_shift = 12;
1432 if (page_shift < dev_page_min) {
1433 dev_err(ctrl->device,
1434 "Minimum device page size %u too large for host (%u)\n",
1435 1 << dev_page_min, 1 << page_shift);
1439 ctrl->page_size = 1 << page_shift;
1441 ctrl->ctrl_config = NVME_CC_CSS_NVM;
1442 ctrl->ctrl_config |= (page_shift - 12) << NVME_CC_MPS_SHIFT;
1443 ctrl->ctrl_config |= NVME_CC_ARB_RR | NVME_CC_SHN_NONE;
1444 ctrl->ctrl_config |= NVME_CC_IOSQES | NVME_CC_IOCQES;
1445 ctrl->ctrl_config |= NVME_CC_ENABLE;
1447 ret = ctrl->ops->reg_write32(ctrl, NVME_REG_CC, ctrl->ctrl_config);
1450 return nvme_wait_ready(ctrl, cap, true);
1452 EXPORT_SYMBOL_GPL(nvme_enable_ctrl);
1454 int nvme_shutdown_ctrl(struct nvme_ctrl *ctrl)
1456 unsigned long timeout = jiffies + (shutdown_timeout * HZ);
1460 ctrl->ctrl_config &= ~NVME_CC_SHN_MASK;
1461 ctrl->ctrl_config |= NVME_CC_SHN_NORMAL;
1463 ret = ctrl->ops->reg_write32(ctrl, NVME_REG_CC, ctrl->ctrl_config);
1467 while ((ret = ctrl->ops->reg_read32(ctrl, NVME_REG_CSTS, &csts)) == 0) {
1468 if ((csts & NVME_CSTS_SHST_MASK) == NVME_CSTS_SHST_CMPLT)
1472 if (fatal_signal_pending(current))
1474 if (time_after(jiffies, timeout)) {
1475 dev_err(ctrl->device,
1476 "Device shutdown incomplete; abort shutdown\n");
1483 EXPORT_SYMBOL_GPL(nvme_shutdown_ctrl);
1485 static void nvme_set_queue_limits(struct nvme_ctrl *ctrl,
1486 struct request_queue *q)
1490 if (ctrl->max_hw_sectors) {
1492 (ctrl->max_hw_sectors / (ctrl->page_size >> 9)) + 1;
1494 blk_queue_max_hw_sectors(q, ctrl->max_hw_sectors);
1495 blk_queue_max_segments(q, min_t(u32, max_segments, USHRT_MAX));
1497 if (ctrl->quirks & NVME_QUIRK_STRIPE_SIZE)
1498 blk_queue_chunk_sectors(q, ctrl->max_hw_sectors);
1499 blk_queue_virt_boundary(q, ctrl->page_size - 1);
1500 if (ctrl->vwc & NVME_CTRL_VWC_PRESENT)
1502 blk_queue_write_cache(q, vwc, vwc);
1505 static int nvme_configure_apst(struct nvme_ctrl *ctrl)
1508 * APST (Autonomous Power State Transition) lets us program a
1509 * table of power state transitions that the controller will
1510 * perform automatically. We configure it with a simple
1511 * heuristic: we are willing to spend at most 2% of the time
1512 * transitioning between power states. Therefore, when running
1513 * in any given state, we will enter the next lower-power
1514 * non-operational state after waiting 50 * (enlat + exlat)
1515 * microseconds, as long as that state's exit latency is under
1516 * the requested maximum latency.
1518 * We will not autonomously enter any non-operational state for
1519 * which the total latency exceeds ps_max_latency_us. Users
1520 * can set ps_max_latency_us to zero to turn off APST.
1524 struct nvme_feat_auto_pst *table;
1530 * If APST isn't supported or if we haven't been initialized yet,
1531 * then don't do anything.
1536 if (ctrl->npss > 31) {
1537 dev_warn(ctrl->device, "NPSS is invalid; not using APST\n");
1541 table = kzalloc(sizeof(*table), GFP_KERNEL);
1545 if (!ctrl->apst_enabled || ctrl->ps_max_latency_us == 0) {
1546 /* Turn off APST. */
1548 dev_dbg(ctrl->device, "APST disabled\n");
1550 __le64 target = cpu_to_le64(0);
1554 * Walk through all states from lowest- to highest-power.
1555 * According to the spec, lower-numbered states use more
1556 * power. NPSS, despite the name, is the index of the
1557 * lowest-power state, not the number of states.
1559 for (state = (int)ctrl->npss; state >= 0; state--) {
1560 u64 total_latency_us, exit_latency_us, transition_ms;
1563 table->entries[state] = target;
1566 * Don't allow transitions to the deepest state
1567 * if it's quirked off.
1569 if (state == ctrl->npss &&
1570 (ctrl->quirks & NVME_QUIRK_NO_DEEPEST_PS))
1574 * Is this state a useful non-operational state for
1575 * higher-power states to autonomously transition to?
1577 if (!(ctrl->psd[state].flags &
1578 NVME_PS_FLAGS_NON_OP_STATE))
1582 (u64)le32_to_cpu(ctrl->psd[state].exit_lat);
1583 if (exit_latency_us > ctrl->ps_max_latency_us)
1588 le32_to_cpu(ctrl->psd[state].entry_lat);
1591 * This state is good. Use it as the APST idle
1592 * target for higher power states.
1594 transition_ms = total_latency_us + 19;
1595 do_div(transition_ms, 20);
1596 if (transition_ms > (1 << 24) - 1)
1597 transition_ms = (1 << 24) - 1;
1599 target = cpu_to_le64((state << 3) |
1600 (transition_ms << 8));
1605 if (total_latency_us > max_lat_us)
1606 max_lat_us = total_latency_us;
1612 dev_dbg(ctrl->device, "APST enabled but no non-operational states are available\n");
1614 dev_dbg(ctrl->device, "APST enabled: max PS = %d, max round-trip latency = %lluus, table = %*phN\n",
1615 max_ps, max_lat_us, (int)sizeof(*table), table);
1619 ret = nvme_set_features(ctrl, NVME_FEAT_AUTO_PST, apste,
1620 table, sizeof(*table), NULL);
1622 dev_err(ctrl->device, "failed to set APST feature (%d)\n", ret);
1628 static void nvme_set_latency_tolerance(struct device *dev, s32 val)
1630 struct nvme_ctrl *ctrl = dev_get_drvdata(dev);
1634 case PM_QOS_LATENCY_TOLERANCE_NO_CONSTRAINT:
1635 case PM_QOS_LATENCY_ANY:
1643 if (ctrl->ps_max_latency_us != latency) {
1644 ctrl->ps_max_latency_us = latency;
1645 nvme_configure_apst(ctrl);
1649 struct nvme_core_quirk_entry {
1651 * NVMe model and firmware strings are padded with spaces. For
1652 * simplicity, strings in the quirk table are padded with NULLs
1658 unsigned long quirks;
1661 static const struct nvme_core_quirk_entry core_quirks[] = {
1664 * This Toshiba device seems to die using any APST states. See:
1665 * https://bugs.launchpad.net/ubuntu/+source/linux/+bug/1678184/comments/11
1668 .mn = "THNSF5256GPUK TOSHIBA",
1669 .quirks = NVME_QUIRK_NO_APST,
1673 /* match is null-terminated but idstr is space-padded. */
1674 static bool string_matches(const char *idstr, const char *match, size_t len)
1681 matchlen = strlen(match);
1682 WARN_ON_ONCE(matchlen > len);
1684 if (memcmp(idstr, match, matchlen))
1687 for (; matchlen < len; matchlen++)
1688 if (idstr[matchlen] != ' ')
1694 static bool quirk_matches(const struct nvme_id_ctrl *id,
1695 const struct nvme_core_quirk_entry *q)
1697 return q->vid == le16_to_cpu(id->vid) &&
1698 string_matches(id->mn, q->mn, sizeof(id->mn)) &&
1699 string_matches(id->fr, q->fr, sizeof(id->fr));
1702 static void nvme_init_subnqn(struct nvme_ctrl *ctrl, struct nvme_id_ctrl *id)
1707 nqnlen = strnlen(id->subnqn, NVMF_NQN_SIZE);
1708 if (nqnlen > 0 && nqnlen < NVMF_NQN_SIZE) {
1709 strcpy(ctrl->subnqn, id->subnqn);
1713 if (ctrl->vs >= NVME_VS(1, 2, 1))
1714 dev_warn(ctrl->device, "missing or invalid SUBNQN field.\n");
1716 /* Generate a "fake" NQN per Figure 254 in NVMe 1.3 + ECN 001 */
1717 off = snprintf(ctrl->subnqn, NVMF_NQN_SIZE,
1718 "nqn.2014.08.org.nvmexpress:%4x%4x",
1719 le16_to_cpu(id->vid), le16_to_cpu(id->ssvid));
1720 memcpy(ctrl->subnqn + off, id->sn, sizeof(id->sn));
1721 off += sizeof(id->sn);
1722 memcpy(ctrl->subnqn + off, id->mn, sizeof(id->mn));
1723 off += sizeof(id->mn);
1724 memset(ctrl->subnqn + off, 0, sizeof(ctrl->subnqn) - off);
1728 * Initialize the cached copies of the Identify data and various controller
1729 * register in our nvme_ctrl structure. This should be called as soon as
1730 * the admin queue is fully up and running.
1732 int nvme_init_identify(struct nvme_ctrl *ctrl)
1734 struct nvme_id_ctrl *id;
1736 int ret, page_shift;
1738 bool prev_apst_enabled;
1740 ret = ctrl->ops->reg_read32(ctrl, NVME_REG_VS, &ctrl->vs);
1742 dev_err(ctrl->device, "Reading VS failed (%d)\n", ret);
1746 ret = ctrl->ops->reg_read64(ctrl, NVME_REG_CAP, &cap);
1748 dev_err(ctrl->device, "Reading CAP failed (%d)\n", ret);
1751 page_shift = NVME_CAP_MPSMIN(cap) + 12;
1753 if (ctrl->vs >= NVME_VS(1, 1, 0))
1754 ctrl->subsystem = NVME_CAP_NSSRC(cap);
1756 ret = nvme_identify_ctrl(ctrl, &id);
1758 dev_err(ctrl->device, "Identify Controller failed (%d)\n", ret);
1762 nvme_init_subnqn(ctrl, id);
1764 if (!ctrl->identified) {
1766 * Check for quirks. Quirk can depend on firmware version,
1767 * so, in principle, the set of quirks present can change
1768 * across a reset. As a possible future enhancement, we
1769 * could re-scan for quirks every time we reinitialize
1770 * the device, but we'd have to make sure that the driver
1771 * behaves intelligently if the quirks change.
1776 for (i = 0; i < ARRAY_SIZE(core_quirks); i++) {
1777 if (quirk_matches(id, &core_quirks[i]))
1778 ctrl->quirks |= core_quirks[i].quirks;
1782 if (force_apst && (ctrl->quirks & NVME_QUIRK_NO_DEEPEST_PS)) {
1783 dev_warn(ctrl->device, "forcibly allowing all power states due to nvme_core.force_apst -- use at your own risk\n");
1784 ctrl->quirks &= ~NVME_QUIRK_NO_DEEPEST_PS;
1787 ctrl->oacs = le16_to_cpu(id->oacs);
1788 ctrl->vid = le16_to_cpu(id->vid);
1789 ctrl->oncs = le16_to_cpup(&id->oncs);
1790 atomic_set(&ctrl->abort_limit, id->acl + 1);
1791 ctrl->vwc = id->vwc;
1792 ctrl->cntlid = le16_to_cpup(&id->cntlid);
1793 memcpy(ctrl->serial, id->sn, sizeof(id->sn));
1794 memcpy(ctrl->model, id->mn, sizeof(id->mn));
1795 memcpy(ctrl->firmware_rev, id->fr, sizeof(id->fr));
1797 max_hw_sectors = 1 << (id->mdts + page_shift - 9);
1799 max_hw_sectors = UINT_MAX;
1800 ctrl->max_hw_sectors =
1801 min_not_zero(ctrl->max_hw_sectors, max_hw_sectors);
1803 nvme_set_queue_limits(ctrl, ctrl->admin_q);
1804 ctrl->sgls = le32_to_cpu(id->sgls);
1805 ctrl->kas = le16_to_cpu(id->kas);
1807 ctrl->npss = id->npss;
1808 ctrl->apsta = id->apsta;
1809 prev_apst_enabled = ctrl->apst_enabled;
1810 if (ctrl->quirks & NVME_QUIRK_NO_APST) {
1811 if (force_apst && id->apsta) {
1812 dev_warn(ctrl->device, "forcibly allowing APST due to nvme_core.force_apst -- use at your own risk\n");
1813 ctrl->apst_enabled = true;
1815 ctrl->apst_enabled = false;
1818 ctrl->apst_enabled = id->apsta;
1820 memcpy(ctrl->psd, id->psd, sizeof(ctrl->psd));
1822 if (ctrl->ops->flags & NVME_F_FABRICS) {
1823 ctrl->icdoff = le16_to_cpu(id->icdoff);
1824 ctrl->ioccsz = le32_to_cpu(id->ioccsz);
1825 ctrl->iorcsz = le32_to_cpu(id->iorcsz);
1826 ctrl->maxcmd = le16_to_cpu(id->maxcmd);
1829 * In fabrics we need to verify the cntlid matches the
1832 if (ctrl->cntlid != le16_to_cpu(id->cntlid)) {
1837 if (!ctrl->opts->discovery_nqn && !ctrl->kas) {
1838 dev_err(ctrl->device,
1839 "keep-alive support is mandatory for fabrics\n");
1844 ctrl->cntlid = le16_to_cpu(id->cntlid);
1845 ctrl->hmpre = le32_to_cpu(id->hmpre);
1846 ctrl->hmmin = le32_to_cpu(id->hmmin);
1851 if (ctrl->apst_enabled && !prev_apst_enabled)
1852 dev_pm_qos_expose_latency_tolerance(ctrl->device);
1853 else if (!ctrl->apst_enabled && prev_apst_enabled)
1854 dev_pm_qos_hide_latency_tolerance(ctrl->device);
1856 ret = nvme_configure_apst(ctrl);
1860 ret = nvme_configure_directives(ctrl);
1864 ctrl->identified = true;
1872 EXPORT_SYMBOL_GPL(nvme_init_identify);
1874 static int nvme_dev_open(struct inode *inode, struct file *file)
1876 struct nvme_ctrl *ctrl;
1877 int instance = iminor(inode);
1880 spin_lock(&dev_list_lock);
1881 list_for_each_entry(ctrl, &nvme_ctrl_list, node) {
1882 if (ctrl->instance != instance)
1885 if (!ctrl->admin_q) {
1889 if (!kref_get_unless_zero(&ctrl->kref))
1891 file->private_data = ctrl;
1895 spin_unlock(&dev_list_lock);
1900 static int nvme_dev_release(struct inode *inode, struct file *file)
1902 nvme_put_ctrl(file->private_data);
1906 static int nvme_dev_user_cmd(struct nvme_ctrl *ctrl, void __user *argp)
1911 mutex_lock(&ctrl->namespaces_mutex);
1912 if (list_empty(&ctrl->namespaces)) {
1917 ns = list_first_entry(&ctrl->namespaces, struct nvme_ns, list);
1918 if (ns != list_last_entry(&ctrl->namespaces, struct nvme_ns, list)) {
1919 dev_warn(ctrl->device,
1920 "NVME_IOCTL_IO_CMD not supported when multiple namespaces present!\n");
1925 dev_warn(ctrl->device,
1926 "using deprecated NVME_IOCTL_IO_CMD ioctl on the char device!\n");
1927 kref_get(&ns->kref);
1928 mutex_unlock(&ctrl->namespaces_mutex);
1930 ret = nvme_user_cmd(ctrl, ns, argp);
1935 mutex_unlock(&ctrl->namespaces_mutex);
1939 static long nvme_dev_ioctl(struct file *file, unsigned int cmd,
1942 struct nvme_ctrl *ctrl = file->private_data;
1943 void __user *argp = (void __user *)arg;
1946 case NVME_IOCTL_ADMIN_CMD:
1947 return nvme_user_cmd(ctrl, NULL, argp);
1948 case NVME_IOCTL_IO_CMD:
1949 return nvme_dev_user_cmd(ctrl, argp);
1950 case NVME_IOCTL_RESET:
1951 dev_warn(ctrl->device, "resetting controller\n");
1952 return nvme_reset_ctrl_sync(ctrl);
1953 case NVME_IOCTL_SUBSYS_RESET:
1954 return nvme_reset_subsystem(ctrl);
1955 case NVME_IOCTL_RESCAN:
1956 nvme_queue_scan(ctrl);
1963 static const struct file_operations nvme_dev_fops = {
1964 .owner = THIS_MODULE,
1965 .open = nvme_dev_open,
1966 .release = nvme_dev_release,
1967 .unlocked_ioctl = nvme_dev_ioctl,
1968 .compat_ioctl = nvme_dev_ioctl,
1971 static ssize_t nvme_sysfs_reset(struct device *dev,
1972 struct device_attribute *attr, const char *buf,
1975 struct nvme_ctrl *ctrl = dev_get_drvdata(dev);
1978 ret = nvme_reset_ctrl_sync(ctrl);
1983 static DEVICE_ATTR(reset_controller, S_IWUSR, NULL, nvme_sysfs_reset);
1985 static ssize_t nvme_sysfs_rescan(struct device *dev,
1986 struct device_attribute *attr, const char *buf,
1989 struct nvme_ctrl *ctrl = dev_get_drvdata(dev);
1991 nvme_queue_scan(ctrl);
1994 static DEVICE_ATTR(rescan_controller, S_IWUSR, NULL, nvme_sysfs_rescan);
1996 static ssize_t wwid_show(struct device *dev, struct device_attribute *attr,
1999 struct nvme_ns *ns = nvme_get_ns_from_dev(dev);
2000 struct nvme_ctrl *ctrl = ns->ctrl;
2001 int serial_len = sizeof(ctrl->serial);
2002 int model_len = sizeof(ctrl->model);
2004 if (!uuid_is_null(&ns->uuid))
2005 return sprintf(buf, "uuid.%pU\n", &ns->uuid);
2007 if (memchr_inv(ns->nguid, 0, sizeof(ns->nguid)))
2008 return sprintf(buf, "eui.%16phN\n", ns->nguid);
2010 if (memchr_inv(ns->eui, 0, sizeof(ns->eui)))
2011 return sprintf(buf, "eui.%8phN\n", ns->eui);
2013 while (serial_len > 0 && (ctrl->serial[serial_len - 1] == ' ' ||
2014 ctrl->serial[serial_len - 1] == '\0'))
2016 while (model_len > 0 && (ctrl->model[model_len - 1] == ' ' ||
2017 ctrl->model[model_len - 1] == '\0'))
2020 return sprintf(buf, "nvme.%04x-%*phN-%*phN-%08x\n", ctrl->vid,
2021 serial_len, ctrl->serial, model_len, ctrl->model, ns->ns_id);
2023 static DEVICE_ATTR(wwid, S_IRUGO, wwid_show, NULL);
2025 static ssize_t nguid_show(struct device *dev, struct device_attribute *attr,
2028 struct nvme_ns *ns = nvme_get_ns_from_dev(dev);
2029 return sprintf(buf, "%pU\n", ns->nguid);
2031 static DEVICE_ATTR(nguid, S_IRUGO, nguid_show, NULL);
2033 static ssize_t uuid_show(struct device *dev, struct device_attribute *attr,
2036 struct nvme_ns *ns = nvme_get_ns_from_dev(dev);
2038 /* For backward compatibility expose the NGUID to userspace if
2039 * we have no UUID set
2041 if (uuid_is_null(&ns->uuid)) {
2042 printk_ratelimited(KERN_WARNING
2043 "No UUID available providing old NGUID\n");
2044 return sprintf(buf, "%pU\n", ns->nguid);
2046 return sprintf(buf, "%pU\n", &ns->uuid);
2048 static DEVICE_ATTR(uuid, S_IRUGO, uuid_show, NULL);
2050 static ssize_t eui_show(struct device *dev, struct device_attribute *attr,
2053 struct nvme_ns *ns = nvme_get_ns_from_dev(dev);
2054 return sprintf(buf, "%8phd\n", ns->eui);
2056 static DEVICE_ATTR(eui, S_IRUGO, eui_show, NULL);
2058 static ssize_t nsid_show(struct device *dev, struct device_attribute *attr,
2061 struct nvme_ns *ns = nvme_get_ns_from_dev(dev);
2062 return sprintf(buf, "%d\n", ns->ns_id);
2064 static DEVICE_ATTR(nsid, S_IRUGO, nsid_show, NULL);
2066 static struct attribute *nvme_ns_attrs[] = {
2067 &dev_attr_wwid.attr,
2068 &dev_attr_uuid.attr,
2069 &dev_attr_nguid.attr,
2071 &dev_attr_nsid.attr,
2075 static umode_t nvme_ns_attrs_are_visible(struct kobject *kobj,
2076 struct attribute *a, int n)
2078 struct device *dev = container_of(kobj, struct device, kobj);
2079 struct nvme_ns *ns = nvme_get_ns_from_dev(dev);
2081 if (a == &dev_attr_uuid.attr) {
2082 if (uuid_is_null(&ns->uuid) ||
2083 !memchr_inv(ns->nguid, 0, sizeof(ns->nguid)))
2086 if (a == &dev_attr_nguid.attr) {
2087 if (!memchr_inv(ns->nguid, 0, sizeof(ns->nguid)))
2090 if (a == &dev_attr_eui.attr) {
2091 if (!memchr_inv(ns->eui, 0, sizeof(ns->eui)))
2097 static const struct attribute_group nvme_ns_attr_group = {
2098 .attrs = nvme_ns_attrs,
2099 .is_visible = nvme_ns_attrs_are_visible,
2102 #define nvme_show_str_function(field) \
2103 static ssize_t field##_show(struct device *dev, \
2104 struct device_attribute *attr, char *buf) \
2106 struct nvme_ctrl *ctrl = dev_get_drvdata(dev); \
2107 return sprintf(buf, "%.*s\n", (int)sizeof(ctrl->field), ctrl->field); \
2109 static DEVICE_ATTR(field, S_IRUGO, field##_show, NULL);
2111 #define nvme_show_int_function(field) \
2112 static ssize_t field##_show(struct device *dev, \
2113 struct device_attribute *attr, char *buf) \
2115 struct nvme_ctrl *ctrl = dev_get_drvdata(dev); \
2116 return sprintf(buf, "%d\n", ctrl->field); \
2118 static DEVICE_ATTR(field, S_IRUGO, field##_show, NULL);
2120 nvme_show_str_function(model);
2121 nvme_show_str_function(serial);
2122 nvme_show_str_function(firmware_rev);
2123 nvme_show_int_function(cntlid);
2125 static ssize_t nvme_sysfs_delete(struct device *dev,
2126 struct device_attribute *attr, const char *buf,
2129 struct nvme_ctrl *ctrl = dev_get_drvdata(dev);
2131 if (device_remove_file_self(dev, attr))
2132 ctrl->ops->delete_ctrl(ctrl);
2135 static DEVICE_ATTR(delete_controller, S_IWUSR, NULL, nvme_sysfs_delete);
2137 static ssize_t nvme_sysfs_show_transport(struct device *dev,
2138 struct device_attribute *attr,
2141 struct nvme_ctrl *ctrl = dev_get_drvdata(dev);
2143 return snprintf(buf, PAGE_SIZE, "%s\n", ctrl->ops->name);
2145 static DEVICE_ATTR(transport, S_IRUGO, nvme_sysfs_show_transport, NULL);
2147 static ssize_t nvme_sysfs_show_state(struct device *dev,
2148 struct device_attribute *attr,
2151 struct nvme_ctrl *ctrl = dev_get_drvdata(dev);
2152 static const char *const state_name[] = {
2153 [NVME_CTRL_NEW] = "new",
2154 [NVME_CTRL_LIVE] = "live",
2155 [NVME_CTRL_RESETTING] = "resetting",
2156 [NVME_CTRL_RECONNECTING]= "reconnecting",
2157 [NVME_CTRL_DELETING] = "deleting",
2158 [NVME_CTRL_DEAD] = "dead",
2161 if ((unsigned)ctrl->state < ARRAY_SIZE(state_name) &&
2162 state_name[ctrl->state])
2163 return sprintf(buf, "%s\n", state_name[ctrl->state]);
2165 return sprintf(buf, "unknown state\n");
2168 static DEVICE_ATTR(state, S_IRUGO, nvme_sysfs_show_state, NULL);
2170 static ssize_t nvme_sysfs_show_subsysnqn(struct device *dev,
2171 struct device_attribute *attr,
2174 struct nvme_ctrl *ctrl = dev_get_drvdata(dev);
2176 return snprintf(buf, PAGE_SIZE, "%s\n", ctrl->subnqn);
2178 static DEVICE_ATTR(subsysnqn, S_IRUGO, nvme_sysfs_show_subsysnqn, NULL);
2180 static ssize_t nvme_sysfs_show_address(struct device *dev,
2181 struct device_attribute *attr,
2184 struct nvme_ctrl *ctrl = dev_get_drvdata(dev);
2186 return ctrl->ops->get_address(ctrl, buf, PAGE_SIZE);
2188 static DEVICE_ATTR(address, S_IRUGO, nvme_sysfs_show_address, NULL);
2190 static struct attribute *nvme_dev_attrs[] = {
2191 &dev_attr_reset_controller.attr,
2192 &dev_attr_rescan_controller.attr,
2193 &dev_attr_model.attr,
2194 &dev_attr_serial.attr,
2195 &dev_attr_firmware_rev.attr,
2196 &dev_attr_cntlid.attr,
2197 &dev_attr_delete_controller.attr,
2198 &dev_attr_transport.attr,
2199 &dev_attr_subsysnqn.attr,
2200 &dev_attr_address.attr,
2201 &dev_attr_state.attr,
2205 static umode_t nvme_dev_attrs_are_visible(struct kobject *kobj,
2206 struct attribute *a, int n)
2208 struct device *dev = container_of(kobj, struct device, kobj);
2209 struct nvme_ctrl *ctrl = dev_get_drvdata(dev);
2211 if (a == &dev_attr_delete_controller.attr && !ctrl->ops->delete_ctrl)
2213 if (a == &dev_attr_address.attr && !ctrl->ops->get_address)
2219 static struct attribute_group nvme_dev_attrs_group = {
2220 .attrs = nvme_dev_attrs,
2221 .is_visible = nvme_dev_attrs_are_visible,
2224 static const struct attribute_group *nvme_dev_attr_groups[] = {
2225 &nvme_dev_attrs_group,
2229 static int ns_cmp(void *priv, struct list_head *a, struct list_head *b)
2231 struct nvme_ns *nsa = container_of(a, struct nvme_ns, list);
2232 struct nvme_ns *nsb = container_of(b, struct nvme_ns, list);
2234 return nsa->ns_id - nsb->ns_id;
2237 static struct nvme_ns *nvme_find_get_ns(struct nvme_ctrl *ctrl, unsigned nsid)
2239 struct nvme_ns *ns, *ret = NULL;
2241 mutex_lock(&ctrl->namespaces_mutex);
2242 list_for_each_entry(ns, &ctrl->namespaces, list) {
2243 if (ns->ns_id == nsid) {
2244 kref_get(&ns->kref);
2248 if (ns->ns_id > nsid)
2251 mutex_unlock(&ctrl->namespaces_mutex);
2255 static int nvme_setup_streams_ns(struct nvme_ctrl *ctrl, struct nvme_ns *ns)
2257 struct streams_directive_params s;
2260 if (!ctrl->nr_streams)
2263 ret = nvme_get_stream_params(ctrl, &s, ns->ns_id);
2267 ns->sws = le32_to_cpu(s.sws);
2268 ns->sgs = le16_to_cpu(s.sgs);
2271 unsigned int bs = 1 << ns->lba_shift;
2273 blk_queue_io_min(ns->queue, bs * ns->sws);
2275 blk_queue_io_opt(ns->queue, bs * ns->sws * ns->sgs);
2281 static void nvme_alloc_ns(struct nvme_ctrl *ctrl, unsigned nsid)
2284 struct gendisk *disk;
2285 struct nvme_id_ns *id;
2286 char disk_name[DISK_NAME_LEN];
2287 int node = dev_to_node(ctrl->dev);
2289 ns = kzalloc_node(sizeof(*ns), GFP_KERNEL, node);
2293 ns->instance = ida_simple_get(&ctrl->ns_ida, 1, 0, GFP_KERNEL);
2294 if (ns->instance < 0)
2297 ns->queue = blk_mq_init_queue(ctrl->tagset);
2298 if (IS_ERR(ns->queue))
2299 goto out_release_instance;
2300 queue_flag_set_unlocked(QUEUE_FLAG_NONROT, ns->queue);
2301 ns->queue->queuedata = ns;
2304 kref_init(&ns->kref);
2306 ns->lba_shift = 9; /* set to a default value for 512 until disk is validated */
2308 blk_queue_logical_block_size(ns->queue, 1 << ns->lba_shift);
2309 nvme_set_queue_limits(ctrl, ns->queue);
2310 nvme_setup_streams_ns(ctrl, ns);
2312 sprintf(disk_name, "nvme%dn%d", ctrl->instance, ns->instance);
2314 if (nvme_revalidate_ns(ns, &id))
2315 goto out_free_queue;
2317 if (nvme_nvm_ns_supported(ns, id) &&
2318 nvme_nvm_register(ns, disk_name, node)) {
2319 dev_warn(ctrl->device, "%s: LightNVM init failure\n", __func__);
2323 disk = alloc_disk_node(0, node);
2327 disk->fops = &nvme_fops;
2328 disk->private_data = ns;
2329 disk->queue = ns->queue;
2330 disk->flags = GENHD_FL_EXT_DEVT;
2331 memcpy(disk->disk_name, disk_name, DISK_NAME_LEN);
2334 __nvme_revalidate_disk(disk, id);
2336 mutex_lock(&ctrl->namespaces_mutex);
2337 list_add_tail(&ns->list, &ctrl->namespaces);
2338 mutex_unlock(&ctrl->namespaces_mutex);
2340 kref_get(&ctrl->kref);
2344 device_add_disk(ctrl->device, ns->disk);
2345 if (sysfs_create_group(&disk_to_dev(ns->disk)->kobj,
2346 &nvme_ns_attr_group))
2347 pr_warn("%s: failed to create sysfs group for identification\n",
2348 ns->disk->disk_name);
2349 if (ns->ndev && nvme_nvm_register_sysfs(ns))
2350 pr_warn("%s: failed to register lightnvm sysfs group for identification\n",
2351 ns->disk->disk_name);
2356 blk_cleanup_queue(ns->queue);
2357 out_release_instance:
2358 ida_simple_remove(&ctrl->ns_ida, ns->instance);
2363 static void nvme_ns_remove(struct nvme_ns *ns)
2365 if (test_and_set_bit(NVME_NS_REMOVING, &ns->flags))
2368 if (ns->disk && ns->disk->flags & GENHD_FL_UP) {
2369 if (blk_get_integrity(ns->disk))
2370 blk_integrity_unregister(ns->disk);
2371 sysfs_remove_group(&disk_to_dev(ns->disk)->kobj,
2372 &nvme_ns_attr_group);
2374 nvme_nvm_unregister_sysfs(ns);
2375 del_gendisk(ns->disk);
2376 blk_cleanup_queue(ns->queue);
2379 mutex_lock(&ns->ctrl->namespaces_mutex);
2380 list_del_init(&ns->list);
2381 mutex_unlock(&ns->ctrl->namespaces_mutex);
2386 static void nvme_validate_ns(struct nvme_ctrl *ctrl, unsigned nsid)
2390 ns = nvme_find_get_ns(ctrl, nsid);
2392 if (ns->disk && revalidate_disk(ns->disk))
2396 nvme_alloc_ns(ctrl, nsid);
2399 static void nvme_remove_invalid_namespaces(struct nvme_ctrl *ctrl,
2402 struct nvme_ns *ns, *next;
2404 list_for_each_entry_safe(ns, next, &ctrl->namespaces, list) {
2405 if (ns->ns_id > nsid)
2410 static int nvme_scan_ns_list(struct nvme_ctrl *ctrl, unsigned nn)
2414 unsigned i, j, nsid, prev = 0, num_lists = DIV_ROUND_UP(nn, 1024);
2417 ns_list = kzalloc(0x1000, GFP_KERNEL);
2421 for (i = 0; i < num_lists; i++) {
2422 ret = nvme_identify_ns_list(ctrl, prev, ns_list);
2426 for (j = 0; j < min(nn, 1024U); j++) {
2427 nsid = le32_to_cpu(ns_list[j]);
2431 nvme_validate_ns(ctrl, nsid);
2433 while (++prev < nsid) {
2434 ns = nvme_find_get_ns(ctrl, prev);
2444 nvme_remove_invalid_namespaces(ctrl, prev);
2450 static void nvme_scan_ns_sequential(struct nvme_ctrl *ctrl, unsigned nn)
2454 for (i = 1; i <= nn; i++)
2455 nvme_validate_ns(ctrl, i);
2457 nvme_remove_invalid_namespaces(ctrl, nn);
2460 static void nvme_scan_work(struct work_struct *work)
2462 struct nvme_ctrl *ctrl =
2463 container_of(work, struct nvme_ctrl, scan_work);
2464 struct nvme_id_ctrl *id;
2467 if (ctrl->state != NVME_CTRL_LIVE)
2470 if (nvme_identify_ctrl(ctrl, &id))
2473 nn = le32_to_cpu(id->nn);
2474 if (ctrl->vs >= NVME_VS(1, 1, 0) &&
2475 !(ctrl->quirks & NVME_QUIRK_IDENTIFY_CNS)) {
2476 if (!nvme_scan_ns_list(ctrl, nn))
2479 nvme_scan_ns_sequential(ctrl, nn);
2481 mutex_lock(&ctrl->namespaces_mutex);
2482 list_sort(NULL, &ctrl->namespaces, ns_cmp);
2483 mutex_unlock(&ctrl->namespaces_mutex);
2487 void nvme_queue_scan(struct nvme_ctrl *ctrl)
2490 * Do not queue new scan work when a controller is reset during
2493 if (ctrl->state == NVME_CTRL_LIVE)
2494 queue_work(nvme_wq, &ctrl->scan_work);
2496 EXPORT_SYMBOL_GPL(nvme_queue_scan);
2499 * This function iterates the namespace list unlocked to allow recovery from
2500 * controller failure. It is up to the caller to ensure the namespace list is
2501 * not modified by scan work while this function is executing.
2503 void nvme_remove_namespaces(struct nvme_ctrl *ctrl)
2505 struct nvme_ns *ns, *next;
2508 * The dead states indicates the controller was not gracefully
2509 * disconnected. In that case, we won't be able to flush any data while
2510 * removing the namespaces' disks; fail all the queues now to avoid
2511 * potentially having to clean up the failed sync later.
2513 if (ctrl->state == NVME_CTRL_DEAD)
2514 nvme_kill_queues(ctrl);
2516 list_for_each_entry_safe(ns, next, &ctrl->namespaces, list)
2519 EXPORT_SYMBOL_GPL(nvme_remove_namespaces);
2521 static void nvme_async_event_work(struct work_struct *work)
2523 struct nvme_ctrl *ctrl =
2524 container_of(work, struct nvme_ctrl, async_event_work);
2526 spin_lock_irq(&ctrl->lock);
2527 while (ctrl->event_limit > 0) {
2528 int aer_idx = --ctrl->event_limit;
2530 spin_unlock_irq(&ctrl->lock);
2531 ctrl->ops->submit_async_event(ctrl, aer_idx);
2532 spin_lock_irq(&ctrl->lock);
2534 spin_unlock_irq(&ctrl->lock);
2537 void nvme_complete_async_event(struct nvme_ctrl *ctrl, __le16 status,
2538 union nvme_result *res)
2540 u32 result = le32_to_cpu(res->u32);
2543 switch (le16_to_cpu(status) >> 1) {
2544 case NVME_SC_SUCCESS:
2547 case NVME_SC_ABORT_REQ:
2548 ++ctrl->event_limit;
2549 queue_work(nvme_wq, &ctrl->async_event_work);
2558 switch (result & 0xff07) {
2559 case NVME_AER_NOTICE_NS_CHANGED:
2560 dev_info(ctrl->device, "rescanning\n");
2561 nvme_queue_scan(ctrl);
2564 dev_warn(ctrl->device, "async event result %08x\n", result);
2567 EXPORT_SYMBOL_GPL(nvme_complete_async_event);
2569 void nvme_queue_async_events(struct nvme_ctrl *ctrl)
2571 ctrl->event_limit = NVME_NR_AERS;
2572 queue_work(nvme_wq, &ctrl->async_event_work);
2574 EXPORT_SYMBOL_GPL(nvme_queue_async_events);
2576 static DEFINE_IDA(nvme_instance_ida);
2578 static int nvme_set_instance(struct nvme_ctrl *ctrl)
2580 int instance, error;
2583 if (!ida_pre_get(&nvme_instance_ida, GFP_KERNEL))
2586 spin_lock(&dev_list_lock);
2587 error = ida_get_new(&nvme_instance_ida, &instance);
2588 spin_unlock(&dev_list_lock);
2589 } while (error == -EAGAIN);
2594 ctrl->instance = instance;
2598 static void nvme_release_instance(struct nvme_ctrl *ctrl)
2600 spin_lock(&dev_list_lock);
2601 ida_remove(&nvme_instance_ida, ctrl->instance);
2602 spin_unlock(&dev_list_lock);
2605 void nvme_stop_ctrl(struct nvme_ctrl *ctrl)
2607 nvme_stop_keep_alive(ctrl);
2608 flush_work(&ctrl->async_event_work);
2609 flush_work(&ctrl->scan_work);
2611 EXPORT_SYMBOL_GPL(nvme_stop_ctrl);
2613 void nvme_start_ctrl(struct nvme_ctrl *ctrl)
2616 nvme_start_keep_alive(ctrl);
2618 if (ctrl->queue_count > 1) {
2619 nvme_queue_scan(ctrl);
2620 nvme_queue_async_events(ctrl);
2621 nvme_start_queues(ctrl);
2624 EXPORT_SYMBOL_GPL(nvme_start_ctrl);
2626 void nvme_uninit_ctrl(struct nvme_ctrl *ctrl)
2628 device_destroy(nvme_class, MKDEV(nvme_char_major, ctrl->instance));
2630 spin_lock(&dev_list_lock);
2631 list_del(&ctrl->node);
2632 spin_unlock(&dev_list_lock);
2634 EXPORT_SYMBOL_GPL(nvme_uninit_ctrl);
2636 static void nvme_free_ctrl(struct kref *kref)
2638 struct nvme_ctrl *ctrl = container_of(kref, struct nvme_ctrl, kref);
2640 put_device(ctrl->device);
2641 nvme_release_instance(ctrl);
2642 ida_destroy(&ctrl->ns_ida);
2644 ctrl->ops->free_ctrl(ctrl);
2647 void nvme_put_ctrl(struct nvme_ctrl *ctrl)
2649 kref_put(&ctrl->kref, nvme_free_ctrl);
2651 EXPORT_SYMBOL_GPL(nvme_put_ctrl);
2654 * Initialize a NVMe controller structures. This needs to be called during
2655 * earliest initialization so that we have the initialized structured around
2658 int nvme_init_ctrl(struct nvme_ctrl *ctrl, struct device *dev,
2659 const struct nvme_ctrl_ops *ops, unsigned long quirks)
2663 ctrl->state = NVME_CTRL_NEW;
2664 spin_lock_init(&ctrl->lock);
2665 INIT_LIST_HEAD(&ctrl->namespaces);
2666 mutex_init(&ctrl->namespaces_mutex);
2667 kref_init(&ctrl->kref);
2670 ctrl->quirks = quirks;
2671 INIT_WORK(&ctrl->scan_work, nvme_scan_work);
2672 INIT_WORK(&ctrl->async_event_work, nvme_async_event_work);
2674 ret = nvme_set_instance(ctrl);
2678 ctrl->device = device_create_with_groups(nvme_class, ctrl->dev,
2679 MKDEV(nvme_char_major, ctrl->instance),
2680 ctrl, nvme_dev_attr_groups,
2681 "nvme%d", ctrl->instance);
2682 if (IS_ERR(ctrl->device)) {
2683 ret = PTR_ERR(ctrl->device);
2684 goto out_release_instance;
2686 get_device(ctrl->device);
2687 ida_init(&ctrl->ns_ida);
2689 spin_lock(&dev_list_lock);
2690 list_add_tail(&ctrl->node, &nvme_ctrl_list);
2691 spin_unlock(&dev_list_lock);
2694 * Initialize latency tolerance controls. The sysfs files won't
2695 * be visible to userspace unless the device actually supports APST.
2697 ctrl->device->power.set_latency_tolerance = nvme_set_latency_tolerance;
2698 dev_pm_qos_update_user_latency_tolerance(ctrl->device,
2699 min(default_ps_max_latency_us, (unsigned long)S32_MAX));
2702 out_release_instance:
2703 nvme_release_instance(ctrl);
2707 EXPORT_SYMBOL_GPL(nvme_init_ctrl);
2710 * nvme_kill_queues(): Ends all namespace queues
2711 * @ctrl: the dead controller that needs to end
2713 * Call this function when the driver determines it is unable to get the
2714 * controller in a state capable of servicing IO.
2716 void nvme_kill_queues(struct nvme_ctrl *ctrl)
2720 mutex_lock(&ctrl->namespaces_mutex);
2722 /* Forcibly unquiesce queues to avoid blocking dispatch */
2724 blk_mq_unquiesce_queue(ctrl->admin_q);
2726 list_for_each_entry(ns, &ctrl->namespaces, list) {
2728 * Revalidating a dead namespace sets capacity to 0. This will
2729 * end buffered writers dirtying pages that can't be synced.
2731 if (!ns->disk || test_and_set_bit(NVME_NS_DEAD, &ns->flags))
2733 revalidate_disk(ns->disk);
2734 blk_set_queue_dying(ns->queue);
2736 /* Forcibly unquiesce queues to avoid blocking dispatch */
2737 blk_mq_unquiesce_queue(ns->queue);
2739 mutex_unlock(&ctrl->namespaces_mutex);
2741 EXPORT_SYMBOL_GPL(nvme_kill_queues);
2743 void nvme_unfreeze(struct nvme_ctrl *ctrl)
2747 mutex_lock(&ctrl->namespaces_mutex);
2748 list_for_each_entry(ns, &ctrl->namespaces, list)
2749 blk_mq_unfreeze_queue(ns->queue);
2750 mutex_unlock(&ctrl->namespaces_mutex);
2752 EXPORT_SYMBOL_GPL(nvme_unfreeze);
2754 void nvme_wait_freeze_timeout(struct nvme_ctrl *ctrl, long timeout)
2758 mutex_lock(&ctrl->namespaces_mutex);
2759 list_for_each_entry(ns, &ctrl->namespaces, list) {
2760 timeout = blk_mq_freeze_queue_wait_timeout(ns->queue, timeout);
2764 mutex_unlock(&ctrl->namespaces_mutex);
2766 EXPORT_SYMBOL_GPL(nvme_wait_freeze_timeout);
2768 void nvme_wait_freeze(struct nvme_ctrl *ctrl)
2772 mutex_lock(&ctrl->namespaces_mutex);
2773 list_for_each_entry(ns, &ctrl->namespaces, list)
2774 blk_mq_freeze_queue_wait(ns->queue);
2775 mutex_unlock(&ctrl->namespaces_mutex);
2777 EXPORT_SYMBOL_GPL(nvme_wait_freeze);
2779 void nvme_start_freeze(struct nvme_ctrl *ctrl)
2783 mutex_lock(&ctrl->namespaces_mutex);
2784 list_for_each_entry(ns, &ctrl->namespaces, list)
2785 blk_freeze_queue_start(ns->queue);
2786 mutex_unlock(&ctrl->namespaces_mutex);
2788 EXPORT_SYMBOL_GPL(nvme_start_freeze);
2790 void nvme_stop_queues(struct nvme_ctrl *ctrl)
2794 mutex_lock(&ctrl->namespaces_mutex);
2795 list_for_each_entry(ns, &ctrl->namespaces, list)
2796 blk_mq_quiesce_queue(ns->queue);
2797 mutex_unlock(&ctrl->namespaces_mutex);
2799 EXPORT_SYMBOL_GPL(nvme_stop_queues);
2801 void nvme_start_queues(struct nvme_ctrl *ctrl)
2805 mutex_lock(&ctrl->namespaces_mutex);
2806 list_for_each_entry(ns, &ctrl->namespaces, list)
2807 blk_mq_unquiesce_queue(ns->queue);
2808 mutex_unlock(&ctrl->namespaces_mutex);
2810 EXPORT_SYMBOL_GPL(nvme_start_queues);
2812 int __init nvme_core_init(void)
2816 nvme_wq = alloc_workqueue("nvme-wq",
2817 WQ_UNBOUND | WQ_MEM_RECLAIM | WQ_SYSFS, 0);
2821 result = __register_chrdev(nvme_char_major, 0, NVME_MINORS, "nvme",
2825 else if (result > 0)
2826 nvme_char_major = result;
2828 nvme_class = class_create(THIS_MODULE, "nvme");
2829 if (IS_ERR(nvme_class)) {
2830 result = PTR_ERR(nvme_class);
2831 goto unregister_chrdev;
2837 __unregister_chrdev(nvme_char_major, 0, NVME_MINORS, "nvme");
2839 destroy_workqueue(nvme_wq);
2843 void nvme_core_exit(void)
2845 class_destroy(nvme_class);
2846 __unregister_chrdev(nvme_char_major, 0, NVME_MINORS, "nvme");
2847 destroy_workqueue(nvme_wq);
2850 MODULE_LICENSE("GPL");
2851 MODULE_VERSION("1.0");
2852 module_init(nvme_core_init);
2853 module_exit(nvme_core_exit);