// /***************************************************************************
// The Disc Image Chef
// ----------------------------------------------------------------------------
//
// Filename       : Plasmon.cs
// Author(s)      : Natalia Portillo <claunia@claunia.com>
//
// Component      : Plasmon vendor commands.
//
// --[ Description ] ----------------------------------------------------------
//
//     Contains vendor commands for Plasmon 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-2018 Natalia Portillo
// ****************************************************************************/

using DiscImageChef.Console;

namespace DiscImageChef.Devices
{
    public partial class Device
    {
        /// <summary>
        ///     Sends the Plasmon READ LONG vendor command
        /// </summary>
        /// <returns><c>true</c> if the command failed and <paramref name="senseBuffer" /> contains the sense buffer.</returns>
        /// <param name="buffer">Buffer where the Plasmon READ LONG response will be stored</param>
        /// <param name="senseBuffer">Sense buffer.</param>
        /// <param name="relAddr">If set to <c>true</c> address contain two's complement offset from last read address.</param>
        /// <param name="address">PBA/LBA to read.</param>
        /// <param name="blockBytes">How many bytes per block.</param>
        /// <param name="pba">If set to <c>true</c> address contain physical block address.</param>
        /// <param name="timeout">Timeout in seconds.</param>
        /// <param name="duration">Duration in milliseconds it took for the device to execute the command.</param>
        public bool PlasmonReadLong(out byte[] buffer,     out byte[] senseBuffer, bool relAddr, uint       address,
                                    ushort     blockBytes, bool       pba,         uint timeout, out double duration)
        {
            return HpReadLong(out buffer, out senseBuffer, relAddr, address, 0, blockBytes, pba, false, timeout,
                              out duration);
        }

        /// <summary>
        ///     Sends the Plasmon READ LONG vendor command
        /// </summary>
        /// <returns><c>true</c> if the command failed and <paramref name="senseBuffer" /> contains the sense buffer.</returns>
        /// <param name="buffer">Buffer where the Plasmon READ LONG response will be stored</param>
        /// <param name="senseBuffer">Sense buffer.</param>
        /// <param name="relAddr">If set to <c>true</c> address contain two's complement offset from last read address.</param>
        /// <param name="address">PBA/LBA to read.</param>
        /// <param name="transferLen">How many blocks/bytes to read.</param>
        /// <param name="blockBytes">How many bytes per block.</param>
        /// <param name="pba">If set to <c>true</c> address contain physical block address.</param>
        /// <param name="sectorCount">
        ///     If set to <c>true</c> <paramref name="transferLen" /> is a count of secors to read. Otherwise
        ///     it will be ignored
        /// </param>
        /// <param name="timeout">Timeout in seconds.</param>
        /// <param name="duration">Duration in milliseconds it took for the device to execute the command.</param>
        public bool PlasmonReadLong(out byte[] buffer,      out byte[] senseBuffer, bool relAddr, uint address,
                                    ushort     transferLen, ushort     blockBytes,  bool pba,     bool sectorCount,
                                    uint       timeout,
                                    out double duration)
        {
            return HpReadLong(out buffer, out senseBuffer, relAddr, address, transferLen, blockBytes, pba, sectorCount,
                              timeout,    out duration);
        }

        /// <summary>
        ///     Retrieves the logical or physical block address for the specified <paramref name="address" />
        /// </summary>
        /// <returns><c>true</c> if the command failed and <paramref name="senseBuffer" /> contains the sense buffer.</returns>
        /// <param name="buffer">Buffer where the block address will be stored</param>
        /// <param name="senseBuffer">Sense buffer.</param>
        /// <param name="address">PBA/LBA to read.</param>
        /// <param name="pba">If set to <c>true</c> address contain a physical block address.</param>
        /// <param name="timeout">Timeout in seconds.</param>
        /// <param name="duration">Duration in milliseconds it took for the device to execute the command.</param>
        public bool PlasmonReadSectorLocation(out byte[] buffer,  out byte[] senseBuffer, uint address, bool pba,
                                              uint       timeout, out double duration)
        {
            senseBuffer = new byte[32];
            byte[] cdb = new byte[10];

            cdb[0] = (byte)ScsiCommands.PlasmonReadSectorLocation;
            cdb[2] = (byte)((address & 0xFF000000) >> 24);
            cdb[3] = (byte)((address & 0xFF0000)   >> 16);
            cdb[4] = (byte)((address & 0xFF00)     >> 8);
            cdb[5] = (byte)(address & 0xFF);
            if(pba) cdb[9] += 0x80;

            buffer = new byte[8];

            LastError = SendScsiCommand(cdb, ref buffer, out senseBuffer, timeout, ScsiDirection.In, out duration,
                                        out bool sense);
            Error = LastError != 0;

            DicConsole.DebugWriteLine("SCSI Device", "PLASMON READ SECTOR LOCATION took {0} ms.", duration);

            return sense;
        }
    }
}