L3P BT IUP (0x0011)

 

This section documents the atomic functions associated with L3P BT IUP.

AF Number

160

Name

Send L3 an equip circuit request.

Description

This function will send an equip message to L3 (i.e. iupcpc).

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

Message is queued for L3

Returns

Success always

AF Number

161

Name

Out of Service atomic function to restore the In-Service Protocol

Description

This function will restore the Primitive table and Event tables to point to the In-Service protocol, and the Protocol ID to the In-Service Protocol ID. The function exits with a status allowing the calling function, in message preprocessor file, to force the In-Service protocol to the desired state.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

See Description.

Returns

PPLerrSET_SM_STATE

AF Number

162

Name

Out of Service atomic function to restore the In-Service Protocol

Description

This function will check for congestion in the outbound direction.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

PPLevINT_EVENT_1 if Output Congestion is detected; PPLevINT_EVENT_0 otherwise

Returns

Success always

AF Number

170

Name

Validate L4/L5 Message

Description

This function will validate any message which originates from L4 or L5. Messages which contain IUP ICBs are validated and completed using the default information contained in the configuration byte area.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

The internal "down working" buffer will contain a valid TLV formatted message, if Success is returned.

The PPLevINT_EVENT_1 is set if successful, otherwise PPLevINT_EVENT_0 is returned.

Returns

Success always

AF Number

171

Name

Send PPL Event Indication SSM to L5

Arg1

<Not Used>

Arg2

<Not Used>

Returns

Success always

AF Number

172

Name

Send PPL Event Indication SER to L5

Arg1

<Not Used>

Arg2

<Not Used>

Returns

Success always

AF Number

173

Name

Send PPL Event Indication ECM to L5

Arg1

<Not Used>

Arg2

<Not Used>

Returns

Success always

AF Number

174

Name

Send PPL Event Indication CFC to L5

Arg1

<Not Used>

Arg2

<Not Used>

Returns

Success always

AF Number

175

Name

Send PPL Event Indication OOR to L5

Arg1

<Not Used>

Arg2

<Not Used><Not Used>

Returns

Success always

AF Number

176

Name

Send PPL Event Indication HLR to L5

Arg1

<Not Used>

Arg2

<Not Used>

Returns

Success always

AF Number

177

Name

Send PPL Event Indication SIM to L5

Arg1

<Not Used>

Arg2

<Not Used>

Returns

Success always

AF Number

178

Name

Send REL with Reason in REG to L3

Arg1

Register number containing the Release Reason

Arg2

<Not Used>

Returns

Success always

AF Number

179

Name

Send CAN with Reason in REG to L3

Arg1

Register number containing the Release Reason

Arg2

<Not Used>

Returns

Success always

AF Number

180

Name

Set Timer associated value

Description

Associates a value with one of the three timers. Later when the timer expires the value may be retrieved to determine the current usage of the timer and take the appropriate action.

Arg1

Timer number Range 1 thru 3

Arg2

Associated value

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

200

Name

Send IAM to L3

Description

This function will send the IAM message to L3. The IAM message is either taken from the "down working" buffer or if the down working buffer is empty, the IAM is taken from the Configuration Byte area.

Arg1

<Not Used>

Arg2

<Not Used>

Returns

Success always

AF Number

201

Name

Send IFAM to L3

Description

This function will send the IFAM message to L3. The IFAM message is either taken from the "down working" buffer or if the down working buffer is empty, the IFAM is taken from the Configuration Byte area.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

202

Name

Send FAM to L3

Description

This function will send the FAM message to L3. The FAM message is either taken from the "down working" buffer or if the down working buffer is empty, the FAM is taken from the Configuration Byte area.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

203

Name

Send SAM to L3

Description

This function will send the SAM message to L3. The SAM message is either taken from the "down working" buffer or if the down working buffer is empty, the SAM is taken from the Configuration Byte area.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

204

Name

Send REL to L3

Description

