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

namespace FtdiApi.Constants
{
    /// <summary>
    /// Available functions for the FT232R CBUS pins.  Controlled by FT232R EEPROM settings
    /// </summary>
    [System.Diagnostics.CodeAnalysis.SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1600:ElementsMustBeDocumented", Justification = "Reviewed.")]
    [System.Diagnostics.CodeAnalysis.SuppressMessage("StyleCop.CSharp.LayoutRules", "SA1516:ElementsMustBeSeparatedByBlankLine", Justification = "Reviewed.")]
    [System.Diagnostics.CodeAnalysis.SuppressMessage("StyleCop.CSharp.OrderingRules", "SA1201:ElementsMustAppearInTheCorrectOrder", Justification = "Reviewed.")]
    [System.Diagnostics.CodeAnalysis.SuppressMessage("StyleCop.CSharp.ReadabilityRules", "SA1121:UseBuiltInTypeAlias", Justification = "Reviewed.")]
    [System.Diagnostics.CodeAnalysis.SuppressMessage("StyleCop.CSharp.OrderingRules", "SA1202:ElementsMustBeOrderedByAccess", Justification = "Reviewed.")]
    [System.Diagnostics.CodeAnalysis.SuppressMessage("StyleCop.CSharp.NamingRules", "SA1305:FieldNamesMustNotUseHungarianNotation", Justification = "Reviewed.")]
    [System.Diagnostics.CodeAnalysis.SuppressMessage("StyleCop.CSharp.NamingRules", "SA1306:FieldNamesMustBeginWithLowerCaseLetter", Justification = "Reviewed.")]
    [System.Diagnostics.CodeAnalysis.SuppressMessage("StyleCop.CSharp.LayoutRules", "SA1503:CurlyBracketsMustNotBeOmitted", Justification = "Reviewed.")]
    [System.Diagnostics.CodeAnalysis.SuppressMessage("StyleCop.CSharp.NamingRules", "SA1310:FieldNamesMustNotContainUnderscore", Justification = "Reviewed.")]
    public class FT_CBUS_OPTIONS
    {
        /// <summary>
        /// FT232R CBUS EEPROM options - Tx Data Enable
        /// </summary>
        public const byte FT_CBUS_TXDEN = 0x00;

        /// <summary>
        /// FT232R CBUS EEPROM options - Power On
        /// </summary>
        public const byte FT_CBUS_PWRON = 0x01;

        /// <summary>
        /// FT232R CBUS EEPROM options - Rx LED
        /// </summary>
        public const byte FT_CBUS_RXLED = 0x02;

        /// <summary>
        /// FT232R CBUS EEPROM options - Tx LED
        /// </summary>
        public const byte FT_CBUS_TXLED = 0x03;

        /// <summary>
        /// FT232R CBUS EEPROM options - Tx and Rx LED
        /// </summary>
        public const byte FT_CBUS_TXRXLED = 0x04;

        /// <summary>
        /// FT232R CBUS EEPROM options - Sleep
        /// </summary>
        public const byte FT_CBUS_SLEEP = 0x05;

        /// <summary>
        /// FT232R CBUS EEPROM options - 48MHz clock
        /// </summary>
        public const byte FT_CBUS_CLK48 = 0x06;

        /// <summary>
        /// FT232R CBUS EEPROM options - 24MHz clock
        /// </summary>
        public const byte FT_CBUS_CLK24 = 0x07;

        /// <summary>
        /// FT232R CBUS EEPROM options - 12MHz clock
        /// </summary>
        public const byte FT_CBUS_CLK12 = 0x08;

        /// <summary>
        /// FT232R CBUS EEPROM options - 6MHz clock
        /// </summary>
        public const byte FT_CBUS_CLK6 = 0x09;

        /// <summary>
        /// FT232R CBUS EEPROM options - IO mode
        /// </summary>
        public const byte FT_CBUS_IOMODE = 0x0A;

        /// <summary>
        /// FT232R CBUS EEPROM options - Bit-bang write strobe
        /// </summary>
        public const byte FT_CBUS_BITBANG_WR = 0x0B;

        /// <summary>
        /// FT232R CBUS EEPROM options - Bit-bang read strobe
        /// </summary>
        public const byte FT_CBUS_BITBANG_RD = 0x0C;
    }
}