ABOUT DM3_cfg_help.txt - online help file for DM3_cfg.sh
ABOUT Version 1.15 Beta
ABOUT Copyright Intel/Dialogic 2001

ACT Board Enabled 
ACT 
ACT Description: Specifies whether the Dialogic System Service should 
ACT download firmware to activate the board. 
ACT 
ACT Guidelines: Enter Yes if you want to download this board. 
ACT 
ACT Enter No if you want to temporarily suspend the use of a 
ACT board in your system. Entering No will comment out the board 
ACT parameters in the configuration file (pyramid.scd). 
ACT 
ACT Values: Yes to enable this board, or No to disable this board. 
ACT 
ACT Default value: Yes 
ACT 
ACT SCD file syntax: The Board Enabled parameter is not in 
ACT the SCD file. It exists within the DM3_cfg.sh configuration 
ACT tool to allow you to easily create an SCD that will only 
ACT download a few boards in a multi-board system. If you disable 
ACT a board, its parameters are written as comment lines in the SCD 
ACT file. 
ACT 

DRIVERS Driver Parameter section. This section should be changed by 
DRIVERS qualified persons only. Incorrect settings can cause 
DRIVERS download or run-time problems. 
DRIVERS 
DRIVERS Default values: 
DRIVERS NumStreams         : 4000	; size of driver stream table 
DRIVERS NumBindHandles     : 4000	; size of driver bind table 
DRIVERS 

LOGID Logical ID 
LOGID 
LOGID Description: User-assigned ID used by the drivers to identify a 
LOGID board. 
LOGID 
LOGID Guidelines: Logical IDs help you keep track of which board is 
LOGID which. It is frequently easiest to assign logical IDs that match 
LOGID the physical location of the board, although this is not a 
LOGID requirement. Giving the first board in the system logical ID 1 
LOGID and sequentially numbering the rest from left to right makes it 
LOGID easy to remember without having to check the configuration file. 
LOGID 
LOGID Since some chassis have slot numbers beginning with 0 rather
LOGID than 1, and a logical ID of 0 is not a valid value, the default
LOGID value for logical ID is PCI slot number + 1. So if the default
LOGID logical IDs for your boards begin with 2 and you would prefer 1,
LOGID change the default values.
LOGID  
LOGID Values: Must be a unique positive integer from 1-16. 
LOGID 
LOGID Default value: PCI slot number + 1
LOGID 
LOGID SCD file syntax: 'Board' followed by the logical ID, enclosed in 
LOGID square brackets. Board-specific information follows enclosed in 
LOGID curly braces. 
LOGID 
LOGID Example: 
LOGID [Board 1] { 
LOGID . 
LOGID .  (board-specific info goes here) 
LOGID . 
LOGID } 
LOGID 

PCD PCD File Name 
PCD 
PCD Description: Specifies the name of the product configuration 
PCD description (PCD) file. The PCD file lists object files and maps 
PCD them to specific processors, configures the kernel for each 
PCD processor, and sets the number of component instances to run on 
PCD each processor. 
PCD 
PCD When you select the parameter to change a boards PCD file name, 
PCD a list of valid PCD files for that particular board are displayed. 
PCD 
PCD Guidelines: Select the PCD file according to the feature set 
PCD (media load) and protocol that this board will use. For information 
PCD about the media loads and PCD files available in this release, see 
PCD the Release Guide. 
PCD 
PCD Values: Any valid PCD file name. The valid PCD file names for the 
PCD board being configured will be displayed. 
PCD 
PCD Default value: NOT_SET. Note that a value for the PCD file name 
PCD parameter must be selected, because the default value cannot be 
PCD used. 
PCD 
PCD SCD file syntax: 'PCDName' followed by a colon and a valid PCD 
PCD file name. 
PCD 
PCD Example: 
PCD PCDName             : ipt_isdn_5ess.pcd 
PCD 


