sys/cam/nvme/nvme_all.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   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  *    without modification, immediately at the beginning of the file.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  18  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  19  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  21  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  22  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  23  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 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
  93         sbuf_printf(sb, "<");
  94         cam_strvis_sbuf(sb, cdata->mn, sizeof(cdata->mn), 0);
  95         sbuf_printf(sb, " ");
  96         cam_strvis_sbuf(sb, cdata->fr, sizeof(cdata->fr), 0);
  97         sbuf_printf(sb, " ");
  98         cam_strvis_sbuf(sb, cdata->sn, sizeof(cdata->sn), 0);
  99         sbuf_printf(sb, ">\n");
 100 }
 101
 102 /* XXX need to do nvme admin opcodes too, but those aren't used yet by nda */
 103 static const char *
 104 nvme_opc2str[] = {
 105         "FLUSH",
 106         "WRITE",
 107         "READ",
 108         "RSVD-3",
 109         "WRITE_UNCORRECTABLE",
 110         "COMPARE",
 111         "RSVD-6",
 112         "RSVD-7",
 113         "WRITE_ZEROES",
 114         "DATASET_MANAGEMENT",
 115         "RSVD-a",
 116         "RSVD-b",
 117         "RSVD-c",
 118         "RESERVATION_REGISTER",
 119         "RESERVATION_REPORT",
 120         "RSVD-f",
 121         "RSVD-10",
 122         "RESERVATION_ACQUIRE",
 123         "RSVD-12",
 124         "RSVD-13",
 125         "RSVD-14",
 126         "RESERVATION_RELEASE",
 127 };
 128
 129 const char *
 130 nvme_op_string(const struct nvme_command *cmd, int admin)
 131 {
 132
 133         if (admin) {
 134                 return "ADMIN";
 135         } else {
 136                 if (cmd->opc >= nitems(nvme_opc2str))
 137                         return "UNKNOWN";
 138                 return nvme_opc2str[cmd->opc];
 139         }
 140 }
 141
 142 const char *
 143 nvme_cmd_string(const struct nvme_command *cmd, char *cmd_string, size_t len)
 144 {
 145         struct sbuf sb;
 146         int error;
 147
 148         if (len == 0)
 149                 return ("");
 150
 151         sbuf_new(&sb, cmd_string, len, SBUF_FIXEDLEN);
 152         nvme_cmd_sbuf(cmd, &sb);
 153
 154         error = sbuf_finish(&sb);
 155         if (error != 0 && error != ENOMEM)
 156                 return ("");
 157
 158         return(sbuf_data(&sb));
 159 }
 160
 161 void
 162 nvme_cmd_sbuf(const struct nvme_command *cmd, struct sbuf *sb)
 163 {
 164
 165         /*
 166          * cid, rsvd areas and mptr not printed, since they are used
 167          * only internally by the SIM.
 168          */
 169         sbuf_printf(sb,
 170             "opc=%x fuse=%x nsid=%x prp1=%llx prp2=%llx cdw=%x %x %x %x %x %x",
 171             cmd->opc, cmd->fuse, cmd->nsid,
 172             (unsigned long long)cmd->prp1, (unsigned long long)cmd->prp2,
 173             cmd->cdw10, cmd->cdw11, cmd->cdw12,
 174             cmd->cdw13, cmd->cdw14, cmd->cdw15);
 175 }
 176
 177 /*
 178  * nvme_command_sbuf() returns 0 for success and -1 for failure.
 179  */
 180 int
 181 nvme_command_sbuf(struct ccb_nvmeio *nvmeio, struct sbuf *sb)
 182 {
 183
 184         sbuf_printf(sb, "%s. NCB: ", nvme_op_string(&nvmeio->cmd,
 185             nvmeio->ccb_h.func_code == XPT_NVME_ADMIN));
 186         nvme_cmd_sbuf(&nvmeio->cmd, sb);
 187         return(0);
 188 }
 189
 190 #ifdef _KERNEL
 191 const void *
 192 nvme_get_identify_cntrl(struct cam_periph *periph)
 193 {
 194         struct cam_ed *device;
 195
 196         device = periph->path->device;
 197
 198         return device->nvme_cdata;
 199 }
 200
 201 const void *
 202 nvme_get_identify_ns(struct cam_periph *periph)
 203 {
 204         struct cam_ed *device;
 205
 206         device = periph->path->device;
 207
 208         return device->nvme_data;
 209 }
 210 #endif