Digital Network Interface Software Reference dt

dt_getparm( )

Description | Cautions | Example | Errors | See Also

Name:

int dt_getparm(devh,param,valuep)

Inputs:

int devh

Digital Network Interface logical board device handle

unsigned long param

device parameter defined name

void *valuep

pointer to integer variable for parameter value

Returns:

0 on success
-1 on failure

Includes:

srllib.h
dtilib.h

Category:

Parameter Request

Mode:

synchronous

Description

The dt_getparm( ) function gets the current value of the selected Digital Network Interface device parameter.

Parameter

Description

devh:

Specifies the valid Digital Network Interface logical board device handle returned by a call to dt_open( ).

param:

Specifies the parameter to be examined.

valuep:

Points to the variable to which the value of the parameter will be assigned.

Table 6 lists each parameter name, its default value, and a brief description.

Table 6. dt_getparm( ) Parameters

#DEFINE

VALUE

DESCRIPTION

DTG_RDEBON

0-255 (5 default)

debounce value for receive signaling transitions from logical 0 to 1 and 1 to 0 (in 10 ms units). DTG_RDEBON is used for only the debounce on value for DTI/1xx boards, but is used for both debounce on and debounce off for Digital Network Interface boards.

DTG_CABTYPE

- - -

line interface unit (LIU) cable length and type (T-1 only):

Digital Network Interface only

DTLL_G703

CCITT recommendation G.703, 2.048 MHz.

DTLL_FCC68

FCC part 68 option A, CSU

DTLL_ANSIT1

ANSI T1.403, CSU

DTLL_133ABAM

0-133 feet DSX-1 ABAM (default)

DTLL_266ABAM

133-266 feet DSX-1 ABAM

DTLL_399ABAM

266-399 feet DSX-1 ABAM

DTLL_533ABAM

399-533 feet DSX-1 ABAM

DTLL_655ABAM

533-655 feet DSX-1 ABAM

D/240SC-T1 only

DTLL_000

000-110 feet

DTLL_110

110-220 feet

DTLL_220

220-330 feet

DTLL_330

330-440 feet

DTLL_440

440-550 feet

DTLL_550

550-655 feet

DTLL_655

655 feet or greater

DTLL_SQUARE

square pulse

DTG_CODESUPR

- - -

bipolar format suppression value (T-1 only).

DTSP_TRAN

transparent (default).

DTSP_B8ZS

binary 8 zero suppression.

DTSP_BIT7

bit 7 stuffing.

DTG_IDLTYP

- - -

gets IDLE value:

IDLE_7F (default)

T-1 IDLE value is 7FH

IDLE_54

E-1 IDLE value is 54H

IDLE_FF

T-1 IDLE value is FFH

IDLE_D5

E-1 IDLE value is D5H

DTG_SETBDMD

- - -

get device mode value. This parameter will NOT change the device mode if the Digital Network Interface remote loopback test switch is set to ON.

DTMD_NORMAL

normal mode (default if Digital Network Interface remote loopback test switch is set to OFF).

DTMD_XCVRLB

transceiver local loopback mode (used for Digital Network Interface testing).

DTMD_LIULLB

line interface unit local loopback mode (used for Digital Network Interface testing).

DTMD_LIURLB

line interface unit remote loopback mode (used by network for network testing).

DTG_SETCLK

- - -