FCD FCD File Name 
FCD 
FCD Description: Specifies the name of the feature configuration 
FCD description (FCD) file. The FCD file adjusts the settings of the 
FCD components that make up each product. For example, an FCD file may 
FCD contain instructions to set certain country-specific codes or 
FCD configure network interface protocols. 
FCD 
FCD Guidelines: The PCD file should be selected first, because this 
FCD determines the default FCD file. The default FCD file has the same 
FCD name as the PCD file but has the extension .fcd instead of .pcd. 
FCD 
FCD The default value is appropriate for most configurations, although 
FCD there are cases where different .fcd files can be used for the same 
FCD .pcd file. If you dont want to use the default, you have to enter 
FCD the FCD file name manually. (Valid file names will not be displayed 
FCD as they are for the PCD file.) For information about the FCD 
FCD files available in this release, see the Release Guide. 
FCD 
FCD Values: Any valid FCD file name. 
FCD 
FCD Default value: Same as the PCD file name (with .fcd extension) 
FCD 
FCD SCD file syntax: 'FCDName' followed by a colon and a valid FCD 
FCD file name. 
FCD 
FCD Example: 
FCD FCDName            : ipt_isdn_5ess.fcd 
FCD 

CFGCLUST Cluster configuration is now handled directly in the PCD. 
CFGCLUST This section is no longer used. 
CFGCLUST 

PCM PCM Encoding 
PCM 
PCM Description: Specifies the pulse code modulation (PCM) encoding 
PCM method as either ALAW or MULAW. 
PCM 
PCM Guidelines: The default value (based on the boards network 
PCM interface) should be appropriate: ALAW for E-1 boards or MULAW 
PCM for T-1 boards. 
PCM 
PCM Some boards (such as resource-only boards) have no network 
PCM interface; in this case the default value is NOT_SET, and you must 
PCM make sure that you select the correct value. All boards connected 
PCM via a telephony bus cable (CT Bus or SCbus) must use the same 
PCM encoding method. 
PCM 
PCM Values: ALAW or MULAW. 
PCM 
PCM Default value: Whatever is appropriate for the board: ALAW for E-1 
PCM boards or MULAW for T-1 boards. NOT_SET is the default if the 
PCM appropriate setting cannot be determined (for example, for 
PCM resource-only boards), and this must be changed to either ALAW or 
PCM MULAW. 
PCM 
PCM SCD file syntax: 'PCMEncoding' followed by a colon and a valid 
PCM encoding method. 
PCM 
PCM Example: 
PCM PCMEncoding        : MULAW 
PCM 

SLOT Slot Number section. Slot number is the physical location on the 
SLOT PCI (or cPCI) bus. The user is not allowed to change this value 
SLOT in the DM3_cfg script. Physically moving the board or changing 
SLOT its device ID selector will cause this value to change and 
SLOT require an SCD update. 
SLOT 
SLOT Default value: Value returned by listboards 
SLOT 
SLOT SCD file syntax: 'SlotNumber' followed by a colon and a valid 
SLOT slot number. Usually from 1 (or 0 depending on the system) to 
SLOT the total number of slots (or slots - 1). 
SLOT 
SLOT Example: 
SLOT SlotNumber         : 1 
SLOT 

SYSBUS System Bus section. This section sets the type of bus the board 
SYSBUS is plugged into in the system. Only PCI/cPCI systems are 
SYSBUS supported at this time, so the user cannot change this value 
SYSBUS in the DM3_cfg script. 
SYSBUS 
SYSBUS Default value: PCI (covers PCI and cPCI) 
SYSBUS 
SYSBUS SCD file syntax: 'BusType' followed by a colon and a valid 
SYSBUS bus type. 
SYSBUS 
SYSBUS Example: 
SYSBUS BusType            : PCI
SYSBUS 

LOG Log File section. 
LOG 
LOG Default value: board<Logical ID Number>.log 
LOG 
LOG SCD file syntax: 'LogFile' followed by a colon and a valid 
LOG log file name. 
LOG 
LOG Example: 
LOG LogFile            : board1.log 
LOG 

