2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (C) 2012-2014 Intel Corporation
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 #ifndef __NVME_PRIVATE_H__
32 #define __NVME_PRIVATE_H__
34 #include <sys/param.h>
37 #include <sys/kernel.h>
39 #include <sys/malloc.h>
40 #include <sys/mutex.h>
42 #include <sys/systm.h>
43 #include <sys/taskqueue.h>
47 #include <machine/bus.h>
51 #define DEVICE2SOFTC(dev) ((struct nvme_controller *) device_get_softc(dev))
53 MALLOC_DECLARE(M_NVME);
55 #define IDT32_PCI_ID 0x80d0111d /* 32 channel board */
56 #define IDT8_PCI_ID 0x80d2111d /* 8 channel board */
59 * For commands requiring more than 2 PRP entries, one PRP will be
60 * embedded in the command (prp1), and the rest of the PRP entries
61 * will be in a list pointed to by the command (prp2). This means
62 * that real max number of PRP entries we support is 32+1, which
63 * results in a max xfer size of 32*PAGE_SIZE.
65 #define NVME_MAX_PRP_LIST_ENTRIES (NVME_MAX_XFER_SIZE / PAGE_SIZE)
67 #define NVME_ADMIN_TRACKERS (16)
68 #define NVME_ADMIN_ENTRIES (128)
69 /* min and max are defined in admin queue attributes section of spec */
70 #define NVME_MIN_ADMIN_ENTRIES (2)
71 #define NVME_MAX_ADMIN_ENTRIES (4096)
74 * NVME_IO_ENTRIES defines the size of an I/O qpair's submission and completion
75 * queues, while NVME_IO_TRACKERS defines the maximum number of I/O that we
76 * will allow outstanding on an I/O qpair at any time. The only advantage in
77 * having IO_ENTRIES > IO_TRACKERS is for debugging purposes - when dumping
78 * the contents of the submission and completion queues, it will show a longer
81 #define NVME_IO_ENTRIES (256)
82 #define NVME_IO_TRACKERS (128)
83 #define NVME_MIN_IO_TRACKERS (4)
84 #define NVME_MAX_IO_TRACKERS (1024)
87 * NVME_MAX_IO_ENTRIES is not defined, since it is specified in CC.MQES
88 * for each controller.
91 #define NVME_INT_COAL_TIME (0) /* disabled */
92 #define NVME_INT_COAL_THRESHOLD (0) /* 0-based */
94 #define NVME_MAX_NAMESPACES (16)
95 #define NVME_MAX_CONSUMERS (2)
96 #define NVME_MAX_ASYNC_EVENTS (8)
98 #define NVME_DEFAULT_TIMEOUT_PERIOD (30) /* in seconds */
99 #define NVME_MIN_TIMEOUT_PERIOD (5)
100 #define NVME_MAX_TIMEOUT_PERIOD (120)
102 #define NVME_DEFAULT_RETRY_COUNT (4)
104 /* Maximum log page size to fetch for AERs. */
105 #define NVME_MAX_AER_LOG_SIZE (4096)
108 * Define CACHE_LINE_SIZE here for older FreeBSD versions that do not define
111 #ifndef CACHE_LINE_SIZE
112 #define CACHE_LINE_SIZE (64)
116 * Use presence of the BIO_UNMAPPED flag to determine whether unmapped I/O
117 * support and the bus_dmamap_load_bio API are available on the target
118 * kernel. This will ease porting back to earlier stable branches at a
122 #define NVME_UNMAPPED_BIO_SUPPORT
125 extern uma_zone_t nvme_request_zone;
126 extern int32_t nvme_retry_count;
128 struct nvme_completion_poll_status {
130 struct nvme_completion cpl;
134 #define NVME_REQUEST_VADDR 1
135 #define NVME_REQUEST_NULL 2 /* For requests with no payload. */
136 #define NVME_REQUEST_UIO 3
137 #ifdef NVME_UNMAPPED_BIO_SUPPORT
138 #define NVME_REQUEST_BIO 4
140 #define NVME_REQUEST_CCB 5
142 struct nvme_request {
144 struct nvme_command cmd;
145 struct nvme_qpair *qpair;
151 uint32_t payload_size;
156 STAILQ_ENTRY(nvme_request) stailq;
159 struct nvme_async_event_request {
161 struct nvme_controller *ctrlr;
162 struct nvme_request *req;
163 struct nvme_completion cpl;
164 uint32_t log_page_id;
165 uint32_t log_page_size;
166 uint8_t log_page_buffer[NVME_MAX_AER_LOG_SIZE];
169 struct nvme_tracker {
171 TAILQ_ENTRY(nvme_tracker) tailq;
172 struct nvme_request *req;
173 struct nvme_qpair *qpair;
174 struct callout timer;
175 bus_dmamap_t payload_dma_map;
179 bus_addr_t prp_bus_addr;
184 struct nvme_controller *ctrlr;
190 struct resource *res;
193 uint32_t num_entries;
194 uint32_t num_trackers;
195 uint32_t sq_tdbl_off;
196 uint32_t cq_hdbl_off;
203 int64_t num_intr_handler_calls;
205 struct nvme_command *cmd;
206 struct nvme_completion *cpl;
208 bus_dma_tag_t dma_tag;
209 bus_dma_tag_t dma_tag_payload;
211 bus_dmamap_t queuemem_map;
212 uint64_t cmd_bus_addr;
213 uint64_t cpl_bus_addr;
215 TAILQ_HEAD(, nvme_tracker) free_tr;
216 TAILQ_HEAD(, nvme_tracker) outstanding_tr;
217 STAILQ_HEAD(, nvme_request) queued_req;
219 struct nvme_tracker **act_tr;
221 boolean_t is_enabled;
223 struct mtx lock __aligned(CACHE_LINE_SIZE);
225 } __aligned(CACHE_LINE_SIZE);
227 struct nvme_namespace {
229 struct nvme_controller *ctrlr;
230 struct nvme_namespace_data data;
234 void *cons_cookie[NVME_MAX_CONSUMERS];
240 * One of these per allocated PCI device.
242 struct nvme_controller {
248 uint32_t ready_timeout_in_ms;
250 bus_space_tag_t bus_tag;
251 bus_space_handle_t bus_handle;
253 struct resource *resource;
256 * The NVMe spec allows for the MSI-X table to be placed in BAR 4/5,
257 * separate from the control registers which are in BAR 0/1. These
258 * members track the mapping of BAR 4/5 for that reason.
260 int bar4_resource_id;
261 struct resource *bar4_resource;
263 uint32_t msix_enabled;
265 uint32_t enable_aborts;
267 uint32_t num_io_queues;
268 uint32_t num_cpus_per_ioq;
269 uint32_t max_hw_pend_io;
271 /* Fields for tracking progress during controller initialization. */
272 struct intr_config_hook config_hook;
273 uint32_t ns_identified;
274 uint32_t queues_created;
276 struct task reset_task;
277 struct task fail_req_task;
278 struct taskqueue *taskqueue;
280 /* For shared legacy interrupt. */
282 struct resource *res;
285 bus_dma_tag_t hw_desc_tag;
286 bus_dmamap_t hw_desc_map;
288 /** maximum i/o size in bytes */
289 uint32_t max_xfer_size;
291 /** minimum page size supported by this controller in bytes */
292 uint32_t min_page_size;
294 /** interrupt coalescing time period (in microseconds) */
295 uint32_t int_coal_time;
297 /** interrupt coalescing threshold */
298 uint32_t int_coal_threshold;
300 /** timeout period in seconds */
301 uint32_t timeout_period;
303 struct nvme_qpair adminq;
304 struct nvme_qpair *ioq;
306 struct nvme_registers *regs;
308 struct nvme_controller_data cdata;
309 struct nvme_namespace ns[NVME_MAX_NAMESPACES];
313 /** bit mask of warning types currently enabled for async events */
314 union nvme_critical_warning_state async_event_config;
317 struct nvme_async_event_request aer[NVME_MAX_ASYNC_EVENTS];
319 void *cons_cookie[NVME_MAX_CONSUMERS];
321 uint32_t is_resetting;
322 uint32_t is_initialized;
323 uint32_t notification_sent;
326 STAILQ_HEAD(, nvme_request) fail_req;
329 #define nvme_mmio_offsetof(reg) \
330 offsetof(struct nvme_registers, reg)
332 #define nvme_mmio_read_4(sc, reg) \
333 bus_space_read_4((sc)->bus_tag, (sc)->bus_handle, \
334 nvme_mmio_offsetof(reg))
336 #define nvme_mmio_write_4(sc, reg, val) \
337 bus_space_write_4((sc)->bus_tag, (sc)->bus_handle, \
338 nvme_mmio_offsetof(reg), val)
340 #define nvme_mmio_write_8(sc, reg, val) \
342 bus_space_write_4((sc)->bus_tag, (sc)->bus_handle, \
343 nvme_mmio_offsetof(reg), val & 0xFFFFFFFF); \
344 bus_space_write_4((sc)->bus_tag, (sc)->bus_handle, \
345 nvme_mmio_offsetof(reg)+4, \
346 (val & 0xFFFFFFFF00000000UL) >> 32); \
349 #if __FreeBSD_version < 800054
350 #define wmb() __asm volatile("sfence" ::: "memory")
351 #define mb() __asm volatile("mfence" ::: "memory")
354 #define nvme_printf(ctrlr, fmt, args...) \
355 device_printf(ctrlr->dev, fmt, ##args)
357 void nvme_ns_test(struct nvme_namespace *ns, u_long cmd, caddr_t arg);
359 void nvme_ctrlr_cmd_identify_controller(struct nvme_controller *ctrlr,
361 nvme_cb_fn_t cb_fn, void *cb_arg);
362 void nvme_ctrlr_cmd_identify_namespace(struct nvme_controller *ctrlr,
363 uint32_t nsid, void *payload,
364 nvme_cb_fn_t cb_fn, void *cb_arg);
365 void nvme_ctrlr_cmd_set_interrupt_coalescing(struct nvme_controller *ctrlr,
366 uint32_t microseconds,
370 void nvme_ctrlr_cmd_get_error_page(struct nvme_controller *ctrlr,
371 struct nvme_error_information_entry *payload,
372 uint32_t num_entries, /* 0 = max */
375 void nvme_ctrlr_cmd_get_health_information_page(struct nvme_controller *ctrlr,
377 struct nvme_health_information_page *payload,
380 void nvme_ctrlr_cmd_get_firmware_page(struct nvme_controller *ctrlr,
381 struct nvme_firmware_page *payload,
384 void nvme_ctrlr_cmd_create_io_cq(struct nvme_controller *ctrlr,
385 struct nvme_qpair *io_que, uint16_t vector,
386 nvme_cb_fn_t cb_fn, void *cb_arg);
387 void nvme_ctrlr_cmd_create_io_sq(struct nvme_controller *ctrlr,
388 struct nvme_qpair *io_que,
389 nvme_cb_fn_t cb_fn, void *cb_arg);
390 void nvme_ctrlr_cmd_delete_io_cq(struct nvme_controller *ctrlr,
391 struct nvme_qpair *io_que,
392 nvme_cb_fn_t cb_fn, void *cb_arg);
393 void nvme_ctrlr_cmd_delete_io_sq(struct nvme_controller *ctrlr,
394 struct nvme_qpair *io_que,
395 nvme_cb_fn_t cb_fn, void *cb_arg);
396 void nvme_ctrlr_cmd_set_num_queues(struct nvme_controller *ctrlr,
397 uint32_t num_queues, nvme_cb_fn_t cb_fn,
399 void nvme_ctrlr_cmd_set_async_event_config(struct nvme_controller *ctrlr,
400 union nvme_critical_warning_state state,
401 nvme_cb_fn_t cb_fn, void *cb_arg);
402 void nvme_ctrlr_cmd_abort(struct nvme_controller *ctrlr, uint16_t cid,
403 uint16_t sqid, nvme_cb_fn_t cb_fn, void *cb_arg);
405 void nvme_completion_poll_cb(void *arg, const struct nvme_completion *cpl);
407 int nvme_ctrlr_construct(struct nvme_controller *ctrlr, device_t dev);
408 void nvme_ctrlr_destruct(struct nvme_controller *ctrlr, device_t dev);
409 void nvme_ctrlr_shutdown(struct nvme_controller *ctrlr);
410 int nvme_ctrlr_hw_reset(struct nvme_controller *ctrlr);
411 void nvme_ctrlr_reset(struct nvme_controller *ctrlr);
412 /* ctrlr defined as void * to allow use with config_intrhook. */
413 void nvme_ctrlr_start_config_hook(void *ctrlr_arg);
414 void nvme_ctrlr_submit_admin_request(struct nvme_controller *ctrlr,
415 struct nvme_request *req);
416 void nvme_ctrlr_submit_io_request(struct nvme_controller *ctrlr,
417 struct nvme_request *req);
418 void nvme_ctrlr_post_failed_request(struct nvme_controller *ctrlr,
419 struct nvme_request *req);
421 int nvme_qpair_construct(struct nvme_qpair *qpair, uint32_t id,
422 uint16_t vector, uint32_t num_entries,
423 uint32_t num_trackers,
424 struct nvme_controller *ctrlr);
425 void nvme_qpair_submit_tracker(struct nvme_qpair *qpair,
426 struct nvme_tracker *tr);
427 void nvme_qpair_process_completions(struct nvme_qpair *qpair);
428 void nvme_qpair_submit_request(struct nvme_qpair *qpair,
429 struct nvme_request *req);
430 void nvme_qpair_reset(struct nvme_qpair *qpair);
431 void nvme_qpair_fail(struct nvme_qpair *qpair);
432 void nvme_qpair_manual_complete_request(struct nvme_qpair *qpair,
433 struct nvme_request *req,
434 uint32_t sct, uint32_t sc,
435 boolean_t print_on_error);
437 void nvme_admin_qpair_enable(struct nvme_qpair *qpair);
438 void nvme_admin_qpair_disable(struct nvme_qpair *qpair);
439 void nvme_admin_qpair_destroy(struct nvme_qpair *qpair);
441 void nvme_io_qpair_enable(struct nvme_qpair *qpair);
442 void nvme_io_qpair_disable(struct nvme_qpair *qpair);
443 void nvme_io_qpair_destroy(struct nvme_qpair *qpair);
445 int nvme_ns_construct(struct nvme_namespace *ns, uint32_t id,
446 struct nvme_controller *ctrlr);
447 void nvme_ns_destruct(struct nvme_namespace *ns);
449 void nvme_sysctl_initialize_ctrlr(struct nvme_controller *ctrlr);
451 void nvme_dump_command(struct nvme_command *cmd);
452 void nvme_dump_completion(struct nvme_completion *cpl);
455 nvme_single_map(void *arg, bus_dma_segment_t *seg, int nseg, int error)
457 uint64_t *bus_addr = (uint64_t *)arg;
460 printf("nvme_single_map err %d\n", error);
461 *bus_addr = seg[0].ds_addr;
464 static __inline struct nvme_request *
465 _nvme_allocate_request(nvme_cb_fn_t cb_fn, void *cb_arg)
467 struct nvme_request *req;
469 req = uma_zalloc(nvme_request_zone, M_NOWAIT | M_ZERO);
472 req->cb_arg = cb_arg;
478 static __inline struct nvme_request *
479 nvme_allocate_request_vaddr(void *payload, uint32_t payload_size,
480 nvme_cb_fn_t cb_fn, void *cb_arg)
482 struct nvme_request *req;
484 req = _nvme_allocate_request(cb_fn, cb_arg);
486 req->type = NVME_REQUEST_VADDR;
487 req->u.payload = payload;
488 req->payload_size = payload_size;
493 static __inline struct nvme_request *
494 nvme_allocate_request_null(nvme_cb_fn_t cb_fn, void *cb_arg)
496 struct nvme_request *req;
498 req = _nvme_allocate_request(cb_fn, cb_arg);
500 req->type = NVME_REQUEST_NULL;
504 static __inline struct nvme_request *
505 nvme_allocate_request_bio(struct bio *bio, nvme_cb_fn_t cb_fn, void *cb_arg)
507 struct nvme_request *req;
509 req = _nvme_allocate_request(cb_fn, cb_arg);
511 #ifdef NVME_UNMAPPED_BIO_SUPPORT
512 req->type = NVME_REQUEST_BIO;
515 req->type = NVME_REQUEST_VADDR;
516 req->u.payload = bio->bio_data;
517 req->payload_size = bio->bio_bcount;
523 static __inline struct nvme_request *
524 nvme_allocate_request_ccb(union ccb *ccb, nvme_cb_fn_t cb_fn, void *cb_arg)
526 struct nvme_request *req;
528 req = _nvme_allocate_request(cb_fn, cb_arg);
530 req->type = NVME_REQUEST_CCB;
531 req->u.payload = ccb;
537 #define nvme_free_request(req) uma_zfree(nvme_request_zone, req)
539 void nvme_notify_async_consumers(struct nvme_controller *ctrlr,
540 const struct nvme_completion *async_cpl,
541 uint32_t log_page_id, void *log_page_buffer,
542 uint32_t log_page_size);
543 void nvme_notify_fail_consumers(struct nvme_controller *ctrlr);
544 void nvme_notify_new_controller(struct nvme_controller *ctrlr);
546 void nvme_ctrlr_intx_handler(void *arg);
547 void nvme_ctrlr_poll(struct nvme_controller *ctrlr);
549 #endif /* __NVME_PRIVATE_H__ */