blob: 6700e7679468f54951f67e846b7635527171f701 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
|
nvme-ocp-hardware-component-log(1)
==================================
NAME
----
nvme-ocp-hardware-component-log - retrieve hardware component log
SYNOPSIS
--------
[verse]
'nvme ocp hardware-component-log' <device> [--comp-id=<num> | -i <num>]
[--list | -l] [--verbose | -v]
[--output-format=<fmt> | -o <fmt>] [--timeout=<timeout>]
DESCRIPTION
-----------
Retrieve hardware component log.
The <device> parameter is mandatory NVMe character device (ex: /dev/nvme0).
This will only work on OCP compliant devices supporting this feature.
Results for any other device are undefined.
On success it returns 0, error code otherwise.
OPTIONS
-------
-i <num>::
--comp-id=<num>::
component identifier
+
[]
|=================
|Value|Definition
|0x0000| Reserved
|0x0001 \| 'asic'| Controller ASIC component
|0x0002 \| 'nand'| NAND Component
|0x0003 \| 'dram'| DRAM Component
|0x0004 \| 'pmic'| PMIC Component
|0x0005 \| 'pcb'| PCB Component
|0x0006 \| 'cap'| capacitor component
|0x0007 \| 'reg'| registor component
|0x0008 \| 'case'| case component
|0x0009 \| 'sn'| Device Serial Number
|0x000A \| 'country'| Country of Origin
|0x000B \| 'hw-rev'| Global Device Hardware Revision
|0x000C-0x7FFF| Reserved
|0x8000 \| 'vendor'| Vendor Unique Component
|0x8001-0xFFFF| Vendor Unique Component
|=================
-l::
--list::
list component descriptions
-v::
--verbose::
Increase the information detail in the output.
-o <fmt>::
--output-format=<fmt>::
Set the reporting format to 'normal', 'json' or 'binary'. Only one
output format can be used at a time.
-t <timeout>::
--timeout=<timeout>::
Override default timeout value. In milliseconds.
EXAMPLES
--------
* Has the program issue a set-error-injection
+
------------
# nvme ocp hardware-component-log /dev/nvme0
------------
* Has the program issue a set-error-injection with the asic component list.
+
------------
# nvme ocp hardware-component-log /dev/nvme0 -i asic -l
------------
NVME
----
Part of the nvme-user suite.
|
