Contents

Function Reference

Header File Reference

Functions

OtxHdlcEx API Functions - OtxHdlcExXXX()

OtxHdlcExXXX() Function Reference

OtxHdlcEx.h

Description

Parameters

hDevice

Handle to the HdlcEx device

Parameters

eDevType

Class of device we are looking for, as known by the module in question. See also OtxLogicalDeviceTypeE

hEventQueue

Handle to separate event queue (0 creates device specific event queue)

nEventSourceId

User specified ID to be used by this device as the Source ID for the events generated by the device

phLogicDevice

Handle to the new logical device (if result code OTX_S_OK)

Parameters

hDevice

Handle to the HdlcEx device

Developer Notes

Parameters

hDevice

Handle to the HdlcEx device

Developer Notes

Parameters

hHdlcDevice

Handle to the HDLC Device

pcoFrameBuffer

Maximum number of frames that the FIFO can contain for this device (if not limited by maximum number of bytes)

pcbOctetBuffer

Maximum number of bytes that the FIFO can contain for this device (if not limited by the number of frames)

pcbOctetsInUse

Number of bytes that the FIFO is currently using

pcoFramesInUse

Number of frames that the FIFO currently contains

pcbOctetsPeakUse

Maximum number of octets that the FIFO has ever used

pcoFramesPeakUse

Maximum number of frames that the FIFO has ever contained

pcoFramesLost

Number of frames lost due to a full FIFO condition

Parameters

hDevice

Handle to the HDLCEX device

pDataBuf

Data buffer

nBufLen

Amount/Size of data buffer

nBufUsed

Upon return, amount of buffer used or filled

Comments

For Thor8-PCI-Plus, Gimle-16-PCI-Plus 128 timeslots (4 spans) per burst highway. OTX_UINT8 Mask[128]; Mask[1+nSpan*32] = 0xff; OtxHdlcExSetTimeSlotMask(hDev,sizeof(Mask),Mask);

So in burst processing thread better to pass all data received from burst device and filter data using HdlcEx internal logics using OtxHdlcExSetTimeSlotMask

See Also

Parameters

phDevice

pointer to array of handles to HDLCEX devices

phDeviceSize

size of handle array

nBufFrameLen

Size of a single frame of the data buffer

pDataBuf

Data buffer

nBufLen

Amount/Size of data buffer (multiple of phDeviceSize)

nBufUsed

Upon return, amount of buffer used or filled

Comments

It is good idea to use this function if you have multiple HdlcEx devices hosted onthe same Burst Highway.

See Also

Parameters

phDevice

pointer to array of handles to HDLCEX devices

phDeviceSize

size of handle array

nBufFrameLen

Size of a single frame of the data buffer

pDataBuf

Data buffer

nBufLen

Amount/Size of data buffer (multiple of nBufFrameLen)

nFrameRefId

Reference ID of first frame in the buffer

dtFrameRefClock

Reference Time of first frame in the buffer

nBufUsed

Upon return, amount of buffer used or filled

Comments

This routine accepts frame reference data.

See Also

Parameters

hDevice

Handle to the HDLCEX device

pDataBuf

Data buffer

nBufLen

Amount/Size of data buffer

nFrameRefId

Reference ID of first frame in the buffer

dtFrameRefClock

Reference Time of first frame in the buffer

nBufUsed

Upon return, amount of buffer used or filled

Comments

This routine accepts frame reference data.

This function differs from original OtxHdlcExProcessIO only by correct timestamps added to the messages. So if you will need to measure data correct arrive time - use it.

See Also

Parameters

pDataBuf

Data buffer for the received data

nBufLen

Length of the user data buffer

pnFrameLen

Length of the received HDLC frame

pnFrameSeq

Sequence number of the received HDLC frame (matches the number in the event queue)

pnFrameEndCode

Frame Status Code

pnTimeStamp

Timestamp of the last received octet of the frame

Parameters

hDevice

Handle to the HdlcEx device

eFrameFillType

