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 * Copyright 2019 Western Digital Corporation 15 * Copyright 2021 Oxide Computer Company 16 */ 17 18 #ifndef _NVMEADM_H 19 #define _NVMEADM_H 20 21 #include <stdio.h> 22 #include <libdevinfo.h> 23 #include <sys/nvme.h> 24 #include <nvme_reg.h> 25 26 #ifdef __cplusplus 27 extern "C" { 28 #endif 29 30 extern int verbose; 31 extern int debug; 32 33 /* Version checking */ 34 extern boolean_t nvme_version_check(nvme_version_t *, uint_t, uint_t); 35 36 /* printing functions */ 37 extern void nvme_print(int, const char *, int, const char *, ...); 38 extern void nvme_print_ctrl_summary(nvme_identify_ctrl_t *, nvme_version_t *); 39 extern void nvme_print_nsid_summary(nvme_identify_nsid_t *); 40 extern void nvme_print_identify_ctrl(nvme_identify_ctrl_t *, 41 nvme_capabilities_t *, nvme_version_t *); 42 extern void nvme_print_identify_nsid(nvme_identify_nsid_t *, nvme_version_t *); 43 extern void nvme_print_error_log(int, nvme_error_log_entry_t *, 44 nvme_version_t *); 45 extern void nvme_print_health_log(nvme_health_log_t *, nvme_identify_ctrl_t *, 46 nvme_version_t *); 47 extern void nvme_print_fwslot_log(nvme_fwslot_log_t *); 48 49 extern void nvme_print_feat_arbitration(uint64_t, void *, size_t, 50 nvme_identify_ctrl_t *, nvme_version_t *); 51 extern void nvme_print_feat_power_mgmt(uint64_t, void *, size_t, 52 nvme_identify_ctrl_t *, nvme_version_t *); 53 extern void nvme_print_feat_lba_range(uint64_t, void *, size_t, 54 nvme_identify_ctrl_t *, nvme_version_t *); 55 extern void nvme_print_feat_temperature(uint64_t, void *, size_t, 56 nvme_identify_ctrl_t *, nvme_version_t *); 57 extern void nvme_print_feat_error(uint64_t, void *, size_t, 58 nvme_identify_ctrl_t *, nvme_version_t *); 59 extern void nvme_print_feat_write_cache(uint64_t, void *, size_t, 60 nvme_identify_ctrl_t *, nvme_version_t *); 61 extern void nvme_print_feat_nqueues(uint64_t, void *, size_t, 62 nvme_identify_ctrl_t *, nvme_version_t *); 63 extern void nvme_print_feat_intr_coal(uint64_t, void *, size_t, 64 nvme_identify_ctrl_t *, nvme_version_t *); 65 extern void nvme_print_feat_intr_vect(uint64_t, void *, size_t, 66 nvme_identify_ctrl_t *, nvme_version_t *); 67 extern void nvme_print_feat_write_atom(uint64_t, void *, size_t, 68 nvme_identify_ctrl_t *, nvme_version_t *); 69 extern void nvme_print_feat_async_event(uint64_t, void *, size_t, 70 nvme_identify_ctrl_t *, nvme_version_t *); 71 extern void nvme_print_feat_auto_pst(uint64_t, void *, size_t, 72 nvme_identify_ctrl_t *, nvme_version_t *); 73 extern void nvme_print_feat_progress(uint64_t, void *, size_t, 74 nvme_identify_ctrl_t *, nvme_version_t *); 75 extern const char *nvme_str_error(int, int); 76 77 /* device node functions */ 78 extern int nvme_open(di_minor_t); 79 extern void nvme_close(int); 80 extern nvme_version_t *nvme_version(int); 81 extern nvme_capabilities_t *nvme_capabilities(int); 82 extern nvme_identify_ctrl_t *nvme_identify_ctrl(int); 83 extern nvme_identify_nsid_t *nvme_identify_nsid(int); 84 extern void *nvme_get_logpage(int, uint8_t, size_t *); 85 extern boolean_t nvme_get_feature(int, uint8_t, uint32_t, uint64_t *, size_t *, 86 void **); 87 extern int nvme_intr_cnt(int); 88 extern boolean_t nvme_format_nvm(int, uint8_t, uint8_t); 89 extern boolean_t nvme_detach(int); 90 extern boolean_t nvme_attach(int); 91 extern boolean_t nvme_firmware_load(int, void *, size_t, offset_t); 92 extern boolean_t nvme_firmware_commit(int fd, int, int, uint16_t *, uint16_t *); 93 94 #ifdef __cplusplus 95 } 96 #endif 97 98 #endif /* _NVMEADM_H */ 99