DIO-BM(PCI/C-PCI)Linux/RT GPH-2X72C. Bus Master Digital Input/Output Board Driver Software for Linux/RTLinux. Help for Linux.

Transcription

1 DIO-BM(PCI/C-PCI)Linux/RT GPH-2X72C Bus Master Digital Input/Output Board Driver Software for Linux/RTLinux Help for Linux

2 -Contents- Chapter 1 Introduction Summary Features... 4 Chapter 2 Product Specifications Operating Environments Target Boards Functional Specifications... 6 Chapter 3 Installation and Board Configuration Installing the Linux Driver Software Loading the Driver Modules Configuring the Device Numbers Programming Compiling the Program Running the Program Programming Guide Initializing a Board Configuring the Operation Mode Start, Suspension, and Termination Conditions Bus Master Transfer Buffer Configuring Interrupt Handling Starting of the Bus Master Transfer Closing the Board x86_64 and PAE Environments CardBus ID Number Configuration Chapter 4 Reference List of Functions DioBmOpen DioBmClose DioBmSetDeviceConfig DioBmGetDeviceConfig DioBmSetBufferConfig DioBmGetBufferConfig DioBmSetTriggerConfig DioBmGetTriggerConfig DioBmStart DioBmStop DioBmEnd DioBmSoftTrigger DioBmSetEventConfig DioBmGetEventConfig DioBmSetCounterEventConfig DioBmGetCounterEventConfig DioBmSetEvent DioBmKillEvent DioBmGetCounter DioBmGetStatus DioBmInputDword DioBmOutputDword DioBmGetLine DioBmSetLine DioBmGetDeviceInfo DioBmSetDeviceConfigEx DioBmGetDeviceConfigEx DioBmStopEx DioBmSoftTriggerEx DioBmSetEdgeEventConfig DioBmGetEdgeEventConfig DioBmSetEventEx DioBmSetFilter DioBmGetFilter DioBmClearSamplingOutput DioBmGetCommonPciDeviceInfo Structure DIOBMCONF Structure DIOBMTRIGCONF Structure DIOBMINFO Structure DIOBMCONFEX Structure Callback Routine

3 4.3.5 Event Callback Routine Set by the DioBmSetEvent Extension Callback Routine Set by DioBmSetEventEx Return Values Data Format Board and Channels Data Packing Kylix Function Definitions Example Test Driver Chapter 5 Sample Programs DiBm.c DiBm_pae.c DoBm.c DoBm_pae.c ExBm.c ExBm_pae.c exbm_event.c exbm_event_pae.c Sampling.c Sampling_pae.c patternout.c patternout_pae.c Sample Programs for Kylix Chapter 6 Utility Program Bus Master Digital Input Utility Program Starting the Bus Master DI Utility Program Selecting the Device Checking the Input Functionality Bus Master Digital Output Utility Program Starting the Bus Master DO Utility Program Selecting the Device Checking the Output Functionality Chapter 7 Important Information Limited Warranty Copyrights and Intellectual Property Rights Warning Regarding Medical and Clinical Use of Our Products Prohibition of Reproduction Limitation of Liability Trademark

4 Chapter 1 Introduction 1.1 Summary The GPH-2X72C software controls Interface bus master digital input/output device from Linux application or RTLinux module. This document includes the information for using the GPH-2X72C on Linux. 1.2 Features - The GPH-2X72C can transmit data directly to the data area of specified user-space at the digital input. For digital input, the GPH-2X72C can transmit the data to the data area of specified user-space directly. - The GPH-2X72C can transmit output data directly to the device from the data area of specified user-space. - The GPH-2X72C can call back the user-defined function when the bus master transfer starts or stops. - Unused control signals can be used as general purpose digital input/output pins. The available pins are limited depending on the operation modes and settings. - The Help system explains how to use the supported functions. Refer to it as you develop your programs. 4

5 Chapter 2 Product Specifications 2.1 Operating Environments The following table shows operating environments for the GPH-2X72C. Supported Computer Interface industrial controllers Interface Classembly Devices(R) PC/AT compatibles Driver Type Character driver Loading Method Loadable module (dynamic load/unload) Major Number Automatic assignment Source Code Open Policies Driver module: partially open Library source code: closed Common module: open Build Support Makefile provided Kernel Version IBM PC/AT compatible - Kernel 2.2.x - Kernel 2.4.x - Kernel 2.6.x Interface SH-CPU board - Interface SH-Linux Help File PDF format Note: For the CardBus series, use the program in Kernel 2.4/Kernel 2.6 and pcmcia-cs or later versions. If the CardBus card is not recognized in the above versions, confirm that the PCMCIA and CardBus are supported in the kernel configuration. Modify /etc/sysconfig/pcmcia file as follows and reboot the program. PCMCIA=yes PCIC=yenta_socket 2.2 Target Boards PCI series (PCI bus products) PCI-2172C, PCI-2472C, PCI-2772C LPC series (Low Profile PCI bus products) LPC , LPC PEX series (PCI Express bus products) PEX , PEX CPZ series (CompactPCI bus products) CPZ , CPZ CSI series (CardBus product products) CSI , CSI CBI series (CardBus products) CBI /TK/TKA/TL/TLA/TR, CBI /TK/TKA/TL/TLA/TR 5

6 2.3 Functional Specifications Function Number of Boards Transfer Mode Start and Termination Condition Trigger Delay Error Signal Output /Specification 16 boards (max.) Notes: - Up to 16 boards of the PCI-2172C and PCI-2472C can be used with any combination. - Up to 16 boards of the PCI-2772C, CPZ , CPZ , CBI/CSI /Tx, CBI/CSI /Tx, LPC/PEX , LPC/PEX can be used with any combination. You can select transfer mode according to your target. The following table shows the transfer mode. Sampling mode (with/without control signal) Input Mode Gated-sampling mode Strobe mode Request mode Pattern output mode (with/without control signal) Output Mode Gated-pattern output mode Strobe mode Request mode The program can specify the start and termination conditions independently. The program provides a software start command to start the data transfer and a software termination command to suspend or terminate the data transfer. The program also supports start and termination of the data transfer by the external signals. This function can put off sampling by the specified number or terminate the output. By configuring the program, it can output an error signal to outside when an over-run error or an under-run error occurs. 6

