Merge pull request #264 from igaw/fix-system-uuid

fabrics: Do not swap bytes for system uuid

fabrics: Do not swap bytes for system uuid

The kernel is taking care of swapping the system uuid bytes since
f1d8e614d74b ("drivers/firmware/dmi_scan.c: check dmi version when get
system uuid"). Hence we should not swap them again. Instead just read
/sys/class/dmi/id/product_uuid and store the bytes directly into the
system_uuid buffer.

Signed-off-by: Daniel Wagner <dwagner@suse.de>

Merge pull request #266 from glimchb/actionbranch

CI: rename branch main to master

CI: rename branch main to master

Signed-off-by: Boris Glimcher <Boris.Glimcher@emc.com>

Merge pull request #257 from glimchb/setuptools

 pyproject.toml instead of setup.py for new packaging

Workflow: temporary disable publish to PyPI, starting with TestPyPI

Signed-off-by: Boris Glimcher <Boris.Glimcher@emc.com>

Merge pull request #259 from Arunpandian15/fix_sct

types: status code type value update as per NVMe specification

Merge pull request #262 from Arunpandian15/util_01

util: Add status code values in geneic status to errono conversion

util: Add status code values in generic status to errno conversion

Signed-off-by: Arunpandian J <apj.arun@samsung.com>

Merge pull request #261 from martin-belanger/move-ccan-out-of-public-headers

Move ccan definitions out of public headers.

Move ccan definitions out of public headers.

Signed-off-by: Martin Belanger <martin.belanger@dell.com>

Add workflow to publish to PyPI and TestPyPI

Signed-off-by: Boris Glimcher <Boris.Glimcher@emc.com>

pyproject.toml instead of setup.py for new packaging

This allows to build with meson and package for Pypi

Build like this:
    python -m build

Signed-off-by: Boris Glimcher <Boris.Glimcher@emc.com>

types: status code type value update as per NVMe specification

Signed-off-by: Arunpandian J <apj.arun@samsung.com>

Merge pull request #258 from Arunpandian15/types_doc_28

types: Add missing doc for ZNS, NVMe OF, NVMe command set

types: Add missing doc for ZNS, NVMe OF, NVMe command set

Signed-off-by: Arunpandian J <apj.arun@samsung.com>

Merge pull request #256 from Arunpandian15/doc_types_25

types: Add doc section for enum fields

types: Add doc section for enum fields

Signed-off-by: Arunpandian J <apj.arun@samsung.com>

Merge pull request #255 from Arunpandian15/types_doc_24

types: Add doc field for admin opcodes, FIDs, LIDs, Identify commands

types: Add doc field for admin opcodes, FIDs, LIDs, Identify commands

Signed-off-by: Arunpandian J <apj.arun@samsung.com>

Merge pull request #254 from Arunpandian15/mi_types

types: All MI command related structure doc field update

types: All MI command related structure doc field update

Signed-off-by: Arunpandian J <apj.arun@samsung.com>

build: Use boolean type for docs-build default

muon complains about the type used for the default value. As it a
boolean type use a boolean as value instead of a string value.

Signed-off-by: Daniel Wagner <dwagner@suse.de>

doc: Regenerate all documentation

Prepare for next release candiate.

Signed-off-by: Daniel Wagner <dwagner@suse.de>

doc: Do not precomple HTML doc anymore

The HTML part is not ready yet. Let's remove the precompiled HTML doc.

Signed-off-by: Daniel Wagner <dwagner@suse.de>

Merge pull request #253 from igaw/port-default-port-for-discovery

fabrics: add default port number for NVMe/TCP I/O controllers

fabrics: add default port number for NVMe/TCP I/O controllers

As per section 7.4.9.3 "Transport Service Identifier" of the NVMe over
Fabrics 1.1 specification, the default IANA port number for a NVMe/TCP
discovery controller is 8009. But at the same time, it also clearly
states that NVMe/TCP I/O controllers should not use TCP port number
8009, but may instead use 4420 as the default here.

So make sure to fill these values appropriately, and pass it down.

Signed-off-by: Martin George <marting@netapp.com>
[dwagner: backport from monolithic branch]
Signed-off-by: Daniel Wagner <dwagner@suse.de>

Merge pull request #252 from Arunpandian15/doc_mi

types: doc field update for NVM commands, Feature Identifiers

types: doc field update for NVM commands, Feature Identifiers

Signed-off-by: Arunpandian J <apj.arun@samsung.com>

Merge pull request #248 from igaw/tp8010-support-refactored

TP8010 support refactored

fabrics: Add support to register with a DC

This adds support for the TP8010 by introducing nvmf_registration_ctlr
function which performs the registration task with a Discovery
Controller.

Signed-off-by: Martin Belanger <martin.belanger@dell.com>
[dwagner: refactored, reformated, udpated documentation,
          moved nvme_fetch_cntrltype_dctype_from_id here]
Signed-off-by: Daniel Wagner <dwagner@suse.de>

ioctl: Add nvme_dim_send()

Add nvme_dim_send() to send Discovery Information Managements commands.

Signed-off-by: Martin Belanger <martin.belanger@dell.com>
[dwagner: reorder args arguments, rename function]
Signed-off-by: Daniel Wagner <dwagner@suse.de>

util: Add key-value helpers and OS identification tools

Key value helpers and also the OS identification are used for
implementing TP8010 support.

Signed-off-by: Martin Belanger <martin.belanger@dell.com>
[dwagner: refactoring, reformating]
Signed-off-by: Daniel Wagner <dwagner@suse.de>

types: Add Discovery Information Managment types

Add Discovery Information Management related types for TP8010.

Signed-off-by: Martin Belanger <martin.belanger@dell.com>
[dwagner: renaming, adding documation and reformating]
Signed-off-by: Daniel Wagner <dwagner@suse.de>

tree: Add cntrltype and dctype to the controller object

The Discovery Controller Type (dctype) is a new attribute defined
in TP8010. This new attribute, as well as the existing Controller
Type (cntrltype) attributes will now be exposed through the sysfs
starting with kernel 5.18. For older kernels, the cntrltype and
dctype must be retrieved by performing a Identify command.

Signed-off-by: Martin Belanger <martin.belanger@dell.com>
[dwagner: Removed nvme_fetch_cntrltype_dctype_from_id]
Signed-off-by: Daniel Wagner <dwagner@suse.de>

Merge pull request #250 from Arunpandian15/types_h_doc_21

types.h: doc update for ZNS structures

Merge pull request #246 from igaw/fix-nvme_msg

log: Allow nvme_msg usage with invalid root pointer

log: Allow nvme_msg usage with invalid root pointer

24ac082f481d ("Add 'nvme_root_t' argument to nvme_msg()") and
19b12831a9ec ("Move global logging variables into nvme_root_t") moved
the logging controller knobs into the root object. In case the pointer
is invalid we should not try to use it. Instead just bailing out just
log the line.

Signed-off-by: Daniel Wagner <dwagner@suse.de>

types.h: doc update for ZNS structures

Signed-off-by: Arunpandian J <apj.arun@samsung.com>

Merge pull request #247 from Arunpandian15/types_h_doc_field

types.h: Add missing documentation for all the log pages

Merge pull request #249 from AkhileshRN/telemetry_ctlr

Fix to update size for telemetry log page when telemetry controller initiated data is unavailable.

linux: Update size when telemetry controller initiated data is unavailable

Fix to update size for telemetry log page when telemetry controller
initiated data is unavailable.

types: Add DCTYPE to nvme_id_psd

TP8010 introduced Discovery Controller Type (DCTYPE) to the
Identify Controller data structure. Add the new field.

Signed-off-by: Martin Belanger <martin.belanger@dell.com>
Signed-off-by: Daniel Wagner <dwagner@suse.de>

tree: Add host symbolic name

The host symbolic name was introduced in TP8010. It is used for
explicit registration with discovery controllers using the
discovery information management (DIM) command.x

Signed-off-by: Martin Belanger <martin.belanger@dell.com>

python: Add dump_config

Add support to the Python binding to dump the JSON config by hooking
up nvme_dump_config.

Signed-off-by: Martin Belanger <martin.belanger@dell.com>
Signed-off-by: Daniel Wagner <dwagner@suse.de>

types.h: Add missing documentaion for all the log pages

Signed-off-by: Arunpandian J <apj.arun@samsung.com>

Merge pull request #245 from Arunpandian15/cleanup_17

Cleanup patch for linux.h, log.h, tree.h

tree: Add missing documentation

Add missing documentation to all functions declarations.
While at it also fix whitespace issues and intentions levels

Signed-off-by: Arunpandian J <apj.arun@samsung.com>
[dwagner: added commit messages, extended the docs bits]
Signed-off-by: Daniel Wagner <dwagner@suse.de>

log: Fix whitespacing in documentation

Make the documentation consistent with the other header files.

Signed-off-by: Arunpandian J <apj.arun@samsung.com>
[dwagner: added commit messages]
Signed-off-by: Daniel Wagner <dwagner@suse.de>

linux: Streamline documentation

Make the documetation consistent with the other header files.
While at it also fix whitespace issues and intentions levels

Signed-off-by: Arunpandian J <apj.arun@samsung.com>
[dwagner: added commit messages, extended the docs bits]
Signed-off-by: Daniel Wagner <dwagner@suse.de>

Merge pull request #242 from Arunpandian15/doc_update

ioctl.h: Add description for fields used

ioctl.h: Add description for fields used

Signed-off-by: Arunpandian J <apj.arun@samsung.com>

Merge pull request #234 from jeffreyalien/uuidx-parm

[libnvme] Add uuidx parm to get log page API

linux: Change nvme_get_log_page to use nvme_get_log_args parm

Combined nvme_get_log_page and nvme_get_log_page_padded into
one function

Signed-off-by: Jeff Lien <jeff.lien@wdc.com>

Merge pull request #237 from Arunpandian15/cleanup_Description

types: Add doc description for fields used

Merge pull request #239 from hanumanthuh/master

add cdw13 for set_feature_args structure

Merge pull request #238 from samiWaheed/master

Corrected FW log page used  in nvme_get_log_fw_slot

add cdw13 for set_feature_args structure

Update ioctl.h

types: Added doc description for fields used

Signed-off-by: Arunpandian J <apj.arun@samsung.com>

Merge pull request #233 from igaw/fix-mem-leak

tree: Fix memleaks in __nvme_free_ns() and nvme_scan_subsystem()

build: make Python memory allocations valgrind friendly

When testing with

  meson test -C .build --wrap='valgrind --leak-check=full'

the Python binding will trigger 'Invalid read of size 4' warnings.
Tell Python to use malloc directly for all memory allocation which can
be properly traced by valgrind.

Signed-off-by: Daniel Wagner <dwagner@suse.de>

tree: Fix memleaks in __nvme_free_ns() and nvme_scan_subsystem()

valgrind reports that we are leaking memory in __nvme_free_ns() and
nvme_scan_subsystem(). Free ns->generic_name and path which makes
valgrind also happy.

Signed-off-by: Daniel Wagner <dwagner@suse.de>

Merge pull request #230 from sc108-lee/fix/io_cmd

ioctl: nvme_io_args.dspec(Directive Specific) value is 16 bits

ioctl: nvme_io_args.dspec(Directive Specific) value is 16 bits

Command Dword 13 [31:16]

Signed-off-by: Steven Seungcheol Lee <sc108.lee@samsung.com>

Merge pull request #229 from igaw/remove-jsonc-ifdefs

tree: Remove CONFIG_JSONC ifdefs

tree: Remove CONFIG_JSONC ifdefs

We have an hard dependency on json-c, so we can rely it's always
available. Remove old ifdefs for json-c.

Signed-off-by: Daniel Wagner <dwagner@suse.de>

Merge pull request #221 from hreinecke/dump-tree

tree: add nvme_dump_tree()

tree: add nvme_dump_tree()

Dump the internal tree in JSON format to stdout for debugging.

Signed-off-by: Hannes Reinecke <hare@suse.de>
[dwagner: dropped json wrapper definition usage]
Signed-off-by: Daniel Wagner <dwagner@suse.de>

Merge pull request #227 from igaw/cleanup-libuuid-dep

tree: Remove dead !LIBUUID code

tree: Remove dead !LIBUUID code

We have added a hard dependency to libuuid. Remove the ifdefs and the
dead code.

Signed-off-by: Daniel Wagner <dwagner@suse.de>

Merge pull request #226 from linux-nvme/kernel-doc-ci

build: Add kernel-doc CI build

build: Add kernel-doc CI build

We want to catching documentation failures early. Let's add a
dedicated documentation CI build. To keep build times low just
shortcut here and do not call meson to build the complete
documentation.

Signed-off-by: Daniel Wagner <dwagner@suse.de>

Merge pull request #213 from jeffreyalien/telemetry-da4-2

[libnvme] Add Support for Telemetry Log Page Data Area 4

linux: Add size and data area parm to nvme_get_telemetry_log

This is necessary to support the retrieval of data area 4.

Signed-off-by: Jeff Lien <jeff.lien@wdc.com>

Merge pull request #223 from hreinecke/json-mandatory

Make JSON-C mandatory

Merge pull request #225 from igaw/fail-on-warnings

build: Make CI build fail on warnings

build: Make CI build fail on warnings

Currently, warnings are hidden in the logs and the build is marked as
succeeded. Mark all warnings as error so that we see them show up in
the review process.

Signed-off-by: Daniel Wagner <dwagner@suse.de>

Merge pull request #222 from igaw/mesonize-doc

doc: Mesonize documentation generation

doc: Regenerate all documentation

Signed-off-by: Daniel Wagner <dwagner@suse.de>

doc: Fix sphinx setup

sphinx warns about cyclic refernce. Do not include the index into the
index file.

Also add the build dir and index.rst to the ignore list. This avoids
another type of warnings.

Signed-off-by: Daniel Wagner <dwagner@suse.de>

doc: Mesonize documentation generation

Introduce a new config flag -Ddocs-build=true which controls if the
build system should generate documentation or not. If disabled but
-Ddocs=man is used then the pre compiled documentation will be
installed.

Furthmore, we are hooking up the sphinx tooling so that we generate
the HTML documentation ouf of the rst files.

Signed-off-by: Daniel Wagner <dwagner@suse.de>

types: Fix doc description

Signed-off-by: Daniel Wagner <dwagner@suse.de>

tree: Remove doublicated declaration

nvme_host_get_hostnqn() and nvme_host_get_hostid() are declared
twice. Remove one.

Signed-off-by: Daniel Wagner <dwagner@suse.de>

doc: Remove unused make.bat file

The file was added by the initial doc experiment commit. It's not
used. Remove it.

Signed-off-by: Daniel Wagner <dwagner@suse.de>

Merge pull request #166 from sc108-lee/for-upstream/tp4095

For upstream/tp4095

nvme: get log domain id included in Log Specific Identifier

domid was not used in nvme_get_log as well

Signed-off-by: Steven Seungcheol Lee <sc108.lee@samsung.com>

nvme: Add nulbaf(Number of Unique Capability LBA Formats) field on nvmd_id_ns

Add explaination for mssrl, mcl, src
Based on spec NVMe - TP 4095 Namespace Capability Reporting 2021.06.28 - Ratified

ioctl: Add identify ioctl for CNS 09h, 0Ah

09h - Identify Namespace data structure for the specified
      User Data Format index containing the namespace capabilities
      for the NVM Command Set.
0Ah - I/O Command Set specific Identify Namespace data structure
      for the specified User Data Format index containing
      the namespace capabilities for the I/O Command Set
      specified in the CSI field.

Signed-off-by: Steven Seungcheol Lee <sc108.lee@samsung.com>

types: Add NVM Command Set id-ns structure

Add uuid index argument on nvme_identify_ns_csi

Signed-off-by: Steven Seungcheol Lee <sc108.lee@samsung.com>

ioctl: Modify identify command argument based on spec

CNS Specific identifier presents all names below for DWORD11 bits [15:00]
    NVM Set Identifier(NVM Set List (04h))
    Domain Identifier(Domain List (18h))
    Endurance Group Identifier(Endurance Group List (19h))

Signed-off-by: Steven Seungcheol Lee <sc108.lee@samsung.com>

Merge pull request #224 from Arunpandian15/Enhanced_ctrl_MD

nvme: Add Enhanced Controller Meta Data(FID: 0x7D)

nvme: Add Enhanced Controller Meta Data(FID: 0x7D)

Reviewed-by: Steven Seungcheol Lee <sc108.lee@samsung.com>
Signed-off-by: Arunpandian J <apj.arun@samsung.com>

Make JSON-C mandatory during built

We already have a JSON-C subproject, so we can make it mandatory
during build anyway.

Signed-off-by: Hannes Reinecke <hare@suse.de>

json: remove wrapper definitions

Switch to JSON-C API.

Signed-off-by: Hannes Reinecke <hare@suse.de>

tree: do not print function twice

nvme_msg() already prints out the function name, no need to specify
it in the message itself.

Signed-off-by: Hannes Reinecke <hare@suse.de>

Merge pull request #199 from Arunpandian15/Supported_Cap_Config_List_Log_Page

nvme: Add Supported Capacity Configuration List log page(LID: 0x11)

nvme: Add Supported Capacity Configuration List log page(LID: 0x11)

Reviewed-by: Steven Seungcheol Lee <sc108.lee@samsung.com>
Signed-off-by: Arunpandian J <apj.arun@samsung.com>

Merge pull request #220 from hreinecke/dhchap-fix

tree: do not set dhchap_key to 'none'

tree: do not set dhchap_key to 'none'

When no dhchap key is set the kernel will set the sysfs attribute
to 'none'. And we shouldn't display this value in our internal tree
as it really means 'not set'.

Signed-off-by: Hannes Reinecke <hare@suse.de>