1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3 * 4 * Copyright (C) 2012-2013 Intel Corporation 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 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 AND CONTRIBUTORS ``AS IS'' AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 * 28 * $FreeBSD$ 29 */ 30 31 #ifndef __NVMECONTROL_H__ 32 #define __NVMECONTROL_H__ 33 34 #include <sys/linker_set.h> 35 #include <dev/nvme/nvme.h> 36 37 struct nvme_function; 38 typedef void (*nvme_fn_t)(struct nvme_function *nf, int argc, char *argv[]); 39 40 struct nvme_function { 41 const char *name; 42 nvme_fn_t fn; 43 const char *usage; 44 }; 45 46 #define NVME_CMDSET(set, sym) DATA_SET(set, sym) 47 #define NVME_COMMAND(set, nam, function, usage_str) \ 48 static struct nvme_function function ## _nvme_cmd = \ 49 { .name = #nam, .fn = function, .usage = usage_str }; \ 50 NVME_CMDSET(set, function ## _nvme_cmd) 51 52 typedef void (*print_fn_t)(const struct nvme_controller_data *cdata, void *buf, uint32_t size); 53 54 struct logpage_function { 55 uint8_t log_page; 56 const char *vendor; 57 const char *name; 58 print_fn_t print_fn; 59 size_t size; 60 }; 61 62 #define NVME_LOGPAGESET(sym) DATA_SET(logpage, sym) 63 #define NVME_LOGPAGE(unique, lp, vend, nam, fn, sz) \ 64 static struct logpage_function unique ## _lpf = { \ 65 .log_page = lp, \ 66 .vendor = vend, \ 67 .name = nam, \ 68 .print_fn = fn, \ 69 .size = sz, \ 70 } ; \ 71 NVME_LOGPAGESET(unique ## _lpf) 72 73 #define DEFAULT_SIZE (4096) 74 struct kv_name { 75 uint32_t key; 76 const char *name; 77 }; 78 79 const char *kv_lookup(const struct kv_name *kv, size_t kv_count, uint32_t key); 80 81 #define NVME_CTRLR_PREFIX "nvme" 82 #define NVME_NS_PREFIX "ns" 83 84 int open_dev(const char *str, int *fd, int show_error, int exit_on_error); 85 void parse_ns_str(const char *ns_str, char *ctrlr_str, uint32_t *nsid); 86 void read_controller_data(int fd, struct nvme_controller_data *cdata); 87 void read_namespace_data(int fd, uint32_t nsid, struct nvme_namespace_data *nsdata); 88 void print_hex(void *data, uint32_t length); 89 void read_logpage(int fd, uint8_t log_page, uint32_t nsid, void *payload, 90 uint32_t payload_size); 91 void print_temp(uint16_t t); 92 93 void usage(const struct nvme_function *f); 94 void dispatch_set(int argc, char *argv[], struct nvme_function **tbl, 95 struct nvme_function **tbl_limit); 96 97 #define DISPATCH(argc, argv, set) \ 98 dispatch_set(argc, argv, SET_BEGIN(set), SET_LIMIT(set)) 99 100 /* Utility Routines */ 101 /* 102 * 128-bit integer augments to standard values. On i386 this 103 * doesn't exist, so we use 64-bit values. So, on 32-bit i386, 104 * you'll get truncated values until someone implement 128bit 105 * ints in sofware. 106 */ 107 #define UINT128_DIG 39 108 #ifdef __i386__ 109 typedef uint64_t uint128_t; 110 #else 111 typedef __uint128_t uint128_t; 112 #endif 113 114 static __inline uint128_t 115 to128(void *p) 116 { 117 return *(uint128_t *)p; 118 } 119 120 uint64_t le48dec(const void *pp); 121 char * uint128_to_str(uint128_t u, char *buf, size_t buflen); 122 123 #endif 124