Document Outline

• NI-VXI ™User Manual
  • Important Information
  • Warranty
  • Copyright
  • Trademarks
  • WARNING REGARDING MEDICAL AND CLINICAL USE OF NATIONAL INSTRUMENTS PRODUCTS
• Table of Contents
• About This Manual
  • Organization of This Manual
  • Conventions Used in This Manual
  • Related Documentation
  • Customer Communication
• Chapter 1 Overview of NI-VXI
  • VXIbus Overview
  • VXI Devices
  • Register-Based Devices
  • Message-Based Devices
  • Word Serial Protocol
  • Commander/Servant Hierarchies
  • Interrupts and Asynchronous Events
  • MXIbus Overview
  • MXI-2 Overview
• Chapter 2 Introduction to the NI-VXI Functions
  • Function Groups
  • VXI/VME Function Groups
  • VXI-Only Function Groups
  • Calling Syntax
  • LabWindows/CVI
  • Type Definitions
  • Input Versus Output Parameters
  • Return Values and System Errors
  • Multiple Mainframe Support
  • Controllers
  • The extender and controller Parameters
  • Using NI-VXI
  • Header Files
  • The datasize.h File
  • The busacc.h File
  • The devinfo.h File
  • The Beginning and End of an NI-VXI Program
  • System Configuration Tools
  • Word Serial Communication
  • Master Memory Access
  • Slave Memory Access
  • Interrupts and Signals
  • Triggers
