1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause 3 * 4 * Copyright (c) 2015 Netflix, Inc. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25 * SUCH DAMAGE. 26 */ 27 28 #include <sys/cdefs.h> 29 __FBSDID("$FreeBSD$"); 30 31 #include <sys/param.h> 32 33 #ifdef _KERNEL 34 #include "opt_scsi.h" 35 36 #include <sys/systm.h> 37 #include <sys/libkern.h> 38 #include <sys/kernel.h> 39 #include <sys/malloc.h> 40 #include <sys/sysctl.h> 41 #else 42 #include <errno.h> 43 #include <stdio.h> 44 #include <stdlib.h> 45 #include <string.h> 46 #ifndef min 47 #define min(a,b) (((a)<(b))?(a):(b)) 48 #endif 49 #endif 50 51 #include <cam/cam.h> 52 #include <cam/cam_ccb.h> 53 #include <cam/cam_queue.h> 54 #include <cam/cam_xpt.h> 55 #include <cam/nvme/nvme_all.h> 56 #include <sys/sbuf.h> 57 #include <sys/endian.h> 58 59 #ifdef _KERNEL 60 #include <cam/cam_periph.h> 61 #include <cam/cam_xpt_sim.h> 62 #include <cam/cam_xpt_periph.h> 63 #include <cam/cam_xpt_internal.h> 64 #endif 65 66 void 67 nvme_ns_cmd(struct ccb_nvmeio *nvmeio, uint8_t cmd, uint32_t nsid, 68 uint32_t cdw10, uint32_t cdw11, uint32_t cdw12, uint32_t cdw13, 69 uint32_t cdw14, uint32_t cdw15) 70 { 71 bzero(&nvmeio->cmd, sizeof(struct nvme_command)); 72 nvmeio->cmd.opc = cmd; 73 nvmeio->cmd.nsid = htole32(nsid); 74 nvmeio->cmd.cdw10 = htole32(cdw10); 75 nvmeio->cmd.cdw11 = htole32(cdw11); 76 nvmeio->cmd.cdw12 = htole32(cdw12); 77 nvmeio->cmd.cdw13 = htole32(cdw13); 78 nvmeio->cmd.cdw14 = htole32(cdw14); 79 nvmeio->cmd.cdw15 = htole32(cdw15); 80 } 81 82 int 83 nvme_identify_match(caddr_t identbuffer, caddr_t table_entry) 84 { 85 return 0; 86 } 87 88 void 89 nvme_print_ident(const struct nvme_controller_data *cdata, 90 const struct nvme_namespace_data *data, struct sbuf *sb) 91 { 92 nvme_print_ident_short(cdata, data, sb); 93 sbuf_printf(sb, "\n"); 94 } 95 96 void 97 nvme_print_ident_short(const struct nvme_controller_data *cdata, 98 const struct nvme_namespace_data *data, struct sbuf *sb) 99 { 100 sbuf_printf(sb, "<"); 101 cam_strvis_sbuf(sb, cdata->mn, sizeof(cdata->mn), 102 CAM_STRVIS_FLAG_NONASCII_SPC); 103 sbuf_printf(sb, " "); 104 cam_strvis_sbuf(sb, cdata->fr, sizeof(cdata->fr), 105 CAM_STRVIS_FLAG_NONASCII_SPC); 106 sbuf_printf(sb, " "); 107 cam_strvis_sbuf(sb, cdata->sn, sizeof(cdata->sn), 108 CAM_STRVIS_FLAG_NONASCII_SPC); 109 sbuf_printf(sb, ">"); 110 } 111 112 /* XXX need to do nvme admin opcodes too, but those aren't used yet by nda */ 113 static const char * 114 nvme_opc2str[] = { 115 "FLUSH", 116 "WRITE", 117 "READ", 118 "RSVD-3", 119 "WRITE_UNCORRECTABLE", 120 "COMPARE", 121 "RSVD-6", 122 "RSVD-7", 123 "WRITE_ZEROES", 124 "DATASET_MANAGEMENT", 125 "RSVD-a", 126 "RSVD-b", 127 "RSVD-c", 128 "RESERVATION_REGISTER", 129 "RESERVATION_REPORT", 130 "RSVD-f", 131 "RSVD-10", 132 "RESERVATION_ACQUIRE", 133 "RSVD-12", 134 "RSVD-13", 135 "RSVD-14", 136 "RESERVATION_RELEASE", 137 }; 138 139 const char * 140 nvme_op_string(const struct nvme_command *cmd, int admin) 141 { 142 143 if (admin) { 144 return "ADMIN"; 145 } else { 146 if (cmd->opc >= nitems(nvme_opc2str)) 147 return "UNKNOWN"; 148 return nvme_opc2str[cmd->opc]; 149 } 150 } 151 152 const char * 153 nvme_cmd_string(const struct nvme_command *cmd, char *cmd_string, size_t len) 154 { 155 struct sbuf sb; 156 int error; 157 158 if (len == 0) 159 return (""); 160 161 sbuf_new(&sb, cmd_string, len, SBUF_FIXEDLEN); 162 nvme_cmd_sbuf(cmd, &sb); 163 164 error = sbuf_finish(&sb); 165 if (error != 0 && 166 #ifdef _KERNEL 167 error != ENOMEM) 168 #else 169 errno != ENOMEM) 170 #endif 171 return (""); 172 173 return(sbuf_data(&sb)); 174 } 175 176 void 177 nvme_cmd_sbuf(const struct nvme_command *cmd, struct sbuf *sb) 178 { 179 180 /* 181 * cid, rsvd areas and mptr not printed, since they are used 182 * only internally by the SIM. 183 */ 184 sbuf_printf(sb, 185 "opc=%x fuse=%x nsid=%x prp1=%llx prp2=%llx cdw=%x %x %x %x %x %x", 186 cmd->opc, cmd->fuse, cmd->nsid, 187 (unsigned long long)cmd->prp1, (unsigned long long)cmd->prp2, 188 cmd->cdw10, cmd->cdw11, cmd->cdw12, 189 cmd->cdw13, cmd->cdw14, cmd->cdw15); 190 } 191 192 /* 193 * nvme_command_sbuf() returns 0 for success and -1 for failure. 194 */ 195 int 196 nvme_command_sbuf(struct ccb_nvmeio *nvmeio, struct sbuf *sb) 197 { 198 199 sbuf_printf(sb, "%s. NCB: ", nvme_op_string(&nvmeio->cmd, 200 nvmeio->ccb_h.func_code == XPT_NVME_ADMIN)); 201 nvme_cmd_sbuf(&nvmeio->cmd, sb); 202 return(0); 203 } 204 205 #ifdef _KERNEL 206 const void * 207 nvme_get_identify_cntrl(struct cam_periph *periph) 208 { 209 struct cam_ed *device; 210 211 device = periph->path->device; 212 213 return device->nvme_cdata; 214 } 215 216 const void * 217 nvme_get_identify_ns(struct cam_periph *periph) 218 { 219 struct cam_ed *device; 220 221 device = periph->path->device; 222 223 return device->nvme_data; 224 } 225 #endif 226