L3P Call Control (0x0005) Atomic Functions

You are here: PPL Developer’s Guide > 7 ISDN Atomic Functions > L3P Call Control (0x0005) Atomic Functions

This section describes the atomic functions for the L3P Call Control PPL component.

L3P Call Control Atomic Functions

The following atomic functions are specific to the ISDN L3P Call Control PPL component.

AF Number	51
Name	Load Raw IE in L4 Buffer
Description	Loads a raw IE received from the distant end into a Raw IE ICB (0x11) to be sent to the host in a PPL Event Indication or PPL Event Request message for service with address data. If the IE is not received, then nothing is loaded.
Arg1	<IE Value> 0-255 (ITU-T Q.931 codeset 0)
Arg2	<Not Used>

AF Number	52
Name	Load Formatted and Raw IEs in L4 Buffer
Description	Loads the formatted IE ICB subtype (0x10) and the raw IE type (0x11) with the IEs received. The supported formatted IEs can be loaded and all other IES are included as raw in the Raw ICB. Eventually, you must invoke an atomic function to send this information.
Arg1	<Not Used>
Arg2	<Not Used>

AF Number	53
Name	Copy Raw IEs into L4 Buffer
Description	Copies received IEs into the Raw IE ICB subtype (0x11) for sending at a later time.
Arg1	<Not Used>
Arg2	<Not Used>

AF Number	54
Name	Purge B Channel and Send Clear to L3
Description	Deletes all timers and frees DSP resources per B channel. Then, it releases the call to Layer 3.
Arg1	<Not Used>
Arg2	<Not Used>

AF Number	55
Name	Load Formatted IEs into L4 Buffer
Description	Loads specific formatted IEs into a formatted IE subtype (0x10) for later reporting to the host.
Arg1	<Formatted IE Type> 1-50
Arg2	<Not Used>

AF Number	56
Name	Test if IE Exists in L4 Message
Description	Tests for an existing IE in a Layer 4 message for PPL Event Request and Outseize Control.
Arg1	<IE Type> 0-255
Arg2	<Not Used>

AF Number	57
Name	Send BSM CR Purge Indication
Description	Sends the BSM (component 7) a purge indication that should return the In-Service DS0 Status Change to the host.
Arg1	<Not Used>
Arg2	<Not Used>

AF Number	58
Name	Send Purge Indication to L4
Description	Sends an L3P initiated purge to Layer 4.
Arg1	<Purge Value> 0-255
Arg2	<Not Used>

AF Number	61
Name	Load L4 IEs in Sorted Order
Description	Translates formatted and raw IEs to be sent to Layer 3 in sorted order.
Arg1	<Not Used>
Arg2	<Not Used>

AF Number	62
Name	Load L4 Formatted IEs to L3 Buffer
Description	Loads just the formatted IEs into a buffer to Layer 3. These would be inserted by host in the PPL Event Request and the Outseize Control.
Arg1	<Not Used>
Arg2	<Not Used>

AF Number	63
Name	Load L4 Raw IEs to L3 Buffer
Description	Loads the Layer 4 Raw IEs into a buffer to send to Layer 3 at a later time.
Arg1	<Not Used>
Arg2	<Not Used>

AF Number	65
Name	PPL Send Host PPL Event Indication
Description	Sends a PPL Event Indication to host. If a previous atomic function’s loaded Layer 3 IEs to go to Layer 4, then they also get sent.
Arg1	<Event ID> 1-255
Arg2	<Not Used>

AF Number	66
Name	Test L3 Error Indication and Map to Internal Event
Description	If the previous event was a Layer 3 Error Indication, the error is added to the internal event base and returned. The state that follows this error should be an internal state to test the value.
Arg1	<Not Used>
Arg2	<Not Used>

AF Number	68
Name	Test # of Stored Digits
Description	Test if the # of stored digits is less than or equal to the value in Arg1.
Arg1	<# of Digits> See AF 84
Arg2	<Not Used>

Test Result	PPL Internal Event
<=	1
Other	0

AF Number	69
Name	Test if IEs Exist in L3 Message
Description	Tests to see if the IE indicated by Arg1exists in a Layer 3 message.
Arg1	<IE ID> 0-255 (ITU-T Q.931 codeset 0 IE value)
Arg2	<Not Used>

Test Result	PPL Internal Event
Exists	1
Does not exist	0

