//-----------------------------------------------------------------------
// <copyright file="PassThruConstants.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.Api
{
    /// <summary>
    /// Constants for PassThru interface.
    /// </summary>
    public sealed class PassThruConstants
    {
        /// <summary>
        /// Max size of the Data field.
        /// </summary>
        public const int MAX_DATA_SIZE = 4128;

        /// <summary>
        /// Default message at success.
        /// </summary>
        public const string SUCCESS = "Success";

        /// <summary>
        /// Prevents a default instance of the <see cref="PassThruConstants" /> class from being created.
        /// </summary>
        private PassThruConstants()
        {
        }

        /// <summary>
        /// J2534 result codes plus internal codes.
        /// </summary>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1034:NestedTypesShouldNotBeVisible", Justification = "Reviewed, intentional.")]
        public enum resultCode
        {
            /// <summary>
            /// Function completed successfully.
            /// </summary>
            ERR_SUCCESS = 0x00,

            /// <summary>
            /// Function option is not supported.
            /// </summary>
            ERR_NOT_SUPPORTED = 0x01,

            /// <summary>
            /// Channel Identifier or handle is not recognized.
            /// </summary>
            ERR_INVALID_CHANNEL_ID = 0x02,

            /// <summary>
            /// Protocol Identifier is not recognized.
            /// </summary>
            ERR_INVALID_PROTOCOL_ID = 0x03,

            /// <summary>
            /// NULL pointer presented as a function parameter, NULL is an invalid address.
            /// </summary>
            ERR_NULL_PARAMETER = 0x04,

            /// <summary>
            /// Ioctl GET_CONFIG/SET_CONFIG parameter value is not recognized.
            /// </summary>
            ERR_INVALID_IOCTL_VALUE = 0x05,

            /// <summary>
            /// Flags bit field(s) contain(s) an invalid value.
            /// </summary>
            ERR_INVALID_FLAGS = 0x06,

            /// <summary>
            /// Unspecified error, use PassThruGetLastError for obtaining error text string.
            /// </summary>
            ERR_FAILED = 0x07,

            /// <summary>
            /// PassThru device is not connected to the PC.
            /// </summary>
            ERR_DEVICE_NOT_CONNECTED = 0x08,

            /// <summary>
            /// Timeout violation. PassThru device is unable to read specified number of messages from the vehicle network.
            /// The actual number of messages returned is in NumMsgs.
            /// </summary>
            ERR_TIMEOUT = 0x09,

            /// <summary>
            /// Message contained a min/max length, ExtraData support or J1850PWM specific source address conflict violation.
            /// </summary>
            ERR_INVALID_MSG = 0x0A,

            /// <summary>
            /// The time interval value is outside the specified range.
            /// </summary>
            ERR_INVALID_TIME_INTERVAL = 0x0B,

            /// <summary>
            /// The limit(ten) of filter/periodic messages has been exceeded for the protocol associated the communications channel.
            /// </summary>
            ERR_EXCEEDED_LIMIT = 0x0C,

            /// <summary>
            /// The message identifier or handle is not recognized.
            /// </summary>
            ERR_INVALID_MSG_ID = 0x0D,

            /// <summary>
            /// The specified PassThru device is already in use.
            /// </summary>
            ERR_DEVICE_IN_USE = 0x0E,

            /// <summary>
            /// Ioctl identifier is not recognized.
            /// </summary>
            ERR_INVALID_IOCTL_ID = 0x0F,

            /// <summary>
            /// PassThru device could not read any messages from the vehicle network.
            /// </summary>
            ERR_BUFFER_EMPTY = 0x10,

            /// <summary>
            /// PassThru device could not queue any more transmit messages destined for the vehicle network.
            /// </summary>
            ERR_BUFFER_FULL = 0x11,

            /// <summary>
            /// PassThru device experienced a buffer overflow and receive messages were lost.
            /// </summary>
            ERR_BUFFER_OVERFLOW = 0x12,

            /// <summary>
            /// Unknown pin number specified for the J1962 connector.
            /// </summary>
            ERR_PIN_INVALID = 0x13,

            /// <summary>
            /// An existing communications channel is currently using the specified network protocol.
            /// </summary>
            ERR_CHANNEL_IN_USE = 0x14,

            /// <summary>
            /// The specified protocol type within the message structure is different from the protocol associated with
            /// the communications channel when it was opened.
            /// </summary>
            ERR_MSG_PROTOCOL_ID = 0x15,

            /// <summary>
            /// Filter identifier is not recognized.
            /// </summary>
            ERR_INVALID_FILTER_ID = 0x16,

            /// <summary>
            /// No ISO15765 flow control filter is set, or no filter matches the header of an outgoing message.
            /// </summary>
            ERR_NO_FLOW_CONTROL = 0x17,

            /// <summary>
            /// An existing filter already matches this header or node identifier.
            /// </summary>
            ERR_NOT_UNIQUE = 0x18,

            /// <summary>
            /// Unable to honor requested Baud rate within required tolerances.
            /// </summary>
            ERR_INVALID_BAUDRATE = 0x19,

            /// <summary>
            /// PassThru device identifier is not recognized.
            /// </summary>
            ERR_INVALID_DEVICE_ID = 0x1A,

            /// <summary>
            /// Internal code for this application indicating that there is no channel configured.
            /// </summary>
            NO_CHANNEL = -767,

            /// <summary>
            /// Internal code for this application indicating that there was a failure reading data.
            /// </summary>
            READ_FAIL = -757,
        }
        
        /// <summary>
        /// Class declaring connection flags.
        /// </summary>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1034:NestedTypesShouldNotBeVisible", Justification = "Intentional for use with DLL API")]
        public class connflags
        {
            /// <summary>
            /// Flag CAN_29BIT_ID.
            /// </summary>
            public const int CAN_29BIT_ID = 0x00000100;

            /// <summary>
            /// Flag ISO9141_NO_CHECKSUM.
            /// </summary>
            public const int ISO9141_NO_CHECKSUM = 0x00000200;

            /// <summary>
            /// Flag CAN_ID_BOTH.
            /// </summary>
            public const int CAN_ID_BOTH = 0x00000800;

            /// <summary>
            /// Flag ISO9141_K_LINE_ONLY.
            /// </summary>
            public const int ISO9141_K_LINE_ONLY = 0x00001000;

            /* The following are vendor specific */

            /// <summary>
            /// Tactrix specific Flag SNIFF_MODE.
            /// </summary>
            public const int SNIFF_MODE = 0x10000000;

            /// <summary>
            /// Tactrix specific Flag ISO9141_FORD_HEADER.
            /// </summary>
            public const int ISO9141_FORD_HEADER = 0x20000000;

            /// <summary>
            /// Tactrix specific Flag ISO9141_NO_CHECKSUM_DT.
            /// </summary>
            public const int ISO9141_NO_CHECKSUM_DT = 0x40000000;

            /// <summary>
            /// Array of supported flags.
            /// </summary>
            public static readonly connflags[] flags =
            {
                new connflags(CAN_29BIT_ID, "CAN_29BIT_ID"),
                new connflags(ISO9141_NO_CHECKSUM, "ISO9141_NO_CHECKSUM"),
                new connflags(CAN_ID_BOTH, "CAN_ID_BOTH"),
                new connflags(ISO9141_K_LINE_ONLY, "ISO9141_K_LINE_ONLY"),
                new connflags(SNIFF_MODE, "SNIFF_MODE"),
                new connflags(ISO9141_FORD_HEADER, "ISO9141_FORD_HEADER"),
                new connflags(ISO9141_NO_CHECKSUM_DT, "ISO9141_NO_CHECKSUM_DT"),
            };

            /// <summary>
            /// Gets value of the flag.
            /// It is a bit masked field that may be 'or':ed with other flags.
            /// </summary>
            public int flag { get; private set; }

            /// <summary>
            /// Gets The name of the flag.
            /// </summary>
            public string name { get; private set; }

            /// <summary>
            /// Initializes a new instance of the <see cref="connflags" /> class.
            /// </summary>
            /// <param name="flag">ID of flag.</param>
            /// <param name="name">Name of flag.</param>
            private connflags(int flag, string name)
            {
                this.flag = flag;
                this.name = name;
            }
        }

        /// <summary>
        /// Class declaring tx message flags.
        /// </summary>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1034:NestedTypesShouldNotBeVisible", Justification = "Intentional for use with DLL API")]
        public class txflags
        {
            /// <summary>
            /// Flag ISO15765_FRAME_PAD.
            /// </summary>
            public const int ISO15765_FRAME_PAD = 0x00000040;

            /// <summary>
            /// Flag ISO15765_ADDR_TYPE.
            /// </summary>
            public const int ISO15765_ADDR_TYPE = 0x00000080;

            /// <summary>
            /// Flag CAN_29BIT_ID.
            /// </summary>
            public const int CAN_29BIT_ID = 0x00000100;

            /// <summary>
            /// Flag WAIT_P3_MIN_ONLY.
            /// </summary>
            public const int WAIT_P3_MIN_ONLY = 0x00000200;

            /// <summary>
            /// Flag SCI_MODE.
            /// </summary>
            public const int SCI_MODE = 0x00400000;

            /// <summary>
            /// Flag SCI_TX_VOLTAGE.
            /// </summary>
            public const int SCI_TX_VOLTAGE = 0x00800000;

            /// <summary>
            /// Array of supported flags.
            /// </summary>
            public static readonly txflags[] flags =
            {
                new txflags(ISO15765_FRAME_PAD, "ISO15765_FRAME_PAD"),
                new txflags(ISO15765_ADDR_TYPE, "ISO15765_ADDR_TYPE"),
                new txflags(CAN_29BIT_ID, "CAN_29BIT_ID"),
                new txflags(WAIT_P3_MIN_ONLY, "WAIT_P3_MIN_ONLY"),
                new txflags(SCI_MODE, "SCI_MODE"),
                new txflags(SCI_TX_VOLTAGE, "SCI_TX_VOLTAGE"),
            };

            /// <summary>
            /// Gets value of the flag.
            /// It is a bit masked field that may be 'or':ed with other flags.
            /// </summary>
            public int flag { get; private set; }

            /// <summary>
            /// Gets The name of the flag.
            /// </summary>
            public string name { get; private set; }

            /// <summary>
            /// Initializes a new instance of the <see cref="txflags" /> class.
            /// </summary>
            /// <param name="flag">ID of flag.</param>
            /// <param name="name">Name of flag.</param>
            private txflags(int flag, string name)
            {
                this.flag = flag;
                this.name = name;
            }
        }

        /// <summary>
        /// Class declaring rx message status flags.
        /// </summary>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1034:NestedTypesShouldNotBeVisible", Justification = "Intentional for use with DLL API")]
        public class rxflags
        {
            /// <summary>
            /// Flag TX_MSG_TYPE.
            /// </summary>
            public const int TX_MSG_TYPE = 0x00000001;

            /// <summary>
            /// Flag START_OF_MESSAGE.
            /// </summary>
            public const int START_OF_MESSAGE = 0x00000002;

            /// <summary>
            /// Flag RX_BREAK.
            /// </summary>
            public const int RX_BREAK = 0x00000004;

            /// <summary>
            /// Flag TX_DONE.
            /// </summary>
            public const int TX_DONE = 0x00000008;

            /// <summary>
            /// Flag ISO15765_PADDING_ERROR.
            /// </summary>
            public const int ISO15765_PADDING_ERROR = 0x00000010;

            /// <summary>
            /// Flag ISO15765_ADDR_TYPE.
            /// </summary>
            public const int ISO15765_ADDR_TYPE = 0x00000080;

            /// <summary>
            /// Array of supported flags.
            /// </summary>
            public static readonly rxflags[] flags =
            {
                new rxflags(TX_MSG_TYPE, "TX_MSG_TYPE"),
                new rxflags(START_OF_MESSAGE, "START_OF_MESSAGE"),
                new rxflags(RX_BREAK, "RX_BREAK"),
                new rxflags(TX_DONE, "TX_DONE"),
                new rxflags(ISO15765_PADDING_ERROR, "ISO15765_PADDING_ERROR"),
                new rxflags(ISO15765_ADDR_TYPE, "ISO15765_ADDR_TYPE"),
            };

            /// <summary>
            /// Gets value of the flag.
            /// It is a bit masked field that may be 'or':ed with other flags.
            /// </summary>
            public int flag { get; private set; }

            /// <summary>
            /// Gets The name of the flag.
            /// </summary>
            public string name { get; private set; }

            /// <summary>
            /// Initializes a new instance of the <see cref="rxflags" /> class.
            /// </summary>
            /// <param name="flag">ID of flag.</param>
            /// <param name="name">Name of flag.</param>
            private rxflags(int flag, string name)
            {
                this.flag = flag;
                this.name = name;
            }
        }

        /// <summary>
        /// Class declaring Filter types.
        /// </summary>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1034:NestedTypesShouldNotBeVisible", Justification = "Intentional for use with DLL API")]
        public class filters
        {
            /// <summary>
            /// Filter type PASS_FILTER.
            /// </summary>
            public const int PASS_FILTER = 0x00000001;

            /// <summary>
            /// Filter type BLOCK_FILTER.
            /// </summary>
            public const int BLOCK_FILTER = 0x00000002;

            /// <summary>
            /// Filter type FLOW_CONTROL_FILTER.
            /// </summary>
            public const int FLOW_CONTROL_FILTER = 0x00000003;

            /// <summary>
            /// Array of supported filters.
            /// </summary>
            public static readonly filters[] filterlist =
            {
                new filters(PASS_FILTER, "PASS_FILTER"),
                new filters(BLOCK_FILTER, "BLOCK_FILTER"),
                new filters(FLOW_CONTROL_FILTER, "FLOW_CONTROL_FILTER"),
            };

            /// <summary>
            /// Gets value of the filter id.
            /// </summary>
            public int id { get; private set; }

            /// <summary>
            /// Gets The name of the filter type.
            /// </summary>
            public string name { get; private set; }

            /// <summary>
            /// Initializes a new instance of the <see cref="filters" /> class.
            /// </summary>
            /// <param name="id">ID of filter.</param>
            /// <param name="name">Name of filter.</param>
            private filters(int id, string name)
            {
                this.id = id;
                this.name = name;
            }
        }
    }
}