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. All rights reserved. 14 * Copyright 2016 The MathWorks, Inc. All rights reserved. 15 */ 16 17 #ifndef _NVME_VAR_H 18 #define _NVME_VAR_H 19 20 #include <sys/ddi.h> 21 #include <sys/sunddi.h> 22 #include <sys/blkdev.h> 23 #include <sys/taskq_impl.h> 24 25 /* 26 * NVMe driver state 27 */ 28 29 #ifdef __cplusplus 30 extern "C" { 31 #endif 32 33 #define NVME_FMA_INIT 0x1 34 #define NVME_REGS_MAPPED 0x2 35 #define NVME_ADMIN_QUEUE 0x4 36 #define NVME_CTRL_LIMITS 0x8 37 #define NVME_INTERRUPTS 0x10 38 39 #define NVME_MIN_ADMIN_QUEUE_LEN 16 40 #define NVME_MIN_IO_QUEUE_LEN 16 41 #define NVME_DEFAULT_ADMIN_QUEUE_LEN 256 42 #define NVME_DEFAULT_IO_QUEUE_LEN 1024 43 #define NVME_DEFAULT_ASYNC_EVENT_LIMIT 10 44 #define NVME_MIN_ASYNC_EVENT_LIMIT 1 45 #define NVME_DEFAULT_MIN_BLOCK_SIZE 512 46 47 48 typedef struct nvme nvme_t; 49 typedef struct nvme_namespace nvme_namespace_t; 50 typedef struct nvme_minor_state nvme_minor_state_t; 51 typedef struct nvme_dma nvme_dma_t; 52 typedef struct nvme_cmd nvme_cmd_t; 53 typedef struct nvme_qpair nvme_qpair_t; 54 typedef struct nvme_task_arg nvme_task_arg_t; 55 56 struct nvme_minor_state { 57 kmutex_t nm_mutex; 58 boolean_t nm_oexcl; 59 uint_t nm_ocnt; 60 }; 61 62 struct nvme_dma { 63 ddi_dma_handle_t nd_dmah; 64 ddi_acc_handle_t nd_acch; 65 ddi_dma_cookie_t nd_cookie; 66 uint_t nd_ncookie; 67 caddr_t nd_memp; 68 size_t nd_len; 69 boolean_t nd_cached; 70 }; 71 72 struct nvme_cmd { 73 nvme_sqe_t nc_sqe; 74 nvme_cqe_t nc_cqe; 75 76 void (*nc_callback)(void *); 77 bd_xfer_t *nc_xfer; 78 boolean_t nc_completed; 79 boolean_t nc_dontpanic; 80 uint16_t nc_sqid; 81 82 nvme_dma_t *nc_dma; 83 84 kmutex_t nc_mutex; 85 kcondvar_t nc_cv; 86 87 taskq_ent_t nc_tqent; 88 nvme_t *nc_nvme; 89 }; 90 91 struct nvme_qpair { 92 size_t nq_nentry; 93 94 nvme_dma_t *nq_sqdma; 95 nvme_sqe_t *nq_sq; 96 uint_t nq_sqhead; 97 uint_t nq_sqtail; 98 uintptr_t nq_sqtdbl; 99 100 nvme_dma_t *nq_cqdma; 101 nvme_cqe_t *nq_cq; 102 uint_t nq_cqhead; 103 uint_t nq_cqtail; 104 uintptr_t nq_cqhdbl; 105 106 nvme_cmd_t **nq_cmd; 107 uint16_t nq_next_cmd; 108 uint_t nq_active_cmds; 109 int nq_phase; 110 111 kmutex_t nq_mutex; 112 }; 113 114 struct nvme { 115 dev_info_t *n_dip; 116 int n_progress; 117 118 caddr_t n_regs; 119 ddi_acc_handle_t n_regh; 120 121 kmem_cache_t *n_cmd_cache; 122 kmem_cache_t *n_prp_cache; 123 124 size_t n_inth_sz; 125 ddi_intr_handle_t *n_inth; 126 int n_intr_cnt; 127 uint_t n_intr_pri; 128 int n_intr_cap; 129 int n_intr_type; 130 int n_intr_types; 131 132 char *n_product; 133 char *n_vendor; 134 135 nvme_version_t n_version; 136 boolean_t n_dead; 137 boolean_t n_strict_version; 138 boolean_t n_ignore_unknown_vendor_status; 139 uint32_t n_admin_queue_len; 140 uint32_t n_io_queue_len; 141 uint16_t n_async_event_limit; 142 uint_t n_min_block_size; 143 uint16_t n_abort_command_limit; 144 uint64_t n_max_data_transfer_size; 145 boolean_t n_write_cache_present; 146 boolean_t n_write_cache_enabled; 147 int n_error_log_len; 148 boolean_t n_lba_range_supported; 149 boolean_t n_auto_pst_supported; 150 151 int n_nssr_supported; 152 int n_doorbell_stride; 153 int n_timeout; 154 int n_arbitration_mechanisms; 155 int n_cont_queues_reqd; 156 int n_max_queue_entries; 157 int n_pageshift; 158 int n_pagesize; 159 160 int n_namespace_count; 161 int n_ioq_count; 162 163 nvme_identify_ctrl_t *n_idctl; 164 165 nvme_qpair_t *n_adminq; 166 nvme_qpair_t **n_ioq; 167 168 nvme_namespace_t *n_ns; 169 170 ddi_dma_attr_t n_queue_dma_attr; 171 ddi_dma_attr_t n_prp_dma_attr; 172 ddi_dma_attr_t n_sgl_dma_attr; 173 ddi_device_acc_attr_t n_reg_acc_attr; 174 ddi_iblock_cookie_t n_fm_ibc; 175 int n_fm_cap; 176 177 ksema_t n_abort_sema; 178 179 ddi_taskq_t *n_cmd_taskq; 180 181 /* state for devctl minor node */ 182 nvme_minor_state_t n_minor; 183 184 /* errors detected by driver */ 185 uint32_t n_dma_bind_err; 186 uint32_t n_abort_failed; 187 uint32_t n_cmd_timeout; 188 uint32_t n_cmd_aborted; 189 uint32_t n_async_resubmit_failed; 190 uint32_t n_wrong_logpage; 191 uint32_t n_unknown_logpage; 192 uint32_t n_too_many_cookies; 193 uint32_t n_admin_queue_full; 194 195 /* errors detected by hardware */ 196 uint32_t n_data_xfr_err; 197 uint32_t n_internal_err; 198 uint32_t n_abort_rq_err; 199 uint32_t n_abort_sq_del; 200 uint32_t n_nvm_cap_exc; 201 uint32_t n_nvm_ns_notrdy; 202 uint32_t n_inv_cq_err; 203 uint32_t n_inv_qid_err; 204 uint32_t n_max_qsz_exc; 205 uint32_t n_inv_int_vect; 206 uint32_t n_inv_log_page; 207 uint32_t n_inv_format; 208 uint32_t n_inv_q_del; 209 uint32_t n_cnfl_attr; 210 uint32_t n_inv_prot; 211 uint32_t n_readonly; 212 213 /* errors reported by asynchronous events */ 214 uint32_t n_diagfail_event; 215 uint32_t n_persistent_event; 216 uint32_t n_transient_event; 217 uint32_t n_fw_load_event; 218 uint32_t n_reliability_event; 219 uint32_t n_temperature_event; 220 uint32_t n_spare_event; 221 uint32_t n_vendor_event; 222 uint32_t n_unknown_event; 223 224 }; 225 226 struct nvme_namespace { 227 nvme_t *ns_nvme; 228 uint8_t ns_eui64[8]; 229 char ns_name[17]; 230 231 bd_handle_t ns_bd_hdl; 232 233 uint32_t ns_id; 234 size_t ns_block_count; 235 size_t ns_block_size; 236 size_t ns_best_block_size; 237 238 boolean_t ns_ignore; 239 240 nvme_identify_nsid_t *ns_idns; 241 242 /* state for attachment point minor node */ 243 nvme_minor_state_t ns_minor; 244 245 /* 246 * If a namespace has no EUI64, we create a devid in 247 * nvme_prepare_devid(). 248 */ 249 char *ns_devid; 250 }; 251 252 struct nvme_task_arg { 253 nvme_t *nt_nvme; 254 nvme_cmd_t *nt_cmd; 255 }; 256 257 258 #ifdef __cplusplus 259 } 260 #endif 261 262 #endif /* _NVME_VAR_H */ 263