# 3 T1 Atomic Functions

This section includes the atomic functions and events associated with the T1 PPL component (0x0003). The PPL state machine, *.ppl, for each protocol is available on CD ROM.

Atomic Functions

AF Number | 59
Name | Send L4 a Q.931 Alerting
Description | 13ppl_af_59() sends a Q.931 L3 - L4 Alerting message.
Input Arg1 | NA
Input Arg2 | NA
Outputs | NA

AF Number | 72
Name | L3PPL Send L4 a Q.931 Alerting with Cut Thru *Changed from L3PPL Send L4 a Q.931 Alerting.
Description | Sends a Q.931 L3 - L4 Alerting with Cut Thru message.
Input Arg1 | NA
Input Arg2 | NA
Outputs | NA

AF Number | 74
Name | L3PPL Send L4 a Setup Indication
Description | Sends a Setup Indication to Layer 4
Input Arg1 | <Config Byte Offset>
Input Arg2 | NA
Outputs | NA

AF Number | 76
Name | L3PPL Send L5 INSZ/OUTZ Ctrl Resp with Status in GPR <GPR #>
Description | Sends a INSEIZE_CTRL or OUTSEIZE_CTRL response should an outstanding L5 Inseize/Outseize Control request exist. Response status is stored in the GPR specified in arg1.
Input Arg1 | GPR # (1 - 25)
Input Arg2 | NA
Outputs | NA

AF Number | 83
Name | L3PPL Test for Outstanding L5 Msg
Description | Tests for any outstanding L5 messages.
Input Arg1 | NA
Input Arg2 | NA
Outputs | PPLevINT_EVENT_0: outstanding L5 messages does not exist. PPLevINT_EVENT_1: outstanding L5 messages exist.

AF Number | 118
Name | T1PPLXMIT AB Line Signaling <CFG Byte Offset>
Description | Transmits line signaling which is stored in the CFG Byte offset. The value stored in the CFG Byte offset is expected to contain only AB signaling bit combination.
Input Arg1 | Config byte offset that contains line signaling. Range (0 - 3)
Input Arg2 | NA
Outputs | NA

AF Number | 119
Name | L3PPL XMIT ABCD Line Signaling <CFG Byte Offset>
Description | Transmits line signaling which is stored in the CFG Byte offset. The value stored in the CFG Byte offset is expected to contain ABCD signaling bit combination.
Input Arg1 | CFG Byte offset that contains line signaling. Range (0 - 15)
Input Arg2 | NA
Outputs | NA

AF Number | 120
Name | T1PPL XMIT Line Signaling <AB bits>
Description | Transmits line signaling which is stored in arg1.
Input Arg1 | AB signaling bit combination. (0 - 3)
Input Arg2 | NA
Outputs | NA

AF Number | 177
Name | L3PPL Store Outseize Ctrl Data ICBs
Description | Stores outseize control instructions data ICBs.
Input Arg1 | NA
Input Arg2 | NA
Outputs | NA

AF Number | 192
Name | L3PPL Test Current Outseize Ctrl Instr Data
Description | Sets up an internal decision event based on the current outseize ctrl instruction data
Input Arg1 | NA
Input Arg2 | NA
Outputs | PPLevINT_EVENT_0 + outseize ctrl instruction data

AF Number | 193
Name | L3PPL Compare Next Outseize Ctrl Instr Addr Sig Type <Addr Sig Type>
Description | Compares the next outseize control instruction data outpulsing address signaling type with the address signaling type passed in arg1 and sets up an internal decision event accordingly.
Input Arg1 | Address Signaling Type 01 DTMF 02 MFR1 (host does not include KP or ST) 03 MFR2 04 MFR1 (host includes KP and any ST signal) 05 Dial Pulse 06 MFR1, Transmit Compelled (MF-MDR1)
Input Arg2 | NA
Outputs | PPLevINT_EVENT_0: address signaling type does not equal to arg1. PPLevINT_EVENT_1: address signaling type equal to arg1.

