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

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

    /// <summary>
    /// Internal structure for reading and writing EEPROM contents.
    /// <para>
    /// NOTE:  NEED Pack=1 for byte alignment!  Without this, data is garbage
    /// </para>
    /// </summary>
    [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1049:TypesThatOwnNativeResourcesShouldBeDisposable", Justification = "Reviewed.")]
    [System.Diagnostics.CodeAnalysis.SuppressMessage("StyleCop.CSharp.MaintainabilityRules", "SA1401:FieldsMustBePrivate", Justification = "Reviewed.")]
    [StructLayout(LayoutKind.Sequential, Pack = 4)]
    internal struct FT_PROGRAM_DATA
    {
        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public uint Signature1;

        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public uint Signature2;

        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public uint Version;

        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public ushort VendorID;

        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public ushort ProductID;

        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public IntPtr Manufacturer;

        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public IntPtr ManufacturerID;

        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public IntPtr Description;

        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public IntPtr SerialNumber;

        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public ushort MaxPower;

        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public ushort PnP;

        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public ushort SelfPowered;

        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public ushort RemoteWakeup;

        //// FT232B extensions

        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public byte Rev4;

        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public byte IsoIn;

        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public byte IsoOut;

        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public byte PullDownEnable;

        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public byte SerNumEnable;

        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public byte USBVersionEnable;

        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public ushort USBVersion;

        // FT2232D extensions

        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public byte Rev5;

        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public byte IsoInA;

        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public byte IsoInB;

        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public byte IsoOutA;

        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public byte IsoOutB;

        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public byte PullDownEnable5;

        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public byte SerNumEnable5;

        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public byte USBVersionEnable5;

        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public ushort USBVersion5;

        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public byte AIsHighCurrent;

        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public byte BIsHighCurrent;

        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public byte IFAIsFifo;

        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public byte IFAIsFifoTar;

        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public byte IFAIsFastSer;

        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public byte AIsVCP;

        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public byte IFBIsFifo;

        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public byte IFBIsFifoTar;

        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public byte IFBIsFastSer;

        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public byte BIsVCP;

        // FT232R extensions

        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public byte UseExtOsc;

        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public byte HighDriveIOs;

        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public byte EndpointSize;

        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public byte PullDownEnableR;

        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public byte SerNumEnableR;

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

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

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

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

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

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

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

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

        /// <summary>
        /// EEPROM Data.
        /// Cbus Mux control - Ignored for FT245R
        /// </summary>
        public byte Cbus0;

        /// <summary>
        /// EEPROM Data.
        /// Cbus Mux control - Ignored for FT245R
        /// </summary>
        public byte Cbus1;

        /// <summary>
        /// EEPROM Data.
        /// Cbus Mux control - Ignored for FT245R
        /// </summary>
        public byte Cbus2;

        /// <summary>
        /// EEPROM Data.
        /// Cbus Mux control - Ignored for FT245R
        /// </summary>
        public byte Cbus3;

        /// <summary>
        /// EEPROM Data.
        /// Cbus Mux control - Ignored for FT245R
        /// </summary>
        public byte Cbus4;

        /// <summary>
        /// EEPROM Data.
        /// Default to loading VCP
        /// </summary>
        public byte RIsD2XX;

        // FT2232H extensions

        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public byte PullDownEnable7;

        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public byte SerNumEnable7;

        /// <summary>
        /// EEPROM Data.
        /// non-zero if AL pins have slow slew
        /// </summary>
        public byte ALSlowSlew;

        /// <summary>
        /// EEPROM Data.
        /// non-zero if AL pins are Schmitt input
        /// </summary>
        public byte ALSchmittInput;

        /// <summary>
        /// EEPROM Data.
        /// valid values are 4mA, 8mA, 12mA, 16mA
        /// </summary>
        public byte ALDriveCurrent;

        /// <summary>
        /// EEPROM Data.
        /// non-zero if AH pins have slow slew
        /// </summary>
        public byte AHSlowSlew;

        /// <summary>
        /// EEPROM Data.
        /// non-zero if AH pins are Schmitt input
        /// </summary>
        public byte AHSchmittInput;

        /// <summary>
        /// EEPROM Data.
        /// valid values are 4mA, 8mA, 12mA, 16mA
        /// </summary>
        public byte AHDriveCurrent;

        /// <summary>
        /// EEPROM Data.
        /// non-zero if BL pins have slow slew
        /// </summary>
        public byte BLSlowSlew;

        /// <summary>
        /// EEPROM Data.
        /// non-zero if BL pins are Schmitt input
        /// </summary>
        public byte BLSchmittInput;

        /// <summary>
        /// EEPROM Data.
        /// valid values are 4mA, 8mA, 12mA, 16mA
        /// </summary>
        public byte BLDriveCurrent;

        /// <summary>
        /// EEPROM Data.
        /// non-zero if BH pins have slow slew
        /// </summary>
        public byte BHSlowSlew;

        /// <summary>
        /// EEPROM Data.
        /// non-zero if BH pins are Schmitt input
        /// </summary>
        public byte BHSchmittInput;

        /// <summary>
        /// EEPROM Data.
        /// valid values are 4mA, 8mA, 12mA, 16mA
        /// </summary>
        public byte BHDriveCurrent;

        /// <summary>
        /// EEPROM Data.
        /// non-zero if interface is 245 FIFO
        /// </summary>
        public byte IFAIsFifo7;

        /// <summary>
        /// EEPROM Data.
        /// non-zero if interface is 245 FIFO CPU target
        /// </summary>
        public byte IFAIsFifoTar7;

        /// <summary>
        /// EEPROM Data.
        /// non-zero if interface is Fast serial
        /// </summary>
        public byte IFAIsFastSer7;

        /// <summary>
        /// EEPROM Data.
        /// non-zero if interface is to use VCP drivers
        /// </summary>
        public byte AIsVCP7;

        /// <summary>
        /// EEPROM Data.
        /// non-zero if interface is 245 FIFO
        /// </summary>
        public byte IFBIsFifo7;

        /// <summary>
        /// EEPROM Data.
        /// non-zero if interface is 245 FIFO CPU target
        /// </summary>
        public byte IFBIsFifoTar7;

        /// <summary>
        /// EEPROM Data.
        /// non-zero if interface is Fast serial
        /// </summary>
        public byte IFBIsFastSer7;

        /// <summary>
        /// EEPROM Data.
        /// non-zero if interface is to use VCP drivers
        /// </summary>
        public byte BIsVCP7;

        /// <summary>
        /// EEPROM Data.
        /// non-zero if using BCBUS7 to save power for self-powered designs
        /// </summary>
        public byte PowerSaveEnable;

        // FT4232H extensions

        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public byte PullDownEnable8;

        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public byte SerNumEnable8;

        /// <summary>
        /// EEPROM Data.
        /// non-zero if AL pins have slow slew
        /// </summary>
        public byte ASlowSlew;

        /// <summary>
        /// EEPROM Data.
        /// non-zero if AL pins are Schmitt input
        /// </summary>
        public byte ASchmittInput;

        /// <summary>
        /// EEPROM Data.
        /// valid values are 4mA, 8mA, 12mA, 16mA
        /// </summary>
        public byte ADriveCurrent;

        /// <summary>
        /// EEPROM Data.
        /// non-zero if AH pins have slow slew
        /// </summary>
        public byte BSlowSlew;

        /// <summary>
        /// EEPROM Data.
        /// non-zero if AH pins are Schmitt input
        /// </summary>
        public byte BSchmittInput;

        /// <summary>
        /// EEPROM Data.
        /// valid values are 4mA, 8mA, 12mA, 16mA
        /// </summary>
        public byte BDriveCurrent;

        /// <summary>
        /// EEPROM Data.
        /// non-zero if BL pins have slow slew
        /// </summary>
        public byte CSlowSlew;

        /// <summary>
        /// EEPROM Data.
        /// non-zero if BL pins are Schmitt input
        /// </summary>
        public byte CSchmittInput;

        /// <summary>
        /// EEPROM Data.
        /// valid values are 4mA, 8mA, 12mA, 16mA
        /// </summary>
        public byte CDriveCurrent;

        /// <summary>
        /// EEPROM Data.
        /// non-zero if BH pins have slow slew
        /// </summary>
        public byte DSlowSlew;

        /// <summary>
        /// EEPROM Data.
        /// non-zero if BH pins are Schmitt input
        /// </summary>
        public byte DSchmittInput;

        /// <summary>
        /// EEPROM Data.
        /// valid values are 4mA, 8mA, 12mA, 16mA
        /// </summary>
        public byte DDriveCurrent;

        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public byte ARIIsTXDEN;

        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public byte BRIIsTXDEN;

        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public byte CRIIsTXDEN;

        /// <summary>
        /// EEPROM Data.
        /// </summary>
        public byte DRIIsTXDEN;

        /// <summary>
        /// EEPROM Data.
        /// non-zero if interface is to use VCP drivers
        /// </summary>
        public byte AIsVCP8;

        /// <summary>
        /// EEPROM Data.
        /// non-zero if interface is to use VCP drivers
        /// </summary>
        public byte BIsVCP8;

        /// <summary>
        /// EEPROM Data.
        /// non-zero if interface is to use VCP drivers
        /// </summary>
        public byte CIsVCP8;

        /// <summary>
        /// EEPROM Data.
        /// non-zero if interface is to use VCP drivers
        /// </summary>
        public byte DIsVCP8;

        // FT232H extensions

        /// <summary>
        /// EEPROM Data.
        /// non-zero if pull down enabled
        /// </summary>
        public byte PullDownEnableH;

        /// <summary>
        /// EEPROM Data.
        /// non-zero if serial number to be used
        /// </summary>
        public byte SerNumEnableH;

        /// <summary>
        /// EEPROM Data.
        /// non-zero if AC pins have slow slew
        /// </summary>
        public byte ACSlowSlewH;

        /// <summary>
        /// EEPROM Data.
        /// non-zero if AC pins are Schmitt input
        /// </summary>
        public byte ACSchmittInputH;

        /// <summary>
        /// EEPROM Data.
        /// valid values are 4mA, 8mA, 12mA, 16mA
        /// </summary>
        public byte ACDriveCurrentH;

        /// <summary>
        /// EEPROM Data.
        /// non-zero if AD pins have slow slew
        /// </summary>
        public byte ADSlowSlewH;

        /// <summary>
        /// EEPROM Data.
        /// non-zero if AD pins are Schmitt input
        /// </summary>
        public byte ADSchmittInputH;

        /// <summary>
        /// EEPROM Data.
        /// valid values are 4mA, 8mA, 12mA, 16mA
        /// </summary>
        public byte ADDriveCurrentH;

        /// <summary>
        /// EEPROM Data.
        /// Cbus Mux control
        /// </summary>
        public byte Cbus0H;

        /// <summary>
        /// EEPROM Data.
        /// Cbus Mux control
        /// </summary>
        public byte Cbus1H;

        /// <summary>
        /// EEPROM Data.
        /// Cbus Mux control
        /// </summary>
        public byte Cbus2H;

        /// <summary>
        /// EEPROM Data.
        /// Cbus Mux control
        /// </summary>
        public byte Cbus3H;

        /// <summary>
        /// EEPROM Data.
        /// Cbus Mux control
        /// </summary>
        public byte Cbus4H;

        /// <summary>
        /// EEPROM Data.
        /// Cbus Mux control
        /// </summary>
        public byte Cbus5H;

        /// <summary>
        /// EEPROM Data.
        /// Cbus Mux control
        /// </summary>
        public byte Cbus6H;

        /// <summary>
        /// EEPROM Data.
        /// Cbus Mux control
        /// </summary>
        public byte Cbus7H;

        /// <summary>
        /// EEPROM Data.
        /// Cbus Mux control
        /// </summary>
        public byte Cbus8H;

        /// <summary>
        /// EEPROM Data.
        /// Cbus Mux control
        /// </summary>
        public byte Cbus9H;

        /// <summary>
        /// EEPROM Data.
        /// non-zero if interface is 245 FIFO
        /// </summary>
        public byte IsFifoH;

        /// <summary>
        /// EEPROM Data.
        /// non-zero if interface is 245 FIFO CPU target
        /// </summary>
        public byte IsFifoTarH;

        /// <summary>
        /// EEPROM Data.
        /// non-zero if interface is Fast serial
        /// </summary>
        public byte IsFastSerH;

        /// <summary>
        /// EEPROM Data.
        /// non-zero if interface is FT1248
        /// </summary>
        public byte IsFT1248H;

        /// <summary>
        /// EEPROM Data.
        /// FT1248 clock polarity
        /// </summary>
        public byte FT1248CpolH;

        /// <summary>
        /// EEPROM Data.
        /// FT1248 data is LSB (1) or MSB (0)
        /// </summary>
        public byte FT1248LsbH;

        /// <summary>
        /// EEPROM Data.
        /// FT1248 flow control enable
        /// </summary>
        public byte FT1248FlowControlH;

        /// <summary>
        /// EEPROM Data.
        /// non-zero if interface is to use VCP drivers
        /// </summary>
        public byte IsVCPH;

        /// <summary>
        /// EEPROM Data.
        /// non-zero if using ACBUS7 to save power for self-powered designs
        /// </summary>
        public byte PowerSaveEnableH;
    }
}