This function will send the REL message to L3. The REL message is either taken from the "down working" buffer or if the down working buffer is empty, the REL is taken from the Configuration Byte area.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

205

Name

Copy up working buffer to save buffer.

Description

This function will free the save buffer, if required. Allocate a new save buffer and copy the up working buffer into the save buffer.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

206

Name

Append up working buffers’ TLVs onto save buffer.

Description

This function will check to see that a save buffer has been allocated. (If not, this function will cause a channel purge.) Copy any TLVs in the up working buffer to the save buffer.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success or PPLerrAF_INITIATED_PURGE

AF Number

207

Name

Swap up working buffer ptr with save buffer ptr

Description

This function will just sway the up working buffer ptr with the save buffer ptr.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

208

Name

Send SND to L3

Description

This function will send the SND message to L3. The SND message is either taken from the "down working" buffer or if the down working buffer is empty, the SND is taken from the Configuration Byte area.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

209

Name

Send CNA with Reason to L3

Description

This function will send a copy of the CNA message stored in the config byte area to L3. Arg1 is used to specify the reason value.

Arg1

Reason

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

210

Name

Send ACM to L3

Description

This function will send the ACM message to L3. The ACM message is either taken from the "down working" buffer or if the down working buffer is empty, the ACM is taken from the Configuration Byte area.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

211

Name

Send ACI to L3. The "down working " buffer must be contain the ACI message to be sent.

Description

This function will send the ACI message to L3

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success if the down working buffer contains a message. Otherwise, the channel will be purged.

AF Number

212

Name

Send REL with Reason to L3

Description

This function will send the REL message to L3 with Arg1 containing the reason.

Arg1

Reason

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

213

Name

Send ANS to L3

Description

This function will send the ANS message to L3. The ANS message is either taken from the "down working" buffer or if the down working buffer is empty, the ANS is taken from the Configuration Byte area.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

214

Name

Send UNDEFINED message to L3

Description

This function will send the a message contained in the Generic TLV Entry Data or a message beginning with a unknown H0,H1 value within the H0,H1 Element TLV to L3.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success if the down working buffer contains a message. Otherwise, the channel will be purged.

AF Number

215

Name

Send ACI to L3 of user defined type

Description

This function will send the specified ACI type message from the config byte area to L3.

Arg1

Desired ACI message type. Range 1 through 7

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success if a valid ACI message type is specified. Otherwise, the channel will be purged.

AF Number

216

Name

Load requested ACI info from Config Bytes.

Description

This function will send the requested ACI type message from the config byte area to L3. The requested info is expected in an ACI type 7 message contained in the up working buffer.

Supported ACI Information Request Codes are 1 through 9 , 11, and 12.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

PPLevINT_EVENT_1 if the ACI message is a type 7 Information Request. Otherwise, it will return PPLevINT_EVENT_0.

Returns

Success if a valid ACI message type is specified. Otherwise, the channel will be purged.

AF Number

217

Name

Copy L3 message into Up Working Buffer

Description

This function will copy an incoming message form L3 into the up working buffer for use by L3P and possibly higher layers.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

218

Name

Send BLO to L3

Description

This function will send a Block message to L3. . The BLO message is either taken from the "down working" buffer or if the down working buffer is empty, the BLO is taken from the Configuration Byte area.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

219

Name

Send UBL to L3

Description

This function will send a Unblock message to L3. The UBL message is either taken from the "down working" buffer or if the down working buffer is empty, the UBL is taken from the Configuration Byte area.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

220

Name

Send an ACI type 7 Request message to L3 with user defined IRC type

Description

This function will send an ACI type 7 message to L3 with the Information Request Code specified in Arg1.

Arg1

The Information Request Code. Range 1 through 12 Except 3, 4, 10.

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success if Arg 1 is valid. Otherwise, the channel is purged.

AF Number

221

Name

Send PPL Event Indication to the Host with event specified in the register.

Description

This function will send a PPL Event Indication to the Host. Arg1 specifies the register containing the event.

Arg1

The Register number which contains the event to be reported.

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

