4 E1 Atomic Functions


 

This chapter documents the atomic functions associated with the E1 PPL component (0x0001) that are released for customization using the PPL Composer.

 

Atomic Functions

System software version 4.0 or newer is required, unless otherwise noted.

AF Number

51

Name

Set GPR to # of Digits Received in Stage

Description

Sets the value in the GPR indicated by Arg1 to the number of digits received for the stage indicated by Arg2.

Arg1

<GPR #> 1-25

Arg2

<Stage #> 1-4

AF Number

52

Name

Store Received Digit in GPR

Description

Stores a single digit received in the GPR indicated by Arg1. If a digit durations reported, it is stored in the GPR indicated by Arg2.

GPR 2:

Stage # of the received digits

GPR 3:

String # of the received digits

GPR 4:

Digit to store (index into digit buffer)

GPR 5:

Value of the GPR where the digit is to be stored (1-25).

Arg1

<Not Used>

Arg2

<Not Used>

AF Number

53

Name

Store Digits Received in GPR

Description

Stores a single digit received in the GPR indicated by Arg1. If a digit durations reported, it is stored in the GPR indicated by Arg2.

Arg1

<GPR #> 1-25

Arg2

<GPR #> 1-25

AF Number

54

Name

L3PPL Store digit at fwd xmit ctr in General Purpose Register

Description

Sets the GPR indicated by Arg 2 to the digit indexed by the Stage number, as indicated by Arg 1

Arg1

<Stage Number> 1:4

Arg2

<General Purpose Register> 1:25

AF Number

55

Name

L3PPL Store Digit Received in General Purpose Register

Description

Stores a single digit received in the GPR specified by Arg 1

Arg1

<Register Number> 1:25

Arg2

<Not Used>

AF Number

56

Name

L3PPL Store General Purpose Register in Stage at FWD Xmt Dig Ctr

Description

Stores the digit indexed by the forward transmit digit ctr indicated by Arg 1 into the GPR indicated by Arg 2

Arg1

<Stage Number> 1:4

Arg2

<Register Number> 1:25

AF Number

60

Name

Send L4 Out of Service/Blocked

Description

Sends a L3 to L4 Out of Service message with a status of Blocked in order to bring the channel out of service in the call processing layer (L4). This message should be sent when a remote blocked line signaling state is detected.

Arg1

<Not Used>

Arg2

<Not Used>

AF Number

61

Name

Send a Busied Out Message to Layer 4

Description

Sends a L3 to L4 Busied Out message after generating local blocked line signaling due to processing a host Busied Out message. This results in updating the call processing layer (L4) for the local busied-out condition.

Arg1

<Not Used>

Arg2

<Not Used>

AF Number

62

Name

Send a Q.931 CONNECT Message to Layer 4

Description

Sends a Q.931 CONNECT message to layer 4 for notification that answer has been detected.

Arg1

<Not Used>

Arg2

<Not Used>

AF Number

63

Name

Send a DISCONNECT message to Layer 4

Description

Sends a DISCONNECT message to Layer 4 upon the detection of release signaling from the network.

Arg1

<Not Used>

Arg2

<Not Used>

AF Number

64

Name

Send a Q.931 CLEAR ACK to Layer 4

Description

