xref: /aosp_15_r20/external/sg3_utils/doc/sg_reset_wp.8 (revision 44704f698541f6367e81f991ef8bb54ccbf3fc18)
SG_RESET_WP "8" "February 2022" "sg3_utils-1.48" SG3_UTILS
NAME
sg_reset_wp - send SCSI RESET WRITE POINTER command
SYNOPSIS
sg_reset_wp [--all] [--count=ZC] [--help] [--verbose] [--version] [--zone=ID] DEVICE
DESCRIPTION
Add any additional description here

Sends a SCSI RESET WRITE POINTER command to the DEVICE. This command is described in ZBC standard (INCITS 536-2016) and the draft ZBC-2 documents at T10 (e.g. zbc2r12.pdf).

OPTIONS
Arguments to long options are mandatory for short options as well.

-a, --all sets the ALL field in the cdb. This causes a reset write pointer operation of all open zones and full zones. When this option is given then the --zone=ID option is ignored. Either this option or the --zone=ID option is required.

-C, --count=ZC ZC is placed in the Zone Count field in the cdb of the RESET WRITE POINTER command supported by this utility. ZC should be a value from 0 to 65535 (0xffff) inclusive.

The action that the DEVICE takes with this option depends on whether the --all option is set. See the RESET WRITE POINTER command description (e.g. section 5.9, table 46 in zbc2r12.pdf).

-h, --help output the usage message then exit.

-v, --verbose increase the level of verbosity, (i.e. debug output).

-V, --version print the version string and then exit.

-z, --zone=ID where ID is placed in the cdb's ZONE ID field. A zone id is a zone start logical block address (LBA). This causes a reset write pointer operation on the zone identified by the ZONE ID field. The default value is 0. Either this option or the --all option is required. ID is assumed to be in decimal unless prefixed with '0x' or has a trailing 'h' which indicate hexadecimal.

NOTES
The Zones Emptied log parameter in the Zoned Block Device Statistics log page counts the number of times the RESET WRITE POINTER command has been (successfully) invoked.
EXIT STATUS
The exit status of sg_reset_wp is 0 when it is successful. Otherwise see the sg3_utils(8) man page.
AUTHORS
Written by Douglas Gilbert.
"REPORTING BUGS"
Report bugs to <dgilbert at interlog dot com>.
COPYRIGHT
Copyright \(co 2014-2022 Douglas Gilbert

This software is distributed under a BSD-2-Clause license. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

"SEE ALSO"
sg_rep_zones,sg_zone(sg3_utils)