You are here: PPL Developer’s Guide > 6 SS7 Atomic Functions > BT IUP CPC (0x0052)

BT IUP CPC (0x0052)

The following atomic functions are used by the BT IUP CPC variant

Atomic Functions

.

AF Number | 151
Name | IUPCPC Send IAM to L3P
Description | This function will forward the received IAM message to L3P. L3P will receive it as event IUP_L3PnIAM with an data buffer containing the received IAM message converted into TLV format.
Arg1 | <Not Used>
Arg2 | <Not Used>
Outputs | Message queued for L3P
Returns | Success

AF Number | 152
Name | IUPCPC Send IFAM to L3P
Description | This function will forward the received IFAM message to L3P. L3P will receive it as event IUP_L3PnIFAM with an data buffer containing the received IFAM message converted into TLV format.
Arg1 | <Not Used>
Arg2 | <Not Used>
Outputs | Message queued for L3P
Returns | Success

AF Number | 153
Name | IUPCPC Send SAM to L3P
Description | This function will forward the received SAM message to L3P. L3P will receive it as event IUP_L3PnSAM with an data buffer containing the received SAM message converted into TLV format.
Arg1 | <Not Used>
Arg2 | <Not Used>
Outputs | Message queued for L3P
Returns | Success

AF Number | 154
Name | IUPCPC Send FAM to L3P
Description | This function will forward the received FAM message to L3P. L3P will receive it as event IUP_L3PnFAM with an data buffer containing the received FAM message converted into TLV format.
Arg1 | <Not Used>
Arg2 | <Not Used>
Outputs | Message queued for L3P
Returns | Success

AF Number | 155
Name | IUPCPC Send ASUI to L3P
Description | This function will forward the received ASUI message to L3P. L3P will receive it as event IUP_L3PnASUI with an data buffer containing the received ASUI message converted into TLV format.
Arg1 | <Not Used>
Arg2 | <Not Used>
Outputs | Message queued for L3P
Returns | Success

AF Number | 156
Name | IUPCPC Send SND to L3P
Description | This function will forward the received SND message to L3P. L3P will receive it as event IUP_L3PnSND with an data buffer containing the received SND message converted into TLV format.
Arg1 | <Not Used>
Arg2 | <Not Used>
Outputs | Message queued for L3P
Returns | Success

AF Number | 157
Name | IUPCPC Send SAD to L3P
Description | This function will forward the received SAD message to L3P. L3P will receive it as event IUP_L3PnSAD with an data buffer containing the received SAD message converted into TLV format.
Arg1 | <Not Used>
Arg2 | <Not Used>
Outputs | Message queued for L3P
Returns | Success

AF Number | 158
Name | IUPCPC Send SASUI to L3P
Description | This function will forward the received SASUI message to L3P. L3P will receive it as event IUP_L3PnSASUI with an data buffer containing the received SASUI message converted into TLV format.
Arg1 | <Not Used>
Arg2 | <Not Used>
Outputs | Message queued for L3P
Returns | Success

AF Number | 159
Name | IUPCPC Send ACM to L3P
Description | This function will forward the received ACM message to L3P. L3P will receive it as event IUP_L3PnACM with an data buffer containing the received ACM message converted into TLV format.
Arg1 | <Not Used>
Arg2 | <Not Used>
Outputs | Message queued for L3P
Returns | Success

AF Number | 160
Name | IUPCPC Send CNG to L3P
Description | This function will forward the received CNG message to L3P. L3P will receive it as event IUP_L3PnCNG with an data buffer containing the received CNG message converted into TLV format.
Arg1 | <Not Used>
Arg2 | <Not Used>
Outputs | Message queued for L3P
Returns | Success

AF Number | 161
Name | IUPCPC Send SEM to L3P
Description | This function will forward the received SEM message to L3P. L3P will receive it as event IUP_L3PnSEM with an data buffer containing the received SEM message converted into TLV format.
Arg1 | <Not Used>
Arg2 | <Not Used>
Outputs | Message queued for L3P
Returns | Success always

AF Number | 162
Name | IUPCPC Send CNA to L3P
Description | This function will forward the received CNA message to L3P. L3P will receive it as event IUP_L3PnCNA with an data buffer containing the received CNA message converted into TLV format.
Arg1 | <Not Used>
Arg2 | <Not Used>
Outputs | Message queued for L3P
Returns | Success always

