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 2021 Oxide Computer Company 14 * Copyright 2022 Tintri by DDN, Inc. All rights reserved. 15 */ 16 17 #ifndef _NVMEADM_H 18 #define _NVMEADM_H 19 20 #include <stdio.h> 21 #include <libdevinfo.h> 22 #include <sys/nvme.h> 23 #include <nvme_reg.h> 24 #include <ofmt.h> 25 26 #ifdef __cplusplus 27 extern "C" { 28 #endif 29 30 extern int verbose; 31 extern int debug; 32 33 /* Common structures */ 34 typedef struct nvme_process_arg nvme_process_arg_t; 35 typedef struct nvme_feature nvme_feature_t; 36 typedef struct nvmeadm_cmd nvmeadm_cmd_t; 37 38 struct nvme_process_arg { 39 int npa_argc; 40 char **npa_argv; 41 char *npa_name; 42 char *npa_nsid; 43 int npa_found; 44 boolean_t npa_isns; 45 const nvmeadm_cmd_t *npa_cmd; 46 di_node_t npa_node; 47 di_minor_t npa_minor; 48 char *npa_path; 49 char *npa_dsk; 50 nvme_identify_ctrl_t *npa_idctl; 51 nvme_identify_nsid_t *npa_idns; 52 nvme_version_t *npa_version; 53 ofmt_handle_t npa_ofmt; 54 }; 55 56 /* Version checking */ 57 extern boolean_t nvme_version_check(nvme_version_t *, uint_t, uint_t); 58 59 /* printing functions */ 60 extern int nvme_strlen(const char *, int); 61 extern void nvme_print(int, const char *, int, const char *, ...); 62 extern void nvme_print_ctrl_summary(nvme_identify_ctrl_t *, nvme_version_t *); 63 extern void nvme_print_nsid_summary(nvme_identify_nsid_t *); 64 extern void nvme_print_identify_ctrl(nvme_identify_ctrl_t *, 65 nvme_capabilities_t *, nvme_version_t *); 66 extern void nvme_print_identify_nsid(nvme_identify_nsid_t *, nvme_version_t *); 67 extern void nvme_print_error_log(int, nvme_error_log_entry_t *, 68 nvme_version_t *); 69 extern void nvme_print_health_log(nvme_health_log_t *, nvme_identify_ctrl_t *, 70 nvme_version_t *); 71 extern void nvme_print_fwslot_log(nvme_fwslot_log_t *, nvme_identify_ctrl_t *); 72 73 extern void nvme_print_feat_arbitration(uint64_t, void *, size_t, 74 nvme_identify_ctrl_t *, nvme_version_t *); 75 extern void nvme_print_feat_power_mgmt(uint64_t, void *, size_t, 76 nvme_identify_ctrl_t *, nvme_version_t *); 77 extern void nvme_print_feat_lba_range(uint64_t, void *, size_t, 78 nvme_identify_ctrl_t *, nvme_version_t *); 79 extern void nvme_print_feat_temperature(uint64_t, void *, size_t, 80 nvme_identify_ctrl_t *, nvme_version_t *); 81 extern void nvme_print_feat_error(uint64_t, void *, size_t, 82 nvme_identify_ctrl_t *, nvme_version_t *); 83 extern void nvme_print_feat_write_cache(uint64_t, void *, size_t, 84 nvme_identify_ctrl_t *, nvme_version_t *); 85 extern void nvme_print_feat_nqueues(uint64_t, void *, size_t, 86 nvme_identify_ctrl_t *, nvme_version_t *); 87 extern void nvme_print_feat_intr_coal(uint64_t, void *, size_t, 88 nvme_identify_ctrl_t *, nvme_version_t *); 89 extern void nvme_print_feat_intr_vect(uint64_t, void *, size_t, 90 nvme_identify_ctrl_t *, nvme_version_t *); 91 extern void nvme_print_feat_write_atom(uint64_t, void *, size_t, 92 nvme_identify_ctrl_t *, nvme_version_t *); 93 extern void nvme_print_feat_async_event(uint64_t, void *, size_t, 94 nvme_identify_ctrl_t *, nvme_version_t *); 95 extern void nvme_print_feat_auto_pst(uint64_t, void *, size_t, 96 nvme_identify_ctrl_t *, nvme_version_t *); 97 extern void nvme_print_feat_progress(uint64_t, void *, size_t, 98 nvme_identify_ctrl_t *, nvme_version_t *); 99 extern const char *nvme_fw_error(int, int); 100 101 /* device node functions */ 102 extern int nvme_open(di_minor_t); 103 extern void nvme_close(int); 104 extern nvme_version_t *nvme_version(int); 105 extern nvme_capabilities_t *nvme_capabilities(int); 106 extern nvme_identify_ctrl_t *nvme_identify_ctrl(int); 107 extern nvme_identify_nsid_t *nvme_identify_nsid(int); 108 extern void *nvme_get_logpage(int, uint8_t, size_t *); 109 extern boolean_t nvme_get_feature(int, uint8_t, uint32_t, uint64_t *, size_t *, 110 void **); 111 extern int nvme_intr_cnt(int); 112 extern boolean_t nvme_format_nvm(int, uint8_t, uint8_t); 113 extern boolean_t nvme_detach(int); 114 extern boolean_t nvme_attach(int); 115 extern boolean_t nvme_firmware_load(int, void *, size_t, offset_t, uint16_t *); 116 extern boolean_t nvme_firmware_commit(int, int, int, uint16_t *); 117 118 /* 119 * ofmt related 120 */ 121 extern const ofmt_field_t nvme_list_ofmt[]; 122 123 #ifdef __cplusplus 124 } 125 #endif 126 127 #endif /* _NVMEADM_H */ 128