Sends a Layer 3 to Layer 4 CLEAR ACK upon detection of idle signaling from the network after release. This will result in Layer 4 sending a Channel Released message to the host, provided that Layer 4 has previously sent an L4 Clear Req PPL event (#58) to the state machine.

Arg1

<Not Used>

Arg2

<Not Used>

AF Number

65

Name

Send an In Service Message to Layer 4

Description

Sends a Layer 3 to Layer 4 In Service message.

Arg1

<Not Used>

Arg2

<Not Used>

AF Number

66

Name

Send an Out of Service (No Reason) Message to Layer 4

Description

Sends Layer 4 an Out of Service (No Reason) message due to distant end failure to release call.

Arg1

<Not Used>

Arg2

<Not Used>

AF Number

67

Name

Send Layer 4 a Call Processing Event message from Call Control Instruction

Description

Sends the host a Call Processing Event message with the event indicated by the current call control instruction and any associated data.

Arg1

<Not Used>

Arg2

<Not Used>

AF Number

68

Name

Send Layer 5 a Call Processing Event Message

Description

Sends the host a Call Processing Event message with the event indicated by Arg1 and any associated data.

Arg1

<Call Processing Event> 1–17

Arg2

<Not Used>

AF Number

69

Name

Send a Q.931 SETUP INDICATION to Layer 4 with Address Data

Description

Sends a SETUP INDICATION message to Layer 4 for notification of an incoming call, including any address digits collected to this point. This message will result in Layer 4 sending a Request for Service with Address Data message to the host.

Arg1

<Not Used>

Arg2

<Not Used>

AF Number

70

Name

Send a Q.931 SETUP INDICATION to Layer 4

Description

Sends a SETUP INDICATION message to Layer 4 for notification of an incoming call. This message will result in Layer 4 sending a Request for Service message to the host.

Arg1

<Not Used>

Arg2

<Not Used>

AF Number

71

Name

Send an Access Denied Message to Layer 4

Description

Sends an ACCESS DENIED message to Layer 4 for notification of an outseize attempt failure, including the failure reason indicated by Arg1 (this should be one of the Outseize Failure message response status).

Arg1

Arg1: <Outseize Failure Status>

Arg2

<Not Used>

AF Number

72

Name

Send a Q.931 ALERTING Message to Layer 4

Description

Sends a Q.931 ALERTING message to Layer 4 for notification of a successful outseizure.

Arg1

<Not Used>

Arg2

<Not Used>

AF Number

73

Name

Send Layer 4 a Flash Event Notification

Description

Send Layer 4 a Flash Event Notification. Minimum Software Version: 4.1. Sends a Flash Detected message to L4. To enable host notification, see message "Flash Timing Configure 0x0016" in the API Reference.

Arg1

<Not Used>

Arg2

<Not Used>

AF Number

74

Name

L3PPL Send a Setup Indication to Layer 4

Description

Sends a "setup indication" to Layer 4, to report an incoming call with associated address/information signals. The address signaling type is specified by the offset of the Config Byte.

Arg1

<Config Byte Offset> 1 - 200

Arg2

 

AF Number

77

Name

Send Layer 4 a Call Processing Event/Digits Message

Description

Sends Layer 4 a Call Processing Event/Digits message, including the stages of digits to be reported indicated by Arg1. This will result in Layer 4 sending a Call Processing Event/Digits message to the host.

Arg1

<Stages of Digits to Report>

Arg2

<Not Used>

AF Number

78

Name

Send Call Processing Event /Digits Message

Description

Sends a Call Processing Event /Digits message to the host reporting the digit strings indicated by Arg1.

Arg1

<Stage # Bit Mask>

Bit 0 Stage 1

Bit 1 Stage 2

Bit 2 Stage 3

Bit 3 Stage 4

Arg2

<Not Used>

AF Number

79

Name

Send Call Processing Event/Digit With Timing Information Message

Description

Sends a Call Processing Event/Digit With Timing Information message to the host reporting a single digit. If digit duration reporting is not enabled, the duration will be 0.

Arg1

<Not Used>

Arg2

<Not Used>

AF Number

80

Name

Send Inseize Control or Outseize Control Response to the Host

Description

Sends an Inseize Control or Outseize Control Response to the host with the error indicated by Arg1. The message sent is determined by which message was originally received.

Arg1

<Response Status> See "API Reference" for values

Arg2

<Not Used>

AF Number

81

Name

Send a Call Processing Event Message with Event ID

Description

Sends a Call Processing Event message with the PPL Event indicated by Arg1.

Arg1

<PPL Event ID>

Arg2

<Not Used>

AF Number

82

Name

Set Receive Stage Status (Minimum Software Version: 4.1)

Description

Updates the receive stage status field for the stage indicated by Arg1 to the value indicated by Arg2.

Arg1

<Stage #> 1 - 4

Arg2

<Value>

AF Number

84

Name

Outpulse BWD R2 Signal in Compelled or Pulsed Mode

Description

Outpulses a BWD R2 signal in either compelled or pulsed mode, depending on the current FWD R2 signaling state. If a FWD R2 signal is present, the BWD R2 signal will be compelled, otherwise it will be pulsed.

Arg1

<BWD R2 Signal> 1 -15 (for both group A and group B).

Arg2

<Value>

AF Number

85

Name

Outpulse BWD R2 Signal in Compelled Mode

Description

Outpulses a BWD R2 signal in compelled mode.

Arg1

<BWD R2 Signal> 1 -15 (for both Group A and Group B).

Arg2

<Not Used>

AF Number

86

Name

Outpulse BWD Pulsed R2 Signal

Description

Outpulses a BWD R2 signal in pulsed mode. The R2 signal value is indicated in Data Byte 2 of a Generate Call Processing Event instruction.

Arg1

<Not Used>

Arg2

<Not Used>

AF Number

87

Name

Outpulse BWD Compelled R2 Signal

Description

Outpulses a backward compelled R2 signal. The R2 signal value is indicated in Data Byte 2 of a Generate Call Processing Event instruction.

Arg1

<Not Used>

Arg2

<Not Used>

AF Number

88

Name

Outpulse BWD R2 Signal in Compelled Mode/Generate Completion Event

Description

Outpulses a backward R2 signal in compelled mode and instructs the MFDSP card to generate PPL Event 46 (R2 COMP CYCLE COMPLETE) when the R2 cycle is complete (silence is detected in both the forward and backward directions). The R2 signal value is indicated in Data Byte 2 of a Generate Call Processing Event instruction. The PPL must wait in a normal state for this event after executing this atomic function to guarantee that the R2 cycle has completed. Once this event is received, MFC R2 reception/transmission can be cancelled using AF 147.

Arg1

<Not Used>

Arg2

<Not Used>

AF Number

89

Name

Outpulse BWD R2 Signal in Compelled Mode/Generate Completion (Using GPR)

Description

Outpulses a backward R2 signal (from GPR indicated by Arg1) in compelled mode and instructs the MFDSP card to generate PPL Event 46 (R2 COMP CYCLE COMPLETE) when the R2 cycle is complete (silence is detected in both the forward and backward directions).

The PPL must wait in a normal state for this event after executing this atomic function to guarantee that the R2 cycle has completed. Once this event is received, MFC R2 reception/transmission can be cancelled using AF 147.

Arg1

<GPR #> 1-25

Arg2

<Not Used>

AF Number

90

Name

Outpulse FWD R2 Signal in Compelled Mode

Description

Outpulses a forward R2 signal in compelled mode.

Arg1

<FWD R2 Signal> 1-15 (for both Group I and Group II).

Arg2

<Not Used>

AF Number

91

Name

Outpulse BWD R2 Signal in Compelled or Pulsed Mode

Description

Outpulses a BWD R2 Signal in either compelled or pulsed mode, depending on the current tone receive state. The R2 signal value is indicated in Data Byte 2 of a Generate Call Processing Event message.

Arg1

<Not Used>

Arg2

<Not Used>

AF Number

92

Name

Outpulse Next FWD Compelled R2 Signal

Description

Transmits the next FWD compelled R2 signal indicated by the FWD R2 Transmit Digit Counter from the stage indicated by Arg1.

Arg1

<Stage #> 1 - 4

Arg2

<Not Used>

AF Number

93

Name

Outpulse BWD R2 Signal in Forced Pulsed Mode

Description

Outpulses a backward R2 signal in pulsed mode and waits until the R2 signal has been pulsed to process the next atomic function.

Arg1

<BWD R2 Signal> 1-15 (for both Group A and Group B).

Arg2

<Not Used>

AF Number

97

Name

L3PPL Outpulse Single MFR1 Digit

Description

Sends a request to TC to outpulse individual MFR1 digits.

Arg1

<Register Number>

Arg2

<Outp Event Flag>

AF Number

98

Name

Outpulse MFR1 Digits

Description

Sends an internal message to outpulse the MFR1 digit string(s) contained in the Outpulse Stage N Address Data ICB for the stage indicated in Arg1. Note: There must be a least one DSP configured for MFR1 tone transmission for this function to work.

Arg1

<Stage #> 1 - 4

Arg2

<Not Used>

AF Number

99

Name

Outpulse MFR1 Digits for Stage Indicated in Outseize Control Instruction

Description

Sends an internal message to outpulse the MFR1 digit string(s) contained in the Outpulse Stage N Address Data ICB for the stage indicated. Note: There must be at least one DSP configured for MFR1 tone transmission for this function to work.

Arg1

<Not Used>

Arg2

<Not Used>

AF Number

100

Name

Outpulse DTMF Digits

Description

Sends an internal message to outpulse the DTMF digit string(s) contained in the Outpulse Stage N Address Data ICB for the stage indicated in Arg1.

Note: There must be a least one DSP configured for DTMF tone transmission for this function to work.

Arg1

<Stage #> 1 - 4

Arg2

<Not Used>

AF Number

101

Name

Outpulse DTMF Digits for Stage Indicated in Outseize Control Instruction

Description

Sends an internal message to outpulse the DTMF digit string(s) contained in the Outpulse Stage N Address Data ICB for the stage indicated.

Note: There must be a least one DSP configured for DTMF tone transmission for this function to work.

Arg1

<Not Used>

Arg2

<Not Used>

AF Number

102

Name

Cancel Outpulsing Digits

Description

Cancels an outstanding outpulse digits request

Arg1

<Not Used>

Arg2

<Not Used>

AF Number

103

Name

Outpulse DTMF Digits

Description

Minimum Software Version: 4.1

Initiates the collection of DTMF digits for the stage indicated by Arg1 using the timer values specified by the Generic Timer ID indicated by Arg2.

Arg1

<Stage #> 1 - 4

Arg2

<Timer ID> 1-100

AF Number

104

Name

Outpulse MFR1 Digits

Description

Minimum Software Version: 4.1

Initiates the collection of MFR1 digits for the stage indicated by Arg1 using the timer values specified by the Generic Timer ID indicated by Arg2.

Arg1

<Stage #> 1 - 4

Arg2

<Timer ID> 1-100

AF Number

105

Name

E1PPL Outpulse MFR1 digits in IFB mode

Description

Sends a request to TC to outpulse MFR1 digits for the stage specified in Arg 1, using IFB mode. No KP/ST Framing

Arg1

<Stage Number> 1:4

Arg2

<Number of Cycles> 1:10

AF Number

106

Name

Outpulse Dial Pulse Digits from Outseize Control Instruction

Description

Sends an internal message to outpulse the Dial Pulse digit string(s) contained in the Outpulse Stage N Address Data ICB for the stage indicated in the ICB. Note: A DSP does not need to be configured for this function to work.

Arg1

<Not Used>

Arg2

<Not Used>

AF Number

107

Name

Outpulse Dial Pulse Digits from Outseize Control Instruction for Stage Indicated

Description

Sends an internal message to outpulse the Dial Pulse digit string(s) contained in the Outpulse Stage N Address Data ICB for the stage indicated by Arg1. Note: A DSP does not need to be configured for this function to work.

Arg1

<Stage #> 1 - 4

Arg2

<Not Used>

AF Number

108

Name

Cancel Outpulse Dial Pulse Digits

Description

Cancels an outstanding request for outpulsing Dial Pulse digits.

Arg1

<Not Used>

Arg2

<Not Used>

AF Number

109

Name

L3PPL Outpulse DP from fwd xmit ctr in General Purpose Register

Description

Sends a request to xsig to outpulse DP digits for stage specified in Arg 1, beginning at the digit specified by the forward xmit digit ctr.

Arg1

<Stage Number> 1:4

Arg2

<Outp Event Flag> 0:1
0 = No outpulse complete event
1 = Send outpulse complete event

AF Number

112

Name

Generate Tone

Description

Initiates the generation of the tone indicated by Arg1, for the number of cycles indicated by Arg2.

Arg1

<Tone ID> See message "Connect Tone Pattern 0x002F" in the API Reference.

Arg2

<# of Cycles>

AF Number

113

Name

Generate Dialtone

Description

Initiates the transmission of North American Standard Dialtone.

Arg1

<Not Used>.

Arg2

<Not Used>

AF Number

114

Name

Cancel Tone

Description

Cancels the generation of the tone indicated by Arg1.

Arg1

<Not Used>.

Arg2

<Not Used>

AF Number

121

Name

Transmit Line Signaling

Description

Sets the transmit line signaling for a channel. Note: CCITT recommends that the C bit be low (0) and the D bit be high (1).

Arg1

<ABCD Signaling Bits>

The ABCD signaling bits are a binary mask representing the line signaling bit combination to be transmitted. The bit order is as follows:

Bit # 7 6 5 4 3 2 1 0

Signal Bit A B C D

Arg2

<Not Used>

AF Number

122

Name

Transmit Default Idle Line Signaling

Description

Transmits the preconfigured idle line signaling ABCD bit pattern.

Arg1

<Not Used>

Arg2

<Not Used>

AF Number

123

Name

Enable CAS ABCD Bit Line Signaling Scanning

Description

Activates scanning of the Channel Associated Signaling (CAS) ABCD line signaling bits.

Arg1

<Not Used>

Arg2

<Not Used>

AF Number

126

Name

E1PPL Attach MFCR2 Reciever (1 - Forward, 2 - Backward) <PPL-CFG-Byte #>

Description

Allocates a MFR2 receiver for Forward/Backward R2 Reception. The first argument determines the direction of the MFR2 signal. The second argument is the location of the configuration byte that contains the setting for the MFR2 tone reception level.

Arg1

MFR2 direction: 1 - Forward, 2 - Backward

Arg2

Index to ppl_cfg_byte which determines if MFR2 tone reception level is set to the high (-22dB) or low (-35dB). The index can be from 1 - 200.

AF Number

127

Name

Setup for FWD Compelled R2 Reception

Description

Allocates a FWD R2 compelled DSP digit receiver. Note: This is a blocking atomic function.

Arg1

<Not Used>

Arg2

<Not Used>

AF Number

128

Name

Setup for BWD Compelled R2 Reception

Description

Allocates a BWD R2 compelled DSP digit receiver. Note: This is a blocking atomic function

Arg1

<Not Used>

Arg2

<Not Used>

AF Number

129

Name

Allocate a FWD R2 Digit Buffer for Current Stage

Description

Allocates a forward R2 digit buffer for storing the current stage of address signaling.

Arg1

<Not Used>

Arg2

<Not Used>

AF Number

130

Name

Allocate a FWD R2 Digit Buffer

Description

Allocates and initializes a forward R2 signal digit buffer for the stage indicated by Arg1.

Arg1

Stage #> 1 - 4

Arg2

<Not Used>

AF Number

131

Name

Reset FWD R2 Receive Digit Counter for Current Stage

Description

Sets the FWD R2 digit reception counter to 0 for the current address signaling stage.

Arg1

<Not Used>

Arg2

<Not Used>

AF Number

132

Name

Reset FWD R2 Receive Digit Counter

Description

Initializes the FWD R2 receive digit counter to 0 for the stage indicated by Arg1.

Arg1

<Stage #> 1 - 4

Arg2

<Not Used>

AF Number

133

Name

Store BWD R2 Signal as Event

Description

Stores the currently received BWD R2 signal for later reporting as a Call Processing Event.

Arg1

<Not Used>

Arg2

<Not Used>

AF Number

134

Name

Set BWD R2 Signal Event Bit

Description

Sets the BWD R2 signal event bit used for later reporting as a Call Processing Event.

Arg1

<Not Used>

Arg2

<Not Used>

AF Number

135

Name

Test For FWD Receive Digit Counter Value in Range

Description

Minimum Software Version: 4.1. Test atomic function that compares the number of digits collected in Stage 1 to the minimum and maximum number of digits indicated by Arg1 and Arg2 respectively, and returns an Internal PPL Event according to the results.

Arg1

<GPR #> 1-25

Arg2

<GPR #> 1-25

Test Result

PPL Internal Event

< minimum

1

within range

2

> or = to maximum

3

AF Number

136

Name

Clear Stage/FWD Digit Count

Description

Clears the digit string and resets the digit count for the stage indicated by Arg1.

Arg1

<Stage #> 1 - 4

Arg2

<Not Used>

AF Number

139

Name

Send DSP Service Request to Collect Individual Digits/Make Matrix Slave (Addr Sig Type)

Description

Sends a "Request Digits" message to sym to collect individual digits after call setup.

Arg1

<Address Signal Type> 1:2

Arg2

<Not Used>

AF Number

140

Name

Setup for DTMF Reception with Inseize Control Instruction

Description

Allocates a DTMF digit receiver. Digit reception parameters used for controlling digit collection are determined by the inpulsing parameters associated with the stage indicated by the current Receive Stage N Inseize Control instruction.

Note: This is a blocking atomic function.

Arg1

<Not Used>

Arg2

<Not Used>

AF Number

141

Name

Setup for DTMF Reception

Description

Allocates a DTMF digit receiver. Digit reception parameters used for controlling digit collection are determined by the inpulsing parameters associated with the stage indicated by Arg1.

Arg1

<Stage #> 1 - 4

Arg2

<Not Used>

AF Number

142

Name

Setup for MFR1 Reception with Inseize Control Instruction

Description

Allocates an MFR1 digit receiver. Digit reception parameters used for controlling digit collection are determined by the inpulsing parameters associated with the stage indicated by the current Receive Stage N Inseize Control instruction. Note: This is a blocking atomic function.

Arg1

<Not Used>

Arg2

<Not Used>

AF Number

143

Name

Setup for MFR1 Reception

Description

Allocates a MFR1 digit receiver. Digit reception parameters used for controlling digit collection are determined by the inpulsing parameters associated with the stage indicated by Arg1. Note: This is a blocking atomic function.

Arg1

<Stage #> 1 - 4

Arg2

<Not Used>

AF Number

144

Name

Setup for Dial Pulse Reception with Inseize Control Instruction

Description

Allocates a Dial Pulse (DP) digit receiver. Digit reception parameters used for controlling digit collection are determined by the inpulsing parameters associated with the stage indicated by the current Receive Stage N Inseize Control instruction.

Note: This is a blocking atomic function.

Arg1

<Not Used>

Arg2

<Not Used>

AF Number

145

Name

Setup for Dial Pulse Reception

Description

Allocates a Dial Pulse (DP) digit receiver. Digit reception parameters used for controlling digit collection are determined by the inpulsing parameters associated with the stage indicated by Arg1. Note: This is a blocking atomic function.

Arg1

<Stage #> 1 - 4

Arg2

<Not Used>

AF Number

146

Name

Send DSP Service Request to Collect Individual Digits

Description

Sends a request to collect single digits after call setup and report digit to the host with a Call Processing Event of "Digits". The Address Signaling Type is indicated by Arg1.

Arg1

<Address Signaling Type>

1 = DTMF

2 = MFR1

3= MFR2

Arg2

<Not Used>

Note

The following PPL Configuration Bytes must be configured prior to invoking this function:

Bytes 196, 197 Digit Timer (MSB, LSB) = The maximum amount of time to wait for the digit. A value of 0xFFFF disables this timer.

Byte 198 0 = disabled, 1 = enabled)