AF Number | 163
Name | Check Incoming Congestion
Description | This function will check for congestion in the inbound direction.
Arg1 | <Not Used>
Arg2 | <Not Used>
Outputs | PPLevINT_EVENT_1 if congestion is detected. Otherwise, it is PPLevINT_EVENT_0.
Returns | Success always

AF Number | 166
Name | IUPCPC Send ANS to L3P
Description | This function will forward the received ANS message to L3P. L3P will receive it as event IUP_L3PnANS with an data buffer containing the received ANS message converted into TLV format.
Arg1 | <Not Used>
Arg2 | <Not Used>
Outputs | Message queued for L3P
Returns | Success always

AF Number | 167
Name | IUPCPC Send CLR to L3P
Description | This function will forward the received CLR message to L3P. L3P will receive it as event IUP_L3PnCLR with an data buffer containing the received CLR message converted into TLV format.
Arg1 | <Not Used>
Arg2 | <Not Used>
Outputs | Message queued for L3P
Returns | Success always

AF Number | 168
Name | IUPCPC Send RAM to L3P
Description | This function will forward the received RAM message to L3P. L3P will receive it as event IUP_L3PnRAM with an data buffer containing the received RAM message converted into TLV format.
Arg1 | <Not Used>
Arg2 | <Not Used>
Outputs | Message queued for L3P
Returns | Success always

AF Number | 169
Name | IUPCPC Send REL to L3P
Description | This function will forward the received REL message to L3P. L3P will receive it as event IUP_L3PnREL with an data buffer containing the received REL message converted into TLV format.
Arg1 | <Not Used>
Arg2 | <Not Used>
Outputs | Message queued for L3P
Returns | Success always

AF Number | 170
Name | IUPCPC Send CCF to L3P
Description | This function will forward the received CCF message to L3P. L3P will receive it as event IUP_L3PnCCF with an data buffer containing the received CCF message converted into TLV format.
Arg1 | <Not Used>
Arg2 | <Not Used>
Outputs | Message queued for L3P
Returns | Success always

AF Number | 171
Name | IUPCPC Send BLO to L3P
Description | This function will forward the received BLO message to L3P. L3P will receive it as event IUP_L3PnBLO with an data buffer containing the received BLO message converted into TLV format.
Arg1 | <Not Used>
Arg2 | <Not Used>
Outputs | Message queued for L3P
Returns | Success always

AF Number | 172
Name | IUPCPC Send UBL to L3P
Description | This function will forward the received UBL message to L3P. L3P will receive it as event IUP_L3PnUBLwith an data buffer containing the received UBL message converted into TLV format.
Arg1 | <Not Used>
Arg2 | <Not Used>
Outputs | Message queued for L3P
Returns | Success always

AF Number | 173
Name | IUPCPC Send BLA to L3P
Description | This function will forward the received BLA message to L3P. L3P will receive it as event IUP_L3PnBLA with an data buffer containing the received BLA message converted into TLV format.
Arg1 | <Not Used>
Arg2 | <Not Used>
Outputs | Message queued for L3P
Returns | Success always

AF Number | 174
Name | IUPCPC Send UBA to L3P
Description | This function will forward the received UBA message to L3P. L3P will receive it as event IUP_L3PnUBA with an data buffer containing the received UBA message converted into TLV format.
Arg1 | <Not Used>
Arg2 | <Not Used>
Outputs | Message queued for L3P
Returns | Success always

AF Number | 175
Name | IUPCPC Send OVL to L3P
Description | This function will forward the received OVL message to L3P. L3P will receive it as event IUP_L3PnOVL with an data buffer containing the received OVL message converted into TLV format.
Arg1 | <Not Used>
Arg2 | <Not Used>
Outputs | Message queued for L3P
Returns | Success always

AF Number | 176
Name | IUPCPC Send CFN to L3P
Description | This function will forward the received CFN message to L3P. L3P will receive it as event IUP_L3PnCFN with an data buffer containing the received CFN message converted into TLV format.
Arg1 | <Not Used>
Arg2 | <Not Used>
Outputs | Message queued for L3P
Returns | Success always

AF Number | 178
Name | IUPCPC Send ACI to L3P
Description | This function will forward the received ACI message to L3P. L3P will receive it as event IUP_L3PnACI with an data buffer containing the received ACI message converted into TLV format.
Arg1 | <Not Used>
Arg2 | <Not Used>
Outputs | Message queued for L3P
Returns | Success always