get clock source (see the Software Installation Guide (for Linux or Windows)

DTC_LOOP (default)

loop timing (clock derived from receive sync; if RLOS detected, falls back to DTC_IND)

DTC_IND

1.544 MHz (T-1) or 2.048 MHz (E-1) independent timing

DTC_NOCLK

no clock

DTG_OOFMAX

0-15 (0 default)

(T-1 only) number of out-of-frame errors to allow before sending an alarm (maximum <= 15). For the default value, an alarm is sent after first detected frame error

DTD_SNDIDLE

transmit IDLE (0 = NO, 1 = YES)

DTD_IDLEVAL

IDLE value to transmit (0 = 7F for T-1, 54 for E-1; 1 = FF for T-1, D5 for E-1)

DTD_STXSIG

(0 = NO, 1 = YES)

DTD_SIGVAL

transmit signaling value (0 = 0, 1 = 1)

DTG_ECRRSTTM

10 (default)

(E-1 only) rate, in 100 ms units, to reset the following 3 error-count registers

DTG_BPVCMAX

0 - 255 (255 default)

bipolar violation count saturation

DTG_CECRMAX

0 - 255 (255 default)

(E-1 only) CRC error count saturation

DTG_FECRMAX

0 - 255 (4 default)

(E-1 only) frame sync error count saturation

DTG_FECSMAX

0 (default)

(T-1 only) frame error count saturation.

DTG_PREWINK

0 (default)

pre-wink transmit delay in 10 ms units.

DTG_WINKLEN

15 (default)

transmit wink duration in 10 ms units.

DTG_WINKMIN

10 (default)

minimum receive wink time in 10 ms units.

DTG_WINKMAX

32 (default)

maximum receive wink time in 10 ms units.

DTG_REDTIME

250 (default)

(T-1 only) time in 10 ms units during which loss of sync (LOS) must exist before declaring a red alarm.

DTG_RCOVRTM

1200 (default)

(T-1 only) time in 10 ms units after recovery of red alarm that a yellow alarm must still be transmitted.

300 (default)

(E-1 only) time in 10 ms units after recovery of FECS alarm.

DTG_RXTXIDLE

0x0F0E (default)

used to set the receive and transmit idle patterns that must be present prior to waiting for a seizure. The upper byte represents the receive signaling pattern, and the lower byte represents the transmit signaling pattern. Bits 0 to 3 represent transmit A, B, C, and D bits. Bits 8 to 11 represent receive A, B, C, and D bits. OFF=0 and ON=1.

DTG_SEIZESIG

0x0C0F (default)

used to set the receive signaling pattern that defines a line seizure and the transmit signaling pattern to use for a response. Bits 0 to 3 represent transmit A, B, C, and D bits. Bits 8 to 11 represent receive A, B, C, and D bits. OFF=0 and ON=1.

Cautions

This function will fail under the following conditions:
- An invalid Digital Network Interface logical board device handle is specified
- The parameter specified is invalid
This function will not fail if time slot devices are open on the Digital Network Interface logical board device.
The value of the parameter returned by this function is an integer. The valuep pointer is the address of an integer, but should be cast as a void pointer when passed in the parameter field.

Example

#include <windows.h>      /* For Windows applications only */  
#include <srllib.h>  
#include <dtilib.h>  
#include <errno.h>  
   
main()  
{  
   int devh;              /* Board device handle */  
   int valuep;            /* Parameter value */  
   /*  
    * Open board 1 device  
    */  
   if ( ( devh = dt_open( "dtiB1", 0 ) ) == -1 ) {  
      printf( "Cannot open board dtiB1.  errno = %d", errno );  
      exit( 1 );  
   }  
   
   /*  
    * Get current clock parameter value  
    */  
   if ( dt_getparm( devh, DTG_SETCLK, ( void * )&valuep ) == -1 ) {  
      printf( "Error message = %s.",ATDV_ERRMSGP( devh ) );  
      exit( 1 );  
   }  
   
/*  
    * Report current clock setting  
    */  
   if ( valuep & DTC_LOOP) {  
      printf( "Clock is set to loop timing \n");  
   }  
   .  
}

Errors

If the function returns -1, use the SRL Standard Attribute function ATDV_LASTERR( ) to obtain the error code or use ATDV_ERRMSGP( ) to obtain a descriptive error message. See Appendix A - Standard Runtime Library for more information on SRL functions. The error codes returned by ATDV_LASTERR( ) are:

EDT_BADBRDERR - Digital Network Interface missing or defective
EDT_BADCMDERR - invalid or undefined command to driver
EDT_BADGLOB - invalid param value
EDT_FWERR - firmware returned an error
EDT_INVBD - invalid Digital Network Interface logical board device handle
EDT_NOMEMERR - cannot map or allocate memory in driver
EDT_PARAMERR - invalid parameter
EDT_RANGEERR - bad/overlapping physical memory range
EDT_SIZERR - message too big or too small
EDT_SKIPRPLYERR - a required reply was skipped
EDT_SYSTEM - system error - check the global variable errno for more information about the error
EDT_TMOERR - timed out waiting for reply from firmware

Error defines can be found in the file dtilib.h.

See Also

dt_setparm( )

Click here to contact Dialogic Customer Engineering

Name:	int dt_getparm(devh,param,valuep)
Inputs:	int devh	Digital Network Interface logical board device handle
	unsigned long param	device parameter defined name
	void *valuep	pointer to integer variable for parameter value
Returns:	0 on success -1 on failure
Includes:	srllib.h dtilib.h
Category:	Parameter Request
Mode:	synchronous

Parameter	Description
devh:	Specifies the valid Digital Network Interface logical board device handle returned by a call to dt_open( ).
param:	Specifies the parameter to be examined.
valuep:	Points to the variable to which the value of the parameter will be assigned.

#DEFINE	VALUE	DESCRIPTION
DTG_RDEBON	0-255 (5 default)	debounce value for receive signaling transitions from logical 0 to 1 and 1 to 0 (in 10 ms units). DTG_RDEBON is used for only the debounce on value for DTI/1xx boards, but is used for both debounce on and debounce off for Digital Network Interface boards.
DTG_CABTYPE	- - -	line interface unit (LIU) cable length and type (T-1 only):
Digital Network Interface only
	DTLL_G703	CCITT recommendation G.703, 2.048 MHz.
	DTLL_FCC68	FCC part 68 option A, CSU
	DTLL_ANSIT1	ANSI T1.403, CSU
	DTLL_133ABAM	0-133 feet DSX-1 ABAM (default)
	DTLL_266ABAM	133-266 feet DSX-1 ABAM
	DTLL_399ABAM	266-399 feet DSX-1 ABAM
	DTLL_533ABAM	399-533 feet DSX-1 ABAM
	DTLL_655ABAM	533-655 feet DSX-1 ABAM
D/240SC-T1 only
	DTLL_000	000-110 feet
	DTLL_110	110-220 feet
	DTLL_220	220-330 feet
	DTLL_330	330-440 feet
	DTLL_440	440-550 feet
	DTLL_550	550-655 feet
	DTLL_655	655 feet or greater
	DTLL_SQUARE	square pulse
DTG_CODESUPR	- - -	bipolar format suppression value (T-1 only).
	DTSP_TRAN	transparent (default).
	DTSP_B8ZS	binary 8 zero suppression.
	DTSP_BIT7	bit 7 stuffing.
DTG_IDLTYP	- - -	gets IDLE value:
	IDLE_7F (default)	T-1 IDLE value is 7FH
	IDLE_54	E-1 IDLE value is 54H
	IDLE_FF	T-1 IDLE value is FFH
	IDLE_D5	E-1 IDLE value is D5H
DTG_SETBDMD	- - -	get device mode value. This parameter will NOT change the device mode if the Digital Network Interface remote loopback test switch is set to ON.
	DTMD_NORMAL	normal mode (default if Digital Network Interface remote loopback test switch is set to OFF).
	DTMD_XCVRLB	transceiver local loopback mode (used for Digital Network Interface testing).
	DTMD_LIULLB	line interface unit local loopback mode (used for Digital Network Interface testing).
	DTMD_LIURLB	line interface unit remote loopback mode (used by network for network testing).
DTG_SETCLK	- - -	get clock source (see the Software Installation Guide (for Linux or Windows)
	DTC_LOOP (default)	loop timing (clock derived from receive sync; if RLOS detected, falls back to DTC_IND)
	DTC_IND	1.544 MHz (T-1) or 2.048 MHz (E-1) independent timing
	DTC_NOCLK	no clock
DTG_OOFMAX	0-15 (0 default)	(T-1 only) number of out-of-frame errors to allow before sending an alarm (maximum <= 15). For the default value, an alarm is sent after first detected frame error
	DTD_SNDIDLE	transmit IDLE (0 = NO, 1 = YES)
	DTD_IDLEVAL	IDLE value to transmit (0 = 7F for T-1, 54 for E-1; 1 = FF for T-1, D5 for E-1)
	DTD_STXSIG	(0 = NO, 1 = YES)
	DTD_SIGVAL	transmit signaling value (0 = 0, 1 = 1)
DTG_ECRRSTTM	10 (default)	(E-1 only) rate, in 100 ms units, to reset the following 3 error-count registers
DTG_BPVCMAX	0 - 255 (255 default)	bipolar violation count saturation
DTG_CECRMAX	0 - 255 (255 default)	(E-1 only) CRC error count saturation
DTG_FECRMAX	0 - 255 (4 default)	(E-1 only) frame sync error count saturation
DTG_FECSMAX	0 (default)	(T-1 only) frame error count saturation.
DTG_PREWINK	0 (default)	pre-wink transmit delay in 10 ms units.
DTG_WINKLEN	15 (default)	transmit wink duration in 10 ms units.
DTG_WINKMIN	10 (default)	minimum receive wink time in 10 ms units.
DTG_WINKMAX	32 (default)	maximum receive wink time in 10 ms units.
DTG_REDTIME	250 (default)	(T-1 only) time in 10 ms units during which loss of sync (LOS) must exist before declaring a red alarm.
DTG_RCOVRTM	1200 (default)	(T-1 only) time in 10 ms units after recovery of red alarm that a yellow alarm must still be transmitted.
	300 (default)	(E-1 only) time in 10 ms units after recovery of FECS alarm.
DTG_RXTXIDLE	0x0F0E (default)	used to set the receive and transmit idle patterns that must be present prior to waiting for a seizure. The upper byte represents the receive signaling pattern, and the lower byte represents the transmit signaling pattern. Bits 0 to 3 represent transmit A, B, C, and D bits. Bits 8 to 11 represent receive A, B, C, and D bits. OFF=0 and ON=1.
DTG_SEIZESIG	0x0C0F (default)	used to set the receive signaling pattern that defines a line seizure and the transmit signaling pattern to use for a response. Bits 0 to 3 represent transmit A, B, C, and D bits. Bits 8 to 11 represent receive A, B, C, and D bits. OFF=0 and ON=1.