From 3d0e6d055b716d4e86dc5665a58167923aa1fff6 Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Tue, 14 May 2013 22:23:17 +0200 Subject: [PATCH] Minor documentation improvements. --- Bootloaders/HID/Descriptors.c | 4 ++-- Bootloaders/MassStorage/Descriptors.c | 2 +- Bootloaders/Printer/Descriptors.c | 6 +++--- LUFA/DoxygenPages/LUFAPoweredProjects.txt | 1 + Projects/USBtoSerial/USBtoSerial.c | 3 +-- 5 files changed, 8 insertions(+), 8 deletions(-) diff --git a/Bootloaders/HID/Descriptors.c b/Bootloaders/HID/Descriptors.c index e67d25cf61..ac27b760b8 100644 --- a/Bootloaders/HID/Descriptors.c +++ b/Bootloaders/HID/Descriptors.c @@ -57,7 +57,7 @@ const USB_Descriptor_HIDReport_Datatype_t HIDReport[] = HID_RI_END_COLLECTION(0), }; -/** Device descriptor structure. This descriptor, located in FLASH memory, describes the overall +/** Device descriptor structure. This descriptor, located in SRAM memory, describes the overall * device characteristics, including the supported USB version, control endpoint size and the * number of device configurations. The descriptor is read out by the USB host when the enumeration * process begins. @@ -84,7 +84,7 @@ const USB_Descriptor_Device_t DeviceDescriptor = .NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS }; -/** Configuration descriptor structure. This descriptor, located in FLASH memory, describes the usage +/** Configuration descriptor structure. This descriptor, located in SRAM memory, describes the usage * of the device in one of its supported configurations, including information about any device interfaces * and endpoints. The descriptor is read out by the USB host during the enumeration process when selecting * a configuration so that the host may correctly communicate with the USB device. diff --git a/Bootloaders/MassStorage/Descriptors.c b/Bootloaders/MassStorage/Descriptors.c index cbc320f9c7..7ae0a7da9e 100644 --- a/Bootloaders/MassStorage/Descriptors.c +++ b/Bootloaders/MassStorage/Descriptors.c @@ -38,7 +38,7 @@ #include "Descriptors.h" -/** Device descriptor structure. This descriptor, located in FLASH memory, describes the overall +/** Device descriptor structure. This descriptor, located in SRAM memory, describes the overall * device characteristics, including the supported USB version, control endpoint size and the * number of device configurations. The descriptor is read out by the USB host when the enumeration * process begins. diff --git a/Bootloaders/Printer/Descriptors.c b/Bootloaders/Printer/Descriptors.c index 3bc483753c..b1b1a5898b 100644 --- a/Bootloaders/Printer/Descriptors.c +++ b/Bootloaders/Printer/Descriptors.c @@ -38,7 +38,7 @@ #include "Descriptors.h" -/** Device descriptor structure. This descriptor, located in FLASH memory, describes the overall +/** Device descriptor structure. This descriptor, located in SRAM memory, describes the overall * device characteristics, including the supported USB version, control endpoint size and the * number of device configurations. The descriptor is read out by the USB host when the enumeration * process begins. @@ -65,7 +65,7 @@ const USB_Descriptor_Device_t DeviceDescriptor = .NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS }; -/** Configuration descriptor structure. This descriptor, located in FLASH memory, describes the usage +/** Configuration descriptor structure. This descriptor, located in SRAM memory, describes the usage * of the device in one of its supported configurations, including information about any device interfaces * and endpoints. The descriptor is read out by the USB host during the enumeration process when selecting * a configuration so that the host may correctly communicate with the USB device. @@ -124,7 +124,7 @@ const USB_Descriptor_Configuration_t ConfigurationDescriptor = } }; -/** Language descriptor structure. This descriptor, located in FLASH memory, is returned when the host requests +/** Language descriptor structure. This descriptor, located in SRAM memory, is returned when the host requests * the string descriptor with index 0 (the first index). It is actually an array of 16-bit integers, which indicate * via the language ID table available at USB.org what languages the device supports for its string descriptors. */ diff --git a/LUFA/DoxygenPages/LUFAPoweredProjects.txt b/LUFA/DoxygenPages/LUFAPoweredProjects.txt index 82d790392a..e689bc91d8 100644 --- a/LUFA/DoxygenPages/LUFAPoweredProjects.txt +++ b/LUFA/DoxygenPages/LUFAPoweredProjects.txt @@ -64,6 +64,7 @@ * \li FootJoy, a 22 button, 6-axis josystick with keyboard and mouse modes: https://bitbucket.org/sirbrialliance/foot-joy/ * \li Gamecube controller to USB adapter: https://www.facebook.com/media/set/?set=a.10150202447076304.310536.688776303&l=df53851c50 * \li Garmin GPS USB to NMEA standard serial sentence translator: http://github.com/nall/garmin-transmogrifier/tree/master + * \li Geiger Counter with USB interface: http://www.hforsten.com/i-made-a-geiger-counter.html * \li Generic HID Device Creator: http://generichid.sourceforge.net/ * \li Generic HID Open Source Framework: http://www.waitingforfriday.com/index.php/USB_Generic_HID_Open_Source_Framework_for_Atmel_AVR_and_Windows * \li Ghetto Drum, a MIDI drum controller: http://noisybox.net/art/gdrum/ diff --git a/Projects/USBtoSerial/USBtoSerial.c b/Projects/USBtoSerial/USBtoSerial.c index a500c83765..76e3cb837b 100644 --- a/Projects/USBtoSerial/USBtoSerial.c +++ b/Projects/USBtoSerial/USBtoSerial.c @@ -99,12 +99,11 @@ int main(void) { int16_t ReceivedByte = CDC_Device_ReceiveByte(&VirtualSerial_CDC_Interface); - /* Read bytes from the USB OUT endpoint into the USART transmit buffer */ + /* Store received byte into the USART transmit buffer */ if (!(ReceivedByte < 0)) RingBuffer_Insert(&USBtoUSART_Buffer, ReceivedByte); } - /* Check if the UART receive buffer flush timer has expired or the buffer is nearly full */ uint16_t BufferCount = RingBuffer_GetCount(&USARTtoUSB_Buffer); if (BufferCount) {