util: introduce int56_to_long() type conversion helper

This is to remove unnecessary mask with 0x00FFFFFFFFFFFFFF.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

ocp-print: use int48_to_long() to print 48 bits values

This is to reduce unnecessary mask with 0x0000FFFFFFFFFFFF.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

ocp: remove unnecessary 64 bits mask

Since the 64 bits variables not necessary to mask by 64 bits.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

ocp: use struct nvme_timestamp type for FAHE-5 timestamp field

Since the field defined by the NVMe timestamp feature.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

nvme-print: move obj_add_* definitions into util/json.h

Also use the same prefix json_object_add_*.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

nvme: fix to use NVME_VAL() for CQ entry status field filter

Previously used incorrectly NVME_GET() but not shifted the masked values.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

nvme-print-json: update id-ctrl print code to use libnvme definition

Use libnvme register definitions instead of the shift operator.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

nvme-print-json: update register print code to use libnvme definition

Use libnvme register definitions instead of the shift operator.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

util: clean up json.h file

Since some json macros can be used without json as common.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

dapustor: avoid sprinkling ifdefs

Use empty json functions instead without json.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

netapp: avoid sprinkling ifdefs

Use empty json functions instead without json.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

intel: avoid sprinkling ifdefs

Use empty json functions instead without json.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

micron: avoid sprinkling ifdefs

Use empty json functions instead without json.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

util: cast to use empty function json_object_array_add parameter k

This is to prevent the build warning without json.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

wdc: enable wdc-nvme.c build without json-c dependencies checking

Only build json print codes with CONFIG_JSONC build option instead.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

ssstc: build plugin not depended on json without json

ssstc plugin does not use json so no need to check the build dependency.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

seagate: enable seagate-nvme.c build without json-c dependencies checking

Only build json print codes with CONFIG_JSONC build option instead.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

scaleflux: enable sfx-nvme.c build without json-c dependencies checking

Only build json print codes with CONFIG_JSONC build option instead.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

scaleflux: use PRIu64 printf format string instead of llu

To fix the cross compiler build fails and some indentation errors also.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

nvidia: build plugin not depended on json without json

nvidia plugin does not use json so no need to check the build dependency.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

netapp: enable netapp-nvme.c build without json-c dependencies checking

Only build json print codes with CONFIG_JSONC build option instead.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

nbft: enable nbft-plugin.c build without json-c dependencies checking

Only build json print codes with CONFIG_JSONC build option instead.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

plugins: introduce OPT_FLAG_JSON for command option json

This is to not need ugly ifdefs everywhere.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

amzn: avoid sprinkling ifdefs and use flags

Use flags instead of cfg.output_format.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

Fixed latency_monitor_feature_enable to be 01h as per OCP spec v2.0

ocp: add ocp_get_log_simple() to set UUID index

The index is required by the OCP specification.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

build: bump wrap

Update build dependencies.

Signed-off-by: Daniel Wagner <wagi@kernel.org>

plugin/lm: Introduce Live Migration plugin

Implementation of TP 4159 PCIe Infrastructure for Live Migration plugin.
Includes command support for Track Send, Migration Receive, Migration
Send, and Controller Data Queue; Identify Controller LM related fields;
Bash and ZSH completions.

Changes are isolated to the User Data Migration subset, with Track
Memory functionality deferred to a future commit.

Signed-off-by: Nate Thornton <n.thornton@samsung.com>

ocp-nvme: Add a different formatting for JSON output

The current OCP JSON format for the SMART extended log page is not
condusive to metric collection via tools like Prometheus. So we add a
new output mode that uses all lower case and underscores (instead of
spaces). This should help with metric collection. At the same time we
clean up some of the field names. We add a new argument
(--output-format-version) to allow us to select which output version
we want. Documentation updated to reflect this change and mark this as
experimental.

Fixes #2577.

Signed-off-by: Stephen Bates <sbates@raithlin.com>

Plugin: ScaleFlux Adding Status Command

Adding ScaleFlux status command, equivalent to vendor unique utility.

Signed-off-by: Ben Reese <5884008+benreese0@users.noreply.github.com>

Plugin: ScaleFlux Use NVME_NSID_ALL

Using NVME_NSID_ALL macro instead of 0xffffffff magic number

Signed-off-by: Jayden Stenfort <127808534+A-Fellow-Comrade@users.noreply.github.com>

Plugin: ScaleFlux Spelling&Typo Fixes

Fixing spelling and typos

Signed-off-by: Jayden Stenfort <127808534+A-Fellow-Comrade@users.noreply.github.com>

Plugin: ScaleFlux Seperating Types

Moving types associated with ScaleFlux into new file sfx-types.h

Signed-off-by: Jayden Stenfort <127808534+A-Fellow-Comrade@users.noreply.github.com>

