NVME-OCP-HARDWARE()                                        NVME-OCP-HARDWARE()

NAME
       nvme-ocp-hardware-component-log - retrieve hardware component log

SYNOPSIS
       nvme [<global-options>] ocp hardware-component-log <device>
                               [--comp-id=<num> | -i <num>]
                               [--list | -l]

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

GLOBAL OPTIONS
       The following options are defined at the top-level nvme command and are
       available to this subcommand:

       --dry-run
           Print the command that would be executed, but do not actually
           execute it.

       --no-ioctl-probing
           Disable probing for 64-bit IOCTL support.

       --no-retries
           Disable retry logic on transient errors.

       -o <fmt>, --output-format=<fmt>
           Set the reporting format to normal, tabular, 'json, or binary. Only
           one output format may be used at a time.

       --output-format-version=<version>
           Select the output format version. Version 1 uses the original field
           naming, while version 2 (default) provides more consistent and
           script-friendly field names.

       --timeout=<ms>
           Set the timeout for the command in milliseconds.

       -v, --verbose
           Increase the level of detail in the output. May be specified
           multiple times to further increase verbosity.

       These options can also be set as machine-wide defaults in
       nvme-cli.conf(5). A command-line flag always overrides the file.

EXAMPLES
       o   Has the program issue a ocp hardware-component-log

               # nvme ocp hardware-component-log /dev/nvme0

       o   Has the program issue a ocp hardware-component-log with asic
           component list

               # nvme ocp hardware-component-log /dev/nvme0 -i asic -l

NVME
       Part of the nvme-user suite.

                                                           NVME-OCP-HARDWARE()