hfce_aperiodic.c

/*******************************************************************************
//
//   File:
//       hfce_aperiodic.c
//
//       Copyright (c) MAX Technologies Inc. 1988-2020, All Rights Reserved.
//             CONFIDENTIAL AND PROPRIETARY INFORMATION WHICH IS THE 
//                         PROPERTY OF MAX TECHNOLOGIES INC. 
//
//    This demo shows how to use the different types of aperiodic transmissions
//    with HFCE channels.
//
//    Hardware Requirements:
//          - 500 series carrier with IPM-HFCE
//          - loopback between TX0 and RX0
//
*******************************************************************************/

#include "example.h"

#define LOOPBACK

#define MAX_TX_RECORDS_TO_TRANSMIT 8
#define BUFFER_SIZE     (MAX_TX_RECORDS_TO_TRANSMIT*sizeof(MXF_HFCE_DATAREC))
#define LABEL 0xCD10
#define PAYLOAD_SIZE 6

void DisplayDataArray(uint64 recNum, MXF_HFCE_DATAREC* rec);
uint32 ReadAcquisitionData(HMXF_BUFFER rxBuffer,  MXF_HFCE_DATAREC* rxHostBuffer);
uint32 StartAperiodicTransmissionDefault(HMXF_BUFFER txBuffer, MXF_HFCE_DATAREC* txHostBuffer);
uint32 StartAperiodicTransmissionAbsolute(HMXF_DEVICE device, HMXF_BUFFER txBuffer, MXF_HFCE_DATAREC* txHostBuffer);
uint32 StartAperiodicTransmissionRecordAbsolute(HMXF_DEVICE device, HMXF_BUFFER txBuffer, MXF_HFCE_DATAREC* txHostBuffer);
uint32 StartAperiodicTransmissionRecordRelative(HMXF_BUFFER txBuffer, MXF_HFCE_DATAREC* txHostBuffer);

/***************************************************************************************************************/
//   Main
/***************************************************************************************************************/

