LALUsb.h File Reference

#include <fcntl.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "ftd2xx.h"

Go to the source code of this file.

Classes
struct	_int_frame_info

Macros
#define	LALUSB_API
#define	_cstmcall
#define	MAXDEVS   40
#define	USB_NoErr   FT_OK
#define	FrameNoErr   FT_OK
#define	FRAME_HEADER   0x000000AA
#define	FRAME_TRAILER   0x00000055
#define	IS_INTERRUPT   0x0000007F
#define	DATA_READ   0x00000080
#define	DATA_WRITE   0x0000007F
#define	USER_IRQ_FLAG   0x00000080

Typedefs
typedef void(*	PrintfFunc) (char *format,...)
typedef void(*	PerrorFunc) (char *msg)
typedef FT_STATUS	USB_Error
typedef enum _frame_error_constants	FrameError
typedef enum _extended_usb_errors	Ext_USB_Error
typedef struct _int_frame_info	InterruptFrameInfo
typedef struct _int_frame_info *	InterruptFrameInfoPtr
typedef enum _fake_errors	FakeErrorType

Enumerations
enum	TXRX_STATUS { RXSTATUS, TXSTATUS, RXSTATUS, TXSTATUS }
enum	_frame_error_constants {   FE_NONE, FE_DEVICE, FE_SOFTWARE, FE_USER,   FE_ERROR, FE_HEADER, FE_TRAILER, MaxFrameError,   FE_NONE, FE_DEVICE, FE_SOFTWARE, FE_USER,   FE_ERROR, FE_HEADER, FE_TRAILER, MaxFrameError }
enum	_extended_usb_errors {   USB_INT_FRAME = FT_OTHER_ERROR + 2, IO_TIMEOUT_WRITE, IO_TIMEOUT_READ, BAD_HEADER_ERROR,   BAD_TRAILER_ERROR, BAD_SUBADDR_ERROR, NULL_DESCSTR_PTR, NULL_SERNUM_PTR,   BAD_TARGET_PATH, MAXLAYER_NULL_PTR, SUB_ADDRR_0x40_ERROR, Max_USB_Errors,   USB_INT_FRAME = FT_OTHER_ERROR + 2, IO_TIMEOUT_WRITE, IO_TIMEOUT_READ, BAD_HEADER_ERROR,   BAD_TRAILER_ERROR, BAD_SUBADDR_ERROR, NULL_DESCSTR_PTR, NULL_SERNUM_PTR,   Max_USB_Errors }
enum	_fake_errors {   FK_LETSBETRUE = 1, FK_HEADER = 2, FK_TRAILER = 4, FK_COUNT = 8,   MaxFakeErrors = 16, FK_LETSBETRUE = 1, FK_HEADER = 2, FK_TRAILER = 4,   FK_COUNT = 8, MaxFakeErrors = 16 }

