ACC Programmer’s Reference Guide
Page
Legal Notices
Page
Printing History
First Edition February 2004 Release
Related Documentation
Software Manuals
Contents
Zcom C I/F Library Routines
Contents
Contents
Zcom Subsystem
Introduction
Zcom Software Overview
Overview of Zcom Software Structure
Zcom Subsystem Components
Zcom Software Overview
Zcom Concepts
Definition and Features of ZLUs
Program ZLUs
Zcom Concepts
User Interface
References
Zcom Message Handling
Overview
ZLU Definition
Mapped ZLUs
Message Queuing
Program Message Queueing
Physical Terminal Table
Priorities
Multiplexing
Outbound Multiplexing
Inbound Multiplexing
Inbound Multiplexing
PTZRVR=PZLU
Terminal State
Terminal State
Error Handling
Error Handling Chapter
Zcom Tables and Data
Zcom Tables and Data Structures
Memory Organization
Memory Organization
Differences in 32-bit and 64-bit Data Structures
ACC Zcom product to implement its functionality. These data
Zcom Header Structure
Zcom Header Structure
Field Name Field Description Field Type Size Bytes
Hnltql
Hncard
Hnresp
Hnltsl
Hnidle
Hndpid
Hndsig
Hnhigh
Zcom Header Structure
Zcom Header Structure
Zcom Header Structure
Zcom Header Structure
Zcom Header Structure
Ttgen
Zcom Header Structure
Qlbnam
Queue Label Table
Qlbgrp
Qlbqnb
Storage Label Table
Zcom Header Structure
Node Entries Table
Node Entries Table
FLAGS.valid
Stats Data Structure
FLAGS.event
FLAGS.status
Host Link Information Structure
Node Entries Table
ZLU Tables
Individual ZLU Data Structure zlutype
ZLU Type Values
Type Description
ZLU Tables
Logical Terminal Tables
Logical Terminal Table Reserved Area
Field Name Field Description Size Type Bytes
Logical Terminal Table User Maintainable Area
10 Logical Terminal Table User Maintainable Area
SPARE2
System Status flags
Logical Terminal Tables
LTCWCT, LTTXCT, LTRXCT, Lterct Message and error counters
Logical Status Format Ltstat
LTINST, LTBRCH, LTWORK, Ltarea Terminal logical ID
Physical Terminal Tables
Physical Terminal Tables System Area
Physical Terminal Tables User Maintainable Area
Ptuser
Physical Terminal Tables
Physical Terminal Tables
Physical Terminal Tables
Terminal Status Field Ptdrst
Physical Terminal Tables
Physical Terminal Tables
Interface Table
Interface Table
Imaxterms
Iportn
Interface HPA Value Format Inhpa
63-32 31-2 27-18 17-1 13-12 10-6
Symbol Value hex Meaning
Interface Card Status Ifstat
Scheduler Event Flags Ischdl
Interface Table
Interface Table
CARD.MMP Structure
CARD.BSP Structure
Interface Table
Itxlstx Express Transmit List Headers
Tmtail
Interface Table
Zcomipstattxbx
Port Configuration Buffer Iportn
20 4-Channel E1/T1 ACC Card Format
31-30 29-26 26-22 21-20 19-16 15-11 10-0
Fmode
Port Subchannel Configuration Structure
Timeslot Array Element Structure
Itbs
23 Subchannel Specification Array Element Structure
31-30 29-24 23-8
INV
Interface Table
Optional E1/T1 Tunable Parameters
Bquota
Response Records
Response Record Format
Zcomrptypebuffer
Symbol Value Meaning
Response Type Field
Zcomrptyperemote
100
Queue Header
Free Queue Header Structure zfqhtype
Qfdata
Queue Header Structure zqhdtype
Qlimit
Qfunc
Chapter 103
Symbol Value Meaning Hex
Queue Flag Format
Chapter 105
Data Buffer Pool
Organization of Buffer Pool
Chapter 107
Buffer Pool Layout when first initialized
Reserved, not used Int
Linkage to the next buffer. zbhdtype. See -30 and Table
System flags length & status Uns.int
Pointer to next buffer on queue
32 Buffer flags Bfflag Field Format
Flag
Chapter 111
MID
Message Header
Message Header zmhdtype
MRQ
Message ID Header zmidtype
Message Type Mstype
LPR XPS PGW BFR DEF ERR
Response code for message type 2 and 10 Format
37 Response code for all other message types
LPR
Message Request Header zmrqtype
Mrqcode Terminal request codes
Request Value Description
118
System Event Message zeventtype Structure
Nstat
Node Status Change Event Fields Zcomsetypenode
Nodenum
Spare
Dynamic Reconfiguration Event
Cfgclass
CFGINFO1
Change in Card Status Event Zcomsetypecard
Chapter 123
HPA value of this interface Long
Zcom Kernel Data
HPA Table Entries
Reserved for future use Int
Chapter 125
HPA value of I/F card Hpano
Chapter 127
SYS structure Zcom system global information
Current Zcom system status
Current Zcom system status Higher Order Bits
Name Value hex State
Debug Level Field Format
Debug Level Field Values
Bit Name Value Meaning Hex
Chapter 131
132
Zcmlock
Linfo Structure Fields
Zcglock
Zcrlock
Super IFT spinlock Zcslock Data Structure
Lockp
Refcount
Zcom C I/F Library Routines
136
Zinit Zcom library access initialization
Initialization call
Interface configuration calls
ZLU information calls
Zsend Send data buffer to ZLU
ZLU Definition
Man Pages
Cancellation point
Getdevice
Fork unsafe
Chapter 143
Device table. The device table is an array
Allocated memory when it is no longer needed
Pointer to a data structure containing the full
Zdevtype elements
Device file, /opt/acc/cfg/zcomdevice
Multiprotocol ACC Utilities Reference
Opt/acc/cfg/zcomdevice.txt
Zdgen1, malloc3C
Ltfind
Llen
Zap
Laddr
Ibuf Return Param
Chapter 149
150
Ltqdget
152
Ltqdget
154
Ltqdput
156
Zcom error codes and their meanings
Ltqdput
158
Makezluname
Returned Comment Name
MYZLU01
Parameter and from the same TTY, the same ZLU name will be
Be returned
Chapter 161
Ptfind
Chapter 163
Async-cancel unsafe
Async-signal unsafe
Ierr != 0, then no data is moved into zptt
Pointer to a buffer into which the Zcom
Physical terminal table data will be placed
Len Length in bytes of zptt buffer
166
Chapter 167
Zclos
Zclos
Zcntl
Zmodedefstatus
Zmodenowait
Zmoderpterrs
Zmoderpterrswbuf
Mhp
Multi-protocol ACC Programmers’ Reference Guide
Param
Rstat
Return
Rtyp
174
Chapter 175
176
Chapter 177
Zcomerror
Not a cancellation
Point
Err Error number
Found, it uses the default message file default.msg
File zerrmsg.msg in /opt/acc/msg ZCOMMESSAGEPATH. If not
180
Async-cancel safe
Zcomlname
Zcomlog3x
Zcomlog
184
Zcomatuchar
Zcomatzerror
Zcomatchar
Zcomatsint
186
Chapter 187
Zcomstatus
ACC Programmers Reference Guide under ‘ZCOM Status Message
Chapter 189
Zconfig
Node Destination node
Cdata
Rdata
Return Param Response data
Chapter 193
Zcomzconfigcard
Zcomzconfigcntl
Zcomzconfigsys
Zcomzconfigport
Zcomsetypereconfig
DSC Control
Configuration Data header.config
Header.tag1 Header.tag2 Any values
No specific response data or error
Header.config
Data.setctl.cfgclass
Data.setsys.sysname
Data.sysret.error
Header.tag1 Header.tag2
Data.setsys.qlimit
Chapter 199
Data.setcard.itype
Link an interface to different hardware
Header.tag1 Header.tag2 Any values Data.setcard.iftno
Data.setcard.fname
Data.cardret.error
Data.cardret.iftno
Data.setport.portno
Data.setport.rcode
Data.setport.spare
Data.setport.cnfg
Value Sync mode select
Value Operating mode
Value Encoding modes
Odd parity
Parity select
No Parity
Even parity
Value Rate
Value Port mode
0001 300
0000 150
Frame mode parameter
Fmod
Value Port mode 0000 Reserved
Value Other port for clock synchronization Port
Value T1 Transmit Attenuation Z7330B only 15 dB 22.5 dB
Makes the line go down whenever loss of T1/E1
Otherwise by default there is a delay to avoid
Fast link-down option
Frame synchronization is detected by the Falc
T1/ESF performance report messages suppressed
Long-haul mode Z7330B only
JT G.706 mode Z7330B only
Reduced corner frequency Z7330B only
Data.portret.iftno Data.portret.portno
Data.portret.status
Chapter 211
212
Data.setportsc.iftno
Configuration Data
Header.action
Data.setportsc.portno
Transmit subch number Transmit fill mask Set to
Receive subch number Receive fill mask
Chapter 215
Data.setportsc.len
Set to Mode
Data.setportsc.ptcfg-ptinfo.subchb.spec
Data.setportsc.qlimit
Data.portscret.status
218
Chapter 219
220
Data.setterm.iftno
Data.setterm.zaddr
Data.setterm.daddr
Data.setterm.portno
Data.setterm.ptt
Response Data data.termret.zaddr
224
Chapter 225
Zeventrcvr
Chapter 227
228
Chapter 229
‘C’ structure for a Zcom Event Message is shown below
Zcomsetypenode
Chapter 231
232
Zgetshrcvrlist
Zgetshrcvrlist Get list of current shared receivers
Maximum number of receivers in each type of shared
Type of data specified by the mode parameter. The list
Is terminated by an entry with a zlu value of 0.
Receiver list is set to ZcMAXSHAREDRCVRS currently
Chapter 235
Zinfo
Zinfo
238
Chapter 239
Zinit
Initialization phase, before any threads are generated
Default program ZLU queue limit
Calling zinit. See zrntimer3X for more information
Following fields
242
Zltmg
Error codes and their meanings
Zltmx
246
Chapter 247
Zltqueue
Globa
Appln Queue Progra Returned Nmb Label
Usage
Ccccc
250
Chapter 251
Zltstore
Zltstore
Logical terminal table, for the storage
Extension area
Chapter 255
256
Zltup
258
Chapter 259
Zluopen
Unsafe
Async-cancel
Async-signal
Unsafe Fork unsafe
262
Chapter 263
Zmapr
Zmapr
Zname
Zname
Zcom address
Chapter 269
Zopen
Chapter 271
Pflag
Name
Limit
273
Zpeek
Chapter 275
Zport
Chapter 277
For Z7200A, Z7340A and Z7400A ACC Interface cards
Stat
Cnfg Configuration data 32 bits
Ecode Sync Mode Parity Clk Baud Pmode Pmode2 = Not Used
FM1 transition = FM0 transition =
Value Parity select No Parity Odd parity Even parity
PmodeValue Port mode
Value Rate 0000 Use Baud2 1000 19,200
T1 ESF
Chapter 283
284
Chapter 285
286
Zptup
288
Zqmve
290
Chapter 291
Zqsze
Zqhdp Return param
294
Chapter 295
Zread
Chapter 297
Programmers’ Reference Guide. See the data structure
Not require the returned message header. It is described
Subsection on ‘Message Header’ in the Multiprotocol ACC
Zmhdtype in zcomsys.h for more detail
No error
Ve Zcom error code
Rstat Return status
300
Chapter 301
302
Chapter 303
Zrntimer
Not a cancellation point
Specified, it is rejected with error -6 Zenode
Means setting the timeout values for ALL remote nodes
Ttgen configuration file. If an unknown node number is
Timeout processing is activated on 1-second intervals
306
Zsend
Mhp-mid.ztagw2
308
Null may be used if the return status is not required
310
Chapter 311
Mode=0 Mode=1 Mode=2 Mode=5
Mode=8
314
Chapter 315
Zsetql
Chapter 317
318
Chapter 319
320
Zsetrcvr
322
Chapter 323
Rzap
Chapter 325
Ztimr
Chapter 327
328