AF Number | 179
Name | Send L5 PPL Event Indication without data.
Description | This function will send a PPL Event Indication to the host with the event number specified in Arg1.
Arg1 | The Event Indication Number
Arg2 | <Not Used>
Outputs | Message queued for L5
Returns | Success, or the channel will purge if internal errors occur

AF Number | 180
Name | IUPCPC Send L5 PPL Event Indication with Raw Data
Description | This function will send a message to L3P indicating that an Invalid ACI message was received from MTP. L3P will receive it as event L3P_L3evINV_ACI with an data buffer containing the received invalid message converted into TLV format.
Arg1 | The Event Indication Number
Arg2 | <Not Used>
Outputs | Message queued for L5
Returns | Success always

AF Number | 181
Name | Get Timer associated value
Description | Retrieves the associated value
Arg1 | Timer number
Arg2 | Register to contain associated value
Returns | Success always

AF Number | 182
Name | Send PPL Event Indication CLR to L5
Arg1 | <Not Used>
Arg2 | <Not Used>
Returns | Success always

AF Number | 183
Name | Send PPL Event Indication RE-ANSWER (RAN) to L5
Arg1 | <Not Used>
Arg2 | <Not Used>
Returns | Success always

AF Number | 184
Name | Send PPL Event Indication SUS to L5
Arg1 | <Not Used>
Arg2 | <Not Used>
Returns | Success always

AF Number | 185
Name | Send PPL Event Indication RES to L5
Arg1 | <Not Used>
Arg2 | <Not Used>
Returns | Success always

AF Number | 186
Name | Send PPL Event Indication SWAP to L5
Arg1 | <Not Used>
Arg2 | <Not Used>
Returns | Success always

AF Number | 187
Name | Send Block Upon Release Event to L3
Arg1 | <Not Used>
Arg2 | <Not Used>
Returns | Success always

AF Number | 191
Name | IUPCPC Send IAM to SPRC
Description | This function will convert a TLV IAM message into raw format and queue it up for SPRC.
Arg1 | <Not Used>
Arg2 | <Not Used>
Outputs | Message queued for SPRC
Returns | Success always

AF Number | 192
Name | IUPCPC Send IFAM to SPRC
Description | This function will convert a TLV IFAM message into raw format and queue it up for SPRC.
Arg1 | <Not Used>
Arg2 | <Not Used>
Outputs | Message queued for SPRC
Returns | Success always

AF Number | 193
Name | IUPCPC Send SAM to SPRC
Description | This function will convert a TLV SAM message into raw format and queue it up for SPRC.
Arg1 | <Not Used>
Arg2 | <Not Used>
Outputs | Message queued for SPRC
Returns | Success always

AF Number | 194
Name | IUPCPC Send FAM to SPRC
Description | This function will convert a TLV FAM message into raw format and queue it up for SPRC.
Arg1 | <Not Used>
Arg2 | <Not Used>
Outputs | Message queued for SPRC
Returns | Success always

AF Number | 195
Name | IUPCPC Send ASUI to SPRC
Description | This function will convert a TLV ASUI message into raw format and queue it up for SPRC.
Arg1 | <Not Used>
Arg2 | <Not Used>
Outputs | Message queued for SPRC
Returns | Success always

AF Number | 196
Name | IUPCPC Send SND to SPRC
Description | This function will convert a TLV SND message into raw format and queue it up for SPRC.
Arg1 | <Not Used>
Arg2 | <Not Used>
Outputs | Message queued for SPRC
Returns | Success always

AF Number | 197
Name | IUPCPC Send SAD to SPRC
Description | This function will convert a TLV SAD message into raw format and queue it up for SPRC.
Arg1 | <Not Used>
Arg2 | <Not Used>
Outputs | Message queued for SPRC
Returns | Success always

AF Number | 198
Name | IUPCPC Send SASUI to SPRC
Description | This function will convert a TLV SASUI message into raw format and queue it up for SPRC.
Arg1 | <Not Used>
Arg2 | <Not Used>
Outputs | Message queued for SPRC
Returns | Success always

AF Number | 199
Name | IUPCPC Send ACM to SPRC
Description | This function will convert a TLV ACM message into raw format and queue it up for SPRC.
Arg1 | <Not Used>
Arg2 | <Not Used>
Outputs | Message queued for SPRC
Returns | Success always