222

Name

Set OOS op Flag to the user specified value

Description

This function will set the Out Of Service operation flag.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

223

Name

L3PIUP Take CIC OOS

Description

This function will Cause an L3P reset to occur.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

With a status of PPLerrAF_INITIATED_RESET

AF Number

224

Name

L3PIUP Test OOS OP Flag

Description

This function will setup a PPL internal event corresponding to the value of the Operation Flag.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

With a status of PPLevINT_EVENT_0 + the value of the Operation Flag

AF Number

225

Name

L3PIUP Send Unequip message to L3

Description

This function will send an unequip message to L3

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

226

Name

L3PIUP Generated In-Service event

Description

This function will send a Transition to In-Service message to L3P.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

227

Name

Send A CFN Event to L3

Description

This function will send a CFN event to L3.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

229

Name

Send A PPL Event Indication of ANS received before ACM to L5

Description

This function will send the above PPL Event Indication to L5.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

230

Name

Send Access Denied to L4

Description

This function will send the Access Denied message to L4.

Arg1

Reason for denying access

Arg2

Call Status 0=Call Inactive, 1=Call Active

Outputs

<Not Used>

Returns

Success always

AF Number

231

Name

Send PPL Event Indication to L5 if enabled by the corresponding Config Byte.

Description

This function will send a PPL Event Indication to L5 if the corresponding Config byte has been enabled to allow a PPL Event Indication to be issued.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success and PPLevINT_EVENT_1 PPL Event Indication was sent. Otherwise, it is a PPLevINT_EVENT_0.

AF Number

232

Name

Test if IUP ICB is Present

Description

This function will test to see if an IUP ICB is present in the message.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success and a PPLevINT_EVENT_1. Otherwise, it is a PPLevINT_EVENT_0.

AF Number

233

Name

Test if Stage N Address Data ICB is present

Description

This function will test to see if a Stage N Address Data ICB is present in the message.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success and a PPLevINT_EVENT_1. Otherwise, it is a PPLevINT_EVENT_0.

AF Number

234

Name

Send Cut Through to L4

Description

This function will send a Cut Through message to L4.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

235

Name

Send Connect to L4

Description

This function will send a Connect message to L4.

Arg1

<Not Used>

Arg2

<Not Used><Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

236

Name

Send Disconnect to L4

Description

This function will send a Disconnect message to L4.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

237

Name

Send Clear Request to L4

Description

This function will send a Clear Request message to L4.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

238

Name

Test and Get Call Type ICB

Description

This function will test to see if a Call Type ICB is present in the message and if so, get the call type byte.

Arg1

Register number to contain the Call Type byte if one is present

Arg2

<Not Used>

Outputs

PPLevINT_EVENT_0 = No Call Type byte present, PPLevINT_EVENT_1 = Call Type byte is present.

Returns

Success always

AF Number

239

Name

Setup Multi Purpose Timer 18 based upon No. Digits Requested and the Exchange Type.

Description

This function will setup the timeout value for timer 18 to a value based upon the number of digits required (in the register specified by Arg1) and the Exchange Type (in the register specified by Arg2).

Arg1

A register containing the number of digits requested in a SND message

Arg2

A register containing the Exchange Type. 0 = Terminating, 1 = Intermediate

Outputs

<Not Used>

Returns

Success if valid input arguments. Otherwise, the channel is purged.

AF Number

240

Name

Test and Get ptr to TLV in specified buffer

Description

This function will examine the up or down working buffer to see if the IUP ICB contains the requested TLV.

Arg1

The requested TLV ID

Arg2

The buffer to check 0 = Upworking Buffer, 1 = Downworking Buffer

Outputs

PPLevINT_EVENT_1 if the TLV is located and an internal variable is setup pointing to the located TLV. Otherwise, PPLevINT_EVENT_0 is returned.

Returns

Success always

AF Number

241

Name

Test and Get TLV byte into register

Description

This function will get the specified byte from the working buffer containing a TLV of interest, and copy it into the specified register.

