Contents

Function Reference

Driver and Generic Functions

Physical Device Functions

Logical Device Functions

Constant and Type Reference

Driver Level

Physical Devices

Logical Devices

Header File Reference

OTX API Alphabetical References

Constants

Enum Types and Constants

Functions

Generic Console Functions - OsaConsoleXXX()

OsaConsoleXXX() Function Reference

Generic stdio.h Functions - OsaStdXXX()

OsaStdXXX() Function Reference

Generic Thread and Mutex Functions - OsaThreadXXX()/OsaMutexXXX()

OsaThreadXXX()/OsaMutexXXX() Function Reference

Osa Macros

To Do

OsaCon.h

OsaDef.h

OsaStd.h

OsaThrd.h

Other Types

OTX Board Level Constants, Macros, and Types

OtxBrdXXX Macro, Constant, and Type Reference

OTX Board Level Functions - OtxBrdXXX()

OtxBrdXXX() Function Reference

OTX Device Types supported by the API (OtxDev.h)

OTX Driver Supported Device Types

OTX Driver Level Constants

OTX Driver Level Functions - OtxDrvXXX()

OtxDrvXXX() Function Reference

OTX Driver Level Result Codes

OTX Driver Level Types

Enumerated Types

Struct Types

Other Types

OTX Driver Management Macros, Constants, and Types

OtxDrvXXX Macro, Constant, and Type Reference

OTX DSP Device Management Functions - OtxDspXXX()

OtxDspXXX() Function Reference

OTX DSP Device Management Macros, Constants, and Types

OtxDspXXX Macro, Constant, and Type Reference

OTX Generic Functions/Macros

OTX Hdlc Device Macros, Constants, and Types

OtxHdlcXXX Macro, Constant, and Type Reference

OTX Hdlc Device Macros, Constants, and Types

OtxHdlcXXX Macro, Constant, and Type Reference

OTX ISDN BRI Line Interface Device Constants, Macros, and Types

OtxBriXXX Macro, Constant, and Type Reference

OTX ISDN BRI Line Interface Device Functions - OtxBriXXX()

OtxBriXXX() Function Reference

OTX JTAG - OtxJtagXXX()

OtxJtagXXX() Function Reference

OTX Logical Hdlc Sender/Receiver Functions - OtxHdlcXXX()

OtxHdlcXXX() Function Reference

OTX Logical RawData Sender/Receiver Functions - OtxRawDataXXX()

OtxRawDataXXX() Function Reference

OTX POTS Line Interface Device Constants, Macros, and Types

OtxPotsXXX Macro, Constant, and Type Reference

OTX POTS Line Interface Device Functions - OtxPotsXXX()

OtxPotsXXX() Function Reference

OTX Raw Data Device Macros, Constants, and Types

OtxRawDataXXX Macro, Constant, and Type Reference

OTX Serial Data Manipulation Device Macros, Constants, and Types

OtxDataXXX Macro, Constant, and Type Reference

OTX Serial Data Manipulation Function Prototypes - OtxDataXXX()

OtxDataXXX() Function Reference

OTX T1/E1 Line Interface Constants, Macros, and Types

OtxT1E1XXX, OtxT1XXX, and OtxE1XXX Macro, Constant, and Type Reference

OTX T1/E1 Line Interface Device Functions - OtxT1XXX(), OtxE1XXX()

OtxT1E1XXX(), OtxT1XXX(), and OtxE1XXX() Function Reference

OTX Tone Generator/Detector Functions - OtxToneXXX()

OtxToneXXX() Function Reference

OTX Tone Logical Data Filter Device Macros, Constants, and Types

OtxToneXXX Macro, Constant, and Type Reference

OtxBrd.h

OtxBrdD.h

OtxBri.h

OtxBriD.h

OtxData.h

OtxDataD.h

OtxDef.h

OtxDev.h

OtxDrv.h

OtxDrvD.h

OtxDsp.h

OtxDspD.h

OtxErr.h

OtxGeneric.h

OtxHdlc.h

OtxHdlcD.h

OtxHdlcD.h

OtxJtag.h

OtxPots.h

OtxPotsD.h

OtxRawD.h

OtxRawData.h

OtxT1E1.h

OtxT1E1D.h

OtxTone.h

OtxToneD.h

OtxType.h

Struct Types

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

OTX error definitions and values

The return value of OTX APIs and methods is an OTX_RESULT. This is not a handle to anything, but is merely a 32-bit value with several fields encoded in the value. The parts of an OTX_RESULT are shown below.

The structure of OTX_RESULT is based on the Win32 HRESULT layout, but the meanings of values used in the bit fields are completely different.

Example

|3 3 2 2 2 2 2 2 2 2 2 2 1 1 1 1 1 1 1 1 1 1
|1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0
|-+-+-+-+-+---------------------+-------------------------------+
|S|R|R|R|R|    Facility         |               Code            |
|-+-+-+-+-+---------------------+-------------------------------+

S - Severity - indicates success/fail

    0 - Success
    1 - Fail

R - reserved portion of the facility code

Facility - is the OTX facility code

Code - is the OTX facility's status code

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Comments

Osa functions are used by the demo programs.

See Also

Parameters

buffer

Placeholder for input string. See gets() in stdio.h

Comments

See Also

Comments