AF Number | 200
Name | IUPCPC Send CNG to SPRC
Description | This function will convert a TLV CNG message into raw format and queue it up for SPRC.
Arg1 | <Not Used>
Arg2 | <Not Used>
Outputs | Message queued for SPRC
Returns | Success always

AF Number | 202
Name | IUPCPC Send CNA to SPRC
Description | This function will convert a TLV CNA message into raw format and queue it up for SPRC.
Arg1 | <Not Used>
Arg2 | <Not Used>
Outputs | Message queued for SPRC
Returns | Success always

AF Number | 203
Name | IUPCPC Send SEM to SPRC
Description | This function will convert a TLV SEM message into raw format and queue it up for SPRC.
Arg1 | <Not Used>
Arg2 | <Not Used>
Outputs | Message queued for SPRC
Returns | Success always

AF Number | 206
Name | IUPCPC Send ANS to SPRC
Description | This function will convert a TLV ANS message into raw format and queue it up for SPRC.
Arg1 | <Not Used>
Arg2 | <Not Used>
Outputs | Message queued for SPRC
Returns | Success always

AF Number | 207
Name | IUPCPC Send CLR to SPRC
Description | This function will convert a TLV CLR message into raw format and queue it up for SPRC.
Arg1 | <Not Used>
Arg2 | <Not Used>
Outputs | Message queued for SPRC
Returns | Success always

AF Number | 208
Name | IUPCPC Send RAM to SPRC
Description | This function will convert a TLV RAM message into raw format and queue it up for SPRC.
Arg1 | <Not Used>
Arg2 | <Not Used>
Outputs | Message queued for SPRC
Returns | Success always

AF Number | 209
Name | IUPCPC Send REL to SPRC
Description | This function will convert a TLV REL message into raw format and queue it up for SPRC.
Arg1 | <Not Used>
Arg2 | <Not Used>
Outputs | Message queued for SPRC
Returns | Success always

AF Number | 210
Name | IUPCPC Send CCF to SPRC
Description | This function will convert a TLV CCF message into raw format and queue it up for SPRC or MTP.
Arg1 | <Not Used>
Arg2 | <Not Used>
Outputs | Message queued for SPRC or MTP
Returns | Success or PPLerrAF_INITIATED_RESET if the send to MTP fails

AF Number | 211
Name | IUPCPC Send BLO to SPRC
Description | This function will convert a TLV BLO message into raw format and queue it up for SPRC or MTP.
Arg1 | <Not Used>
Arg2 | <Not Used>
Outputs | Message queued for SPRC or MTP
Returns | Success or PPLerrAF_INITIATED_RESET if the send to MTP fails

AF Number | 212
Name | IUPCPC Send UBL to SPRC
Description | This function will convert a TLV UBL message into raw format and queue it up for SPRC.
Arg1 | <Not Used>
Arg2 | <Not Used>
Outputs | Message queued for SPRC
Returns | Success always

AF Number | 213
Name | IUPCPC Send BLA to SPRC
Description | This function will convert a TLV BLA message into raw format and queue it up for SPRC or MTP.
Arg1 | <Not Used>
Arg2 | <Not Used>
Outputs | Message queued for SPRC or MTP
Returns | Success or PPLerrAF_INITIATED_RESET if the send to MTP fails

AF Number | 214
Name | IUPCPC Send UBA to SPRC
Description | This function will convert a TLV UBA message into raw format and queue it up for SPRC or MTP.
Arg1 | <Not Used>
Arg2 | <Not Used>
Outputs | Message queued for SPRC or MTP
Returns | Success or PPLerrAF_INITIATED_RESET if the send to MTP fails

AF Number | 215
Name | IUPCPC Send OVL to SPRC
Description | This function will convert a TLV OVL message into raw format and queue it up for SPRC.
Arg1 | <Not Used>
Arg2 | <Not Used>
Outputs | Message queued for SPRC
Returns | Success always

AF Number | 216
Name | IUPCPC Send CFN to SPRC
Description | This function will convert a TLV CFN message into raw format and queue it up for SPRC or MTP.
Arg1 | <Not Used>
Arg2 | <Not Used>
Outputs | Message queued for SPRC or MTP
Returns | Success or PPLerrAF_INITIATED_RESET if the send to MTP fails

