discrete_rx_acquisition_trigger.cs

/*******************************************************************************
//
//   File:
//      discrete_rx_acquisition_trigger.cs
//
//     Copyright (c) MAX Technologies Inc. 1988-2019, All Rights Reserved. 
//           CONFIDENTIAL AND PROPRIETARY INFORMATION WHICH IS THE 
//                      PROPERTY OF MAX TECHNOLOGIES INC. 
//
//   This demo illustrates how to use the trigger functionality
//   to start acquisition on a receive channel.
//
//   The program first starts the acquisition and waits for bit 5 to be 1.
//   Aperiodic transmission is then done to fire the trigger.
//
//   Hardware Requirements:
//       - MAXT Flex or MAXT 500 series carrier with IPM with discrete channel
//       - loopback between TX and RX discrete channels.
//
*******************************************************************************/


//#define LOOPBACK
#define LOCAL


using System;
using static MAXT.MXFoundation.mxf;
using System.Runtime.InteropServices;
using System.Text;

namespace discrete_example
{
    class discrete_pulse_clock
    {
        const int MAX_TX_RECORDS_TO_TRANSMIT = 100;
        public static readonly UInt64 BUFFER_SIZE = (UInt64)(MAX_TX_RECORDS_TO_TRANSMIT * Marshal.SizeOf(typeof(MXF_DISCRETE_DATAREC))); // Space for at least 100 records