micron: enable micron-nvme.c build without json-c dependencies checking

Only build json print codes with CONFIG_JSONC build option instead.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

intel: enable intel-nvme.c build without json-c dependencies checking

Only build json print codes with CONFIG_JSONC build option instead.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

huawei: enable huawei-nvme.c build without json-c dependencies checking

Only build json print codes with CONFIG_JSONC build option instead.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

fdp: build plugin not depended on json without json

fdp plugin does not use json so no need to check the build dependency.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

dell: build plugin not depended on json without json

dell plugin does not use json so no need to check the build dependency.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

dapustor: enable dapustor-nvme.c build without json-c dependencies checkin

Only build json print codes with CONFIG_JSONC build option instead.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

amzn: use PRIu64 printf format string instead of llu

To fix the cross compiler build fails.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

amzn: enable amzn-nvme.c build without json-c dependencies checking

Only build json print codes with CONFIG_JSONC build option instead.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

nvme: disable output-format option json value without json-c

Since only json print codes work with the json-c library.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

doc: Add write zeroes command namespace-zeroes option

Add Namespace Zeroes (NSZ) option of Write Zeroes command.

Signed-off-by: Francis Pravin <francis.p@samsung.com>

ocp: add set-enable-ieee1667-silo command

The command sets enable IEEE1667 silo.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

ocp: add ocp-types.h file for OCP requirements definitions

This is for the OCP requirement fields and bits definitions.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

nvme-wrap: add nvme_cli_set_features() API function

The wrap API supported for MI interface.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

doc: remove TLS documentation

We started to collect these types of documetation in the associated
nvme-cli wiki. Thus remove this file.

Signed-off-by: Daniel Wagner <wagi@kernel.org>

sed: add '--read-only' to 'sed initialize'

By default 'sed initialize' will set the entire disk to read/write
locked, ie no access is possible. That is all fine if the BIOS supports
TCG Opal, as then the BIOS can unlock the drive before access.
But for BIOS _not_ supporting TCG Opal this results in an inaccessible
drive, and requires the user to use a different drive to boot and
unlock the SED device.
This patch adds a flag '--read-only' to 'nvme sed initlialize' such
that the 'read-lock enable' flag is not set for the locking range,
and the device continues to be readable by the BIOS for booting.

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

plugins: build plugins not depended on json without json

Some plugins do not use json so no need to check the build dependency.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

ocp: update internal-log command telemetry type description

Add host0 and host1 help documentation description.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

ocp: delete internal-log command telemetry type none value definition

Since the type none value never set by the command handling.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

nvme: plugins/fdp, check endurance group identifier

For FDP options such as stats and events, default endurance identifier 0
is used which results in error.
This patch returns error for missing endurance group identifier from
user.

Signed-off-by: Nitesh Shetty <nj.shetty@samsung.com>

print: OACS Host Managed Live Migration Support (HMLMS)

Additional HMLMS bit in OACS field (stdout)

Signed-off-by: Nate Thornton <n.thornton@samsung.com>

build: bump libnvme wrap

Update libnvme wrap to latest to pick up Live Migration types & ioctls

Signed-off-by: Nate Thornton <n.thornton@samsung.com>

nbft: Report proper error codes from discover_from_nbft()

In case of a connection failure of any SSNS records that are not
marked as 'unavailable', report proper error code so that nvme-cli
callers may retry the operation.

The semantics of most functions is to return 0 zero for success
and negative errno numbers in case of an error.

Signed-off-by: Tomas Bzatek <tbzatek@redhat.com>

tests: Use container image to run nightly tests

Using the pre-build linux-nvme/debian.python container to avoid
installing dependencies every time which fails occasionally.

Also drop clean up steps as this is part of the self-hosted runner
now.

Signed-off-by: Dennis Maisenbacher <dennis.maisenbacher@wdc.com>

tests: Fix `subprosess.call` calls

Don't use stdout=PIPE with subprocess.call as noted in the documentation:
https://docs.python.org/3/library/subprocess.html#subprocess.call

Signed-off-by: Dennis Maisenbacher <dennis.maisenbacher@wdc.com>

tests: Refactor prints

Remove unused prints and add some informative prints.

Signed-off-by: Dennis Maisenbacher <dennis.maisenbacher@wdc.com>

tests: Remove unneeded sleep statements

Removing sleep statements, which improves the test cases runtime.

Signed-off-by: Dennis Maisenbacher <dennis.maisenbacher@wdc.com>

tests: use current LBA format as I/O block size

When running I/O use the current LBA format as default block size.

Signed-off-by: Dennis Maisenbacher <dennis.maisenbacher@wdc.com>

tests: Use json output for parsing

To make the parsing of nvme cmd output easier use the json output when
possible.

