summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-lnvm-diag-set-bbtbl.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/nvme-lnvm-diag-set-bbtbl.txt')
-rw-r--r--Documentation/nvme-lnvm-diag-set-bbtbl.txt63
1 files changed, 63 insertions, 0 deletions
diff --git a/Documentation/nvme-lnvm-diag-set-bbtbl.txt b/Documentation/nvme-lnvm-diag-set-bbtbl.txt
new file mode 100644
index 0000000..f5dd004
--- /dev/null
+++ b/Documentation/nvme-lnvm-diag-set-bbtbl.txt
@@ -0,0 +1,63 @@
+nvme-lnvm-diag-set-bbtbl(1)
+===========================
+
+NAME
+----
+nvme-lnvm-diag-set-bbtbl - Set a block state in the bad block table
+
+SYNOPSIS
+--------
+[verse]
+'nvme lnvm-diag-set-bbtbl' [--namespace-id=<NUM> | -n <NUM>]
+ [--channel-id=<CHID> | -c <CHID>]
+ [--lun-id=<LUNID> | -l <LUNID>]
+ [--plane-id=<PLANEID> | -p <PLANEID>]
+ [--block-id=<BLKID> | -b <BLKID>]
+ [--value=<NUM> | -v <NUM>]
+
+DESCRIPTION
+-----------
+Set the bad block table for a given channel, lun, plane and block with value v.
+
+For each block available, the status byte is read as follows:
+
+0: Good block
+1: Bad block
+2: Grown bad block
+4: Device reserved block
+8: Host-side reserved block
+16: Media managed reserved block
+
+OPTIONS
+-------
+--namespace-id=<NUM>::
+-n <NUM>::
+ Namespace id to use
+
+--channel-id::
+-c::
+ Channel id
+
+--lun-id::
+-l::
+ LUN id
+
+--plane-id::
+-p::
+ Plane id
+
+--block-id::
+-b::
+ Block id
+
+EXAMPLES
+--------
+* Set channel 0, lun 0, plane 0, block 10 to bad block value 2 (grown bad)
+ on physical device /dev/nvme0
+------------
+# nvme lnvm-diag-set-bbtbl /dev/nvme0 -c 0 -l 0 -p 0 -b 10 -v 2
+------------
+
+NVME
+----
+Part of the nvme-user suite