See Also

Parameters

formatStr

Format string. See printf() in stdio.h

argList

Argument list. See printf() in stdio.h

Comments

See Also

Parameters

pMutex

Pointer to the mutex created by a call to OsaMutexInit

Comments

See Also

Parameters

pMutex

Pointer to the mutex created by this function call

Comments

See Also

Parameters

pMutex

Pointer to the mutex created by a call to OsaMutexInit

Comments

See Also

Parameters

pMutex

Pointer to the mutex created by a call to OsaMutexInit

Comments

See Also

Parameters

s

String to be converted to upper case. See strupr() in string.h

Comments

See Also

Parameters

c

char to be converted to upper case. See toupper() in file ctype.h

Comments

See Also

Parameters

nMilliSecs

Sleep time in milliseconds

Comments

See Also

Parameters

pfnThreadFunc

Thread function to be started

Comments

See Also

Parameters

pfnThreadFunc

Thread function to be started

lpParameter

Parameter to be passed to the thread

Comments

See Also

Parameters

hDevice

A handle to any type device

Parameters

hDevice

A handle to any type device

Parameters

hDevice

A handle to any type device

Parameters

hDevice

A handle to any type device

Parameters

hDevice

A handle to any type device

Parameters

hDevice

A handle to any type device

Parameters

hDevice

A handle to any type device

*/ ((StructType *) (((OTX_UINT8 *) pBase) + nByteOffset))
Defined in: OtxGeneric.h

Parameters

hDevice

A handle to any type device

Parameters

hCodecDevice

Handle to Codec device

eLaw

U-law or A-law

See Also

Parameters

hBrdDevice

Handle to Board device

clkMode

TSS Clock Mode (Master/Slave)

clkSource

Clock which the TSS uses to clock the highways

Comments

See Also

Parameters

hBriDev

Handle to the BRI Transceiver Device

nWaitMaxMs

Time in milliseconds to wait for the layer 1 to become active

Parameters

hBriTeDev

Handle to the the Li which will listen as a TE

hBriNtDev

Handle to the the Li which will listen as a NT

Parameters

hBriDev

Handle to the BRI Transceiver Device

nWaitMaxMs

Time in milliseconds to wait for the layer 1 to become active

Comments

Parameters

hBriDev

Handle to the BRI Transceiver Device

pLineStatus

T1/E1 Physical Layer Line Status

Parameters

hBriDev

Handle to the BRI Device

eLiMode

Mode to be configured to (TE/NT)

Parameters

hBriDev

Handle to the BRI Transceiver Device

bConnectTermRes

If OTX_TRUE, connect the terminating resistor

Parameters

hDevice

Handle to the logical Data Converter Device

eDataFormatIn

Data format coming in. See also OtxDataFormat

eDataFormatOut

Data format coming out. See also OtxDataFormat

See Also

Parameters

hDevice

Handle to the logical Data Mixer Device

Comments

See Also

Parameters

hDevice

Handle to the device

nTaskRef

Callers task reference, as given earlier. See OTX_TASK_REF

Comments

See Also

Parameters

hObject

Object handle to a physical/logical device, pipe or event queue

Comments

See Also

Parameters

hEvent

Event handle to close. See Also OTX_EVENT

Comments

Developer Notes

See Also

Parameters

hCtBus

Handle to a CT Bus

hBoard

Handle to a board (Nic) device which is connected to this CT bus

Comments

When two ore more boards are connected together with the appropriate CT Bus board interconnect cable it is possible to connect two devices with a pipe even if they are located on different board. Before pipes can connect over separate boards the driver must be informed about what types of board interconnects exists, and how the boards are connected. This is done by calling this function.

The CT Bus device must be opened by calling OtxDrvOpenPhysicalDevice prior to calling this function. The same applies to all the boards which are connected to the CT Bus.

The CT Bus does not have a direction like a pipe. The direction of each individual timeslot is determined at the time a Pipe Device must utilize the CT Bus to reach a different board. The direction of the pipe then determines the direction of that timeslot in the CT Bus.

The OTX driver supports a CT bus capacity of 2048 kbps which corresponds to 32 timeslots/highway.

See Also

Comments

See Also

Parameters

hFromDevice

Logical Device or Pipe whose output is to be connected

iFromConnectPoint

Output connection point to connect, -1 = don't care

hToDevice

Logical Device or Pipe whose input is to be connected

iToConnectPoint

Connection point on the second device to connect to, -1 = don't care

Comments

The connection point index is only needed for devices that has more than one inputs of outputs, e.g. a mixer or a conference bridge, and even in that case it can be left as -1 if the connection points are 100% symmetrical, e.g. a symmetrically mixed conference bridge.

Developer Notes

See Also

Parameters

hPipe

Pipe to be connected to a Physical Device.

ePipeEnd

End of the pipe (input vs. output) to be connected. See Also OtxPipeEndE

hDevice

Physical Device to be connected to

nHighway

Physical Highway to be used. -1 = don't care

sqConnectMask[]

Connection mask for mapping the Pipe Bits to time-slots and bits on the PCM highway connected to the physical device Can be NULL if don't care and coMaskSize = 0 Each octet in the mask represents a timeslot on the highway

coMaskSize

Size of connection mask for the highway connection (in octets). 0 = don't care.

