summaryrefslogtreecommitdiff
path: root/serial/VirtualSerial
diff options
context:
space:
mode:
authorBarry Golden <[email protected]>2019-03-12 14:02:43 -0700
committerAdonais Romero González <[email protected]>2019-03-12 14:02:43 -0700
commitef7ec4ec9ff7ce3c53d60e1c8906915966e17e01 (patch)
tree3017523a73c6552c27947d402afa6062f4df2706 /serial/VirtualSerial
parent35bff356ac249057f4d673d39c7f28ed348cbf0f (diff)
Update README.md for samples portal (#358)
* Update README.md for samples portal * Update README.md for samples portal * Removed installwdf * Update fork (#2) * Fix typo ture -> true * Remove InstallWdf sample * Fix typo (#340) ture -> true * Readme typo fix (#349) * Update langid
Diffstat (limited to 'serial/VirtualSerial')
-rw-r--r--serial/VirtualSerial/README.md68
-rw-r--r--serial/VirtualSerial/serial-virtualserial.yml12
2 files changed, 34 insertions, 46 deletions
diff --git a/serial/VirtualSerial/README.md b/serial/VirtualSerial/README.md
index 7b9c9c39..21bf52da 100644
--- a/serial/VirtualSerial/README.md
+++ b/serial/VirtualSerial/README.md
@@ -1,3 +1,13 @@
+---
+topic: sample
+name: The Serial (16550-based RS-232) sample driver is a WDF version of the inbox Serial.sys driver.
+description: Demonstrates a simple virtual serial driver (ComPort) and a controller-less modem driver (FakeModem).
+languages:
+ - cpp
+products:
+ - windows
+---
+
<!---
name: Virtual serial driver sample
platform: UMDF1
@@ -7,63 +17,53 @@
samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617963
--->
-
-Virtual serial driver sample
-============================
+# Virtual serial driver sample
This sample demonstrates these two serial drivers:
-- A simple virtual serial driver (ComPort)
-- A controller-less modem driver (FakeModem).This driver supports sending and receiving AT commands using the ReadFile and WriteFile calls or via a TAPI interface using an application such as, HyperTerminal.
+- A simple virtual serial driver (ComPort)
+- A controller-less modem driver (FakeModem).This driver supports sending and receiving AT commands using the ReadFile and WriteFile calls or via a TAPI interface using an application such as, HyperTerminal.
This sample driver is a minimal driver meant to demonstrate the usage of the User-Mode Driver Framework. It is not intended for use in a production environment.
For more information, see [Serial Controller and Device Drivers](http://msdn.microsoft.com/en-us/library/windows/hardware/ff546939) in the WDK documentation.
-Code tour
----------
-
-File manifest
-
-Description
-
-comsup.cpp & comsup.h
-
-COM Support code - specifically base classes which provide implementations for the standard COM interfaces **IUnknown** and **IClassFactory** which are used throughout the sample.
-
-The implementation of **IClassFactory** is designed to create instances of the CMyDriver class. If you should change the name of your base driver class, you would also need to modify this file.
+## Code tour
-dllsup.cpp
+### comsup.cpp & comsup.h
-DLL Support code - provides the DLL's entry point as well as the single required export (**DllGetClassObject**).
+- COM Support code - specifically base classes which provide implementations for the standard COM interfaces **IUnknown** and **IClassFactory** which are used throughout the sample.
+- The implementation of **IClassFactory** is designed to create instances of the CMyDriver class. If you should change the name of your base driver class, you would also need to modify this file.
-These depend on comsup.cpp to perform the necessary class creation.
+### dllsup.cpp
-exports.def
+- DLL Support code - provides the DLL's entry point as well as the single required export (**DllGetClassObject**).
+- These depend on comsup.cpp to perform the necessary class creation.
-This file lists the functions that the driver DLL exports.
+### exports.def
-internal.h
+- This file lists the functions that the driver DLL exports.
-This is the main header file for the sample driver.
+### internal.h
-driver.cpp & driver.h
+- This is the main header file for the sample driver.
-Definition and implementation of the driver callback class (CMyDriver) for the sample. This includes **DriverEntry** and events on the framework driver object.
+### driver.cpp & driver.h
-device.cpp & driver.h
+- Definition and implementation of the driver callback class (CMyDriver) for the sample. This includes **DriverEntry** and events on the framework driver object.
-Definition and implementation of the device callback class (CMyDriver) for the sample. This includes events on the framework device object.
+### device.cpp & driver.h
-queue.cpp & queue.h
+- Definition and implementation of the device callback class (CMyDriver) for the sample. This includes events on the framework device object.
-Definition and implementation of the base queue callback class (CMyQueue). This includes events on the framework I/O queue object.
+### queue.cpp & queue.h
-VirtualSerial.rc /FakeModem.rc
+- Definition and implementation of the base queue callback class (CMyQueue). This includes events on the framework I/O queue object.
-This file defines resource information for the sample driver.
+### VirtualSerial.rc /FakeModem.rc
-VirtualSerial.inf / FakeModem.inf
+- This file defines resource information for the sample driver.
-INF file that contains installation information for this driver.
+### VirtualSerial.inf / FakeModem.inf
+- INF file that contains installation information for this driver.
diff --git a/serial/VirtualSerial/serial-virtualserial.yml b/serial/VirtualSerial/serial-virtualserial.yml
deleted file mode 100644
index 7b33b547..00000000
--- a/serial/VirtualSerial/serial-virtualserial.yml
+++ /dev/null
@@ -1,12 +0,0 @@
-### YamlMime:Sample
-sample:
-- name: The Serial (16550-based RS-232) sample driver is a WDF version of the inbox Serial.sys driver.
- description: Demonstrates a simple virtual serial driver (ComPort) and a controller-less modem driver (FakeModem).
- generateZip: true
- preserveParentHierarchy: true
- author: windows-driver-samples
- languages:
- - cpp
- technologies:
- - windows
- vssolution: /serial/VirtualSerial/VirtualSerial.sln