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/cdefs.h> 27 __FBSDID("$FreeBSD$"); 28 29 #include <sys/param.h> 30 #include <sys/ioccom.h> 31 32 #include <ctype.h> 33 #include <err.h> 34 #include <fcntl.h> 35 #include <stdbool.h> 36 #include <stddef.h> 37 #include <stdio.h> 38 #include <stdlib.h> 39 #include <string.h> 40 #include <sysexits.h> 41 #include <unistd.h> 42 43 #include "nvmecontrol.h" 44 45 _Static_assert(sizeof(struct nvme_power_state) == 256 / NBBY, 46 "nvme_power_state size wrong"); 47 48 #define POWER_NONE 0xffffffffu 49 50 static struct options { 51 bool list; 52 uint32_t power; 53 uint32_t workload; 54 const char *dev; 55 } opt = { 56 .list = false, 57 .power = POWER_NONE, 58 .workload = 0, 59 .dev = NULL, 60 }; 61 62 static void 63 power_list_one(int i, struct nvme_power_state *nps) 64 { 65 int mpower, apower, ipower; 66 uint8_t mps, nops, aps, apw; 67 68 mps = (nps->mps_nops >> NVME_PWR_ST_MPS_SHIFT) & 69 NVME_PWR_ST_MPS_MASK; 70 nops = (nps->mps_nops >> NVME_PWR_ST_NOPS_SHIFT) & 71 NVME_PWR_ST_NOPS_MASK; 72 apw = (nps->apw_aps >> NVME_PWR_ST_APW_SHIFT) & 73 NVME_PWR_ST_APW_MASK; 74 aps = (nps->apw_aps >> NVME_PWR_ST_APS_SHIFT) & 75 NVME_PWR_ST_APS_MASK; 76 77 mpower = nps->mp; 78 if (mps == 0) 79 mpower *= 100; 80 ipower = nps->idlp; 81 if (nps->ips == 1) 82 ipower *= 100; 83 apower = nps->actp; 84 if (aps == 1) 85 apower *= 100; 86 printf("%2d: %2d.%04dW%c %3d.%03dms %3d.%03dms %2d %2d %2d %2d %2d.%04dW %2d.%04dW %d\n", 87 i, mpower / 10000, mpower % 10000, 88 nops ? '*' : ' ', nps->enlat / 1000, nps->enlat % 1000, 89 nps->exlat / 1000, nps->exlat % 1000, nps->rrt, nps->rrl, 90 nps->rwt, nps->rwl, ipower / 10000, ipower % 10000, 91 apower / 10000, apower % 10000, apw); 92 } 93 94 static void 95 power_list(struct nvme_controller_data *cdata) 96 { 97 int i; 98 99 printf("\nPower States Supported: %d\n\n", cdata->npss + 1); 100 printf(" # Max pwr Enter Lat Exit Lat RT RL WT WL Idle Pwr Act Pwr Workloadd\n"); 101 printf("-- -------- --------- --------- -- -- -- -- -------- -------- --\n"); 102 for (i = 0; i <= cdata->npss; i++) 103 power_list_one(i, &cdata->power_state[i]); 104 } 105 106 static void 107 power_set(int fd, int power_val, int workload, int perm) 108 { 109 struct nvme_pt_command pt; 110 uint32_t p; 111 112 p = perm ? (1u << 31) : 0; 113 memset(&pt, 0, sizeof(pt)); 114 pt.cmd.opc = NVME_OPC_SET_FEATURES; 115 pt.cmd.cdw10 = htole32(NVME_FEAT_POWER_MANAGEMENT | p); 116 pt.cmd.cdw11 = htole32(power_val | (workload << 5)); 117 118 if (ioctl(fd, NVME_PASSTHROUGH_CMD, &pt) < 0) 119 err(EX_IOERR, "set feature power mgmt request failed"); 120 121 if (nvme_completion_is_error(&pt.cpl)) 122 errx(EX_IOERR, "set feature power mgmt request returned error"); 123 } 124 125 static void 126 power_show(int fd) 127 { 128 struct nvme_pt_command pt; 129 130 memset(&pt, 0, sizeof(pt)); 131 pt.cmd.opc = NVME_OPC_GET_FEATURES; 132 pt.cmd.cdw10 = htole32(NVME_FEAT_POWER_MANAGEMENT); 133 134 if (ioctl(fd, NVME_PASSTHROUGH_CMD, &pt) < 0) 135 err(EX_IOERR, "set feature power mgmt request failed"); 136 137 if (nvme_completion_is_error(&pt.cpl)) 138 errx(EX_IOERR, "set feature power mgmt request returned error"); 139 140 printf("Current Power State is %d\n", pt.cpl.cdw0 & 0x1F); 141 printf("Current Workload Hint is %d\n", pt.cpl.cdw0 >> 5); 142 } 143 144 static void 145 power(const struct cmd *f, int argc, char *argv[]) 146 { 147 struct nvme_controller_data cdata; 148 int fd; 149 char *path; 150 uint32_t nsid; 151 152 if (arg_parse(argc, argv, f)) 153 return; 154 155 if (opt.list && opt.power != POWER_NONE) { 156 fprintf(stderr, "Can't set power and list power states\n"); 157 arg_help(argc, argv, f); 158 } 159 160 open_dev(opt.dev, &fd, 1, 1); 161 get_nsid(fd, &path, &nsid); 162 if (nsid != 0) { 163 close(fd); 164 open_dev(path, &fd, 1, 1); 165 } 166 free(path); 167 168 if (opt.list) { 169 if (read_controller_data(fd, &cdata)) 170 errx(EX_IOERR, "Identify request failed"); 171 power_list(&cdata); 172 goto out; 173 } 174 175 if (opt.power != POWER_NONE) { 176 power_set(fd, opt.power, opt.workload, 0); 177 goto out; 178 } 179 power_show(fd); 180 181 out: 182 close(fd); 183 exit(0); 184 } 185 186 static const struct opts power_opts[] = { 187 #define OPT(l, s, t, opt, addr, desc) { l, s, t, &opt.addr, desc } 188 OPT("list", 'l', arg_none, opt, list, 189 "List the valid power states"), 190 OPT("power", 'p', arg_uint32, opt, power, 191 "Set the power state"), 192 OPT("workload", 'w', arg_uint32, opt, workload, 193 "Set the workload hint"), 194 { NULL, 0, arg_none, NULL, NULL } 195 }; 196 #undef OPT 197 198 static const struct args power_args[] = { 199 { arg_string, &opt.dev, "controller-id|namespace-id" }, 200 { arg_none, NULL, NULL }, 201 }; 202 203 static struct cmd power_cmd = { 204 .name = "power", 205 .fn = power, 206 .descr = "Manage power states for the drive", 207 .ctx_size = sizeof(opt), 208 .opts = power_opts, 209 .args = power_args, 210 }; 211 212 CMD_COMMAND(power_cmd); 213