Bit 0 = Report the digit at its falling edge (when the first digit is released). If the bit is not set the digit will be reported at its rising edge (when the digit is first pressed).

Bit 1 - Ignore "#" character as first digit.

Bit 2 = Report digit duration (the amount of time the digit has been pressed). Valid only if configuration bit# 0 is 1.

Bytes 199, 200 Minimum Receive Digit Duration Timer (MSB, LSB) = The minimum amount of time for a digit to be present before it is detected and validated.

AF Number

147

Name

Cancel R2 Reception

Description

Releases an MFR2 signal receiver. This function can be used to release R2 receivers used for forward and backward R2 reception.

Arg1

<Not Used>

Arg2

<Not Used>

AF Number

148

Name

Collect DTMF Digits

Description

Minimum Software Version: 4.1 Initiates the collection of DTMF digits using the timers defined in the Config Bytes (Arg1) with the values specified by the Generic Timer ID indicated by Arg2.

Arg1

<Config Byte #> 1- 200

Arg2

<Timer ID> 1-100

AF Number

149

Name

Collect MFR1 Digits

Description

Minimum Software Version: 4.1

Initiates the collection of MFR1 digits using the timers defined in the Config Bytes (Arg1) with the values specified by the Generic Timer ID indicated by Arg2.

Arg1

