xref: /freebsd/sys/cam/nvme/nvme_all.h (revision 5ca8e32633c4ffbbcd6762e5888b6a4ba0708c6c)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2015 Netflix, Inc.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  */
27 
28 #ifndef CAM_NVME_NVME_ALL_H
29 #define CAM_NVME_NVME_ALL_H 1
30 
31 #include <dev/nvme/nvme.h>
32 
33 struct ccb_nvmeio;
34 
35 void	nvme_ns_cmd(struct ccb_nvmeio *nvmeio, uint8_t cmd, uint32_t nsid,
36     uint32_t cdw10, uint32_t cdw11, uint32_t cdw12, uint32_t cdw13,
37     uint32_t cdw14, uint32_t cdw15);
38 
39 int	nvme_identify_match(caddr_t identbuffer, caddr_t table_entry);
40 
41 struct sbuf;
42 void	nvme_print_ident(const struct nvme_controller_data *, const struct nvme_namespace_data *, struct sbuf *);
43 void	nvme_print_ident_short(const struct nvme_controller_data *,
44     const struct nvme_namespace_data *, struct sbuf *);
45 const char *nvme_op_string(const struct nvme_command *, int admin);
46 const char *nvme_cmd_string(const struct nvme_command *, char *, size_t);
47 void nvme_cmd_sbuf(const struct nvme_command *, struct sbuf *sb);
48 int nvme_command_sbuf(struct ccb_nvmeio *nvmeio, struct sbuf *sb);
49 const void *nvme_get_identify_cntrl(struct cam_periph *);
50 const void *nvme_get_identify_ns(struct cam_periph *);
51 
52 #endif /* CAM_NVME_NVME_ALL_H */
53