diff options
| author | Barry Golden <[email protected]> | 2019-09-30 10:40:48 -0700 |
|---|---|---|
| committer | GitHub <[email protected]> | 2019-09-30 10:40:48 -0700 |
| commit | 85e09b9be0b4359d46d3fdf196b4a39e74060920 (patch) | |
| tree | c0d6a9f68787fa8b2d991fe7ee91507e12547339 /wpd | |
| parent | f7eb738097908a1e32ca2a07a605bba0e85ccb95 (diff) | |
Diffstat (limited to 'wpd')
| -rw-r--r-- | wpd/WpdBasicHardwareDriver/README.md | 28 | ||||
| -rw-r--r-- | wpd/WpdHelloWorldDriver/README.md | 98 | ||||
| -rw-r--r-- | wpd/WpdMultiTransportDriver/README.md | 18 | ||||
| -rw-r--r-- | wpd/WpdServiceSampleDriver/README.md | 16 | ||||
| -rw-r--r-- | wpd/WpdWudfSampleDriver/README.md | 22 |
5 files changed, 68 insertions, 114 deletions
diff --git a/wpd/WpdBasicHardwareDriver/README.md b/wpd/WpdBasicHardwareDriver/README.md index de510d47..56414e93 100644 --- a/wpd/WpdBasicHardwareDriver/README.md +++ b/wpd/WpdBasicHardwareDriver/README.md @@ -8,16 +8,6 @@ products: - windows-wdk --- - -<!--- - name: WPD Basic Hardware Sample Driver - platform: UMDF1 - language: cpp - category: WDP - description: Supports nine sensor devices that integrate with the Parallax BS2 programmable microcontroller. - samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=620318 ----> - # WPD Basic Hardware Sample Driver (UMDF Version 1) The WpdBasicHardwareDriver is a WPD driver that supports nine devices. These devices were selected because of their simplicity. This simplicity allowed the sample to focus on the tasks that are common to portable devices without getting bogged down in hardware complexities. @@ -32,15 +22,15 @@ The circuit designs are based on the sample circuits provided by Parallax in the The microcontroller firmware for each of the nine circuits is included in the **\\firmware** subdirectory of this sample. -For a complete description of this sample and its underlying code and functionality, refer to the [WPD Basic Hardware Driver](http://msdn.microsoft.com/en-us/library/windows/hardware/ff597697) description in the Windows Driver Kit documentation. +For a complete description of this sample and its underlying code and functionality, refer to the [WPD Basic Hardware Driver](https://docs.microsoft.com/windows-hardware/drivers/portable/the-wpdbasichardwaredriver-sample) description in the Windows Driver Kit documentation. ## Related topics -[WPD Design Guide](http://msdn.microsoft.com/en-us/library/windows/hardware/ff597864) +[WPD Design Guide](https://docs.microsoft.com/windows-hardware/drivers/portable/wpd-design-guide) -[WPD Driver Development Tools](http://msdn.microsoft.com/en-us/library/windows/hardware/ff597568) +[WPD Driver Development Tools](https://docs.microsoft.com/windows-hardware/drivers/portable/familiarizing-yourself-with-the-sample-driver) -[WPD Programming Guide](http://msdn.microsoft.com/en-us/library/windows/hardware/) +[WPD Programming Guide](https://docs.microsoft.com/windows-hardware/drivers/portable/wpd-programming-guide) ## Installation @@ -49,10 +39,14 @@ To test this sample, you must have a test computer. This can be a second compute To install the WpdBasicHardwareDriver sample, do the following: 1. Copy the driver binary and the wpdbasichardwaredriver.inf file to a directory on your test computer (for example, C:\\wpdbasichardwaredriver.) + 1. Copy the UMDF coinstaller, WUDFUpdate\_*MMmmmm*.dll, from the \\redist\\wdf\\\<architecture\> directory to the same directory (for example, C:\\wpdbasichardwaredriver). - **Note** You can obtain the co-installers by downloading and installing the "Windows Driver Framework (WDF)" package from [WDK 8 Redistributable Components](http://go.microsoft.com/fwlink/p/?LinkID=226396). + > [!NOTE] + > You can obtain the co-installers by downloading and installing the "Windows Driver Framework (WDF)" package from [WDK 8 Redistributable Components](https://go.microsoft.com/fwlink/p/?LinkID=253170). 1. Navigate to the directory that contains the INF file and binaries (for example, cd /d c:\\wpdbasichardwaredriver), and run DevCon.exe as follows: - **devcon.exe install wpdbasichardwaredriver.inf WUDF\\WpdBasicHardware** - You can find DevCon.exe in the \\tools directory of the WDK (for example, \\tools\\devcon\\i386\\devcon.exe).
\ No newline at end of file + + `devcon.exe install wpdbasichardwaredriver.inf WUDF\WpdBasicHardware` + + You can find DevCon.exe in the \\tools directory of the WDK (for example, \\tools\\devcon\\i386\\devcon.exe). diff --git a/wpd/WpdHelloWorldDriver/README.md b/wpd/WpdHelloWorldDriver/README.md index 417859e4..6942f4c6 100644 --- a/wpd/WpdHelloWorldDriver/README.md +++ b/wpd/WpdHelloWorldDriver/README.md @@ -8,81 +8,71 @@ products: - windows-wdk --- - -<!--- - name: WPD Hello World Sample - platform: UMDF1 - language: cpp - category: WPD - description: Supports four objects: a device object, a storage object, a folder object, and a file object. - samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=618008 ----> - # WPDHelloWorld sample driver for portable devices The WpdHelloWorld sample driver supports four objects: a device object, a storage object, a folder object, and a file object. Each object supports corresponding properties. These properties are defined in the file WpdObjectProperties.h. The sample driver supports a device object that exposes ten read-only properties. These properties, their types, and their values are listed in the following table. -Property name | Property type | Value ---------------|---------------|------ -DEVICE_PROTOCOL | String | "Hello World Protocol ver 1.00" -DEVICE_FIRMWARE_VERSION | String | "1.0.0.0" -DEVICE_POWER_LEVEL | Integer | 100 -DEVICE_MODEL | String | "Hello World!" -DEVICE_MANUFACTURER | String | "Windows Portable Devices Group" -DEVICE_FRIENDLY | String | "Hello World!" -DEVICE_SERIAL_NUMBER | String | "01234567890123-45676890123456" -DEVICE_SUPPORTS_NONCONSUMABLE | Bool | True -WPD_DEVICE_TYPE | Integer | WPD_DEVICE_TYPE_GENERIC -WPD_FUNCTIONAL_OBJECT_CATEGORY | GUID | WPD_FUNCTIONAL_CATEGORY_STORAGE +| Property name | Property type | Value | +| --- | --- | --- | +| DEVICE_PROTOCOL | String | "Hello World Protocol ver 1.00" | +| DEVICE_FIRMWARE_VERSION | String | "1.0.0.0" | +| DEVICE_POWER_LEVEL | Integer | 100 | +| DEVICE_MODEL | String | "Hello World!" | +| DEVICE_MANUFACTURER | String | "Windows Portable Devices Group" | +| DEVICE_FRIENDLY | String | "Hello World!" | +| DEVICE_SERIAL_NUMBER | String | "01234567890123-45676890123456" | +| DEVICE_SUPPORTS_NONCONSUMABLE | Bool | True | +| WPD_DEVICE_TYPE | Integer | WPD_DEVICE_TYPE_GENERIC | +| WPD_FUNCTIONAL_OBJECT_CATEGORY | GUID | WPD_FUNCTIONAL_CATEGORY_STORAGE | The driver supports a storage object that exposes seven read-only properties. These properties, their types, and their values are listed in the following table. -Property name | Property type | Value ---------------|---------------|------ -STORAGE_CAPACITY | 64-bit Integer | 1024 * 1024 -STORAGE_FREE_SPACE_IN_BYTES | 64-bit Integer | 1024 * 1024 -STORAGE_SERIAL_NUMBER | String | 98765432109876-54321098765432 -STORAGE_FILE_SYSTEM_TYPE | String | FAT32 -STORAGE_DESCRIPTION | String | Hello World! Memory Storage System -WPD_STORAGE_TYPE | Integer | WPD_STORAGE_TYPE_FIXED_ROM -WPD_FUNCTIONAL_OBJECT_CATEGORY | GUID | WPD_FUNCTIONAL_CATEGORY_STORAGE +| Property name | Property type | Value | +| --- | --- | --- | +| STORAGE_CAPACITY | 64-bit Integer | 1024 * 1024 | +| STORAGE_FREE_SPACE_IN_BYTES | 64-bit Integer | 1024 * 1024 | +| STORAGE_SERIAL_NUMBER | String | 98765432109876-54321098765432 | +| STORAGE_FILE_SYSTEM_TYPE | String | FAT32 | +| STORAGE_DESCRIPTION | String | Hello World! Memory Storage System | +| WPD_STORAGE_TYPE | Integer | WPD_STORAGE_TYPE_FIXED_ROM | +| WPD_FUNCTIONAL_OBJECT_CATEGORY | GUID | WPD_FUNCTIONAL_CATEGORY_STORAGE | The driver supports a folder object that exposes three read-only properties. These properties, their types, and their values are listed in the following table. -Property name | Property type | Value ---------------|---------------|------ -WPD_OBJECT_DATE_MODIFIED | Date | 2006/6/26 5:0:0.0 -WPD_OBJECT_DATE_CREATED | Date | 2006/1/25 12:0:0.0 -WPD_OBJECT_ORIGINAL_FILE_NAME_VALUE | String | Documents +| Property name | Property type | Value | +| --- | --- | --- | +| WPD_OBJECT_DATE_MODIFIED | Date | 2006/6/26 5:0:0.0 | +| WPD_OBJECT_DATE_CREATED | Date | 2006/1/25 12:0:0.0 | +| WPD_OBJECT_ORIGINAL_FILE_NAME_VALUE | String | Documents | The driver supports a file object that exposes three read-only properties. These properties, their types, and their values are listed in the following table. -Property name | Property type | Value ---------------|---------------|------ -WPD_OBJECT_DATE_MODIFIED | Date | 2006/6/26 5:0:0.0 -WPD_OBJECT_DATE_CREATED | Date | 2006/1/25 12:0:0.0 -WPD_OBJECT_ORIGINAL_FILE_NAME | String | Readme.txt +| Property name | Property type | Value | +| --- | --- | --- | +| WPD_OBJECT_DATE_MODIFIED | Date | 2006/6/26 5:0:0.0 | +| WPD_OBJECT_DATE_CREATED | Date | 2006/1/25 12:0:0.0 | +| WPD_OBJECT_ORIGINAL_FILE_NAME | String | Readme.txt | In addition to the above properties, every object (for example, device, storage, folder, or file) also supports seven common WPD object properties. These are read-only properties that contain object-specific values for the most part. These properties, their types, and their values are listed in the following table. -Property name | Property type | Value ---------------|---------------|------ -WPD_OBJECT_ID | String | Object-specific -WPD_OBJECT_PERSISTENT_UNIQUE_ID | String | Object-specific -WPD_OBJECT_PARENT_ID | String | Object-specific -WPD_OBJECT_NAME | String | Object-specific -WPD_OBJECT_FORMAT | GUID | Object-specific -WPD_OBJECT_CONTENT_TYPE | GUID | Object-specific -WPD_OBJECT_CAN_DELETE | Bool | False +| Property name | Property type | Value | +| --- | --- | --- | +| WPD_OBJECT_ID | String | Object-specific | +| WPD_OBJECT_PERSISTENT_UNIQUE_ID | String | Object-specific | +| WPD_OBJECT_PARENT_ID | String | Object-specific | +| WPD_OBJECT_NAME | String | Object-specific | +| WPD_OBJECT_FORMAT | GUID | Object-specific | +| WPD_OBJECT_CONTENT_TYPE | GUID | Object-specific | +| WPD_OBJECT_CAN_DELETE | Bool | False | -For a complete description of this sample and its underlying code and functionality, refer to the [WPD HelloWorld Driver](http://msdn.microsoft.com/en-us/library/windows/hardware/) description in the Windows Driver Kit documentation. +For a complete description of this sample and its underlying code and functionality, refer to the [WPD HelloWorld Driver](https://docs.microsoft.com/windows-hardware/drivers/portable/the-sample-driver-architecture) description in the Windows Driver Kit documentation. ## Related topics -[WPD Design Guide](http://msdn.microsoft.com/en-us/library/windows/hardware/ff597864) +[WPD Design Guide](https://docs.microsoft.com/windows-hardware/drivers/portable/wpd-design-guide) -[WPD Driver Development Tools](http://msdn.microsoft.com/en-us/library/windows/hardware/ff597568) +[WPD Driver Development Tools](https://docs.microsoft.com/windows-hardware/drivers/portable/familiarizing-yourself-with-the-sample-driver) -[WPD Programming Guide](https://msdn.microsoft.com/en-us/library/windows/hardware/ff597898)
\ No newline at end of file +[WPD Programming Guide](https://docs.microsoft.com/windows-hardware/drivers/portable/wpd-programming-guide) diff --git a/wpd/WpdMultiTransportDriver/README.md b/wpd/WpdMultiTransportDriver/README.md index 024bf124..3656e8b9 100644 --- a/wpd/WpdMultiTransportDriver/README.md +++ b/wpd/WpdMultiTransportDriver/README.md @@ -8,28 +8,18 @@ products: - windows-wdk --- - -<!--- - name: WPD multi-transport sample driver - platform: UMDF1 - language: cpp - category: WPD - description: Demonstrates how to extend the WpdHelloWorldDriver for a device that supports multiple transports. - samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=618009 ----> - # WPD multi-transport sample driver The WpdMultiTransportDriver sample demonstrates how you could extend the WpdHelloWorldDriver for a device that supports multiple transports. A transport is a protocol over which a portable device communicates with a computer. Example transports include Internet Protocol (IP), Bluetooth, and USB. A number of portable devices now support multiple transports. For example, a number of cell phones support both Bluetooth and USB. Windows supports a multitransport driver model that ensures that only one node appears for each device. -For a complete description of this sample and its underlying code and functionality, refer to the [WPD MultiTransport Driver](http://msdn.microsoft.com/en-us/library/windows/hardware/ff597709) description in the Windows Driver Kit documentation. +For a complete description of this sample and its underlying code and functionality, refer to the [WPD MultiTransport Driver](https://docs.microsoft.com/windows-hardware/drivers/portable/the-wpdmultitransportdriver-sample) description in the Windows Driver Kit documentation. ## Related topics -[WPD Design Guide](http://msdn.microsoft.com/en-us/library/windows/hardware/ff597864) +[WPD Design Guide](https://docs.microsoft.com/windows-hardware/drivers/portable/wpd-design-guide) -[WPD Driver Development Tools](http://msdn.microsoft.com/en-us/library/windows/hardware/ff597568) +[WPD Driver Development Tools](https://docs.microsoft.com/windows-hardware/drivers/portable/familiarizing-yourself-with-the-sample-driver) -[WPD Programming Guide](https://msdn.microsoft.com/en-us/library/windows/hardware/ff597898)
\ No newline at end of file +[WPD Programming Guide](https://docs.microsoft.com/windows-hardware/drivers/portable/wpd-programming-guide) diff --git a/wpd/WpdServiceSampleDriver/README.md b/wpd/WpdServiceSampleDriver/README.md index 11754a04..4cd6b4dc 100644 --- a/wpd/WpdServiceSampleDriver/README.md +++ b/wpd/WpdServiceSampleDriver/README.md @@ -8,24 +8,14 @@ products: - windows-wdk --- - -<!--- - name: WPD service sample driver - platform: UMDF1 - language: cpp - category: WPD - description: Demonstrates how to extend the WpdHelloWorldDriver sample so that it supports a simulated device with a Contacts device service. - samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=618010 ----> - # WPD service sample driver Demonstrates how to extend the WpdHelloWorldDriver sample so that it supports a simulated device with a Contacts device service. ## Related topics -[WPD Design Guide](http://msdn.microsoft.com/en-us/library/windows/hardware/ff597864) +[WPD Design Guide](https://docs.microsoft.com/windows-hardware/drivers/portable/wpd-design-guide) -[WPD Driver Development Tools](http://msdn.microsoft.com/en-us/library/windows/hardware/ff597568) +[WPD Driver Development Tools](https://docs.microsoft.com/windows-hardware/drivers/portable/familiarizing-yourself-with-the-sample-driver) -[WPD Programming Guide](https://msdn.microsoft.com/en-us/library/windows/hardware/ff597898) +[WPD Programming Guide](https://docs.microsoft.com/windows-hardware/drivers/portable/wpd-programming-guide) diff --git a/wpd/WpdWudfSampleDriver/README.md b/wpd/WpdWudfSampleDriver/README.md index 440de631..63d7898f 100644 --- a/wpd/WpdWudfSampleDriver/README.md +++ b/wpd/WpdWudfSampleDriver/README.md @@ -8,30 +8,20 @@ products: - windows-wdk --- - -<!--- - name: WPD WUDF sample driver - platform: UMDF1 - language: cpp - category: WPD - description: Demonstrates virtually all aspects of the WPD device driver interface (DDI). - samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=618011 ----> - # WPD WUDF sample driver -The comprehensive WPD sample driver (`WpdWudfSampleDriver`) demonstrates virtually all aspects of the Microsoft Windows Portable Devides (WPD) device driver interface (DDI). This driver is built as a normal User-Mode Driver Framework (UMDF) driver that also processes the WPD command set. Although this driver does not interact with actual hardware, it simulates communicating with a device that supports phone contacts, pictures, music, and video. +The comprehensive WPD sample driver (WpdWudfSampleDriver) demonstrates virtually all aspects of the Microsoft Windows Portable Devices (WPD) device driver interface (DDI). This driver is built as a normal User-Mode Driver Framework (UMDF) driver that also processes the WPD command set. Although this driver does not interact with actual hardware, it simulates communicating with a device that supports phone contacts, pictures, music, and video. This driver was written in the simplest way to demonstrate concepts. Therefore, the sample driver might perform operations or be structured in a way that are inefficient in a production driver. Additionally, this sample does not use real hardware. Instead, it simulates a device by using data structures in memory. Therefore, the driver might be implemented in a way that is unrealistic for production hardware. -Some of the tasks that are accomplished by the `WpdWudfSampleDriver` are written for the advanced Windows Portable Devices (WPD) driver developer. +Some of the tasks that are accomplished by the `WpdWudfSampleDriver` sample are written for the advanced Windows Portable Devices (WPD) driver developer. -For a complete description of this sample and its underlying code and functionality, refer to the [WPD WUDF Sample Driver](http://msdn.microsoft.com/en-us/library/windows/hardware/ff597723) description in the Windows Driver Kit documentation. +For a complete description of this sample and its underlying code and functionality, refer to the [WPD WUDF Sample Driver](https://docs.microsoft.com/windows-hardware/drivers/portable/the-wpdwudfsampledriver-sample) description in the Windows Driver Kit documentation. ## Related topics -[WPD Design Guide](http://msdn.microsoft.com/en-us/library/windows/hardware/ff597864) +[WPD Design Guide](https://docs.microsoft.com/windows-hardware/drivers/portable/wpd-design-guide) -[WPD Driver Development Tools](http://msdn.microsoft.com/en-us/library/windows/hardware/ff597568) +[WPD Driver Development Tools](https://docs.microsoft.com/windows-hardware/drivers/portable/familiarizing-yourself-with-the-sample-driver) -[WPD Programming Guide](https://msdn.microsoft.com/en-us/library/windows/hardware/ff597898)
\ No newline at end of file +[WPD Programming Guide](https://docs.microsoft.com/windows-hardware/drivers/portable/wpd-programming-guide) |