int main(void)
{
uint32 rc;
HMXF_SERVER  server;
HMXF_DEVICE  device=0;
HMXF_MODULE  module=0;
HMXF_CHANNEL rxChannel=0;
HMXF_CHANNEL txChannel=0;
HMXF_BUFFER  rxBuffer=0;
HMXF_BUFFER  txBuffer=0;
size_t       txBufferSize=0;
size_t       rxBufferSize=0;
MXF_HFCE_DATAREC*    rxHostBuffer=0;
MXF_HFCE_DATAREC*    txHostBuffer=0;
uint64 dev, mod, port;
   
   // Connect to services local or remote 
   rc = mxfServerConnect("0.0.0.0", "", "", FALSE, &server);

   if (rc)
   {
      printf("Failed to connect; rc=0x%08x", rc);
      printf("\nPress a key to terminate\n");
      getchar();
      return 0;
   }

   // Initialize the server
   printf("\nStarting\n");
   
   if(!rc)
      rc = mxfSystemInit(server);

   // Gets handle of first HFCE RX channel
   if(!rc)
      rc = mxfChannelGet(server, MXF_CLASS_HFCE, MXF_SCLASS_RX_CHANNEL, MXF_MODULE_ALL, 0, &rxChannel);

   // Gets handle of first HFCE TX channel
   if (!rc)
      rc = mxfChannelGet(server, MXF_CLASS_HFCE, MXF_SCLASS_TX_CHANNEL, MXF_MODULE_ALL, 0, &txChannel);

   if(!rc)
      rc = mxfChannelInfoGet(txChannel, &device, &module);

   //Set speed
   if (!rc)
      rc = mxfAttributeUint64Set(txChannel, KMXF_HFCE_SPEED, 400000);

   if(!rc)
      rc = mxfAttributeUint64Set(rxChannel, KMXF_HFCE_SPEED, 400000);

   // Sets interframe idle pattern
   if (!rc)
      rc = mxfAttributeUint64Set(txChannel, KMXF_HFCE_TX_INTERFRAME_TIME_FILL, VMXF_HFCE_TX_INTERFRAME_TIME_FILL_IDLE_PATTERN);

   // Enables loopback
   #ifdef LOOPBACK
   if(!rc)
      rc = mxfAttributeUint64Set(rxChannel, KMXF_HFCE_TX_RX_TEST_LB, VMXF_ENABLE);
   #endif

   // Allocates buffer for tx data
   if(!rc)
   {
      txBufferSize = BUFFER_SIZE;

      // Allocates TX Aperiodic static buffer for HIGH priority queue
      rc = mxfTxAperiodicBufferAlloc(txChannel, MXF_TXAPERIODIC_PRIORITY_HIGH, txBufferSize, &txBuffer, NULL);

      // Host buffer allocation
      if(!rc)
      {
         txHostBuffer = (MXF_HFCE_DATAREC*) calloc(1, txBufferSize);
         if(!txHostBuffer)
            rc = MAXT_ERROR_MEM;
      }
   }

   // Allocates buffer for RX data
   if(!rc)
   {
      rxBufferSize = BUFFER_SIZE;

      // Allocates RX acquisition static buffer
      rc = mxfRxAcqBufferAlloc(rxChannel, rxBufferSize, &rxBuffer,NULL);

      // Host buffer allocation
      if(!rc)
      {
         rxHostBuffer = (MXF_HFCE_DATAREC*) calloc(1, rxBufferSize);
         if(!rxHostBuffer)
            rc = MAXT_ERROR_MEM;
      }
   }

   // Sets timebase to RTC nsec
   if(!rc)
      rc = mxfSystemTimeBaseSet(server, MXF_TIMEBASE_DEVICE_NSEC);
   
   // Gets the physical port location
   if (!rc)
   {
      rc = mxfChannelLocationGet(rxChannel, &dev, &mod, &port);
      if (!rc)
         printf("Acquisition Channel (RX) location=%"PRIu64".%"PRIu64".%"PRIu64"\n", dev, mod, port);
   }

   if (!rc)
   {
      rc = mxfChannelLocationGet(txChannel, &dev, &mod, &port);
      if (!rc)
         printf("Transmitter Channel (TX) location=%"PRIu64".%"PRIu64".%"PRIu64"\n", dev, mod, port);
   }

    // Starts the acquisition process
   if (!rc)
      rc = mxfRxAcqModeSet(rxBuffer, MXF_RXACQ_MODE_LINEAR);
   
   if (!rc)
      rc = mxfRxAcqStart(rxBuffer, MXF_RXACQ_FLAG_DEFAULT, 0, 0);

   if(!rc)
      mxfSleep(100);

   if (!rc)
   {
      // Starts HDLC data transmission
      rc = StartAperiodicTransmissionDefault(txBuffer, txHostBuffer);
      if (!rc)
         rc = ReadAcquisitionData(rxBuffer, rxHostBuffer);
      if (!rc)
         rc = StartAperiodicTransmissionAbsolute(device, txBuffer, txHostBuffer);
      if (!rc)
         rc = ReadAcquisitionData(rxBuffer, rxHostBuffer);
      if (!rc)
         rc = StartAperiodicTransmissionRecordAbsolute(device, txBuffer, txHostBuffer);
      if (!rc)
         rc = ReadAcquisitionData(rxBuffer, rxHostBuffer);
      if (!rc)
         rc = StartAperiodicTransmissionRecordRelative(txBuffer, rxHostBuffer);
      if (!rc)
         rc = ReadAcquisitionData(rxBuffer, rxHostBuffer);
   }
   
   // Stops acquisition
   if(!rc)
      rc = mxfRxAcqStop(rxBuffer);

   // Frees device and host buffers
   if(txBuffer)
      mxfTxAperiodicBufferFree(txBuffer);
   if(rxBuffer)
      mxfRxAcqBufferFree(rxBuffer);

   if(txHostBuffer)
      free(txHostBuffer);
   if(rxHostBuffer)
      free(rxHostBuffer);

   if(rc)
   {
   char errorString[200];

      if(mxfSystemErrorStringGet(server, rc, sizeof(errorString), errorString))
         sprintf (errorString,"ERROR # 0x%X", rc);

      printf("%s\n\r", errorString);
   }

   printf("Terminating ...\n");

   // Unloads MX Foundation library
   mxfSystemTerminate(server);

   // Disconnects from MX Foundation library
   mxfServerDisconnect(server);

   printf("\nPress a key to terminate\n");
   getchar();

   return rc;
}

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

uint32 ReadAcquisitionData(HMXF_BUFFER rxBuffer, MXF_HFCE_DATAREC* rxHostBuffer)
{
uint64 status, msgsCount, bytesCount;
uint32 rc;

   // Reads and displays records
   printf("Receiving ...\n");
   rc = mxfHFCERxAcqRead(rxBuffer, 0, BUFFER_SIZE, &status, &msgsCount, &bytesCount, rxHostBuffer);
   if(!rc)
   {
      printf("String received count = %"PRIu64" \n", msgsCount);

      // Displays received strings
      DisplayDataArray(msgsCount, rxHostBuffer);
   }
   else
      printf("Acquisition read failed; rc=0x%08x\n\r", rc);

return rc;
}

