diff options
author | Fabian Topfstedt <topfstedt@schneevonmorgen.com> | 2017-07-20 08:22:44 +0200 |
---|---|---|
committer | Fabian Topfstedt <topfstedt@schneevonmorgen.com> | 2017-07-20 08:22:44 +0200 |
commit | ee43856ff7ba37ea89d1a8a4700efba4e4f69571 (patch) | |
tree | b0ed5b538396b0b2b027e69ad8ceac443c067c79 /lib/lufa/LUFA/DoxygenPages/OSDrivers.txt | |
parent | 99b6e918eab31d4f53cabc04a995da945335ac7f (diff) | |
parent | 14c5160b1a94d5dc416002791b3c207ba0dca789 (diff) |
Merge https://github.com/qmk/qmk_firmware
Diffstat (limited to 'lib/lufa/LUFA/DoxygenPages/OSDrivers.txt')
-rw-r--r-- | lib/lufa/LUFA/DoxygenPages/OSDrivers.txt | 111 |
1 files changed, 111 insertions, 0 deletions
diff --git a/lib/lufa/LUFA/DoxygenPages/OSDrivers.txt b/lib/lufa/LUFA/DoxygenPages/OSDrivers.txt new file mode 100644 index 0000000000..4823c5b089 --- /dev/null +++ b/lib/lufa/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="150px">Android</th> + * <th width="150px">Windows</th> + * <th width="150px">Linux</th> + * <th width="150px">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>3.?+</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, + * VID/PID ID pair, Windows 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/LUFA CDC-ACM.inf" + * + * \subsection SSec_WinINF_RNDIS Windows RNDIS INF Template + * This template is required for all RNDIS devices on Windows XP or newer. + * \verbinclude "WindowsINF/LUFA RNDIS.inf" + */ + |