Comments

Multiple logical devices (implemented within a physical device) can be connected within a physical device to use data from a pipe output. To connect logical devices to each other and to a pipe, use function OtxDrvConnectLogicalDevice

The connection mask is only needed for devices where an exact mapping of the pipe onto a physical interface (i.e. specific time-slots) is needed, e.g. in the case of a multichannel line interface where a specific time slot is used for signalling. It is important that the mapping matches the capacity of the pipe exactly. If the time-slots to be used do not matter, or if they cannot be changed by the user, specify coMaskSize = 0 and sqConnectMask = NULL.

Developer Notes

See Also

Parameters

phEvent

Event handle, ready for use. See Also OTX_EVENT

Comments

Developer Notes

See Also

Parameters

nSize

Size of the queue to be created in # of messages

hEvent

Event which a Win32 app can Wait for events to occur, NULL if no notification needed (or if not a Win32 application).

phEventQueue

Event Queue handle

Comments

See Also

Parameters

hHostDevice

Parent (typically a physical device) who owns the logical device we are connecting to

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)

Comments

The following Logical Devices are supported by the OTX Driver:

Tone Devices : Logical devices for tone generation and reception (See OtxTone.h) Data Devices : Devices for sending, receiving, and manipulation of Raw data (See OtxData.h) HDLC Devices : Logical devices implementing HDLC Sender and Receiver Devices (See OtxHdlc.h) CAS Devices : Devices implementin Channel Associated Signalling (CAS) functions (See OtxCas1.h) Modem Devices : Devices implementing Modem emulation Fax Devices : Devices implementin Fax emulation Voice Devices : Devices implementing Voice Codecs, echo cancellation, silence supression, etc.

See Also

Parameters

nCapacity

Capacity in kbps (only 8kbps increments allowed)

phPipe

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

Comments

A pipe can be created for a data rate between 8 kbit/s and 2.048Mbit/s (2.048 Mbit/s max is standard. Highways can be operated at up to 8.192Mbits/s). A pipe is a configured entity and it is overlaid on internal highways. A pipe can constitute a single time-slot on a Highway or it can be a superchannel of any number of time slots. The pipe is mapped on the physical highways when it is connected to a device with function OtxDrvConnectPipe

See Also

Parameters

hDevice

Handle to device

nCommandCode

Code indicating requested operation

pInBuffer

Input parameters in serial format

cbInBuffer

Byte count of input parameters

pOutBuffer

Buffer to receive output parameters in serial format

cbOutBuffer

Size in bytes of output buffer. Must be large enough for the given command

cbReturned

Actual number of bytes returned (may differ from cbOutBuffer).

nTaskRef

See OTX_TASK_REF

nWaitMaxMs

See OTX_TIME

Comments

See Also

Parameters

hObject

Any OTX_HANDLE

nTaskRef

See OTX_TASK_REF

nWaitMaxMs

See OTX_TIME

See Also

To Do

Parameters

hFromDevice

Logical Device or Pipe whose output is to be disconnected

iFromConnectPoint

Output connection point to be disconnected, -1 = disconnect all

hToDevice

Logical Device or Pipe whose input is to be disconnected

iToConnectPoint

Connection point on the second device to be disconnect to, -1 = disconnect all

Comments

The connection point index is only needed for devices that has more than one inputs of outputs, e.g. a mixer or a conference bridge, and even in that case it can be left as -1 if the connection points are 100% symmetrical, e.g. a symmetrically mixed conference bridge.

Developer Notes

See Also

Parameters

hPipe

Pipe to be disconnected

ePipeEnd

End of the pipe to be disconnected. See Also OtxPipeEndE

Comments

See Also

Parameters

hObject

Any OTX_HANDLE

nTaskRef

See OTX_TASK_REF

nWaitMaxMs

See OTX_TIME

See Also

Parameters

hDevice

Handle to the physical parent device

eDeviceType

Physical or logical device type. See OtxPhysicalDeviceTypeE and OtxLogicalDeviceTypeE

pItr

Enumeration start position. See OTX_ITERATOR

phChildDevice

Handle to device referenced by iterator. This handle can be always be used to query the device, but the device must have been opened for most other operations to succeed

Comments

After the calll the iterator has been incremented to reference the next item in the sequence. It can be used in a subsequent call to the same function to fetch data for the next element in the same sequence. Repeated calls to the same function with the same iterator eventually fetches data for all items in this sequence. Note that it is not possible to increment the iterator in any other way.

The iterator must already be initialized with a call to OtxDrvIteratorBegin before the first call to this function.

It is important that the iterator is used on the same sequence of items between each call to OtxDrvIteratorBegin, i.e. the same function must be called with the same handle value (hDevice) and the same iterator (pItr).

However, it is possible for multiple iterators to be used on the same sequence independently, at the same time, even in separate threads.

See Also

Parameters

hDevice

Handle to the physical parent device

pItr

Enumeration start position. See OTX_ITERATOR

peDeviceType

Physical or logical device type. See OtxPhysicalDeviceTypeE and OtxLogicalDeviceTypeE

Comments

The iterator is incremented to reference the next item in the sequence. It can be used in a subsequent call to the same function to fetch data for the next element in the same sequence. Repeated calls to the same function with the same iterator eventually fetches data for all items in this sequence.

