Skip to content

Commit 4b22004

Browse files
brandon-paupore-sndkigaw
brandon-paupore-sndk
authored and
igaw
committed
plugin: cleanup vs-internal-log documentation
Some of these statements are out of date and missing important clarifying information. This attempts to clear that up and point out some parameters that are now deprecated. Signed-off-by: Brandon Paupore <[email protected]> Reviewed-by: Jeffrey Lien <[email protected]>
1 parent 85154a1 commit 4b22004

4 files changed

Lines changed: 56 additions & 36 deletions

File tree

‎Documentation/nvme-sndk-vs-internal-log.txt‎

Lines changed: 21 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -39,31 +39,37 @@ OPTIONS
3939

4040
-d <DATA AREA>::
4141
--data-area=<DATA AREA>::
42-
DUI data area to retrieve. The DUI data areas from 1 to <DATA AREA> will
43-
be retrieved. This parameter is currently only supported on the SN340,
44-
SN640, SN730, and SN840 devices.
42+
Data area to retrieve. For capture with a --type value that includes
43+
telemetry (CONTROLLER or HOST), this specifies the NVMe telemetry data
44+
area to capture, containing data from areas 1 to <DATA AREA>. For
45+
capture without such a --type value, this specifies the amount of
46+
vendor defined debug data to capture, and this is only supported on the
47+
SN340, SN350, SN530, SN570, SN730, SN740, SN840, SN850X, SN5000,
48+
SN5100S, SN7000S, SN7100, and SN7150 devices.
4549

4650
-f <FILE SIZE>::
4751
--file-size=<FILE SIZE>::
48-
Specifies the desired size of the data file starting at the passed in
49-
offset. This allows the user to retrieve the data in several smaller
50-
files of the passed in size. This parameter is currently only supported
51-
on the SN340 device.
52+
Deprecated. Specifies the desired size of the data file starting at the
53+
passed in offset. This allows the user to retrieve the data in several
54+
smaller files of the passed in size. This parameter is only supported on
55+
the devices mentioned in the documentation of the --data-area parameter,
56+
and only for capture with --type=NONE or --type not specified.
5257

5358
-e <OFFSET>::
5459
--offset=<OFFSET>::
55-
Specifies the data offset at which to start retrieving the data. This
56-
parameter is used in combination with the file size parameter to
57-
retrieve the data in several smaller files. This parameter is currently
58-
only supported on the SN340 device.
60+
Deprecated. Specifies the data offset at which to start retrieving the
61+
data. This parameter is used in combination with the file size parameter
62+
to retrieve the data in several smaller files. This parameter is only
63+
supported on the devices mentioned in the documentation of the
64+
--data-area parameter, and only for capture with --type=NONE or --type
65+
not specified.
5966

6067
-t <TYPE>::
6168
--type=<TYPE>::
6269
Specifies the telemetry type - NONE, HOST, or CONTROLLER. This parameter
63-
is used to get either the host generated or controller initiated
64-
telemetry log page. If not specified or none is specified, the command
65-
will return the default E6 log data. This parameter is currently only
66-
supported on the SN640 and SN840 devices.
70+
is used to get either the host-initiated or controller-initiated
71+
telemetry log page. If not specified or if <TYPE> is NONE, the command
72+
will return vendor defined debug data.
6773

6874
-v <VERBOSE>::
6975
--verbose=<VERBOSE>::

‎Documentation/nvme-wdc-vs-internal-log.txt‎

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -31,39 +31,45 @@ OPTIONS
3131
-o <FILE>::
3232
--output-file=<FILE>::
3333
Output file; defaults to device serial number followed by
34-
"_internal_fw_log_<date>_<time>.bin" suffix
34+
"_internal_fw_log_<date>_<time>.bin" suffix.
3535

3636
-s <SIZE>::
3737
--transfer-size=<SIZE>::
38-
Transfer size; defaults to 0x10000 (65536 decimal) bytes
38+
Transfer size; defaults to 0x10000 (65536 decimal) bytes.
3939

4040
-d <DATA AREA>::
4141
--data-area=<DATA AREA>::
42-
DUI data area to retrieve. The DUI data areas from 1 to <DATA AREA> will
43-
be retrieved. This parameter is currently only supported on the SN340,
44-
SN640, SN730, and SN840 devices.
42+
Data area to retrieve. For capture with a --type value that includes
43+
telemetry (CONTROLLER or HOST), this specifies the NVMe telemetry data
44+
area to capture, containing data from areas 1 to <DATA AREA>. For
45+
capture without such a --type value, this specifies the amount of
46+
vendor defined debug data to capture, and this is only supported on the
47+
SN340, SN350, SN530, SN570, SN730, SN740, SN840, SN850X, SN5000,
48+
SN5100S, SN7000S, SN7100, and SN7150 devices.
4549