<Config Byte #> 1- 200

Arg2

<Timer ID> 1-100

AF Number

150

Name

Send Request To Do Call Progress Analysis For Class 0 (North American)

Description

Sends an internal message to do Call Progress Analysis for Class 0 (North American). Note: There must be a least one DSP configured for call progress analysis for this function to work.

Arg1

<Not Used>

Arg2

<Not Used>

AF Number

151

Name

Test Call Progress Analysis Result and Set up Internal Event

Description

Tests the result of Call Progress Analysis.

Arg1

<Not Used>

Arg2

<Not Used>

Test Result

PPL Internal Event

Answer

80

Error

81

Continuous On

82

Max Silence Timeout

83

Not Determined Timeout

84

Max Determined Timeout

85

Signaling Answer

86

Dialtone

87

Other

0

AF Number

152

Name

Report Call Progress Analysis Result to the Host

Description

Reports the Call Progress Analysis result indicated by Arg1 to the host.

Arg1

<Call Progress Analysis Result>

Arg2

<Not Used>

AF Number

153

Name

Report Call Progress Analysis Result from Atomic Function 151 to the Host

Description

Reports the Call Progress Analysis result from Atomic Function 151 to the host.

Arg1

<Not Used>

Arg2

<Not Used>

AF Number

154

Name

