ar708_periodic.c

/******************************************************************************
//
//    File:
//       ar708_periodic.c
//
//       Copyright (c) MAX Technologies Inc. 1988-2015, All Rights Reserved.
//             CONFIDENTIAL AND PROPRIETARY INFORMATION WHICH IS THE 
//                         PROPERTY OF MAX TECHNOLOGIES INC. 
//
//    This demo shows how to set a basic periodic transmission 
//    based on ARINC 708 protocol.
//
//       Hardware requirements:
//          - MAXT Flex with A708 option.
//          - Loopback between TX and RX channels if internal loopback is not used.
//
*******************************************************************************/

#include "example.h"

//#define LOOPBACK
//#define LOCAL

#define MAX_TX_RECORDS_TO_TRANSMIT  32
#define BUFFER_SIZE                 MAX_TX_RECORDS_TO_TRANSMIT*sizeof(MXF_A708_DATAREC)

uint32 ReadAcquisitionData(HMXF_BUFFER rxBuffer, MXF_A708_DATAREC *recA708);
void DisplayDataArray(uint64 recNum, MXF_A708_DATAREC* rec);
uint32 PeriodicScheduling(HMXF_CHANNEL txChannel, HMXF_BUFFER *txBuffer, MXF_A708_DATAREC *recA708);

/***************************************************************************************************************/
//   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;
MXF_A708_DATAREC *rec=NULL;
uint64 dev, mod, port;
uint64 moduleCount=0, channelCount;
   
   // Connects to services and initialize environment
#ifdef LOCAL
   rc = mxfServerConnect("0.0.0.0", "", "", FALSE, &server);
#else
   rc = mxfServerConnect("192.168.0.1", "admin", "admin", FALSE, &server);
#endif

   // Initializes MX Foundation library
   if (!rc)
   {
      printf("Starting ...\n");
      rc = mxfSystemInit(server);
   }

   // Gets the device handle 
   if (!rc)
      rc = mxfSystemDeviceGet(server, 0, &device);

   // Gets handle of first ARINC 708 module
   if (!rc)
      rc = mxfDeviceModuleAllGet(device, MXF_MODULE_A708_EH, 1, &moduleCount, &module);

   // If module not found, return an error
   if(!rc && !moduleCount)
      rc = MAXT_ERROR_NOT_FOUND;

   // Activates the ARINC 708 module (because the MIL-STD-1553 is by default activated, except on FM1553-2)
   if (!rc)
   {
      rc = mxfAttributeUint64Set(module, KMXF_A708_MODULE_ACTIVE, TRUE);
      if (rc == MAXT_ERROR_NOT_SUPPORTED) // Attribute not supported on FM1553-2, simply ignore
         rc = MAXT_SUCCESS;
   }

   // Gets handle of first ARINC 708 RX channel
   if(!rc)
      rc = mxfModuleChannelAllGet(module, MXF_CLASS_A708, MXF_SCLASS_RX_CHANNEL, 1, &channelCount, &rxChannel);

   // Gets handle of first ARINC 708 TX channel
   if (!rc)
      rc = mxfModuleChannelAllGet(module, MXF_CLASS_A708, MXF_SCLASS_TX_CHANNEL, 1, &channelCount, &txChannel);

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

   // Set timebase to 64-bit microseconds
   if (!rc)
      rc = mxfSystemTimeBaseSet(server, MXF_TIMEBASE_DEVICE_USEC);
   
   // Get the physical port location
   if (!rc)
   {
      rc = mxfChannelLocationGet(rxChannel, &dev, &mod, &port);
      if (!rc)
         printf("Acquisition Channel (RX) location=%llu.%llu.%llu\n", dev, mod, port);
   }

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

   // Allocate RX acquisition buffer
   if (!rc)
      rc = mxfRxAcqBufferAlloc(rxChannel, BUFFER_SIZE, &rxBuffer, NULL);

   // Allocate TX Periodic Update buffer
   if(!rc)
      rc = mxfTxPeriodicUpdateMsgBufferAlloc(txChannel, 0, BUFFER_SIZE, &txBuffer, NULL);

   // Allocate host buffer
   if (!rc)
   {
      rec = (MXF_A708_DATAREC*)malloc(BUFFER_SIZE);
      if (!rec)
         rc = MAXT_ERROR_MEM;
   }

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

   // Start data transmission
   if (!rc)
   {
      rc = PeriodicScheduling(txChannel, &txBuffer, rec);
      if (!rc)
      {
         // Read data in acquisition buffer
         rc = ReadAcquisitionData(rxBuffer, rec);
      }
   }

   // Stop and flush unread data
   if (!rc)
      rc = mxfRxAcqStop(rxBuffer);
   if (!rc)
   {
      rc = mxfRxAcqClear(rxBuffer);
      if (!rc)
         printf("\nAcquisition stopped\n\r");
   }

   // Catch any previous error
   if (rc)
   {
   char buffer[256];
      rc = mxfSystemErrorStringGet(server, rc, sizeof(buffer), buffer);
      printf("%s\n", buffer);
   }
   
   printf("\nTerminating\n");
   
   // Free all buffers and terminate
   if (rxBuffer)
      mxfRxAcqBufferFree(rxBuffer);

   if (txBuffer)
      mxfTxPeriodicUpdateMsgBufferFree(txBuffer);

   if (rec)
      free(rec);
   
   mxfSystemTerminate(server);
   mxfServerDisconnect(server);

   printf("\nPress enter to terminate\n");
   getchar();

   return rc;
}

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

