Windows 98\NT\2K\XP Driver User Manual
Contents
1. 4 10 8 SIO4_Attach_Interrupt Attaches a user handle to a specified interrupt Prototype U32 GIO4 Attach_Interrupt U32 BoardNumber HANDLE userHandle INTR_TYPE ullnterrupt U32 ulLocallntr Returns Error code or 0 Where BoardNumber Defines board number to be used by the driver for a particular device userHandle User supplied handle to attach to the interrupt ullnterrupt Interrupt type to attach to valid for Local DmaCh0 DmaCh1 ulLocallntr Local interrupt to attach to if ullnterrupt Local 25 General Standards Corporation Phone 800 653 9970 PLXSW SIO4 User Manual Revision 1 00 5 Driver Installation This section details driver installation on the target system Any current driver previously installed for the SIO4 must be uninstalled prior to this installation to avoid interference To install the driver API and associated example files insert the CD ROM into the drive and close the bay The installation should commence automatically and display user prompts Follow the onscreen instructions to complete the installation Should the installation fail to automatically start Select Start gt Run gt Browse on the Windows toolbar popup and browse to find Setup exe on the CD ROM Click on OK to commence the installation The following files are installed on the target system OS dependent PciSlO4 sys OS dependent PIxApi dll Program Files General Standards SIO4 C Examp2. Value to write to the selected register Refer to the SIO4 user manual for all register bit definitions 16 General Standards Corporation Phone 800 653 9970 PLXSW SIO4 User Manual Revision 1 00 4 9 SIO04_Close Closes the device handle and frees the resources Prototype U32 SI04_Close U32 BoardNumber Returns Error code or 0 Where BoardNumber Defines board number to be used by the driver for a particular device 17 General Standards Corporation Phone 800 653 9970 PLXSW SIO4 User Manual Revision 1 00 4 10 Interface Functions These functions allow the user to perform certain operations on the board without having to keep track of individual register values and bit definitions 4 10 1 GIO4 Board_Reset Perform a reset on all Serial Channels of the board Prototype U32 SIO4 Board Reser U32 BoardNumber Returns Error code or 0 Where BoardNumber Defines board number to be used by the driver for a particular device 18 General Standards Corporation Phone 800 653 9970 PLXSW SIO4 User Manual Revision 1 00 4 10 2 Sl04_Open_DMA_Channel Opens a DMA channel for subsequent data transfers Prototype U32 GIO4 Open DMA Channel U32 BoardNumber U32 ulDMAChannel Returns Error code or 0 Where BoardNumber Defines board number to be used by the driver for a particular device ulDMAChannel DMA channel to open valid for 0 or 1 19 General Standards Corpo
3. Must have been previously opened or an error returned Prototype U32 SIO4_Close_DMA_Channel U32 BoardNumber U32 ulDMAChannel Returns Error code or 0 Where BoardNumber Defines board number to be used by the driver for a particular device ulDMAChannel DMA Channel Valid for 0 or 1 22 General Standards Corporation Phone 800 653 9970 PLXSW SIO4 User Manual Revision 1 00 4 10 6 SlO4 Enablelnterrupt Enables the desired interrupt in the local register and for the PCI bus See SIO4 User manual for interrupt sources Unused interrupts should be disabled to maximize performance Prototype U32 GIO4 Enablelnterrupt U32 BoardNumber U32 ulValue Returns Error code or 0 Where BoardNumber Defines board number to be used by the driver for a particular device ulValue The desired interrupt value to set valid for O OxFFFF 23 General Standards Corporation Phone 800 653 9970 PLXSW SIO4 User Manual Revision 1 00 4 10 7 SlO4_Disablelnterrupt Disables specified interrupt s in the local register and for the PCI bus Prototype U32 S104 _Disablelnterrupt U32 BoardNumber U32 ulValue Returns Error code or 0 Where BoardNumber Defines board number to be used by the driver for a particular device ulValue The desired interrupt value to clear valid for 0 OxFFFF 24 General Standards Corporation Phone 800 653 9970 PLXSW SIO4 User Manual Revision 1 00
4. General Standards Corporation Phone 800 653 9970 PLXSW SIO4 User Manual Revision 1 00 4 1 SIO4_FindBoards Detects all PLX Devices connected via the PCI Bus Prototype U32 S104 FindBoards char pDevicelnfo U32 ulError Returns Total number of PLX boards found in the system or 1L if error or no boards found Where pDevicelnfo Contains Board Bus Slot Type Ser info for PLX boards found ulError Returns 0 or error code Refer to tools h for a list of error codes 9 General Standards Corporation Phone 800 653 9970 PLXSW SIO4 User Manual Revision 1 00 4 2 SI04_Open Initializes Handle for the passed board number IN THE DRIVER Prototype U32 SIO4 Open U32 BoardNumber Returns Error code or 0 Where BoardNumber Defines board number to be used by the driver for a particular device Refer to tools h for a list of error codes 10 General Standards Corporation Phone 800 653 9970 PLXSW SIO4 User Manual Revision 1 00 4 3 SIO4_ReadLocalRegister Read a value from the board local register Prototype U32 SIO4_ReadLocalRegister U32 BoardNumber U32 ulRegister U32 pulError Returns Value Read from Register Where BoardNumber Defines board number to be used by the driver for a particular device ulRegister Local Register to read Values defined in SlO4interface h pulError Returns 0 or error code Refer to tools h for a list of error co
5. Manual Revision 1 00 1 Scope The Purpose of this document is to describe how to interface with the SIO4 Windows Driver API developed by General Standards Corporation GSC This software provides the interface between the Application Software and the SIO4 board The SIO4 Driver API Software executes under control of the Windows Operating System The SIO4 is implemented as a standard Windows driver API written in C programming language The SIO4 Driver API Software is designed to operate on CPU boards containing x86 processors The SIO4 Driver consists of a Windows driver with an interface layer GSC API to simplify the interface to the PLX Driver While an application may interface directly to the PLX driver interfacing to the GSC API layer will simplify the application software development 4 General Standards Corporation Phone 800 653 9970 PLXSW SIO4 User Manual Revision 1 00 Hardware Overview The S104 board is a four channel serial interface card which provides high speed full duplex multi protocol serial capability for PCI applications The SIO4 combines two multi protocol Dual Universal Serial Controllers USC and 8 external FIFOs to provide four fully independent asynchronous or synchronous RS422 RS485 serial channels These features along with a high performance PCI interface engine give the SIO4 unsurpassed performance in a serial interface card The SIO4 incorporates the following features F
6. ReadConfigRegister Reads PCI Configuration registers from one SIO4 card 104_WriteLocalRegister Writes PCI Configuration Registers of one SIO4 card 104_Enablelnterrupt Enables a desired interrupt 104_Disablelnterrupt Disables a desired interrupt 104_Attach_Interrupt Attaches a user handle to a specified interrupt SIO4 _Dma_Mode Configures the DMA transfer mode Demand Mode or Non Demand Mode DMA operation e 104 Open_DMA_Channel Opens a DMA channel to transfer of data to or from the SIO4 two DMA channels are available on the SIO4 cards e 104 _DMA_From_FIFO Transfers data from the SIO4 channel FIFO to user memory e SIO4 _DMA_To_FIFO Transfers data to the SIO4 channel FIFO from user memory e 104 Close DMA Channel Closes a DMA channel The user MUST call Find Boards to determine what PLX devices are installed in the system and get the associated board number The user then calls the Open function with each board number to be used This function obtains a handle to the device and initializes the device parameters within the API driver The user is then free assuming no errors to write read the registers as desired The user should always call Close when done to free resources prior to exiting The function definitions and parameters are defined in the following paragraphs of this section 7 General Standards Corporation Phone 800 653 9970 PLXSW SIO4 User Manual Revision 1 00 8
7. SIO4 4 Channel High Speed Serial Interface Windows 98 NT 2K XP Driver User Manual Manual Revision August 29 2003 General Standards Corporation 8302A Whitesburg Drive Huntsville AL 35802 Phone 256 880 8787 Fax 256 880 8788 URL http www generalstandards com E mail sales generalstandards com E mail support generalstandards com Preface Copyright 2003 General Standards Corporation Additional copies of this manual or other literature may be obtained from General Standards Corporation 8302A Whitesburg Dr Huntsville Alabama 35802 Phone 256 880 8787 FAX 256 880 8788 URL http www generalstandards com E mail sales generalstandards com General Standards Corporation makes no warranty of any kind with regard to this material including but not limited to the implied warranties of merchantability and fitness for a particular purpose Although extensive editing and reviews are performed before release to ECO control General Standards Corporation assumes no responsibility for any errors that may exist in this document No commitment is made to update or keep current the information contained in this document General Standards Corporation does not assume any liability arising out of the application or use of any product or circuit described herein nor is any license conveyed under any patent rights or any rights of others General Standards Corporation assumes no responsibility for any consequences
8. abVIEW LabWindows CVI etc 27 General Standards Corporation Phone 800 653 9970 PLXSW SIO4 User Manual Revision 1 00
9. ates the user from operating system specific requirements allowing the API to be used with all Windows operating systems 98 NT W2K XP The SIO4 Win Driver provides an interface to a SIO4 card and a Windows application which run on a x86 target processor The driver is installed and devices are created when the driver is started during boot up The functions of the driver can then be used to access the board Devices are created with the name board x where x is the device number Device numbers start at 1 and for each board found the device number will increment Included in the board diver software is a menu driven board application program This program is delivered undocumented and unsupported but may be used to exercise the card and the device driver It can also be used as an example for programming the SIO4 device The user interfaces to the GSC API at the basic level with the following functions 104_FindBoards Detects all SIO4 Devices connected via the PCI Bus GIO4 Open Opens a driver interface to one SIO4 card 104_Close Closes a driver interface to one SIO4 card Sl04_Board_Reset Perform a reset on all Serial Channels of the board 104_ReadLocalRegister Reads local registers from one SIO4 card 104_WriteLocalRegister Writes to local Registers of one SIO4 card 104_ReadUSCRegister Reads USC registers from one SIO4 card 104_WriteUSCRegister Writes to USC Registers of one SIO4 card 104_
10. des 11 General Standards Corporation Phone 800 653 9970 PLXSW SIO4 User Manual Revision 1 00 4 4 SIO04_WriteLocalRegister Write a value to the board local register Prototype U32 SIO4_WriteLocalRegister U32 BoardNumber U32 ulRegister U32 ulValue Returns Error code or 0 Where BoardNumber Defines board number to be used by the driver for a particular device ulRegister Register to write Values defined in SlO4interface h ulValue Value to wite to the selected register Refer to the SIO4 user manual for all register bit definitions 12 General Standards Corporation Phone 800 653 9970 PLXSW SIO4 User Manual Revision 1 00 4 5 SIO4_ReadUSCRegister Read a value from the board USC register Prototype U32 SIO4_ReadUSCRegister U32 BoardNumber U32 ulChannel U32 ulRegister U32 pulError Returns Value Read from Register Where BoardNumber Defines board number to be used by the driver for a particular device ulChannel Serial Channel Registers are channel specific ulRegister USC Register to read Values defined in SlO4interface h pulError Returns 0 or error code Refer to tools h for a list of error codes 13 General Standards Corporation Phone 800 653 9970 PLXSW SIO4 User Manual Revision 1 00 4 6 SIO4_WriteUSCRegister Write a value to the board USC register Prototype U32 SIO4_WriteUSCRegister U32 U32 U32 U32 Returns Erro
11. l Standards Corporation PLX and PLX Technology are trademarks of PLX Technology Inc 2 General Standards Corporation Phone 800 653 9970 PLXSW SIO4 User Manual Revision 1 00 Table of Contents Pons 5 6 SCOPC E 4 Hardware Overview ENEE 5 Referenced Documents EE En 6 General Standards AR EE EE 7 4 1 SO Eindosargett ugereegt Klee degen vaca dene Seeee ewes 8 4 2 SIDA OPON DEE 9 4 3 SIO4 ReadLocalRegister 2 cccceceeeeeeeeeeeeeeeeeeeeeeeeeeeeeeneeees 10 4 4 SIO4_WriteLocalRegister 0 cececeeeeeeeeeeeeeeeeeeeeeseeeseseeeeeeees 11 4 5 SIO4 ReadUSCRegister 2 2 0cececeeeeeeeceeeeeeee senses eeeeeeeeeeeeees 12 4 6 SIO4 WrttelGChegister NENNEN NEE En 13 4 7 SIO4_ReadConfigRegister 2 ccccceeeeeceeeeeeeeeeeeeeeeeeeeeeeeeeeeees 14 4 8 GIO4 WrtteContiobegistert NEEN 15 4 9 SIO4 Close EE 16 4 10 Interface Functons EEN 17 4 10 1 SlO4 Board Besen ENEE 17 4 10 2 SIlO4 Open DMA Channel NEE 18 4 10 3 GIO4 DMA From EIFOI NEE 19 4 10 4 SlO4_DMA_To_FIFO h E A S EER SE GEN 20 4 10 5 SlO4 Close DNA Channel NEEN 21 4 10 6 SlO4_ Enabielnterrupt REENEN 22 4 10 7 GIO4 Disabielnterrupt NEEN 23 4 10 8 SlO4 Attach_Interrupt cceeee eee e eee e eee eee eee eee eee 24 Driver Installati n ire stenene cee NENNEN ENNEN NENNEN ENNEN 25 Example Programm eege see EE SEENEN e eege 26 3 General Standards Corporation Phone 800 653 9970 PLXSW SIO4 User
12. le exe Program Files General Standards SIO4 C SIO4 Driver C d Program Files General Standards SIO4 C SIO4 Driver C lib Program Files General Standards SlO4 C SlO4intface h Program Files General Standards SIO4 C SIO4 Example c Program Files General Standards SIO4 C Tools c Program Files General Standards SlO4 C Tools h Program Files General Standards SlO4 C CioColor h Program Files General Standards SlO4 C SlO4Cdriver inf 26 General Standards Corporation Phone 800 653 9970 PLXSW SIO4 User Manual Revision 1 00 6 Example Program This section describes the example program and the files required to develop an application The complied example program allows the user to exercise the installed device while observing the I O To execute double click on Example exe Refer to the Driver Installation section for file location The source is provided to educate the user with the GSC API function calls and provide a working example to aid the user with application development To build the example program using MS Visual C create a project and add the following files Source Files SIO4 Example c Tools c Header Files SlO4intface h CioColor h Tools h Resource Files SIO4 Driver C lib Select Build gt ProjectName exe on the toolbar NOTE SIO4 Driver C dll must be in the project directory to run the example Contact GSC for example programs drivers for other development environments i e L
13. our Independent Multi Protocol Serial Channels Synchronous Serial Data Rates up to 10 Mbits sec Asynchronous Serial Data Rates up to 1 Mbit sec SCSI II type 68 pin front edge I O Connector with optional cable adapter to four DB25 connectors Independent Transmit and Receive FIFO Buffers for each Serial Channel Up to 32k Deep Each Fast RS485 RS422 Differential Cable Transceivers to Provide Increased Noise Immunity Two Industry Standard Zilog Z16C30 Multi Protocol Universal Serial Controllers USC Serial Mode Protocols include Asynchronous Bisync SDLC HDLC Ethernet and Nine Bit Parity and CRC detection capability Two Serial Clocks Two Serial Data signals Data Carrier Detect and Clear To Send per Channel Dual PCI DMA Engine to speed transfers and minimize host I O overhead Four Programmable Oscillators provide increased flexibility for Baud Rate Clock generation Chi Sample Block Diagram of SIO4 PMC SIO4AR used as example 5 General Standards Corporation Phone 800 653 9970 PLXSW SIO4 User Manual Revision 1 00 3 Referenced Documents The following documents provide reference material for the DMI32 board e PCI SIO4 User s Manual GSC e PLX Technology Inc PCI 9080 PCI Bus Master Interface Chip data sheet 6 General Standards Corporation Phone 800 653 9970 PLXSW SIO4 User Manual Revision 1 00 4 General Standards API This section describes the interface to the SIO4 GSC API The SIO4 GSC API isol
14. r code or 0 Where BoardNumber ulChannel ulRegister ulValue BoardNumber Defines board number to be used by the driver for a particular device ulChannel Serial Channel Registers are channel specific ulRegister Register to write Values defined in SlO4interface h ulValue Value to write to the selected register Refer to the SIO4 user manual for all register bit definitions 14 General Standards Corporation Phone 800 653 9970 PLXSW SIO4 User Manual Revision 1 00 4 7 SIO4_ReadConfigRegister Read a value from the board PCI Configuration register Prototype U32 SI04_ReadConfigRegister U32 BoardNumber U32 ulRegister U32 pulError Returns Value Read from Register Where BoardNumber Defines board number to be used by the driver for a particular device ulRegister PCI Configuration Register to read Refer to Users Manual pulError Returns 0 or error code Refer to tools h for a list of error codes 15 General Standards Corporation Phone 800 653 9970 PLXSW SIO4 User Manual Revision 1 00 4 8 SI04_WriteConfigRegister Write a value to the board PCI Configuration register Prototype U32 SIO4_WriteConfigRegister U32 BoardNumber U32 ulRegister U32 ulValue Returns Error code or 0 Where BoardNumber Defines board number to be used by the driver for a particular device ulRegister Register to write Refer to Users Manual ulValue
15. ration Phone 800 653 9970 PLXSW SIO4 User Manual Revision 1 00 4 10 3 S104_DMA_From_FiFO Transfers data from the SIO4 channel FIFO to user memory DMA channel must have been previously opened Prototype U32 SIO4_DMA_From_FIFO U32 U32 U32 U32 U32 Returns Error code or 0 Where BoardNumber ulSerChannel ulDMAChannel ulWords uData BoardNumber Defines board number to be used by the driver for a particular device ulSerChannel Serial Channel Valid for 1 4 ulDMAChannel DMA Channel Valid for 0 or 1 ulWords Words to transfer uData Pointer to user memory buffer 20 General Standards Corporation Phone 800 653 9970 PLXSW SIO4 User Manual Revision 1 00 4 10 4 SIO4 DMA_To_FIFO Transfers data from user memory to the SIO4 channel FIFO DMA channel must have been previously opened Prototype U32 SIO4 _DMA_To_FIFO U32 U32 U32 U32 U32 Returns Error code or 0 Where BoardNumber ulSerChannel ulDMAChannel ulBytes uData BoardNumber Defines board number to be used by the driver for a particular device ulSerChannel Serial Channel Valid for 1 4 ulDMAChannel DMA Channel Valid for 0 or 1 ulWords Words to transfer uData Pointer to user memory buffer 21 General Standards Corporation Phone 800 653 9970 PLXSW SIO4 User Manual Revision 1 00 4 10 5 GIO4 Close DMA Channel Closes the DMA channel
16. resulting from omissions or errors in this manual or from the use of information contained herein General Standards Corporation reserves the right to make any changes without notice to this product to improve reliability performance function or design ALL RIGHTS RESERVED The Purchaser of this software may use or modify in source form the subject software but not to re market or distribute it to outside agencies or separate internal company divisions The software however may be embedded in the Purchaser s distributed software In the event the Purchaser s customers require the software source code then they would have to purchase their own copy of the software General Standards Corporation makes no warranty of any kind with regard to this software including but not limited to the implied warranties of merchantability and fitness for a particular purpose and makes this software available solely on an as is basis General Standards Corporation reserves the right to make changes in this software without reservation and without notification to its users The information in this document is subject to change without notice This document may be copied or reproduced provided it is in support of products from General Standards Corporation For any other use no part of this document may be copied or reproduced in any form or by any means without prior written consent of General Standards Corporation GSC is a trademark of Genera
Download Pdf Manuals
Related Search