Functions
LALUSB_API BOOL _cstmcall	USB_FindDevices (char *DeviceDescriptionStr)
LALUSB_API BOOL _cstmcall	USB_Init (int id, BOOL verbose)
LALUSB_API BOOL _cstmcall	USB_ResetDevice (int id)
LALUSB_API FT_STATUS _cstmcall	GetDeviceSerNum (char *buffer, int index)
LALUSB_API FT_STATUS _cstmcall	GetDeviceDesc (char *buffer, int index)
LALUSB_API int _cstmcall	USB_GetNumberOfDevs (void)
LALUSB_API int _cstmcall	OpenUsbDevice (char *sernumstr)
LALUSB_API void _cstmcall	CloseUsbDevice (int id)
LALUSB_API void _cstmcall	USB_CloseAll (void)
LALUSB_API void _cstmcall	dbg_OpenLogFile (void)
LALUSB_API void _cstmcall	dbg_CloseLogFile (void)
LALUSB_API BOOL _cstmcall	USB_PurgeBuffers (int id)
LALUSB_API BOOL _cstmcall	USB_Write (int id, void *buf, int count, int *written)
LALUSB_API BOOL _cstmcall	USB_Read (int id, void *buf, int maxcnt, int *rdcount)
LALUSB_API int _cstmcall	USB_GetStatus (int id, TXRX_STATUS)
LALUSB_API BOOL _cstmcall	USB_SetTimeouts (int id, int tx_timeout, int rx_timeout)
LALUSB_API BOOL _cstmcall	USB_SetXferSize (int id, unsigned long txsize, unsigned long rxsize)
LALUSB_API BOOL _cstmcall	USB_SetLatencyTimer (int id, UCHAR msecs)
LALUSB_API BOOL _cstmcall	USB_GetLatencyTimer (int id, PUCHAR msecs)
LALUSB_API BOOL _cstmcall	USB_SetBaudRate (int id, int baud)
LALUSB_API void _cstmcall	USB_Perror (USB_Error err_code)
LALUSB_API USB_Error _cstmcall	USB_GetLastError (void)
LALUSB_API void _cstmcall	USB_SetPerrorFunc (PerrorFunc func)
LALUSB_API void _cstmcall	USB_PrintErrMsg (char *msg)
LALUSB_API char *_cstmcall	GetErrMsg (USB_Error err_code)
void	USB_Printf (char *format,...)
LALUSB_API void _cstmcall	USB_SetPrintfFunc (PrintfFunc func)
USB_Error	GetUSB_Errno (void)
LALUSB_API BOOL _cstmcall	USB_ResetMode (int id)
LALUSB_API BOOL _cstmcall	USB_SetSynchronousMode (int id, int sleep_time)
LALUSB_API BOOL _cstmcall	USB_SetFlowControlToHardware (int id)
LALUSB_API BOOL _cstmcall	USB_EraseEEpromData (int id)
LALUSB_API BOOL _cstmcall	USB_WriteEEpromData (int id)
LALUSB_API BOOL _cstmcall	USB_ReadEEpromData (int id, BOOL verbose)
LALUSB_API BOOL _cstmcall	USB_SetSerialNumber (int id, char *sernum)
LALUSB_API char *_cstmcall	USB_GetDefaultSerialNum (void)
LALUSB_API char *_cstmcall	USB_GetEpromSerialNum (void)
LALUSB_API BOOL _cstmcall	USB_SetDescStr (int id, char *desc_str)
LALUSB_API char *_cstmcall	USB_GetDefaultDeviceDesc (void)
LALUSB_API char *_cstmcall	USB_GetEpromDeviceDesc (void)
LALUSB_API BOOL _cstmcall	USB_SetPowerSource (int id, unsigned short powersrc)
LALUSB_API BOOL _cstmcall	USB_SetMaxPower (int id, unsigned short current)
LALUSB_API int _cstmcall	UsbWrt (int id, char sub_addr, void *buffer, int count)
LALUSB_API int _cstmcall	UsbRd (int id, char sub_addr, void *array, int count)
LALUSB_API int _cstmcall	UsbRdEx (int id, void *array, int maxcnt, int *frames)
LALUSB_API int _cstmcall	UsbReadEx (int id, void *array, int maxcnt, int *frames, int *frame_size)
LALUSB_API void _cstmcall	UsbSetIntCheckingState (BOOL truefalse)
LALUSB_API void _cstmcall	PrintFrameInfo (void)
LALUSB_API int _cstmcall	GetLastFrameStatus (void)
LALUSB_API InterruptFrameInfoPtr _cstmcall	GetLastFrame (void)
LALUSB_API void _cstmcall	ResetLostFrames (void)
LALUSB_API void _cstmcall	ResetFrameErrors (void)
LALUSB_API ULONG _cstmcall	GetLostFrames (void)
LALUSB_API ULONG _cstmcall	GetTotalByteCount (void)
LALUSB_API void _cstmcall	ResetTotalByteCount (void)
LALUSB_API ULONG _cstmcall	GetHeaderErrors (void)
LALUSB_API ULONG _cstmcall	GetTrailerErrors (void)
LALUSB_API void _cstmcall	GenerateFakeError (FakeErrorType fet, BOOL onoff)

Variables
LALUSB_API PerrorFunc	pfError

Macro Definition Documentation

_cstmcall

#define _cstmcall

Definition at line 30 of file LALUsb.h.

DATA_READ

#define DATA_READ   0x00000080

Definition at line 165 of file LALUsb.h.

DATA_WRITE

