PCI Windows Driver Software User`s Manual
Contents
1. 2 ccccssnnsseeeeeeeceecccnnnsnseeeeeeeeneconassesnseeseeooonnasssseeeeseeneconaaseenenees 17 Deploying Applications to Target Systems See 18 Kernel Driver Installation ccccccssesssseseeeeeeseeeeeesnnneeeeeeseeeeeessnneeeeeeseeeoeasnnnneeeees 18 Application and DLL Installation cccccssseeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeneees 18 DEL Location Notes iscicc cose KEE SNE neangannana EeNEEE ve sevedenebe dee ys kaan iaa naad di saiua iii CV 18 Modifying the PATH setting ccceseeceseseeeeeseeneeeeseeneeseseeneeseseenenseseeeenseseenenseseenensnseenenes 19 Windows XP Vista 7 and 8 EE 19 Acromag Inc Tel 248 295 0310 Fax 248 624 9234 Email solutions acromag com http www acromag com 4 PCI Windows Driver Software User s Manual Introduction PCI Windows Driver Software consists of low level drivers and Windows Dynamic Link Libraries DLLs that facilitate the development of Windows applications accessing Acromag PMC I O module products e g PMC730 PCI I O Cards e g APC730 CompactPCI I O Cards e g AcPC730 and PCI Express XMC I O modules e g XMC VLX85 Notes e The convention of this document is to refer to the above hardware devices using the generic name PCI module e PCle is used when it s necessary to distinguish PCI Express modules from their PCI counterparts There are two versions of the software The 32 bit Windows PCI software library PCISW API WIN32 is2. Subdirectory Microsoft Visual C 32 bit example projects with source code A prebuilt executable is in each project s Release directory c_lib Win32 COFF format import libraries config_files Example VHDL object code for reconfigurable FPGA I O Modules redist DLLs Win32 32 bit DLLs docs User s manual DLL references application notes redist Driver 32 bit device driver and co installer DLL INF and catalog files for each board utility Win32 32 bit PClEnum utility Acromag Inc Tel 248 295 0310 Fax 248 624 9234 Email solutions acromag com http www acromag com 7 PCI Windows Driver Software User s Manual Installed Files PCISW API WIN64 The default installation directory is C Acromag PCISW_API_ WIN64 Subdirectory Microsoft Visual C 64 bit example projects with source code A prebuilt executable is in each project s Release directory c_lib Win64 COFF format import libraries config_files Example VHDL object code for reconfigurable FPGA I O Modules redist DLLs Win64 64 bit DLLs redist Driver 64 bit device driver and co installer DLL INF and catalog files for each board utility Win64 64 bit PCIEnum utility docs User s manual DLL references application notes Acromag Inc Tel 248 295 0310 Fax 248 624 9234 Email solutions acromag com http www acromag com 8 PCI Windows Driver Software User s Manual Hardware Installation 1 Configure any jumpers on the PCI PCle module as necess
3. PCI module has its own DLL with unique functions all PCI modules are accessed using the calling sequence shown below PCIXXX_Open PCIXXX_SetUserCallback PCIXXX Hardware Access Function Calls PCIXXX_Close Notes 1 PCIXXX_Open provides an integer handle used to access the specific PCIXXX module in all subsequent calls 2 Not all Acromag PCI modules support interrupts User callbacks are used to implement custom interrupt service routine logic for reconfigurable boards 3 PCIXXX_Close should always be called for each open PCI module prior to terminating the application Acromag Inc Tel 248 295 0310 Fax 248 624 9234 Email solutions acromag com http www acromag com 4 PCI Windows Driver Software User s Manual Interrupts PCI Windows Driver Software supports callback functions for allowing your application to respond to interrupts generated in the hardware Callback functions execute synchronously with the internal interrupt service routines see below Each PCI DLL that supports interrupts has its own predefined internal interrupt service routine DLLs for reconfigurable boards are a special case See note below The specifics of each routine are outlined in the PCI modules corresponding Function Reference document If you choose to implement a callback function you have the option of overriding this routine This is done by setting a Replace parameter when designating the call
4. by appending the path to the common DLL directory to the right of the existing value 5 Click OK Acromag Inc Tel 248 295 0310 Fax 248 624 9234 Email solutions acromag com http www acromag com
5. called by your application before it attempts to access data or device memory that can be accessed by another thread Remember to call PCIXXX_EndIsrSynch when finished accessing these shared resources Base Address Pointers Each DLL provides a function that returns the base address of the user mode mapping of the PCI module s memory space C and C programmers can cast the returned value to a pointer and access memory using normal pointer mechanisms This method can be used to write additional functions that complement those provided through the DLL Example Read PMC408 Digital Input Channel Register A UINT64 base address volatile BYTE pbase addr WORD chan val if PCI408 GetBaseAddress Handle amp base address 0 pbase addr BYTE base address chan val PWORD pbase addr 0x200 Acromag Inc Tel 248 295 0310 Fax 248 624 9234 Email solutions acromag com http www acromag com 6 PCI Windows Driver Software User s Manual Using the Library with Visual C This section describes the basic steps to add a PCI Windows Driver dynamic link library to a 32 bit or 64 bit Visual C project These instructions are based on the Microsoft Visual Studio 2010 development environment PCISW API WIN32 1 Open a new or existing Visual C project 2 Open the project s property pages 3 Confirm the Platform drop down is set to Win32 and the Configuration drop down is set to All Conf
6. in the PCI module s Function Reference document This format however will be some variation of the following C void _stdcall YourIsrName int Handle BYTE Status The Handle argument identifies the board that caused the interrupt If the function is not overriding the internal ISR the Status variable s will contain data allowing you to determine the cause of the interrupt e g the value read from a status register by the internal ISR If the function is overriding the internal ISR the Status variable s will be zero since the internal ISR did not read any registers prior to invoking the callback function Acromag Inc Tel 248 295 0310 Fax 248 624 9234 Email solutions acromag com http www acromag com d D PCI Windows Driver Software User s Manual SYNCHRONIZATION The DLL s interrupt service routine ISR executes on a different thread than that of your application Within the DLL the ISR which includes the call to any callback function is delimited as a device critical section PCIXXX_StartIsrSynchand PCIXXX_EndIsrSynch can be used to synchronize other application threads with the ISR thread and to synchronize multiple threads within an application with each other Bracketing a section of code between calls of PCIXXX StartIsrSynch and PCIXXX_EndIsrSynch defines that code as a device critical section Two threads within a single process cannot execute critical section code simultaneously PCIXXX StartIsrSynch should be
7. logic cells PCILX60 er configurable Virtex 4 FPGA with 59 904 logic cells PCISLX150 ser configurable Spartan 6 FPGA with 147 433 logic cells PCISX35 ser configurable Virtex 4 FPGA with 34 560 logic cells PCIVFX70 ser configurable Virtex 5 FPGA with 71 680 logic cells and PowerPC Core PCIVLX85 ser configurable Virtex 5 FPGA with 82 944 logic cells PCIVLX110 ser configurable Virtex 5 FPGA with 110 592 logic cells PCIVLX155 ser configurable Virtex 5 FPGA with 155 648 logic cells PCIVSX95 ser configurable Virtex 5 FPGA with 94 208 logic cells PCle6VLX240 ser configurable Virtex 6 FPGA with 240k logic cells no front I O PCle6VLX240F User configurable Virtex 6 FPGA with 240k logic cells SFP front I O PCle6VLX365 ser configurable Virtex 6 FPGA with 365k logic cells no front I O PCle6VLX365F User configurable Virtex 6 FPGA with 365k logic cells SFP front I O PCleSLX150 ser configurable Spartan 6 FPGA with 150k logic cells PCleVLX85 ser configurable Virtex 5 FPGA with 85k logic cells PCleVLX110 ser configurable Virtex 5 FPGA with 100k logic cells PCleVLX155 ser configurable Virtex 5 FPGA with 155k logic cells PC1l230 Cc Supported Programming Languages The demonstration program source code as well as the function descriptions and example code provided in the documentation are all written in the C programming language However the library functions are also callable from numerous other languages The DLL functions use the Windows _ stdcall
8. used to create applications that will run on 32 bit versions of Windows A corresponding 64 bit software library PCISW API WIN64 is used to create applications that will run on 64 bit versions of Windows Except where noted otherwise the usage of the 32 bit and 64 bit DLLs is identical Notes e The 32 bit DLLs are used with a 32 bit kernel driver and are therefore not compatible with the WoW64 subsystem found on 64 bit versions of Windows In other words the 32 bit driver software can only be run on 32 bit versions of Windows and 64 bit driver software can only be run on 64 bit versions of Windows e The bitness of the Target system is important The bitness of the Development system is not For example you can install PCISW API WIN64 on a 32 bit Windows system and use it to develop an application that will run on a 64 bit Windows target DLL functions use the Windows _ stdcall calling convention and can be accessed from a number of programming languages This document covers general information on hardware and software installation programming concepts application development and deployment issues Also included in the PCI Window Driver documentation is a set of Function Reference documents for each Acromag PCI module DLL After reviewing this user s manual readers will next want to consult the Function Reference document specific to their hardware PCISW API WIN32 and PCISW API WIN64 supersede Acromag s older Windows PCI so
9. Acromag kd THE LEADER IN INDUSTRIAL I O PCI Windows Driver Software User s Manual ACROMAG INCORPORATED Tel 248 295 0310 30765 South Wixom Road Fax 248 624 9234 P O BOX 437 Wixom MI 48393 7037 U S A Copyright 2011 2013 Acromag Inc Printed in the USA 9500 310C Data and specifications are subject to change without notice 9500 311C 2 PCI Windows Driver Software User s Manual The information in this document is subject to change without notice Acromag Inc makes no warranty of any kind with regard to this material and accompanying software including but not limited to the implied warranties of merchantability and fitness for a particular purpose Further Acromag Inc assumes no responsibility for any errors that may appear in this document and accompanying software and makes no commitment to update or keep current the information contained in this document No part of this document may be copied or reproduced in any form without the prior written consent of Acromag Inc Copyright 2011 2013 Acromag Inc All trademarks are the property of their respective owners Acromag Inc Tel 248 295 0310 Fax 248 624 9234 Email solutions acromag com http www acromag com 3 PCI Windows Driver Software User s Manual Contents CONTENTS sce ctor ira te attra la ca ata ca cam tsi ete a akela taekan aiaia haai 3 de e re e EE 4 eo el RE TEE 5 Supported Programming LAnguagGes cccsscesseeeeeeeeeeeeeeeeee
10. XX h PClErrorCodes h to the project To do this open the Configuration Properties C C General property page and modify the Additional Include Directories property This can be a relative path dh e g C_include Add the path to the 64 bit import library PCIXXX lib to the project To do this open the Configuration Properties Linker General property page and modify the Additional Library Directories property This can be a relative path e g C_lib Win64 5 Select the Configuration Properties Linker Input property page and add the import library to the Additional Dependencies property e g PCI1408 lib 6 Include the windows h PCIXXX h and PClErrorCodes h header files at the beginning of your c C source code or cpp C source code files e g include lt windows h gt include PCI408 h include PCIErrorCodes h Acromag Inc Tel 248 295 0310 Fax 248 624 9234 Email solutions acromag com http www acromag com d 8 PCI Windows Driver Software User s Manual Deploying Applications to Target Systems This section outlines how to move your custom application from the development system to a target system where the driver software is not currently installed Kernel Driver Installation The kernel driver for the Acromag board is installed on the target using the procedure outlined in the Hardware Installation section The complete driver software package does not need to be i
11. XXX_WritePCIReg if an error occurred while writing data to the device s PCI configuration space ERR_EEPROM Returned by EEPROM write if the value read from the READBACK EEPROM does not match value written ERR_FILE_OPEN Returned if a file cannot be opened Returned if file contents are not in the expected format Returned if a file cannot be read Returned by functions if the configuration of a re configurable board is not complete ERR Ex DESIGN Returned by functions if a re configurable board is not configured with the Acromag supplied example design E 4 S i i 2 2 2 2 2 2 2 8 9 0 6 Acromag Inc Tel 248 295 0310 Fax 248 624 9234 Email solutions acromag com http www acromag com d 2 PCI Windows Driver Software User s Manual ERR_HARDWARE Returned if a hardware malfunction is detected 28 ERR FLASH BUSY Returned if a flash operation cannot be carried out because the flash chip is busy ERR_UNSUPPORTED Returned if the device does not support the requested action 31 ERR_HANDLER Returned if the function requires an interrupt handler and one has not yet been attached 3 ERR_INVALID_ Returned if the kernel driver control handle is invalid CTRLHNDL 29 i ERR_CHECKSUM Returned if a checksum mismatch is detected 5 Acromag Inc Tel 248 295 0310 Fax 248 624 9234 Email solutions acromag com http www acromag com d 9 PCI Windows Driver Software User s Manual Sequence of Operations Although each
12. ary With power off install the module into an available slot on the target system Connect any field wiring at this time 3 Turn on the system XP and Vista You will receive a dialog box shortly after boot up asking if you want to install a driver for the new device Answer yes and direct the New Hardware Wizard to the redist Driver subdirectory see table above or to the optical drive containing the PCI Windows Driver disk or to some other directory with the required files see note below The New Hardware Wizard will copy and install the kernel mode driver Windows 7 and 8 a Launch Device Manager from the Control Panel or type devmgmt msc in the Search Box b Locate and right click the PCI Data Acquisition and Signal Processing Controller select Update Driver and browse to the driver files as described for XP and Vista Note If you want to install the driver from a custom location e g a flash drive the following files must be present e The INF file for the board e g PciLX60 inf The same INF file is used to install both the 32 bit and the 64 bit drivers e The platform specific catalog file for the board e g PciLX60_x64 cat The catalog file is digitally signed by Acromag It should be placed in the same directory as the INF file e The platform specific kernel driver acrmgpci sys and co installer acrmgcls dll The kernel driver and co installer must be placed in a subdirectory relative to the INF a
13. back See Callback Functions below When an interrupt occurs the following sequence of events takes place 1 The kernel level driver disables the board s Interrupt Enable bit and signals the DLL s internal interrupt service routine ISR 2 At this point three things can happen a If no callback was configured the ISR simply processes the interrupt and then re enables the board s Interrupt Enable bit b If a callback function was configured but should not override the internal ISR the internal ISR processes the interrupt re enables the board s Interrupt Enable bit and then invokes the callback c If acallback function was configured to override the internal ISR the ISR invokes the callback and then immediately returns without further processing It is then the responsibility of the callback function to process the interrupt and re enable the Interrupt Enable bit Note The DLLs for user programmable FPGA boards include only a bare bones ISR When using interrupts applications for these boards must include a callback function to implement the custom ISR logic In other word overriding the internal ISR is mandatory CALLBACK FUNCTIONS When using the callback mechanism your application defines a function that the DLL will call from its internal interrupt service routine The format of this function must exactly match that expected by the DLL This format is hardware specific and is given in the PCIXXX_SetUserCallback topic
14. calling convention Any programming language capable of calling the Windows API DLL functions should be able to call the PCISW API DLL functions in a similar manner Acromag Inc Tel 248 295 0310 Fax 248 624 9234 Email solutions acromag com http www acromag com 6 PCI Windows Driver Software User s Manual Getting Started Software Installation To install the PCI Windows Driver software on the development system insert the software disk into the CD drive and run Setup exe Note that administrative rights are required to perform the installation Note The installation CD is used to install the complete driver software package on the development system the system where your application will be written and built Often the target system the system where your application will run will be different than the development system If your development and target systems are different you will also want to read the Deploying Applications to Target Systems section of this document INSTALLED SOFTWARE Program Menu Shortcuts e Shortcut to installation directory see below e Shortcut to this manual e Shortcut to Enumeration utility optionally installed if the driver software and OS are runtime compatible e Shortcut to executable demonstration programs optionally installed if the driver software and OS are runtime compatible Installed Files PCISW API WIN32 The default installation directory is C Acromag PCISW_API_ WIN32
15. connecting to the device This will occur if the specified card number is invalid or if the kernel mode drivers are not properly installed or configured Returned by PCIXXX Open UH an error occurred mapping the devices physical memory into the virtural address space 4 Returned by PCIXXX_Open if the maximum number of handles have already been allocated ERR_BAD_PARAM Returned by a function if it received an invalid parameter This typically means the parameter was outside of the expected range or the function received a NULL pointer Consult the individual function descriptions for other possible reasons for this error 3 4 15 a 17 Returned by PCIXXX_ReadPCIReg if an error occurred while reading data from the device s PCI configuration space Returned by a function if it timed out before completing ndicates an error generating or using calibration data ERR_BUFFER Indicates an error occurred accessing a user defined data fe err leat Returned by a DMA function if a DMA buffer is not mapped into the process Returned by EEPROM access functions if an Acknowledge is expected but not received 1 5 0 1 ERR_INSUF Returned by a function if there were insufficient resources RESOURCES to create a required data structure or carry out an operation ERR_CONFIG SET Returned by a Configuration function if the current settings used by this function do not represent a valid configuration ERR _CONFIG_WRITE Returned by PCI
16. earch order is as follows The directory from which the application is loaded The system directory e g C Windows system32 The 16 bit system directory e g C Windows system The Windows directory e g C Windows The current directory The directories listed in the PATH environment variable DOV ON reg The easiest solution to sharing a DLL is to place it in the Windows or Windows system directory However many applications store DLLs in these directories so using these locations creates the most risk for DLL conflict issues Acromag Inc Tel 248 295 0310 Fax 248 624 9234 Email solutions acromag com http www acromag com d 9 PCI Windows Driver Software User s Manual The technique used by the PCI Windows Driver Software installer is to append the common DLL directory typically C Acromag PCISW_API_WIN32 redist DLLs Win32 or C Acromag PCISW_API_WIN64 redist DLLs Win64 to the PATH environment variable This allows the appropriate DLL to be located when running each example project MODIFYING THE PATH SETTING Use the following steps if you wish to modify the PATH setting on a target machine Windows XP Vista 7 and 8 1 Launch the System applet from the Windows Control Panel 2 Select the Advanced link or tab and then click the Environment Variables button 3 Locate Path in the User Variables or System Variables The PATH is a series of one or more directories separated by semicolons 4 Edit the variable
17. eeeeeeeeeeeeeeeeeeeeeeeeeeeeenneees 5 GOING Stare EE 6 Software Installations steet e ckae desst Zero Zecee ee Eee dee Ce 6 Installed Software wii ccscccscees cocks Coccecteeteeite wedcceeyvetdaetavedoceesuebdecesacecedesenceves seteeestielecversetceees 6 Program M nu Snorteuts ifcccscedsscceceecescedence es GEESS unano pasao aoea SEENEN 6 Installed Files PCISW API WIN32 ss sssssssssssssssssssssssscsesssssssseaeacscsesessssseaeaesesesesesseseatanacseees 6 Installed Files PCISW API WINGA ss ssssssscssssssssssssssesesesessssssesescsnsesssesesseaeaesceesesesseseacansnssees 7 Hardware lnstallatteon ve eege eg EK EESeeEN ENEE eeh eN Ree CNN 8 PCI Enumeration UN i035 ccc chee ae ee i ok eet 9 Demonstratioun tees es est eee es Aa ek 9 Where to Go From Here c2sssccsccececccecs dvezcisseccsecsessesesteccecctsasyesevsesecestetecs sstesdeeeseonterss 9 Slkiulicldche UE 10 Function Format ue Seege SE ENEE ENEE See DEENEN 10 Status e E 11 Sequence of Operations i caieccetes tied eer eee eee 13 Ur 14 Callback Functions ek KEEN NEEN esseeccienenteuesesduets NEEN KEEN SEENEN KEES NEE ebe 14 SYMCHTOMIZACION tegt cess te eninneeeecentee et sens ch ENEE dene aeo Erea oep deters Edrei nn nEn sansa E 15 Base Address POInters enges Ee eee eebe ec 15 Using the Library with Visual C cccecceeesseeeeeeeeeeeeeeeeeeeeeseeeeeeeeeeeeeeeeeees 16 PGISW API WINS2 E eteEReENNNeEed REENEN ENEE ENN e degkeee eg 16 PCISW API WING4
18. ftware library PCISW API WIN The documentation set also includes an Upgrading from PCISW API WIN document which describes the differences between the old and new libraries and outlines how to upgrade applications written against the old library Acromag Inc Tel 248 295 0310 Fax 248 624 9234 Email solutions acromag com http www acromag com 5 PCI Windows Driver Software User s Manual Supported Hardware The list of supported PCI and PCle devices is shown in Table1 Table 1 Acromag PCI and PCle Modules Description 8 Ch 16 Bit DAC Outputs PCI330 16 Bit 16DE 32SE Analog Input Module PCI341 12 14 Bit 16DE Simultaneous Analog Input Module PCI408 32 Non Iso Digital Inputs Outputs Low Side Sw PCl424 Differential UO Counter Timer Module PCI464 Digital UO Counter Timer Module PCl482 10 16 bit counters TTL PC1483 4 16 bit counters TTL and 4 32 bit counters RS422 PCl484 6 32 bit counters RS422 PCI520 8 Channel Serial 232 Communication PCI521 8 Channel Serial 422 485 Communication PCI730 Multi Function Input Output Board PCIDX501 econfigurable 500K gates 64 TTL I O PCIDX502 econfigurable 500K gates 32 Differential I O PCIDX503 econfigurable 500K gates 24 Differential 16 TTL I O PCIDX2001 econfigurable 2M gates 64 TTL I O PCIDX2002 econfigurable 2M gates 32 Differential I O PCIDX2003 econfigurable 2M gates 24 Differential 16 TTL I O PCILX40 ser configurable Virtex 4 FPGA with 41 472
19. igurations 4 Add the path to the necessary header files PCIXXX h PClErrorCodes h to the project To do this open the Configuration Properties C C General property page and modify the Additional Include Directories property This can be a relative path e g C_include Add the path to the 32 bit import library PCIXXX lib to the project To do this open the Configuration Properties Linker General property page and modify the Additional Library Directories property This can be a relative path e g C_lib Win32 5 Select the Configuration Properties Linker Input property page and add the import library to the Additional Dependencies property e g PCI408 lib 6 Include the windows h PCIXXX h and PClErrorCodes h header files at the beginning of your c C source code or cpp C source code files e g include lt windows h gt include PCI408 h include PCIErrorCodes h Acromag Inc Tel 248 295 0310 Fax 248 624 9234 Email solutions acromag com http www acromag com d 7 PCI Windows Driver Software User s Manual PCISW API WIN64 Open a new or existing Visual C project Open the project s property pages Confirm the Platform drop down is set to x64 and the Configuration drop down is set to All Configurations If x64 is not available you will need to create the new platform in Configuration Manager 4 Add the path to the necessary header files PCIX
20. nd catalog files The 32 bit files must be in a subdirectory named i386 and the 64 bit files must be in subdirectory named amd64 Acromag Inc Tel 248 295 0310 Fax 248 624 9234 Email solutions acromag com http www acromag com 9 PCI Windows Driver Software User s Manual PCI Enumeration Utility PCI Windows Driver Software includes a command line utility PCIEnum exe which may be run to display basic information about all installed Acromag PCI modules Running this utility is a quick way to verify that the device driver and boards are properly installed The displayed information includes the board name board number and the address and length of each memory range present The board number is the value passed to the PCIXXX_Open function to open a connection to the device See the Sequence of Operations section below Demonstration Programs Console demonstration programs Source code provided are included for each Acromag board Use the demo program to test your board and to become familiar with how it operates Tip Some of the more complicated demos include instructions on the main menu to walk you through some basic operations Rather than jump back and forth between the instructions and the other menus open two instances of the program and use one to display the instructions and the other to communicate with the board In some cases the main demo source file PCIxxxDemo c will include comments with additional inf
21. nstalled on the system Direct the New Hardware or Update Driver Software wizard to the PCI Win32 Win64 Driver disk or to some other directory where the required files can be found The acrmgpci sys driver will be installed to the windows system32 drivers directory Application and DLL Installation The following files must be installed on the target machine e Your application program e All DLL s corresponding to the PCI modules you are using Copy these from the redist DLLs folder on the development system These are typically installed in your application s directory e The PCI DLLs are dependent upon the Microsoft C Runtime Library msvcr100 dll If this file is not already present on the target it can be copied from the redist DLLs folder on the development system Place the file in your application s directory e f your application program is dependent on additional components those will need to be installed on the target system as well DLL Location Notes To reduce the likelihood of DLL Conflict issues Microsoft recommends that DLLs be installed to the application directory with the program executable This is the preferred location when running a single executable However if several applications will be simultaneously sharing a PCI DLL it is recommended that the DLL be placed in a common directory In order for the operating system to find a DLL its location must be part of the Windows search order The typical s
22. ons of a single copy of a DLL in memory Function Format All PCI DLL functions have the following form status PCIXXX FunctionName argl arg2 argn The PCIXXX portion of the function name indicates the PCI module the function is used with e g PMC464 Note that functions for PCI Express modules have a PCleXXX prefix Every function returns a 32 bit status value This value is set to 0 when a function completes successfully or to a negative error code if a problem occurred The following Status Codes section describes the values that may be returned from the DLL functions For most functions arg1 is an integer handle used to reference a specific PCI module See the Sequence of Operations section below Acromag Inc Tel 248 295 0310 Fax 248 624 9234 Email solutions acromag com http www acromag com 1 PCI Windows Driver Software User s Manual STATUS CODES The table below summarizes the 32 bit status codes that may be returned from the DLL functions Please note the return code of any failing functions if you should need to contact Acromag for technical support Value _ Mnemonic _ _ Description ERR OK Operation Successful ERR INVALID HNDL Returned if no board is associated with the specified handle Applies to most functions 2 Returned by PCIXXX Open if board is already open This can occur if the board is in use by another application Returned by PCIXXX Open if an error occurred
23. ormation necessary for running the demo e g how channels should be wired together Where to Go From Here 1 Read the remainder of this document It covers general concepts for using the software 2 Read the function reference document for the library you will be developing with 3 Study the source code for the demonstration program corresponding to your board You can use this code as a starting point for your custom application Acromag Inc Tel 248 295 0310 Fax 248 624 9234 Email solutions acromag com http www acromag com d 0 PCI Windows Driver Software User s Manual Software Overview The software includes 32 bit or 64 bit DLLs for each Acromag PCI module In most cases the name of the DLL matches the name of the PCI module For example the PMC464 is used with PCI464 dll There are a few exceptions however where groups of similar PCI modules are supported by a single DLL These include PCI Modules Shared DLL DX Series PCIDX dll LX and SX Series PCILX dll PCI VLX and VSX Series PCIVLX dll PCle SLX Series PCleSLX dll PCle VLX Series PCleVLX dll PCle 6VLX Series PCle6VLX dll The DLLs provide the Application Programming Interface API used to access the hardware Each DLL is written in C and contains functions using the _stdcall calling convention The DLL is loaded and linked at runtime when its functions are called by an executable application Multiple applications can access the functi
Download Pdf Manuals
Related Search