第1页 / 共333页
第2页 / 共333页
第3页 / 共333页
第4页 / 共333页
第5页 / 共333页
第6页 / 共333页
第7页 / 共333页
第8页 / 共333页
windriver 驱动.pdf
WinDriver™ PCI/ISA User's Manual
Table of Contents
List of Figures
Chapter 1. WinDriver Overview
1.1. Introduction to WinDriver
1.2. Background
1.2.1. The Challenge
1.2.2. The WinDriver Solution
1.3. How Fast Can WinDriver Go?
1.4. Conclusion
1.5. WinDriver Benefits
1.6. WinDriver Architecture
1.7. What Platforms Does WinDriver Support?
1.8. Limitations of the Different Evaluation Versions
1.9. How Do I Develop My Driver with WinDriver?
1.9.1. On Windows and Linux
1.10. What Does the WinDriver Toolkit Include?
1.10.1. WinDriver Modules
1.10.2. Utilities
1.10.3. Samples and Enhanced-Support Chipset APIs
1.10.3.1. Enhanced Chipset Support
1.11. Can I Distribute the Driver Created with WinDriver?
Chapter 2. Understanding Device Drivers
2.1. Device Driver Overview
2.2. Classification of Drivers According to Functionality
2.2.1. Monolithic Drivers
2.2.2. Layered Drivers
2.2.3. Miniport Drivers
2.3. Classification of Drivers According to Operating Systems
2.3.1. WDM Drivers
2.3.2. Unix Device Drivers
2.3.3. Linux Device Drivers
2.4. The Entry Point of the Driver
2.5. Associating the Hardware with the Driver
2.6. Communicating with Drivers
Chapter 3. Installing WinDriver
3.1. System Requirements
3.1.1. Windows System Requirements
3.1.2. Linux System Requirements
3.2. WinDriver Installation Process
3.2.1. Windows WinDriver Installation Instructions
3.2.2. Linux WinDriver Installation Instructions
3.2.2.1. Preparing the System for Installation
3.2.2.2. Installation
3.2.2.3. Restricting Hardware Access on Linux
3.3. Upgrading Your Installation
3.4. Checking Your Installation
3.4.1. Windows and Linux Installation Check
3.5. Uninstalling WinDriver
3.5.1. Windows WinDriver Uninstall Instructions
3.5.2. Linux WinDriver Uninstall Instructions
Chapter 4. Using DriverWizard
4.1. An Overview
4.2. DriverWizard Walkthrough
4.2.1. Automatic Code Generation
4.2.1.1. Generating the Code
4.2.1.2. The Generated PCI/ISA C Code
4.2.2. Compiling the Generated Code
4.2.2.1. Windows Compilation
4.2.2.2. Linux Compilation
Chapter 5. Developing a Driver
5.1. Using DriverWizard to Build a Device Driver
5.2. Writing the Device Driver Without DriverWizard
5.2.1. Include the Required WinDriver Files
5.2.2. Write Your Code
5.2.3. Configure and Build Your Code
Chapter 6. Debugging Drivers
6.1. User-Mode Debugging
6.2. Debug Monitor
6.2.1. The wddebug_gui Utility
6.2.1.1. Running wddebug_gui for a Renamed Driver
6.2.2. The wddebug Utility
6.2.2.1. Console-Mode wddebug Execution
Chapter 7. Enhanced Support for Specific Chipsets
7.1. Overview
7.2. Developing a Driver Using the Enhanced Chipset Support
Chapter 8. PCI Express
8.1. PCI Express Overview
8.2. WinDriver for PCI Express
Chapter 9. Advanced Issues
9.1. Performing Direct Memory Access (DMA)
9.1.1. Implementing Scatter/Gather DMA
9.1.2. Implementing Contiguous-Buffer DMA
9.1.2.1. Preallocating Contiguous DMA Buffers on Windows
9.2. Handling Interrupts
9.2.1. Interrupt Handling — Overview
9.2.2. WinDriver Interrupt Handling Sequence
9.2.3. Registering IRQs for Non-Plug-and-Play Hardware on Windows 7 and Higher
9.2.4. Determining the Interrupt Types Supported by the Hardware
9.2.5. Determining the Interrupt Type Enabled for a PCI Card
9.2.6. Setting Up Kernel-Mode Interrupt Transfer Commands
9.2.6.1. Interrupt Mask Commands
9.2.6.2. Sample WinDriver Transfer Commands Code
9.2.7. WinDriver MSI/MSI-X Interrupt Handling
9.2.7.1. Windows MSI/MSI-X Device INF Files
9.2.8. Sample User-Mode WinDriver Interrupt Handling Code
9.3. Buffer sharing between multiple processes
Chapter 10. Improving Performance
10.1. Overview
10.1.1. Performance Improvement Checklist
10.2. Improving the Performance of a User-Mode Driver
10.2.1. Using Direct Access to Memory-Mapped Regions
10.2.2. Block Transfers and Grouping Multiple Transfers
10.2.3. Performing 64-Bit Data Transfers
Chapter 11. Understanding the Kernel PlugIn
11.1. Background
11.2. Do I Need to Write a Kernel PlugIn Driver?
11.3. What Kind of Performance Can I Expect?
11.4. Overview of the Development Process
11.5. The Kernel PlugIn Architecture
11.5.1. Architecture Overview
11.5.2. WinDriver's Kernel and Kernel PlugIn Interaction
11.5.3. Kernel PlugIn Components
11.5.4. Kernel PlugIn Event Sequence
11.5.4.1. Opening a Handle from the User Mode to a Kernel PlugIn Driver
11.5.4.2. Handling User-Mode Requests from the Kernel PlugIn
11.5.4.3. Interrupt Handling — Enable/Disable and High Interrupt Request Level Processing
11.5.4.4. Interrupt Handling — Deferred Procedure Calls
11.5.4.5. Plug-and-Play and Power Management Events
11.6. How Does Kernel PlugIn Work?
11.6.1. Minimal Requirements for Creating a Kernel PlugIn Driver
11.6.2. Kernel PlugIn Implementation
11.6.2.1. Before You Begin
11.6.2.2. Write Your KP_Init Function
11.6.2.3. Write Your KP_Open Function(s)
11.6.2.4. Write the Remaining PlugIn Callbacks
11.6.3. Sample/Generated Kernel PlugIn Driver Code Overview
11.6.4. Kernel PlugIn Sample/Generated Code Directory Structure
11.6.4.1. pci_diag and kp_pci Sample Directories
11.6.4.2. The Generated DriverWizard Kernel PlugIn Directory
11.6.5. Handling Interrupts in the Kernel PlugIn
11.6.5.1. Interrupt Handling in the User Mode (Without the Kernel PlugIn)
11.6.5.2. Interrupt Handling in the Kernel (Using the Kernel PlugIn)
11.6.6. Message Passing
Chapter 12. Creating a Kernel PlugIn Driver
12.1. Determine Whether a Kernel PlugIn is Needed
12.2. Prepare the User-Mode Source Code
12.3. Create a New Kernel PlugIn Project
12.4. Open a Handle to the Kernel PlugIn
12.5. Set Interrupt Handling in the Kernel PlugIn
12.6. Set I/O Handling in the Kernel PlugIn
12.7. Compile Your Kernel PlugIn Driver
12.7.1. Windows Kernel PlugIn Driver Compilation
12.7.2. Linux Kernel PlugIn Driver Compilation
12.8. Install Your Kernel PlugIn Driver
12.8.1. Windows Kernel PlugIn Driver Installation
12.8.2. Linux Kernel PlugIn Driver Installation
Chapter 13. Dynamically Loading Your Driver
13.1. Why Do You Need a Dynamically Loadable Driver?
13.2. Windows Dynamic Driver Loading
13.2.1. The wdreg Utility
13.2.1.1. WDM Drivers
13.2.1.2. Non-WDM Drivers
13.2.2. Dynamically Loading/Unloading windrvr1260.sys INF Files
13.2.3. Dynamically Loading/Unloading Your Kernel PlugIn Driver
13.3. Linux Dynamic Driver Loading
13.3.1. Dynamically Loading/Unloading Your Kernel PlugIn Driver
Chapter 14. Distributing Your Driver
14.1. Getting a Valid WinDriver License
14.2. Windows Driver Distribution
14.2.1. Preparing the Distribution Package
14.2.2. Installing Your Driver on the Target Computer
14.2.3. Installing Your Kernel PlugIn on the Target Computer
14.3. Linux Driver Distribution
14.3.1. Preparing the Distribution Package
14.3.1.1. Kernel Module Components
14.3.1.2. User-Mode Hardware-Control Application or Shared Object
14.3.2. Building and Installing the WinDriver Driver Module on the Target
14.3.3. Building and Installing Your Kernel PlugIn Driver on the Target
14.3.4. Installing the User-Mode Hardware-Control Application or Shared Object
Chapter 15. Driver Installation — Advanced Issues
15.1. Windows INF Files
15.1.1. Why Should I Create an INF File?
15.1.2. How Do I Install an INF File When No Driver Exists?
15.1.3. How Do I Replace an Existing Driver Using the INF File?
15.2. Renaming the WinDriver Kernel Driver
15.2.1. Windows Driver Renaming
15.2.2. Linux Driver Renaming
15.3. Windows Digital Driver Signing and Certification
15.3.1. Overview
15.3.1.1. Authenticode Driver Signature
15.3.1.2. Windows Certification Program
15.3.2. Driver Signing and Certification of WinDriver-Based Drivers
15.3.2.1. HCK Test Notes
Appendix A. 64-Bit Operating Systems Support
A.1. Supported 64-Bit Architectures
A.2. Support for 32-Bit Applications on 64-Bit Windows and Linux Platforms
A.3. 64-Bit and 32-Bit Data Types
Appendix B. API Reference
B.1. WD_DriverName
B.2. WDC Library Overview
B.3. WDC High-Level API
B.3.1. Structures, Types and General Definitions
B.3.1.1. WDC_DEVICE_HANDLE
B.3.1.2. WDC_DRV_OPEN_OPTIONS Definitions
B.3.1.3. WDC_DIRECTION Enumeration
B.3.1.4. WDC_ADDR_MODE Enumeration
B.3.1.5. WDC_ADDR_RW_OPTIONS Enumeration
B.3.1.6. WDC_ADDR_SIZE Definitions
B.3.1.7. WDC_SLEEP_OPTIONS Definitions
B.3.1.8. WDC_DBG_OPTIONS Definitions
B.3.1.9. WDC_PCI_SCAN_RESULT Structure
B.3.1.10. WDC_PCI_SCAN_CAPS_RESULT Structure
B.3.2. WDC_DriverOpen()
B.3.3. WDC_DriverClose()
B.3.4. WDC_PciScanDevices()
B.3.5. WDC_PciScanDevicesByTopology()
B.3.6. WDC_PciScanRegisteredDevices()
B.3.7. WDC_PciScanCaps()
B.3.8. WDC_PciScanCapsBySlot()
B.3.9. WDC_PciScanExtCaps()
B.3.10. WDC_PciGetExpressGen()
B.3.11. WDC_PciGetExpressGenBySlot()
B.3.12. WDC_PciGetExpressOffset()
B.3.13. WDC_PciGetHeaderType()
B.3.14. PciConfRegData2Str()
B.3.15. PciExpressConfRegData2Str()
B.3.16. WDC_PciGetDeviceInfo()
B.3.17. WDC_PciDeviceOpen()
B.3.18. WDC_IsaDeviceOpen()
B.3.19. WDC_PciDeviceClose()
B.3.20. WDC_IsaDeviceClose()
B.3.21. WDC_CardCleanupSetup()
B.3.22. WDC_KernelPlugInOpen()
B.3.23. WDC_CallKerPlug()
B.3.24. WDC_ReadMemXXX()
B.3.25. WDC_WriteMemXXX()
B.3.26. WDC_ReadAddrXXX()
B.3.27. WDC_WriteAddrXXX()
B.3.28. WDC_ReadAddrBlock()
B.3.29. WDC_WriteAddrBlock()
B.3.30. WDC_MultiTransfer()
B.3.31. WDC_AddrSpaceIsActive()
B.3.32. WDC_PciReadCfgBySlot()
B.3.33. WDC_PciWriteCfgBySlot()
B.3.34. WDC_PciReadCfg()
B.3.35. WDC_PciWriteCfg()
B.3.36. WDC_PciReadCfgBySlotXXX()
B.3.37. WDC_PciWriteCfgBySlotXXX()
B.3.38. WDC_PciReadCfgXXX()
B.3.39. WDC_PciWriteCfgXXX()
B.3.40. WDC_DMAContigBufLock()
B.3.41. WDC_DMASGBufLock()
B.3.42. WDC_DMAReservedBufLock()
B.3.43. WDC_DMABufUnlock()
B.3.44. WDC_DMABufGet()
B.3.45. WDC_DMAGetGlobalHandle Macro
B.3.46. WDC_DMASyncCpu()
B.3.47. WDC_DMASyncIo()
B.3.48. WDC_IntEnable()
B.3.49. WDC_IntDisable()
B.3.50. WDC_IntIsEnabled()
B.3.51. WDC_IntType2Str()
B.3.52. WDC_EventRegister()
B.3.53. WDC_EventUnregister()
B.3.54. WDC_EventIsRegistered()
B.3.55. WDC_SetDebugOptions()
B.3.56. WDC_Err()
B.3.57. WDC_Trace()
B.3.58. WDC_GetWDHandle()
B.3.59. WDC_GetDevContext()
B.3.60. WDC_GetBusType()
B.3.61. WDC_Sleep()
B.3.62. WDC_Version()
B.4. WDC Low-Level API
B.4.1. WDC_ADDR_DESC Structure
B.4.2. WDC_DEVICE Structure
B.4.3. PWDC_DEVICE
B.4.4. WDC_MEM_DIRECT_ADDR Macro
B.4.5. WDC_ADDR_IS_MEM Macro
B.4.6. WDC_GET_ADDR_DESC Macro
B.4.7. WDC_GET_ADDR_SPACE_SIZE Macro
B.4.8. WDC_GET_ENABLED_INT_TYPE Macro
B.4.9. WDC_GET_INT_OPTIONS Macro
B.4.10. WDC_INT_IS_MSI Macro
B.4.11. WDC_GET_ENABLED_INT_LAST_MSG Macro
B.4.12. WDC_IS_KP Macro
B.5. WDS Library Overview
B.6. WDS High-Level API
B.6.1. WDS_SharedBufferAlloc()
B.6.2. WDS_SharedBufferFree()
B.6.3. WDS_SharedBufferGet()
B.6.4. WDS_SharedBufferGetGlobalHandle Macro
B.7. WD_xxx Structures, Types and General Definitions
B.7.1. WD_BUS_TYPE Enumeration
B.7.2. ITEM_TYPE Enumeration
B.7.3. WD_PCI_ID Structure
B.7.4. WD_PCI_SLOT Structure
B.7.5. WD_PCI_CAP Structure
B.7.6. WD_ITEMS Structure
B.7.7. WD_CARD Structure
B.7.8. WD_PCI_CARD_INFO Structure
B.7.9. WD_DMA Structure
B.7.10. WD_TRANSFER Structure
B.7.11. WD_KERNEL_BUFFER Structure
B.8. Kernel PlugIn Kernel-Mode Functions
B.8.1. KP_Init
B.8.2. KP_Open
B.8.3. KP_Close
B.8.4. KP_Call
B.8.5. KP_Event
B.8.6. KP_IntEnable
B.8.7. KP_IntDisable
B.8.8. KP_IntAtIrql
B.8.9. KP_IntAtDpc
B.8.10. KP_IntAtIrqlMSI
B.8.11. KP_IntAtDpcMSI
B.8.12. COPY_TO_USER_OR_KERNEL, COPY_FROM_USER_OR_KERNEL
B.8.13. Kernel PlugIn Synchronization APIs
B.8.13.1. Kernel PlugIn Synchronization Types
B.8.13.2. kp_spinlock_init()
B.8.13.3. kp_spinlock_wait()
B.8.13.4. kp_spinlock_release()
B.8.13.5. kp_spinlock_uninit()
B.8.13.6. kp_interlocked_init()
B.8.13.7. kp_interlocked_uninit()
B.8.13.8. kp_interlocked_increment()
B.8.13.9. kp_interlocked_decrement()
B.8.13.10. kp_interlocked_add()
B.8.13.11. kp_interlocked_read()
B.8.13.12. kp_interlocked_set()
B.8.13.13. kp_interlocked_exchange()
B.9. Kernel PlugIn Structure Reference
B.9.1. WD_KERNEL_PLUGIN
B.9.2. WD_INTERRUPT
B.9.3. WD_KERNEL_PLUGIN_CALL
B.9.4. KP_INIT
B.9.5. KP_OPEN_CALL
B.10. User-Mode Utility Functions
B.10.1. Stat2Str
B.10.2. get_os_type
B.10.3. ThreadStart
B.10.4. ThreadWait
B.10.5. OsEventCreate
B.10.6. OsEventClose
B.10.7. OsEventWait
B.10.8. OsEventSignal
B.10.9. OsEventReset
B.10.10. OsMutexCreate
B.10.11. OsMutexClose
B.10.12. OsMutexLock
B.10.13. OsMutexUnlock
B.10.14. PrintDbgMessage
B.10.15. WD_LogStart
B.10.16. WD_LogStop
B.10.17. WD_LogAdd
B.11. WinDriver Status Codes
B.11.1. Introduction
B.11.2. Status Codes Returned by WinDriver
Appendix C. WinDriver IPC
C.1. WinDriver IPC Overview
C.2. WinDriver IPC API Reference
C.2.1. IPC_MSG_RX_HANDLER()
C.2.2. WDS_IpcRegister()
C.2.3. WDS_IpcUnRegister()
C.2.4. WDS_IsIpcRegistered()
C.2.5. WDS_IpcScanProcs()
C.2.6. WDS_IpcMulticast()
C.2.7. WDS_IpcSubGroupMulticast()
C.2.8. WDS_IpcUidUnicast()
Appendix D. Troubleshooting and Support
Appendix E. Evaluation Version Limitations
E.1. Windows WinDriver Evaluation Limitations
E.2. Linux WinDriver Evaluation Limitations
Appendix F. Purchasing WinDriver
Appendix G. Distributing Your Driver — Legal Issues
Appendix H. Additional Documentation
WinDriver™ PCI/ISA User's
Manual
Jungo Connectivity Ltd.
Version 12.6.0
WinDriver™ PCI/ISA User's Manual
Copyright © 2017 Jungo Connectivity Ltd. 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 Connectivity Ltd.
Brand and product names mentioned in this document are trademarks of their respective owners and are used here only for
identification purposes.
© 2017 Jungo Connectivity Ltd.
ii
CONFIDENTIAL
Table of Contents
1. WinDriver Overview .................................................................................................................. 1
1.1. Introduction to WinDriver ............................................................................................... 1
1.2. Background ...................................................................................................................... 2
1.2.1. The Challenge ....................................................................................................... 2
1.2.2. The WinDriver Solution ....................................................................................... 2
1.3. How Fast Can WinDriver Go? ........................................................................................ 3
1.4. Conclusion ....................................................................................................................... 3
1.5. WinDriver Benefits .......................................................................................................... 3
1.6. WinDriver Architecture ................................................................................................... 5
1.7. What Platforms Does WinDriver Support? ..................................................................... 6
1.8. Limitations of the Different Evaluation Versions ........................................................... 6
1.9. How Do I Develop My Driver with WinDriver? ............................................................ 7
1.9.1. On Windows and Linux ....................................................................................... 7
1.10. What Does the WinDriver Toolkit Include? ................................................................. 7
1.10.1. WinDriver Modules ............................................................................................ 7
1.10.2. Utilities ................................................................................................................ 8
1.10.3. Samples and Enhanced-Support Chipset APIs ................................................... 9
1.10.3.1. Enhanced Chipset Support ....................................................................... 9
1.11. Can I Distribute the Driver Created with WinDriver? .................................................. 9
2. Understanding Device Drivers ................................................................................................. 10
2.1. Device Driver Overview ................................................................................................ 10
2.2. Classification of Drivers According to Functionality ................................................... 10
2.2.1. Monolithic Drivers .............................................................................................. 10
2.2.2. Layered Drivers .................................................................................................. 11
2.2.3. Miniport Drivers ................................................................................................. 12
2.3. Classification of Drivers According to Operating Systems .......................................... 13
2.3.1. WDM Drivers ..................................................................................................... 13
2.3.2. Unix Device Drivers ........................................................................................... 14
2.3.3. Linux Device Drivers ......................................................................................... 14
2.4. The Entry Point of the Driver ....................................................................................... 14
2.5. Associating the Hardware with the Driver .................................................................... 15
2.6. Communicating with Drivers ........................................................................................ 15
3. Installing WinDriver ................................................................................................................. 16
3.1. System Requirements .................................................................................................... 16
3.1.1. Windows System Requirements ......................................................................... 16
3.1.2. Linux System Requirements ............................................................................... 17
3.2. WinDriver Installation Process ...................................................................................... 17
3.2.1. Windows WinDriver Installation Instructions .................................................... 17
3.2.2. Linux WinDriver Installation Instructions .......................................................... 18
3.2.2.1. Preparing the System for Installation ...................................................... 18
3.2.2.2. Installation ................................................................................................ 19
3.2.2.3. Restricting Hardware Access on Linux ................................................... 21
3.3. Upgrading Your Installation .......................................................................................... 21
3.4. Checking Your Installation ............................................................................................ 22
3.4.1. Windows and Linux Installation Check ............................................................. 22
3.5. Uninstalling WinDriver ................................................................................................. 22
© 2017 Jungo Connectivity Ltd.
iii
CONFIDENTIAL
Table of Contents
3.5.1. Windows WinDriver Uninstall Instructions ....................................................... 23
3.5.2. Linux WinDriver Uninstall Instructions ............................................................. 25
4. Using DriverWizard .................................................................................................................. 26
4.1. An Overview .................................................................................................................. 26
4.2. DriverWizard Walkthrough ........................................................................................... 27
4.2.1. Automatic Code Generation ............................................................................... 34
4.2.1.1. Generating the Code ................................................................................ 34
4.2.1.2. The Generated PCI/ISA C Code ............................................................. 34
4.2.2. Compiling the Generated Code .......................................................................... 35
4.2.2.1. Windows Compilation ............................................................................. 35
4.2.2.2. Linux Compilation ................................................................................... 36
5. Developing a Driver ................................................................................................................. 37
5.1. Using DriverWizard to Build a Device Driver ............................................................. 37
5.2. Writing the Device Driver Without DriverWizard ........................................................ 38
5.2.1. Include the Required WinDriver Files ............................................................... 38
5.2.2. Write Your Code ................................................................................................ 39
5.2.3. Configure and Build Your Code ........................................................................ 39
6. Debugging Drivers .................................................................................................................... 41
6.1. User-Mode Debugging .................................................................................................. 41
6.2. Debug Monitor ............................................................................................................... 41
6.2.1. The wddebug_gui Utility .................................................................................... 42
6.2.1.1. Running wddebug_gui for a Renamed Driver ......................................... 44
6.2.2. The wddebug Utility ........................................................................................... 45
6.2.2.1. Console-Mode wddebug Execution ......................................................... 45
7. Enhanced Support for Specific Chipsets .................................................................................. 48
7.1. Overview ........................................................................................................................ 48
7.2. Developing a Driver Using the Enhanced Chipset Support .......................................... 48
8. PCI Express .............................................................................................................................. 50
8.1. PCI Express Overview .................................................................................................. 50
8.2. WinDriver for PCI Express ........................................................................................... 51
9. Advanced Issues ....................................................................................................................... 52
9.1. Performing Direct Memory Access (DMA) .................................................................. 52
9.1.1. Implementing Scatter/Gather DMA .................................................................... 53
9.1.2. Implementing Contiguous-Buffer DMA ........................................................... 55
9.1.2.1. Preallocating Contiguous DMA Buffers on Windows ............................ 57
9.2. Handling Interrupts ........................................................................................................ 60
9.2.1. Interrupt Handling — Overview ........................................................................ 60
9.2.2. WinDriver Interrupt Handling Sequence ............................................................ 62
9.2.3. Registering IRQs for Non-Plug-and-Play Hardware on Windows 7 and
Higher ............................................................................................................................ 63
9.2.4. Determining the Interrupt Types Supported by the Hardware ........................... 64
9.2.5. Determining the Interrupt Type Enabled for a PCI Card ................................... 65
9.2.6. Setting Up Kernel-Mode Interrupt Transfer Commands .................................... 65
9.2.6.1. Interrupt Mask Commands ...................................................................... 66
9.2.6.2. Sample WinDriver Transfer Commands Code ........................................ 66
9.2.7. WinDriver MSI/MSI-X Interrupt Handling ........................................................ 67
9.2.7.1. Windows MSI/MSI-X Device INF Files ................................................. 68
9.2.8. Sample User-Mode WinDriver Interrupt Handling Code ................................... 69
© 2017 Jungo Connectivity Ltd.
iv
CONFIDENTIAL
Table of Contents
9.3. Buffer sharing between multiple processes ................................................................... 72
10. Improving Performance .......................................................................................................... 73
10.1. Overview ...................................................................................................................... 73
10.1.1. Performance Improvement Checklist ............................................................... 74
10.2. Improving the Performance of a User-Mode Driver ................................................... 75
10.2.1. Using Direct Access to Memory-Mapped Regions .......................................... 75
10.2.2. Block Transfers and Grouping Multiple Transfers ........................................... 76
10.2.3. Performing 64-Bit Data Transfers .................................................................... 76
11. Understanding the Kernel PlugIn ........................................................................................... 78
11.1. Background .................................................................................................................. 78
11.2. Do I Need to Write a Kernel PlugIn Driver? .............................................................. 78
11.3. What Kind of Performance Can I Expect? ................................................................. 79
11.4. Overview of the Development Process ....................................................................... 79
11.5. The Kernel PlugIn Architecture .................................................................................. 79
11.5.1. Architecture Overview ...................................................................................... 79
11.5.2. WinDriver's Kernel and Kernel PlugIn Interaction .......................................... 80
11.5.3. Kernel PlugIn Components .............................................................................. 81
11.5.4. Kernel PlugIn Event Sequence ......................................................................... 81
11.5.4.1. Opening a Handle from the User Mode to a Kernel PlugIn Driver ........ 81
11.5.4.2. Handling User-Mode Requests from the Kernel PlugIn ........................ 82
11.5.4.3. Interrupt Handling — Enable/Disable and
High Interrupt Request Level Processing .............................................................. 83
11.5.4.4. Interrupt Handling — Deferred Procedure Calls ................................... 84
11.5.4.5. Plug-and-Play and Power Management Events ..................................... 85
11.6. How Does Kernel PlugIn Work? ................................................................................ 85
11.6.1. Minimal Requirements for Creating a Kernel PlugIn Driver ........................... 85
11.6.2. Kernel PlugIn Implementation ......................................................................... 86
11.6.2.1. Before You Begin .................................................................................. 86
11.6.2.2. Write Your KP_Init Function ................................................................ 86
11.6.2.3. Write Your KP_Open Function(s) ......................................................... 88
11.6.2.4. Write the Remaining PlugIn Callbacks ................................................. 93
11.6.3. Sample/Generated Kernel PlugIn Driver Code Overview ................................ 93
11.6.4. Kernel PlugIn Sample/Generated Code Directory Structure ............................ 94
11.6.4.1. pci_diag and kp_pci Sample Directories ............................................... 94
11.6.4.2. The Generated DriverWizard Kernel PlugIn Directory ......................... 96
11.6.5. Handling Interrupts in the Kernel PlugIn ......................................................... 98
11.6.5.1. Interrupt Handling in the User Mode (Without the Kernel PlugIn) ....... 98
11.6.5.2. Interrupt Handling in the Kernel (Using the Kernel PlugIn) ................. 99
11.6.6. Message Passing ............................................................................................. 101
12. Creating a Kernel PlugIn Driver .......................................................................................... 103
12.1. Determine Whether a Kernel PlugIn is Needed ........................................................ 103
12.2. Prepare the User-Mode Source Code ........................................................................ 103
12.3. Create a New Kernel PlugIn Project ......................................................................... 104
12.4. Open a Handle to the Kernel PlugIn ......................................................................... 105
12.5. Set Interrupt Handling in the Kernel PlugIn ............................................................. 106
12.6. Set I/O Handling in the Kernel PlugIn ...................................................................... 107
12.7. Compile Your Kernel PlugIn Driver ......................................................................... 107
12.7.1. Windows Kernel PlugIn Driver Compilation ................................................. 107
© 2017 Jungo Connectivity Ltd.
v
CONFIDENTIAL
Table of Contents
12.7.2. Linux Kernel PlugIn Driver Compilation ....................................................... 111
12.8. Install Your Kernel PlugIn Driver ............................................................................. 112
12.8.1. Windows Kernel PlugIn Driver Installation ................................................... 112
12.8.2. Linux Kernel PlugIn Driver Installation ......................................................... 113
13. Dynamically Loading Your Driver ...................................................................................... 114
13.1. Why Do You Need a Dynamically Loadable Driver? .............................................. 114
13.2. Windows Dynamic Driver Loading .......................................................................... 114
13.2.1. The wdreg Utility ........................................................................................... 114
13.2.1.1. WDM Drivers ...................................................................................... 115
13.2.1.2. Non-WDM Drivers .............................................................................. 116
13.2.2. Dynamically Loading/Unloading windrvr1260.sys INF Files ........................ 118
13.2.3. Dynamically Loading/Unloading Your Kernel PlugIn Driver ........................ 118
13.3. Linux Dynamic Driver Loading ................................................................................ 119
13.3.1. Dynamically Loading/Unloading Your Kernel PlugIn Driver ........................ 119
14. Distributing Your Driver ...................................................................................................... 121
14.1. Getting a Valid WinDriver License .......................................................................... 121
14.2. Windows Driver Distribution .................................................................................... 121
14.2.1. Preparing the Distribution Package ................................................................ 122
14.2.2. Installing Your Driver on the Target Computer ............................................. 122
14.2.3. Installing Your Kernel PlugIn on the Target Computer ................................. 125
14.3. Linux Driver Distribution .......................................................................................... 126
14.3.1. Preparing the Distribution Package ................................................................ 126
14.3.1.1. Kernel Module Components ................................................................ 126
14.3.1.2. User-Mode Hardware-Control Application or Shared Object ............. 129
14.3.2. Building and Installing the WinDriver Driver Module on the Target ............ 129
14.3.3. Building and Installing Your Kernel PlugIn Driver on the Target ................. 131
14.3.4. Installing the User-Mode Hardware-Control Application or
Shared Object .............................................................................................................. 132
15. Driver Installation — Advanced Issues ............................................................................... 133
15.1. Windows INF Files .................................................................................................... 133
15.1.1. Why Should I Create an INF File? ................................................................ 133
15.1.2. How Do I Install an INF File When No Driver Exists? ................................. 134
15.1.3. How Do I Replace an Existing Driver Using the INF File? ........................... 134
15.2. Renaming the WinDriver Kernel Driver ................................................................... 135
15.2.1. Windows Driver Renaming ............................................................................ 136
15.2.2. Linux Driver Renaming .................................................................................. 138
15.3. Windows Digital Driver Signing and Certification ................................................... 139
15.3.1. Overview ......................................................................................................... 139
15.3.1.1. Authenticode Driver Signature ............................................................ 140
15.3.1.2. Windows Certification Program .......................................................... 140
15.3.2. Driver Signing and Certification of WinDriver-Based Drivers ...................... 141
15.3.2.1. HCK Test Notes .................................................................................. 142
A. 64-Bit Operating Systems Support ........................................................................................ 143
A.1. Supported 64-Bit Architectures .................................................................................. 143
A.2. Support for 32-Bit Applications on 64-Bit Windows and Linux Platforms ............... 143
A.3. 64-Bit and 32-Bit Data Types .................................................................................... 145
B. API Reference ........................................................................................................................ 146
B.1. WD_DriverName ........................................................................................................ 146
© 2017 Jungo Connectivity Ltd.
vi
CONFIDENTIAL
Table of Contents
B.2. WDC Library Overview ............................................................................................. 147
B.3. WDC High-Level API ................................................................................................ 148
B.3.1. Structures, Types and General Definitions ...................................................... 148
B.3.1.1. WDC_DEVICE_HANDLE ................................................................... 148
B.3.1.2. WDC_DRV_OPEN_OPTIONS Definitions ......................................... 148
B.3.1.3. WDC_DIRECTION Enumeration ........................................................ 149
B.3.1.4. WDC_ADDR_MODE Enumeration ..................................................... 150
B.3.1.5. WDC_ADDR_RW_OPTIONS Enumeration ........................................ 150
B.3.1.6. WDC_ADDR_SIZE Definitions ........................................................... 151
B.3.1.7. WDC_SLEEP_OPTIONS Definitions .................................................. 151
B.3.1.8. WDC_DBG_OPTIONS Definitions ..................................................... 151
B.3.1.9. WDC_PCI_SCAN_RESULT Structure ................................................ 153
B.3.1.10. WDC_PCI_SCAN_CAPS_RESULT Structure .................................. 154
B.3.2. WDC_DriverOpen() ......................................................................................... 155
B.3.3. WDC_DriverClose() ......................................................................................... 156
B.3.4. WDC_PciScanDevices() .................................................................................. 156
B.3.5. WDC_PciScanDevicesByTopology() .............................................................. 157
B.3.6. WDC_PciScanRegisteredDevices() ................................................................. 158
B.3.7. WDC_PciScanCaps() ....................................................................................... 160
B.3.8. WDC_PciScanCapsBySlot() ............................................................................ 161
B.3.9. WDC_PciScanExtCaps() .................................................................................. 162
B.3.10. WDC_PciGetExpressGen() ............................................................................ 163
B.3.11. WDC_PciGetExpressGenBySlot() ................................................................. 164
B.3.12. WDC_PciGetExpressOffset() ......................................................................... 165
B.3.13. WDC_PciGetHeaderType() ............................................................................ 166
B.3.14. PciConfRegData2Str() .................................................................................... 167
B.3.15. PciExpressConfRegData2Str() ....................................................................... 168
B.3.16. WDC_PciGetDeviceInfo() ............................................................................. 169
B.3.17. WDC_PciDeviceOpen() ................................................................................. 170
B.3.18. WDC_IsaDeviceOpen() .................................................................................. 172
B.3.19. WDC_PciDeviceClose() ................................................................................. 176
B.3.20. WDC_IsaDeviceClose() ................................................................................. 177
B.3.21. WDC_CardCleanupSetup() ............................................................................ 178
B.3.22. WDC_KernelPlugInOpen() ............................................................................ 179
B.3.23. WDC_CallKerPlug() ...................................................................................... 180
B.3.24. WDC_ReadMemXXX() ................................................................................. 181
B.3.25. WDC_WriteMemXXX() ................................................................................ 182
B.3.26. WDC_ReadAddrXXX() ................................................................................. 183
B.3.27. WDC_WriteAddrXXX() ................................................................................ 184
B.3.28. WDC_ReadAddrBlock() ................................................................................ 185
B.3.29. WDC_WriteAddrBlock() ............................................................................... 186
B.3.30. WDC_MultiTransfer() .................................................................................... 187
B.3.31. WDC_AddrSpaceIsActive() ........................................................................... 188
B.3.32. WDC_PciReadCfgBySlot() ............................................................................ 189
B.3.33. WDC_PciWriteCfgBySlot() ........................................................................... 190
B.3.34. WDC_PciReadCfg() ....................................................................................... 191
B.3.35. WDC_PciWriteCfg() ...................................................................................... 192
B.3.36. WDC_PciReadCfgBySlotXXX() ................................................................... 193
© 2017 Jungo Connectivity Ltd.
vii
CONFIDENTIAL
Table of Contents
B.3.37. WDC_PciWriteCfgBySlotXXX() .................................................................. 194
B.3.38. WDC_PciReadCfgXXX() .............................................................................. 196
B.3.39. WDC_PciWriteCfgXXX() ............................................................................. 197
B.3.40. WDC_DMAContigBufLock() ........................................................................ 198
B.3.41. WDC_DMASGBufLock() .............................................................................. 200
B.3.42. WDC_DMAReservedBufLock() .................................................................... 202
B.3.43. WDC_DMABufUnlock() ............................................................................... 204
B.3.44. WDC_DMABufGet() ..................................................................................... 204
B.3.45. WDC_DMAGetGlobalHandle Macro ............................................................ 206
B.3.46. WDC_DMASyncCpu() .................................................................................. 207
B.3.47. WDC_DMASyncIo() ..................................................................................... 208
B.3.48. WDC_IntEnable() ........................................................................................... 209
B.3.49. WDC_IntDisable() ......................................................................................... 213
B.3.50. WDC_IntIsEnabled() ...................................................................................... 214
B.3.51. WDC_IntType2Str() ....................................................................................... 215
B.3.52. WDC_EventRegister() ................................................................................... 216
B.3.53. WDC_EventUnregister() ................................................................................ 218
B.3.54. WDC_EventIsRegistered() ............................................................................. 218
B.3.55. WDC_SetDebugOptions() .............................................................................. 219
B.3.56. WDC_Err() ..................................................................................................... 220
B.3.57. WDC_Trace() ................................................................................................. 221
B.3.58. WDC_GetWDHandle() .................................................................................. 222
B.3.59. WDC_GetDevContext() ................................................................................. 222
B.3.60. WDC_GetBusType() ...................................................................................... 223
B.3.61. WDC_Sleep() ................................................................................................. 223
B.3.62. WDC_Version() ............................................................................................. 224
B.4. WDC Low-Level API ................................................................................................. 225
B.4.1. WDC_ADDR_DESC Structure ....................................................................... 226
B.4.2. WDC_DEVICE Structure ................................................................................ 226
B.4.3. PWDC_DEVICE .............................................................................................. 228
B.4.4. WDC_MEM_DIRECT_ADDR Macro ............................................................ 228
B.4.5. WDC_ADDR_IS_MEM Macro ....................................................................... 229
B.4.6. WDC_GET_ADDR_DESC Macro .................................................................. 230
B.4.7. WDC_GET_ADDR_SPACE_SIZE Macro ..................................................... 230
B.4.8. WDC_GET_ENABLED_INT_TYPE Macro .................................................. 231
B.4.9. WDC_GET_INT_OPTIONS Macro ................................................................ 232
B.4.10. WDC_INT_IS_MSI Macro ............................................................................ 233
B.4.11. WDC_GET_ENABLED_INT_LAST_MSG Macro ...................................... 234
B.4.12. WDC_IS_KP Macro ...................................................................................... 234
B.5. WDS Library Overview .............................................................................................. 235
B.6. WDS High-Level API ................................................................................................. 235
B.6.1. WDS_SharedBufferAlloc() .............................................................................. 236
B.6.2. WDS_SharedBufferFree() ................................................................................ 237
B.6.3. WDS_SharedBufferGet() ................................................................................. 238
B.6.4. WDS_SharedBufferGetGlobalHandle Macro .................................................. 239
B.7. WD_xxx Structures, Types and General Definitions ................................................. 240
B.7.1. WD_BUS_TYPE Enumeration ........................................................................ 240
B.7.2. ITEM_TYPE Enumeration .............................................................................. 240
© 2017 Jungo Connectivity Ltd.
viii
CONFIDENTIAL
相关推荐
2023年江西萍乡中考道德与法治真题及答案.doc
2012年重庆南川中考生物真题及答案.doc
2013年江西师范大学地理学综合及文艺理论基础考研真题.doc
2020年四川甘孜小升初语文真题及答案I卷.doc
2020年注册岩土工程师专业基础考试真题及答案.doc
2023-2024学年福建省厦门市九年级上学期数学月考试题及答案.doc
2021-2022学年辽宁省沈阳市大东区九年级上学期语文期末试题及答案.doc
2022-2023学年北京东城区初三第一学期物理期末试卷及答案.doc
2018上半年江西教师资格初中地理学科知识与教学能力真题及答案.doc
2012年河北国家公务员申论考试真题及答案-省级.doc
2020-2021学年江苏省扬州市江都区邵樊片九年级上学期数学第一次质量检测试题及答案.doc
2022下半年黑龙江教师资格证中学综合素质真题及答案.doc
