Aaru/SCSI/Modes/22_Certance.cs

// /***************************************************************************
// Aaru Data Preservation Suite
// ----------------------------------------------------------------------------
//
// Filename       : 22_Certance.cs
// Author(s)      : Natalia Portillo <claunia@claunia.com>
//
// Component      : Device structures decoders.
//
// --[ Description ] ----------------------------------------------------------
//
//     Decodes Certance MODE PAGE 22h: Interface Control Mode 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"), SuppressMessage("ReSharper", "NotAccessedField.Global")]
public static partial class Modes
{
    #region Certance Mode Page 0x22: Interface Control Mode Page
    public struct Certance_ModePage_22
    {
        /// <summary>Parameters can be saved</summary>
        public bool PS;
        public byte BaudRate;
        public byte CmdFwd;
        public bool StopBits;
        public byte Alerts;
        public byte PortATransportType;
        public byte PortAPresentSelectionID;
        public byte NextSelectionID;
        public byte JumperedSelectionID;
        public byte TargetInitiatedBusControl;
        public bool PortAEnabled;
        public bool PortAEnabledOnPower;
    }

    public static Certance_ModePage_22? DecodeCertanceModePage_22(byte[] pageResponse)
    {
        if((pageResponse?[0] & 0x40) == 0x40)
            return null;

        if((pageResponse?[0] & 0x3F) != 0x22)
            return null;

        if(pageResponse[1] + 2 != pageResponse.Length)
            return null;

        if(pageResponse.Length != 16)
            return null;

        var decoded = new Certance_ModePage_22();

        decoded.PS                        |= (pageResponse[0] & 0x80) == 0x80;
        decoded.BaudRate                  =  pageResponse[2];
        decoded.CmdFwd                    =  (byte)((pageResponse[3] & 0x18) >> 3);
        decoded.StopBits                  |= (pageResponse[3]       & 0x04) == 0x04;
        decoded.CmdFwd                    =  (byte)(pageResponse[3] & 0x03);
        decoded.PortATransportType        =  pageResponse[4];
        decoded.PortAPresentSelectionID   =  pageResponse[7];
        decoded.NextSelectionID           =  pageResponse[12];
        decoded.JumperedSelectionID       =  pageResponse[13];
        decoded.TargetInitiatedBusControl =  pageResponse[14];
        decoded.PortAEnabled              |= (pageResponse[15] & 0x10) == 0x10;
        decoded.PortAEnabledOnPower       |= (pageResponse[15] & 0x04) == 0x04;

        return decoded;
    }

    public static string PrettifyCertanceModePage_22(byte[] pageResponse) =>
        PrettifyCertanceModePage_22(DecodeCertanceModePage_22(pageResponse));

    public static string PrettifyCertanceModePage_22(Certance_ModePage_22? modePage)
    {
        if(!modePage.HasValue)
            return null;

        Certance_ModePage_22 page = modePage.Value;
        var                  sb   = new StringBuilder();

        sb.AppendLine(Localization.Certance_Interface_Control_Mode_Page);

        if(page.PS)
            sb.AppendLine("\t" + Localization.Parameters_can_be_saved);

        switch(page.BaudRate)
        {
            case 0:
            case 1:
            case 2:
                sb.AppendLine("\t" + Localization.Library_interface_will_operate_at_9600_baud_on_next_reset);

                break;
            case 3:
                sb.AppendLine("\t" + Localization.Library_interface_will_operate_at_19200_baud_on_next_reset);

                break;
            case 4:
                sb.AppendLine("\t" + Localization.Library_interface_will_operate_at_38400_baud_on_next_reset);

                break;
            case 5:
                sb.AppendLine("\t" + Localization.Library_interface_will_operate_at_57600_baud_on_next_reset);

                break;
            case 6:
                sb.AppendLine("\t" + Localization.Library_interface_will_operate_at_115200_baud_on_next_reset);

                break;
            default:
                sb.AppendFormat("\t" + Localization.Unknown_library_interface_baud_rate_code_0, page.BaudRate).
                   AppendLine();

                break;
        }

        sb.AppendLine(page.StopBits ? Localization.Library_interface_transmits_2_stop_bits_per_byte
                          : Localization.Library_interface_transmits_1_stop_bits_per_byte);

        switch(page.CmdFwd)
        {
            case 0:
                sb.AppendLine("\t" + Localization.Command_forwarding_is_disabled);

                break;
            case 1:
                sb.AppendLine("\t" + Localization.Command_forwarding_is_enabled);

                break;
            default:
                sb.AppendFormat("\t" + Localization.Unknown_command_forwarding_code_0, page.CmdFwd).AppendLine();

                break;
        }

        switch(page.PortATransportType)
        {
            case 0:
                sb.AppendLine("\t" + Localization.Port_A_link_is_down);

                break;
            case 3:
                sb.AppendLine("\t" + Localization.Port_A_uses_Parallel_SCSI_Ultra160_interface);

                break;
            default:
                sb.AppendFormat("\t" + Localization.Unknown_port_A_transport_type_code_0, page.PortATransportType).
                   AppendLine();

                break;
        }

        if(page.PortATransportType > 0)
            sb.AppendFormat("\t" + Localization.Drive_responds_to_SCSI_ID_0, page.PortAPresentSelectionID).AppendLine();

        sb.AppendFormat("\t" + Localization.Drive_will_respond_to_SCSI_ID_0_on_Port_A_enabling, page.NextSelectionID).
           AppendLine();

        sb.AppendFormat("\t" + Localization.Drive_jumpers_choose_SCSI_ID_0, page.JumperedSelectionID).AppendLine();

        sb.AppendLine(page.PortAEnabled ? "\t" + Localization.SCSI_port_is_enabled
                          : "\t"               + Localization.SCSI_port_is_disabled);

        sb.AppendLine(page.PortAEnabledOnPower ? "\t" + Localization.SCSI_port_will_be_enabled_on_next_power_up
                          : "\t"                      + Localization.SCSI_port_will_be_disabled_on_next_power_up);

        return sb.ToString();
    }
    #endregion Certance Mode Page 0x22: Interface Control Mode Page
}