SccpInitUSapCfg

Initializes an SCCP user service access point configuration buffer to default values that can be passed to SccpSetUSapCfg.

Prototype

SCCP_STATUS SccpInitUSapCfg ( SccpUSapCfg *pCfg, S16 swType)

Argument

Description

pCfg

Pointer to the address of the SCCP SAP configuration parameters buffer:

typedef struct
{
  U16  numConPc;                 /* number of concerned point codes */
  U16  dummy;                    /*                                 */
  U32  usapOpc;                  /* OPC for this USAP               */
  U32  conPcList[SCCP_MAXCONPC]; /* concerned point code list       */
} UsapOpcInfo;

typedef struct
{
  S16          swType;                   /* Protocol Switch 
                                          * type/version               */
  U8           selector;                 /* selector                   */
  U8           spare1;                   /* alignment                  */
  MemoryId     mem;                      /* memory region & pool id    */
  U8           bkupPcInd;                /* backup point code indicator
                                          * (0==none)                  */
  U8           aicEnabled;               /* app. inactivity timing
                                          * enabled (1 = yes)          */
  U16          numAltOpc;                /* number of alternate PCs    */
  UsapOpcInfo  usapAltOpc[SCCP_MAXALTOPC]; /* multiple OPCs            */
  U32          bkupPc;                   /* backup point code          */
  SccpAddrMask addrMaskList[SCCP_MAXMASKS];   
                                         /* address mask for outgoing 
                                          * pkts on this SAP           */
  U8           useMsk;                   /* use address mask?
                                          * (0=no, 1=yes)              */
  U8           priority;                 /* priority                   */
  U8           route;                    /* route                      */
  U8           hopCnt;                   /* default Hop Count
                                          * (between 1 and 15)         */
  U32          qThresh1;                 /* inbound queue congestion
                                          * threshold 1                */
  U32          qThresh2;                 /* inbound queue congestion
                                          * threshold 2                */
  U32          qThresh3;                 /* inbound queue congestion
                                          * threshold 3                */
} SccpUSapCfg;

 

swType

Switch type used by the SCCP service access point:

SCCP_SW_ITU88

SCCP_SW_ITU92

SCCP_SW_ITU96

SCCP_SW_ANS88

SCCP_SW_ANS92

SCCP_SW_ANS96


Return values

Return value

Description

SCCP_SUCCESS

 

SCCP_NULLPTR

Null pointer was specified for pCfg.

SCCP_SWTYPE

Invalid switch type was specified for swType.


Details

Prior to calling SccpSetUSapCfg to send the configuration block to the SCCP layer, the application can change the default values within the specified range for any fields other than those denoted as internal or unused.

Default values for the SccpUSapCfg structure that can be overridden by the calling application are listed in the following table.

Note: SccpUSapCfg structure members not listed in the following table are either unused or for internal use only. These fields are set to correct values by SccpInitUSapCfg and must not be overridden by the application.

All values listed in the following table can be modified on the first call to SccpSetUSapCfg. On subsequent calls to SccpSetUSapCfg, only parameters listed in bold can be modified. Those fields not in bold are ignored on subsequent calls.

Field

Range

Default value

Description

swType

SCCP_SW_ANS88

SCCP_SW_ANS92

SCCP_SW_ANS96

SCCP_SW_ITU88

SCCP_SW_ITU92

SCCP_SW_ITU96

SCCP_SW_ANS92

Protocol variant used for this SAP.

bkupPcInd

0 or 1

0

Set to 1 if a backup point code is to be configured.

bkupPc

Hex number

none

Point code where this subsystem is backed up. Enter 1.1.1 as 0x00010101.

aicEnabled

0 or 1

0

Set to 1 to enable application inactivity timer.

numAltOpc

0 - 8

none

Number of alternate point codes.

usapAltOpc

N/A

none

Array of alternate point codes.

usapAltOpc[i].numConPc

0 to
SCCP_MAXALTPC

0

Number of concerned point codes in the conPcList.

usapAltOpc[i].usapOpc

Hex number

none

Originating point code for this USAP.

usapAltOpc[i].conPcList

Hex number

none

Up to SCCP_MAXCONPC point codes, each entered as a hex value. Enter 1.1.1 as 0x00010101.

AddrMaskList[i].length

0 to SCCP_LENADR

none

Length of the address mask in bytes. Set to 0 if a mask is not used.

AddrMaskList[i].strg

0 to SCCP_LENADR
characters

none

An address mask describing which digits to match when performing a global title translation.

useMsk

0 or 1

0

Set to 1 if an addrMsk is defined.

hopCnt

1 - 15

10

Hop count value used on outgoing SCCP messages from this SAP.

qThresh1

1 - 2000

600

Number of messages outstanding to a higher level task (TCAP) or an application at which inbound congestion level 1 starts.

qThresh2

1 - 2000

900

Number of messages outstanding to a higher level task (TCAP) or an application at which inbound congestion level 2 starts.

qThresh3

1 - 2000

1200

Number of messages outstanding to a higher level task (TCAP) or an application at which inbound congestion level 3 starts.


 

The addrMsk can be composed of only 0 and f. Each byte contains two hexadecimal digits. SccpAsciiMaskToBcd can be used to convert an ASCII string into the correct format. As an example, FFF masks off everything but the first three digits of a global title. The result is then compared to the various global titles configured. The mask FFFFFFFFFF does not mask off any digits.

An addrMsk of a single 0 (zero) matches all global titles. Any global title masked with an addrMsk of 0 (zero) matches an ADDRESS section of 0 (zero).