sbin/nvmecontrol/nvmecontrol.h

   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 typedef void (*nvme_fn_t)(int argc, char *argv[]);
  35
  36 struct nvme_function {
  37         const char      *name;
  38         nvme_fn_t       fn;
  39         const char      *usage;
  40 };
  41
  42 #define NVME_CTRLR_PREFIX       "nvme"
  43 #define NVME_NS_PREFIX          "ns"
  44
  45 #define DEVLIST_USAGE                                                          \
  46 "       nvmecontrol devlist\n"
  47
  48 #define IDENTIFY_USAGE                                                         \
  49 "       nvmecontrol identify [-x [-v]] <controller id|namespace id>\n"
  50
  51 #define PERFTEST_USAGE                                                         \
  52 "       nvmecontrol perftest <-n num_threads> <-o read|write>\n"               \
  53 "                            <-s size_in_bytes> <-t time_in_seconds>\n"        \
  54 "                            <-i intr|wait> [-f refthread] [-p]\n"             \
  55 "                            <namespace id>\n"
  56
  57 #define RESET_USAGE                                                            \
  58 "       nvmecontrol reset <controller id>\n"
  59
  60 #define LOGPAGE_USAGE                                                          \
  61 "       nvmecontrol logpage <-p page_id> [-x] <controller id|namespace id>\n"  \
  62
  63 #define FIRMWARE_USAGE                                                         \
  64 "       nvmecontrol firmware [-s slot] [-f path_to_firmware] [-a] <controller id>\n"
  65
  66 #define POWER_USAGE                                                            \
  67 "       nvmecontrol power [-l] [-p new-state [-w workload-hint]] <controller id>\n"
  68
  69 #define WDC_USAGE                                                              \
  70 "       nvmecontrol wdc (cap-diag|drive-log|get-crash-dump|purge|purge-montior)\n"
  71
  72 void devlist(int argc, char *argv[]);
  73 void identify(int argc, char *argv[]);
  74 void perftest(int argc, char *argv[]);
  75 void reset(int argc, char *argv[]);
  76 void logpage(int argc, char *argv[]);
  77 void firmware(int argc, char *argv[]);
  78 void power(int argc, char *argv[]);
  79 void wdc(int argc, char *argv[]);
  80
  81 int open_dev(const char *str, int *fd, int show_error, int exit_on_error);
  82 void parse_ns_str(const char *ns_str, char *ctrlr_str, int *nsid);
  83 void read_controller_data(int fd, struct nvme_controller_data *cdata);
  84 void read_namespace_data(int fd, int nsid, struct nvme_namespace_data *nsdata);
  85 void print_hex(void *data, uint32_t length);
  86 void read_logpage(int fd, uint8_t log_page, int nsid, void *payload,
  87     uint32_t payload_size);
  88 void gen_usage(struct nvme_function *);
  89 void dispatch(int argc, char *argv[], struct nvme_function *f);
  90
  91 #endif
  92