libMPSSE_spi.h

Go to the documentation of this file.

 
#ifndef LIBMPSSE_SPI_H
#define LIBMPSSE_SPI_H
 
#include "ftd2xx.h"
 
/******************************************************************************/
/*                              Macro defines                                 */
/******************************************************************************/
 
#ifdef __cplusplus
#define FTDI_API extern "C"
#else
#define FTDI_API
#endif
 
 
#define SPI_TRANSFER_OPTIONS_SIZE_IN_BYTES 0x00000000
#define SPI_TRANSFER_OPTIONS_SIZE_IN_BITS 0x00000001
#define SPI_TRANSFER_OPTIONS_CHIPSELECT_ENABLE 0x00000002
#define SPI_TRANSFER_OPTIONS_CHIPSELECT_DISABLE 0x00000004
 
#define SPI_CONFIG_OPTION_MODE_MASK 0x00000003
#define SPI_CONFIG_OPTION_MODE0 0x00000000
#define SPI_CONFIG_OPTION_MODE1 0x00000001
#define SPI_CONFIG_OPTION_MODE2 0x00000002
#define SPI_CONFIG_OPTION_MODE3 0x00000003
 
#define SPI_CONFIG_OPTION_CS_MASK 0x0000001C 
#define SPI_CONFIG_OPTION_CS_DBUS3 0x00000000 
#define SPI_CONFIG_OPTION_CS_DBUS4 0x00000004 
#define SPI_CONFIG_OPTION_CS_DBUS5 0x00000008 
#define SPI_CONFIG_OPTION_CS_DBUS6 0x0000000C 
#define SPI_CONFIG_OPTION_CS_DBUS7 0x00000010 
#define SPI_CONFIG_OPTION_CS_ACTIVELOW 0x00000020
 
/******************************************************************************/
/*                              Type defines                                  */
/******************************************************************************/
 
#ifndef _FTDI_LIB_FT4222_H_
typedef unsigned char uint8;
typedef unsigned short uint16;
typedef unsigned long long uint64;
 
typedef signed char int8;
typedef signed short int16;
typedef signed long long int64;
 
#ifdef __x86_64__
/*20111025: 64bit linux doesn't work is uint32 is unsigned long*/
typedef unsigned int uint32;
typedef signed int int32;
#else
typedef unsigned long uint32;
typedef signed long int32;
#endif
#endif
 
typedef enum I2C_ClockRate_t
{
    I2C_CLOCK_STANDARD_MODE = 100000, 
    I2C_CLOCK_FAST_MODE = 400000, 
    I2C_CLOCK_FAST_MODE_PLUS = 1000000, 
    I2C_CLOCK_HIGH_SPEED_MODE = 3400000 
} I2C_CLOCKRATE;
 
typedef struct ChannelConfig_t
{
    uint32 ClockRate;
 
    uint8 LatencyTimer;
 
    uint32 configOptions; 
    uint32 Pin; 
    uint16 reserved;
} ChannelConfig;
 
/******************************************************************************/
/*                              External variables                            */
/******************************************************************************/
 
/******************************************************************************/
/*                              Function declarations                         */
/******************************************************************************/
FTDI_API FT_STATUS SPI_GetNumChannels(uint32 *numChannels);
FTDI_API FT_STATUS SPI_GetChannelInfo(uint32 index,
    FT_DEVICE_LIST_INFO_NODE *chanInfo);
FTDI_API FT_STATUS SPI_OpenChannel(uint32 index, FT_HANDLE *handle);
FTDI_API FT_STATUS SPI_InitChannel(FT_HANDLE handle, ChannelConfig *config);
FTDI_API FT_STATUS SPI_CloseChannel(FT_HANDLE handle);
FTDI_API FT_STATUS SPI_Read(FT_HANDLE handle, uint8 *buffer,
    uint32 sizeToTransfer, uint32 *sizeTransfered, uint32 options);
FTDI_API FT_STATUS SPI_Write(FT_HANDLE handle, uint8 *buffer,
    uint32 sizeToTransfer, uint32 *sizeTransfered, uint32 options);
FTDI_API FT_STATUS SPI_ReadWrite(FT_HANDLE handle, uint8 *inBuffer,
    uint8 *outBuffer, uint32 sizeToTransfer, uint32 *sizeTransferred,
    uint32 transferOptions);
FTDI_API FT_STATUS SPI_IsBusy(FT_HANDLE handle, unsigned char *state);
FTDI_API void Init_libMPSSE(void);
FTDI_API void Cleanup_libMPSSE(void);
FTDI_API FT_STATUS SPI_ChangeCS(FT_HANDLE handle, uint32 configOptions);
FTDI_API FT_STATUS FT_WriteGPIO(FT_HANDLE handle, uint8 dir, uint8 value);
FTDI_API FT_STATUS FT_ReadGPIO(FT_HANDLE handle, uint8 *value);
FTDI_API FT_STATUS SPI_ToggleCS(FT_HANDLE handle, unsigned char state);
 
/******************************************************************************/
 
#endif /*LIBMPSSE_SPI_H*/