        static void Main(string[] args)
        {

            UInt32 rc;
            UInt64 server;
            UInt64 count = 0;
            var rxChannel = new UInt64[1];
            var txChannel = new UInt64[1];
            UInt64 rxBuffer = 0;
            UInt64 txBuffer = 0;
            IntPtr recDiscrete = IntPtr.Zero;
            UInt64 dev, mod, port;
            var condParam = new MXF_RXACQ_TRIG_COND_RDATA_DW_PARM();
            UInt64 condList = 0;
            UInt64 module = 0;
            UInt64 moduleType = 0;

            // Connect to services and initialize environment
#if LOCAL
            rc = mxfServerConnect("0.0.0.0", "", "", 0, out server);
#else
            rc = mxfServerConnect("192.168.0.1", "admin", "admin", 0, out server);
#endif

            if (rc != MAXT_SUCCESS)
            {
                Console.Write("Failed to connect; rc=0x%08x", rc);
                Console.Write("\nPress a key to terminate\n");
                Console.ReadKey();
                return;
            }

            // Initialize the server
            Console.Write("\nStarting\n");

            rc = mxfSystemInit(server);

            // Obtain the first Discrete RX channel (RX logical #0)
            if (rc == MAXT_SUCCESS)
                rc = mxfChannelAllGet(server, MXF_CLASS_DISCRETE, MXF_SCLASS_RX_CHANNEL, MXF_MODULE_ALL, 1, out count, rxChannel);

            // Obtain the first Discrete TX channel (TX logical #0)
            if (rc == MAXT_SUCCESS && count > 0)
                rc = mxfChannelAllGet(server, MXF_CLASS_DISCRETE, MXF_SCLASS_TX_CHANNEL, MXF_MODULE_ALL, 1, out count, txChannel);

            // If channel not found, return an error
            if (rc == MAXT_SUCCESS && count == 0)
                rc = MAXT_ERROR_NOT_FOUND;

            // Set timebase to computer time 64-bit microseconds
            if (rc == MAXT_SUCCESS)
                rc = mxfSystemTimeBaseSet(server, MXF_TIMEBASE_COMPUTER_USEC);

            // Get the physical port location
            if (rc == MAXT_SUCCESS)
            {
                rc = mxfChannelLocationGet(rxChannel[0], out dev, out mod, out port);
                if (rc == MAXT_SUCCESS)
                    Console.Write("Acquisition Channel (RX) location={0}.{1}.{2}\n", dev, mod, port);
            }

            if (rc == MAXT_SUCCESS)
            {
                rc = mxfChannelLocationGet(txChannel[0], out dev, out mod, out port);
                if (rc == MAXT_SUCCESS)
                    Console.Write("Transmitter Channel (TX) location={0}.{1}.{2}\n", dev, mod, port);
            }

            if (rc == MAXT_SUCCESS)
                rc = mxfChannelInfoGet(rxChannel[0], IntPtr.Zero, out module);

            if (rc == MAXT_SUCCESS)
                rc = mxfAttributeUint64Get(module, KMXF_MODULE_TYPE, out moduleType);

            if (rc == MAXT_SUCCESS)
            {
                if (moduleType == MXF_MODULE_DIOFIFO_EH)
                {
                    rc = mxfAttributeUint64Set(rxChannel[0], KMXF_DISCRETE_RX_PULSE_WIDTH_FILTER, 100);

                    //Activate loopback before transmission and reception
                    #if LOOPBACK
                    if (rc == MAXT_SUCCESS)
                        rc = mxfAttributeUint64Set(rxChannel[0], KMXF_DISCRETE_TX_RX_TEST_LB, VMXF_ENABLE);
                    #endif
                }
                else
                {
                    rc = mxfAttributeUint64Set(rxChannel[0], KMXF_DISCRETE_DIRECTION, 0x00ff);
                    if (rc == MAXT_SUCCESS)
                        rc = mxfAttributeUint64Set(rxChannel[0], KMXF_DISCRETE_RX_EDGE_FALLING, 0xff);

                    if (rc == MAXT_SUCCESS)
                        rc = mxfAttributeUint64Set(rxChannel[0], KMXF_DISCRETE_RX_EDGE_RISING, 0xff);
                }
            }

            // Allocate RX acquisition buffer
            if (rc == MAXT_SUCCESS)
                rc = mxfRxAcqBufferAlloc(rxChannel[0], BUFFER_SIZE, out rxBuffer, IntPtr.Zero);

            // Allocate TX Aperiodic buffer (1MiB)
            if (rc == MAXT_SUCCESS)
                rc = mxfTxAperiodicBufferAlloc(txChannel[0], 0, BUFFER_SIZE, out txBuffer, IntPtr.Zero);

            // Allocate host buffer
            if (rc == MAXT_SUCCESS)
            {
                try
                {
                    recDiscrete = Marshal.AllocHGlobal((int)BUFFER_SIZE);
                }
                catch (OutOfMemoryException)
                {
                    rc = MAXT_ERROR_MEM;
                }
            }

            // Configure trigger
            // Create the condition list
            if (rc == MAXT_SUCCESS)
                rc = mxfRxAcqTrigConditionListAlloc(server, out condList);

            // The condition will be triggered when bit 5 will be high
            if (rc == MAXT_SUCCESS)
            {
                condParam.mask = 1 << 5;
                condParam.data = 1 << 5;
                condParam.offset = 0;
                condParam.options = MXF_RXACQ_TRIG_COND_RDATA_OPTIONS_EQUAL;

                rc = mxfRxAcqTrigConditionAdd(condList, MXF_RXACQ_TRIG_COND_ID_RDATA_DW, ref condParam);
            }

            // Set the trigger with a pretrig count of 3 which allows some records to be read before the condition was triggered.
            // For discrete channel, this number is rounded to the closest internal acquisition buffer size.
            if (rc == MAXT_SUCCESS)
                rc = mxfRxAcqTrigSet(rxBuffer, condList, 3);

            // 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.Write("\nAcquisition started\n\r");
            }

            // Start discrete data transmission
            if (rc == MAXT_SUCCESS)
            {
                rc = TransmitAperiodicData(txBuffer, recDiscrete, moduleType);
                if (rc == MAXT_SUCCESS)
                {
                    // Read discrete data in acquisition buffer
                    rc = ReadAcquisitionData(rxBuffer, recDiscrete);
                }
            }

            // Stop and flush unread data
            if (rc == MAXT_SUCCESS)
                rc = mxfRxAcqStop(rxBuffer);
            if (rc == MAXT_SUCCESS)
            {
                rc = mxfRxAcqClear(rxBuffer);
                if (rc == MAXT_SUCCESS)
                    Console.Write("\nAcquisition stopped\n\r");
            }

            // Free trigger condition list
            if (rc == MAXT_SUCCESS)
                rc = mxfRxAcqTrigConditionListFree(condList);

            // Catch any previous error
            if (rc != MAXT_SUCCESS)
            {
                var buffer = new StringBuilder(256);
                if (mxfSystemErrorStringGet(server, rc, (UInt32)Marshal.SizeOf(buffer), buffer) != 0)
                    Console.Write(buffer + "ERROR # 0x{0:X8}", rc);

                Console.Write("{0}\n\r", buffer);
            }

            Console.Write("\nTerminating\n");