The iterator must already be initialized with a call to OtxDrvIteratorBegin before the first call to this function.

It is important that the iterator is used on the same sequence of items between each call to OtxDrvIteratorBegin, i.e. the same function must be called with the same handle and the same iterator.

However, it is possible for multiple iterators to be used on the same sequence independently, at the same time, even in separate threads.

See Also

Parameters

hDevice

Handle to the device who generated the event

nEventCode

Event Cause Code to be translated. See also OtxEventDataS

nBufLen

Length of the User supplied String Buffer

szStrBuf[]

User supplied String buffer

Comments

Parameters

hDevice

Handle to the device being queried

nAttribId

ID of attribute

peAttribType

Type of the attribute, if attribute exists

pcbAttribValue

Size in bytes of attribute value (Get value with OtxDrvGetAttributeValue)

pbReadOnly

Is attribute writable or read-only

Comments

See Also

Parameters

hDevice

Handle to the device being queried

nAttribId

ID of attribute

pAttribValueBuf

Buffer to hold the value of the attribute

cbAttribValueBuf

Size of the attribValueBuf in bytes

pcbAttribValue

Bytes actually used in attribValueBuf

Comments

See Also

See Also

See Also

See Also

Parameters

pnTimeStamp

Current time of the host

See Also

To Do

Comments

See Also

Parameters

hEventQueue

Event queue to read event from

pEventData

Pointer to place-holder for event data See also OtxEventDataS

Comments

Each event is time stamped.

Win32 applications can wait efficiently for events to occur by setting up a Win32 Event with the driver, see OtxWaitForSingleEvent

See Also

Parameters

hEventQueue

Event queue to read event from

psqEventData

Pointer to place-holder array for event data (OtxEventDataS)

coEventData

Capacity of psqEventData (in number of OtxEventDataS elements), i.e. maximum number of events which the driver can entry in psqEventData.

pcoEventsReturned

Number of events returned by this function (number of elements which the driver entered in psqEventData).

See Also

Parameters

hObject

Handle to a driver object to get state info about

peDevState

State of the device. See also OtxDeviceStateE

Comments

See Also

See Also

See Also

Parameters

hHostDevice

Parent (typically Board Device) who owns the device we are connecting to Specify NULL when opening a board device

eDevType

Class of device we are looking for. See OtxPhysicalDeviceTypeE

nDevice

Sequence number of device within it's class

nEventSourceId

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

hEventQueue

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

phPhysDevice

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

Comments

The physical devices can be classified in 2 categories:

BOARD Devices: A board device represents one OTX Network Interface card or a Daughter Board Module. The board device is the placeholder and controller of other physical devices on the board.

CHIP Devices: A chip device represents a physical integrated circuit on the board performing one or several functions. A logical device can be created to represent each of the functions implemented by a chip device. For example, a Digital Signal Processor is a physical "chip" device. However, the DSP software may implement several functions which then can be represented by a multiple of logical devices.

The chip devices can be further categorized as follows:

Line Interface Devices: A hardware device that interfaces with the external network and converts/maps the non-TTL level external data interface to the internal serial data highways. Typically an actual line interface transceiver chip on a board. Examples of Line Interface Devices include T1/E1, BRI, POTS, T3/E3 Li’s.

Processor Devices: A processor (general purpose micro processor or Digital Signal Processor) is an integrated circuit that implements certain functionality (logical devices) under software control.

Switch Device: A device connecting and disconnecting data-paths.

Other miscellaneous chips.

See Also

Parameters

hPhysDevice

Handle to the physical device

nEventSourceId

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

hEventQueue

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

See Also

Parameters

hDevice

Handle to device

Comments

Parameters

hDevice

Handle to the device to read from

nAddress

Register address within the device

pnValue

16-bit value read from the device

Parameters

hDevice

Handle to the device to read from

nAddress

Register address within the device

pnValue

8-bit value read from the device

Comments

See Also

Events in the event queue for the particular object are removed by this command.
Defined in: OtxDrv.h

Parameters

hObject

Handle to a object to reset

See Also

Parameters

hDevice

Handle to the device who generated the result code

nResultCode

Result Code to be translated. See also OTX_RESULT

nBufLen

Length of the User supplied String Buffer

szStrBuf[]

User supplied String buffer

Comments

Parameters

hDevice

Handle to the device being queried

nAttribId

ID of attribute

attribValueBuf[]

Value of the attribute, if attribute exists

cbAttribValueBuf

Size in bytes of the buffer for the value

Comments

See Also

See Also

See Also

See Also

Parameters

hEventQueue

Event queue to be used

eDeviceType

Device Type with which the event is associated

nSourceId

Device Id of the device that the event is associated with (supplied by the user when the device for opened/created)

hDevice

Handle to the Device with which the event is associated

nCode

Device specific cause code indicating what happened. Each device types has it own set of event cause codes

nRequestId

If the message is for a previous user request this member holds the user assigned request ID

nParam

Optional parameter with user defined meaning

Comments

The driver will time stamp the event.

See Also

Parameters

hEvent

Handle to an Event to be set into signalled state. See Also OTX_EVENT

Comments

Developer Notes

See Also

Parameters

coEventHandles

Event handle count

sqhEvents[]

Array of event handles. See Also OTX_EVENT