DISPLAY Display Configuration section. 
DISPLAY 
DISPLAY Default value: YES 
DISPLAY 
DISPLAY SCD file syntax: 'DisplayConfig' followed by a colon and 
DISPLAY YES or NO. 
DISPLAY 
DISPLAY Example: 
DISPLAY DisplayConfig      : YES 
DISPLAY 
 
TTS Time to Send Message section. 
TTS 
TTS Default value: 50 
TTS 
TTS SCD file syntax: 'TimeToSendMsg' followed by a colon and 
TTS a value in milliseconds. 
TTS 
TTS Example: 
TTS TimeToSendMsg      : 50 
TTS 

BM TDM Clock Function 
BM 
BM Description: Specifies whether this board is a clock master or 
BM slave. A clock master is one of the boards in a system that is 
BM designated to provide reference timing for all boards attached to 
BM the bus. This board must derive timing from a network reference
BM which ultimately derives clock from a T-1 or E-1 line (for
BM example, the H.100 CT_NETREF), or else must derive timing 
BM from a digital network interface or, as a last alternative,
BM from its own internal oscillator. 
BM 
BM The H.100/H.110 bus has two types of clock masters: Primary Clock 
BM Master and Secondary Clock Master. The Secondary Clock Master 
BM becomes the clock master if the Primary Clock Master fails or is 
BM removed from the system. 
BM 
BM Guidelines: Only one board in a system can be the primary clock 
BM master. 
BM 
BM Note: Since the default value for the TDM Clock Function parameter 
BM is PRIMARY, you must change the default for all boards that are not 
BM the Primary Clock Master. One of the boards can be the Secondary 
BM Clock Master, and all other boards must be slaves. The Secondary 
BM Clock Master is used in CT Bus applications only, so this setting 
BM is not applicable when the TDM Bus Type parameter is SCBUS. 
BM 
BM H.100 boards require certain signals that can only be provided by 
BM another H.100 board and routed over the H.100 cable. Make sure that 
BM the board that you intend to use as the clock master can do the 
BM following: 
BM 
BM  - Derive timing from a network reference or directly from a 
BM    digital network interface 
BM 
BM  - Provide both H.100 core signals and compatibility bus signals 
BM 
BM In addition, the placement of the clock master board within the 
BM chassis is significant in mixed CT Bus/SCbus systems. Typically, 
BM the clock master board is located at either end of the 68-lead 
BM H.100 cable. In systems that include at least one board with a 
BM 26-pin (SCbus) connector, the H.100 board to the furthest right 
BM (when viewed from the faceplate) should be designated as the clock 
BM master. 
BM  
BM If your system contains both DM3 boards and SpringWare boards, and
BM if a SpringWare board is the clock master, set the TDM Clock 
BM Function parameter to SLAVE for all DM3 boards. (All other TDM bus 
BM configuration parameters for the DM3 boards will use the H.100 
BM defaults.) However, if a SpringWare board is the clock master and
BM a DM3 board is providing the NETREF_1 signal, you have to manually
BM edit the pyramid.scd file to specify the board that is providing
BM the NETREF_1 signal. Use the NetRef1, NetRef1From, and NetRef1CR
BM parameters.
BM  
BM Note: When both DM3 and SpringWare boards are installed in the same
BM system, the technology (board type) that is to provide the clock
BM master must be downloaded first. By default, this is assumed to be
BM DM3. If you want a SpringWare board to be the clock master in a
BM mixed DM3/SpringWare system, you have to use the dlorder command
BM (or edit the .order file) to specify that a SpringWare board is the
BM clock master and should be downloaded first.
BM 
BM Values: PRIMARY, SECONDARY, or SLAVE. Only one board can be PRIMARY, 
BM one board can be SECONDARY, and all others are SLAVEs. SECONDARY is 
BM valid only in CT Bus applications. 
BM 
BM Default value: PRIMARY. Since only one board can actually be the 
BM Primary Clock Master, the default must be changed for all boards 
BM that are not the Primary Clock Master. 
BM 
BM SCD file syntax: 'MasterStatus' followed by a colon and either 
BM PRIMARY, SECONDARY (CT Bus only), or SLAVE.
BM
BM Example: 
BM MasterStatus       : PRIMARY 
BM 

