diff options
Diffstat (limited to 'LUFA/DoxygenPages')
-rw-r--r-- | LUFA/DoxygenPages/DevelopingWithLUFA.txt | 1 | ||||
-rw-r--r-- | LUFA/DoxygenPages/OSDrivers.txt | 111 |
2 files changed, 112 insertions, 0 deletions
diff --git a/LUFA/DoxygenPages/DevelopingWithLUFA.txt b/LUFA/DoxygenPages/DevelopingWithLUFA.txt index e669e284c..9a02f95b9 100644 --- a/LUFA/DoxygenPages/DevelopingWithLUFA.txt +++ b/LUFA/DoxygenPages/DevelopingWithLUFA.txt @@ -15,6 +15,7 @@ * \li \subpage Page_TokenSummary - Summary of Compile Time Tokens * \li \subpage Page_Migration - Migrating from an Older LUFA Version * \li \subpage Page_VIDPID - Allocated USB VID and PID Values + * \li \subpage Page_OSDrivers - Operating System Driver Information * \li \subpage Page_BuildLibrary - Building as a Linkable Library * \li \subpage Page_ExportingLibrary - Exporting LUFA for IDE Use * \li \subpage Page_WritingBoardDrivers - How to Write Custom Board Drivers diff --git a/LUFA/DoxygenPages/OSDrivers.txt b/LUFA/DoxygenPages/OSDrivers.txt new file mode 100644 index 000000000..28c1ca93a --- /dev/null +++ b/LUFA/DoxygenPages/OSDrivers.txt @@ -0,0 +1,111 @@ +/** \file + * + * This file contains special DoxyGen information for the generation of the main page and other special + * documentation pages. It is not a project source file. + */ + +/** \page Page_OSDrivers Operating System Drivers + * + * Most of the USB classes supported by LUFA are also supported natively in + * most operating systems, without extra drivers being required. However, in + * some cases, a driver file is required in order for the device to enumerate + * and function correctly. + * + * \section Sec_OSClassSupport Operating System USB Class Support + * The table below lists the supported LUFA USB classes, and their associated + * <i>native</i> support on modern operating systems. + * + * <table> + * <tr> + * <th width="200px">USB Class</th> + * <th width="200px">Android</th> + * <th width="200px">Windows</th> + * <th width="200px">Linux</th> + * <th width="200px">OS X</th> + * </tr> + * <tr> + * <td>Android Open Accessory</td> + * <td>2.3.4+</td> + * <td>N/A</td> + * <td>N/A</td> + * <td>N/A</td> + * </tr> + * <tr> + * <td>Audio 1.0</td> + * <td>N/A</td> + * <td>XP+</td> + * <td>2.6.?+</td> + * <td>10.?+</td> + * </tr> + * <tr> + * <td>CDC-ACM</td> + * <td>N/A</td> + * <td>XP+</td> + * <td>2.6.?+</td> + * <td>10.?+</td> + * </tr> + * <tr> + * <td>HID</td> + * <td>N/A</td> + * <td>XP+</td> + * <td>2.6.?+</td> + * <td>10.?+</td> + * </tr> + * <tr> + * <td>MIDI</td> + * <td>N/A</td> + * <td>XP+</td> + * <td>2.6.?+</td> + * <td>10.?+</td> + * </tr> + * <tr> + * <td>Mass Storage</td> + * <td>N/A</td> + * <td>XP+</td> + * <td>2.6.?+</td> + * <td>10.?+</td> + * </tr> + * <tr> + * <td>Printer</td> + * <td>N/A</td> + * <td>XP+</td> + * <td>2.6.?+</td> + * <td>10.?+</td> + * </tr> + * <tr> + * <td>RNDIS</td> + * <td>N/A</td> + * <td>XP+</td> + * <td>2.6.?+</td> + * <td>N/A</td> + * </tr> + * <tr> + * <td>Still Image</td> + * <td>N/A</td> + * <td>XP+</td> + * <td>2.6.?+</td> + * <td>10.?+</td> + * </tr> + * </table> + * + * \section Sec_WinINFTemplates Windows INF Drivers + * Windows uses INF driver files to associate a USB device of a specific class, + * Vendor and Product ID, compatibility ID or other characteristic to a kernel + * driver. In most cases these files are build into the operating system, and + * no special user action or driver files are required for a device using a + * standard USB class to enumerate. However, for some classes, a specific INF + * driver must be created and given to the operating system for the device to + * enumerate. + * + * Those USB classes requiring a custom INF driver file in Windows are listed + * below, along with a basic INF template for each class. + * + * \subsection SSec_WinINF_CDC Windows CDC INF Template + * This template is required for all CDC-ACM devices on Windows XP or newer. + * \verbinclude WindowsINF/CDC-ACM.inf + * + * \subsection SSec_WinINF_RNDIS Windows RNDIS INF Template + * This template is required for all CDC-RNDIS devices on Windows XP or newer. + * \verbinclude WindowsINF/RNDIS.inf + */ + |