Fixed incorrect interface values in the VirtualSerialMouse and KeyboardMouse demo class driver structures.

Added caveat information to the CDC device class driver.

3 files changed, 20 insertions, 2 deletions

diff --git a/LUFA/Doxygen.conf b/LUFA/Doxygen.conf
index 265a27ec6..c46aba6a1 100644
--- a/LUFA/Doxygen.conf
+++ b/LUFA/Doxygen.conf
@@ -872,14 +872,14 @@ GENERATE_HTMLHELP      = NO
 # can add a path in front of the file if the result should not be

 # written to the html output directory.

 

-CHM_FILE               =

+CHM_FILE               = ../LUFA.chm

 

 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can

 # be used to specify the location (absolute path including file name) of

 # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run

 # the HTML help compiler on the generated index.hhp.

 

-HHC_LOCATION           =

+HHC_LOCATION           = 

 

 # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag

 # controls if a separate .chi index file is generated (YES) or that

diff --git a/LUFA/Drivers/USB/Class/Device/CDC.h b/LUFA/Drivers/USB/Class/Device/CDC.h
index 617410b11..d248868cd 100644
--- a/LUFA/Drivers/USB/Class/Device/CDC.h
+++ b/LUFA/Drivers/USB/Class/Device/CDC.h
@@ -38,6 +38,23 @@
  *  \section Module Description

  *  Device Mode USB Class driver framework interface, for the CDC USB Class driver.

  *

+ *  \note There are several major drawbacks to the CDC-ACM standard USB class, however

+ *        it is very standardized and thus usually available as a built-in driver on

+ *        most platforms, and so is a better choice than a proprietary serial class.

+ *        

+ *        One major issue with CDC-ACM is that it requires two Interface descriptors,

+ *        which will upset most hosts when part of a multi-function "Composite" USB

+ *        device, as each interface will be loaded into a separate driver instance. To

+ *        conbat this, you should use the "Interface Association Descriptor" addendum to

+ *        the USB standard which is available on most OSes when creating Composite devices.

+ *

+ *        Another major oversight is that there is no mechanism for the host to notify the

+ *        device that there is a data sink on the host side ready to accept data. This

+ *        means that the device may try to send data while the host isn't listening, causing

+ *        lengthy blocking timeouts in the transmission routines. To combat this, it is

+ *        recommended that the virtual serial line DTR (Data Terminal Ready) be used where

+ *        possible to determine if a host application is ready for data.

+ *

  *  @{

  */

  

diff --git a/LUFA/ManPages/ChangeLog.txt b/LUFA/ManPages/ChangeLog.txt
index 351c33f3e..d0043223e 100644
--- a/LUFA/ManPages/ChangeLog.txt
+++ b/LUFA/ManPages/ChangeLog.txt
@@ -34,6 +34,7 @@
   *  - Fixed blocking CDC streams not aborting when the host is disconnected

   *  - Fixed XPLAIN board Dataflash driver broken due to incorrect preprocessor commands

   *  - Fixed inverted XPLAIN LED driver output (LED turned on when it was supposed to be turned off, and vice-versa)

+  *  - Fixed Class Driver struct interface numbers in the KeyboardMouse and VirtualSerialMouse demos

   *

   *  \section Sec_ChangeLog091223 Version 091223

   *