GDK System Configuration

• Control Panel Configuration Utility
• Setting the Country Code Properly
• Country Codes and Call-Progress Error Codes
• Enabling Debug
• Enabling Transparent PRI Debug

The configuration parameters for the GDK software are now stored in the registry. The configuration can be changed using the Dialogic GDK Configuration utility.

Control Panel Configuration Utility

The automatic board detection and configuration processes are controlled by the services control panel applet. For more information, refer to the GDK Installation and Configuration Guide for Windows NT.

Setting the Country Code Properly

The COUNTRY command is required by the GDK firmware for proper operation of the fax channel. The COUNTRY parameter defines the country where the fax board has been designed to operate in, not the country where the board is currently installed. The firmware needs this information to select the correct electrical characteristics and PTT modem parameters.

NOTE:

The correct COUNTRY parameter code should be the country or countries specified on the hardware packaging materials. If the packaging materials specify more than one country, set the COUNTRY parameter code to the country in which the board is installed (the country must be one of the approved countries).

If the fax board is connected to a programmable PBX, the correct COUNTRY parameter code will depend on the following:

· the line characteristics generated by the PBX

· the country or countries for which the board has been designed

If the fax board has not been designed to recognize the line characteristics of the telephone network connection, it will not function properly.

Country Codes and Call-Progress Error Codes

Country codes are the prefixes used for international calls. They also serve as configuration values for the GDK software, setting up the date strings that are in the correct format for the specified country and activating country-specific dialing schemes in the software. GDK provides call-progress error codes that can help debug international calls. Refer to the Error and Status Codes Manual for a list of error codes.

Enabling Debug

Traditionally the GDK System Service has only allowed debug logging to a text file called %GFAX%\GFAX.$DL. Enabling debug is accomplished by the following command:

	HKEY_LOCAL_MACHINE\SOFTWARE\GammaLink\_global
  
		DEBUG

The DEBUG command is configured by one or two parameters whose mask values are defined in Table 1 and Table 2.

In addition to the DEBUG command, more options are available. With this release, the GDK System Service logs debug trace information to shared memory and only saves debug log information to file, if configured to do so. The level of trace information logged to shared memory and the level of trace information logged to a text file is separately configurable through various bit mask values. In Transparent PRI mode, the GDK system also provides access to Dialogic's PRI Trace logging functionality.

In addition to the existing DEBUG command, logging is now enabled and configured by setting the following commands:

	HKEY_LOCAL_MACHINE\SOFTWARE\Dialogic\Gammalink\Debug
  
		UseSRAM
  
		SRAMMask
  
		LogFile
  
		LogFileMask
  
		DebugToSRAM
  
		UseGFAX$DL

Debugging is enabled by first setting the UseSRAM command to a string value of either "yes" or "no".

NOTE:

If UseSRAM is set to "no", none of the other debug commands, including the existing DEBUG command, are enabled.

The level of debug information sent to shared memory is configured by setting SRAMMask to a bit mask whose value is defined by OR'ing the bits specified in Table 5. Saving debug trace information to a text file is enabled by setting the LogFile command to a full path and filename. The level of debug information written to the text file is configured by setting the LogFileMask to a bit mask whose value is defined by OR'ing the bits specified in Table 5. See GDK 5.0 New Parameter Summary for more information about these commands.

NOTE:

Do not save log information to a text file during normal operations; as it is disk intensive and will grow too large.

The functionality of the DebugToSRAM and UseGFAX$DL commands depend on the traditional DEBUG command being enabled. Setting the DebugToSRAM command to "yes" will include traditional DEBUG information in shared memory. Setting UseGFAX$DL to "yes" will save only traditional DEBUG information to a text file called %GFAX%\GFAX.$DL. These two commands are provided to maintain backward compatibility with the traditional DEBUG mechanism of logging to a text file.

The traditional DEBUG command provides system level and fax call progress diagnostic information. The level of detail and category of information provided is determined by the DEBUG command's mask value. The DEBUG command can contain two parameters; the second is optional. The first parameter specifies system level trace information; the second parameter specifies channel (or firmware) level trace information.

The debug mask value specifies the type and level information written to the log file. Table 3 defines the mask values for the DEBUG command's first parameter. Table 4 defines the mask values for the DEBUG command's optional second parameter.

NOTE:

The DEBUG command requires the high-order byte and the low-order byte of each parameter to be the same.

Table 3. Mask Values for DEBUG Parameter 1