AF Number | 212
Name | L3PPL INIT a Channel Purge with Purge Reason in GPR <GPR #>
Description | Initiates a purge passing the purge reason to L4. Purge reason is stored in the GPR.
Input Arg1 | <GPR #> 1 - 25
Input Arg2 | NA
Outputs | NA

AF Number | 226
Name | Send PPL Event Indication Message to the Host with GPR Value
Description | Sends a PPL Event Indication message to the host with the event indicated by Arg1. | The value of the GPR indicated by Arg2 is returned to the host in a PPL GPR Data ICB (Subtype, 0xFF, Data Length = 4).
Arg1: | <PPL Event> See message "PPL Event Indication 0x0043" in the API Reference.
Arg2: | <GPR #> 1-25

AF Number | 229
Name | L3 PPL Send L5 Event Indication with General Purpose Register Value <Event ID>
Description | Sends an Event Indication to Layer 5 with GPR value of Event ID
Arg1: | <GPR #> 1-25
Arg2: | <Not Used>

AF Number | 265
Name | L3PPL Test Previous Outseize Ctrl Instr Data
Description | Tests for previous outseize ctrl instruction data and sets up an internal decision event according.
Input Arg1 | NA
Input Arg2 | NA
Outputs | PPLevINT_EVENT_0 +previous outs ctrl instr data PPLevINT_EVENT_255: previous outs ctrl instr does not exist

AF Number | 266
Name | L3PPL Test Previous Outseize Ctrl Instr
Description | Tests for previous outseize ctrl instruction and sets up an internal decision event accordingly.
Input Arg1 | NA
Input Arg2 | NA
Outputs | PPLevINT_EVENT_0 + previous outs ctrl instr PPLevINT_EVENT_225: previous outs ctrl instr does not exist

AF Number | 270
Name | L3PPL Outpulse MFR1 KP Digit using compelled KP Mode
Description | Sends a request to DSP to outpulse digits using compelled KP mode.
Input Arg1 | NA
Input Arg2 | NA
Outputs | NA

AF Number | 271
Name | L3PPL Continue Outpulse MFR1 Digits using Compelled KP Mode
Description | Sends a request to DSP to remove KP and continue outpulsing digits using compelled KP mode.
Input Arg1 | NA
Input Arg2 | NA
Outputs | NA

AF Number | 276
Name | PPL Enable Multi Purpose Timer <Timer #> <GPR #>
Description | Enables 1 of 3 multi-purpose timers for use by the PPL. The timer value is stored in GPR indicated in arg2.
Input Arg1 | Timer # (1 - 3)
Input Arg2 | GPR # (1 - 25)
Outputs | NA

AF Number | 279
Name | L3PPL Test CP Event Bit of Onhook <Boolean>
Description | Compares call processing event bit of onhook with the value specified in arg1 and sets up an internal decision event accordingly.
Input Arg1 | Boolean (0 -1)
Input Arg2 | NA
Outputs | PPLevINT_EVENT_0: False PPLevINT_EVENT_1: True

AF Number | 280
Name | L3PPL Setup Host CP Event of Wink
Description | Sets up a Call Processing event of Wink for possible later reporting to L5. Wink number is extracted from the outseize control message.
Input Arg1 | NA
Input Arg2 | NA
Outputs | NA

AF Number | 281
Name | L3PPL Setup Host CP Event of Offhook <Boolean>
Description | Sets up a call processing event of offhook for possible later reporting to L5.
Input Arg1 | Boolean (0 - 1)
Input Arg2 | NA
Outputs | NA

AF Number | 282
Name | L3PPL Setup Host CP Event of Onhook <Boolean>
Description | Sets up a call processing event of onhook for possible later reporting to L5. Also used for onhook host notify.
Input Arg1 | Boolean (0 - 1)
Input Arg2 | NA
Outputs | NA