Send Request To Do Call Progress Analysis (Class From Arg1)

Description

Sends a request to do Call Progress Analysis for the class indicated by Arg1.

Arg1

<Call Progress Analysis Class>

Arg2

<Not Used>

AF Number

155

Name

Send Request To Do Call Progress Analysis (Class from Outseize Control Message)

Description

Sends a request to do Call Progress Analysis for the class indicated by an Outseize Control message.

Arg1:

<Not Used>

Arg2:

<Not Used>

AF Number

156

Name

Cancel Call Progress Analysis

Description

Sends a request to cancel Call Progress Analysis.

Arg1:

<Not Used>

Arg2:

<Not Used>

AF Number

157

Name

CPC Detection

Description

Initiates CPC detection.

Arg1:

<Not Used>

Arg2:

<Not Used>

AF Number

158

Name

Cancel CPC Detection

Description

Cancels CPC detection.

Arg1:

<Not Used>

Arg2:

<Not Used>

AF Number

159

Name

Reset FWD R2 Transmit Digit Counter to 1

Description

Sets the generate FWD R2 signal counter to 1 for initiation of FWD R2 signal transmission.

Arg1:

<Not Used>

Arg2:

<Not Used>

AF Number

160

Name

Increment FWD R2 Transmit Digit Counter by 1

