// /***************************************************************************
// The Disc Image Chef
// ----------------------------------------------------------------------------
//
// Filename       : Adaptec.cs
// Author(s)      : Natalia Portillo <claunia@claunia.com>
//
// Component      : Adaptec vendor commands.
//
// --[ Description ] ----------------------------------------------------------
//
//     Contains vendor commands for Adaptec ACB-4000A and
//     ACB-4070 ST-506 to SCSI controllers.
//
// --[ 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-2017 Natalia Portillo
// ****************************************************************************/

using System;
using DiscImageChef.Console;

namespace DiscImageChef.Devices
{
    public partial class Device
    {
        /// <summary>
        /// Sets the drive to the xtreme unlocked state
        /// </summary>
        /// <returns><c>true</c> if the command failed and <paramref name="senseBuffer"/> contains the sense buffer.</returns>
        /// <param name="senseBuffer">Sense buffer.</param>
        /// <param name="timeout">Timeout.</param>
        /// <param name="duration">Duration.</param>
        public bool KreonDeprecatedUnlock(out byte[] senseBuffer, uint timeout, out double duration)
        {
            senseBuffer = new byte[32];
            byte[] cdb = new byte[6];
            byte[] buffer = new byte[0];
            bool sense;

            cdb[0] = (byte)ScsiCommands.Kreon_Command;
            cdb[1] = 0x08;
            cdb[2] = 0x01;
            cdb[3] = 0x01;

            lastError = SendScsiCommand(cdb, ref buffer, out senseBuffer, timeout, ScsiDirection.None, out duration, out sense);
            error = lastError != 0;

            DicConsole.DebugWriteLine("SCSI Device", "KREON DEPRECATED UNLOCK took {0} ms.", duration);

            return sense;
        }

        /// <summary>
        /// Sets the drive to the locked state.
        /// </summary>
        /// <returns><c>true</c> if the command failed and <paramref name="senseBuffer"/> contains the sense buffer.</returns>
        /// <param name="senseBuffer">Sense buffer.</param>
        /// <param name="timeout">Timeout.</param>
        /// <param name="duration">Duration.</param>
        public bool KreonLock(out byte[] senseBuffer, uint timeout, out double duration)
        {
            return KreonSetLockState(out senseBuffer, KreonLockStates.Locked, timeout, out duration);
        }

        /// <summary>
        /// Sets the drive to the xtreme unlocked state
        /// </summary>
        /// <returns><c>true</c> if the command failed and <paramref name="senseBuffer"/> contains the sense buffer.</returns>
        /// <param name="senseBuffer">Sense buffer.</param>
        /// <param name="timeout">Timeout.</param>
        /// <param name="duration">Duration.</param>
        public bool KreonUnlockXtreme(out byte[] senseBuffer, uint timeout, out double duration)
        {
            return KreonSetLockState(out senseBuffer, KreonLockStates.Xtreme, timeout, out duration);
        }

        /// <summary>
        /// Sets the drive to the wxripper unlocked state
        /// </summary>
        /// <returns><c>true</c> if the command failed and <paramref name="senseBuffer"/> contains the sense buffer.</returns>
        /// <param name="senseBuffer">Sense buffer.</param>
        /// <param name="timeout">Timeout.</param>
        /// <param name="duration">Duration.</param>
        public bool KreonUnlockWxripper(out byte[] senseBuffer, uint timeout, out double duration)
        {
            return KreonSetLockState(out senseBuffer, KreonLockStates.Wxripper, timeout, out duration);
        }

        /// <summary>
        /// Sets the drive to the specified lock state
        /// </summary>
        /// <returns><c>true</c> if the command failed and <paramref name="senseBuffer"/> contains the sense buffer.</returns>
        /// <param name="senseBuffer">Sense buffer.</param>
        /// <param name="timeout">Timeout.</param>
        /// <param name="duration">Duration.</param>
        /// <param name="state">Lock state</param>
        public bool KreonSetLockState(out byte[] senseBuffer, KreonLockStates state, uint timeout, out double duration)
        {
            senseBuffer = new byte[32];
            byte[] cdb = new byte[6];
            byte[] buffer = new byte[0];
            bool sense;

            cdb[0] = (byte)ScsiCommands.Kreon_Command;
            cdb[1] = 0x08;
            cdb[2] = 0x01;
            cdb[3] = 0x11;
            cdb[4] = (byte)state;

            lastError = SendScsiCommand(cdb, ref buffer, out senseBuffer, timeout, ScsiDirection.None, out duration, out sense);
            error = lastError != 0;

            DicConsole.DebugWriteLine("SCSI Device", "KREON SET LOCK STATE took {0} ms.", duration);

            return sense;
        }

