1 /*- 2 * Copyright (C) 2012-2013 Intel Corporation 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 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24 * SUCH DAMAGE. 25 * 26 * $FreeBSD$ 27 */ 28 29 #ifndef __NVMECONTROL_H__ 30 #define __NVMECONTROL_H__ 31 32 #include <dev/nvme/nvme.h> 33 34 #define NVME_CTRLR_PREFIX "nvme" 35 #define NVME_NS_PREFIX "ns" 36 37 #define DEVLIST_USAGE \ 38 " nvmecontrol devlist\n" 39 40 #define IDENTIFY_USAGE \ 41 " nvmecontrol identify [-x [-v]] <controller id|namespace id>\n" 42 43 #define PERFTEST_USAGE \ 44 " nvmecontrol perftest <-n num_threads> <-o read|write>\n" \ 45 " <-s size_in_bytes> <-t time_in_seconds>\n" \ 46 " <-i intr|wait> [-f refthread] [-p]\n" \ 47 " <namespace id>\n" 48 49 #define RESET_USAGE \ 50 " nvmecontrol reset <controller id>\n" 51 52 #define LOGPAGE_USAGE \ 53 " nvmecontrol logpage <-p page_id> [-x] <controller id|namespace id>\n" \ 54 55 #define FIRMWARE_USAGE \ 56 " nvmecontrol firmware [-s slot] [-f path_to_firmware] [-a] <controller id>\n" 57 58 void devlist(int argc, char *argv[]); 59 void identify(int argc, char *argv[]); 60 void perftest(int argc, char *argv[]); 61 void reset(int argc, char *argv[]); 62 void logpage(int argc, char *argv[]); 63 void firmware(int argc, char *argv[]); 64 65 int open_dev(const char *str, int *fd, int show_error, int exit_on_error); 66 void parse_ns_str(const char *ns_str, char *ctrlr_str, int *nsid); 67 void read_controller_data(int fd, struct nvme_controller_data *cdata); 68 void read_namespace_data(int fd, int nsid, struct nvme_namespace_data *nsdata); 69 void print_hex(void *data, uint32_t length); 70 void read_logpage(int fd, uint8_t log_page, int nsid, void *payload, 71 uint32_t payload_size); 72 73 #endif 74 75