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/GenericHID | |
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/GenericHID')
-rw-r--r-- | Demos/Device/GenericHID/GenericHID.c | 32 | ||||
-rw-r--r-- | Demos/Device/GenericHID/GenericHID.h | 7 |
2 files changed, 39 insertions, 0 deletions
diff --git a/Demos/Device/GenericHID/GenericHID.c b/Demos/Device/GenericHID/GenericHID.c index 9c8023a5c..b933e4506 100644 --- a/Demos/Device/GenericHID/GenericHID.c +++ b/Demos/Device/GenericHID/GenericHID.c @@ -28,8 +28,18 @@ this software.
*/
+/** \file
+ *
+ * Main source file for the GenericHID demo. This file contains the main tasks of
+ * the demo and is responsible for the initial application hardware configuration.
+ */
+
#include "GenericHID.h"
+/** LUFA HID Class driver interface configuration and state information. This structure is
+ * passed to all HID Class driver functions, so that multiple instances of the same class
+ * within a device can be differentiated from one another.
+ */
USB_ClassInfo_HID_t Generic_HID_Interface =
{
.InterfaceNumber = 0,
@@ -45,6 +55,9 @@ USB_ClassInfo_HID_t Generic_HID_Interface = .UsingReportProtocol = true,
};
+/** 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();
@@ -58,6 +71,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,16 +92,19 @@ void SetupHardware(void) TIMSK0 = (1 << OCIE0A);
}
+/** 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);
@@ -96,17 +113,26 @@ 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_HID_ProcessControlPacket(&Generic_HID_Interface);
}
+/** ISR to keep track of each millisecond interrupt, for determining the HID class idle period remaining when set. */
ISR(TIMER0_COMPA_vect, ISR_BLOCK)
{
if (Generic_HID_Interface.IdleMSRemaining)
Generic_HID_Interface.IdleMSRemaining--;
}
+/** HID class driver callback function for the creation of HID reports to the host.
+ *
+ * \param HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced
+ * \param ReportData Pointer to a buffer where the created report should be stored
+ *
+ * \return Number of bytes written in the report (or zero if no report is to be sent
+ */
uint16_t CALLBACK_USB_HID_CreateNextHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, void* ReportData)
{
// Create generic HID report here
@@ -114,6 +140,12 @@ uint16_t CALLBACK_USB_HID_CreateNextHIDReport(USB_ClassInfo_HID_t* HIDInterfaceI return 0;
}
+/** HID class driver callback function for the processing of HID reports from the host.
+ *
+ * \param HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced
+ * \param ReportData Pointer to a buffer where the created report has been stored
+ * \param ReportSize Size in bytes of the received HID report
+ */
void CALLBACK_USB_HID_ProcessReceivedHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, void* ReportData, uint16_t ReportSize)
{
// Process received generic HID report here
diff --git a/Demos/Device/GenericHID/GenericHID.h b/Demos/Device/GenericHID/GenericHID.h index 94a09af93..b68dc4c24 100644 --- a/Demos/Device/GenericHID/GenericHID.h +++ b/Demos/Device/GenericHID/GenericHID.h @@ -52,9 +52,16 @@ #include <LUFA/Drivers/USB/Class/Device/HID.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: */
|