L3P CIC (0x000F)

You are here: PPL Developer’s Guide > 6 SS7 Atomic Functions > L3P CIC (0x000F)

L3P CIC (0x000F)

This section documents the atomic functions associated with L3P CIC.

Atomic Functions

The following AFs are specific to the L3P CIC Call Control PPL component.

AF Number	51
Name	Send L4 Channel Status In Service
Description	Sends L4 a channel in service indication.
Arg1	<Not Used>
Arg2	<Not Used>

AF Number	52
Name	Send ISUP Circuit Reset
Description	Sends ISUP a CIC reset request using no parameters.
Arg1	<Not Used>
Arg2	<Not Used>

AF Number	53
Name	Fault
Description	Generates an SS7 card fault using fault code in Arg1.
Arg1	<Fault Code>
Arg2	<Not Used>

AF Number	54
Name	PPL Restore Channel’s Assigned Protocol
Description	Function to switch from the OOS to the INS protocol.
Arg1	<Fault Code>
Arg2	<Not Used>

AF Number	55
Name	PPL Send L5 PPL Event Indication using L4/L5 Outgoing Buffer
Description	Sends a PPL Event Indication to the host using the event ID in Arg1 and sending up any ISUP parameters stored in the L4/L5 outgoing buffer.
Arg1	<Event ID>
Arg2	<Not Used>

AF Number	56
Name	Send L4 a Cut Through
Description	Sends L4 a cut through indication.
Arg1	<Not Used>
Arg2	<Not Used>

AF Number	57
Name	Send L5 PPL Event
Description	Sends a PPL event indication to the host using the Event ID in Arg1 and sending up ICB with the data in Arg2.
Arg1	<Event ID>
Arg2	<Event Data>

AF Number	58
Name	Send ISUP OOS Maintenance Loopback Ack
Description	Notifies ISUP that the requested PCM loopback has been established.
Arg1	<Not Used>
Arg2	<Not Used>

AF Number	59
Name	Copy Default ISUP Parameters into L5 Incoming Buffer
Description	Loads the PPL Config Byte prestored parameters at offset in Arg1 into the L5 incoming buffer.
Arg1	<Config Byte Offset of Defaults>
Arg2	<Not Used>

AF Number	61
Name	Test for Existence of BCD Encoded Digits in Message
Description	Tests an Outseize Control message for the existence of BCD digits.
Arg1	<Not Used>
Arg2	<Not Used>

Test Result	PPL Internal Event
Digits not present	0
Digits present	1

AF Number	62
Name	Send L4 a Q.931 Connect Message
Description	Sends L4 a Connect Indication.
Arg1	<Not Used>
Arg2	<Not Used>

AF Number	63
Name	Send L4 a Q.931 Disconnect
Description	Sends L4 a disconnect Indication.
Arg1	<Not Used>
Arg2	<Not Used>

AF Number	64
Name	Send L4 a Q.931 Clear using L4/L5 Outgoing Buffer
Description	Sends L4 a Clear indication including any parameters present in the L4/L5 outgoing buffer.
Arg1	<Not Used>
Arg2	<Not Used>

AF Number	65
Name	Send L4 OOS Maintenance Loopback
Description	Send L4 an OOS indication which also requests that a PCM loopback be connected to the channel.
Arg1	<Not Used>
Arg2	<Not Used>

AF Number	66
Name	Send L4 an Out of Service Message
Description	Sends an Out of Service message to L3/L4 with the reason indicated by Arg1.
Arg1	<Reason>
Arg2	<Not Used>

AF Number	67
Name	Test L5 Incoming Buffer for parameters and assemble with defaults
Description	Search the L4/L5 incoming buffer for an ICB relating to the message configuration specified in Arg1. If found, the ICB is concatenated with prestored parameters in the Config Bytes at the index specified by Arg2 and the resulting ICB is placed into the L4 /L5 incoming buffer.
Arg1	<ISUP Message Config Index>
Arg2	<Config Byte with Default>

Test Result	PPL Internal Event
No ICB Found	0
ICB Found	1

AF Number	68
Name	Copy Default ISUP Parameters and use BCD-Encoded digits into L5 Incoming Buffer
Description	Searches for a Stage N Address Data ICB w/ BCD encoded digit strings in the L4/L5 incoming buffer. The digits are translated into SS7 Called and Calling Party Number parameters using the parameter IDs specified in the MSB (Called Party) and LSB (Calling Party) of Arg2. The parameters are concatenated with prestored parameters in the config bytes at the index specified in Arg1. The resulting ICB is stored in the L4/L5 incoming buffer.
Arg1	<Config Byte Offset Of Defaults> 1-200
Arg2	<Called Number Party ID/Calling Number Party ID>

