summaryrefslogtreecommitdiff
path: root/serial/VirtualSerial
diff options
context:
space:
mode:
authorDipannita Shaw <[email protected]>2021-04-27 14:26:21 -0700
committerDipannita Shaw <[email protected]>2021-04-27 14:26:21 -0700
commit78a1795995814a0bac43042f7ca68e83ab525bd5 (patch)
tree8e2eb0e8c3a11220f2f119964c6c6e3674eda0da /serial/VirtualSerial
parent465e27457dd3b47cf64e4b7274705cc6acc011a6 (diff)
parent672fafbcc455cd97172b2df78040c7c405e32d00 (diff)
Merge remote-tracking branch 'upstream/master'
Diffstat (limited to 'serial/VirtualSerial')
-rw-r--r--serial/VirtualSerial/README.md25
1 files changed, 10 insertions, 15 deletions
diff --git a/serial/VirtualSerial/README.md b/serial/VirtualSerial/README.md
index b566c2a5..3eeb9764 100644
--- a/serial/VirtualSerial/README.md
+++ b/serial/VirtualSerial/README.md
@@ -5,38 +5,33 @@ languages:
- cpp
products:
- windows
+- windows-wdk
---
-<!---
- name: Virtual serial driver sample
- platform: UMDF1
- language: cpp
- category: Serial
- description: Demonstrates a simple virtual serial driver (ComPort) and a controller-less modem driver (FakeModem).
- samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617963
---->
-
# 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.
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.
+For more information, see the [Serial Controller Driver Design Guide](https://docs.microsoft.com/windows-hardware/drivers/serports/).
## Code tour
-### comsup.cpp & comsup.h
+### comsup.cpp and 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.
### dllsup.cpp
- 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.
### exports.def
@@ -47,15 +42,15 @@ For more information, see [Serial Controller and Device Drivers](http://msdn.mic
- This is the main header file for the sample driver.
-### driver.cpp & driver.h
+### driver.cpp and driver.h
- Definition and implementation of the driver callback class (CMyDriver) for the sample. This includes **DriverEntry** and events on the framework driver object.
-### device.cpp & driver.h
+### device.cpp and driver.h
- Definition and implementation of the device callback class (CMyDriver) for the sample. This includes events on the framework device object.
-### queue.cpp & queue.h
+### queue.cpp and queue.h
- Definition and implementation of the base queue callback class (CMyQueue). This includes events on the framework I/O queue object.
@@ -65,4 +60,4 @@ For more information, see [Serial Controller and Device Drivers](http://msdn.mic
### VirtualSerial.inf / FakeModem.inf
-- INF file that contains installation information for this driver. \ No newline at end of file
+- INF file that contains installation information for this driver.