diff options
author | Dean Camera <dean@fourwalledcubicle.com> | 2009-06-04 02:55:30 +0000 |
---|---|---|
committer | Dean Camera <dean@fourwalledcubicle.com> | 2009-06-04 02:55:30 +0000 |
commit | a67bd74e3e8aad87dcee8cf0c0eaaccbe7d00552 (patch) | |
tree | fdf670b5b93e2e192d19ca71138a667d7f3ba4f9 /Demos/Device/CDC | |
parent | 7c5444b89a49df7cb671b0b041567990d2a3012e (diff) | |
download | lufa-a67bd74e3e8aad87dcee8cf0c0eaaccbe7d00552.tar.gz lufa-a67bd74e3e8aad87dcee8cf0c0eaaccbe7d00552.tar.bz2 lufa-a67bd74e3e8aad87dcee8cf0c0eaaccbe7d00552.zip |
Minor documentation page updates.
Redocumented all device demos, now that they have changed over to the new USB class drivers.
Added C linkage to class drivers for C++ support.
Added prefixes to most of the class driver constants to prevent name clashes.
Diffstat (limited to 'Demos/Device/CDC')
-rw-r--r-- | Demos/Device/CDC/CDC.c | 21 | ||||
-rw-r--r-- | Demos/Device/CDC/CDC.h | 7 |
2 files changed, 27 insertions, 1 deletions
diff --git a/Demos/Device/CDC/CDC.c b/Demos/Device/CDC/CDC.c index e6bc1a455..6f1539334 100644 --- a/Demos/Device/CDC/CDC.c +++ b/Demos/Device/CDC/CDC.c @@ -28,8 +28,18 @@ this software.
*/
+/** \file
+ *
+ * Main source file for the CDC demo. This file contains the main tasks of
+ * the demo and is responsible for the initial application hardware configuration.
+ */
+
#include "CDC.h"
+/** LUFA CDC Class driver interface configuration and state information. This structure is
+ * passed to all CDC Class driver functions, so that multiple instances of the same class
+ * within a device can be differentiated from one another.
+ */
USB_ClassInfo_CDC_t VirtualSerial_CDC_Interface =
{
.ControlInterfaceNumber = 0,
@@ -44,6 +54,9 @@ USB_ClassInfo_CDC_t VirtualSerial_CDC_Interface = .NotificationEndpointSize = CDC_NOTIFICATION_EPSIZE,
};
+/** Main program entry point. This routine contains the overall program flow, including initial
+ * setup of all components and the main program loop.
+ */
int main(void)
{
SetupHardware();
@@ -63,6 +76,7 @@ int main(void) }
}
+/** Configures the board hardware and chip peripherals for the demo's functionality. */
void SetupHardware(void)
{
/* Disable watchdog if enabled by bootloader/fuses */
@@ -78,11 +92,12 @@ void SetupHardware(void) USB_Init();
}
+/** Checks for changes in the position of the board joystick, sending strings to the host upon each change. */
void CheckJoystickMovement(void)
{
uint8_t JoyStatus_LCL = Joystick_GetStatus();
char* ReportString = NULL;
- static bool ActionSent = false;
+ static bool ActionSent = false;
char* JoystickStrings[] =
{
@@ -114,16 +129,19 @@ void CheckJoystickMovement(void) }
}
+/** Event handler for the library USB Connection event. */
void EVENT_USB_Connect(void)
{
LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
}
+/** Event handler for the library USB Disconnection event. */
void EVENT_USB_Disconnect(void)
{
LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
}
+/** Event handler for the library USB Configuration Changed event. */
void EVENT_USB_ConfigurationChanged(void)
{
LEDs_SetAllLEDs(LEDMASK_USB_READY);
@@ -132,6 +150,7 @@ void EVENT_USB_ConfigurationChanged(void) LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
}
+/** Event handler for the library USB Unhandled Control Packet event. */
void EVENT_USB_UnhandledControlPacket(void)
{
USB_CDC_ProcessControlPacket(&VirtualSerial_CDC_Interface);
diff --git a/Demos/Device/CDC/CDC.h b/Demos/Device/CDC/CDC.h index dc4033448..23072d683 100644 --- a/Demos/Device/CDC/CDC.h +++ b/Demos/Device/CDC/CDC.h @@ -51,9 +51,16 @@ #include <LUFA/Drivers/USB/Class/Device/CDC.h>
/* Macros: */
+ /** LED mask for the library LED driver, to indicate that the USB interface is not ready. */
#define LEDMASK_USB_NOTREADY LEDS_LED1
+
+ /** LED mask for the library LED driver, to indicate that the USB interface is enumerating. */
#define LEDMASK_USB_ENUMERATING (LEDS_LED2 | LEDS_LED3)
+
+ /** LED mask for the library LED driver, to indicate that the USB interface is ready. */
#define LEDMASK_USB_READY (LEDS_LED2 | LEDS_LED4)
+
+ /** LED mask for the library LED driver, to indicate that an error has occurred in the USB interface. */
#define LEDMASK_USB_ERROR (LEDS_LED1 | LEDS_LED3)
/* Function Prototypes: */
|