/* * This file and its contents are supplied under the terms of the * Common Development and Distribution License ("CDDL"), version 1.0. * You may only use this file in accordance with the terms of version * 1.0 of the CDDL. * * A full copy of the text of the CDDL should have accompanied this * source. A copy of the CDDL is also available via the Internet at * http://www.illumos.org/license/CDDL. */ /* * Copyright 2016 The MathWorks, Inc. All rights reserved. * Copyright 2019 Joyent, Inc. * Copyright 2019 Unix Software Ltd. * Copyright 2021 Oxide Computer Company. * Copyright 2022 OmniOS Community Edition (OmniOSce) Association. * Copyright 2022 Tintri by DDN, Inc. All rights reserved. */ #ifndef _NVME_VAR_H #define _NVME_VAR_H #include #include #include #include #include /* * NVMe driver state */ #ifdef __cplusplus extern "C" { #endif #define NVME_FMA_INIT 0x1 #define NVME_REGS_MAPPED 0x2 #define NVME_ADMIN_QUEUE 0x4 #define NVME_CTRL_LIMITS 0x8 #define NVME_INTERRUPTS 0x10 #define NVME_UFM_INIT 0x20 #define NVME_MUTEX_INIT 0x40 #define NVME_MGMT_INIT 0x80 #define NVME_MIN_ADMIN_QUEUE_LEN 16 #define NVME_MIN_IO_QUEUE_LEN 16 #define NVME_DEFAULT_ADMIN_QUEUE_LEN 256 #define NVME_DEFAULT_IO_QUEUE_LEN 1024 #define NVME_DEFAULT_ASYNC_EVENT_LIMIT 10 #define NVME_MIN_ASYNC_EVENT_LIMIT 1 #define NVME_DEFAULT_MIN_BLOCK_SIZE 512 typedef struct nvme nvme_t; typedef struct nvme_namespace nvme_namespace_t; typedef struct nvme_minor_state nvme_minor_state_t; typedef struct nvme_dma nvme_dma_t; typedef struct nvme_cmd nvme_cmd_t; typedef struct nvme_cq nvme_cq_t; typedef struct nvme_qpair nvme_qpair_t; typedef struct nvme_task_arg nvme_task_arg_t; struct nvme_minor_state { kthread_t *nm_oexcl; boolean_t nm_open; }; struct nvme_dma { ddi_dma_handle_t nd_dmah; ddi_acc_handle_t nd_acch; ddi_dma_cookie_t nd_cookie; uint_t nd_ncookie; caddr_t nd_memp; size_t nd_len; boolean_t nd_cached; }; struct nvme_cmd { struct list_node nc_list; nvme_sqe_t nc_sqe; nvme_cqe_t nc_cqe; void (*nc_callback)(void *); bd_xfer_t *nc_xfer; boolean_t nc_completed; boolean_t nc_dontpanic; uint16_t nc_sqid; nvme_dma_t *nc_dma; nvme_dma_t *nc_prp; /* DMA for PRP lists */ kmutex_t nc_mutex; kcondvar_t nc_cv; taskq_ent_t nc_tqent; nvme_t *nc_nvme; }; struct nvme_cq { size_t ncq_nentry; uint16_t ncq_id; nvme_dma_t *ncq_dma; nvme_cqe_t *ncq_cq; uint_t ncq_head; uint_t ncq_tail; uintptr_t ncq_hdbl; int ncq_phase; taskq_t *ncq_cmd_taskq; kmutex_t ncq_mutex; }; struct nvme_qpair { size_t nq_nentry; /* submission fields */ nvme_dma_t *nq_sqdma; nvme_sqe_t *nq_sq; uint_t nq_sqhead; uint_t nq_sqtail; uintptr_t nq_sqtdbl; /* completion */ nvme_cq_t *nq_cq; /* shared structures for completion and submission */ nvme_cmd_t **nq_cmd; /* active command array */ uint16_t nq_next_cmd; /* next potential empty queue slot */ uint_t nq_active_cmds; /* number of active cmds */ kmutex_t nq_mutex; /* protects shared state */ ksema_t nq_sema; /* semaphore to ensure q always has >= 1 empty slot */ }; struct nvme { dev_info_t *n_dip; int n_progress; caddr_t n_regs; ddi_acc_handle_t n_regh; kmem_cache_t *n_cmd_cache; kmem_cache_t *n_prp_cache; size_t n_inth_sz; ddi_intr_handle_t *n_inth; int n_intr_cnt; uint_t n_intr_pri; int n_intr_cap; int n_intr_type; int n_intr_types; char *n_product; char *n_vendor; nvme_version_t n_version; boolean_t n_dead; boolean_t n_strict_version; boolean_t n_ignore_unknown_vendor_status; uint32_t n_admin_queue_len; uint32_t n_io_squeue_len; uint32_t n_io_cqueue_len; uint16_t n_async_event_limit; uint_t n_min_block_size; uint16_t n_abort_command_limit; uint64_t n_max_data_transfer_size; boolean_t n_write_cache_present; boolean_t n_write_cache_enabled; int n_error_log_len; boolean_t n_lba_range_supported; boolean_t n_auto_pst_supported; boolean_t n_async_event_supported; boolean_t n_progress_supported; int n_submission_queues; int n_completion_queues; int n_nssr_supported; int n_doorbell_stride; int n_timeout; int n_arbitration_mechanisms; int n_cont_queues_reqd; int n_max_queue_entries; int n_pageshift; int n_pagesize; int n_namespace_count; uint_t n_namespaces_attachable; uint_t n_ioq_count; uint_t n_cq_count; nvme_identify_ctrl_t *n_idctl; /* Pointer to the admin queue, which is always queue 0 in n_ioq. */ nvme_qpair_t *n_adminq; /* * All command queues, including the admin queue. * Its length is: n_ioq_count + 1. */ nvme_qpair_t **n_ioq; nvme_cq_t **n_cq; nvme_namespace_t *n_ns; ddi_dma_attr_t n_queue_dma_attr; ddi_dma_attr_t n_prp_dma_attr; ddi_dma_attr_t n_sgl_dma_attr; ddi_device_acc_attr_t n_reg_acc_attr; ddi_iblock_cookie_t n_fm_ibc; int n_fm_cap; ksema_t n_abort_sema; /* protects namespace management operations */ kmutex_t n_mgmt_mutex; /* protects minor node operations */ kmutex_t n_minor_mutex; /* state for devctl minor node */ nvme_minor_state_t n_minor; /* errors detected by driver */ uint32_t n_dma_bind_err; uint32_t n_abort_failed; uint32_t n_cmd_timeout; uint32_t n_cmd_aborted; uint32_t n_wrong_logpage; uint32_t n_unknown_logpage; uint32_t n_too_many_cookies; /* errors detected by hardware */ uint32_t n_data_xfr_err; uint32_t n_internal_err; uint32_t n_abort_rq_err; uint32_t n_abort_sq_del; uint32_t n_nvm_cap_exc; uint32_t n_nvm_ns_notrdy; uint32_t n_inv_cq_err; uint32_t n_inv_qid_err; uint32_t n_max_qsz_exc; uint32_t n_inv_int_vect; uint32_t n_inv_log_page; uint32_t n_inv_format; uint32_t n_inv_q_del; uint32_t n_cnfl_attr; uint32_t n_inv_prot; uint32_t n_readonly; /* errors reported by asynchronous events */ uint32_t n_diagfail_event; uint32_t n_persistent_event; uint32_t n_transient_event; uint32_t n_fw_load_event; uint32_t n_reliability_event; uint32_t n_temperature_event; uint32_t n_spare_event; uint32_t n_vendor_event; uint32_t n_notice_event; uint32_t n_unknown_event; /* hot removal NDI event handling */ ddi_eventcookie_t n_rm_cookie; ddi_callback_id_t n_ev_rm_cb_id; /* DDI UFM handle */ ddi_ufm_handle_t *n_ufmh; /* Cached Firmware Slot Information log page */ nvme_fwslot_log_t *n_fwslot; /* Lock protecting the cached firmware slot info */ kmutex_t n_fwslot_mutex; }; struct nvme_namespace { nvme_t *ns_nvme; uint8_t ns_eui64[8]; uint8_t ns_nguid[16]; char ns_name[17]; bd_handle_t ns_bd_hdl; uint32_t ns_id; size_t ns_block_count; size_t ns_block_size; size_t ns_best_block_size; boolean_t ns_allocated; boolean_t ns_active; boolean_t ns_ignore; boolean_t ns_attached; nvme_identify_nsid_t *ns_idns; /* state for attachment point minor node */ nvme_minor_state_t ns_minor; /* * If a namespace has neither NGUID nor EUI64, we create a devid in * nvme_prepare_devid(). */ char *ns_devid; }; struct nvme_task_arg { nvme_t *nt_nvme; nvme_cmd_t *nt_cmd; }; #ifdef __cplusplus } #endif #endif /* _NVME_VAR_H */