WIXLIB

Application NoteAN 178 Programming Guide for libMPSSE - SPIVersion 1.1Document Reference No.: FT 00492Clearance No.: FTDI# 215Parameters:inhandleHandle of the channelin*inBufferPointer to buffer to which data read will bestoredoutoutBufferPointer to the buffer from where data is to bewritteninsizeToTransferNumber of bytes or bits to writeout*sizeTransferredPointer to variable containing the number ofbytes or bits writtenintransferOptionsThis parameter specifies data transfer options.The bit positions defined for each of theseoptions are:BIT0: if set then sizeToTransfer is in bits,otherwise bytes. Bit masks defined for this bitare SPI TRANSFER OPTIONS SIZE IN BYTESand SPI TRANSFER OPTIONS SIZE IN BITSBIT1: if set then the chip select line is assertedbefore beginning the transfer. Bit mask definedfor this bit isSPI TRANSFER OPTIONS CHIPSELECT ENABLEBIT2: if set then the chip select line is dissertedafter the transfer ends. Bit mask defined forthis bit isSPI TRANSFER OPTIONS CHIPSELECT DISABLEBIT3 – BIT31: reservedReturns:Returns status code of type FT STATUSWarning:This is a blocking function and will not return until either the specified amount ofdata is transferred or an error is encountered.3.1.9SPI IsBusyFT STATUS SPI IsBusy(FT HANDLE handle, bool *state)This function reads the state of the MISO line without clocking the SPI bus.Some applications need the SPI master to poll the MISO line without clocking the busto check if the SPI slave has completed previous operation and is ready for the nextoperation. This function is useful for such applications.Parameters:inhandleHandle of the channelout*statePointer to a variable to which the state of the MISO10Copyright 2011 Future Technology Devices International Limited

Application NoteAN 178 Programming Guide for libMPSSE - SPIVersion 1.1Document Reference No.: FT 00492Clearance No.: FTDI# 215line will be readReturns:Returns status code of type FT STATUS3.1.10 SPI ChangeCSFT STATUS SPI ChangeCS(FT HANDLE handle, uint32 configOptions)This function changes the chip select line that is to be used to communicate to theSPI slave.Parameters:inhandleHandle of the channelinconfigOptionsThis parameter provides a way to select the chipselect line and the slave's SPI mode. It is the sameparameter as ConfigChannel.configOptions that ispassed to function SPI InitChannel and it isexplained in section 3.4.1Returns:Returns status code of type FT STATUS3.2 GPIO functionsEach MPSSE channel in the FTDI chips are provided with a general purpose I/O porthaving 8 lines in addition to the port that is used for synchronous serial communication.For example, the FT232H has only one MPSSE channel with two 8-bit ports, ADBUS andACBUS. Out of these, ADBUS is used for synchronous serial communications(I2C/SPI/JTAG) and ACBUS is free to be used as GPIO. The two functions describedbelow have been provided to access these GPIO lines (also called the higher byte lines ofMPSSE) that are available in various FTDI chips with MPSSEs.3.2.1FT WriteGPIOFT STATUS FT WriteGPIO(FT HANDLE handle, uint8 dir, uint8 value)This function writes to the 8 GPIO lines associated with the high byte of the MPSSEchannelParameters:inhandleHandle of the channelindirEach bit of this byte represents the direction of the 8respective GPIO lines. 0 for in and 1 for outinvalueIf the direction of a GPIO line is set to output, theneach bit of this byte represent the output logic stateof the 8 respective GPIO lines. 0 for logic low and 1for logic highReturns:Returns status code of type FT STATUS11Copyright 2011 Future Technology Devices International Limited