Category	Mask	Description
Global diagnostics	0x01	Enables the logging of serious error messages.
Board messages	0x02	Enables board debug messages.
Polling diagnostics	0x04 = Type only 0x08 = Type and parameters 0x0C = Full trace	Reports every request the board makes of the System Service. Reports additional parameters for each transaction. Reports every poll along with details of internal packet.
Messaging diagnostics	0x10 = Connections 0x20 = Transactions 0x30 = Full trace	Reports the results of event notification and remote status and control operations. (It is recommended that 0x30 not be used.)
Queue file diagnostics	0x40 = Transactions 0x80 = All messages 0xC0 = Full trace	Reports accesses to the Queue file.

Table 4. Mask Values for DEBUG Parameter 2

Category	Mask	Description
Global diagnostics	0x0100	Enables error messages from the card and from failed faxes. Shows sent and received CSID values, as well as the phone number dialed.
T.30 diagnostics	0x0400	Enables all the above plus DIS bits and DCS bits sent and received. Also logs messages about image compressions and conversions written to disk.
Total diagnostics	0x0800	Enables all the above plus information in the queue record before being processed. Also logs information on the file and image being sent.

Table 5. Mask Values for SRAMMask and LogFileMask

Mnemonic	Bit	Description
DMASK_ERROR	1	A critical error occurred either at FAX or PRI level
DMASK_DIALERROR	1	Failures on Dialogic functions
DMASK_GENERAL	2	General Information (e.g. Number of channels, Version numbers)
DMASK_REGISTRY	3	Registry (read / write) related activity
DMASK_ERR_REGISTRY	3	Registry error related info
DMASK_GLCOMMAND	4	GDK related commands (e.g. GFXSHUTDOWN, GFXRECORD, ...)
DMASK_GLQSUBMQREC	5	On-hold, Free related activity
DMASK_GLPIPEOP	6	Pipe related activity
DMASK_GLMSG	7	Device related activity
DMASK_SCBUS	8	SCbus related activity
DMASK_SCMANAG	9	Resource management activity
DMASK_DIALMSG	10	Dialogic General information (ISDN frame, D-Channel, ...)
DMASK_DIALCMD	11	Dialogic commands related information
DMASK_SPECIAL	12	Dialogic special functions
DMASK_DIALEVENT	13	ISDN Event related information (all ccev events)
DMASK_DIALCC	14	Call control related information (all cc commands)
DMASK_DIALINFO	15	Dialogic / GDK interaction and board handles info.
DMASK_FIRMWARE	16	Debug information specific to Firmware
DMASK_DISPATCHER	17	Debug information specific to Dispatcher

NOTE:

There are 32 possible Debug Levels. Undefined Debug levels are reserved for future use.

Enabling Transparent PRI Debug

When Transparent PRI mode is enabled in the GDK System Service, the UseSRAM command is automatically enabled. Trace information about the ISDN and FAX resources is provided during system startup and initialization (this information is not outputted in non-ISDN mode).

In addition, the Dialogic ISDN cc_Trace logging mechanism is available by setting the following commands:

	HKEY_LOCAL_MACHINE\SOFTWARE\Dialogic\Gammalink\Debug
  
		TraceTrunkNumber
  
		TraceFileName

ISDN trace is enabled by setting TraceFileName to a full path and filename and by setting TraceTrunkNumber to a valid ISDN trunk. The resultant file from the TraceFileName command can be used as input to Dialogic's PRITRACE tool.

Debug Command Examples

To obtain debugging information for two categories, use the logical OR to combine the hex values. For example, to get polling diagnostics for type only, the first four digits of the mask are 0x04. Then, to get polling diagnostics for both type and parameters, the mask is 0x08. A full trace of polling diagnostics would be as follows:

0x04 OR 0x08 = 0x0C

where: the first byte is to file and the second byte is to screen.

Logging of general trace information and serious error messages can be enabled with the following parameter:

DEBUG 0x0101

The recommended debug level for most diagnostic purposes is the following mask value:

DEBUG 0xb7b7

To obtain additional fax protocol diagnostics, also set the second DEBUG parameter:

DEBUG 0xb7b7 0xc0c0

Debug Setting Dependencies

Two parameters have been added that control how the Debug information is logged:

· UseSRAM

· DebugToSRAM

The UseSRAM parameter lets you specify whether to log Debug levels with a bit setting of 1 to the Shared Memory. If the parameter is set to "yes" only the debug levels having a corresponding mask set to 1 in the bit mask SRAMMask are passed to Shared Memory.

The DebugToSRAM parameter lets you specify whether to send debug information with Debug level DMASK_FIRMWARE if the information is originated by the firmware (XXX_put), or DMASK_DISPATCHER if the information is originated by the dispatcher to Shared Memory.

For more information about these parameters, refer to the New Parameters section in Chapter 3.

Click here to contact Dialogic Customer Engineering