AF Number | 285
Name | L3PPL Test Outseize Ctrl for any Action ICB
Description | Checks for the outseize ctrl instructions for an Action ICB and sets up an internal decision event accordingly.
Input Arg1 | NA
Input Arg2 | NA
Outputs | PPLevINT_EVENT_0: Null PPLevINT_EVENT_1: Exist

AF Number | 286
Name | L3PPL Test Outseize Ctrl for all Data ICB
Description | Checks for the outseize ctrl instruction for data ICB and sets up an internal decision event accordingly. No action ICB is allowed in the outseize control message.
Input Arg1 | NA
Input Arg2 | NA
Outputs | PPLevINT_EVENT_0: Null PPLevINT_EVENT_1: Exist

AF Number | 287
Name | L3PPL Load Current Outseize Ctrl Instr Data [0], Data [1] into GPR <GPR #>
Description | Loads current outseize ctrl instruction Data [0], Data [1] into GPR.
Input Arg1 | GPR # (1 - 25)
Input Arg2 | NA
Outputs | NA

AF Number | 290
Name | T1PPL Test for Flash Timing
Description | Tests if flash timing is enabled.
Input Arg1 | NA
Input Arg2 | NA
Outputs | PPLevINT_EVENT_0: Flash timing not enabled PPLevINT_EVENT_1: Flash timing enabled

AF Number | 295
Name | T1PPL Outpulse MFR1 Digits
Description | Sends a request to DSP to outpulse MFR1 digits for the stage indicated by the current instruction data.
Input Arg1 | NA
Input Arg2 | NA
Outputs | NA

AF Number | 300
Name | T1PPL Outpulse DTMF Digits
Description | Sends a request to DSP to outpulse DTMF digits for the stage indicated by the current instruction data.
Input Arg1 | NA
Input Arg2 | NA
Outputs | NA

AF Number | 305
Name | L3PPL Test Next Inseize Ctrl Instr for Inpulsing Digit Str Cnt
Description | Tests the inpulsing parameter digit string count for the next inseize ctrl instruction. It is assumed that the next instruction will be receive Stage n.
Input Arg1 | NA
Input Arg2 | NA
Outputs | PPLevINT_EVENT_0: 0 digit strings or invalid string count PPLevINT_EVENT_1: 1 digit string PPLevINT_EVENT_2: 2 digit strings

AF Number | 306
Name | L3PPL Test Next Inseize Ctrl Instr for Collection Method
Description | Sets up an internal decision event based upon the next stage’s impulsing parameter collection method.
Input Arg1 | NA
Input Arg2 | NA
Outputs | PPLevINT_EVENT_1: USE_FIXED_NUMBER PPLevINT_EVENT_2: USE_MULTIPLE_TERM_DIGITS PPLevINT_EVENT_3: USE_KP_ST PPLevINT_EVENT_4: USE_FIXED_OR_TERM PPLevINT_EVENT_5: USE_COMPELLED_MODE PPLevINT_EVENT_6: USE_KP_ST_ALL PPLevINT_EVENT_7: USE_COMPELLED_KP PPLevINT_EVENT_20: default

AF Number | 310
Name | T1PPL Attach DTMF Digit Receiver
Description | Request to collect DTMF digits. The stage of digits to be collected is determined by the next instruction in the instruction list.
Input Arg1 | NA
Input Arg2 | NA
Outputs | NA

AF Number | 315
Name | T1PPL Attach MFR1 Digit Receiver
Description | Request to collect MFR1 digits. The stage of digits to be collected is determined by the next instruction in the instruction list.
Input Arg1 | NA
Input Arg2 | NA
Outputs | NA

