ui43api.h

CAM-TOOL 是高效率高质量的模具制造的最好CAM解决方案。在当今的 Windows 操作环境里

/* This function lets the host write a single word to the specified   */
/* address. The address is in the DMEM area of the oak DSP.           */
/* ****************************************************************** */
/* I43 host commands in use:                                          */
/*	SetWord                                                           */
/* ****************************************************************** */
I43_ERROR_CODE I43_SetWord(I43_UINT16 wAddress, I43_UINT16 wValue);



/* ****************************************************************** */
/*                             I43_SetCCD                             */
/* ****************************************************************** */
/* Input Parameters:                                                  */
/*	bNum  - The TG burst number (zero based).                         */
/* Return Value:                                                      */
/*	Success - I43ERR_OK.                                              */
/*  Fail    - I43 error code according to the specific error.         */
/* ****************************************************************** */
/* This function writes the control bits to the CCD TG.               */
/* The data is read from a predefined memory location.                */
/* Note that since the I43 works with 16bit words for every write     */
/* operation, the data at the memory location must be in 16 bit       */
/* baundery. The padding bits should be zeros.                        */
/* ****************************************************************** */
/* I43 host commands in use:                                          */
/*	SetCCD                                                            */
/* ****************************************************************** */
I43_ERROR_CODE I43_SetCCD(I43_UINT8 bNum);

/* ****************************************************************** */
/*                           I43_SelectGPIOEx                         */
/* ****************************************************************** */
/* Input Parameters:                                                  */
/*  bGroup    - The GPIO group of pins to be addressed.               */
/*  bBit      - The GPIO pin in the group to be selected.             */
/*  bFunc     - The functionality of the pin.                         */
/*  bCounter  - Currently not implemented and therefore ignored.      */
/* Return Value:                                                      */
/*  Success - I43ERR_OK.                                              */
/*  Fail    - I43 error code according to the specific error.         */
/* ****************************************************************** */
/* This function sets the functionality of a COACH-V selectable pin.  */
/* Pins can be selected as either functional or GPIO.                 */
/* THIS API IS APPLICABLE ONLY ON COACH-V.                            */
/* ****************************************************************** */
/* I43 host commands in use:                                          */
/*  SelectGPIO                                                        */
/* ****************************************************************** */
I43_ERROR_CODE I43_SelectGPIOEx( I43_GPIO_GROUP_TYPE   bGroup,
                                 I43_UINT8             bBit,
                                 I43_GPIO_FUNC_TYPE    bFunc,
                                 I43_GPIO_COUNTER_TYPE bCounter );

/* ****************************************************************** */
/*                           I43_ConfigGPIOEx                         */
/* ****************************************************************** */
/* Input Parameters:                                                  */
/*  bGroup - The GPIO group of pins to be addressed.                  */
/*  bBit   - The GPIO pin in the group to be configured.              */
/*  bDir   - The configuration (input or output) of the pin.          */
/* Return Value:                                                      */
/*  Success - I43ERR_OK.                                              */
/*  Fail    - I43 error code according to the specific error.         */
/* ****************************************************************** */
/* This function sets the configuration of a COACH-V selectable pin.  */
/* Prior to configuring a pin it must first be selected as GPIO.      */
/* THIS API IS APPLICABLE ONLY ON COACH-V.                            */
/* ****************************************************************** */
/* I43 host commands in use:                                          */
/*  ConfigGPIO                                                        */
/* ****************************************************************** */
I43_ERROR_CODE I43_ConfigGPIOEx( I43_GPIO_GROUP_TYPE  bGroup,
                                 I43_UINT8            bBit,
                                 I43_GPIO_CONFIG_TYPE bDir   );

/* ****************************************************************** */
/*                              I43_GetGPIO                           */
/* ****************************************************************** */
/* Input Parameters:                                                  */
/*  bNum        - Specific General Purpose I/O pin/group number.      */
/*  bClustering - Whether it is pin number or group number.           */
/*  pwValue     - Pointer to where the GPIO pin/group state will be   */
/*                read to.                                            */
/* Return Value:                                                      */
/*  Success - I43ERR_OK.                                              */
/*  Fail    - I43 error code according to the specific error.         */
/* ****************************************************************** */
/* This function reads the current GPIO pins state. Reading a pin     */
/* that is defined as output results with a value of 0.               */
/* In case bClustering is equal to I43_GPIO_PIN, bNum sets the        */
/* specific GPIO pin to retrieve. In case bClustering is equal to     */
/* I43_GPIO_GROUP, bNum sets the GPIO group to retrieve (see          */
/* definitions I43_GPIO_GROUP_xxxxGPIO, where xxxx may be BASE, EX,   */
/* XL or H).                                                          */
/* ****************************************************************** */
/* I43 host commands in use:                                          */
/*  GetGPIO                                                           */
/* ****************************************************************** */
I43_ERROR_CODE I43_GetGPIO( I43_UINT8 bNum, I43_GPIO_CLUSTERING_TYPE bClustering,
						   I43_UINT16 *pwValue );