Description

Increments the generate FWD R2 signal counter by 1.

Arg1:

<Not Used>

Arg2:

<Not Used>

AF Number

161

Name

Decrement FWD R2 Transmit Digit Counter by 1

Description

Decrements the generate FWD R2 signal counter by 1.

Arg1:

<Not Used>

Arg2:

<Not Used>

AF Number

162

Name

Decrement FWD R2 Transmit Digit Counter by 2

Description

Decrements the generate FWD R2 signal counter by 2.

Arg1:

<Not Used>

Arg2:

<Not Used>

AF Number

163

Name

Decrement FWD R2 Transmit Digit Counter by 3

Description

Decrements the generate FWD R2 signal counter by 3.

Arg1:

<Not Used>

Arg2:

<Not Used>

AF Number

164

Name

Test if Current FWD Digit Count > Stage Digit Count

Description

Tests if the current FWD digit count is greater than the stage digit count for the stage number indicated by Arg1.

Arg1:

Arg1: <Stage #> 1 - 4

Arg2:

<Not Used>

Test Result

PPL Internal Event

Greater than

1

Other

0

AF Number

165

Name

Test if Current FWD Digit Count <>== Stage Digit Count

Description

Tests if the current FWD digit count is greater than, less than, or equal to the stage digit count for the stage number indicated by Arg1.

Arg1:

<Stage #> 1 - 4

Arg2:

<Not Used>

Test Result

PPL Internal Event

==

0

<

1

>

2

AF Number

166

Name

Test if FWD Stage Digit Count == 0

Description

Tests if the current FWD digit count for the stage number indicated by Arg1 equals 0.

Arg1:

<Stage #> 1 - 4

Arg2:

<Not Used>

Test Result

PPL Internal Event

== 0

0

Other

1

AF Number

167

Name

Store FWD Transmit Digit Counter Value in GPR

Description

Minimum Software Version: 4.1

Stores the value of the forward digit counter (i.e. number of digits received) for the current call in a GPR.

Arg1:

<GPR #> 1-25

Arg2:

<Not Used>

AF Number

168

Name

Store GPR Value in FWD Transmit Digit Counter

Description

Transfers the contents of a General Purpose register into the forward digit counter for the current call.

Arg1:

<GPR #> 1-25

Arg2:

<Not Used>

AF Number

169

Name

L3PPL Test if Current Xmit Digit Ctr = Stage Digit Count

Description

Checks that the total number of FWD digits to be transmitted is equal to the current FWD transmit digit counter.

Arg1

<Stage Number> 1:25

Arg2

<Not Used>

AF Number

170

Name

Store FWD R2 Signal

Description

Stores the current FWD R2 signal in the digit buffer assigned to the receive digit stage indicated by Arg1. R2 FWD signals are stored in BCD encoded format. The location within the digit buffer where the signal is stored is determined by the current FWD digit counter.

Arg1:

<Stage #> 1 - 4

Arg2:

<Not Used>

AF Number

171

Name

Test If Digit Count == 0xFF

Description

Tests if the digit count for the stage number indicated by Arg1 equals 0xFF.

Arg1:

<Stage #> 1 - 4

Arg2:

<Not Used>

Test Result

PPL Internal Event

== 0xFF)

2

< 0xFF

1

Other

0

AF Number

172

Name

Setup Host Call Processing Event/Digits

Description

Sets up a Call Processing Event/Digits message to send to the host upon collection of a complete stage of digits.

Arg1:

<Stage #> 1 - 4

Arg2:

<Not Used>

AF Number

173

Name

Increment Receive FWD R2 Digit Counter

Description

Increments the current receive stage digit counter due to reception of a FWD R2 signal.

Arg1:

<Stage #> 1 - 4

Arg2:

<Not Used>

AF Number

174

Name

Store L4 Inseize/Outseize ICBsr

Description

Stores Layer 4 Inseize or Outseize Control ICBs for later processing. These ICBs contain inseize or outseize instructions and related data (i.e.: R2 signal to generate). Layer 4 will send Layer 3 an Inseize Control or Outseize Control message after receiving and preprocessing a host Inseize Control or Outseize Control message.

