nvmecontrol.h revision 252268 
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: head/sbin/nvmecontrol/nvmecontrol.h 252268 2013-06-26 23:05:48Z jimharris $
27 */
28
29#ifndef __NVMECONTROL_H__
30#define __NVMECONTROL_H__
31
32#include <dev/nvme/nvme.h>
33
34#define DEVLIST_USAGE							       \
35"       nvmecontrol devlist\n"
36
37#define IDENTIFY_USAGE							       \
38"       nvmecontrol identify <controller id|namespace id>\n"
39
40#define PERFTEST_USAGE							       \
41"       nvmecontrol perftest <-n num_threads> <-o read|write>\n"	       \
42"                            <-s size_in_bytes> <-t time_in_seconds>\n"	       \
43"                            <-i intr|wait> [-f refthread] [-p]\n"	       \
44"                            <namespace id>\n"
45
46#define RESET_USAGE							       \
47"       nvmecontrol reset <controller id>\n"
48
49int open_dev(const char *str, int *fd, int show_error, int exit_on_error);
50void read_controller_data(int fd, struct nvme_controller_data *cdata);
51void read_namespace_data(int fd, int nsid, struct nvme_namespace_data *nsdata);
52
53void devlist(int argc, char *argv[]);
54void identify(int argc, char *argv[]);
55void perftest(int argc, char *argv[]);
56void reset(int argc, char *argv[]);
57
58#endif
59
60