            if (recDiscrete != IntPtr.Zero)
                Marshal.FreeHGlobal(recDiscrete);

            mxfSystemTerminate(server);
            mxfServerDisconnect(server);

            Console.Write("\nPress enter to terminate\n");
            Console.ReadKey();

            return;
        }

        /***************************************************************************************************************/
        //   TransmitAperiodicData
        /***************************************************************************************************************/

        private static UInt32 TransmitAperiodicData(UInt64 txBuffer, IntPtr recDiscrete, UInt64 moduleType)
        {
            UInt32 rc;
            IntPtr recPtr = recDiscrete;
            MXF_DISCRETE_DATAREC rec = new MXF_DISCRETE_DATAREC();
            UInt64 data;
            UInt64 startTime = 100 * 1000; //100 msec
            UInt64 delay = 1 * 1000;  //1 msec

            // Prepare data
            for (data = 0; data < MAX_TX_RECORDS_TO_TRANSMIT; data++)
            {
                rec.timeTag = startTime + (data * delay); // 1 msec between each
                rec.control = 0;
                rec.repeatCount = 1;
                rec.highDuration = 0;
                rec.lowDuration = 0;
                rec.data = (UInt16)data;
                rec.edge = (uint)((moduleType == MXF_MODULE_DIOFIFO_EH) ? 0xffff : 0);

                Marshal.StructureToPtr(rec, recPtr, true);

                mxfNextRecordPtrGet(MXF_CLASS_DISCRETE, MXF_RECTYPE_DATAREC, recPtr, out recPtr);
            }

            Console.Write("Transmitting ...\n");
            rc = mxfTxAperiodicWrite(txBuffer, MXF_TXAPERIODIC_FLAG_USE_RECORD_RELATIVE_TIME, 0, MAX_TX_RECORDS_TO_TRANSMIT, recDiscrete);

            // Wait a little for transmission to occur
            if (rc == MAXT_SUCCESS)
                mxfSleep(1000);

            return rc;
        }

        /***************************************************************************************************************/
        //   ReadAcquisitionData
        /***************************************************************************************************************/

        private static UInt32 ReadAcquisitionData(UInt64 rxBuffer, IntPtr recDiscrete)
        {
            MXF_DISCRETE_DATAREC rec = new MXF_DISCRETE_DATAREC();
            IntPtr recPtr = recDiscrete;
            UInt64 status, msgsCount, bytesCount, pendingBytes, freeBytes;
            UInt64 j, trigTime = 0;
            UInt32 rc;

            UInt64 usec;
            var offset = TimeZoneInfo.Local.GetUtcOffset(DateTime.UtcNow);
            var time = new DateTime(1970, 1, 1).AddTicks(offset.Ticks); //create a time object set to jan 01 1970 in current timezone

            // Check trigger happened
            rc = mxfRxAcqBufferStatusGet(rxBuffer, out status, out msgsCount, out pendingBytes, out freeBytes);
            if (rc == MAXT_SUCCESS)
            {
                if ((status & MXF_RXACQ_STATUS_TRIG_OCCURRED) > 0)
                {
                    // Display the acquisition trigger time
                    rc = mxfRxAcqTrigTimeGet(rxBuffer, out trigTime);
                    if (rc == MAXT_SUCCESS)
                    {
                        time = time.AddMilliseconds(trigTime / 1000);
                        usec = trigTime % 1000;

                        Console.WriteLine("Event triggered at {0}:{1:000}", time.ToString("yyyy-MM-dd HH:mm:ss:fff"), usec);;
                    }
                }
                else
                    Console.Write("Trigger not fired\n");
            }

            // Read and display records
            rc = mxfDiscreteRxAcqRead(rxBuffer, 0, BUFFER_SIZE, out status, out msgsCount, out bytesCount, recDiscrete);
            for (j = 0; j < msgsCount && rc == MAXT_SUCCESS; j++)
            {
                rec = (MXF_DISCRETE_DATAREC)Marshal.PtrToStructure(recPtr, typeof(MXF_DISCRETE_DATAREC));

                Console.Write("   {0:00}: Timetag={1}, Data=0x{2:x4} {3}\n", j, rec.timeTag, rec.data, trigTime == rec.timeTag ? " *" : "");

                mxfNextRecordPtrGet(MXF_CLASS_DISCRETE, MXF_RECTYPE_DATAREC, recPtr, out recPtr);
            }

            return rc;
        }

    }
}