Arg1

The number of the byte to fetch (Range 1 to 256), Beginning with the first data byte.

Arg2

The number of the register to contain the requested byte

Outputs

If successful PPLevINT_EVENT_1 is returned, Otherwise, the specified register is cleared and PPLevINT_EVENT_0 is returned.

Returns

Success always

AF Number

242

Name

Get Config byte into GPR 10

Description

This function will get the specified configuration byte into General Purpose Register 10.

The user specifies the configuration byte by Block number and Byte number.

Arg1

The Block number containing the byte. (Range 1 to 3)

Arg2

The offset to the desired byte. (Range 1 to 200)

Outputs

If successful PPLevINT_EVENT_1, otherwise PPLevINT_EVENT_0 is returned.

Returns

Success always

AF Number

243

Name

Arg1:GPR = Arg1:GPR – Arg2:GPR

Description

This function will subtract the contents of the register specified in Arg2 from the contents of the register specified in Arg1. The results are stored in register specified in Arg1.

Arg1

Any GPR

Arg2

Any GPR

Outputs

PPLevINT_EVENT_0 if the resulting contents of GPR specified in Arg1 is < 0 (i.e Arg2 > Arg1)

PPLevINT_EVENT_1 if the resulting contents of GPR specified in Arg1 is > 0 (i.e. Arg1 > Arg2)

PPLevINT_EVENT_2 if the resulting contents of GPR specified in Arg1 is 0 (i.e. Arg1 = Arg2)

Returns

Success always

AF Number

244

Name

Form SND message using GPR value for N

Description

This message will format a SND message in TLV format using the contents of the register specified in Arg1 as the N value. (i.e. the number of digits requested). The SND message is either taken from the "down working" buffer or if the down working buffer is empty, the SND is taken from the Configuration Byte area.

Arg1

The number of a register containing the number of digits requested.

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

245

Name

Append accumulated addressed digits into Up Working buffer.

Description

This function will insert the original IAM message into the upworking buffer with the total accumulated address signals from the original IAM and subsequent SAM or FAM message.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success, If a previous IAM was not received the channel is purged.

AF Number

246

Name

Arg1:GPR = Arg1:GPR + Arg2:GPR

Description

This function will add the contents of the register specified in Arg2 to the contents of the register specified in Arg1. The results are stored in register specified in Arg1.

Arg1

Any GPR

Arg2

Any GPR

Outputs

<Not Used>

Returns

Success always

AF Number

247

Name

Save Address Digits

Description

This function will save the received address digits (form a IAM or IFAM) into an internal buffer. The contents of the internal buffer are overwritten with the new address digits.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

248

Name

Append Address Digits

Description

This function will append the digits received from a SAM or FAM to internal buffer containing previously saved address digits.

Arg1

The number of a General Purpose Register to contain the total number of address digits collected for this call.

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success, Otherwise, PPLerrAF_INITIATED_PURGE if no digits were previously saved.

AF Number

249

Name

Form ICB Setup message for L4

Description

This function will form a setup message for L4 in ICB format.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success or PPLerrAF_INITIATED_PURGE if up working buffer is not valid.

AF Number

250

Name

Form BCD Setup message for L4

Description

This function will form a setup message for L4 in BCD format.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success or PPLerrAF_INITIATED_PURGE if up working buffer is not valid.

AF Number

251

Name

Send Formatted Setup message to L4

Description

This function will send the formatted message created by (Form ICB Setup message for L4 or Form BCD Setup message for L4) and send it to L4.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

252

Name

Send PPL Event Indication ACI to L5

Description

This function will send a PPL Event Indication of ACI to L5.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

253

Name

Send PPL Event Indication SAM to L5

Description

This function will send a PPL Event Indication of SAM to L5.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

254

Name

Send PPL Event Indication FAM to L5

Description

This function will send a PPL Event Indication of FAM to L5.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

255

Name

Send NACK or ACK to L5

Description

This function will send a ACK or NACK to L5 based upon the contents of Arg1.

