Home

ECDR-GC314-FS SoftwareUserManual

1. csccscssssssoscsssssessensessesovessssseosensensevsevessssseovevsenseocevessssneavensensensevessanveaveneas 4 23 VG COMO PUNCO Calio resiente AA E E E 4 24 ecdrG C314 FsSetG lobalSyncMask ccsscssssssssssecsssssssecsssssssesesssssssscsssssssscssessssssscesssssssessessssseacesesssscasesessseseens 4 25 ecdrG C314 F sClearG lobalSyncMask ccsesessssssssssssecsssssssesssssssssscssessssscssesssssescsssssssscssessssseacesesssseasessssseseens 4 26 PCC IE Sse by EN T Ka E E A tenets ea teat aeraeeci teatro tioes 4 27 ecdrG cS MFSC learSyncMaSkK ssseroseiseeitercrusorursreriroettretsttriciketd rotid tb tora ttes terade eiee Eek toC ENES ketin EE NENON KANES rE Eois 4 29 ZO ECDR GC314 FS Driver pCa een Revision 1 0 ecdiG co PA FST WD SVG opcscsieseecsssncsuccesressesess rN e E E EE E EEEE EE EE E EEE EE EAE E manne 4 30 CCUG C51 ESI ISADICSVING scssasnissasszouszntsiesaeeresesevobetiesiosadondbesstonsentstebgspnesnstvobitossiesgeendsezevonseglabesgeenssesstobitoistubaroatoese 4 31 ecdrG C3I4FsSetSyncBusMode csesscssorcssssrssvessessesenssssevsovessssseasensensensevesssscavevsenseosevessasssovevsensensevessanseavenees 4 32 PGE AES Se e RE TL a en nnn eee eee 4 33 OCOIG C31L4ZPSSELSVNICZRIUST Ki Aale AAE A E A E EEE AE 4 34 BCCI CO14 FSG Choy IRE TIMO 5sc cscszsssasatsxssnessenconstpsssesesnnsssencansyagaanesnncaunscoaponseuesssanssnasnosesanssossssnssnepeoagensentstss 4 35 GOL MGT co AFSG etne RETIE Ae ee ee nee eee 4 36 FP Taree ON
2. ECDR GC314 XXX FS Software User Manual This manual covers the Echotek ECDR GC314 FS family of high speed digital receiver boards ECDR GC314 PMC FS ECDR GC314 PCI FS ECDR GC314 PCI R OT REVISION LO ECHOTEK CORPORATION 555 Sparkman Drive Suite 400 Huntsville AL 35816 Phone 256 721 1911 Fax 256 721 9266 E Mail Sales echotek com Web Site http Awww echotek com ZO ECDR GC314 FS Driver pCa een Revision 1 0 Copyright statement All rights reserved Disclaimer The information in this document has been carefully checked and is believed to be entirely reliable However no responsibility is assumed for inaccuracies Echotek Corporation makes no representations or warranties with respect to the contents hereof and specifically disclaims any implied warranties of merchantability or fitness for any particular purpose Furthermore Echotek Corporation reserves the right to make changes to any product herein to improve reliability function or design without obligation of Echotek Corporation to notify any person of such revision or changes Echotek Corporation does not assume any liability arising out of applications or use of any product or circuit described herein neither does it convey any license under its patent rights nor the rights of others ZO ECDR GC314 FS Driver A ee Revision 1 0 Revision History Rev Date Chapter Section Change Addition 0 5 07 18 03 Preliminary Release Updated document to ref
3. ECDR GC314 FS Driver oree Revision 1 0 ecdrGc314FsUnregisterFifoOverflow Callback This function call enables a user to unregister an event callback function The Unregister function call disables the event notification interrupt Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsUnregisterFifoOverflowCallback EcdrGc314FsBoardObject pBoardObject U32 receiverBlock U32 channel Return Values EC OK Or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance receiverBlock The Receiver Block to configure Valid choices are BC IWB RECEIVER EC_GC4016_ RECEIVER 1 EC_GC4016_RECEIVER_2 EC_GC4016_RECEIVER_3 channel The channel of the Receiver Block to configure Valid choices are EC_ GC4016_CHANNEL_A EC_ GC4016_CHANNEL_B EC_ GC4016_CHANNEL_C EC_ GC4016_CHANNEL_D Chapter 4 Application Programming Interface API Page 4 74 ZO ECDR GC314 FS Driver oree Revision 1 0 ecdrGc314FsRegisterFifoLevelCallback This function call enables a user to register an event callback function that will be executed when the number of data words in the specified FIFO is equal to or exceeds the level amount The Register function call enables the event notification interrupt The prototype of the callback function must be void function void For Receiver Blocks that only have one channel the IWB Block the channel argument is ignore
4. EC_ GC4016_CHANNEL_C EC_ GC4016_CHANNEL_D Chapter 4 Application Programming Interface API Page 4 78 ZO ECDR GC314 FS Driver a ee Revision 1 0 Number of data words to copy from the specified FIFO Pointer to a U32 pointer used to pass back the address of the buffer into which the data for this transfer request will be stored Chapter 4 Application Programming Interface API Page 4 79 ZO ECDR GC314 FS Driver hore Revision 1 0 ecdrGc314FsAddPciDmaTransfer This function call adds a D MA transfer request to the specified D MA transfer list This function call will chain the transfer request to the other request in the list For Receiver Blocks that only have one channel the IWB Block the channel argument is ignored Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsAddPciDmaTransfer EcdrGc314FsBoardObject pBoardObject DmaTransferList pDma U32 receiverBlock U32 channel USzZ2 wordcount U32 pburrer Retum Values EC_OK or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance pDma Pointer to the DmaTransferList to which this request is to be added chained receiverBlock The Receiver Block to query Valid choices are EC LWB RECEIVER EC_GC4016_RECEIVER_1 EC_GC4016_RECEIVER_2 EC_GC4016_RECEIVER_3 channel The channel of the Receiver Block to query Valid choices are EC_ GC4016_CHANNEL_A E
5. EcdrGc314FsBoardObject pBoardObject Retum Values EC_OK or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance Chapter 4 Application Programming Interface API Page 4 13 oo ECDR GC314 FS Driver OP Revision 1 0 ecdrGc314FsEnableLbTerm This function call enables termination of the Local Bus cycle after the specified termination count The termination count represents the number of PCI clock cycles that must pass without a local bus response before the Local Bus termination occurs The initial state of the Local Bus Termination is disabled NOTE hen assigning this value ensure that enough time is allowed for a Local Bus transfer to complete Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsEnableLbTerm EcdrGc314FsBoardObject pBoardObject U32 terminationCount Retum Values EC_OK or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance terminat i onCount Number of PCI clock cycles that must pass without a Local Bus response before the Local Bus termination occurs This is a 32 bit count Chapter 4 Application Programming Interface API Page 4 14 ZO ECDR GC314 FS Driver a ee Revision 1 0 ecdrGc314FsDisableLbTerm This function call disables the termination of the Local Bus cycle The initial
6. HUIL 2 nemorcy sllocstion isiled Wind River Syska piim i Eni ool a The EcdrG c314Fs workspace is made up of several projects The main project is the EcdrG c314Fs project and the others are Echotek code library projects The output of each project is linked together to form the ECD R GC314 FS driver static library object EcdrGc314Fs o which is in the Projec V xW orks Bin subdirectory The driver code is delivered already compiled and linked into the library object The following steps can be used to link the ECD R GC314 FS driver library object to a user application 1 Under the Builds setting of the User Application project add the ECDR GC314 FS DriverCode Project VxWorks Bin EcdrGc34Fs 0 file to the PRJ_LIBS macro Chapter 2 Building and Linking the Driver Page 2 3 ZO ECDR GC314 FS Driver TAD Revision 1 0 Properties build specification Bin LeL compiler l Link Order assembler linker General Rules Macros Ok Macros PR LIBS Cancel Mame PRJ_LIBS Apply Value DriverCade Project WoarksBingEcdacal 4Fs o0 Help Comment Libraries against which a downloadable app is linked gt Add Set Delete 2 Next click C C compiler and type the following paths to specify your C C compiler rules IC ProjectPath ECD R GC314 FS DriverCode Source IC ProjectPath ECD R GC314 FS DriverCode Lib where ProjectPath is the application code root path
7. Properties build specification Bin General Rules Macros L L compiler Link Order assembler linker OK I Include debug info Optimization level none Cancel g metrict align nostdinc PAW MULTI THAEAD Apply D_REENTRANT fvolatie fro buitin fro for scope l IL Tormada tanget h OCPU PPCEO4 IL ProjectPath ECDR GCS14 F5 DnverlodesS ource JC 4AProjectPath ECD A GCO31 4 FS DriverCode Lib Tool coppe Help dd 3 Finally compile and link with your code The application code delivered with the ECD R G C314 FS driver code can be used as an example of the linking procedure Chapter 2 Building and Linking the Driver Page 2 4 ZO ECDR GC314 FS Driver TAD Revision 1 0 Building the Driver for Windows The ECD R GC314 FS driver was developed using the Microsoft Visual C 6 0 IDE Integrated D evelopment Environment All required workspace and project files are included in the Project W indows subdirectory The ECD R G C314 FS driver code is delivered as a static library object that can be linked with a user s application or system code The source code and project files are delivered incase a user needs to modify the driver code for a specific application The following shows the Visual C IDE with the ECD R GC314 FS driver workspace files EcdrGc314Fs Microsoft isual C C Source EcBoardObject c a E oj x B File Edit wiew Insert Project Build Tools
8. Table 4 2 IWB Block Data Value Macros sscssssssssssssssssssssssssssssssssssssssssssssessssasesssssssasesssssesssess 4 52 Table 4 3 TI Receiver Block Register OffSets scssssssssssssssssssssscescscssssssesesesesesesesesesessssssessessssees 4 53 vii ZO ECDR GC314 FS Driver oneee Revision 0 4 Chapter 1 Introduction This chapter contains a brief introduction to Echotek Corporation s ECD R GC314 FS driver code a list of system requirements and technical support contact information Chapter 1 Introduction Page 1 1 ZO ECDR GC314 FS Driver oree Revision 1 0 Features The ECD R GC314 F driver code is designed for use with Echotek s ECD R GC314 FS family of high speed digital receiver boards which consists of the following boards e ECDR GC314 PMC FS e ECDR GC314 PCI FS e ECDR GC314R 0T The ECD R GC314 FS driver code is designed to support operation under the Windows NT 2000 Linux and VxWorks O perating Systems This driver is supplied as a statically linked library for all supported operating systems The source code is also supplied along with workspace and project files that can be used to compile the code The ECD R G C314 FS driver uses the Jungo WinD river product and provides the necessary run time components For complete descriptions of supported function calls refer to Chapter 4 A pplication Programming Interface A PI Before Getting Started Before installing the ECD R GC314 FS drive
9. Chapter 4 Application Programming Interface API Page 4 91 ZO ECDR GC314 FS Driver a ee Revision 1 0 ecdrGc314FsUnregisterRwDmal ransferDoneCallback T his function call enables a user to unregister an event callback function The Unregister function call disables the event notification interrupt Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsUnregisterRwDmaTransferDoneCallback EcdrGc314FsBoardObject pBoardObject Retum Values EC_OK or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance Chapter 4 Application Programming Interface API Page 4 92 ZO ECDR GC314 FS Driver A ee Revision 1 0 ecdrGc314FsRegisterRwErrorCallback This function call enables a user to register an event callback function that will be executed if a RACEway RACE read error or timeout occurs The Register function call enables the event notification interrupt The prototype of the callback function must be void tunction void Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsRegisterRwErrorCallback EcdrGce314FsBoardObject pBoardObject void pFunction void pFuncArgument Retum Values EC_OK or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance pFunction Pointer to the callback function that will be executed wh
10. DGAN orela iana E E re Ee een ees 4 9 SPE PEIL ITIR Se AD ME PEA E E EEE A A E EN E E A enn Siouiy ots 10 ecdro Co lAPSSelectCloCk OUTO E Sc cacscscdsaisccsissasonssesevenacsssiecusoniansegsodepnsbu tastscoapsontspabasbscnisseseccnaasseuseaooeaspagneneorabusunts 11 eoe E En DEE 400 E R E 12 gcro e MAE D EaD Ce EO R taste teretensaneueierdies 13 CCUG co lAFSETaDleLDT OT soraia a a 14 OCI C5 SDI BELO TOT eea AE ore neste eenneonee 4 15 ecdrG c314FsRegisterLbTermCallback cccssssssessssesesessssesssessssesesesssssscssssssssescsssesssscssssssssssessesssescaseeesesescens 4 16 ecdrG c314FsUnregisterLbT ermCallback cccsessssessssssssessssssssssessssssssessessssssscsssssssscssesssssacsssssssscasesessseseens 4 17 OC CD APS Oat Del Ae a ctsasscseccevctectcecidintencrtaciecstestansehiaie E setae acide ateeatcids 4 18 ecdrG c314FsReconfigureFpoa s sccssesessesscssessesssessssssesssssssscsssssssssscsssssssscseessssssscassssssseasessessescsusssesscasessssseseens 4 19 mpu contol FUNCTION GC GIS ssacssasaasassestansaasasasnsenonesnoegsaagonspsoaeseaqssasasneasancseneotgsonasoapsnsessnestonssasnsnsorsnonestoegsasasnanss 4 20 ec drG c3l4FsSelectIwbInputSourCE cesesesessssesesesssessssssssssesessssssssssssssssscscssssssssssssssscscssessssssssesssscssesesessseens 4 21 ecdrG c3l4FsSelectG CA0L6INput SoU E 0 esescsseesssesessssssscsesssssssssssssssssscssssssscsssssssssssssssessssssesssssssssesessssesess 4 22 ecdrG C314FslnputC hanO VerrangGe
11. E ee ee ee ee eee ee ee 3 4 Installing the driver on the target computer ccccceeccccseeeccseeecceeeeeeeeceeaeeeeeseseeeseeeeseneesseeesaes 3 4 Installing the ECD R G C314 FS Driver for LinuX cs esessesecesessssesesssssscssssssssescsssssseseessssssseasesssssesseseessees 3 5 Installing the ECD R G C314 FS Driver for VXWOTKS cesssssesessssesessssssesesessssesessssssesessssssescseessseseseeeeeeseas 3 6 CHAPTER 4 APPLICATION PROGRAMMING INTERFACE API ssccssssssscssssssscssssssecsssseeeseees 4 1 Overview of the ECD R G C314 FS APT ou ssscssessessesenevsssnsovesssseosensensenseneessnnsovensssseavensensensevesnsenesvensasseaves 4 2 Board Initialization and Configuration Function Calls se ssesssesssesssesseesseesseeseenseenseessenssenseennresseessressreseresees 4 3 ecdrG c314FsCreateBoardInstance Create s s snsesesesesessssssessesesesesesenenensrsssesesesesesesonsnsnsnseseseseseseseseenssseseses 4 4 ecdrG c314FsD eleteBoardInstance Delete ccc eccssccsscsscscsscscsssscsssscsscsssccscsscscsscscsacecsacesssceassceecscsassceasees 4 5 OC SG ODT OSA as rasacecasasossaesxecsncncuessace E E A E E EEEE E E 4 6 ecdrG c314FsRegisterLogInfoFunction cccsccesessssessssssssessssssssesessssssescssssssssesssessssesessssssesesssesseacssesseesesseeeeeseas 4 7 ecdrG c314FsUnregisterLogInfoFunction ssesseesseesseesseesseeseesseesseesseessresetnseesstesstsstesetnseessensstesetsreessresernseresens 4 8 Godr CAF SO EIF
12. EcStatus ecdrGc314FsDisableDataFraming EcdrGc314FsBoardObject pBoardObject Us2Z 2recerverbliock U22 channe Retum Values EC_OK or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance receiverBlock The Receiver Block to configure Valid choices are EC _IWE RECEIVER EC_GC4016_ RECEIVER_1 EC_GC4016_RECEIVER_2 EC_GC4016_RECEIVER_3 The channel of the Receiver Block to configure Valid choices are EC_GC4016_CHANNEL_A EC_GC4016_CHANNEL_B EC_GC4016_CHANNEL_C EC_GC4016_CHANNEL_D Chapter 4 Application Programming Interface API Page 4 43 ZO ECDR GC314 FS Driver A ee Revision 1 0 ecdrGc314FsSetChlid This function call enables a user to set the channel ID for any particular channel Synopsis include EcdrGc314FsApi h FCStatus ecdrGcs 4FsserChid EcdrGc314FsBoardObject pBoardObject UsZ Precesversiock U32 channel U22 chia Retum Values EC_OK Or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance receiverBlock The Receiver Block to configure Valid choices are BEC _IWB_ RECEIVER EC_GC4016_ RECEIVER 1 EC_GC4016_RECEIVER_2 EC_GC4016_RECEIVER_3 channel The channel of the Receiver Block to configure Valid choices are EC_GC4016_CHANNEL_A EC_GC4016_CHANNEL_B EC_GC4016_CHANNEL_C EC_GC4016_CHANNEL_D fchId Soo
13. FIFO The level specifies a threshold at which a user is interested in knowing when data in the FIFO is equal to or exceeds the amount The maximum level for the WB Block is 16383 and for the three G C4016 Receiver Blocks is 1023 For the G C4016 Receiver Blocks the level may be a multiple of 1023 based on the FIFO mode of operation Refer to the ECD R GC314 X X X FS H ardware U sers M anual for complete details about the FIFO modes For Receiver Blocks that only have one channel the IWB Block the channel argument is ignored Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsSetFifoLevel EcdrGc314FsBoardObject pBoardObject U32 receiverBlock U32 channel U32 fifolLevel Retum Values EC_OK or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance receiverBlock The Receiver Block to query Valid choices are BEC LWB RECEIVER EC_GC4016_RECEIVER_1 EC_GC4016_RECEIVER_2 EC_GC4016_RECEIVER_3 channel The channel of the Receiver Block to query Valid choices are EC_ GC4016_CHANNEL_A EC_ GC4016_CHANNEL_B EC_ GC4016_CHANNEL_C EC_ GC4016_CHANNEL_D The value of the FIFO level to program into the FIFO Chapter 4 Application Programming Interface API Page 4 70 ZO ECDR GC314 FS Driver pCa een Revision 1 0 ecdrGc314FsGetFifoStatus This function call returns the status of the specified FIFO The possible states are
14. Number of bytes of FPGA image data to be loaded Chapter 4 Application Programming Interface API Page 4 18 ZO ECDR GC314 FS Driver A ee Revision 1 0 ecdrGc314FsReconfigureFpga This function call enables a user to reconfigure the FPGA with the specified image file that has been previously loaded into the onboard Flash memory Refer to the ECD R GC314 X X X FS H ardware U sers M anual for complete details on the FPGA images and their Flash partitioning Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsReconfigureFpga EcdrGc314FsBoardObject oBoardObject U32 imageNumber Retum Values EC_OK Or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance imageNumber Number of the FPGA image in Flash memory to be programmed into the FPGA Chapter 4 Application Programming Interface API Page 4 19 ZO ECDR GC314 FS Driver oree Revision 1 0 Input Control Function Calls The Input C ontrol group of function calls select and configure the source of data to the Receiver Blocks There are four Receiver Blocks consisting of the Echotek Internal Wideband Receiver IWB and three TI Texas Instruments G C4016 Receivers Chapter 4 Application Programming Interface API Page 4 20 ZO ECDR GC314 FS Driver oree Revision 1 0 ecdrGc314FsSelectlwbInputSource This function call selects the input channel i e one of the fron
15. PARAMETER Indicates that one or more parameters were not valid or out of range The ECD R GC314 FS software provides sample application code that uses the API to perform most functions Refer to the application code for examples of the program flow using the ECDR GC314 FS driver API The ECD R GC314 FS boards are made up of multiple Receiver Blocks that control all aspects of data collection The complete details of the board architecture are described in the E CD R GC314 FS H ardware U ser M anual Most ECD R GC314 FS driver API function calls take the parameters and channel of the specific Receiver Block the function is to act upon A unique feature of the ECD R GC314 FS driver API is the ability to OR together the valid Receiver Block values and channel to enable functions to act on more that one identical Receiver Block and or channel at the same time Thus a user can configure multiple Receiver Blocks and or channels with the same configuration using one set of function calls Chapter 4 Application Programming Interface API Page 4 2 ZO ECDR GC314 FS Driver oree Revision 1 0 Board Initialization and Configuration Function Calls The Board Initialization and C onfiguration group of function calls relate to board initialization and configuration These function calls create the existence of the board initialize the driver code to control a specific instance of an ECD R GC314 FS board and initialize and configure the hardware of the sp
16. The channel ID for the specified channel Chapter 4 Application Programming Interface API Page 4 44 ZO ECDR GC314 FS Driver A ee Revision 1 0 ecdrGc314FsGetChlid This function call enables a user to retrieve the channel ID for any particular channel Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsGetChid EcdrGc314FsBoardObject pBoardObject U32 receiverBlock U32 channel U32 pChId Retum Values EC_OK Or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance receiverBlock The Receiver Block to configure Valid choices are EC _IWE RECEIVER EC_GC4016_ RECEIVER_1 EC_GC4016_RECEIVER_2 EC_GC4016_RECEIVER_3 The channel of the Receiver Block to configure Valid choices are EC_GC4016_CHANNEL_A EC_GC4016_CHANNEL_B EC_GC4016_CHANNEL_C EC_GC4016_CHANNEL_D pChiId o Stores the retrieved channel ID Chapter 4 Application Programming Interface API Page 4 45 ZO ECDR GC314 FS Driver hore Revision 1 0 ecdrGc314FsGetFrameCount These function calls allow users to retrieve the current frame count for any particular channel Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsGetFrameCount EcdrGc314FsBoardObject pBoardObject U32 receiverBlock U32 channel U22 pFrameCount gt Retum Values EC_OK Or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by
17. Window Help laj x Ja shg pelo BBS W_LCENSE 7 n Emas s POC no 8e PORE S S ems E to Copyright 2003 Echotek Corp All Fights Reserved fs Workspace Ecdracs14Fs 4 project s A Eel EcdrGe314Fs files a a EchotekOS include EcBoardObject h include lt stdlib h gt include lt string h gt Hinclude lt stdio h gt fg PxSB56Lib BA RecisterLib eee E EcAcquisitionCtrl c oon E EcBoardEtrl e E EcBoardDbject e i E EcFlashintel c include EchotekOS Source Ect e0tilities h include Ple9656Lib Source EcPle9656Bridge h include EcBoardob Def h H EcFpgalmageCtrl c BE cece ne cee eee nce ne cece ce cece ec nn oon cen ca nnn concen ce nena nem nen ce ne oon con cae nanan cence nena oe Local variables a ee E o RARA 3 a I Echec AA yersion in the form major minor bugfix build static EcVersion ecdrbc3l4FsDriverYersion 0x01 0x00 000 Ox00 External Dependencies H 7 Ee EchotekOS files HEE PIRIB5SELib files CE ae cacararrcares create E EE S H E RegisterLib files A I A carer seareeemeemarapansnaenemanenansasapnansiaemnsnsaapnassege static void logInfo U32 infoType const char infoString a si pli Classview Z FileView F z ef Build Debug h FindinFiles1 FindinFiles2 Afa f Source Code Control operation complete 2 The EcdrG c314Fs workspace is made up of several projects The main project is the EcdrG
18. a VE CLIO TCLS near eacaxcaeez cass asnetontacvene a acescasecdeadoiedueatansconanactacnesasasgeacase naasoeasteece senna tossigacmatcers 4 37 ecdrG C3L4FsSetFraminGMode ccccsscssesscsssssesscsssssssessssssssesssssssssscssessesscseesssssescesessssscasesssescscesessesscasesessseseens 4 38 CIN ASG CLI Sat aAA 4 39 BCUTG Co LAP SSEEP AMC SIZE ssterssssczouszcteiasaeeresesszebetiesiatazenasessvonseutstasdsehesas vobitonstes benasesstontedsasesieekesesstebitoisbetgeentoaze 4 40 COS ESIS E E Tal C170 E N E E N E A E E E E E O 4 41 OCG c3 l4FsEpnableD ataF TaN G sevice cccysscasidivesecudivsensstesisrnesvandesadbstvasidbvcouterssdeneettelarsesuasdessddabarseatetsusstesiemeitcis 4 42 ecdrG c314FsD isableD ataPraming ccececesessesesesessssesesessssesessssssescsessssssesessssssesesssesescsesessesescsceesseseaesseeseseess 4 43 EERE TILLIT Sn Ee EPEE A A AE A 4 44 SEE EE PE E AE TE EAA AE AE E E AE EEA A E AEE ET 4 45 Cedr ero AE CGE a O aa S 4 46 Receiver Control Function Calls csssssesessesecsssssssessssssssessssssssssessssssssessesssssscesssssssessesssseeacesessssscasessssseseens 4 47 ecdrG c314FsWriteRcvrConfig Write se sseesseesseessesseesseesseessenseeeseenseesseesseesetuneenseesseensteetesetsseessteseresetsseesreess 4 48 ecdrG c314FsReadRevrGonfig Read ccesscsecscsssssecsssssssesssssssssscsssssssscssessssssscessssssscasesssssescesessssscasesessseseens 4 50 OAE Ca IAP SW MTC CV COI A E A N E E O E E E E T 4 54 CCGG FS RE
19. c314Fs project and the others are Echotek code library projects The output of each project is linked together to form the ECD R GC314 FS driver static library object EcdrGc314Fs lib which is found in the Project W indows Bin subdirectory The driver code is delivered already compiled and linked into the library object The following steps can be used to link the ECD R GC314 FS driver library object to a user application 1 Under the Project Setting of the User Application project add the ECDR GC314 FS DriverCode Project Windows Bin EcdrGc314Fs lib file to the Object library modules Chapter 2 Building and Linking the Driver Page 2 5 ZO ECDR GC314 FS Driver TAD Revision 1 0 ES Settings For win32 Debug m General Debug C C Link Resourci nt ES EcdrGe314Fs Dee Patsgou Genel SI Eee EcdrGc314Fs4ppCode aegis General Reset EA EcdGe3l4Fs Output file name 8 Ecdral4AppCode c ES Fehotek OS Debug EcdrGc31 4Fs4ppCode exe mE PRI656Lib Objectlibrary modules EF RegisterLib DriverCode Project Windows Bin E edie 4F lib i Generate debug info Ignore all default libraries i Link incrementally Generate mapfile M Enable profiling Project Options kermels2 ib users lib gdis2 lib winspoollib comdlgsz lib advapise lib shells2 lib oles lib oleauks lib uuid lib odbe32 lib odbecps lib kernels lib users2 lib gdiaz lib 2 Next click C C and type the following paths into
20. e EC FIFO EMPTY The FIFO contains no data e EC FIFO NOT EMPTY The FIFO contains at least one data word e EC FIFO LEVEL The number of data words is greater than or equal to the value set in the FIFO level e EC FIFO FULL The FIFO is full FIFO overflows are indicated in the events of the Ecdr Gc314 Fs driver The status is returned using the pointer U32 f ifoStatus For Receiver Blocks that only have one channel the IWB Block the channel argument is ignored Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsGetFifoStatus EcdrGc314FsBoardObject pBoardObject U32 receivarBlock U32 channel U22 priroStCactcus Return Values EC_OK Or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance receiverBlock The Receiver Block to query Valid choices are EC IWE RECEIVER EC_GC4016_RECEIVER_1 EC_GC4016_RECEIVER_2 EC_GC4016_RECEIVER_3 Chapter 4 Application Programming Interface API Page 4 71 ECDR GC314 FS Driver one Revision 1 0 Parameters Description The channel of the Receiver Block to query Valid choices are EC_ GC4016_CHANNEL_A EC_ GC4016_CHANNEL_B EC_ GC4016_CHANNEL_C EC_ GC4016_CHANNEL_D pFifoStatus Pointer to a variable containing the FIFO status return value The possible values of pFifoStatus are EOG FIFO EMPLY EC FIFO NOL EMPTY EC FIFO LEVEL BC FIFO FULL Chapter 4 Application Progra
21. in length maxLen The maximum number of characters that can be written into the char buffer pointed to by sPtr Chapter 4 Application Programming Interface API Page 4 6 ZO ECDR GC314 FS Driver oree Revision 1 0 ecdrGc314FsRegisterLogInfoFunction This function call registers a function pointer to a logging facility that enables the EcdrG c314Fs driver code to display information log errors stats etc to the user The registered function provides a user defined mechanism to display the information of the driver code The driver code calls this registered function passing in the information to display The registered function must perform all desired formatting of the passed in string ie in fost ring contains no n characters The prototype for the logInfoFuncPtr iS void logInfoFunction U32 infoType const char infoString where infoType is used to indicate the type of information FC CRITICAL _ ERROR e EC_MAJOR_ERROR e EC_MINOR_ERROR e EC_ALERT_ INFO e EC_GENERAL INFO e EC _DEBUG_INFO Synopsis include EcdrGc314FsApi h void ecdrGc314FsRegisterLoginfoFunction VOID_FUNCPTR pPLOGInNT Of unc Retum Values void Chapter 4 Application Programming Interface API Page 4 7 ZO ECDR GC314 FS Driver ne ee Revision 1 0 Parameters pLogInfoFunc Pointer to the function that implements a logging function The prototype for the pLogInfoFunc is void JogIntoFunction USs2 anrorype const char infoStr
22. interrupt Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsUnregisterPciDmaTransferDoneCallback EcdrGc314FsBoardObject pBoardObject Retum Values EC_OK or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance Chapter 4 Application Programming Interface API Page 4 84 ZO ECDR GC314 FS Driver oree Revision 1 0 ecdrGc314FsCreateRwDmatTransferList This function call creates a D MA transfer list containing one or more D MA transfer requests The D MA transfer list initializes with the parameters of the first request Additional DMA transfers request can then be added to the list chaining the transfer request together using the AddRwDmaTransfer function call For Receiver Blocks that only have one channel the IWB Block the channel argument is ignored Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsCreateRwDmaTransferList EcdrGc314FsBoardObject pBoardObject DmaTransferList pDma U32 receiverBlock USZ channel U32 wordCounct UszZ destRouce U32 destAddr Retum Values EC_OK Or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance pDma Pointer to the DmaTransferList pointer variable that a user keeps to identify this specific D MA transfer list receiverBlock The Receiver Block to query Valid choic
23. is no longer needed or at the end of program execution Synopsis include EcdrGc314FsApi h void ecdrGc314FsDeleteBoardiInstance EcdrGc314FsBoard0Object oBoardObject Retum Values void Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance Chapter 4 Application Programming Interface API Page 4 5 ZO ECDR GC314 FS Driver a ee Revision 1 0 ecdrGc314FsGetDriverVersion This function call returns the version of the EcdrGc314Fs driver There are two characteristics of this function call e The return is a U32 that represents the version in the form 0xX X YY ZZBB where X X is major YY is minor ZZ is bugfix and BB is the build e The other characteristic returns the version by copying the string X X YY ZZ Build BB into the sPt r char pointer passed in by the caller If the caller passes in a NULL pointer only the U32 is returned The passed in char buffer MU ST be at least 22 characters in length Synopsis include EcdrGc314FsApi h U32 ecdrGc314FsGetDriverVersion char sPtr int maxlLen Retum Values U32 representing the version in the form 0xX X YY ZZBB see description above Parameters Pointer to the character buffer into which this function call will copy the version string X X Y Y ZZ Build BB If a NULL pointer is passed in only the U32 is returned The passed in char buffer MUST be at least 22 characters
24. sseesseessesssesseesseesseesseeseenseenseesseesseessrnseresersseesseess 4 84 ecdrG c314FsCreateRwD maT ransferList esessseeseesseesseesseesseessesseenseesseesseeseteseesseesstensreetnsetsstesstesereserssersreess 4 85 ecdrG c314FsAddRwD Mal Tansler csecscssessesecsssssssecsesssssesscssssssscssssssssessessssssacssessssseseessssseacessssssseasessssseseens 4 87 ecdrG c314FsStartRwD maTransfer ccccscssessssscessssssecsssssssescssssssssessssssssessessssssscessssssscssesssssescesessssscasesessseseens 4 89 ecdrG c314FsD eleteRwD maT ransferList ccccccessssecscsssssessssssssssessssssssessesssssscsssssssscssesssssssesessssscasessssseseens 4 90 ZO ECDR GC314 FS Driver hore Revision 1 0 ecdrG c314FsRegisterRwD maT ransferD OneCallback 0 0 cececesesessesesssessssessssssssesesssssesessssssessseesssesesseseeesees 4 91 ecdrG c314FsUnregisterRwD maT ransferD OneCallback cccsseesesessesssessssesesesessssesssssssescssssssssesseseseseseens 4 92 ecdrG C314FsRegisterRWE rrorCallback cccssesesessssesssessssescsessssesessssssssesessssssesesesssssessssssssescssessseseseeseeseseens 4 93 ecdrG c314FsUnregisterRWE rrorCallback ccccessssecsssssssesssssssssssssssssssessessssssscesssssssessesssseasesessssseasesessseseens 4 94 vi ZO ECDR GC314 FS Driver hore Revision 1 0 List of Tables Table 41 IWB Block Register OffSetS ccscccsescscssssssscvesssssssssssesesesevevesesesseeveseovevevevevenesesssssnananansees 4 51
25. sys Windows NT or windrvr vxd Windows 95 file to the Windows installation directory on the target computer On Windows NT target computers Copy windrvr sys to WINNT system32 drivers On Windows 95 target computers Copy windrvr vxd to Windows system VMM32 Chapter 3 Installing the Driver Page 3 4 ZO ECDR GC314 FS Driver oree Revision 1 0 2 Use the wdreg_gui utility to add windrvr sys windrvr vxd to the list of device drivers that Windows loads upon booting Windows NT 95 Use the following installation command gt wdreg_gui install Windows 98 Me when installing windrvr vxd Use the vxd flag in the installation command gt wdreg_gui vxd install By default wdreg_gui installs windrvr sys on Windows NT 98 Me 2000 XP and windrvr vxd on Windows 95 Installing the ECDR GC314 FS Driver for Linux The Echotek ECD R GC314 F S driver code uses the WinD river product by Jungo within the Linux environment The following procedure installs the WinD river run time components and the ECD R GC314 FS driver components necessary for use with Linux TBD Chapter 3 Installing the Driver Page 3 5 ZO ECDR GC314 FS Driver oree Revision 1 0 Installing the ECDR GC314 FS Driver for VxWorks There is no installation procedure for the ECD R_GC314 FS driver code for the VxWorks operating system environment Simply follow the Building and Linking instructions from C hapter 2 to use the ECD R GC314 FS drive
26. the Additional include directories field to specify your C C compiler rules ProjectPath ECD R GC314 FS DriverCode Source ProjectPath ECD R GC314 FS DriverCode Lib where ProjectPath is the application code root path Chapter 2 Building and Linking the Driver Page 2 6 ZO ECDR GC314 FS Driver eC ey lt i Revision 1 0 Settings For wind Debug General Debug C C Ee EcdrGc31 4Fs 4 Bled EociGcs dF snode Pategow Preprocessor x Best AA Eodricd1 4Fs Preprocessor definitions E Ecd314AppCode c memeres lens amam IE Fehotek OS WARTS DEBUG CONSOLE MECS Fee PSS 6Lib Undefined symbols Undefine all symbols ES FRegisterLib Additional include directores ProjectPathi e LOR_GCS1 4 FS 0nverlode S ource Proje T Ignore standard include paths Link Resourci Project Options Anologo MT AWS Gm Gs del Od Jl ProjectPath ECDR GC314 FS 0rverlodesSource l ProjectPath ECDR_GCS14 FS40rverCodeLib 3 Finally compile and link with your code The application code delivered with the ECD R G C314 FS driver code can be used as an example of the linking procedure Building the Driver for Linux TBD Chapter 2 Building and Linking the Driver Page 2 7 ZO ECDR GC314 FS Driver oneee Revision 0 4 Chapter 3 Installing the Driver This chapter includes steps for installing the ECD R GC314 FS driver Chapter 3 Installing the Driver Page 3 1 ZO ECDR GC314 FS
27. the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance Pointer to the character buffer into which this function call will copy the version string X X YY ZZ Build BB Ifa NULL pointer is passed in only the U32 is returned The passed in char buffer MUST be at least 22 characters in length maxLen The maximum number of characters that can be written into the char buffer pointed to by sPtr Chapter 4 Application Programming Interface API Page 4 9 ZO ECDR GC314 FS Driver ar ee Revision 1 0 ecdrGc314FsResetBoard This function call enables a user to reset a specific EcdrG c314Fs board Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsResetBoard EcdrGc314FsBoardObject oBoardObject Retum Values EC_OK Or EC_ERROR Parameters pBoardObject TheEcdrGc314FsBoardObject pointer returned by the Create function call for the specific board instance Chapter 4 Application Programming Interface API Page 4 10 ZO ECDR GC314 FS Driver oree Revision 1 0 ecdrGc314FsSelectClockSource This function call selects either the on board oscillator or the external clock source the Front panel connector as the source for the data clocking of the board No clockSource is initially selected This function call must be made before any configuration can be performed on the board Synopsis include EcdrGc314FsApi h BCcStatus ecdrGc3l4rsSelectClockSource EcdrGc314FsBo
28. the IWB Block FIFO Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsDisablelIwbBypass EcdrGc314FsBoardObject pBoardObject Retum Values EC_OK or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance Chapter 4 Application Programming Interface API Page 4 67 ZO ECDR GC314 FS Driver hore Revision 1 0 ecdrGc314FsSetFifoMode This function call sets the operation mode for the FIFOs that collect the data from the three G C4016 Receiver Blocks This mode of operation MUST match the configuration of the specific Receiver Block if Receiver Block EC_GC4016_RECEIVER_1 is set for Narrowband Mode then the FIFO mode for Receiver Block EC_GC4016_RECEIVER_1 must also be set for Narrowband Mode Refer to the ECD R GC314 X X X FS H ardware U sers M anual for complete details about the FIFO modes Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsSetFifoMode EcdrGc314FsBoardObject pBoardObject U32 re eceiverbiock U32 fifoMode Return Values EC _OKOrEC ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance receiverBlock The Receiver Block to configure Valid choices are EC_GC4016_RECEIVER_1 EC_GC4016_RECEIVER_2 EC_GC4016_RECEIVER_3 fifoMode The FIFO mode of the Receiver Block Valid choices are BC_FIFO_MODE_N
29. 1 0 Sync Control Function Calls To support synchronized operations across more than one ECD R GC314 X X FS two sync buses are implemented and are connected to all Receiver Blocks and their associated control logic There are three ways a sync signal can be generated onto these sync buses e By the onboard sync signal generation logic e By the sync master of the multi board sync bus e By the external trigger the external trigger is only capable of generating sync on Sync Bus 1 Each control logic and Receiver Block capable of receiving the sync signal on the sync buses has an associated sync mask in the Global Sync Mask register A sync mask is simply a sync enable that when set enables any sync occurring on the sync bus to be received by the associated logic Two sets of masks are available for each control logic e A one time mask The one time mask enables the reception of one sync signal from the sync bus before it goes inactive A user must set the one time mask again if another sync signal is desired For some operations a periodic sync signal is expected from external source s or from onboard RTS syncs generation logic In this case it can be difficult to determine when to arm the sync mask to catch the periodic sync signal at the right time Furthermore the act of rearming the sync mask s after each sync can cause unnecessary bus traffic in a system e A continuous mask The continuous sync mask is provided to most l
30. 16_CHANNEL_A EC_GC4016_CHANNEL_B EC_GC4016_CHANNEL_C EC_GC4016_CHANNEL_D pFrameSize Stores the retrieved frame size Chapter 4 Application Programming Interface API Page 4 41 ZO ECDR GC314 FS Driver a ee Revision 1 0 ecdrGc314FsEnableDataFraming These function calls enable a user to set the data framing capability on a channel basis The frame size of the channel being enabled must be set by calling ecdrGc314FsSetFrameSize prior to enabling data framing If the frame size is not set this function call will return EC_ERROR Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsEnableDataFraming EcdrGc314FsBoardObject pBoardObject U32 receiverBlock U32 channel Return Values EC_OK Or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance receiverBlock The Receiver Block to configure Valid choices are BEC _IWB_ RECEIVER EC_GC4016 RECEIVER 1 EC_GC4016 RECEIVER 2 EC_GC4016_RECEIVER_3 The channel of the Receiver Block to configure Valid choices are EC_GC4016_CHANNEL_A EC_GC4016_CHANNEL_B EC_GC4016_CHANNEL_C EC_GC4016_CHANNEL_D Chapter 4 Application Programming Interface API Page 4 42 ZO ECDR GC314 FS Driver hore Revision 1 0 ecdrGc314FsDisableDataFraming This function call enables a user to disable the data framing capability on a channel basis Synopsis include EcdrGc314FsApi h
31. 4 FS Driver oree Revision 1 0 ecdrGc314FsSetSyncBusMode T his function call enables a user to set up the sync bus mode of the board In a single board configuration the syncBusMode Is always EC_SYNC_BUS_MASTER In multi board configuration only one board can be configured as EC_SYNC_BUS_MASTER Other boards must be configured as EC_SYNC_BUS_SLAVE Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsSetSyncBusMode EcdrGc314FsBoardObject pBoardObject U32 syncBusMode Retum Values EC OK Or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance syncBusMode Selects the sync bus mode Valid choices are BC _ oYNC BUS _ MASTER BC SYNC_BUS_SLAVE Chapter 4 Application Programming Interface API Page 4 32 ZO ECDR GC314 FS Driver neuen Revision 1 0 ecdrGc314FsSetSynciRtsTime The following function call enables the setting of the sync 1 RTS time to generate a sync signal onto the sync buses The RTS sync enable must be enabled via ecdrGc314FsEnableSync before the RTS syncing logic will generate syncs onto the sync buses Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsSetSynclRtsTime EcdrGc314FsBoardObject pBoardObject U32 rtsSyncTimeSelect Retum Values EC_OK or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific
32. 6_RECEIVER_3 The channel of the Receiver Block to query Valid choices are EC_GC4016_CHANNEL_A EC_GC4016_CHANNEL_B EC_GC4016_CHANNEL_C EC_GC4016_CHANNEL_D Chapter 4 Application Programming Interface API Page 4 62 ZO ECDR GC314 FS Driver oree Revision 1 0 ecdrGc314FsRegisterAcquisitionDoneCallback This function call enables a user to register an event callback function that will be executed when the data acquisition is completed The Register function call enables the event notification interrupt The prototype of the callback function must be void function void Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsRegisterAcquisitionDoneCallback EcdrGc314FsBoardObject pBoardObject U32 receiverBlock U32 channel void pFunction void pFuncArgument Retum Values EC_OK Or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance receiverBlock The Receiver Block to configure Valid choices are BEC _IWB_ RECEIVER EC_GC4016 RECEIVER I EC GC4016 RECEIVER 2 EC_GC4016_RECEIVER_3 The channel of the Receiver Block to query Valid choices are EC_GC4016_CHANNEL_A EC_GC4016_CHANNEL_B EC_GC4016_CHANNEL_C EC_GC4016_CHANNEL_D pFunction Pointer to the callback function that will be executed when data acquisition is completed pFuncArgument Pointer to any data that the a wants to pass to the callback function
33. ARROWBAND EC FIFO MODE_WIDEBAND BC_FIFO_MODE_EXTRA_WIDEBAND Chapter 4 Application Programming Interface API Page 4 68 ZO ECDR GC314 FS Driver hore Revision 1 0 ecdrGc314FsClearFifo This function call clears the specified FIFO Depending on the FIFO mode the FIFOs may be combined to create a larger FIFO for a particular receiver channel Clearing all data fora particular receiver channel may require one or more ecdrGc314FsClearFifo commands Refer to the ECD R GC314 X X X FS H ardware U sers M anual for complete details on FIFO modes For Receiver Blocks that only have one channel the IWB Block the channel argument is ignored Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsClearFifo EcdrGc314FsBoardObject pBoardObject U32 receziverBilock U32 channel Retum Values EC OK or EC_ERROR Parameters pBoardObject Pointer to EcdrGc314FsBoardObject retumed by the Create function call for the specific board instance receiverBlock The Receiver Block to configure Valid choices are BC _IWB_ RECEIVER EC_GC4016_ RECEIVER 1 EC GC4016 RECEIVER Z2 EC_GC4016_RECEIVER_3 The channel of the Receiver Block to query Valid choices are EC_ GC4016_CHANNEL_A EC_ GC4016_CHANNEL_B EC_ GC4016_CHANNEL_C EC_ GC4016_CHANNEL_D Chapter 4 Application Programming Interface API Page 4 69 ZO ECDR GC314 FS Driver hore Revision 1 0 ecdrGc314FsSetFifoLevel This function call sets the level indicator for each
34. B and the three TI G C4016 receivers Chapter 4 Application Programming Interface API Page 4 58 ZO ECDR GC314 FS Driver oree Revision 1 0 ecdrGc314FsSelectAcquisitionMode This function call selects the acquisition mode of each of the specified Receiver Blocks Refer to the ECD R GC314 X X X FS H ardware U sers M anual for complete details about the acquisition modes Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsSelectAcgquisitionMode EcdrGc314FsBoardObject pBoardObject USZ receiverBlock U32 channel U32 acquisitionMode Retum Values EC_OK or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance receiverBlock The Receiver Block to configure Valid choices are PC JWe RECEIVER EC_GC4016_RECEIVER_1 EC_GC4016 RECEIVER 2 EC_GC4016_RECEIVER_3 channel The channel of the Receiver Block to query Valid choices are EC_GC4016_CHANNEL_A EC_GC4016_CHANNEL_B EC_GC4016_CHANNEL_C EC_GC4016_CHANNEL_D acquisitionMode_ The acquisition mode of the Receiver Block Valid choices are BRC ACOUISTITION_DISABLED FC ACOUISITION_GATE BC ACOUISITION_BURST BC ACQUISITION CONTINUOUS Chapter 4 Application Programming Interface API Page 4 59 ZO ECDR GC314 FS Driver hore Revision 1 0 ecdrGc314FsSetBurstCount This function call sets the burst count of each Receiver Blocks acquisition control logic The
35. CDR GC314 FS Driver hore Revision 1 0 ECDR GC314 FS Driver Directory Structure The ECDR GC314 FS driver is delivered with the following directory structure E ECDR GC314 F5 9 Applicationcode H a Documentation A DriverCode Install See Lib H Echotekos Bl PlxS656Lib A RegisterLib E Q Project H vO Ane ai ae Source iia s Flash The ECDR GC314 FS driver directory contains the following subdirectories e DriverCode Contains all driver source code Echotek code Libraries Installation files and Project files required to compile and build the driver for the supported operating systems Each operating system has a Project subdirectory containing all files needed to compile and build the driver code for the operating system e Documentation Contains user manuals test files and other supporting documents detailing the operation and usage of the Echotek ECDR GS314 FS family of digital receiver boards e ApplicationCode Contains all application source code which demonstrates the functionality of the ECDR GC314 FS boards and may be referenced by users to guide them The application code is detailed in the ECDR GC314 F S Demo Code User Manual Chapter 2 Building and Linking the Driver Page 2 2 Pd ECDR GC314 FS Driver ECHOT Oh Revision 1 0 Building the Driver for VxWorks The ECD R GC314 FS driver was developed using the Tornado II IDE Integrated Development Environment All required work
36. C_ GC4016_CHANNEL_B EC_ GC4016_CHANNEL_C EC_ GC4016_CHANNEL_D Chapter 4 Application Programming Interface API Page 4 80 ZO ECDR GC314 FS Driver A ee Revision 1 0 Number of data words to copy from the specified FIFO Pointer to a U32 pointer used to pass back the address of the buffer into which the data for this transfer request will be stored ecdrGc314FsStartPciDmaTransfer This function call starts the D MA transfers specified in the passed in D MA transfer list and continues transferring data until the last request in the list is completed Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsStartPciDmaTransfer EcdrGc314FsBoardObject pBoardObject DmaTransferList pDma j Retum Values EC_OK Or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance pDma Pointer to the DmaTransferList to which this request is to be added chained Chapter 4 Application Programming Interface API Page 4 81 ZO ECDR GC314 FS Driver a ee Revision 1 0 ecdrGc314FsDeletePciDmaTransferList This function call deletes the specified D MA transfer list and all list associated memory All buffers used for data transfers will be freed Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsDeletePciDmaTransferlList EcdrGc314FsBoardObject pBoardObject DmaTransferList pDma Retum Values EC_OK Or EC_ERROR Pa
37. Data Pointer to the data buffer to copy data into from the specified FIFO Number of data words to copy from the specified FIFO Chapter 4 Application Programming Interface API Page 4 77 ZO ECDR GC314 FS Driver oree Revision 1 0 ecdrGc314FsCreatePciDmaTransferList This function call creates a D MA transfer list containing one or more D MA transfer requests The D MA transfer list initializes with the parameters of the first request Additional DMA transfers request can then be added to the list chaining the transfer request together using the AddPciDmaTransfer function call For Receiver Blocks that only have one channel the IWB Block the channel argument is ignored Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsCreatePciDmaTransferList EcdrGc314FsBoardObject pBoardObject DmaTransferList pDma U32 receiverBlock U34 channel UsZ2 wordCounct UsZ pburirer Retum Values EC_OK Or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance pDma Pointer to the DmaTransferList pointer variable that a user keeps to identify this specific D MA transfer list receiverBlock The Receiver Block to query Valid choices are BEC LWB RECEIVER EC_GC4016_RECEIVER_1 EC_GC4016_RECEIVER_2 EC_GC4016_RECEIVER_3 channel The channel of the Receiver Block to query Valid choices are EC_ GC4016_CHANNEL_A EC_ GC4016_CHANNEL_B
38. Driver oree Revision 1 0 Installing the ECDR GC314 FS Driver for Windows The Echotek ECD R GC314 F S driver code uses the WinD river product by Jungo within the Windows environment The following procedure installs the WinD river run time components and the ECD R GC314 FS driver components necessary for use with Windows The Install subdirectory contains the following files windrvr sys windrvr vxd wd_ virtual inf EcdrGc314Fs inf wdreg_gui exe Windows 98 Me and 2000 XP NOTE This section refers to distribution of SYS files Due to the limitations of Windows 98 Me IN DRVR SYS cannot be loaded dynamically on these operating systems but instead requires the rebooting of your computer In lieu of rebooting you may use WIN DRVR VXD and follow the installation instructions for Windows 95 below Installing the driver on the target computer Follow the instructions below in order to properly install your driver on the target computer e Preliminary steps O To avoid rebooting ensure that no PCI USB devices are currently registered to work with WinDriver before attempting to install the driver 1 e ensure that no INF files pointing to windrvr sys are currently installed for any of the PCI USB devices on the PC This may be relevant for example when upgrading a driver developed with an earlier version of WinDriver To do this uninstall all PCI USB devices that are registered to work with WinDriver from the Device M
39. IRI COC aa cet atencidinte netics atest seraieecitet acide tneaeticids 4 56 Acquisition Control Function Gall scziectncbsccsanssuowsouestvebaseiisobovedivcbenetductavsstewtoueddecbagedtsebavebivcbarstductavnbtantonedtesduse s 4 58 ecdrG C314FsSelectA CqUISIIONMOE cccscsssseesssssssssssssssssssssssssssssssssssscssesssssssssssssssssesessssssesesssscssesesessesess 4 59 SO OIKC COATS silo Ulecl O Aaa es hh a a ee ee ee 4 60 CCI oE eD lid KCO E n 4 61 ecdrG c314FsStopContinuousA cquisition c ccccccceesesessssssssesessssscsssssssssssscsesssssssssesssssscsssssssssssssesssscssssssssseses 4 62 ecdrG c314FsRegisterA cquisitionD oneCallbacK se sseesseessesseesseesseessesseeeseenseesseesseessrnsernseesseessreseresersseesseess 4 63 ecdrG c314FsUnregisterA cquisitionD OneCall ack cesesesesessssesssessssessssssssescssssssssessssssssescssssssescssseeseseseees 4 64 Output Control Function Calls scisscscssdssscetevesasszaceactenastinusasisasecoodanonsiedannssassanceciadsacushsaseaoebodensnesarsnansacntacotosdsasiebes 4 65 ecdrG C3IAFSE nableReceiverBypPass cccccecesserecsssssssecsssssssesssssssssscssssssssessessssssscesessssseasessssseacesessssscasessssseseens 4 66 ecdrG C314FsD isableReceiverByPass s scssessesecsssssssecsssssssesssssssssscssssssssessesessssscssessssscssessssescesessssseasesesssescens 4 67 SEURE Tel So LG A E E E A AE E E E E E 4 68 SEE oE SETE i 0 E EE a AE EAE A ea A E EAA AAE ee 4 69 ecd oe E O L a ne eee ee ee e
40. NTER EC_SYNC2_IWB_SIA_ ONE_TIME EC_SYNC2_TWB_SIA_ CONTINUOUS EC_SYNC2_IWB_SIB_ONE_TIME EC SYNCZ_IWB_SIB CONTINUOUS EC_SYNC2_GC4016_SIA_ ONE_TIME EC_SYNC2_GC4016_STA_CONTINUOUS EC_SYNC2_GC4016_SIB ONE_TIME BEC SYNCZ GC4016_ S15 CONTINUOUS EC_SYNC2_ CLEAR RTS COUNTER EC_SYNC2_ LATCH _RTS_COUNTER Chapter 4 Application Programming Interface API Revision 1 0 Page 4 25 ZO ECDR GC314 FS Driver hore Revision 1 0 ecdrGc314FsClearGlobalSyncMask This function call enables a user to clear sync masks that globally affect the module Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsClearGlobalSyncMask EcdrGc314FsBoardObject pBoardObject U32 syncMaskSelect Retum Values EC_OK Or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance syncMaskSelect Selects the sync mask to clear Only the continuous sync mask can be cleared This function has no effect if one time sync mask is specified Valid choices are BC UOYNCL IWE SIA CONTINUOUS BC SYNC IWB_ SIB CONTINUOUS EC_SYNC1_GC4016_SIA_CONTINUOQUS EC SYNCI GC4016 SIB CONTINUOUS EC_SYNC2_IWB_SIA_CONTINUOUS EC oYNCZ IWB SIB CONTINUOUS EC_SYNC2_GC4016_SIA_ CONTINUOUS EC ONCA GC4016 SIB CONTINUOUS Chapter 4 Application Programming Interface API Page 4 26 ZO ECDR GC314 FS Driver hore Revision 1 0 ecdrGc314FsSetSyncMask These function calls enable a user to se
41. all writes to the configuration registers of the specified Receiver Block The registers of the Receiver Blocks may be separated into two types of registers e Global registers Registers that control overall operation of the receiver e Channel registers Registers that control an individual channel and that are set per channel For global registers and for Receiver Blocks that only have one channel the IWB Block the channel argument is ignored Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FswWriteRcvrConfig EcdrGc314FsBoardObject pBoardObject U32 receiverBlock U32 channel U32 registerOffset U32 data Retum Values EC_OK Or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance receiverBlock The Receiver Block to configure Valid choices are BEC _IWB_ RECEIVER EC_GC4016 RECEIVER_1 EC_GC4016_RECEIVER_2 EC_GC4016_RECEIVER_3 channel The channel of the Receiver Block to configure Valid choices are EC_GC4016_CHANNEL_A EC_GC4016_CHANNEL_B EC_GC4016_CHANNEL_C EC_GC4016_CHANNEL_D Chapter 4 Application Programming Interface API Page 4 48 ECDR GC314 FS Driver Pe set Parameters Description registerOffset The register offset of the configuration register to which writing will occur Valid choices are dependent on the Revision 1 0 Receiver Block being configured The two Register Offset table
42. anager Properties gt Uninstall If this action is not performed WDREG_GUI will fail when the reload or remove command is used see instructions below WDREG GUI will then inform the user that s he must first uninstall all devices currently registered to work with WinDriver or reboot the PC in order to successfully execute the command Chapter 3 Installing the Driver Page 3 2 ZO ECDR GC314 FS Driver eC ey lt hr Revision 1 0 o To prevent Windows from automatically installing old INF files for PCI USB devices that you wish to handle with WinDriver it is also recommended that any backup INF files be deleted that Windows may have created for these PCI USB devices On Windows 2000 XP these files are stored in the windir inf directory and are named oem inf On Windows 98 Me these files are stored in the Windows inf other directory NOTE ou can search for the device s vendor ID and device product ID in the backup INF directory to locate the relevant files s for your device s e Installing WinDriver s kernel module 3 Copy windrvr sys to the Windows installation directory on the target computer On Windows 2000 WINNT system32 drivers On Windows 98 Me XP Windows system32 drivers TIP The command windir system32 drivers points to the Windows installation directory regardless of the operating system windir is equivalent to typing the Windows base directory WINNT or indows 4 Copy wd_
43. ardObject pBoardObject U32 ClhockSource Retum Values EC_OK Or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance clockSource Valid choices are BC INTERNAL CLOCK EC EXTERNAL CLOCK Chapter 4 Application Programming Interface API Page 4 11 ZO ECDR GC314 FS Driver A ee Revision 1 0 ecdrGc314FsEnableExtTrigger This function call enables the External Trigger TRG signal This signal is used as both a trigger source and or a sync source for the Acquisition Control logic and the Receiver Control logic The initial state of the External Trigger signal is disabled Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsEnableExtTrigger EcdrGc314FsBoardObject OBOaArdObDIeCT Retum Values EC_OK Or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance Chapter 4 Application Programming Interface API Page 4 12 ZO ECDR GC314 FS Driver a ee Revision 1 0 ecdrGc314FsDisableExtTrigger This function call disables the External Trigger TRG signal This signal is used as both a trigger source and or a sync source for the Acquisition Control logic and the Receiver Control logic The initial state of the External Trigger signal is disabled Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsDisableExtTrigger
44. are EC LWB RECEIVER EC_GC4016_RECEIVER_1 EC_GC4016_RECEIVER_2 EC_GC4016_RECEIVER_3 channel The channel of the Receiver Block to query Valid choices are EC_ GC4016_CHANNEL_A EC_ GC4016_CHANNEL_B EC_ GC4016_CHANNEL_C EC_ GC4016_CHANNEL_D Chapter 4 Application Programming Interface API Page 4 87 ZO ECDR GC314 FS Driver A ee Revision 1 0 Number of data words to copy from the specified FIFO The Raceway route code of the destination memory The Raceway address of the destination memory Chapter 4 Application Programming Interface API Page 4 88 ZO ECDR GC314 FS Driver A ee Revision 1 0 ecdrGc314FsStartRwDmatTransfer This function call starts the D MA transfers specified in the passed in D MA transfer list and continues transferring data until the last request in the list is completed Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsStartRwDmaTransfer EcdrGc314FsBoardObject pBoardObject DmaTransferList pDma j Retum Values EC_OK Or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance pDma Pointer to the DmaTransferList to which this request is to be added chained Chapter 4 Application Programming Interface API Page 4 89 ZO ECDR GC314 FS Driver a ee Revision 1 0 ecdrGc314FsDeleteRwDmatTransferList This function call deletes the specified D MA transfer list and all list assoc
45. board instance rtsSyncTimeSelect The time when async signal is to be generated on sync Bus 1 Chapter 4 Application Programming Interface API Page 4 33 ZO ECDR GC314 FS Driver a ee Revision 1 0 ecdrGc314FsSetSync2RtsTime The following function call enables the setting of the sync 2 RTS time to generate a sync signal onto the sync buses The RTS Sync enable must be enabled via ecdrGc314FsEnableSync before the RTS syncing logic will generate syncs onto the sync buses Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsSetSync2RtsTime EcdrGc314FsBoardObject pBoardObject U32 rtsSyncTimeSelect Retum Values EC_OK or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance rtsSyncTimeSelect The time when async signal is to be generated on sync Bus 2 Chapter 4 Application Programming Interface API Page 4 34 ZO ECDR GC314 FS Driver ar ee Revision 1 0 ecdrGc314FsGetSynciRtsTime This function call enables a user to retrieve the current sync 1 RTS time Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsGetSynclRtsTime EcdrGc314FsBoardObject pBoardObject Uo2 DRESSVnCcl ime Retum Values EC_OK or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance Stores the current SY NC 1 SYNC 2 syn
46. burst count is the number of data words 32 bit captured when the Receiver Block is in burst acquisition mode The maximum burst count is 16384 for the IWB Block and 4096 for the three G C4016 Receiver Blocks Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsSetBurstCount EcdrGc314FsBoardObject pBoardObject U32 receiverBlock U32 channel U32 Durst Wordcount gt Retum Values EC_OK Or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance receiverBlock The Receiver Block to configure Valid choices are BEC _IWB_ RECEIVER EC_GC4016_RECEIVER_1 EC_GC4016_RECEIVER_2 EC_GC4016_RECEIVER_3 channel The channel of the Receiver Block to query Valid choices are EC_GC4016_CHANNEL_A EC_GC4016_CHANNEL_B EC_GC4016_CHANNEL_C EC_GC4016_CHANNEL_D burstWordCount Number of words to capture in burst mode Chapter 4 Application Programming Interface API Page 4 60 ZO ECDR GC314 FS Driver oree Revision 1 0 ecdrGc314FsSetDataSkipCount T his function call sets the D ata Skip count of each Receiver Blocks acquisition control logic The D ata Skip count is the number of data words 32 bit skipped after the trigger is received but before data is captured The D ata Skip count is applicable in all acquisition modes The maximum D ata Skip count is 16384 for the IWB Block and 4096 for the three G C4016 Receiver Blocks Synopsi
47. c 1 RTS time Chapter 4 Application Programming Interface API Page 4 35 ZO ECDR GC314 FS Driver ar ee Revision 1 0 ecdrGc314FsGetSync2RtsTime This function call enables a user to retrieve the current sync 2 RTS time Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsGetSync2RtsTime EcdrGc314FsBoardObject pBoardObject U32 pRtsSyncTime Retum Values EC_OK Or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance Stores the current sync 2 RTS time Chapter 4 Application Programming Interface API Page 4 36 ZO ECDR GC314 FS Driver hore Revision 1 0 Frame Control Function Calls The Frame Control function calls provide capabilities to control data framing and latching clearing timestamps on the ECD R GC314 XXX FS module Chapter 4 Application Programming Interface API Page 4 37 ZO ECDR GC314 FS Driver hore Revision 1 0 ecdrGc314FsSetFramingMode This function call selects the data framing header mode when data framing is enabled Two modes are available e EC FRAME RTS _AND_CHID Frame header contains both the RTS and Channel ID e EC_FRAME_RTS_ONLY Frame header contains only the RTS Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsSetFramingMode EcdrGc314FsBoardObject pBoardObject U32 framingMode Retum Values EC_OK Or EC_ERROR Parameters pBoardObject Pointe
48. c1 Sync2 RTS time This sync is periodic and will continue to be generated until it is disabled The External Trigger enable only generates a sync to Sync Bus 1 whenever an external trigger has been detected Synopsis include EcdrGc314FsApi h E Status ecdrec3l4sknablesync EcdrGc314FsBoardObject pBoardObject U32 syncSelect Retum Values EC_OK or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance syncSelect Selects the sync to generate Valid choices are EC pYNCG PULSE BECWoY NCL EVEL aC D C Fite EC_SYNC1_EXT_TRIGGER EC SYNCZ_ PULSE EC_SYNC2_LEVEL HC eZ RIS Chapter 4 Application Programming Interface API Page 4 30 ZO ECDR GC314 FS Driver hore Revision 1 0 ecdrGc314FsDisableSync This function call enables a user to disable the generation of sync signals on either both sync buses Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsDisableSync EcdrGc314FsBoardObject pBoardObject U32 syncSelect Retum Values EC_OK or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance syncSelect Clears the selected sync signal Valid choices are BC SYNC LEVEL EC DINCL RIS EC_SYNC1_EXT_TRIGGER BC SYNCZ LEVEL EC ONCA RIO Chapter 4 Application Programming Interface API Page 4 31 ZO ECDR GC31
49. complete details on IWB filter configuration and coefficient register sets Refer to the TI GC4016 U ser Manual for complete details on G C4016 filter configuration and coefficient registers For Receiver Blocks with only one channel the IWB Block or for filters that affect all channels the channe1 argument is ignored For filters that have multiple sets of coefficients the IWB Block the coefficient set is selected via the filterset argument of the specific filter selection Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsWriteRcvrCoefft EcdrGc314FsBoardObject pBoardObject U32 receiverBlock U32 channel U32 filter U32 BumCoet rt U32 pData Return Values EC_OK Or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance receiverBlock The Receiver Block to configure Valid choices are BEC _IWB_ RECEIVER EC_GC4016 RECEIVER I EC_GC4016_RECEIVER_2 EC_GC4016_RECEIVER_3 The channel of the Receiver Block to configure Valid choices are EC_GC4016_CHANNEL_A EC_GC4016_CHANNEL_B EC_GC4016_CHANNEL_C EC_GC4016_CHANNEL_D Chapter 4 Application Programming Interface API Page 4 54 ECDR GC314 FS Driver one Revision 1 0 Parameters Description The filter being configured Valid choices are Receiver Block dependent EC IWB_FIR filtersSet firDecimation EC_GC4016_CFIR EC _GC4016_ PFIR EC _GC4016_ RESAMPLER wh
50. d Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsRegisterFifoLevelCallback EcdrGc314FsBoardObject pBoardObject U32 receiverBlock U32 channel vold pFunction void pFuncArgument Retum Values EC_OK Or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance receiverBlock The Receiver Block to configure Valid choices are BEC _IWB_ RECEIVER EC_GC4016_RECEIVER_1 EC_GC4016_ RECEIVER 2 EC_GC4016_RECEIVER_3 channel The channel of the Receiver Block to configure Valid choices are EC_ GC4016_CHANNEL_A EC_ GC4016_CHANNEL_B EC_ GC4016_CHANNEL_C EC_ GC4016_CHANNEL_D pFunction Pointer to the callback function that will be executed if the specified FIFO s Level is reached pFuncArgument Pointer to any data that a user wants pass to the callback function when the event occurs Chapter 4 Application Programming Interface API Page 4 75 ZO ECDR GC314 FS Driver oree Revision 1 0 ecdrGc314FsUnregisterFifoLevelCallback This function call enables a user to unregister an event callback function The Unregister function call disables the event notification interrupt Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsUnregisterFifoLevelCallback EcdrGc314FsBoardObject pBoardObject U32 receiverBlock U32 channel Retum Values EC_OK Or EC_ERROR Parameters pBoardObject Pointer to the Ec
51. drGc314FsBoardObject returned by the Create function call for the specific board instance receiverBlock The Receiver Block to configure Valid choices are EG IWB RECEIVER EC_GC4016_RECEIVER_1 EC_GC4016_RECEIVER_2 EC_GC4016_RECEIVER_3 channel The channel of the Receiver Block to configure Valid choices are EC_ GC4016_CHANNEL_A EC_ GC4016_CHANNEL_B EC_ GC4016_CHANNEL_C EC_ GC4016_CHANNEL_D Chapter 4 Application Programming Interface API Page 4 76 ZO ECDR GC314 FS Driver oree Revision 1 0 ecdrGc314FsReadFifoData This function call reads data from the specified FIFO and copies it into the buffer pointed to by pBuffer The number of words to copy is specified by wordCount For Receiver Blocks that only have one channel the IWB Block the channel argument is ignored Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsReadFifoData EcdrGc314FsBoardObject pBoardObject U32 receiverBlock U32 channel U32 pBuffer U32 wordCount Retum Values EC _OKOrEC_ ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance receiverBlock The Receiver Block to query Valid choices are BEC _IWB RECEIVER EC_GC4016_RECEIVER_1 EC_GC4016_RECEIVER_2 EC_GC4016_RECEIVER_3 The channel of the Receiver Block to query Valid choices are EC_ GC4016_CHANNEL_A EC_ GC4016_CHANNEL_B EC_ GC4016_CHANNEL_C EC_ GC4016_CHANNEL_D p
52. dreg_gui with the loadinf option gt wdreg_gui inf lt full path to INF file gt loadinf For example if the INF file my_inf inf has been copied to the c tmp directory on the target computer run gt wdreg_gui inf c tmp my_inf inf loadinf On Windows 98 Me skip this step and follow the manual INF installation instructions below On Windows 98 Me install the INF file manually using Windows Add New Hardware Wizard or Upgrade Device Driver Wizard NOTE To prevent Windows from automatically detecting and installing an INF file previously installed for the device remove the backup INF file that Windows created from the W indows inf other directory before installing the new INF file that you created Y ou can search for the device s vendor ID and device product ID in the backup INF directory to locate the relevant files s for your device s This is particularly relevant when upgrading from a previous WinD river version Ensure that you do not overwrite windrvr sys with an older existing version of the file in the indows driver directory windir system32 drivers You should compare the timestamp on the two versions of the files and not overwrite a newer version with an older version Windows 95 and NT 4 0 Installing the driver on the target computer Follow the instructions below in order to properly install your driver on the target computer o Installing WinDriver s kernel module 1 Copy the windrvr
53. ecdrGc314FsClearSyncMask EcdrGc314FsBoardObject pBoardObject U34 PeceiverBliock U32 channel U32 syncMaskSelect Retum Values EC_OK or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance receiverBlock The Receiver Block to configure Valid choices are BEC _IWB_ RECEIVER EC_GC4016 RECEIVER L EC_GC4016_RECEIVER_2 EC_GC4016_RECEIVER_3 The channel of the Receiver Block to configure Valid choices are EC_GC4016_CHANNEL_A EC_GC4016_CHANNEL_B EC_GC4016_CHANNEL_C EC_GC4016_CHANNEL_D syncMaskSelect Selects the sync mask to clear Only the continuous sync mask can be cleared This function has no effect if one time sync mask is specified Valid choices are EC_SYNC2_DATA ACQ CONTINUOUS EC_SYNC1_DATA_ACQ CONTINUOUS Chapter 4 Application Programming Interface API Page 4 29 ZO ECDR GC314 FS Driver hore Revision 1 0 ecdrGc314FsEnableSync This function call enables a user to set generation of sync signals on either both sync buses When a pulsed sync is selected the sync logic generates a four clocks wide sync signal onto the associated sync bus A latched sync causes the sync signal to be asserted until being cleared The RTS sync enable does not cause a sync signal to be generated immediately Instead it allows the RTS syncing logic to generate sync signals whenever the current timestamp value matches the pre programmed Syn
54. ecified ECD R G C314 FS board Chapter 4 Application Programming Interface API Page 4 3 ZO ECDR GC314 FS Driver hore Revision 1 0 ecdrGc314FsCreateBoardInstance Create This function call constructs an instance of a board object containing all information necessary to use the board The required memory for the board object is allocated during the ecdrGc314FsCreateBoardiInstance function call and the freed during the Delete function call The ecdrGc314FsCreateBoardiInstance function call takes two parameters e The specific type ID that uniquely identifies the board e The instance of the specified board that you are going to control i e which board This function call will also initialize the board with the appropriate configuration Synopsis include EcdrG c314FsA pi h EcdrGc314FsBoardObject ecdrGc314FsCreateBoardinstance U32 boardTypeid U32 instance Retum Values Returns a pointer to EcdrGc314FsBoardOb ject or NULL if an error occurs Parameters Parameters boardTypelId ID of the specific type of EcdrGc314Fs board used Valid choices for boardTypeld ae ECDR GCS14 PMC FS ECDR GC3l4 PCI FS ECDR_GC314_ RPPOT instance Specified board instance to control where zero 0 is the first board instance Chapter 4 Application Programming Interface API Page 4 4 ZO ECDR GC314 FS Driver a ee Revision 1 0 ecdrGc314FsDeleteBoardIinstance Delete All created instances of a board must be deleted when it
55. ee eee 4 70 3 600 KG C lAr SG OFO Ta ainra RERE AEEA ER EE ER EEEE ERE E EERE RETEE IRE EEi TA EEAEETERE REE iT 4 71 ecdrG c314FsRegisterFifoO VertlowCallback cccsecsssssssesscsssssssessssssssessessssssscssessssscssessssescesessssscasesessseseess 4 73 ecdrG c314FsUnregisterFifoO verflowCallback cccssesessesssssesssesessssssessssssssescsssesssscssssssssescssssssescsssseseseseens 4 74 ecdrG 0314 FsRegisterFifo LevelCallback csssssessssecsssssssesscsssssssessssssssessessssssscssesssssessesssssescesessssscasesessseacens 4 75 ecdrG c314FsUnregisterFifo LevelC allback cccessssssessssssesesssessssessssssssessssssssesessssssssessscssssescssesssescsseseseseseees 4 76 ecdrG c314FsReadFifoD Gla scisusiscsvaceescocacbscsteonsensincosecutenadiiansanrsieodecutdsesienudontine sd satesesiicodannesvosesatdsasieeddontnotcateseshis 4 77 ecdrG c314FsCreatePciD mal ansferList ccccccessssecscsssssessssssssssesssssssscssessssssscesessssscssessssessesessssscasessssseseess 4 78 Podia cio AEPA dd eg oil BJs aa Yell hot OT Gates ane renee eree oeeie ee ae 4 80 ecd CoA Sora PCD Mel Fal SIC srianan E 4 81 ecdrG c314FsD eletePciD maT ransferList cccsesessessssssssessssssssssessssssssessesssssssessssssscssessssescesessssscssessssseseens 4 82 ecdrG c314FsRegisterPciD maT ransferD oneCallback ssesssesseesseesseessesseenseenseesseeseenseenseenseesueessresernsersseesreess 4 83 ecdrG c314FsUnregisterPciD maT ransferD oneCallback se
56. en a Raceway Error occurs pFuncArgument Pointer to any data that a user wants to pass to the callback function when the event occurs Chapter 4 Application Programming Interface API Page 4 93 ZO ECDR GC314 FS Driver A ee Revision 1 0 ecdrGc314FsUnregisterRwErrorCallback This function call enables a user to unregister an event callback function The Unregister function call disables the event notification interrupt Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsUnregisterRwErrorCallback EcdrGc314FsBoardObject pBoardObject Retum Values EC_OK Or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance Chapter 4 Application Programming Interface API Page 4 94
57. ere filterSet is coefficient set to configure 0 63 and valid choices for fi rDecimation ae BC _ IWB_FITR_NO_DECTIMATION EC_IWB_FIR_DECIMATE _BY_2 EC_IWB_FIR_DECIMATE_BY_3 EC_IWB_FIR_DECIMATE_BY_4 The number of coefficients to configure pData Pointer to the data buffer containing numCoef f of values to configure into the specified coefficient set Chapter 4 Application Programming Interface API Page 4 55 ZO ECDR GC314 FS Driver hore Revision 1 0 ecdrGc314FsReadRcvrCoeff This function call reads the filter coefficients for the specified Receiver Block A Receiver Block is comprised of one or more filters that may have one or more sets of coefficients Refer to the E chotek W ideband Receiver M odule U ser M anual for complete details on IWB filter configuration and coefficient register sets Refer to the TI GC 4016 U ser M anual for complete details on the G C4016 filter configuration and coefficient registers For Receiver Blocks with only one channel the IWB Block or for filters that affect all channels the channel argument is ignored For filters that have multiple sets of coefficients the IWB Block the coefficient set is selected via the argument fi1terSet of the specific filter selection Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsReadRevrCoeft EcdrGc314FsBoardObject pBoardObject U32 receiverBlock U32 channel U32 filter U32 numCoeff U32 pData Retum Values EC_OK or EC_ERROR Para
58. es are BC IWE RECE LVER EC_GC4016_RECEIVER_1 EC_GC4016_RECEIVER_2 EC_GC4016_RECEIVER_3 channel The channel of the Receiver Block to query Valid choices are EC_ GC4016_CHANNEL_A EC_ GC4016_CHANNEL_B EC_ GC4016_CHANNEL_C EC_ GC4016_CHANNEL_D Chapter 4 Application Programming Interface API Page 4 85 ZO ECDR GC314 FS Driver a ee Revision 1 0 Number of data words to copy from the specified FIFO The Raceway route code of the destination memory The Raceway address of the destination memory Chapter 4 Application Programming Interface API Page 4 86 ZO ECDR GC314 FS Driver hore Revision 1 0 ecdrGc314FsAddRwDmatransfer This function call adds a D MA transfer request to the specified D MA transfer list This function call will chain the transfer request to the other request in the list For Receiver Blocks that only have one channel the IWB Block the channel argument is ignored Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsAddRwDmaTransfer EcdrGc314FsBoardObject pBoardObject DmaTransferList pDma U32 receiverBlock U32 channel U32 wordCount U32 destRoute U32 destAddr Retum Values EC_OK or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance pDma Pointer to the DmaTransferList to which this request is to be added chained receiverBlock The Receiver Block to query Valid choices
59. ge 4 50 ECDR GC314 FS Driver waar Revision 1 0 Parameters Description registerOffset The register offset of the configuration register from which to read Valid choices are dependent on the Receiver Block being configured The two Register Offset tables define the register offsets available for the IWB and the TI receiver Pointer to variable to return register value The IWB Block Registers O ffset table defines the valid choices for the registerOffset value in the READ and WRITE receiver configuration function calls The IWB Block Data Value Macros table defines helper Macros that ease the programming of the IWB registers and are used for the data value in the WRITE configuration function call Refer to the E chotek W ideband R ecaver M odule U ser M anual for complete details on the registers The G C4016 Receiver Block oe rer Offset table defines the register offsets of the TI GC4016 Receiver Block Refer to the TI GC 4016 User M anual for complete details on the registers Echotek Intemal Wideband Receiver IWB Registers O ffset EC_IWB_GAINDEC filterset Where filterSet is the filter set to configure 0 63 Table 4 1 IWB Block Register O ffsets Chapter 4 Application Programming Interface API Page 4 51 zo ECDR GC314 FS Driver TED Revision 1 0 Echotek Intemal Wideband Receiver IWB Data Value Macros EC_IWB_GAINDEC_VAL fineGain coarseGain firDecimation Where fineGainisan 8 bit value coarseGa
60. iated memory All buffers used for these data transfers will be freed Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsDeleteRwDmaTransferbhist EcdrGc314FsBoardObject pBoardObject DmaTransferList pDma j Retum Values EC_OK Or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance Pointer to the DmaTransferList to be deleted Chapter 4 Application Programming Interface API Page 4 90 ZO ECDR GC314 FS Driver A ee Revision 1 0 ecdrGc314FsRegisterRwDmaTlransferDoneCallback This function call enables a user to register an event callback function that will be executed when the Raceway RACE DMA transfer is completed The Register function call enables the event notification interrupt The prototype of the callback function must be void LUnCE Lon Void Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsRegisterRwDmaTransferDoneCallback EcdrGc314FsBoardObject pBoardObject void pFunction void pFuncArgument Retum Values EC_OK or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance pFunction Pointer to the callback function that will be executed when a Raceway D MA transfer is completed pFuncArgument Pointer to any data that a user wants to pass to the callback function when the event occurs
61. include EcdrGc314FsApi h EcStatus ecdrGc314FsSetFrameSize EcdrGc314FsBoardObject pBoardObject U32 receiverBlock U32 channel U32 frameSize Retum Values EC_OK Or EC_ERROR Parameters PboardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance ReceiverBlock The Receiver Block to configure Valid choices are EC _ IWE RECEIVER EC_GC4016_ RECEIVER_1 EC_GC4016_RECEIVER_2 EC_GC4016_RECEIVER_3 Channel The channel of the Receiver Block to configure Valid choices are EC_GC4016_CHANNEL_A EC_GC4016_CHANNEL_B EC_GC4016_CHANNEL_C EC_GC4016_CHANNEL_D FrameSize Desired frame size Chapter 4 Application Programming Interface API Page 4 40 ZO ECDR GC314 FS Driver ar ee Revision 1 0 ecdrGc314FsGetFrameSize This function call retrieves the frame size for a particular channel Synopsis include EcdrG c314FsA pi h EcStatus ecdrGc314FsGetFrameSize EcdrGc314FsBoardObject pBoardObject UsZ recervereiock U32 Channel U32 pFrameSize Retum Values EC_OK Or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance receiverBlock The Receiver Block to configure Valid choices are EC WE RECEIVER EC_GC4016_ RECEIVER_1 EC_GC4016_RECEIVER_2 EC_GC4016_RECEIVER_3 channel The channel of the Receiver Block to configure Valid choices are EC_GC40
62. ing where infoType is used to indicate the type of information Valid choices for infoType ae BC CRITICAL ERROR BC_MAJOR_ERROR BC _MINOR_ERROR BC ALERT_INFO BiC_GENERAL INFO EC DEBUG INFO ecdrGc314FsUnregisterLogInfoFunction This function call disables the EcdrG c314Fs driver code s logging facility Synopsis include EcdrGc314FsApi h void ecdrGc314FsUnregisterLoginfoFunction void Retum Values void Parameters void Chapter 4 Application Programming Interface API Page 4 8 ZO ECDR GC314 FS Driver a ee Revision 1 0 ecdrGc314FsGetFpgaVersion This function call provides the version of the Echotek ECD R GC314 X XX FS Altera Stratix design programmed into the FPGA There are two characteristics of this function call e The return is a U32 that represents the version in the form 0xX X YY ZZBB where XX is major YY is minor ZZ is bugfix and BB is the build e The other characteristic returns the version by copying the string X X YY ZZ Build BB into the sPt r char pointer passed in by the caller If the caller passes in a NULL pointer only the U32 is returned The passed in char buffer MUST be at least 22 characters in length Synopsis include EcdrGc314FsApi h U32 ecdrGc314FsGetFpgaVersion EcdrGc314FsBoardObject oBoardObject Char sPtr int maxLen Retum Values U32 representing the version in the form 0xX X YY ZZBB see description above Parameters pBoardObject Pointer to
63. inisa3 bit value and valid choices for firDecimation ae EC _IWB FIR NO DECIMATION EC_IWB FIR DECIMATE BY 2 EC_IWB_ FIR DECIMATE BY 3 EC _IWB FIR DECIMATE_BY 4 EC_IWB_FREQSYNC_VAL freqSync phaseSync Where the valid choices for fregSync and phaseSync are BC TWB_SYNC_DISABLE BC_IWB_ SIA ENABLE BC_IWB_SIB_ ENABLE BC _IWB_SIA_SIB_ ENABLE BC _IWB_SYNC_ALWAYS EC WE RECSOYNG VAL mCoOsync Firsvnc Fluishsyne Where the valid choices for ncoSync firSync and flushSync ae EC IWB SYNC DISABLE EC_IWB_SIA_ENABLE EC_IWB_SIB_ENABLE EC_IWB_SIA_SIB_ENABLE Table 4 2 IWB Block Data Value Macros Chapter 4 Application Programming Interface API Page 4 52 y ZO ECDR GC314 FS Driver ECHOT Chr Revision 1 0 mesere fec_scaieratos O Beccar msaren OOOO esearo fT Eesen ooreormos i Becer owore OOOO ec_scuois_ooreur_woro_size OOOO Besen omwonen OOOO Beccan seamen OOOO fec_scaois_coreur_tasa OOO Eeen oeras OO Beson omora OOOO fec_scaois_ooreur_tasp fec_scaie reves fec scwismiss CP Table 4 3 TI Receiver Block Register O ffsets Chapter 4 Application Programming Interface API Page 4 53 ZO ECDR GC314 FS Driver hore Revision 1 0 ecdrGc314FswWriteRcvrCoeff This function call writes the filter coefficients for the specified Receiver Block A Receiver Block is comprised of one or more filters that may have one or more sets of coefficients Refer to the E chotek W ideband Receiver M odule U ser M anual for
64. lect current API development ZO ECDR GC314 FS Driver pCa reee Revision 1 0 Table of Contents FXOVAGIO Il m 1SUOIY csasosasescsenasoscsonsesrsoneessscesacennocacennon sen reneentsrnsen A A A jii CHAPTER LINTRODUCTION srsssissssivisinniin rnn 1 1 L RE R PE E A 1 2 Bolore G etting VIA IC acscacesravestieny tencaucestc Pidio r Cirer AENEAN BAS AEEA ONENEAN AEE EEES tencanestenesarsiceubsesaresteas CESEN ESON E 1 2 Me CCTMIG ale SUNT I OIA rA A O E E O E E E A E A teat natasnaniants 1 3 CHAPTER 2 BUILDING AND LINKING THE DRIVER esssssssssssossssssssoososssssssssoooessssssssoosossssssssoooe 2 1 ECD R G C314 FS Driver Directory Structure scesssssssssssssssssssssssssssssssssssssssssesssssesssssssssssssesssssssesssesesess 2 2 Building the D river for VXW OTIS seriisiiniiaiiniiesiniireinsnaan oina a aaa aiaiai kaasi inis 2 3 pu lding tme Diver tOr W indOWS iesiriscritneriristoseeri een unenee renies ee eende bei e Eoaea reniei 2 5 Palino De DINT TOTE aE EEEE E EE ESR 2 7 CHAPTER 3 INSTALLING THE DRIVER essssssssssssssssssssooocssssssssoocosssssssoooocessssssooocosessssssooooossessssoosoosssseso 3 1 Installing the ECD R G C314 FS Driver for WindOWS ccssssssesessssesesesssscsessssssesessssssesessesseseseessesesceseesens 3 2 WV TG OWS 9G Mend 0 A E nE EEEE tenants 3 2 Installing the driver on the target computer ccccceeccccseeecceeeeceeeeeeeseeeeeseseeeseseeeseseeeaeeesseneeeaes 3 2 WON acie Bil Be 8 0 eae eee ene
65. meters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance receiverBlock The Receiver Block to query Valid choices are BC IWB RECEIVER EC_GC4016_RECEIVER_1 EC_GC4016_RECEIVER_2 EC_GC4016_RECEIVER_3 channel The channel of the Receiver Block to query Valid choices are EC_GC4016_CHANNEL_A EC_GC4016_CHANNEL_B EC_GC4016_CHANNEL_C EC_GC4016_CHANNEL_D Chapter 4 Application Programming Interface API Page 4 56 ECDR GC314 FS Driver one Revision 1 0 Parameters Description The filter being configured Valid choices are Receiver Block dependent EC _IWB FIR filterSet firDecimation EC _GC4016_CFIR EC _GC4016_ PFIR EC _GC4016 RESAMPLER Where filterSet is coefficient set to configure 0 63 and valid choices for fi rDecimation ae BC _IWB_FIR_NO_DECIMATION EC_IWB_FIR_DECIMATE _BY_2 EC_IWB_FIR_DECIMATE_BY_3 EC_IWB_FIR_DECIMATE_BY_4 The number of coefficients to read pData Pointer to the data buffer large enough for numCoetf of values to read into from the specified coefficient set Chapter 4 Application Programming Interface API Page 4 57 ZO ECDR GC314 FS Driver hore Revision 1 0 Acquisition Control Function Calls The A quisition C ontrol group of function calls control how and when data is acquired by the board These function calls provide individual configuration of the acquisition modes of each of the Receiver Blocks the IW
66. mming Interface API Page 4 72 ZO ECDR GC314 FS Driver oree Revision 1 0 ecdrGc314FsRegisterFifoOverflow Callback This function call enables a user to register an event callback function that will be executed if the specified FIFO is overflowed The Register function call enables the event notification interrupt The prototype of the callback function must be void function void For Receiver Blocks that only have one channel the IWB Block the channel argument is ignored Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsRegisterFifoOverflowCallback EcdrGc314FsBoardObject pBoardObject U32 receiverBlock U32 channel void pFunction vold pFuncArgument Retum Values EC_OK Or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance receiverBlock The Receiver Block to configure Valid choices are EC IWE RECEIVER EC_GC4016_ RECEIVER_1 EC_GC4016_RECEIVER_2 EC_GC4016_RECEIVER_3 channel The channel of the Receiver Block to configure Valid choices are EC_ GC4016_CHANNEL_A EC_ GC4016_CHANNEL_B EC_ GC4016_CHANNEL_C EC_ GC4016_CHANNEL_D pFunction Pointer to the callback function that will be executed if the specified FIFO is overflowed pFuncArgument Pointer to any data that a user wants to pass to the callback function when the event occurs Chapter 4 Application Programming Interface API Page 4 73 ZO
67. o be notified of events interrupts related to data output The procedure to perform D MA transfers is to create a D MA transfer list which consists of one or more D MA transfer requests Each request is defined as a transfer of a number of data words from the FIFOs to a user defined memory location Once a D MA transfer list is created additional D MA transfer request can then be added to the list chaining the transfers together Finally the D MA transfers contained in the list are started O nce all the transfers in a list are complete the user defined event callback function is executed Chapter 4 Application Programming Interface API Page 4 65 zo ECDR GC314 FS Driver Pe set Revision 1 0 ecdrGc314FsEnableReceiverBypass This function call enables the Receiver Block bypass If the IWB bypass is enabled raw A D data is collected in the IWB Block FIFO Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsEnablelIwbBypass EcdrGc314FsBoardObject pBoardObject Retum Values EC_OK or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance Chapter 4 Application Programming Interface API Page 4 66 ZO ECDR GC314 FS Driver A ee Revision 1 0 ecdrGc314FsDisableReceiverBypass This function call disables the Receiver Block bypass If the IWB bypass is disabled the output data of the IWB I and Q data is collected in
68. ogic that might require a periodic sync signal This sync mask when set stays set until it is cleared Two types of sync signals can be generated on the sync buses e Pulsed A pulsed sync signal goes active for four clocks before being de asserted e Latched A latched sync will stay active until being de asserted manually A special type of pulsed sync the RTS sync can also be generated A user can specify an RTS time a 32 bit value so that a pulsed sync is generated onto the sync bus whenever this time matches the onboard free running RTS Chapter 4 Application Programming Interface API Page 4 24 ECDR GC314 FS Driver eS ey lt Che ecdrGc314FsSetGlobalSyncMask This function call enables a user to set sync masks that globally affect the module Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsSetGlobalSyncMask EcdrGc314FsBoardObject pBoardObject U32 syncMaskSelect Retum Values BC_OK OFTECO ERRUR Parameters Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance pBoardObject syncMaskSelect Selects the sync mask to enable Valid choices are EC_SYNC1_IWB_STA_ONE_TIME EKC_SYNC1_IWB_STA_ CONTINUOUS EC_SYNC1_IWB_SIB_ONE_TIME EC oYNC IWB SI1B_ CONTINUOUS EC_SYNC1_GC4016_STA_ONE_TIME BC SYNC LL GC4016 OIA CONTINUOUS EC_SYNC1_GC4016_SIB_ONE_TIME EC_SYNC1_GC4016_SIB_ CONTINUOUS EC_SYNC1_CLEAR_RTS_COUNTER EC_SYNC1_LATCH_RTS_COU
69. on call enables a user to unregister an event callback function The Unregister function call disables the event notification interrupt Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsUnregisterLbTermCallback EcdrGc314FsBoardObject pBoardObject Retum Values EC_OK or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance Chapter 4 Application Programming Interface API Page 4 17 ZO ECDR GC314 FS Driver a ee Revision 1 0 ecdrGc314FsLoadFpgalmage This function call enables a user to load an FPGA image file into the onboard Flash memory Refer to the ECD R G C314 X X X FS H ardware U sers M anual for complete details about the FPGA images and their Flash partitioning O nce images are loaded into Flash memory another function call enables a user to reconfigure the FPGA with these images Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsLoadFpgalimage EcdrGc314FsBoardObject oBoardObject U32 imageNumber U32 pBuffer U32 numBytes Retum Values EC_OK Or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance imageNumber Number of the Flash partition into which an image is to be loaded Each partition may contain one FPGA image pBuffer Pointer to the buffer that contains the FPGA image data numBytes
70. r code ensure that your system meets the following requirements The ECDR GC314 X XX FS board is installed in your system If the ECD R GC314 X XX FS is configured for use with an external clock source connect the clock input to the ECD R GC314 XXX FS The input clock should have an amplitude range of between 4 dBm and 4 dBm Please refer to the E CD R G C314 X X X FS User Manual for exact specifications N Any clock source with amplitude outside this range may cause the board to malfunction and may damage the board The analog input connected to the ECD R GC314 XXX FS should have an amplitude less than or equal to 5 dBm N Any input with amplitude exceeding 5 dBm causes the Analog to D igital converter to saturate and may damage the board Chapter 1 Introduction Page 1 2 ZO ECDR GC314 FS Driver hore Revision 1 0 Technical Support If you need additional technical information or assistance use the following contact information E Mail rich echotek com Telephone 256 721 1911 Ext 161 Facsimile 256 721 9266 Ext 161 Address Echotek Corporation 555 Sparkman Drive Suite 400 Huntsville Al 35816 Chapter 1 Introduction Page 1 3 ZO ECDR GC314 FS Driver oneee Revision 0 4 Chapter 2 Building and Linking the Driver This chapter contains information for building and linking the ECD R GC314 FS driver for all available development environments Chapter 2 Building and Linking the Driver Page 2 1 ZO E
71. r code and include the file EcdrGc314FsApi h in the user application code Chapter 3 Installing the Driver Page 3 6 ZO ECDR GC314 FS Driver oneee Revision 0 4 Chapter 4 Application Programming Interface API This chapter includes the API calls supported by the ECD R GC314 FS driver Chapter 4 Application Programming Interface API Page 4 1 ZO ECDR GC314 FS Driver oree Revision 1 0 Overview of the ECDR GC314 FS API The ECD R GC314 FS API provides all function calls necessary to configure control and utilize all functionality of ECD R GC314 FS boards The function calls are divided into several groups related to various aspects of board configuration or operation This chapter lists all function calls along with descriptions and valid parameters The EcdrG c314Fs driver s API is defined in the EcdrGc314FsApi h header file Simply include this file in the user application code when calling the driver code function calls Each ECD R GC314 FS board in a system must be created and initialized using the ecdrGc314FsCreateBoardInstance function call which returns a board pointer that must then be passed into each function to reference the specific board Most functions return an EcStatus value that indicates the success or failure of the function call The valid values for EcStatus are e EC_OK Indicates successful operation of the function e EC_ERROR Indicates a failure to complete the desired function e EC _INVALID
72. r to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance framingMode Selects the desired framing mode Valid choices are iC FRAME RTS_AND_CHID BC _FRAME RTS_ONLY Chapter 4 Application Programming Interface API Page 4 38 zo ECDR GC314 FS Driver TAD Revision 1 0 ecdrGc314FsGetTimestamp This function call retrieves the contents of either of two relative timestamp counters e EC_SYNCHRONIZED_RTS This counter contains the free running RTS value e EC_IMMEDIATE_RTS This counter contains the synchronized or latched timestamp value The synchronized RTS updates only when the LATCHED_RTS_COUNTER sync mask syncl or sync is set and the corresponding sync has been generated Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsGetTimestamp EcdrGc314FsBoardObject pBoardObject U32 rtsSelect U32 pRtsValue Retum Values EC_OK or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance rtsSelect Selects the timestamp counter to read from Valid choices are BC_SYNCHRONIZED_ RTS EC IMMEDIATE RIS pRtsValue Stores the timestamp value read from the board Chapter 4 Application Programming Interface API Page 4 39 ZO ECDR GC314 FS Driver ar ee Revision 1 0 ecdrGc314FsSetFrameSize This function call sets the fame size for a particular channel Synopsis
73. rameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance Pointer to the DmaTransferList to be deleted Chapter 4 Application Programming Interface API Page 4 82 ZO ECDR GC314 FS Driver A ee Revision 1 0 ecdrGc314FsRegisterPciDmalransferDoneCallback This function call enables a user to register an event callback function that will be executed when the PCI DMA transfer is completed The Register function call enables the event notification interrupt The prototype of the callback function must be void TUNnCE on vold Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsRegisterPciDmaTransferDoneCallback EcdrGc314FsBoardObject pBoardObject void pFunction void pFuncArgument Retum Values EC_OK Or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance pFunction Pointer to the callback function executed when a PCI D MA transfer is completed pFuncArgument Pointer to any data that a user wants to pass to the callback function when the event occurs Chapter 4 Application Programming Interface API Page 4 83 ZO ECDR GC314 FS Driver a ee Revision 1 0 ecdrGc314FsUnregisterPciDmaT ransferDoneCallback This function call enables a user to unregister an event callback function The Unregister function call disables the event notification
74. s include EcdrGc314FsApi h EcStatus ecdrGc314FsSetDataSkipCount EcdrGc314FsBoardObject pBoardObject U32 receiverBlock U32 channel U32 skipWwordCount Retum Values EC_OK Or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance receiverBlock The Receiver Block to configure Valid choices are EG IWB RECEIVER EC_GC4016_ RECEIVER_1 EC_GC4016_RECEIVER_2 EC_GC4016_RECEIVER_3 channel The channel of the Receiver Block to query Valid choices are EC_GC4016_CHANNEL_A EC_GC4016_CHANNEL_B EC_GC4016_CHANNEL_C EC_GC4016_CHANNEL_D skipWordCount Number of words to skip before capturing data Chapter 4 Application Programming Interface API Page 4 61 ZO ECDR GC314 FS Driver hore Revision 1 0 ecdrGc314FsStopContinuousAcquisition This function call stops data acquisition for an individual Receiver Block configured for continuous acquisition mode Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsStopFreerunAcgquisition EcdrGc314FsBoardObject pBoardObject UszZ receiver sbiock UsZ Channel Retum Values EC_OK Or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance receiverBlock The Receiver Block to configure Valid choices are BEC _IWB_ RECEIVER EC_GC4016_ RECEIVER 1 EC_GC4016_RECEIVER_2 EC_GC401
75. s define the register offsets available for the IWB and the TI receivers The value to write to the configuration register Chapter 4 Application Programming Interface API Page 4 49 ZO ECDR GC314 FS Driver oree Revision 1 0 ecdrGc314FsReadRcvrConfig Read This function call reads the configuration registers of the specified Receiver Block The registers of the Receiver Blocks may be separated into two types of registers e Global registers Registers that control overall operation of the receiver e Channel registers Registers that control an individual channel and that are set per channel For global registers and for Receiver Blocks that only have one channel the IWB Block the channel argument is ignored Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsReadRevrConfig EcdrGc314FsBoardObject pBoardObject U32 receiverBlock U32 channel U32 registerOffset U32 pData Return Values EC_OK Or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance receiverBlock The Receiver Block to query Valid choices are EC _IWB_ RECEIVER EC_GC4016_RECEIVER_1 EC_GC4016_RECEIVER_2 EC_GC4016_RECEIVER_3 channel The channel of the Receiver Block to query Valid choices are EC_GC4016_CHANNEL_A EC_GC4016_CHANNEL_B EC_GC4016_CHANNEL_C EC_GC4016_CHANNEL_D Chapter 4 Application Programming Interface API Pa
76. space and project files are included in the Project V xW orks subdirectory The ECD R GC314 FS driver code is delivered as a static library object that can be linked with a user s application or system code The source code and project files are also provided in case a user needs to modify the driver code for a specific application The following shows the Tornado II IDE with the ECD R GC314 FS driver workspace files Tornado Workspace EedrGes 1 4Fs PEE lls E E E Tic Aroi DriverCude Source EcboardObpecte io Copyright 2003 Echotek TEA ll Rights Raeerved eB T EcdrGcslaFes Files fincelade EeBosrdQbject h Eca ia tc E Paape finolude teatdlib h 3 Finclude string h eae tinelude tdia hs fa EcFogslmageChl EdnpCile finclade EchotekOo Source EcOs0tilitiee h fe EcCuiputtt tinclude PleI6S6lib Source EcPl e96Sbbridge h fe EcRecenverCi c finclude EcBosrdObjDaf h A Exleinel Dependencies fg Dhjet Hodde Bin E i Echotek OS Filer Be PS Sh ity Filis H S Register i Files fo wersion in the foru major ninor bugfix build static EcYersion scdrocdldbsDrivec ecsion 0201 0x00 sl Ox00 static woid JleginfotUs iofo l pa const char FintoString ee API Hethod E draha ardhjen HecdrGcdidPsCresteboardinstance 0492 bosardTypelId O42 BodrGcsl4FeBoarddb spBoerd EcdrocsliPsboard0bj inalloc sizeof Eodrac exteRegisterlog nfoFunctiont loginfa re pBoard
77. state of the Local Bus Termination is disabled Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsDisableLbTerm EcdrGc314FsBoardObject 7D BOALOOD FECL F Retum Values EC_OK Or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance Chapter 4 Application Programming Interface API Page 4 15 ZO ECDR GC314 FS Driver a ee Revision 1 0 ecdrGc314FsRegisterLbTermCallback This function call enables a user to register an event callback function that will be executed when the Local Bus cycle is terminated This function call enables the event notification interrupt The prototype of the callback function must be void function void Synopsis include EedrGc314FsApi h EcStatus ecdrGc314FsRegisterLbTermCallback EcdrGc314FsBoardObject pBoardObject void pFunction void pFuncArgument Retum Values EC_OK Or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance pFunction Pointer to the callback function that will be executed when a Local Bus cycle is terminated pFuncArgument Pointer to any data that a user wants to pass to the callback function when the event occurs Chapter 4 Application Programming Interface API Page 4 16 ZO ECDR GC314 FS Driver A ee Revision 1 0 ecdrGc314FsUnregisterLbT ermCallback This functi
78. t panel connectors as the input to the IWB An all Os zeros input can also be connected as the input channel of the IWB Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsSelectIwbInputSource EcdrGc314FsBoardObject pBoardObject U32 inputChannel Retum Values EC_OK or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance inputChannel_ The Input Channel that is to be connected to the IWB Valid choices are KC_INPUT_CHANNEL_ 1 EC_INPUT_CHANNEL_ 2 EC_INPUT_CHANNEL_3 EC INPUT Aly ZEROS Chapter 4 Application Programming Interface API Page 4 21 ZO ECDR GC314 FS Driver oree Revision 1 0 ecdrGc314FsSelectGc4016InputSource This function call selects the input source to the TI GC4016 receivers The available input sources are the three input channels of digitized A D data or the output of the IWB When the input channels CH1 CH2 CH3 are selected each input channel is connected to the input channels of each G C4016 A B and C respectively with D grounded When IWB data is selected the 16 bits of I and Q data are connected to input A and B of each TI GC4016 receiver with input C and D grounded IMPORTANT The GC4016s must be configured to operate in the appropriate mode to match the input data connected to the G C4016 chips Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsSelectGc4016InputSo
79. t sync masks that affect a particular receiver channel Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsSetSyncMask EcdrGc314FsBoardObject pBoardObject U32 receiverBlock U32 channel U32 syncMaskSelect Retum Values EC_OK Or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance receiverBlock The Receiver Block to configure Valid choices are EC _IWB RECEIVER EC_GC4016_RECEIVER_1 EC_GC4016_RECEIVER_2 EC_GC4016_RECEIVER_3 The channel of the Receiver Block to configure Valid choices are EC_GC4016_CHANNEL_A EC_GC4016_CHANNEL_B EC_GC4016_CHANNEL_C EC_GC4016_CHANNEL_D Chapter 4 Application Programming Interface API Page 4 27 ECDR GC314 FS Driver A ee Revision 1 0 Parameters Description syncMaskSelect Selects the sync mask to enable Valid choices are EC _SYNC2 DATA ACQ CONTINUOUS EC_SYNC2 DATA ACQ ONE TIME EC SYNC1 DATA ACQ CONTINUOUS EC_SYNC1_DATA_ACQ_ONE_TIME EC_SYNC2_CLEAR_FIFO EC OYNCIL CLEAR FIFO EC_SYNC2_CLEAR_FRAME_COUNTER EC_SYNC1_CLEAR_FRAME COUNTER EC_SYNC2_UPDATE_ CHANNEL ID EC SYNCI UPDATE CHANNEL ID Chapter 4 Application Programming Interface API Page 4 28 ZO ECDR GC314 FS Driver hore Revision 1 0 ecdrGc314FsClearSyncMask These function calls enable a user to clear sync masks that affect a particular receiver channel Synopsis include EcdrGc314FsApi h EcStatus
80. the Create function call for the specific board instance receiverBlock The Receiver Block to configure Valid choices are BEC _IWB_ RECEIVER EC_GC4016_ RECEIVER 1 EC_GC4016_RECEIVER_2 EC_GC4016_RECEIVER_3 The channel of the Receiver Block to configure Valid choices are EC_GC4016_CHANNEL_ A EC_GC4016_CHANNEL_B EC_GC4016_CHANNEL_C EC_GC4016_CHANNEL_D pFrameCount Stores the retrieved channel frame count Chapter 4 Application Programming Interface API Page 4 46 zo ECDR GC314 FS Driver TAD Revision 1 0 Receiver Control Function Calls The R ecaver Control group of function calls give access to each of the four Receiver Blocks configuration registers The Receiver Blocks are made up of the IWB and the three TI G C4016 receivers Each Receiver Block has two synchronization signal inputs e Sync Input A SIA e Sync Input B SIB These signal inputs are used internally to synchronize various aspects of the receiver logic as set in the Receiver Block registers The synchronization process completes when the sync signal transitions from an asserted state to a released state Refer to the E chotek Internal W ideband R ecaver M odule U ser M anual and the TI GC 4016 User Manual for complete details about the synchronization and synchronization signal inputs Chapter 4 Application Programming Interface API Page 4 47 ZO ECDR GC314 FS Driver oree Revision 1 0 ecdrGc314FsWriteRcvrConfig Write This function c
81. urce EcdrGc314FsBoardObject pBoardObject U32 inputSource Retum Values EC_OK Or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance inputSource The input source to be connected to the TI GC4016 receivers Valid choices are EC_SOURCE_INPUT_CHANNELS EC_SOURCE_IWB_IANDQ_ DATA Chapter 4 Application Programming Interface API Page 4 22 ZO ECDR GC314 FS Driver A ee Revision 1 0 ecdrGc314FsInputChanOverrange This function call indicates whether the specified input channel s A D input has exceeded the acceptable range i e if the A D has been saturated The TRUE FALSE over range status result is returned using the passed in Boolean pointer Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsInputChanOverrange EcdrGc314FsBoardObject pBoardObject U32 inputChannel Boolean pOverrangeStatus Retum Values EC_OK Or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance inputChannel The input channel to check for A D over range status Valid choices are KC_INPUT_CHANNEL_ 1 EC_INPUT_CHANNEL_ 2 EKC_INPUT_CHANNEL_ 3 pOverrangeStatus Pointer to the Boolean variable in which to hold the resulting TRUE FALSE value Chapter 4 Application Programming Interface API Page 4 23 ZO ECDR GC314 FS Driver oree Revision
82. virtual inf to a temporary directory on the target computer e g c tmp You can delete this file from the temporary directory after completing the installation process 5 Use the utility wdreg_gui to install WinDriver s kernel module on the target computer From the command line type gt wdreg_gui inf lt full path to wd_virtual inf gt reload For example if wd_virutal inf has been copied to the c tmp directory on the target computer type the following gt wdreg_gui inf c tmp wd_virtual inf reload NOTE ou must type the full path to the INF file when using wdreg_ gui NOTE dreg_gui is an interactive utility If the utility fails it will display a message instructing the user on how to resolve the problem In some cases the user may be asked to reboot the computer CAUTION Chapter 3 Installing the Driver Page 3 3 zo ECDR GC314 FS Driver a ae Ensure that you do not overwrite windrvr sys with an older existing version of the file in the Revision 1 0 indows driver directory windir system32 drivers You should compare the timestamp on the two versions of the files and not overwnite a newer version with an older version o Installing the EcdrGc314Fs inf updating Windows Device Manager On Windows 2000 XP you can use the wdreg_gui utility to automatically load the INF file and update Windows Device Manager To automatically install your INF file and update Windows Device Manager run w
83. when the event occurs Chapter 4 Application Programming Interface API Page 4 63 ZO ECDR GC314 FS Driver oree Revision 1 0 ecdrGc314FsUnregisterAcquisitionDoneCallback This function call enables a user to unregister an event callback function The Unregister function call disables the event notification interrupt Synopsis include EcdrGc314FsApi h EcStatus ecdrGc314FsUnregisterAcgquisitionDoneCallback EcdrGc314FsBoardObject pBoardObject U32 receiverBlock U32 channel Retum Values EC_OK or EC_ERROR Parameters pBoardObject Pointer to the EcdrGc314FsBoardObject returned by the Create function call for the specific board instance receiverBlock The Receiver Block to configure Valid choices are BC IWE RECE LVER EC_GC4016_RECEIVER_1 EC_GC4016_RECEIVER_2 EC_GC4016_RECEIVER_3 channel The channel of the Receiver Block to query Valid choices are EC_GC4016_CHANNEL_A EC_GC4016_CHANNEL_B EC_GC4016_CHANNEL_C EC_GC4016_CHANNEL_D Chapter 4 Application Programming Interface API Page 4 64 zo ECDR GC314 FS Driver TAD Revision 1 0 Output Control Function Calls The Output Control group of function calls control the FIFOs that data is collected into and collected data gets to the end user All EcdrG c314Fs boards can perform D MA transfers The functions to configure the D MA transfers are included in this section The Output C ontrol functions also provide the function calls that enable a user t

ECDR-GC314-FS SoftwareUserManual

Contents

Download Pdf Manuals

Related Search

Related Contents