Home | History | Annotate | Line # | Download | only in nvmectl
nvmectl.h revision 1.1 
      1 /*	$NetBSD: nvmectl.h,v 1.1 2016/06/04 16:29:35 nonaka 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 295087 2016-01-30 22:48:06Z 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 #define NVME_CTRLR_PREFIX	"nvme"
     40 #define NVME_NS_PREFIX		"ns"
     41 
     42 #define DEVLIST_USAGE							       \
     43 "       nvmectl devlist\n"
     44 
     45 #define IDENTIFY_USAGE							       \
     46 "       nvmectl identify [-x [-v]] <controller id|namespace id>\n"
     47 
     48 #if 0
     49 #define PERFTEST_USAGE							       \
     50 "       nvmectl perftest <-n num_threads> <-o read|write>\n"	               \
     51 "                        <-s size_in_bytes> <-t time_in_seconds>\n"	       \
     52 "                        <-i intr|wait> [-f refthread] [-p]\n"	               \
     53 "                        <namespace id>\n"
     54 #endif
     55 
     56 #if 0
     57 #define RESET_USAGE							       \
     58 "       nvmectl reset <controller id>\n"
     59 #endif
     60 
     61 #define LOGPAGE_USAGE							       \
     62 "       nvmectl logpage <-p page_id> [-x] <controller id|namespace id>\n"  \
     63 
     64 #if 0
     65 #define FIRMWARE_USAGE							       \
     66 "       nvmectl firmware [-s slot] [-f path_to_firmware] [-a] <controller id>\n"
     67 #endif
     68 
     69 #define POWER_USAGE							       \
     70 "       nvmectl power [-l] [-p new-state [-w workload-hint]] <controller id>\n"
     71 
     72 void devlist(int, char *[]);
     73 void identify(int, char *[]);
     74 #ifdef PERFTEST_USAGE
     75 void perftest(int, char *[]);
     76 #endif
     77 #ifdef RESET_USAGE
     78 void reset(int, char *[]);
     79 #endif
     80 void logpage(int, char *[]);
     81 #ifdef FIRMWARE_USAGE
     82 void firmware(int, char *[]);
     83 #endif
     84 void power(int, char *[]);
     85 
     86 int open_dev(const char *, int *, int, int);
     87 void parse_ns_str(const char *, char *, int *);
     88 void read_controller_data(int, struct nvm_identify_controller *);
     89 void read_namespace_data(int, int, struct nvm_identify_namespace *);
     90 void print_hex(void *, uint32_t);
     91 void read_logpage(int, uint8_t, int, void *, uint32_t);
     92 void nvme_strvis(uint8_t *, int, const uint8_t *, int);
     93 
     94 #endif	/* __NVMECTL_H__ */
     95