7 Chapter 3 Installation and Board Configuration 3.1 Installing the Linux Driver Software Install the board into the open slot according to the manual came with the board. Login to your Linux system as a super user %su Password: 3. Run Linux. 4. Install the Linux driver software according to the instructions of the installer. #bash install 3.2 Loading the Driver Modules When the installation destination is the default, a shell script for loading the driver module is copied to the following directory; /usr/src/interface/gpg2x72c/(architecture name * )/linux/drivers * * The architecture name is i386 in PC/AT compatible and sh4 in SH-4 CPU module. Run insdiobm.sh shell script for loading the driver modules. #cd /usr/src/interface/gph2x72c/<architecture name>/linux/drivers #sh insdiobm.sh 3.3 Configuring the Device Numbers 1. The GPH-2X72C cannot change the device number, but you should start the device number setting utility after installing this product. Load the device number utility with setup.sh. Run a shell script for loading the device number utility. #cd /usr/src/interface/gph2x72c/<architecture name>/linux/drivers #sh setup.sh 2. When the device number setting utility starts, the following information and prompt will be displayed. ************************************************** Setup Utility Version : Copyright 2003, 2005 Interface Corporation. All rights reserved. ************************************************** Enter a model number of the product : GPG/GPH- 7

8 3. Enter 2X72C and press the ENTER key. The software searches every Interface bus master digital input/output board installed on the system, and then displays information about them. =========================================== Ref.ID Model RSW1 CH Device No PCI -2172C PCI-2472C 1 2 =========================================== Code Ref. ID Model RSW1 CH Device No. Reference ID of the board Model number of the board which the system currently recognizes. RSW1 setting value Channel number Device number assigned to the board In the GPH-2X72C, the device number is fixed to the setting value of RSW ************* Command *************** 1. Change the device number. 2. Delete the device number. 3. Load new device setting file. 4. Run the initialization program. 5. Run the CardBus ID setup utility. 99. Exit the program. ************************************** Enter the command number: No. Command 1 Change the device number. Changes the device number of the board. 2 Delete the device number. Deletes the device number. To delete it, enter the ID of the board. To configure the device number again after deleting the device number here, execute dpg0101 again. 3 Load new device setting file. Loads other device setting file. Use it to construct the system with other category devices. 4 Run the initialization program. The GPH-2X72C does not support this command. Run the CardBus ID setup utility. Use the command to use multiple CardBus cards of the same type. 99 Exit the program. Exit the device number setting utility. * To load new devices into the system, prepare new device nodes for the devices with the device number configuration program. Do not change the load order of the device drivers. If the lord order changes while you use devices of multiple categories, set the load order back to the order when the device number configuration program was executed. If the load order of the device drivers needs to be changed, reconfigure the load order with the device number configuration program. 8

9 3.4 Programming This section explains how to write the program. Start the editor, then write the following codes. This example shows sampling processings on the PCI-2172C board whose RSW1 setting value is 0. When you use Kylix, refer to 4.6 Kylix. After writing the program, save this file named as samplingtest.c. #include #include <stdio.h> "FbiDioBm.h" int main(void) { int nret; /* Return value */ int i ; DIOBMCONF DevConf; /* Function setting structure */ DIOBMTRIGCONF TrigConf; /* Trigger condition setting structure */ unsigned int *dwbuffer; /* Bus master transfer buffer */ unsigned long dwstatus; /*A variable to store the status*/ unsigned long dwbuffersize; /* A variable to retrieve the status */ /* Initialize the board*/ nret = DioBmOpen( 1 ); if ( nret!= DIOBM_ERROR_SUCCESS ) { printf( Failed to open the board. n ); return -1; /* Exit program.*/ } DevConf.dwMode = DIOBM_MODE_SAMPLING; DevConf.dwRedirectWidth = DIOBM_WIDTH_DWORD; DevConf.dwEQConf = 0; DevConf.dwClock = DIOBM_CLK_100K; DevConf.dwSmplNum = 1024; DevConf.dwTimingOption = 0; DevConf.dwSTBConf = 0; DevConf.dwACKConf = 0; DevConf.dwREQConf = 0; DevConf.dwOREConf = 0; DevConf.dwUREConf = 0; /* Configure the operation mode.*/ nret = DioBmSetDeviceConfig(1, &DevConf); if (nret!= DIOBM_ERROR_SUCCESS) { printf( Failed to configure the operation mode. n ); return -1; /* Exit program.*/ } TrigConf.dwSoftTrigger = 0; TrigConf.dwStartLine = 0; TrigConf.dwEndLine = 0; TrigConf.dwStopLine = 0; TrigConf.dwTriggerDelayNum = 0; TrigConf.dwPatternEq = 0; TrigConf.dwPatternMask = 0; TrigConf.dwPatternData = 0; /* Trigger condition setting */ nret = DioBmSetTriggerConfig(1, &TrigConf); if (nret!= DIOBM_ERROR_SUCCESS) { printf( Failed to configure the trigger condition. n ); return -1; /* Exit program.*/ } /* Failed to configure the bus master transfer buffer. n */ 9