• Chapter 3 Software Overview
  • System Configuration Functions
  • CloseVXIlibrary ()
  • CreateDevInfo (la)
  • FindDevLA (namepat, manid, modelcode, devclass, slot, mainframe, cmdrla, la)
  • GetDevInfo (la, field, fieldvalue)
  • GetDevInfoLong (la, field, longvalue)
  • GetDevInfoShort (la, field, shortvalue)
  • GetDevInfoStr (la, field, stringvalue)
  • InitVXIlibrary ()
  • SetDevInfo (la, field, fieldvalue)
  • SetDevInfoLong (la, field, longvalue)
  • SetDevInfoShort (la, field, shortvalue)
  • SetDevInfoStr (la, field, stringvalue)
  • Commander Word Serial Protocol Functions
  • Programming Considerations
  • Interrupt Service Routine Support
  • Single-Tasking Operating System Support
  • Cooperative Multitasking Support
  • Multitasking Support (Preemptive Operating System)
  • WSabort (la, abortop)
  • WSclr (la)
  • WScmd (la, cmd, respflag, response)
  • WSEcmd (la, cmdExt, cmd, respflag, response)
  • WSgetTmo (actualtimo)
  • WSLcmd (la, cmd, respflag, response)
  • WSLresp (la, response)
  • WSrd (la, buf, count, modevalue, retcount)
  • WSrdf (la, filename, count, modevalue, retcount)
  • WSresp (la, response)
  • WSsetTmo (timo, actualtimo)
  • WStrg (la)
  • WSwrt (la, buf, count, modevalue, retcount)
  • WSwrtf (la, filename, count, modevalue, retcount)
  • Servant Word Serial Protocol Functions
  • Programming Considerations
  • DefaultWSScmdHandler (cmd)
  • DefaultWSSEcmdHandler (cmdExt, cmd)
  • DefaultWSSLcmdHandler (cmd)
  • DefaultWSSrdHandler (status, count)
  • DefaultWSSwrtHandler (status, count)
  • GenProtError (proterr)
  • GetWSScmdHandler ()
  • GetWSSEcmdHandler ()
  • GetWSSLcmdHandler ()
  • GetWSSrdHandler ()
  • GetWSSwrtHandler ()
  • RespProtError ()
  • SetWSScmdHandler (func)
  • SetWSSEcmdHandler (func)
  • SetWSSLcmdHandler (func)
  • SetWSSrdHandler (func)
  • SetWSSwrtHandler (func)
  • WSSabort (abortop)
  • WSSdisable ()
  • WSSenable ()
  • WSSLnoResp ()
  • WSSLsendResp (response)
  • WSSnoResp ()
  • WSSrd (buf, count, modevalue)
  • WSSsendResp (response)
  • WSSwrt (buf, count, modevalue)
  • High-Level VXI/VMEbus Access Functions
  • Programming Considerations
  • VXIin (accessparms, address, width, value)
  • VXIinReg (la, reg, value)
  • VXImove (srcparms, srcaddr, destparms, destaddr, length, width)
  • VXIout (accessparms, address, width, value)
  • VXIoutReg (la, reg, value)
  • Low-Level VXI/VMEbus Access Functions
  • Programming Considerations
  • Multiple-Pointer Access for a Window
  • Owner Privilege
  • Access-Only Privilege
  • GetByteOrder (window, ordermode)
  • GetContext (window, context)
  • GetPrivilege (window, priv)
  • GetVXIbusStatus (controller, status)
  • GetVXIbusStatusInd (controller, field, status)
  • GetWindowRange (window, windowbase, windowend)
  • MapVXIAddress (accessparms, address, timo, window, ret)
  • MapVXIAddressSize (size)
  • SetByteOrder (window, ordermode)
  • SetContext (window, context)
  • SetPrivilege (window, priv)
  • UnMapVXIAddress (window)
  • VXIpeek (addressptr, width, value)
  • VXIpoke (addressptr, width, value)
  • Local Resource Access Functions
  • GetMyLA
  • ReadMODID (modid)
  • SetMODID (enable, modid)
  • VXIinLR (reg, width, value)
  • VXImemAlloc (size, useraddr, vxiaddr)
  • VXImemCopy (useraddr, bufaddr, size, dir)
  • VXImemFree (useraddr)
  • VXIoutLR (reg, width, value)
  • VXI Signal Functions
  • Programming Considerations
  • WaitForSignal Considerations
  • DefaultSignalHandler (signal)
  • DisableSignalInt ()
  • EnableSignalInt ()
  • GetSignalHandler (la)
  • RouteSignal (la, modemask)
  • SetSignalHandler (la, func)
  • SignalDeq (la, signalmask, signal)
  • SignalEnq (signal)
  • SignalJam (signal)
  • WaitForSignal (la, signalmask, timeout, retsignal, retsignalmask)
  • VXI Interrupt Functions
  • Programming Considerations
  • ROAK Versus RORA VXI/VME Interrupters
  • AcknowledgeVXIint (controller, level, statusId)
  • AssertVXIint (controller, level, statusId)
  • DeAssertVXIint (controller, level)
  • DefaultVXIintHandler (controller, level, statusId)
  • DisableVXIint (controller, levels)
  • DisableVXItoSignalInt (controller, levels)
  • EnableVXIint (controller, levels)
  • EnableVXItoSignalInt (controller, levels)
  • GetVXIintHandler (level)
  • RouteVXIint (controller, Sroute)
  • SetVXIintHandler (levels, func)
  • VXIintAcknowledgeMode (controller, modes)
  • VXI Trigger Functions
  • Capabilities of the National Instruments Triggering Hardware
  • External Controller/VXI-MXI-1 Trigger Capabilities
  • Embedded, External MXI-2, and Remote Controller Trigger Capabilities
  • Acceptor Trigger Functions
  • AcknowledgeTrig (controller, line)
  • DefaultTrigHandler (controller, line, type)
  • DefaultTrigHandler2 (controller, line, type)
  • DisableTrigSense (controller, line)
  • EnableTrigSense (controller, line, prot)
  • GetTrigHandler (line)
  • SetTrigHandler (lines, func)
  • WaitForTrig (controller, line, timeout)
  • Map Trigger Functions
  • MapTrigToTrig (controller, srcTrig, destTrig, mode)
  • UnMapTrigToTrig (controller, srcTrig, destTrig)
  • Source Trigger Functions
  • SrcTrig (controller, line, prot, timeout)
  • Trigger Configuration Functions
  • TrigAssertConfig (controller, trigline, mode)
  • TrigCntrConfig (controller, mode, source, count)
  • TrigExtConfig (controller, extline, mode)
  • TrigTickConfig (controller, mode, source, tcount1, tcount2)
  • System Interrupt Handler Functions
  • AssertSysreset (controller, mode)
  • DefaultACfailHandler (controller)
  • DefaultBusErrorHandler ()
  • DefaultSoftResetHandler ()
  • DefaultSysfailHandler (controller)
  • DefaultSysresetHandler (controller)
  • DisableACfail (controller)
  • DisableSoftReset ()
  • DisableSysfail (controller)
  • DisableSysreset (controller)
  • EnableACfail (controller)
  • EnableSoftReset ()
  • EnableSysfail (controller)
  • EnableSysreset (controller)
  • GetACfailHandler ()
  • GetBusErrorHandler ()
  • GetSoftResetHandler ()
  • GetSysfailHandler ()
  • GetSysresetHandler ()
  • SetACfailHandler (func)
  • SetBusErrorHandler (func)
  • SetSoftResetHandler (func)
  • SetSysfailHandler (func)
  • SetSysresetHandler (func)
  • VXI/VMEbus Extender Functions
  • MapECLtrig
  • MapTTLtrig
  • MapUtilBus (extender, modes)
  • MapVXIint (extender, levels, directions)
• Appendix A Function Classification Reference
• Appendix B Customer Communication
• Glossary
• Index
• Figures
  • Figure 1-1. VXI Configuration Registers
  • Figure 1-2. VXI Software Protocols
  • Figure 2-1. An Embedded Controller Connected to Other Frames via Mainframe Extenders Using MXI-2
  • Figure 2-2. An External Controller Connected Using MXI-2 to a Number of Remote Controllers
  • Figure 3-1. Preemptive Word Serial Mutual Exclusion (Per Logical Address)
  • Figure 3-2. NI-VXI Servant Word Serial Model
  • Figure 3-3. NI-VXI Interrupt and Signal Model
  • Figure 3-4. NI-VXI Interrupt and Signal Model
• Tables
  • Table A-1. Function Listing by Group
  • Table A-2. Function Listing by Name