Get GraphicUSB DevKit Manual
Contents
1. GraphicUSB Devkit 1 01 Copyright 2008 2009 MQP Electronics Ltd 9 ma GRAPHICUSB DEVKIT ELECTRONICS 2 2 From GraphicUSB Application without Displaying Event Capturing During Capture all events on the USB link will be saved to a buffer You may plug in or unplug your device while capturing Click here to run traffic generator Capture Filtering Enabled Capture L Buffer Full Packets 1584 ACKed Transactions 0 N Ked Transactions 792 Frames 6341 Capture Duration 05 Data Size 106 971 Analyser FIFO Usage Add Comment po nt Click Save and Display to stop capturing and view the results Click Save Only to stop capturing and save the results without viewing Click Restart to clear the events captured and start again Click Cancel to abandon the capture Restart Cancel Save On i When saving the capture file you can click Save Only and the file will be saved without the need to perform the normal display parsing On very large files this can result in a considerable time saving GraphicUSB Devkit 1 01 Copyright 2008 2009 MQP Electronics Ltd 10 ni La Fe ELECTRONICS GRAPHICUSB DEVKIT Appendix 1 The include file mquaccess h ifndef defin MQUACC it sho e ESS E MQUACCESSDLL H MQUACCESSDLL H XPORTS is defined when building the dll uld not be defined when calling the dll def2. Packet Only GraphicUSB Devkit 1 01 Copyright 2008 2009 MQP Electronics Ltd 12 ni La Fe ELECTRONICS BOOL bBitStuffError BOOL bBothLinesHighError BOOL bPacketError BYTE nEopLengthInClks Keep Alive BOOL bChirpdJ BOOL bDn BOOL bVbusCurrentState High Low Only BOOL bDpCurrentState High Low Only BOOL bDnCurrentState High Low Only BOOL bSpuriousBytesFound GRAPHICUSB DEVKIT Packet Only Packet Only Packet Only e g no EOP Ls Fs Packets Resume End and Chirp Start only Data Line High Low Only Data Line High Low or VBUS Data Line High Low or VBUS Data Line High Low or VBUS file contains non parsed record D containing the dll version number it is important to check this before using the dll further exported functions XKKKKKXKXX MOUACCESS D11GetVersion Returns a WOR XKKKKKXKXX MOUACCESS Open const Opens the named mqu file in the dll must be done before using MQUACC MQUACCESS GetFileInfo returns TRUE for successful opening k KKK KKK MOUACC returns FALSE opened ye KKKKKKKKKK MO Fills in the file ifdef MQUACC on vent r Even t b ESS_GetFileInfo FileInfo pFil Fills in the FileInfo structure for the mqu fil if file could no accessed ES
3. e t closes the text file e Finally it releases the dll capture mqu This is a sample capture file created by GraphicUSB using an analyser registered for DevkKit The folder also contains files created by Visual Studio 6 which were used to compile this project In the Release folder is outtext exe A compiled version of the program DevKit Test Release A desktop link icon for testing purposes GraphicUSB Devkit 1 01 Copyright 2008 2009 MQP Electronics Ltd 5 m CI GRAPHICUSB DEVKIT ELECTRONICS 1 3 Trying it Out Documentation is provided mainly by comments in the mquaccess h file to ensure that the documentation used refers to the current version As delivered the outtext project is set up as a Visual Studio 6 workspace and a C project although of course you may use mquaccess dll in any way that suits your programming tools As delivered a desktop shortcut DevKit Test Release is provided to open a command line window and set the release folder as current Double click this then at the command line prompt type outtext capture mqu text txt The capture file will be processed and the file text txt will be created Type Type text txt for a brief flavour of the content GraphicUSB Devkit 1 01 Copyright 2008 2009 MQP Electronics Ltd 6 m CI GRAPHICUSB DEVKIT ELECTRONICS 1 4 Points to remember e Unless you move the DLL or installed it elsewhere you should use the path name t
4. 2009 MQP Electronics Ltd 14
5. S_GetEvent or UACCESS GetEvent Event E SCEUC urned for each call returns FALSE for end of file p ture for each successive event in the mqu Event ig LPCTSTR filepath eInfo e if it hadn t been or if file captured on analyser not registered for DevKit KKKKKKKKKK MQ returns TRUE UACCESS Close Closes the named mqu file in the dll for successful closing ESS EXPORTS extern C declspec dllexport WORD GraphicUSB Devkit 1 01 MQUACCES S D11GetVersion Copyright 2008 2009 MQP Electronics Ltd 13 ke Fe ELECTRONICS GRAPHICUSB DEVKIT MQUACCESS Open const LPCTSTR MQUACCESS GetEvent Event MQUACCESS Close extern C declspec dllexport BOOL filepath extern C declspec dllexport BOOL MQUACCESS GetFileInfo FileInfo pFile lnfo extern C declspec dllexport BOOL pEvent extern C declspec dllexport BOOL Helse typedef WORD typedef BOOL typedef BOOL typedef BOOL typedef BOOL MQUACCESS Ge typedef BOOL MQUACCESS Ge endif endif GraphicUSB Devkit 1 01 Filelnfo Event Byte const MQUACCESS D11GetVersion MQUACCESS Open MQUACCESS Close MQUACCESS Get F E LPCTSTR filepath FileInfo pFilelInfo vent pEvent Copyright 2008
6. es when the developers would like access to the capture file from their own programs A possible reason is when it is necessary to perform an extremely large capture in order to see a packet which occurs only infrequently A user written program could analyse the capture file using the developer s unique knowledge of the vendor class device It could output the significant information to a small text file GraphicUSB is equipped with functionality which allows it to perform a capture from a command line or to perform a capture and save the file without displaying it thus eliminating the time needed to index the file The optional GraphicUSB Devkit contains a Dynamic Link Library file which user programs can link to This DLL allows access to each event in turn contained in the mqu capture file saved by GraphicUSB An example C command line program illustrates how to make use of the DLL The Devkit is compatible with any of Packet Master Analyser series GraphicUSB Devkit 1 01 Copyright 2008 2009 MQP Electronics Ltd 3 m JP GRAPHICUSB DEVKIT ELECTRONICS 1 2 Installing the Software and DLL File 1 2 1 Install the Software from CD e Insert the GraphicUSB Installation disk into the CD drive e On the Choose Components page ensure that DevKit is checked e Continue with install The Devkit files will be found in their own folder called GraphicUsbDevkit e The access DLL file will be placed in the same P
7. ine MQUACCESS DLL VERSION 0x0101 T defines used in Event struct eventType possible values define EVENTNONE 0 define EVENTPACKET 1 define EVENTPLUGGED 2 define EVENTUNPLUGGED 3 define EVENTRESETSTART 4 define EVENTRESETEND 5 define EVENTSUSPEND 6 define EVENTRESUMESTART 7 define EVENTRESUMEEND 8 define EVENTKEEPALIVE 9 define EVENTBOTHLINESHIGH 10 define EVENTSPURIOUSDATA 11 define EVENTDATALINEHIGH 12 define EVENTDATALINELOW 13 define EVENTVBUSON 14 define EVENTVBUSOFF 15 define EVENTCHIRPSTART 16 define EVENTCHIRPEND 17 define EVENTHSRESETSTART 18 define EVENTCOMMENT 19 define EVENTTRIGGERSTART 20 define EVENTTRIGGERSTOP 21 define EVENTENDOFFILE 255 PID values define PIDTOKOUT Oxel define PIDTOKIN 0x69 define PIDTOKSOF 0xas5 define PIDTOKSETUP 0x2d define PIDTOKDATAO Oxc3 define PIDTOKDATAI 0x4b define PIDTOKDATA2 0x87 define PIDTOKMDATA OxO define PIDTOKACK Oxd2 define PT DTOKNAK 0x5a define PIDTOKSTALL Oxle GraphicUSB Devkit 1 01 Copyright 2008 2009 MQP Electronics Ltd 11 GC GRAPHICUSB DEVKIT ELECTRONICS define PIDTOKNYET 0x96 define PIDTOKPREORERR Ox3c define PIDTOKSPLIT 0x78 define PIDTOKPING O
8. ma GRAPHICUSB DEVKIT ELECTRONICS GraphicUSB Devkit 1 01 User Manual MQP Electronics Ltd Unit 2 Park Road Centre Malmesbury Wiltshire SN16 OBX United Kingdom e mail sales mqp com Website www mgp com GraphicUSB Devkit 1 01 Copyright 2008 2009 MQP Electronics Ltd 1 ma GRAPHICUSB DEVKIT ELECTRONICS Contents 1 GETTING STARTED 5 nnne 3 14 INGOOUCUON enti AE 3 1 2 Installing the Software and DLL Fille sscccccsseeeeeeceeeennneees 4 1 2 1 Install the Software from CD 4 1 2 2 Files supplied see nn non 4 1 3 Trying it OUt osier ES 6 1 4 Points to remember ss 7 2 FAST WAYS TO PRODUCE A CAPTURE FILE 8 2 1 From Command Line ccsssscccssseeceneeeesnsneneessnessenensncnsanenssaanes 8 2 1 1 Start COMMIS antenne tic toi 8 2 1 2 Restart CADIUlS sn ieninessndeneele sn ediones ess 9 2 1 3 Stop CADRE me 9 21 4 DISDIA NES a case an 9 2 2 From GraphicUSB Application without Displaying 10 APPENDIX 1 THE INCLUDE FILE MQUACCESS H 11 GraphicUSB Devkit 1 01 Copyright 2008 2009 MQP Electronics Ltd 2 m CI GRAPHICUSB DEVKIT ELECTRONICS 1 GETTING STARTED 1 1 Introduction This manual assumes that you are already familiar with the Packet Master analyser and normal use of the GraphicUSB application Refer to the Packet Master User Manual in case of any doubt Whilst GraphicUSB can display and export data in a wide variety of formats there will always be cas
9. o the DLL Program Files MQP Electronics GraphicUSB mquaccess dll Before you can use the DLL you must link to it using LoadLibrary At the end of your program you should release the DLL using FreeLibrary e The header file mqpaccess h must match the version number of the mqpaccess dll file To ensure this your program must check the DLL version using MQUACCESS _DIIGetVersion before using any other function e The capture file must have been generated using an analyser registered for the DevKit option You can check this by using MQUACCESS _Open const LPCTSTR filepath followed by MQUACCESS _GetFilelnfo Filelnfo pFilelnfo and then checking filelnfo bDevkitRegistered GraphicUSB Devkit 1 01 Copyright 2008 2009 MQP Electronics Ltd 7 m CI GRAPHICUSB DEVKIT ELECTRONICS 2 FAST WAYS TO PRODUCE A CAPTURE FILE 2 1 From Command Line It is possible to control GraphicUSB from another application using a command line syntax This allows another application to perform a capture without GraphicUSB becoming visible For the sake of simplicity the following examples show the commands being issued by use of the older WinExec function You may wish to use a more recent function such as CreateProcess or the NET function Process Start The strings are all supposed to be on one line but will be shown split in this document The filename is shown in the examples without a full path In this case the file will be
10. rogram Files folder as the GraphicUSB application 1 2 2 Files supplied The key files provided are mquaccess dll This Dynamic Link Library DLL file contains the functions required to access the mqu capture file This is placed in the same Program Files folder as the GraphicUSB application Consequently an absolute path to this location should be specified when linking to it mquaccess h This include file contains the declarations for the functions required to access the mqu capture file mquaccess h should be included in your c file to allow access to the dll at run time outtext cpp This is a sample C program which can be used as the basis of your own custom program The sample is a command line program which performs the following e t starts by linking to the dll checking that it is the right version e t opens a new text file for writing its results to e It instructs the dll to open a specified capture mqu file GraphicUSB Devkit 1 01 Copyright 2008 2009 MQP Electronics Ltd 4 m JP GRAPHICUSB DEVKIT ELECTRONICS e t requests a set of information about the file A key item of information is whether the capture file was created using an analyser which was registered for use with the DevKit If it was not further analysis will not be possible e t requests each event in turn from the dll outputting appropriate information to the text file as required e It instructs the dll to close the mqu file
11. saved in the Application Data folder for GraphicUSB You can also specify a full pathname in order to save the file in a folder of your choice The available commands which make use of the switches c0 c1 and c2 are as follows 2 1 1 Start Capture WinExec c Program Files MQP Electronics GraphicUSB GraphicUSB cl TestCapt mqu SW HIDE This will start GraphicUSB running define TestCapt mqu as the location to save the capture when complete and start the capture If GraphicUSB is already running visibly it will become invisible and start the capture GraphicUSB Devkit 1 01 Copyright 2008 2009 MQP Electronics Ltd 8 m CI GRAPHICUSB DEVKIT ELECTRONICS 2 1 2 Restart Capture WinExec c Program Files MQP Electronics GraphicUSB GraphicUSB c2 SW HIDE This assumes that a capture is in progress else an error message is displayed It will abandon the capture in progress and start it again 2 1 3 Stop Capture WinExec c Program Files MQP Electronics GraphicUSB GraphicUSB c0 SW HIDE This assumes that a capture is in progress else an error message is displayed It will stop the capture in progress and save it to the file named in the Start Capture command 2 1 4 Display File WinExec c Program Files MQP Electronics GraphicUSB GraphicUSB TestCapt mqu SW_SHOW This will display the captured file specified in a visible instance of GraphicUSB
12. xb4 define PIDTOKRESERVED Oxf0 usbSpeed possible values define USBSPEED LS 0 define USBSPEED FS 1 define USBSPEED HS 2 define DATABUFFERSIZE 1027 structures used by mquaccess dll basic information about the opened capture mqu file struct FileInfo DWORD64 captureDuration DWORD analyserSerNum serial number of analyser used display as decimal WORD fileVersion WORD swVersion version of GraphicUSB used for capture WORD modifyingSwVersion WORD analyserPid WORD analyserDriverVersion WORD analyserFwVersion WORD analyserPcbVersion BOOL bFileOpen O not open 1 open BOOL bDevkitRegistered O not registered 1 registered DWORD fileSize WORD clocksPerUs 60 or 48 clocks per microsecond see timestamps information describing a particular event in the file struct Event DWORD fileIndex could be used for progress bar with FileInfo fileSize DWORD64 timeStamp in clocks 0 means file had syntax error BYTE eventType see list above int numDataBytes if it s a packet BYTE data DATABUFFERSIZE includes PID and CRC int usbSpeed USBSPEED LS USBSPEED FS USBSPEED HS BOOL bCrcl6Error data0 1 2 mdata Packet Only BOOL bCrc5Error in out setup sof split Packet Only BOOL bByteError
Download Pdf Manuals
Related Search