Arg1:

<Not Used>

Arg2:

<Not Used>

AF Number

175

Name

Test for Prior Sending of Layer 3 to Layer 4 SETUP INDICATION

Description

Tests if an L3 to L4 SETUP INDICATION message has been previously sent.

Note: A SETUP INDICATION is sent to the Call Processing Layer (L4) to indicate that an incoming call has been received.

Arg1:

<Not Used>

Arg2:

<Not Used>

Test Result

PPL Internal Event

Sent

1

Not Sent

0

AF Number

179

Name

Use Pre-programmed Inseize Instruction List

Description

Points a channel to the inseize instruction list preconfigured on the channel with the Inseize Instruction List Configure message.

Arg1:

<Not Used>

Arg2:

<Not Used>

AF Number

180

Name

Use Instructions in Inseize Control or Outseize Control message

Description

Points a channel to the inseize or outseize instruction list provided by the host through an interactive Inseize Control or Outseize Control message. Note: This function can be used for both inseize and outseize instruction processing.

Arg1:

<Not Used>

Arg2:

<Not Used>

AF Number

181

Name

Reset Instruction Index

Description

Resets the current inseize or outseize instruction pointer to instruction 1. Note: This function can be used for both inseize and outseize instruction processing.

Arg1:

<Not Used>

Arg2:

<Not Used>

AF Number

182

Name

Increment Instruction Index

Description

Increments the current inseize or outseize instruction pointer to the next instruction #. Note: This function can be used for both inseize and outseize instruction #. processing

Arg1:

<Not Used>

Arg2:

<Not Used>

AF Number

183

Name

Test Current Inseize Control Instruction

Description

Tests for the current Inseize Control instruction

Arg1:

<Not Used>

Arg2:

<Not Used>

Test Result

PPL Internal Event

Null

0

Report Call Processing Event

1

Generate Call Processing Event

2

Receive Stage n Data

3

Wait for Host Control

4

Report Incoming Call

5

Report Incoming Call with Data

6

Generate Inseize ACK

7

Send Host Inseize ACK

8

Use Instruction List

9

Other

20

AF Number

184

Name

Set Call Control Instruction Index to Host Value

Description

Sets the call control instruction index to that indicated in the Use Instruction List ICB sent in an interactive Inseize Control or Outseize Control message by the host.

Arg1:

<Not Used>

Arg2:

<Not Used>

AF Number

185

Name

3

Description

Tests the stage number in the current Inseize Control Instruction. The stage # is determined by the Receive Stage N Address Data Inseize Control instruction currently being processed.

Arg1:

<Not Used>

Arg2:

<Not Used>

Test Result

PPL Internal Event

Stage # 1

1

Stage # 2

2

Stage # 3

3

Stage # 4

4

Other

0xFF

AF Number

186

Name

Test Next Inseize Control Instruction

Description

Tests if the next Inseize Control Instruction is Receive Stage N Address Data.

Arg1:

<Not Used>

Arg2:

<Not Used>

Test Result

PPL Internal Event

Receive Stage N Address Data

1

Other

0

AF Number

187

Name

Test Inseize Control Generate Call Processing Event Instruction

Description

Tests if the next Inseize Control Instruction is Receive Stage N Address Data.

Arg1:

<Not Used>

Arg2:

<Not Used>

Result

PPL Internal Event

ANI Request Off Hook

5

Wink 1

6

Wink 2

7

Wink 3

8

Wink 4

9

Wink 5

10

Wink 6

11

Wink 7

12

Wink 8

13

BWD Pulsed R2 Signal

1

BWD Compelled R2 Signal

2

BWD Compelled R2 Signal with Cycle Completion

3

BWD Compelled or Pulsed R2 Signal

4

AF Number

188

Name

Test Next Inseize Control Instruction for Address Signaling Type

Description

Tests for the receive signaling type from the inpulsing parameters of a stage. The stage number is obtained from the next Inseize Control Instruction, as indicated by the current instruction index (provided that it is a Receive Stage N instruction)..

Arg1:

<Not Used>

Arg2:

<Not Used>

Test Result

PPL Internal Event

DTMF

1

MFR1

2

MFR2

3

Other

20

AF Number

189

Name

Test Address Signaling Type of Stage N Inpulsing Parameters

Description

Tests the inpulsing parameters of the stage indicated by Arg1 for its receive signaling type.

Arg1:

Stage #> 1 - 4

Arg2:

<Not Used>

Test Result

PPL Internal Event

DTMF

1

MFR1

2

MFR2

3

Other

20

 

AF Number

190

Name

Return Inpulsing Signaling Type

Description

Tests for the receive signaling type from the inpulsing parameters of a stage. The stage number is obtained from the current Inseize Control Instruction, as indicated by the current instruction index (provided that it is a Receive Stage N instruction).

Arg1:

<Not Used>

Arg2:

<Not Used>

Test Result

PPL Internal Event

DTMF

1

MFR1

2

MFR2

3

Other

20

AF Number

194

Name

Test for Outseize Control ICB Buffer

Description

Tests if the Outseize Control ICB buffer is attached to the Layer 4 to Layer 3 CALL REQUEST message.

Arg1:

<Not Used>

Arg2:

<Not Used>

Result

PPL Internal Event

Yes

1

No

0

AF Number

195

Name