10 /*64 bit environment*/ #ifdef x86_64 nret = DioBmSetBufferConfig(1, (void*)-1, 1024 * sizeof(unsigned int)); if (nret!= DIOBM_ERROR_SUCCESS) { printf( Failed to configure the bus master transfer buffer. n ); return -1; /* Exit program.*/ } void* ptr; nret = DioBmGetBufferConfig(1, &ptr, &dwbuffersize); if (nret!= DIOBM_ERROR_SUCCESS) { printf( Failed to configure the bus master transfer address. n ); return -1; /* Exit program.*/ } dwbuffer = (unsigned int*)ptr; #else /*32 bit environment*/ dwbuffer = malloc(1024 * sizeof(unsigned int)) nret = DioBmSetBufferConfig(1, dwbuffer, 1024 * sizeof(unsigned int)); if (nret!= DIOBM_ERROR_SUCCESS) { printf( Failed to configure the bus master transfer buffer. n ); } #endif free(dwbuffer); return -1; /* Exit program.*/ /* Start sampling.*/ nret = DioBmStart(1); if (nret!= DIOBM_ERROR_SUCCESS) { printf( Failed to start sampling. n ); return -1; /* Exit program.*/ } /* wait for end */ do{ nret = DioBmGetStatus(1,&dwStatus); if (nret!= DIOBM_ERROR_SUCCESS) { printf( Failed to retrieve the status. n ); return -1; /* Exit program.*/ } }while(dwstatus & DIOBM_STATUS_ACTIVE_DMA); /* Display sampling data.*/ for (i = 0; i < 1024; i++) { printf( "%04d : %08Xh n", i+1, dwbuffer[i]); } #ifndef x86_64 free(dwbuffer); #endif /* Close the board.*/ nret = DioBmClose( 1 ); if ( nret!= DIOBM_ERROR_SUCCESS ) { printf( Failed to close the board. n ); return -1; /* Exit program.*/ } return 0; } Write the above code and save the file as samplingtest.c. 10

11 3.5 Compiling the Program Compile the program made in 3.4 Programming. Type the command as follows. #gcc -o samplingtest samplingtest.c lgpg2x72c 3.6 Running the Program After compilation, the samplingtest executable file is created. Run the program as follows. #./samplingtest The program controls the device as follows. Open > Configure the function > Configure trigger function > Configure bus master transfer destination buffer > Start sampling > Wait for bus master transfer completion > Display input data > Close device The console screen displays the sampling data. If the processing of function fails, an error message is displayed on the console screen. Refer to 3.7 Programming Guide, for more details of how to program. 3.7 Programming Guide This section explains how to use the provided functions. Sample codes are written in C. - PCI-2172C, PCI-2472C When you use two or more bus master digital I/O boards, PCI-2172C and PCI-2472C, set the RSW1 rotary switch on each board so as not to conflict with any other. The CardBus ID number and RSW1 setting values are used to uniquely identify each product in case multiple Interface CardBus cards of the same type are installed in the same system. If the numbers overlap, this program will not work normally. - PCI-2772C, CPZ , CPZ , CBI/CSI , CBI/CSI , LPC/PEX , LPC/PEX When you use two or more bus master digital I/O boards, set the setting value of RSW1 rotary switch on the PCI-2772C, CPZ , CPZ , LPC/PEX , LPC/PEX and the setting value of BoardID on the CBI/CSI , CBI/CSI so as not to conflict with any other. The combination of the PCI-2772C, CPZ , CPZ , CBI/CSI , CBI/CSI , LPC/PEX , and LPC/PEX can be expanded up to 16 boards or cards except the total number of the PCI-2172C and PCI-2472C Initializing a Board The DioBmOpen function initializes a board. nret = DioBmOpen( 1 ); Specify the device number of the device to be initialized to the parameter. The configurable device number is a decimal number from 1 through PCI-2172C, PCI-2472C The device number corresponds to the RSW1 value plus 1. The device can be used by specifying the RSW1 value plus 1. - PCI-2772C, CPZ , CPZ , CBI/CSI , CBI/CSI , LPC/PEX , LPC/PEX Device number is specified in the range of 17 through 48. When you use a board of PCI-2772C, CPZ , CPZ , CBI/CSI , CBI/CSI , LPC/PEX , LPC/PEX , the bus master digital input circuits and bus master digital output circuits are individually initialized as follows: Bus master digital input circuits: (RSW1 value * 2) + 17 Bus master digital output circuits: (RSW1 value * 2)

12 RSW1 Bus Master Digital Input Circuits Bus Master Digital Output Circuits 0h h h F Two or more processes can share the same bus master digital I/O device. The processes should arbitrate with each other to retain data consistency in the hardware and software configuration. The initialized device must be closed by the DioBmClose function before the application is terminated Configuring the Operation Mode The DioBmSetDeviceConfig function configures the transfer mode, transfer data unit, sampling rate, and control signals. When you use the PCI-2772C, CPZ , CPZ , CBI/CSI , CBI/CSI , LPC/PEX , or LPC/PEX , use the DioBmSetDeviceConfigEx function to configure them in details Start, Suspension, and Termination Conditions The DioBmSetTriggerConfig function configures the start, suspension, and termination conditions of the data transfer through the board to the application Bus Master Transfer Buffer The DioBmSetBufferConfig function specifies the memory information for bus master transfer. The specified data region is bus master transfer destination (for digital input) or bus master transfer source (for digital output). If you use this program in the x86_64 environment, refer to 3.8 x86_64 and PAE Environments Configuring Interrupt Handling The DioBmSetEvent function registers an interrupt service routine to be called, the place where to send a message. The GPH-2X72C supports events such as the start of a transfer event, end of a transfer event, end of a DMA event, and so on Starting of the Bus Master Transfer The DioBmStart function starts the bus master transfer. Once you have set the start condition by using the DioBmSetTriggerConfig function, the data transfer is delayed until the start condition satisfied Closing the Board The DioBmClose function closes the device and releases the resources. DioBmClose( 1 ); 12

13 3.8 x86_64 and PAE Environments In 64-bit OS and PAE environments (Interface Linux System6, Interface Linux System 7 with 4 GB or larger memory), DMA transfer is not available for the main memory region allocated in the user application. Our Linux driver performs DMA transfer to the physical memory region allocated in the Kernel. The location to allocate memory is in the 32-bit space. Upon the request in user application through the DioBmSetBufferConfig function, the driver maps the specified size of physical memory to the virtual address to make the memory accessible in user application. The DioBmSetBufferConfig function retrieves the initial address of the virtual memory as a pointer variable and directly accesses the data. 3.9 CardBus ID Number Configuration The CardBus ID Number Configuration utility is used to use multiple CardBus products of the same type. It configures different ID number for each CardBus product. [How to operate] Run the CardBus ID Number Configuration utility. #dpg0101 -c The information of our CardBus product that is currently inserted is displayed. ===================================================== Ref.ID Bus Dev Func Model RSW CBI ===================================================== 13