/***************************************************************************************************************/
//   StartAperiodicTransmissionDefault
/***************************************************************************************************************/

uint32 StartAperiodicTransmissionDefault(HMXF_BUFFER txBuffer, MXF_HFCE_DATAREC* txHostBuffer)
{
MXF_HFCE_DATAREC* rec;
uint64 data, word;
uint32 rc=0;
uint16 ramp=0;
   
   //  In the example below the record are sent back-to-back 100 ms in the future.
   
   printf("\nAperiodic transmission (Relative Start Time-Default)\n");

   rec = txHostBuffer;
   //Prepares records to send for basic transmission/reception test
   for(data=0; data<MAX_TX_RECORDS_TO_TRANSMIT; data++)
   {
      rec->timeTag      = 0;
      rec->control      = 0;
      rec->repeatCount  = 1;
      rec->dataSize     = (PAYLOAD_SIZE+2)*2;
      rec->reserved     = 0;
      rec->data[0] = LABEL;
      rec->data[1] = PAYLOAD_SIZE;
      for(word=0; word < PAYLOAD_SIZE; word++, ramp++)
      {
         rec->data[word+2] = ramp;
      }
      rc = mxfHFCENextDataRecordPtrGet(rec, &rec);
   }

   if(!rc)
   {
      printf("\nTransmitting ...\n");
      // Transmits strings on relative record time
      rc = mxfHFCETxAperiodicWrite(txBuffer, MXF_TXAPERIODIC_FLAG_DEFAULT, 0, MAX_TX_RECORDS_TO_TRANSMIT, txHostBuffer);
   }

   if(!rc)
      mxfSleep(1000);

   return rc;
}

/***************************************************************************************************************/
//   StartAperiodicTransmissionAbsolute
/***************************************************************************************************************/

uint32 StartAperiodicTransmissionAbsolute(HMXF_DEVICE device, HMXF_BUFFER txBuffer, MXF_HFCE_DATAREC* txHostBuffer)
{
MXF_HFCE_DATAREC* rec;
uint32 rc;
uint32 delay100ms = 100000000;
uint64 currentTime;
uint64 data, word;
   
   // Get the current time
   rc = mxfDeviceTimerGet(device, &currentTime);
   if (rc)
      return rc;
   
   //  In the example below the option MXF_TXAPERIODIC_FLAG_ABSOLUTE_START_TIME
   //  is used. In this case the records are sent freely (no time clock control)
   //  with a start transmission time based on the device clock + 100ms in the future.
   
   printf("\nAperiodic transmission (Absolute)\n");

   if(!rc)
   {
      rec = txHostBuffer;
      //Prepares records to send for basic transmission/reception test
      for(data=0; data<MAX_TX_RECORDS_TO_TRANSMIT; data++)
      {
         rec->timeTag      = 0;
         rec->control      = 0;
         rec->repeatCount  = 1;
         rec->dataSize     = (PAYLOAD_SIZE+2)*2;
         rec->reserved     = 0;
         rec->data[0] = LABEL;
         rec->data[1] = PAYLOAD_SIZE;
         for(word=0; word < PAYLOAD_SIZE; word++)
         {
            rec->data[word+2] = (uint16)(0x1111*data);
         }
         rc = mxfHFCENextDataRecordPtrGet(rec, &rec);
      }
   }
    
   // Transmit the array of records
   if(!rc)
   {
      printf("\nTransmitting ...\n");
      rc = mxfHFCETxAperiodicWrite(txBuffer, MXF_TXAPERIODIC_FLAG_ABSOLUTE_START_TIME, currentTime+delay100ms, MAX_TX_RECORDS_TO_TRANSMIT, txHostBuffer);
   }

   if(!rc)
      mxfSleep(1000);
   
   return rc;
}

/***************************************************************************************************************/
//   StartAperiodicTransmissionRecordAbsolute
/***************************************************************************************************************/