#define DATA_WRITE   0x0000007F

Definition at line 166 of file LALUsb.h.

FRAME_HEADER

#define FRAME_HEADER   0x000000AA

Definition at line 161 of file LALUsb.h.

FRAME_TRAILER

#define FRAME_TRAILER   0x00000055

Definition at line 162 of file LALUsb.h.

FrameNoErr

#define FrameNoErr   FT_OK

Definition at line 69 of file LALUsb.h.

IS_INTERRUPT

#define IS_INTERRUPT   0x0000007F

Definition at line 163 of file LALUsb.h.

LALUSB_API

#define LALUSB_API

Definition at line 29 of file LALUsb.h.

MAXDEVS

#define MAXDEVS   40

Definition at line 52 of file LALUsb.h.

USB_NoErr

#define USB_NoErr   FT_OK

Definition at line 68 of file LALUsb.h.

USER_IRQ_FLAG

#define USER_IRQ_FLAG   0x00000080

Definition at line 168 of file LALUsb.h.

Typedef Documentation

Ext_USB_Error

typedef enum _extended_usb_errors Ext_USB_Error

FakeErrorType

typedef enum _fake_errors FakeErrorType

FrameError

typedef enum _frame_error_constants FrameError

InterruptFrameInfo

typedef struct _int_frame_info InterruptFrameInfo

InterruptFrameInfoPtr

typedef struct _int_frame_info * InterruptFrameInfoPtr

PerrorFunc

typedef void(* PerrorFunc) (char *msg)

Definition at line 63 of file LALUsb.h.

PrintfFunc

typedef void(* PrintfFunc) (char *format,...)

Definition at line 57 of file LALUsb.h.

USB_Error

typedef FT_STATUS USB_Error

Definition at line 71 of file LALUsb.h.

Enumeration Type Documentation

_extended_usb_errors

enum _extended_usb_errors

Enumerator
USB_INT_FRAME
IO_TIMEOUT_WRITE
IO_TIMEOUT_READ
BAD_HEADER_ERROR
BAD_TRAILER_ERROR
BAD_SUBADDR_ERROR
NULL_DESCSTR_PTR
NULL_SERNUM_PTR
BAD_TARGET_PATH
MAXLAYER_NULL_PTR
SUB_ADDRR_0x40_ERROR
Max_USB_Errors
USB_INT_FRAME
IO_TIMEOUT_WRITE
IO_TIMEOUT_READ
BAD_HEADER_ERROR
BAD_TRAILER_ERROR
BAD_SUBADDR_ERROR
NULL_DESCSTR_PTR
NULL_SERNUM_PTR
Max_USB_Errors

Definition at line 199 of file LALUsb.h.

{
    USB_INT_FRAME = FT_OTHER_ERROR + 2,
    IO_TIMEOUT_WRITE,
    IO_TIMEOUT_READ,
    BAD_HEADER_ERROR,
    BAD_TRAILER_ERROR,
    BAD_SUBADDR_ERROR,
    NULL_DESCSTR_PTR,
    NULL_SERNUM_PTR,
    Max_USB_Errors
}Ext_USB_Error;

_fake_errors

enum _fake_errors

Enumerator
FK_LETSBETRUE
FK_HEADER
FK_TRAILER
FK_COUNT
MaxFakeErrors
FK_LETSBETRUE
FK_HEADER
FK_TRAILER
FK_COUNT
MaxFakeErrors

Definition at line 224 of file LALUsb.h.

{
    FK_LETSBETRUE = 1,          // No error
    FK_HEADER = 2,              // header
    FK_TRAILER = 4,             // trailer
    FK_COUNT = 8,               // bad number of bytes
    MaxFakeErrors = 16
}FakeErrorType;

_frame_error_constants

enum _frame_error_constants

Enumerator
FE_NONE
FE_DEVICE
FE_SOFTWARE
FE_USER
FE_ERROR
FE_HEADER
FE_TRAILER
MaxFrameError
FE_NONE
FE_DEVICE
FE_SOFTWARE
FE_USER
FE_ERROR
FE_HEADER
FE_TRAILER
MaxFrameError

Definition at line 186 of file LALUsb.h.