AF Number	69
Name	Send L4 a Q.931 SETUP using L4/L5 Outgoing Buffer
Description	Sends L4 a call SETUP indication including any SS7 parameters present in the L4/L5 outgoing buffer.
Arg1	<Not Used>
Arg2	<Not Used>

AF Number	71
Name	Transfer L5 Formatted Raw SS7 Parameters from L4/L5 Incoming to ISUP Outgoing Buffer
Description	Searches the L4/L5 incoming buffer for the ICB corresponding to the message configuration specified by Arg1. Once found, the ICB is transferred to the ISUP outgoing buffer.
Arg1	<ISUP Message Config Index>
Arg2	<Not Used>

AF Number	72
Name	Send L4 a Q.931 Alerting
Description	Sends L4 an alerting indication including any parameters present in the L4/L5 outgoing buffer.
Arg1	<Not Used>
Arg2	<Not Used>

AF Number	73
Name	Test for Existence of SS7 Parameters in Message
Description	Test any message for the presence of SS7 ICB buffers.
Arg1	<Not Used>
Arg2	<Not Used>

Test Result	PPL Internal Event
No parameters present	0
Parameters present	1

AF Number	74
Name	Purge Channel
Description	Initiates a channel purge with purge reason specified in Arg1.
Arg1	<Purge Code>
Arg2	<Not Used>

AF Number	75
Name	Send L5 PPL Event Request ACK
Description	Sends an acknowledgment to a PPL event request with the status specified in Arg1.
Arg1	<Status>
Arg2	<Not Used>

AF Number	76
Name	Assemble L5 Parameters into L5 Incoming Buffer w/ Defaults
Description	Stores the ICBs attached to the L4/L5 message into the L4/L5 incoming buffer. A search for an ICB whose message type matches the message type of the prestored parameters specified in Arg1 is invoked. If found, the ICB is concatenated with prestored parameters in the Config Bytes at the index specified by Arg1 and the resulting ICB is placed into the L4 /L5 incoming buffer. If not found, the defaults are copied ‘as is’ into the L4 /L5 incoming buffer.
Arg1	<Config Byte # of Defaults>
Arg2	<Not Used>

AF Number	76
Name	Assemble L5 Parameters into L5 Incoming Buffer w/ Defaults
Description	Stores the ICBs attached to the L4/L5 message into the L4/L5 incoming buffer. A search for an ICB whose message type matches the message type of the prestored parameters specified in Arg1 is invoked. If found, the ICB is concatenated with prestored parameters in the Config Bytes at the index specified by Arg1 and the resulting ICB is placed into the L4 /L5 incoming buffer. If not found, the defaults are copied ‘as is’ into the L4 /L5 incoming buffer.
Arg1	<Config Byte # of Defaults>
Arg2	<Not Used>

AF Number	77
Name	Transfer Network ISUP Raw SS7 Parameters from ISUP Incoming to L4/L5 Outgoing Buffer
Description	Transfers the ISUP incoming ICB to the L4/L5 outgoing buffer.
Arg1	<Not Used>
Arg2	<Not Used>

AF Number	78
Name	Transfer Network Raw Parameters from ISUP Incoming into BCD-Encoded Digits
Description	Searches the ISUP incoming buffer for the Called Party parameter (indicated by Arg1) and the Calling Party parameter (indicated by Arg2). If found, the parameters are translated into BCD encoded digits strings and placed into the L4/L5 outgoing buffer.
Arg1	<Called Number Party ID>
Arg2	<Calling Number>

AF Number	79
Name	Send L4 a Q.931 SETUP using BCD Digits.
Description	Sends L4 a Call Setup using any BCD digit string in the L4/L5 outgoing buffer.
Arg1	<Not Used>
Arg2	<Not Used>

AF Number	80
Name	Send ISUP Setup Request using ISUP Outgoing Buffer
Description	Sends ISUP a Call Setup Request using the SS7 parameters present in the ISUP outgoing buffer.
Arg1	<Not Used>
Arg2	<Not Used>

AF Number	81
Name	Send ISUP Answer Request using ISUP Outgoing Buffer
Description	Sends ISUP an Answer Request using the SS7 parameters present in the ISUP outgoing buffer.
Arg1	<Not Used>
Arg2	<Not Used>

AF Number	82
Name	Send ISUP Release Request using ISUP Outgoing Buffer
Description	Sends ISUP a Release Request using the SS7 parameters present in the ISUP outgoing buffer.
Arg1	<Not Used>
Arg2	<Not Used>

