//-----------------------------------------------------------------------
// <copyright file="Protocols.cs" company="bedug.com">
//     Copyright © 2012 Nils Hammar. All rights reserved.
// </copyright>
//-----------------------------------------------------------------------
/*
 * Software to access vehicle information via the OBD-II connector.
 * 
 * Copyright © 2012 Nils Hammar
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * This program 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 General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 * 
 * Alternative licensing is possible, see the licensing document.
 * 
 * The above text may not be removed or modified.
 */

namespace SharedObjects.Protocol
{
    using System.Collections.Generic;

    /// <summary>
    /// The supported protocols as defined by the J2534 API.
    /// </summary>
    public class Protocols
    {
        /* Protocol ID:s.  */

        /// <summary>
        /// Protocol AT Commands over Serial Connection.
        /// </summary>
        public const int SERIAL_SIMPLE = -3;

        /// <summary>
        /// Protocol AT Commands over Serial Connection.
        /// </summary>
        public const int SERIAL_AT_ELM = -2;

        /// <summary>
        /// Protocol AT Commands over Serial Connection.
        /// </summary>
        public const int SERIAL_AT_AGV = -1;

        /// <summary>
        /// Protocol J1850VPW.
        /// </summary>
        public const int J1850VPW = 1;

        /// <summary>
        /// Protocol J1850PWM.
        /// </summary>
        public const int J1850PWM = 2;

        /// <summary>
        /// Protocol ISO9141.
        /// </summary>
        public const int ISO9141 = 3;

        /// <summary>
        /// Protocol ISO14230 (KWP2000).
        /// </summary>
        public const int ISO14230 = 4;

        /// <summary>
        /// Protocol CAN.
        /// </summary>
        public const int CAN = 5;

        /// <summary>
        /// Protocol ISO15765.
        /// </summary>
        public const int ISO15765 = 6;

        /// <summary>
        /// Protocol SCI_A_ENGINE.
        /// </summary>
        public const int SCI_A_ENGINE = 7;

        /// <summary>
        /// Protocol SCI_A_TRANS.
        /// </summary>
        public const int SCI_A_TRANS = 8;

        /// <summary>
        /// Protocol SCI_B_ENGINE.
        /// </summary>
        public const int SCI_B_ENGINE = 9;

        /// <summary>
        /// Protocol SCI_B_TRANS.
        /// </summary>
        public const int SCI_B_TRANS = 10;

        /* Protocol Families */

        /// <summary>
        /// Protocol Family SERIAL.
        /// </summary>
        public const int SERIAL = -1;

        /// <summary>
        /// Protocol Family VPW_PWM.
        /// </summary>
        public const int VPW_PWM = 1;

        /// <summary>
        /// Protocol Family KL_LINE.
        /// </summary>
        public const int KL_LINE = 2;

        /// <summary>
        /// Protocol Family CANBUS.
        /// </summary>
        public const int CANBUS = 3;

        /// <summary>
        /// List of generic addresses to use if no ECU:s or addresses are declared.
        /// <para>
        /// Notice: Not used for ISO15765 11-bit.
        /// </para>
        /// </summary>
        public static readonly uint[] genericAddressList =
        {
            0x10,
            0x11,
            0x17,
            0x18,
            0x1a,
            0x1f
        };

        /// <summary>
        /// Address bit declaration alternatives.
        /// </summary>
        public static readonly AddressData[] addrISO15765 =
        {
            new AddressData(11, "0x07df Broadcast", "0x07e0", "0x07e8", 0x00, new uint[]{0x00}),
            new AddressData(29, "0x18db3300 Broadcast", "0x18da0000", "0x18da0000", 0x100, new uint[]{0xf1, 0xf2, 0xf0, 0xf3, 0xf4, 0xf5, 0xf6, 0xf7, 0xf8, 0xf9, 0xfa, 0xfb, 0xfc, 0xfd, 0xfe, 0xff}),
        };

        /// <summary>
        /// Address bit declaration alternatives.
        /// </summary>
        public static readonly AddressData[] addrISO9141 =
        {
            new AddressData(8, "0x6a Broadcast", "0x6a", "0xf1", 0x00, new uint[]{0x00})
        };