        /// <summary>
        /// Gets a list of supported features
        /// </summary>
        /// <returns><c>true</c> if the command failed and <paramref name="senseBuffer"/> contains the sense buffer.</returns>
        /// <param name="senseBuffer">Sense buffer.</param>
        /// <param name="timeout">Timeout.</param>
        /// <param name="duration">Duration.</param>
        /// <param name="features">Features supported by drive.</param>
        public bool KreonGetFeatureList(out byte[] senseBuffer, out KreonFeatures features, uint timeout, out double duration)
        {
            senseBuffer = new byte[32];
            byte[] cdb = new byte[6];
            byte[] buffer = new byte[26];
            bool sense;
            features = 0;

            cdb[0] = (byte)ScsiCommands.Kreon_Command;
            cdb[1] = 0x08;
            cdb[2] = 0x01;
            cdb[3] = 0x10;

            lastError = SendScsiCommand(cdb, ref buffer, out senseBuffer, timeout, ScsiDirection.In, out duration, out sense);
            error = lastError != 0;

            DicConsole.DebugWriteLine("SCSI Device", "KREON GET FEATURE LIST took {0} ms.", duration);

            if(sense)
                return sense;

            if(buffer[0] != 0xA5 || buffer[1] != 0x5A || buffer[2] != 0x5A || buffer[3] != 0xA5)
                return true;

            for(int i = 4; i < 26; i += 2)
            {
                ushort feature = BitConverter.ToUInt16(buffer, i);

                if(feature == 0x0000)
                    break;

                switch(feature)
                {
                    case 0x0001:
                        features |= KreonFeatures.XtremeUnlock360;
                        break;
                    case 0x0101:
                        features |= KreonFeatures.WxripperUnlock360;
                        break;
                    case 0x2001:
                        features |= KreonFeatures.DecryptSS360;
                        break;
                    case 0x2101:
                        features |= KreonFeatures.ChallengeResponse360;
                        break;
                    case 0x0002:
                        features |= KreonFeatures.XtremeUnlock;
                        break;
                    case 0x0102:
                        features |= KreonFeatures.WxripperUnlock;
                        break;
                    case 0x2002:
                        features |= KreonFeatures.DecryptSS;
                        break;
                    case 0x2102:
                        features |= KreonFeatures.ChallengeResponse;
                        break;
                    case 0x00F0:
                        features |= KreonFeatures.Lock;
                        break;
                    case 0x01F0:
                        features |= KreonFeatures.ErrorSkipping;
                        break;
                }
            }

            return false;
        }

        /// <summary>
        /// Gets the SS sector.
        /// </summary>
        /// <returns><c>true</c> if the command failed and <paramref name="senseBuffer"/> contains the sense buffer.</returns>
        /// <param name="senseBuffer">Sense buffer.</param>
        /// <param name="timeout">Timeout.</param>
        /// <param name="duration">Duration.</param>
        /// <param name="buffer">The SS sector.</param>
        public bool KreonExtractSS(out byte[] buffer, out byte[] senseBuffer, uint timeout, out double duration)
        {
            buffer = new byte[2048];
            byte[] cdb = new byte[12];
            senseBuffer = new byte[32];
            bool sense;

            cdb[0] = (byte)ScsiCommands.Kreon_SS_Command;
            cdb[1] = 0x00;
            cdb[2] = 0xFF;
            cdb[3] = 0x02;
            cdb[4] = 0xFD;
            cdb[5] = 0xFF;
            cdb[6] = 0xFE;
            cdb[7] = 0x00;
            cdb[8] = 0x08;
            cdb[9] = 0x00;
            // TODO: Documentation puts this as xx but doesn't say what is the meaning.
            cdb[10] = 0x00;
            cdb[11] = 0xC0;

            lastError = SendScsiCommand(cdb, ref buffer, out senseBuffer, timeout, ScsiDirection.In, out duration, out sense);
            error = lastError != 0;

            DicConsole.DebugWriteLine("SCSI Device", "KREON EXTRACT SS took {0} ms.", duration);

            return sense;
        }
    }
}