14 Code Ref.ID Bus Dev Func Model RSW1 Index ID of the CardBus product The number is used to select CardBus product in menu. Bus number in which a card is inserted. Device number in which a card is inserted. Function number in which the CardBus product is inserted Model number of the CardBus product CardBus ID setting value To change an ID number, select 1 in the menu and enter the index ID number of the CardBus product to change. **************Command******************** 1. Change the board id number. 2. Run the device number setup utility. 99. Exit the program. ***************************************** Enter the command number: 1 Type the CardBus ID number, 0 through 15, and press the Enter key. Enter Ref.ID: 1 Enter the board id number (0-15). If you want to cancel this operation, enter -1. : 1 Type 99 to close the utility. Notes: - When a board ID number is changed, restart the driver so that the system can recognize the ID number. - Put an ID number label on your CardBus card for your reference. 14

15 Chapter 4 Reference 4.1 List of Functions No. Function 1 DioBmOpen Opens a bus master digital input/output device and enables to access to it. 2 DioBmClose Closes the bus master digital input/output device and releases the resources. The subsequent accesses to the device are forbidden. 3 DioBmSetDeviceConfig Configures the transfer mode, transfer data unit, sampling rate, and control signals. 4 DioBmGetDeviceConfig Retrieves the transfer mode, transfer data unit, sampling rate, and control signals. 5 DioBmSetBufferConfig Specifies the bus master transfer buffer. 6 DioBmGetBufferConfig Retrieves the address and size of a bus master transfer buffer. 7 DioBmSetTriggerConfig Configures the start, suspend, and termination conditions of transfer. 8 DioBmGetTriggerConfig Retrieves the start, suspend, and termination conditions of transfer. 9 DioBmStart Starts a bus master transfer. 10 DioBmStop Suspends a bus master transfer. 11 DioBmEnd Terminates a bus master transfer. 12 DioBmSoftTrigger Issues a software trigger command. 13 DioBmSetEventConfig Configures interrupt edges of signals. 14 DioBmGetEventConfig Retrieves interrupt edges of signals. 15 DioBmSetCounterEventConfig Configures a counter event cycle for the bus master transfer. 16 DioBmGetCounterEventConfig Retrieves the counter event cycle for the bus master transfer. 17 DioBmSetEvent Configures interrupt callback. 18 DioBmKillEvent Deletes the registered interrupt callback. 19 DioBmGetCounter Retrieves the counter value for the bus master transfer. 20 DioBmGetStatus Retrieves the transfer status. 21 DioBmInputDword Reads 32 general purpose digital input pins and stores the data into a double-word variable. 22 DioBmOutputDword Writes 32 general purpose digital output pins. 23 DioBmGetLine Retrieves the status of control signals. 24 DioBmSetLine Controls the control signal. 25 DioBmGetDeviceInfo Retrieves the device information. 26 DioBmSetDeviceConfigEx Configures the transfer mode, transfer data unit, sampling rate, and control signals. *1 27 DioBmGetDeviceConfigEx Retrieves the transfer mode, transfer data unit, sampling rate, and control signals. *1 15

16 No. Function (Continued) 28 DioBmStopEx Suspends a bus master transfer. Suspends the bus master transfer of bus master digital input and bus master digital output on the same board or CardBus card simultaneously. *1 29 DioBmSoftTriggerEx Issues a software trigger command. Simultaneously satisfies the trigger conditions for the bus master digital input and bus master digital output on the same board or CardBus card simultaneously. *1 30 DioBmSetEdgeEventConfig Configures all point input signal interrupt event source. *2 31 DioBmGetEdgeEventConfig Retrieves all point input signal interrupt event source. *2 32 DioBmSetEventEx Configures expansion interrupt events. *2 33 DioBmSetFilter Configures a digital filter. *2 34 DioBmGetFilter Retrieves the digital filter. *2 35 DioBmClearSamplingOutput Clears the status of DMA transfer data output. *2 36 DioBmGetCommonPciDeviceInfo Retrieves the information of the board such as the device ID, resource information, Board ID (RSW1), and so on. Notes: Expansion function for the PCI-2772C, CPZ , CPZ , CBI/CSI , CBI/CSI , and LPC/PEX , LPC/PEX Expansion function for the CPZ , CPZ , CBI/CSI , CBI/CSI , LPC/PEX , and LPC/PEX

17 4.1.1 DioBmOpen The DioBmOpen function opens a device and enables to access it. It specifies a device number and initializes the device. The configurable device number is a decimal number from 1 through PCI-2172C, PCI-2472C The device number corresponds to the RSW1 value plus 1. The device can be used by specifying the RSW1 value plus 1. - PCI-2772C, CPZ , CPZ , CBI/CSI , CBI/CSI , LPC/PEX , LPC/PEX Device number is specified in the range of 17 through 48. When you use a board of PCI-2772C, CPZ , CPZ , CBI/CSI , CBI/CSI , LPC/PEX , LPC/PEX , the bus master digital input circuits and bus master digital output circuits are individually initialized as different devices. The device number allocation rule is as follows. Bus master digital input circuits: (RSW1 value * 2) + 17 Bus master digital output circuits: (RSW1 value * 2) + 18 RSW1 Bus Master Digital Input Circuits Bus Master Digital Output Circuits 0h h h F h int DioBmOpen( int ndevice /* Device number*/ );... Parameter ndevice Specifies the device number of the device to control. Return Value The DioBmOpen function returns DIOBM_ERROR_SUCCESS if the process is successfully completed. Otherwise, this function returns other codes. Please refer to the error codes. Example int nret; nret = DioBmOpen( 1 ); Open the bus master digital input/output device whose device number is 1. 17

18 4.1.2 DioBmClose The DioBmClose function closes the device and releases the resources. Subsequent accesses to the device are forbidden. int DioBmClose( ); int ndevice /* Device number */ Parameter ndevice Specifies the device number specified by the DioBmOpen function. Return Value The DioBmClose function returns DIOBM_ERROR_SUCCESS if the process is successfully completed. Otherwise, this function returns other codes. Please refer to the error codes. Example int nret; nret = DioBmClose( 1 ); Close the device. 18

