===============
Version History - openSeaChest_Format
===============
v26.03.2  13-May-2026  Fix for 32bit platforms for reading SCSI defect list. Previous fixes covered 64bit
                       systems, but did not fully resolve 32bit platform issues.
                       Fixed a logic error in fast-format where the MBR erase step was silently skipped on
                       SATA drives that do not support the ATA Zeros Ext command. On hardware without this
                       command, a drive with a valid MBR, including a protective MBR on a GPT-partitioned
                       disk, could become unpartitionable after a sector-size change without manually
                       erasing the MBR with a tool such as openSeaChest_Erase after a system power cycle.
                       Added additional bounds checks for SAS firmware download capability detection,
                       improved overflow checking when reading physical element status (HDD head health),
                       added bounds checks when reading raw GPT partition information to prevent overflow
                       if more than 31.5 million partitions exist in the table, added bounds checks when
                       reading Set Max LBA model number and capacity descriptor lists to prevent overflow
                       if an abnormally large descriptor count is reported, and added maximum bounds checks
                       when iterating over SCSI log pages, subpages, and VPD page lists. A device returning
                       a malformed or oversized length value in any of these paths could cause a loop
                       counter to wrap and in at least one case produce an infinite loop. None of these
                       conditions are reachable with real, spec-compliant hardware.
v26.03.1  04-Apr-2026  Fix out or bounds read when reading Linux OS information in --version.
                       Fix possible out of bounds issue reading SCSI defect list for extremely
                       large defect lists. Unconfirmed if this access occurs in v26.03.0 due to
                       significant API changes that were made, however all versions prior to v26.03.0
                       are affected.
                       Fix for our of bounds write when issuing trim/unmap/deallocate to NVMe devices.
                       Added additional checks to ensure populating supported formats stays in bounds for
                       NVMe devices. This does not affect v26.03.0 however earlier versions could go out of
                       bounds if a malicious response from an NVMe device were received.
                       Added option to disable SATA power consumption feature.
                       Fixed location of SATA power consumption help text to move out of SAS only section.
                       Fixed possible bugs trimming whitespace on model numbers, serial numbers, firmware
                       revisions and other drive reported strings that are space padded. No known real world
                       impacts, mostly just edge cases found during testing various inputs and outputs to these
                       functions.
                       Fixed input handling to various options. When units are provided, hexadecimal input is not
                       allowed. Hex can be passed to many options but it is treated as a raw input, not something
                       to be adjusted based on the unit. Ex: milliamps may be expected, but providing amps would
                       multiply the input by 1000 to convert it to milliamps for internal code.
                       Fixed incorrect bounds passed when generating JSON data for FARM and drive info. This
                       does not appear to go out of bounds due to what is written here, however this could
                       potentially go out of bounds if the data were too long. No known real world impact.
v26.03.0  06-Mar-2026  Utilities now use calendar versioning (CalVer) synchronized with
                       library releases and unified package versioning. This aligns the
                       utility version with the released package containing all tools,
                       simplifying version tracking and release coordination for both
                       developers and users.
                       Fixed possible bug opening drive handle in Linux when scanning for
                       drive connection information. Fixed issue with NVMe set features
                       command in Windows that could affect some feature configuration
                       operations (most users will not be impacted). Improved USB device
                       compatibility, particularly with older USB adapter chipsets. Fixed
                       CISS RAID scanning and device handling. Fixed potential crash when
                       displaying ATA SMART error logs with unclassifiable error codes.
                       Fixed possible memory reading issue in certain diagnostic output
                       where string parsing could read beyond the intended string
                       boundary, though remaining within allocated memory bounds.
                       Added JSON output support for device information and diagnostics
                       reporting. Improved automatic UDS pull method selection to minimize
                       the need for manual --udsMode option when retrieving UDS data.
                       Improved SCSI defect list reporting accuracy.
                       Added LBA status log support for SATA drives. Implemented enhanced
                       recovery procedures during fast format operations to minimize the
                       possibility of interruptions. Added detection of firmware depop/repop
                       timing anomalies.
