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 * 2. Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 *
13 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23 * SUCH DAMAGE.
24 */
25
26 #include <sys/param.h>
27 #include <sys/ioccom.h>
28
29 #include <ctype.h>
30 #include <err.h>
31 #include <fcntl.h>
32 #include <stdbool.h>
33 #include <stddef.h>
34 #include <stdio.h>
35 #include <stdlib.h>
36 #include <string.h>
37 #include <sysexits.h>
38 #include <unistd.h>
39
40 #include "nvmecontrol.h"
41
42 _Static_assert(sizeof(struct nvme_power_state) == 256 / NBBY,
43 "nvme_power_state size wrong");
44
45 #define POWER_NONE 0xffffffffu
46
47 static struct options {
48 bool list;
49 uint32_t power;
50 uint32_t workload;
51 const char *dev;
52 } opt = {
53 .list = false,
54 .power = POWER_NONE,
55 .workload = 0,
56 .dev = NULL,
57 };
58
59 static void
power_list_one(int i,struct nvme_power_state * nps)60 power_list_one(int i, struct nvme_power_state *nps)
61 {
62 int mpower, apower, ipower;
63 uint8_t mps, nops, aps, apw;
64
65 mps = NVMEV(NVME_PWR_ST_MPS, nps->mps_nops);
66 nops = NVMEV(NVME_PWR_ST_NOPS, nps->mps_nops);
67 apw = NVMEV(NVME_PWR_ST_APW, nps->apw_aps);
68 aps = NVMEV(NVME_PWR_ST_APS, nps->apw_aps);
69
70 mpower = nps->mp;
71 if (mps == 0)
72 mpower *= 100;
73 ipower = nps->idlp;
74 if (nps->ips == 1)
75 ipower *= 100;
76 apower = nps->actp;
77 if (aps == 1)
78 apower *= 100;
79 printf("%2d: %2d.%04dW%c %3d.%03dms %3d.%03dms %2d %2d %2d %2d %2d.%04dW %2d.%04dW %d\n",
80 i, mpower / 10000, mpower % 10000,
81 nops ? '*' : ' ', nps->enlat / 1000, nps->enlat % 1000,
82 nps->exlat / 1000, nps->exlat % 1000, nps->rrt, nps->rrl,
83 nps->rwt, nps->rwl, ipower / 10000, ipower % 10000,
84 apower / 10000, apower % 10000, apw);
85 }
86
87 static void
power_list(struct nvme_controller_data * cdata)88 power_list(struct nvme_controller_data *cdata)
89 {
90 int i;
91
92 printf("\nPower States Supported: %d\n\n", cdata->npss + 1);
93 printf(" # Max pwr Enter Lat Exit Lat RT RL WT WL Idle Pwr Act Pwr Workloadd\n");
94 printf("-- -------- --------- --------- -- -- -- -- -------- -------- --\n");
95 for (i = 0; i <= cdata->npss; i++)
96 power_list_one(i, &cdata->power_state[i]);
97 }
98
99 static void
power_set(int fd,int power_val,int workload,int perm)100 power_set(int fd, int power_val, int workload, int perm)
101 {
102 struct nvme_pt_command pt;
103 uint32_t p;
104
105 p = perm ? (1u << 31) : 0;
106 memset(&pt, 0, sizeof(pt));
107 pt.cmd.opc = NVME_OPC_SET_FEATURES;
108 pt.cmd.cdw10 = htole32(NVME_FEAT_POWER_MANAGEMENT | p);
109 pt.cmd.cdw11 = htole32(power_val | (workload << 5));
110
111 if (ioctl(fd, NVME_PASSTHROUGH_CMD, &pt) < 0)
112 err(EX_IOERR, "set feature power mgmt request failed");
113
114 if (nvme_completion_is_error(&pt.cpl))
115 errx(EX_IOERR, "set feature power mgmt request returned error");
116 }
117
118 static void
power_show(int fd)119 power_show(int fd)
120 {
121 struct nvme_pt_command pt;
122
123 memset(&pt, 0, sizeof(pt));
124 pt.cmd.opc = NVME_OPC_GET_FEATURES;
125 pt.cmd.cdw10 = htole32(NVME_FEAT_POWER_MANAGEMENT);
126
127 if (ioctl(fd, NVME_PASSTHROUGH_CMD, &pt) < 0)
128 err(EX_IOERR, "set feature power mgmt request failed");
129
130 if (nvme_completion_is_error(&pt.cpl))
131 errx(EX_IOERR, "set feature power mgmt request returned error");
132
133 printf("Current Power State is %d\n", pt.cpl.cdw0 & 0x1F);
134 printf("Current Workload Hint is %d\n", pt.cpl.cdw0 >> 5);
135 }
136
137 static void
power(const struct cmd * f,int argc,char * argv[])138 power(const struct cmd *f, int argc, char *argv[])
139 {
140 struct nvme_controller_data cdata;
141 int fd;
142 char *path;
143 uint32_t nsid;
144
145 if (arg_parse(argc, argv, f))
146 return;
147
148 if (opt.list && opt.power != POWER_NONE) {
149 fprintf(stderr, "Can't set power and list power states\n");
150 arg_help(argc, argv, f);
151 }
152
153 open_dev(opt.dev, &fd, 1, 1);
154 get_nsid(fd, &path, &nsid);
155 if (nsid != 0) {
156 close(fd);
157 open_dev(path, &fd, 1, 1);
158 }
159 free(path);
160
161 if (opt.list) {
162 if (read_controller_data(fd, &cdata))
163 errx(EX_IOERR, "Identify request failed");
164 power_list(&cdata);
165 goto out;
166 }
167
168 if (opt.power != POWER_NONE) {
169 power_set(fd, opt.power, opt.workload, 0);
170 goto out;
171 }
172 power_show(fd);
173
174 out:
175 close(fd);
176 exit(0);
177 }
178
179 static const struct opts power_opts[] = {
180 #define OPT(l, s, t, opt, addr, desc) { l, s, t, &opt.addr, desc }
181 OPT("list", 'l', arg_none, opt, list,
182 "List the valid power states"),
183 OPT("power", 'p', arg_uint32, opt, power,
184 "Set the power state"),
185 OPT("workload", 'w', arg_uint32, opt, workload,
186 "Set the workload hint"),
187 { NULL, 0, arg_none, NULL, NULL }
188 };
189 #undef OPT
190
191 static const struct args power_args[] = {
192 { arg_string, &opt.dev, "controller-id|namespace-id" },
193 { arg_none, NULL, NULL },
194 };
195
196 static struct cmd power_cmd = {
197 .name = "power",
198 .fn = power,
199 .descr = "Manage power states for the drive",
200 .ctx_size = sizeof(opt),
201 .opts = power_opts,
202 .args = power_args,
203 };
204
205 CMD_COMMAND(power_cmd);
206