19 4.1.3 DioBmSetDeviceConfig The DioBmSetDeviceConfig function configures the transfer mode, transfer data unit, sampling rate, and control signals. int DioBmSetDeviceConfig( ); int PDIOBMCONF ndevice, pconf Parameters ndevice Specifies the device number specified by the DioBmOpen function. pconf Points to the DIOBMCONF structure containing operation parameters. Return Value The DioBmSetDeviceConfig function returns DIOBM_ERROR_SUCCESS if the process is successfully completed. Otherwise, this function returns other codes. Please refer to the error codes. Example int nret; DIOBMCONF BmConf; BmConf.dwMode = DIOBM_MODE_SAMPLING; BmConf.dwRedirectWidth = DIOBM_WIDTH_DWORD; BmConf.dwEQConf = 0; BmConf.dwClock = DIOBM_CLK_100K; BmConf.dwSmplNum = 1024; BmConf.dwTimingOption = 0; BmConf.dwSTBConf = 0; BmConf.dwACKConf = 0; BmConf.dwREQConf = 0; BmConf.dwOREConf = 0; BmConf.dwUREConf = 0; nret = DioBmSetDeviceConfig( 1, &BmConf ); Configure functions of the device as follows. Member Parameter Mode dwmode Transfer mode Sampling mode dwredirectwidth Bus master transfer width Double word size dweqconf EQx signal Disabled dwclock Pacer rate 100 khz dwsmplnum Number of samples 1024 dwtimingoption FIFO operation mode Not specified dwstbconf STBx signal Disabled dwackconf ACKx signal Disabled dwreqconf REQx signal Disabled dworeconf ORE1 signal Disabled dwureconf URE2 signal Disabled 19

20 4.1.4 DioBmGetDeviceConfig The DioBmGetDeviceConfig function retrieves the transfer mode, transfer data unit, sampling rate, and control signals. int DioBmGetDeviceConfig( int ndevice, PDIOBMCONF pconf ); Parameters ndevice Specifies the device number specified by the DioBmOpen function. pconf Points to the DIOBMCONF structure to receive the operation parameters. Return Value The DioBmGetDeviceConfig function returns DIOBM_ERROR_SUCCESS if the process is successfully completed. Otherwise, this function returns other codes. Please refer to the error codes. Example int nret; DIOBMCONF BmConf; nret = DioBmGetDeviceConfig( 1, &BmConf ); Receive the operation parameters of the board specified by device number into the BmConf structure. 20

21 4.1.5 DioBmSetBufferConfig The DioBmSetBufferConfig function specifies the bus master transfer buffer. int DioBmSetBufferConfig( ); int void unsigned long ndevice, *pbuffer, dwbuffersize Parameters ndevice Specifies the device number specified by the DioBmOpen function. pbuffer Specifies the base address of the bus master transfer buffer. [32-bit environment] Specifies the base address of buffer on the user application. [64-bit and PAE environments] Specifies -1 to use the physical memory allocated in the Kernel. dwbuffersize Specifies the size of the buffer in byte. Return Value The DioBmSetBufferConfig function returns DIOBM_ERROR_SUCCESS if the process is successfully completed. Otherwise, this function returns other codes. Please refer to the error codes. Comments If the number of input/output exceeds than the buffer size, the program returns to the head of the buffer and continues to input/output. With this feature, in the case of output, the program can transfer mass data seamlessly by updating the transferred data region regularly. In the case of input, mass contiguous data can be input by saving the input data in the other region regularly. Concretely, the program monitors the number of DMA transfer by the interrupt event of DMA transfer counter and comparison counter match" or by the DioBmGetCounter function. When half of the total capacity of the buffer is transferred, it updates of saves the data in the buffer. The buffer configured by the DioBmSetBufferConfig function is used as a region for bus master transfer destination or bus master transfer source. 21

22 Example (32-bit environment) int nret; unsigned long dwbuffer[128]; nret = DioBmSetBufferConfig( 1, dwbuffer, 128 * sizeof(unsigned long) ); Specify the bus master transfer buffer. Example (64-bit environment) int nret; void* ptr; unsigned long dwbuffersize; nret = DioBmSetBufferConfig( 1, (void*)-1, 128 * sizeof(unsigned long) ); nret = DioBmGetBufferConfig( 1, &ptr, &dwbuffersize); Specify the bus master transfer buffer and retrieve the buffer address. 22

23 4.1.6 DioBmGetBufferConfig The DioBmGetBufferConfig function retrieves the address and size of the bus master transfer buffer. int DioBmGetBufferConfig ( ); int void unsigned long ndevice, **pbuffer, *pdwbuffersi ze Parameters ndevice Specifies the device number specified by the DioBmOpen function. pbuffer Points to a pointer to receive the base address of the bus master transfer buffer. In 64-bit environment, the initial address of the buffer specified by the DioBmSetBufferConfig function can be retrieved pdwbuffersize Points to a variable to receive the size of the bus master transfer buffer in byte. Return Value The DioBmGetBufferConfig function returns DIOBM_ERROR_SUCCESS if the process is successfully completed. Otherwise, this function returns other codes. Please refer to the error codes. Example int nret; unsigned int *pdwbuffer; unsigned long dwbuffersize; nret = DioBmGetBufferConfig( 1, &pdwbuffer, &dwbuffersize ); Store the configuration of the bus master transfer buffer into the pdwbuffer and dwbuffersize variables. 23

