summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_is_64bit_reg.2
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2022-11-05 18:17:21 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2022-11-05 18:17:32 +0000
commitb0dc2feab3271dbcb42df6e6d8a37138a90c44a1 (patch)
treeae02f159c125f183b2adae47fdf0e64357bf76a8 /doc/man/nvme_is_64bit_reg.2
parentReleasing debian version 1.1-2. (diff)
downloadlibnvme-b0dc2feab3271dbcb42df6e6d8a37138a90c44a1.tar.xz
libnvme-b0dc2feab3271dbcb42df6e6d8a37138a90c44a1.zip
Merging upstream version 1.2.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/man/nvme_is_64bit_reg.2')
-rw-r--r--doc/man/nvme_is_64bit_reg.216
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/man/nvme_is_64bit_reg.2 b/doc/man/nvme_is_64bit_reg.2
new file mode 100644
index 0000000..e23f562
--- /dev/null
+++ b/doc/man/nvme_is_64bit_reg.2
@@ -0,0 +1,16 @@
+.TH "nvme_is_64bit_reg" 9 "nvme_is_64bit_reg" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_is_64bit_reg \- Checks if offset of the controller register is a know 64bit value.
+.SH SYNOPSIS
+.B "bool" nvme_is_64bit_reg
+.BI "(__u32 offset " ");"
+.SH ARGUMENTS
+.IP "offset" 12
+Offset of controller register field in bytes
+.SH "DESCRIPTION"
+This function does not care about transport so that the offset is not going
+to be checked inside of this function for the unsupported fields in a
+specific transport. For example, BPMBL(Boot Partition Memory Buffer
+Location) register is not supported by fabrics, but it can be checked here.
+.SH "RETURN"
+true if given offset is 64bit register, otherwise it returns false.