Page MenuHomeFreeBSD
Differential D24639

Document the passthru commands.
ClosedPublic
Actions

Authored by imp on Apr 30 2020, 5:54 PM.
Tags
None
Referenced Files
Unknown Object (File)
Wed, Apr 16, 5:11 PM
Unknown Object (File)
Tue, Apr 15, 4:00 PM
Unknown Object (File)
Mar 6 2025, 10:10 PM
Unknown Object (File)
Feb 23 2025, 5:40 PM
Unknown Object (File)
Jan 24 2025, 5:15 PM
Unknown Object (File)
Jan 24 2025, 9:15 AM
Unknown Object (File)
Jan 18 2025, 10:09 PM
Unknown Object (File)
Jan 13 2025, 2:57 AM
View All 60 Files
Subscribers
dab
gbe

Details

Reviewers
bcr
0mp
Group Reviewers
manpages
Commits
rS360547: Document the passthru commands.

Diff Detail

Repository
rS FreeBSD src repository - subversion
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Revision Contents
Changeset List

PathSize
head/
sbin/
nvmecontrol/
70 lines
2 lines

Diff 71253

View Options

head/sbin/nvmecontrol/nvmecontrol.8

Show First 20 Lines • Show All 188 Lines • ▼ Show 20 Lines
.Op Fl o path_template .Op Fl o path_template
.Aq Ar device-id .Aq Ar device-id
.\" .Nm .\" .Nm
.\" .Ic wdc purge .\" .Ic wdc purge
.\" .Aq device-id .\" .Aq device-id
.\" .Nm .\" .Nm
.\" .Ic wdc purge-monitor .\" .Ic wdc purge-monitor
.\" .Aq device-id .\" .Aq device-id
.Nm
.Ic admin-passthru
.Op args
.Aq Ar device-id
.Nm
.Ic io-passthru
.Op args
.Aq Ar namespace-id
.Sh DESCRIPTION .Sh DESCRIPTION
NVM Express (NVMe) is a storage protocol standard, for SSDs and other NVM Express (NVMe) is a storage protocol standard, for SSDs and other
high-speed storage devices over PCI Express. high-speed storage devices over PCI Express.
.Pp .Pp
.Ss identify .Ss identify
The identify commands reports information from the drive's The identify commands reports information from the drive's
.Dv IDENTIFY_CONTROLLER .Dv IDENTIFY_CONTROLLER
if a if a
▲ Show 20 Lines • Show All 256 Lines • ▼ Show 20 Lines
The The
.Fl o .Fl o
flag specifies a path template to use to output the files. flag specifies a path template to use to output the files.
Each file takes the path template (which defaults to nothing), appends Each file takes the path template (which defaults to nothing), appends
the drive's serial number and the type of dump it is followed the drive's serial number and the type of dump it is followed
by .bin. by .bin.
These logs must be sent to the vendor for analysis. These logs must be sent to the vendor for analysis.
This tool only provides a way to extract them. This tool only provides a way to extract them.
.Ss passthru
The
.Dq admin-passthru
and
.Dq io-passthru
commands send NVMe commands to
either the administrative or the data part of the device.
These commands are expected to be compatible with nvme-cli.
Please see
.St The NVMe Standard
for details.
.Bl -tag -width 16n
.It Fl o -opcode Ar opcode
Opcode to send.
.It Fl 2 -cdw2 Ar value
32-bit value for CDW2.
.It Fl 3 -cdw3 Ar value
32-bit value for CDW3.
.It Fl 4 -cdw10 Ar value
32-bit value for CDW10.
.It Fl 5 -cdw11 Ar value
32-bit value for CDW11.
.It Fl 6 -cdw12 Ar value
32-bit value for CDW12.
.It Fl 7 -cdw13 Ar value
32-bit value for CDW13.
.It Fl 8 -cdw14 Ar value
32-bit value for CDW14.
.It Fl 9 -cdw15 Ar value
32-bit value for CDW15.
.It Fl l -data-len
Length of the data for I/O (bytes).
.It Fl m -metadata-len
Length of the metadata segment for command (bytes).
This is ignored and not implemented in
.Xr nvme 4 .
.It Fl f -flags
Nvme command flags.
.It Fl n -namespace-id
Namespace ID for command (Ignored).
.It Fl p -prefill
Value to prefill payload with.
.It Fl b -raw-binary
Output in binary format (otherwise a hex dump is produced).
.It Fl d -dry-run
Do not actually execute the command, but perform sanity checks on it.
.It Fl r -read
Command reads data from the device.
.It Fl s -show-command
Show all the command values on stdout.
.It Fl w -write
Command writes data to the device.
.El
Send arbitrary commands to the device.
Can be used to extract vendor specific logs.
Transfers to/from the device possible, but limited to
.Dv MAXPHYS
bytes.
Commands either read data or write it, but not both.
Commands needing metadata are not supported by the
.Xr nvme 4
drive.
.Sh DEVICE NAMES .Sh DEVICE NAMES
Where Where
.Aq Ar namespace-id .Aq Ar namespace-id
is required, you can use either the is required, you can use either the
.Pa nvmeXnsY .Pa nvmeXnsY
device, or the disk device such as device, or the disk device such as
.Pa ndaZ .Pa ndaZ
or or
▲ Show 20 Lines • Show All 143 Lines • Show Last 20 Lines
View Options

head/sbin/nvmecontrol/passthru.c

Show First 20 Lines • Show All 286 Lines • ▼ Show 20 Lines
}; };
static struct cmd io_pass_cmd = { static struct cmd io_pass_cmd = {
.name = "io-passthru", .name = "io-passthru",
.fn = io_passthru, .fn = io_passthru,
.ctx_size = sizeof(struct options), .ctx_size = sizeof(struct options),
.opts = opts, .opts = opts,
.args = args, .args = args,
.descr = "Send a pass through Admin command to the specified device", .descr = "Send a pass through I/O command to the specified device",
}; };
CMD_COMMAND(admin_pass_cmd); CMD_COMMAND(admin_pass_cmd);
CMD_COMMAND(io_pass_cmd); CMD_COMMAND(io_pass_cmd);