DotNetFrameworkDev/GenericTeProgramLibrary
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Big changes

Browse Source
This commit is contained in:
Duc
2025-03-13 12:04:22 -07:00
parent c689fcb7f9
commit ffa9905494
748 changed files with 199255 additions and 3743 deletions
Download Patch File Download Diff File Expand all files Collapse all files

565
Source/TSRealLib/HAL/Implementations/FPGA/CustomAsciiSerial/CommFpgaCustomAsciiSerial.cs Normal file
View File

@@ -0,0 +1,565 @@
// UNCLASSIFIED
/*-------------------------------------------------------------------------
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.
-------------------------------------------------------------------------*/
using System;
using System.IO.Ports;
using System.Text;
using System.Threading;
using NLog;
using Raytheon.Common;
namespace Raytheon.Instruments
{
/// <summary>
/// A class the provides an interface for read/write to registers on an FPGA that implement a custom ascii serial interface
/// </summary>
public class CommFpgaCustomAsciiSerial : IFpgaComm, IDisposable
{
#region PrivateClassMembers
private SerialPort _serialPort;
private byte[] _readBuf;
private static object _syncObj = new Object();
private uint _delayBeforeReadMs;
private string _readFormat;
private string _writeFormat;
private SelfTestResult _selfTestResult;
private State _state;
private string _name;
/// <summary>
/// NLog logger
/// </summary>
private readonly ILogger _logger;
/// <summary>
/// Raytheon configuration
/// </summary>
private readonly IConfigurationManager _configurationManager;
private readonly IConfiguration _configuration;
#endregion
#region PrivateFuctions
/// <summary>
/// The Finalizer
/// </summary>
~CommFpgaCustomAsciiSerial()
{
Dispose(false);
}
/// <summary>
/// Reads the serial port until it is empty
/// </summary>
private void ClearBuffer()
{
lock (_syncObj)
{
bool isClearComplete = false;
while (isClearComplete == false)
{
try
{
int numBytesRead = _serialPort.Read(_readBuf, 0, _readBuf.Length);
if (numBytesRead < _readBuf.Length)
{
isClearComplete = true;
}
}
catch (Exception)
{
//expected if buffer is already cleared
isClearComplete = true;
}
}
}
}
/// <summary>
/// Dispose of this object
/// </summary>
/// <param name="disposing"></param>
protected virtual void Dispose(bool disposing)
{
try
{
if (disposing)
{
if (_state == State.Ready)
{
_serialPort.Dispose();
_state = State.Uninitialized;
}
}
}
catch (Exception)
{
try
{
//ErrorLogger.Instance().Write(err.Message + "\r\n" + err.StackTrace);
}
catch (Exception)
{
//Do not rethrow. Exception from error logger that has already been garbage collected
}
}
}
#endregion
#region PublicFuctions
/// <summary>
/// ELoadScpiKeysight factory constructor
/// </summary>
/// <param name="deviceName"></param>
/// <param name="configurationManager"></param>
public CommFpgaCustomAsciiSerial(string deviceName, IConfigurationManager configurationManager, ILogger logger)
{
Name = deviceName;
_logger = logger;
_configurationManager = configurationManager;
_configuration = _configurationManager.GetConfiguration(Name);
const int READ_BUF_SIZE = 1024;
try
{
_selfTestResult = SelfTestResult.Unknown;
_state = State.Uninitialized;
string comPortName = _configuration.GetConfigurationValue("CommFpgaCustomAsciiSerial", "ComPortName", "COM1");
int baudRate = _configuration.GetConfigurationValue("CommFpgaCustomAsciiSerial", "BaudRate", 9600);
Parity parity = _configuration.GetConfigurationValue("CommFpgaCustomAsciiSerial", "Parity", Parity.None);
int dataBits = _configuration.GetConfigurationValue("CommFpgaCustomAsciiSerial", "DataBits", 8);
StopBits stopBits = _configuration.GetConfigurationValue("CommFpgaCustomAsciiSerial", "StopBits", StopBits.None);
_serialPort = new SerialPort(comPortName, baudRate, parity, dataBits, stopBits);
_readFormat = _configuration.GetConfigurationValue("CommFpgaCustomAsciiSerial", "ReadFormat", "");
_writeFormat = _configuration.GetConfigurationValue("CommFpgaCustomAsciiSerial", "WriteFormat", "");
_serialPort.ReadTimeout = _configuration.GetConfigurationValue("CommFpgaCustomAsciiSerial", "ReadTimeout", 100);
_delayBeforeReadMs = _configuration.GetConfigurationValue<uint>("CommFpgaCustomAsciiSerial", "DelayBeforeReadMs", 0);
_readBuf = new byte[READ_BUF_SIZE];
//check format of readFormat and writeFormat
if (!_readFormat.Contains("<ADDRESS>"))
{
throw new Exception("the read format input for card " + _name + " does not contain the <ADDRESS> tag");
}
if (!_writeFormat.Contains("<ADDRESS>"))
{
throw new Exception("the write format input for card " + _name + " does not contain the <ADDRESS> tag");
}
if (!_writeFormat.Contains("<DATA>"))
{
throw new Exception("the write format input for card " + _name + " does not contain the <DATA> tag");
}
}
catch (Exception ex)
{
_logger.Error(ex);
if (_serialPort.IsOpen == true)
{
_serialPort.Close();
}
throw;
}
}
/// <summary>
/// The constructor which opens up a serial port
/// </summary>
/// <param name="comPortName">The port name. "Com1' for example</param>
/// <param name="delayBeforeReadMs">The num of ms to wait before a read</param>
/// <param name="baudRate">The baud rate</param>
/// <param name="parity">The parity</param>
/// <param name="dataBits">Number of data bits</param>
/// <param name="stopBits">Number of Stop Bits</param>
public CommFpgaCustomAsciiSerial(string name, string comPortName, uint delayBeforeReadMs, string readFormat, string writeFormat, int baudRate = 115200, Parity parity = Parity.None, int dataBits = 8, StopBits stopBits = StopBits.One)
{
const int READ_BUF_SIZE = 1024;
try
{
_name = name;
_selfTestResult = SelfTestResult.Unknown;
_state = State.Uninitialized;
_serialPort = new SerialPort(comPortName, baudRate, parity, dataBits, stopBits);
_readFormat = readFormat;
_writeFormat = writeFormat;
_serialPort.ReadTimeout = 100;
_delayBeforeReadMs = delayBeforeReadMs;
_readBuf = new byte[READ_BUF_SIZE];
Array.Clear(_readBuf, 0, _readBuf.Length);
_logger = LogManager.GetCurrentClassLogger();
//check format of readFormat and writeFormat
if (readFormat.Contains("<ADDRESS>") == false)
{
throw new Exception("the read format input for card " + _name + " does not contain the <ADDRESS> tag");
}
if (writeFormat.Contains("<ADDRESS>") == false)
{
throw new Exception("the write format input for card " + _name + " does not contain the <ADDRESS> tag");
}
if (writeFormat.Contains("<DATA>") == false)
{
throw new Exception("the write format input for card " + _name + " does not contain the <DATA> tag");
}
}
catch (Exception ex)
{
_logger.Error(ex);
if (_serialPort.IsOpen == true)
{
_serialPort.Close();
}
throw;
}
}
/// <summary>
///
/// </summary>
/// <returns></returns>
public bool ClearErrors()
{
return false;
}
/// <summary>
///
/// </summary>
public string DetailedStatus
{
get
{
return "This is a FPGA Custom Ascii called " + _name;
}
}
/// <summary>
///
/// </summary>
public bool DisplayEnabled
{
get
{
return false;
}
set
{
throw new NotImplementedException();
}
}
/// <summary>
/// Dispose of this object
/// </summary>
public void Dispose()
{
try
{
Dispose(true);
GC.SuppressFinalize(this);
}
catch (Exception)
{
try
{
//ErrorLogger.Instance().Write(err.Message + "\r\n" + err.StackTrace);
}
catch (Exception)
{
//Do not rethrow. Exception from error logger that has already been garbage collected
}
}
}
/// <summary>
///
/// </summary>
public bool FrontPanelEnabled
{
get
{
return false;
}
set
{
throw new NotImplementedException();
}
}
/// <summary>
///
/// </summary>
public InstrumentMetadata Info
{
get
{
throw new NotImplementedException();
}
}
/// <summary>
///
/// </summary>
public void Initialize()
{
Initialize(string.Empty);
}
/// <summary>
///
/// </summary>
/// <param name="fpga"></param>
public void Initialize(string fpga)
{
lock (_syncObj)
{
if (_state == State.Uninitialized)
{
if (_serialPort.IsOpen == false)
{
_serialPort.Open();
}
//ClearBuffer();
_state = State.Ready;
}
else
{
throw new Exception("expected the state to be Uninitialized, state was: " + _state.ToString() + " on card " + _name);
}
}
}
/// <summary>
///
/// </summary>
public string Name
{
get
{
return _name;
}
set { _name = value; }
}
/// <summary>
///
/// </summary>
/// <returns></returns>
public SelfTestResult PerformSelfTest()
{
_selfTestResult = SelfTestResult.Unknown;
return _selfTestResult;
}
/// <summary>
///
/// </summary>
/// <param name="fpga"></param>
/// <param name="address"></param>
/// <returns></returns>
public uint Read(string fpga, uint address)
{
// lock up the FPGA resource
lock (_syncObj)
{
string hexAddress = "0x" + address.ToString("X8");
string commandToSend = _readFormat.Replace("<ADDRESS>", hexAddress);
commandToSend = commandToSend.Trim();
_serialPort.Write(commandToSend);
Thread.Sleep((int)_delayBeforeReadMs);
int numBytesRead = _serialPort.Read(_readBuf, 0, _readBuf.Length);
string data = Encoding.UTF8.GetString(_readBuf, 0, _readBuf.Length);
// get rid of new lines
data = data.Replace("\r", " ");
data = data.Replace("\n", " ");
data = data.Trim();
uint dataToReturn = Convert.ToUInt32(data, 16);
return dataToReturn;
}
}
/// <summary>
///
/// </summary>
/// <param name="fpgaName"></param>
/// <param name="address"></param>
/// <param name="numberOfWordsToRead"></param>
/// <param name="shallWeIncrementAddress"></param>
/// <param name="dataRead"></param>
public void ReadBlock(string fpgaName, uint address, uint numberOfWordsToRead, bool shallWeIncrementAddress, ref uint[] dataRead)
{
// lock up the FPGA resource
lock (_syncObj)
{
Thread.Sleep((int)_delayBeforeReadMs);
int bytesRead = _serialPort.Read(_readBuf, 0, _readBuf.Length);
int bytesToCopy = Math.Min(bytesRead, dataRead.Length);
Array.Copy(_readBuf, dataRead, bytesToCopy);
Array.Clear(_readBuf, 0, _readBuf.Length);
}
}
/// <summary>
///
/// </summary>
public void Reset()
{
Shutdown();
Initialize();
}
/// <summary>
///
/// </summary>
public SelfTestResult SelfTestResult
{
get
{
return _selfTestResult;
}
}
/// <summary>
///
/// </summary>
public State Status
{
get
{
return _state;
}
}
/// <summary>
///
/// </summary>
public void Shutdown()
{
// lock up the FPGA resource
lock (_syncObj)
{
if (_state == State.Ready)
{
_serialPort.Dispose();
_state = State.Uninitialized;
}
}
}
/// <summary>
///
/// </summary>
/// <param name="fpga"></param>
/// <param name="address"></param>
/// <param name="data"></param>
public void Write(string fpga, uint address, uint data)
{
// lock up the FPGA resource
lock (_syncObj)
{
string hexAddress = "0x" + address.ToString("X8");
string hexData = "0x" + data.ToString("X8");
string commandToSend = _writeFormat.Replace("<ADDRESS>", hexAddress);
commandToSend = commandToSend.Replace("<DATA>", hexData);
commandToSend = commandToSend.Trim();
_serialPort.Write(commandToSend);
}
}
/// <summary>
///
/// </summary>
/// <param name="fpgaName"></param>
/// <param name="address"></param>
/// <param name="numberOfWordsToWrite"></param>
/// <param name="data"></param>
/// <param name="shallWeIncrementAddress"></param>
public void WriteBlock(string fpgaName, uint address, uint numberOfWordsToWrite, uint[] data, bool shallWeIncrementAddress)
{
// lock up the FPGA resource
lock (_syncObj)
{
throw new Exception("Not Implemented");
}
}
/// <summary>
/// Loads firmware
/// </summary>
/// <param name="fpgaName"></param>
public void LoadFirmware(string fpgaName)
{
Initialize(fpgaName);
}
#endregion
}
}

