//-----------------------------------------------------------------------
// <copyright file="FT_XSERIES_DATA.cs" company="bedug.com">
//     Copyright © 2012 Nils Hammar and Future Technology Devices International Limited. All rights reserved.
// </copyright>
//-----------------------------------------------------------------------

namespace FtdiApi.Structs
{
    using System.Runtime.InteropServices;

    /// <summary>
    /// FT X-series data.
    /// </summary>
    [System.Diagnostics.CodeAnalysis.SuppressMessage("StyleCop.CSharp.NamingRules", "SA1307:AccessibleFieldsMustBeginWithUpperCaseLetter", Justification = "Reviewed.")]
    [StructLayout(LayoutKind.Sequential, Pack = 4)]
    internal struct FT_XSERIES_DATA
    {
        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public FT_EEPROM_HEADER common;

        /// <summary>
        /// non-zero if AC bus pins have slow slew
        /// </summary>
        public byte ACSlowSlew;

        /// <summary>
        /// non-zero if AC bus pins are Schmitt input
        /// </summary>
        public byte ACSchmittInput;

        /// <summary>
        /// valid values are 4mA, 8mA, 12mA, 16mA
        /// </summary>
        public byte ACDriveCurrent;

        /// <summary>
        /// non-zero if AD bus pins have slow slew
        /// </summary>
        public byte ADSlowSlew;

        /// <summary>
        /// non-zero if AD bus pins are Schmitt input
        /// </summary>
        public byte ADSchmittInput;

        /// <summary>
        /// valid values are 4mA, 8mA, 12mA, 16mA
        /// </summary>
        public byte ADDriveCurrent;

        // CBUS options

        /// <summary>
        /// Cbus Mux control
        /// </summary>
        public byte Cbus0;

        /// <summary>
        /// Cbus Mux control
        /// </summary>
        public byte Cbus1;

        /// <summary>
        /// Cbus Mux control
        /// </summary>
        public byte Cbus2;

        /// <summary>
        /// Cbus Mux control
        /// </summary>
        public byte Cbus3;

        /// <summary>
        /// Cbus Mux control
        /// </summary>
        public byte Cbus4;

        /// <summary>
        /// Cbus Mux control
        /// </summary>
        public byte Cbus5;

        /// <summary>
        /// Cbus Mux control
        /// </summary>
        public byte Cbus6;

        // UART signal options

        /// <summary>
        /// non-zero if invert TXD
        /// </summary>
        public byte InvertTXD;

        /// <summary>
        /// non-zero if invert RXD
        /// </summary>
        public byte InvertRXD;

        /// <summary>
        /// non-zero if invert RTS
        /// </summary>
        public byte InvertRTS;

        /// <summary>
        /// non-zero if invert CTS
        /// </summary>
        public byte InvertCTS;

        /// <summary>
        /// non-zero if invert DTR
        /// </summary>
        public byte InvertDTR;

        /// <summary>
        /// non-zero if invert DSR
        /// </summary>
        public byte InvertDSR;

        /// <summary>
        /// non-zero if invert DCD
        /// </summary>
        public byte InvertDCD;

        /// <summary>
        /// non-zero if invert RI
        /// </summary>
        public byte InvertRI;

        // Battery Charge Detect options

        /// <summary>
        /// Enable Battery Charger Detection
        /// </summary>
        public byte BCDEnable;

        /// <summary>
        /// asserts the power enable signal on CBUS when charging port detected
        /// </summary>
        public byte BCDForceCbusPWREN;

        /// <summary>
        /// forces the device never to go into sleep mode
        /// </summary>
        public byte BCDDisableSleep;

        // I2C options

        /// <summary>
        /// I2C slave device address
        /// </summary>
        public ushort I2CSlaveAddress;

        /// <summary>
        /// I2C device ID
        /// </summary>
        public uint I2CDeviceId;

        /// <summary>
        /// Disable I2C Schmitt trigger
        /// </summary>
        public byte I2CDisableSchmitt;

        // FT1248 options

        /// <summary>
        /// FT1248 clock polarity - clock idle high (1) or clock idle low (0)
        /// </summary>
        public byte FT1248Cpol;

        /// <summary>
        /// FT1248 data is LSB (1) or MSB (0)
        /// </summary>
        public byte FT1248Lsb;

        /// <summary>
        /// FT1248 flow control enable
        /// </summary>
        public byte FT1248FlowControl;

        // Hardware options

        /// <summary>
        /// Suppress Echo on RS485
        /// </summary>
        public byte RS485EchoSuppress;

        /// <summary>
        /// Enable Power Save.
        /// </summary>
        public byte PowerSaveEnable;

        // Driver option

        /// <summary>
        /// Driver Type
        /// </summary>
        public byte DriverType;
    }
}