AF Number	83
Name	Send ISUP Release Response
Description	Sends ISUP a Release Response using the SS7 parameters present in the ISUP outgoing buffer.
Arg1	<Not Used>
Arg2	<Not Used>

AF Number	84
Name	Send ISUP Progress Request using ISUP Outgoing Buffer
Description	Sends ISUP a Progress Request using the SS7 parameters present in the ISUP outgoing buffer.
Arg1	<Not Used>
Arg2	<Not Used>

AF Number	85
Name	Send ISUP Alert Request using ISUP Outgoing Buffer
Description	Sends ISUP an Alert Request using the SS7 parameters present in the ISUP outgoing buffer.
Arg1	<Not Used>
Arg2	<Not Used>

AF Number	86
Name	Send ISUP Reset Response
Description	Sends ISUP a Reset response using the SS7 parameters present in the ISUP outgoing buffer.
Arg1	<Not Used>
Arg2	<Not Used>

AF Number	87
Name	Send ISUP Maintenance Block Response
Description	Sends ISUP a Maintenance Block response using the SS7 parameters present in the ISUP outgoing buffer.
Arg1	<Not Used>
Arg2	<Not Used>

AF Number	88
Name	Send ISUP Maintenance Unblock Response
Description	Sends ISUP a Maintenance Unblock response using the SS7 parameters present in the ISUP outgoing buffer.
Arg1	<Not Used>
Arg2	<Not Used>

AF Number	89
Name	Send ISUP Block Request using ISUP Outgoing Buffer
Description	Sends ISUP a Block Request using the SS7 parameters present in the ISUP outgoing buffer.
Arg1	<Not Used>
Arg2	<Not Used>

AF Number	90
Name	Send L4 OOS Span Alarm
Description	Sends Layer 4 an Out of Service due to a span alarm.
Arg1	<Not Used>
Arg2	<Not Used>

AF Number	91
Name	Send ISUP Unblock Request using ISUP Outgoing Buffer
Description	Sends ISUP an Unblock Request using the SS7 parameters present in the ISUP outgoing buffer.
Arg1	<Not Used>
Arg2	<Not Used>

AF Number	92
Name	Send L4 OOS DPC Inaccessible
Description	Sends L4 a a channel status of OOS due to a DPC Inaccessible indication.
Arg1	<Not Used>
Arg2	<Not Used>

AF Number	93
Name	Transfer ISUP Raw SS7 Parameter from ISUP Incoming To L4/L5 Outgoing Buffer
Description	Copies a parameter from the incoming ISUP buffer to the outgoing L4/L5 buffer.
Arg1	<Parameter ID>
Arg2	<Not Used>

AF Number	94
Name	Send L5 Outseize Control ACK
Description	Acknowledges an Outseize Control message with status specified in Arg1.
Arg1	<Status>
Arg2	<Not Used>

AF Number	95
Name	Send L4 Access Denied
Description	Send L4 an Access Denied message with the reason specified in Arg1. The L3 Clear Pending Flag indicates if a Clear is sent to L4.
Arg1	<Reason>
Arg2	<L3 Clear Pending Flag>

AF Number	96
Name	Store Network SS7 Parameters into ISUP Incoming Buffer
Description	Stores any incoming ISUP parameters into the ISUP incoming buffer.
Arg1	<Not Used>
Arg2	<Not Used>

AF Number	97
Name	Pass Return Value
Description	Used to request services as part of a group state machine. Arg1 is used to request different services.
Arg1	<Value> 1 Group Reset 2 Group Block 3 Group Unblock 4 Group Reset Response 5 Group Hardware Block 6 Group Hardware Unblock
Arg2	<Not Used>

AF Number	98
Name	Store ISUP Protocol Violation ICB into L4/L5 Outgoing Buffer
Description	Used to store the information generated by an ISUP protocol violation in the L4/L5 outgoing buffer for transport to the host as part of a protocol violation PPL Event Indication.
Arg1	<Not Used>
Arg2	<Not Used>

AF Number	99
Name	Store ISUP Protocol Violation ICB into L4/L5 Outgoing Buffer
Description	Used to store the information generated by an ISUP protocol violation in the L4/L5 outgoing buffer for transport to the host as part of a protocol violation PPL Event Indication.
Arg1	<Not Used>
Arg2	<Not Used>

AF Number	100
Name	Send ISUP Delete CIC Event
Description	Sends ISUP a delete CIC request which forces a CIC to the unequipped (OOS) state. (Minimum Software Version: 5.0)
Arg1	<Not Used>
Arg2	<Not Used>

