MX Foundation 4
ar717.cs
/*****************************************************************************
//
// File:
// ar717.cs
//
// Copyright (c) MAX Technologies Inc. 1988-2019, All Rights Reserved.
// CONFIDENTIAL AND PROPRIETARY INFORMATION WHICH IS THE
// PROPERTY OF MAX TECHNOLOGIES INC.
//
// This example demonstrates the basic usage of ARINC 717 channel class
// for transmission and reception.
//
// Hardware requirements:
// - MAXT FlexMulti
// - Loopback between first TX and RX ARINC 717 channels if internal loopback is not used
//
*****************************************************************************/
#define LOOPBACK
//#define LOCAL
using System;
using static MAXT.MXFoundation.mxf;
using System.Runtime.InteropServices;
using System.Text;
namespace ar717_example
{
class ar717
{
const int MAX_TX_SUBFRAMES_TO_TRANSMIT = 4; //minimum 4 to have at least one full frame.
public static void Main(string[] args)
{
UInt32 rc;
UInt64 server = 0;
UInt64 device = 0;
var module = new UInt64[1];
var rxChannel = new UInt64[1];
var txChannel = new UInt64[1];
UInt64 rxBuffer = 0;
UInt64 txBuffer = 0;
IntPtr recPtr = IntPtr.Zero;
UInt64 moduleCount = 0;
UInt64 channelCount = 0;
uint txBufferSize = 0;
uint rxBufferSize = 0;
IntPtr rxHostBuffer = IntPtr.Zero;
IntPtr txHostBuffer = IntPtr.Zero;
UInt64 rxAcqStatus = 0;
UInt64 msgCount = 0;
UInt64 byteCount = 0;
UInt64 data;
UInt64 word, subframeSize;
int nbFrames = MAX_TX_SUBFRAMES_TO_TRANSMIT;
MXF_SYSTEM_INIT_ATTRIBUTE_UINT64_HANDLER _initHandler = initHandler;
{
data = new UInt16[8192]
};
// Connects to services and initialize environment
#if LOCAL
rc = mxfServerConnect("0.0.0.0", "", "", Convert.ToUInt64(false), out server);
#else
rc = mxfServerConnect("192.168.0.1", "admin", "admin", Convert.ToUInt64(false), out server);
#endif
if (rc != MAXT_SUCCESS)
{
Console.Write("Failed to connect; rc=0x{0:x8}", rc);
Console.WriteLine();
Console.WriteLine("Press a key to terminate");
Console.Read();
return;
}
// Initializes init callback handler to set first TX and RX channel to A717
if (rc == MAXT_SUCCESS)
// Initializes MX Foundation library
if (rc == MAXT_SUCCESS)
{
Console.Write("Starting ...\n");
rc = mxfSystemInit(server);
}
// Gets the device handle
if (rc == MAXT_SUCCESS)
rc = mxfSystemDeviceGet(server, 0, out device);
// Gets handle of first multi_eh module
if (rc == MAXT_SUCCESS)
rc = mxfDeviceModuleAllGet(device, MXF_MODULE_MULTI_EH, 1, out moduleCount, module);
if ((rc == MAXT_SUCCESS) && (moduleCount == 0))
rc = MAXT_ERROR_NOT_FOUND;
// Gets handle of first A717 RX channel
if (rc == MAXT_SUCCESS)
rc = mxfModuleChannelAllGet(module[0], MXF_CLASS_A717, MXF_SCLASS_RX_CHANNEL, 1, out channelCount, rxChannel);
// Gets handle of first A717 TX channel
if ((rc == MAXT_SUCCESS) && (channelCount != 0))
rc = mxfModuleChannelAllGet(module[0], MXF_CLASS_A717, MXF_SCLASS_TX_CHANNEL, 1, out channelCount, txChannel);
// If channel not found, returns an error
if ((rc == MAXT_SUCCESS) && (channelCount == 0))
rc = MAXT_ERROR_NOT_FOUND;
// Enables loopback
#if LOOPBACK
if (rc == MAXT_SUCCESS)
rc = mxfAttributeUint64Set(rxChannel[0], KMXF_A717_TX_RX_TEST_LB, VMXF_ENABLE);
#endif
if (nbFrames < 4)
{
if (rc == MAXT_SUCCESS)
Console.Write("Number of subframes to transmit less than 4: synchronization will not occur.\n");
}
// Allocates buffer for tx data
if (rc == MAXT_SUCCESS)
{
txBufferSize = (uint)(MAX_TX_SUBFRAMES_TO_TRANSMIT * Marshal.SizeOf(typeof(MXF_A717_DATAREC)));
// Allocates TX Aperiodic static buffer for HIGH priority queue
rc = mxfTxAperiodicBufferAlloc(txChannel[0], MXF_TXAPERIODIC_PRIORITY_HIGH, txBufferSize, out txBuffer, IntPtr.Zero);
// Host buffer allocation
if (rc == MAXT_SUCCESS)
{
try
{
txHostBuffer = Marshal.AllocHGlobal((int)txBufferSize);
}
catch (OutOfMemoryException)
{
rc = MAXT_ERROR_MEM;
}
}
}
// Allocates buffer for rx data
if (rc == MAXT_SUCCESS)
{
rxBufferSize = (uint)(MAX_TX_SUBFRAMES_TO_TRANSMIT * Marshal.SizeOf(typeof(MXF_A717_DATAREC)));
// Allocates RX acquisition static buffer
rc = mxfRxAcqBufferAlloc(rxChannel[0], rxBufferSize, out rxBuffer, IntPtr.Zero);
// Host buffer allocation
if (rc == MAXT_SUCCESS)
{
try
{
rxHostBuffer = Marshal.AllocHGlobal((int)rxBufferSize);
}
catch (OutOfMemoryException)
{
rc = MAXT_ERROR_MEM;
}
}
}
// Sets timebase to RTC nsec
if (rc == MAXT_SUCCESS)
rc = mxfSystemTimeBaseSet(server, MXF_TIMEBASE_DEVICE_NSEC);
// Sets RX & TX channels subframe size to 128 words
subframeSize = 128;
if (rc == MAXT_SUCCESS)
rc = mxfAttributeUint64Set(rxChannel[0], KMXF_A717_SUBFRAME_SIZE, subframeSize);
if (rc == MAXT_SUCCESS)
rc = mxfAttributeUint64Set(txChannel[0], KMXF_A717_SUBFRAME_SIZE, subframeSize);
// Sets RX & TX channels bit encoding to harvard
if (rc == MAXT_SUCCESS)
rc = mxfAttributeUint64Set(rxChannel[0], KMXF_A717_BIT_ENCODING, VMXF_A717_BIT_ENCODING_HARVARDBIPHASE);
if (rc == MAXT_SUCCESS)
rc = mxfAttributeUint64Set(txChannel[0], KMXF_A717_BIT_ENCODING, VMXF_A717_BIT_ENCODING_HARVARDBIPHASE);
// Sets RX & TX channels electrical selection to default
if (rc == MAXT_SUCCESS)
rc = mxfAttributeUint64Set(rxChannel[0], KMXF_A717_ELECTRICAL_SELECTION, VMXF_A717_ELECTRICAL_SELECT_DEFAULT);
if (rc == MAXT_SUCCESS)
rc = mxfAttributeUint64Set(txChannel[0], KMXF_A717_ELECTRICAL_SELECTION, VMXF_A717_ELECTRICAL_SELECT_DEFAULT);
// Starts acquisition
if (rc == MAXT_SUCCESS)
rc = mxfRxAcqStart(rxBuffer, MXF_RXACQ_FLAG_DEFAULT, 0, 0);
if (rc == MAXT_SUCCESS)
{
// Prepares string array
recPtr = txHostBuffer;
for (data = 0; data < MAX_TX_SUBFRAMES_TO_TRANSMIT; data++)
{
rec.timeTag = 0;
rec.control = 0;
rec.dataSize = 2 * (UInt32)subframeSize; // 16 bits per word in subframe
rec.repeatCount = 1;
rec.reserved = 0;
for (word = 0; word < subframeSize; word++)
{
if (word == 0)
{
//1st word of each subframe has to be a sync word
// sync words are:
// - 0x247 for subframe #0
// - 0x5B8 for subframe #1
// - 0xA47 for subframe #2
// - 0xDB8 for subframe #3
switch (data % 4)
{
case 0:
rec.data[word] = 0x247;
break;
case 1:
rec.data[word] = 0x5B8;
break;
case 2:
rec.data[word] = 0xA47;
break;
case 3:
rec.data[word] = 0xDB8;
break;
default:
break;
}
}
else
rec.data[word] = (UInt16)(0x11 * word);
}
Marshal.StructureToPtr(rec, recPtr, false);
rc = mxfA717NextDataRecordPtrGet(recPtr, out recPtr);
}
}
if (rc == MAXT_SUCCESS)
{
Console.Write("Transmitting ...\n");
// Transmits records with default option
rc = mxfA717TxAperiodicWrite(txBuffer, MXF_TXAPERIODIC_FLAG_DEFAULT, 0, MAX_TX_SUBFRAMES_TO_TRANSMIT, txHostBuffer);
}
if (rc == MAXT_SUCCESS)
mxfSleep((MAX_TX_SUBFRAMES_TO_TRANSMIT + 1) * 1000); // 1 second per subframe + 1 second to be sure to exceed the minimum duration to wait.
if (rc == MAXT_SUCCESS)
{
Console.Write("Receiving ...\n");
// Reads rx buffer
rc = mxfA717RxAcqRead(rxBuffer, 0, rxBufferSize, out rxAcqStatus, out msgCount, out byteCount, rxHostBuffer);
}
if (rc == MAXT_SUCCESS)
Console.Write("String received count = {0} \n", msgCount);
if (rc == MAXT_SUCCESS)
{
// Displays received strings
recPtr = rxHostBuffer;
for (data = 0; (data < msgCount) && (rc == MAXT_SUCCESS); data++)
{
rec = (MXF_A717_DATAREC)Marshal.PtrToStructure(recPtr, typeof(MXF_A717_DATAREC));
Console.Write("\n{0:D2}: Timetag={1:D12}, Size={2} words\n", data, rec.timeTag, (rec.dataSize) / 2);
for (word = 0; word < subframeSize; word++)
Console.Write("{0:X3} ", rec.data[word]);
Console.Write("\n");
mxfA717NextDataRecordPtrGet(recPtr, out recPtr);
}
}
// Stops acquisition
if (rc == MAXT_SUCCESS)
rc = mxfRxAcqStop(rxBuffer);
// Frees device and host buffers
if (rxBuffer != 0)
mxfRxAcqBufferFree(rxBuffer);
if (txBuffer != 0)
if (txHostBuffer != IntPtr.Zero)
Marshal.FreeHGlobal(txHostBuffer);
if (rxHostBuffer != IntPtr.Zero)
Marshal.FreeHGlobal(rxHostBuffer);
if (rc != MAXT_SUCCESS)
{
StringBuilder buffer = new StringBuilder(256);
if (mxfSystemErrorStringGet(server, rc, 256, buffer) != MAXT_SUCCESS)
buffer.Append(string.Format("ERROR # 0x{0:x8}", rc));
Console.WriteLine(buffer);
}
Console.Write("Terminating ...\n");
// Unloads MX Foundation library
// Disconnects from MX Foundation library
Console.Write("\nPress a key to terminate\n");
Console.Read();
return;
}
private static UInt32 initHandler(UInt64 server, UInt64 deviceIndex, UInt64 moduleIndex, UInt64 channelIndex, UInt64 attrib, ref UInt64 value)
{
UInt64 device = 0;
MXF_DEVICE_INFO deviceInfo = new MXF_DEVICE_INFO();
UInt32 rc;
server = server;
deviceIndex = deviceIndex;
if (attrib == KMXF_CHANNEL_CLASS)
{
rc = mxfSystemDeviceGet(server, deviceIndex, out device);
if (rc == MAXT_SUCCESS)
rc = mxfDeviceInfoGet(device, out deviceInfo);
if ((rc == MAXT_SUCCESS) && (deviceInfo.modules[moduleIndex].type == MXF_MODULE_MULTI_EH))
{
// Sets MXF_MODULE_MULTI_EH first TX and RX channels to A717
if ((channelIndex == 0) || (channelIndex == deviceInfo.modules[moduleIndex].txCount))
{
value = MXF_CLASS_A717;
return Convert.ToUInt32(true);
}
}
}
return Convert.ToUInt32(false);
}
}
}
Updated 10/23/2023