AF Number | 317
Name | T1PPL Attach MFR1 Digit Receiver (Get Stage # From Next Instr) <PPL CFG Byte #>
Description | Allocates a MFR1 receiver to collect digits. The stage of digits to be collected is determined by the next instruction in the instruction list. It is like Atomic Function 315 with the added feature of configuring the MFR1 tone reception threshold.
Input Arg1 | The first argument is the index into the ppl configuration byte array. The value of this byte is absolute value of the minimum dBm level of the MFR1 digits for detection. Valid entries for this ppl_cfg_byte are between 1 and 30, which equate to -1dBm and -30dBm, respectively. The MFR1 receiver will reject any tones below the detection level.
Input Arg2 | NA
Outputs | NA

AF Number | 318
Name | T1PPL Attach MFR1 Digit Receiver (Get Stage # From Current Instr) <PPL CFG Byte #>
Description | Allocates a MFR1 receiver to collect digits. The stage of digits to be collected is determined by the current instruction in the instruction list. It is like Atomic Function 316 with the added feature of configuring the MFR1 tone reception threshold.
Input Arg1 | The first argument is the index into the ppl configuration byte array. The value of this byte is absolute value of the minimum dBm level of the MFR1 digits for detection. Valid entries for this ppl_cfg_byte are between 1 and 30, which equate to -1dBm and -30dBm, respectively. The MFR1 receiver will reject any tones below the detection level.
Input Arg2 | NA
Outputs | NA

AF Number | 319
Name | L3PPL Test Inseize Ctrl for any Action ICB
Description | Checks the inseize ctrl instruction for any action ICBs and sets up an internal decision event accordingly.
Input Arg1 | NA
Input Arg2 | NA
Outputs | PPLevINT_EVENT_0: Null PPLevINT_EVENT_1: Exist

AF Number | 320
Name | L3PPL Test Current Inseize Ctrl Instr for Addr Signaling Type
Description | Sets up an internal decision event based upon the current stage’s inpulsing parameter address signaling type.
Input Arg1 | NA
Input Arg2 | NA
Outputs | PPLevINT_EVENT_1: DTMF PPLevINT_EVENT_2:MFR1 PPLevINT_EVENT_3: MFR2 PPLevINT_EVENT_4: MFR1_ALL PPLevINT_EVENT_5: DP PPLevINT_EVENT_6: COMPELLED_KP PPLevINT_EVENT_20: Default

AF Number | 321
Name | L3PPL Load GPR with Stage Complete Timer for Current Inseize Ctrl Instr <GPR #>
Description | Loads GPR specified in arg1 with the stage complete timer for the current inseize ctrl instruction.
Input Arg1 | GPR # (1 - 25)
Input Arg2 | NA
Outputs | NA

AF Number | 322
Name | L3PPL Test Current Inseize Ctrl Instr for Collection Method
Description | Sets up an internal decision event based upon the current stage’s inpulsing parameter collection method.
Input Arg1 | NA
Input Arg2 | NA
Outputs | PPLevINT_EVENT_1: USE_FIXED_NUMBER PPLevINT_EVENT_2: USE_MULTIPLE_TERM_DIGITS PPLevINT_EVENT_3: USE_KP_ST PPLevINT_EVENT_4: USE_FIXED_OR_TERM PPLevINT_EVENT_5: USE_COMPELLED_MODE PPLevINT_EVENT_6: USE_KP_ST_ALL PPLevINT_EVENT_7: USE_COMPELLED_KP PPLevINT_EVENT_20: default

AF Number | 323
Name | L3PPL Test Current Inseize Ctrl Instr for Inpulsing Digit Str Cnt
Description | Tests the inpulsing parameter digit string count for the current inseize ctrl instruction.
Input Arg1 | NA
Input Arg2 | NA
Outputs | PPLevINT_EVENT_0: 0 digit strings or invalid string count PPLevINT_EVENT_1: 1 digit string PPLevINT_EVENT_2: 2 digit strings

AF Number | 324
Name | L3PPL Load Current Inseize Ctrl Instr Data[0], Data [1] into GPR <GPR #>
Description | Loads current inseize ctrl instruction Data[0], Data [1] into GPR
Input Arg1 | GPR # (1 - 25)
Input Arg2 | NA
Outputs | NA

AF Number | 325
Name | L3PPL Test Previous Inseize Ctrl Instr Data
Description | Test for previous inseize ctrl instruction data and sets up an internal decision event accordingly.
Input Arg1 | NA
Input Arg2 | NA
Outputs | PPLevINT_EVENT_0 + previous inseize ctrl instr data PPLevINT_EVENT_255: previous inseize ctrl instr does not exist

AF Number | 326
Name | L3PPL Test Previous Inseize Ctrl Instr
Description | Tests for previous inseize ctrl instruction and sets up an internal decision event accordingly.
Input Arg1 | NA
Input Arg2 | NA
Outputs | PPLevINT_EVENT_0 + previous inseize ctrl instr does not exist PPLevINT_EVENT_255: previous inseize ctrl does not exist

AF Number | 330
Name | L3PPL Test Wink Number in Host Generate CP Event
Description | Tests the wink number in the host generate call processing event and sets up an internal decision event accordingly.
Input Arg1 | NA
Input Arg2 | NA
Outputs | PPLevINT_EVENT_0 + Wink Number PPLevINT_EVENT_225: No event to process

AF Number | 335
Name | L3PPL Do CPA without Line Signaling
Description | Sends a request to do Call Progress Analysis. The class is taken from the outseize control message.
Input Arg1 | NA
Input Arg2 | NA
Outputs | NA

PPL Events

Event Number | Event Name | Event Description
--- | --- | ---
53 | L3PPLevL4GEN_CP_EVENT_WINK | Host sends a generate call processing event of Wink on the specified channel.
54 | L3PPLev_HOST_CONNECT | Event received when the channel that was outseized received a "Connect" sent from the host.
63 | L3PPLevL4_XMIT_FLASH | Indicates host has sent a Call Processing Event of FLASH on the specified channel.
64 | L3PPLevL4_XMIT_ONHOOK | Indicates host has sent a Call Processing Event of ONHOOK on the specified channel.
65 | L3PPLevL4_XMIT_OFFHOOK | Indicates host has sent a Call Processing Event of OFFHOOK on the specified channel.
82 | L3PPLevDSP_RESULT_FIRST_ DIGIT_RCVD | Used for compelled KP. Event received when the first KP digit is received.
100 | T1PPLevRCV_LINE_SIG_00 | Receive event of AB line signaling. A low B low.
101 | T1PPLevRCV_LINE_SIG_01 | Receive event of AB line signaling. A low B high.
102 | T1PPLevRCV_LINE_SIG_10 | Receive event of AB line signaling. A high B low.
103 | T1PPLevRCV_LINE_SIG_11 | Receive event of AB line signaling. A high B high.

Digital communications link - voice, data, and video at a 1.544 Mbps rate (24 64 Kbps channels)
See Programmable Protocol Language.
Read Only Memory
See Atomic Function.
Call signaling protocol for setup and termination of calls.
Call processing layer of the CSP.
Outgoing call setup during real-time call processing on a specific channel.
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.
Multi-Frequency
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.
A computer, attached to the Excel platform through an RS-232 or Ethernet link, from which you run the telecommunications application that controls the Excel platform.
See Information Control Block.
Application layer of the CSP.
Digital Signal Processor
Momentary interruption in a single frequency tone indicating the distant switch is ready to receive the digits just dialed.
Quick depress and release of the phone plunger of a handset to signal the PBX or Centrex of instructions to follow (e.g., Call Transfer).
Incoming call setup during real time call processing on a specific channel.
AF. A predefined PPL software routine that performs a single, simple task, such as "Transmit Line Signaling" or "Allocate Digit Buffer." It is composed of standard software interrupts, calls, and data formats used by applications. Each AF has two values named "Arguments." AFs 1-50 are generic, and apply to all PPL components. AFs 51 and above apply to specific components. An AF is called "Atomic" because it is the smallest useful unit in PPL.