diff options
| author | Barry Golden <[email protected]> | 2019-03-12 14:02:43 -0700 |
|---|---|---|
| committer | Adonais Romero González <[email protected]> | 2019-03-12 14:02:43 -0700 |
| commit | ef7ec4ec9ff7ce3c53d60e1c8906915966e17e01 (patch) | |
| tree | 3017523a73c6552c27947d402afa6062f4df2706 /serial/VirtualSerial2 | |
| parent | 35bff356ac249057f4d673d39c7f28ed348cbf0f (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/VirtualSerial2')
| -rw-r--r-- | serial/VirtualSerial2/README.md | 69 | ||||
| -rw-r--r-- | serial/VirtualSerial2/serial-virtualserial2.yml | 12 |
2 files changed, 42 insertions, 39 deletions
diff --git a/serial/VirtualSerial2/README.md b/serial/VirtualSerial2/README.md index 81405d15..23e8b170 100644 --- a/serial/VirtualSerial2/README.md +++ b/serial/VirtualSerial2/README.md @@ -1,3 +1,13 @@ +--- +topic: sample +name: Virtual serial driver sample (UMDF version 2) +description: Demonstrates UMDF version 2 serial drivers and includes a simple virtual serial driver (ComPort) and a controller-less modem driver (FakeModem). +languages: + - cpp +products: + - windows +--- + <!--- name: Virtual serial driver sample (UMDF version 2) platform: UMDF2 @@ -7,48 +17,53 @@ samplefwlink: http://go.microsoft.com/fwlink/p/?LinkId=617965 ---> - -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 ---------- +## Code tour + +### 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. -#### 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. +### driver.cpp & driver.h -#### 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. +- Definition and implementation of the driver callback class (CMyDriver) for the sample. This includes **DriverEntry** and events on the framework driver object. -#### exports.def -This file lists the functions that the driver DLL exports. +### device.cpp & driver.h -#### internal.h -This is the main header file for the sample driver. +- Definition and implementation of the device callback class (CMyDriver) for the sample. This includes events on the framework device object. -#### 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. +### queue.cpp & queue.h -#### device.cpp & driver.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 -Definition and implementation of the base queue callback class (CMyQueue). This includes events on the framework I/O queue object. +### VirtualSerial.rc /FakeModem.rc -#### VirtualSerial.rc /FakeModem.rc -This file defines resource information for the sample driver. +- This file defines resource information for the sample driver. -#### VirtualSerial.inf / FakeModem.inf -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/VirtualSerial2/serial-virtualserial2.yml b/serial/VirtualSerial2/serial-virtualserial2.yml deleted file mode 100644 index aff10eda..00000000 --- a/serial/VirtualSerial2/serial-virtualserial2.yml +++ /dev/null @@ -1,12 +0,0 @@ -### YamlMime:Sample -sample: -- name: Virtual serial driver sample (UMDF version 2) - description: Demonstrates UMDF version 2 serial drivers and includes 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/VirtualSerial2/VirtualSerial.sln |
