summaryrefslogtreecommitdiff
path: root/serial/VirtualSerial/ReadMe.md
diff options
context:
space:
mode:
authorDave Wilson <[email protected]>2015-03-17 19:50:07 -0700
committerDave Wilson <[email protected]>2015-03-17 19:50:07 -0700
commit97cf5197cf5b882b2c689d8dc2b555f2edf8f418 (patch)
tree46f3701832d70b420eb0fc0eb93261f9da45db3f /serial/VirtualSerial/ReadMe.md
parentef1905bf1e8825bb31120dfb27e0daf3154d859a (diff)
Initial publish
Diffstat (limited to 'serial/VirtualSerial/ReadMe.md')
-rw-r--r--serial/VirtualSerial/ReadMe.md59
1 files changed, 59 insertions, 0 deletions
diff --git a/serial/VirtualSerial/ReadMe.md b/serial/VirtualSerial/ReadMe.md
new file mode 100644
index 00000000..2b1bc513
--- /dev/null
+++ b/serial/VirtualSerial/ReadMe.md
@@ -0,0 +1,59 @@
+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.
+
+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.
+
+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
+
+This file lists the functions that the driver DLL exports.
+
+internal.h
+
+This is the main header file for the sample driver.
+
+driver.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.
+
+device.cpp & 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
+
+Definition and implementation of the base queue callback class (CMyQueue). This includes events on the framework I/O queue object.
+
+VirtualSerial.rc /FakeModem.rc
+
+This file defines resource information for the sample driver.
+
+VirtualSerial.inf / FakeModem.inf
+
+INF file that contains installation information for this driver.
+