nvmevar.h revision 1.2
1 /* $NetBSD: nvmevar.h,v 1.2 2016/06/04 16:11:51 nonaka Exp $ */ 2 /* $OpenBSD: nvmevar.h,v 1.8 2016/04/14 11:18:32 dlg Exp $ */ 3 4 /* 5 * Copyright (c) 2014 David Gwynne <dlg (at) openbsd.org> 6 * 7 * Permission to use, copy, modify, and distribute this software for any 8 * purpose with or without fee is hereby granted, provided that the above 9 * copyright notice and this permission notice appear in all copies. 10 * 11 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 12 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 13 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 14 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 15 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 16 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 17 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 18 */ 19 20 #include <sys/bus.h> 21 #include <sys/cpu.h> 22 #include <sys/device.h> 23 #include <sys/mutex.h> 24 #include <sys/pool.h> 25 #include <sys/queue.h> 26 27 struct nvme_dmamem { 28 bus_dmamap_t ndm_map; 29 bus_dma_segment_t ndm_seg; 30 size_t ndm_size; 31 void *ndm_kva; 32 }; 33 #define NVME_DMA_MAP(_ndm) ((_ndm)->ndm_map) 34 #define NVME_DMA_LEN(_ndm) ((_ndm)->ndm_map->dm_segs[0].ds_len) 35 #define NVME_DMA_DVA(_ndm) ((uint64_t)(_ndm)->ndm_map->dm_segs[0].ds_addr) 36 #define NVME_DMA_KVA(_ndm) ((void *)(_ndm)->ndm_kva) 37 38 struct nvme_softc; 39 struct nvme_queue; 40 41 struct nvme_ccb { 42 SIMPLEQ_ENTRY(nvme_ccb) ccb_entry; 43 44 bus_dmamap_t ccb_dmamap; 45 46 void *ccb_cookie; 47 void (*ccb_done)(struct nvme_queue *, 48 struct nvme_ccb *, struct nvme_cqe *); 49 50 bus_addr_t ccb_prpl_off; 51 uint64_t ccb_prpl_dva; 52 uint64_t *ccb_prpl; 53 54 uint16_t ccb_id; 55 }; 56 SIMPLEQ_HEAD(nvme_ccb_list, nvme_ccb); 57 58 struct nvme_queue { 59 struct nvme_softc *q_sc; 60 kmutex_t q_sq_mtx; 61 kmutex_t q_cq_mtx; 62 struct nvme_dmamem *q_sq_dmamem; 63 struct nvme_dmamem *q_cq_dmamem; 64 bus_size_t q_sqtdbl; /* submission queue tail doorbell */ 65 bus_size_t q_cqhdbl; /* completion queue head doorbell */ 66 uint16_t q_id; 67 uint32_t q_entries; 68 uint32_t q_sq_tail; 69 uint32_t q_cq_head; 70 uint16_t q_cq_phase; 71 72 kmutex_t q_ccb_mtx; 73 u_int q_nccbs; 74 struct nvme_ccb *q_ccbs; 75 struct nvme_ccb_list q_ccb_list; 76 struct nvme_dmamem *q_ccb_prpls; 77 }; 78 79 struct nvme_namespace { 80 struct nvm_identify_namespace *ident; 81 device_t dev; 82 uint32_t flags; 83 #define NVME_NS_F_OPEN __BIT(0) 84 }; 85 86 struct nvme_softc { 87 device_t sc_dev; 88 89 bus_space_tag_t sc_iot; 90 bus_space_handle_t sc_ioh; 91 bus_size_t sc_ios; 92 bus_dma_tag_t sc_dmat; 93 94 int (*sc_intr_establish)(struct nvme_softc *, 95 uint16_t qid, struct nvme_queue *); 96 int (*sc_intr_disestablish)(struct nvme_softc *, 97 uint16_t qid); 98 void **sc_ih; 99 100 u_int sc_rdy_to; 101 size_t sc_mps; 102 size_t sc_mdts; 103 u_int sc_max_sgl; 104 105 struct nvm_identify_controller 106 sc_identify; 107 108 u_int sc_nn; 109 struct nvme_namespace *sc_namespaces; 110 111 bool sc_use_mq; 112 u_int sc_nq; /* # of io queue (sc_q) */ 113 struct nvme_queue *sc_admin_q; 114 struct nvme_queue **sc_q; 115 116 uint32_t sc_flags; 117 #define NVME_F_ATTACHED __BIT(0) 118 #define NVME_F_OPEN __BIT(1) 119 }; 120 121 #define lemtoh16(p) le16toh(*((uint16_t *)(p))) 122 #define lemtoh32(p) le32toh(*((uint32_t *)(p))) 123 #define lemtoh64(p) le64toh(*((uint64_t *)(p))) 124 #define htolem16(p, x) (*((uint16_t *)(p)) = htole16(x)) 125 #define htolem32(p, x) (*((uint32_t *)(p)) = htole32(x)) 126 #define htolem64(p, x) (*((uint64_t *)(p)) = htole64(x)) 127 128 struct nvme_attach_args { 129 uint16_t naa_nsid; 130 uint32_t naa_qentries; 131 }; 132 133 int nvme_attach(struct nvme_softc *); 134 int nvme_detach(struct nvme_softc *, int flags); 135 void nvme_childdet(device_t, device_t); 136 int nvme_intr(void *); 137 int nvme_mq_msi_intr(void *); 138 int nvme_mq_msix_intr(void *); 139 140 static inline struct nvme_queue * 141 nvme_get_q(struct nvme_softc *sc) 142 { 143 return sc->sc_q[cpu_index(curcpu()) % sc->sc_nq]; 144 } 145 146 /* 147 * namespace 148 */ 149 static inline struct nvme_namespace * 150 nvme_ns_get(struct nvme_softc *sc, uint16_t nsid) 151 { 152 if (nsid == 0 || nsid - 1 >= sc->sc_nn) 153 return NULL; 154 return &sc->sc_namespaces[nsid - 1]; 155 } 156 157 int nvme_ns_identify(struct nvme_softc *, uint16_t); 158 void nvme_ns_free(struct nvme_softc *, uint16_t); 159 160 struct nvme_ns_context { 161 void *nnc_cookie; 162 void (*nnc_done)(struct nvme_ns_context *); 163 uint16_t nnc_nsid; 164 165 struct buf *nnc_buf; 166 void *nnc_data; 167 int nnc_datasize; 168 int nnc_secsize; 169 daddr_t nnc_blkno; 170 u_int nnc_flags; 171 #define NVME_NS_CTX_F_READ __BIT(0) 172 #define NVME_NS_CTX_F_POLL __BIT(1) 173 174 int nnc_status; 175 }; 176 177 extern pool_cache_t nvme_ns_ctx_cache; 178 179 #define nvme_ns_get_ctx(flags) pool_cache_get(nvme_ns_ctx_cache, (flags)) 180 #define nvme_ns_put_ctx(ctx) pool_cache_put(nvme_ns_ctx_cache, (ctx)) 181 182 int nvme_ns_dobio(struct nvme_softc *, struct nvme_ns_context *); 183 int nvme_ns_sync(struct nvme_softc *, struct nvme_ns_context *); 184
Indexes created Mon Sep 29 21:09:56 GMT 2025