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