Application NoteAN 178 Programming Guide for libMPSSE - SPIVersion 1.1Document Reference No.: FT 004923.2.2Clearance No.: FTDI# 215FT ReadGPIOFT STATUS FT ReadGPIO(FT HANDLE handle, uint8 *value)This function reads from the 8 GPIO lines associated with the high byte of the MPSSEchannelParameters:inhandleHandle of the channelout*valueIf the direction of a GPIO line is set to input, theneach bit of this byte represent the input logic state ofthe 8 respective GPIO lines. 0 for logic low and 1 forlogic highReturns:Returns status code of type FT STATUSNote:The direction of the GPIO line must first be set using FT WriteGPIO functionbefore this function is used.3.3 Library Infrastructure FunctionsThe two functions described in this section typically do not need to be called fromthe user applications as they are automatically called during entry/exit time.However, these functions are not called automatically when linking the librarystatically using Microsoft Visual C . It is then that they need to be calledexplicitly from the user applications. The static linking sample provided with thismanual uses a macro which checks if the code is compiled using Microsofttoolchain, if so then it automatically calls these functions.3.3.1Init libMPSSEvoid Init libMPSSE(void)Initializes the eanup libMPSSEvoid Cleanup libMPSSE(void)12Copyright 2011 Future Technology Devices International Limited

Application NoteAN 178 Programming Guide for libMPSSE - SPIVersion 1.1Document Reference No.: FT 00492Clearance No.: FTDI# 215Cleans up resources used by the libraryParameters:innoneoutnoneReturns:void3.4 Data types3.4.1 ChannelConfigChannelConfig is a structure that holds the parameters used for initializing a channel. Thefollowing are members of the structure:uint32 ClockRateThis parameter takes the value of the clock rate of the SPI bus in hertz. Valid rangefor ClockRate is 0 to 30MHz.uint8 LatencyTimerRequired value, in milliseconds, of latency timer. Valid range is 0 – 255. However,FTDI recommend the following ranges of values for the latency timer:Range for full speed devices (FT2232D):Range 2 – 255Range for Hi-speed devices (FT232H, FT2232H, FT4232H):Range 1 - 255uint32 configOptionsBits of this member are used in the way described below:BitnumberDescriptionValueMeaning ofvalueDefined macro(if any)BIT1BIT0These bitsspecify to whichof the standardSPI modesshould the SPImaster beconfigured to00SPI MODE0SPI CONFIG OPTION MODE001SPI MODE1SPI CONFIG OPTION MODE1( Please refer to the release notes within therelease package zip file for revision history andknown limitations of this version)10SPI MODE2SPI CONFIG OPTION MODE211SPI MODE3SPI CONFIG OPTION MODE3(Please refer to the release notes within therelease package zip file for revision history andknown limitations of this version)BIT4BIT2These bitsspecify which ofthe availablelines should beused as chip000xDBUS3 ofMPSSE ischip selectSPI CONFIG OPTION CS DBUS3001xDBUS4 ofMPSSE isSPI CONFIG OPTION CS DBUS413Copyright 2011 Future Technology Devices International Limited