24 4.1.7 DioBmSetTriggerConfig The DioBmSetTriggerConfig function configures the start, suspension, and termination conditions. int DioBmSetTriggerConfig( ); int ndevice, PDIOBMTRIGCONF ptrigconf Parameters ndevice Specifies the device number specified by the DioBmOpen function. ptrigconf Points to the DIOBMTRIGCONF structure containing trigger conditions. Return Value The DioBmSetTriggerConfig function returns DIOBM_ERROR_SUCCESS if the process is successfully completed. Otherwise, this function returns other codes. Please refer to the error codes. Comments The trigger functions including the start trigger by the START signal and the end trigger by the END signal are not applied to the second or later start on the PCI-2172C and PCI-2472C. After inputting/outputting data, close the program by the DioBmClose function once. Then, Open it by the DioBmOpen function to input/output the subsequent data. Or, review the external interfaces to use the gated sampling mode or gated pattern output mode. (In these modes, data can be input/output only while the GATE signal is asserted. ) In the PCI-2772C, CPZ , CPZ , CBI/CSI , CBI/CSI , LPC/PEX and LPC/PEX , trigger conditions are effective for the second or later data transfer without closing the program. The trigger conditions including the start trigger by the START signal and the end trigger by the END signal on the PCI-2172C and PCI-2472C are effective only for the first sampling start after opening and does not applied for the second or later start (by the DioBmStart function). To apply the conditions, close the program once by the DioBmClose function and reconfigure them. Overwriting them by the DioBmSetTriggerConfig function does not solve the problem. Therefore, trigger functions including the start trigger by the START signal and end trigger by the END signal are not applied to the second or later times when the program processes by calling the DioBmStart function multiple times. 24

25 Example int nret; DIOBMTRIGCONF TrigConf; TrigConf.dwSoftTrigger = DIOBM_SOFT_TRIGGER_START; TrigConf.dwStartLine = 0; TrigConf.dwEndLine = DIOBM_LINE_FUNC_ENABLE; TrigConf.dwStopLine = 0; TrigConf.dwTriggerDelayNum = 0; TrigConf.dwPatternEq = 0; TrigConf.dwPatternMask = 0; TrigConf.dwPatternData = 0; nret = DioBmSetTriggerConfig( 1, &TrigConf ); Configure the start, suspension, and termination conditions of transfer of the board specified by device number as follows. Member Condition dwsofttrigger Software trigger Enables software start command. dwstartline STARTx signal trigger Disabled dwendline ENDx signal trigger Disabled (Terminates the transfer at assertion of the END signal.) dwstopline STOPx signal input Disabled dwtriggerdelaynum Number of delay samples 0 (No trigger delay) dwpatterneq Pattern matching trigger Disabled dwpatternmask Pattern matching mask No meanings (Because the pattern matching trigger is disabled.) dwpatterndata Pattern comparison data No meanings (Because the pattern matching trigger is disabled.) 25

26 4.1.8 DioBmGetTriggerConfig The DioBmGetTriggerConfig function retrieves the start, suspension, and termination conditions of transfer. int DioBmGetTriggerConfig( ); int ndevice PDIOBMTRIGCONF ptrigconf Parameters ndevice Specifies the device number specified by the DioBmOpen function. ptrigconf Points to the DIOBMTRIGCONF structure to receive trigger conditions Return Value The DioBmGetTriggerConfig function returns DIOBM_ERROR_SUCCESS if the process is successfully completed. Otherwise, this function returns other codes. Please refer to the error codes. Example int nret; DIOBMTRIGCONF TrigConf; nret = DioBmGetTriggerConfig( 1, &TrigConf ); Retrieve the start, suspension, and termination conditions of transfer of the board specified by device number into the TrigConf structure. 26

27 4.1.9 DioBmStart The DioBmStart function starts a bus master transfer. When the bus master transfer is suspended, this function resumes the bus master transfer. int DioBmStart( ); int ndevice, Parameter ndevice Specifies the device number specified by the DioBmOpen function. Return Value The DioBmStart function returns DIOBM_ERROR_SUCCESS if the process is successfully completed. Otherwise, this function returns other codes. Please refer to the error codes. Example int nret; nret = DioBmStart( 1 ); Start the bus master transfer of the board specified by device number. 27

28 DioBmStop The DioBmStop function suspends a bus master transfer. int DioBmStop ( int ); ndevice, Parameter ndevice Specifies the device number specified by the DioBmOpen function. Return Value The DioBmStop function returns DIOBM_ERROR_SUCCESS if the process is successfully completed. Otherwise, this function returns other codes. Please refer to the error codes. Example int nret; nret = DioBmStop( 1 ); Suspend the bus master transfer. 28

29 DioBmEnd The DioBmEnd function terminates a bus master transfer. The function is used to terminate output immediately in case of emergency. int DioBmEnd( ); int ndevice, Parameter ndevice Specifies the device number specified by the DioBmOpen function. Return Value The DioBmEnd function returns DIOBM_ERROR_SUCCESS if the process is successfully completed. Otherwise, this function returns other codes. Please refer to the error codes. Example int nret; nret = DioBmEnd( 1 ); Terminate the bus master transfer. 29

30 DioBmSoftTrigger The DioBmSoftTrigger function issues a software trigger command. If you use the software trigger, you must enable it by the DioBmSetTriggerConfig function beforehand. int DioBmSoftTrigger( ); Int ndevice, Parameter ndevice Specifies the device number specified by the DioBmOpen function. Return Value The DioBmSoftTrigger function returns DIOBM_ERROR_SUCCESS if the process is successfully completed. Otherwise, this function returns other codes. Please refer to the error codes. Example int nret; nret = DioBmSoftTrigger( 1 ); Issue the software trigger command on the board specified by device number. 30

31 DioBmSetEventConfig The DioBmSetEventConfig function configures interrupt edges of signals. int DioBmSetEventConfig( int ndevice, unsigned long dweventconfig ); Parameters ndevice Specifies the device number specified by the DioBmOpen function. dweventconfig Specifies the data to configure interrupt edges of signals. Refer to the following tables. - PCI-2172C, PCI-2472C bit31 through bit8 bit7 bit6 bit5 through bit0 Reserved END signal START signal Reserved - PCI-2772C, CPZ , CPZ bit31 through bit6 bit5 bit4 bit3 bit2 bit1 bit0 Reserved STOP2 signal STOP1 signal EXT22 signal EXT21 signal EXT12 signal EXT11 signal 0: An interrupt occurs at each falling edge of the signal. 1: An interrupt occurs at each rising edge of the signal. Notes: - When the PCI bus is reset, the external reset signal is asserted, or the power is turned on, the setting is set to 0. - When you use the START or END signal event, use the DioBmSetDeviceConfigEx function to assign the EXT11, EXT12, EXT21, or EXT22 signal to the START or END signal. - The CBI/CSI , CBI/CSI , LPC/PEX , and LPC/PEX do not support this function. Return Value The DioBmSetEventConfig function returns DIOBM_ERROR_SUCCESS if the process is successfully completed. Otherwise, this function returns other codes. Please refer to the error codes. Example int nret; nret = DioBmSetEventConfig( 1, 0x00 ); Configure the interrupt edge of the signal of the board specified by device number as follows: - START signal: An interrupt occurs at each falling edge of the signal. - END signal: An interrupt occurs at each falling edge of the signal. 31