v3.5.1  06-Oct-2025  Fixed mismatch of GNU/clang access attribute description and how the code was actually written in many
                     parts of the low-level library code. Also added const to many objects to make intention more clear and
                     reduce the chance of accidental modification to memory intended to be used in a read-only way. No known
                     bugs from this, but may affect some optimizations in the code.
                     Fixed compatibility with some newer C23 capable compilers.
                     Fixed incorrect pointer check in TRIM function causing a failure when trying to use this option with valid
                     inputs.
                     Fixed incorrect lookup for supported read defect data command in SCSI Defect list code.
                     Added automatic selection of firmware download transfer size based on drive reported information for all
                     interfaces (min/max/granularity, etc).
                     Fixed out of bounds access when generating FARM combined log (was adding NULL terminator one past end of memory).
                     Removed use of os_Update_File_System_Cache from situations where the drive may not be in a good state (still sanitizing,
                     or after a sector size change) to minimize possible system interaction issues which may disconnect the device from the
                     system.
                     Fixed read/write logic on some USB devices which reported an ATA maxlba of 0.
                     Added tracking lock/unlock requests to a tDevice to keep things in sync better between operations.
                     Refactor SCSI device read/write logic on how commands are selected and issued (10B vs 16B)
                     Removed automatic ATA passthrough reads/writes due to other side affects this created on some devices.
                     Fixed a crash on NVMe devices in Windows when using the openfabrics NVMe driver.
                     Fixed a bug that tracks the last command's sense data after issuing which may have been missed in certain situations.
                     Fixed implied captive/foreground mode for SAS fast format. This mode can be selected using the --disableImmediateResponse option.