139
Source/TSRealLib/HAL/Implementations/FPGA/CustomAsciiSerial/CommFpgaCustomAsciiSerialFactory.cs Normal file
View File

@@ -0,0 +1,139 @@
// **********************************************************************************************************
// CommFpgaCustomAsciiSerialFactory.cs
// 2/20/2023
// NGI - Next Generation Interceptor
//
// Contract No. HQ0856-21-C-0003/1022000209
//
// THIS DOCUMENT DOES NOT CONTAIN TECHNOLOGY OR TECHNICAL DATA CONTROLLED UNDER EITHER THE U.S.
// INTERNATIONAL TRAFFIC IN ARMS REGULATIONS OR THE U.S. EXPORT ADMINISTRATION REGULATIONS.
//
// 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.
//
// UNPUBLISHED WORK - COPYRIGHT RAYTHEON COMPANY.
//
// DESTRUCTION NOTICE: FOR CLASSIFIED DOCUMENTS FOLLOW THE PROCEDURES IN DOD 5220.22-M,
// NATIONAL INDUSTRIAL SECURITY PROGRAM OPERATING MANUAL, FEBRUARY 2006,
// INCORPORATING CHANGE 1, MARCH 28, 2013, CHAPTER 5, SECTION 7, OR DODM 5200.01-VOLUME 3,
// DOD INFORMATION SECURITY PROGRAM: PROTECTION OF CLASSIFIED INFORMATION, ENCLOSURE 3,
// SECTION 17. FOR CONTROLLED UNCLASSIFIED INFORMATION FOLLOW THE PROCEDURES IN DODM 5200.01-VOLUME 4,
// INFORMATION SECURITY PROGRAM: CONTROLLED UNCLASSIFIED INFORMATION.
//
// CONTROLLED BY: MISSILE DEFENSE AGENCY
// CONTROLLED BY: GROUND-BASED MIDCOURSE DEFENSE PROGRAM OFFICE
// CUI CATEGORY: CTI
// DISTRIBUTION/DISSEMINATION CONTROL: F
// POC: Alex Kravchenko (1118268)
// **********************************************************************************************************
using NLog;
using Raytheon.Common;
using System;
using System.Collections.Generic;
using System.ComponentModel.Composition;
using System.IO;
using System.Reflection;
namespace Raytheon.Instruments
{
[ExportInstrumentFactory(ModelNumber = "CommFpgaCustomAsciiSerialFactory")]
public class CommFpgaCustomAsciiSerialFactory : IInstrumentFactory
{
/// <summary>
/// The supported interfaces
/// </summary>
private readonly List<Type> _supportedInterfaces = new List<Type>();
private ILogger _logger;
private readonly IConfigurationManager _configurationManager;
private const string DefaultConfigPath = @"C:\ProgramData\Raytheon\InstrumentManagerService";
private static string DefaultPath;
public CommFpgaCustomAsciiSerialFactory(string defaultConfigPath = DefaultConfigPath)
: this(null, defaultConfigPath)
{
}
/// <summary>
/// COECommDeviceInstrumentFactory injection constructor
/// </summary>
/// <param name="configManager"></param>
/// <param name="simEngine"></param>
/// <param name="logger"></param>
[ImportingConstructor]
public CommFpgaCustomAsciiSerialFactory([Import(AllowDefault = false)] IConfigurationManager configManager,
[Import(AllowDefault = true)] string defaultConfigPath = null)
{
DefaultPath = defaultConfigPath;
if (LogManager.Configuration == null)
{
var assemblyFolder = Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location);
LogManager.Configuration = new NLog.Config.XmlLoggingConfiguration(assemblyFolder + "\\nlog.config");
}
_configurationManager = configManager ?? GetConfigurationManager();
_supportedInterfaces.Add(typeof(IFpgaComm));
}
/// <summary>
/// Gets the instrument
/// </summary>
/// <param name="name"></param>
/// <returns></returns>
public IInstrument GetInstrument(string name)
{
try
{
_logger = LogManager.GetLogger(name);
return new CommFpgaCustomAsciiSerial(name, _configurationManager, _logger);
}
catch (Exception)
{
throw;
}
}
/// <summary>
/// Gets the instrument
/// </summary>
/// <param name="name"></param>
/// <returns></returns>
public object GetInstrument(string name, bool simulateHw)
{
try
{
_logger = LogManager.GetLogger(name);
if (simulateHw)
return new CommFpgaSim(name, _configurationManager, _logger);
else
return new CommFpgaCustomAsciiSerial(name, _configurationManager, _logger);
}
catch (Exception)
{
throw;
}
}
/// <summary>
/// Gets supported interfaces
/// </summary>
/// <returns></returns>
public ICollection<Type> GetSupportedInterfaces()
{
return _supportedInterfaces.ToArray();
}
/// <summary>
/// returns configuration based on the predefined path or default path c:/ProgramData/Raytheon/InstrumentManagerService
/// </summary>
/// <returns></returns>
private static IConfigurationManager GetConfigurationManager()
{
return string.IsNullOrEmpty(DefaultPath) ? new RaytheonConfigurationManager() : new RaytheonConfigurationManager(DefaultPath);
}
}
}