32 DioBmGetEventConfig The DioBmGetEventConfig function retrieves interrupt edges of signals. int DioBmGetEventConfig( int ndevice unsigned long *pdweventconfig ); Parameters ndevice Specifies the device number specified by the DioBmOpen function. pdweventconfig Points to a variable to receive the interrupt edges of signal configurations. - PCI-2172C, PCI-2472C bit31 through bit8 bit7 bit6 bit5 through bit0 Reserved END signal START signal Reserved - PCI-2772C, CPZ , CPZ bit31 through bit6 bit5 bit4 bit3 bit2 bit1 bit0 Reserved STOP2 signal STOP1 signal EXT22 signal EXT21 signal EXT12 signal EXT11 signal 0: The interrupt occurs at the falling edge ( High to Low ). 1: The interrupt occurs at the rising edge ( Low to High ). The CBI/CSI , CBI/CSI , LPC/PEX , LPC/PEX does not support this function. Return Value The DioBmGetEventConfig function returns DIOBM_ERROR_SUCCESS if the process is successfully completed. Otherwise, this function returns other codes. Please refer to the error codes. Example int nret; unsigned long dweventconfig; nret = DioBmGetEventConfig( 1, &dweventconfig ); Store the interrupt edge of the signal to dweventconfig. 32

33 DioBmSetCounterEventConfig The DioBmSetCounterEventConfig function configures a counter event cycle for the bus master transfer. int DioBmSetCounterEventConfig( ); int unsigned long ndevice, dwcounter Parameters ndevice Specifies the device number specified by the DioBmOpen function. dwcounter Comparison counter setting value Specify the number of counter match events. - PCI -2172C, PCI -2472C Specifies a counter event cycle based on the transfer count. The I/O counter event (DIOBM_EV_EXEQ) and DMA counter event (DIOBM_EV_INEQ) occur at the specified cycle. You can set the value to 0 or power of 2. The following table shows the minimum setting value of the bus master transfer width. If you specify the power of 2, the following condition is effective. Width Minimum Setting Value DWORD 1 WORD 2 BYTE 4 If you specify 0, each operation is different depending on the transfer width. Transfer Width DWORD No event available WORD No event available BYTE An I/O counter event occurs at every counts. The default setting is 0. 33

34 - PCI-2772C, CPZ , CPZ , CBI/CSI , CBI/CSI , LPC/PEX , LPC/PEX The configurable range is from 0 through (0h through FFFFFFFFh). When the input/output counter match event is used, the value is configured by number. When the DMA counter match event is used, the value is configured by bytes. Specifies a counter event cycle based on the transfer count. The I/O counter event (DIOBM_EV_EXEQ) or DMA counter event (DIOBM_EV_INEQ) occurs at the specified cycle. The DIOBM_EV_EXEQ and DIOBM_EV_INEQ events cannot be unmasked simultaneously when they are unmasked by the DioBmSetEvent function. When the value matches with input/output counter, EQ1 or EQ2 signal is output (low). To use the match detection output function, call the DioBmSetDeviceConfigEx function and enable the match detection output function of EQ1 and EQ2 signals. (The EQ signal is not output at the DMA counter match. Only interrupt even is generated. ) Return Value The DioBmSetCounterEventConfig function returns DIOBM_ERROR_SUCCESS if the process is successfully completed. Otherwise, this function returns other codes. Please refer to the error codes. Comments - The DioBmSetEvent function is used to retrieve the event. - The EQ1 or EQ2 signal can be asserted (low) when the event occurs. To enable the comparator output function, call the DioBmSetDeviceConfig function Example int nret; nret = DioBmSetCounterEventConfig( 1, 1024 ); Configure the counter event cycle to

35 DioBmGetCounterEventConfig The DioBmGetCounterEventConfig function retrieves the counter event cycle for the bus master transfer. int DioBmGetCounterEventConfig( ); int unsigned long ndevice, *pdwcounter Parameters ndevice Specifies the device number specified by the DioBmOpen function. pdwcounter Points to a variable to receive a counter event cycle. Return Value The DioBmGetCounterEventConfig function returns DIOBM_ERROR_SUCCESS if the process is successfully completed. Otherwise, this function returns other codes. Please refer to the error codes. Example int nret; unsigned long dwcounter; nret = DioBmGetCounterEventConfig( 1, &dwcounter ); Retrieve the counter event cycle to dwcounter. 35

36 DioBmSetEvent The DioBmSetEvent function configures interrupt callback. int DioBmSetEvent( int ndevice, unsigned long dweventmask, LPDIOBMCALLBACK lpeventproc, unsigned long dwuser, unsigned long *pdweventdata ); Parameters ndevice Specifies the device number specified by the DioBmOpen function. dweventmask Specifies event sources to use. When you specify two or more event sources, use the following codes by using OR operators or plus operators. - PCI -2172C, PCI-2472C Bit Code DIOBM_EV_ENDTRG End of transfer event DIOBM_EV_DTRG Trigger delay event DIOBM_EV_START_TRG Start of transfer event DIOBM_EV_START_LINE START1 or START2 signal event DIOBM_EV_END_LINE END1 or END2 signal event DIOBM_EV_DMAEND End of DMA event DIOBM_EV_STOP STOP1 or STOP2 signal event (only when STOP1 or STOP2 signal is enabled) DIOBM_EV_FIFO_EFFF FIFO full/empty event DIOBM_EV_OREURE Over-run/under-run error event DIOBM_EV_EXEQ Data I/O counter and comparison comparator match DIOBM_EV_INEQ DMA counter and comparator counter match - PCI-2772C, CPZ , CPZ Bit Code DIOBM_EV_ENDTRG End of transfer event DIOBM_EV_DTRG Trigger delay event DIOBM_EV_START_TRG Start of transfer event DIOBM_EV_DMAEND End of DMA event DIOBM_EV_STOP1 STOP1 signal event DIOBM_EV_STOP2 STOP2 signal event DIOBM_EV_FIFO_EFFF FIFO full/empty event DIOBM_EV_OREURE Over-run/under-run error event DIOBM_EV_EXEQ I/O counter event DIOBM_EV_INEQ DMA counter event DIOBM_EV_EXT11 EXT11 signal event DIOBM_EV_EXT12 EXT12 signal event DIOBM_EV_EXT21 EXT21 signal event DIOBM_EV_EXT22 EXT22 signal event DIOBM_EV_EDGE All point input event * 36

