Home

WinDriver™ USB User`s Manual - Version 10.2.0

1. printf Error incorrect WinDriver version n B 6 4 WD Close PURPOSE e Closes the access to the WinDriver kernel module PROTOTYPE void WD_Close HANDLE hwWD PARAMETERS Name Type Input Output hWD HANDLE Input DESCRIPTION Name Description hWD Handle to WinDriver s kernel mode driver as received from WD_Open B 6 2 RETURN VALUE None REMARKS e This function must be called when you finish using WinDriver kernel module EXAMPLE Jungo Ltd 2005 2010 147 WD Close hWD B 6 5 WD Debug PURPOSE e Sets debugging level for collecting debug messages PROTOTYPE DWORD WD_Debug HANDLE hWD WD_DEBUG pDebug PARAMETERS Name Type Input Output hWD HANDLE Input pDebug WD_DEBUG Input e dwCmd DWORD Input e dwLevel DWORD Input e dwSection DWORD Input e dwLevelMessageBox DWORD Input e dwBufferSize DWORD Input DESCRIPTION Name Description hWD Handle to WinDriver s kernel mode driver as received from WD_Open B 6 2 pDebug Pointer to a debug information structure e dwCmd Debug command Set filter Clear buffer etc For more details please refer to DEBUG_COMMAND in windrvr h e dwLevel Used for dwCmd DEBUG_SET_FILTER Sets the debugging level es dwSection to collect Error Warning Info Trace For more details please refer to DEBUG_LEVEL
2. RETURN VALUE The handle to the WinDriver kernel module If device could not be opened returns INVALID_HANDLE_VALUE Jungo Ltd 2005 2010 145 REMARKS e If you are a registered user please refer to the documentation of WD_License B 6 9 for an example of how to register your WinDriver license EXAMPLE HANDLE hWD hWD WD_Open if hWD INVALID HANDLE VALUE printf Cannot open WinDriver device n B 6 3 WD Version PURPOSE e Returns the version number of the WinDriver kernel module currently running PROTOTYPE DWORD WD_Version HANDLE hWD WD_VERSION pVer PARAMETERS Name Type Input Output hWD HANDLE Input pVer WD_VERSION e dwVer DWORD Output e cVer CHAR 128 Output DESCRIPTION Name Description hWD Handle to WinDriver s kernel mode driver as received from WD_Open B 6 2 pVer Pointer to a WinDriver version information structure e dwVer The version number e cVer Version information string The version string s size is limited to 128 characters including the NULL terminator character Jungo Ltd 2005 2010 146 RETURN VALUE Returns WD_STATUS_SUCCESS 0 on success or an appropriate error code otherwise B 8 EXAMPLE WD_VERSION ver BZERO ver WD_Version hWD amp ver printf Ss n ver cVer if ver dwVer lt WD_VER
3. Software Status Codes NOTE Only the error bit is set WD_USBD_STATUS_NO_MEMORY USBD Out of memory WD_USBD_STATUS_INVALID_URB_FUNCTION USBD Invalid URB function WD_USBD_STATUS_INVALID_PARAMETER USBD Invalid parameter outstanding transfers Returned if client driver attempts to close an endpoint interface or configuration with WD_USBD_STATUS_ERROR_BUSY USBD Attempted to close endpoint interface configuration with outstanding transfer Jungo Ltd 2005 2010 167 Status Code Description Returned by USBD if it cannot complete a URB request Typically this will be returned in the URB status field when the IRP is completed with a more specific error code The IRP status codes are indicated in WinDriver s Debug Monitor tool wddebug_gui wddebug WD_USBD_STATUS_REQUEST_FAILED USBD URB request failed WD_USBD_STATUS_INVALID_PIPE_HANDLE USBD Invalid pipe handle Returned when there is not enough bandwidth available to open a requested endpoint WD_USBD_STATUS_NO_BANDWIDTH USBD Not enough bandwidth for endpoint Generic HC Host Controller error WD_USBD_STATUS_INTERNAL_ HC ERROR USBD Host controller error Returned when a short packet terminates the transfer i e USBD_SHORT_TRANSFER_OK bit not set WD_USBD_STATUS_ERROR SHORT TRANSFER USBD Transfer terminated with short packet Returned if the requested start frame is not with
4. On the development PC you can have the INF file automatically installed when selecting to generate the INF file with DriverWizard by checking the Automatically Install the INF file option in the DriverWizard s INF generation window refer to section 5 2 It is also possible to install the INF file manually using either of the following methods e Windows Found New Hardware Wizard This wizard is activated when the device is plugged in or if the device was already connected when scanning for hardware changes from the Device Manager e Windows Add Remove Hardware Wizard Right click on My Computer select Properties choose the Hardware tab and click on Hardware Wizard e Windows Upgrade Device Driver Wizard Locate the device in the Device Manager devices list and select the Update Driver option from the right click mouse menu or from the Device Manager s Action menu In the manual installation methods above you will need to point Windows to the location of the relevant INF file during the installation If the installation wizard offers to install an INF file other than the one you have generated select Install one of the other drivers and choose your specific INF file from the list We recommend using the wdreg utility to install the INF file automatically instead of installing it manually Tf the installation fails with an ERROR_FILE_NOT_FOUND error inspect the Windows s registry to see if the RunOnce key exists in HKEY
5. ee eee eeeeeseeeeneeeeeeeeeeeenees 75 10 Dynamically Loading Your Driver sccssasicesesessscsestieceangeznscepsasecelesaneedengsdsusdoessucaseausiernuasdactesees 77 10 1 Why Do You Need a Dynamically Loadable Driver AA 77 10 2 Windows Dynamic Driver Loading scysiatsadsesed ocd eacunscadanesnaecadeans geedesoadcbueadaaieneunceasdeniges 77 TOL NR NK 77 10 2 2 The wdreg Utility ions taeda senetirecaheecn te seeend ids cainnsdencheiessuceaesechceepneedctnagieectaerdaesvbes 71 1022 E 78 10 2 3 Dynamically Loading Unloading windrvr6 sys INF Files seser 79 10 3 Linux Dynamic Driver Loading isthe cctoscecvescxecatesaGssessscennnesce Aietenieesabnnncenseatsrateacetes 80 10 4 Windows Mobile Dynamic Driver Loading eeeeseseeseseeseseeseesessrerressresrrsrresrrssesrresee 80 El Distib tine Your Dryer tege eaaa A E E TRE E aa i 81 11 1 Getting a Valid License for WinDriver ee eee ceseceseeeeeeeeseecaeceseeeseeeeaeessaeenseesees 81 11 2 Windows Driver Distribution sic cc5sc tes spree ces seaetemeacetocsuneetetnancevenduaeerncetenideamtennets 81 11 2 1 Preparing the Distribution Package scdc 1sostsdssegissesdcesenciysesesennsaneeccreasdcnnsoeenacare 82 11 2 2 Installing Your Driver on the Target Computer 82 11 3 Windows CE Driver Kee eege eege ege 85 11 3 1 Distribution to New Windows CE Platforms 00 ee ce eeeeeseeseeeeeeeseeenseeeeenees 85 Jungo Ltd 2005 2010 v 11 3 2 Distribution to Windows CE Computers
6. used for reading writing PCMCIA attribute space accessing PCMCIA I O and memory ranges and handling PCMCIA interrupts pemcia_scan exe WinDriver util pemcia_scan exe used to obtain a list of the PCMCIA cards installed and the resources allocated for each card 1 9 3 WinDriver s Specific Chipset Support WinDriver provides custom wrapper APIs and sample code for major USB chipsets see Chapter 8 including for the following chipsets Cypress EZ USB WinDriver cypress Microchip PIC18F4550 WinDriver microchip pic18f4550 Philips PDIUSBD12 WinDriver pdiusbd12 Texas Instruments TUSB3410 TUSB3210 TUSB2136 and TUSB5052 WinDriver ti Agere USS2828 WinDriver agere Silicon Laboratories C8051F320 USB WinDriver silabs 1 9 4 Samples In addition to the samples provided for specific chipsets 1 9 3 WinDriver includes a variety of samples that demonstrate how to use WinDriver s API to communicate with your device and perform various driver tasks C samples found under the WinDriver samples directory These samples also include the source code for the utilities listed above 1 9 2 NET C and Visual Basic NET samples Windows found under the WinDriver csharp net and WinDriver vb net directories respectively Delphi Pascal samples Windows WinDriver delphi samples directory Visual Basic samples Windows found under the WinDriver vb samples directory Jungo Ltd 2005 2010 8 WinDriver Ove
7. EE E 154 Pe Ty es e eet 155 B73 Tread EE 155 B 7 4 Thread CIE 156 Bid EE HEES 156 B 76 OSEVENtG EE 157 B 7 1 OSEVENCW All GE 157 Jungo Ltd 2005 2010 vii B 7 8 OSEyentSi onal assistearre aiaa a a a a ea iA ae 158 B 7 9 e EE GE 159 Bi7 10 OSMUtEK Create sisscs 05cc cuss sssessgeveedseesssdessscneeedadessdpagesseecessseviguesdassecudacecevesessste e 159 B 7 11 OSMUteXClOSe ccccccccccccssssssecececccecsesessesecececcceesensseaeceeeecesesessaaeeeseeeeseneneas 160 B 7 12 OSMUTEX LOCK E 160 B73 OSMUtex UNIOCK E 161 Be ER eeh 161 ek WD E EEN 162 B 7 16 WD Ee E 163 B717 WD LogAdd ere 163 B 8 WinDriver Status Codes cccccsccccccccecsesessssccecececeesensnsececeeeceesessssnaeeeseceesesensneaeeeeess 165 RS AMtOGUCUONE eeen E E ES 165 B 8 2 Status Codes Returned by WinDriver AANEREN 165 B 8 3 Status Codes Returned by USB D scrsesacorcsonsssiadeanieansiartetaceaneneneeseeaieetiae 166 C Troubleshooting E 170 D Evaluation Version Limitations ccccccccccccsessssssececececsesessnsecececccsesesesseaeeeceeeeeesesssseeeseeeens 171 D 1 Windows WinDriver Evaluation Limitations sesesesesesesererererererererererererererererrreres 171 D 2 Windows CE WinDriver Evaluation Limitations cccccccccccceesssssscecececeeeeeensaees 171 D 3 Linux WinDriver Evaluation Limitations 00 ccccccccccccccccecsessnseceeecececeesensnseaeeeeees 171 E Purchasing EE 173 F Di
8. In case of a blocking stream the function blocks until the entire data is written to the stream or until the stream s attempt to write data to the device times out In the case of a non blocking stream the function writes as much of the write data as currently possible to the stream and returns immediately For both blocking and non blocking transfers the read write function returns the amount of bytes actually transferred between the stream and the calling application within an output parameter pdwBytesRead B 4 9 3 pdwBytesWritten B 4 9 4 You can flush an active stream at any time by calling the WOU_StreamF1lush function B 4 9 5 which writes the entire contents of the stream s data buffer to the device for a write stream and blocks until all pending I O for the stream is handled You can flush both blocking and non blocking streams Jungo Ltd 2005 2010 75 USB Transfers You can call WOU_St reamGet Status B 4 9 6 for any open stream in order to get the stream current status information To stop the data streaming between an active stream and the device call WDU_StreamStop B 4 9 7 In the case of a write stream the function flushes the stream i e writes its contents to the device before stopping it An open stream can be stopped and restarted at any time until it is closed To close an open stream call WOU_StreamClose B 4 9 8 The function stops the stream including flushi
9. inf directory Jungo Ltd 2005 2010 37 Installing WinDriver 3 Uninstall WinDriver e On the development PC on which you installed the WinDriver toolkit Run Start WinDriver Uninstall OR run the uninstall exe utility from the WinDriver installation directory The uninstall will stop and unload the WinDriver kernel module windrvr6 sys delete the copy of the windrvr6 inf file from the windir inf directory delete WinDriver from Windows Start menu delete the WinDriver installation directory except for files that you added to this directory and delete the shortcut icons to the DriverWizard and Debug Monitor utilities from the Desktop e Ona target PC on which you installed the WinDriver kernel module windrvr6 sys but not the entire WinDriver toolkit Use the wdreg utility to stop and unload the driver wdreg inf lt path to windrvr6 inf gt uninstall When running this command windrvr6 sys should reside in the same directory as windrvr6 inf On the development PC the relevant wdreg uninstall command is executed for you by the uninstall utility e If you attempt to uninstall WinDriver while there are open handles to the WinDriver service windrvr6 sys or your renamed driver 12 2 or there are connected and enabled Plug and Play devices that are registered to work with this service wdreg will fail to uninstall the driver This ensures that you do not uninstall the driver while it is bei
10. Name Description hStream A unique identifier for the stream as returned by WDU_St reamOpen RETURN VALUE Returns WO_STATUS_SUCCESS 0 on success or an appropriate error code otherwise B 8 B 4 10 WDU_ResetPipe PURPOSE e Resets a pipe by clearing both the halt condition on the host side of the pipe and the stall condition on the endpoint This function is applicable for all pipes except pipe00 PROTOTYPE DWORD WDU_ResetPipe WDU_DEVICE_HANDLI FE hDevice DWORD dwPipeNum PARAMETERS Jungo Ltd 2005 2010 131 Name Type Input Output hDevice WDU_DEVICE_HANDLE Input dwPipeNum DWORD Input DESCRIPTION Name Description hDevice A unique identifier for the device interface dwPipeNum The pipe s number RETURN VALUE Returns WO_STATUS_SUCCESS 0 on success or an appropriate error code otherwise B 8 REMARKS e This function should be used if a pipe is halted in order to clear the halt B 4 11 WDU_ ResetDevice PURPOSE e Resets a device PROTOTYPE DWORD WDU_ResetDevice WDU_DEVICE_HANDLE hDevice DWORD dwOptions PARAMETERS Name Type Input Output hDevice WDU_DEVICE_HANDLE Input dwOptions DWORD Input DESCRIPTION Name Description hDevice A unique identifier for the device interface Jungo Ltd 2005 2010 132 Name Descrip
11. WD_Sleep hWD amp slp B 6 9 WD_License PURPOSE e Transfers the license string to the WinDriver kernel module and returns information regarding the license type of the specified license string When using the WOU USB APIs B 2 your WinDriver license registration is done via the gt call to wWDU_Init B 4 1 so you do not need to call WD License directly from your code PROTOTYPE DWORD WD_License HANDLE hWD WD_LICENSE pLicense Jungo Ltd 2005 2010 152 PARAMETERS Name Type Input Output hWD HANDLE Input pLicense WD_LICENSE e cLicense CHAR Input e dwLicense DWORD Output e dwLicense2 DWORD Output DESCRIPTION Name Description hWD Handle to WinDriver s kernel mode driver as received from WD_Open B 6 2 pLicense Pointer to a WinDriver license information structure e cLicense A buffer to contain the license string that is to be transferred to the e dwLicense WinDriver kernel module If an empty string is transferred then WinDriver kernel module returns the current license type to the parameter dwLicense Returns the license type of the specified license string cLicnese The return value is a bit mask of license flags defined as an enum in windrvr h Zero signifies an invalid license string Additional flags for determining the license type are returned in dwLicense2 if needed e dwLicense2 Returns ad
12. 1 On Windows and Linux ccccccccssssssscececececsenssseaecececcesessssnaeceseceesesesenaeaeeeeees 6 LSZ On Windows CE miraire siorino a ET L ENE E AAEE 6 1 9 What Does the WinDriver Toolkit Include 00 cc cccccccccccccccceceessssnsececececeesenssseaeeeseceees 6 1 9 1 WinDriver Modules ccccccccccccecsesssscceceseceesessnsnseceeeccescsesesssaeeeseesesesensasaeeeeecs 7 1 92 UUES EE 7 1 9 3 WinDriver s Specific Chipset Support essessssseesessrsesesressereresressresrerrensersresresseese 8 IR EE 8 1 10 Can I Distribute the Driver Created with WinDriver ccccccccccceceesesssseceeeeeeeeeeees 9 2 Understanding Device LAUER tege Era 10 2 1 Device Driver Overview iicisivedesnsesvsceiadesesieiesscdetssehdsuuseusddetdseocsheds us ddesovadsesdudeddeeavoudeeds 10 2 2 Classification of Drivers According to Functionality 0 eeecesceereeeneeenneeeseeeees 10 2 2 1 Monolithic Dri Vers gesiess Zeie ege ecders suodeueds EAR 10 BD 2y EEN 11 2 23 Mimp rt KE 12 2 3 Classification of Drivers According to Operating Systems 0 eee eeeeeeseeeteeeeeeeeees 14 2553 Le WDM DE Vers risista arrinin aR EEEE IE T eE AEE a A 14 23 2 VXD RE 14 29 3 UniX Device Drivers moassen ta i e E aE aasa 14 2 3 4 Linux Device Drivers arraroan aaria a ENNEN 14 24 The Entry Point of the Divet Aere 15 2 5 Associating the Hardware with the Driver 2 c cesctescccceccescdecscccedensssndeaccassdessteegedeeansesdeess 15 2 6 C mmuni
13. 3 pipe 0x6 Bulk direction out packet size 512 Read Write Information Panel Log Output Description Figure 5 6 Select Device Interface i Select the desired pipe ii For a control pipe a bidirectional pipe click Read Write A new dialogue will appear allowing you to select a standard USB request or define a custom request as demonstrated in 5 7 f3 Pipe 0 Control Setup Packet Write to pipe data Hex Custom request E Type Request wYalue wiIndex wLength 00 0 om o 0 00 00 00 00 00 00 00 00 Action Read From Pipe Trace USB transaction in Ellisys visual USB Figure 5 7 USB Control Transfers When you select one of the available standard USB requests the setup packet information for the selected request is automatically filled and the request description is displayed in the Request Description box Jungo Ltd 2005 2010 47 Using DriverWizard For a custom request you are required to enter the setup packet information and write data if exists yourself The size of the setup packet should be eight bytes and it should be defined using little endian byte ordering The setup packet information should conform to the USB specification parameters omRequest Type bRequest wValue wIndex whength More detailed information on the standard USB requests on how to implement the control transfer and how to send setu
14. CE WinDriver lib WINCE lt CPU gt wdapil020 lib e For Linux From the WinDriver lib directory libwdapi1020 so or libwdapil1020_32 so for 32 bit applications targeted at 64 bit platforms Note When using libwdapil020_32 so first create a copy of this file in a different directory and rename it to libwdapi1020 so then link your code with the renamed file A 2 You can also include the library s source files in your project instead of linking the project with the library The C source files are located under the WinDriver src wdapi directory ST E 3 When linking your project with the WDAPI library shared object you will need to distribute this binary with your driver For Windows get wdapi1020 dll wdapi1020_32 dll for 32 bit applications targeted at 64 bit platforms from the WinDriver redist directory Jungo Ltd 2005 2010 54 Developing a Driver For Linux get libwdapil020 so libwdapil1020_32 so for 32 bit applications targeted at 64 bit platforms from the WinDriver lib directory Note On Windows and Linux when using the DLL shared object file for 32 bit applications on 64 bit platforms wdapi1020_32 dll libwdapi1020_32 so rename the copy of the file in the distribution package by removing the _32 portion A 2 For detailed distribution instructions refer to Chapter 11 4 Add any other WinDriver source files that implement API that you which to use in your code e g files from the WinDr
15. Functional USB Data Transfers Overview Functional USB data exchange is used to move data to and from the device There are three types of USB data transfers Bulk Interrupt and Isochronous which are described in detail in sections 3 6 2 3 6 4 of the manual Functional USB data transfers can be implemented using two alternative methods single blocking transfers and streaming transfers both supported by WinDriver as explained in the following sections The generated DriverWizard USB code 5 2 3 and the generic WinDriver util usb_diag exe utility 1 9 2 source code located under the WinDriver samples usb_diag directory enable the user to select which type of transfer to perform 9 3 2 Single Blocking Transfers In the single blocking USB data transfer scheme blocks of data are synchronously transferred hence blocking between the host and the device per request from the host hence single transfers 9 3 2 1 Performing Single Blocking Transfers with WinDriver WinDriver s WOU_Transfer function and the WOU_TransferBulk WDU_TransferIsoch and WOU_TransferInterrupt convenience functions all described in section BAS of the manual enable you to easily impelment single blocking USB data transfers You can also perform single blocking transfers using the DriverWizard utility which uses the WDU_Transfer function as demonstrated in section 5 2 of the manual 9 3 3 Streaming Data Transfers In the
16. HANDLE hThread PARAMETERS Name Type Input Output hThread HANDLE Input DESCRIPTION Name Description hThread The handle to the thread whose completion is awaited RETURN VALUE None B 7 5 PURPOS OsEventCreate E e Creates an event object PROTOT DWORD Os YPE EventCreate HANDLE phOsEvent PARAMETERS Jungo Ltd 2005 2010 156 Name Type Input Output phOsEvent HANDLE Output DESCRIPTION Name Description phOsEvent The pointer to a variable that receives a handle to the newly created event object RETURN VALUE Returns WO_STATUS_SUCCESS 0 on success or an appropriate error code otherwise B 8 B 7 6 OsEventClose PURPOSE e Closes a handle to an event object PROTOTYPE void OsEventClose HANDLE hOsEvent PARAMETERS Name Type Input Output hOsEvent HANDLE Input DESCRIPTION Name Description hOsEvent The handle to the event object to be closed RETURN VALUE None B 7 7 OsEventWait PURPOSE e Waits until a specified event object is in the signaled state or the time out interval elapses Jungo Ltd 2005 2010 157 PROTOT DWORD Os YPE EventWait HANDLE hOsEvent DWOR D dwSecTimeout PARAMETERS Name Type Input Output hOsEvent
17. Index of serial number string descriptor bNumConfigurations UCHAR Number of possible configurations B 5 2 8 WDU_CONFIGURATION_DESCRIPTOR Structure USB configuration descriptor information structure Field Type Description bLength UCHAR Size in bytes of the descriptor Jungo Ltd 2005 2010 142 Field Type Description bDescriptorType UCHAR Configuration descriptor 0x02 wTotalLength USHORT Total length in bytes of data returned bNumInterfaces UCHAR Number of interfaces bConfigurationValue UCHAR Configuration number iConfiguration UCHAR _ Index of string descriptor that describes this configuration bmAttributes UCHAR Power settings for this configuration e D6 self powered e D5 remote wakeup allows device to wake up the host MaxPower UCHAR Maximum power consumption for this configuration in 2mA units B 5 2 9 WDU INTERFACE DESCRIPTOR Structure USB interface descriptor information structure Field Type Description bLength UCHAR Size in bytes of the descriptor 9 bytes bDescriptorType UCHAR _ Interface descriptor 0x04 bInterfaceNumber UCHAR Interface number bAlternateSetting UCHAR Alternate setting number bNumEndpoints UCHAR Number of endpoints used by this interface bInterfaceClass UCHAR The interface s class code as assigned by USB IF bInterfaceSubClass UCHAR
18. The interface s sub class code as assigned by USB IF bInterfaceProtocol UCHAR The interface s protocol code as assigned by USB IF iInterface UCHAR _ Index of string descriptor that describes this interface B 5 2 10 WDU_ENDPOINT_DESCRIPTOR Structure USB endpoint descriptor information structure Field Type Description bLength UCHAR Size in bytes of the descriptor 7 bytes bDescriptorT ype UCHAR Endpoint descriptor 0x05 bEndpointAddress UCHAR Endpoint address Use bits 0 3 for endpoint number set bits 4 6 to zero 0 and set bit 7 to zero 0 for outbound data and to one 1 for inbound data ignored for control endpoints Jungo Ltd 2005 2010 143 Field Type Description bmAttributes UCHAR Specifies the transfer type for this endpoint control interrupt isochronous or bulk See the USB specification for further information wMaxPacketSize USHORT Maximum size of packets this endpoint can send or receive bInterval UCHAR Interval in frame counts for polling endpoint data transfers Ignored for bulk and control endpoints Must equal 1 for isochronous endpoints May range from to 255 for interrupt endpoints B 5 2 11 WDU_ PIPE_ USB pipe information structure INFO Structure Field Type Description dwNumber DWORD Pipe number Zero for default pipe dwMaximumPacketSize DWORD Maxim
19. a USB device information structure B 5 2 3 RETURN VALUE Returns WI B 4 6 WDU_ PutDevicelnfo PURPOSE e Receives a device information pointer allocated with a previous WI DU Ger Devicel PROTOTYPE nfo B 4 5 call in order to perform the necessary cleanu D_STATUS_SUCCESS 0 on success or an appropriate error code otherwise B 8 D Jungo Ltd 2005 2010 117 void WDU_PutDeviceInfo WDU_DEVICE pDevicelInfo PARAMETERS Name Type Input Output pDevicelInfo WDU_DEVICE Input DESCRIPTION Name Description pDevicelnfo Pointer to a USB device information structure B 5 2 3 as returned by a previous call to WOU_GetDeviceInfo B 4 5 RETURN VALUE None B 4 7 WDU_Uninit PURPOSE e Stops listening to devices matching a given criteria and unregisters the notification callbacks for these devices PROTOTYPE void WDU_Uninit WDU_DRIVI ER_HANDLI Rate PARAMETERS Name Type Input Output hDriver WDU_DRIVER_HANDLE Input DESCRIPTION Name Description hDriver Handle to the registration received from WDU_Init B 4 1 RETURN VALUE None Jungo Ltd 2005 2010 118 B 4 8 Single Blocking Transfer Functions This section describes WinDriver s single blocking data transfer functions For more information refer to 9 3 2 of the manual B
20. arguments 7 2 2 2 Windows CE GUI wddebug Execution On Windows CE you can also log debug messages by running wddebug without any arguments This method is designed to enable debug logging on Windows CE platforms that do not have a command line prompt On such platforms you can activate debug logging by double clicking the wddebug executable this is equivalent to running the application with no arguments from a command line prompt When executing wddebug without arguments the user is informed via a GUI message box that log messages will be stored in a predetermined log file wdlog txt in the root Windows CE directory and is given the option to cancel or continue wddebug x i Press OK to start logging debug messages J The messages will be saved to wdlog tst in the root Windows CE directory Cancel Figure 7 3 wddebug Windows CE Start Log Message If the user selects to continue debug logging is turned on with a trace level of TRACE and debug sections ALL and the Debug Monitor begins dumping debug messages to the wdlog txt log file The user can stop the logging and turn off debug logging at any time via a dedicated GUI message box Jungo Ltd 2005 2010 64 Debugging Drivers wddebug Jl Press OK to stop logging Figure 7 4 wddebug Windows CE Stop Log Message Jungo Ltd 2005 2010 65 Chapter 8 Enhanced Support for Specific Chipsets 8 1 Overview In addi
21. as selected during the installation This variable is used in the make and source files of the WinDriver samples and generated DriverWizard 5 code and is also used to determine the default directory for saving your generated DriverWizard projects If you do Jungo Ltd 2005 2010 35 Installing WinDriver not define this variable you will be instructed to do so when attempting to build the sample generated code using the WinDriver makefiles 10 You can now start using WinDriver to access your hardware and generate your driver code Q Use the WinDriver util wdreg script to load the WinDriver kernel module 10 3 The following steps are for registered users only To register your copy of WinDriver with the license you received from Jungo follow these steps 11 Start DriverWizard lt path to WinDriver gt wizard wdwizard 12 Select the Register WinDriver option from the File menu and insert the license string you received from Jungo 13 Click the Activate License button 14 To register source code that you developed during the evaluation period refer to the documentation of WDU_Init B 4 1 4 2 3 3 Restricting Hardware Access on Linux Since dev windrvr6 gives direct hardware access to user programs it may compromise kernel stability on multi user Linux systems Please restrict access to DriverWizard and the device file dev windrvr6 to trusted users For security reasons the WinDriver installation
22. const char sLicense DWORD dwOptions PARAMETERS Name Type Input Output phDriver WDU_DRIVER_HANDLE Output pMatchTables WDU_MATCH_TABLE Input dwNumMatchTables DWORD Input pEventTable WDU_EVENT_TABLE Input sLicense const char Input dwOptions DWORD Input DESCRIPTION Name Description phDriver Handle to the registration of events amp criteria pMatchTables Array of match tables B 5 2 1 defining the devices criteria dwNumMatchTables Number of elements in pMatchTables pEventTable Pointer to an event table structure B 5 2 2 which holds the addresses of the user mode device status change notification callback functions B 3 and the data to pass to the callbacks sLicense WinDriver s license string dwOptions Can be zero or e WD_ACKNOWLEDGE the user can seize control over the device when returning value in WOU_ATTACH_CALLBACK B 3 1 Jungo Ltd 2005 2010 113 RETURN VALUE Returns WI D_STATUS_SUCCESS 0 on success or an appropriate error code otherwise B 8 B 4 2 WDU_Setinterface PURPOSE e Sets the alternate setting for the specified interface PROTOTYPE DWORD WDU_SetInterface WDU_DEV ICE_HANDLE hDevice DWORD dwiInterfaceNum DWORD dwAlternateSetting PARAMETERS Name Type Input Output hDevice WDU_DEVICE_HANDLE Input dwInterfaceNum DWORD Input dwAlternateSetting DWORD Input DESCRIPTION Name Description hDevi
23. default directory for saving your generated code and is used in the include paths of the generated project make files If the installation fails with an ERROR_FILE_NOT_FOUND error inspect the Windows registry to see if the RunOnce key exists in HKEY_LOCAL_MACHINE SOFTWARE Microsoft Windows CurrentVersion This registry key is required by Windows Plug and Play in order to properly install drivers using INF files If the RunOnce key is missing create it then try installing the INF file again The following steps are for registered users only To register your copy of WinDriver with the license you received from Jungo follow these steps 3 Start DriverWizard Start Programs WinDriver DriverWizard 4 Select the Register WinDriver option from the File menu and insert the license string you received from Jungo 5 Click the Activate License button 6 To register source code that you developed during the evaluation period refer to the documentation of WDU_Init B 4 1 4 2 2 Windows CE WinDriver Installation Instructions 4 2 2 1 Installing WinDriver CE when Building New CE Based Platforms e The following instructions apply to platform developers who build Windows CE kernel images using Windows CE Platform Builder or using MSDEV 2005 2008 with the Windows CE 6 0 plugin The instructions use the notation Windows CE IDE to refer to either of these platforms e We recommend that you read Microsoft s documen
24. file HKEY_LOCAL_MACHINE DRIVERS USB LoadClients lt ID gt Default Default WDR Jungo Ltd 2005 2010 55 Developing a Driver DLL windrvr6 d11 lt ID gt consists of your vendor ID and product ID separated by an underscore character lt MY VENDOR ID gt _ lt MY PRODUCT ID gt Insert your device specific information to this key The key registers your device with Windows CE Plug and Play USB driver and enables identification of the device during boot You can refer to the registry after calling WDU_Init and then this key will exist From that moment the device will be recognized by CE If your device has a persistent registry this addition will remain until you remove it For more information refer to the Microsoft Development Network MSDN Library under the USB Driver Registry Settings section The following registry example shows how to register your device with the PCI bus driver can be added to your platform reg file HKEY_LOCAL_MACHINE Drivers BuiltIn PCI Template MyCard Class dword 04 SubClass dword 01 ProglF dword 00 WendorlDY mulbiasz EE an Je breet EE For more information refer to MSDN Library under PCI Bus Driver Registry Settings section 6 4 Developing in Visual Basic and Delphi The entire WinDriver API can be used when developing drivers in Visual Basic and Delphi 6 4 1 Using DriverWizard DriverWizard can be used to
25. input value of this parameter is ignored As output points to a value indicating the required buffer size for storing the registry property property The ID of the registry property to be retrieved see the description of the WD_DEVICE_REGISTRY_PROPERTY enumeration B 5 1 Note String registry properties are in WCHAR format RETURN VALUE Returns WO_STATUS_SUCCESS 0 on success or an appropriate error code otherwise B 8 REMARKS e When the size of the provided user buffer Buffer pdwSize input is not sufficient to hold the requested registry property the function returns WO_INVALID_PARAMETER Jungo Ltd 2005 201 0 116 e This function is supported only on Windows 2000 and higher B 4 5 WDU_GetDevicelnfo PURPOSE e Gets configuration information from a device including all the device descriptors NOTE The caller to this function is responsible for calling WOU_PutDevice order to free the ppDevicelInfo pointer returned by the function PROTOTYPE DWORD WDU_Get DevicelInfo WDU_DEVICE_HANDLE hDevice WDU DEVICE ppDevice eeh nfo B 4 6 in PARAMETERS Name Type Input Output hDevice WDU_DEVICE_HANDLE Input ppDevicelnfo WDU_DEVICE Output DESCRIPTION Name Description hDevice A unique identifier for a device interface ppDevicelnfo Pointer to pointer to
26. is a related set of endpoints that present a specific functionality or feature of the device Each interface may operate independently The interface descriptor describes the number of the interface the number of endpoints used by this interface and the interface specific class subclass and protocol values when the interface operates independently In addition an interface may have alternate settings The alternate settings allow the endpoints or their characteristics to be varied after the device is configured e Endpoint Level The lowest level is the endpoint descriptor which provides the host with information regarding the endpoint s data transfer type and maximum packet size For isochronous endpoints the maximum packet size is used to reserve the required bus time for the data transfer i e the bandwidth Other endpoint attributes are its bus access frequency endpoint number error handling mechanism and direction The same endpoint can have different properties and consequently different uses in different alternate settings Seems complicated Not at all WinDriver automates the USB configuration process The included DriverWizard utility 5 and USB diagnostics application scan the USB bus detect all USB devices and their configurations interfaces alternate settings and endpoints and enable you to pick the desired configuration before starting driver development Jungo Ltd 2005 2010 24 WinDriver USB Overview W
27. isochronous pipe before the data transfer It also resets the pipe after minor errors consequently allowing to transfer to continue USB_ISOCH_FULL_PACKETS_ ONLY Prevents transfers of less than the packet size on isochronous pipes e USB_BULK_INT_URB_SIZE_OVERRIDE_128K Limits the size of the USB Request Block URB to 128KB pBuffer Address of the data buffer dwBufferSize Number of bytes to transfer The buffer size is not limited to the device s maximum packet size therefore you can use larger buffers by setting the buffer size to a multiple of the maximum packet size Use large buffers to reduce the number of context switches and thereby improve performance pdwBytesTransferred Number of bytes actually transferred pSetupPacket dwTimeout An 8 byte packet to transfer to control pipes Maximum time in milliseconds ms to complete a transfer A value of zero indicates no timeout infinite wait RETURN VALUE Returns WO_STATUS_SUCCESS 0 on success or an appropriate error code otherwise B 8 REMARKS e The resolution of the timeout the dwIimeout parameter is according to the operating system scheduler s time slot For example in Windows the timeout s resolution is 10 milliseconds ms B 4 8 2 WDU_HaltTransfer PURPOSE e Halts the transfer on the specified pipe only one simultaneous transfer per pipe is allowed by WinDriver Jungo Ltd 2005 2010 1
28. messages as they are being logged to the command prompt the kernel debugger You can run wddebug with the status command at any time while the Debug Monitor is on to view the current debug level and sections as well as information regarding the running lt driver_name gt kernel module You can use dbg_on and dbg_ of f to toggle the redirection of debug messages to a kernel debugger at any time while the Debug Monitor is on When you are ready turn off the Debug Monitor by running wddebug with the of command You can also run wddebug with the status command while the Debug Monitor is turned off to view information regarding the running lt driver_name gt driver EXAMPLE Jungo Ltd 2005 2010 63 Debugging Drivers The following is an example of a typical wddebug usage sequence Since no lt driver_name gt is set the commands are applied to the default driver windrvr6 s Turn the Debug Monitor on with the highest trace level for all sections wddebug on TRACE ALL Note This is the same as running wddebug on TRACE since ALL is the default debug sections option e Dump the debug messages continuously until the user selects to stop wddebug dump e Use the driver and view the debug messages in the command prompt e Turn the Debug Monitor off wddebug off e Display usage instructions wddebug help As explained above on all platforms other than Windows CE this is equivalent to running wddebug with no
29. of the driver on the target computer Second install the driver on the target machine This involves installing windrvr6 sys and windrvr6 inf and installing the specific INF file for your device Finally you need to install and execute the hardware control application that you developed with WinDriver These steps can be performed using wdreg utility 11 2 1 Preparing the Distribution Package Your distribution package should include the following files e Your hardware control application DLL e windrvr6 sys Get this file from the WinDriver redist directory of the WinDriver package e windrvr6 inf Get this file from the WinDriver redist directory of the WinDriver package e wd1020 cat Get this file from the WinDriver redist directory of the WinDriver package e wdapil020 dll for distribution of 32 bit binaries to 32 bit target platforms or for distribution of 64 bit binaries to 64 bit platforms or wdapil1020_32 dll for distribution of 32 bit binaries to 64 bit platforms A 2 Get this file from the WinDriver redist directory of the WinDriver package e difxapi dll required by the wdreg exe utility 10 2 2 Get this file from the WinDriver util directory of the WinDriver package e An INF file for your device You can generate this file with DriverWizard as explained in section 5 2 11 2 2 Installing Your Driver on the Target Computer Follow the instructions below in the order specified to properly install your dr
30. of the project_wd reg file in the WinDriver samples wince_install directory to the project reg file in the _FLATRELEASEDIR sub directory Jungo Ltd 2005 2010 31 Installing WinDriver e Append the contents of the project_wd bib file in the WinDriver samples wince_install directory to the project bib file in the _FLATRELEASEDIR sub directory This step is only necessary if you want the WinDriver CE kernel file windrvr6 dll to be a permanent part of the Windows CE image NK BIN which is the case if you select to transfer the file to your target platform using a floppy disk If you prefer to have the file windrvr6 dll loaded on demand via the CESH PPSH services you do not need to carry out this step until you build a permanent kernel 5 Select Make Run Time Image from the Build menu and name the new image NK BIN 6 Download your new kernel to the target platform and initialize it either by selecting Download Initialize from the Target menu or by using a floppy disk 7 Restart your target CE platform The WinDriver CE kernel will automatically load 8 Compile and run the sample programs to make sure that WinDriver CE is loaded and is functioning correctly see section 4 4 2 which describes how to check your installation 4 2 2 2 Installing WinDriver CE when Developing Applications for Windows CE Computers Unless otherwise specified Windows CE references in this section include all supported Le
31. pipe endpoint and two functional data transfer pipes endpoints as identified by WinDriver s DriverWizard utility discussed in Chapter 5 D DriverWizard File Tools View Project Help g ER Nk ba E Active Projects tting 2 Number of Endpoints 2 Cypress Semiconductor Corp Product ID 1003 lt Cypress Semiconductor Corp Product ID 1003 Alternate Setting 0 Pipe Name Pipe Type Information Ee Doze 0x0 Control drecken in amp out packet size 64 Alternate Setting 2 Alternate Setting 3 e Alternate Setting 4 2 pipe 0x82 Bulk direction in packet size 512 Alternate Setting 5 Alternate Setting 6 3 pipe 0x6 Bulk direction out packet size 512 Read Write Information Panel Log Output Description Lie Figure 3 2 USB Pipes More information on how to implement the control transfer by sending setup packets can be found in section 9 2 3 6 USB Data Transfer Types The USB device function communicates with the host by transferring data through a pipe between a memory buffer on the host and an endpoint on the device USB supports four different transfer types A type is selected for a specific endpoint according to the requirements of the device and the software The transfer type of a specific endpoint is determined in the endpoint descriptor The USB specification provides for the following data transfer types 3 6 1 C
32. requests to the control pipe and reset the pipes Verify that your device operates as expected e Use DriverWizard to generate skeletal code for your device in C CH Visual Basic NET Delphi or Visual Basic For more information about DriverWizard refer to Chapter 5 e If you are using one of the specific chipsets for which WinDriver offers enhanced support The Cypress EZ USB family Microchip PIC18F4550 Philips PDIUSBD12 Texas Instruments TUSB3410 TUSB3210 TUSB2136 and TUSB5052 Agere USS2828 Silicon Laboratories C8051F320 we recommend that you use the specific sample code provided for your chip as your skeletal driver code For more details regarding WinDriver s enhanced support for specific chipsets refer to Chapter 8 e Use any C NET Delphi Visual Basic compiler such as MSDEV Visual C C MSDEV NET Borland C Builder Borland Delphi Visual Basic 6 0 MS eMbedded Visual C MS Platform Builder C GCC etc to compile the skeletal driver you need e For Linux use any compilation environment preferably GCC to build your code e That is all you need to do in order to create your user mode driver Please see Appendix B for a detailed description of WinDriver s USB API For more information regarding implementation of USB transfers with WinDriver refer to Chapter 9 of the manual Jungo Ltd 2005 2010 53 Developing a Driver 6 2 Writing the Device Driver Without DriverWizard There may be times when
33. should copy the renamed DLL shared object to the relevant OS directory windir sysWOW64 on Windows or usr lib on Linux All other distribution files are the same as for any other 64 bit WinDriver driver distribution as detailed in chapter 11 An application created using the method described in this section will not work on 32 bit platforms A WinDriver application for 32 bit platforms needs to be compiled without the KERNEL _64BIT definition it needs to be linked with the standard 32 bit version of the WinDriver API library shared object from the 32 bit WinDriver installation lt WD32 gt lib x86 wdapi1020 lib on Windows lt WD32 gt lib libwdapi1020 so on Linux and it should be distributed with the standard 32 bit WinDriver API DLL shared object lt WD32 gt redist wdapi1020 dll on Windows lt WD32 gt lib libwdapi1020 so on Linux and any other required 32 bit distribution file as outlined in Chapter 11 A 3 64 bit and 32 bit Data Types In general DWORD is unsigned long While any 32 bit compiler treats this type as 32 bits wide 64 bit compilers treat this type differently With Windows 64 bit compilers the size of this type is still 32 bits However with UNIX 64 bit compilers e g GCC the size of this type is 64 bits In order to avoid compiler dependency issues use the UINT32 and UINT64 cross platform types when you want to refer to a 32 bit or 64 bit address respectively Jungo Ltd 2005 2010 104
34. the SLD file and click Import 3 Add the WinDriver component to your Windows XP Embedded image 1 Open your project in the Target Designer 2 Double click the WinDriver component to add it to your project Note If you already have an earlier version of the WinDriver component in your project s components list right click this component and select Upgrade 3 Run a dependency check and build your image After following these steps WinDriver will automatically be installed during the first boot on the target Windows XP Embedded platform on which your image is loaded Gi _ If you have selected to rename the WinDriver kernel module 12 2 you will not be able to use the provided windriver sld component You can build your own component for the renamed driver or use the wdreg utility to install the driver on the target Windows XP Embedded platform as explained in the manual Jungo Ltd 2005 2010 102 Appendix A 64 bit Operating Systems Support A 1 Supported 64 bit Architectures WinDriver supports the following 64 bit platforms e Linux AMD64 or Intel EM64T x86_64 For a full list of the Linux platforms supported by WinDriver refer to section 4 1 3 e Windows AMD64 or Intel EM64T x64 For a full list of the Windows platforms supported by WinDriver refer to section 4 1 1 A 2 Support for 32 Bit Applications on 64 Bit Windows and Linux Platforms By default applications created using the 64 bit version
35. the supported integrated development environments IDEs MSDEV Visual C 5 6 MSDEV NET 2003 2005 2008 Borland C Builder Visual Basic 6 0 Borland Delphi MS eMbedded Visual C or MS Platform Builder and you can also select to automatically invoke your selected IDE from the wizard You can then proceed to immediately build and run the code from your IDE You can also build the generated code from any other IDE that supports the selected code language and target OS Simply create a new project file for your selected IDE then add the generated source files to your project and compile and run the code e For Windows 7 Vista Server 2008 Server 2003 XP 2000 the generated IDE files are located under an x86 directory for 32 bit projects or amd64 directory for 64 bit projects e For Windows CE note that the generated Windows Mobile code is targeted at the Windows Mobile 5 0 6 0 ARMV4I SDK 5 2 4 2 Linux Compilation Use the makefile that was created for you by DriverWizard in order to build the generated code using your favorite compiler preferably GCC 5 2 5 Bus Analyzer Integration Ellisys Visual USB DriverWizard provides native support for the Ellisys Explorer 200 USB analyzer on Windows XP and higher 32 bit only This support enables you to Jungo Ltd 2005 2010 51 Using DriverWizard e Initiate USB traffic capture directly from DriverWizard e Capture discrete control transfers To capture US
36. windrvr6 sys kernel module and modify your device INF file to register with your renamed driver as explained in section 12 2 1 To install your modified INF files using wdreg simply replace any references to windrvr6 below with the name of your new driver Usage The wdreg utility can be used in two ways as demonstrated below l wdreg inf lt filename gt silent log lt logfile gt install uninstall enable disable 2 wdreg rescan lt enumerator gt silent log lt logfile gt e OPTIONS wdreg supports several basic OPTIONS from which you can choose one some or none e inf The path of the INF file to be dynamically installed e rescan lt enumerator gt Rescan enumerator ROOT USB etc for hardware changes Only one enumerator can be specified e silent Suppress display of all messages optional e log lt logfile gt Log all messages to the specified file optional e compat Use the traditional SetupDi API instead of the newer Driver Install Frameworks API DIFXxAPD e ACTIONS wdreg supports several basic ACTIONS e install Installs the INF file copies the relevant files to their target locations and dynamically loads the driver specified in the INF file name by replacing the older version if needed Jungo Ltd 2005 2010 78 Dynamically Loading Your Driver e preinstall Pre installs the INF file for a non present device e uninstall Removes your driv
37. 0 159 DESCRIPTION Name Description phOsMutex The pointer to a variable that receives a handle to the newly created mutex object RETURN VALUE Returns WO_STATUS_SUCCESS 0 on success or an appropriate error code otherwise B 8 B 7 11 OsMutexClose PURPOSE e Closes a handle to a mutex object PROTOTYPE void OsMutexClose HANDLE hOsMutex PARAMETERS Name Type Input Output hOsMutex HANDLE Input DESCRIPTION Name Description hOsMutex The handle to the mutex object to be closed RETURN VALUE None B 7 12 OsMutexLock PURPOSE e Locks the specified mutex object PROTOTYPE DWORD OsMutexLock HANDLE hOsMutex Jungo Ltd 2005 2010 160 PARAMETERS Name Type Input Output hOsMutex HANDLE Input DESCRIPTION Name Description hOsMutex The handle to the mutex object to be locked RETURN VALUE Returns WD_STATUS_SUCCESS 0 on success or an appropriate error code otherwise B 8 B 7 13 OsMutexUnlock PURPOSE e Releases unlocks a locked mutex object PROTOTYPE DWORD OsMutexUnlock HANDLE hOsMutex PARAMETERS Name Type Input Output hOsMutex HANDLE Input DESCRIPTION Name Description hOsMutex The handle to the mutex object to be unlocked RETURN VALUE Returns WD_STATUS_SUCCESS 0 on success or an appropriate err
38. 010 49 Using DriverWizard For detailed compilation instructions refer to section 5 2 4 5 2 1 Logging WinDriver API Calls You have the option to log all the WinDriver API calls using DriverWizard with the API calls input and output parameters You can select this option by selecting the Log API calls option from the Tools menu or by clicking on the Log API calls toolbar icon in DriverWizard s opening window 5 2 2 DriverWizard Logger The wizard logger is the empty window that opens along with the Device Resources dialogue box when you open a new project The logger keeps track of all of the input and output during the diagnostics stage so that you may analyze your device s physical performance at a later time You can save the log for future reference When saving the project your log is saved as well Each log is associated with one project 5 2 3 Automatic Code Generation After you have finished diagnosing your device and have ensured that it runs according to your specifications you are ready to write your driver 5 2 3 1 Generating the Code Generate code by selecting this option either via DriverWizard s Generate Code toolbar icon or from the wizard s Project Generate Code menu DriverWizard will generate the source code for your driver and place it along with the project file xxx wdp where xxx is the project name The files are saved in a directory DriverWizard creates for every development environment and operati
39. 2 00 0 eecceeessseceseeeeeeeeeeceaeenseeseneeenees 87 11 4 amie Driver Disa E 88 114 1 Kernel leese eene EE 88 11 4 2 User Mode Hardware Control Application Shared Objects c ceeeeeeeees 89 TV As Installation Script scziccasecateceheacetieas soap oxtactenqidseaddav neh ictascqucdend ceagosdueswasteutvaensiess 90 12 Driver Installation Advanced Issues oc isieisoccsncvesossseceassenesecussieduescaneyasosaedesuionedseneieivananceuies 91 12 1 WW MWS LIME E 91 12 1 1 Why Should I Create an INF File a decccceeescasc ciesdsacateussiqundeioeoatvnnGeuetscieuies 91 12 1 2 How Do I Install an INF File When No Driver Exists eccerre 92 12 1 3 How Do I Replace an Existing Driver Using the INF File scce 92 12 2 Renaming the WinDriver Kernel Driver 2 iccsccsccsieesseesecessosescednacesversaaseeeceeaedertodeaceente 93 12 2 1 RE 94 12 2 2 Linux Driver E 96 12 3 Digital Driver Signing and Certification Windows 7 Vista Server 2008 Server 2003 XP 2000 ats carat aac igenre e ei ea eenaa Eaa Ea EAEE aaa ea ARESE 97 e a WE 97 2 3 1 1 Authenticod Driver Signature ccc ecssossue sonasecenttavenesaoesscenngevevesesqneness 98 12 3 1 2 WHQL Driver Certification aa icczcsdsraconndeueceussaietlansdicaressaacsavionenetaniens 98 12 3 2 Driver Signing and Certification of WinDriver Based Drivers seese 99 12 3 2 1 WHQL DTM Test Notes xcisencrsuirreaiesdssetansesaetimmninniasantincnereess 100 12 4 Windows XP Embedded WinDriver Compone
40. 20 PROTOTYPE DWORD WDU_HaltTransfer WDU_DEVICE_HANDLE hDevice DWORD dwPipeNum PARAMETERS Name Type Input Output hDevice WDU_DEVICE_HANDLE Input dwPipeNum DWORD Input DESCRIPTION Name Description hDevice A unique identifier for the device interface dwPipeNum The number of the pipe RETURN VALUE Returns WO_STATUS_SUCCESS 0 on success or an appropriate error code otherwise B 8 B 4 8 3 WDU_TransferDefaultPipe PURPOSE e Transfers data to or from a device through the default pipe PROTOTYPE DWORD WD WDU_ DWOR DWOR PVOIL DWOR PDWO DWOR Seel U_TransferDefaultPi Bess EVICE_HANDLE hDevi ce D D fRead D dwOptions DPE tiene D dwBufferSize D dwTimeout PARAMETERS See parameters of WI RD pdwBytesTransferred Ee poetupPacket DU_Transfer B 4 8 1 Note that dwP ipeNunm is not a parameter of this function DESCRIPTION See description of WI DU_Transfer B 4 8 1 Jungo Ltd 2005 2010 121 RETURN VALUE Returns WO_STATUS_SUCCESS 0 on success or an appropriate error code otherwise B 8 B 4 8 4 WDU_TransferBulk PURPOSE e Performs bulk data transfer to or from a device PROTOTYPE PARAMETERS See parameters of WOU_Transfer B 4 8 1 Note that pSetupPacket is not a parameter of this function DESCRIPTION See description of WOU_T
41. 3 other 1 bRequest The actual request see the Standard Device Request Codes table 9 2 1 5 2 wValueL A word size value that varies according to the request For example in the CLEAR_FEATURE request the value is used to select the feature in the GET_DESCRIPTOR request the value indicates the descriptor type and in the SET_ADDRESS request the value contains the device address Jungo Ltd 2005 2010 69 USB Transfers Byte Field Description 3 wValueH The upper byte of the Value word 4 wIndexL A word size value that varies according to the request The index is generally used to specify an endpoint or an interface 5 wIndexH The upper byte of the Index word 6 wLengthL A word size value that indicates the number of bytes to be transferred if there is a data stage 7 wLengthH The upper byte of the Length word 9 2 1 5 Standard Device Request Codes The table below shows the standard device request codes bRequest Value GET_STATUS 0 CLEAR_FEATURE 1 Reserved for future use 2 SET_FEATURE 3 Reserved for future use 4 SET_ADDRESS 5 GET_DESCRIPTOR 6 SET_DESCRIPTOR 7 GET_CONFIGURATION 8 SET_CONFIGURATION 9 GET_INTERFACE 10 SET_INTERFACE 11 SYNCH_FRAME 12 9 2 1 6 Setup Packet Example This example of a standard USB device request illustrates the setup packet format and its fields The s
42. 4 Distributing Your Driver your 32 bit installation program The system64 exe program provided in the WinDriver redist directory of the Windows x64 WinDriver distributions enables you to do this Install your hardware control application DLL Copy your hardware control application DLL to the target and run it 11 3 Windows CE Driver Distribution 11 3 1 Distribution to New Windows CE Platforms The following instructions apply to platform developers who build Windows CE kernel images using Windows CE Platform Builder or using MSDEV 2005 2008 with the Windows CE 6 0 plugin The instructions use the notation Windows CE IDE to refer to either of these platforms To distribute the driver you developed with WinDriver to a new target Windows CE platform follow these steps 1 Modify the project registry file to add an entry for your target device If you select to use the WinDriver component refer to step 2 modify WinDriver samples wince_install lt TARGET_CPU gt WinDriver reg eo WinDriver samples wince_install ARMV4l WinDriver reg e Otherwise modify WinDriver samples wince_install project_wd reg 2 You can simplify the driver integration into your Windows CE platform by following the procedure described in this step before the Sysgen platform compilation stage Note e The procedure described in this step is relevant only for developers who use Windows CE 4 x 5 x with Platform Builder Dev
43. 4 8 1 WDU_ Transfer PURPOSE e Transfers data to or from a device PROTOTYPE DWORD WDU_Transfer E_ HANDLE hDevice ize WDU_DEVIC DWORD dwPipeNum DWORD fRead DWORD dwOptions WAGED STEE EE DWORD dwBufferSi PDWORD pdwBytes Transferred EE EI pS SeUp Lacks DWORD dwTimeout PARAMETERS Name Type Input Output hDevice WDU_DEVICE_HANDLE Input dwPipeNum DWORD Input fRead DWORD Input dwOptions DWORD Input pBuffer PVOID Input dwBufferSize DWORD Input pdwBytesTransferred PDXWORD Output pSetupPacket PBYTE Input dwTimeout DWORD Input DESCRIPTION Name Description hDevice A unique identifier for the device interface received from WDU_Init B 4 1 dwPipeNum The number of the pipe through which the data is transferred Jungo Ltd 2005 2010 119 Name Description fRead TRUE for read FALSE for write dwOptions A bit mask which can consist of a combination of any of the following flags e USB_ISOCH_NOASAP For isochronous data transfers Setting this option instructs the lower USB stack driver usbd sys to use a preset frame number instead of the next available frame while performing the data transfer Use this flag if you notice unused frames during the transfer on low speed or full speed devices USB 1 1 only and only on Windows excluding Windows CE e USB_ISOCH_RESET Resets the
44. 5 Select the desired alternate setting DriverWizard detects all the device s supported alternate settings and displays them as demonstrated in Figure 5 6 below Select the desired alternate setting from the displayed list DriverWizard will display the pipes information for the selected alternate setting EH For USB devices with only one alternate setting configured DriverWizard automatically selects the detected alternate setting and therefore the Select Device Interface dialogue will not be displayed 6 Diagnose your device Before writing your device driver it is important to make sure your hardware is working as expected Use DriverWizard to diagnose your hardware All of your activity will be logged in the DriverWizard log so that you may later analyze your tests a Test your USB device s pipes DriverWizard shows the pipes detected for the selected alternate setting To perform USB data transfers on the pipes follow these steps Jungo Ltd 2005 2010 46 Using DriverWizard DriverWizard File Tools View Project Help g U T H b E Active Projects Alternate Setting 2 Number of Endpoints 2 Cypress Semiconductor Corp Product ID 1003 4 Cypress Semiconductor Corp Product ID 1003 S Interface 0 Alternate Setting 0 Pipe Name Pipe Type Information Alternate Setting 2 Baies Sa S 2 pipe 0x62 Buk direction in packet size 512 Alternate Setting 5 Alternate Setting 6
45. 5 2 3 2 Th Gomer ated USB C e 50 5 2 3 3 The Generated Visual Basic and Delphi Code A 51 5 2 3 4 The Generated C and Visual Basic NET Code 0 eee eeeeeneeeeee 51 5 2 4 Compiling the Generated Code cos1cssccieusececapiniencesaceduossacsieetdaeovernigteeneaenmn 51 5 2 4 1 Windows and Windows CE Compilation s ssseesseeeseseeseesreseieeresresseeeresee 51 5 24 2 Linux Compilation E 51 5 2 5 Bus Analyzer Integration Ellisys Visual USB 51 6 Deyel ping a Diver eeben 53 6 1 Using DriverWizard to Build a Device Driver esessessseeesessessresrrsresserererressersrrereesesee 53 6 2 Writing the Device Driver Without DriverWizard essseseseeseeerresserersreerrerersersrrereeseese 54 6 2 1 Include the Required WinDriver Files 2 0 0 0 ees eeseceseeseeeeeeeceaeceeeeeeeeeeneeeaeens 54 602 2 Wite DEE tege Eege 55 6 2 3 Configure and Build Your Code sssssseseeeseesessrsesrsressersesressessrerreesersesreeseesee 55 6 3 Developing Your Driver on Windows CE Platforms eeeessseeseesreeseseeesrreresressrreresreses 55 6 4 Developing in Visual Basic and Delphi 56 64 1 Using CIE VY ME 56 Jungo Ltd 2005 2010 iv E sete ss che E EE EE 56 64 3 Creatin your EIERE eer 57 Te Debusgin BEE 58 Tl User WEG eS RE 58 T2 EES MONITOT eege eege AEA EAEE 58 7 2 1 The wddebug_gui Utility egeederee nereerebegeienu dereen 58 7 2 1 1 Running wddebug_gui for a Renamed Driver ee eeceeeeeeeeteeeeeee 61 7 2 2 Th
46. Appendix B WinDriver USB PC Host API Reference This function reference is C oriented The WinDriver NET Visual Basic and Delphi APIs have been implemented as closely as possible to the C APIs therefore NET VB and Delphi programmers can also use this reference to better understand the WinDriver APIs for their selected development language For the exact API implementation and usage examples for your selected language refer to the WinDriver NET VB Delphi source code O B 1 WD_DriverName PURPOSE e Sets the name of the WinDriver kernel module which will be used by the calling application The default driver name which is used if the function is not called is windrvr6 e This function must be called once and only once from the beginning of your application before calling any other WinDriver function including WD_Open WDU_Init as demonstrated in the sample and generated DriverWizard WinDriver applications which include a call to this function with the default driver name windrvr6 e On Windows and Linux if you select to modify the name of the WinDriver kernel module windrvr6 sys o ko as explained in section 12 2 you must ensure that your application calls WD_DriverName with your new driver name e In order to use the WD_DriverName function your user mode driver project must be built with WO_DRIVER_NAME_CHANGE preprocessor flag eg DWD_DRIVER_NAME_ CHANGE for Visual Studio a
47. B traffic 1 Select Tools Start USB Analyzer Capture to start capturing USB data 2 To finish the data capture select Tools Stop USB Analyzer Capture A dialogue box will appear notifying you where DriverWizard stored the analyzer trace Click Yes to run Ellisys s Visual Analyzer with the captured data To capture a discrete control trasfer check the Trace USB transaction in Ellisys Visual USB check box in the control transfers dialogue box eI Pipe 0 Control Setup Packet Write to pipe data Hex Custom request el Type Request wYalue windex wLength o0 fo 0000 o Un 00 00 00 00 00 00 00 00 Action Write to Pipe I Read from Pipe Pipe to File File to Pipe Trace USB transaction in Ellisys visual USB Figure 5 11 Ellisys Visual USB Integration Jungo Ltd 2005 2010 52 Chapter 6 Developing a Driver This chapter takes you through the WinDriver driver development cycle If your device is based on one of the chipsets for which WinDriver provides enhanced support The Cypress EZ USB family Microchip PIC18F4550 Philips PDIUSBD12 Texas Instruments TUSB3410 TUSB3210 TUSB2136 and TUSB5052 Agere USS2828 Silicon Laboratories C8051F320 read the following overview and then skip straight to Chapter 8 6 1 Using DriverWizard to Build a Device Driver e Use DriverWizard to diagnose your device View the device s configuration information transfer data on the device s pipes send standard
48. Driver kernel module windrvr6 dll on a Windows Mobile platform On Windows Mobile the operating system s security scheme prevents the loading of unsigned drivers at boot time therefore the WinDriver kernel module has to be reloaded after boot To load WinDriver on the target Windows Mobile platform every time the OS is started copy the wdreg exe utility to the Windows StartUp directory on the target PC The source code of the Windows Mobile wdreg exe utility is available under the WinDriver samples wince_install wdreg directory on the development PC Jungo Ltd 2005 2010 80 Chapter 11 Distributing Your Driver og Read this chapter in the final stages of driver development It will guide you in preparing your driver for distribution 11 1 Getting a Valid License for WinDriver To purchase a WinDriver license complete the WinDriver docs order pdf order form and fax or email it to Jungo Complete details are included on the order form Alternatively you can order WinDriver on line For more details visit our web site http www jungo com In order to install the registered version of WinDriver and to activate driver code that you have developed during the evaluation period on the development machine please follow the installation instructions found in section 4 2 above 11 2 Windows Driver Distribution All references to wdreg in this section can be replaced with wdreg_gui which offers the same functional
49. Driver kernel module to a specific USB device e To override the existing driver if any e To enable WinDriver applications and DriverWizard to access a USB device Jungo Ltd 2005 2010 91 Driver Installation Advanced Issues 12 1 2 How Do Install an INF File When No Driver Exists You can use the wdreg utility with the install command to automatically install the INF file wdreg inf lt path to the INF file gt install For more information refer to 10 2 2 of the manual On the development PC you can have the INF file automatically installed when selecting to generate the INF file with DriverWizard by checking the Automatically Install the INF file option in the DriverWizard s INF generation window refer to section 5 2 It is also possible to install the INF file manually using either of the following methods e Windows Found New Hardware Wizard This wizard is activated when the device is plugged in or if the device was already connected when scanning for hardware changes from the Device Manager e Windows Add Remove Hardware Wizard Right click the mouse on My Computer select Properties choose the Hardware tab and click on Hardware Wizard e Windows Upgrade Device Driver Wizard Locate the device in the Device Manager devices list and select the Update Driver option from the right click mouse menu or from the Device Manager s Action menu In all the manual installation methods above you will n
50. For example if you have renamed the default windrvr6 sys driver on Windows to my_driver sys you can log messages from your driver by running the Debug Monitor using the following command wddebug_gui my_driver 7 2 2 The wddebug Utility 7 2 2 1 Console Mode wddebug Execution The wddebug version of the Debug Monitor utility can be executed as a console mode application on all supported operating systems Windows Windows CE and Linux To use the console mode Debug Monitor version run WinDriver util wddebug in the manner explained below For console mode execution on Windows CE start a command window CMD EXE on the Windows CE target and then run the program WDDEBUG EXE inside this shell You can also execute wddebug via the Windows CE GUI as explained in section 7 2 2 2 Jungo Ltd 2005 2010 61 Debugging Drivers wddebug console mode usage wddebug lt driver_name gt lt command gt lt level gt lt sections gt _ The wddebug arguments must be provided in the order in which they appear in the usage statement above e lt driver_name gt The name of the driver to which to apply the command The driver name should be set to the name of the WinDriver kernel module windrvr6 or a renamed version of this driver refer to the explanation in section 12 2 The driver name should be set to the name of the driver file without the file s extension for example windrvr6 not windrvr6 sys on Win
51. HANDLE Input dwSecTimeout DWORD Input DESCRIPTION Name Description hOsEvent The handle to the event object dwSecTimeout Time out interval of the event in seconds For an infinite wait set the timeout to INFINITE RETURN VALUE Returns WO_STATUS_SUCCESS 0 on success or an appropriate error code otherwise B 8 B 7 8 OsEventSignal PURPOS E e Sets the specified event object to the signaled state PROTOTYPE DWORD OsEventSignal HANDLE hOsEvent PARAMETERS Name Type Input Output hOsEvent HANDLE Input DESCRIPTION Name Description hOsEvent The handle to the event object Jungo Ltd 2005 2010 158 RETURN VALUE Returns WO_STATUS_SUCCESS 0 on success or an appropriate error code otherwise B 8 B 7 9 OsEventReset PURPOSE e Resets the specified event object to the non signaled state PROTOTYPE DWORD OsEventReset HANDLE hOsEvent PARAMETERS Name Type Input Output hOsEvent HANDLE Input DESCRIPTION Name Description hOsEvent The handle to the event object RETURN VALUE Returns WD_STATUS_SUCCESS 0 on success or an appropriate error code otherwise B 8 B 7 10 OsMutexCreate PURPOSE e Creates a mutex object PROTOTYPE DWORD OsMutexCreate HANDLE phOsMutex PARAMETERS Name Type Input Output phOsMutex HANDLE Output Jungo Ltd 2005 201
52. ITE dwOptions flag this is also the maximum transfer size fBlocking e TRUE for a blocking stream which performs blocked I O e FALSE for a non blocking stream which performs non blocking I O For additional information refer to 9 3 3 1 dwOptions A bit mask which can consists of a combination of any of the following flags e USB_ISOCH_NOASAP For isochronous data transfers Setting this option instructs the lower USB stack driver usbd sys to use a preset frame number instead of the next available frame while performing the data transfer Use this flag if you notice unused frames during the transfer on low or full speed USB 1 1 devices This flag is applicable only on Windows and is ignored on Windows CE e USB_ISOCH_FULL_PACKETS_ ONLY Prevents transfers of less than the packet size on isochronous pipes e USB_BULK_INT_URB_SIZE_OVERRIDE_128K Limits the size of the USB Request Block URB to 128KB This flag is applicable only on Windows USB_STREAM OVERWRITE_BUFFER_WHEN_FULL When there is not enough free space in a read stream s data buffer to complete the transfer overwrite old data in the buffer This flag is applicable only to read streams USB_STREAM MAX TRANSFER_SIZE_OVERRIDE Overrides the default maximum transfer size with the dwRxSize transfer size on Windows CE Note that setting a large dwRxSize value when using this flag may cause the transfers to fail due to host controller limitation
53. Monitor File Edit View Help BE WinDriver Debug Monitor v9 01 Running WinDriver v9 01 Jungo CH 1997 2007 Build Date Jun 10 2007 x86 32bit SYS 13 48 53 OS Windows NT 5 1 Build 0 0 2600 Service Pack 2 Time Sun 10 Jun 15 50 33 2007 Figure 7 1 Start Debug Monitor 2 Set the Debug Monitor s status trace level and debug sections information from the Debug Options dialogue which is activated either from the Debug Monitor s View Debug Options menu or the Debug Options toolbar button Jungo Ltd 2005 2010 59 Debugging Drivers Debug Options Section yo PnP Dm Kernel Plugin Interrupts PCI PCMCIA ISA PnP USB Kernel Driver Miscellaneous License Card Registration DMA Events All Sections Level CH Error CH Warm i Info Gi Trace Send debug messages to the operating system kernel debugger Figure 7 2 Debug Options e Status Set trace on or off e Section Choose what part of the WinDriver API you would like to monitor USB developers should select the USB section Choose carefully those sections that you would like to monitor Checking more options than necessary could result in an overflow of information making it harder for you to locate your problem e Level Choose the level of messages you want to see for the resources defined e Error is the lowest trace level resulting in minimum output to the screen e Trace is the highest trace level displaying e
54. OUT USBD Timeout WD_USBD_STATUS_DEVICE_GONE USBD Device gone WD_USBD_STATUS_STATUS_NOT_MAPPED USBD Status not mapped Extended isochronous error codes returned by USBD These errors appear in the packet status field of an isochronous transfer WD_USBD_STATUS_ISO_NOT_ACCESSED_BY_HW USBD The controller did not access the TD associated with this packet WD_USBD_STATUS_ISO_TD_ERROR USBD Controller reported an error in the TD WD_USBD_STATUS_ISO_NA_LATE_USBPORT USBD The packet was submitted in time by the client but failed to reach the miniport in time WD_USBD_STATUS_ISO_NOT_ACCESSED_LATE USBD The packet was not sent because the client submitted it too late to transmit Jungo Ltd 2005 2010 169 Appendix C Troubleshooting and Support Please refer to http www jungo com st support support_windriver html for additional resources for developers including e Technical documents e FAQs e Samples e Quick start guides Jungo Ltd 2005 2010 170 Appendix D Evaluation Version Limitations D 1 Windows WinDriver Evaluation Limitations e Each time WinDriver is activated an Unregistered message appears e When using DriverWizard a dialogue box with a message stating that an evaluation version is being run appears on every interaction with the hardware e DriverWizard 5 e Each time DriverWizard is activated an Unregistered message appears
55. QL certification However once you have used WinDriver to develop a Windows 7 Vista Server 2008 Server 2003 XP 2000 driver for your selected hardware you can submit both the hardware and driver for Microsoft WHQL certification as explained below The driver certification and signature procedures either via Authenticode or WHQL require the creation of a catalog file for the driver This file is a sort of hash which describes other files The signed windrvr6 sys driver is provided with a matching catalog file WinDriver redist wd1020 cat This file is assigned to the CatalogFile entry in the windrvr6 inf file provided as well in the redist directory This entry is used to inform Windows of the driver s signature and the relevant catalog file during the driver s installation When the name contents or even the date of the files described in a driver s catalog file is modified the catalog file and consequently the driver signature associated with it become invalid Therefore if you select to rename the windrvr6 sys driver 12 2 and or the related windrvr6 inf file the wd1020 cat catalog file and the related driver signature will become invalid In addition when using WinDriver to develop a driver for your Plug and Play device you normally also create a device specific INF file that registers your device to work with the windrvr6 sys driver module or a renamed version of this driver Since this INF file is created at y
56. RN VALUE None B 3 3 WDU_POWER_CHANGE_CALLBACK PURPOSE e WinDriver calls this function when a controlled device has changed its power settings PROTOTYPE typedef BOOL DLLCALLCONV WDU_POWER_CHANGE_CALLBACK WDU_DEVICE_HANDLE hDevice DWORD dwPowerState PVOID pUserData PARAMETERS Name Type Input Output dwPowerState DWORD Input pUserData PVOID Input DESCRIPTION Name Description hDevice A unique identifier for the device interface dwPowerState Number of the power state selected pUserData Pointer to user mode data for the callback as passed to WDU_Init B 4 1 within the event table parameter pEvent Table gt pUserData RETURN VALUE TRUE FALSE Currently there is no significance to the return value REMARKS e This callback is supported only in Windows operating systems starting from Windows 2000 B 4 USB Functions The functions described in this section are declared in the Jungo Ltd 2005 2010 112 WinDriver include wdu_lib h header file B 4 1 WDU_Init PURPOSE e Starts listening to devices matching input criteria and registers notification callbacks for these devices PROTOTYPE DWORD WDU_Init WDU_DRIVER_HAN WDU_MATCH_TABL BUR Siet aeal were Ry el Geer DWORD dwNumMatchTables WDU_EVENT_TABLE pEventTable
57. SB E EE 73 B 1 WinDriver USB Calling Sequence Eeer EEENeee 108 B 2 WmDriver EE 139 B 3 WinDriver API Calling Sequence eege ee 145 Jungo Ltd 2005 2010 ix Chapter 1 WinDriver Overview In this chapter you will explore the uses of WinDriver and learn the basic steps of creating your driver f i This manual outlines WinDriver s support for USB devices WinDriver also supports development for PCI PCMCIA CardBus ISA EISA CompactPCI PCI Express devices For detailed information regarding WinDriver s support for these buses please refer to the WinDriver Product Line page on our web site http www jungo com st windriver html and to the WinDriver PCI Manual which is available on line at http www jungo com st support support_windriver html 1 1 Introduction to WinDriver WinDriver is a development toolkit that dramatically simplifies the difficult task of creating device drivers and hardware access applications WinDriver includes a wizard and code generation features that automatically detect your hardware and generate the driver to access it from your application The driver and application you develop using WinDriver is source code compatible across all supported operating systems 1 6 The driver is binary compatible across Windows 7 Vista Server 2008 Server 2003 XP 2000 WinDriver provides a complete solution for creating high performance drivers Don t let the size of this manual fool you WinDrive
58. SB request from the requests list which includes requests such as GET_DESCRIPTOR CONFIGURATION GET_DESCRIPTOR DEVICE GET_STATUS DEVICE etc see Figure 9 4 The description of the selected request will be displayed in the Request Description box on the right hand of the dialogue window 3 Pipe 0 Control Setup Packet Custom request Custom request GET_DESCRIPTOR CONFIGURATION GET_DESCRIPTOR DEVICE GET_DESCRIPTOR STRING GET_STATUS DEVICE GET_STATUS ENDPOINT GET_STATUS INTERFACE Read from Pipe Save Write Data Pipe to File File to Pipe Trace USB transaction in Ellisys Visual USB Figure 9 4 Requests List Write to pipe data Hex Jungo Ltd 2005 2010 72 USB Transfers 3 The results of the transfer such as the data that was read or a relevant error are displayed in Driver Wizard s Log window Figure 9 5 below shows the contents of the Log window after a successful GET_DESCRIPTOR DEVICE request Information Panel 12 01 00 02 00 00 00 40 B4 0403 1000000102 0 0001 Log Output Description Figure 9 5 USB Request Log 9 2 2 2 Control Transfers with WinDriver API To perform a read or write transaction on the control pipe you can either use the API generated by DriverWizard for your hardware or directly call the WinDriver WI function from within your application Fill the setup packet in the BYTE SetupPacket 8 array and call t
59. SCRIPTION Name Description e dwStatus A numeric status code RETURN VALUE Returns the verbal status description string that corresponds to the specified numeric status code REMARKS See section B 8 for a complete list of status codes and strings Jungo Ltd 2005 2010 154 B 7 2 get os type PURPOSE e Retrieves the type of the operating system PROTOTYPE OS_TYPE get os type void RETURN VALUE Returns the type of the operating system If the operating system type is not detected returns OS_CAN_NOT_DETECT B 7 3 ThreadStart PURPOSE e Creates a thread PROTOTYPE DWORD ThreadStart HANDLE phThread HANDLER_FUNC pFunc VOU parta PARAMETERS Name Type Input Output phThread HANDLE Output pFunc typedef void HANDLER_FUNC Input void pData pData VOID Input DESCRIPTION Name Description phThread Returns the handle to the created thread pFunc Starting address of the code that the new thread is to execute The handler s prototype HANDLER_FUNC is defined in utils h Jungo Ltd 2005 2010 155 Name Description pData Pointer to the data to be passed to the new thread RETURN VALUE Returns WD_STATUS_SUCCESS 0 on success or an appropriate error code otherwise B 8 B 7 4 PURPOS ThreadWait E e Waits for a thread to exit PROTOTYPE void ThreadWait
60. USBD are software interfaces and components of the operating system where the HCD layer represents a lower level of abstraction The HCD is the software layer that provides an abstraction of the host controller hardware while the USBD provides an abstraction of the USB device and the data transfer between the host software and the function of the USB device The USBD communicates with its clients the specific device driver for example through the USB Driver Interface USBDID At the lower level the Core Driver and USB Hub Driver implement the hardware access and data transfer by communicating with the HCD using the Host Controller Driver Interface HCDD The USB Hub Driver is responsible for identifying the addition and removal of devices from a particular hub When the Hub Driver receives a signal that a device was attached or detached it uses additional host software and the USB Core Driver to recognize and configure the device The software implementing the configuration can include the hub driver the device driver and other software WinDriver USB abstracts the configuration procedure and hardware access described above for the developer With WinDriver s USB API developers can perform all the hardware related operations without having to master the lower level implementation for supporting these operations Jungo Ltd 2005 2010 26 WinDriver USB Overview oO Components You Write E WinDriver Components Your Appl
61. WD_NO_EVENTS No events WD_INVALID_PARAMETER Invalid parameter WD_INCORRECT_VERSION WD_TRY_AGAIN Incorrect WinDriver version installed Try again WD_INVALID_IOCTL Received an invalid IOCTL WD_OPERATION_FAILED Operation failed WD_INVALID_32BIT_APP Received an invalid 32 bit IOCTL WD_TOO_MANY_HANDLES No room to add handle WD_NO_DEVICE_OBJECT Driver not installed B 8 3 Status Codes Returned by USBD The following WinDriver status codes comply with USBD_XXX status codes returned by the USB stack drivers Status Code USBD Status Types Description WD_USBD_STATUS_SUCCESS USBD Success WD_USBD_STATUS_PENDING USBD Operation pending WD_USBD_STATUS_ERROR USBD Error WD_USBD_STATUS_HALTED USBD Halted USBD Status Codes NOTE The status codes consist of one of the status types above and an error code i e OXXYYYYYYYL where X status type and YYYYYYY error code The same error codes may also appear with one of the other status types as well Status type HC Host Controller Status Codes NOTE These use the WD_USBD_STATUS_HALTED WD_USBD_STATUS_CRC HC status CRC WD_USBD_STATUS_BTSTUFF HC status Bit stuffing WD_USBD_STATUS_DATA_TOGGLE_MISMATCH HC status Data toggle mismatch WD_USBD_STATUS_STALL_PID HC status PID stall WD_USBD_STATUS_DEV_NOT_RESPONDING WD_USBD_STATUS_PID_CHECK_FAILURE HC
62. WinDriver USB User s Manual Version 10 2 0 Jungo Ltd WinDriver USB User s Manual Version 10 2 0 Copyright Jungo Ltd 2005 2010 All Rights Reserved Information in this document is subject to change without notice The software described in this document is furnished under a license agreement The software may be used copied or distributed only in accordance with that agreement No part of this publication may be reproduced stored in a retrieval system or transmitted in any form or any means electronically or mechanically including photocopying and recording for any purpose without the written permission of Jungo Ltd Brand and product names mentioned in this document are trademarks of their respective owners and are used here only for identification purposes Jungo Ltd 2005 2010 Table of Contents 1 Wan Driver EE 1 1 1 Introduction to WinDIiver cccccccccccccceesessssseceeeceescsesssecececcesesesesseaececeeseeeeensasaeeeeees 1 1 2 TEE 2 1 2 1 The E 2 1 2 2 The WinDriver e e EE 2 13s ee EE 3 l4 WinbDriver Benefits pcnsis ssia is tba e a ar N aa AR S 3 L WinDriver Architecture sorsia ee aiae a iaae iriiria 4 1 6 What Platforms Does WinDriver Support s cc ciessccccstssscsstusecasceauedescsestensccevscdesdeseedeeeuee 5 1 7 Limitations of the Different Evaluation Versions cc ccccccccceceesessssecececeeeesessnseeeeeeees 5 1 8 How Do I Develop My Driver with WinDriver A 6 1 8
63. Windows CE platforms including Windows Mobile The following instructions apply to driver developers who do not build the Windows CE kernel but only download their drivers built using Microsoft eMbedded Visual C Windows CE 4 x 5 x or MSDEV NET 2005 2008 Windows Mobile or Windows CE 6 x to a ready made Windows CE platform 1 Insert the WinDriver CD into your Windows host CD drive 2 Exit the automatic installation 3 Copy WinDriver s kernel module windrvr6 dll from the WinDriver redist WINCE lt TARGET_CPU gt directory on the Windows host development PC to the Windows directory on your target Windows CE platform 4 Add WinDriver to the list of device drivers Windows CE loads on boot e Modify the registry according to the entries documented in the file WinDriver samples wince_install project_wd reg This can be done using the Windows CE Pocket Registry Editor on the hand held CE computer or by using the Remote CE Registry Editor Tool supplied with MS eMbedded Visual C Windows CE 4 x 5 x MSDEV NET 2005 2008 Windows Mobile or Windows CE 6 x Note that in order to use the Remote Jungo Ltd 2005 2010 32 Installing WinDriver CE Registry Editor tool you will need to have Windows CE Services installed on your Windows host platform e On Windows Mobile the operating system s security scheme prevents the loading of unsigned drivers at boot time therefore the WinDriver kernel module has to be rel
64. _LOCAL_MACHINE SOFTWARE Microsoft Windows CurrentVersion This registry key is required by Windows Plug and Play in order to properly install drivers using INF files If the RunOnce key is missing create it then try installing the INF file again 12 2 Renaming the WinDriver Kernel Driver The WinDriver APIs are implemented within the WinDriver kernel driver module windrvr6 sys dll o ko depending on the OS which provides the main driver functionality and enables you to code your specific driver logic from the user mode 1 5 On Windows and Linux you can change the name of the WinDriver kernel module to your preferred driver name and then distribute the renamed driver instead of default kernel module Jungo Ltd 2005 2010 93 Driver Installation Advanced Issues windrvr6 sys o ko The following sections explain how to rename the driver for each of the supported operating systems o A renamed WinDriver kernel driver can be installed on the same machine as the original kernel module You can also install multiple renamed WinDriver drivers on the same machine simultaneously Try to give your driver a unique name in order to avoid a potenial conflict with other drivers on the target machine on which your driver will be installed 12 2 1 Windows Driver Renaming DriverWizard automates most of the work of renaming the Windows WinDriver kernel driver windrvr6 sys Renaming the signed windrvr6 s
65. ag with kernel source lt pathb gt to the configure script The lt path gt is the full path to the kernel source directory e g usr src linux If the Linux kernel is version 2 6 26 or higher configure generates makefiles that use kbuild to compile the kernel modules You can force the use of kbuild on earlier versions of Linux by passing the enable kbuild flag to configure b lt WinDriver directory gt redist make c Become super user lt WinDriver directory gt redist su d Install the driver lt WinDriver directory gt redist make install 6 Create a symbolic link so that you can easily launch the DriverWizard GUI ln s lt path to WinDriver gt wizard wdwizard usr bin wdwizard 7 Change the read and execute permissions on the file wdwizard so that ordinary users can access this program 8 Change the user and group IDs and give read write permissions to the device file dev windrvr6 depending on how you wish to allow users to access hardware through the device If you are using a Linux 2 6 x kernel that has the udev file system change the permissions by modifying your etc udev permissions d 50 udev permissions file For example add the following line to provide read and write permissions windrvr6 root root 0666 Otherwise use the chmod command for example chmod 666 dev windrvr6 9 Define a new WD_BASEDTIR environment variable and set it to point to the location of your WinDriver directory
66. al C Windows CE 4 x 5 x MSDEV NET 2005 2008 Windows Mobile or Windows CE 6 x Note that in order to use the Remote CE Registry Editor tool you will need to have Windows CE Services installed on your Windows host platform e On Windows Mobile the operating system s security scheme prevents the loading of unsigned drivers at boot time therefore the WinDriver kernel module has to be reloaded after boot To load WinDriver on the target Windows Mobile platform every time the OS is started copy the WinDriver redist Windows_Mobile_5_ARMV4l wdreg exe utility to the Windows StartUp directory on the target PC 3 Restart your target CE computer The WinDriver CE kernel will automatically load You will have to do a warm reset rather than just suspend resume use the reset or power button on your target CE computer 4 Install your hardware control application DLL on the target If your hardware control application DLL uses wdapil1020 dll as is the case for the sample and generated DriverWizard WinDriver projects also copy this DLL from the WinDriver redist WINCE lt TARGET_CPU gt directory on the development PC to the target s Windows directory Jungo Ltd 2005 2010 87 Distributing Your Driver 11 4 Linux Driver Distribution ui The Linux kernel is continuously under development and kernel data structures are subject to frequent changes To support such a dynamic development environment and still have kernel stabi
67. am f Blocking TRUE see WDU_St reamOpen the call to this function is blocked until the entire data is written to the stream or until the stream s attempt to write to the device times out i e the timeout period for transfers between the stream and the device as set in the dwRxTxTimeout WDU_St reamOpen parameter B 4 9 1 expires For a non blocking stream f Blocking FALSE the function writes as much data as currently possible to the stream s data buffer and returns immediately For both blocking and non blocking transfers the function returns the amount of bytes that were actually written to the stream within the pdwBytesWritten parameter Jungo Ltd 2005 2010 127 PROTOTYPE DWORD DLLCALLCONV WDU_StreamWrite HANDLE hStream COnsr TEVOTDIPBUCESE DWORD bytes DWORD pdwBytesWritten PARAMETERS Name Type Input Output hStream WDU_STREAM_HANDLE Input pBuffer const PVOID Input bytes DWORD Input pdwBytesWritten DWORD Output DESCRIPTION Name Description hStream A unique identifier for the stream as returned by WDU_St reamOpen pBuffer Pointer to a data buffer containing the data to write to the stream bytes Number of bytes to write to the stream pdwBytesWritten Pointer to a value indicating the number of bytes actually written to the stream RETURN VALUE Returns WO_STATUS_SUCCESS 0 on success or an appropriate error code oth
68. and high speed devices but not by low speed devices Bulk transfer is non periodic large packet bursty communication Bulk transfer allows access to the bus on an as available basis guarantees the data transfer but not the latency and provides an error check mechanism with retries attempts If part of the USB bandwidth is not being used for other transfers the system will use it for bulk transfer Like the other stream pipes isochronous and interrupt the bulk pipe is also unidirectional so bi directional transfers require two endpoints The maximum packet size for bulk endpoints can be 8 16 32 or 64 bytes for full speed devices and 512 bytes for high speed devices 3 7 USB Configuration Before the USB function or functions in a compound device can be operated the device must be configured The host does the configuring by acquiring the configuration information from the USB device USB devices report their attributes by descriptors A descriptor is the defined structure and format in which the data is transferred A complete description of the USB descriptors can be found in Chapter 9 of the USB Specification see http www usb org for the full specification It is best to view the USB descriptors as a hierarchical structure with four levels e The Device level e The Configuration level e The Interface level this level may include an optional sub level called Alternate Setting e The Endpoint level There is onl
69. and name the new image NK BIN 6 Download your new kernel to the target platform and initialize it either by selecting Download Initialize from the Target menu or by using a floppy disk 7 Restart your target CE platform The WinDriver CE kernel will automatically load 8 Install your hardware control application DLL on the target If your hardware control application DLL uses wdapi1020 dll as is the case for the sample and generated DriverWizard WinDriver projects also copy this DLL from the WinDriver Jungo Ltd 2005 2010 86 Distributing Your Driver redist WINCE lt TARGET_CPU gt directory on the Windows host development PC to the target s Windows directory 11 3 2 Distribution to Windows CE Computers _ Unless otherwise specified Windows CE references in this section include all supported Windows CE platforms including Windows Mobile E 1 Copy WinDriver s kernel module windrvr6 dll from the WinDriver redist WINCE lt TARGET_CPU gt directory on the Windows host development PC to the Windows directory on your target Windows CE platform 2 Add WinDriver to the list of device drivers Windows CE loads on boot e Modify the registry according to the entries documented in the file WinDriver samples wince_install project_wd reg This can be done using the Windows CE Pocket Registry Editor on the hand held CE computer or by using the Remote CE Registry Editor Tool supplied with MS eMbedded Visu
70. as its own set of specialized commands that only its driver knows In contrast most programs access devices by using generic commands The driver therefore accepts generic commands from a program and then translates them into specialized commands for the device 2 2 Classification of Drivers According to Functionality There are numerous driver types differing in their functionality This subsection briefly describes three of the most common driver types 2 2 1 Monolithic Drivers Monolithic drivers are device drivers that embody all the functionality needed to support a hardware device A monolithic driver is accessed by one or more user applications and directly drives a hardware device The driver communicates with the application through I O control commands IOCTLs and drives the hardware using calls to the different WDK ETK DDI DKI functions Jungo Ltd 2005 2010 10 Understanding Device Drivers Application User Mode EKemel Mode Figure 2 1 Monolithic Drivers Monolithic drivers are supported in all operating systems including all Windows platforms and all Unix platforms 2 2 2 Layered Drivers Layered drivers are device drivers that are part of a stack of device drivers that together process an I O request An example of a layered driver is a driver that intercepts calls to the disk and encrypts decrypts all data being transferred to from the disk In this example a driver would be hooked on to the top of
71. asing WinDriver Fill in the order form found in Start WinDriver Order Form on your Windows start menu and send it to Jungo via email fax or mail see details below Your WinDriver package will be sent to you via courier or registered mail The WinDriver license string will be emailed to you immediately Email Web Site Sales Information sales jungo com http www jungo com License Registration wd_license jungo com Phone Fax Worldwide 972 74 721 2121 Worldwide 972 74 721 2122 USA toll free 1 877 514 0537 USA toll free 1 877 514 0538 France toll free 33 800 908 062 Mailing Address Jungo Ltd 1 Hamachshev St P O Box 8493 Netanya 42504 Israel Jungo Ltd 2005 2010 173 Appendix F Distributing Your Driver Legal Issues WinDriver is licensed per seat The WinDriver license allows one developer on a single computer to develop an unlimited number of device drivers and to freely distribute the created drivers without royalties as outlined in the license agreement in the WinDriver docs license pdf file Jungo Ltd 2005 2010 174 Appendix G Additional Documentation Updated Manuals The most updated WinDriver user manuals can be found on Jungo s site at http www jungo com st support support_windriver html Version History If you wish to view WinDriver version history refer to the WinDriver Release Notes http www jungo com st wdver html The release notes include a
72. bNumSupportedLangIDs WDU_LANGID pLangIDs BYTE bNumLangIDs PARAMETERS Name Type Input Output hDevice WDU_DEVICE_HANDLE Input pbNumSupportedLangIDs PBYTE Output pLangIDs WDU_LANGID Output bNumLangIDs BYTE Input DESCRIPTION Name Description hDevice A unique identifier for the device interface pbNumSupportedLangIDs Parameter to receive number of supported language IDs pLangIDs Array of language IDs If bNumLangIDs is not zero the function will fill this array with the supported language IDs for the device bNumLangIDs Number of IDs in the pLangIDs array RETURN VALUE Returns WO_STATUS_SUCCESS 0 on success or an appropriate error code otherwise B 8 REMARKS e If dwNumLangIDs is zero the function will return only the number of supported language IDs in pbNumSupportedLangIDs but will not update the language IDs array pLangIDs Jungo Ltd 2005 2010 135 with the actual IDs For this usage pLangIDs can be NULL since it is not referenced but pbNumSupportedLangIDs must not be NULL e pbNumSupportedLangIDs can be NULL if the user only wants to receive the list of supported language IDs and not the number of supported IDs In this case bNumLangIDs cannot be zero and pLangIDs cannot be NULL e If the device does not support any language IDs the function will return success The caller should therefore check the value of pbNumS
73. cating With Dryers eege ee 15 3 WinDriver USB OvervieW enres e r e d a aaa anei iaa a iaa 17 3 1 Introduction to USB orero uri inssi dais ders A A aa aaa a 17 3 2 WinDriver USB Benefits 00 cccccssssssccecececeesensnsececeseceesessssnaecesecceseseseaeaeeeseesesenes 18 3 23 USB COMI OMENS E 18 3 4 Data Fl w in USB DEVICES ncns aeaea iaaea i EEE 19 Dee USB Eeer 20 3 6 USB Data KE 21 3 6 1 Control Transfet serden a a a Aa sas EE N A A N 21 3 6 2 ISOCHTONOUS Transfer 2 cs3 cisscdecscuadgessis davisdhadeessssduue i a a e an i de 22 D3 Interrupt Transfer ee ee Ee 22 3 6 4 Bulk Transfer ees eege derer dE 23 Ded US BC OT E 23 3 8 WinDriyer USB saneren a a e a Rear e aaa aa 25 Jungo Ltd 2005 2010 iii 3 9 WinDriver USB Architecture cc cece ceeeccccccescccccsseccccesscccecsesccecausecceaasceceuaeeseeeans 26 3 10 Which Drivers Can I Write with WinDriver USB oe eee eeeeceeeeeeeeenaeenteeteeee 27 4 Installing W UAV eege ege eeneg 28 ENEE 28 4 1 1 Windows System Requirements 625 2sccssocencseeceosenseasscesnocsdueseacuoucecnesduerebonteesees 28 4 1 2 Windows CE System Requirements 4 ccc cc ciecsassseessdesaqeesaessseceeaseaeteassseesvesseiees 28 4 1 3 Linux System Requirements seseseseseeseeserssesreeseesrrsrreserserreesresesernsressesseesreset 29 4 2 WinDriver Installation Process eeseeeseseesesseesesressessesressteerestenserstestesseesresereseeseeseresre 29 4 2 1 Windows WinDriver Installation In
74. ce A unique identifier for the device interface dwInterfaceNum The interface s number dwAlternateSetting The desired alternate setting value RETURN VALUE Returns WO_STATUS_SUCCESS 0 on success or an appropriate error code otherwise B 8 REMARKS e On Windows CE as opposed to Windows 7 Vista Server 2008 Server 2003 XP 2000 WI DU Ger nterface attempts to open all the pipes of the specified alternate setting even if not all pipes are currently required The reason for this is that Windows CE limits the total number of pipes that can be opened simultaneously on a device to 16 see http msdn microsoft com en us library ms919318 aspx By opening all the pipes the driver ensures that the pipes will be available for use when needed Jungo Ltd 2005 2010 114 The pipes are opened using the Windows CE USB host controller driver s LPOPEN_PIPE callback On some Mobile devices the call to this callback fails causing WDU_Set Interface to fail as well To resolve such problems upgrade the device s USB host controller driver B 4 3 WDU_ GetDeviceAddr PURPOSE e Gets the USB address for a given device PROTOTYPE DWORD WDU_GetDeviceAdadr WDU_DEVICE_HANDLE hDevice ULONG pAddress PARAMETERS Name Type Input Output hDevice WDU_DEVICE_HANDLE Input pAddress ULONG Output DESCRIPTION Name Description hDevice A
75. compiled with the same header files that the kernel itself was compiled with Since WinDriver installs kernel modules it must compile with the header files of the Linux kernel during the installation process Therefore before you install WinDriver for Linux verify that the Linux source code and the file versions h are installed on your machine Install the Linux kernel source code e If you have yet to install Linux install it including the kernel source code by following the instructions for your Linux distribution e If Linux is already installed on your machine check whether the Linux source code was installed You can do this by looking for linux in the usr sre directory If the source code Jungo Ltd 2005 2010 33 Installing WinDriver is not installed either install it or reinstall Linux with the source code by following the instructions for your Linux distribution Install version h e The file version h is created when you first compile the Linux kernel source code Some distributions provide a compiled kernel without the file version h Look under usr sre linux include linux to see if you have this file If you do not please follow these steps 1 Become super user su 2 Change directory to the Linux source directory cd usr src linux 3 Type make xconfig 4 Save the configuration by choosing Save and Exit 5 Type make dep To run GUI WinDriver applications e g DriverWi
76. cription pData Pointer to an additional debug information structure e dwLevel Assigns the level in the Debug Monitor in which the data will be declared If dwLevel is zero D_ERROR will be declared For more details please refer to DEBUG_LEVEL in windrvr h e dwSection Assigns the section in the Debug Monitor in which the data will be declared If dwSection is zero S_MISC section will be declared For more details please refer to DEBUG_SECTION in windrvr h e pcBuffer The string to copy into the message log RETURN VALUE Returns WO_STATUS_SUCCESS 0 on success or an appropriate error code otherwise B 8 EXAMPLE WD_DEBUG_ADD add BZERO add add dwLevel D_WARN add dwSection S_MISC sprinec add EE This message will be displayed in the Debug Monitor n WD_DebugAdd hwWD amp add B 6 7 WD_DebugDump PURPOSE e Retrieves debug messages buffer PROTOTYPE DWORD WD_DebugDump HANDLE hWD WD_DEBUG_DUMP pDebugDump PARAMETERS Name Type Input Output hWD HANDLE Input pDebug WD_DEBUG_DUMP Input e pcBuffer PCHAR Input Output Jungo Ltd 2005 2010 150 Name Type Input Output e dwSize DWORD Input DESCRIPTION Name Description hWD Handle to WinDriver s kernel mode driver as received from WD_Open B 6 2 pDebugDump Pointer to a debug dump information struct
77. d to create an INF file for your USB device refer to section 12 1 1 of the manual For detailed information on creation of INF files with DriverWizard refer to section 5 2 see specifically step 3 With WinDriver USB all development is done in the user mode using familiar development and debugging tools and your favorite compiler such as MSDEV Visual C C MSDEV NET Borland C Builder Borland Delphi Visual Basic 6 0 MS eMbedded Visual C MS Platform Builder C or GCC Jungo Ltd 2005 2010 25 WinDriver USB Overview For more information regarding implementation of USB transfers with WinDriver refer to Chapter 9 of the manual 3 9 WinDriver USB Architecture To access your hardware your application calls the WinDriver kernel module using functions from the WinDriver USB API The high level functions utilize the low level functions which use IOCTLs to enable communication between the WinDriver kernel module and your user mode application The WinDriver kernel module accesses your USB device resources through the native operating system calls There are two layers responsible for abstracting the USB device to the USB device driver The upper layer is the USB Driver USBD layer which includes the USB Hub Driver and the USB Core Driver The lower level is the Host Controller Driver HCD layer The division of duties between the HCD and USBD layers is not defined and is operating system dependent Both the HCD and
78. d user mode APIs You can also use WinDriver APIs to send your own debug messages to the Debug Monitor log e Use DriverWizard to validate your device s USB configuration and test the communication with the device 7 2 Debug Monitor Debug Monitor is a powerful graphical and console mode tool for monitoring all activities handled by the WinDriver kernel You can use this tool to monitor how each command sent to the kernel is executed In addition WinDriver enables you to print your own debug messages to the Debug Monitor using the WD_DebugAdd function B 6 6 or the high level PrintDbgMessage function B 7 14 The Debug Monitor comes in two versions e wddebug_gui 7 2 1 a GUI version for Windows 7 Vista Server 2008 Server 2003 XP 2000 and Linux e wddebug 7 2 2 a console mode version for Windows Windows CE and Linux on Windows CE wddebug also supports GUI execution Both Debug Monitor versions are provided in the WinDriver util directory 7 2 1 The wddebug_gui Utility wddebug_gui is a fully graphical GUI version of the Debug Monitor utility for Windows 7 Vista Server 2008 Server 2003 XP 2000 and Linux Jungo Ltd 2005 2010 58 Debugging Drivers 1 Run the Debug Monitor using either of the following methods e Run WinDriver util wddebug_gui e Run the Debug Monitor from DriverWizard s Tools menu e On Windows run Start Programs WinDriver Debug Monitor B WinDriver Debug
79. destroyed a opens a file for writing at the end of the file 1 e append RETURN VALUE Returns WO_STATUS_SUCCESS 0 on success or an appropriate error code otherwise B 8 REMARKS e Once a log file is opened all API calls are logged in this file You may add your own printouts to the log file by calling WI B 7 16 WD_LogStop PURPOSE e Closes a log file PROTOTYPE VOID WD_LogStop void RETURN VALUE None B 7 17 WD_LogAdd PURPOSE D_LogAddQ B 7 17 Jungo Ltd 2005 2010 163 e Adds user printouts into log file PROTOTYPE VOID DLLCALLCONV WD_LogAdd const char sFormat m argument eck PARAMETERS Name Type Input Output sFormat const char Input argument Input DESCRIPTION Name Description sFormat Format control string argument Optional format arguments RETURN VALUE Returns WO_STATUS_SUCCESS 0 on success or an appropriate error code otherwise B 8 Jungo Ltd 2005 2010 164 B 8 WinDriver Status Codes B 8 1 Introduction Most of the WinDriver functions return a status code where zero WD_STATUS_SUCCESS means success and a non zero value means failure The Stat2Str functions can be used to retrieve the status description string for a given status code The status codes and their descriptive strings are listed below B 8 2 Status Codes Returned by WinDriver Status Code Descriptio
80. diagnose your hardware and verify that it is working properly before you start coding You can then proceed to automatically generate source code with the wizard in a variety of languages including Delphi and Visual Basic For more information refer to Chapter 5 and Section 6 4 3 below 6 4 2 Samples Samples for drivers written using the WinDriver API in Delphi or Visual Basic can be found in 1 WinDriver delphi samples 2 WinDriver vb samples Use these samples as a starting point for your own driver Jungo Ltd 2005 2010 56 Developing a Driver 6 4 3 Creating your Driver The method of development in Visual Basic is the same as the method in C using the automatic code generation feature of DriverWizard Your work process should be as follows e Use DriverWizard to easily diagnose your hardware e Verify that it is working properly e Generate your driver code e Integrate the driver into your application e You may find it useful to use the WinDriver samples to get to know the WinDriver API and as your skeletal driver code Jungo Ltd 2005 2010 57 Chapter 7 Debugging Drivers The following sections describe how to debug your hardware access application code 7 1 User Mode Debugging e Since WinDriver is accessed from the user mode we recommend that you first debug your code using your standard debugging software e The Debug Monitor utility 7 2 logs debug messages from WinDriver s kernel mode an
81. ditional flags for determining the license type if dwLicense cannot hold all the relevant information otherwise zero RETURN VALUE Returns WD_STATUS_ REMARKS SUCCESS 0 on success or an appropriate error code otherwise B 8 e When using a registered version this function must be called before any other WinDriver API call apart from WD_Open B 6 2 in order to register the license from the code EXAMPLE Example usage Add registration routine to your application DWORD RegisterWinDriver HANDLE hWD WD_LICENSE lic DWORD dwStatus WD_INVALID_HANDLE Jungo Ltd 2005 2010 153 hWD WD_Open if hWD INVALID_ HANDLE VALUE BARRO amie Replace the following string with your license string strcepy lic cLicense 12345abcde12345 CompanyName dwStatus WD_License hWD amp lic WD_Close hWD return dwStatus B 7 User Mode Utility Functions This section describes a number of user mode utility functions you will find useful for implementing various tasks These utility functions are multi platform implemented on all operating systems supported by WinDriver B 7 1 Stat2Str PURPOSE e Retrieves the status string that corresponds to a status code PROTOTYPE const char Stat2Str DWORD dwStatus PARAMETERS Name Type Input Output dwStatus DWORD Input DE
82. dle to the relevant Jungo Ltd 2005 2010 15 Understanding Device Drivers OS file access functions e g the Windows ReadFile and WriteFile functions or the Linux read and write functions The application sends requests to the driver via I O control IOCTL calls using the custom OS APIs provided for this purpose eg the Windows DeviceIoControl1 function or the Linux ioct1Q function The data passed between the driver and the application via the IOCTL calls is encapsulated using custom OS mechanisms For example on Windows the data is passed via an I O Request Packet IRP structure and is encapsulated by the I O Manager Jungo Ltd 2005 2010 16 Chapter 3 WinDriver USB Overview This chapter explores the basic characteristics of the Universal Serial Bus USB and introduces WinDriver USB s features and architecture 3 1 Introduction to USB USB Universal Serial Bus is an industry standard extension to the PC architecture for attaching peripherals to the computer It was originally developed in 1995 by leading PC and telecommunication industry companies such as Intel Compaq Microsoft and NEC USB was developed to meet several needs among them the needs for an inexpensive and widespread connectivity solution for peripherals in general and for computer telephony integration in particular an easy to use and flexible method of reconfiguring the PC and a solution for adding a large number o
83. dows or windrvr6 o on Linux O e lt command gt The Debug Monitor command to execute e Activation commands s on Turn the Debug Monitor on e off Turn the Debug Monitor off e dbg_on Redirect the debug messages from the Debug Monitor to a kernel debugger and turn the Debug Monitor on if it was not already turned on ES On Windows 7 and Vista the first time that you enable this option you will need to restart the PC e dbg_off Stop redirecting debug messages from the Debug Monitor to a kernel debugger The on and dbg_on commands can be run together with the lt level gt and lt sections gt options described below e dump Continuously display dump debug information until the user selects to stop e status Display information regarding the running lt driver_name gt driver the current Debug Monitor status including the active debug level and sections when the Debug Monitor is on and the size of the debug messages buffer e help Display usage instructions e None You can run wddebug with no arguments including no command On platforms other than Windows CE this is equivalent to running wddebug help On Windows CE running wddebug with no arguments activates the utility s Windows CE GUI version as explained in section 7 2 2 2 Jungo Ltd 2005 2010 62 Debugging Drivers The following options are applicable only to the on and dbg_on commands lt level gt Th
84. dows 98 Me The WinDriver Windows kernel module windrvr6 sys is a fully WDM driver which can be installed using the wdreg utility as explained in the following sections 10 2 2 The wdreg Utility WinDriver provides a utility for dynamically loading and unloading your driver which replaces the slower manual process using Windows Device Manager which can still be used for the device INF This utility is provided in two forms wdreg and wdreg_gui Both versions can be found in the WinDriver util directory can be run from the command line and provide the same functionality The difference is that wdreg_gui displays installation messages graphically while wdreg displays them in console mode Jungo Ltd 2005 2010 77 Dynamically Loading Your Driver This section describes the use of wdreg wdreg_gui on Windows operating systems de 1 wdreg is dependent on the Driver Install Frameworks API DIFxAPI DLL difxapi dll unless when run with the compat option described below difxapi dll is provided under the WinDriver util directory 2 The explanations and examples below refer to wdreg but any references to wdreg can be replaced with wdreg_gui 10 2 2 1 Overview This section explains how to use the wdreg utility to install the WDM windrvr6 sys driver on Windows or to install INF files that register USB devices to work with this driver on Windows 7 Vista Server 2008 Server 2003 XP 2000 You can rename the
85. drvr6 so all you need to do is replace the driver name that is passed to the function in the code with your new driver name 3 Verify that your user mode driver project is built with the WD_DRIVER_NAME_CHANGE preprocessor flag DWD_DRIVER_NAME _ CHANGE Note The sample and generated DriverWizard WinDriver kernel projects makefiles already set this preprocessor flag by default 4 Install your new driver by following the instructions in section 11 4 of the manual using the modified files from the generated xxx_installation directory instead of the installation files from the original WinDriver distribution As part of the installation build your new kernel driver module s by following the instructions in section 11 4 1 using the files from your new installation directory Jungo Ltd 2005 2010 96 Driver Installation Advanced Issues 12 3 Digital Driver Signing and Certification Windows 7 Vista Server 2008 Server 2003 XP 2000 12 3 1 Overview Before distributing your driver you can digitally sign and or certify it either by submitting it to the Microsoft Windows Logo Program for certification and signature or by having the driver Authenticode signed Some Windows operating systems such as Windows XP and below do not require installed drivers to be digitally signed or certified There are however advantages to getting your driver digitally signed or fully certified including the foll
86. drvr6_usb o ko WinDriver USB Linux GPL driver is automatically renamed to lt new driver name gt _usb o ko O References to xxx in this section should be replaced with the name of your generated DriverWizard driver project To rename your Linux WinDriver kernel driver follow these steps 1 Use the DriverWizard utility to generate driver code for your hardware on Linux refer to section 5 2 step 7 using your preferred driver name xxx as the name of the generated driver project The generated project directory xxx will include an xxx_installation directory with the following files and directories e redist directory This directory contains copies of the files from the original WinDriver redist installation directory but with the required modifications for building your xxx 0 Ko driver instead of windrvr6 0 ko e lib and include directories Copies of the library and include directories from the original WinDriver distribution These copies are created since the supported Linux WinDriver kernel driver build method relies on the existence of these directories directly under the same parent directory as the redist directory 2 Verify that your user mode application calls the WO_DriverName function B 1 with your new driver name before calling any other WinDriver function Note that the sample and generated DriverWizard WinDriver applications already include a call to this function but with the default driver name win
87. e signature s validity this file must be found in the same installation directory as the windrvr6 inf file If you select to distribute the catalog and INF files in different directories or make any changes to these files or to any other files referred to by the catalog file such as windrvr6 sys you will need to do either of the following Create a new catalog file and re sign the driver using this file Comment out or remove the following line in the windrvr6 inf file CatalogFile wd1020 cat and do not include the catalog file in your driver distribution However note that this option invalidates the driver s digital signature For more information regarding driver digital signing and certification and the signing of your WinDriver based driver refer to section 12 3 of the manual 2 Use the utility wdreg to install WinDriver s kernel module on the target computer wdreg inf lt path to windrvr6 inf gt install For example if windrvr6 inf and windrvr6 sys are in the d MyDevice directory on the target computer the command should be wdreg inf d MyDevice windrvr6 inf install You can find the executable of wdreg in the WinDriver package under the WinDriver util directory For a general description of this utility and its usage please refer to Chapter 10 CA e wdreg is dependent on the difxapi dll DLL e wdreg is an interactive utility If it fails it will display a message instructing the user how to overcome the pr
88. e The NDIS miniport driver is one example of such a driver The NDIS miniport framework is used to create network drivers that hook up to NT s communication stacks and are therefore accessible to common communication calls used by applications The Windows NT kernel provides drivers for the various communication stacks and other code that is common to communication cards Due to the NDIS framework the network card developer does not have to write all of this code only the code that is specific to the network card he is developing Jungo Ltd 2005 2010 13 Understanding Device Drivers 2 3 Classification of Drivers According to Operating Systems 2 3 1 WDM Drivers WDM Windows Driver Model drivers are kernel mode drivers within the Windows NT and Windows 98 operating system families The Windows NT family includes Windows 7 Vista Server 2008 Server 2003 XP 2000 NT 4 0 and the Windows 98 family includes Windows 98 and Windows Me WDM works by channeling some of the work of the device driver into portions of the code that are integrated into the operating system These portions of code handle all of the low level buffer management including DMA and Plug and Play Pnp device enumeration WDM drivers are PnP drivers that support power management protocols and include monolithic drivers layered drivers and miniport drivers 2 3 2 VxD Drivers VxD drivers are Windows 95 98 Me Virtual Device Drivers often called VxDs because t
89. e An evaluation message is displayed on every interaction with the hardware using DriverWizard e WinDriver will function for only 30 days after the original installation D 2 Windows CE WinDriver Evaluation Limitations e Each time WinDriver is activated an Unregistered message appears e The WinDriver CE Kernel windrvr6 dll will operate for no more than 60 minutes at a time e DriverWizard 5 used on a host Windows 7 Vista Server 2008 Server 2003 XP 2000 PC e Each time DriverWizard is activated an Unregistered message appears e An evaluation message is displayed on every interaction with the hardware using DriverWizard D 3 Linux WinDriver Evaluation Limitations e Each time WinDriver is activated an Unregistered message appears e DriverWizard 5 Jungo Ltd 2005 2010 171 e Each time DriverWizard is activated an Unregistered message appears e An evaluation message is displayed on every interaction with the hardware using Driver Wizard e WinDriver s kernel module will work for no more than 60 minutes at a time To continue working the WinDriver kernel module must be reloaded unload and load the module using the following commands A The following commands must be executed with root privileges To unload sbin modprobe r windrvr6 To load lt path to wdreg gt windrvr6 wdreg is provided in the WinDriver util directory Jungo Ltd 2005 2010 172 Appendix E Purch
90. e debug trace level to set The level can be set to either of the following flags ERROR WARN INFO or TRACE where ERROR is the lowest trace level and TRACE is the highest level displays all messages The default debug trace level is ERROR lt sections gt The debug sections to set The debug sections determine what part of the WinDriver API you would like to monitor For a full list of all supported debug sections run wddebug help to view the utility s usage instructions The default debug sections flag is ALL sets all the supported debug sections Usage Sequence To log messages using wddebug use this sequence Turn on the Debug Monitor by running wddebug with either the on command or the dbg_on command which redirects the debug messages to a kernel debugger before turning on the Debug Monitor You can use the level and or sections flags to set the debug level and or sections for the log If these options are not explicitly set the default values will be used You can also log messages from a renamed WinDriver driver by preceding the command with the name of the driver see the lt driver_name gt option above The default driver name is windrvr6 Run wddebug with the dump command to begin dumping debug messages to the command prompt You can turn off the display of the debug messages at any time by following the instructions displayed in the command prompt Run applications that use the driver and view the debug
91. e detected devices below or choose ISA card For non Plug and Play cards Type Description vendor Refresh devices list PCI PCI Virtual Device ISA ISA Device ISA Device SE ISA Parallel Port ISA Device PCI SiS SiS648MX Host to PCI Bridge EIS b PCI SiS SiS760 Virtual PCI to PCI Bridge AGP sis ATI 01541014 Rage P M Mobility AGP 2x ATI PCI SiS SiS964 LPC Bridge sis Fels SiS SiS5513 PCI IDE Controller sis PCI SiS SiS7012 PCI Audio Accelerator sis PCI SiS 5i55571 USB Host Controller sis PCI SiS SiS5S71 USB Host Controller sis PCI SiS SiS5S571 USB Host Controller sis H PCI SiS SiS7002 USB 2 0 Enhanced Host Controller conductor Corp Product ID 1003 Cypri Semiconductor Corp PCI SiS SiS900 Fast Ethernet Home Networking Ctrlr PCI Realtek RTL81394 B C Fast Ethernet Adapter Realtek PCI PLX PCI S6S56RDK Lite PCI Rapid Development Kit for P PLX Uninstall INF file Device Description Hardware ID Vendor 04b4 Product 1003 Driver WinDriver6 bat_test_04b4_1003 Figure 5 2 Select Your Device 3 Generate an INF file for DriverWizard On Windows 7 Vista Server 2008 Server 2003 XP 2000 the driver for Plug and Play devices such as USB is installed by installing an INF file for the device DriverWizard enables you to generate an INF file that registers your device to work with WinDriver i e with the windrvr6 sys driver The INF file generated by DriverWizard sh
92. e drivers are linked with the kernel and the system is brought down and restarted after installing a new driver Linux introduces the concept of a dynamically loadable driver called a module Linux modules can be loaded or removed dynamically without requiring the system to be shut down A Linux driver can be written so that it is statically linked or written in a modular form that allows it to be dynamically loaded This makes Linux memory usage very efficient because modules can be written to probe for their own hardware and unload themselves if they cannot find the hardware they are looking for Like Unix device drivers Linux device drivers are either layered or monolithic drivers 2 4 The Entry Point of the Driver Every device driver must have one main entry point like the main function in a C console application This entry point is called DriverEntry in Windows and init_module in Linux When the operating system loads the device driver this driver entry procedure is called There is some global initialization that every driver needs to perform only once when it is loaded for the first time This global initialization is the responsibility of the DriverEntry init_module routine The entry function also registers which driver callbacks will be called by the operating system These driver callbacks are operating system requests for services from the driver In Windows these callbacks are called dispatch routines and in Linux the
93. e expense and stress of in house testing Jungo prepares a WHQL submission package containing the test results and delivers the package to the customer ready for submission to Microsoft For more information refer to http www jungo com st whql_certification html For detailed information regarding the WHQL certification process refer to the following Microsoft web pages e WHQL home page http www microsoft com whdc whq default mspx e WHQL Policies page http www microsoft com whdc whql policies default mspx e Windows Quality Online Services Winqual home page https winqual microsoft com e Winqual help https winqual microsoft com Help e WHQL tests procedures and forms download page http www microsoft com whdc whql WHQLdwn mspx e Windows Driver Kit WDK Jungo Ltd 2005 2010 98 Driver Installation Advanced Issues http www microsoft com whdc devtools wdk default mspx e Driver Test Manager DTM http www microsoft com whdc DevTools WDK DTM mspx Note Some of the links require Windows Internet Explorer dn 12 3 2 Driver Signing and Certification of WinDriver Based Drivers As indicated above 12 3 1 1 The WinDriver redist windrvr6 sys driver has an Authenticode signature Since WinDriver s kernel module windrvr6 sys is a generic driver which can be used as a driver for different types of hardware devices it cannot be submitted as a stand alone driver for WH
94. e to your target platform using a floppy disk However if you prefer to have the file windrvr6 dll loaded on demand via the CESH PPSH services you need to perform the manual integration method described in step 4 instead of performing the procedure described in the present step a Run the Windows CE IDE and open your platform b From the File menu select Manage Catalog Items and then click the Import button and select the WinDriver cec file from the relevant WinDriver samples wince_install lt TARGET_CPU gt directory eg WinDriver samples wince_install ARMV4I This will add a WinDriver component to the Platform Builder Catalog c In the Catalog view right click the mouse on the WinDriver Component node in the Third Party tree and select Add to OS design 3 Compile your Windows CE platform Sysgen stage 4 If you did not perform the procedure described in step 2 above perform the following steps after the Sysgen stage in order to manually integrate the driver into your platform Note If you followed the procedure described in step 2 skip this step and go directly to step 5 a Run the Windows CE IDE and open your platform b Select Open Release Directory from the Build menu c Copy the WinDriver CE kernel file WinDriver redist lt TARGET_CPU windrvr6 dll to the _FLATRELEASEDIR sub directory on the target development platform should be the current directory in the new command window d Append the contents
95. e wddebug BEE 61 7 2 2 1 Console Mode wddebug Execution c cccccecsecceeesseceesesseeeeeeseaeeeenes 61 7 2 2 2 Windows CE GUI wddebug Execution 00 0 0 cccecceceeesteeeeeeneeeenees 64 8 Enhanced Support for Specific Chipsets ose geesuugsetgetueegeerg Zeeche EE 66 Peet AN EY Th WNC acta beeen ss ea ec ee eee esc E eae es eae ad 66 8 2 Developing a Driver Using the Enhanced Chipset Support 66 OPN KEE 67 ON E 67 9 2 BEE 68 9 2 1 USB Control Transfers Overview scccsncssacusseastoceacsneastvespouiandsonsssenpgonsxcsengiedendusens 68 9 2 1 1 RE 68 9 2 1 2 More About the Control Transfer se 21csiscssieascecascsuacsecersnavendanesaedensesesceszs 68 9 2 1 3 The Setup Packet E 69 9 2 1 4 USB Setup Packet Form t egteterieghgeeerseege regeert ggeg 69 9 2 1 5 Standard Device Request DEIER beggen eegener 70 9 2 1 6 Setup Packet Example siesenssssesssssssssessesossessssisersesesiseosesaansisscssssedeess 70 9 2 2 Performing Control Transfers with WinDriver eeeseesseseesseseresrrersrrsrrerrrsrreeee 71 9 2 2 1 Control Transfers with DriverWi1zard A 71 9 2 2 2 Control Transfers with WinDriver API A 13 9 3 Functional USB RK 74 9 3 1 Functional USB Data Transfers Overview ccseccsecceeeceeenteeceteeecetneesoneens 74 9 3 2 Single e NK 74 9 3 2 1 Performing Single Blocking Transfers with WinDrivet eee 74 9 3 3 Streaming Data Transfers eegene 74 9 3 3 1 Performing Streaming with WinDriver 00
96. ed USB Product ID to detect as assigned by the product manufacturer Jungo Ltd 2005 2010 139 Field Type Description bDeviceClass BYTE The device s class code as assigned by USB IF bDeviceSubClass BYTE The device s sub class code as assigned by USB IF bInterfaceClass BYTE The interface s class code as assigned by USB IF bInterfaceSubClass BYTE The interface s sub class code as assigned by USB IF bInterfaceProtocol BYTE The interface s protocol code as assigned by USB IF B 5 2 2 WDU_ USB events table structure This structure is declared in the WinDriver include wdu_lib h header file EVENT TABLE Structure Field Type Description pfDeviceAttach WOU_ATTACH_CALLBACK Will be called by WinDriver when a device is attached pfDeviceDetach WOU_DETACH_CALLBACK Will be called by WinDriver when a device is detached pfPowerChange WDU_POWER_CHANGE_CALLBACK Will be called by WinDriver when there is a change in a device s power state pUserData PVOID Pointer to user mode data to be passed to the callbacks B 5 2 3 WDU_DEVICE Structure USB device information structure Field Type Description Descriptor WDU_DEVICE_DESCRIPTOR Device descriptor information structure B 5 2 7 PipeO WDU_PIPE_INFO Pipe information structure B 5 2 11 for the device s default pipe Pipe 0 pConfigs WDU_CONFIGURATION P
97. eed to point Windows to the location of the relevant INF file during the installation We recommend using the wdreg utility to install the INF file automatically instead of installing it manually EN If the installation fails with an ERROR_FILE_NOT_FOUND error inspect the Windows bag registry to see if the RunOnce key exists in HKEY_LOCAL_MACHINE SOFTWARE Microsoft Windows CurrentVersion This registry key is required by Windows Plug and Play in order to properly install drivers using INF files If the RunOnce key is missing create it then try installing the INF file again 12 1 3 How Do Replace an Existing Driver Using the INF File i You must have administrative privileges in order to replace a driver 1 On Windows 2000 if you wish to upgrade the driver for USB devices that have been registered to work with earlier versions of WinDriver we recommend that you first delete from the Windows INF directory windir inf any previous INF files for the device to Jungo Ltd 2005 2010 92 Driver Installation Advanced Issues prevent Windows from installing an old INF file in place of the new file that you created Look for files containing your device s vendor and device IDs and delete them 2 Install your INF file You can use the wdreg utility with the install command to automatically install the INF file wdreg inf lt path to INF file gt install For more information refer to 10 2 2 of the manual
98. eloper from the need to study the hardware s specification Applications are binary compatible across Windows 7 Vista Server 2008 Server 2003 XP 2000 Applications are source code compatible across all supported operating systems Windows 7 Vista Server 2008 Server 2003 XP 2000 Windows CE NET Windows Embedded CE v6 00 Windows Mobile 5 0 6 0 and Linux Can be used with common development environments including MSDEV Visual C C MSDEV NET Borland C Builder Borland Delphi Visual Basic 6 0 MS eMbedded Visual C MS Platform Builder C GCC or any other appropriate compiler No WDK ETK DDI or any system level programming knowledge required Supports multiple CPUs Jungo Ltd 2005 2010 3 WinDriver Overview e Includes dynamic driver loader e Comprehensive documentation and help files e Detailed examples in C CH Visual Basic NET Delphi and Visual Basic 6 0 e WHOL certifiable driver Windows e Two months of free technical support e No run time fees or royalties 1 5 WinDriver Architecture Your Application DII Shared Object Your Driver Code WinDriver NET Wrapper API wdapi_dotnet DLL High level WinDriver API wdapi DLL shared object User Mode Kernel Mode Low Level WinDriver API WinDriver Kernel Module windrvr6 sys dll 0 ko HES S ll oO Components You Write ET WinDriver Components Oo OS Comp
99. elopers who use Windows CE 6 x with MSDEV 2005 2008 should skip to the next step refer to step 3 e This procedure provides a convenient method for integrating WinDriver into your Windows CE platform If you select not to use this method you will need to perform the manual integration steps described in step 4 below after the Sysgen stage e The procedure described in this step also adds the WinDriver kernel module windrvr6 dll to your OS image This is a necessary step if you want the WinDriver CE kernel file windrvr6 dll to be a permanent part of the Windows CE image NK BIN which is the case if you select to transfer the file to your target platform using a floppy disk However if you prefer to have the file windrvr6 dll loaded on demand via the CESH PPSH services you need to perform the manual integration method described in step 4 instead of performing the procedure described in the present step Jungo Ltd 2005 2010 85 Distributing Your Driver a Run the Windows CE IDE and open your platform b From the File menu select Manage Catalog Items and then click the Import button and select the WinDriver cec file from the relevant WinDriver samples wince_install lt TARGET_CPU gt directory eg WinDriver samples wince_install ARMV41I This will add a WinDriver component to the Platform Builder Catalog c In the Catalog view right click the mouse on the WinDriver Component node in the Third Party tree and selec
100. emory Hosts Buffers Device Data Pipes Data Transfer Figure 3 1 USB Endpoints A pipe is a logical component that represents an association between an endpoint on the USB device and software on the host Data is moved to and from a device through a pipe A pipe can be either a stream pipe or a message pipe depending on the type of data transfer used in the pipe Stream pipes handle interrupt bulk and isochronous transfers while message pipes support the control transfer type The different USB transfer types are discussed below 3 6 3 5 USB Data Exchange The USB standard supports two kinds of data exchange between a host and a device functional data exchange and control exchange e Functional Data Exchange is used to move data to and from the device There are three types of USB data transfers Bulk Interrupt and Isochronous e Control Exchange is used to determine device identification and configuration requirements and to configure a device and can also be used for other device specific purposes including control of other pipes on the device Control exchange takes place via a control pipe mainly the default Pipe 0 which always exists The control transfer consists of a setup stage in which a setup packet is sent from the host to the device an optional data stage and a status stage Jungo Ltd 2005 2010 20 WinDriver USB Overview Figure 3 2 below depicts a USB device with one bi directional control
101. emoval policy Windows XP and later B 5 2 USB Structures The following figure depicts the structure hierarchy used by WinDriver s USB API The arrays situated in each level of the hierarchy may contain more elements than are depicted in the diagram Arrows are used to represent pointers In the interest of clarity only one structure at each level of the hierarchy is depicted in full detail with all of its elements listed and pointers from it pictured Jungo Ltd 2005 2010 138 WDU_ DEVICE Descriptor Piped i e e e e eg e e sg e e es e es ajat pConfigs 1 2 zl pActiveConfig P pActivelnterface WDU CONFIGURATION WDU CONFIGURATION WDU CONFIGURATION Descriptor dwNumlinterfaces polnterfaces WDU INTERFACE WDU_INTERFACE WDU INTERFACE pAlternateSettings dwNumAltSettings WDU ALTERNATE SETTING WDU_ALTERNATE SETTING WDU ALTERNATE SETTING Descriptor Wl pPipes WDU_ENDPOINT DESCRIPTOR WDU_PIPE_INFO bLength dwNumber bDescriptorType dwMaximumPacketSize bEndpointAddress type bmAttributes direction whaxPacketSize binterval bInterval Figure B 2 WinDriver USB Structures B 5 2 1 WDU_MATCH_TABLE Structure USB match table structure de For all field members if value is set to zero match all Field Type Description wVendorld WORD Required USB Vendor ID to detect as assigned by USB IF E wProductld WORD Requir
102. en modifying the code you can utilize the custom WinDriver API for your specific chip The custom API is typically found under the WinDriver chip_vendor lib directory Jungo Ltd 2005 2010 66 Chapter 9 USB Transfers 9 1 Overview This chapter provides detailed information regarding implementation of USB transfers using WinDriver As explained in section 3 5 the USB standard supports two kinds of data exchange between the host and the device control exchange and functional data exchange The WinDriver APIs enable you to implement both control and functional data transfers Figure 9 1 demonstrates how a device s pipes are displayed in the DriverWizard utility which enables you to perform transfers from a GUI environment Alternate Setting 2 Number of Endpoints 2 Pipe Name Pipe Type Information Control Pipe 1 pipeOxO Control direction in amp out packet size 64 Pipe 00 direction in packet size 512 Functional Pipes Bulk Interrupt Isochronous direction out packet size 512 Figure 9 1 USB Data Exchange Section 9 2 below provides detailed information regarding USB control transfers and how they can be implemented using WinDriver Section 9 3 describes the functional data transfer implementation options provided by WinDriver Jungo Ltd 2005 2010 67 USB Transfers 9 2 USB Control Transfers 9 2 1 USB Control Transfers Overview 9 2 1 1 Con
103. ent wd_files directory or modify its contents unless instructed to so in the following guidelines 1 Modify the dev inf file The windriver sld component depends on the existence of a dev inf file in the wd_files directory The WinDriver installation on your development Windows platform contains a generic WinDriver redist xp_embedded wd_component wd_files dev inf file Use either of the following methods to modify this file to suit your device e Modify the generic dev inf file to describe your device At the very least you must modify the template DeviceList entry and insert your device s hardware type and vendor and product IDs For example for a device with vendor ID 0x1234 and product ID 0x5678 my_dev_usb Install USB VID_1234 amp PID_5678 OR e Create an INF file for your device using DriverWizard refer to section 5 2 step 3 and name it dev inf or use an INF file from one of WinDriver s enhanced support chipsets 8 that suits your card and rename it to dev inf Then copy your dev inf device INF file to the WinDriver redist xp_embedded wd_component wd_files directory 2 Add the WinDriver component to the Windows Embedded Component Database 1 Open the Windows Embedded Component Database Manager DBMegr 2 Click Import 3 Select the WinDriver component Jungo Ltd 2005 2010 101 Driver Installation Advanced Issues WinDriver redist xp_embedded wd_component windriver sld as
104. er from the registry so that it will not load on next boot see note below e enable Enables your driver e disable Disables your driver i e dynamically unloads it but the driver will reload after system boot see note below dn To successfully disable uninstall your driver make sure that there are no open handles to the WinDriver service windrvr6 sys or your renamed driver refer to section 12 2 and that there are no connected and enabled Plug and Play devices that are registered with this service 10 2 3 Dynamically Loading Unloading windrvr6 sys INF Files When using WinDriver you develop a user mode application that controls and accesses your hardware by using the generic windrvr6 sys driver WinDriver s kernel module Therefore you might want to dynamically load and unload the driver windrvr6 sys which you can do using wdreg In addition in WDM compatible operating systems you also need to dynamically load INF files for your Plug and Play devices wdreg enables you to do so automatically on Windows 7 Vista Server 2008 Server 2003 XP 2000 This section includes wdreg usage examples which are based on the detailed description of wdreg contained in the previous section e To start windrvr6 sys on Windows 7 Vista Server 2008 Server 2003 XP 2000 wdreg inf lt path to windrvr6 inf gt install This command loads windrvr6 inf and starts the windrvr6 sys service e To load an INF file named device inf l
105. erate Code toolbar icon or from the Project Generate Code menu b In the Select Code Generation Options dialogue box that will appear choose the code language and development environment s for the generated code and select Next to generate the code Select Code Generation Options In which language do you want your code to be generated ANSI C v Generate project makefile for C MS Developer Studio 6 5 C MS Developer Studio MET 2003 E MS Developer Studio NET 2005 for X86 C MS Developer Studio NET 2005 for AMD64 C MS Developer Studio NET 2005 for Windows Mobile 5 C MS Developer Studio NET 2008 for X86 C MS Developer Studio NET 2008 for AMD64 C MS Developer Studio MET 2008 For Windows Mobile 5 C Microsoft eMbdedded Visual C for CE TT Microsoft Platform Builder C for CE C Borlad C Builder 3 TT Borlad C Builder 4 6 C Linux Makefile IDE to Invoke None Figure 5 10 Code Generation Options c Save your project if required and click OK to open your development environment with the generated driver d Close DriverWizard 8 Compile and run the generated code e Use this code as a starting point for your device driver Modify where needed to perform your driver s specific functionality e The source code DriverWizard creates can be compiled with any 32 bit compiler and will run on all supported platforms without modification Jungo Ltd 2005 2
106. erwise B 8 B 4 9 5 WDU_StreamFlush PURPOSE e Flushes a write stream i e writes the entire contents of the streame data buffer to the device e Blocks until the completion of all pending I O on the stream fi This function can be called for both blocking and non blocking streams PROTOTYPE Jungo Ltd 2005 2010 128 DWORD DLLCALLCONV WDU_StreamFlush WDU_STREAM_HANDLE hStream PARAMETERS Name Type Input Output hStream WDU_STREAM_HANDLE Input DESCRIPTION Name Description hStream A unique identifier for the stream as returned by WDU_St reamOpen RETURN VALUE Returns WO_STATUS_SUCCESS 0 on success or an appropriate error code otherwise B 8 B 4 9 6 WDU_ StreamGetStatus PURPOSE e Returns a stream s current status PROTOTYPE DWORD DLLCALLCONV WDU_StreamGetStatus WDU_STREAM_HAN DLE hStream BOOL pfIsRunning DWORD pdwLast EGEO DWORD pdwBytesInBuffer PARAMETERS Name Type Input Output hStream WDU_STREAM_HANDLE Input pflsRunning BOOL Output pdwLastError DWORD Output pdwBytesInBuffer DWORD Output DESCRIPTION Jungo Ltd 2005 2010 129 Name Description hStream A unique identifier for the stream as returned by WDU_St reamOpen pflsRunning Pointer to a value indicating the stream s current state e TRUE the stream is currently runn
107. esesesreesesressereresressrseresressrrsrerreeseese 119 e WDU Transfer teste 119 B 4 8 2 WDU I aS BSE voc eeegetere ere eege ebe 120 B 4 8 3 WDU_TransferDefaultPipe eieiei egenen egtieg 121 B 4 8 4 WDU_ TransferBulk woos ccccseesescecccccesssseseseeceeseessuseeesessesseeaes 122 E WV Var SOC EE 122 Jungo Ltd 2005 2010 vi B 4 8 6 WDU_TransferInterrupt es ces ces sete eder Seed teeet eege 123 B 4 9 Streaming Data Transfer Functions 2 cs lt ccccsscusoncssscsssersnacenscenaneueccesseeesneees 123 B 4 9 1 WDU Sie E 124 B 4 9 2 WDU_StreamStart 0 cccccccccccccccceessssssececececeesessnseseceeeceesesensneaeeesees 125 B 4 9 3 WDU_StreamRead o cc ccccccssccccccccecsesssseceeeeeceeseesssnsecececeesesensneaeeeeess 126 B 4 9 4 WDU_StreamWrite E 127 B 4 9 5 WDU_StreamFlush 200 0 ccccececccccccceceesessnsececececeesesensnseeeeescesenesenteaeees 128 B 4 9 6 WDU_StreamGetStatus ccccccccssssssecececceecesssssecececceeceesessseeeseeeens 129 B 4 9 7 WDU_StreamStop oss tcastsa erat naasnansodacenatejaidiesaatet eaeeaesioe teens 130 B 4 9 8 WDU_StreamClose ccccccccccccccecssssssececececeesesesssecececcesceesesseseeeeeesesenes 131 B410 KREE 131 B 4 11 WDU_ResetDevice srren iaaa Er aaa AA ER aE 132 B 4 12 WDU_SelectiveSuspend sssessssosesssssssorsesersessesessesssorsessisesessessersssesosssssssessse 133 BA 13 WDU Wakeup EE 134 B4 14 WDU Eet eege 135 B 4 15 WDU GetString DESC eegeutegseeedesteue
108. etup packet is in Hex format The following setup packet is for a control read transaction that retrieves the device descriptor from the USB device The device descriptor includes information such as USB standard revision vendor ID and product ID GET_DESCRIPTOR Device Setup Packet 80 06 00 O1 00 00 12 00 Jungo Ltd 2005 2010 USB Transfers Setup packet meaning Byte Field Value Description 0 BmRequest Type 80 8h 1000b bit 7 1 gt direction of data is from device to host Oh 0000b bits 0 1 00 gt the recipient is the device 1 bRequest 06 The Request is GET_DESCRIPTOR 2 wValueL 00 3 wValueH 01 The descriptor type is device values defined in USB spec 4 wIndexL 00 The index is not relevant in this setup packet since there is only one device descriptor 5 wIndexH 00 wLengthL 12 Length of the data to be retrieved 18 12h bytes this is the length of the device descriptor 7 wLengthH 00 In response the device sends the device descriptor data A device descriptor of Cypress EZ USB Integrated Circuit is provided as an example Byte No 0 1 2 3 4 5 6 7 8 9 10 Content 12 Ol 00 O1 ff ff ff 40 47 05 80 Byte No 11 12 13 14 15 16 17 Content 00 O1 00 00 00 OO O1 As defined in the USB s
109. evice product ID to locate the file s associated with the device es If the installation fails with an ERROR_FILE_NOT_FOUND error inspect the Windows registry to see if the RunOnce key exists in HKEY_LOCAL_MACHINE SOFTWARE Microsoft Windows CurrentVersion This registry key is required by Windows Plug and Play in order to properly install drivers using INF files If the RunOnce key is missing create it then try installing the INF file again Install wdapil020 dll If your hardware control application DLL uses wdapil1020 dll as is the case for the sample and generated DriverWizard WinDriver projects copy this DLL to the target s windir system32 directory If you are distributing a 32 bit application DLL to a target 64 bit platform A 2 rename wdapil020_32 dll in your distribution package to wdapil020 dll and copy the renamed file to the target s windir sysWOW64 directory ur If you attempt to write a 32 bit installation program that installs a 64 bit program and therefore copies the 64 bit wdapi1020 dll DLL to the windir system32 directory you may find that the file is actually copied to the 32 bit windir sysWOW64 directory The reason for this is that Windows x64 platforms translate references to 64 bit directories from 32 bit commands into references to 32 bit directories You can avoid the problem by using 64 bit commands to perform the necessary installation steps from Jungo Ltd 2005 2010 8
110. f external peripherals The USB standard meets these needs The USB specification allows for the connection of a maximum of 127 peripheral devices including hubs to the system either on the same port or on different ports USB also supports Plug and Play installation and hot swapping The USB 1 1 standard supports both isochronous and asynchronous data transfers and has dual speed data transfer 1 5 Mb s megabits per second for low speed USB devices and 12 Mb s for high speed USB devices much faster than the original serial port Cables connecting the device to the PC can be up to five meters 16 4 feet long USB includes built in power distribution for low power devices and can provide limited power up to 500 mA of current to devices attached on the bus The USB 2 0 standard supports a signalling rate of 480 Mb s known as high speed which is 40 times faster than the USB 1 1 full speed transfer rate USB 2 0 is fully forward and backward compatible with USB 1 1 and uses existing cables and connectors USB 2 0 supports connections with PC peripherals that provide expanded functionality and require wider bandwidth In addition it can handle a larger number of peripherals simultaneously USB 2 0 enhances the user s experience of many applications including interactive gaming broadband Internet access desktop and Web publishing Internet services and conferencing Because of its benefits described also in section 3 2 below USB
111. g a driver for a device that is based on one of the enhanced support USB chipsets The Cypress EZ USB family Microchip PIC18F4550 Philips PDIUSBD12 Texas Instruments TUSB3410 TUSB3210 TUSB2136 and TUSB5052 Agere USS2828 Silicon Laboratories C8051F320 we recommend that you read Chapter 8 which explains WinDriver s enhanced support for specific chipsets before starting your driver development DriverWizard can be used to diagnose your hardware and can generate an INF file for your hardware on Windows Avoid using DriverWizard to generate code for a device based on one of the supported USB chipsets 8 as DriverWizard generates generic code which will have to be modified according to the specific functionality of the device in question Preferably use the complete source code libraries and sample applications supplied in the package tailored to the various USB chipsets DriverWizard is an excellent tool for two major phases in your HW Driver development e Hardware diagnostics After the hardware has been built attach your device to a USB port on your machine and use DriverWizard to verify that the hardware is performing as expected e Code generation Once you are ready to build your code let DriverWizard generate your driver code for you The code generated by DriverWizard is composed of the following elements e Library functions for accessing each element of your device s resources memory ranges I O ranges registers and in
112. g eMbedded Visual C to meet your specific needs If you are using Platform Builder activate it and insert the generated pbp into your workspace 5 Test your driver on the target embedded Windows CE platorm 1 9 What Does the WinDriver Toolkit Include e A printed version of this manual e Two months of free technical support Phone Fax Email e WinDriver modules e The WinDriver CD e Utilities e Chipset support APIs Jungo Ltd 2005 2010 6 WinDriver Overview e Sample files 1 9 1 WinDriver Modules e WinDriver WinDriver include the general purpose hardware access toolkit The main files here are windrvr h Declarations and definitions of WinDriver s basic API e wdu_lib h Declarations and definitions of the WinDriver USB WDU library which provides convenient wrapper USB APIs e windrvr_int_thread h Declarations of convenient wrapper functions to simplify interrupt handling e windrvr_events h Declarations of APIs for handling and Plug and Play and power management events e utils h Declarations of general utility functions e status_strings h Declarations of API for converting WinDriver status codes to descriptive error strings e DriverWizard WinDriver wizard wdwizard a graphical application that diagnoses your hardware and enables you to easily generate code for your driver refer to Chapter 5 for details e Debug Monitor a debugging tool that collects information about you
113. gFile entry e If you wish to submit your driver for WHQL certification refer to the additional guidelines in section 12 3 2 1 e Submit your driver for WHQL certification or for an Authenticode signature Note that many WinDriver customers have already successfully digitally signed and certified their WinDriver based drivers 12 3 2 1 WHQL DTM Test Notes As indicated in the WHQL documentation before submitting the driver for testing you need to download Microsoft s Driver Test Manager DTM http www microsoft com whdc DevTools WDK DTM mspx and run the relevant tests for your hardware software After you have verified that you can successfully pass the DTM tests create the required logs package and proceed according to Microsoft s documentation When running the DTM tests note the following The DTM test class for WinDriver based drivers should be Unclassified Universal Device e The Driver Verifier test is applied to all unsigned drivers found on the test machine It is therefore important to try and minimize the number of unsigned drivers installed on the test PC apart from the test driver windrvr6 sys e The USB Selective Suspend test requires that the depth of the under test USB device in the USB devices tree is at least one external hub and no more than two external hubs deep e The ACPI Stress test requires that the ACPI settings in the BIOS support the S3 power state e Verify that the PAE switch is added
114. hat provide information used by the Plug and Play mechanism on Windows 7 Vista Server 2008 Server 2003 XP 2000 Me 98 to install software that supports a given hardware device INF files are required for hardware that identifies itself such as USB and PCI An INF file includes all necessary information about a device and the files to be installed When hardware manufacturers introduce new products they must create INF files to explicitly define the resources and files required for each class of device In some cases the INF file for your specific device is supplied by the operating system In other cases you will need to create an INF file for your device WinDriver s DriverWizard can generate a specific INF file for your device The INF file is used to notify the operating system that WinDriver now handles the selected device For USB devices you will not be able to access the device with WinDriver either from DriverWizard or from the code without first registering the device to work with windrvr6 sys This is done by installing an INF file for the device DriverWizard will offer to automatically generate the INF file for your device You can use DriverWizard to generate the INF file on the development machine as explained in 5 2 of the manual and then install the INF file on any machine to which you distribute the driver as explained in the following sections 12 1 1 Why Should I Create an INF File e To bind the Win
115. he file names end with the vxd extension VxD drivers are typically monolithic in nature They provide direct access to hardware and privileged operating system functions VxD drivers can be stacked or layered in any fashion but the driver structure itself does not impose any layering 2 3 0 Unix Device Drivers In the classic Unix driver model devices belong to one of three categories character char devices block devices and network devices Drivers that implement these devices are correspondingly known as char drivers block drivers or network drivers Under Unix drivers are code units linked into the kernel that run in privileged kernel mode Generally driver code runs on behalf of a user mode application Access to Unix drivers from user mode applications is provided via the file system In other words devices appear to the applications as special device files that can be opened Unix device drivers are either layered or monolithic drivers A monolithic driver can be perceived as a one layer layered driver 2 3 4 Linux Device Drivers Linux device drivers are based on the classic Unix device driver model 2 3 3 In addition Linux introduces some new characteristics Under Linux a block device can be accessed like a character device as in Unix but also has a block oriented interface that is invisible to the user or application Jungo Ltd 2005 2010 14 Understanding Device Drivers Traditionally under Unix devic
116. hese functions to send setup packets on Pipe00 and to retrieve control and status data from the device e The following sample demonstrates how to fill the SetupPacket 8 variable with a GET_DESCRIPTOR setup packe setupPacket 0 0x80 setupPacket 1 0x6 setupPacket 2 0 setupPacket 3 0x1 setupPacket 4 0 setupPacket 5 0 setupPacket 6 0x12 setupPacket 7 0 t BmRequstType 0x6 GET bRequest wValue wValue Descriptor Type wIndex windex Ee Ee size tor the returned butter wLength _DESCRIPTOR Oxl EVICE e The following sample demonstrates how to send a setup packet to the control pipe a GET instruction the device will return the information requested in the pBuf fer variable WDU_TransferDefaultPipe hDev tee Ehe TRUE amp setupPacket 0 D pBuffer dwSize 10000 e The following sample demonstrates how to send a setup packet to the control pipe a SET instruction WDU_TransferDefaultPipe hDev EE EE EE For further information regarding WI DU Transfer For further information regarding WI FALSE amp setupPacket 0 NUTT 0 10000 DU Transfer refer to section B 4 8 1 Jungo Ltd 2005 2010 73 DU_Transfer B 4 8 1 DefaultPipe refer to section B 4 8 3 USB Transfers 9 3 Functional USB Data Transfers 9 3 1
117. ication DII Shared Object I Os Components s Your Driver Code WinDriver NET wrapper API wdapi_dotnet High level WinDriver API wdapi DLL shared object Kernel Mode Low Level WinDriver API WinDriver Kernel Module windrvr6 sys dll o ko S ll LIHER hee privar L Host Controller Driver HCD UD SHS WSS Hardware Figure 3 4 WinDriver USB Architecture 3 10 Which Drivers Can Write with WinDriver USB Almost all monolithic drivers drivers that need to access specific USB devices can be written with WinDriver USB In cases where a standard driver is required e g NDIS driver SCSI driver Display driver USB to Serial port drivers USB layered drivers etc use KernelDriver USB also from Jungo For quicker development time select WinDriver USB over KernelDriver USB whenever possible Jungo Ltd 2005 2010 27 Chapter 4 Installing WinDriver This chapter takes you through the process of installing WinDriver on your development platform and shows you how to verify that your WinDriver is properly installed The last section discusses the uninstall procedure To find out how to install the driver you create on target platforms refer to Chapter 11 4 1 System Requirements 4 1 1 Windows System Requirements Any x86 32 bit or 64 bit x64 AMD64 or Intel EM64T processor Any development environment supporting C NET VB or Delphi Windows 2000 requires SP4 Windows XP req
118. ier versions of Linux by passing the enable kbuild flag to configure The files that use kbuild include kbuild in their names e configure wd a configuration script that creates makefile wd kbuild from makefile wd kbuild in e configure usb a configuration script that creates makefile usb kbuild from makefile usb kbuild in e makefile in a template for the main WinDriver makefile which compiles and installs WinDriver by making makefile wd kbuild and makefile usb kbuild e makefile wd in a template for a makefile that compiles and installs the main WinDriver kernel module e makefile wd kbuild in a template for a makefile that compiles the main WinDriver kernel module using kbuild and then installs the module e makefile usb in a template for a makefile that compiles and installs the USB kernel module windrvr6_usb o ko e makefile usb kbuild in a template for a makefile that compiles the USB kernel module using kbuild and then installs the module e setup_inst_dir a script to install your driver modules e wdreg provided under the WinDriver util directory a script to load the WinDriver kernel driver modules see section 10 3 Note The setup_inst_dir script uses wdreg to load the driver modules 11 4 2 User Mode Hardware Control Application Shared Objects Copy the hardware control application shared object that you created with WinDriver to the target If your hardware control application
119. ification processing continues Your application may make use of any functions defined in the high or low level APIs below The high level functions provided for your convenience make use of the low level functions which in turn use IOCTLs to enable communication between the WinDriver kernel module and your user mode application When exiting your application calls WOU_Uninit B 4 7 to stop listening to devices matching the given criteria and to unregister the notification callbacks for these devices The following figure depicts the calling sequence described above Each vertical line represents a function or process Each horizontal arrow represents a signal or request drawn from the initiator to the recipient Time progresses from top to bottom Jungo Ltd 2005 2010 107 USB Device WDU TranserQ Signal Attach eu itiate other requests to Wi USB Device Notify the user of the detached device 9 U device_detach wu Unie If the WD_ACKNOVWVLEDGE flag was set in the call to WWDU_Init the attach callback should return TRUE to accept control of the device or FALSE otherwise 2 Only possible if the attach callback returned TRUE Figure BI WinDriver USB Calling Sequence The following piece of meta code can serve as a framework for your user mode application s code Jungo Ltd 2005 2010 108 main EE white C wait for new devices J issue
120. in USBD_ISO_START_FRAME_RANGE of the current USB frame NOTE The stall bit is set WD_USBD_STATUS_BAD_START_FRAME USBD Start frame outside range Returned by HCD Host Controller Driver if all packets in an isochronous transfer complete with an error WD_USBD_STATUS_ISOCH_REQUEST_FAILED HCD Isochronous transfer completed with error Returned by USBD if the frame length control for a given HC Host Controller is already taken by another driver WD_USBD_STATUS_FRAME_ CONTROL_OWNED USBD Frame length control already taken Returned by USBD if the caller does not own frame length control and attempts to release or modify the HC frame length WD_USBD_STATUS_FRAME_CONTROL_NOT_ USBD Attempted operation on OWNED frame length control not owned by caller Additional software error codes added for USB 2 0 for Windows only WD_USBD_STATUS_NOT_SUPPORTED USBD API not supported implemented WD_USBD_STATUS_INAVLID_CONFIGURATION__ USBD Invalid configuration DESCRIPTOR descriptor WD_USBD_STATUS_INSUFFICIENT_RESOURCES USBD Insufficient resources WD_USBD_STATUS_SET_CONFIG_FATLED USBD Set configuration failed WD_USBD_STATUS_BUFFER_TOO_SMALL USBD Buffer too small Jungo Ltd 2005 2010 168 Status Code Description WD_USBD_STATUS_INTERFACE_NOT_FOUND USBD Interface not found WD_USBD_STATUS_INAVLID_PIPE_FLAGS USBD Invalid pipe flags WD_USBD_STATUS_TIME
121. in windrvr h Used for dwCmd DEBUG_SET_ FILTER Sets the sections to collect I O Memory Interrupt etc Use S_ALL for all For more details please refer to DEBUG_SECTION in windrvr h e dwLevelMessageBox Used for dwCmd DEBUG_SET_FILTER Sets the debugging level to print in a message box For more details please refer to DEBUG_LEVEL in windrvr h Jungo Ltd 2005 2010 148 Name Description e dwBufferSize Used for dwCmd DEBUG_SET BUFFER The size of buffer in the kernel RETURN VALUE Returns WO_STATUS_SUCCESS 0 on success or an appropriate error code otherwise B 8 EXAMPLE WD_DEBUG dbg BZERO dbg dbg dwCmd DEBUG_SET_FILTER dbg dwLevel D_ERROR dbg dwSection S_ALL dbg dwLevelMessageBox D_ERROR WD_Debug hWD amp dbg B 6 6 WD_DebugAdd PURPOSE e Sends debug messages to the debug log Used by the driver code PROTOTYPE DWORD WD_DebugAdd HANDLE hWD WD_DEBUG_ADD pData PARAMETERS Name Type Input Output hWD HANDLE Input pData WD_DEBUG_ADD e dwLevel DWORD Input e dwSection DWORD Input e pcBuffer CHAR 256 Input DESCRIPTION Name Description hWD Handle to WinDriver s kernel mode driver as received from WD_Open B 6 2 Jungo Ltd 2005 2010 Name Des
122. inDriver identifies the endpoint transfer type as determined in the endpoint descriptor The driver created with WinDriver contains all configuration information acquired at this early stage 3 8 WinDriver USB WinDriver USB enables developers to quickly develop high performance drivers for USB based devices without having to learn the USB specifications and operating system internals or use the operating system development kits For example Windows drivers can be developed without using the Windows Driver Kit WDK or learning the Windows Driver Model WDM The driver code developed with WinDriver USB is binary compatible across the supported Windows platforms Windows 7 Vista Server 2008 Server 2003 XP 2000 and source code compatible across all supported operating systems Windows 7 Vista Server 2008 Server 2003 XP 2000 Windows CE NET Windows Embedded CE v6 00 Windows Mobile 5 0 6 0 and Linux For an up to date list of supported operating systems visit Jungo s web site at http www jungo com WinDriver USB is a generic tool kit that supports all USB devices from all vendors and with all types of configurations WinDriver USB encapsulates the USB specification and architecture letting you focus on your application logic WinDriver USB features the graphical DriverWizard utility 5 which enables you to easily detect your hardware view its configuration information and test it before writing a single line of code DriverWi
123. ing e FALSE the stream is currently stopped pdwLastError Pointer to the last error associated with the stream Note Calling the function also resets the streame last error pdwBytesInBuffer Pointer to the current bytes count in the stream data buffer RETURN VALUE Returns WO_STATUS_SUCCESS 0 on success or an appropriate error code otherwise B 8 B 4 9 7 WDU_StreamStop PURPOSE e Stops an active stream i e stops transfers between the stream and the device In the case of a write stream the function flushes the stream i e writes its contents to the device before stopping it PROTOTYPE DWORD DLLCALLCONV WD WDU_STREAM_HANDL U_StreamStop E hStream PARAMETERS Name Type Input Output hStream WDU_STREAM_HANDLE Input DESCRIPTION Name Description hStream A unique identifier for the stream as returned by WDU_St reamOpen RETURN VALUE Returns WO_STATUS_SUCCESS 0 on success or an appropriate error code otherwise B 8 Jungo Ltd 2005 2010 130 B 4 9 8 WDU_StreamClose PURPOSE e Closes an open stream The function stops the stream including flushing its data to the device in the case of a write stream before closing it PROTOTYPE DWORD DLLCALLCONV WD WDU_STREAM_HANDLE hStream U_StreamClose PARAMETERS Name Type Input Output hStream WDU_STREAM_HANDLE Input DESCRIPTION
124. ing the operation of a USB device the host can initiate a flow of data between the client software and the device Data can be transferred between the host and only one device at a time peer to peer communication However two hosts cannot communicate directly nor can two USB devices with the exception of On The Go OTG devices where one device acts as the master host and the other as the slave The data on the USB bus is transferred via pipes that run between software memory buffers on the host and endpoints on the device Data flow on the USB bus is half duplex i e data can be transmitted only in one direction at a given time An endpoint is a uniquely identifiable entity on a USB device which is the source or terminus of the data that flows from or to the device Each USB device logical or physical has a collection of independent endpoints The three USB speeds low full and high all support one bi directional control endpoint endpoint zero and 15 unidirectional endpoints Each unidirectional endpoint can be used for either inbound or outbound transfers so theoretically there are 30 supported endpoints Each endpoint has the following attributes bus access frequency bandwidth requirement endpoint number error handling mechanism maximum packet size that can be transmitted or received transfer type and direction into or out of the device Jungo Ltd 2005 2010 19 WinDriver USB Overview Endpoints M
125. ion High Level API This function has been replaced by WD_Open WDU_Init O B 4 1 WD_Version WD_UsbScanDevice Jungo Ltd 2005 2010 109 Problem Solution WD_UsbDeviceRegister WDU_SetInterface B 4 2 WD_UsbGetConfiguration WDU_GetDeviceInfo B 4 5 WD_UsbDeviceUnregister WDU_Uninit B 4 7 Low Level API This function has been replaced by WD_UsbTransfer WDU_Transfer B 4 8 1 WDU_TransferDefaultPipe B 4 8 3 WDU_TransferBulk B 4 8 4 WDU_TransferIsoch B 4 8 5 WDU_TransferInterrupt B 4 8 6 USB_TRANSFER_HALT option WDU_HaltTransfer B 4 8 2 WD_UsbResetPipe WDU_ResetPipe B 4 10 WD_UsbResetDevice WDU_ResetDevice B 4 11 WD_UsbResetDeviceEx B 3 USB User Callback Functions B 3 1 WDU_ATTACH_CALLBACK PURPOSE e WinDriver calls this function when a new device matching the given criteria is attached provided it is not yet controlled by another driver This callback is called once for each matching interface PROTOTYPE Eypeder BOOL WDU_DEVIC WDU_DEVICE pDevicelnto PVOTDIDUSeErData DLLCALLCONV WDU_ATTACH_CALLBACK E HANDLE hDevice PARAMETERS Name Type Input Output hDevice WDU_DEVICE_HANDLE Input pDevicelInfo WDU_DEVICE Input pUserData PVOID Input DESCRIPTION Jungo L
126. is currently enjoying broad market acceptance Jungo Ltd 2005 2010 17 WinDriver USB Overview 3 2 WinDriver USB Benefits This section describes the main benefits of the USB standard and the WinDriver USB toolkit which supports this standard External connection maximizing ease of use Self identifying peripherals supporting automatic mapping of function to driver and configuration Dynamically attachable and re configurable peripherals Suitable for device bandwidths ranging from a few Kb s to hundreds of Mb s Supports isochronous as well as asynchronous transfer types over the same set of wires Supports simultaneous operation of many devices multiple connections Supports a data transfer rate of up to 480 Mb s high speed for USB 2 0 for the operating systems that officially support this standard and up to 12 Mb s full speed for USB 1 1 Guaranteed bandwidth and low latencies appropriate for telephony audio etc isochronous transfer may use almost the entire bus bandwidth Flexibility supports a wide range of packet sizes and a wide range of data transfer rates Robustness built in error handling mechanism and dynamic insertion and removal of devices with no delay observed by the user Synergy with PC industry Uses commodity technologies Optimized for integration in peripheral and host hardware Low cost implementation therefore suitable for development of low cost peripherals Low cost cables and connector
127. ity as wdreg but displays GUI messages instead of console mode messages If you have renamed the WinDriver kernel module windrvr6 sys as explained in section 12 2 replace the relevant windrvr6 references with the name of your driver and replace references to the WinDriver redist directory with the path to the directory that contains your modified installation files For example when using the generated DriverWizard renamed driver files for your driver project as explained in section 12 2 1 you can replace references to the WinDriver redist directory with references to the generated xxx_installation redist directory where xxx is the name of your generated driver project If you have created new INF and or catalog files for your driver replace the references to the original WinDriver INF files and or to the wd1020 cat catalog file with the names of your new files see information in sections 12 2 1 and 12 3 2 regarding renaming of the original files If you wish to distribute drivers for both 32 bit and 64 bit target platforms you must prepare a separate driver installation package for each platform The required files for each package are located within the WinDriver installation directory for the respective platform Jungo Ltd 2005 2010 81 Distributing Your Driver Distributing the driver you created is a multi step process First create a distribution package that includes all the files required for the installation
128. iver on the target computer e Preliminary Steps e To successfully install your driver make sure that there are no open handles to the WinDriver service windrvr6 sys or your renamed driver refer to section 12 2 and that there are no connected and enabled Plug and Play devices that are registered with Jungo Ltd 2005 2010 82 Distributing Your Driver this service This is relevant for example when upgrading the version of the driver for WinDriver v6 0 0 and above earlier versions used a different module name If the service is being used attempts to install the new driver using wdreg will fail You can disable or uninstall connected devices from the Device Manager Properties Disable Uninstall or using wdreg or otherwise physically disconnect the device s from the PC e On Windows 2000 remove any INF file s previously installed for your device such as files created with an earlier version of WinDriver from the windir inf directory before installing the new INF file that you created for the device This will prevent Windows from automatically detecting and installing an obsolete file You can search the INF directory for the device s vendor ID and device product ID to locate the file s associated with the device e Install WinDriver s kernel module 1 Copy windrvr6 sys windrvr6 inf and wd1020 cat to the same directory wd1020 cat contains the driver s Authenticode digital signature To maintain th
129. iver samples shared directory 6 2 2 Write Your Code 1 Call WOU_Init B 4 1 at the beginning of your program to initialize WinDriver for your USB device and wait for the device attach callback The relevant device information will be provided in the attach callback 2 Once the attach callback is received you can start using one of the WDU_Transfer B 4 8 1 functions family to send and receive data 3 To finish call WOU_Uninit B 4 7 to unregister from the device 6 2 3 Configure and Build Your Code After including the required files and writing your code make sure that the required build flags and environment variables are set then build your code Before building your code verify that the WO_BASEDIR environment variable is set to the O location of the of the WinDriver installation directory On Windows Windows CE and Linux you can define the WD_BASEDIR environment variable globally as explained in Chapter 4 For Windows refer to the Windows WD_BASEDIR note in section 4 2 1 for Windows CE refer to section 4 2 2 3 for Linux refer to section 4 2 3 2 step 9 6 3 Developing Your Driver on Windows CE Platforms In order to register your USB device to work with WinDriver you can perform one of two of the following e Call WDU_Init B 4 1 before the device is plugged into the CE system OR e You can add the following entry to the registry can be added to your platform reg
130. les sbin modprobe r windrvr6 3 If you are not using a Linux 2 6 x kernel that supports the udev file system remove the old device node in the dev directory rm f dev windrvr6 4 Remove the file windriver rc from the ete directory rm f etc windriver rc 5 Remove the file windriver rc from HOME rm f SHOME windriver rec 6 If you created a symbolic link to DriverWizard remove the link using the command rm f usr bin wdwizard 7 Remove the WinDriver installation directory using the command rm rf WinDriver 8 Remove the WinDriver shared object file if it exists usr lib ibwdapil1020 so 32 bit x86 usr lib64 libwdapil020 so 64 bit x86 Jungo Ltd 2005 2010 39 Chapter 5 Using DriverWizard This chapter describes WinDriver DriverWizard s hardware diagnostics and driver code generation capabilities 5 1 An Overview DriverWizard included in the WinDriver toolkit is a GUI based diagnostics and driver generation tool that allows you to write to and read from the hardware before writing a single line of code The hardware is diagnosed through a Graphical User Interface the device s configuration and pipes information is displayed data can be transferred on the pipes the pipes can be reset etc Once the device is operating to your satisfaction DriverWizard creates the skeletal driver source code with functions to access your hardware s resources If you are developin
131. list of the new features enhancements and fixes that have been added in each WinDriver version Technical Documents For additional information refer to the WinDriver Technical Documents database http www jungo com st support tech_docs_indexes main_index html This database includes detailed descriptions of WinDriver s features utilities and APIs and their correct usage troubleshooting of common problems useful tips and answers to frequently asked questions Jungo Ltd 2005 2010 175
132. lity the Linux kernel developers decided that kernel modules must be compiled with header files identical to those with which the kernel itself was compiled They enforce this by including a version number in the kernel header files that is checked against the version number encoded into the kernel This forces Linux driver developers to facilitate recompilation of their driver based on the target system s kernel version If you have renamed the WinDriver driver modules windrvr6 o0 ko and windrvr6_usb o ko as explained in section 12 2 replace windrvr6 references with your new driver name and replace references to the WinDriver redist lib and include directories with the path to your copy of the relevant directory For example when using the generated DriverWizard renamed driver files for your driver project as explained in section 12 2 2 you can replace references to the WinDriver redist directory with references to the generated xxx_installation redist directory where xxx is the name of your generated driver project If you wish to distribute drivers for both 32 bit and 64 bit target platforms you must prepare a separate driver installation package for each platform The required files for each package are located within the WinDriver installation directory for the respective platform 11 4 1 Kernel Modules WinDriver uses two kernel modules the main WinDriver driver module which implements the WinDriver API windrvr6 o k
133. llowing WDU_SELECTIVE_SUSPEND_OPTIONS values e WDU_SELECTIVE_SUSPEND_SUBMIT submit a request to suspend the device e WDOU_SELECTIVE_SUSPEND_CANCEL cancel a previous request to suspend the device RETURN VALUE Returns WO_STATUS_SUCCESS 0 on success or an appropriate error code otherwise B 8 If the device is busy when a suspend request is submitted dwOptions WDU_SELECTIVE_SUSPEND_SUBMIT the function returns WD_OPERATION_FAT REMARKS LED e WDU_SelectiveSuspend is supported on Windows XP and higher B 4 13 WDU_ Wakeup PURPOSE e Enables Disables the wakeup feature PROTOTYPE DWORD WDU_Wakeup WDU_DEVICE_HANDLE hDevice DWORD dwOptions PARAMETERS Name Type Input Output hDevice WDU_DEVICE_HANDLE Input dwOptions DWORD Input DESCRIPTION Name Description hDevice A unique identifier for the device interface dwOptions Can be either e WOU_WAKEUP_ENABLE enable wakeup OR e WOU_WAKEUP_DISABLE disable wakeup Jungo Ltd 2005 2010 134 RETURN VALUE Returns WO_STATUS_SUCCESS 0 on success or an appropriate error code otherwise B 8 B 4 14 WDU_GetLangIDs PURPOSE e Reads a list of supported language IDs and or the number of supported language IDs from a device PROTOTYPE DWORD DLLCALLCONV WDU_GetLangIDs WDU_DEVICE_HANDLE hDevice PBYTE p
134. mechanism verifies the authenticity of driver s provider It allows driver developers to include information about themselves and their code with their programs through the use of digital signatures and informs users of the driver that the driver s publisher is participating in an infrastructure of trusted entities The Authenticode signature does not however guarantee the code s safety or functionality The WinDriver redist windrvr6 sys driver has an Authenticode digital signature 12 3 1 2 WHQL Driver Certification Microsoft s Windows Logo Program http www microsoft com whdc winlogo default mspx lays out procedures for submitting hardware and software modules including drivers for Microsoft quality assurance tests Passing the tests qualifies the hardware software for Microsoft certification which verifies both the driver provider s authenticity and the driver s safety and functionality Device drivers should be submitted for certification together with the hardware that they drive The driver and hardware are submitted to Microsoft s Windows Hardware Quality Labs WHQL testing in order to receive digital signature and certification This procedure verifies both the driver s provider and its behavior Jungo s professional services unit provides a complete WHQL pre certification service for Jungo based drivers Professional engineers efficiently perform all the required tests in the Jungo WHQL test lab relieving customers of th
135. n WD_STATUS_SUCCESS Success WD_STATUS_INVALID_WD_HANDLE Invalid WinDriver handle WD_WINDRIVER_STATUS_ERROR Error WD_INVALID_HANDLE Invalid handle WD_INVALID_PIPE_NUMBER Invalid pipe number WD_READ_WRITE_CONFLICT Conflict between read and write operations WD_ZERO_PACKET_SIZE Packet size is zero WD_INSUFFICIENT_RESOURCES Insufficient resources WD_UNKNOWN_PIPE_TYPE Unknown pipe type WD_SYSTEM_INTERNAL_ERROR WD_DATA_MISMATCH Internal system error Data mismatch WD_NO_LICENSE No valid license WD_NOT_IMPLEMENTED Function not implemented WD_FAILED_ENABLING_INTERRUPT Failed enabling interrupt WD_INTERRUPT_NOT_ENABLED Interrupt not enabled WD_RESOURCE_OVERLAP Resource overlap WD_DEVICE_NOT_FOUND Device not found WD_WRONG_UNIQUE_ID Wrong unique ID WD_OPERATION_ALREADY_DONE Operation already done WD_USB_DESCRIPTOR_ERROR USB descriptor error WD_SET_CONFIGURATION_FAILED Set configuration operation failed WD_CANT_OBTAIN_PDO WD_TIME_OUT_EXPIRED Cannot obtain PDO Timeout expired WD_IRP_CANCELED IRP operation cancelled Jungo Ltd 2005 2010 165 Status Code Description WD_FAILED_USER_MAPPING Failed to map in user space WD_FAILED_KERNEL_MAPPING Failed to map in kernel space WD_NO_RESOURCES_ON_DEVICE No resources on the device
136. nDriver is activated an Unregistered message appears e When using DriverWizard a dialogue box with a message stating that an evaluation version is being run appears on every interaction with the hardware e In the Linux and Windows CE versions the driver will remain operational for 60 minutes after which time it must be restarted e The Windows evaluation version expires 30 days from the date of installation For more details please refer to appendix D Jungo Ltd 2005 2010 5 WinDriver Overview 1 8 How Do Develop My Driver with WinDriver 1 8 1 On Windows and Linux 1 Start DriverWizard and use it to diagnose your hardware see details in Chapter 5 2 Let DriverWizard generate skeletal code for your driver or use one of the WinDriver samples as the basis for your driver application see Chapter 8 for details regarding WinDriver s enhanced support for specific chipsets 3 Modify the generated sample code to suit your application s needs 4 Run and debug your driver EH The code generated by DriverWizard is a diagnostics program that contains functions that perform data transfers on the device s pipes send requests to the control pipe change the active alternate setting reset pipes and more 1 8 2 On Windows CE 1 Plug your hardware into a Windows host machine 2 Diagnose your hardware using DriverWizard 3 Let DriverWizard generate your driver s skeletal code 4 Modify this code usin
137. nd gcc The sample and generated DriverWizard Windows and Linux WinDriver projects makefiles already set this preprocessor flag PROTOTYPE const char DLLCALLCONV WD_DriverName const char sName PARAMETERS Name Type Input Output sName const char Input Jungo Ltd 2005 2010 105 DESCRIPTION Name Description sName The name of the WinDriver kernel module to be used by the application NOTE The driver name should be indicated without the driver file s extension For example use windrvr6 not windrvr6 sys or windrvr6 o RETURN VALUE Returns the selected driver name on success returns NULL on failure e g if the function is called twice from the same application long REMARKS e The ability to rename the WinDriver kernel module is supported on Windows and Linux as explained in section 12 2 On Windows CE always call the WDO_DriverName function with the default WinDriver kernel module name windrvr6 or refrain from calling the function altogether B 2 WinDriver USB WDU Library Overview This section provides a general overview of WinDriver s USB Library WDU including e An outline of the WOU_xxx API calling sequence see section B 2 1 e Instructions for upgrading code developed with the previous WinDriver USB API used in version 5 22 and earlier to use the improved WOU_xxx API see section B 2 2 If you do not need
138. ng its data to the device in the case of a write stream before closi Note Each call to WI ng it later on in the code i DU_StreamOpen must have a matching call to WI n order to perform the necessary cleanup DU_StreamClose Jungo Ltd 2005 2010 76 Chapter 10 Dynamically Loading Your Driver 10 1 Why Do You Need a Dynamically Loadable Driver When adding a new driver you may be required to reboot the system in order for it to load your new driver into the system WinDriver is a dynamically loadable driver which enables your customers to start your application immediately after installing it without the need for reboot EH To successfully unload your driver make sure that there are no open handles to the WinDriver service windrvr6 sys or your renamed driver refer to section 12 2 and that there are no connected and enabled Plug and Play devices that are registered with this service 10 2 Windows Dynamic Driver Loading 10 2 1 Windows Driver Types Windows drivers can be implemented as either of the following types e WDM Windows Driver Model drivers Files with the extension sys on Windows 7 Vista Server 2008 Server 2003 XP 2000 Me 98 e g windrvr6 sys WDM drivers are installed via the installation of an INF file see below e Non WDM Legacy drivers These include drivers for non Plug and Play Windows operating systems Windows NT 4 0 and files with the extension vxd on Win
139. ng system selected in the code generation dialogue box 5 2 3 2 The Generated USB C Code In the source code directory you now have a new xxx_diag c source file where xxx is the name you selected for your DriverWizard project This file implements a diagnostic USB application which demonstrates how to use WinDriver s USB API to locate and communicate with your USB device s including detection of Plug and Play events device insertion removal etc performing read write transfers on the pipes resetting the pipes and changing the device s active alternate setting The generated application supports handling of multiple identical USB devices Jungo Ltd 2005 2010 50 Using DriverWizard 5 2 3 3 The Generated Visual Basic and Delphi Code The generated DriverWizard Visual Basic and Delphi code includes similar functions and provides similar functionality as the generated C code described in section 5 2 3 2 The generated Delphi code implements a console application like the C code w hile the Visual Basic code implements a GUI application 5 2 3 4 The Generated CH and Visual Basic NET Code The generated DriverWizard C and Visual Basic NET code provides similar functionality as the generated C code 5 2 3 2 but from a GUI NET program 5 2 4 Compiling the Generated Code 5 2 4 1 Windows and Windows CE Compilation As explained above on Windows you can select to generate project and workspace solution files for any of
140. ng used O You can check if the WinDriver kernel module is loaded by running the Debug Monitor utility WinDriver util wddebug_gui exe 7 2 When the driver is loaded the Debug Monitor log displays driver and OS information otherwise it displays a relevant error message On the development PC the uninstall command will delete the Debug Monitor executables to use this utility after the uninstallation create a copy of wddebug_gui exe before performing the uninstall procedure 4 If windrvr6 sys was successfully unloaded erase the following files if they exist e windir system32 drivers windrvr6 sys e windir inf windrvr6 inf e windir system32 wdapil020 dll e windir sysWOW64 wdapil020 dll Windows x64 5 Reboot the computer Jungo Ltd 2005 2010 38 Installing WinDriver 4 5 2 Linux WinDriver Uninstall Instructions The following commands must be executed with root privileges EH 1 Verify that the WinDriver driver modules are not being used by another program e View the list of modules and the programs using each of them sbin 1lsmod e Identify any applications and modules that are using the WinDriver driver modules By default WinDriver module names begin with windrvr6 e Close any applications that are using the WinDriver driver modules e Unload any modules that are using the WinDriver driver modules sbin modprobe r lt module_name gt 2 Unload the WinDriver driver modu
141. nning GUI WinDriver applications eg DriverWizard 5 Debug Monitor 7 2 4 2 WinDriver Installation Process The WinDriver CD contains all versions of WinDriver for the supported operating systems The CD s root directory contains the Windows 7 Vista Server 2008 Server 2003 XP 2000 version The installation of this version will begin automatically when you insert the CD into the CD drive on your Windows development machine The other versions of WinDriver are located in lt OS gt sub directories for example Linux Wince 4 2 1 Windows WinDriver Installation Instructions Driver installation on Windows requires administrator privileges 1 Insert the WinDriver CD into your CD ROM drive or double click the downloaded installation file WD1020 EXE and follow the installation instructions i When using the installation CD wait a few seconds for the installation to begin automatically If this does not happen double click the file WD1020 EXE in the CD and click the Install WinDriver button 2 At the end of the installation you may be prompted to reboot your computer Jungo Ltd 2005 2010 29 Installing WinDriver a The WinDriver installation defines a WD BASEDIR environment variable which is set to point to the location of your WinDriver directory as selected during the installation This variable is used during the DriverWizard 5 code generation it determines the
142. nt ceccceeesseeeeseceeeeeeeenneeeesaeeees 101 A 64 bit Operating Systems Support saccscecesetscseenndocs cceuudenddeeasetedbansaegundeus segsabieestauesiepasinesecades 103 A 1 Supported 64 bit Architectures sssessseseesesserererreestesrrrernserssenreestesrsernseesseseresresee 103 A 2 Support for 32 Bit Applications on 64 Bit Windows and Linux Platforms 103 A 3 64 bit and 32 bit Data Types EN 104 B WinDriver USB PC Host API Keen zeettr egeugegeudeeereueegkegsedee eebe degt 105 B l Ku 105 B 2 WinDriver USB WDU Library Overview sssssssessseesssseeessrrssrreserssersssresssressres 106 B 2 1 Calling Sequence for WinDriver USB sssessesssessesessrreseeressersrirrrnsrrsrerrresreser 106 B 2 2 Upgrading from the WD_xxx USB API to the WDU_xxx API 109 B 3 USB User Callback Functions eegenen 110 B 3 1 WDU_ATTACH_CALLBACK cnccaccresteanieniaatenanenenaieanietannchans 110 B 3 2 WDU_DETACH_CALLBACK E 111 B 3 3 WDU_POWER_CHANGE_CALLBACK aj sssessasssessccsssseceansenscsacseaatsossenesncaves 112 B4 Be 112 BAWOU KE 113 B42 WU AS UAC eege eeh anai ieena oa 114 B43 WU GetDeviceAddr eben AEE E R AAS 115 BAA WDU_GetDeviceRegistryPropetty vesesecaseecdvcsecesdeasesesssessdensseievesedgvecestaateeesieeet 115 BAD WDU Get e vie E 117 B 4 6 WDU_PutDevicelInfo wei ccccccccccccssssescecccccccsessssscsceccessssuesseseesesesseeeneneess 117 BAT WDO EE 118 B 4 8 Single Blocking Transfer Functions ssses
143. o and a driver module that implements the USB functionality windrvr6_usb o ko Since these are kernel modules they must be recompiled for every kernel version on which they are loaded To facilitate recompilation we supply the following components which are all provided under the WinDriver redist directory unless specified otherwise You need to distribute these components along with your driver source object code e windrvr_gcc_v2 a windrvr_gcec_v3 a and windrvr_gcc_v3_regparm a compiled object code for the WinDriver kernel module windrvr_gec_v2 a is used for kernels compiled with GCC v2 x x and windrvr_gcc_v3 a is used for kernels compiled with GCC v3 x x windrvr_gcc_v3_regparm a is used for kernels compiled with GCC v3 x x with the regparm flag e linux_wrappers c h wrapper library source code files that bind the WinDriver kernel module to the Linux kernel jinux_common h windrvr h wd_ver h windrvr_usb h and wdusb_interface h header files required for building the WinDriver kernel module on the target Jungo Ltd 2005 2010 88 Distributing Your Driver e wdusb_linux c used by WinDriver to utilize the USB stack e configure a configuration script that creates makefile from makefile in and runs configure wd and configure usb see below CA If the Linux kernel is version 2 6 26 or higher configure generates makefiles that use kbuild to compile the kernel modules You can force the use of kbuild on earl
144. oaded after boot To load WinDriver on the target Windows Mobile platform every time the OS is started copy the WinDriver redist Windows_Mobile_5_ARMV4l wdreg exe utility to the Windows StartUp directory on the target PC 5 Restart your target CE computer The WinDriver CE kernel will automatically load You will have to do a warm reset rather than just suspend resume use the reset or power button on your target CE computer 6 Compile and run the sample programs to make sure that WinDriver CE is loaded and is functioning correctly see section 4 4 which describes how to check your installation 4 2 2 3 Windows CE Installation Note The WinDriver installation on the host Windows 7 Vista Server 2008 Server 2003 XP 2000 PC defines a WD_BASEDTR environment variable which is set to point to the location of your WinDriver directory as selected during the installation This variable is used during the DriverWizard 5 code generation it determines the default directory for saving your generated code and is used in the include paths of the generated project make files Note that if you install the WinDriver Windows 7 Vista Server 2008 Server 2003 XP 2000 toolkit on the same host PC the installation will override the value of the WD_BASEDIR variable from the Windows CE installation 4 2 3 Linux WinDriver Installation Instructions 4 2 3 1 Preparing the System for Installation In Linux kernel modules must be
145. oblem In some cases the user may be asked to reboot the computer Jungo Ltd 2005 2010 83 Distributing Your Driver When distributing your driver take care not to overwrite a newer version of windrvr6 sys with an older version of the file in Windows drivers directory windir system32 drivers You should configure your installation program if you are using one or your INF file so that the installer automatically compares the time stamp on these two files and does not overwrite a newer version with an older one e Install the INF file for your device registering your Plug and Play device with windrvr6 sys Run the utility wdreg with the install command to automatically install the INF file and update Windows Device Manager wdreg inf lt path to your INF file gt install You can also use the wdreg utility s preinstall command to pre install an INF file for a device that is not currently connected to the PC wdreg inf lt path to your INF file gt preinstall On Windows 2000 if another INF file was previously installed for the device which registered the device to work with the Plug and Play driver used in earlier versions of WinDriver remove any INF file s for the device from the windir inf directory before installing the new INF file that you created This will prevent Windows from automatically detecting and installing an obsolete file You can search the INF directory for the device s vendor ID and d
146. ocated in the c tmp directory wdreg inf c tmp device inf install You can replace the install option in the example above with preinstall to pre install the device INF file for a device that is not currently connected to the PC ES H the installation fails with an ERROR_FILE_NOT_FOUND error inspect the Windows ka registry to see if the RunOnce key exists in HKEY_LOCAL_MACHINE SOFTWARE Microsoft Windows CurrentVersion This registry key is required by Windows Plug and Play in order to properly install drivers using INF files If the RunOnce key is missing create it then try installing the INF file again To unload the driver INF file use the same commands but simply replace instal11 in the examples above with uninstall Jungo Ltd 2005 2010 79 Dynamically Loading Your Driver 10 3 Linux Dynamic Driver Loading The following commands must be executed with root privileges e To dynamically load WinDriver run the following command lt path to wdreg gt windrvr6 e To dynamically unload WinDriver run the following command sbin modprobe r windrvr6 wdreg is provided in the WinDriver util directory To automatically load WinDriver on each boot add the following to the target Linux boot file ete re d rc local lt path to wdreg gt windrvr6 10 4 Windows Mobile Dynamic Driver Loading The WinDriver redist Windows_Mobile_5_ARMV4lI wdreg exe utility can be used for loading the Win
147. ointer to the device s configuration information structure B 5 2 4 pActiveConfig WDU_CONFIGURATION Pointer to a configuration information structure B 5 2 4 for the device s active configuration pActivelnterface WDU_INTERFACE Array of pointers to interface WD_USB_MAX_INTERFACES information structures B 5 2 5 for the device s active interfaces Jungo Ltd 2005 2010 140 B 5 2 4 WDU_CONFIGURATION Structure Configuration information structure Field Type Description Descriptor WDU_CONFIGURATION_DESCRIPTOR Configuration descriptor information structure B 5 2 8 dwNumiInterfaces DWORD Number of interfaces supported by this configuration pInterfaces WDU_INTERFACE Pointer to the beginning of an array of interface information structures B 5 2 5 for the configuration s interfaces B 5 2 5 WDU_INTERFACE Structure Interface information structure Field Type Description pAlternateSettings WDU_ALTERNATE_SETTING Pointer to the beginning of an array of alternate setting information structures B 5 2 6 for the interface s alternate settings dwNumAltSettings DWORD Number of alternate settings supported by this interface pActiveAltSetting WDU_ALTERNATE_SETTING Pointer to an alternate setting information structure B 5 2 6 for the interface s active alternate setting B 5 2 6 WDU_ALTERNATE_SETTING Structure Alte
148. onents Figure 1 1 WinDriver Architecture Jungo Ltd 2005 2010 4 WinDriver Overview For hardware access your application calls one of the WinDriver user mode functions The user mode function calls the WinDriver kernel which accesses the hardware for you through the native calls of the operating system 1 6 What Platforms Does WinDriver Support WinDriver supports the following operating systems e Windows 7 Vista Server 2008 Server 2003 XP 2000 henceforth collectively Windows e Windows CE 4 x 5 x Windows CE NET Windows Embedded CE v6 00 Windows Mobile 5 0 6 0 henceforth collectively Windows CE e Linux The same source code will run on all supported platforms simply re compile it for the target platform The source code is binary compatible across Windows 7 Vista Server 2008 Server 2003 XP 2000 WinDriver executables can be ported among the binary compatible platforms without re compilation Even if your code is meant only for one of the supported operating systems using WinDriver will give you the flexibility to move your driver to another operating system in the future without needing to change your code 1 7 Limitations of the Different Evaluation Versions All the evaluation versions of the WinDriver USB Host toolkit are full featured No functions are limited or crippled in any way The evaluation version of WinDriver varies from the registered version in the following ways e Each time Wi
149. ontrol Transfer Control Transfer is mainly intended to support configuration command and status operations between the software on the host and the device This transfer type is used for low full and high speed devices Each USB device has at least one control pipe default pipe which provides access to the configuration status and control information Jungo Ltd 2005 2010 21 WinDriver USB Overview Control transfer is bursty non periodic communication The control pipe is bi directional i e data can flow in both directions Control transfer has a robust error detection recovery and retransmission mechanism and retries are made without the involvement of the driver The maximum packet size for control endpoints can be only 8 bytes for low speed devices 8 16 32 or 64 bytes for full speed devices and only 64 bytes for high speed devices For more in depth information regarding USB control transfers and their implementation refer to section 9 2 of the manual 3 6 2 lsochronous Transfer Isochronous Transfer is most commonly used for time dependent information such as multimedia streams and telephony This transfer type can be used by full speed and high speed devices but not by low speed devices Isochronous transfer is periodic and continuous The isochronous pipe is unidirectional i e a certain endpoint can either transmit or receive information Bi directional isochronous communication require
150. or code otherwise B 8 B 7 14 PrintDbgMessage PURPOSE Jungo Ltd 2005 2010 161 e Sends debug messages to the Debug Monitor PROTOTYPE void PrintDbgMessage DWORD dwLevel DWORD dwSection const Char fEormat ces Game mite rere es PARAMETERS Name Type Input Output dwLevel DWORD Input dwSection DWORD Input format const char Input argument Input DESCRIPTION Name Description dwLevel Assigns the level in the Debug Monitor in which the data will be declared If zero D ERROR will be declared For more details please refer to DEBUG_LEVEL in windrvr h dwSection Assigns the section in the Debug Monitor in which the data will be declared If zero S_MISC will be declared For more details please refer to DEBUG_SECTION in windrvr h format Format control string argument Optional arguments limited to 256 bytes RETURN VALUE None B 7 15 WD_LogStart PURPOSE e Opens a log file PROTOTYPE DWORD WD_LogStart const char sFileName Jungo Ltd 2005 2010 162 const char sMode PARAMETERS Name Type Input Output sFileName const char Input sMode const char Input DESCRIPTION Name Description sFileName Name of log file to be opened sMode Type of access permitted For example NULL or w opens an empty file for writing and if the given file exists its contents are
151. ould later be distributed to your customers who are using Windows 7 Vista Server 2008 Server 2003 XP 2000 and installed on their PCs The INF file that you generate in this step is also designed to enable DriverWizard to diagnose Plug and Play devices on Windows 7 Vista Server 2008 Server 2003 XP 2000 Additional information concerning the need for an INF file is provided in section 12 1 1 If you do not need to generate an INF file skip this step and proceed to the next one To generate the INF file with DriverWizard follow the steps below a In the Select Your Device screen click the Generate INF file button or click Next b DriverWizard will display information detected for your device Vendor ID Product ID Device Class manufacturer name and device name and allow you to modify this information Jungo Ltd 2005 2010 42 Using DriverWizard Enter Information for INF File Please Fill in the information below for your device This information will be incorporated into the INF file which WinDriver will generate for your device The information you specify will appear in the Device Manager after the installation of the INF file vendor ID 04b4 Device ID 1003 Manufacturer name Cypress Semiconductor Corp Device name DEVICE Device Class WinDriver s unique Class Use this option for a non standard type of device WinDriver will se
152. our site for your specific hardware it is not referenced from the wd1020 cat catalog file and cannot be signed by Jungo a priori When renaming windrvr6 sys and or creating a device specific INF file for your device you have two alternative options regarding your driver s digital signing e Do not digitally sign your driver If you select this option remove or comment out the reference to the wd1020 cat file from the windrvr6 inf file or your renamed version of this file e Submit your driver for WHQL certification or have it Authenticode signed Note that while renaming WinDriver redist windrvr 6 sys nullifies the driver s digital signature the driver is still WHQL compliant and can therefore be submitted for WHQL testing Jungo Ltd 2005 2010 99 Driver Installation Advanced Issues To digitally sign certify your driver follow these steps e Create a new catalog file for your driver as explained in Microsoft s WHQL documentation The new file should reference both windrvr6 sys or your renamed driver and any INF files used in your driver s installation e Assign the name of your new catalog file to the CatalogFile entry in your driver s INF file s You can either change the CatalogFile entry in the windrvr6 inf file to refer to your new catalog file and add a similar entry in your device specific INF file or incorporate both windrvr6 inf and your device INF file into a single INF file that contains such a Catalo
153. owing e Driver installation on systems where installing unsigned drivers has been blocked e Avoiding warnings during driver installation e Full pre installation of INF files 12 1 on Windows XP and higher 64 bit versions of Windows Vista and higher require Kernel Mode Code Signing KMCS of software that loads in kernel mode This has the following implications for WinDriver based drivers e Drivers that are installed via an INF file must be distributed together with a signed catalog file see details in section 12 3 2 e Drivers that are not installed using an INF file must contain an embedded driver signature CA During driver development you can configure Windows to temporarily allow the installation of unsigned drivers For more information about digital driver signing and certification see e Driver Signing Requirements for Windows http www microsoft com whdc winlogo drvsign drvsign mspx e The Introduction to Code Signing topic in the Microsoft Development Network MSDN documentation e Digital Signatures for Kernel Modules on Systems Running Windows Vista and higher http www microsoft com whdc winlogo drvsign kmsigning mspx This white paper contains information about kernel mode code signing test signing and disabling signature enforcement during development Jungo Ltd 2005 2010 97 Driver Installation Advanced Issues 12 3 1 1 Authenticode Driver Signature The Microsoft Authenticode
154. p packets can be found in section 9 2 iii For an input pipe moves data from device to host click Listen to Pipe To successfully accomplish this operation with devices other than HID you need to first verify that the device sends data to the host If no data is sent after listening for a short period of time DriverWizard will notify you that the Transfer Failed To stop reading click Stop Listen to Pipe Alternate Setting 2 Number of Endpoints 2 Pipe Name Pipe Type Information 1 pipe 0x0 Control direction in amp out packet size 64 direction in packet size 512 3 pipe 0x6 Bulk direction out packet size 512 2 Peers Figure 5 8 Listen to Pipe iv For an output pipe moves data from host to device click Write to Pipe A new dialogue box will appear asking you to enter the data to write The DriverWizard log will contain the result of the operation E Alternate Setting 2 r 1 Ko Write to pipe data Hex DE AD BE AF PpeName Poe Type Information Leid Conto drecton in Bout packet size 64 2 end Ak Grecton in packet sze 512 Action Write to Pipe File to Pipe Clear Save Write Data Figure 5 9 Write to Pipe Jungo Ltd 2005 2010 48 Using DriverWizard v You can reset input and output pipes by pressing the Reset Pipe button for the selected pipe 7 Generate the skeletal driver code a Select to generate code either via the Gen
155. pecification byte 0 indicates the length of the descriptor bytes 2 3 contain the USB specification release number byte 7 is the maximum packet size for endpoint 00 bytes 8 9 are the Vendor ID bytes 10 11 are the Product ID etc 9 2 2 Performing Control Transfers with WinDriver WinDriver allows you to easily send and receive control transfers on Pipe00 while using DriverWizard to test your device You can either use the API generated by DriverWizard 5 for your hardware or directly call the WinDriver WOU_Transfer B 4 8 1 function from within your application 9 2 2 1 Control Transfers with DriverWizard 1 Choose Pipe 0x0 and click the Read Write button 2 You can either enter a custom setup packet or use a standard USB request Jungo Ltd 2005 2010 71 USB Transfers e For a custom request enter the required setup packet fields For a write transaction that includes a data stage enter the data in the Write to pipe data Hex field Click Read From Pipe or Write To Pipe according to the required transaction see Figure 9 3 9 Pipe 0 Control Setup Packet Custom request Se Write to pipe data Hex Type Request wYalue windex wLength o o mmm Ip o o0 o0 o0 o0 o0 o0 oo o0 Action Write to Pipe Pipe to File File to Pipe Trace USB transaction in Ellisys Visual USB Figure 9 3 Custom Request Read From Pipe e For a standard USB request select a U
156. r driver as it runs This tool is available both as a fully graphical application WinDriver util wddebug_gui and as a console mode application WinDriver util wddebug The console mode version also supports GUI execution on Windows CE platforms that don t have a command line prompt For details regarding the Debug Monitor refer to section 7 2 e WinDriver distribution package WinDriver redist the files you include in the driver distribution to customers e This manual the full WinDriver manual this document in different formats can be found under the WinDriver docs directory 1 9 2 Utilities e usb_diag exe WinDriver util usb_diag exe enables the user to view the resources of connected USB devices and communicate with the devices transfer data to from the device set the active alternate setting reset pipes etc On Windows the program identifies all devices that have been registered to work with WinDriver using an INF file On the other supported operating systems the program identifies all USB devices connected to the target platform Jungo Ltd 2005 2010 7 WinDriver Overview pci_dump exe WinDriver util pci_dump exe used to obtain a dump of the PCI configuration registers of the installed PCI cards pci_scan exe WinDriver util pci_scan exe used to obtain a list of the PCI cards installed and the resources allocated for each card pemcia_diag exe WinDriver util pemcia_diag exe
157. r makes developing device drivers an easy task that takes hours instead of months Most of this manual deals with the features that WinDriver offers to the advanced user However most developers will find that reading this chapter and glancing through the DriverWizard and function reference chapters is all they need to successfully write their driver WinDriver supports development for all USB chipsets Enhanced support is offered for Cypress Microchip Philips Texas Instruments Agere and Silicon Laboratories USB chipsets as outlined in Chapter 8 of the manual Visit Jungo s web site at http www jungo com for the latest news about WinDriver and other driver development tools that Jungo offers Jungo Ltd 2005 2010 1 WinDriver Overview 1 2 Background 1 2 1 The Challenge In protected operating systems such as Windows and Linux a programmer cannot access hardware directly from the application level user mode where development work is usually done Hardware can only be accessed from within the operating system itself kernel mode or Ring 0 utilizing software modules called device drivers In order to access a custom hardware device from the application level a programmer must do the following Learn the internals of the operating system he is working on Learn how to write a device driver Learn new tools for developing debugging in kernel mode WDK ETK DDI DKI Write the kernel mode device driver that does the ba
158. ransfer B 4 8 1 RETURN VALUE Returns WD_STATUS_SUCCESS 0 on success or an appropriate error code otherwise B 8 B 4 8 5 WDU_Transferlsoch PURPOSE e Performs isochronous data transfer to or from a device PROTOTYPE Jungo Ltd 2005 2010 122 DWORD dwTimeout PARAMETERS See parameters of WOU_Transfer B 4 8 1 Note that pSetupPacket is not a parameter of this function DESCRIPTION See description of WOU_Transfer B 4 8 1 RETURN VALUE Returns WO_STATUS_SUCCESS 0 on success or an appropriate error code otherwise B 8 B 4 8 6 WDU_Transferlnterrupt PURPOSE e Performs interrupt data transfer to or from a device PROTOTYPE DWORD WDU_TransferInterrupt WDU_DEVICE_HANDLE hDevice DWORD dwPipeNum DWORD fRead D D D DWORD dwOptions PVOLD OBUT EEN DWORD dwBufferSize PDWORD pdwBytesTransferred DWORD dwTimeout PARAMETERS See parameters of WOU_Transfer B 4 8 1 Note that pSetupPacket is not a parameter of this function DESCRIPTION See description of WOU_Transfer B 4 8 1 RETURN VALUE Returns WO_STATUS_SUCCESS 0 on success or an appropriate error code otherwise B 8 B 4 9 Streaming Data Transfer Functions This section describes WinDriver s streaming data transfer functions Jungo Ltd 2005 2010 123 For a detailed explanation regarding stream transfers and their implementation with Windri
159. re Kernel Mode Performance WinDriver s API is optimized for performance Jungo Ltd 2005 2010 2 WinDriver Overview 1 3 Conclusion Using WinDriver a developer need only do the following to create an application that accesses the custom hardware Start DriverWizard and detect the hardware and its resources Automatically generate the device driver code from within DriverWizard or use one of the WinDriver samples as the basis for the application see Chapter 8 for an overview of WinDriver s enhanced support for specific chipsets Modify the user mode application as needed using the generated sample functions to implement the desired functionality for your application Your hardware access application will run on all the supported platforms 1 6 just re compile the code for the target platform The code is binary compatible across Windows 7 Vista Server 2008 Server 2003 XP 2000 platforms there is no need to rebuild the code when porting it across binary compatible platforms 1 4 WinDriver Benefits Easy user mode driver development Friendly DriverWizard allows hardware diagnostics without writing a single line of code Automatically generates the driver code for the project in C C Visual Basic NET Delphi Pascal or Visual Basic Supports any USB device regardless of manufacturer Enhanced support for Cypress Microchip Philips Texas Instruments Agere and Silicon Laboratories chipsets frees the dev
160. returned RETURN VALUE Returns WO_STATUS_SUCCESS 0 on success or an appropriate error code otherwise B 8 REMARKS e If the size of the pbBuf buffer is smaller than the size of the string descriptor dwBufSize pdwDescSize the returned descriptor will be truncated to the provided buffer size dwBufSize B 5 USB Data Types The types described in this section are declared in the WinDriver include windrvr h header file unless otherwise specified in the documentation B 5 1 WD DEVICE REGISTRY_PROPERTY Enumeration Enumeration of device registry property identifiers String properties are returned in NULL terminated WCHAR array format For more information regarding the properties described in this enumaration refer to the description of the Windows ToGetDeviceProperty function s DeviceProperty parameter in the Microsoft Development Network MSDN documentation Enum Value Description WdDevicePropertyDeviceDescription Device description WdDevicePropertyHardwareID The device s hardware IDs WdDevicePropertyCompatibleIDs The device s compatible IDs WdDevicePropertyBootConfiguration The hardware resources assigned to the device by the firmware in raw data form Jungo Ltd 2005 2010 137 Enum Value Description WdDevicePropertyBootConfigurationTranslated The hardware resources assigned to the device by the firmware in translated form WdDeviceProper
161. rm blocking transfers will henceforth be referred to as blocking streams and streams that perform non blocking transfers will be referred to as non blocking streams The function s dwRxITxTimeout parameter indicates the desired timeout period for transfers between the stream and the device After opening a stream call WOU_StreamStart B 4 9 2 to begin data transfers between the stream s data buffer and the device In the case of a read stream the driver will constantly read data from the device into the stream s buffer in blocks of a pre defined size as set in the dwRxSize parameter of the WDU_St reamOpen function B 4 9 1 In the case of a write stream the driver will constantly check for data in the stream s data buffer and write any data that is found to the device To read data from a read stream to the user mode host application call WDU_StreamRead B 4 9 3 In case of a blocking stream the read function blocks until the entire amount of data requested by the application is transferred from the stream to the application or until the stream s attempt to read data from the device times out In the case of a non blocking stream the function transfers to the application as much of the requested data as possible subject to the amount of data currently available in the stream s data buffer and returns immediately To write data from the user mode host application to a write the stream call WDU_StreamWrite B 4 9 4
162. rnate setting information structure Field Type Description Descriptor WDU_INTERFACE_DESCRIPTOR Interface descriptor information structure B 5 2 9 Jungo Ltd 2005 2010 141 Field Type Description pEndpointDescriptors WDU_ENDPOINT_DESCRIPTOR Pointer to the beginning of an array of endpoint descriptor information structures B 5 2 10 for the alternate setting s endpoints pPipes WDU_PIPE_INFO Pointer to the beginning of an array of pipe information structures B 5 2 11 for the alternate setting s pipes B 5 2 7 WDU_DEVICE_DESCRIPTOR Structure USB device descriptor information structure Field Type Description bLength UCHAR Size in bytes of the descriptor 18 bytes bDescriptorType UCHAR _ Device descriptor 0x01 bcdUSB USHORT Number of the USB specification with which the device complies bDeviceClass UCHAR The device s class bDeviceSubClass UCHAR The device s sub class bDeviceProtocol UCHAR The device s protocol bMaxPacketSize0 UCHAR Maximum size of transferred packets idVendor USHORT Vendor ID as assigned by USB IF idProduct USHORT Product ID as assigned by the product manufacturer bcdDevice USHORT Device release number iManufacturer UCHAR _ Index of manufacturer string descriptor iProduct UCHAR Index of product string descriptor iSerialNumber UCHAR _
163. rview 1 10 Can I Distribute the Driver Created with WinDriver Yes WinDriver is purchased as a development toolkit and any device driver created using WinDriver may be distributed royalties free in as many copies as you wish See the license agreement at WinDriver docs license pdf for more details Jungo Ltd 2005 2010 9 Chapter 2 Understanding Device Drivers This chapter provides you with a general introduction to device drivers and takes you through the structural elements of a device driver i Using WinDriver you do not need to familiarize yourself with the internal workings of driver development As explained in Chapter 1 of the manual WinDriver enables you to communicate with your hardware and develop a driver for your device from the user mode using only WinDriver s simple APIs without any need for driver or kernel development knowledge 2 1 Device Driver Overview Device drivers are the software segments that provides an interface between the operating system and the specific hardware devices such as terminals disks tape drives video cards and network media The device driver brings the device into and out of service sets hardware parameters in the device transmits data from the kernel to the device receives data from the device and passes it back to the kernel and handles device errors A driver acts like a translator between the device and programs that use the device Each device h
164. s This flag is applicable only to read streams on Windows CE dwRxTxTimeout Maximum time in milliseconds ms for the completion of a data transfer between the stream and the device A value of zero indicates no timeout infinite wait phStream Pointer to a unique identifier for the stream to be returned by the function and passed to the other WOU_St reamXXX functions RETURN VALUE Returns WO_STATUS_SUCCESS 0 on success or an appropriate error code otherwise B 8 B 4 9 2 WDU_ StreamStart PURPOSE Jungo Ltd 2005 2010 125 e Starts a stream i e starts transfers between the stream and the device Data will be transferred according to the streame direction read write PROTOTYPE DWORD DLLCALLCONV WDU_StreamStart WDU_STREAM_HANDLE hStream PARAMETERS Name Type Input Output hStream WDU_STREAM_HANDLE Input DESCRIPTION Name Description hStream A unique identifier for the stream as returned by WDU_St reamOpen RETURN VALUE Returns WO_STATUS_SUCCESS 0 on success or an appropriate error code otherwise B 8 B 4 9 3 WDU_ StreamRead PURPOSE e Reads data from a read stream to the application For a blocking stream fBlocking TRUE see WDU_St reamOpen the call to this function is blocked until the specified amount of data bytes is read or until the stream s attempt to read from the device time
165. s Built in power management and distribution Specific library support for custom USB HID devices 3 3 USB Components The Universal Serial Bus USB consists of the following primary components USB Host The USB host platform is where the USB host controller is installed and where the client software device driver runs The USB Host Controller is the interface between the host and the USB peripherals The host is responsible for detecting the insertion and removal of Jungo Ltd 2005 2010 18 WinDriver USB Overview USB devices managing the control and data flow between the host and the devices providing power to attached devices and more e USB Hub A USB device that allows multiple USB devices to attach to a single USB port on a USB host Hubs on the back plane of the hosts are called root hubs Other hubs are called external hubs e USB Function A USB device that can transmit or receive data or control information over the bus and that provides a function A function is typically implemented as a separate peripheral device that plugs into a port on a hub using a cable However it is also possible to create a compound device which is a physical package that implements multiple functions and an embedded hub with a single USB cable A compound device appears to the host as a hub with one or more non removable USB devices which may have ports to support the connection of external devices 3 4 Data Flow in USB Devices Dur
166. s of WinDriver are 64 bit applications Such applications are more efficient than 32 bit applications However you can also use the 64 bit WinDriver versions to create 32 bit applications that will run on the supported Windows and Linux 64 bit platforms A 1 EH In the following documentation lt WD64 gt signifies the path to a 64 bit WinDriver installation directory for your target operating system and lt WD32 gt signifies the path to a 32 bit WinDriver installation directory for the same operating system To create a 32 bit application for 64 bit Windows or Linux platforms using the 64 bit version of WinDriver do the following 1 Create a WinDriver application as outlined in this manual e g by generating code with DriverWizard or using one of the WinDriver samples 2 Build the application with an appropriate 32 bit compiler for your target OS using the following configuration e Add a KERNEL_64BIT preprocessor definition to your project or makefile CA In the makefiles the definition is added using the D flag DKERNEL_64BIT The sample and wizard generated Linux makefiles and Windows MSDEV projects in the 64 bit WinDriver toolkit already add this definition Jungo Ltd 2005 2010 103 e Link the application with the specific version of the WinDriver API library shared object for 32 bit applications executed on 64 bit platforms lt WD64 gt lib amd64 x86 wdapil020 lib on Windows lt WD64 g
167. s out i e the timeout period for transfers between the stream and the device as set in the dwRxTxTimeout WDU_St reamOpen parameter B 4 9 1 expires For a non blocking stream f Blocking FALSE the function transfers to the application as much of the requested data as possible subject to the amount of data currently available in the stream s data buffer and returns immediately For both blocking and non blocking transfers the function returns the amount of bytes that were actually read from the stream within the pdwBytesRead parameter PROTOTYPE DWORD DLLCALLCONV WDU_StreamRead Jungo Ltd 2005 2010 126 HANDLE hStream PV OTD SPB Ur tens DWORD bytes DWORD pdwBytesRead PARAMETERS Name Type Input Output hStream WDU_STREAM_HANDLE Input pBuffer PVOID Output bytes DWORD Input pdwBytesRead DWORD Output DESCRIPTION Name Description hStream A unique identifier for the stream as returned by WDU_St reamOpen pBuffer Pointer to a data buffer to be filled with the data read from the stream bytes Number of bytes to read from the stream pdwBytesRead Pointer to a value indicating the number of bytes actually read from the stream RETURN VALUE Returns WO_STATUS_SUCCESS 0 on success or an appropriate error code otherwise B 8 B 4 9 4 WDU_StreamWrite PURPOSE e Writes data from the applciation to a write stream For a blocking stre
168. s two isochronous pipes one in each direction USB guarantees the isochronous transfer access to the USB bandwidth i e it reserves the required amount of bytes of the USB frame with bounded latency and guarantees the data transfer rate through the pipe unless there is less data transmitted Since timeliness is more important than correctness in this type of transfer no retries are made in case of error in the data transfer However the data receiver can determine that an error occurred on the bus 3 6 3 Interrupt Transfer Interrupt Transfer is intended for devices that send and receive small amounts of data infrequently or in an asynchronous time frame This transfer type can be used for low full and high speed devices Interrupt transfer type guarantees a maximum service period and that delivery will be re attempted in the next period if there is an error on the bus The interrupt pipe like the isochronous pipe is unidirectional and periodical The maximum packet size for interrupt endpoints can be 8 bytes or less for low speed devices 64 bytes or less for full speed devices and 1 024 bytes or less for high speed devices Jungo Ltd 2005 2010 22 WinDriver USB Overview 3 6 4 Bulk Transfer Bulk Transfer is typically used for devices that transfer large amounts of non time sensitive data and that can use any available bandwidth such as printers and scanners This transfer type can be used by full speed
169. script does not automatically perform the steps of changing the permissions on dev windrvr 6 and the DriverWizard application wdwizard 4 3 Upgrading Your Installation To upgrade to a new version of WinDriver on Windows follow the steps outlined in section 4 2 1 which illustrate the process of installing WinDriver for Windows 7 Vista Server 2008 Server 2003 XP 2000 You can either choose to overwrite the existing installation or install to a separate directory After installation start DriverWizard and enter the new license string if you have received one This completes the upgrade of WinDriver To upgrade your source code pass the new license string as a parameter to WOU_Init B 4 1 or to WO_License when using the old WD_UsbXXxX APIs The procedure for upgrading your installation on other operating systems is the same as the one described above Please check the respective installation sections for installation details Jungo Ltd 2005 2010 36 Installing WinDriver 4 4 Checking Your Installation 4 4 1 Windows and Linux Installation Check 1 Start DriverWizard lt path to WinDriver gt wizard wdwizard On Windows you can also run DriverWizard from the Start menu Start Programs WinDriver Driver Wizard 2 If you are a registerd user make sure that your WinDriver license is registered refer to section 4 2 which explains how to install WinDriver and register your license If
170. shared object uses libwdapil020 so as is the case for the sample and generated DriverWizard WinDriver projects copy this file from the WinDriver lib directory on the development machine to the target s library directory usr lib for 32 bit x86 targets or usr lib64 for 64 bit x86 targets Jungo Ltd 2005 2010 89 Distributing Your Driver If you are distributing a 32 bit application shared object to a target 64 bit platform A 2 copy libwdapil020_32 so from the WinDriver lib directory to your distribution package rename the copy to libwdapi1020 so and copy the renamed file to the target s usr lib directory Since your hardware control application shared object does not have to be matched against the kernel version number you are free to distribute it as binary code if you wish to protect your source code from unauthorized copying or as source code Note that under the license agreement with Jungo you may not distribute the source code of the libwdapil020 so shared object If you select to distribute your source code make sure you do not distribute your WinDriver license string which is used in the code 11 4 3 Installation Script We suggest that you supply an installation shell script to automate the build and installation processes on the target Jungo Ltd 2005 2010 90 Chapter 12 Driver Installation Advanced Issues 12 1 Windows INF Files Device information INF files are text files t
171. sic hardware input output Write the application in user mode that accesses the hardware through the device driver written in kernel mode Repeat the first four steps for each new operating system on which the code should run 1 2 2 The WinDriver Solution Easy Development WinDriver enables Windows Windows CE and Linux programmers to create USB based device drivers in an extremely short time WinDriver allows you to create your driver in the familiar user mode environment using MSDEV Visual C C MSDEV NET Borland C Builder Borland Delphi Visual Basic 6 0 MS eMbedded Visual C MS Platform Builder C GCC or any other appropriate compiler You do not need to have any device driver knowledge nor do you have to be familiar with operating system internals kernel programming the WDK ETK or DDI DKI Cross Platform The driver created with WinDriver will run on Windows 7 Vista Server 2008 Server 2003 XP 2000 Windows CE NET Windows Embedded CE v6 00 Windows Mobile 5 0 6 0 and Linux In other words write it once run it on many platforms Friendly Wizards DriverWizard included is a graphical diagnostics tool that lets you view the device s resources and test the communication with the hardware with just a few mouse clicks before writing a single line of code Once the device is operating to your satisfaction DriverWizard creates the skeletal driver source code giving access functions to all the resources on the hardwa
172. status Device not responding HC status PID check failed WD_USBD_STATUS_UNEXPECTED_PID HC status Unexpected PID Jungo Ltd 2005 2010 166 Status Code Description WD_USBD_STATUS_DATA_ OVERRUN HC status Data overrun WD_USBD_STATUS_DATA_UNDERRUN HC status Data underrun WD_USBD_STATUS_RESERVED1 HC status Reserved WD_USBD_STATUS_RESERVED2 HC status Reserved2 WD_USBD_STATUS_BUFFER_OVERRUN HC status Buffer overrun WD_USBD_STATUS_BUFFER_UNDERRUN WD_USBD_STATUS_NOT_ACCESSED HC status Buffer Underrun HC status Not accessed WD_USBD_STATUS_FIFO HC status FIFO For Windows only WD_USBD_STATUS_XACT_ERROR HC status The host controller has set the Transaction Error XactErr bit in the transfer descriptor s status field WD_USBD_STATUS_BABBLE_ DETECTED HC status Babble detected WD_USBD_STATUS_DATA_BUFFER_ERROR HC status Data buffer error For Windows CE only WD_USBD_STATUS_ISOCH USBD Isochronous transfer failed WD_USBD_STATUS_NOT_COMPLETE USBD Transfer not completed WD_USBD_STATUS_CLIENT_BUFFER USBD Cannot write to buffer For all platforms WD_USBD_STATUS_CANCELED stalled USBD Transfer cancelled Returned by HCD Host Controller Driver if a transfer is submitted to an endpoint that is WD_USBD_STATUS_ENDPOINT_HALTED HCD Transfer submitted to stalled endpoint
173. streaming USB data transfer scheme data is continuously streamed between the host and the device using internal buffers allocated by the host driver streams Stream transfers allow for a sequential data flow between the host and the device and can be used to reduce single blocking transfer overhead which may occur as a result of multiple function calls and context switches between user and kernel modes This is especially relevant for devices with small data buffers which might for example overwrite data before the host is able to read it due to a gap in the data flow between the host and device Jungo Ltd 2005 2010 74 USB Transfers 9 3 3 1 Performing Streaming with WinDriver WinDriver s WOU_St reamXXxX functions described in section B 4 9 of the manual enable you to impelment USB streaming data transfers Note These functions are currently supported on Windows and Windows CE To begin performing stream transfers call the WOU_StreamOpen function B 4 9 1 When this function is called WinDriver creates a new stream object for the specified data pipe You can open a stream for any pipe except for the control pipe Pipe 0 The stream s data transfer direction read write is derived from the direction of its pipe WinDriver supports both blocking and non blocking stream transfers The open function s Blocking parameter indicates which type of transfer to perform see explanation below Streams that perfo
174. stributing Your Driver Legal Issues Geste edegeeegehbg gedeien ees 174 G Additional Documentation ssnsneesoseeseneoeeserssseseserstssssosereeetsssssseseoresessssoserereesssssserreeesssessene 175 Jungo Ltd 2005 2010 viii List of Figures Tale Wim Driver Architecture deeg eebe 4 E Monolithic ge 11 2 23 Layered DOVES eege 12 ER EE 13 SD Bee EE 20 32 EE 21 De Device Descriptors EE 24 3 4 WinDriver USB Architecture neresna i a E EEEE EE NAN 27 Sole Create of Open a WinDriver Projeti EE 41 5 2 Select YOUR EE 42 5 3 DriverWizard INF File Information eege 43 5 4 DriverWizard Multi Interface INF File Information Specific Interface eee 44 5 5 DriverWizard Multi Interface INF File Information Composite Device s s s 45 5 6 Sel ct Deyice REENEN 47 5 1 USB Control hett ee 47 5 9 Listen 0 EE 48 5 9 Write to PINE ee 48 5 10 Code Generation OpPtiOnS sssrin ok n a aea A aa E ede AE 49 5 11 Ellisys Vistial USB Integration Aucune enw eee eee 52 TA Start Debug Monitor geeiertegeggregeeeete or aie a a E EIERE ENS 59 We Pe Debug Er E 60 7 3 wddebug Windows CE Start Log Message sesseesesseseesrsesessiesersresreesresrrerresressesnresressesert 64 7 4 wddebug Windows CE Stop Log Message sessssesesssesssesssssseessetssstesseessesseresseeesseesseesse 65 9 1 USB Data EXehan oeren 67 9 2 USB Re ad and e 69 Ve Custom REgUESt veerassen cs ee ch aee eere Eer e EE E a EEEn RT 72 VE RRS E EE 72 9 5 U
175. structions sseeeeeeseseeseeeeeereeeresrrererrersreseee 29 4 2 2 Windows CE WinDriver Installation Instructions eseeeeeeeeeeeeeseeeeeeerereerersrre 30 4 2 2 1 Installing WinDriver CE when Building New CE Based Platforms 30 4 2 2 2 Installing WinDriver CE when Developing Applications for Windows CE COMBS ES eege AEAEE AEA A EAA aia EE 32 4 2 2 3 Windows CE Installation Note egene ctegeuereureng egbesbeeegeiesgreugeeeeggesggegg 33 4 2 3 Linux WinDriver Installation Instructions seesseseeseeeeseseeseeseessreerrsrrsrerrresresseee 33 4 2 3 1 Preparing the System for Installation cctsccsccsseesscassescacessvessacadauseecasesseeescens 33 BD et AUST TE 34 4 2 3 3 Restricting Hardware Access on Linux ceeceeceeeseeesseceseeeeeeeeaeeenaeens 36 4 3 Upgrading Your Installation TE 36 4 4 Ch king E EE 37 4 4 1 Windows and Linux Installation Check A 37 4 4 2 Windows CE Installation Check E 37 4 5 Uninstalling WinDriver eeneg 37 4 5 1 Windows WinDriver Uninstall Instructions eeeseseeeeeeeeeseeseesressrseresrrssereresresss 37 4 5 2 Linux WinDriver Uninstall Instructions seeeseseeseeeeeeseesesersserresressessrerressersees 39 5 Using Driver EE 40 Di Uh AN E E 40 5 2 DriverWizard Walkthrough E 41 5 2 1 Logging WinDriver API Calls scscasetesetss ueseceytleataesnncezaceddarndeeteesqegs de sieeseucanesastee 50 5 2 2 DriverWizatd LOSSE eege 50 5 2 3 Automatic Code E TEE 50 5 2 3 1 Generating the E 50
176. t lib libwdapi1020_32 so on Linux On Linux the installation of the 64 bit WinDriver toolkit on the development machine creates a libwdapil020 so symbolic link in the usr lib directory which links to lt WD64 gt lib libwdapi1020_32 so and in the usr lib64 directory which links to lt WD64 gt lib libwdapi1020 so the 64 bit version of this shared object The sample and wizard generated WinDriver makefiles rely on these symbolic links to link with the appropriate shared object depending on whether the code is compiled using a 32 bit or 64 bit compiler On Windows the sample and wizard generated MSDEV projects are defined to link with wdapil020 lib see the Addit ionalDependencies but the linker library path refers to the 64 bit library file in the lt WD64 gt lib amd64 directory see AdditionalLibraryDirectories when using such a project to compile a 32 bit application for 64 bit platforms add x86 to the library path in order to link the code with lt WD64 gt lib amd64 x86 wdapil020 lib ui When distributing your application to target 64 bit platforms you need to provide with it the WinDriver API DLL shared object for 32 bit applications executed on 64 bit platforms lt WD64 gt redist wdapi1020_32 dll on Windows lt WD64 gt lib libwdapil020_32 so on Linux Before distributing this file rename the copy of the file in your distribution package by removing the _32 portion The installation on the target
177. t Add to OS design 3 Compile your Windows CE platform Sysgen stage 4 If you did not perform the procedure described in step 2 above perform the following steps after the Sysgen stage in order to manually integrate the driver into your platform Note If you followed the procedure described in step 2 skip this step and go directly to step 5 a Run the Windows CE IDE and open your platform b Select Open Release Directory from the Build menu c Copy the WinDriver CE kernel file WinDriver redist lt TARGET_CPU windrvr6 dll to the _FLATRELEASEDIR sub directory on the target development platform should be the current directory in the new command window d Append the contents of the project_wd reg file in the WinDriver samples wince_install directory to the project reg file in the _FLATRELEASEDIR sub directory e Append the contents of the project_wd bib file in the WinDriver samples wince_install directory to the project bib file in the _FLATRELEASEDIR sub directory This step is only necessary if you want the WinDriver CE kernel file windrvr6 dll to be a permanent part of the Windows CE image NK BIN which is the case if you select to transfer the file to your target platform using a floppy disk If you prefer to have the file windrvr6 dll loaded on demand via the CESH PPSH services you do not need to carry out this step until you build a permanent kernel 5 Select Make Run Time Image from the Build menu
178. t a new Class type for your device Support Message Signaled Interrupts MSI MSI x Automatically install the INF file Note This will replace any existing driver you may have for your device Figure 5 3 DriverWizard INF File Information c For multiple interface USB devices you can select to generate an INF file either for the composite device or for a specific interface e When selecting to generate an INF file for a specific interface of a multi interface USB device the INF information dialogue will indicate for which interface the INF file is generated Jungo Ltd 2005 2010 43 Using DriverWizard Enter Information for INF File Please Fill in the information below For your device This information will be incorporated into the INF file which WinDriver will generate For your device The information you specify will appear in the Device Manager after the installation of the INF file vendor ID o9d9 Device ID Manufacturer name KRF Tech Ltd Device name DEVICE This is a multi interface device Generate INF file for the root device itself Generate INF file for the Following device interfaces Interface 0 Device Class WinDriver s unique Class Use this option for a non standard type of device WinDriver will set a new Class type for your device Support Message Signaled Interrup
179. tation and understand the Windows CE and device driver integration procedure before you perform the installation 1 Modify the project registry file to add an entry for your target device If you select to use the WinDriver component refer to step 2 modify WinDriver samples wince_install lt TARGET_CPU gt WinDriver reg eo WinDriver samples wince_install ARMV4l WinDriver reg e Otherwise modify WinDriver samples wince_install project_wd reg Jungo Ltd 2005 2010 30 Installing WinDriver 2 You can simplify the driver integration into your Windows CE platform by following the procedure described in this step before the Sysgen platform compilation stage Note e The procedure described in this step is relevant only for developers who use Windows CE 4 x 5 x with Platform Builder Developers who use Windows CE 6 x with MSDEV 2005 2008 should skip to the next step refer to step 3 e This procedure provides a convenient method for integrating WinDriver into your Windows CE platform If you select not to use this method you will need to perform the manual integration steps described in step 4 below after the Sysgen stage e The procedure described in this step also adds the WinDriver kernel module windrvr6 dll to your OS image This is a necessary step if you want the WinDriver CE kernel file windrvr6 dll to be a permanent part of the Windows CE image NK BIN which is the case if you select to transfer the fil
180. td 2005 2010 110 Name Description hDevice A unique identifier for the device interface pDevicelnfo Pointer to a USB device information structure B 5 2 3 Valid until the end of the function pUserData Pointer to user mode data for the callback as passed to WDU_Init B 4 1 within the event table parameter pEvent Table gt pUserData RETURN VALUE If the WD_ACKNOWLEDGE flag was set in the call to WOU_Init B 4 1 within the dwOptions parameter the callback function should check if it wants to control the device and if so return TRUE otherwise return FALSE If the WO_ACKNOWLEDGE flag was not set in the call to WOU_Init then the return value of the callback function is insignificant B 3 2 WDU_DETACH_CALLBACK PURPOSE e WinDriver calls this function when a controlled device has been detached from the system PROTOTYPE typedef void DLLCALLCONV WDU_DETACH_CALLBACK WDU_DEVICE_HANDLE hDevice PVOID pUserData PARAMETERS Name Type Input Output hDevice WDU_DEVICE_HANDLE Input pUserData PVOID Input DESCRIPTION Name Description hDevice A unique identifier for the device interface pUserData Pointer to user mode data for the callback as passed to WDU_Init B 4 1 within the event table parameter pEvent Table gt pUserData Jungo Ltd 2005 2010 111 RETU
181. tegeugeng te eier ES EEEN Ei 136 B5 USB A E 137 Bal WD_DEVICE_REGISTRY_PROPERTY Enumeration cccc ccccceeseeees 137 B 32 USB SUCUS EE 138 B 5 2 1 WOU_MATCH_TABLE Structure oo cccccecccccceccceeeessnsseeeeeeeens 139 B 5 2 2 WOU_EVENT_TABLE Structure oo ccccccesssececececeesensaeeeeeeeees 140 B 5 2 3 WDU_DEVICE Structure 140 B 5 2 4 WOU_CONFIGURATIION Structure o cccccccesseceeeessececeesseceeeessaes 141 B 5 2 5 WDU_INTERFACE Structure 141 B 5 2 6 WOU_ALTERNATE_SETTING Structure cccccccccesseeceeeteeeeee 141 B 5 2 7 WOU_DEVICE_DESCRIPTOR Structure 0 0 eccecceceeessteeeeeees 142 B 5 2 8 WODU_CONFIGURATION_DESCRIPTOR Structure 0 142 B 5 2 9 WOU_INTERFACE_DESCRIPTOR Structure 143 B 5 2 10 WOU_ENDPOINT_DESCRIPTOR Structure ccccccceeeeceeseeeeee 143 B 5 2 11 WDU_PIPE_INFO Structure cccccceccccccccecsesssscecececeesesensnseseeeeees 144 Bo General WD_xxx FUNCTIONS 0 cececcesessecececeeeesesssaeceeeceeeenensaeseeeceeecsesesaaeeeceeeesenes 144 B 6 1 Calling Sequence WinDriver General Use ecceeeceeceeeeeeeeeeeeeeeeeeeteeeenaeees 144 B62 EE 145 B6 WD EE ne nee er On PP S 146 BOA WD Te EE 147 B03 yy DIU Steet 148 B 6 6 WD Sd EE 149 B67 WD Debus DUMP resnimi peter teenie E EE E REAA Eai 150 B6 Bigs WDS EDD a E E eat pea aca nteaeacennaonerds 151 EE WD LICENSE ees eege 152 B 7 User Mode Utility rn eege eege ee eEEel 154
182. terrupts Jungo Ltd 2005 2010 40 Using DriverWizard e A 32 bit diagnostics program in console mode with which you can diagnose your device This application utilizes the special library functions described above Use this diagnostics program as your skeletal device driver e A project workspace solution that you can use to automatically load all of the project information and files into your development environment For Linux DriverWizard generates the required makefile 5 2 DriverWizard Walkthrough To use DriverWizard 1 Attach your hardware to the computer Attach your device to a USB port on your computer 2 Run DriverWizard and select your device a Start DriverWizard lt path to WinDriver gt wizard wdwizard On Windows you can also run DriverWizard from the Start menu Start Programs WinDriver DriverWizard g On Windows 7 and Vista you must run DriverWizard as administrator b Click New host driver project to start a new project or Open an existing project to open a saved session Choose Your Project WinDriver The World Standard in Driver Development New host driver project Open an existing project a Cancel Figure 5 1 Create or Open a WinDriver Project c Select your Device from the list of devices detected by DriverWizard Jungo Ltd 2005 2010 41 Using DriverWizard Select Your Device Please select your device from th
183. the existing driver and would only do the encryption decryption Layered drivers are sometimes also known as filter drivers and are supported in all operating systems including all Windows platforms and all Unix platforms Jungo Ltd 2005 2010 11 Understanding Device Drivers Wel User Mode Figure 2 2 Layered Drivers 2 2 3 Miniport Drivers A Miniport driver is an add on to a class driver that supports miniport drivers It is used so the miniport driver does not have to implement all of the functions required of a driver for that class The class driver provides the basic class functionality for the miniport driver A class driver is a driver that supports a group of devices of common functionality such as all HID devices or all network devices Miniport drivers are also called miniclass drivers or minidrivers and are supported in the Windows NT 2000 family namely Windows 7 Vista Server 2008 Server 2003 XP 2000 NT 4 0 Jungo Ltd 2005 2010 12 Understanding Device Drivers Application User Mode Kerpel Mode SSAA w N NOIS Framework N SE E Miniport Driver Y N Figure 2 3 Miniport Drivers Windows 7 Vista Server 2008 Server 2003 XP 2000 NT 4 0 provide several driver classes called ports that handle the common functionality of their class It is then up to the user to add only the functionality that has to do with the inner workings of the specific hardwar
184. the file e xxx_device inf A modified version of the standard generated DriverWizard INF file for your device which registers your device with your driver xxx sys You can make additional modifications to this file if you wish such as changing the manufacturer or driver provider strings Jungo Ltd 2005 2010 94 Driver Installation Advanced Issues e wdapil020 dll A copy of the WinDriver API DLL The DLL is copied here in order to simplify the driver distribution allowing you to use the generated xxx redist directory as the main installation directory for your driver instead of the original WinDriver redist directory e sys directory This directory contains files for advanced users who wish to change the properties of their driver file Note Changing the file s properties requires rebuilding of the driver module using the Windows Driver Kit WDK To modify the properties of your xxx sys driver file 1 Verify that the WDK is installed on your development PC or elsewhere on its network and set the BASEDIR environment variable to point to the WDK installation directory 2 Modify the xxx re resources file in the generated sys directory in order to set different driver file properties 3 Rebuild the driver by running the following command ddk_make lt OS gt lt build mode free checked gt For example to build a release version of the driver for Windows XP ddk_make winxp free Note The ddk_make bat
185. tion dwOptions Can be either zero or WD_USB_HARD_ RESET reset the device even if it is not disabled After using this option it is advised to set the interface device using WDU_SetInterface B 4 2 WD_USB_CYCLE_PORT simulate unplugging and replugging of the device prompting the operating system to re enumerate the device without resetting it This option is supported only on Windows XP and higher RETURN VALUE Returns WO_STATUS_SUCCESS 0 on success or an appropriate error code otherwise B 8 REMARKS e WDU_ResetDevice is supported only on Windows and Windows CE beginning with Windows CE 5 0 The WD_USB_CYCLE_PORT option is supported on Windows XP and higher e The function issues a request from the Windows USB driver to reset a hub port provided the Windows USB driver supports this feature B 4 12 WDU_SelectiveSuspend PURPOSE e Submits a request to suspend a given device selective suspend or cancels a previous suspend request PROTOTYPE DWORD DLLCALLCONV WDU_SelectiveSuspend WDU_DEVICE_HANDLE hDevice DWORD dwOptions PARAMETERS Name Type Input Output hDevice WDU_DEVICE_HANDLE Input dwOptions DWORD Input DESCRIPTION Name Description hDevice A unique identifier for the device interface Jungo Ltd 2005 2010 133 Name Description dwOptions Can be set to either of the fo
186. tion to the standard WinDriver API and the DriverWizard code generation capabilities described in this manual which support development of drivers for any USB device WinDriver offers enhanced support for specific USB chipsets The enhanced support includes custom API and sample diagnostics code which are designed specifically for these chipsets WinDriver s enhanced support is currently available for the following chipsets The Cypress EZ USB family Microchip PIC18F4550 Philips PDIUSBD12 Texas Instruments TUSB3410 TUSB3210 TUSB2136 and TUSB5052 Agere USS2828 Silicon Laboratories C805 1F320 8 2 Developing a Driver Using the Enhanced Chipset Support When developing a driver for a device based on one of the enhanced support chipsets 8 1 you can use WinDriver s chipset set specific support by following these steps 1 Locate the sample diagnostics program for your device under the WinDriver chip_vendor chip_name directory Most of the sample diagnostics program names are derived from the sample s main purpose e g download_sample for a firmware download sample and their source code can be found directly under the specific chip_name directory 2 Run the custom diagnostics program to diagnose your device and familiarize yourself with the options provided by the sample program 3 Use the source code of the diagnostics program as your skeletal device driver and modify the code as needed to suit your specific development needs Wh
187. to the boot flags in the PC s boot ini file e Before submitting the file for certification you need to create a new catalog file which lists your driver and specific INF file s and refer to this catalog file from your INF file s as explained above 12 3 2 Jungo Ltd 2005 2010 100 Driver Installation Advanced Issues 12 4 Windows XP Embedded WinDriver Component When creating a Windows XP Embedded image using the Target Designer tool from Microsoft s Windows Embedded Studio you can select the components that you wish to add to your image The added components will be installed automatically during the first boot on the Windows XP Embedded target on which the image is loaded To automatically install the required WinDriver files such as the windrvr6 inf file and the WinDriver kernel driver that it installs windrvr6 sys your device INF file and the WinDriver API DLL wdapi1020 dIl on Windows XP Embedded platforms you can create a relevant WinDriver component and add it to your Windows XP Embedded image WinDriver simplifies this task for you by providing you with a ready made component WinDriver redist xp_embedded wd_component windriver sld To use the provided component follow the steps below i The provided windriver sld component relies on the existence of a wd_files directory in the same directory that holds the component Therefore do not rename the provided WinDriver redist xp_embedded wd_compon
188. to upgrade USB driver code developed with an older version of WinDriver simply skip this section The WDU library s interface is found in the WinDriver include wdu_lib h and WinDriver include windrvr h header files which should be included from any source file that calls the WDU API wdu_lib h already includes windrvr h B 2 1 Calling Sequence for WinDriver USB The WinDriver WDU_xxx USB API is designed to support event driven transfers between your user mode USB application and USB devices This is in contrast to earlier versions in which USB devices were initialized and controlled using a specific sequence of function calls You can implement the three user callback functions specified in the next section WDU_ATTACH_CALLBACK B 3 1 WOU_DETACH_CALLBACK B 3 2 and Jungo Ltd 2005 2010 106 WDU_POWER_CHANGE_CALLBACK B 3 3 at the very least WOU_ATTACH_CALLBACK These functions are used to notify your application when a relevant system event occurs such as the attaching or detaching of a USB device For best performance minimal processing should be done in these functions Your application calls WOU_Init B 4 1 and provides the criteria according to which the system identifies a device as relevant or irrelevant The WOU_Init function must also pass pointers to the user callback functions Your application then simply waits to receive a notification of an event Upon receipt of such a not
189. transka 4 WDU_Uninit B 2 2 Upgrading from the WD_xxx USB API to the WDU_xxx API The WinDriver WDU_xxx USB API provided beginning with version 6 00 is designed to support event driven transfers between your user mode USB application and USB devices This is in contrast to earlier versions in which USB devices were initialized and controlled using a specific sequence of function calls As aresult of this change you will need to modify your USB applications that were designed to interface with earlier versions of WinDriver to ensure that they will work with WinDriver v6 X on all supported platforms and not only on Microsoft Windows You will have to reorganize your application s code so that it conforms with the framework illustrated by the piece of meta code provided in section B 2 1 In addition the functions that collectively define the USB API have been changed The new functions described in the next few sections provide an improved interface between user mode USB applications and the WinDriver kernel module Note that the new functions receive their parameters directly unlike the old functions which received their parameters using a structure The table below lists the legacy functions in the left column and indicates in the right column which function or functions replace s each of the legacy functions Use this table to quickly determine which new functions to use in your new code Problem Solut
190. trol Data Exchange USB control exchange is used to determine device identification and configuration requirements and to configure a device and can also be used for other device specific purposes including control of other pipes on the device Control exchange takes place via a control pipe mainly the default Pipe 0 which always exists The control transfer consists of a setup stage in which a setup packet is sent from the host to the device an optional data stage and a status stage 9 2 1 2 More About the Control Transfer The control transaction always begins with a setup stage The setup stage is followed by zero or more control data transactions data stage that carry the specific information for the requested operation and finally a status transaction completes the control transfer by returning the status to the host During the setup stage an 8 byte setup packet is used to transmit information to the control endpoint of the device The setup packet s format is defined by the USB specification A control transfer can be a read transaction or a write transaction In a read transaction the setup packet indicates the characteristics and amount of data to be read from the device In a write transaction the setup packet contains the command sent written to the device and the number of control data bytes that will be sent to the device in the data stage Refer to Figure 9 2 taken from the USB specification for a sequence of read and
191. ts MSI MSI x Automatically install the INF file Note This will replace any existing driver you may have for your device Figure 5 4 DriverWizard Multi Interface INF File Information Specific Interface e When selecting to generate an INF file for a composite device of a multi interface USB device the INF information dialogue provides you with the option to either generate an INF file for the root device itself or generate an INF file for specific interfaces which you can select from the dialogue Jungo Ltd 2005 2010 44 Using DriverWizard Selecting to generate an INF file for the root device will enable you to handle multiple active interfaces simultaneously Enter Information for INF File Please Fill in the information below For your device This information will be incorporated into the INF file which WinDriver will generate For your device The information you specify will appear in the Device Manager after the installation of the INF file vendor ID E Device ID Manufacturer name KRF Tech Ltd Device name DEVICE This is a multi interface device Generate INF file For the root device itself Generate INF file for the Following device interfaces Interface 2 Interface 0 Device Class WinDriver s unique Class Use this option for a non standard type of device WinDriver will set a new Class type for your de
192. tyClassName The name of the device s setup class in text format WdDevicePropertyClassGuid The GUID for the device s setup class string format WdDevicePropertyDriverKey Name The name of the driver specific registry key WdDeviceProperty Manufacturer Device manufacturer string WdDevicePropertyFriendlyName WdDevicePropertyLocationInformation Friendly device name typically defined by the class installer which can be used to distinguish between two similar devices Information about the device s Location on the bus string format The interpertation of this information is bus specific WdDevicePropertyPhysicalDeviceObjectName The name of the Physical Device Object PDO for the device WdDevicePropertyBusTypeGuid The GUID for the bus to which the device is connected WdDevicePropertyLegacyBusType The bus type e g PCIBus or PCMCIABus WdDevicePropertyBusNumber The legacy bus number of the bus to which the device is connected WdDevicePropertyEnumeratorName The name of the device s enumerator e g PCI or root WdDeviceProperty Address The device s bus address The interpertation of this address is bus specific WdDeviceProperty UINumber A number associated with the device that can be displayed in the user interface WdDevicePropertyInstallState The device s installation state WdDevicePropertyRemovalPolicy The device s current r
193. uires SP2 4 1 2 Windows CE System Requirements An x86 MIPS ARM Windows CE 4 x 5 x Windows CE NET or Windows Embedded CE v6 00 target platform or an ARMV4I Windows Mobile 5 0 6 0 target platform Windows 7 Vista Server 2008 Server 2003 XP 2000 host development platform For Windows CE 4 x 5 0 Microsoft eMbedded Visual C with a corresponding target SDK OR Microsoft Platform Builder with a corresponding BSP Board Support Package for the target platform For Windows Embedded CE 6 0 Microsoft Visual Studio MSDEV NET with the Windows CE 6 0 plugin For Windows Mobile Microsoft Visual Studio MSDEV NET 2005 2008 Jungo Ltd 2005 2010 28 Installing WinDriver 4 1 3 Linux System Requirements e Any 32 bit x86 processor with a Linux 2 4 x or 2 6 x kernel or Any 64 bit x86 AMD64 or Intel EM64T x86_64 processor with a Linux 2 4 x or 2 6 x kernel Jungo strives to support new Linux kernel versions as close as possible to their release To find out the latest supported kernel version refer to the WinDriver release notes found online at http www jungo com st wdver html e A GCC compiler O The version of the GCC compiler should match the compiler version used for building the running Linux kernel e Any 32 bit or 64 bit development environment depending on your target configuration supporting C for user mode e On your development PC glibc2 3 x e libstdc so 5 required for ru
194. um size of packets that can be transferred using this pipe type DWORD Transfer type for this pipe direction DWORD Direction of the transfer USB_DIR_IN or USB_DIR_OUT for isochronous bulk or interrupt pipes e USB_DIR_IN_OUT for control pipes dwInterval DWORD Interval in milliseconds Relevant only to interrupt pipes B 6 General WD_xxx Functions B 6 1 Calling Sequence WinDriver General Use The following is a typical calling sequence for the WinDriver API Jungo Ltd 2005 2010 144 WD_Open WD_Version General WinDriver API PrintDbgMessage W D_DebugAdd WD_Sleep WD_Logxxx ee ee WD Close WinDriver s Hardware Access API Figure BA WinDriver API Calling Sequence e We recommend calling the WinDriver function WD_Version B 6 3 after calling WD_Opend B 6 2 and before calling any other WinDriver function Its purpose is to return the WinDriver kernel module version number thus providing the means to verify that your application is version compatible with the WinDriver kernel module e WD_DebugAdd B 6 6 and WD_Sleep B 6 8 can be called anywhere after WD_Open B 6 2 WD_Open PURPOSE e Opens a handle to access the WinDriver kernel module The handle is used by all WinDriver APIs and therefore must be called before any other WinDriver API is called PROTOTYPE HANDLE WD_Open void
195. unique identifier for a device interface pAddress A pointer to the address number returned by the function RETURN VALUE Returns WD_STATUS_SUCCESS 0 on success or an appropriate error code otherwise B 8 REMARKS e This function is supported only on Windows 2000 and higher B 4 4 WDU_GetDeviceRegistryProperty PURPOSE e Gets the specified registry property of a given USB device Jungo Ltd 2005 2010 115 PROTOTYPE DWORD DLLCALLCONV WD WDU_DEVICE_ U_GetDeviceRegistryProperty HANDLE hDevice EE Et STE EE PDWORD pdwSize WD_DEVICE_REGISTRY_PROPERTY property PARAMETERS Name Type Input Output hDevice WDU_DEVICE_HANDLE Input pBuffer PVOID Output pdwSize PDWORD Input Output property WD_DEVICE_REGISTRY_PROPERTY Input DESCRIPTION Name Description hDevice A unique identifier of the device interface pBuffer Pointer to a user allocated buffer to be filled with the requested registry property The function will fill the buffer only if the buffer size as indicated in the input value of the pdwSize parameter is sufficient i e gt the property s size as returned via pdwSize pBuffer can be set to NULL when using the function only to retrieve the size of the registry property see pdwSize pdwSize As input points to a value indicating the size of the user supplied buffer pBuffer if pBuffer is set to NULL the
196. upportedLangIDs after the function returns e If the size of the pLangIDs array bNumLangIDs is smaller than the number of IDs supported by the device pbNumSupportedLangIDs the function will read and return only the first bNumLangIDs supported language IDs B 4 15 WDU_GetStringDesc PURPOSE e Reads a string descriptor from a device by string index PROTOTYPE DWORD DLLCALLCONV WD U_GetStringDesc WDU_DEVICE_HANDLE hDevice BYTE bStrIndex PBYTE pbBuf DWORD dwBufSize WDU_LANGID langID PDWORD pdwDescSize PARAMETERS Name Type Input Output hDevice WDU_DEVICE_HANDLE Input bStrIndex BYTE Input pbBuf PBYTE Output dwBufSize DWORD Input langID WDU_LANGID Input pdwDescSize PDWORD Output DESCRIPTION Name Description hDevice A unique identifier for the device interface Jungo Ltd 2005 2010 136 Name Description bStrIndex The index of the string descriptor to read pbBuf Pointer to a buffer to be filled with the string descriptor dwBufSize The size of the pbBuf buffer in bytes langID The language ID to be used in the get string descriptor request If this parameter is 0 the request will use the first supported language ID returned by the device pdwDescSize An optional DWORD pointer to be filled with the size of the string descriptor read from the device If NULL the size of the string descriptor will not be
197. ure e pcBuffer Buffer to receive debug messages dwSize Size of buffer in bytes RETURN VALUE Returns WO_STATUS_SUCCESS 0 on success or an appropriate error code otherwise B 8 EXAMPLE char buffer 1024 WD_DEBUG_DUMP dump dump pcBuffer buffer dump dwSize sizeof buffer WD_DebugDump hWD amp dump B 6 8 WD Sleep PURPOSE e Delays execution for a specific duration of time PROTOTYPE DWORD WD_Sleep HANDLE hWD WDESEEEE oSleco PARAMETERS Name Type Input Output hWD HANDLE Input pSleep WD_SLEEP e dwMicroSeconds DWORD Input e dwOptions DWORD Input Jungo Ltd 2005 2010 151 DESCRIPTION Name Description hWD Handle to WinDriver s kernel mode driver as received from WD_Open B 6 2 pSleep Pointer to a sleep information structure e dwMicroSeconds Sleep time in microseconds 1 1 000 000 of a second e dwOptions A bit mask which can be set to either of the following e Zero 0 Busy sleep default OR e SLEEP_NON_BUSY Delay execution without consuming CPU resources Not relevant for under 17 000 micro seconds Less accurate than busy sleep RETURN VALUE Returns WO_STATUS_SUCCESS 0 on success or an appropriate error code otherwise B 8 REMARKS e Example usage to access slow response hardware EXAMPLE WDUSlesp slp BZERO slp slp dwMicroSeconds 200
198. utility is provided under the WinDriver util directory and should be automatically identified by Windows when running the installation command After rebuilding the xxx sys driver copy the new driver file to the generated xxx_installation redist directory 2 Verify that your user mode application calls the WO_DriverName function B 1 with your new driver name before calling any other WinDriver function Note that the sample and generated DriverWizard WinDriver applications already include a call to this function but with the default driver name windrvr6 so all you need to do is replace the driver name that is passed to the function in the code with your new driver name 3 Verify that your user mode driver project is built with the WD_DRIVER_NAME_CHANGE preprocessor flag e g DWD_DRIVER_NAME_CHANGE Note The sample and generated DriverWizard WinDriver kernel projects makefiles already set this preprocessor flag by default 4 Install your new driver by following the instructions in section 11 2 of the manual using the modified files from the generated xxx_installation directory instead of the installation files from the original WinDriver distribution Jungo Ltd 2005 2010 95 Driver Installation Advanced Issues 12 2 2 Linux Driver Renaming DriverWizard automates most of the work of renaming the Linux WinDriver kernel driver windrvr6 0 ko When renaming windrvr6 o ko the win
199. ver refer to 9 3 3 of the manual Ai The streaming APIs are currently supported on Windows and Windows CE B 4 9 1 WDU_StreamOpen PURPOSE e Opens a new stream for the specified pipe A stream can be associated with any pipe except for the control pipe Pipe 0 The stream s data transfer direction read write is derived from the direction of its pipe PROTOTYPE DWORD DLLCALLCONV WD U_StreamOpen BOOL fBlocking DWORD dwOptions DWORD dwRxTxTimeout WDU_DEVICE_HANDLE hDevice DWORD dwPipeNum DWORD dwBufferSize DWORD dwRxSize WDU_STREAM_HANDLE phStream PARAMETERS Name Type Input Output hDevice WDU_DEVICE_HANDLE Input dwPipeNum DWORD Input dwBufferSize DWORD Input dwRxSize DWORD Input fBlocking BOOL Input dwOptions DWORD Input dwRxTxTimeout DWORD Input phStream WDU_STREAM_HANDLE Output DESCRIPTION Name Description hDevice A unique identifier for the device interface dwPipeNum The number of the pipe for which to open the stream dwBufferSize The size in bytes of the stream s data buffer Jungo Ltd 2005 2010 124 Name Description dwRxSize The size in bytes of the data blocks that the stream reads from the device This parameter is relevant only for read streams and must not exceed the value of the dwBufferSize parameter Note When setting the USB_STREAM MAX TRANSFER_SIZE_OVERWR
200. very operation the WinDriver kernel performs Jungo Ltd 2005 2010 60 Debugging Drivers e Send debug messages to the operating system kernel debugger Select this option to send the debug messages received from the WinDriver kernel module to an external kernel debugger in addition to the Debug Monitor On Windows 7 and Vista the first time that you enable this option you will need to restart the PC A free Windows kernel debugger WinDbg is distributed with the Windows Driver Kit WDK and is part of the Debugging Tools for Windows package distributed via the Microsoft web site e a 3 Once you have defined what you want to trace and on what level click OK to close the Debug Options window 4 Activate your application step by step or in one run 5 Watch the Debug Monitor log or the kernel debugger log if enabled for errors or any unexpected messages 7 2 1 1 Running wddebug_ gui for a Renamed Driver By default wddebug_gui logs messages from the default WinDriver kernel module windrvr6 sys o ko However you can also use wddebug_gui to log debug messages from a renamed version of this driver 12 2 by running wddebug_gui from the command line with the driver_name option wddebug_gui lt driver_name gt _ The driver name should be set to the name of the driver file without the file s extension e g Windrvr6 not windrvr6 sys on Windows or windrvr6 o on Linux
201. vice Support Message Signaled Interrupts MSI MSI x Automatically install the INF File Note This will replace any existing driver you may have for your device Figure 5 5 DriverWizard Multi Interface INF File Information Composite Device d When you are done click Next and choose the directory in which you wish to store the generated INF file DriverWizard will then automatically generate the INF file for you Jungo Ltd 2005 2010 45 Using DriverWizard You can choose to automatically install the INF file by checking the Automatically Install the INF file option in the DriverWizard s INF generation dialogue If the automatic INF file installation fails DriverWizard will notify you and provide manual installation instructions refer also the manual INF file installation instructions in section 12 1 e When the INF file installation completes select and open your device from the list in the Select Your Device screen 4 Uninstall the INF file of your device You can use the Uninstall option to uninstall the INF file of your device Once you uninstall the INF file the device will no longer be registered to work with the windrvr6 sys and the INF file will be deleted from the Windows root directory If you do not need to uninstall an INF file skip this step and proceed to the next one a In the Select Your Device screen click the Uninstall INF file button b Select the INF file to be removed
202. write transactions in indicates data flow from the device to the host out indicates data flow from the host to the device Jungo Ltd 2005 2010 68 USB Transfers Setup Data Stage Stage Optional Status Control ie Setup Data Stage Stage Optional Status Control co seip Status Stage Control Figure 9 2 USB Read and Write 9 2 1 3 The Setup Packet The setup packets combined with the control data stage and the status stage are used to configure and send commande to the device Chapter 9 of the USB specification defines standard device requests USB requests such as these are sent from the host to the device using setup packets The USB device is required to respond properly to these requests In addition each vendor may define device specific setup packets to perform device specific operations The standard setup packets standard USB device requests are detailed below The vendor s device specific setup packets are detailed in the vendor s data book for each USB device 9 2 1 4 USB Setup Packet Format The table below shows the format of the USB setup packet For more information please refer to the USB specification at http www usb org Byte Field Description 0 bmRequest Type Bit 7 Request direction 0 Host to device Out 1 Device to host In Bits 5 6 Request type O standard 1 class 2 vendor 3 reserved Bits 0 4 Recipient O device 1 interface 2 endpoint
203. y are called file operations Each registered callback is called by the operating system as a result of some criteria such as disconnection of hardware for example 2 5 Associating the Hardware with the Driver Operating systems differ in the ways they associate a device with a specific driver In Windows the hardware driver association is performed via an INF file which registers the device to work with the driver This association is performed before the DriverEntry routine is called The operating system recognizes the device checks its database to identify which INF file is associated with the device and according to the INF file calls the driver s entry point In Linux the hardware driver association is defined in the driver s init_module routine This routine includes a callback that indicates which hardware the driver is designated to handle The operating system calls the driver s entry point based on the definition in the code 2 6 Communicating with Drivers Communication between a user mode application and the driver that drives the hardware is implemented differently for each operating system using the the custom OS Application Programming Interfaces APIs On Windows Windows CE and Linux the application can use the OS file access API to open a handle to the driver eg using the Windows Creat eFile function or using the Linux open function and then read and write from to the device by passing the han
204. y one device descriptor for each USB device Each device has one or more configurations each configuration has one or more interfaces and each interface has zero or more endpoints as demonstrated in Figure 3 3 below Jungo Ltd 2005 2010 23 WinDriver USB Overview Device Descriptor Configuration Descriptor g Configuration Descriptor Interface Descriptor g Interface Descriptor n Endpoint Endpoint Descriptor Descriptor Figure 3 3 Device Descriptors e Device Level The device descriptor includes general information about the USB device i e global information for all of the device configurations The device descriptor identifies among other things the device class HID device hub locator device etc subclass protocol code vendor ID device ID and more Each USB device has one device descriptor e Configuration Level A USB device has one or more configuration descriptors Each descriptor identifies the number of interfaces grouped in the configuration and the power attributes of the configuration such as self powered remote wakeup maximum power consumption and more Only one configuration can be loaded at a given time For example an ISDN adapter might have two different configurations one that presents it with a single interface of 128 Kb s and a second that presents it with two interfaces of 64 Kb s each e Interface Level The interface
205. you are an evaluation version user you do not need to register a license 4 4 2 Windows CE Installation Check 1 Copy the console mode Debug Monitor utility WinDriver util wddebug lt TARGET_CPU gt wddebug exe from the host Windows machine to a directory on your target Windows CE device 2 Run the Debug Monitor with the status command on the target device wddebug exe status If the windriver installation was successful the application will display information regarding the Debug Monitor version and current status the running WinDriver kernel module and general system information 4 5 Uninstalling WinDriver This section will help you to uninstall either the evaluation or registered version of WinDriver 4 5 1 Windows WinDriver Uninstall Instructions You can select to use the graphical wdreg_gui exe utility instead of wdreg exe O wdreg exe and wdreg_gui exe are found in the WinDriver util directory see Chapter 10 for details regarding these utilities 1 Close any open WinDriver applications including DriverWizard the Debug Monitor and user specific applications 2 Uninstall all Plug and Play devices USB PCI PCMCIA that have been registered with WinDriver via an INF file e Uninstall the device using the wdreg utility wdreg inf lt path to the INF file gt uninstall e Verify that no INF files that register your device s with WinDriver s kernel module windrvr6 sys are found in the windir
206. you choose to write your driver directly without using DriverWizard In such cases either follow the steps outlined in this section to create a new driver project or use one of the WinDriver samples which most closely resembles your target driver and modify the sample to suit your specific requirements 6 2 1 Include the Required WinDriver Files 1 Include the relevant WinDriver header files in your driver project All header files are found under the WinDriver include directory All WinDriver projects require the windrvr h header file When using the WOU_xxx WinDriver USB API B 2 include the wdu_lib h header file this file already includes windrvr h Include any other header file that provides APIs that you wish to use from your code e g files from the WinDriver samples shared directory which provide convenient diagnostics functions 2 Include the relevant header files from your source code For example to use the USB API from the wdu_lib h header file add the following line to the code include wdu_lib h 3 Link your code with the WDAPI library Windows shared object Linux e For Windows 7 Vista Server 2008 Server 2003 XP 2000 WinDriver lib lt CPU gt wdapil020 lib or wdapi1020_borland lib for Borland C Builder where the lt CPU gt directory is either x86 32 bit binaries for x86 platforms amd64 64 bit binaries for x64 platforms or amd64 x86 32 bit binaries for x64 platforms A 2 e For Windows
207. ys driver nullifies its signature In such cases you can select either to sign your new driver or to distribute an unsigned driver For more information on driver signing and certification refer to 12 3 For guidelines for signing and certifying your renamed driver refer to section 12 3 2 a References to xxx in this section should be replaced with the name of your generated DriverWizard driver project To rename your Windows WinDriver kernel driver follow these steps 1 Use the DriverWizard utility to generate driver code for your hardware on Windows refer to section 5 2 step 7 using your preferred driver name xxx as the name of the generated driver project The generated project directory xxx will include an xxx_installation directory with the following files and directories e redist directory e xxx sys Your new driver which is actually a renamed copy of the windrvr6 sys driver Note The properties of the generated driver file such as the file s version company name etc are identical to the properties of the original windrvr6 sys driver You can rebuild the driver with new properties using the files from the generated xxx_installation sys directory as explained below e xxx driver inf A modified version of the windrvr6 inf file which will be used to install your new xxx sys driver You can make additional modifications to this file if you wish namely changing the string definitions and or comments in
208. zard 5 Debug Monitor 7 2 you must also have version 5 0 of the libstdc library libstdc so 5 If you do not have this file install it from the relevant RPM in your Linux distribution e g compat libstdc Before proceeding with the installation you must also make sure that you have a linux symbolic link If you do not create one by typing usr src ln s lt target kernel gt linux For example for the Linux 2 4 kernel type usr src ln s linux 2 4 linux 4 2 3 2 Installation 1 Insert the WinDriver CD into your Linux machine s CD drive or copy the downloaded file to your preferred directory 2 Change directory to your preferred installation directory for example to your home directory cd 3 Extract the WinDriver distribution file WD1020LN tgz tar xvzf lt file location gt WD1020LN tgz For example e From a CD tar xvzf mnt cdrom LINUX WD1020LN tgz Jungo Ltd 2005 2010 34 Installing WinDriver e From a downloaded file tar xvzf home username WD1020LN tgz 4 Change directory to your WinDriver redist directory the tar automatically creates a WinDriver directory cd lt WinDriver directory path gt redist 5 Install WinDriver a lt WinDriver directory gt redist configure The configure script creates a makefile based on your specific running kernel You may run the configure script based on another kernel source you have installed by adding the fl
209. zard first lets you choose the desired configuration interface and alternate setting combination using a friendly graphical user interface After detecting and configuring your USB device you can proceed to test the communication with the device perform data transfers on the pipes send control requests reset the pipes etc in order to ensure that all your hardware resources function as expected After your hardware is diagnosed you can use DriverWizard to automatically generate your device driver source code in C C Visual Basic NET Delphi or Visual Basic WinDriver USB provides user mode APIs which you can call from within your application in order to implement the communication with your device The WinDriver USB API includes USB unique operations such as reset of a pipe or a device The generated DriverWizard code implements a diagnostics application which demonstrates how to use WinDriver s USB API to drive your specific device In order to use the application you just need to compile and run it You can jump start your development cycle by using this application as your skeletal driver and then modifying the code as needed to implement the desired driver functionality for your specific device DriverWizard also automates the creation of an INF file that registers your device to work with WinDriver which is an essential step in order to correctly identify and handle USB devices using WinDriver For an explanation on why you nee

WinDriver™ USB User`s Manual - Version 10.2.0

Contents

Download Pdf Manuals

Related Search

Related Contents

WinDriver&trade; USB User`s Manual - Version 10.2.0

Contents

Download Pdf Manuals

Related Search

Related Contents

WinDriver™ USB User`s Manual - Version 10.2.0