Arg1

0 = NACK, 1 = ACK

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

256

Name

L3PIUP Send Response to Outseize Control Message

Description

This function will send an response to L5 with a status specified in Arg1.

Arg1

The value to be sent in the status field of the message

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

257

Name

Send PPL Event Indication UNDEFINED Msg to L5

Description

This function will send a PPL Event Indication of UNDEFINED message to L5.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

258

Name

Send PPL Event Indication Circuit already Blocked to L5

Description

This function will send a PPL Event Indication to L5.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

259

Name

Send PPL Event Indication Call Connected to L5

Description

This function will send a PPL Event Indication of Call Connected to L5.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

260

Name

Send PPL Event Indication SND to L5

Description

This function will send a PPL Event Indication of SND to L5.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

261

Name

Form IFAM from Stage N Address Data ICB

Description

This function will format an IFAM TLV message from a Stage N Address Data ICB message.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

If successful PPLevINT_EVENT_1 is returned, otherwise PPLevINT_EVENT_0.

Returns

Success or Failure

AF Number

262

Name

Send PPL Event Indication of Circuit NOT Blocked to L5

Description

This function will format a PPL Event Indication to L5.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

263

Name

Send PPL Event Indication of Error Timer Expired, Sending CNA to L5

Description

This function will format a PPL Event Indication to L5.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

264

Name

Send PPL Event Indication to host

Description

This function will format a PPL Event Indication message using the Arg1 value as the event, and send it to the host.

Arg1

The event.

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

265

Name

PURGE CHANNEL

Description

This function will cause the Channel to be Purged, with the reason specified in Arg1.

Arg1

The purge reason

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

266

Name

Send PPL Event Indication CFN to L5

Description

This function will send a PPL Event Indication of CFN to L5. In addition if a buffer is present

in the m_message it will be sent also.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

267

Name

Send PPL Event Indication No Response to ACI Request to L5

Description

This function will send a PPL event Indication to the L5 when timer 2 (i.e. TO-14) expires due to not receiving any ACI response from an ACI request.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

268

Name

Send PPL Event Indication of CNG to L5

Description

This function will send this indication to L5.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

269

Name

Send PPL Event Indication of CNA to L5

Description

This function will send this indication to L5.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

270

Name

Send PPL Event Indication of RAM to L5

Description

This function will send this indication to L5.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

271

Name

Send PPL Event Indication of SEM to L5

Description

This function will send this indication to L5.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

272

Name

Send PPL Event Indication of SAD to L5

Description

This function will send this indication to L5.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

273

Name

Send PPL Event Indication of SASUI to L5

Description

This function will send this indication to L5.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

274

Name

Send PPL Event Indication of ASUI to L4

Description

This function will send this indication to L5.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

275

Name

Send PPL Event Indication of No response to SASUI request

Description

This function will send a PPL Event Indication to the L5 when Timer 2 (i.e. TO-14) expires due to not receiving any ASUI response from an SASUI request.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

276

Name

Load Requested ASUI info from Config Bytes

Description

This function will form the appropriate ASUI message into the down working buffer based upon the SASUI request in the up working buffer.

The ASUI message is taken from the Config byte area.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

If it is a valid request PPLevINT_EVENT_1, otherwise PPLevINT_EVENT_0.

Returns

Success always

AF Number

277

Name

Send ASUI to L3

Description

This function will send an ASUI message to L3.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

278

Name

Send SASUI to L3

Description

This function will send a SASUI message to L3.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

279

Name

Send SASUI request message to L3, with user defined type

Description

This function will send a SASUI message to L3, of the type specified in Arg1.

Arg1

The Type of ASUI message to be returned (range 0 to 255). Only 1 is currently valid.

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

280

Name

Force sending an ACM message to L3

Description

This function will dynamically build and send an ACM message to L3. The contents of the down working buffer are not accessed or disturbed.

Arg1

 

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

281

Name

Set Remote Maintenance Blocking State

Description