Application NoteAN 178 Programming Guide for libMPSSE - SPIVersion 1.1Document Reference No.: FT 00492selectBIT5BIT6BIT31This bit specifiesif the chip selectline should beactive lowClearance No.: FTDI# 215chip select010xDBUS5 ofMPSSE ischip selectSPI CONFIG OPTION CS DBUS5011xDBUS6 ofMPSSE ischip selectSPI CONFIG OPTION CS DBUS6100xDBUS7 ofMPSSE ischip selectSPI CONFIG OPTION CS DBUS70Chip select isactive high1Chip select isactive lowSPI CONFIG OPTION CS ACTIVELOWReservedNote: The terms xDBUS0 – xDBUS7 corresponds to lines ADBUS0 – ADBUS7 if thefirst MPSSE channel is used, otherwise it corresponds to lines BDBUS0 – BDBUS7 ifthe second MPSSE channel(i.e. if available in the chip) is used.The SPI modes are:SPI MODE0 - data are captured on rising edge and propagated on falling edgeSPI MODE1 - data are captured on falling edge and propagated on rising edgeSPI MODE2 - data are captured on falling edge and propagated on rising edgeSPI MODE3 - data are captured on rising edge and propagated on falling edgeuint32 PinsThis member specifies the directions and values of the lines associated with the lower byte ofthe MPSSE channel after SPI InitChannel and SPI CloseChannel functions are called.Bit numberDescriptionCommentBIT7-BIT0Direction of the lines afterA 1 corresponds to outputand a 0 corresponds toinputSPI InitChannel is calledBIT15-BIT8Value of the lines afterSPI InitChannel is calledBIT23-BIT16Direction of the lines afterSPI CloseChannel is calledBIT31-BIT24Value of the lines afterSPI CloseChannel is calledA 1 corresponds to logichigh and a 0 correspondsto logic lowA 1 corresponds to outputand a 0 corresponds toinputA 1 corresponds to logichigh and a 0 correspondsto logic lowNote that the directions of the SCLK, MOSI and the specified chip select line will beoverwritten to 1 and the direction of the MISO like will be overwritten to 014Copyright 2011 Future Technology Devices International Limited

Application NoteAN 178 Programming Guide for libMPSSE - SPIVersion 1.1Document Reference No.: FT 00492Clearance No.: FTDI# 215irrespective of the values passed by the user application. Other than these 4 lines,the rest of the lines will be an a state that is specified via this parameter.uint16 reservedThis parameter is reserved and should not be used.3.4.2 TypedefsFollowing are the typedefs that have been defined keeping cross platform portability ypedefunsigned char uint8unsigned short uint16unsigned long uint32signed char int8signed short int16signed long int32unsigned char bool15Copyright 2011 Future Technology Devices International Limited

Application NoteAN 178 Programming Guide for libMPSSE - SPIVersion 1.1Document Reference No.: FT 00492Clearance No.: FTDI# 2154 Example CircuitThis example will demonstrate how to connect a MPSSE chip (FT2232H) to an SPI device (93LC56B– EEPROM) and program it using libMPSSE-SPI library.Figure 3: Schematic for connecting FT2232H to SPI EEPROM device (93LC56B)The above schematic shows how to connect a FT2232H chip to an SPI EEPROM. Pleasenote that the FT2232H chip is also available as a module which contains all thecomponents shown in the above schematic (except the 93LC56B and the pull-upresistors connected to it). This module is called FT2232H Mini Module and details about itcan be found in the device datasheet. The FT2232H chip acts as the SPI master here andis connected to a PC running using USB interface.16Copyright 2011 Future Technology Devices International Limited

Application NoteAN 178 Programming Guide for libMPSSE - SPIVersion 1.1Document Reference No.: FT 00492Clearance No.: FTDI# 2155 Example ProgramThe required D2XX driver should be installed into the system depending on the OS thatis already installed in the PC/host. If a linux PC is used then the default drivers usbserialand ftdi sio must be removed (using rmmod command).Once the hardware shown above is connected to a PC and the drivers are installed, wecan place the following sample code (sample-static.c), D2XX.h, libMPSSE spi.h andlibMPSSE.a into one folder, compile the sample and run it./*!* \file sample-static.c** \author FTDI* \date 20110512** Copyright 2011 Future Technology Devices International Limited* Company Confidential** Project: libMPSSE* Module: SPI Sample Application - Interfacing 94LC56B SPI EEPROM** Rivision History:* 0.1 - 20110512 - Initial version* 0.2 - 20110801 - Changed LatencyTimer to 255*Attempt to open channel only if available*Added & modified macros*Included stdlib.h* 0.3 - 20111212 - Added ***************************************//*Include ************************************//* Standard C libraries */#include stdio.h #include stdlib.h /* OS specific libraries */#ifdef WIN32#include windows.h #endif/* Include D2XX header*/#include "ftd2xx.h"/* Include libMPSSE header */#include "libMPSSE ***********************************//*Macro and type **************************************//* Helper macros */#define APP CHECK STATUS(exp) {if(exp! FT OK){printf("%s:%d:%s(): status(0x%x) \! FT OK\n", FILE , LINE , FUNCTION ,exp);exit(1);}else{;}};#define CHECK NULL(exp){if(exp NULL){printf("%s:%d:%s(): NULL expression \encountered \n", FILE , LINE , FUNCTION );exit(1);}else{;}};/* Application specific macro definations */#define SPI DEVICE BUFFER SIZE25617Copyright 2011 Future Technology Devices International Limited