nWaitMaxMs

Max time to wait in millisconds

bWaitAll

Specifies the wait type. If OTX_TRUE, the function returns when the state all objects in the lpHandles array is signaled. If OTX_FALSE, the function returns when the state of any one of the objects set to is signaled. In the latter case, the return value indicates the object whose state caused the function to return. See also OTX_BOOL

pnEventFired

index to event in array that fired

Comments

Specify nMilliseconds = OTX_TIME_INFINITY to wait forever.

See Also

Return Value

OTX_E_HANDLE

Handle invalid

OTX_S_TIMEOUT

Wait timed out

OTX_S_OK

Event occured

OTX_E_FAIL

Non-specified failure

Parameters

hEvent

Event handle, initilized with OtxDrvCreateEvent

nWaitMaxMs

Max time to wait in millisconds

Comments

Specify nMilliseconds = OTX_TIME_INFINITY to wait forever.

See Also

Parameters

hDevice

Handle to the device to write to

nAddress

Register address within the device

nValue

16-bit value to be written to the device

Parameters

hDevice

Handle to the device to write to

nAddress

Register address within the device

nValue

8-bit value to be written to the device

Parameters

szProgfile

Application file to be converted to an image

szEntryPoint

Label for the entry point of the application. Usually "_c_int00" for a C-compiled application.

coProgImageMax

Count of objects (size) of psqProgImage (in elements) provided by the user

psqProgImage

Image Buffer provided by the user

coProgImage

Number of image elements returned in psqProgImage

nEntryAddr

Program Entry address

See Also

Parameters

hDspDevice

Handle to the physical DSP device

nIoControlCode

I/O Control Code to be passed

pInBuf

Pointer to the user allocated input buffer

nInBufSize

Size of the input buffer

pOutBuf

Pointer to the user allocated output buffer

nOutBufSize

Size of the output buffer

pnBytesReturned

Number of Bytes returned

nTaskRef

See OTX_TASK_REF

nWaitMaxMs

See OTX_TIME

See Also

Return Value

OTX_S_OK

Data was fetched

OTX_S_FALSE

No Data available at this moment

OTX_E_BUFFER_TO_SMALL

The supplied user data buffer is too small to fit the received data

Parameters

hDspDevice

Handle to the physical DSP device

nTaskRef

See OTX_TASK_REF

pOutBuf

Pointer to the user allocated output buffer

nOutBufSize

Size of the output buffer

pnBytesReturned

Number of Bytes returned

pnIoControlCode

I/O Control Code the returned data is associated with

See Also

Parameters

hDspDevice

Handle to the physical DSP device

nHpiAddress

HPI Address to start to read from

coWordsToRead

Number of OTX_UINT16s (Words) to read from the HPI

pReadBuf

Pointer to the user allocated output buffer (Words)

Comments

See Also

This function is only meant to be called if a DSP Debugger is being used.
Defined in: OtxDsp.h

Parameters

hDspDevice

Handle to DSP device

Example

1. First the OtxDspRunImage(), OtxDspRunSpm(), or OtxDspRunProgram() is called.
2. Immediately thereafter the host application must be stopped.
3. While the host application is stopped the DSP program is loaded and started
   from the DSP Debugger.
4. Once the DSP program is running again, OtxDspRunProgram() should be called
   to bring the DSP program back to the state it was right after step 1 was
   executed.

See Also

Parameters

hDspDevice

Handle to DSP device

psqProgImage

Program image

coProgImage

Number of elements in psqProgImage

nEntryAddr

Program Entry Address

See Also

Parameters

hDspDevice

Handle to DSP device

szPrgfile

Application file to be loaded

szEntryPoint

Label for the entry point of the application

See Also

Parameters

hDspDevice

Handle to DSP device

eProgramModule

Standard Program Module to be loaded in the DSP (from the Lib)

See Also

Parameters

hDspDevice

Handle to the physical DSP device

nHpiAddress

HPI Address to start to write to

coWordsToWrite

Number of OTX_UINT16s (Words) to write to the HPI

pWriteBuf

Pointer to the user allocated input buffer (Words)

Comments

See Also

Parameters

hLogicDevice

Handle to the E1 ABCD-Bit Access Logical Device

pABCDBitData

ABCD CAS signalling data received. See also OtxE1ABCDBitDataS

Comments

Developer Notes

See Also

Parameters

hLogicDevice

Handle to the E1 ABCD-Bit Access Logical Device

nChannel

CAS Channel (1 - 30)

pnABCDBits

The ABCD bits for this channel are returned in the lower nibble of this parameter (A=bit3,B=bit2,C=bit1,D=bit0)

Developer Notes

See Also

Parameters

hLineDevice

Handle to the T1/E1 Transceiver Device

pE1ConfigOptions

E1 Configuration Data

See Also

Parameters

hLogicDevice

Handle to the E1 S-Bit Access Logical Device

eSaBit

Sa bit to retrieve. See also OtxE1SaBitE

pSaVal

Last 8 received Sa-bits

Comments

Developer Notes

See Also

Parameters

hLogicDevice

Handle to the E1 S-Bit Access Logical Device

pSi1Val

Value of the FAS Si-bit in doubleframe format or Si (E) bit in frame 13 in CRC-multiframe format