Fill character(s) to be send between HDLC frames. See also OtxHdlcFrameFillTypeE

nInterFrameTimeFill

Minimum No of interframe time characters between 2 HDLC frames (1=shared flags, 2=non-shared) Min value is 1. Max is 1024.

eCrcMode

Cyclic Redundancy Check (CRC) mode: 16-bit, 32-bit, or none. See also OtxHdlcCrcModeE

bBitInversion

If OTX_TRUE then all bits are inverted when transmitted and before received

bAppendTxCrc

If OTX_TRUE the HDLC device will append the CRC to the frame to be transmitted. If OTX_FALSE, the CRC is generated with software

eTxRate

HDLC Transmission Rate for V.110 and X.30 modes. See also OtxHdlcTxRateE

bEveryEventFlag

Use one event for one frame, otherwise sgenerate only first

Comments

Example

// initialize the HDLC Receiver
result = OtxHdlcExReceiverInit(
		  g_sqHdlcReceiver[i].hHandle,
		  OTX_HDLC_FFT_FLAGS,
		  2,
		  OTX_HDLC_CRC16,
		  OTX_FALSE,
		  OTX_TRUE,
		  OTX_HDLC_TR_NA,
		  OTX_FALSE);

See Also

Parameters

hDevice

Handle to the HdlcEx device

Developer Notes

Parameters

hDevice

Handle to the HdlcEx device

sqData

Data to be sent

nDataLen

Length of the data to be send

nTaskRef

See OTX_TASK_REF

nWaitMaxMs

See OTX_TIME

Example

for (i = 0; i < 10; i++) {
  arMsg[i] = (OTX_UINT8) i;
}

// send one HDLC Frame
result = OtxHdlcExSendData(
	    g_hLogicDevs.hHdlcSender,
	    arMsg,
	    10,
	    DEMO_TASK_REF,
	    OTX_TIME_INFINITY);

Parameters

hDevice

Handle to the HdlcEx device

eFrameFillType

Fill character(s) to be send between HDLC frames. See also OtxHdlcFrameFillTypeE

nInterFrameTimeFill

Minimum No of interframe time characters between 2 HDLC frames (1=shared flags, 2=non-shared) Min value is 1. Max is 1024.

eCrcMode

Cyclic Redundancy Check (CRC) mode: 16-bit, 32-bit, or none. See also OtxHdlcCrcModeE

bBitInversion

If OTX_TRUE then all bits are inverted when transmitted and before received

bAppendTxCrc

If OTX_TRUE the HDLC device will append the CRC to the frame to be transmitted. If OTX_FALSE, the CRC is generated with software

eTxRate

HDLC Transmission Rate for V.110 and X.30 modes. See also OtxHdlcTxRateE

Comments

Example

result = OtxHdlcExSenderInit(
		  g_hLogicDevs.hHdlcSender,
		  OTX_HDLC_FFT_FLAGS,
		  2,
		  OTX_HDLC_CRC16,
		  OTX_FALSE,
		  OTX_TRUE,
		  OTX_HDLC_TR_NA);

See Also

Parameters

hDevice

Handle to the HdlcEx device

pCallback

Pointer to callback function. See pHdlcExCallback

Comments

Example

...
result = OtxHdlcExSetCallback(g_sqHdlcReceiver[i].hHandle, MyCallback);
...

pHdlcExCallback MyCallback(OtxEventDataS *pEventData)
{
  OTX_RESULT            result;
  OTX_UINT8             buf[0x3000];
  OTX_UINT32            nFrameLen;
  OTX_UINT32            nFrameSeq;
  OtxHdlcFrameEndCodeE  nFrameEndCode;
  OTX_DATETIME          nTimeStamp;

  otxRc = OtxHdlcExReadData(pEventData->m_hDevice, buf, sizeof(buf), &nFrameLen, &nFrameSeq, &nFrameEndCode, &nTimeStamp);
}

See Also

Parameters

hDevice

Handle to the HdlcEx device