uint32 ReadAcquisitionData(HMXF_BUFFER rxBuffer, MXF_A708_DATAREC *recA708)
{
uint64 status, msgsCount, bytesCount;
uint32 rc;

   // Read and display records
   rc = mxfA708RxAcqRead(rxBuffer, 0, BUFFER_SIZE, &status, &msgsCount, &bytesCount, recA708);
   if(!rc)
      DisplayDataArray(msgsCount, recA708);

   return rc;
}

/***************************************************************************************************************/
//   PeriodicScheduling
/***************************************************************************************************************/

uint32 PeriodicScheduling(HMXF_CHANNEL txChannel, HMXF_BUFFER *txBuffer, MXF_A708_DATAREC *recA708)
{
HMXF_SCHED schedule;
HMXF_SCHED_MSG msg=0;
MXF_A708_DATAREC *rec;
uint32 rc;
uint64 data, word;
   
   // Create the periodic scheduler
   rc = mxfTxPeriodicScheduleNew(txChannel, &schedule);

   // Set scheduling values: Rate=5 ms, Phase=0 us
   if(!rc)
      rc = mxfTxPeriodicScheduleMsgAdd(schedule, 5000, 0, &msg);

   // Define the number of buffer for the list and link to it
   if(!rc)
      rc = mxfTxPeriodicScheduleBufferListAdd(msg, 1, 0, txBuffer);
   
   // Set records for the buffers
   if(!rc)
   {
      rec = recA708;
      //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->manchesterBitErr = 0;
         rec->dataSize  = 200;         //200 bytes corresponds to 1600 bits (see ARINC 708 specification)
         for(word=0; word < rec->dataSize/2; word++)     //The first 8 bits of each message have to be 055
         {
            switch(word)
            {
            case 0:
               rec->data[word] = 055; // Label
               break;
            case 1:
            case 2:
            case 3:
            case 4:
               rec->data[word] = 0x0000;
               break;
            default:
              rec->data[word] = (uint16)(0x0101*data);
            }
         }
         rc = mxfA708NextDataRecordPtrGet(rec, &rec);
      }
   }

   //DisplayDataArray(MAX_TX_RECORDS_TO_TRANSMIT, recA708);
   if (!rc)
      rc = mxfA708TxPeriodicUpdateMsgWrite(*txBuffer, MAX_TX_RECORDS_TO_TRANSMIT, recA708);

   //  Run the scheduler, update records
   if(!rc)
   {
      printf("Running periodic transmission, please wait...\n\r");
   
      // Run the schedule now
      rc = mxfTxPeriodicScheduleRun(schedule);
   }

   // Wait for transmission
   if(!rc)
   {
      mxfSleep(1000);
   
      rc = mxfTxPeriodicScheduleFree(schedule);
   }

   if(!rc)
      printf("\n\rTransmission stopped\n\r");
   
   return rc;
}

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

   printf("\n");
   for(iRec=0; iRec < recNum; iRec++)
   {
      printf("%03llu %010llu 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");

      mxfA708NextDataRecordPtrGet(p, &p);
   }
}