pSi2Val

Value of the service word Si bit in DoubleFrame format or Si (E) bit in frame 15 in CRC-multiframe format

Comments

In CRC-Multiframe format, the Si bit are the first bits of frames 13 and 15. In CRC-Multiframe format these bits are also known as the E-bits.

Developer Notes

See Also

Parameters

hLogicDevice

Handle to the E1 ABCD-Bit Access Logical Device

pABCDBitData

ABCD CAS signalling data to be transmitted. See also OtxE1ABCDBitDataS

Comments

Developer Notes

See Also

Parameters

hLogicDevice

Handle to the E1 ABCD-Bit Access Logical Device

nChannel

CAS Channel (1 - 30)

nABCDBits

The ABCD bits for this channel to be transmitted (A=bit3,B=bit2,C=bit1,D=bit0)

Comments

Developer Notes

See Also

Parameters

hLineDevice

Handle to the T1/E1 Transceiver Device

pE1ConfigOptions

E1 Configuration Data

See Also

Parameters

hLogicDevice

Handle to the E1 S-Bit Access Logical Device

eSaBit

Sa bit to set. See also OtxE1SaBitE

nSaVal

Byte (8 bits) to be sent. LSB will be sent first.

Comments

In Doubleframe format one bit of the saVal word is sent in the every other frame starting from the least significant bit.

Start signalling by calling function OtxDrvEnable and end it with function OtxDrvDisable

Developer Notes

See Also

Parameters

hLogicDevice

Handle to the E1 S-Bit Access Logical Device

nSi1Val

Value of the FAS Si-bit in doubleframe format or Si (E) bit in frame 13 in CRC-multiframe format

nSi2Val

Value of the service word Si bit in DoubleFrame format or Si (E) bit in frame 15 in CRC-multiframe format

Comments

In CRC-Multiframe format, the Si bit are the first bits of frames 13 and 15. In CRC-Multiframe format these bits are also known as the E-bits.

Developer Notes

See Also

Return Value

OTX_S_OK

Hdlc Data was fetched

OTX_S_FALSE

No Hdlc Data available at this moment

OTX_E_BUFFER_TO_SMALL

The supplied user data buffer is too small to fit the received HDLC frame

Parameters

hHdlcDevice

Handle to the HDLC Receiver Device

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

See Also

Return Value

OTX_S_OK

Hdlc Data was fetched

OTX_S_FALSE

No Hdlc Data available at this moment

OTX_E_BUFFER_TO_SMALL

The supplied user data buffer is too small to fit the first HDLC frame info and data

Parameters

hHdlcDevice

Handle to the HDLC Receiver Device

psqInfoAndDataBuffer

Data buffer for the received data and info for all received frames

cbBufferCapacity

Length of the buffer

coMaxFrames

Maximum number of HDLC frames to be read by this call. A count of zero means read until buffer full

bTruncate

Utilize whole buffer even if it means that the last frame is truncated and the remainder discarded

pcoFrames

Number of frames actually placed in buffer upon return

Comments

OtxHdlcFrameInfoS p1 = buffer; OtxHdlcFrameInfoS p2 = OTX_STRUCT_ADD_BYTE_OFFSET(OtxHdlcFrameInfoS, p1, p1->nOffsetNext);

This dispenses with the need to worry about the byte alignments of the OtxHdlcFrameInfoS structs.

The last frame's nOffsetNext field will be zero

See Also

Parameters

hHdlcDevice

Handle to logical HDLC Filter 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

bExcludeRxCrc

If OTX_TRUE the HDLC device will remove the CRC from the received frame, if OTX_FALSE the CRC is passed on to the receiving software

eTxRate

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

bEventForEveryFrame

If OTX_TRUE the HDLC device will generate an event for every received frame, if OTX_FALSE then the HDLC device will only generate an event when one or more frames have been received since the last call to OtxHdlcReadData or OtxHdlcReadDataEx.

Comments

See Also

Parameters

hHdlcDevice

Handle to the HDLC Sender Device

sqData

Data to be sent

nDataLen

Length of the data to be send

nTaskRef

See OTX_TASK_REF

nWaitMaxMs

See OTX_TIME

See Also

Parameters

hHdlcDevice

Handle to the HDLC Sender Device

See Also

Parameters

hHdlcDevice

Handle to logical HDLC Filter 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

See Also

Parameters

hHdlcDevice

Handle to the HDLC Device

pFilterMask

Currently active Filter Mask (see HDLC_SS7_FILTER_XXXX Macros)

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

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

See Also

Parameters

hHdlcDevice

Handle to the HDLC Pipe

filterMask

Filter Mask (see HDLC_SS7_FILTER_XXXX Macros)

See Also

This function can be used to continously send SS7 FISUs or LSSUs.
Defined in: OtxHdlc.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

See Also

Parameters

hHdlcDevice

Handle to the HDLC Device

See Also

Parameters

hDevice

Handle to the TBC Device

nCmd

Command to be executed

See Also

Parameters

hDevice

Handle to the TBC Device

nTms

TMS chain number (0-7)

pszDataIn

Data string to be scanned in

pszDataOut

Data string scanned out

See Also

Parameters

hDevice

Handle to the TBC Device

nTms

TMS chain number (0-7)

pszCommand

Instruction string of be scanned in