{
    FE_NONE,                        // No frame error nor interrupt
    FE_DEVICE,                      // Error (Interrupt) came from device
    FE_SOFTWARE,                    // Error detected by the software
    FE_USER,                        // User interrupt
    FE_ERROR,                       // Interrupt has been generated by an error
    FE_HEADER,                      // Header error
    FE_TRAILER,                     // Trailer error
    MaxFrameError
}FrameError;

TXRX_STATUS

enum TXRX_STATUS

Enumerator
RXSTATUS
TXSTATUS
RXSTATUS
TXSTATUS

Definition at line 46 of file LALUsb.h.

{
    RXSTATUS,
    TXSTATUS
}TXRX_STATUS;

Function Documentation

CloseUsbDevice()

LALUSB_API void _cstmcall CloseUsbDevice

(

int

id

)

dbg_CloseLogFile()

LALUSB_API void _cstmcall dbg_CloseLogFile

(

void

)

dbg_OpenLogFile()

LALUSB_API void _cstmcall dbg_OpenLogFile

(

void

)

GenerateFakeError()

LALUSB_API void _cstmcall GenerateFakeError	(	FakeErrorType	fet,
		BOOL	onoff
	)

GetDeviceDesc()

LALUSB_API FT_STATUS _cstmcall GetDeviceDesc	(	char *	buffer,
		int	index
	)

GetDeviceSerNum()

LALUSB_API FT_STATUS _cstmcall GetDeviceSerNum	(	char *	buffer,
		int	index
	)

GetErrMsg()

LALUSB_API char* _cstmcall GetErrMsg

(

USB_Error

err_code

)

GetHeaderErrors()

LALUSB_API ULONG _cstmcall GetHeaderErrors

(

void

)

GetLastFrame()

LALUSB_API InterruptFrameInfoPtr _cstmcall GetLastFrame

(

void

)

GetLastFrameStatus()

LALUSB_API int _cstmcall GetLastFrameStatus

(

void

)

GetLostFrames()

LALUSB_API ULONG _cstmcall GetLostFrames

(

void

)

GetTotalByteCount()

LALUSB_API ULONG _cstmcall GetTotalByteCount

(

void

)

GetTrailerErrors()

LALUSB_API ULONG _cstmcall GetTrailerErrors

(

void

)

GetUSB_Errno()

USB_Error GetUSB_Errno

(

void

)

OpenUsbDevice()

LALUSB_API int _cstmcall OpenUsbDevice

(

char *

sernumstr

)

PrintFrameInfo()

LALUSB_API void _cstmcall PrintFrameInfo

(

void

)

ResetFrameErrors()

LALUSB_API void _cstmcall ResetFrameErrors

(

void

)

ResetLostFrames()

LALUSB_API void _cstmcall ResetLostFrames

(

void

)

ResetTotalByteCount()

LALUSB_API void _cstmcall ResetTotalByteCount

(

void

)

USB_CloseAll()

LALUSB_API void _cstmcall USB_CloseAll

(

void

)

USB_EraseEEpromData()

LALUSB_API BOOL _cstmcall USB_EraseEEpromData

(

int

id

)

USB_FindDevices()

LALUSB_API BOOL _cstmcall USB_FindDevices

(

char *

DeviceDescriptionStr

)

USB_GetDefaultDeviceDesc()

LALUSB_API char* _cstmcall USB_GetDefaultDeviceDesc

(

void

)

USB_GetDefaultSerialNum()

LALUSB_API char* _cstmcall USB_GetDefaultSerialNum

(

void

)

USB_GetEpromDeviceDesc()

LALUSB_API char* _cstmcall USB_GetEpromDeviceDesc

(

void

)

USB_GetEpromSerialNum()

LALUSB_API char* _cstmcall USB_GetEpromSerialNum

(

void

)

USB_GetLastError()

LALUSB_API USB_Error _cstmcall USB_GetLastError

(

void

)

USB_GetLatencyTimer()

LALUSB_API BOOL _cstmcall USB_GetLatencyTimer	(	int	id,
		PUCHAR	msecs
	)

USB_GetNumberOfDevs()

LALUSB_API int _cstmcall USB_GetNumberOfDevs

(

void

)

USB_GetStatus()

