ui43api.h

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

#ifndef		__I43_API_H__
#define		__I43_API_H__

#ifdef __cplusplus
extern "C" {
#endif	/* __cplusplus	*/

_declspec(dllexport)
/* ****************************************************************** */
/*                            I43IO_ComOpen                           */
/* ****************************************************************** */
/* Input Parameters:                                                  */
/*  bPortNum   - The port number to open.                             */
/*  dwBaudRate - The communication baud rate.                         */
/* Return Value:                                                      */
/*  Success - I43ERR_OK.                                              */
/*  Fail    - I43 error code according to the specific error.         */
/* ****************************************************************** */
/* This function opens the communication port.                        */
/* The function also initilizes the port and set its state.           */
/* ****************************************************************** */
I43_ERROR_CODE I43IO_ComOpen();

/* ****************************************************************** */
/*                            I43IO_ComClose                          */
/* ****************************************************************** */
/* Input Parameters:                                                  */
/*  None.                                                             */
/* Return Value:                                                      */
/*  Success - I43ERR_OK.                                              */
/*  Fail    - I43 error code according to the specific error.         */
/* ****************************************************************** */
/* This function closes the connection to the communication port.     */
/* The function also releases any allocated resources.                */
/* ****************************************************************** */
I43_ERROR_CODE I43IO_ComClose(void);

/* ****************************************************************** */
/*                        I43_GetStatusRegister                       */
/* ****************************************************************** */
/* Input Parameters:                                                  */
/*	bRegister - the register to be read.                              */
/*	pwValue   - the returned register value.                          */
/* Return Value:                                                      */
/*	Success - I43ERR_OK.                                              */
/*  Fail    - I43 error code according to the specific error.         */
/* ****************************************************************** */
/* This function reads the value of the specified status register.    */
/* The read value is written to the pwValue operand.                  */
/* ****************************************************************** */
/* I43 host commands in use:                                          */
/*	None.                                                             */
/* ****************************************************************** */
I43_ERROR_CODE I43_GetStatusRegister(I43_STATUS_REGISTER bRegister,I43_UINT16* pwValue);

/* ****************************************************************** */
/*                            I43_SetMode                             */
/* ****************************************************************** */
/* Input Parameters:                                                  */
/*	bNewMode - the new mode for the I43.                              */
/* Return Value:                                                      */
/*	Success - I43ERR_OK.                                              */
/*  Fail    - I43 error code according to the specific error.         */
/* ****************************************************************** */
/* This function moves the I43 to the specified mode.                 */
/* ****************************************************************** */
/* I43 host commands in use:                                          */
/*	SetMode                                                           */
/* ****************************************************************** */
I43_ERROR_CODE I43_SetMode(I43_MODE bNewMode);

/* ****************************************************************** */
/*                       I43_SetSequenceLength                        */
/* ****************************************************************** */
/* Input Parameters:                                                  */
/*	bSequenceLength - the required sequence length (range: 2-127).    */
/*	bDelay          - the delay between two consequtive images in the */
/*	                  sequence. The Delay is 2^bDelay readouts.       */
/* Return Value:                                                      */
/*	Success - I43ERR_OK.                                              */
/*  Fail    - I43 error code according to the specific error.         */
/* ****************************************************************** */
/* This function sets the required sequence length to be used when a  */
/* capture sequence mode is entered.                                  */
/* ****************************************************************** */
/* I43 host commands in use:                                          */
/*	SetSequenceLength                                                 */
/* ****************************************************************** */
I43_ERROR_CODE I43_SetSequenceLength(I43_UINT8 bSequenceLength, I43_UINT8 bDelay);

/* ****************************************************************** */
/*                       I43_SetCurrentImage                          */
/* ****************************************************************** */
/* Input Parameters:                                                  */
/*	wImageIndex - the new current image index.                        */
/* Return Value:                                                      */
/*	Success - I43ERR_OK.                                              */
/*  Fail    - I43 error code according to the specific error.         */
/* ****************************************************************** */
/* This function sets the current Image for future operations such    */
/* as Restore, Erase, Lock etc.                                       */
/* ****************************************************************** */
/* I43 host commands in use:                                          */
/*	SetCurrentPicture                                                 */
/* ****************************************************************** */
I43_ERROR_CODE I43_SetCurrentImage(I43_UINT16 wImageIndex);

/* ****************************************************************** */
/*                      I43_GetStorageMediaStatus                     */
/* ****************************************************************** */
/* Input Parameters:                                                  */
/*	pwSuccess - Pointer to where to write the operation result.       */
/*	           0 - Operation succeeded.                               */
/*	           Other values - Operation failed.                       */
/*	pwImageCount - Pointer to where to write how many pictures are    */
/*             there on the storage media in the current directory.   */
/*	pwImageLeft - Pointer to where to write how many more pictures    */
/*             can be stored on the storage media.                    */
/*	pwSizeMS - Pointer where to write the MS word of the available    */
/*             storage space.                                         */
/*	pwSizeLS - Pointer where to write the LS word of the available    */
/*             storage space.                                         */
/* Return Value:                                                      */
/*	Success - I43ERR_OK.                                              */
/*  Fail    - I43 error code according to the specific error.         */
/* ****************************************************************** */
/* This function returns to the host, the number of Image files       */
/* that are currently stored on the storage media and the number      */
/* of images that can be stored on the storage media.                 */
/* Also the function retunes the available storage space left in      */
/* memory (in bytes).                                                 */
/* Note: if pwSuccess is non-zero, all other return values are        */
/* invalid and should not be used.                                    */
/* ****************************************************************** */
/* I43 host commands in use:                                          */
/*	GetStorageMediaStatus                                             */
/* ****************************************************************** */
I43_ERROR_CODE I43_GetStorageMediaStatus(I43_UINT16* pwSuccess,
										 I43_UINT16* pwImageCount,
										 I43_UINT16* pwImageLeft,
										 I43_UINT16* pwSizeMS,
										 I43_UINT16* pwSizeLS);

/* ****************************************************************** */
/*                     I43_GetStorageMediaGeometry                    */
/* ****************************************************************** */
/* Input Parameters:                                                  */
/*	pwSuccess - Pointer to where to write the operation result.       */
/*	           0 - Operation succeeded.                               */
/*	           Other values - Operation failed.                       */
/*	pwBytesPerSector - Pointer to where to write how many bytes are   */
/*                     in each sector.                                */
/*	pwSectorsPerCluster - Pointer to where to write how many sectors  */
/*                        are in each cluster.                        */
/*	pwTotalClusters - Pointer where to write the total number of      */
/*                    clusters (both used and free).                  */
/*	wFreeClusters - Pointer where to write the number of free         */
/*                  clusters.                                         */
/* Return Value:                                                      */
/*	Success - I43ERR_OK.                                              */
/*  Fail    - I43 error code according to the specific error.         */
/* ****************************************************************** */
/* This function returns to the host the number of bytes per sector,  */
/* the number of sectors per cluster, the total number of clusters    */
/* and the total number of free clusters.                             */
/* Note: if pwSuccess is non-zero, all other return values are        */
/* invalid and should not be used.                                    */
/* ****************************************************************** */
/* I43 host commands in use:                                          */
/*	GetStorageMediaStatus                                             */
/* ****************************************************************** */
I43_ERROR_CODE I43_GetStorageMediaGeometry( I43_UINT16* pwSuccess,
										    I43_UINT16* pwBytesPerSector,
											I43_UINT16* pwSectorsPerCluster,
											I43_UINT16* pwTotalClusters,
											I43_UINT16* wFreeClusters );

/* ****************************************************************** */
/*                             I43_GetWord                            */
/* ****************************************************************** */
/* Input Parameters:                                                  */
/*  wAddress - The address to read from.                              */
/*	pwValue  - Pointer where to write the value read from the         */
/*             specified address.                                     */
/* Return Value:                                                      */
/*	Success - I43ERR_OK.                                              */
/*  Fail    - I43 error code according to the specific error.         */
/* ****************************************************************** */
/* This function lets the host read a single word from the specified  */
/* address. The address is in the DMEM area of the oak DSP.           */
/* ****************************************************************** */
/* I43 host commands in use:                                          */
/*	GetWord                                                           */
/* ****************************************************************** */
I43_ERROR_CODE I43_GetWord(I43_UINT16  wAddress, I43_UINT16* pwValue);

/* ****************************************************************** */
/*                             I43_SetWord                            */
/* ****************************************************************** */
/* Input Parameters:                                                  */
/*  wAddress - The address to write to.                               */
/*	wValue   - The value to write to the specified address.           */
/* Return Value:                                                      */
/*	Success - I43ERR_OK.                                              */
/*  Fail    - I43 error code according to the specific error.         */
/* ****************************************************************** */