pszOutBuf

Instruction string scanned out

See Also

Parameters

hDevice

A handle to a POTS line device.

peLiMode

Line Interface Device mode

See Also

Parameters

hDevice

A handle to a POTS line device.

nDurationMs

Time to stay on-hook.

nTaskRef

Callers reference, see also OTX_TASK_REF.

nWaitMaxMs

Maximum time for operation to complete, see also OTX_TIME.

Comments

See Also

Parameters

hDevice

A handle to a POTS line device.

Comments

No operation if already off-hook.

See Also

Parameters

hDevice

A handle to a POTS line device.

Comments

See Also

Parameters

hDevice

A handle to a POTS line device.

nDisconnectMs

Time to keep line on-hook for each pulse

nConnectMs

Time to keep line off-hook for each pulse

nInterPulseGroupMs

Time to keep line off-hook between each pulse group (i.e. digit)

sqPulseGroups

Sequence (i.e. array) of digits constituting one pulse group each

coPulseGroups

Count of digits (i.e. pulse groups)

nTaskRef

Callers reference, see also OTX_TASK_REF.

nWaitMaxMs

Maximum time for operation to complete, see also OTX_TIME.

Comments

A pulse is a disconnection of the line, and it is therefore a prerequisite that the line is off-hook prior to calling this function.

See Also

Parameters

hDevice

A handle to a POTS line device.

eLiMode

Line Interface Device mode

Comments

See Also

Return Value

OTX_S_OK

Raw Data Data was fetched

OTX_S_FALSE

No Raw Data Data available at this moment

OTX_E_BUFFER_TO_SMALL

The supplied user data buffer is too small to fit the received data

Parameters

hRawDataDevice

Handle to the Raw Data Receiver Device

pDataBuf

Data buffer for the received data

nBufLen

Length of the user data buffer

pnFrameLen

Length of the received raw data buffer (number of octets)

pbFrameEnd

Set to OTX_TRUE if a flag (as specified in OtxRawDataReceiverInit) followed the received data frame (valid if OTX_TRUE if OtxRawDataReceiverInit was initialized with bExtractFlag=OTX_TRUE)

See Also

Parameters

hRawDataDevice

Handle to logical Raw Data Device

eDataFormat

Format of the received Raw Data. Use OTX_DATA_FORMAT_UINT8 if no data conversion to be applied. Use OTX_DATA_FORMAT_COMPAND8_A_LAW or OTX_DATA_FORMAT_COMPAND8_U_LAW to expand the 8-bit values from the incoming data stream to 16-bit signed integer values retrieved in the OtxRawDataReadData calls.

flag

Flag to be extracted if bExtractFlag is TRUE

bExtractFlag

if TRUE then received octets that equal the flag value are extracted from the receive data stream

bLsbReceivedFirst

Only applicable for subchannels (pipe capacity of 8, 16, or 32kpbs). If TRUE then the received octets are formatted so that the least significant bits of the octet contains the the first received bits of the subchannel. If FALSE then the received octets are formatted so that the most significant bits of the octet contains the the first received bits of the subchannel;

Comments

Example

|
|7 6 5 4 3 2 1 0
|---+---+---+---+
|x x|x x|x x|x x|  Octet received by the Raw Data Receiver
|---------------+
| ^           ^
| |           |
| |           +----- These two bits are the first two bits received
| |                  from the subchannel pipe
| |
| |
| +----- These two bits are the last two bits received
|        from the subchannel pipe

See Also

Parameters

hRawDataDevice

Handle to the Raw Data Sender Device

sqData

Data to be sent

nDataLen

Length of the data to be send

nTaskRef

See OTX_TASK_REF

nWaitMaxMs

See OTX_TIME

Parameters

hRawDataDevice

Handle to the Raw Data Sender Device

See Also

Parameters

hRawDataDevice

Handle to logical Raw Data Device

eDataFormat

Format of the Raw Data supplied to this device. Use OTX_DATA_FORMAT_UINT8 if no conversion to be applied. Use OTX_DATA_FORMAT_COMPAND8_A_LAW or OTX_DATA_FORMAT_COMPAND8_U_LAW to supply 16-bit signed integer values in the calls to OtxRawDataSendData and let the device compress these value to 8-bit A-law/U-law values before they are placed in the outgoing data stream.

flag

Value to send when there is no more Raw Data to send

bLsbSentFirst

Only applicable for subchannels (pipe capacity of 8, 16, or 32kpbs). Determines in which order bits are extracted from the each octet before they are placed into a subchannel pipe. If TRUE the device will send the least significant bits of the octet first, and send the most significant bits last. If FALSE the device will send the most significant bits of the octet first, and send the least significant bits last.

Comments

Example

|
|7 6 5 4 3 2 1 0
|---+---+---+---+
|x x|x x|x x|x x|  Octet passed to the Raw Data Sender
|---------------+
| ^           ^
| |           |
| |           +----- These two bits are sent first
| |
| |
| +----- These two bits are sent last

See Also

Parameters

hRawDataDevice

Handle to the HDLC Device

sqData

Data to be sent

nDataLen

Length of the data to be send

See Also

Parameters

hRawDataDevice

Handle to the HDLC Device

See Also

Parameters

hLineDevice

Handle to the T1/E1 Transceiver Device

