User Manual for SMT1026 - Sundance Multiprocessor Technology Ltd.
Contents
1. void FillMem unsigned int pBuf unsigned int nBytes pBuf Buffer that contains the data to copy to the SMT351 memory nBytes Number of bytes to copy to the SMT351 memory None This function acquires data from the SMT351 3 3 4 SMT381 interface The SMT381 interface can be used with a SMT381 plugged a Sundance carrier board This section describes the SMT381 functions ConfigureDACReg ConfigureDACClock SetTrigger Reset the SMT381 enumerated types e DATAMODE The SMT381 functions All the following functions can throw an SMTExc exception Prototype Parameters Return value Notes Prototype Parameters Return value Notes Prototype Parameters Return value Notes Prototype Parameters ConfigureDACReg void ConfigureDACReg DATAMODE unsigned int nBurstSize mode unsigned short pBuf mode Select the data mode See struct DATAMODE Buffer that contains the data to write to the DAC memory pBuf only used when the direct mode is selected Set the burst size for the DACs Typically it will be the number nBurstSize of 14 bit samples divided by the number of samples per cycle NB_SAMPLE_CYCLE None This function configures the DAC registers of the SMT381 ConfigureDACClock unsigned int int nRf_SamplingFreq ConfigureADCClock unsigned bool bOnBoardClk nRf SamplingFreq Sampling frequency of the on board c2. Unit Module Description FPGA only module SDK Unit Module Number SMT1026 Document Issue Number Issue Date Original Author Emilie Wheatley User Manual for SMT1026 Sundance Multiprocessor Technology Ltd Chiltern House Waterside Chesham Bucks HP5 1PS This document is the property of Sundance and may not be copied nor communicated to a third party without prior written permission Sundance Multiprocessor Technology Limited 2009 Certificate Number FM55022 Revision History Table of Contents 1 2 5 ETUC OCC o VA AN AN AE E AA AAA 1 1 SMT1026 main features a iia 1 2 Supported Hardwate sccscscscscsscsssssssssssssssesscssssscssessessesesessesesesaessesassaesesaseass Getting started iiini DAM A E A A E E TEE 2 2 Pere QUISE 23 Software os tala is 2 3 1 Software Installation From CD csccssssssssessesssesserscesserscessesseeseesesseesserseeseeres 2 3 2 Visual Stdio Configuratio stinnan 2 3 3 Visual Studio express 2010 Configuration ccccsesesessessessessesessesseeeeeasens SS OEE WAL Ea 3 1 Interface MechamisSM ccsscssccsssccessesscessessesssesserscessesscesstssceeseesenseescesseeserseensesssenaees 3 2 Functions exported by SMtFPGA LL c cc ceescsseseeseeseeesessesseeaesaessesaesaeeaesaeeaeeanens 3 3 Sundance Hardware Interface Description cccccccnonncnncnncnnenncnnrnnennrnnr narrar nar nnr nar 14 3 3 1 General INLer ac G
3. hostlink None This function stops the ADC to acquire data ADCReset void ADCReset void None None Notes Prototype Parameters Return value Notes Prototype Parameters Return value Notes Prototype Parameters Return value Notes Prototype Parameters Return value Notes This function resets the ADCs SetADCMode void SetADCMode unsigned int n n ADC mode value None This function sets the ADC mode SetCikMode void SetClkMode CLKMODE391 clkmode clkmode ADC clock mode parameters See struct CLKSMT391 None This function sets the clock mode GetFirmwareVersion unsigned int GetFirmwareVersion void None None This function gets the firmware version Before using this function the user has to make sure this functionality is part of the firmware used to program the FPGA GetTemp void GetTemp TEMP pTemp Tem Structure that receives the modules temperatures See struct pliemP TEMP None This function gets the temperatures on different part of the hardware Before using this function the user has to make sure this functionality is part of the firmware used to program the FPGA Prototype Parameters pSN Return None value Notes GetSN void GetSN SN pSN Structure that receives the modules temperatures See struct SN This function gets the FPGA module serial number Before us
4. Gain DAC channel B The default value is OXFFF Sampling frequency divider for the ADCs The default value is div3 Sampling frequency divider for the DACs The default value is div2 The SMT350 enumerated types Enumerated type Description enum SMT350TYPE There are two types of SMT350 The default one with the ad9510 0 component CDCM7005 and the one with the component AD9510 cdem7005 1 The right SMT350 type can be selected using this enumerated type y enum SAMPLING_RATIO divl div2 div3 div4 div6 div8 divl6 r This enumerated type selects the sampling frequency divider OY G w DN 2 O 3 3 3 SMT351 interface The SMT351 interface can be used with a SMT351 plugged a Sundance carrier board This section describes the SMT351 functions e Acquire e ReadBack e FillMem The SMT351 functions All the following functions can throw an SMTExc exception Acquire Prototype void Acquire unsigned int nBytes unsigned int nAddress nBytes Number of bytes to acquire Parameters nAddress Memory address from where to acquire the data Return None value Notes Prototype Parameters Return value Notes Prototype Parameters Return value Notes This function prepares the SMT351 for the acquisition ReadBack void ReadBack void None None This function starts the acquisition from the SMT351 FillMem
5. SMT384 smT391 Firmware 4 Host 43 Output 5 Include i 5 Lib lt 1 objects Disk free space 49 9 GB 44 0 KB 4 My Computer This executable is a very simple console application aimed to show the basic use of the SMT1026 libraries But more complicated and flexible user interfaces can be developed using the functionalities of the SMT1026 libraries See Configure FPGA only module
6. 1 1 SMT1026 main features This section lists the main characteristics of the SMT1026 package The SMT1026 SDK Accelerate your development time by providing ready to use library of functions Configure the FPGA from the Host Transfer data from the FPGA only module to the Host Control the data acquisition on the daughter modules from the Host Give you a basic framework for more complex custom systems Provide you with C type interfaces to the FPGA only modules 1 2 Supported Hardware The SMT1026 currently supports the following carrier boards Carrier board Description Functionality SMT100 SLB carrier Virtex 5 512Mbytes DDR2 Full support USB2 RS232 MicroSD Transflash 4 lane and 1 lane PCIe interface 32 bit 33MHz PCI cable PCIe connector SMT101 SLB carrier Virtex 5 512Mbytes DDR2 Full support USB2 RS232 MicroSD Transflash 4 lane and 1 lane PCIe interface 8 channel 12 bit ADC 32 bit 33 MHz PCI SMT105 SLB carrier Virtex 5 512Mbytes DDR2 Full support USB2 RS232 MicroSD Transflash 4 lane and 1 lane PCIe interface 3 banks of QDRII memory 72 Mbit 2x Fibre modules The SMT1026 currently supports the following FPGA only module Carrier board Description SMT350 Dual ADC DAC module at 500MSPS SMT351 1GB memory module SMT370 Dual channel ADC DAC SMT381 Dual 14 bit DAC module at 1GSPS SMT384 Quad 14 bit ADC module at 125MSPS SMT390 Dual 1
7. B false Non inverting The default value is false true trigger selection channel A and B false internal trigger The default value is false true trigger polarity channel C and D false Non inverting The default value is false true trigger selection channel C and D false internal trigger The default value is false Channel A and B selection The default value is channelab Channel C and D selection The default value is channelab True ADC A and B output 2 s complement samples False ADC A and B output binary samples The default value is false True ADC C and D output 2 s complement samples False ADC C and D output binary samples The default value is false The SMT391 interface can be used with a SMT391 plugged in a Sundance carrier board This section describes the SMT391 functions e Reset e ConfigureADCReg ConfigureADCClock Acquire ADCReset SetADCMode SetClkMode GetFirmwareVersion GetTemp GetSN the SMT391 structures e SETADC391 the SMT391 enumerated types e CLKMODE391 The SMT391 functions All the following functions can throw an SMTExc exception Reset Prototype void Reset bool bGlobal bool bADC bool bUser bGlobal True to do a global reset otherwise false Parameters bADC True to do an ADC reset otherwise false bUser True to do a user reset otherwise false Return None value Notes This function reset the SMT391 ConfigureAD
8. Parameters Return value Notes Prototype Smt351Close void Smt351Close IFSmt351 p p Pointer to the Smt351 interface None This function closes the Smt351 interface Smt3700pen IFSmt370 Smt3700pen unsigned int nIndex 0 nIndex Index of the carrier board on which the Smt370 is plugged in The return value is a pointer to an Smt370 interface This function obtains an interface to an Smt370 plugged in the first TIM site of a Sundance carrier board Smt370Close void Smt370Close IFSmt370 p p Pointer to the Smt370 interface None This function closes the Smt370 interface Smt3840pen IFSmt384 Smt3840pen unsigned int nIndex 0 nIndex Index of the carrier board on which the Smt384 is plugged in The return value is a pointer to an Smt384 interface This function obtains an interface to an Smt384 plugged in the first TIM site of a Sundance carrier board Smt384Close void Smt384Close IFSmt384 p Parameters Return value Notes Prototype Parameters Return value Notes Prototype Parameters Return value Notes Prototype Parameters Return value Notes Prototype Parameters Return value p Pointer to the Smt384 interface None This function closes the Smt384 interface Smt3900pen IFSmt390 Smt3900pen unsigned int nIndex 0 nIndex Index of the carrier board on which the Smt390 is pl
9. Size of the data nNoOfBit Number of relevant bits per word This value is used to mask A each word saved in the file FileOpt Structure which contains the extra file options append data PUE add date and time See struct FILE OPTIONS None This function stores data into a file CallbackSet void CallbackSet SMIFPGACALLBACK pf void user pf Callback function user User specified callback value None This function sets the function that is to be called when words are sent to the FPGA module CallbackGet void CallbackGet SMIFPGACALLBACK pf void user Parameters Return value Notes Prototype Parameters Return value Notes Prototype Parameters Return value Notes Prototype Parameters Return value pf Callback function user User specified callback value None This function gets the function that is to be called when words are sent to the FPGA module ResetTIMs void ResetTIMs void None None This function resets the TIMs on the carrier board ResetBoard void ResetBoard void None None This function resets the carrier board GenSig void GenSig SIGGEN type int nAmp float fSigFreq unsigned int pBuf float fSamplingFreg int nBytes type Type of signal to generate See SIGGEN nAmp Signal amplitude fSamplingFreq Sampling frequency fSigFreg Signal frequency pBuf Buffer for t
10. to 500MHz Gain Set the gain fo the DACs Offset Set the offset for the DACs Channel selection Select the output channel s Data format Select the format of the output data binary or 2 s complement External clock Check this check box if you are using an external clock Trigger inverting Check this check box for an inverting trigger External trigger Check this check box if you are using an external trigger Test Check this check box to use the ADC test data as input data Configure ADC Press this button to configure the ADCs and the DACs of the SMT350 3 Acquisition File to save data Set the file to which the data should be written Bytes to acquire Set the size of the acquisition in bytes or 2 14 bit samples Bytes to avoid Set the number of bytes or 2 14 bit samples to avoid before starting the acquisition This can be useful in some cases For example the host comport on the SMT310Q has a very small buffer that can overflow before the acquisition starts By setting the Bytes to avoid field the comport buffer gets empty before starting the acquisition Host link Select the link used between the host and the carrier board Most of the time it will be the host comport but sometime it s possible to use the host RSL Acquire data Press this button to start an data acquisition 4 1 2 SMT351 This section explains how to use the Configure FPGA only module user interface For more informa
11. 2 bit ADC module at 210MSPs SMT391 Dual 8 bit ADC module at 1GSPS SMT941 4 channel 14 bit ADC at 250 MHz 2 Getting started This section will help you to get started e Abbreviations e Prerequisites e Software Installation 2 1 Abbreviations The following abbreviations will be used through the all document FPGA Field Programmable Gate Array CPLD Complex PLDs PCI Peripheral Component Interconnect PLD Programmable Logic Device SMT Sundance Multiprocessor Technology Ltd TIM Texas Instruments Module 2 2 Prerequisites The language C is used for the software interfaces Even if you are not familiar with C you should be able to find your way by referring to the samples The samples have been compiled and tested with Microsoft Visual Studio 2010 express edition 2 3 Software Installation This section describes how to install the SMT1026 package e From CD e Visual Studio Configuration e Visual Studio 2010 Configuration 2 3 1 Software Installation From CD Insert the SMT1026 CD into your CD drive The setup program should start automatically if it doesn t you can start it yourself by opening an Explorer window browsing to the CD and then double clicking setup exe The installation program will give you the option of installing samples We recommend that you become familiar with the SMT1026 by installing and reviewing the sample code The default directory is C Program Fi
12. 3 3 2 SMT350 interface The SMT350 interface can be used with a SMT350 plugged in a Sundance carrier board This section describes the SMT350 functions ResetDevices Acquire ConfigureADCReg ConfigureADCClock the SMT350 structures e CLKMODE350 e SETDAC e SETCLK the SMT350 enumerated types e SMT350TYPE e SAMPLING RATIO The SMT350 functions All the following functions can throw an SMTExc exception ResetDevices Prototype void ResetDevices SMT350TYPE smt350type cdcm7005 Parameters smt350type Select the SMT350 type CDCM7005 or AD9510 See enum SMT350TYPE Return value Notes Prototype Parameters Return value Notes Prototype Parameters Return value Notes Prototype Parameters Return value Notes None This function does a global reset of the SMT350 ADCs DACs Clock ConfigureADCReg void ConfigureADCReg OUTPUT outputADC SETDAC pSetDAC SMT350TYPE smt350type SETCLK pSetClk VCXOTYPE vcxotype vcx0245 outputADC Type of data the ADCs output See enum OUTPUT pSetDAC DAC parameters gain and offset See struct SETDAC smt350type Select the SMT350 type CDCM7005 or AD9510 See enum SMIESOLYPE SMT350TYPE Clock parameters sampling frequency ratio See struct pSetClk SETCLK Meis Select the right VCXO used on the SMT350 100MHz or VEXOTYPE 245 76 MHz See enum VCXOTYPE None This func
13. 6026 Examples 5MT391 Host v Go Folders x Name Type E w 5 smT6001 A 69 sMT391 cpp C Source file 5 smT6012 Slsm7391 dsp Project File E 5 SMT6025 E SMT391 dsy Project Workspace SMT6026 le StdAFx cpp C Source file GD Examples h stdafx h C Header file 6 E SMT350 E E SMT351 E E sMT381 E SMT384 smT391 O Firmware O Host Output 5 Include Lib lt j 5 objects Disk free space 49 9 GB 10 6 KB 4 My Computer Source code The source code is similar for all the supported FPGA only modules 1 Open the FPGA library 2 Reset the board and TIM 3 Configure the FPGA 4 Configure the ADCs DACs 5 Start the acquisition on the ADCs or trigger the DACs 6 Save data to file ADCs Tip Change the value of the define directives at the beginning of the program to change the parameters Don t forget to recompile 5 3 Output This folder contains the executable application It s installed in the following directory C Program Files Sundance SMT6026 Examples SMT391 Output Remark SMT391 can be replaced by the number of the board you are interested in ER File Edit View Favorites Tools Help d Q Back gt B a Search e Folders MEE Address O C Program Files Sundance SMT6026 Examples SMT391 Output v Go Folders x Name Size Type E SMT6001 A Fsmr391 exe 44KB Application 1 smt6012 E SMT6025 a SMT6026 E 5 Examples w SMT350 w SMT351 w sMT381 dl E
14. CReg void ConfigureADCReg unsigned int amp nSamplingFreq Prototype serApc391 setadc nSamplingFreq Sampling frequency of the on board clock Parameters setadc ADC parameters See struct SETADC391 Return None value Notes This function configures the ADC registers of the SMT391 Prototype Parameters Return value Notes Prototype Parameters Return value Notes Prototype Parameters Return value Notes Prototype Parameters Return value ConfigureADCClock unsigned int int nRf_SamplingFreq ConfigureADCClock unsigned bool bOnBoardClk nRf SamplingFreq Sampling frequency of the on board clock True to use the on board clock otherwise false False is bOnBoardClk the default value Sampling frequency of the on board clock This function configures the clock of the SMT391 Acquire void Acquire unsigned int nBytes 0 bool bDDR false Number of bytes to acquire If no DDR memory has been nBytes implemented in the FPGA firmware the acquisition is continue and nBytes is not used 0 is the default value True when DDR memory is implemented in the FPGA firmware BOBA otherwise false False is the default value None This function configures the SMT391 to start acquiring data StopAcquire void StopAcquire HOST_LINK hostlink Communication link on which to write the data Host comport per default See enum HOST LINK
15. FPGA only module interface Notes Prototype Parameters Return value Notes Prototype Parameters Return value Notes Prototype Parameters Return value Notes Prototype Parameters Return value Notes This function obtains an interface to any FPGA only module plugged in the first TIM site of a Sundance carrier board SmtFPGAClose void SmtFPGAClose IFSmtFPGA p p Pointer to the FPGA only module interface None This function closes the FPGA only module interface Smt3500pen IFSmt350 Smt3500pen unsigned int nIndex 0 nIndex Index of the carrier board on which theSmt350 is plugged in The return value is a pointer to an Smt350 interface This function obtains an interface to an Smt350 plugged in the first TIM site of a Sundance carrier board Smt350Close void Smt350Close IFSmt350 p p Pointer to theSmt350 interface None This function closes the Smt350 interface Smt3510pen IFSmt351 Smt3510pen unsigned int nIndex 0 nIndex Index of the carrier board on which the Smt351 is plugged in The return value is a pointer to an Smt351 interface This function obtains an interface to an Smt351 plugged in the first TIM site of a Sundance carrier board Prototype Parameters Return value Notes Prototype Parameters Return value Notes Prototype Parameters Return value Notes Prototype
16. K pBuf Buffer that receives the data nBytes Size of the data to read hostlink Communication link on which to read the data Host comport per gt default See struct HOST LINK None This function reads data from the carrier board HostWrite void HostWrite void pBuf hostlink cp unsigned int nBytes HOST_LINK pBuf Buffer that contains the data to write nBytes Size of the data to write hostlink Communication link on which to write the data Host comport per gt default See enum HOST LINK None This function writes data to the carrier board HostCancel void HostCancel HOST_LINK hostlink cp Communication link on which to write the data Host comport per hostlink default See enum HOST LINK None This function cancels pending read write operations Prototype Parameters Return value Notes Prototype Parameters Return value Notes Prototype Parameters Return value Notes Prototype WriteCtriWord void WriteCtrlWord unsigned int nCtrl nCtrl Control word to send None This function sends a control word to the FPGA only module on the first TIM slot of a Sundance carrier board StoreDataToFile void StoreDataToFile const char pcFile void pBuf unsigned int nBytes unsigned int nNoOfBit FILE_OPTIONS 0 pcFile Name of the file where the data will be saved pBuf Buffer containing the data nBytes
17. Return SmtGetBoardCount DWORD SmtGetBoardCount void None The return value is the number of carrier board found This function returns the number of Sundance carrier boards found in the system SmtGetBoardIndex INT SmtGetBoardIindex UINT nBaseAddress nBaseAddress Base address of the board to open The return value is the board index value Notes Prototype Parameters Return value Notes Prototype Parameters Return value Notes This function returns an nBaseAddress If index to the board at the base address no board is found the function returns 1 SmtGetBoardInfo SMTRet SmtGetl BoardInfo UINT nIindex SMTBI amp info nIndex Index of the board to return information about info The return value The information structure to populate is the board index This function returns information about the carrier board specified by nIndex SmtGetError const char SmtGetError SMTRet Error Error Error value to translate into a string The return value This function retu is an error string rns a string description of the error specified by Error 3 3 Sundance Hardware Interface Description Once an interface to the hardware has been obtained by calling SmtXXXOpen unsigned int nIndex 0 the interface allows you to access the FPGA only module functions General interface
18. Sampling Frequency Set the sampling frequency in MHz Signal Frequency Set the signal frequency in MHz Signal selection Select the type of signal to write to the SMT351 memory Address Set the address for the memory from where to read Bytes to acquire Set the size of the acquisition in bytes File to save data Set the file to which the data should be written Acquire data Press this button to start an data acquisition 4 1 3 SMT381 This section explains how to use the Configure FPGA only module user interface For more information on how to set the parameters please look at the SMT381 user manual z ConfigFPGAMod SMT350 sMT351 SMT381 sMT384 SMT391 FPGA Configuration Bitstream C Program Files Sundance SMTB026 examples Smt381 SFimwaresSMT 331_SM va Configuring FPGA FPGA configured successfully V Quick Configuration Kv Configure FPGA ADC Reaisters C Direct data Memory data Sampling frequency 500 MHz Signal frequency 25 MHz Display progress information Signal selection Sine wave MV On board clock E Configure DAC Default Values Press this button to set all the Press this button to open the parameters to their default value help file Press this button to reset the carrier board and the FPGA only TIM 1 FPGA Configuration Bitstream Select the FPGA bitstream This field is not used when the Quick Configuration box is checked Quick Configurati
19. Smt350 interface Smt370 interface Smt351 interface Smt381 interface Smt384 interface Smt390 interface Smt391 interface Smt941 interface 3 3 1 General interface The general interface can be used with any FPGA only module plugged in a Sundance carrier board This section describes the general functions ConfigureFPGA HostRead HostWrite HostCancel WriteCtrlWord StoreDataToFile CallbackSet CallbackGet ResetTIMs ResetBoard GenSig SetTimeout GetTimeout the general structures e TEMP e SN e FILE OPTIONS the general enumerated types CHSEL OUTPUT VCXOTYPE HOST LINK DATAFORMAT The general functions All the following functions can throw an SMTExc exception Prototype Parameters ConfigureFPGA void ConfigureFPGA const char bQuickConf false pBitstream FPGA bitstream p Bitstream bool True Reset the FPGA The FPGA has to be fully configured at bQuickConf least once before using this option False Configure fully the FPGA default Return value Notes Prototype Parameters Return value Notes Prototype Parameters Return value Notes Prototype Parameters Return value Notes None This function configures the FPGA of the FPGA only module plugged in the first TIM slot of the Sundance carrier board HostRead void HostRead void pBuf hostlink cp unsigned int nBytes HOST_LIN
20. ave data Set the file to which the data should be written Bytes to acquire Set the size of the acquisition in bytes or 2 14 bit samples Bytes to avoid Set the number of bytes or 2 14 bit samples to avoid before starting the acquisition This can be useful in some cases For example the host comport on the SMT310Q has a very small buffer that can overflow before the acquisition starts By setting the Bytes to avoid field the comport buffer gets empty before starting the acquisition Host link Select the link used between the host and the carrier board Most of the time it will be the host comport but sometime it s possible to use the host RSL Acquire data Press this button to start an data acquisition 4 1 5 SMT391 This section explains how to use the Configure FPGA only module user interface For more information on how to set the parameters please look at the SMT391 user manual En ConfigFPGAMod 5MT350 SMT351 SMT381 SMT384 SMT391 FPGA Configuration Bitstream C Program eee Lea El Configuring FPGA 1 FPGA configured successfully Configure FPGA Display progress informatio ADC Registers Sampling frequency 648 MHz M Onboard clock Analog gain 128 T Test Offset compensation 0 V Channel only ADC input e DRDA channel amp 0 5 2 Configure ADC Acquisition File to save data C Program Files Sundance SMT6026 data txt ES Bytes to acquire 1024 Bytes to avoid 0 Host link Compor
21. de VCInstallDirjatimfc include Winda Manifest Tool gt Resources XML Document Generator Browse Information Build Events Custom Build Step Library Directories Path to use when searching for library files while building a VC project Corresponds to environment variable 4 Tt gt LIB Apply Obtain an interface pointer to the hardware by calling Smtxxx0pen unsigned int nIindex 0 Use the interface pointer to call functions related to the hardware Example Open the SMT391 library IFSmt391 pSmt391 Smt3910pen 0 pSmt391 gt ResetTIMs Configure the FPGA pSmt 391 gt ConfigureFPGA BITSTREAM QUICK _CONF 3 2 Functions exported by SmtFPGA dll This section describes each of the functions exported by SmtFPGA dll These functions are described in the header file IFSmtFPGA h SmtFPGAOpen SmtFPGAClose Smt3500pen Smt350Close Smt3510pen Smt351Close Smt3700pen Smt370Close Smt3840pen Smt384Close Smt3900pen Smt390Close Smt3910pen smt391Close Smt9410pen Smt941Close The following functions can be used to get information about the carrier board SmtGetBoardCount SmtGetBoardIndex SmtGetBoardInfo SmtGetError Functions to access the interfaces SmtFPGAOpen Prototype IFSmtFPGA SmtFPGAOpen unsigned int nIndex 0 Index of the carrier board on which the FPGA only module is Parameters nIndex plugged in Return value The return value is a pointer to an
22. e SMT941 ConfigureADCReg Prototype int ConfigureADCReg OUTPUT output CLKMODE941 clkmode output Type of data the ADCs output See enum OUTPUT Parameters clkmode Select the clock parameters See struct CLKMODE941 Return value Notes Prototype Parameters Return value Notes Prototype Parameters Return value Notes Prototype Parameters Return value Notes None This function configures the ADC registers of the SMT941 AcquireAB int AcquireAB unsigned int chart unsigned short b nBytes unsigned ay nBytes Number of bytes to acquire a Data sampled from channel A b Data sampled from channel B Return 0 if successful otherwise 1 This function acquires data on channel A and channel B of the SMT941 AcquireCD int AcquireCD unsigned int chart unsigned short d nBytes unsigned CO nBytes Number of bytes to acquire c Data sampled from channel C d Data sampled from channel D Return 0 if successful otherwise 1 This function acquires data on channel C and channel D of the SMT941 GetFirmwareVersion unsigned int GetFirmwareVersion void None None This function gets the firmware version Before using this function the user has to make sure this functionality is part of the firmware used to program the FPGA GetError Prototype char GetError int err Parameters err Error code Return The de
23. elect Project gt Properties from the menu Select the VC Directories in Configuration properties on the left of the window Select Include directories on the right of the window Add the path to the include directory for the SMT1026 installation to the list of directories as shown below Select Library directories on the right of the window Add the path to the library files for the SMT1026 to the list of directories Configuration 3 Software This section describes the functionality of the SMT1026 package 3 1 Interface Mechanism The design makes use of a C style interface pointer to the hardware SmtFPGA dl exports functions that gather information about the installed boards and provide an interface pointer for later use To use the SMT1026 you need to Active Release v Platform Active Win32 x Configuration Manager p gt Common Properties 4 Gens 4 Configuration Properties Executable Directories VCInstallDir bin WindowsSdkDirjbin NETFX 4 0 Tools S 1 General Include Directories VCInstallDirjinclude S VCInstallDirjatimfc include S Winde Debugging Reference Directories S VCInstallDirjatimfc lib S VClnstallDir lib VC Directories Library Directories VCInstallDir lib VCInstallDirjatimfc lib SWindowsSdk y C C Source Directories VCInstallDirjatimfc src mfc VCinstallDinjatlmfc sre mfct Linker Exclude Directories VCinstallDirjinclu
24. h 2 Folders Ez Address DB C Program Files Sundance SMT6026 Examples SMT391 Firmware Folders x Name s l E sMT6001 A 45M7391_SMT338VP30_CP_chl app smreo12 4sm7391_SMT338 P30_CP_chQ app C SMT6025 EZ SMT391_5MT3685 35_CP_chI app a smT6026 EZ SMT391_5MT3685x35_CP_chQ app S E Examples E readme txt 6 5 SMT350 H SMT351 E E SMT381 E E SMT384 E E S5MT391 D Firmware O Host 3 Output 5 Include O Lib lt 5 objects Disk free space 49 9 GB 4 My Computer The bitstream have been compiled with 3L Diamond FPGA and therefore are app files The readme txt file contains some information about the firmware The source code can be provided on demand but an NDA Non Disclosure Agreement has to be signed first Remark The FPGA library works with the basic functionalities implemented in the firmware supplied with the SMT1026 If bitstreams other than the ones provided with the SMT1026 are used with the FPGA library the software will not work properly anymore In those circumstances Sundance will decline all responsibilities 5 2 Host This folder contains the source code for the host It s installed in the following directory C Program Files Sundance SMT6026 Examples SMT391 Host Remark SMT391 can be replaced by the number of the board you are interested in File Edit View Favorites Tools Help sex fl lt 2 T Search e Folders z Address C Program Files Sundance SMT
25. hannel I and Q Configure ADC Press this button to configure the ADCs of the SMT391 3 Acquisition File to save data Set the file to which the data should be written Bytes to acquire Set the size of the acquisition in bytes or 8 bit samples Bytes to avoid Set the number of bytes or 8 bit samples to avoid before starting the acquisition This can be useful in some cases For example the host comport on the SMT310Q has a very small buffer that can overflow before the acquisition starts By setting the Bytes to avoid field the comport buffer gets empty before starting the acquisition Host link Select the link used between the host and the carrier board Most of the time it will be the host comport but sometime it s possible to use the host RSL Acquire data Press this button to start an data acquisition 5 Examples The SMT1026 provides several examples to illustrate the used of the Sundance s FPGA library There is an example for each supported FPGA module and a more generic one Those examples are organised in three folders e Firmware e Host e Output 5 1 Firmware This folder contains several firmware for the FPGA only module It s installed in the following directory C Program Files Sundance SMT6026 Examples SMT391 Firmware Remark SMT391 can be replaced by the number of the board you are interested in S Firmware TER File Edit View Favorites Tools Help sek Q Dd Searc
26. he signal data nBytes Size of the buffer in bytes None Notes Prototype Parameters Return v alue Notes Prototype Parameters Return v alue Notes This function generates a signal SetTimeout void SetTimeout unsigned int n Value of the timeout in ms If O the timeout is not set and the comport and RSL functions will never return if they fail None This function changes the value of the timeout for the comport and RSL functions Unless really necessary the user is not advised to use this function GetTimeout unsigned int GetTimeout void None The current value of the timeout This function returns the current value of the timeout for the comport and RSL functions The general structures struct TEMP n n unsigned int nAir unsigned int nFPGA nsigned nsigned Daughter_Al struct SN unsigned int nNoA unsigned int nNoB Daughter_Air Temperature measured on the base module such as an SMT338VP Temperature measured on the FPGA of the base module as Temperature measured on the daughter module int Temperature measured on the ADCs of the daughter module DC Serial number A of the base module Serial number B of the base module unsigned int nNo unsigned int nDa unsigned int nDa unsigned int nDa unsigned int nDa unsigned int nNoC Serial number C of the base module D Serial number D of the base
27. ing this function the user has to make sure this functionality is part of the firmware used to program the FPGA The SMT391 structures struct SETADC391 bool bikro unsigned int nAnalogGain unsigned int nOffsetComp bool bTest unsigned int nDrda True The input for the channels I and Q is the same False Channels I and Q have different inputs The default value is true Analog gain The default value is 128 Offset compensation The default value is O True the ADCs outputs test data False the ADCs outputs data from theirs inputs The default value is false Set the value of the DRDA between 0 and 7 The default value is 7 The SMT391 enumerated types Enumerated type enun e e e e 1k_mode_ Ik mode Q lk_mode_ Ilk mode Oli O n CLKMODE391 _I_Q_O TRONO Oo Description Selects the clock mode 3 3 7 SMT941 interface The SMT941 interface can be used with a SMT941 plugged in a Sundance carrier board This section describes the SMT941 functions ResetDevices ConfigureADCReg AcquireAB AcquireCD GetFirmwareVersion GetError the SMT941 structures e CLKMODE941 the SMT941 enumerated types e ERRORS e CLOCK DIVIDER The SMT941 functions All the following functions can throw an SMTExc exception ResetDevices Prototype void ResetDevices void Parameters None Return None value Notes This function reset th
28. ion ChannelAB y ADC sampling frequency Jinput clock 73 y Data format Binay y DAC sampling frequency Input clock 22 Y I Extemal clock Trigger inverting Gain DAC A amp B 40954 T Test TT Extemal trigger Offset DAC A amp B E o 2 Configure ADC Acquisition File to save data SMT60264S ource Config PGAMod Host data txt pe NB of bytes to acquire 1024 NB of bytes to avoid 0 Host link Comport y G Acquire data Default Values Cancel Press this button to set all the Press this button to open the parameters to their default value help file Press this button to reset the carrier board and the FPGA only TIM 1 FPGA Configuration Bitstream Select the FPGA bitstream This field is not used when the Quick Configuration box is checked Quick Configuration Check this check box if the FPGA has already been configured with the right bitstream When this check box is checked only a start key is sent to the FPGA to reconfigure it Configure FPGA Press this button to configure the FPGA of the SMT391 2 ADC Configuration CDCM7005 AD9510 Select the type of component fitted on the FPGA TIM VCXO type Select the type of the VCXO fitted on the FPGA TIM 100 MHz or 245 76 MHz ADC Sampling Frequency Set the sampling frequency for the ADCs of the SMT350 Up to 125MHz DAC Sampling Frequency Set the sampling frequency for the DACs of the SMT350 Up
29. ist aautontatstaetoutondatenatede em muianimane manta aei 15 3 32 MIS IEA AC ee ee 21 3 3 3 SMT35 LIO AO dida 24 3 3 4 SMTI S Maha he ts Los e PPPPPAO OPOO0 _ 050 A 25 A h 27 OM rs 200 BN A 2 OO a aa a ehh 29 evi OM A POR ae aaa a alo sisas 34 VUH S ii 37 4 1 Configure FPGA only modules ccoconconcnncnncnncnocnocnocnnrnnrnnr nor nor nnr nor nar narrar narrar narrar nara 37 AAE SMES o Ona tanita A AA a 38 A2 SMT3 S Re ae eRe nS iaidd dioad ERA RE EA ee 40 2 FN Bis 1 Bl feo bl A A A A A A AA 41 ATA ME ao iaa 43 A O e Pn 44 Examples a see ine toner ooh a Teo nN Te iT SOR an TOO STR Hon Cann St erie ann ee ene eH oN an een on Soe 46 Sel CHITMWareiacsdnckdn dade dein hein ada ada dein San Sadak dn dann tne dated 46 A a A O eile SN RY le 47 1 Introduction This section gives a brief description of the SMT1026 package The SMT1026 is a SDK for Windows The SMT1026 is an efficient ready to use host side interface to Sundance FPGA only module It allows you to control the FPGA only modules from the host as well as to exchange data between the host and the module on the first site of the Sundance carrier board Your application f Smt1026 Acquire Sundance carrier board on PCI104e Configure The figure above shows the SMT1026 forming the link between your application and the Sundance hardware in your system The SMT1026 hides the details of the device driver allowing you to concentrate on the development process
30. ition File to save data C Program Files Sundance SMT6026 data txt 5 Bytes to acquire 8192 Bytes to avoid 0 Host link Comport y G Acquire data Default Values Press this button to set all the Press this button to open the parameters to their default value help file Press this button to reset the carrier board and the FPGA only TIM 1 FPGA Configuration Bitstream Select the FPGA bitstream This field is not used when the Quick Configuration box is checked Quick Configuration Check this check box if the FPGA has already been configured with the right bitstream When this check box is checked only a start key is sent to the FPGA to reconfigure it Configure FPGA Press this button to configure the FPGA of the SMT384 2 ADC Configuration Channel selection Select the output channel s Data format Select the format of the output data binary or 2 s complement VCXO type Select the type of the VCXO fitted on the FPGA TIM 100 MHz or 245 76 MHz Clock Divider Select the clock divider for the sampling frequency External clock Check this check box if you are using an external clock Trigger inverting Check this check box for an inverting trigger External trigger Check this check box if you are using an external trigger Test Check this check box to use the ADC test data as input data Configure ADC Press this button to configure the ADCs of the SMT384 3 Acquisition File to s
31. lesiSundance1SMT1026 The applications need access to smtFPGA h and smtFPGA lib You need to arrange that these files can be found during compilation and linking We strongly recommend that you do not make copies of these files but access them from the installation directory See the Visual Studio Configuration for more details 2 3 2 Visual Studio Configuration The installation process configures the examples to compile and link correctly without any user intervention However for your own applications you need to configure visual studio to add the paths to the include and lib directories to your compiler options You do this as follows Open Visual studio Select Tools gt Options from the menu Select the Directories tab Select Include files from the Show directories for drop down list Add the path to the include directory for the SMT1026 installation to the list of directories Select Library files from the Show directories for drop down list Add the path to the library files for the SMT1026 to the to the list of directories 2 3 3 Visual Studio express 2010 Configuration The installation process configures the examples to compile and link correctly without any user intervention However for your own applications you need to configure visual studio to add the paths to the include and lib directories to your compiler options You do this as follows Open Visual studio express 2010 S
32. lock True to use the on board clock otherwise false False is the default value bOnBoardClk Sampling frequency of the on board clock This function configures the clock of the SMT381 SetTrigger void SetTrigger bool bStart bStart Set the trigger to O of 1 The trigger is active high None This function sets the trigger of the SMT381 Reset void Reset bool bSDB bool bDAC bool bDCM SDB reset 0 inactive 1 active DAC reset active on falling edge Reset all FPGA internal registers and DAC bDCM DCM reset O inactive 1 active Return None value Notes This function resets the SMT381 The SMT381 enumerated types Enumerated RA type Description enum DATAMODE Selects the data mode direct memory direct the input data comes from the FPGA memory the input data i comes from the DAC memory 3 3 5 SMT384 interface The SMT384 interface can be used with a SMT384 plugged in a Sundance carrier board This section describes the SMT384 functions ResetDevices ConfigureADCReg ConfigureADCClock Acquire the SMT384 structures e CLKMODE384 The SMT384 functions All the following functions can throw an SMTExc exception ResetDevices Prototype Parameters Return value Notes Prototype Parameters Return value Notes Prototype Parameters Return value Notes Prototype Parameters Return value Notes void Rese
33. ls Help peck amp 5 Search W Folders ER a Address a C Program FilesiSundancel 5MT6026 Folders 2 Sundance A examples 4 E smT6001 Include smT6012 Lib B SMT6025 EA configFPGAMod exe EE sMT6026 W ReleaseNotes rtf H Examples ES SMT6026 chm 15 Include 5 Lib L3 SMT6300 lt 6 objects Disk free space 49 9 GB _ v Eo Type File Folder File Folder File Folder Application Rich Text Format Compiled HTML Help 4 My Computer This user interface is a quick and easy way to configure and communicate with an FPGA only module on the first TIM site of a Sundance carrier board It s also a good example of what can be achieved using the SMT1026 libraries To run the application double click on ConfigFPGAMod exe and select the tab corresponding to your FPGA module SMT350 SMT351 SMT381 SMT384 SMT391 4 1 1 SMT350 This section explains how to use the Configure FPGA only module user interface For more information on how to set the parameters please look at the SMT350 user manual z ConfigFPGAMod SMT350 SMT351 SMT381 SMT384 SMT331 5 i l FPGA Configuration Display progress informatio Bitstream C Program Files Sundance SMT 6026 examples S mt350 Firmware SMT350_A4D Pe Configuring FPGA FPGA configured successfully TA Quick Configuration Configure FPGA ADC DAC Registers CDCM7005 C AD9510 VCXO type vex 100MH2 gt Channel select
34. module ughterNoA Serial number A of the daughter module ughterNoB Serial number B of the daughter module ughterNoC Serial number C of the daughter module ughterNoD Serial number D of the daughter module struct FILE OPTIONS bool bAppend bool bDateStamp True append data at the end of the file False overwrite the file The default value is false True add date and time before writing the data False don t add the date and time inside the file The default value is false The general enumerated types Enumerated types enum CHSEL channela 1 channelb 2 channelab 3 enum OUTPUT normal O zeros 1 ones 2 test o enum VCXOTYPE vcexol00 0 vexo245 1 y enum HOST_LINK cp 0 jets IL y Description Selects the active channel Selects the type of the output samples Selects the VCXO installed on the FPGA module 100Mhz or 245 76 MHz The host application can always communicate with the Sundance carrier boards through the host comport But some carrier board offers other communication link like the RSL link This enumerated type selects the host link used to communicate with the Sundance carrier board enum DATAFORMAT binary 0 complement2 1 y enum SIGGEN Selects the format of the output samples sine 0 triangle 1 square 2 Selects the shape of the signal to generate ramp_pos 3 ramp_neg 4 y
35. on Check this check box if the FPGA has already been configured with the right bitstream When this check box is checked only a start key is sent to the FPGA to reconfigure it Configure FPGA Press this button to configure the FPGA of the SMT391 2 DAC Configuration Direct data Memory data Select the source of the input data Sampling Frequency Set the sampling frequency for the DACs of the SMT381 The range is from 50MHz to 500MHz Signal Frequency Set the signal frequency of the signal to write to the DAC memories Signal selection Select the type of signal to write to the DAC memories On board clock Check this check box if you are using the on board clock Configure DAC Press this button to configure the DACs of the SMT381 4 1 4 SMT384 This section explains how to use the Configure FPGA only module user interface For more information on how to set the parameters please look at the SM7384 user manual E ConfigFPGAMod 5MT350 SMT351 smT381 SMT384 smras1 FPGA Configuration Bitstream C Program Files Sundance SMTB026 E xamples SMT 384 Fimware SMT 384_5 El Configuring FPGA FPGA configured successfully I Quick Configuration 1 Configure FPGA ADC Registers Channel selection Channel AB for CD F Extemal clock I Trigger inverting oe Bray z I Extemal trigger ptes VCXO 245 76MHz v I Test Display progress informatic Clock divider 22 2 Configure ADC Acquis
36. scription of the error code value Notes This function returns the description of the error code enter as parameter The SMT941 structures struct CLKMODE941 True External reference bool bExtRef False On board 10 MHz reference The default value is false True External Clock bool bExtClk False On board VCXO The default value is false Trigger polarity True Inverting False Non Inverting The default value is false bool bTrigInvert Trigger selection True External trigger False Internal trigger The default value is false bool birighxt True External reference bool b2sComplement False On board 10 MHz reference The default value is false Set the value of the clock divider unsigned int nCikDiv A The default value is div_by_one The SMT941 enumerated types Enumerated type Description enum ERRORS Error codes ERR_SUCCESS ERR_CLK_REG ERR_CLK_LOCKED Za ERR_ADCAB_DCM_LOCKED 3 ERR_ADCCD_DCM_LOCKED 4 0 1 enum CLOCK_DIVIDER div_by_one div_by_two div_by_three Selects the clock divider div by four div_by_five 4 Utilities The utilities are useful little applications The following utilities are available with the SMT1026 e ConfigFPGAMod 4 1 Configure FPGA only modules This application is installed in the following directory C Program Files Sundance SMT6026 ConfigFPGAMod exe S SMT6026 File Edit View Favorites Too
37. t 3 Acquire data o o Default Values Cace Press this button to set all the Press this button to open the parameters to their default value help file Press this button to reset the carrier board and the FPGA only TIM 1 FPGA Configuration Bitstream Select the FPGA bitstream This field is not used when the Quick Configuration box is checked Quick Configuration Check this check box if the FPGA has already been configured with the right bitstream When this check box is checked only a start key is sent to the FPGA to reconfigure it Configure FPGA Press this button to configure the FPGA of the SMT391 2 ADC Configuration Sampling Frequency Set the sampling frequency for the ADCs of the SMT391 The range is from 50MHz to 1GHz Analog gain Set the analog gain The range is from O to 255 Offset Compensation Set the offset compensation The range is from 0 to 255 On board clock Check this check box if you are using the on board clock DRDA channel I amp Q Set the DRDA value This value depends of the FPGA module and the sampling frequency Test Check this check box to use the ADC test data as input data In the next step the data will be saved in two separate files One file should contain a ramp with a positive slope The other file should contain a ramp with a negative slope Channel I only ADC input Check this check box to use the connector of channel I as the only input source for c
38. tDevices void None None This function does a global reset of the SMT384 ADCs Clock ConfigureADCReg nVCXOTYPE void ConfigureADCReg OUTPUT output unsigned int nClkDiv vcxotype output Type of data the ADCs output See enum OUTPUT nClkDiv VCO clock divider to set the sampling frequency vex type Select the right VCXO used on the SMT384 100MHz or 245 76 VcxOLYP MHz See enum VCXOTYPE None This function configures the ADC registers of the SMT384 ConfigureADCClock void ConfigureADCC1k CLKMODE384 clkmode clkmode ADC clock mode parameters See struct CLKMODE384 None This function configures the clock for the ADCs on the SMT384 Acquire void Acquire CLKMODE384 clkmode unsigned int nBytes clkmode ADC clock mode parameters See struct CLKMODE384 nBytes Number of bytes to acquire None This function set the ADCs on the SMT384 to acquire data The SMT384 structures struct CLKMODE384 bool bool Bool bool DOOL DOOL CHSEL ABChSel CHS HE Ve De cil Dool bool 3 3 6 bExtRef vacios bABTrigInvert ABTrigExt bCDTrigInvert CD Miss ade bAB2sComplement bCD2sComplement SMT391 interface true external reference false on board 10 MHz reference The default value is false true external clock false on board VCXO The default value is false true trigger polarity channel A and
39. tion configures the ADC DAC and clock registers ConfigureADCClock void ConfigureADCC1lk CLKMODE350 pClkMode pClkMode ADC clock mode parameters See struct CLKSMT350 None This function configures the ADC clock Acquire void Acquire CLKMODE350 pClkMode pClkMode ADC clock mode parameters See struct CLKSMT350 None This function acquires data from the Smt350 The SMT350 sructures struct CLKMODE350 bool bExtRet bool bExtG lk bool bTrigInvert Sen Je eo lie CASE Chisel bool b2sComplement struct SETDAC unsigned int nGainA unsigned int nGainB struct SETCLK SAMPLING_RATIO ADCSamplingRatio SAMPLING_RATIO DACSamplingRatio unsigned int nOffsetA unsigned int nOffsetB true external reference false on board 10 MHz reference The default value is false true external clock false on board VCXO The default value is false true trigger polarity channel A and B false Non inverting The default value is false true trigger selection channel A and B false internal trigger The default value is false Channel selection The default value is channelab True ADC A and B output 2 s complement samples False ADC A and B output binary samples The default value is false Offset DAC channel A The default value is O Gain DAC channel A The default value is OXFFF Offset DAC channel B The default value is O
40. tion on how to set the parameters please look at the SMT351 user manual E ConfigFPGAMod SMT350 SMT351 smr3e1 smrass smras FPGA Configuration ee A Bitstream CAP Files Sundance SMT6026 examples Smt351 FirmwaresSMT351_CP Configuring FPGA FPGA configured successfully 1 Configure FPGA f Display progress information Acquisition From host comport From SDB Sampling frequency 500 MHz Signal frequency 25 MHz Signal selection Sine wave X 2 Address 0 Bytes to acquire 1024 File to save data CoXProgram Files Sundance SMT6026 data tut m Acquire data Default Values Cancel DK Press this button to set all the Press this button to open the parameters to their default value help file Press this button to reset the carrier board and the FPGA only TIM 1 FPGA Configuration Bitstream Select the FPGA bitstream This field is not used when the Quick Configuration box is checked Quick Configuration Check this check box if the FPGA has already been configured with the right bitstream When this check box is checked only a start key is sent to the FPGA to reconfigure it Configure FPGA Press this button to configure the FPGA of the SMT391 2 Acquisition From host comport From SDB Select the origin of the input data If the input data comes from the host comport the followings parameters define the signal to save into the SMT351 memory
41. ugged in The return value is a pointer to an Smt390 interface This function obtains an interface to an Smt390 plugged in the first TIM site of a Sundance carrier board Smt390Close void Smt390Close IFSmt390 p p Pointer to the Smt390 interface None This function closes the Smt390 interface Smt3910pen IFSmt391 Smt3910pen unsigned int nIndex 0 nIndex Index of the carrier board on which the Smt391 is plugged in The return value is a pointer to an Smt391 interface This function obtains an interface to an Smt391 plugged in the first TIM site of a Sundance carrier board Smt391Close void Smt350Close IFSmt391 p p Pointer to the Smt391 interface None Notes Prototype Parameters Return value Notes Prototype Parameters Return value Notes This function closes the Smt391 interface Smt9410pen IFSmt941 Smt9410pen unsigned int nIndex 0 nIndex Index of the carrier board on which the Smt941 is plugged in The return value is a pointer to an Smt941 interface This function obtains an interface to an Smt941 plugged in the first TIM site of a Sundance carrier board Smt941Close void Smt941Close IFSmt941 p p Pointer to the Smt941 interface None This function closes the Smt941 interface Functions to get information about the carrier board Prototype Parameters Return value Notes Prototype Parameters
Download Pdf Manuals
Related Search