xref: /illumos-gate/usr/src/cmd/nvmeadm/nvmeadm.h (revision 30165b7f6753bc3d48c52319bed7ec7b3ea36b3c)
1 /*
2  * This file and its contents are supplied under the terms of the
3  * Common Development and Distribution License ("CDDL"), version 1.0.
4  * You may only use this file in accordance with the terms of version
5  * 1.0 of the CDDL.
6  *
7  * A full copy of the text of the CDDL should have accompanied this
8  * source.  A copy of the CDDL is also available via the Internet at
9  * http://www.illumos.org/license/CDDL.
10  */
11 
12 /*
13  * Copyright 2016 Nexenta Systems, Inc.
14  */
15 
16 #ifndef _NVMEADM_H
17 #define	_NVMEADM_H
18 
19 #include <stdio.h>
20 #include <libdevinfo.h>
21 #include <sys/nvme.h>
22 
23 #ifdef __cplusplus
24 extern "C" {
25 #endif
26 
27 extern int verbose;
28 extern int debug;
29 
30 /* printing functions */
31 extern void nvme_print(int, char *, int, const char *, ...);
32 extern void nvme_print_ctrl_summary(nvme_identify_ctrl_t *, nvme_version_t *);
33 extern void nvme_print_nsid_summary(nvme_identify_nsid_t *);
34 extern void nvme_print_identify_ctrl(nvme_identify_ctrl_t *,
35     nvme_capabilities_t *, nvme_version_t *);
36 extern void nvme_print_identify_nsid(nvme_identify_nsid_t *, nvme_version_t *);
37 extern void nvme_print_error_log(int, nvme_error_log_entry_t *);
38 extern void nvme_print_health_log(nvme_health_log_t *, nvme_identify_ctrl_t *);
39 extern void nvme_print_fwslot_log(nvme_fwslot_log_t *);
40 
41 extern void nvme_print_feat_arbitration(uint64_t, void *, size_t,
42     nvme_identify_ctrl_t *);
43 extern void nvme_print_feat_power_mgmt(uint64_t, void *, size_t,
44     nvme_identify_ctrl_t *);
45 extern void nvme_print_feat_lba_range(uint64_t, void *, size_t,
46     nvme_identify_ctrl_t *);
47 extern void nvme_print_feat_temperature(uint64_t, void *, size_t,
48     nvme_identify_ctrl_t *);
49 extern void nvme_print_feat_error(uint64_t, void *, size_t,
50     nvme_identify_ctrl_t *);
51 extern void nvme_print_feat_write_cache(uint64_t, void *, size_t,
52     nvme_identify_ctrl_t *);
53 extern void nvme_print_feat_nqueues(uint64_t, void *, size_t,
54     nvme_identify_ctrl_t *);
55 extern void nvme_print_feat_intr_coal(uint64_t, void *, size_t,
56     nvme_identify_ctrl_t *);
57 extern void nvme_print_feat_intr_vect(uint64_t, void *, size_t,
58     nvme_identify_ctrl_t *);
59 extern void nvme_print_feat_write_atom(uint64_t, void *, size_t,
60     nvme_identify_ctrl_t *);
61 extern void nvme_print_feat_async_event(uint64_t, void *, size_t,
62     nvme_identify_ctrl_t *);
63 extern void nvme_print_feat_auto_pst(uint64_t, void *, size_t,
64     nvme_identify_ctrl_t *);
65 extern void nvme_print_feat_progress(uint64_t, void *, size_t,
66     nvme_identify_ctrl_t *);
67 
68 /* device node functions */
69 extern int nvme_open(di_minor_t);
70 extern void nvme_close(int);
71 extern nvme_version_t *nvme_version(int);
72 extern nvme_capabilities_t *nvme_capabilities(int);
73 extern nvme_identify_ctrl_t *nvme_identify_ctrl(int);
74 extern nvme_identify_nsid_t *nvme_identify_nsid(int);
75 extern void *nvme_get_logpage(int, uint8_t, size_t *);
76 extern boolean_t nvme_get_feature(int, uint8_t, uint32_t, uint64_t *, size_t *,
77     void **);
78 extern int nvme_intr_cnt(int);
79 extern boolean_t nvme_format_nvm(int, uint8_t, uint8_t);
80 extern boolean_t nvme_detach(int);
81 extern boolean_t nvme_attach(int);
82 
83 #ifdef __cplusplus
84 }
85 #endif
86 
87 #endif /* _NVMEADM_H */
88