ZLU configuration calls | HP UX 11i v1 I/O Cards instruction

ZCOM C I/F Library Routines

Introduction

The following is a list of ZCOM C interface library routines:

Initialization call

zinit-ZCOM library access initialization

Interface configuration call

zport	-Datacomm port configuration
zconfig	-Dynamic system configuration

ZLU configuration calls

zclos	-Delete program input ZLU
zmapr	-Set up ZLU mapping configuration
zopen	-Create ZLU program input queue
zluopen	-Open a ZLU for file system access
zset_rcvr	-Set up a program ZLU as receiver for a terminal ZLU
zevent_rcvr	-Set up a program ZLU as receiver for system event messages
zsetql	-Set buffer queue limit
ztimr	-Enable/disable ZLU timer

Data storage allocation calls

zltqueue -Logical data queue allocation

zltstore

-Logical data storage allocation

Chapter 4

131

Image 131

HP UX 11i v1 I/O Cards manual ZLU configuration calls, Zltstore Logical data storage allocation

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 Hpiftp HpzluHpttbl Hpptbl Zcom Header Structure Zcom Header Structure Zcom Header Structure Zcom Header Structure Zcom Header Structure Ttgen Zcom Header Structure Qlbrsv QlbgrpQlbnam Qlbqnb Slboff SlbgrpSlbnam Slbsze Zcom Header Structure Node Entries Table FLAGS.local FLAGS.eventFLAGS.valid FLAGS.status Node Entries Table Individual ZLU Entries ZLU Tables Type Description ZLU Type Values ZLU Tables Logical Terminal Tables Ltaddr LtzshrcvrsLthldq Lthdqn 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 Sync Port Configuration Buffer IportnChannel E1/T1 ACC Card Format Ecode TxFill WhereTimeslot Array Element Structure TxSubch 31-30 29-24 23-8 Subchannel Specification Array Element Structure IFIRQBUF, IRESPBUF, Istdtbuf DMA response buffers Datadelay Response Records Zcomrptypeirr Response Type Field Symbol Value MeaningZcomrptypebuffer Zcomrptyperemote Response Records Queue Header Area Queue Header Qfunc QlimitQfdata 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 MRQ Message HeaderMID Mzsrce MstypeMsresp Mzdest Message Type Mstype Response code for all other message types Response code for message type 2 Mrqtag MrqcodeMrqterm Mrqstat Request Value Description Mrqcode Terminal request codes Setime SetypeSeflag Senode Spare Node Status Change Event Fields ZcomsetypenodeNodenum Nstat CFGINFO1 Dynamic Reconfiguration Event ZcomsetypereconfigCfgclass 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 Name Value hex State Current Zcom system status Name Value hex StateCurrent Zcom system status Higher Order Bits Debug Level Field Values Bit Name Value hex Meaning Debug Level Field Format Chapter 125 Zcslock ZcglockZcmlock Zcrlock 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 Zdgen1, malloc3C File, /opt/acc/cfg/zcomdeviceMultiprotocol ACC Utilities Reference Ascii file, /opt/acc/cfg/zcomdevice.txt Description Ltfind Len Length in bytes of ibuf Logical terminal table. Note that if the logicalTerminal is not found, ibuf will not contain valid data 142 Chapter 143 Ltqdget Posix 1003.1c kernel threads API package. This routine has Ltqdget 146 Ltqdput 148 Chapter 149 MYZLU01 MakezlunameTTY Name Returned Name Comment Makezluname Parameter and from the same TTY, the same ZLU name will be Ptfind 154 Data is moved into zptt Pointer to a buffer into which the Zcom physicalTerminal table data will be placed. Note that if Physical terminal is not found i.e., ierr != 0, then no Return Value Zclos Cancellation point Chapter 159 Zcntl Send no wait, definite status Send no wait, report errorsSend no wait, report errors with buffer Send no wait ReturnParam MhpACC Programmers’ Reference Guide Ibuf, len Rstat 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 Zcom error string will be logged Int Unix error code, usually errnoUnix error string will be logged Int Zcom error code 174 Chapter 175 ACC Programmers Reference Guide under ‘ZCOM Status Message Zcomstatus Chapter 177 Zconfig Zap Return Param Response data Chapter 181 Zcomzconfigport ZcomzconfigcntlZcomzconfigsys Zcomzconfigcard Chapter 183 Header.action Configuration DataHeader.config DSC Control Zcom subsystem No specific response data or errorData.setctl.cfgclass Data.setctl.cfginfo1 Data.setsys.qlimit Data.sysret.errorHeader.tag1 Header.tag2 Data.setsys.sysname Chapter 187 Data.setcard.fname DscreassigniftData.setcard.iftno Data.setcard.itype Data.cardret.iftno Data.cardret.error Data.setport.spare Data.setport.portnoData.setport.rcode Value Parity select No Parity Odd parity Even parity Data.setport.cnfgValue Encoding modes FM1 transition = FM0 transition = Value Rate Value Clock multiplierValue Rate 0000 Use Baud2 1000 19,200 Fsync Pmode Pmode2 Value T1 Transmit Attenuation Z7330B only 15 dB 22.5 dB Value Other port for clock synchronization Port Performance report messages in T1/ESF mode Otherwise by default there is a delay to avoidT1/ESF mode contain an address which User device. By default the ACC is a user Data.portret.status Data.setport.qlimitData.portret.iftno Data.portret.portno Chapter 197 Configuration Data header.config Data.setportsc.rcode Data.setportsc.iftnoData.setportsc.portno Data.setportsc.subchno RTI Data.setportsc.ptcfg-ptinfo.subchb.tmsl Data.setportsc.len Set to ModeData.setportsc.ptcfg-ptinfo.subchb.spec Set to Data.portscret.status Chapter 203 Data.setterm.iftno Header.action ZcDSCCREATELTTPTT Create a new terminal LTTZcDSCCREATELTTONPTT Create a new LTT on an existing Data.setterm.daddr Data.setterm.ltype Data.setterm.portnoData.setterm.subchno Data.setterm.dtype 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 Should have ZcMAXSHAREDRCVRS+1 entries Table entry from which you want the shared receivers listType of shared receiver list is set to ZcMAXSHAREDRCVRS 216 Zinfo Name Param Return, Tables and Data Structures section 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 Node contains the local node as defined in the Ttgen Ld1Zap Zcom address node, ZLU number, and checksum 250 Chapter 251 Zpeek Zread3X, zluopen3X Error codes and their meanings Zport Zcomzmuxportport ZcomzmuxportallZcomzmuxportconf Zcomzmuxportbaud Break routine not installed No errorSome terminals in this port not disabled Illegal port mode Value Clock source Value Operating modeValue Parity select Clk 258 T1 ESF Value Port ModeValue 260 Chapter 261 Zptup Chapter 263 Zqmve Chapter 265 Zqsze Zqhdp Return param 268 Zread Same ZLU. When a message arrives, only one Mode ZcREADWWAIT 0 Read with waitAfter the timeout period has elapsed There is no message on the queue, error Zenodata 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