pCallbackEx

Pointer to callback function. See pHdlcExCallbackEx

pContext

Context to be passed to the callback

Comments

typedef void (*pHdlcExCallbackEx)(OtxEventDataS *, void *);

Example

void ReceiverCallbackEx(OtxEventDataS *pEventData, void *pContext);

class MyReceiver: public:

private
   friend void ReceiverCallbackEx(OtxEventDataS *pEventData, void *pContext);

protected:
   void MyCallback(OtxEventDataS *pEventData);

   HDLCX_HANDLE hHandle;
};


void _cdecl ReceiverCallbackEx(OtxEventDataS *pEventData, void *pContext)
{
   MyReceiver *pMyReceiver = (MyReceiver *) pContext;
   pMyReceiver->MyCallback(pEventData);
}


void MyReceiver::Init()
{
   OTX_RESULT result;

   result = OtxHdlcExCreate(OTX_LDEVICE_HDLC_RECEIVER, OTX_INVALID_HANDLE_VALUE, 0, &hHandle);
   result = OtxHdlcExSetCallbackEx(hHandle, ReceiverCallbackEx, (void *) this);
}


void MyReceiver::MyCallback(OtxEventDataS *pEventData)
{
  OTX_RESULT            result;
  OTX_UINT8             buf[0x3000];
  OTX_UINT32            nFrameLen;
  OTX_UINT32            nFrameSeq;
  OtxHdlcFrameEndCodeE  nFrameEndCode;
  OTX_DATETIME          nTimeStamp;

  assert(pEventData->m_hDevice == hDevice);
  otxRc = OtxHdlcExReadData(pEventData->m_hDevice, buf, sizeof(buf), &nFrameLen, &nFrameSeq, &nFrameEndCode, &nTimeStamp);
}

See Also

Parameters

hDevice

Handle to the HdlcEx device

Comments

Example

OTX_UINT8 TimeSlotMask[32];