        /// <summary>
        /// Address bit declaration alternatives.
        /// </summary>
        public static readonly AddressData[] addrISO14230 =
        {
            new AddressData(8, "0x33 Broadcast", "0x33", "0xf1", 0x00, new uint[]{0x00})
        };
        
        /// <summary>
        /// Declare the IDs of the protocols to scan when trying to detect protocol.
        /// <para>
        /// Notice that the order matters.
        /// </para>
        /// </summary>
        public static readonly int[] protocolScanOrder = new int[]
        {
            ISO15765,
            ISO14230,
            ISO9141,
            J1850PWM,
            J1850VPW,
            SERIAL_AT_ELM,
            SERIAL_AT_AGV,
            CAN,
        };

        /// <summary>
        /// Array of protocols.
        /// </summary>
        public static readonly Protocols[] protocols = new Protocols[]
        {
            new Protocols(SERIAL_SIMPLE, "SERIAL_SIMPLE", new int[]{SERIAL}, null, false, false, 1000),
            new Protocols(SERIAL_AT_ELM, "SERIAL_AT_ELM", new int[]{SERIAL}, null, false, false, 1000),
            new Protocols(SERIAL_AT_AGV, "SERIAL_AT_AGV", new int[]{SERIAL}, null, false, false, 1000),
            new Protocols(J1850VPW, "J1850VPW", new int[]{VPW_PWM}, null, false, true, 1000),
            new Protocols(J1850PWM, "J1850PWM", new int[]{VPW_PWM}, null, false, true, 1000),
            new Protocols(ISO9141, "ISO9141", new int[]{KL_LINE}, addrISO9141, false, true, 4000),
            new Protocols(ISO14230, "ISO14230 (KWP2000)", new int[]{KL_LINE}, addrISO14230, false, true, 4000),
            new Protocols(CAN, "CAN", new int[]{CANBUS}, null, true, true, 100),
            new Protocols(ISO15765, "ISO15765", new int[]{CANBUS}, addrISO15765, true, true, 100),
            new Protocols(SCI_A_ENGINE, "SCI_A_ENGINE", new int[]{KL_LINE, CANBUS}, null, false, false, 1000),
            new Protocols(SCI_A_TRANS, "SCI_A_TRANS", new int[]{KL_LINE, CANBUS}, null, false, false, 1000),
            new Protocols(SCI_B_ENGINE, "SCI_B_ENGINE", new int[]{KL_LINE, CANBUS}, null, false, false, 1000),
            new Protocols(SCI_B_TRANS, "SCI_B_TRANS", new int[]{KL_LINE, CANBUS}, null, false, false, 1000)
        };

        /// <summary>
        /// Gets Protocol ID.
        /// </summary>
        public int id { get; private set; }

        /// <summary>
        /// Gets Protocol Name.
        /// </summary>
        public string name { get; private set; }

        /// <summary>
        /// Gets a value indicating whether asynchronous calls can be made.
        /// <para>
        /// This indicates that the protocol allows for asynchronous
        /// calls, but it depends on the vehicle if they can be successful.
        /// </para>
        /// </summary>
        public bool isAsync { get; private set; }

        /// <summary>
        /// Gets a value indicating whether Protocol is possible to detect using auto-detect mechanism.
        /// </summary>
        public bool canDetect { get; private set; }

        /// <summary>
        /// List of possible address bits alternatives.
        /// </summary>
        private List<AddressData> addrDataList = new List<AddressData>();

        /// <summary>
        /// Gets Address Bits alternatives where applicable.
        /// </summary>
        public IList<AddressData> addressDataList
        {
            get
            {
                return this.addrDataList;
            }
        }

        /// <summary>
        /// List of protocol families.
        /// </summary>
        private List<int> familyList = new List<int>();

        /// <summary>
        /// Gets Protocol Family.
        /// </summary>
        public IList<int> families
        {
            get
            {
                return this.familyList;
            }
        }

