SccpInitRteCfg

Initializes an SCCP route definition that can be passed to SccpSetRteCfg.

Prototype

SCCP_STATUS SccpInitRteCfg ( SccpRouteCfg *pCfg, U32 dpc)

Argument

Description

pCfg

Pointer to the address of the SCCP route definition buffer:

typedef struct
{
  S16  swType;                   /* not used                        */
  U8   ssn;                      /* subsystem number                */
  U8   status;                   /* status                          */
  U8   bkupPcInd;                /* backup point code indicator 
                                  * (0=none)                        */
  U8   upOnResume;               /* alignment                       */
  U16  numConPc;                 /* number of concerned point codes */
  U32  bkupPc;                   /* backup point code               */
  U32  conPcList[SCCP_MAXCONPC]; /* concerned point codes           */
} SccpSsnCfg;

typedef struct
{
  U32  rteOpc;                   /* OPC for this route                */
  U8   status;                   /* status of the route for this OPC  */
  U8   align1;                   /*                                   */
  U16  align2;                   /*                                   */
} RouteOpcInfo;

typedef struct
{
  S16        swType;                /* Protocol Switch
                                     * type/version                */
  U8         status;                /* adjacent/translator 
                                     * flags                       */
  U8         bkupPcInd;             /* backup point code 
                                     * indicator (0=none)          */
  U32        dpc;                   /* destination point code      */
  U32        bkupPc;                /* backup point code           */
  U8         numSsns;               /* number of subsystems        */
  U8         spare1;                /* alignment                   */
  U8         spare2;                /* alignment                   */
  U16        nmbAltOpc;             /* number of alt. point codes  */
  RouteOpcInfo rteAltOpc[SCCP_MAXALTOPC]; /* Alternate OPCs        */
  SccpSsnCfg ssnList[SCCP_MAXSSNS]; /*subsystems for this dpc      */
} SccpRouteCfg;

 

dpc

Destination point code of the route to be added, specified as a hexadecimal number. Point code 1.1.1 is stored as 0x00010101.


Return values

Return value

Description

SCCP_SUCCESS

 

SCCP_NULLPTR

Null pointer was specified for pCfg.

SCCP_POINTCODE

dpc is out of range.


Details

Prior to calling SccpSetRteCfg 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 SccpRouteCfg structure that can be overridden by the calling application are listed in the following table.

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

Once a route definition is set by SccpSetRteCfg, it can only be modified by first deleting it with SccpDelRteCfg, and then calling SccpSetRteCfg with the new parameters.

Field

Range

Default value

Description

swType

SCCP_SW_ANS

SCCP_SW_ITU

SCCP_SW_ANS

Protocol variant for this point code.

dpc

Hex number

None

Input parameter. Enter 1.1.1 as 0x00010101.

status

SCCP_ONLINE

SCCP_TRANS

SCCP_ADJACENT

SCCP_ONLINE

SCCP_TRANS

SCCP_ADJACENT

Flags to set initial status of point code. Flags are OR'd together:

SCCP_ONLINE

SCCP_TRANS

SCCP_ADJACENT

bkupPcInd

0 or 1

0

Set to 1 if backup point code is specified.

bkupPc

Hex number

None

Point code of backup for this destination. Enter 1.1.1 as 0x00010101.

numSsns

0 to
SCCP_MAXSSNS

0

Number of subsystem definitions contained in the ssnList array.

ssnList

N/A

none

Array of subsystem definitions for this point code.

ssnList[n].ssn

0 - 255

none

Subsystem number.

ssnList[n].status

SCCP_SNR

SCCP_ACC

SCCP_SNR
SCCP_ACC

Flags to set initial status of subsystem. Flags are OR'd together:

SCCP_SNR
SCCP_ACC

ssnList[n].bkupPcInd

0 or 1

0

Set to 1 if backup point code is specified.

ssnList[n].bkupPc

Hex number

none

Point code of backup for this subsystem. Enter 1.1.1 as 0x00010101.

ssnList[n].numConPc

0 to
SCCP_MAXCONPC

0

Number of concerned point codes contained in the conPcList array.

ssnList[n].conPcList

see dpc

none

List of concerned point codes for this subsystem.

ssnList[n].upOnResume

0 - 1

1

Subsystem is immediately put back in service when a point code resume message is received from MTP. The subsystem test procedure is not started.

numAltOpc

0-8

0

Number of alternate originating point codes for this route.

rteAltOpc

N/A

none

Array of alternate originating point codes.

rteAltOpc.rteOpc

Hex number

none

Originating point code for this route.

rteAltOpc.status

none

none

Status of this route for this originating point code.