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 <sys/queue.h> 36 #include <dev/nvme/nvme.h> 37 38 struct nvme_function; 39 typedef void (*nvme_fn_t)(const struct nvme_function *nf, int argc, char *argv[]); 40 41 struct nvme_function { 42 const char *name; 43 nvme_fn_t fn; 44 const char *usage; 45 }; 46 47 #define NVME_SETNAME(set) set 48 #define NVME_CMDSET(set, sym) DATA_SET(NVME_SETNAME(set), sym) 49 #define NVME_COMMAND(set, nam, function, usage_str) \ 50 static struct nvme_function function ## _nvme_cmd = \ 51 { .name = #nam, .fn = function, .usage = usage_str }; \ 52 NVME_CMDSET(set, function ## _nvme_cmd) 53 #define NVME_CMD_BEGIN(set) SET_BEGIN(NVME_SETNAME(set)) 54 #define NVME_CMD_LIMIT(set) SET_LIMIT(NVME_SETNAME(set)) 55 #define NVME_CMD_DECLARE(set, t) SET_DECLARE(NVME_SETNAME(set), t) 56 57 typedef void (*print_fn_t)(const struct nvme_controller_data *cdata, void *buf, uint32_t size); 58 59 struct logpage_function { 60 SLIST_ENTRY(logpage_function) link; 61 uint8_t log_page; 62 const char *vendor; 63 const char *name; 64 print_fn_t print_fn; 65 size_t size; 66 }; 67 68 69 #define NVME_LOGPAGE(unique, lp, vend, nam, fn, sz) \ 70 static struct logpage_function unique ## _lpf = { \ 71 .log_page = lp, \ 72 .vendor = vend, \ 73 .name = nam, \ 74 .print_fn = fn, \ 75 .size = sz, \ 76 } ; \ 77 static void logpage_reg_##unique(void) __attribute__((constructor)); \ 78 static void logpage_reg_##unique(void) { logpage_register(&unique##_lpf); } 79 80 #define DEFAULT_SIZE (4096) 81 struct kv_name { 82 uint32_t key; 83 const char *name; 84 }; 85 86 const char *kv_lookup(const struct kv_name *kv, size_t kv_count, uint32_t key); 87 88 NVME_CMD_DECLARE(top, struct nvme_function); 89 void logpage_register(struct logpage_function *p); 90 91 struct set_concat { 92 void **begin; 93 void **limit; 94 }; 95 void set_concat_add(struct set_concat *m, void *begin, void *end); 96 #define SET_CONCAT_DEF(set, t) \ 97 static struct set_concat set ## _concat; \ 98 static inline const t * const *set ## _begin(void) { return ((const t * const *)set ## _concat.begin); } \ 99 static inline const t * const *set ## _limit(void) { return ((const t * const *)set ## _concat.limit); } \ 100 void add_to_ ## set(t **b, t **e) \ 101 { \ 102 set_concat_add(&set ## _concat, b, e); \ 103 } 104 #define SET_CONCAT_DECL(set, t) \ 105 void add_to_ ## set(t **b, t **e) 106 SET_CONCAT_DECL(top, struct nvme_function); 107 108 #define NVME_CTRLR_PREFIX "nvme" 109 #define NVME_NS_PREFIX "ns" 110 111 int open_dev(const char *str, int *fd, int show_error, int exit_on_error); 112 void parse_ns_str(const char *ns_str, char *ctrlr_str, uint32_t *nsid); 113 void read_controller_data(int fd, struct nvme_controller_data *cdata); 114 void read_namespace_data(int fd, uint32_t nsid, struct nvme_namespace_data *nsdata); 115 void print_hex(void *data, uint32_t length); 116 void read_logpage(int fd, uint8_t log_page, uint32_t nsid, void *payload, 117 uint32_t payload_size); 118 void print_temp(uint16_t t); 119 void print_intel_add_smart(const struct nvme_controller_data *cdata __unused, void *buf, uint32_t size __unused); 120 121 void usage(const struct nvme_function *f); 122 void dispatch_set(int argc, char *argv[], const struct nvme_function * const *tbl, 123 const struct nvme_function * const *tbl_limit); 124 125 #define DISPATCH(argc, argv, set) \ 126 dispatch_set(argc, argv, \ 127 (const struct nvme_function * const *)NVME_CMD_BEGIN(set), \ 128 (const struct nvme_function * const *)NVME_CMD_LIMIT(set)) \ 129 130 /* Utility Routines */ 131 /* 132 * 128-bit integer augments to standard values. On i386 this 133 * doesn't exist, so we use 64-bit values. So, on 32-bit i386, 134 * you'll get truncated values until someone implement 128bit 135 * ints in sofware. 136 */ 137 #define UINT128_DIG 39 138 #ifdef __i386__ 139 typedef uint64_t uint128_t; 140 #else 141 typedef __uint128_t uint128_t; 142 #endif 143 144 static __inline uint128_t 145 to128(void *p) 146 { 147 return *(uint128_t *)p; 148 } 149 150 uint64_t le48dec(const void *pp); 151 char * uint128_to_str(uint128_t u, char *buf, size_t buflen); 152 153 #endif 154