4650
-f <FILE SIZE>::
4751
--file-size=<FILE SIZE>::
4852
Specifies the desired size of the data file starting at the passed in
4953
offset. This allows the user to retrieve the data in several smaller
50-
files of the passed in size. This parameter is currently only supported
51-
on the SN340 device.
54+
files of the passed in size. This parameter is only supported on the
55+
devices mentioned in the documentation of the --data-area parameter,
56+
and only for capture with --type=NONE or --type not specified.
5257

5358
-e <OFFSET>::
5459
--offset=<OFFSET>::
5560
Specifies the data offset at which to start retrieving the data. This
5661
parameter is used in combination with the file size parameter to
57-
retrieve the data in several smaller files. This parameter is currently
58-
only supported on the SN340 device.
62+
retrieve the data in several smaller files. This parameter is only
63+
supported on the devices mentioned in the documentation of the
64+
--data-area parameter, and only for capture with --type=NONE or --type
65+
not specified.
5966

6067
-t <TYPE>::
6168
--type=<TYPE>::
6269
Specifies the telemetry type - NONE, HOST, or CONTROLLER. This parameter
63-
is used to get either the host generated or controller initiated
64-
telemetry log page. If not specified or none is specified, the command
65-
will return the default E6 log data. This parameter is currently only
66-
supported on the SN640 and SN840 devices.
70+
is used to get either the host-initiated or controller-initiated
71+
telemetry log page. If not specified or if <TYPE> is NONE, the command
72+
will return vendor defined debug data.
6773

6874
-v <VERBOSE>::
6975
--verbose=<VERBOSE>::

‎plugins/sandisk/sandisk-nvme.c‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -310,12 +310,16 @@ static int sndk_vs_internal_fw_log(int argc, char **argv,
310310
const char *file = "Output file pathname.";
311311
const char *size = "Data retrieval transfer size.";
312312
const char *data_area =
313-
"Data area to retrieve up to. Currently only supported on the SN340, SN640, SN730, and SN840 devices.";
314-
const char *file_size = "Output file size. Currently only supported on the SN340 device.";
313+
"Data area to retrieve up to. Supported for telemetry, see man page for other use cases.";
314+
const char *file_size =
315+
"Output file size. Deprecated, see man page for supported devices.";
315316
const char *offset =
316-
"Output file data offset. Currently only supported on the SN340 device.";
317+
"Output file data offset. Deprecated, see man page for supported devices.";
317318
const char *type =
318-
"Telemetry type - NONE, HOST, or CONTROLLER Currently only supported on the SN530, SN640, SN730, SN740, SN810, SN840 and ZN350 devices.";
319+
"Telemetry type - NONE, HOST, or CONTROLLER:\n" \
320+
" NONE - Default, capture without using NVMe telemetry.\n" \
321+
" HOST - Host-initiated telemetry.\n" \
322+
" CONTROLLER - Controller-initiated telemetry.";
319323
const char *verbose = "Display more debug messages.";
320324
char f[PATH_MAX] = {0};
321325
char fileSuffix[PATH_MAX] = {0};

‎plugins/wdc/wdc-nvme.c‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4296,12 +4296,16 @@ static int wdc_vs_internal_fw_log(int argc, char **argv, struct command *acmd,
42964296
const char *file = "Output file pathname.";
42974297
const char *size = "Data retrieval transfer size.";
42984298
const char *data_area =
4299-
"Data area to retrieve up to. Currently only supported on the SN340, SN640, SN730, and SN840 devices.";
4300-
const char *file_size = "Output file size. Currently only supported on the SN340 device.";
4299+
"Data area to retrieve up to. Supported for telemetry, see man page for other use cases.";
4300+
const char *file_size =
4301+
"Output file size. See man page for supported devices.";
43014302
const char *offset =
4302-
"Output file data offset. Currently only supported on the SN340 device.";
4303+
"Output file data offset. See man page for supported devices.";
43034304
const char *type =
4304-
"Telemetry type - NONE, HOST, or CONTROLLER Currently only supported on the SN530, SN640, SN730, SN740, SN810, SN840 and ZN350 devices.";
4305+
"Telemetry type - NONE, HOST, or CONTROLLER:\n" \
4306+
" NONE - Default, capture without using NVMe telemetry.\n" \
4307+
" HOST - Host-initiated telemetry.\n" \
4308+
" CONTROLLER - Controller-initiated telemetry.";
43054309
const char *verbose = "Display more debug messages.";
43064310
char f[PATH_MAX] = {0};
43074311
char fb[PATH_MAX/2] = {0};

0 commit comments

Comments
 (0)