Home | History | Annotate | Line # | Download | only in nvmectl
nvmectl.h revision 1.5 
      1 /*	$NetBSD: nvmectl.h,v 1.5 2018/03/17 11:07:26 jdolecek Exp $	*/
      2 
      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: head/sbin/nvmecontrol/nvmecontrol.h 314230 2017-02-25 00:09:16Z imp $
     29  */
     30 
     31 #ifndef __NVMECTL_H__
     32 #define __NVMECTL_H__
     33 
     34 #include <sys/ioctl.h>
     35 
     36 #include <dev/ic/nvmeio.h>
     37 #include "nvme.h"
     38 
     39 typedef void (*nvme_fn_t)(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_CTRLR_PREFIX	"nvme"
     48 #define NVME_NS_PREFIX		"ns"
     49 
     50 #define DEVLIST_USAGE							       \
     51 "devlist\n"
     52 
     53 #define IDENTIFY_USAGE							       \
     54 "identify [-x [-v]] <controller id|namespace id>\n"
     55 
     56 #if 0
     57 #define PERFTEST_USAGE							       \
     58 "perftest <-n num_threads> <-o read|write>\n"		       \
     59 "                        <-s size_in_bytes> <-t time_in_seconds>\n"	       \
     60 "                        <-i intr|wait> [-f refthread] [-p]\n"		       \
     61 "                        <namespace id>\n"
     62 #endif
     63 
     64 #if 0
     65 #define RESET_USAGE							       \
     66 "reset <controller id>\n"
     67 #endif
     68 
     69 #define LOGPAGE_USAGE							       \
     70 "logpage <-p page_id> [-b] [-v vendor] [-x] "		       \
     71     "<controller id|namespace id>\n"
     72 
     73 #if 0
     74 #define FIRMWARE_USAGE							       \
     75 "firmware [-s slot] [-f path_to_firmware] [-a] <controller id>\n"
     76 #endif
     77 
     78 #define POWER_USAGE							       \
     79 "power [-l] [-p new-state [-w workload-hint]] <controller id>\n"
     80 
     81 #define WDC_USAGE							       \
     82 "wdc (cap-diag|drive-log|get-crash-dump|purge|purge-montior)\n"
     83 
     84 void devlist(int, char *[]) __dead;
     85 void identify(int, char *[]) __dead;
     86 #ifdef PERFTEST_USAGE
     87 void perftest(int, char *[]) __dead;
     88 #endif
     89 #ifdef RESET_USAGE
     90 void reset(int, char *[]) __dead;
     91 #endif
     92 void logpage(int, char *[]) __dead;
     93 #ifdef FIRMWARE_USAGE
     94 void firmware(int, char *[]) __dead;
     95 #endif
     96 void power(int, char *[]) __dead;
     97 void wdc(int, char *[]) __dead;
     98 
     99 int open_dev(const char *, int *, int, int);
    100 void parse_ns_str(const char *, char *, int *);
    101 void read_controller_data(int, struct nvm_identify_controller *);
    102 void read_namespace_data(int, int, struct nvm_identify_namespace *);
    103 void print_hex(void *, uint32_t);
    104 void read_logpage(int, uint8_t, int, void *, uint32_t);
    105 __dead void dispatch(int argc, char *argv[], const struct nvme_function *f);
    106 void nvme_strvis(uint8_t *, int, const uint8_t *, int);
    107 
    108 #endif	/* __NVMECTL_H__ */
    109