AF Number | 218
Name | IUPCPC Send ACI to SPRC
Description | This function will convert a TLV ACI message into raw format and queue it up for SPRC.
Arg1 | <Not Used>
Arg2 | <Not Used>
Outputs | Message queued for SPRC
Returns | Success always

AF Number | 219
Name | IUPCPC SEND REL w/data to SPRC
Description | This function will format a raw Release message with the reason suPPLied in Arg1 and queue it up for MTP
Arg1 | Decimal value of Release Reason
Arg2 | <Not Used>
Outputs | Message queued for MTP
Returns | Success or PPLerrAF_INITIATED_RESET if the send to MTP fails

AF Number | 220
Name | IUPCPC Send CNA w/data to SPRC
Description | This function will format a raw Connection Not Admitted message with the reason suPPLied in Arg1 and queue it up for SPRC.
Arg1 | Decimal value of CNA Reason
Arg2 | Decimal value of CNA Diagnostics
Outputs | Message queued for SPRC or MTP
Returns | Success or PPLerrAF_INITIATED_RESET if the send to MTP fails

AF Number | 221
Name | Check for Incoming Congestion
Description | This function will check an internal variable to see if incoming congestion has been detected.
Arg1 | NA
Arg2 | NA
Outputs | PPLevINT_EVENT_0 when no congestion exists. PPLevINT_EVENT_1 when Congestion IS Present.
Returns | Success always

AF Number | 232
Name | IUPCPC Test if Circuit is Blocked
Description | This function will test the blocked state of the circuit. The user may specify which of three types of blocking conditions for both local and remote circuit ends. The routine will return with a PPL event corresponding to it’s state. PPLevINT_EVENT_0 if not blocked, or PPLevINT_EVENT_1 if blocked.
Arg1 | Circuit end to check. 0 = Local, 1 = Remote
Arg2 | Type of Block to check. 0 = Maintenance, 1 = Hardware, 2 = Software
Outputs | See above
Returns | Success always

AF Number | 233
Name | IUPCPC Set Local Circuit Maintenance status to user specified state.
Description | This function will set the local circuit’s maintenance status to the value specified in Arg1.
Arg1 | State
Arg2 | <Not Used>
Outputs | <Not Used>
Returns | Success always

AF Number | 236
Name | IUPCPC Validate and Convert SPRC message to TLV format
Description | This function will validate and convert raw message into TLV format.
Arg1 | <Not Used>
Arg2 | <Not Used>
Outputs | A buffer containing the TLV format of the raw message. If successful PPLevINT_EVENT_1, otherwise PPLevINT_EVENT_0.
Returns | Success always

AF Number | 247
Name | IUPCPC Send Unknown MSG to SPRC
Description | This function will send a message containing the Generic TLV Entry Data to raw format, and send it to SPRC.
Arg1 | <Not Used>
Arg2 | <Not Used>
Outputs | <Not Used>
Returns | Success always

AF Number | 250
Name | IUPCPC Get IUP message Parameter byte from the TLV into GPR #19
Description | This function will search for the TLV ID and byte specified in args 1 and 2 and return with GPR 19 containing the value of the specified byte.
Arg1 | The TLV ID to be retrieved.
Arg2 | The byte within the TLV to be place into GPR 19
Outputs | If successful GPR 19 will contain the specified byte and return with PPLevINT_EVENT_1. Otherwise, GPR 19 will be set to 0 and we return PPLevINT_EVENT_0.
Returns | Success

AF Number | 253
Name | IUPCPC Update Remote Circuit Maintenance Block State to users specified state.
Description | This function will set an internal variable indicating the state of Remote Circuit’s maintenance block state.
Arg1 | The State. 0 = Unblocked, 1 = Blocked
Arg2 | <Not Used>
Outputs | <Not Used>
Returns | Success

See Atomic Function.
In PPL, a condition that, when met, drives a state machine (PPL Component) from one state to another, by invoking an associated Primitive. In PPL files, an Event is marked by an arrow and text.
Tag-Length-Value block. A standardized block that allows data to inserted in a standard way into API messages.
Random Access Memory
Blocking Acknowldgment message
See Programmable Protocol Language.
A condition that, when met, drives a state machine from one state to another. A condition that drives a Component out of its current state by invoking an associated primitive.
See Message Transfer Part.
See Recorded Announcements.
The condition of a component at a given instant. The current "context" of a PPL object, such as Idle, Seizing, Answered. In PPL files, a State is represented by a circle.