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

using System.Diagnostics.CodeAnalysis;
using Aaru.Decoders.ATA;
using Aaru.Logging;

// ReSharper disable UnusedMember.Global

namespace Aaru.Devices;

[SuppressMessage("ReSharper", "UnusedMethodReturnValue.Global")]
[SuppressMessage("ReSharper", "OutParameterValueIsAlwaysDiscarded.Global")]
public partial class Device
{
    /// <summary>Sends the ATA IDENTIFY 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 AtaIdentify(out byte[] buffer, out AtaErrorRegistersChs statusRegisters) =>
        AtaIdentify(out buffer, out statusRegisters, Timeout);

    /// <summary>Sends the ATA IDENTIFY 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 AtaIdentify(out byte[] buffer, out AtaErrorRegistersChs statusRegisters, out double duration) =>
        AtaIdentify(out buffer, out statusRegisters, Timeout, out duration);

    /// <summary>Sends the ATA IDENTIFY 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 AtaIdentify(out byte[] buffer, out AtaErrorRegistersChs statusRegisters, uint timeout) =>
        AtaIdentify(out buffer, out statusRegisters, timeout, out _);

    /// <summary>Sends the ATA IDENTIFY 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 AtaIdentify(out byte[] buffer, out AtaErrorRegistersChs statusRegisters, uint timeout,
                            out double duration)
    {
        buffer = new byte[512];

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

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

        Error = LastError != 0;

        AaruLogging.Debug(ATA_MODULE_NAME, "IDENTIFY DEVICE took {0} ms.", duration);

        return sense;
    }

    /// <summary>Reads sectors using CHS addressing and DMA transfer, retrying on error</summary>
    /// <param name="buffer">Buffer that contains the read data</param>
    /// <param name="statusRegisters">Returned status registers</param>
    /// <param name="cylinder">Cylinder of read start</param>
    /// <param name="head">Head of read start</param>
    /// <param name="sector">Sector of read start</param>
    /// <param name="count">How many blocks to read, or 0 to indicate 256 blocks</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 ReadDma(out byte[] buffer, out AtaErrorRegistersChs statusRegisters, ushort cylinder, byte head,
                        byte       sector, byte                     count, uint timeout, out double duration) =>
        ReadDma(out buffer, out statusRegisters, true, cylinder, head, sector, count, timeout, out duration);

    /// <summary>Reads sectors using CHS addressing and DMA transfer</summary>
    /// <param name="buffer">Buffer that contains the read data</param>
    /// <param name="statusRegisters">Returned status registers</param>
    /// <param name="retry">Retry on error</param>
    /// <param name="cylinder">Cylinder of read start</param>
    /// <param name="head">Head of read start</param>
    /// <param name="sector">Sector of read start</param>
    /// <param name="count">How many blocks to read, or 0 to indicate 256 blocks</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 ReadDma(out byte[] buffer, out AtaErrorRegistersChs statusRegisters, bool retry, ushort cylinder,
                        byte       head,   byte sector, byte count, uint timeout, out double duration)
    {
        buffer = count == 0 ? new byte[512 * 256] : new byte[512 * count];

        var registers = new AtaRegistersChs
        {
            SectorCount  = count,
            CylinderHigh = (byte)((cylinder & 0xFF00) / 0x100),
            CylinderLow  = (byte)((cylinder & 0xFF)   / 0x1),
            DeviceHead   = (byte)(head & 0x0F),
            Sector       = sector,
            Command      = retry ? (byte)AtaCommands.ReadDmaRetry : (byte)AtaCommands.ReadDma
        };

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

        Error = LastError != 0;

        AaruLogging.Debug(ATA_MODULE_NAME, Localization.READ_DMA_took_0_ms, duration);

        return sense;
    }

    /// <summary>
    ///     Reads sectors using CHS addressing and PIO transfer, sending an interrupt only after all the sectors have been
    ///     transferred
    /// </summary>
    /// <param name="buffer">Buffer that contains the read data</param>
    /// <param name="statusRegisters">Returned status registers</param>
    /// <param name="cylinder">Cylinder of read start</param>
    /// <param name="head">Head of read start</param>
    /// <param name="sector">Sector of read start</param>
    /// <param name="count">How many blocks to read, or 0 to indicate 256 blocks</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 ReadMultiple(out byte[] buffer, out AtaErrorRegistersChs statusRegisters, ushort cylinder, byte head,
                             byte       sector, byte                     count, uint timeout, out double duration)
    {
        buffer = count == 0 ? new byte[512 * 256] : new byte[512 * count];

        var registers = new AtaRegistersChs
        {
            Command      = (byte)AtaCommands.ReadMultiple,
            SectorCount  = count,
            CylinderHigh = (byte)((cylinder & 0xFF00) / 0x100),
            CylinderLow  = (byte)((cylinder & 0xFF)   / 0x1),
            DeviceHead   = (byte)(head & 0x0F),
            Sector       = sector
        };

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

        Error = LastError != 0;

        AaruLogging.Debug(ATA_MODULE_NAME, Localization.READ_MULTIPLE_took_0_ms, duration);

        return sense;
    }

    /// <summary>Reads sectors using CHS addressing and PIO transfer, retrying on error</summary>
    /// <param name="buffer">Buffer that contains the read data</param>
    /// <param name="statusRegisters">Returned status registers</param>
    /// <param name="cylinder">Cylinder of read start</param>
    /// <param name="head">Head of read start</param>
    /// <param name="sector">Sector of read start</param>
    /// <param name="count">How many blocks to read, or 0 to indicate 256 blocks</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 Read(out byte[] buffer, out AtaErrorRegistersChs statusRegisters, ushort cylinder, byte head,
                     byte       sector, byte                     count,           uint timeout, out double duration) =>
        Read(out buffer, out statusRegisters, true, cylinder, head, sector, count, timeout, out duration);

    /// <summary>Reads sectors using CHS addressing and PIO transfer</summary>
    /// <param name="buffer">Buffer that contains the read data</param>
    /// <param name="statusRegisters">Returned status registers</param>
    /// <param name="retry">Retry on error</param>
    /// <param name="cylinder">Cylinder of read start</param>
    /// <param name="head">Head of read start</param>
    /// <param name="sector">Sector of read start</param>
    /// <param name="count">How many blocks to read, or 0 to indicate 256 blocks</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 Read(out byte[] buffer, out AtaErrorRegistersChs statusRegisters, bool retry, ushort cylinder,
                     byte       head,   byte                     sector, byte count, uint timeout, out double duration)
    {
        buffer = count == 0 ? new byte[512 * 256] : new byte[512 * count];

        var registers = new AtaRegistersChs
        {
            Command      = retry ? (byte)AtaCommands.ReadRetry : (byte)AtaCommands.Read,
            SectorCount  = count,
            CylinderHigh = (byte)((cylinder & 0xFF00) / 0x100),
            CylinderLow  = (byte)((cylinder & 0xFF)   / 0x1),
            DeviceHead   = (byte)(head & 0x0F),
            Sector       = sector
        };

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

        Error = LastError != 0;

        AaruLogging.Debug(ATA_MODULE_NAME, Localization.READ_SECTORS_took_0_ms, duration);

        return sense;
    }

    /// <summary>Reads a long sector using CHS addressing and PIO transfer, retrying on error</summary>
    /// <param name="buffer">Buffer that contains the read data</param>
    /// <param name="statusRegisters">Returned status registers</param>
    /// <param name="cylinder">Cylinder of read start</param>
    /// <param name="head">Head of read start</param>
    /// <param name="sector">Sector of read start</param>
    /// <param name="blockSize">Size in bytes of the long sector</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 ReadLong(out byte[] buffer, out AtaErrorRegistersChs statusRegisters, ushort cylinder, byte head,
                         byte       sector, uint                     blockSize, uint timeout, out double duration) =>
        ReadLong(out buffer, out statusRegisters, true, cylinder, head, sector, blockSize, timeout, out duration);

    /// <summary>Reads a long sector using CHS addressing and PIO transfer, retrying on error</summary>
    /// <param name="buffer">Buffer that contains the read data</param>
    /// <param name="statusRegisters">Returned status registers</param>
    /// <param name="retry">Retry on error</param>
    /// <param name="cylinder">Cylinder of read start</param>
    /// <param name="head">Head of read start</param>
    /// <param name="sector">Sector of read start</param>
    /// <param name="blockSize">Size in bytes of the long sector</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 ReadLong(out byte[] buffer, out AtaErrorRegistersChs statusRegisters, bool retry, ushort cylinder,
                         byte       head,   byte sector, uint blockSize, uint timeout, out double duration)
    {
        buffer = new byte[blockSize];

        var registers = new AtaRegistersChs
        {
            Command      = retry ? (byte)AtaCommands.ReadLongRetry : (byte)AtaCommands.ReadLong,
            SectorCount  = 1,
            CylinderHigh = (byte)((cylinder & 0xFF00) / 0x100),
            CylinderLow  = (byte)((cylinder & 0xFF)   / 0x1),
            DeviceHead   = (byte)(head & 0x0F),
            Sector       = sector
        };

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

        Error = LastError != 0;

        AaruLogging.Debug(ATA_MODULE_NAME, Localization.READ_LONG_took_0_ms, duration);

        return sense;
    }

    /// <summary>Sets the reading mechanism ready to read the specified block using CHS addressing</summary>
    /// <param name="statusRegisters">Returned status registers</param>
    /// <param name="cylinder">Cylinder to position reading mechanism ready to read</param>
    /// <param name="head">Head to position reading mechanism ready to read</param>
    /// <param name="sector">Sector to position reading mechanism ready to read</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 Seek(out AtaErrorRegistersChs statusRegisters, ushort cylinder, byte head, byte sector, uint timeout,
                     out double               duration)
    {
        byte[] buffer = [];

        var registers = new AtaRegistersChs
        {
            Command      = (byte)AtaCommands.Seek,
            CylinderHigh = (byte)((cylinder & 0xFF00) / 0x100),
            CylinderLow  = (byte)((cylinder & 0xFF)   / 0x1),
            DeviceHead   = (byte)(head & 0x0F),
            Sector       = sector
        };

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

        Error = LastError != 0;

        AaruLogging.Debug(ATA_MODULE_NAME, Localization.SEEK_took_0_ms, duration);

        return sense;
    }

    /// <summary>Enables drive features</summary>
    /// <param name="statusRegisters">Returned status registers</param>
    /// <param name="feature">Feature to enable</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 SetFeatures(out AtaErrorRegistersChs statusRegisters, AtaFeatures feature, uint timeout,
                            out double               duration) =>
        SetFeatures(out statusRegisters, feature, 0, 0, 0, 0, timeout, out duration);

    /// <summary>Enables drive features</summary>
    /// <param name="statusRegisters">Returned status registers</param>
    /// <param name="feature">Feature to enable</param>
    /// <param name="cylinder">Value for the cylinder register</param>
    /// <param name="head">Value for the head register</param>
    /// <param name="sector">Value for the sector register</param>
    /// <param name="sectorCount">Value for the sector count register</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 SetFeatures(out AtaErrorRegistersChs statusRegisters, AtaFeatures feature, ushort cylinder, byte head,
                            byte                     sector, byte sectorCount, uint timeout, out double duration)
    {
        byte[] buffer = [];

        var registers = new AtaRegistersChs
        {
            Command      = (byte)AtaCommands.SetFeatures,
            CylinderHigh = (byte)((cylinder & 0xFF00) / 0x100),
            CylinderLow  = (byte)((cylinder & 0xFF)   / 0x1),
            DeviceHead   = (byte)(head & 0x0F),
            Sector       = sector,
            SectorCount  = sectorCount,
            Feature      = (byte)feature
        };

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

        Error = LastError != 0;

        AaruLogging.Debug(ATA_MODULE_NAME, Localization.SET_FEATURES_took_0_ms, duration);

        return sense;
    }

    /// <summary>Prevents ejection of the media inserted in the drive</summary>
    /// <param name="statusRegisters">Returned status registers</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 DoorLock(out AtaErrorRegistersChs statusRegisters, uint timeout, out double duration)
    {
        byte[] buffer = [];

        var registers = new AtaRegistersChs
        {
            Command = (byte)AtaCommands.DoorLock
        };

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

        Error = LastError != 0;

        AaruLogging.Debug(ATA_MODULE_NAME, Localization.DOOR_LOCK_took_0_ms, duration);

        return sense;
    }

    /// <summary>Allows ejection of the media inserted in the drive</summary>
    /// <param name="statusRegisters">Returned status registers</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 DoorUnlock(out AtaErrorRegistersChs statusRegisters, uint timeout, out double duration)
    {
        byte[] buffer = [];

        var registers = new AtaRegistersChs
        {
            Command = (byte)AtaCommands.DoorUnLock
        };

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

        Error = LastError != 0;

        AaruLogging.Debug(ATA_MODULE_NAME, Localization.DOOR_UNLOCK_took_0_ms, duration);

        return sense;
    }

    /// <summary>Ejects the media inserted in the drive</summary>
    /// <param name="statusRegisters">Returned status registers</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 MediaEject(out AtaErrorRegistersChs statusRegisters, uint timeout, out double duration)
    {
        byte[] buffer = [];

        var registers = new AtaRegistersChs
        {
            Command = (byte)AtaCommands.MediaEject
        };

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

        Error = LastError != 0;

        AaruLogging.Debug(ATA_MODULE_NAME, Localization.MEDIA_EJECT_took_0_ms, duration);

        return sense;
    }
}