From a67bd74e3e8aad87dcee8cf0c0eaaccbe7d00552 Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Thu, 4 Jun 2009 02:55:30 +0000 Subject: 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. --- Demos/Device/KeyboardMouse/KeyboardMouse.c | 46 +++++++++++++++++++++++++++--- Demos/Device/KeyboardMouse/KeyboardMouse.h | 7 +++++ 2 files changed, 49 insertions(+), 4 deletions(-) (limited to 'Demos/Device/KeyboardMouse') diff --git a/Demos/Device/KeyboardMouse/KeyboardMouse.c b/Demos/Device/KeyboardMouse/KeyboardMouse.c index 71a8375aa..e68a24793 100644 --- a/Demos/Device/KeyboardMouse/KeyboardMouse.c +++ b/Demos/Device/KeyboardMouse/KeyboardMouse.c @@ -28,9 +28,20 @@ arising out of or in connection with the use or performance of this software. */ - + +/** \file + * + * Main source file for the KeyboardMouse demo. This file contains the main tasks of + * the demo and is responsible for the initial application hardware configuration. + */ + #include "KeyboardMouse.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. This is for the keyboard HID + * interface within the device. + */ USB_ClassInfo_HID_t Keyboard_HID_Interface = { .InterfaceNumber = 0, @@ -46,6 +57,11 @@ USB_ClassInfo_HID_t Keyboard_HID_Interface = .IdleCount = 500, }; +/** 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. This is for the mouse HID + * interface within the device. + */ USB_ClassInfo_HID_t Mouse_HID_Interface = { .InterfaceNumber = 0, @@ -58,7 +74,10 @@ USB_ClassInfo_HID_t Mouse_HID_Interface = .ReportOUTEndpointNumber = 0, .ReportOUTEndpointSize = 0, }; - + +/** 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(); @@ -73,6 +92,7 @@ int main(void) } } +/** Configures the board hardware and chip peripherals for the demo's functionality. */ void SetupHardware() { /* Disable watchdog if enabled by bootloader/fuses */ @@ -94,16 +114,19 @@ void SetupHardware() TIMSK0 = (1 << OCIE0A); } +/** Event handler for the library USB Connection event. */ void EVENT_USB_Connect(void) { - LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING); + LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING); } +/** Event handler for the library USB Disconnection event. */ void EVENT_USB_Disconnect(void) { - LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY); + LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY); } +/** Event handler for the library USB Configuration Changed event. */ void EVENT_USB_ConfigurationChanged(void) { LEDs_SetAllLEDs(LEDMASK_USB_READY); @@ -115,12 +138,14 @@ 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(&Keyboard_HID_Interface); USB_HID_ProcessControlPacket(&Mouse_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 (Keyboard_HID_Interface.IdleMSRemaining) @@ -130,6 +155,13 @@ ISR(TIMER0_COMPA_vect, ISR_BLOCK) Mouse_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) { uint8_t JoyStatus_LCL = Joystick_GetStatus(); @@ -183,6 +215,12 @@ uint16_t CALLBACK_USB_HID_CreateNextHIDReport(USB_ClassInfo_HID_t* HIDInterfaceI } } +/** 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) { if (HIDInterfaceInfo == &Keyboard_HID_Interface) diff --git a/Demos/Device/KeyboardMouse/KeyboardMouse.h b/Demos/Device/KeyboardMouse/KeyboardMouse.h index c18c6e1af..9afe7646b 100644 --- a/Demos/Device/KeyboardMouse/KeyboardMouse.h +++ b/Demos/Device/KeyboardMouse/KeyboardMouse.h @@ -49,9 +49,16 @@ #include /* 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) /* Type Defines: */ -- cgit v1.2.3