// ******************************************************************************************
// **                                                                                       **
// **      RAYTHEON PROPRIETARY: THIS DOCUMENT CONTAINS DATA OR INFORMATION                 **
// **      PROPRIETARY TO RAYTHEON COMPANY AND IS RESTRICTED TO USE ONLY BY PERSONS         **
// **      AUTHORIZED BY RAYTHEON COMPANY IN WRITING TO USE IT.DISCLOSURE TO                **
// **      UNAUTHORIZED PERSONS WOULD LIKELY CAUSE SUBSTANTIAL COMPETITIVE HARM TO          **
// **      RAYTHEON COMPANY'S BUSINESS POSITION. NEITHER SAID DOCUMENT NOR ITS              **
// **      CONTENTS SHALL BE FURNISHED OR DISCLOSED TO OR COPIED OR USED BY PERSONS         **
// **      OUTSIDE RAYTHEON COMPANY WITHOUT THE EXPRESS WRITTEN APPROVAL OF RAYTHEON        **
// **      COMPANY.                                                                         **
// **                                                                                       **
// **      THIS PROPRIETARY NOTICE IS NOT APPLICABLE IF DELIVERED TO THE U.S.               **
// **      GOVERNMENT.                                                                      **
// **                                                                                       **
// **      UNPUBLISHED WORK - COPYRIGHT RAYTHEON COMPANY.                                   **
// **                                                                                       **
// **      WARNING: THIS DOCUMENT CONTAINS TECHNICAL DATA AND / OR TECHNOLOGY WHOSE         **
// **      EXPORT OR DISCLOSURE TO NON-U.S.PERSONS, WHEREVER LOCATED, IS RESTRICTED         **
// **      BY THE INTERNATIONAL TRAFFIC IN ARMS REGULATIONS (ITAR) (22 C.F.R.SECTION        **
// **      120-130) OR THE EXPORT ADMINISTRATION REGULATIONS(EAR) (15 C.F.R.SECTION         **
// **      730-774). THIS DOCUMENT CANNOT BE EXPORTED(E.G., PROVIDED TO A SUPPLIER          **
// **      OUTSIDE OF THE UNITED STATES) OR DISCLOSED TO A NON-U.S.PERSON, WHEREVER         **
// **      LOCATED, UNTIL A FINAL JURISDICTION AND CLASSIFICATION DETERMINATION HAS         **
// **      BEEN COMPLETED AND APPROVED BY RAYTHEON, AND ANY REQUIRED U.S.GOVERNMENT         **
// **      APPROVALS HAVE BEEN OBTAINED. VIOLATIONS ARE SUBJECT TO SEVERE CRIMINAL          **
// **      PENALTIES.                                                                       **
// **                                                                                       **
// **      CAPITAL EQUIPMENT/SOFTWARE: THIS TECHNICAL DATA WAS DEVELOPED OR ACQUIRED        **
// **      EXCLUSIVELY AT CONTRACTOR EXPENSE AND IS INTENDED FOR USE ON MULTIPLE            **
// **      PROJECTS/PROGRAMS.                                                               **
// **                                                                                       **
// *******************************************************************************************

using Raytheon.Communication;

namespace Raytheon.Instruments
{
    /// <summary>
    /// An interface for FPGA communication
    /// </summary>
    public interface IFpgaComm : IInstrument
    {
        /// <summary>
        /// 
        /// </summary>
        /// <param name="fpgaName">The name of the FPGA</param>
        [UmsCommand("IFpgaComm.Initialize")]
        void Initialize(string fpgaName);

        /// <summary>
        /// 
        /// </summary>
        /// <param name="fpgaName">The name of the FPGA</param>
        [UmsCommand("IFpgaComm.LoadFirmware")]
        void LoadFirmware(string fpgaName);

        /// <summary>
        /// 
        /// </summary>
        /// <param name="fpgaName">The name of the FPGA</param>
        /// <param name="address">The address to read from</param>
        /// <returns>The data conttained in the FPGA at the address specified</returns>
        [UmsCommand("IFpgaComm.Read")]
        uint Read(string fpgaName, uint address);

        /// <summary>
        /// 
        /// </summary>
        /// <param name="fpgaName"></param>
        /// <param name="address"></param>
        /// <param name="numberOfWordsToRead"></param>
        /// <param name="shallWeIncrementAddress"></param>
        /// <param name="dataRead"></param>
        /// <returns></returns>
        [UmsCommand("IFpgaComm.ReadBlock")]
        void ReadBlock(string fpgaName, uint address, uint numberOfWordsToRead, bool shallWeIncrementAddress, ref uint[] dataRead);

        /// <summary>
        /// 
        /// </summary>
        /// <param name="fpgaName">The name of the FPGA</param>
        /// <param name="address">The address to write to</param>
        /// <param name="value">The value to write</param>
        [UmsCommand("IFpgaComm.Write")]
        void Write(string fpgaName, uint address, uint value);

        /// <summary>
        /// 
        /// </summary>
        /// <param name="fpgaName"></param>
        /// <param name="address"></param>
        /// <param name="numberOfWordsToWrite"></param>
        /// <param name="data"></param>
        /// <param name="shallWeIncrementAddress"></param>
        /// <returns></returns>
        [UmsCommand("IFpgaComm.WriteBlock")]
        void WriteBlock(string fpgaName, uint address, uint numberOfWordsToWrite, uint[] data, bool shallWeIncrementAddress);
    }
}