MX Foundation 4
ar629_aperiodic_frame.cs
/*****************************************************************************
//
// File:
// ar629_aperiodic_frame.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 aperiodic mode functionnality and the use of CID from XPP.
//
// It demonstrates how to:
//
// - Get handle to first TX channel with mxfModuleChannelAllGet().
// - Enable CID from XPP with mxfAttributeUint64Set().
// - Configure major frame with mxfA629TxPeriodicMajorFrameSet().
// - Write data to TX message queue with mxfA629TxPeriodicUpdateMsgWrite().
// - Start major frame with mxfA629TxPeriodicMajorFrameStart().
// - Stop major frame with mxfTxPeriodicMajorFrameStop().
//
// Hardware requirements:
// - MAXT FlexMulti-629.
//
*****************************************************************************/
#define TTL
//#define LOCAL
using System;
using static MAXT.MXFoundation.mxf;
using System.Runtime.InteropServices;
using System.Text;
namespace ar629_example
{
class ar629_aperiodic_frame
{
const int MAX_RX_RECORDS_TO_RECEIVE = 1000;
const int MAX_TX_RECORDS_TO_TRANSMIT = 1;
static void Main(string[] args)
{
int RX_BUFFER_SIZE = MAX_RX_RECORDS_TO_RECEIVE * Marshal.SizeOf(typeof(MXF_A629_DATAREC));
int TX_BUFFER_SIZE = MAX_TX_RECORDS_TO_TRANSMIT * Marshal.SizeOf(typeof(MXF_A629_DATAREC));
var aMinorFrame = new MXF_A629_TXPERIODIC_MJRFRAME_MSG[32];
var aRec629 = new MXF_A629_DATAREC[10];
aRec629[0].data = new UInt16[258];
IntPtr arec629Ptr = IntPtr.Zero;
IntPtr hostBuffer = IntPtr.Zero;
UInt64 server = 0;
UInt64 device = 0;
var module = new UInt64[1];
UInt64 count = 0;
var rxChannel = new UInt64[1];
var txChannel = new UInt64[1];
UInt64 rxBuffer = 0;
var txBuffer = new UInt64[2];
MXF_A629_TXPERIODIC_MJRFRAME_PROPERTIES majorProperties = new MXF_A629_TXPERIODIC_MJRFRAME_PROPERTIES();
UInt32 rc;
UInt64 index;
UInt64 status, msgsCount, bytesCount;
UInt32 TI;
UInt32 length;
int i=0;
// 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
// Initializes MX Foundation library
if (rc == MAXT_SUCCESS)
{
Console.WriteLine("Starting ...");
rc = mxfSystemInit(server);
}
// Gets the first device handle
if (rc == MAXT_SUCCESS)
rc = mxfSystemDeviceGet(server, 0, out device);
if (rc == MAXT_SUCCESS)
rc = mxfDeviceModuleAllGet(device, MXF_MODULE_A629MRT_EH, 1, out count, module);
// Obtains the first ARINC 629 Protocol RX channel (RX logical #0)
if ((rc == MAXT_SUCCESS) && (count != 0))
rc = mxfModuleChannelAllGet(module[0], MXF_CLASS_A629, MXF_SCLASS_RX_CHANNEL, 1, out count, rxChannel);
// Obtains the first ARINC 629 Protocol TX channel (TX logical #0)
if ((rc == MAXT_SUCCESS) && (count != 0))
rc = mxfModuleChannelAllGet(module[0], MXF_CLASS_A629, MXF_SCLASS_TX_CHANNEL, 1, out count, txChannel);
// If module or channel not found, returns an error
if ((rc == MAXT_SUCCESS) && (count == 0))
rc = MAXT_ERROR_NOT_FOUND;
// Sets timebase to 64-bit nanoseconds
if (rc == MAXT_SUCCESS)
rc = mxfSystemTimeBaseSet(server, MXF_TIMEBASE_DEVICE_NSEC);
// Sets interface to SIM or TTL
#if TTL
if (rc == MAXT_SUCCESS)
rc = mxfAttributeUint64Set(module[0], KMXF_A629_MODULE_INTERFACE, VMXF_A629_MODULE_INTERFACE_TTL);
#else
if (rc == MAXT_SUCCESS)
rc = mxfAttributeUint64Set(module[0], KMXF_A629_MODULE_INTERFACE, VMXF_A629_MODULE_INTERFACE_SIM);
#endif
// Allocates RX acquisition buffer
if (rc == MAXT_SUCCESS)
rc = mxfRxAcqBufferAlloc(rxChannel[0], (UInt64)RX_BUFFER_SIZE, out rxBuffer, IntPtr.Zero);
// Allocates two TX Periodic Update Message buffer
for (index = 0; (index < 2) && (rc == MAXT_SUCCESS); index++)
rc = mxfTxPeriodicUpdateMsgBufferAlloc(txChannel[0], index, (UInt64)TX_BUFFER_SIZE, out txBuffer[index], IntPtr.Zero);
// Allocates host buffer
if (rc == MAXT_SUCCESS)
{
try
{
hostBuffer = Marshal.AllocHGlobal(Math.Max(RX_BUFFER_SIZE, TX_BUFFER_SIZE));
}
catch (OutOfMemoryException)
{
rc = MAXT_ERROR_MEM;
}
try
{
arec629Ptr = Marshal.AllocHGlobal(Marshal.SizeOf(aRec629[0]));
}
catch (OutOfMemoryException)
{
rc = MAXT_ERROR_MEM;
}
}
// Enables the CID in XPP
if (rc == MAXT_SUCCESS)
rc = mxfAttributeUint64Set(module[0], KMXF_A629_MODULE_XPP_CID_ENABLE, VMXF_ENABLE);
// Start the acquisition process
if (rc == MAXT_SUCCESS)
rc = mxfRxAcqModeSet(rxBuffer, MXF_RXACQ_MODE_LINEAR);
if (rc == MAXT_SUCCESS)
{
rc = mxfRxAcqStart(rxBuffer, MXF_RXACQ_FLAG_DEFAULT, 0, 0);
if (rc == MAXT_SUCCESS)
{
Console.WriteLine();
Console.WriteLine("Acquisition started");
}
}
// Clears the major frame
if (rc == MAXT_SUCCESS)
rc = mxfTxPeriodicMajorFrameClear(txChannel[0], 0);
if (rc == MAXT_SUCCESS)
{
//--- Sets the minor frame #0 with 1 WordString --//
//WordString #0 : Label 0x1, CID 0xF
aMinorFrame[0].buffer = txBuffer[0];
aMinorFrame[0].label = 0x1;
aMinorFrame[0].cid = 0xF;
aMinorFrame[0].options = MXF_A629_TXPERIODIC_MJRFRAME_MSG_OPT_DEFAULT;
aMinorFrame[0].length = 1;
if (rc == MAXT_SUCCESS)
rc = mxfA629TxPeriodicMajorFrameSet(txChannel[0], 0, 0, 1, aMinorFrame);
}
if (rc == MAXT_SUCCESS)
{
//--- Sets the minor frame #1 with 1 WordString --//
//WordString #0 : Label 0x2, CID 0xE
aMinorFrame[0].buffer = txBuffer[1];
aMinorFrame[0].label = 0x2;
aMinorFrame[0].cid = 0xE;
aMinorFrame[0].options = MXF_A629_TXPERIODIC_MJRFRAME_MSG_OPT_DEFAULT;
aMinorFrame[0].length = 59;
if (rc == MAXT_SUCCESS)
rc = mxfA629TxPeriodicMajorFrameSet(txChannel[0], 0, 1, 1, aMinorFrame);
}
//--- Sets default data for label 0x1, CID 0xF ---//
if (rc == MAXT_SUCCESS)
{
//Sets the lentgh of this label/CID
length = 4; //4 bytes (label + 1 data word)
aRec629[0].control = 0;
aRec629[0].repeatCount = 1;
aRec629[0].dataSize = length;
aRec629[0].data[0] = 0;
aRec629[0].data[1] = 0x1104;
Marshal.StructureToPtr(aRec629[0], arec629Ptr, false);
rc = mxfA629TxPeriodicUpdateMsgWrite(txBuffer[0], 1, arec629Ptr);
}
//--- Set default data for label 0x2, CID 0xE ---//
if (rc == MAXT_SUCCESS)
{
//Set the lentgh of this label/CID
length = 120; //120 bytes (label + 59 data words)
aRec629[0].control = 0;
aRec629[0].repeatCount = 1;
aRec629[0].dataSize = length;
aRec629[0].data[0] = 0x0; // Not used
aRec629[0].data[1] = 0x0178;
for (i = 2; i < (int)length / 2; i++)
{
aRec629[0].data[i] = (UInt16)i;
}
Marshal.StructureToPtr(aRec629[0], arec629Ptr, false);
rc = mxfA629TxPeriodicUpdateMsgWrite(txBuffer[1], 1, arec629Ptr);
}
//------------------------------------------------//
//Starts the major frame in the Block mode
TI = 500000;
if (rc == MAXT_SUCCESS)
rc = mxfAttributeUint64Set(module[0], KMXF_A629_MODULE_TI, TI);
if (rc == MAXT_SUCCESS)
{
majorProperties.mode = MXF_A629_TXPERIODIC_MJRFRAME_PROPERTIES_MODE_BLOCK;
majorProperties.reserved = 0;
rc = mxfA629TxPeriodicMajorFrameStart(txChannel[0], 0, ref majorProperties);
}
//Waiting 10 seconds. Allows major frame to run a little bit.
mxfSleep(10000);
//Stop the major frame
if (rc == MAXT_SUCCESS)
rc = mxfTxPeriodicMajorFrameStop(txChannel[0], 0, 0);
// Stop acquisition and read data
if (rc == MAXT_SUCCESS)
rc = mxfRxAcqStop(rxBuffer);
if (rc == MAXT_SUCCESS)
{
rc = mxfA629RxAcqRead(rxBuffer, 0, (UInt64)RX_BUFFER_SIZE, out status, out msgsCount, out bytesCount, hostBuffer);
DisplayDataArray(msgsCount, hostBuffer);
}
//Disable the CID in XPP
if (rc == MAXT_SUCCESS)
rc = mxfAttributeUint64Set(txChannel[0], KMXF_A629_MODULE_XPP_CID_ENABLE, VMXF_DISABLE);
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.WriteLine("Terminating ...");
// Free all buffers and terminate
if (rxBuffer != 0)
mxfRxAcqBufferFree(rxBuffer);
for (index = 0; (index < 2) && (rc == MAXT_SUCCESS); index++)
{
if(txBuffer[index] != 0)
mxfTxPeriodicUpdateMsgBufferFree(txBuffer[index]);
}
if (hostBuffer != IntPtr.Zero)
Marshal.FreeHGlobal(hostBuffer);
if (arec629Ptr != IntPtr.Zero)
Marshal.FreeHGlobal(arec629Ptr);
// Unloads MX Foundation library
mxfSystemTerminate(server);
// Disconnects from MX Foundation library
mxfServerDisconnect(server);
Console.WriteLine();
Console.WriteLine("Press a key to terminatee");
Console.Read();
return;
}
private static void DisplayDataArray(UInt64 recNum, IntPtr rec)
{
UInt64 iRec,
iData;
IntPtr p = rec;
MXF_A629_DATAREC rec629 = new MXF_A629_DATAREC
{
data = new UInt16[258]
};
Console.WriteLine();
for (iRec = 0; iRec < recNum; iRec++)
{
rec629 = (MXF_A629_DATAREC)Marshal.PtrToStructure(p, typeof(MXF_A629_DATAREC));
Console.Write("{0:D3} {1:D10} {2:D2} ", iRec, rec629.timeTag, rec629.dataSize);
if ((rec629.control & MXF_A629_RX_REC_CTRL_STRING_CRC_ERROR) == MXF_A629_RX_REC_CTRL_STRING_CRC_ERROR)
Console.Write(" CRC error");
if ((rec629.control & MXF_A629_RX_REC_CTRL_STRING_DATA_SYNC_ERROR) == MXF_A629_RX_REC_CTRL_STRING_DATA_SYNC_ERROR)
Console.Write(" Data sync error");
if (((rec629.control & (MXF_A629_RX_REC_CTRL_STRING_LABEL_MANCHESTER_ERROR)) == (MXF_A629_RX_REC_CTRL_STRING_LABEL_MANCHESTER_ERROR)) ||
((rec629.control & (MXF_A629_RX_REC_CTRL_STRING_DATA_MANCHESTER_ERROR)) == (MXF_A629_RX_REC_CTRL_STRING_DATA_MANCHESTER_ERROR)))
Console.Write(" Manchester error ");
if (((rec629.control & (MXF_A629_RX_REC_CTRL_STRING_LABEL_PARITY_ERROR)) == (MXF_A629_RX_REC_CTRL_STRING_LABEL_PARITY_ERROR)) ||
((rec629.control & (MXF_A629_RX_REC_CTRL_STRING_DATA_PARITY_ERROR)) == (MXF_A629_RX_REC_CTRL_STRING_DATA_PARITY_ERROR)))
Console.Write(" Parity error ");
if ((rec629.control & MXF_A629_RX_REC_CTRL_STRING_EOS_ERROR) == MXF_A629_RX_REC_CTRL_STRING_EOS_ERROR)
Console.Write(" End of String error");
for (iData = 0; iData < rec629.dataSize / 2; iData++)
{
Console.Write("{0:x4} ", rec629.data[iData]);
if ((((iData + 1) % 8) == 0) && (iData + 1 < rec629.dataSize / 2))
Console.Write("\n ");
}
Console.WriteLine();
mxfA629NextDataRecordPtrGet(p, out p);
}
}
}
}
Updated 10/23/2023