//-----------------------------------------------------------------------
// <copyright file="FT_EEPROM_HEADER.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>
    /// EEPROM Header struct.
    /// </summary>
    [System.Diagnostics.CodeAnalysis.SuppressMessage("StyleCop.CSharp.NamingRules", "SA1307:AccessibleFieldsMustBeginWithUpperCaseLetter", Justification = "Reviewed.")]
    [StructLayout(LayoutKind.Sequential, Pack = 4)]
    internal struct FT_EEPROM_HEADER
    {
        /// <summary>
        /// EEPROM Data.
        /// FTxxxx device type to be programmed
        /// </summary>
        public uint deviceType;

        // Device descriptor options

        /// <summary>
        /// EEPROM Data.
        /// 0x0403
        /// </summary>
        public ushort VendorId;

        /// <summary>
        /// EEPROM Data.
        /// 0x6001
        /// </summary>
        public ushort ProductId;

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

        // Config descriptor options

        /// <summary>
        /// EEPROM Data.
        /// 0 &lt; MaxPower &lt;= 500
        /// </summary>
        public ushort MaxPower;

        /// <summary>
        /// EEPROM Data.
        /// 0 = bus powered, 1 = self powered
        /// </summary>
        public byte SelfPowered;

        /// <summary>
        /// EEPROM Data.
        /// 0 = not capable, 1 = capable
        /// </summary>
        public byte RemoteWakeup;

        // Hardware options

        /// <summary>
        /// EEPROM Data.
        /// non-zero if pull down in suspend enabled
        /// </summary>
        public byte PullDownEnable;
    }
}