Aaru/Aaru.Devices/Device/ScsiCommands/Fujitsu.cs

// /***************************************************************************
// Aaru Data Preservation Suite
// ----------------------------------------------------------------------------
//
// Filename       : Fujitsu.cs
// Author(s)      : Natalia Portillo <claunia@claunia.com>
//
// Component      : Fujitsu vendor commands.
//
// --[ Description ] ----------------------------------------------------------
//
//     Contains vendor commands for Fujitsu SCSI devices.
//
// --[ 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-2025 Natalia Portillo
// ****************************************************************************/

using System;
using System.Text;
using Aaru.Helpers;
using Aaru.Logging;

namespace Aaru.Devices;

public partial class Device
{
    /// <summary>Sets the data for the integrated display</summary>
    /// <param name="senseBuffer">Returned SENSE buffer</param>
    /// <param name="flash">If the display should start flashing</param>
    /// <param name="mode">Display mode</param>
    /// <param name="firstHalf">String to be shown in the first line of the display</param>
    /// <param name="secondHalf">String to be shown in the second line of the display</param>
    /// <param name="timeout">Timeout to wait for command execution</param>
    /// <param name="duration">Time the device took to execute the command in milliseconds</param>
    /// <returns><c>true</c> if the device set an error condition, <c>false</c> otherwise</returns>
    public bool FujitsuDisplay(out ReadOnlySpan<byte> senseBuffer, bool   flash,      FujitsuDisplayModes mode,
                               string                 firstHalf,   string secondHalf, uint timeout, out double duration)
    {
        byte[]     tmp;
        var        firstHalfBytes  = new byte[8];
        var        secondHalfBytes = new byte[8];
        var        buffer          = new byte[17];
        var        displayLen      = false;
        var        halfMsg         = false;
        Span<byte> cdb             = CdbBuffer[..10];
        senseBuffer = SenseBuffer;
        cdb.Clear();

        if(!string.IsNullOrWhiteSpace(firstHalf))
        {
            tmp = Encoding.ASCII.GetBytes(firstHalf);
            Array.Copy(tmp, 0, firstHalfBytes, 0, 8);
        }

        if(!string.IsNullOrWhiteSpace(secondHalf))
        {
            tmp = Encoding.ASCII.GetBytes(secondHalf);
            Array.Copy(tmp, 0, secondHalfBytes, 0, 8);
        }

        if(mode != FujitsuDisplayModes.Half)
        {
            if(!ArrayHelpers.ArrayIsNullOrWhiteSpace(firstHalfBytes) &&
               !ArrayHelpers.ArrayIsNullOrWhiteSpace(secondHalfBytes))
                displayLen = true;
            else if(!ArrayHelpers.ArrayIsNullOrWhiteSpace(firstHalfBytes) &&
                    ArrayHelpers.ArrayIsNullOrWhiteSpace(secondHalfBytes))
                halfMsg = true;
        }

        buffer[0] = (byte)((byte)mode << 5);

        if(displayLen) buffer[0] += 0x10;

        if(flash) buffer[0] += 0x08;

        if(halfMsg) buffer[0] += 0x04;

        buffer[0] += 0x01; // Always ASCII

        Array.Copy(firstHalfBytes,  0, buffer, 1, 8);
        Array.Copy(secondHalfBytes, 0, buffer, 9, 8);

        cdb[0] = (byte)ScsiCommands.FujitsuDisplay;
        cdb[6] = (byte)buffer.Length;

        LastError = SendScsiCommand(cdb, ref buffer, timeout, ScsiDirection.Out, out duration, out bool sense);

        Error = LastError != 0;

        AaruLogging.Debug(SCSI_MODULE_NAME, Localization.FUJITSU_DISPLAY_took_0_ms, duration);

        return sense;
    }
}