36
Source/TSRealLib/HAL/Implementations/FPGA/CustomAsciiSerial/CustomAsciiSerial.csproj Normal file
View File

@@ -0,0 +1,36 @@
<Project Sdk="Microsoft.NET.Sdk">
<Import Project="$(SolutionDir)Solution.props" />
<PropertyGroup>
<TargetFramework>net472</TargetFramework>
<AssemblyName>Raytheon.Instruments.FPGA.CustomAsciiSerial</AssemblyName>
<Product>Custom Ascii Serial implementation</Product>
<Description>FPGA Custom Ascii Serial implementation</Description>
<OutputType>Library</OutputType>
<!-- Static versioning (Suitable for Development) -->
<!-- Disable the line below for dynamic versioning -->
<Version>1.0.0</Version>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="NLog" Version="5.0.0" />
<PackageReference Include="Raytheon.Common" Version="1.0.0" />
<PackageReference Include="Raytheon.Instruments.FpgaComm.Contracts" Version="1.1.0" />
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\FpgaSim\FpgaSim.csproj" />
</ItemGroup>
<!-- Copy all *.dlls and *.pdb in the output folder to a temp folder -->
<Target Name="CopyFiles" AfterTargets="AfterBuild">
<ItemGroup>
<FILES_1 Include="$(OutDir)*.dll" />
<FILES_2 Include="$(OutDir)*.pdb" />
</ItemGroup>
<Copy SourceFiles="@(FILES_1)" DestinationFolder="$(HalTempFolder)" />
<Copy SourceFiles="@(FILES_2)" DestinationFolder="$(HalTempFolder)" />
</Target>
</Project>