37 Notes: - When you use the START or END signal event, use the DioBmSetDeviceConfigEx function to assign the EXT11, EXT12, EXT21, or EXT22 signal to the START or END signal. - To use the counter interrupt, set the counter event by using the DioBmSetCounterEventConfig function. - The All point input event (DIOBM_EV_EDGE) is applicable only the CPZ and CPZ CBI/CSI , CBI/CSI , LPC/PEX , LPC/PEX Bit Code DIOBM_EV_ENDTRG End of transfer event DIOBM_EV_DTRG Trigger delay event DIOBM_EV_START_TRG Start of transfer event DIOBM_EV_DMAEND End of DMA event DIOBM_EV_FIFO_EFFF FIFO full/empty event DIOBM_EV_OREURE Over-run/under-run error event DIOBM_EV_EXEQ I/O counter event DIOBM_EV_INEQ DMA counter and comparator counter match DIOBM_EV_EDGE All point input event * Notes: - To use the START or END signal event, enable the edge event of the input pin with START or END signal by the DioBmSetDeviceConfig function. - Configure the comparator counter by the DioBmSetCounterEventConfig function. - When the all point input event is used, all the interrupt sources are disabled in default configuration. Therefore, the detailed event sources such as rising/falling edge, input pin need to be configured by the DioBmSetEdgeEventConfig function. lpeventproc Points to the callback routine to call when an event occurs. If you do not use event notification, specify it as follows: - NULL (C) - nil (Kylix) dwuser Specifies the user-supplied data passed to the callback routine when the events occur. 37

38 pdweventdata Points to a variable to receive event sources occurred. When an event occurs, the following code is set to the corresponding bit. - PCI-2172C, PCI-2472C Bit Code DIOBM_EV_ENDTRG End of transfer event DIOBM_EV_DTRG Trigger delay event DIOBM_EV_START_TRG Start of transfer event DIOBM_EV_START_LINE START1 or START2 signal event DIOBM_EV_END_LINE END1 or END2 signal event DIOBM_EV_DMAEND End of DMA event DIOBM_EV_STOP STOP1 or STOP2 signal event (only when STOP1 or STOP2 signal is enabled) DIOBM_EV_FIFO_EFFF FIFO full/empty event DIOBM_EV_OREURE Over-run/under-run error event DIOBM_EV_EXEQ Data I/O counter and comparison comparator match DIOBM_EV_INEQ DMA counter and comparator counter match - PCI-2772C, CPZ , CPZ Bit Code DIOBM_EV_ENDTRG End of transfer event DIOBM_EV_DTRG Trigger delay event DIOBM_EV_START_TRG Start of transfer event DIOBM_EV_DMAEND End of DMA event DIOBM_EV_STOP1 STOP1 signal event DIOBM_EV_STOP2 STOP2 signal event DIOBM_EV_FIFO_EFFF FIFO full/empty event DIOBM_EV_OREURE Over-run/under-run error event DIOBM_EV_EXEQ I/O counter event DIOBM_EV_INEQ DMA counter event DIOBM_EV_EXT11 EXT11 signal event DIOBM_EV_EXT12 EXT12 signal event DIOBM_EV_EXT21 EXT21 signal event DIOBM_EV_EXT22 EXT22 signal event DIOBM_EV_EDGE All point input event * Note: When you use the START or END signal event, use the DioBmSetDeviceConfigEx function to assign the EXT11, EXT12, EXT21, or EXT22 signal to the START or END signal. When the interrupt event of EXT signal to which the START of END signal is assigned is enabled, an interrupt event is generated. The All point input event (DIOBM_EV_EDGE) is applicable only the CPZ and CPZ

39 - CBI/CSI , CBI/CSI , LPC/PEX , LPC/PEX Bit Code DIOBM_EV_ENDTRG End of transfer event DIOBM_EV_DTRG Trigger delay event DIOBM_EV_START_TRG Start of transfer event DIOBM_EV_DMAEND End of DMA event DIOBM_EV_FIFO_EFFF FIFO full/empty event DIOBM_EV_OREURE Over-run/under-run error event DIOBM_EV_EXEQ I/O counter event DIOBM_EV_INEQ DMA counter and comparator counter match DIOBM_EV_EDGE All point input event * Notes: - To use the START or END signal event, enable the edge event of the input pin with START or END signal by the DioBmSetDeviceConfig function. - Configure the comparator counter by the DioBmSetCounterEventConfig function. - When the all point input event is used, all the interrupt sources are disabled in default configuration. Therefore, the detailed event sources such as rising/falling edge, input pin need to be configured by the DioBmSetEdgeEventConfig function. Return Value The DioBmSetEvent function returns DIOBM_ERROR_SUCCESS if the process is successfully completed. Otherwise, this function returns other codes. Please refer to the error codes. Example int nret; unsigned long dweventdata; nret = DioBmSetEvent( 1, DIOBM_EV_ENDTRG, EventProc, 0, &dweventdata ); Configure the interrupt events of the board specified by device name as follows. Condition Event End of transfer Callback routine Not specified User data Disabled (because of no callback routine) Event buffer dweventdata 39