Aaru/Aaru.Devices/Device/AtaCommands/Atapi.cs

// /***************************************************************************
// Aaru Data Preservation Suite
// ----------------------------------------------------------------------------
//
// Filename       : Atapi.cs
// Author(s)      : Natalia Portillo <claunia@claunia.com>
//
// Component      : ATA commands.
//
// --[ Description ] ----------------------------------------------------------
//
//     Contains ATAPI commands.
//
// --[ 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 Aaru.Console;
using Aaru.Decoders.ATA;

namespace Aaru.Devices;

public partial class Device
{
    /// <summary>Sends the ATA IDENTIFY PACKET DEVICE command to the device, using default device timeout</summary>
    /// <returns><c>true</c> if the command failed and <paramref name="statusRegisters" /> contains the error registers.</returns>
    /// <param name="buffer">Buffer.</param>
    /// <param name="statusRegisters">Status registers.</param>
    public bool AtapiIdentify(out byte[] buffer, out AtaErrorRegistersChs statusRegisters) =>
        AtapiIdentify(out buffer, out statusRegisters, Timeout);

    /// <summary>Sends the ATA IDENTIFY PACKET DEVICE command to the device, using default device timeout</summary>
    /// <returns><c>true</c> if the command failed and <paramref name="statusRegisters" /> contains the error registers.</returns>
    /// <param name="buffer">Buffer.</param>
    /// <param name="statusRegisters">Status registers.</param>
    /// <param name="duration">Duration.</param>
    public bool AtapiIdentify(out byte[] buffer, out AtaErrorRegistersChs statusRegisters, out double duration) =>
        AtapiIdentify(out buffer, out statusRegisters, Timeout, out duration);

    /// <summary>Sends the ATA IDENTIFY PACKET DEVICE command to the device</summary>
    /// <returns><c>true</c> if the command failed and <paramref name="statusRegisters" /> contains the error registers.</returns>
    /// <param name="buffer">Buffer.</param>
    /// <param name="statusRegisters">Status registers.</param>
    /// <param name="timeout">Timeout.</param>
    public bool AtapiIdentify(out byte[] buffer, out AtaErrorRegistersChs statusRegisters, uint timeout) =>
        AtapiIdentify(out buffer, out statusRegisters, timeout, out _);

    /// <summary>Sends the ATA IDENTIFY PACKET DEVICE command to the device</summary>
    /// <returns><c>true</c> if the command failed and <paramref name="statusRegisters" /> contains the error registers.</returns>
    /// <param name="buffer">Buffer.</param>
    /// <param name="statusRegisters">Status registers.</param>
    /// <param name="timeout">Timeout.</param>
    /// <param name="duration">Duration.</param>
    public bool AtapiIdentify(out byte[] buffer, out AtaErrorRegistersChs statusRegisters, uint timeout,
                              out double duration)
    {
        buffer = new byte[512];

        var registers = new AtaRegistersChs
        {
            Command = (byte)AtaCommands.IdentifyPacketDevice,
            Sector  = 1
        };

        LastError = SendAtaCommand(registers,  out statusRegisters, AtaProtocol.PioIn, AtaTransferRegister.SectorCount,
                                   ref buffer, timeout,             true,              out duration, out bool sense);

        Error = LastError != 0;

        AaruConsole.DebugWriteLine(ATA_MODULE_NAME, Localization.IDENTIFY_PACKET_DEVICE_took_0_ms, duration);

        return sense;
    }
}