        /// <summary>
        /// Gets timeout waiting for response.
        /// </summary>
        public int timeout { get; private set; }

        /// <summary>
        /// Initializes a new instance of the <see cref="Protocols" /> class.
        /// </summary>
        /// <param name="id">Protocol ID.</param>
        /// <param name="name">Protocol Name.</param>
        /// <param name="families">Protocol Families.</param>
        /// <param name="addrData">Addressing data struct array.</param>
        /// <param name="isAsync">Asynchronous calls can be made.</param>
        /// <param name="canDetect">Protocol can be auto-detected.</param>
        /// <param name="timeout">Detection timeout for protocol.</param>
        private Protocols(int id, string name, int[] families, AddressData[] addrData, bool isAsync, bool canDetect, int timeout)
        {
            this.id = id;
            this.name = name;
            this.isAsync = isAsync;
            this.canDetect = canDetect;
            this.timeout = timeout;

            foreach (int family in families)
            {
                this.families.Add(family);
            }

            if (addrData != null)
            {
                foreach (AddressData addrDataItem in addrData)
                {
                    this.addrDataList.Add(addrDataItem);
                }
            }
        }

        /// <summary>
        /// Get the protocol with the given ID.
        /// </summary>
        /// <param name="id">Protocol ID.</param>
        /// <returns>The matching protocol or 'null' if no match.</returns>
        public static Protocols getProtocolById(int id)
        {
            Protocols protocol = null;
            foreach (Protocols proto in protocols)
            {
                if (proto.id == id)
                {
                    protocol = proto;
                    break;
                }
            }

            return protocol;
        }

        /// <summary>
        /// Get the protocol with the given name.
        /// </summary>
        /// <param name="name">Protocol name.</param>
        /// <returns>The matching protocol or 'null' if no match.</returns>
        public static Protocols getProtocolByName(string name)
        {
            Protocols protocol = null;
            foreach (Protocols proto in protocols)
            {
                if (proto.name == name)
                {
                    protocol = proto;
                    break;
                }
            }

            return protocol;
        }

        /// <summary>
        /// Address data for protocol.
        /// </summary>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1034:NestedTypesShouldNotBeVisible", Justification = "Reviewed, intentional.")]
        public class AddressData
        {
            /// <summary>
            /// Gets address bits for protocol.
            /// </summary>
            public int bits { get; private set; }

            /// <summary>
            /// Gets broadcast (functional) address for protocol.
            /// </summary>
            public string broadcastAddress { get; private set; }

            /// <summary>
            /// Gets base destination address for protocol.
            /// </summary>
            public string baseDestinationAddress { get; private set; }

            /// <summary>
            /// Gets base source address for protocol.
            /// </summary>
            public string baseSourceAddress { get; private set; }

            /// <summary>
            /// Gets connection flags for address alternative.
            /// </summary>
            public uint connFlags { get; private set; }

            /// <summary>
            /// Gets tool source addresses; 0xf0, 0xf1 etc.
            /// </summary>
            [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays", Justification = "Reviewed")]
            public uint[] srcAddr { get; private set; }

            /// <summary>
            /// Initializes a new instance of the <see cref="AddressData" /> class.
            /// </summary>
            /// <param name="bits">Address bits for protocol.</param>
            /// <param name="broadcastAddress">Broadcast (functional) address for protocol.</param>
            /// <param name="baseDestinationAddress">Base destination address for protocol.</param>
            /// <param name="baseSourceAddress">Base source address for protocol.</param>
            /// <param name="connFlags">Connection Flags.</param>
            /// <param name="srcAddr">Array of possible source addresses to use.</param>
            internal AddressData(int bits, string broadcastAddress, string baseDestinationAddress, string baseSourceAddress, uint connFlags, uint[] srcAddr)
            {
                this.bits = bits;
                this.broadcastAddress = broadcastAddress;
                this.baseDestinationAddress = baseDestinationAddress;
                this.baseSourceAddress = baseSourceAddress;
                this.connFlags = connFlags;
                this.srcAddr = srcAddr;
            }
        }
    }
}