Refactoring code snippets that needed to be touched when adjusing for
json output.

Signed-off-by: Dennis Maisenbacher <dennis.maisenbacher@wdc.com>

tests: Introduce configurable nvme binary path

Introducing the `nvme_bin` config to point to a different nvme-cli
binary.

With this change all nvme cmd strings are reworked for uniformity.
This includes using f-strings and expanding short options into long
options.

Signed-off-by: Dennis Maisenbacher <dennis.maisenbacher@wdc.com>

nvme: add Namespace Zeroes support to Write Zeroes command

Added the Namespace Zeroes (NSZ) support to Write Zeroes command.
Also, fixed the dtype limitation (bit 22:20).
TP4160 - WZSL Limit Modification

Signed-off-by: Francis Pravin <francis.p@samsung.com>
Reviewed-by: Steven Seungcheol Lee <sc108.lee@samsung.com>

print: id-ctrl print updated based on NVMe v2.1

new fields, missing fields print added

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

print: Add missing fid to string

NVME_FEAT_FID_CTRL_DATA_QUEUE : Controller Data Queue

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

build: bump libnvme wrap

types: Update id-ctrl field based on NVMe 2.1 spec
new fields are added on id-ctrl structure

Boot Partition Capabilities (BPCAP)
NVM Subsystem Shutdown Latency (NSSL)
Power Loss Signaling Information (PLSI)
Controller Reachability Capabilities (CRCAP)
Key Per I/O Capabilities (KPIOC)
Maximum Processing Time for Firmware Activation Without Reset (MPTFAWR)
Command Quiesce Time (CQT)
Recommended Host-Initiated Refresh Interval (RHIRI)
Host-Initiated Refresh Time (HIRT)

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

ocp: TCG Configuration Log field added ocp v2.6

Add Number of Namespace Provisioned Locking Objects Extended(TCGL-23)
remove reserved area prints (Shall be cleared to zero)
reserved area field name modified by byte address

remove 0x from rsvd area stdout print (aligned with json)
0x%d prints wrong way to print, so follow json print logic

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

ns_descs: prevent buffer overrun and memory corruption

nsdescs should point to an allocated memory of size
NVME_IDENTIFY_DATA_SIZE bytes, not "sizeof(*void)" bytes.

Signed-off-by: Maurizio Lombardi <mlombard@redhat.com>

ocp: set UUID index to get extended smart log

The index is required by the OCP specification.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

plugins/ocp: fixed crash in telemetry string log output format json

Fixed the code to handle the json output crash
Disabled debug logs output when parsing telemetry-string-log data

Signed-off-by: Karthik Balan karthik.b82@samsung.com <karthik.b82@samsung.com>
Reviewed-by: Arunpandian J <arun.j@samsung.com>

nvme: Host-init telemetry log mcda field added

Maximum Created Data Area for Telemetry Host-Initiated Log creation
This will ignored by contorller when MCDAS bit is 0 from supported log

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

build: bump libnvme wrap

mi: telemetry log update based NVMe v2.1

This update allow to call below APIs
  nvme_get_log_create_telemetry_host
  nvme_mi_admin_get_log_create_telemetry_host_mcda

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

nvme-print-stdout: print MAXWZD and NSZS bits of ONCS field

Print the newly added MAXWZD and NSZS bits of ONCS field in Identify
Controller Data Structure.
TP4160 - WZSL Limit Modification

Signed-off-by: Francis Pravin <francis.p@samsung.com>

build: bump libnvme wrap

b50a076 - types: add enum for the fields added in TP4160

Signed-off-by: Francis Pravin <francis.p@samsung.com>

netapp-smdev: add verbose output

Add a verbose option to display additional information of smdevices
on the host. And while at it, make a few corrections/modifications
to the JSON output as well.

Signed-off-by: Martin George <marting@netapp.com>
Tested-by: Clayton Skaggs <claytons@netapp.com>

netapp-smdev-doc: add verbose details

Add verbose option details to the smdevices documentation.

Signed-off-by: Martin George <marting@netapp.com>
Tested-by: Clayton Skaggs <claytons@netapp.com>

netapp-smdev: remove redundant code

Remove redundant code in regular and JSON functions, which is
already invoked in a separate function.

Signed-off-by: Martin George <marting@netapp.com>

nvme-print: fix Arbitration Mechanism Supported

Fix the error of the "Arbitration Mechanism Supported"
in the Controller Capabilities field of Controller Properties

Signed-off-by: Xiaoyuan Zhang <zhxiaoy2024@gmail.com>

nvme: telemetry ctrl-init need to clear RAE

if rae default is true, it's always true
so it was not possible to issue with RAE=0

If the host is reading the Telemetry Controller-Initiated log page,
then the host reads any portion of that log page with the Retain
Asynchronous Event bit cleared to ‘0’ to indicate to the controller
that the host has completed reading the Telemetry Controller-Initiated
log page

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

