User Interface | HP UX 11i v1 I/O Cards instruction

ZCOM Subsystem

User Interface

User Interface

The interface between the application programs and the ZCOM Subsystem is through the ZCOM ‘C’ Application Programming Interface (API) library. The functions provided by this library are documented in Chapter 4 , “ZCOM C I/F Library Routines.” All functions within the library are thread-safe and can be used in multi-threaded programs. Both 32-bit and 64-bit applications are supported.

The interactive program ZTERM gives the user access to all the ZCOM routines and can be used to test programs or terminals by sending and receiving messages between them. The program ZSCAN allows the programmer to display the contents of the ZCOM memory areas.

Chapter 1

21

Image 21

HP UX 11i v1 I/O Cards manual User Interface

Contents

ACC Programmer’s Reference Guide Page Legal Notices Page Ninth Edition April Release B.03.10 HP-UX Printing History Hardware Manuals Related Documentation Contents Zcom Tables and Data Structures Zcom C I/F Library Routines Contents Zcom Subsystem Introduction Zcom Software Overview Zcom 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 Outbound Multiplexing Inbound Multiplexing PTZRVR=PZLU Pzlu Inbound Multoplexing Terminal State Terminal State Error Handling Error Handling Zcom Tables and Data Zcom Tables and Data Structures Memory Organization Memory Organization Differences in 32-bit and 64-bit Data Structures Differences in 32-bit and 64-bit Data Structures Zcom Header Structure Hpttbl HpzluHpptbl Hpiftp Zcom Header Structure Zcom Header Structure Zcom Header Structure Zcom Header Structure Zcom Header Structure Ttgen Zcom Header Structure Qlbnam QlbgrpQlbqnb Qlbrsv Slbnam SlbgrpSlbsze Slboff Zcom Header Structure Node Entries Table FLAGS.valid FLAGS.eventFLAGS.status FLAGS.local Node Entries Table Individual ZLU Entries ZLU Tables Type Description ZLU Type Values ZLU Tables Logical Terminal Tables Lthldq LtzshrcvrsLthdqn Ltaddr Logical Terminal Tables System Status flags Logical Status Structure Ltstat LTCWCT, LTTXCT, LTRXCT, Lterct Message and error counters LTINST, LTBRCH, LTWORK, Ltarea Terminal logical ID Physical Terminal Tables Field Name Field Description Field Type Size Bytes Physical Terminal Tables User Maintainable Area Ptuser Physical Terminal Tables Physical Terminal Tables Physical Terminal Tables Terminal Status Field Ptdrst Firmware terminal status Ptfwst Physical Terminal Tables Physical Terminal Tables Interface Table Ifwinfo 63-32 31-28 27-18 17-14 13-12 10-6 Interface HPA Value Inhpa Interface Card Status Ifstat Symbol Value hex Meaning Scheduler Event Flags Ischdl Interface Table Interface Table Ipendgbufs Isubchbuf Ifirqbp Nextl Interface Table Zcomipstatund Zcomipstattxb Channel E1/T1 ACC Card Format Port Configuration Buffer IportnEcode Sync Timeslot Array Element Structure WhereTxSubch TxFill 31-30 29-24 23-8 Subchannel Specification Array Element Structure IFIRQBUF, IRESPBUF, Istdtbuf DMA response buffers Datadelay Response Records Zcomrptypebuffer Response Type Field Symbol Value MeaningZcomrptyperemote Zcomrptypeirr Response Records Queue Header Area Queue Header Qlimit QfdataQfunc Queue Header Queue Flags Chapter 101 Organization of Buffer Pool Data Buffer Pool Buffer Pool Layout when first initialized Free Buffer Header Structure zfbhtype Block Size Used flag Buffer flags Bfflag Field 106 Message Header MIDMRQ Msresp MstypeMzdest Mzsrce Message Type Mstype Response code for all other message types Response code for message type 2 Mrqterm MrqcodeMrqstat Mrqtag Request Value Description Mrqcode Terminal request codes Seflag SetypeSenode Setime Nodenum Node Status Change Event Fields ZcomsetypenodeNstat Spare Dynamic Reconfiguration Event Zcomsetypereconfig CfgclassCFGINFO1 116 Chapter 117 Ncard Zcom Kernel Data Chapter 119 HPA value of I/F card Hpano Chapter 121 SYS structure Zcom system global information, zsystype Current Zcom system status Name Value hex State Current Zcom system status Higher Order BitsName Value hex State Debug Level Field Values Bit Name Value hex Meaning Debug Level Field Format Chapter 125 Zcmlock ZcglockZcrlock Zcslock Refcount Lockp Zcom Kernel Data 128 Zcom C I/F Library Routines 130 Zltstore Logical data storage allocation ZLU configuration calls ZLU data transfer calls Chapter 133 ZLU Definition Man Pages Getdevice Read Zcom device definitions Getdevice Dpp Return param Considerations Example Multiprotocol ACC Utilities Reference File, /opt/acc/cfg/zcomdeviceAscii file, /opt/acc/cfg/zcomdevice.txt Zdgen1, malloc3C Description Ltfind Logical terminal table. Note that if the logical Terminal is not found, ibuf will not contain valid dataLen Length in bytes of ibuf 142 Chapter 143 Ltqdget Posix 1003.1c kernel threads API package. This routine has Ltqdget 146 Ltqdput 148 Chapter 149 Makezluname TTY Name Returned Name CommentMYZLU01 Makezluname Parameter and from the same TTY, the same ZLU name will be Ptfind 154 Terminal table data will be placed. Note that if Pointer to a buffer into which the Zcom physicalPhysical terminal is not found i.e., ierr != 0, then no Data is moved into zptt Return Value Zclos Cancellation point Chapter 159 Zcntl Send no wait, report errors with buffer Send no wait, report errorsSend no wait Send no wait, definite status ACC Programmers’ Reference Guide Ibuf, len MhpRstat ReturnParam Rtyp For rcode not all of them are applicable to zcntl 164 Chapter 165 166 Not a cancellation point Zcomerror 168 Zcomlname Async-cancel safe Zcomlog3x Zcomlog 172 Unix error string will be logged Int Unix error code, usually errnoInt Zcom error code Zcom error string will be logged 174 Chapter 175 ACC Programmers Reference Guide under ‘ZCOM Status Message Zcomstatus Chapter 177 Zconfig Zap Return Param Response data Chapter 181 Zcomzconfigsys ZcomzconfigcntlZcomzconfigcard Zcomzconfigport Chapter 183 Header.config Configuration DataDSC Control Header.action Data.setctl.cfgclass No specific response data or errorData.setctl.cfginfo1 Zcom subsystem Header.tag1 Header.tag2 Data.sysret.errorData.setsys.sysname Data.setsys.qlimit Chapter 187 Data.setcard.iftno DscreassigniftData.setcard.itype Data.setcard.fname Data.cardret.iftno Data.cardret.error Data.setport.portno Data.setport.rcodeData.setport.spare Value Encoding modes Data.setport.cnfgFM1 transition = FM0 transition = Value Parity select No Parity Odd parity Even parity Value Clock multiplier Value Rate 0000 Use Baud2 1000 19,200Value Rate Fsync Pmode Pmode2 Value T1 Transmit Attenuation Z7330B only 15 dB 22.5 dB Value Other port for clock synchronization Port T1/ESF mode contain an address which Otherwise by default there is a delay to avoidUser device. By default the ACC is a user Performance report messages in T1/ESF mode Data.setport.qlimit Data.portret.iftno Data.portret.portnoData.portret.status Chapter 197 Configuration Data header.config Data.setportsc.portno Data.setportsc.iftnoData.setportsc.subchno Data.setportsc.rcode RTI Data.setportsc.ptcfg-ptinfo.subchb.tmsl Data.setportsc.ptcfg-ptinfo.subchb.spec Set to ModeSet to Data.setportsc.len Data.portscret.status Chapter 203 ZcDSCCREATELTTONPTT Create a new LTT on an existing Header.action ZcDSCCREATELTTPTT Create a new terminal LTTData.setterm.daddr Data.setterm.iftno Data.setterm.subchno Data.setterm.portnoData.setterm.dtype Data.setterm.ltype Response Data data.termret.zaddr Chapter 207 208 Zeventrcvr Name 210 Chapter 211 Zcomsetypenode ‘C’ structure for a Zcom Event Message is shown below Files Zgetshrcvrlist Get list of current shared receivers Zgetshrcvrlist Table entry from which you want the shared receivers list Type of shared receiver list is set to ZcMAXSHAREDRCVRSShould have ZcMAXSHAREDRCVRS+1 entries 216 Zinfo Name Return , Tables and Data Structures sectionParam Returnvalue Files Zinit Zcom routine initialization Zinit Following fields Parameters Chapter 223 Zltmg Move a logical terminal between groups Zltmg Zltmg 226 Zltmx Control logical terminal multiplexing Zltmx Parameters Chapter 229 Zltqueue Logical data queue allocation Zltqueue Appln Application number of terminal group Appln Queue Returned Program Nmbr Label Queue No Chapter 233 Zltstore Logical data storage allocation Zltstore Terminal table, for the storage in the extension area 236 Zltup 238 Chapter 239 Zluopen This return parameter is undefined Zcom error codes and their meanings 242 Zmapr 244 Zname 246 Chapter 247 Zopen Ld1 Zap Zcom address node, ZLU number, and checksumNode contains the local node as defined in the Ttgen 250 Chapter 251 Zpeek Zread3X, zluopen3X Error codes and their meanings Zport Zcomzmuxportconf ZcomzmuxportallZcomzmuxportbaud Zcomzmuxportport Some terminals in this port not disabled No errorIllegal port mode Break routine not installed Value Parity select Value Operating modeClk Value Clock source 258 Value Port Mode ValueT1 ESF 260 Chapter 261 Zptup Chapter 263 Zqmve Chapter 265 Zqsze Zqhdp Return param 268 Zread After the timeout period has elapsed Mode ZcREADWWAIT 0 Read with waitThere is no message on the queue, error Zenodata Same ZLU. When a message arrives, only one Chapter 271 272 Chapter 273 274 Zrntimer 276 Chapter 277 Mhp-mid.ztagw2 Zsend Zsend 280 Chapter 281 282 Chapter 283 284 Chapter 285 286 Chapter 287 Zsetql Chapter 289 290 Zsetrcvr 292 Zsetrcvr 294 Ztimr 296 Chapter 297 298