eAlarmType

Alarm type to turned off

See Also

Parameters

hLineDevice

Handle to the T1/E1 Transceiver Device

eAlarmType

Alarm type to be sent to the Remote End

See Also

Parameters

hLineDevice

Handle to the T1/E1 Transceiver Device

Parameters

hLineDevice

Handle to the T1/E1 Transceiver Device

eLayer1Status

T1/E1 Physical Layer Line Status. Either OTX_T1E1_RES_L1_DOWN or OTX_T1E1_RES_L1_OK

Parameters

hLineDevice

Handle to the T1/E1 Transceiver Device

eT1E1Mode

T1 or E1 mode

See Also

Parameters

hLineDevice

Handle to the T1/E1 Transceiver Device

eLoopType

Loop Type: Line loop or Remote loop

See Also

Parameters

hLineDevice

Handle to the T1/E1 Transceiver Device

eTermMode

Termination mode to match impedance of the cable connected to the Line Interface

Parameters

hLineDevice

Handle to the T1/E1 Transceiver Device

bMonitorModeActive

If OTX_TRUE the receiver sensitivity is increased to detect resistively attenuated signals of -20 dB

Comments

Parameters

hLineDevice

Handle to the T1/E1 Transceiver Device

bTxPinEnable

OTX_TRUE enable, OTX_FALSE disables (tri-state) the Line Interface Transmit Pins

Parameters

hLogicDevice

Handle to the T1 Bit Rob Access Logical Device

nChannel

Channel (1 - 24)

pnABCDBits

The ABCD bits for this channel are returned in the lower nibble of this parameter (A=bit3,B=bit2,C=bit1,D=bit0)

Developer Notes

See Also

Parameters

hLineDevice

Handle to the T1/E1 Transceiver Device

pT1ConfigOptions

T1 Configuration Data

See Also

Parameters

hLogicDevice

Handle to the T1 BitRob Access Logical Device

pRobBitData

Bit-robbed signalling data received. See also OtxT1RobBitDataS

Developer Notes

See Also

Parameters

hLogicDevice

Handle to the T1 S-Bit Access Logical Device

nChannel

Channel (1 - 24)

nABCDBits

The ABCD bits for this channel to be transmitted (A=bit3,B=bit2,C=bit1,D=bit0)

Comments

Developer Notes

See Also

Parameters

hLineDevice

Handle to the T1/E1 Transceiver Device

pT1ConfigOptions

T1 Configuration Options

See Also

Parameters

hLogicDevice

Handle to the T1 DL-Bit Access Logical Device

nDlBits

DL-Data to be transmitted.
Mode OTX_T1_FF_F12:
nDlBits should contain 8 DL bits.
Bit0 is transmitted in frame 2 and Bit7 in frame 12.
Remaining bits should be zero.

Mode OTX_T1_FF_ESF:
nDlBits should contain 16 DL bits.
Bit0 is transmitted in frame 1 and Bit7 in frame 15.
Bit8 is transmitted in frame 17 and Bit15 in frame 23.
Remaining bits should be zero.

Mode OTX_T1_FF_F72:
nDlBits should contain 24 DL bits.
Bit0 is transmitted in frame 26 and Bit7 in frame 40
Bit8 is transmitted in frame 42 and Bit15 in frame 56.
Bit16 is transmitted in frame 58 and Bit23 in frame 72.
Remaining bits should be zero.

Comments

Developer Notes

See Also

Parameters

hLogicDevice

Handle to the T1 BitRob Access Logical Device

pRobBitData

Bit-robbed signalling data to be transmitted. See also OtxT1RobBitDataS

Comments

Developer Notes

See Also

Parameters

hDevice

Handle to the Logical device

eDataFormat

Format of the Generated Data

nConstWord

Constant Value to be sent

Comments

See Also

Parameters

hDevice

Handle to the Logical device

eDataFormat

Data Format of the Monitored Data Stream

nToneDuration

Time (in 12.75ms increments) that dialtone must be present to be reported

Comments

See Also

Parameters

hDevice

Handle to the Logical device

bDialtone

OTX_TRUE if Dial Tone present, OTX_FALSE if not

See Also

Parameters

hDevice

Handle to the Logical device

eDataFormat

Data Format of the Monitored Data Stream

bStoreInQueue

If OTX_TRUE, generate events and store the received digits in the Event QueusFifo, If OTX_FALSE Don't store. Provide polling test with function OtxToneDtmfDetectorStatus

Comments

Start detection by calling the function OtxDrvEnable and stop generation by calling the function OtxDrvDisable

See Also

Parameters

hDevice

Handle to the Logical device

cDtmfDigit

Most recent DTMF digit detected (or \\0 if none)

See Also

Parameters

hDevice

Handle to the Logical device

sqDigits[]

Digits to send

nDigits

Number of digits to send

nTaskRef

See OTX_TASK_REF

nWaitMaxMs

See OTX_TIME

Comments

See Also

Parameters

hDevice

Handle to the Logical device

eDataFormat

Data Format of the Generated DTMF digits

nOnTime

Duration of DTMF tones in milliseconds, 12.75 milliseconds resolution (0 for infinity)

nOffTime

Silence time between of DTMF tones in increments of 12.75ms

eToneGain

Digital gain of generated tone