nvme-netapp: update err messages

Trivial fix to update a few error messages.

Signed-off-by: Martin George <marting@netapp.com>

netapp-ontapdev: fix JSON output for nsze & nuse

The namespace size & utilization values printed in the JSON
output was incorrect. Fix the same.

Signed-off-by: Martin George <marting@netapp.com>

netapp-ontapdev: fix fw version handling

The string used to capture the fw version was not handled
properly. Fix the same.

Signed-off-by: Martin George <marting@netapp.com>

print: Supported Log lidsp print updated NVMe v2.1

LIDSP : LID Specific Parameter using upper 16bits
so fix wrong bit shift (0x16 = 22bit shift)

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

nvme-print-stdout: add nvm-id-ctrl command VER and LBAMQF fields

The fields added by NVM command set specification 1.1.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

build: bump libnvme wrap

Fetch dad5a9805a38 ("types: add NVME_ID_CTRL_NVM_LBAMQF definitions")

Signed-off-by: Daniel Wagner <wagi@kernel.org>

wdc: rework log retrieval and parsing

We should only need to retrieve the log page once, rather than once per
field to be parsed. This also fixes some endianness issues when handling
the parsed data entries.

Signed-off-by: Brandon Paupore <brandon.paupore@wdc.com>

build: change muon setup command and parameter

The command and parameter changed by the muon commits below.
  eec469bb ("bootstrap.sh - use muon-bootstrap as exe name")
  5a64dfd3 ("disable bestline by default")

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

ocp: set UUID index to get hwcomp log

The index is required by the OCP specification.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

type: Using enums of ANSAN and RGCNS bit for OAES

Using enums of ANSAN and RGCNS bit for OAES field based on NVM Express
Base Specification 2.1

Signed-off-by: Arbaz Khan <arbaz.khan@samsung.com>
Reviewed-by: Steven Seungcheol Lee <sc108.lee@samsung.com>
Reviewed-by: Francis Pravin <francis.p@samsung.com>

nvme-print: print the new fields added in Sanitize log - TP4152

Print the new fields added in Sanitize log as part of TP4152.
TP4152 - Post-Sanitize Media Verification 2024.04.01 Ratified.

Signed-off-by: Francis Pravin <francis.p@samsung.com>
Reviewed-by: Steven Seungcheol Lee <sc108.lee@samsung.com>

build: bump libnvme wrap

To use enum for idctrl CTRATT.RHII

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

nvme-print: Add id-ctrl CTRATT.RHII, using enum

use enum nvme_id_ctrl_ctratt to parse values
reorder variable define
rename variables with abbreviation from nvme spec 2.1

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

fabrics: update return values for dim

The nvme dim command returns a zero even for failure scenarios
as shown below:

nvme0 DIM register command error. Status:0xffffffff -
Operation not supported

echo $?
0

Fix this by ensuring appropriate values are returned for success
and failure scenarios. And while at it, remove a couple of
superfluous braces too here.

Signed-off-by: Martin George <marting@netapp.com>

ocp-nvme: Add Error Injection type from ocp2.6

4.15.3.1 Error Injection Entry Data Structure
ERRIE-3 Error Injection Type

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

ocp-nvme: Update ocp v2.6 Hardware Component

Log Identifier C6h
Hardware Component Log Size (bytes)
Component Identifier added
0x000C Born on Date. The date on which the device was manufactured.
ASCII string format is MMDDYYYY.

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

build(deps): bump codecov/codecov-action from 4 to 5

Bumps [codecov/codecov-action](https://github.com/codecov/codecov-action) from 4 to 5.
- [Release notes](https://github.com/codecov/codecov-action/releases)
- [Changelog](https://github.com/codecov/codecov-action/blob/main/CHANGELOG.md)
- [Commits](https://github.com/codecov/codecov-action/compare/v4...v5)

---
updated-dependencies:
- dependency-name: codecov/codecov-action
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>

nvme: update messages for few misc functions

Print a helpful success message (under verbose option) for few
functions like subsystem_reset(), reset() and ns_rescan().

Signed-off-by: Martin George <marting@netapp.com>

ocp-nvme: fix the error display of Hardware Component Log

The display of Hardware Component (Log Identifier C6h) failures to
comply with protocol OCP2.5

Issue: https://github.com/linux-nvme/nvme-cli/issues/2566

Signed-off-by: liuzhen <liuzhen@dapustor.com>

opc: fix hardware component descriptions bytes number

Subtract offset bytes number 64 from the hardware component log size.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

ocp-nvme: Recommit removed patch

commit a5f155c9740b ("ocp-nvme: Add LMDATA-37 for Latency Monitor Log")

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