summaryrefslogtreecommitdiff
path: root/usb
diff options
context:
space:
mode:
authorDen Delimarsky <[email protected]>2019-03-13 14:21:46 -0700
committerDen Delimarsky <[email protected]>2019-03-13 14:21:46 -0700
commit34dcaceff4ea13c5078c06058957abf075b358ef (patch)
tree84c5048b5568cda4d2ecbfdd19ab88425f4a22c8 /usb
parent1404d5fcfc743326d065c7f6977a68e92f3bf9f6 (diff)
Update READMEs
Diffstat (limited to 'usb')
-rw-r--r--usb/UcmCxUcsi/README.md4
-rw-r--r--usb/UcmTcpciCxClientSample/README.md4
-rw-r--r--usb/UcmUcsiAcpiSample/README.md4
-rw-r--r--usb/kmdf_enumswitches/README.md6
-rw-r--r--usb/kmdf_fx2/README.md4
-rw-r--r--usb/ufxclientsample/README.md4
-rw-r--r--usb/umdf2_fx2/README.md4
-rw-r--r--usb/umdf_filter_kmdf/README.md10
-rw-r--r--usb/umdf_filter_umdf/README.md8
-rw-r--r--usb/umdf_fx2/README.md8
-rw-r--r--usb/usbsamp/README.md4
-rw-r--r--usb/usbview/README.md4
-rw-r--r--usb/wdf_osrfx2_lab/README.md4
13 files changed, 34 insertions, 34 deletions
diff --git a/usb/UcmCxUcsi/README.md b/usb/UcmCxUcsi/README.md
index 19741dcf..42a50dd7 100644
--- a/usb/UcmCxUcsi/README.md
+++ b/usb/UcmCxUcsi/README.md
@@ -2,9 +2,9 @@
topic: sample
description: Demonstrates how to create a Windows USB Type-C port controller driver using the USB Connector Manager class extension driver (UcmCx).
languages:
- - cpp
+- cpp
products:
- - windows
+- windows
---
<!---
diff --git a/usb/UcmTcpciCxClientSample/README.md b/usb/UcmTcpciCxClientSample/README.md
index 8eeb7545..2dfab641 100644
--- a/usb/UcmTcpciCxClientSample/README.md
+++ b/usb/UcmTcpciCxClientSample/README.md
@@ -2,9 +2,9 @@
topic: sample
description: Demonstrates how to create a Windows USB Type-C port controller driver using the USB Connector Manager Type-C Port Controller Interface class extension driver (UcmTcpciCx).
languages:
- - cpp
+- cpp
products:
- - windows
+- windows
---
<!---
diff --git a/usb/UcmUcsiAcpiSample/README.md b/usb/UcmUcsiAcpiSample/README.md
index aa340ece..f2ac668b 100644
--- a/usb/UcmUcsiAcpiSample/README.md
+++ b/usb/UcmUcsiAcpiSample/README.md
@@ -2,9 +2,9 @@
topic: sample
description: Demonstrates how to create a Windows USB Type-C port controller driver using the USB Connector Manager class extension driver (UcmCx).
languages:
- - cpp
+- cpp
products:
- - windows
+- windows
---
<!---
diff --git a/usb/kmdf_enumswitches/README.md b/usb/kmdf_enumswitches/README.md
index d6dcee41..c22cfa8f 100644
--- a/usb/kmdf_enumswitches/README.md
+++ b/usb/kmdf_enumswitches/README.md
@@ -2,9 +2,9 @@
topic: sample
description: Demonstrates how to use KMDF as a bus driver using the OSR USB-FX2 device.
languages:
- - cpp
+- cpp
products:
- - windows
+- windows
---
<!---
@@ -55,7 +55,7 @@ Here is the overview of the device:
For example, bit 0x80 is labeled 1 on the pack
- Bulk Endpoints are configured for loopback:
- - Device moves data from IN endpoint to OUT endpoint.
+- Device moves data from IN endpoint to OUT endpoint.
- Device does not change the values of the data it receives nor does it internally create any data.
- Endpoints are always double buffered.
- Maximum packet size depends on speed (64 Full speed, 512 High speed).
diff --git a/usb/kmdf_fx2/README.md b/usb/kmdf_fx2/README.md
index 2be7db13..f2c90029 100644
--- a/usb/kmdf_fx2/README.md
+++ b/usb/kmdf_fx2/README.md
@@ -2,9 +2,9 @@
topic: sample
description: Demonstrates how to use KMDF to perform bulk and interrupt data transfers to a USB device.
languages:
- - cpp
+- cpp
products:
- - windows
+- windows
---
<!---
diff --git a/usb/ufxclientsample/README.md b/usb/ufxclientsample/README.md
index 02353846..191c9e49 100644
--- a/usb/ufxclientsample/README.md
+++ b/usb/ufxclientsample/README.md
@@ -2,9 +2,9 @@
topic: sample
description: Demonstrates how to create a Windows USB function controller driver using the USB function class extension driver (UFX).
languages:
- - cpp
+- cpp
products:
- - windows
+- windows
---
<!---
diff --git a/usb/umdf2_fx2/README.md b/usb/umdf2_fx2/README.md
index dace2b0b..4a486fd0 100644
--- a/usb/umdf2_fx2/README.md
+++ b/usb/umdf2_fx2/README.md
@@ -2,9 +2,9 @@
topic: sample
description: Demonstrates a UMDF version 2 driver for the OSR USB-FX2 device.
languages:
- - cpp
+- cpp
products:
- - windows
+- windows
---
<!---
diff --git a/usb/umdf_filter_kmdf/README.md b/usb/umdf_filter_kmdf/README.md
index 7ef509e1..a5a8af0d 100644
--- a/usb/umdf_filter_kmdf/README.md
+++ b/usb/umdf_filter_kmdf/README.md
@@ -2,9 +2,9 @@
topic: sample
description: Demonstrates how to load a UMDF filter driver as an upper filter driver above the kmdf_fx2 sample driver.
languages:
- - cpp
+- cpp
products:
- - windows
+- windows
---
<!---
@@ -37,18 +37,18 @@ The default Solution build configuration is **Debug** and **Win32**.
- It contains 1 interface and 3 endpoints (Interrupt IN, Bulk Out, Bulk IN).
- Firmware supports vendor commands to query or set LED Bar graph display and 7-segment LED display, and to query toggle switch states.
- Interrupt Endpoint:
- - Sends an 8-bit value that represents the state of the switches.
+- Sends an 8-bit value that represents the state of the switches.
- Sent on startup, resume from suspend, and whenever the switch pack setting changes.
- Firmware does not de-bounce the switch pack.
- One switch change can result in multiple bytes being sent.
- Bits are in the reverse order of the labels on the pack (for example, bit 0x80 is labeled 1 on the pack).
- Bulk Endpoints are configured for loopback:
- - The device moves data from IN endpoint to OUT endpoint.
+- The device moves data from IN endpoint to OUT endpoint.
- The device does not change the values of the data it receives nor does it internally create any data.
- Endpoints are always double buffered.
- Maximum packet size depends on speed (64 full speed, 512 high speed).
- ETW events:
- - Included osrusbfx2.man, which describes events added.
+- Included osrusbfx2.man, which describes events added.
- Three events are targeted to the event log:
- Failure during the add device routine.
- Failure to start the OSR device on a USB 1.1 controller.
diff --git a/usb/umdf_filter_umdf/README.md b/usb/umdf_filter_umdf/README.md
index 503b63de..ace83811 100644
--- a/usb/umdf_filter_umdf/README.md
+++ b/usb/umdf_filter_umdf/README.md
@@ -2,9 +2,9 @@
topic: sample
description: Demonstrates how to load a UMDF filter driver as an upper filter driver above the umdf_fx2 sample driver.
languages:
- - cpp
+- cpp
products:
- - windows
+- windows
---
<!---
@@ -28,13 +28,13 @@ This sample is written for the OSR USB-FX2 Learning Kit. The specification for t
- It contains 1 interface and 3 endpoints (Interrupt IN, Bulk Out, Bulk IN).
- Firmware supports vendor commands to query or set LED Bar graph display and 7-segment LED display, and to query toggle switch states.
- Interrupt Endpoint:
- - Sends an 8-bit value that represents the state of the switches.
+- Sends an 8-bit value that represents the state of the switches.
- Sent on startup, resume from suspend, and whenever the switch pack setting changes.
- Firmware does not de-bounce the switch pack.
- One switch change can result in multiple bytes being sent.
- Bits are in the reverse order of the labels on the pack (for example, bit 0x80 is labeled 1 on the pack).
- Bulk Endpoints are configured for loopback:
- - The device moves data from IN endpoint to OUT endpoint.
+- The device moves data from IN endpoint to OUT endpoint.
- The device does not change the values of the data it receives nor does it internally create any data.
- Endpoints are always double buffered.
- Maximum packet size depends on speed (64 full speed, 512 high speed).
diff --git a/usb/umdf_fx2/README.md b/usb/umdf_fx2/README.md
index bf9c7cc3..0b57018e 100644
--- a/usb/umdf_fx2/README.md
+++ b/usb/umdf_fx2/README.md
@@ -2,9 +2,9 @@
topic: sample
description: A UMDF driver for the OSR USB-FX2 device that includes a test application, sample device metadata, and supports impersonation and idle power down.
languages:
- - cpp
+- cpp
products:
- - windows
+- windows
---
<!---
@@ -45,13 +45,13 @@ The default Solution build configuration is Debug and Win32.
- It contains 1 interface and 3 endpoints (Interrupt IN, Bulk Out, Bulk IN).
- Firmware supports vendor commands to query or set LED Bar graph display and 7-segment LED display, and to query toggle switch states.
- Interrupt Endpoint:
- - Sends an 8-bit value that represents the state of the switches.
+- Sends an 8-bit value that represents the state of the switches.
- Sent on startup, resume from suspend, and whenever the switch pack setting changes.
- Firmware does not de-bounce the switch pack.
- One switch change can result in multiple bytes being sent.
- Bits are in the reverse order of the labels on the pack (for example, bit 0x80 is labeled 1 on the pack).
- Bulk Endpoints are configured for loopback:
- - The device moves data from IN endpoint to OUT endpoint.
+- The device moves data from IN endpoint to OUT endpoint.
- The device does not change the values of the data it receives nor does it internally create any data.
- Endpoints are always double buffered.
- Maximum packet size depends on speed (64 full speed, 512 high speed).
diff --git a/usb/usbsamp/README.md b/usb/usbsamp/README.md
index a2e1a7c1..b9d13ad8 100644
--- a/usb/usbsamp/README.md
+++ b/usb/usbsamp/README.md
@@ -2,9 +2,9 @@
topic: sample
description: Demonstrates how to perform full speed, high speed, and SuperSpeed transfers to and from bulk and isochronous endpoints of a generic USB device.
languages:
- - cpp
+- cpp
products:
- - windows
+- windows
---
<!---
diff --git a/usb/usbview/README.md b/usb/usbview/README.md
index fdb5774f..688800bc 100644
--- a/usb/usbview/README.md
+++ b/usb/usbview/README.md
@@ -2,9 +2,9 @@
topic: sample
description: Provides an application that allows you to browse all USB controllers and connected USB devices on your system.
languages:
- - cpp
+- cpp
products:
- - windows
+- windows
---
<!---
diff --git a/usb/wdf_osrfx2_lab/README.md b/usb/wdf_osrfx2_lab/README.md
index e2cee35c..5455a8c7 100644
--- a/usb/wdf_osrfx2_lab/README.md
+++ b/usb/wdf_osrfx2_lab/README.md
@@ -2,9 +2,9 @@
topic: sample
description: Contains a console test application and a series of iterative drivers for both KMDF and UMDF version 1.
languages:
- - cpp
+- cpp
products:
- - windows
+- windows
---
<!---