This function will allow the user to set the Remote Maintenance Blocking state.

Input Argument 1

0 = Unblocked, 1 = Blocked

Input Argument 2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

282

Name

Set Local Maintenance Blocking State

Description

This function will allow the user to set the Local Maintenance Blocking state.

Input Argument 1

0 = Unblocked, 1 = Blocked

Input Argument 2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

283

Name

Test Blocking State

Description

This function will allow the user to Test any of the following local or remote blocking states. Maintenance, Hardware, and Software.

Input Argument 1

Blocking Location. 0 = Local, 1 = Remote

Input Argument 2

Blocking Type. 0 = Maintenance, 1 = Hardware, 2 = Software.

Outputs

If blocked PPLevINT_EVENT_1 is returned, otherwise PPLevINT_EVENT_0.

Returns

Success always

AF Number

284

Name

Send SAD to L3

Description

This function will send a SAD message to L3.

Input Argument 1

<Not Used>

Input Argument 2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

285

Name

Test Accumulated Digits against Config Byte Digits

Description

This function compares n digits of the accumulated digits string with the digit string contained in the config byte area, at the specified config block and byte number. If the config byte string contains a digit of F that digit is skipped, in the config byte area and the accumulated digit string area.

NOTE: The digit to begin comparison, within the accumulated digit string is set by the value in register 20.

Arg1

The Config byte block number. Range 1 through 3

Arg2

The byte number within the above block. Range 1 through 200

Outputs

PPLevINT_EVENT_0 if match fails. Or the config bytes exceed

the size block limit. PPLevINT_EVENT_1 if match succeeds

Returns

Success always

AF Number

286

Name

Test Accumulated Digits against Immediate Value

Description

This function compares from 1 to 4 digits of the accumulated digits string with the digit string contained in Arg2. If a nibble within Arg2 contains an F that digit is skipped.

NOTE: The starting digit within the accumulated digit string is set by the value in register 20.

Arg1

The number of bytes present in Arg2 to check. (range 1 to 4)

Arg2

The digits to validate against the accumulated buffer.

NOTE: A value of 0x4321 would attempt to match a 1 against the first digit in the accumulated digit string, a 2 against the second digit, a 3 against the third...

Outputs

PPLevINT_EVENT_0 if match fails. Or the config bytes exceed

the size block limit. PPLevINT_EVENT_1 if match succeeds

Returns

Success always

AF Number

287

Name

Send Alarm Msg to Host

Description

This function will send an ALARM message to the Host using the user defined Severity, Entity, and Alarm values. Please refer to ALARM.H for normal values for these elements.

Arg1

High byte Severity, Low byte Entity

Arg2

Alarm Value

Outputs

Alarm message is sent to L5

Returns

Success always

AF Number

288

Name

Set OOS Reason

Description

This function will Set the Out Of Service Reason to the value specified in Arg1.

Arg1

OOS reason.

Arg2

<Not Used>

Outputs

...rw->unique_to.l3p_tup.oos_reason = Arg1

Returns

Success always

AF Number

289

Name

Send Purge Message to L4

Description

Just sends the Purge Message to L4.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always

AF Number

290

Name

Clear Up Working Buffer Ptr

Description

This function will free the buffer attached to the up_working_buffer_ptr, if present.

Arg1

<Not Used>

Arg2

<Not Used>

Outputs

up_working_buff_ptr is set to NULL.

Returns

Success always

AF Number

291

Name

Set the In-Service_startup_flag to value in Arg1.

Description

This function will set the read write variable "inservice_startup_flag" to the value suPPLied in Arg1.

Arg1

Value.

Arg2

<Not Used>

Outputs

...inservice_startup_flag = value.

Returns

Success always

AF Number

292

Name

Get the In-Service_startup_flag value into register

Description

This function will load the contents of In-Service_startup_flag variable into the register specified in Arg1.

Arg1

Register to contain the value of inservice_startup_flag.

Arg2

<Not Used>

Outputs

<Not Used>

Returns

Success always