USB3-DIO01 API Programming (Rev 1.1)

Transcription

1 USB3-DIO01 API Programming (Rev 1.1) Windows, Windows2000, Windows NT and Windows XP are trademarks of Microsoft. We acknowledge that the trademarks or service names of all other organizations mentioned in this document as their own property. Information furnished by DAQ system is believed to be accurate and reliable. However, no responsibility is assumed by DAQ system for its use, nor for any infringements of patents or other rights of third parties which may result from its use. No license is granted by implication or otherwise under any patent or copyrights of DAQ system. The information in this document is subject to change without notice and no part of this document may be copied or reproduced without the prior written consent. Copyrights 2005 DAQ system, All rights reserved

2 Board Level APIs Overview Int Int OpenDAQDevice (void) CloseDAQDevice (void) GetBoardNum (void) ResetBoard (int nboard) USB3_SetMode (int nboard, int nmode) OpenDAQDevice This function initializes the device. You may call this function at the very first time you run the program. OpenDAQDevice (void) None. If the function succeeds, it returns the number of boards which were detected. (In the case of multi-board up to a max. 7) If the function fails, the return value is -1, it means there is no device in the system. CloseDAQDevice This function closes all opened devices (boards). If using of device is finished, you must certainly close a device for making it other programs so as usable. CloseDAQDevice (void) Parameters : None. If the function fail to close, it returns FALSE. If the function succeed to close, it returns TRUE

3 GetBoardNum This function returns currently detected board number in the system. int GetBoardNum (void) Parameters : None Returns the number of boards installed. (In the case of multi-board up to a max. 7) ResetBoard This function initializes a device at currently equipped system (PC). ResetBoard (int nboard) It returns TRUE in case of the success of reset and initialization. If you get FALSE, you should not call any API functions with the board and call the CloseDAQDevice() instead. USB3_SetMode It determines the USB input / output direction of the board. "0" is used as an input board, and the rest is used as an output board. USB3_SetMode (int nboard, int nmode) nmode : 0: input(default), others : output If the function fail to close, it returns FALSE. If the function succeed to close, it returns TRUE

4 LVDS API Functions Overview DWORD LVDS_Init (int nboard) LVDS_Start (int nboard) LVDS_GetFrame (int nboard, DWORD* ncnt, unsigned char* buf) LVDS_Close (int nboard) LVDS_GetResolutuion (int nboard, DWORD *xres, DWORD *yres) LVDS_Stop (int nboard) LVDS_StartFrame (int nboard) LVDS_SendFrame (int nboard, DWORD* ncnt, unsigned char* buf) LVDS_SetDataMode (int nboard, int nmode) LVDS_GetVersion (int nboard, int *nfpgaver, int *nfirmver) LVDS_GetError (int nboard, DWORD *dwstatuse) LVDS_Init This function initialize resources for the LVDS sub-system, for example interrupt and LVDS control register. LVDS_Init (nboard) LVDS_Start This function starts receiving frame data. After calling this function, by calling LVDS_GetFrame() function can be checked the complete data. LVDS_Start (int nboard) -4-

5 LVDS_GetFrame This function acquires image data from the frame buffer. The size of the buffer to receive the data should be informed. LVDS_GetFrame (int nboard, DWORD* ncnt, unsigned char* buf) ncnt : It is the address which contains the number of data to be received in byte size. Specifies the size buffer when the function is called, and read the values of the variables after a call to find out how many actually read. The data size is in bytes. buf : Pointer of first pixel of image data. If the function call fails, it returns FALSE and ncnt value is zero. If the function call succeeds, check the values of the size that you want to read ncnt. LVDS_Close This function releases all resources that used for LVDS function. At the end of the program, the application program calls this function. LVDS_Close (int nboard) Parameters : Return Value : -5-

6 LVDS_GetResolution This function sets the camera resolution for the specific camera Model. LVDS_GetResolution (int nboard, DWORD *xres, DWORD *yres) *xres : Address pointer to receive horizontal Camera resolution (Frame Width) *yres : Address pointer to receive vertical Camera resolution (Frame Height) LVDS_Stop This function stops the frame data capture. LVDS_Stop (int nboard) Parameters : LVDS_StartFrame This function starts frame data transfer. LVDS_StartFrame (int nboard) Parameters : -6-

7 LVDS_SendFrame It sends frame data to the specified size. At this point, you must tell the buffer size to send the data. LVDS_SendFrame (int nboard, DWORD* ncnt, unsigned char* buf) ncnt : The address of the variable where the size of the buffer to send frame data is stored. The data size is in bytes. buf : Frame data buffer pointer to send. If the function call fails, it returns FALSE and ncnt value is zero. If the function call succeeds, check the values of the size that you want to read ncnt. LVDS_SetDataMode This function sets the image pixel data mode. LVDS_SetDataMode (int nboard, int nmode) nmode : 0 : 8bit Mode, 1 : 16bit Mode, default : 32bit Mode, Return Value : -7-

8 LVDS_GetVersion This function gets a current FPGA version. LVDS_GetVersion (int nboard, int *nfpgaver, int *nfirmver) *nfpgaver : The pointer of the FPGA version. *nfirmver : The pointer of the Firmware version. LVDS_GetError This function gets a frame (image) error. LVDS_GetError (int nboard, DWORD *dwstatus) *dwstatus : Gets the error status value.. 1 : Overflow error 2 : Read error, 4 : Size error Return Value : -8-

