HP Advanced Communications Controllers (ACC) specification

	ZCOM C I/F Library Routines
	ZCNTL (3X)
	/opt/acc/include/zcom/zcomcall.h ZCOM routine function prototypes
	(requires ANSI C compilation).
SEE ALSO	zcomstatus(3X), zconfig(3X), zread(3X), zsend(3X), zopen(3X).

Chapter 4

177

Image 177

HP Advanced Communications Controllers (ACC) manual

Contents

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 StructureField Name Field Description Field Type Size Bytes Hnresp HncardHnltql Hnltsl Hndsig HndpidHnidle Hnhigh Zcom Header Structure Zcom Header Structure Zcom Header Structure Zcom Header Structure Zcom Header Structure Ttgen Zcom Header Structure Qlbgrp Queue Label TableQlbnam Qlbqnb Storage Label Table Zcom Header Structure Node Entries Table Node Entries Table FLAGS.event Stats Data StructureFLAGS.valid FLAGS.status Host Link Information Structure Node Entries Table Individual ZLU Data Structure zlutype ZLU Tables Type Description ZLU Type Values ZLU Tables Logical Terminal Tables Logical Terminal Table Reserved AreaField 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 LTCWCT, LTTXCT, LTRXCT, Lterct Message and error counters Logical Status Format LtstatLTINST, 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 20 4-Channel E1/T1 ACC Card Format 31-30 29-26 26-22 21-20 19-16 15-11 10-0Fmode Timeslot Array Element Structure Port Subchannel Configuration Structure 31-30 29-24 23-8 23 Subchannel Specification Array Element StructureItbs INV Interface Table Optional E1/T1 Tunable Parameters Bquota Response Record Format Response Records Response Type Field Symbol Value MeaningZcomrptypebuffer Zcomrptyperemote 100 Free Queue Header Structure zfqhtype Queue Header Qlimit Queue Header Structure zqhdtypeQfdata Qfunc 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 System flags length & status Uns.int Linkage to the next buffer. zbhdtype. See -30 and TableReserved, not used Int Pointer to next buffer on queue Flag 32 Buffer flags Bfflag Field Format Chapter 111 Message Header zmhdtype Message HeaderMID MRQ Message ID Header zmidtype Message Type Mstype 37 Response code for all other message types Response code for message type 2 and 10 FormatLPR XPS PGW BFR DEF ERR LPR Message Request Header zmrqtype Request Value Description Mrqcode Terminal request codes 118 System Event Message zeventtype Structure Nodenum Node Status Change Event Fields ZcomsetypenodeNstat Spare Dynamic Reconfiguration Event CfgclassCFGINFO1 Change in Card Status Event Zcomsetypecard Chapter 123 HPA Table Entries Zcom Kernel DataHPA value of this interface Long 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 BitsName Value hex State Debug Level Field Format Debug Level Field ValuesBit Name Value Meaning Hex Chapter 131 132 Zcglock Linfo Structure FieldsZcmlock Zcrlock Super IFT spinlock Zcslock Data Structure LockpRefcount 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 Cancellation point GetdeviceFork unsafe Chapter 143 Pointer to a data structure containing the full Allocated memory when it is no longer neededDevice table. The device table is an array Zdevtype elements Multiprotocol ACC Utilities Reference Device file, /opt/acc/cfg/zcomdevice Zdgen1, malloc3C Opt/acc/cfg/zcomdevice.txt Ltfind Laddr ZapLlen Ibuf Return Param Chapter 149 150 Ltqdget 152 Ltqdget 154 Ltqdput 156 Ltqdput Zcom error codes and their meanings 158 Makezluname Returned Comment NameMYZLU01 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 Physical terminal table data will be placed Pointer to a buffer into which the ZcomIerr != 0, then no data is moved into zptt Len Length in bytes of zptt buffer 166 Chapter 167 Zclos Zclos Zcntl Zmoderpterrs ZmodenowaitZmodedefstatus Zmoderpterrswbuf Multi-protocol ACC Programmers’ Reference Guide Mhp Return RstatParam Rtyp 174 Chapter 175 176 Chapter 177 Zcomerror Not a cancellationPoint Err Error number Found, it uses the default message file default.msgFile zerrmsg.msg in /opt/acc/msg ZCOMMESSAGEPATH. If not 180 Zcomlname Async-cancel safe Zcomlog3x Zcomlog 184 Zcomatchar ZcomatzerrorZcomatuchar Zcomatsint 186 Chapter 187 ACC Programmers Reference Guide under ‘ZCOM Status Message Zcomstatus Chapter 189 Zconfig Node Destination node Cdata RdataReturn Param Response data Chapter 193 Zcomzconfigsys ZcomzconfigcntlZcomzconfigcard Zcomzconfigport DSC Control Zcomsetypereconfig Header.tag1 Header.tag2 Any values Configuration Data header.config No specific response data or error Header.configData.setctl.cfgclass Header.tag1 Header.tag2 Data.sysret.errorData.setsys.sysname Data.setsys.qlimit Chapter 199 Header.tag1 Header.tag2 Any values Data.setcard.iftno Link an interface to different hardwareData.setcard.itype Data.setcard.fname Data.cardret.iftno Data.cardret.error Data.setport.portno Data.setport.rcodeData.setport.spare Value Operating mode Value Sync mode selectData.setport.cnfg Value Encoding modes No Parity Parity selectOdd parity Even parity 0001 300 Value Port modeValue Rate 0000 150 Fmod Frame mode parameter Value Port mode 0000 Reserved Value Other port for clock synchronization PortValue T1 Transmit Attenuation Z7330B only 15 dB 22.5 dB Fast link-down option Otherwise by default there is a delay to avoidMakes the line go down whenever loss of T1/E1 Frame synchronization is detected by the Falc JT G.706 mode Z7330B only Long-haul mode Z7330B onlyT1/ESF performance report messages suppressed Reduced corner frequency Z7330B only Data.portret.status Data.portret.iftno Data.portret.portno Chapter 211 212 Header.action Configuration DataData.setportsc.iftno Data.setportsc.portno Receive subch number Receive fill mask Transmit subch number Transmit fill mask Set to Chapter 215 Data.setportsc.ptcfg-ptinfo.subchb.spec Set to ModeData.setportsc.len Data.setportsc.qlimit Data.portscret.status 218 Chapter 219 220 Data.setterm.daddr Data.setterm.zaddrData.setterm.iftno Data.setterm.portno 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 Is terminated by an entry with a zlu value of 0. Type of data specified by the mode parameter. The listMaximum number of receivers in each type of shared Receiver list is set to ZcMAXSHAREDRCVRS currently Chapter 235 Zinfo Zinfo 238 Chapter 239 Zinit Calling zinit. See zrntimer3X for more information Default program ZLU queue limitInitialization phase, before any threads are generated Following fields 242 Zltmg Error codes and their meanings Zltmx 246 Chapter 247 Zltqueue Usage Appln Queue Progra Returned Nmb LabelGloba Ccccc 250 Chapter 251 Zltstore Zltstore Extension area Logical terminal table, for the storage Chapter 255 256 Zltup 258 Chapter 259 Zluopen Async-signal Async-cancelUnsafe Unsafe Fork unsafe 262 Chapter 263 Zmapr Zmapr Zname Zname Zcom address Chapter 269 Zopen Chapter 271 Pflag NameLimit 273 Zpeek Chapter 275 Zport Chapter 277 Stat For Z7200A, Z7340A and Z7400A ACC Interface cards Cnfg Configuration data 32 bits Ecode Sync Mode Parity Clk Baud Pmode Pmode2 = Not UsedFM1 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 Subsection on ‘Message Header’ in the Multiprotocol ACC Not require the returned message header. It is describedProgrammers’ Reference Guide. See the data structure Zmhdtype in zcomsys.h for more detail No error Ve Zcom error codeRstat Return status 300 Chapter 301 302 Chapter 303 Not a cancellation point Zrntimer Ttgen configuration file. If an unknown node number is Means setting the timeout values for ALL remote nodesSpecified, it is rejected with error -6 Zenode Timeout processing is activated on 1-second intervals 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