nvmeio.h revision 1.1.18.2
1 1.1.18.2 jdolecek /* $NetBSD: nvmeio.h,v 1.1.18.2 2017/12/03 11:37:03 jdolecek Exp $ */ 2 1.1.18.2 jdolecek 3 1.1.18.2 jdolecek /*- 4 1.1.18.2 jdolecek * Copyright (C) 2012-2013 Intel Corporation 5 1.1.18.2 jdolecek * All rights reserved. 6 1.1.18.2 jdolecek * 7 1.1.18.2 jdolecek * Redistribution and use in source and binary forms, with or without 8 1.1.18.2 jdolecek * modification, are permitted provided that the following conditions 9 1.1.18.2 jdolecek * are met: 10 1.1.18.2 jdolecek * 1. Redistributions of source code must retain the above copyright 11 1.1.18.2 jdolecek * notice, this list of conditions and the following disclaimer. 12 1.1.18.2 jdolecek * 2. Redistributions in binary form must reproduce the above copyright 13 1.1.18.2 jdolecek * notice, this list of conditions and the following disclaimer in the 14 1.1.18.2 jdolecek * documentation and/or other materials provided with the distribution. 15 1.1.18.2 jdolecek * 16 1.1.18.2 jdolecek * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17 1.1.18.2 jdolecek * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 1.1.18.2 jdolecek * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 1.1.18.2 jdolecek * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 20 1.1.18.2 jdolecek * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 1.1.18.2 jdolecek * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 1.1.18.2 jdolecek * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 1.1.18.2 jdolecek * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 1.1.18.2 jdolecek * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 1.1.18.2 jdolecek * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 1.1.18.2 jdolecek * SUCH DAMAGE. 27 1.1.18.2 jdolecek * 28 1.1.18.2 jdolecek * $FreeBSD: head/sys/dev/nvme/nvme.h 296617 2016-03-10 17:13:10Z mav $ 29 1.1.18.2 jdolecek */ 30 1.1.18.2 jdolecek 31 1.1.18.2 jdolecek #ifndef __NVMEIO_H__ 32 1.1.18.2 jdolecek #define __NVMEIO_H__ 33 1.1.18.2 jdolecek 34 1.1.18.2 jdolecek #include <sys/ioccom.h> 35 1.1.18.2 jdolecek #include <dev/ic/nvmereg.h> 36 1.1.18.2 jdolecek 37 1.1.18.2 jdolecek #define NVME_PASSTHROUGH_CMD _IOWR('n', 0, struct nvme_pt_command) 38 1.1.18.2 jdolecek 39 1.1.18.2 jdolecek #define nvme_completion_is_error(cpl) \ 40 1.1.18.2 jdolecek ((NVME_CQE_SC((cpl)->flags) != NVME_CQE_SC_SUCCESS) \ 41 1.1.18.2 jdolecek || (NVME_CQE_SCT((cpl)->flags) != NVME_CQE_SCT_GENERIC)) 42 1.1.18.2 jdolecek 43 1.1.18.2 jdolecek struct nvme_pt_command { 44 1.1.18.2 jdolecek 45 1.1.18.2 jdolecek /* 46 1.1.18.2 jdolecek * cmd is used to specify a passthrough command to a controller or 47 1.1.18.2 jdolecek * namespace. 48 1.1.18.2 jdolecek * 49 1.1.18.2 jdolecek * The following fields from cmd may be specified by the caller: 50 1.1.18.2 jdolecek * * opcode 51 1.1.18.2 jdolecek * * nsid (namespace id) - for admin commands only 52 1.1.18.2 jdolecek * * cdw10-cdw15 53 1.1.18.2 jdolecek * 54 1.1.18.2 jdolecek * Remaining fields must be set to 0 by the caller. 55 1.1.18.2 jdolecek */ 56 1.1.18.2 jdolecek struct nvme_sqe cmd; 57 1.1.18.2 jdolecek 58 1.1.18.2 jdolecek /* 59 1.1.18.2 jdolecek * cpl returns completion status for the passthrough command 60 1.1.18.2 jdolecek * specified by cmd. 61 1.1.18.2 jdolecek * 62 1.1.18.2 jdolecek * The following fields will be filled out by the driver, for 63 1.1.18.2 jdolecek * consumption by the caller: 64 1.1.18.2 jdolecek * * cdw0 65 1.1.18.2 jdolecek * * flags (except for phase) 66 1.1.18.2 jdolecek * 67 1.1.18.2 jdolecek * Remaining fields will be set to 0 by the driver. 68 1.1.18.2 jdolecek */ 69 1.1.18.2 jdolecek struct nvme_cqe cpl; 70 1.1.18.2 jdolecek 71 1.1.18.2 jdolecek /* buf is the data buffer associated with this passthrough command. */ 72 1.1.18.2 jdolecek void *buf; 73 1.1.18.2 jdolecek 74 1.1.18.2 jdolecek /* 75 1.1.18.2 jdolecek * len is the length of the data buffer associated with this 76 1.1.18.2 jdolecek * passthrough command. 77 1.1.18.2 jdolecek */ 78 1.1.18.2 jdolecek uint32_t len; 79 1.1.18.2 jdolecek 80 1.1.18.2 jdolecek /* 81 1.1.18.2 jdolecek * is_read = 1 if the passthrough command will read data into the 82 1.1.18.2 jdolecek * supplied buffer from the controller. 83 1.1.18.2 jdolecek * 84 1.1.18.2 jdolecek * is_read = 0 if the passthrough command will write data from the 85 1.1.18.2 jdolecek * supplied buffer to the controller. 86 1.1.18.2 jdolecek */ 87 1.1.18.2 jdolecek uint32_t is_read; 88 1.1.18.2 jdolecek 89 1.1.18.2 jdolecek /* 90 1.1.18.2 jdolecek * timeout (unit: ms) 91 1.1.18.2 jdolecek * 92 1.1.18.2 jdolecek * 0: use default timeout value 93 1.1.18.2 jdolecek */ 94 1.1.18.2 jdolecek uint32_t timeout; 95 1.1.18.2 jdolecek }; 96 1.1.18.2 jdolecek 97 1.1.18.2 jdolecek #endif /* __NVMEIO_H__ */ 98
Indexes created Wed Oct 22 13:09:56 GMT 2025