Test for Host Outseize Control Instructions

Description

Tests if there are Outseize Control Instructions from the host.

Arg1:

<Not Used>

Arg2:

<Not Used>

 

Result

PPL Internal Event

Yes

1

No

0

AF Number

196

Name

Use Pre-programmed Outseize Instruction List

Description

Points a channel to use the channel’s pre-programmed outseize instruction list.

Arg1:

<Not Used>

Arg2:

<Not Used>

AF Number

197

Name

Test Current Outseize Control Instruction

Description

Tests for the current Outseize Control instruction.

Arg1:

<Not Used>

Arg2:

<Not Used>

Test Result

PPL Internal Event

Null

0

Scan for Wink

1

Scan for ANI Request Off-hook

2

Scan for Dialtone

3

Report Call Processing Event

4

Outpulse Stage N Digits

5

Wait for Host Address Data

6

Wait for Host Control

7

Send Host Acknowledgment

8

Do Call Progress Analysis

9

Seize

10

Use Pre-programmed Instruction List

11

Cancel R2 Receiver

13

Scan for Backward R2 Signal

14

Wait for Host Control with Answer Supervision

15

Other

20

AF Number

198

Name

Test for Outpulsing Data ICB

Description

Tests if there are host-supplied outpulsing digits for the current stage.

Arg1:

<Not Used>

Arg2:

<Not Used>

Test Result

PPL Internal Event

Yes

1

No

0

AF Number

199

Name

Test Address Signaling Type of Outpulse Stage N Address Data for Current Stage

Description

Tests the address signaling type in the Outpulse Stage N Address Data ICB for the current stage. The stage number is obtained from the current outseize control instruction from list, provided that it is an Outpulse Stage N instruction.

Arg1:

<Not Used>

Arg2:

<Not Used>

Result

PPL Internal Event

DTMF

1

MFR1

2

MFR2

3

MFR1 ALL

4

Dial Pulse

5

Compelled KP

6

Other

20

AF Number

200

Name

Transfer Remaining Digits

Description

Takes digits remaining from the stage indicated by Arg1 and dynamically creates a Data ICB with the remaining address data for the stage indicated by Arg2.

Arg1:

Stage #> 1 - 4

Arg2:

<Stage #> 1 - 4

Note: If a Data ICB already exists for the stage indicated by Arg2, any digits it contains will be over-written by the digits from the stage indicated by Arg1.

AF Number

201

Name

Return Config

Description

Byte #

Stores the Config Offset where Outseize Control Instructions end in the GPR indicated by Arg1. The Config Byte indicated by Arg2 indicates where the Outseize Control Instructions begin.

Arg1:

Arg1: <GPR #> 1-25

Arg2:

<Config Byte #> 1- 200

AF Number

202

Name

Test for Outpulsing Data ICB

Description

Minimum Software Version: 4.1. Tests if there are host-supplied outpulsing digits for the current stage

Arg1:

<Stage #> 1 - 4

Arg2:

<Not Used>

Result

PPL Internal Event

No

0

Yes

1

AF Number

203

Name

Test Address Signaling Type of Outpulse Stage N Address Data for Current Stage

Description

Minimum Software Version: 4.1. Tests the address signaling type in the Outpulse Stage N Address Data ICB for the stage indicated by Arg1.

Arg1:

<Stage #> 1 - 4

Arg2:

<Not Used>

Test Result

PPL Internal Event

DTMF

1

MFR1

2

MFR2

3

MFR1 ALL

4

Dial Pulse

5

Compelled KP

6

Other

20

AF Number

204

Name

Store Digit Collection Status

Description

Stores the digit collection status for the stage indicated in the current Receive Stage N Address Data inseize control instruction.

 

Arg1:

<Status #>

66 - Digits Received

67 - First Digit Timeout

68 - Inter-digit Timeout

69 - Digits Complete Timeout

Arg2:

<Not Used>

AF Number

205

Name

Store Digits

Description

Stores a DSP decoded digit string in the inpulsing stage digit buffer associated with the stage indicated in the current Receive Stage N Address Data inseize control instruction data.

Arg1:

<Not Used>

Arg2:

<Not Used>

AF Number

206

Name

Store Digits

Description

Stores a DSP decoded digit string in the inpulsing stage digit buffer associated with the stage indicated by Arg1.

Arg1:

<Stage #> 1 - 4

Arg2:

<Not Used>

AF Number

207

Name

Update Timeout Status

Description

Minimum Software Version: 4.1

Updates the Receive digit status for the stage indicated by Arg2 according to the test results shown below. The status is reported in the Request for Service with Data message.

Arg1:

<Timeout Value>

Arg2:

<Stage #> 1 - 4

Test Result

Status

Digits Received

0x10 (Positive ACK)

First Digit Timeout

0x81(Permanent Signal Condition

Interdigit Timeout

0x80 (Partial Dial Condition)

Digits Complete Timeout

0x92 (Inpulsing Complete Timeout)

AF Number

208

Name

Store Single Digit in Stage

Description

Minimum Software Version: 4.1

Stores a single digit in the Receive Stage digit buffer for the stage indicated by Arg1. PPL Event 66 (DSP Result Digits) must be the event received immediately preceding this AF.

Arg1:

<Stage #> 1 - 4

Arg2:

<Not Used>