uint32 StartAperiodicTransmissionRecordAbsolute(HMXF_DEVICE device, HMXF_BUFFER txBuffer, MXF_HFCE_DATAREC* txHostBuffer)
{
MXF_HFCE_DATAREC* rec;
uint64 currentTime;
uint32 rc;
uint64 data, word;
   
   //  In the example below the timetag in the record is set
   //  and the option MXF_TXAPERIODIC_FLAG_USE_RECORD_ABSOLUTE_TIME
   //  In this case the records are sent based on the absolute clock
   //  timing specified in the timetag field for each records.
   
   printf("\nAperiodic transmission (Absolute with timetag)\n");
   
   // Get the current time
   rc = mxfDeviceTimerGet(device, &currentTime);
   if (rc)
      return rc;
   
   currentTime+=100000000;
   
   // Set the record
   // The scheduling timetag is as follow:
   // clock current time + 100 ms
   // Each record are sent with a timetag of 10 ms interval.

   if(!rc)
   {
      rec = txHostBuffer;
      //Prepares recordw to send for basic transmission/reception test
      for(data=0; data<MAX_TX_RECORDS_TO_TRANSMIT; data++)
      {
         rec->timeTag      = currentTime;
         rec->control      = 0;
         rec->repeatCount  = 1;
         rec->dataSize     = (PAYLOAD_SIZE+2)*2;
         rec->reserved     = 0;
         rec->data[0] = LABEL;
         rec->data[1] = PAYLOAD_SIZE;
         for(word=0; word < PAYLOAD_SIZE; word++)
         {
            rec->data[word+2] = (uint16)(0x1111*data);
         }
         currentTime += 10000000;
         rc = mxfHFCENextDataRecordPtrGet(rec, &rec);
      }
   }

   // Transmit the array of records
   if(!rc)
   {
      printf("\nTransmitting ...\n");
      rc = mxfHFCETxAperiodicWrite(txBuffer, MXF_TXAPERIODIC_FLAG_USE_RECORD_ABSOLUTE_TIME, 0, MAX_TX_RECORDS_TO_TRANSMIT, txHostBuffer);
   }

   if(!rc)
      mxfSleep(1000);
   
   return rc;
}

/***************************************************************************************************************/
//   StartAperiodicTransmissionRecordRelative
/***************************************************************************************************************/

uint32 StartAperiodicTransmissionRecordRelative(HMXF_BUFFER txBuffer, MXF_HFCE_DATAREC* txHostBuffer)
{
MXF_HFCE_DATAREC* rec;
uint64 currentTime;
uint32 rc=0;
uint64 data, word;
   
   //  In the example below the timetag in the record is set
   //  and the option MXF_TXAPERIODIC_FLAG_USE_RECORD_RELATIVE_TIME.
   //  The relative time between each records is set in the 
   //  timetag field of the record array.
   
   printf("\nAperiodic transmission (Record Relative)\n");
   
   // Set the record
   // The scheduling timetag is as follow:
   // clock current time + 100 ms
   // Each record are sent with a timetag a 10000 uS (10 ms) interval.

   if(!rc)
   {
      rec = txHostBuffer;
      //Prepares records to send for basic transmission/reception test
      for(data=0, currentTime=100000000; data<MAX_TX_RECORDS_TO_TRANSMIT; data++)
      {
         rec->timeTag      = currentTime;
         rec->control      = 0;
         rec->repeatCount  = 1;
         rec->dataSize     = (PAYLOAD_SIZE+2)*2;
         rec->reserved     = 0;
         rec->data[0] = LABEL;
         rec->data[1] = PAYLOAD_SIZE;
         for(word=0; word < PAYLOAD_SIZE; word++)
         {
            rec->data[word+2] = (uint16)(0x1010*data);
         }
         currentTime += 10000000;
         rc = mxfHFCENextDataRecordPtrGet(rec, &rec);
      }
   }

   // Transmit the array of records
   if(!rc)
   {
      printf("\nTransmitting ...\n");
      rc = mxfHFCETxAperiodicWrite(txBuffer, MXF_TXAPERIODIC_FLAG_USE_RECORD_RELATIVE_TIME, 0, MAX_TX_RECORDS_TO_TRANSMIT, txHostBuffer);
   }

   if(!rc)
      mxfSleep(1000);

   return rc;
}

void DisplayDataArray(uint64 recNum, MXF_HFCE_DATAREC* rec)
{
uint64 iRec,
       iData;
MXF_HFCE_DATAREC *p=rec;

   printf("\n");
   for(iRec=0; iRec < recNum; iRec++)
   {
      printf("%03"PRIu64" %010"PRIu64" 0x%08x %02u ", iRec, p->timeTag, p->control, p->dataSize);
      for (iData = 0; iData < p->dataSize / 2; iData++)
      {
         printf("%04x ", p->data[iData]);

         if (!((iData + 1) % 8) && (iData + 1 < p->dataSize / 2))
            printf("\n                             ");
      }

      printf("\n");

      mxfHFCENextDataRecordPtrGet(p, &p);
   }
}