AF Number	101
Name	Send ISUP Connect Request using ISUP Outgoing Buffer
Description	Sends ISUP a connect request using the SS7 parameters present in the ISUP outgoing buffer. (Minimum Software Version: 5.0)
Arg1	<Not Used>
Arg2	<Not Used>

AF Number	102
Name	Take CIC Out of Service
Description	Takes the CIC out of service. (Minimum Software Version: 5.0)
Arg1	<Not Used>
Arg2	<Not Used>

AF Number	103
Name	Set Out of Service Operation Flag
Description	The Out of Service Operation Flag determines how the CIC will respond to the next transition from Out of Service to In service. (Minimum Software Version: 5.0)
Arg1	<Flag Value> 0x00 - Unblock 0x01 - Reset
Arg2	<Not Used>

AF Number	127
Name	Test message ID in outseize
Description	This atomic function returns the message ID in the Outseize Control message.
Arg1	<Not Used>
Arg2	<Not Used>
Test AF Results	PPLevINT_EVENT_1, PPLevINT_EVENT_234

AF Number	128
Name	Send CRM to ISUP
Description	Sends a CRM request to ISUP with default parameters from configuration or the parameters sent by the host
Arg1	<Not Used>
Arg2	<Not Used>

AF Number	129
Name	Test ISUP CRM status.
Description	Test the status value in the ISUP_CRM_STATUS message.
Arg1	<Not Used>
Arg2	<Not Used>
Test AF Results	Status event ranging from PPLevINT_EVENT_1 to PPLevINT_EVENT_255

AF Number	130
Name	Send IAM request to ISUP.
Description	Send IAM request to ISUP after Circuit Reservation.
Arg1	<Not Used>
Arg2	<Not Used>

AF Number	134
Name	Cic_af_129
Description	Send busy out request to EX/CPU.
Arg1	<Not Used>
Arg2	<Not Used>

Atomic Function	Description	Arguments
		Arg1 (range)	Arg2 (range)
109	Send msg. to ISUP CCR	--	--
110	Send msg. to SYM	--	--
111	Send msg. to ISUP CCO	--	--
112	Check for Positive status	--	--
113	Send msg. to ISUP DCO	--	--
114	Send ISUP CRCS ACK. msg. (ITU only)	--	--
115	Send ISUP CRCS CPA result (ITU only)	--	--
116	Send ISUP CRCS stop (ITU)	--	--
117	Send ISUP CRO stop (ANSI)	--	--
118	Send SYM Connect Tone msg.	--	--
119	Send ISUP DCO CPA result	--	--
120	Send ISUP CCO CPA result	--	--
121	Send ISUP msg. Req. using outgoing buffer	Event ID (1 : 78)	--
122	Validate and assemble msg. using config. table in L5 incoming buffer	Cfg. table entry (1 : 50)	--
123	Test message ID in PAM	--	--
124	Send L5 Event Ind. without data	Event ID. (1 : 255)	--
125	Send ISUP CVT request	msg. offset (1 : 255)	--
126	Send ISUP CVT req. for User part test	msg. offset (1 : 255)	--

AF Number	160
Type	Normal
Name	Copy CDPN digits to Digit_Buffer.
Description	This function will parse through the incoming setup message for the CDPN parameter. When it finds the parameter, it will copy the address signals in the parameter to the Digit_Buffer in the RW area and update the Number_of_Digits parameter in the RW area.
Arg1	<Not Used>
Arg2	<Not Used>
Test AF Results	<Not Used>

AF Number	162
Type	Normal
Name	Append digits received in SAM to Digit_Buffer.
Description	This function will parse through the incoming SAM for the Subsequent Address Parameter. This will append the digits in the Subsequent Address Parameter to the Digit_Buffer in the RW area, and update the Number_of_Digits parameter to reflect the new total.
Arg1	<Not Used>
Arg2	<Not Used>
Test AF Results	<Not Used>

AF Number	163
Type	Normal
Name	Copy digits from Digit_Buffer to ISUP incoming buffer.
Description	This function will copy the digits from the Digit_Buffer to the CDPN parameter in the stored ISUP SETUP message. It will also update the CDPN parameter to reflect the increased length and also update the "Odd/Even" indicator field.
Arg1	<Not Used>
Arg2	<Not Used>
Test AF Results	<Not Used>

AF Number	164
Type	Normal
Name	Check the digits in the Digit_Buffer.
Description	This function will compare the number of digits received with the maximum number of digits to be received. It will also check whether the maximum number of digits can be collected. This is indicated by the fact that the size of the config byte is greater than the normal size of the Digit_Buffer (40 bytes).
Arg1	Configuration byte offset
	Input range: 0-600
Arg2	<Not Used>
Test AF Results	<Not Used>