TDM TDM Bus Type 
TDM 
TDM Description: Specifies the bus mode for the TDM bus as either 
TDM H100, H110, or SCBUS. H100 is CT Bus on PCI systems, and H110
TDM is CT Bus on cPCI systems.
TDM 
TDM Guidelines: This parameter only has to be set for the board that 
TDM is the primary clock master. The value NA (not applicable) will 
TDM be displayed for all other boards. 
TDM  
TDM If your system contains an SCbus-only board (such as some of the 
TDM SpringWare boards), then the TDM Bus Type parameter must be set to 
TDM SCBUS, even though you may have one or more H.100 compliant boards 
TDM in the system. (SCBUS is not supported on cPCI.)
TDM 
TDM Values: H100, H110, or SCBUS. 
TDM 
TDM Default value: H100 
TDM 
TDM SCD file syntax: 'TDMBusType' followed by a colon and either 
TDM H100, H110, or SCBUS. 
TDM 
TDM Example: 
TDM TDMBusType         : H100 
TDM 

BCR 
BCR 
BCR 
BCR Default value: 8 for H100 and H110, 4 for SCbus. 
BCR 
BCR SCD file syntax: 'BusCR' followed by a colon and a valid clock 
BCR rate (8 for CT Bus, 4 for SCbus). 
BCR 
BCR Example: 
BCR BusCR              : 8 
BCR 

GxCR 
GxCR 
GxCR 
GxCR Default value: 8 
GxCR 
GxCR SCD file syntax: 'Group<group number>CR' followed by a colon and 
GxCR a valid clock rate (only 8 currently). 
GxCR 
GxCR Example: 
GxCR Group1CR           : 8 
GxCR 

CS Clock Source 
CS 
CS Description: Specifies the clock source used to drive the Primary 
CS Line. 
CS 
CS Guidelines: This parameter only has to be set for the board that is 
CS the Primary Clock Master. The value NA (not applicable) will be 
CS displayed for all other boards. 
CS 
CS The default clock source is the internal oscillator of the Primary 
CS Clock Master board. However, clocking should be derived from a 
CS network reference or directly from a digital network interface if
CS available, not from a boards internal oscillator. The internal 
CS oscillator should be used as the clock source only for internal 
CS testing purposes. 
CS
CS If the clock source is set to NETREF_1, you must manually edit the 
CS pyramid.scd file to specify the board that is providing the NETREF_1 
CS signal. Add the following parameters to the board parameter section 
CS for the board providing the NETREF_1 signal:
CS 
CS   NetRef1        : Yes
CS   NetRef1From    : <network interface trunk number 1-4>
CS   NetRef1CR      : 1
CS
CS where:
CS 
CS - NetRef1: Yes specifies that this board is providing the NETREF_1 
CS   signal.
CS - NetRef1From: <network interface trunk number 1-4> specifies the 
CS   network interface source of the reference, for example, 
CS   NetRef1From: 1 to derive CS   NETREF_1 from network interface 
CS   trunk 1.
CS - NetRef1CR: 1 specifies the clock rate for the NETREF_1 line. 
CS   Currently, only 8 kHz is supported and this is indicated by 
CS   entering NetRef1CR: 1 as shown.
CS
CS Likewise, if the clock source is set to NETREF_2, you must manually
CS edit the pyramid.scd file to specify the board that is providing 
CS the NETREF_2 signal. In this case, use the parameters NetRef2, 
CS NetRef2From, and NetRef2CR.
CS 
CS Values: Valid values for the Clock Source parameter are: 
CS 
CS  - OSC: derive clocking from the boards internal oscillator 
CS  - NETREF_1: derive clocking from NETREF_1 
CS    NOTE: When NETREF_1 is selected, be sure to add the NetRef1, 
CS          NetRef1From, and NetRef1CR parameters to the pyramid.scd 
CS          file in the board section for the board providing the 
CS          NETREF_1 signal.
CS  - NETREF_2: derive clocking from NETREF_2 (H.110 only)
CS    NOTE: When NETREF_2 is selected, be sure to add the NetRef2, 
CS          NetRef2From, and NetRef2CR parameters to the pyramid.scd
CS          file in the board section for the board providing the 
CS          NETREF_1 signal.
CS
CS The following are valid values for SCbus mode only:
CS 
CS  - 1: derive clocking from network interface trunk 1 
CS  - 2: derive clocking from network interface trunk 2 
CS  - 3: derive clocking from network interface trunk 3 
CS  - 4: derive clocking from network interface trunk 4 
CS 
CS Default value: OSC 
CS 
CS SCD file syntax: 'DeriveClockFrom' followed by a colon and 
CS a valid clock source. 
CS 
CS Example: 
CS DeriveClockFrom    : NETREF_1 
CS 