AF Number	70
Name	Load IE Library IE
Description	Copies previously stored IEs in the IE Library into the buffer to Layer 3.
Arg1	<IE Library Index> 0-30
Arg2	<Not Used>

AF Number	71
Name	Test if Stored Digits Equals Config Byte Value
Description	Tests to see if # of stored digits is less than or equal the value in Arg1.
Arg1	<Config Byte>
Arg2	<Not Used>

Test Result	PPL Internal Event
<=	1
Other	0

AF Number	72
Name	Test For Sending Complete Indication
Description	Tests to see if there is a Sending Complete Indication message.
Arg1	<Not Used>
Arg2	<Not Used>

Test Result	PPL Internal Event
Yes	1
No	0

AF Number	73
Name	Load Cause Code IE
Description	Copies the Cause Code indicated in Arg1 into a buffer to send to L3.
Arg1	<Cause Code>
Arg2	<Not Used>

AF Number	74
Name	Test First Data ICB in Outseize Control Message
Description	Tests the first Data ICB subtype in the Outseize Control message. This lets the Layer 3 Plus protocol distinguish the BCD encoded format for sending the information, and the formatted and raw subtypes. The returned code is the internal event for the value.
Arg1	<Not Used>
Arg2	<Not Used>

AF Number	75
Name	Translate Network-specific IE from B Channel Option
Description	Looks into channel previously configured options (B Channel Configure) and creates and copies the network-specific IE in the buffer to Layer 3. This atomic function is not needed if the host includes this information in the Outseize Control message.
Arg1	<Not Used>
Arg2	<Not Used>

AF Number	76
Name	Translate Bearer Capability IE from B Channel Option
Description	Looks into channel previously configured options (B Channel Configure) and creates and copies the Bearer Capability IE in the buffer to Layer 3. This atomic function is not needed if the host includes this information in the Outseize Control message.
Arg1	<Not Used>
Arg2	<Not Used>

AF Number	77
Name	Load Outseize Control Address Digits to Q.931 IEs
Description	Takes the BCD encoded stage digits from the Outseize Control and creates the Called Party IE and loads it in a buffer to send to Layer 3.
Arg1	<Not Used>
Arg2	<Not Used>

AF Number	78
Name	Send Outseize Control Ack
Description	Sends an Outseize Control ACK.
Arg1	<Value> 0-255
Arg2	<Not Used>

AF Number	80
Name	Send L3 to L4 SETUP Indication Using BCD-Encoded Stages
Description	Extracts Layer 3 SETUP information to load called and calling party digits in the Request for Service with Address Data message.
Arg1	<Not Used>
Arg2	<Not Used>

AF Number	81
Name	Send L3 to L4 SETUP Indication Exact L3 Frame
Description	Sends the exact received frame for the SETUP message to the host in the Request for Service with Data message.
Arg1	<Not Used>
Arg2	<Not Used>

AF Number	82
Name	Test Bit Mask in Specified Byte Offset Of IE in L2 to L3 Message
Description	Tests any set of bits in any byte of an IE in a message from L3.
Arg1	<IE ID>
Arg2	<Byte Offset/Bit Mask> Byte Offset (MSB)/Bit Mask (LSB)

AF Number	83
Name	Test for Sufficient Digits In Stored Called Party IE Buffer
Description	Verifies that there are sufficient digits in the Called Party IE Buffer. The number of significant digits is indicated in Config Byte 10. NOTE: This atomic function applies to Euro ISDN only
Arg1	<Not Used>
Arg2	<Not Used>

AF Number	85
Name	Store Called Party IE Digits
Description	Stores the Called Party digits from the Called Party IE in a SETUP or INFORMATION message from L3 into the Overlap Receive buffer. See AF 68 and AF 71.
Arg1	<Not Used>
Arg2	<Not Used>

AF Number	86
Name	Send INFO Requests in Overlap Mode
Description	Sends Called Party digits in continuous INFORMATION messages to L3 with one Called Party digit per message. This function should only be used for testing. The Call Type must be set to 1 (Called Party digits are in Call Type ICB) using the Call Type ICB in the Outseize Control message.
Arg1	<Not Used>
Arg2	<Not Used>

AF Number	87
Name	Test Call Type
Description	Tests the Call Type obtained from the Call Type ICB sent in an Outseize Control message.
Arg1	<Not Used>
Arg2	<Not Used>