LALUSB_API int _cstmcall USB_GetStatus	(	int	id,
		TXRX_STATUS
	)

USB_Init()

LALUSB_API BOOL _cstmcall USB_Init	(	int	id,
		BOOL	verbose
	)

USB_Perror()

LALUSB_API void _cstmcall USB_Perror

(

USB_Error

err_code

)

USB_PrintErrMsg()

LALUSB_API void _cstmcall USB_PrintErrMsg

(

char *

msg

)

USB_Printf()

void USB_Printf	(	char *	format,
			...
	)

USB_PurgeBuffers()

LALUSB_API BOOL _cstmcall USB_PurgeBuffers

(

int

id

)

USB_Read()

LALUSB_API BOOL _cstmcall USB_Read	(	int	id,
		void *	buf,
		int	maxcnt,
		int *	rdcount
	)

USB_ReadEEpromData()

LALUSB_API BOOL _cstmcall USB_ReadEEpromData	(	int	id,
		BOOL	verbose
	)

USB_ResetDevice()

LALUSB_API BOOL _cstmcall USB_ResetDevice

(

int

id

)

USB_ResetMode()

LALUSB_API BOOL _cstmcall USB_ResetMode

(

int

id

)

USB_SetBaudRate()

LALUSB_API BOOL _cstmcall USB_SetBaudRate	(	int	id,
		int	baud
	)

USB_SetDescStr()

LALUSB_API BOOL _cstmcall USB_SetDescStr	(	int	id,
		char *	desc_str
	)

USB_SetFlowControlToHardware()

LALUSB_API BOOL _cstmcall USB_SetFlowControlToHardware

(

int

id

)

USB_SetLatencyTimer()

LALUSB_API BOOL _cstmcall USB_SetLatencyTimer	(	int	id,
		UCHAR	msecs
	)

USB_SetMaxPower()

LALUSB_API BOOL _cstmcall USB_SetMaxPower	(	int	id,
		unsigned short	current
	)

USB_SetPerrorFunc()

LALUSB_API void _cstmcall USB_SetPerrorFunc

(

PerrorFunc

func

)

USB_SetPowerSource()

LALUSB_API BOOL _cstmcall USB_SetPowerSource	(	int	id,
		unsigned short	powersrc
	)

USB_SetPrintfFunc()

LALUSB_API void _cstmcall USB_SetPrintfFunc

(

PrintfFunc

func

)

USB_SetSerialNumber()

LALUSB_API BOOL _cstmcall USB_SetSerialNumber	(	int	id,
		char *	sernum
	)

USB_SetSynchronousMode()

LALUSB_API BOOL _cstmcall USB_SetSynchronousMode	(	int	id,
		int	sleep_time
	)

USB_SetTimeouts()

LALUSB_API BOOL _cstmcall USB_SetTimeouts	(	int	id,
		int	tx_timeout,
		int	rx_timeout
	)

USB_SetXferSize()

LALUSB_API BOOL _cstmcall USB_SetXferSize	(	int	id,
		unsigned long	txsize,
		unsigned long	rxsize
	)

USB_Write()

LALUSB_API BOOL _cstmcall USB_Write	(	int	id,
		void *	buf,
		int	count,
		int *	written
	)

USB_WriteEEpromData()

LALUSB_API BOOL _cstmcall USB_WriteEEpromData

(

int

id

)

UsbRd()

LALUSB_API int _cstmcall UsbRd	(	int	id,
		char	sub_addr,
		void *	array,
		int	count
	)

UsbRdEx()

LALUSB_API int _cstmcall UsbRdEx	(	int	id,
		void *	array,
		int	maxcnt,
		int *	frames
	)

UsbReadEx()

LALUSB_API int _cstmcall UsbReadEx	(	int	id,
		void *	array,
		int	maxcnt,
		int *	frames,
		int *	frame_size
	)

UsbSetIntCheckingState()

LALUSB_API void _cstmcall UsbSetIntCheckingState

(

BOOL

truefalse

)

UsbWrt()

LALUSB_API int _cstmcall UsbWrt	(	int	id,
		char	sub_addr,
		void *	buffer,
		int	count
	)

Variable Documentation

pfError

LALUSB_API PerrorFunc pfError