/* ****************************************************************** */
/*                            I43_SetGPIO                             */
/* ****************************************************************** */
/* Input Parameters:                                                  */
/*	bNum   - The number of the GPIO pin to set the new value to.      */
/*	bValue - The new value to be set to the GPIO pin.                 */
/* Return Value:                                                      */
/*	Success - I43ERR_OK.                                              */
/*  Fail    - I43 error code according to the specific error.         */
/* ****************************************************************** */
/* This function sets the given value to the specified GPIO pin.      */
/* Writing to a pin that is defined as input has no effect.           */
/* ****************************************************************** */
/* I43 host commands in use:                                          */
/*	SetGPIO                                                           */
/* ****************************************************************** */
I43_ERROR_CODE I43_SetGPIO(I43_UINT8 bNum, I43_BOOL bValue);

/* ****************************************************************** */
/*                           I43_ConfigGPIO                           */
/* ****************************************************************** */
/* Input Parameters:                                                  */
/*  bNum      - Specific General Purpose I/O pin number.              */
/*  bIOConfig - Direction of the specific General Purpose I/O pin.    */
/* Return Value:                                                      */
/*  Success - I43ERR_OK.                                              */
/*  Fail    - I43 error code according to the specific error.         */
/* ****************************************************************** */
/* This function sets the new configuration to the I43 GPIO pins.     */
/* ****************************************************************** */
/* I43 host commands in use:                                          */
/*  ConfigGPIO                                                        */
/* ****************************************************************** */
I43_ERROR_CODE I43_ConfigGPIO( I43_UINT8 bNum, I43_GPIO_CONFIG_TYPE bIOConfig);

/* ****************************************************************** */
/*                              I43_Beep                              */
/* ****************************************************************** */
/* Input Parameters:                                                  */
/*	uDuration - beep duration in resolution of 50ms.                  */
/* Return Value:                                                      */
/*	Success - I43ERR_OK.                                              */
/*  Fail    - I43 error code according to the specific error.         */
/* ****************************************************************** */
/* This function activates beep sound, which duration is equal to     */
/* (50 * uDuration) ms.                                               */
/* ****************************************************************** */
/* I43 host commands in use:                                          */
/*	Beep                                                              */
/* ****************************************************************** */
I43_ERROR_CODE I43_Beep(I43_UINT8 uwDuration);





/* ****************************************************************** */
/*                            I43_GetI2C                              */
/* ****************************************************************** */
/* Input Parameters:                                                  */
/*  wSubAddr - the register sub address.                              */
/*  pwData   - Pointer where to write the read data.                  */
/* Return Value:                                                      */
/*  Success - I43ERR_OK.                                              */
/*  Fail    - I43 error code according to the specific error.         */
/* ****************************************************************** */
/* This function allows the host to read "through" the                */
/* I43 to an I2C slave device that is connected to the I43.           */
/* The function reads one byte/word at a time as configured in the    */
/* I43_ConfigI2CAccess API.                                           */
/* The operation result is reported in SR1 status codes.              */
/* ****************************************************************** */
/* I43 host commands in use:                                          */
/*  GetI2C                                                            */
/* ****************************************************************** */
I43_ERROR_CODE I43_GetI2C( I43_UINT16  wSubAddr,
                           I43_UINT16* pwData
                         );




/* ****************************************************************** */
/*                        I43_SetAFRectangle                          */
/* ****************************************************************** */
/* Input Parameters:                                                  */
/*  wStartX - the X start point of the ROI.                           */
/*  wSizeX  - the X size of the ROI.                                  */
/*  wStartY - the Y start point of the ROI.                           */
/*  wSizeY  - the Y size of the ROI.                                  */
/* Return Value:                                                      */
/*  Success - I43ERR_OK.                                              */
/*  Fail    - I43 error code according to the specific error.         */
/* ****************************************************************** */
/* This function defines the Region Of Interest (ROI) for the auto    */
/* focus support.                                                     */
/* ****************************************************************** */
/* I43 host commands in use:                                          */
/*  ConfigAF                                                          */
/* ****************************************************************** */
I43_ERROR_CODE I43_SetAFRectangle( I43_UINT16 wStartX,
                                   I43_UINT16 wSizeX,
                                   I43_UINT16 wStartY,
                                   I43_UINT16 wSizeY
                                 ) ;