v3.4.0  07-Jul-2025  Fixed a bug with scan not showing any output in specific circumstances where number of successfully
                     enumerated devices is equivalent to the number of unsuccessfully enumerated devices.
                     Added new exit code for when paths are detected as insecure to be resolved by the user before
                     files will be accessed in these directories (see https://github.com/Seagate/openSeaChest/wiki/Secure-File-And-Path).
                     Fixed a check for reading correct mode page which may cause changing some SAS features to fail.
                     Fixed incorrect protocol specified in ATA download microcode passthrough command. This causes firmware updates
                     to hang when the device does not support the download DMA command.
                     Fixed NVMe firmware update in Windows 11 23H2 and 24H2.
                     Disabled extra CSMI related device scan in Windows that can cause a hang on some chipsets.
                     Added some more legacy USB devices to list of known devices to support these better when they are used.
                     Added missing option to run remove elements and modify zones for zoned devices.
v3.3.0  28-May-2025  Added support for low-level SCSI rescan in Linux when passing aggressive scan flag -S.
                     Refactor reading SCSI capacity code which may reduce total commands issued.
                     Refactored looking up supported SCSI commands with Report Supported operations codes and
                     legacy CmdDT bit in Inquiry which reduces total commands issued.
                     Source code level support for OpenBSD, NetBSD, and DragonflyBSD now available.
                     More source code hardening implemented with new bounds checking functions from
                     opensea-common library (behave similar to Annex K in C11).
                     Fixed a bug in reading device information (-i) on USB devices causing the information to be
                     incomplete.
                     Fixed big endian system support for all devices, but especially for NVMe.
                     Fixed looking up SD to SG device handles in Linux.
                     Added new exit codes for Device Not Found when opening the handle and Device Busy when
                     attempting to open a handle.
                     Enhanced file security API to display recommended actions to modify directories to be
                     compatible with security requirements when reading or writing a file.
                     Fixed a crash when reading/writing files located at / in unix-like systems.
                     Fixed exit code when -d all or --modelMatch are used but all devices are skipped so that
                     the exit code is not set to 0 (success) when all the devices were skipped.
                     Added exclusive open for set sector size and fast format to reduce likelyhood of a reset while
                     these operations are running.
                     Added additional error checking when changing SAS sector size to confirm the drive accepted the
                     correct size. ex: setting 4k, but drive formats to 528 instead due to not reporting an error.
v3.2.0  28-Aug-2024  Pull in security updates and low-level bug fixes from opensea-libs.
                     CISS RAID device support for Linux (CCISS, HPSA, and SmartPQI drivers)
                     Added secure file API for reading pattern to use for formatting when user
                     is providing a custom pattern to use for a format unit on SAS.
                     Added --force as option to pass with --setSectorSize to force retries
                     or attempt the commands to change sector size or recovery from bad formats.
v3.0.4  01-Dec-2023  Updated to newer opensea-libs to pull in low-level fixes.
                     Changed set sector size timeout to 1 hour instead of infinite to
                     improve compatibility with some drivers in Linux.
                     Added more warnings around set sector size option.
                     Changed default behavior of SAS fast format with --setSectorSize
                     to use polling while changing the sector size to reduce the
                     chance of OS interruption/resets.
                     Stopped reading /etc/passwd file to show username in banner.
                     Banner will now show either "admin"/"root" or "current user".
                     Improved parsing of linux distro/release information from
                     /etc/os-release file.
                     Fixed a bug in byte swap string used to get ATA MN, SN, FW.
                     Fixed a bug in getting/reporting power on hours as years,
                     days, hours, etc where days was being truncated.
                     Fixed error reading NVMe features in Windows for drive info.
                     Fixed SAS Date of manufacture in drive info.
                     Added detection of HPA security feature.
                     Added more SMART attributes definitions for Seagate HDDs & SSDs,
                     and more definitions for Maxtor HDDs.
                     Improved temperature detection from older HDDs with only
                     SMART attribute 194 reporting current temperature.
                     Added separate warning for SMART attributes below threshold that
                     are not considered prefail/warranty attributes (aka failures).
                     Fixed output of Seagate Airflow temperature SMART attribute.
                     Added showing new capacity after changing Max LBA.
                     Fixed possible segmentation fault when reading /etc/mtab in Linux.
                     Workaround for some SAS drives on some HBAs reporting incorrect
                     response to SAT A1h CDB.
                     Fixed a bug in FreeBSD causing non-data ATA commands to report
                     all zeroes instead of expected output in RTFRs.
v2.7.0  27-Mar-2023  opensea-transport updated to fix CSMI scan duplicating devices
                     found in certain scenarios.
v2.7.0  28-Feb-2023  New acceptance string for low-level format options that are not
                     obvious that they are doing a formwat. As these options are dangerous
                     and in some cases can be interrupted by the host, this new string
                     is required to be used to accept the risk since it may leave a device
                     in an unusable state if interrupted. New warnings accompany this change.
                     Tool also was updated to remove the manual option to perform a Seagate
                     quick format on SATA drives since this is now handled automatically when
                     it is detected as needed to recover the device to a fully functional state.
                     Includes new --noBanner option and new fast discovery option
                     that can be used in situations where super critical performance
                     is required at a loss of information about a drive's capabilities.
                     Help now has many more examples of the options in the tool.
                     Fixed a few bugs in scan and device discovery that could cause
                     a crash or the tool to list no devices found.
                     Added option to dump low-level info to assist with debugging.
                     Added date of manufacture info to the -i output when available.
                     Fixed some big endian compatibility issues discovered on AIX.
                     Added capability for NVM format with user data erase in Windows as well
                     as crypto erase with format in Windows. Reworked conditions for issuing
                     sanitize on NVMe devices so that it might work in Windows too.
v2.3.1  16-Jun-2021  Pulled in updates to opensea-libs which includes the following:
                     Minor USB compatibility improvements and more products added
                     to the list with their specific workarounds.
                     Updated NVMe compatibility for FreeBSD 11.
                     Support for detection and showing of concurrent positioning
                     (new multi-actuator support from the standards).
v2.3.1  27-Apr-2021  Adding Seagate quick format option for SATA drives. If a setSectorSize
                     operation fails, this may be necessary in order to get the drive back
                     to a good state. If a failure is detected this will automatically be run
                     to try and make sure the drive is left in a good state.
v2.2.1  12-Feb-2021  Added depopulate and repopulate options to openSeaChest_Format
                     Improved argument parsing to accept hex in addition to decimal for
                     many different options.
                     Setting fast-format to hold busy until complete for better results.
                     More messages are now displayed warning not to interrupt format/fast
                     format operations and depopulate.
                     opensea-transport code pulled in enhancements to attempt to block
                     other applications and the OS from interrupting format, fast format,
                     depopulate, and repopulate to prevent potential problems
                     during these operations or which may leave the drive in a bad state
                     if they are interrupted.
v2.1.0  20-Nov-2020  Added Storage element depopulation commands to openSeaChest_Format.
                     Added support for new storage element repopulation command.
v2.0.0  18-Oct-2020  Changed how scan-flags are parsed. CSMI rewrite and initial
                     Intel RST NVMe support added. Numerous code quality improvements
                     which fixed many potential bugs and memory leaks. Improved
                     support for openfabrics NVMe drivers. Changed permissions
                     detection to show warnings rather than errors. Removed obsolete
                     CSMI and SAT 12B CDB options. CSMI handles now show as csmi:?:?:?
v1.5.2  13-Apr-2020  1_21_30 libraries, fix memory allocation during the scan
                     command.
v1.5.1  19-Feb-2020  1_21_30 libraries add in check for Elevated Privileges
                     (sudo, run as administrator) before trying to talk to
                     devices, new exit code 9 if privileges are missing;
                     printing the USB VID/PID in the device info; fix to sg
                     helper to support large systems; many changes in support
                     of dual actuators (example: warning that EPC settings
                     affect multiple LUNs); overhaul to USB device detection
                     and support, incorporating a new USB hacks and workarounds
                     approach which uses a lookup table listing various USB
                     bridge VIDs/PIDs and their specific issues; separate
                     Seagate SAS SN and PCBA SN.
v1.4.0  10-Jun-2019  1_19_23 libraries added SNTL (SCSI to NVMe translator),
                     updated software SAT translator to use dataset management
                     XL command, fixes for issuing vendor unique commands under
                     Windows, improved fast format support detection, and
                     refactored verbose output for NVMe commands.
v1.4.0  03-May-2019  1_19_18 libraries added per device verbosity, --deviceInfo
                     adds SAS (not SATA) FastFormat for Features Supported
                     section,  --deviceInfo now gives Low Current Spinup
                     status. Adds --showSupportedFormats, removes
                     --showSupportedSectorSizes. Adds several new commands in
                     support of NVMe format: --nvmFormat, --nvmFmtSecErase,
                     --nvmFmtMS, --nvmFmtNSID, --nvmFmtPI, --nvmFmtPIL,
                     --nvmFmtMetadataSet.
v1.2.1  18-Oct-2018  1_18_3 libraries Added NVMe generic read command support.
v1.2.1  21-Sep-2018  1_18_2 libraries Added in reading os-release PRETTY_NAME
                     field to get the OS name under linux; NVMe enabled;  fixed
                     a bug in the ATA activate FW command; added in reading ID
                     Data log and Device statistics logs page 0 to check the
                     list of supported pages; fixed a bug in the loop used to
                     read mode pages for -i information on SAS; IDD SAS
                     improvements; fixed a bug in DST & Clean with ATA drives
                     behind SCSI controllers. Fix for --modelMatch that have
                     spaces in the name. Added additional information to the
                     banner and -V data to show support levels. Add general
                     support for NVMe and NVMe specific identify data to "-i"
                     command.
v1.2.0  19-Apr-2018  1_18_0 libraries improves device detection of CD-ROM and
                     USB flash drives, support for early 90's PATA drives that
                     don't support LBA mode, bug fix where the last digit of
                     the SCSI Unit Serial Number was being dropped, additional
                     logic for deferred download completion status. --scan
                     --onlySeagate for just Seagate drives in a large system,
                     Long Drive Self Test Time in the -i output, write protect
                     status has been added for SCSI and NVMe in the -i output,
                     IDD enhancements for SAS, IDD enhancements to allow
                     captive mode on SATA, added USB Hacks to better support
                     some odd-ball USB devices and prevent crashes and improve
                     performance for some operations on them by issuing test
                     unit ready commands when something fails during device
                     discovery, automatic fall back to SAT 10 byte commands
                     during device discovery to help work with some USB
                     devices, some Legacy SCSI support enhancements (partially
                     from USB hacks development), enhanced SD to SG mapping in
                     Linux. Removed immediate bit from SAS Fast Format.
v1.2.0  02-Nov-2017  1_17_7 libraries fixes Long DST time on SCSI/SAS products.
v1.2.0  31-Oct-2017  1_17_6 libraries adds ATA Security compatibility with SATL
                     on some LSI adapters, corrects firmware download issue
                     under Windows 10 API.
v1.2.0  26-Oct-2017  1_17_5 libraries fixes SATA drive discovery behind HBAs
                     that don't show as SATA and don't support the SAT VPD
                     page; added Automatic fallback to 12byte CDBs during
                     initial device discovery;  integrated fixes for SAS
                     firmware download and fixes for SAS LongDST time
                     calculation; added detection of TCG Pyrite and Opalite
                     drives. Removed --defaultFormat since that is now the
                     default behavior until other flags are added.
v1.1.1  12-Oct-2017  1_17_3 libraries improves Fast-Format compatibility on SAS.
v1.1.0  10-Oct-2017  1_17_1 libraries adds Better handling of NVMe as a SCSI
                     device, SAT library strings, and fixes to Read-Buffer
                     error history (ISL). Updated copyright notice, invalid
                     command line options now only display an error instead of
                     long help. Added --setSectorSize moved from
                     SeaChest_Configure. Name change from SeaChest_FormatUnit
                     to openSeaChest_Format.
v1.0.0  25-Sep-2017  1_17_0 libraries adds improved SATA device discovery on
                     SAS adapters, added NVMe read, write & Flush commands.
v1.0.0  19-Sep-2017  1_16_4 libraries fixes SCSI "--progress format", added
                     reading remanufacture time for SAS when the drive reports
                     a time, fixed SAS --abortDST.
v1.0.0  27-Jul-2017  1_16_2 libraries enhances Seagate brand detection.
v1.0.0  14-Jul-2017  1_16_1 libraries adds support for ATA drives that have the
                     Sense Data Reporting feature enabled, changes to how we
                     interpret the completion status from the drive, new Sense
                     Data ASC, ASCQ definitions from SPC5. Adds --Scan (or -S,
                     note the capital S) aggressive system scan.
v0.0.1  23-May-2017  1_14_3 libraries.  SeaChest_FormatUnit initial beta
                     test release.  Branched from SeaChest_Erasev0.0.2  14-Jun-2017  1_15_0 libraries adds bug fix malformed command line
                     should exit with code = 1; added detection of parallel ATA
                     and SCSI speeds; temperature data on ATA now uses the
                     values from the SCT status log or device statistics log.
                     Bug fix where the "-d all" was not filtering out csmi
                     drives like it is supposed to causing duplicate drives to
                     show up.  Adds the child drive matching options
                     --childModelMatch, --childOnlyFW, and --childNewFW.
