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.
