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