memset(TimeSlotMask,0,sizeof(TimeSlotMask);
TimeSlotMask[0] = 0xff;

result = OtxHdlcExSetTimeSlotMask(
	   g_sqHdlcReceiver[i].hHandle,
	   sizeof(TimeSlotMask),
	   &TimeSlotMask[0]);

Developer Notes

Parameters

hHdlcDevice

Handle to the HDLC Device

pFilterMask

Currently active Filter Mask (see HDLC_SS7_FILTER_XXXX Macros)

Example

OTX_HANDLE hHandle;
OTX_UINT32 filterMask;

hHandle = g_sqDspHdlcReceiver.hHandle;

// toggle OTX_HDLC_SS7_FILTER_FISU_ALL filter mask on/off
result = OtxHdlcExSS7GetFilter(
	    hHandle,
	    &filterMask);

if (filterMask & OTX_HDLC_SS7_FILTER_FISU_ALL) {
  filterMask &= ~OTX_HDLC_SS7_FILTER_FISU_ALL;
} else {
  filterMask |= OTX_HDLC_SS7_FILTER_FISU_ALL;
}

// reset the filter mask
result = OtxHdlcSS7SetFilter(
	    hHandle,
	    filterMask);

See Also

Parameters

hHdlcDevice

Handle to the HDLC Device

pnFisuCount

Number of FISUs received

pnLssuCount

Number of LSSUs received

pnMsuCount

Number of MSUs received

pFisu

The last received FISU on the pipe. See also OtxHdlcSS7FisuS

Example

OTX_UINT32  nFisuCount;   // Number of FISUs received
OTX_UINT32  nLssuCount;   // Number of LSSUs received
OTX_UINT32  nMsuCount;    // Number of MSUs received
OtxHdlcSS7FisuS fisu;     // The last received FISU on the pipe.

result = OtxHdlcExSS7GetReceiveStatus(
	    hHandle,
	    &nFisuCount,
	    &nLssuCount,
	    &nMsuCount,
	    &fisu);

// print out status
if (OTX_SUCCESS(result)) {
  DemoLogf("FISUs received: %lu\\n", nFisuCount);
  DemoLogf("LSSUs received: %lu\\n", nLssuCount);
  DemoLogf("MSUs  received: %lu\\n", nMsuCount);
  DemoLogf("Last FISU received: bsn = %d, bib = %d, fsn = %d, fib = %d,
	    li = %d\\n", fisu.bsn, fisu.bib, fisu.fsn, fisu.fib, fisu.li);
}

See Also

Parameters

hHdlcDevice

Handle to the Logical HDLC Device

psqData

Data (MSU, LSSU, or other arbitrary frame) to be sent

nDataLen

Length of the data to be sent

pFisu

Next FISU to be sent after the data

nTaskRef

See OTX_TASK_REF

nWaitMaxMs

See OTX_TIME

Example

OtxHdlcSS7FisuS msu;
OtxHdlcSS7FisuS *pFisu;
OTX_UINT8 sqHdlcFrame[300];

memcpy(&msu, pFisu, OTX_HDLC_SS7_CB_FISU);        // Build the first 3 bytes of the MSU
msu.li = 10 - OTX_HDLC_SS7_CB_FISU;               // Set the Length Indicator
memcpy(sqHdlcFrame, &msu, OTX_HDLC_SS7_CB_FISU);  // Put the first 3 bytes of the MSU in the HDLC frame buffer
for (i = OTX_HDLC_SS7_CB_FISU; i < 10; i++) {     // Add the payload the HDLC frame buffer
  sqHdlcFrame[i + OTX_HDLC_SS7_CB_FISU] = (OTX_UINT8) i;
}

// Send MSU Frame with length of 10
result = OtxHdlcExSS7SendData(
	    g_sqDspHdlcSender.hHandle,
	    sqHdlcFrame,
	    10,
	    pFisu,
	    DEMO_TASK_REF,
	    OTX_TIME_INFINITY);

See Also

Parameters

hHdlcDevice

Handle to the HDLC Pipe

filterMask

Filter Mask (see HDLC_SS7_FILTER_XXXX Macros)

Comments

Example

// set filter mask on 2 DSP

  // Initialize the Hdlc Receiver
  result = OtxHdlcExReceiverInit(
	      hReceiver,
	      OTX_HDLC_FFT_FLAGS,
	      1,
	      OTX_HDLC_CRC16,
	      OTX_FALSE,
	      OTX_FALSE,
	      OTX_HDLC_TR_NA,
	      OTX_TRUE
    );

  result = OtxHdlcExSS7SetFilter(
	      hReceiver,
	      OTX_HDLC_SS7_FILTER_FISU | OTX_HDLC_SS7_FILTER_SHORT_LSSU | OTX_HDLC_SS7_FILTER_LONG_LSSU);

See Also

This function can be used to continously send SS7 FISUs or LSSUs.
Defined in: OtxHdlcEx.h

Parameters

hHdlcDevice

Handle to the HDLC Device

psqData

Repeat Data frame to be sent

nDataLen

Length of the data frame to be sent

nTaskRef

See OTX_TASK_REF

nWaitMaxMs

See OTX_TIME

Example

OTX_UINT8 *pRepeatFrame = (OTX_UINT8 *)"\\x10\\x11\\x12\\x13\\x14";
OTX_HANDLE hHandle;

hHandle = g_sqDspHdlcSender.hHandle;

// start Repeat Data Frames with length of 5 from HDLC Sender
result = OtxHdlcExStartRepeatData(
	    hHandle,
	    pRepeatFrame,
	    5,
	    DEMO_TASK_REF,
	    OTX_TIME_INFINITY);

See Also

Parameters

hHdlcDevice

Handle to the HDLC Device

Example

OTX_HANDLE hHandle;

hHandle = g_sqDspHdlcSender.hHandle;

// stop Repeat Data Frames from HDLC Sender
result = OtxHdlcExStopRepeatData(hHandle);

See Also