9 Clock API Functions Overview CLK_Init (int nboard) CLK_Close (int nboard) DWORD CLK_Get (int nboard) CLK_Set (int nboard, DWORD val) CLK_On (int nboard, bon) CLK_Init This function initializes the Sensor(Camera) Clock. CLK_Init (int nboard) Parameters : Return Value : CLK_ Close This function closes the opened Sensor Clock. CLK_Close (int nboard) Parameters : Return Value : -9-

10 CLK_Get This function gets the selected Sensor Clock. DWORD CLK_Get (int nboard) Parameters : Return Value : CLK_Set This function sets the Sensor Clock. CLK_Set (int nboard, DWORD val) Parameters : val : 1039Hz ~ 68Mhz. Return Value : CLK_Off This function operates the Sensor Clock. CLK_On (int nboard, boff) Parameters : boff : True : Clock Off, False : Clock On Return Value :

11 Digital Input/Output API Functions Overview DWORD DIO_SetDirection (int nboard, DWORD dwval) DIO_GetDirection (int nboard, DWORD *dwval) DIO_Read (int nboard) DIO_Write (int nboard, DWORD dwval) DIO_GetWrite (int nboard, DWORD *dwval) DIO_SetDirection If you want to use USB3-DIO01 as 32-bit Digital Data Signal Line, each port can be set as input or output you want to use. DIO_SetDirection (int nboard, DWORD dwval) dwval : Input/Output direction setting value. 1 : Output / 0 : Input DIO_GetDirection This function reads the value of current direction. DIO_GetDirection (int nboard, DWORD *dwval) *dwval : Input/Output direction to read in variables

12 DIO_Read This function reads the input value. DWORD DIO_Read (int nboard) DIO_Write This function writes the desired value to output port. DIO_Write (int nboard, DWORD dwval) dwval : The value to be written to the port. DIO_GetWrite This function writes the output current value. DIO_GetWrite (int nboard, DWORD *dwval) *dwval : Variable of the output port s current value

13 I2C API Functions Overview I2C_SYS_Reset (int nboard) I2C_SYS_Read (int nboard, Byte sladdr, DWORD naddrlen, DWORD naddr, DWORD ncnt, unsigned char* buf) I2C_SYS_Write (int nboard, Byte sladdr, DWORD naddrlen, DWORD naddr, DWORD ncnt, unsigned char* buf) I2C_SYS_Reset This function initializes the resources of system I2C. I2C_SYS_Reset (int nboard) I2C_SYS_Read This function receives the data via I2C. I2C_SYS_Read (int nboard, Byte sladdr, DWORD naddrlen, DWORD naddr, DWORD ncnt, unsigned char* buf) sladdr : Slave address naddrlen : Address Lengh naddr : Register Address ncnt : Byte size of letter address Maximum number of character that can be read is limited to the 256byte. buf : Buffer Address

14 I2C_SYS_Write This function sends the data via I2C. I2C_SYS_Write (int nboard, Byte sladdr, DWORD naddrlen, DWORD naddr, DWORD ncnt, unsigned char* buf) sladdr : Slave address naddrlen : Address Lengh naddr : Register Address ncnt : Byte size of letter address. Maximum number of character that can be sent is limited to the 1Kbyte(1024). buf : Buffer Address

15 Video Simulation API Functions Overview SIM_Vout_Size (int nboard, int nhtotal, int nhfront, int nhback, int ndtotal, int ndfront, int ndback, int nvtotal, int nvfront, int nvback) SIM_Vout_Mode (int nboard, int nmode) SIM_Vout_RbSwap (int nboard, bswap) SYM_Vout_Size The user can output the active frame by adjusting Horizontal, Vertical Size to Total, Front porch, and Back porch values. [Figure 1. Hsize, Vsize Front/Back Porch]

16 [Figure 2. V_RES, V_BLK 와 D_RES, D_BLK 관계 ] SIM_Vout_Size (int nboard, int nhtotal, int nhfront, int nhback, int ndtotal, int ndfront, int ndback, int nvtotal, int nvfront, int nvback) nhtotal: Horizontal signal total value nhfront: Horizontal signal front porch value nhback: Horizontal signal back porch value ndtotal: Valid (valid) signal total value ndfront: Valid signal front porch value ndback: Valid signal back porch value nvtotal: Vertical signal total value nvfront: Vertical signal front porch value nvback: Vertical signal back porch value

17 SYM_Vout_Mode It selects the type of output data.. USB Data --- Outputs normal USB data values. Constant --- Outputs a specified constant value of a constant pattern. hcnt --- Print the Horizontal Count value. Pixel Count --- Outputs the entire Pixel Count value as a hexadecimal value. For example, in case of 640x480, 0 ~ 4B000 ( pixels) is output. SIM_Vout_Mode (int nboard, int nmode) nmode : 0:USB, 1:Constant, 2:Horizontal Count, 4: Pixel Count SYM_Vout_RbSwap This function exchanges the red and blue signal values of the output data. SIM_Vout_RbSwap (int nboard, bswap) bswap : True : Red, False : Blue swap