mirror of
https://github.com/aaru-dps/Aaru.git
synced 2025-12-16 11:14:25 +00:00
248 lines
8.5 KiB
C#
248 lines
8.5 KiB
C#
// /***************************************************************************
|
|
// Aaru Data Preservation Suite
|
|
// ----------------------------------------------------------------------------
|
|
//
|
|
// Filename : 01.cs
|
|
// Author(s) : Natalia Portillo <claunia@claunia.com>
|
|
//
|
|
// Component : Device structures decoders.
|
|
//
|
|
// --[ Description ] ----------------------------------------------------------
|
|
//
|
|
// Decodes and encodes SCSI MODE PAGE 01h: Read-write error recovery page.
|
|
//
|
|
// --[ License ] --------------------------------------------------------------
|
|
//
|
|
// This library is free software; you can redistribute it and/or modify
|
|
// it under the terms of the GNU Lesser General Public License as
|
|
// published by the Free Software Foundation; either version 2.1 of the
|
|
// License, or (at your option) any later version.
|
|
//
|
|
// This library is distributed in the hope that it will be useful, but
|
|
// WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
// Lesser General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU Lesser General Public
|
|
// License along with this library; if not, see <http://www.gnu.org/licenses/>.
|
|
//
|
|
// ----------------------------------------------------------------------------
|
|
// Copyright © 2011-2023 Natalia Portillo
|
|
// ****************************************************************************/
|
|
|
|
using System.Diagnostics.CodeAnalysis;
|
|
using System.Text;
|
|
|
|
namespace Aaru.Decoders.SCSI;
|
|
|
|
[SuppressMessage("ReSharper", "InconsistentNaming")]
|
|
[SuppressMessage("ReSharper", "MemberCanBeInternal")]
|
|
[SuppressMessage("ReSharper", "MemberCanBePrivate.Global")]
|
|
public static partial class Modes
|
|
{
|
|
public static byte[] EncodeModePage_01(ModePage_01 page)
|
|
{
|
|
var pg = new byte[8];
|
|
|
|
pg[0] = 0x01;
|
|
pg[1] = 6;
|
|
|
|
if(page.PS)
|
|
pg[0] += 0x80;
|
|
|
|
if(page.AWRE)
|
|
pg[2] += 0x80;
|
|
|
|
if(page.ARRE)
|
|
pg[2] += 0x40;
|
|
|
|
if(page.TB)
|
|
pg[2] += 0x20;
|
|
|
|
if(page.RC)
|
|
pg[2] += 0x10;
|
|
|
|
if(page.EER)
|
|
pg[2] += 0x08;
|
|
|
|
if(page.PER)
|
|
pg[2] += 0x04;
|
|
|
|
if(page.DTE)
|
|
pg[2] += 0x02;
|
|
|
|
if(page.DCR)
|
|
pg[2] += 0x01;
|
|
|
|
pg[3] = page.ReadRetryCount;
|
|
pg[4] = page.CorrectionSpan;
|
|
pg[5] = (byte)page.HeadOffsetCount;
|
|
pg[6] = (byte)page.DataStrobeOffsetCount;
|
|
|
|
// This is from a newer version of SCSI unknown what happen for drives expecting an 8 byte page
|
|
/*
|
|
pg[8] = page.WriteRetryCount;
|
|
if (page.LBPERE)
|
|
pg[7] += 0x80;
|
|
pg[10] = (byte)((page.RecoveryTimeLimit & 0xFF00) << 8);
|
|
pg[11] = (byte)(page.RecoveryTimeLimit & 0xFF);*/
|
|
|
|
return pg;
|
|
}
|
|
|
|
#region Mode Page 0x01: Read-write error recovery page
|
|
|
|
/// <summary>Disconnect-reconnect page Page code 0x01 12 bytes in SCSI-2, SBC-1, SBC-2</summary>
|
|
public struct ModePage_01
|
|
{
|
|
/// <summary>Parameters can be saved</summary>
|
|
public bool PS;
|
|
/// <summary>Automatic Write Reallocation Enabled</summary>
|
|
public bool AWRE;
|
|
/// <summary>Automatic Read Reallocation Enabled</summary>
|
|
public bool ARRE;
|
|
/// <summary>Transfer block</summary>
|
|
public bool TB;
|
|
/// <summary>Read continuous</summary>
|
|
public bool RC;
|
|
/// <summary>Enable early recovery</summary>
|
|
public bool EER;
|
|
/// <summary>Post error reporting</summary>
|
|
public bool PER;
|
|
/// <summary>Disable transfer on error</summary>
|
|
public bool DTE;
|
|
/// <summary>Disable correction</summary>
|
|
public bool DCR;
|
|
/// <summary>How many times to retry a read operation</summary>
|
|
public byte ReadRetryCount;
|
|
/// <summary>How many bits of largest data burst error is maximum to apply error correction on it</summary>
|
|
public byte CorrectionSpan;
|
|
/// <summary>Offset to move the heads</summary>
|
|
public sbyte HeadOffsetCount;
|
|
/// <summary>Incremental position to which the recovered data strobe shall be adjusted</summary>
|
|
public sbyte DataStrobeOffsetCount;
|
|
/// <summary>How many times to retry a write operation</summary>
|
|
public byte WriteRetryCount;
|
|
/// <summary>Maximum time in ms to use in data error recovery procedures</summary>
|
|
public ushort RecoveryTimeLimit;
|
|
|
|
/// <summary>Logical block provisioning error reporting is enabled</summary>
|
|
public bool LBPERE;
|
|
}
|
|
|
|
public static ModePage_01? DecodeModePage_01(byte[] pageResponse)
|
|
{
|
|
if((pageResponse?[0] & 0x40) == 0x40)
|
|
return null;
|
|
|
|
if((pageResponse?[0] & 0x3F) != 0x01)
|
|
return null;
|
|
|
|
if(pageResponse[1] + 2 != pageResponse.Length)
|
|
return null;
|
|
|
|
if(pageResponse.Length < 8)
|
|
return null;
|
|
|
|
var decoded = new ModePage_01();
|
|
|
|
decoded.PS |= (pageResponse[0] & 0x80) == 0x80;
|
|
decoded.AWRE |= (pageResponse[2] & 0x80) == 0x80;
|
|
decoded.ARRE |= (pageResponse[2] & 0x40) == 0x40;
|
|
decoded.TB |= (pageResponse[2] & 0x20) == 0x20;
|
|
decoded.RC |= (pageResponse[2] & 0x10) == 0x10;
|
|
decoded.EER |= (pageResponse[2] & 0x08) == 0x08;
|
|
decoded.PER |= (pageResponse[2] & 0x04) == 0x04;
|
|
decoded.DTE |= (pageResponse[2] & 0x02) == 0x02;
|
|
decoded.DCR |= (pageResponse[2] & 0x01) == 0x01;
|
|
|
|
decoded.ReadRetryCount = pageResponse[3];
|
|
decoded.CorrectionSpan = pageResponse[4];
|
|
decoded.HeadOffsetCount = (sbyte)pageResponse[5];
|
|
decoded.DataStrobeOffsetCount = (sbyte)pageResponse[6];
|
|
|
|
if(pageResponse.Length < 12)
|
|
return decoded;
|
|
|
|
decoded.WriteRetryCount = pageResponse[8];
|
|
decoded.RecoveryTimeLimit = (ushort)((pageResponse[10] << 8) + pageResponse[11]);
|
|
decoded.LBPERE |= (pageResponse[7] & 0x80) == 0x80;
|
|
|
|
return decoded;
|
|
}
|
|
|
|
public static string PrettifyModePage_01(byte[] pageResponse) =>
|
|
PrettifyModePage_01(DecodeModePage_01(pageResponse));
|
|
|
|
public static string PrettifyModePage_01(ModePage_01? modePage)
|
|
{
|
|
if(!modePage.HasValue)
|
|
return null;
|
|
|
|
ModePage_01 page = modePage.Value;
|
|
var sb = new StringBuilder();
|
|
|
|
sb.AppendLine(Localization.SCSI_Read_write_error_recovery_page);
|
|
|
|
if(page.PS)
|
|
sb.AppendLine("\t" + Localization.Parameters_can_be_saved);
|
|
|
|
if(page.AWRE)
|
|
sb.AppendLine("\t" + Localization.Automatic_write_reallocation_is_enabled);
|
|
|
|
if(page.ARRE)
|
|
sb.AppendLine("\t" + Localization.Automatic_read_reallocation_is_enabled);
|
|
|
|
if(page.TB)
|
|
{
|
|
sb.AppendLine("\t" +
|
|
Localization.
|
|
Data_not_recovered_within_limits_shall_be_transferred_back_before_a_CHECK_CONDITION);
|
|
}
|
|
|
|
if(page.RC)
|
|
{
|
|
sb.AppendLine("\t" +
|
|
Localization.
|
|
Drive_will_transfer_the_entire_requested_length_without_delaying_to_perform_error_recovery);
|
|
}
|
|
|
|
if(page.EER)
|
|
sb.AppendLine("\t" + Localization.Drive_will_use_the_most_expedient_form_of_error_recovery_first);
|
|
|
|
if(page.PER)
|
|
sb.AppendLine("\t" + Localization.Drive_shall_report_recovered_errors);
|
|
|
|
if(page.DTE)
|
|
sb.AppendLine("\t" + Localization.Transfer_will_be_terminated_upon_error_detection);
|
|
|
|
if(page.DCR)
|
|
sb.AppendLine("\t" + Localization.Error_correction_is_disabled);
|
|
|
|
if(page.ReadRetryCount > 0)
|
|
{
|
|
sb.AppendFormat("\t" + Localization.Drive_will_repeat_read_operations_0_times, page.ReadRetryCount).
|
|
AppendLine();
|
|
}
|
|
|
|
if(page.WriteRetryCount > 0)
|
|
{
|
|
sb.AppendFormat("\t" + Localization.Drive_will_repeat_write_operations_0_times, page.WriteRetryCount).
|
|
AppendLine();
|
|
}
|
|
|
|
if(page.RecoveryTimeLimit > 0)
|
|
{
|
|
sb.AppendFormat("\t" + Localization.Drive_will_employ_a_maximum_of_0_ms_to_recover_data,
|
|
page.RecoveryTimeLimit).
|
|
AppendLine();
|
|
}
|
|
|
|
if(page.LBPERE)
|
|
sb.AppendLine(Localization.Logical_block_provisioning_error_reporting_is_enabled);
|
|
|
|
return sb.ToString();
|
|
}
|
|
|
|
#endregion Mode Page 0x01: Read-write error recovery page
|
|
} |