CL Primary CT Bus Clock Line 
CL 
CL Description: Specifies whether the Primary Line is Line A or Line B. 
CL Line A and Line B are the two pairs of clock signals that the CT Bus 
CL sets aside for clock synchronization. Either Line A or Line B can be 
CL assigned as the Primary Line; the remaining line is assigned as the 
CL Secondary Line. The Primary Line is driven by the Primary Clock 
CL Master, and the Secondary Line is driven by the Secondary Clock 
CL Master. 
CL 
CL Guidelines: This parameter only has to be set for the board that is 
CL the primary clock master. The value NA (not applicable) will be 
CL displayed for all other boards. 
CL 
CL Since this parameter is used for CT Bus only, it is not applicable 
CL when the TDM Bus Type parameter is SCBUS. 
CL 
CL Values: CT_A for Line A or CT_B for Line B. 
CL 
CL Default value: CT_A 
CL 
CL SCD file syntax: 'PrimaryLines' followed by a colon and either 
CL CT_A or CT_B. 
CL 
CL Example: 
CL PrimaryLines       : CT_A  
CL 

NIC 
NIC 
NIC 
NIC Default value: Same as the board Logical ID 
NIC 
NIC SCD file syntax: 'NIC' followed by the numeric NIC ID, enclosed 
NIC in square brackets. This structure must be nested within the 
NIC board structure. NIC specific information follows, enclosed in 
NIC curly braces. 
NIC 
NIC Example: 
NIC [NIC 1] 
NIC  { 
NIC   . 
NIC   . (NIC info goes here) 
NIC   . 
NIC  } 
NIC 

BIP Board IP Address 
BIP 
BIP Description: Specifies the IP address to be assigned to the NIC on 
BIP this IPLink board. Incoming calls to this IPLink board should be 
BIP directed to the IP address specified by this parameter. 
BIP 
BIP Guidelines: Each IPLink board in the system must have a unique 
BIP value for the Board IP Address parameter. Use the format 
BIP xxx.xxx.xxx.xxx (for example, 146.152.187.42). 
BIP 
BIP Values: A valid IP address. 
BIP 
BIP Default value: 000.000.000.000 
BIP 
BIP SCD file syntax: 'IPAddress' followed by a colon and a valid 
BIP IP address. 
BIP 
BIP Example: 
BIP IPAddress        : 255.255.255.255 
BIP 

