xref: /openbmc/linux/drivers/nvme/host/pr.c (revision f0614790)
1b668f2f5SMike Christie // SPDX-License-Identifier: GPL-2.0
2b668f2f5SMike Christie /*
3b668f2f5SMike Christie  * Copyright (c) 2015 Intel Corporation
4b668f2f5SMike Christie  *	Keith Busch <kbusch@kernel.org>
5b668f2f5SMike Christie  */
6b668f2f5SMike Christie #include <linux/blkdev.h>
7b668f2f5SMike Christie #include <linux/pr.h>
8b668f2f5SMike Christie #include <asm/unaligned.h>
9b668f2f5SMike Christie 
10b668f2f5SMike Christie #include "nvme.h"
11b668f2f5SMike Christie 
12b668f2f5SMike Christie static char nvme_pr_type(enum pr_type type)
13b668f2f5SMike Christie {
14b668f2f5SMike Christie 	switch (type) {
15b668f2f5SMike Christie 	case PR_WRITE_EXCLUSIVE:
16b668f2f5SMike Christie 		return 1;
17b668f2f5SMike Christie 	case PR_EXCLUSIVE_ACCESS:
18b668f2f5SMike Christie 		return 2;
19b668f2f5SMike Christie 	case PR_WRITE_EXCLUSIVE_REG_ONLY:
20b668f2f5SMike Christie 		return 3;
21b668f2f5SMike Christie 	case PR_EXCLUSIVE_ACCESS_REG_ONLY:
22b668f2f5SMike Christie 		return 4;
23b668f2f5SMike Christie 	case PR_WRITE_EXCLUSIVE_ALL_REGS:
24b668f2f5SMike Christie 		return 5;
25b668f2f5SMike Christie 	case PR_EXCLUSIVE_ACCESS_ALL_REGS:
26b668f2f5SMike Christie 		return 6;
27b668f2f5SMike Christie 	default:
28b668f2f5SMike Christie 		return 0;
29b668f2f5SMike Christie 	}
30b668f2f5SMike Christie }
31b668f2f5SMike Christie 
32b668f2f5SMike Christie static int nvme_send_ns_head_pr_command(struct block_device *bdev,
33*f0614790SMike Christie 		struct nvme_command *c, void *data, unsigned int data_len)
34b668f2f5SMike Christie {
35b668f2f5SMike Christie 	struct nvme_ns_head *head = bdev->bd_disk->private_data;
36b668f2f5SMike Christie 	int srcu_idx = srcu_read_lock(&head->srcu);
37b668f2f5SMike Christie 	struct nvme_ns *ns = nvme_find_path(head);
38b668f2f5SMike Christie 	int ret = -EWOULDBLOCK;
39b668f2f5SMike Christie 
40b668f2f5SMike Christie 	if (ns) {
41b668f2f5SMike Christie 		c->common.nsid = cpu_to_le32(ns->head->ns_id);
42b668f2f5SMike Christie 		ret = nvme_submit_sync_cmd(ns->queue, c, data, data_len);
43b668f2f5SMike Christie 	}
44b668f2f5SMike Christie 	srcu_read_unlock(&head->srcu, srcu_idx);
45b668f2f5SMike Christie 	return ret;
46b668f2f5SMike Christie }
47b668f2f5SMike Christie 
48b668f2f5SMike Christie static int nvme_send_ns_pr_command(struct nvme_ns *ns, struct nvme_command *c,
49*f0614790SMike Christie 		void *data, unsigned int data_len)
50b668f2f5SMike Christie {
51b668f2f5SMike Christie 	c->common.nsid = cpu_to_le32(ns->head->ns_id);
52b668f2f5SMike Christie 	return nvme_submit_sync_cmd(ns->queue, c, data, data_len);
53b668f2f5SMike Christie }
54b668f2f5SMike Christie 
55b668f2f5SMike Christie static int nvme_sc_to_pr_err(int nvme_sc)
56b668f2f5SMike Christie {
57b668f2f5SMike Christie 	if (nvme_is_path_error(nvme_sc))
58b668f2f5SMike Christie 		return PR_STS_PATH_FAILED;
59b668f2f5SMike Christie 
60b668f2f5SMike Christie 	switch (nvme_sc) {
61b668f2f5SMike Christie 	case NVME_SC_SUCCESS:
62b668f2f5SMike Christie 		return PR_STS_SUCCESS;
63b668f2f5SMike Christie 	case NVME_SC_RESERVATION_CONFLICT:
64b668f2f5SMike Christie 		return PR_STS_RESERVATION_CONFLICT;
65b668f2f5SMike Christie 	case NVME_SC_ONCS_NOT_SUPPORTED:
66b668f2f5SMike Christie 		return -EOPNOTSUPP;
67b668f2f5SMike Christie 	case NVME_SC_BAD_ATTRIBUTES:
68b668f2f5SMike Christie 	case NVME_SC_INVALID_OPCODE:
69b668f2f5SMike Christie 	case NVME_SC_INVALID_FIELD:
70b668f2f5SMike Christie 	case NVME_SC_INVALID_NS:
71b668f2f5SMike Christie 		return -EINVAL;
72b668f2f5SMike Christie 	default:
73b668f2f5SMike Christie 		return PR_STS_IOERR;
74b668f2f5SMike Christie 	}
75b668f2f5SMike Christie }
76b668f2f5SMike Christie 
77*f0614790SMike Christie static int nvme_send_pr_command(struct block_device *bdev,
78*f0614790SMike Christie 		struct nvme_command *c, void *data, unsigned int data_len)
79*f0614790SMike Christie {
80*f0614790SMike Christie 	if (IS_ENABLED(CONFIG_NVME_MULTIPATH) &&
81*f0614790SMike Christie 	    bdev->bd_disk->fops == &nvme_ns_head_ops)
82*f0614790SMike Christie 		return nvme_send_ns_head_pr_command(bdev, c, data, data_len);
83*f0614790SMike Christie 
84*f0614790SMike Christie 	return nvme_send_ns_pr_command(bdev->bd_disk->private_data, c, data,
85*f0614790SMike Christie 				       data_len);
86*f0614790SMike Christie }
87*f0614790SMike Christie 
88b668f2f5SMike Christie static int nvme_pr_command(struct block_device *bdev, u32 cdw10,
89b668f2f5SMike Christie 				u64 key, u64 sa_key, u8 op)
90b668f2f5SMike Christie {
91b668f2f5SMike Christie 	struct nvme_command c = { };
92b668f2f5SMike Christie 	u8 data[16] = { 0, };
93b668f2f5SMike Christie 	int ret;
94b668f2f5SMike Christie 
95b668f2f5SMike Christie 	put_unaligned_le64(key, &data[0]);
96b668f2f5SMike Christie 	put_unaligned_le64(sa_key, &data[8]);
97b668f2f5SMike Christie 
98b668f2f5SMike Christie 	c.common.opcode = op;
99b668f2f5SMike Christie 	c.common.cdw10 = cpu_to_le32(cdw10);
100b668f2f5SMike Christie 
101*f0614790SMike Christie 	ret = nvme_send_pr_command(bdev, &c, data, sizeof(data));
102b668f2f5SMike Christie 	if (ret < 0)
103b668f2f5SMike Christie 		return ret;
104b668f2f5SMike Christie 
105b668f2f5SMike Christie 	return nvme_sc_to_pr_err(ret);
106b668f2f5SMike Christie }
107b668f2f5SMike Christie 
108b668f2f5SMike Christie static int nvme_pr_register(struct block_device *bdev, u64 old,
109b668f2f5SMike Christie 		u64 new, unsigned flags)
110b668f2f5SMike Christie {
111b668f2f5SMike Christie 	u32 cdw10;
112b668f2f5SMike Christie 
113b668f2f5SMike Christie 	if (flags & ~PR_FL_IGNORE_KEY)
114b668f2f5SMike Christie 		return -EOPNOTSUPP;
115b668f2f5SMike Christie 
116b668f2f5SMike Christie 	cdw10 = old ? 2 : 0;
117b668f2f5SMike Christie 	cdw10 |= (flags & PR_FL_IGNORE_KEY) ? 1 << 3 : 0;
118b668f2f5SMike Christie 	cdw10 |= (1 << 30) | (1 << 31); /* PTPL=1 */
119b668f2f5SMike Christie 	return nvme_pr_command(bdev, cdw10, old, new, nvme_cmd_resv_register);
120b668f2f5SMike Christie }
121b668f2f5SMike Christie 
122b668f2f5SMike Christie static int nvme_pr_reserve(struct block_device *bdev, u64 key,
123b668f2f5SMike Christie 		enum pr_type type, unsigned flags)
124b668f2f5SMike Christie {
125b668f2f5SMike Christie 	u32 cdw10;
126b668f2f5SMike Christie 
127b668f2f5SMike Christie 	if (flags & ~PR_FL_IGNORE_KEY)
128b668f2f5SMike Christie 		return -EOPNOTSUPP;
129b668f2f5SMike Christie 
130b668f2f5SMike Christie 	cdw10 = nvme_pr_type(type) << 8;
131b668f2f5SMike Christie 	cdw10 |= ((flags & PR_FL_IGNORE_KEY) ? 1 << 3 : 0);
132b668f2f5SMike Christie 	return nvme_pr_command(bdev, cdw10, key, 0, nvme_cmd_resv_acquire);
133b668f2f5SMike Christie }
134b668f2f5SMike Christie 
135b668f2f5SMike Christie static int nvme_pr_preempt(struct block_device *bdev, u64 old, u64 new,
136b668f2f5SMike Christie 		enum pr_type type, bool abort)
137b668f2f5SMike Christie {
138b668f2f5SMike Christie 	u32 cdw10 = nvme_pr_type(type) << 8 | (abort ? 2 : 1);
139b668f2f5SMike Christie 
140b668f2f5SMike Christie 	return nvme_pr_command(bdev, cdw10, old, new, nvme_cmd_resv_acquire);
141b668f2f5SMike Christie }
142b668f2f5SMike Christie 
143b668f2f5SMike Christie static int nvme_pr_clear(struct block_device *bdev, u64 key)
144b668f2f5SMike Christie {
145b668f2f5SMike Christie 	u32 cdw10 = 1 | (key ? 0 : 1 << 3);
146b668f2f5SMike Christie 
147b668f2f5SMike Christie 	return nvme_pr_command(bdev, cdw10, key, 0, nvme_cmd_resv_release);
148b668f2f5SMike Christie }
149b668f2f5SMike Christie 
150b668f2f5SMike Christie static int nvme_pr_release(struct block_device *bdev, u64 key, enum pr_type type)
151b668f2f5SMike Christie {
152b668f2f5SMike Christie 	u32 cdw10 = nvme_pr_type(type) << 8 | (key ? 0 : 1 << 3);
153b668f2f5SMike Christie 
154b668f2f5SMike Christie 	return nvme_pr_command(bdev, cdw10, key, 0, nvme_cmd_resv_release);
155b668f2f5SMike Christie }
156b668f2f5SMike Christie 
157b668f2f5SMike Christie const struct pr_ops nvme_pr_ops = {
158b668f2f5SMike Christie 	.pr_register	= nvme_pr_register,
159b668f2f5SMike Christie 	.pr_reserve	= nvme_pr_reserve,
160b668f2f5SMike Christie 	.pr_release	= nvme_pr_release,
161b668f2f5SMike Christie 	.pr_preempt	= nvme_pr_preempt,
162b668f2f5SMike Christie 	.pr_clear	= nvme_pr_clear,
163b668f2f5SMike Christie };
164