//-----------------------------------------------------------------------
// <copyright file="IoctlParameter.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 DeviceApi.J2534
{
    /// <summary>
    /// Definition of constants for IOCTL operations.
    /// </summary>
    public static class IoctlParameter
    {
        /// <summary>
        /// IOCTL Parameter DATA_RATE.
        /// </summary>
        public const int DATA_RATE = 0x01;

        /// <summary>
        /// IOCTL Parameter LOOPBACK.
        /// </summary>
        public const int LOOPBACK = 0x03;

        /// <summary>
        /// IOCTL Parameter NODE_ADDRESS.
        /// </summary>
        public const int NODE_ADDRESS = 0x04;

        /// <summary>
        /// IOCTL Parameter NETWORK_LINE.
        /// </summary>
        public const int NETWORK_LINE = 0x05;

        /// <summary>
        /// IOCTL Parameter P1_MIN.
        /// </summary>
        public const int P1_MIN = 0x06;

        /// <summary>
        /// IOCTL Parameter P1_MAX.
        /// </summary>
        public const int P1_MAX = 0x07;

        /// <summary>
        /// IOCTL Parameter P2_MIN.
        /// </summary>
        public const int P2_MIN = 0x08;

        /// <summary>
        /// IOCTL Parameter P2_MAX.
        /// </summary>
        public const int P2_MAX = 0x09;

        /// <summary>
        /// IOCTL Parameter P3_MIN.
        /// </summary>
        public const int P3_MIN = 0x0A;

        /// <summary>
        /// IOCTL Parameter P3_MAX.
        /// </summary>
        public const int P3_MAX = 0x0B;

        /// <summary>
        /// IOCTL Parameter P4_MIN.
        /// </summary>
        public const int P4_MIN = 0x0C;

        /// <summary>
        /// IOCTL Parameter P4_MAX.
        /// </summary>
        public const int P4_MAX = 0x0D;

        /// <summary>
        /// IOCTL Parameter W1.
        /// </summary>
        public const int W1 = 0x0E;

        /// <summary>
        /// IOCTL Parameter W2.
        /// </summary>
        public const int W2 = 0x0F;

        /// <summary>
        /// IOCTL Parameter W3.
        /// </summary>
        public const int W3 = 0x10;

        /// <summary>
        /// IOCTL Parameter W4.
        /// </summary>
        public const int W4 = 0x11;

        /// <summary>
        /// IOCTL Parameter W5.
        /// </summary>
        public const int W5 = 0x12;

        /// <summary>
        /// IOCTL Parameter TIDLE.
        /// </summary>
        public const int TIDLE = 0x13;

        /// <summary>
        /// IOCTL Parameter TINIL.
        /// </summary>
        public const int TINIL = 0x14;

        /// <summary>
        /// IOCTL Parameter TWUP.
        /// </summary>
        public const int TWUP = 0x15;

        /// <summary>
        /// IOCTL Parameter PARITY.
        /// </summary>
        public const int PARITY = 0x16;

        /// <summary>
        /// IOCTL Parameter BIT_SAMPLE_POINT.
        /// </summary>
        public const int BIT_SAMPLE_POINT = 0x17;

        /// <summary>
        /// IOCTL Parameter SYNC_JUMP_WIDTH.
        /// </summary>
        public const int SYNC_JUMP_WIDTH = 0x18;

        /// <summary>
        /// IOCTL Parameter T1_MAX.
        /// </summary>
        public const int T1_MAX = 0x1A;

        /// <summary>
        /// IOCTL Parameter T2_MAX.
        /// </summary>
        public const int T2_MAX = 0x1B;

        /// <summary>
        /// IOCTL Parameter T4_MAX.
        /// </summary>
        public const int T4_MAX = 0x1C;

        /// <summary>
        /// IOCTL Parameter T5_MAX.
        /// </summary>
        public const int T5_MAX = 0x1D;

        /// <summary>
        /// IOCTL Parameter ISO15765_BS.
        /// </summary>
        public const int ISO15765_BS = 0x1E;

        /// <summary>
        /// IOCTL Parameter ISO15765_STMIN.
        /// </summary>
        public const int ISO15765_STMIN = 0x1F;

        /// <summary>
        /// IOCTL Parameter DATA_BITS.
        /// </summary>
        public const int DATA_BITS = 0x20;

        /// <summary>
        /// IOCTL Parameter FIVE_BAUD_MOD.
        /// </summary>
        public const int FIVE_BAUD_MOD = 0x21;

        /// <summary>
        /// IOCTL Parameter BS_TX.
        /// </summary>
        public const int BS_TX = 0x22;

        /// <summary>
        /// IOCTL Parameter STMIN_TX.
        /// </summary>
        public const int STMIN_TX = 0x23;

        /// <summary>
        /// IOCTL Parameter T3_MAX.
        /// </summary>
        public const int T3_MAX = 0x24;

        /// <summary>
        /// IOCTL Parameter ISO15765_WFT_MAX.
        /// </summary>
        public const int ISO15765_WFT_MAX = 0x25;

        /*********** Parameter Types **********/

        /// <summary>
        /// Parameter type TYPE_BINARY.
        /// </summary>
        public const int TYPE_BINARY = 0x01;

        /// <summary>
        /// Parameter type TYPE_8BIT.
        /// </summary>
        public const int TYPE_8BIT = 0x02;

        /// <summary>
        /// Parameter type TYPE_16BIT.
        /// </summary>
        public const int TYPE_16BIT = 0x03;

        /// <summary>
        /// Parameter type TYPE_32BIT.
        /// </summary>
        public const int TYPE_32BIT = 0x04;

        /// <summary>
        /// Parameter type TYPE_BUS.
        /// </summary>
        public const int TYPE_BUS = 0x05;

        /// <summary>
        /// Parameter type TYPE_PARITY.
        /// </summary>
        public const int TYPE_PARITY = 0x06;
    }
}