BSM Board Subnet Mask 
BSM 
BSM Description: A number used as a filter (mask) to determine a subnet 
BSM address. IP addresses have two components: the network address and 
BSM the host address. Subnetting is a way to further divide the host 
BSM part of the address so that an IP address can be shared on a LAN. 
BSM With IPLink applications, for example, subnetting can be used to 
BSM determine whether Ethernet packets are sent directly to a particular 
BSM address or sent to a default router. The board subnet mask and IP 
BSM address are ANDed to identify the subnet address. 
BSM 
BSM Guidelines: Set this parameter according to site IP procedures. 
BSM Use the format FFFFFFFF, where each pair of Fs represents one 
BSM segment of the mask. For example, use FFFFFF0A for 255.255.255.10. 
BSM 
BSM Values: A valid subnet mask in hexadecimal. 
BSM 
BSM Default value: FFFFFF00 
BSM 
BSM SCD file syntax: 'SubnetMask' followed by a colon and a valid 
BSM subnet mask in hexadecimal. 
BSM 
BSM Example: 
BSM SubnetMask       : ffffff00 
BSM 

NICNAME Board Name 
NICNAME 
NICNAME Description: Specifies the name of the NIC on the IPLink board. 
NICNAME This is the name by which you will refer to the board, for 
NICNAME example, in the Domain Naming System (DNS). 
NICNAME 
NICNAME Guidelines: You can choose any name. 
NICNAME 
NICNAME Values: Any specified name. 
NICNAME 
NICNAME Default value: board<logical ID> (for example, board1) 
NICNAME 
NICNAME SCD file syntax: 'TargetName' followed by a colon and the 
NICNAME name specified for the NIC (e.g., in DNS). 
NICNAME 
NICNAME Example: 
NICNAME TargetName       : board1 
NICNAME 

HIP Host IP Address 
HIP 
HIP Description: Specifies the IP address of the third-party NIC on 
HIP the host. 
HIP 
HIP Systems using an IPLink board with an onboard NIC do not require 
HIP a third-party NIC, because this functionality is provided on the 
HIP board itself. Even for these boards, however, installing a 
HIP third-party NIC in the same host provides a means for verifying 
HIP the integrity of the built-in NIC. 
HIP 
HIP Guidelines: Use the format xxx.xxx.xxx.xxx (for example, 
HIP 146.152.187.42). 
HIP 
HIP Values: A valid IP address. 
HIP 
HIP Default value: 000.000.000.000 
HIP 
HIP SCD file syntax: 'HostIPAddress' followed by a colon and a 
HIP valid IP address. 
HIP 
HIP Example: 
HIP HostIPAddress    : 000.000.000.000 
HIP 

HOST Host Name 
HOST 
HOST Description: Specifies the name of the host system whose IP 
HOST address is defined using the Host IP Address parameter. 
HOST 
HOST Guidelines: Enter the name of the host system. 
HOST 
HOST Values: Any specified name by which the system is known to a 
HOST communications network. 
HOST 
HOST Default value: The value returned by uname -n 
HOST 
HOST SCD file syntax: 'HostName' followed by a colon and the 
HOST name of the host machine in which the board is installed. 
HOST 
HOST Example: 
HOST HostName         : myhost 
HOST 


HUID Host User ID 
HUID 
HUID Description: Specifies the name of a valid user on the host 
HUID system named using the Host Name parameter. 
HUID 
HUID Guidelines: Enter any name with valid log-on access to the host 
HUID system. 
HUID 
HUID Values: A valid user name. 
HUID 
HUID Default value: nobody 
HUID 
HUID SCD file syntax: 'UserName' followed by a colon and the name of 
HUID a valid user on the host machine in which the board is installed. 
HUID 
HUID Example: 
HUID UserName         : nobody 
HUID 

GIP Gateway IP Address 
GIP 
GIP Description: Specifies the IP address of the default router for 
GIP the Ethernet interface. 
GIP 
GIP Guidelines: Use the format xxx.xxx.xxx.xxx (for example, 
GIP 146.152.187.42). 
GIP 
GIP Values: A valid IP address. 
GIP 
GIP Default value: 000.000.000.255 
GIP 
GIP SCD file syntax: 'GatewayIPAddress' followed by a colon and a 
GIP valid IP address. 
GIP 
GIP Example: 
GIP GatewayIPAddress : 255.255.255.255 
GIP 


