xref: /freebsd/sys/cam/nvme/nvme_all.c (revision d6b92ffa)
1 /*-
2  * Copyright (c) 2015 Netflix, Inc
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer,
10  *    without modification, immediately at the beginning of the file.
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 ``AS IS'' AND ANY EXPRESS OR
16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  */
26 
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
29 
30 #include <sys/param.h>
31 
32 #ifdef _KERNEL
33 #include "opt_scsi.h"
34 
35 #include <sys/systm.h>
36 #include <sys/libkern.h>
37 #include <sys/kernel.h>
38 #include <sys/sysctl.h>
39 #else
40 #include <errno.h>
41 #include <stdio.h>
42 #include <stdlib.h>
43 #include <string.h>
44 #ifndef min
45 #define min(a,b) (((a)<(b))?(a):(b))
46 #endif
47 #endif
48 
49 #include <cam/cam.h>
50 #include <cam/cam_ccb.h>
51 #include <cam/cam_queue.h>
52 #include <cam/cam_xpt.h>
53 #include <cam/nvme/nvme_all.h>
54 #include <sys/sbuf.h>
55 #include <sys/endian.h>
56 
57 void
58 nvme_ns_cmd(struct ccb_nvmeio *nvmeio, uint8_t cmd, uint32_t nsid,
59     uint32_t cdw10, uint32_t cdw11, uint32_t cdw12, uint32_t cdw13,
60     uint32_t cdw14, uint32_t cdw15)
61 {
62 	bzero(&nvmeio->cmd, sizeof(struct nvme_command));
63 	nvmeio->cmd.opc = cmd;
64 	nvmeio->cmd.nsid = nsid;
65 	nvmeio->cmd.cdw10 = cdw10;
66 	nvmeio->cmd.cdw11 = cdw11;
67 	nvmeio->cmd.cdw12 = cdw12;
68 	nvmeio->cmd.cdw13 = cdw13;
69 	nvmeio->cmd.cdw14 = cdw14;
70 	nvmeio->cmd.cdw15 = cdw15;
71 }
72 
73 int
74 nvme_identify_match(caddr_t identbuffer, caddr_t table_entry)
75 {
76 	return 0;
77 }
78 
79 
80 void
81 nvme_print_ident(const struct nvme_controller_data *cdata,
82     const struct nvme_namespace_data *data)
83 {
84 	printf("I'm a pretty NVME drive\n");
85 }
86 
87 /* XXX need to do nvme admin opcodes too, but those aren't used yet by nda */
88 static const char *
89 nvme_opc2str[] = {
90 	"FLUSH",
91 	"WRITE",
92 	"READ",
93 	"RSVD-3",
94 	"WRITE_UNCORRECTABLE",
95 	"COMPARE",
96 	"RSVD-6",
97 	"RSVD-7",
98 	"DATASET_MANAGEMENT"
99 };
100 
101 const char *
102 nvme_op_string(const struct nvme_command *cmd)
103 {
104 	if (cmd->opc > nitems(nvme_opc2str))
105 		return "UNKNOWN";
106 
107 	return nvme_opc2str[cmd->opc];
108 }
109 
110 const char *
111 nvme_cmd_string(const struct nvme_command *cmd, char *cmd_string, size_t len)
112 {
113 	/*
114 	 * cid, rsvd areas and mptr not printed, since they are used
115 	 * only internally by the SIM.
116 	 */
117 	snprintf(cmd_string, len,
118 	    "opc=%x fuse=%x nsid=%x prp1=%llx prp2=%llx cdw=%x %x %x %x %x %x",
119 	    cmd->opc, cmd->fuse, cmd->nsid,
120 	    (unsigned long long)cmd->prp1, (unsigned long long)cmd->prp2,
121 	    cmd->cdw10, cmd->cdw11, cmd->cdw12, cmd->cdw13, cmd->cdw14, cmd->cdw15);
122 
123 	return cmd_string;
124 }
125