3fb740c323417e3c1bca3f8aa6e0349f76ba0585
[multipath-tools/.git] / libmultipath / nvme / nvme-ioctl.h
1 #ifndef _NVME_LIB_H
2 #define _NVME_LIB_H
3
4 #include <linux/types.h>
5 #include <stdbool.h>
6 #include "linux/nvme_ioctl.h"
7 #include "nvme.h"
8
9 int nvme_get_nsid(int fd);
10
11 /* Generic passthrough */
12 int nvme_submit_passthru(int fd, unsigned long ioctl_cmd,
13                          struct nvme_passthru_cmd *cmd);
14
15 int nvme_passthru(int fd, unsigned long ioctl_cmd, __u8 opcode, __u8 flags,
16                   __u16 rsvd, __u32 nsid, __u32 cdw2, __u32 cdw3,
17                   __u32 cdw10, __u32 cdw11, __u32 cdw12,
18                   __u32 cdw13, __u32 cdw14, __u32 cdw15,
19                   __u32 data_len, void *data, __u32 metadata_len,
20                   void *metadata, __u32 timeout_ms, __u32 *result);
21
22 /* NVME_SUBMIT_IO */
23 int nvme_io(int fd, __u8 opcode, __u64 slba, __u16 nblocks, __u16 control,
24               __u32 dsmgmt, __u32 reftag, __u16 apptag,
25               __u16 appmask, void *data, void *metadata);
26
27 int nvme_read(int fd, __u64 slba, __u16 nblocks, __u16 control,
28               __u32 dsmgmt, __u32 reftag, __u16 apptag,
29               __u16 appmask, void *data, void *metadata);
30
31 int nvme_write(int fd, __u64 slba, __u16 nblocks, __u16 control,
32                __u32 dsmgmt, __u32 reftag, __u16 apptag,
33                __u16 appmask, void *data, void *metadata);
34
35 int nvme_compare(int fd, __u64 slba, __u16 nblocks, __u16 control,
36                  __u32 dsmgmt, __u32 reftag, __u16 apptag,
37                  __u16 appmask, void *data, void *metadata);
38
39 /* NVME_IO_CMD */
40 int nvme_passthru_io(int fd, __u8 opcode, __u8 flags, __u16 rsvd,
41                      __u32 nsid, __u32 cdw2, __u32 cdw3,
42                      __u32 cdw10, __u32 cdw11, __u32 cdw12,
43                      __u32 cdw13, __u32 cdw14, __u32 cdw15,
44                      __u32 data_len, void *data, __u32 metadata_len,
45                      void *metadata, __u32 timeout);
46
47 int nvme_write_zeros(int fd, __u32 nsid, __u64 slba, __u16 nlb,
48                      __u16 control, __u32 reftag, __u16 apptag, __u16 appmask);
49
50 int nvme_write_uncorrectable(int fd, __u32 nsid, __u64 slba, __u16 nlb);
51
52 int nvme_flush(int fd, __u32 nsid);
53
54 int nvme_dsm(int fd, __u32 nsid, __u32 cdw11, struct nvme_dsm_range *dsm,
55              __u16 nr_ranges);
56 struct nvme_dsm_range *nvme_setup_dsm_range(__u32 *ctx_attrs,
57                                             __u32 *llbas, __u64 *slbas,
58                                             __u16 nr_ranges);
59
60 int nvme_resv_acquire(int fd, __u32 nsid, __u8 rtype, __u8 racqa,
61                       bool iekey, __u64 crkey, __u64 nrkey);
62 int nvme_resv_register(int fd, __u32 nsid, __u8 rrega, __u8 cptpl,
63                        bool iekey, __u64 crkey, __u64 nrkey);
64 int nvme_resv_release(int fd, __u32 nsid, __u8 rtype, __u8 rrela,
65                       bool iekey, __u64 crkey);
66 int nvme_resv_report(int fd, __u32 nsid, __u32 numd, __u32 cdw11, void *data);
67
68 int nvme_identify13(int fd, __u32 nsid, __u32 cdw10, __u32 cdw11, void *data);
69 int nvme_identify(int fd, __u32 nsid, __u32 cdw10, void *data);
70 int nvme_identify_ctrl(int fd, void *data);
71 int nvme_identify_ns(int fd, __u32 nsid, bool present, void *data);
72 int nvme_identify_ns_list(int fd, __u32 nsid, bool all, void *data);
73 int nvme_identify_ctrl_list(int fd, __u32 nsid, __u16 cntid, void *data);
74 int nvme_identify_ns_descs(int fd, __u32 nsid, void *data);
75 int nvme_identify_nvmset(int fd, __u16 nvmset_id, void *data);
76 int nvme_get_log13(int fd, __u32 nsid, __u8 log_id, __u8 lsp, __u64 lpo,
77                    __u16 group_id, bool rae, __u32 data_len, void *data);
78 int nvme_get_log(int fd, __u32 nsid, __u8 log_id, bool rae,
79                  __u32 data_len, void *data);
80
81
82 int nvme_get_telemetry_log(int fd, void *lp, int generate_report,
83                            int ctrl_gen, size_t log_page_size, __u64 offset);
84 int nvme_fw_log(int fd, struct nvme_firmware_log_page *fw_log);
85 int nvme_changed_ns_list_log(int fd,
86                 struct nvme_changed_ns_list_log *changed_ns_list_log);
87 int nvme_error_log(int fd, int entries, struct nvme_error_log_page *err_log);
88 int nvme_smart_log(int fd, __u32 nsid, struct nvme_smart_log *smart_log);
89 int nvme_ana_log(int fd, void *ana_log, size_t ana_log_len, int rgo);
90 int nvme_effects_log(int fd, struct nvme_effects_log_page *effects_log);
91 int nvme_discovery_log(int fd, struct nvmf_disc_rsp_page_hdr *log, __u32 size);
92 int nvme_sanitize_log(int fd, struct nvme_sanitize_log_page *sanitize_log);
93 int nvme_endurance_log(int fd, __u16 group_id,
94                        struct nvme_endurance_group_log *endurance_log);
95
96 int nvme_feature(int fd, __u8 opcode, __u32 nsid, __u32 cdw10,
97                  __u32 cdw11, __u32 cdw12, __u32 data_len, void *data,
98                  __u32 *result);
99 int nvme_set_feature(int fd, __u32 nsid, __u8 fid, __u32 value, __u32 cdw12,
100                      bool save, __u32 data_len, void *data, __u32 *result);
101 int nvme_get_feature(int fd, __u32 nsid, __u8 fid, __u8 sel,
102                      __u32 cdw11, __u32 data_len, void *data, __u32 *result);
103
104 int nvme_format(int fd, __u32 nsid, __u8 lbaf, __u8 ses, __u8 pi,
105                 __u8 pil, __u8 ms, __u32 timeout);
106
107 int nvme_ns_create(int fd, __u64 nsze, __u64 ncap, __u8 flbas,
108                    __u8 dps, __u8 nmic, __u32 *result);
109 int nvme_ns_delete(int fd, __u32 nsid);
110
111 int nvme_ns_attachment(int fd, __u32 nsid, __u16 num_ctrls,
112                        __u16 *ctrlist, bool attach);
113 int nvme_ns_attach_ctrls(int fd, __u32 nsid, __u16 num_ctrls, __u16 *ctrlist);
114 int nvme_ns_detach_ctrls(int fd, __u32 nsid, __u16 num_ctrls, __u16 *ctrlist);
115
116 int nvme_fw_download(int fd, __u32 offset, __u32 data_len, void *data);
117 int nvme_fw_commit(int fd, __u8 slot, __u8 action, __u8 bpid);
118
119 int nvme_sec_send(int fd, __u32 nsid, __u8 nssf, __u16 spsp,
120                   __u8 secp, __u32 tl, __u32 data_len, void *data, __u32 *result);
121 int nvme_sec_recv(int fd, __u32 nsid, __u8 nssf, __u16 spsp,
122                   __u8 secp, __u32 al, __u32 data_len, void *data, __u32 *result);
123
124 int nvme_subsystem_reset(int fd);
125 int nvme_reset_controller(int fd);
126 int nvme_ns_rescan(int fd);
127
128 int nvme_dir_send(int fd, __u32 nsid, __u16 dspec, __u8 dtype, __u8 doper,
129                   __u32 data_len, __u32 dw12, void *data, __u32 *result);
130 int nvme_dir_recv(int fd, __u32 nsid, __u16 dspec, __u8 dtype, __u8 doper,
131                   __u32 data_len, __u32 dw12, void *data, __u32 *result);
132 int nvme_get_properties(int fd, void **pbar);
133 int nvme_set_property(int fd, int offset, int value);
134 int nvme_get_property(int fd, int offset, uint64_t *value);
135 int nvme_sanitize(int fd, __u8 sanact, __u8 ause, __u8 owpass, __u8 oipbp,
136                   __u8 no_dealloc, __u32 ovrpat);
137 int nvme_self_test_start(int fd, __u32 nsid, __u32 cdw10);
138 int nvme_self_test_log(int fd, struct nvme_self_test_log *self_test_log);
139 #endif                          /* _NVME_LIB_H */