From 189d0c7e669b6a3d07ed35c1eaa0bfc8cbc7a729 Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Mon, 22 Jun 2009 11:32:51 +0000 Subject: Add demos/bootloaders/projects overview to the manual. --- Demos/Device/LowLevel/USBtoSerial/USBtoSerial.c | 2 +- LUFA.pnproj | 2 +- LUFA/ManPages/ChangeLog.txt | 2 +- LUFA/ManPages/DemosBootloadersProjects.txt | 92 +++++++++++++++++++++++++ LUFA/ManPages/MainPage.txt | 17 ++--- 5 files changed, 100 insertions(+), 15 deletions(-) create mode 100644 LUFA/ManPages/DemosBootloadersProjects.txt diff --git a/Demos/Device/LowLevel/USBtoSerial/USBtoSerial.c b/Demos/Device/LowLevel/USBtoSerial/USBtoSerial.c index 444aa5e1c..c48c33c08 100644 --- a/Demos/Device/LowLevel/USBtoSerial/USBtoSerial.c +++ b/Demos/Device/LowLevel/USBtoSerial/USBtoSerial.c @@ -237,7 +237,7 @@ void CDC_Task(void) if (Endpoint_IsOUTReceived()) { /* Read the bytes in from the endpoint into the buffer while space is available */ - while (Endpoint_BytesInEndpoint() && (BUFF_STATICSIZE - Rx_Buffer.Elements)) + while (Endpoint_BytesInEndpoint() && (Rx_Buffer.Elements != BUFF_STATICSIZE)) { /* Store each character from the endpoint */ Buffer_StoreElement(&Rx_Buffer, Endpoint_Read_Byte()); diff --git a/LUFA.pnproj b/LUFA.pnproj index 354a4f574..9855bab21 100644 --- a/LUFA.pnproj +++ b/LUFA.pnproj @@ -1 +1 @@ - \ No newline at end of file + \ No newline at end of file diff --git a/LUFA/ManPages/ChangeLog.txt b/LUFA/ManPages/ChangeLog.txt index a0998358f..81fb51555 100644 --- a/LUFA/ManPages/ChangeLog.txt +++ b/LUFA/ManPages/ChangeLog.txt @@ -27,7 +27,7 @@ * - Make Pipe_ConfigurePipe() mask the given endpoint number against PIPE_EPNUM_MASK to ensure the endpoint IN direction bit is * cleared to prevent endpoint type corruption * - Fix documentation mentioning Pipe_GetCurrentToken() function when real name is Pipe_GetPipeToken() - * - Extend USB_GetDeviceConfigDescriptor() routine to require the configuration number within the device to fetch + * - Extended USB_GetDeviceConfigDescriptor() routine to require the configuration number within the device to fetch * - Added new USE_INTERNAL_SERIAL define for using the unique serial numbers in some AVR models as the USB device's serial number, * added NO_INTERNAL_SERIAL compile time option to turn off new serial number reading code * - Fixed ADC driver for the ATMEGA32U4 and ATMEGA16U4 (thanks to Opendous Inc.) diff --git a/LUFA/ManPages/DemosBootloadersProjects.txt b/LUFA/ManPages/DemosBootloadersProjects.txt new file mode 100644 index 000000000..c88651361 --- /dev/null +++ b/LUFA/ManPages/DemosBootloadersProjects.txt @@ -0,0 +1,92 @@ +/** \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_Apps Library Demos, Projects and Bootloaders + * + * The LUFA library ships with several different host and device demos, located in the /Demos/ subdirectory. + * If this directory is missing, please re-download the project from the project homepage. Within this directory the demos + * are seperated by USB mode (Device, Host, OTG) and further seperated by the use or non-use of the library USB Class drivers. + * + * Also included with the library are three fully functional bootloaders, located in the /Bootloaders/ subdirectory. + * The DFU class bootloader is compatible with Atmel's FLIP software or the open source dfu-programmer project, the + * CDC class (AVR109 protocol) is compatible with such open source software as AVRDUDE and AVR-OSP, and the TeensyLoader + * HID class bootloader is compatible with the software from PJRC (http://www.pjrc.com/teensy/index.html). + * + * User-submitted projects are located in the /Projects/ subdirectory. If you wish to have your LUFA project included, + * please email it to the Library author. + * + * \section Sec_AppOverview Overview of Included Library Applications + * The following shows the folder structure of the included library applications, including demos, bootloaders and user-submitted + * open source projects. + * + * + * + * - Demos + * - Device + * - ClassDriver + * - AudioInput - Audio In (microphone) demo, using the library USB Audio Class driver framework. + * - AudioOutput - Audio Out (speaker) demo, using the library USB Audio Class driver framework + * - CDC - Virtual Serial Port demo, using the library USB CDC Class driver framework + * - DualCDC - Dual Virtual Serial Port demo, using the library USB CDC Class driver framework + * - GenericHID - Generic Human Interface Class demo, using the library USB HID Class driver framework + * - Joystick - USB Joystick demo, using the library USB HID Class driver framework + * - Keyboard - USB Keyboard demo, using the library USB HID Class driver framework + * - KeyboardMouse - Dual Keyboard/Mouse demo, using the library USB HID Class driver framework + * - MassStorage - Dual Drive Mass Storage demo, using the library USB Mass Storage Class driver framework + * - MIDI - MIDI In demo, using the library USB MIDI-Audio Class driver framework + * - Mouse - USB Mouse demo, using the library USB HID driver framework + * - RNDISEthernet - RNDIS Ethernet Webserver demo, using the library USB RNDIS driver framework + * - USBtoSerial - USB to USART Serial converter demo, using the library USB CDC driver framework + * - LowLevel + * - AudioInput - Audio In (microphone) demo, using the low level LUFA APIs to implement the USB Audio class + * - AudioOutput - Audio Out (speaker) demo, using the low level LUFA APIs to implement the USB Audio class + * - CDC - Virtual Serial Port demo, using the low level LUFA APIs to implement the USB CDC class + * - DualCDC - Dual Virtual Serial Port demo, using the low level LUFA APIs to implement the USB CDC class + * - GenericHID - Generic Human Interface Class demo, using the low level LUFA APIs to implement the USB HID class + * - Joystick - USB Joystick demo, using the low level LUFA APIs to implement the USB HID class + * - Keyboard - USB Keyboard demo, using the low level LUFA APIs to implement the USB HID class + * - KeyboardMouse - Dual Keyboard/Mouse demo, using the low level LUFA APIs to implement the USB HID class + * - MassStorage - Dual Drive Mass Storage demo, using the low level LUFA APIs to implement the USB Mass Storage class + * - MIDI - MIDI In demo, using the low level LUFA APIs to implement the USB MIDI-Audio class + * - Mouse - USB Mouse demo, using the low level LUFA APIs to implement the USB HID class + * - RNDISEthernet - RNDIS Ethernet Webserver demo, using the low level LUFA APIs to implement the USB RNDIS class + * - USBtoSerial - USB to USART Serial converter demo, using the low level LUFA APIs to implement the USB CDC class + * - Incomplete + * - SideShow - Incomplete Windows SideShow demo, using the low level LUFA APIs to implement the USB SideShow class + * - Host + * - ClassDriver + * - CDCHost - Virtual Serial Port host demo, using the library USB CDC Class driver framework + * - GenericHIDHost - Generic HID host demo, using the library USB HID Class driver framework + * - KeyboardHost - USB Keyboard host demo, using the library USB HID Class driver framework + * - KeyboardHostWithParser - USB Keyboard host demo with HID Descriptor parser, using the library USB HID Class + * driver framework + * - MassStorageHost - Mass Storage host demo, using the library USB Mass Storage Class driver framework + * - MouseHost - Mouse host demo, using the library USB HID Class driver framework + * - MouseHostWithParser - Mouse host demo with HID Descriptor parser, using the library USB HID Class driver framework + * - StillImageHost - Still Image Camera host demo, using the library USB Still Image Class driver framework + * - LowLevel + * - CDCHost - Virtual Serial Port host demo, using the low level LUFA APIs to implement the USB CDC class + * - GenericHIDHost - Generic HID host demo, using the low level LUFA APIs to implement the USB HID class + * - KeyboardHost - USB Keyboard host demo, using the low level LUFA APIs to implement the USB HID class + * - KeyboardHostWithParser - USB Keyboard host demo with HID Descriptor parser, using the low level LUFA APIs to + * implement the USB HID class + * - MassStorageHost - Mass Storage host demo, using the low level LUFA APIs to implement the USB Mass Storage class + * - MouseHost - Mouse host demo, using the low level LUFA APIs to implement the USB HID class + * - MouseHostWithParser - Mouse host demo with HID Descriptor parser, using the low level LUFA APIs to implement the + * USB HID class + * - StillImageHost - Still Image Camera host demo, using the low level LUFA APIs to implement the USB Still Image class + * - Incomplete + * - BluetoothHost - Incomplete Bluetooth host demo, using the low level LUFA APIs to implement the USB Bluetooth class + * - Bootloaders + * - DFU - DFU Class USB bootloader, compatible with Atmel's FLIP and the open source dfu-programmer software + * - CDC - CDC Class USB bootloader, compatible with any AVR910 protocol programming software such as AVRDude + * - TeensyHID - HID Class bootloader, compatible with the PJRC TeensyLoader software + * - Projects + * - Magstripe - Magnetic Stripe Card Reader project + * - MissileLaucher - Toy Missile Launcher Host project + * + * + */ \ No newline at end of file diff --git a/LUFA/ManPages/MainPage.txt b/LUFA/ManPages/MainPage.txt index 23fa08b4c..75f677b97 100644 --- a/LUFA/ManPages/MainPage.txt +++ b/LUFA/ManPages/MainPage.txt @@ -13,8 +13,8 @@ * * For author and donation information, see \ref Page_Donating. * - * Originally based on the AT90USBKEY from Atmel, LUFA is an open-source USB library for the USB-enabled AVR - * microcontrollers, released under the MIT license. It now supports a large number of USB AVR models and boards. + * LUFA is an open-source USB library for the USB-enabled AVR microcontrollers, released under the MIT license. It supports + * a large number of USB AVR models and boards (see \ref Page_DeviceSupport). * * The library is currently in a stable release, suitable for download and incorporation into user projects for * both host and device modes. For information about the project progression, check out my blog. @@ -23,20 +23,13 @@ * library API more streamlined and robust. You can download AVR-GCC for free in a convenient windows package, * from the the WinAVR website. * - * The LUFA library ships with several different host and device demos, located in the /Demos/ subdirectory. - * If this directory is missing, please re-download the project from the project homepage. - * - * Also included with the library are three fully functional bootloaders, located in the /Bootloaders/ subdirectory. - * The DFU class bootloader is compatible with Atmel's FLIP software or the open source dfu-programmer project, the - * CDC class (AVR109 protocol) is compatible with such open source software as AVRDUDE and AVR-OSP, and the TeensyLoader - * HID class bootloader is compatible with the software from PJRC (http://www.pjrc.com/teensy/index.html). - * - * User-submitted projects are located in the /Projects/ subdirectory. If you wish to have your LUFA project included, - * please email it to the Library author. + * Accompanying LUFA in the download package is a set of example demo applications, plus several Bootloaders (DFU, CDC and HID + * class) and open source LUFA powered projects. * * Subsections: * - \subpage Page_Licence Project License * - \subpage Page_Donating Donating to Support this Project + * - \subpage Page_Apps Project Demos, Bootloaders and Projects * * * Logo design by Pavla Dlab -- cgit v1.2.3