Application NoteAN 178 Programming Guide for libMPSSE - SPIVersion 1.1Document Reference No.: FT 00492#define SPI WRITE COMPLETION RETRY#define START ADDRESS EEPROM#define END ADDRESS EEPROM#define RETRY COUNT EEPROM#define CHANNEL TO OPEN#define SPI SLAVE 0#define SPI SLAVE 1#define SPI SLAVE 2#define DATA OFFSETClearance No.: FTDI# 215100x00 /*read/write start address inside the EEPROM*/0x1010/* number of retries if read/write fails */0/*0 for first available channel, 1 for next. ***********************************//*Global ****************************************/uint32 channels;FT HANDLE ftHandle;ChannelConfig channelConf;uint8 buffer[SPI DEVICE BUFFER ***********************************//*Public function ******************************************//*!* \brief Writes to EEPROM** This function writes a byte to a specified address within the 93LC56B EEPROM** \param[in] slaveAddress Address of the I2C slave (EEPROM)* \param[in] registerAddress Address of the memory location inside the slave to where the byte*is to be written* \param[in] data The byte that is to be written* \return Returns status code of type FT STATUS(see D2XX Programmer's Guide)* \sa Datasheet of 93LC56B 794F.pdf* \note* \warning*/FT STATUS read byte(uint8 slaveAddress, uint8 address, uint16 *data){uint32 sizeToTransfer 0;uint32 sizeTransfered;bool writeComplete 0;uint32 retry 0;bool state;FT STATUS status;/* CS High Write command Address */sizeToTransfer 1;sizeTransfered 0;buffer[0] 0xC0;/* Write command (3bits)*/buffer[0] buffer[0] ( ( address 3) & 0x0F );/*5 most significant add bits*/status SPI Write(ftHandle, buffer, sizeToTransfer, &sizeTransfered,SPI TRANSFER OPTIONS SIZE IN BYTES SPI TRANSFER OPTIONS CHIPSELECT ENABLE);APP CHECK STATUS(status);/*Write partial address bits */sizeToTransfer 4;sizeTransfered 0;buffer[0] ( address & 0x07 ) 5; /* least significant 3 address bits */status SPI Write(ftHandle, buffer, sizeToTransfer, &sizeTransfered,SPI TRANSFER OPTIONS SIZE IN BITS);APP CHECK STATUS(status);/*Read 2 bytes*/sizeToTransfer 2;sizeTransfered 0;status SPI Read(ftHandle, buffer, sizeToTransfer, &sizeTransfered,18Copyright 2011 Future Technology Devices International Limited

Application NoteAN 178 Programming Guide for libMPSSE - SPIVersion 1.1Document Reference No.: FT 00492Clearance No.: FTDI# 215SPI TRANSFER OPTIONS SIZE IN BYTES SPI TRANSFER OPTIONS CHIPSELECT DISABLE);APP CHECK STATUS(status);*data (uint16)(buffer[1] 8);*data (*data & 0xFF00) (0x00FF & (uint16)buffer

3.1 SPI Functions 3.1.1 SPI_GetNumChannels FT_STATUS SPI_GetNumChannels (uint32 *numChannels) This function gets the number of SPI channels that are connected to the host system. The number of ports available in each of these chips is different. Parameters: out *numChannels The number of channels connected to the host Returns: