Minor documentation page updates.

[pub/USBasp.git] / Demos / Device / KeyboardMouse / KeyboardMouse.c

diff --git a/Demos/Device/KeyboardMouse/KeyboardMouse.c b/Demos/Device/KeyboardMouse/KeyboardMouse.c
index 71a8375..e68a247 100644 (file)
--- 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\r
   this software.\r
 */\r
   arising out of or in connection with the use or performance of\r
   this software.\r
 */\r

- \r
+\r
+/** \file\r
+ *\r
+ *  Main source file for the KeyboardMouse demo. This file contains the main tasks of\r
+ *  the demo and is responsible for the initial application hardware configuration.\r
+ */\r
+\r

 #include "KeyboardMouse.h"\r
 \r
 #include "KeyboardMouse.h"\r
 \r

+/** LUFA HID Class driver interface configuration and state information. This structure is\r
+ *  passed to all HID Class driver functions, so that multiple instances of the same class\r
+ *  within a device can be differentiated from one another. This is for the keyboard HID\r
+ *  interface within the device.\r
+ */\r

 USB_ClassInfo_HID_t Keyboard_HID_Interface =\r
        {\r
                .InterfaceNumber         = 0,\r
 USB_ClassInfo_HID_t Keyboard_HID_Interface =\r
        {\r
                .InterfaceNumber         = 0,\r


@@ -46,6 +57,11 @@ USB_ClassInfo_HID_t Keyboard_HID_Interface =
                .IdleCount               = 500,\r
        };\r
        \r
                .IdleCount               = 500,\r
        };\r
        \r

+/** LUFA HID Class driver interface configuration and state information. This structure is\r
+ *  passed to all HID Class driver functions, so that multiple instances of the same class\r
+ *  within a device can be differentiated from one another. This is for the mouse HID\r
+ *  interface within the device.\r
+ */\r

 USB_ClassInfo_HID_t Mouse_HID_Interface =\r
        {\r
                .InterfaceNumber         = 0,\r
 USB_ClassInfo_HID_t Mouse_HID_Interface =\r
        {\r
                .InterfaceNumber         = 0,\r


@@ -58,7 +74,10 @@ USB_ClassInfo_HID_t Mouse_HID_Interface =
                .ReportOUTEndpointNumber = 0,\r
                .ReportOUTEndpointSize   = 0,\r
        };\r
                .ReportOUTEndpointNumber = 0,\r
                .ReportOUTEndpointSize   = 0,\r
        };\r

-       \r
+\r
+/** Main program entry point. This routine contains the overall program flow, including initial\r
+ *  setup of all components and the main program loop.\r
+ */\r

 int main(void)\r
 {\r
        SetupHardware();\r
 int main(void)\r
 {\r
        SetupHardware();\r


@@ -73,6 +92,7 @@ int main(void)
        }\r
 }\r
 \r
        }\r
 }\r
 \r

+/** Configures the board hardware and chip peripherals for the demo's functionality. */\r

 void SetupHardware()\r
 {\r
        /* Disable watchdog if enabled by bootloader/fuses */\r
 void SetupHardware()\r
 {\r
        /* Disable watchdog if enabled by bootloader/fuses */\r


@@ -94,16 +114,19 @@ void SetupHardware()
        TIMSK0 = (1 << OCIE0A);\r
 }\r
 \r
        TIMSK0 = (1 << OCIE0A);\r
 }\r
 \r

+/** Event handler for the library USB Connection event. */\r

 void EVENT_USB_Connect(void)\r
 {\r
 void EVENT_USB_Connect(void)\r
 {\r

-       LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);\r
+    LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);\r

 }\r
 \r
 }\r
 \r

+/** Event handler for the library USB Disconnection event. */\r

 void EVENT_USB_Disconnect(void)\r
 {\r
 void EVENT_USB_Disconnect(void)\r
 {\r

-       LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\r
+    LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\r

 }\r
 \r
 }\r
 \r

+/** Event handler for the library USB Configuration Changed event. */\r

 void EVENT_USB_ConfigurationChanged(void)\r
 {\r
        LEDs_SetAllLEDs(LEDMASK_USB_READY);\r
 void EVENT_USB_ConfigurationChanged(void)\r
 {\r
        LEDs_SetAllLEDs(LEDMASK_USB_READY);\r


@@ -115,12 +138,14 @@ void EVENT_USB_ConfigurationChanged(void)
          LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
 }\r
 \r
          LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
 }\r
 \r

+/** Event handler for the library USB Unhandled Control Packet event. */\r

 void EVENT_USB_UnhandledControlPacket(void)\r
 {\r
        USB_HID_ProcessControlPacket(&Keyboard_HID_Interface);\r
        USB_HID_ProcessControlPacket(&Mouse_HID_Interface);\r
 }\r
 \r
 void EVENT_USB_UnhandledControlPacket(void)\r
 {\r
        USB_HID_ProcessControlPacket(&Keyboard_HID_Interface);\r
        USB_HID_ProcessControlPacket(&Mouse_HID_Interface);\r
 }\r
 \r

+/** ISR to keep track of each millisecond interrupt, for determining the HID class idle period remaining when set. */\r

 ISR(TIMER0_COMPA_vect, ISR_BLOCK)\r
 {\r
        if (Keyboard_HID_Interface.IdleMSRemaining)\r
 ISR(TIMER0_COMPA_vect, ISR_BLOCK)\r
 {\r
        if (Keyboard_HID_Interface.IdleMSRemaining)\r


@@ -130,6 +155,13 @@ ISR(TIMER0_COMPA_vect, ISR_BLOCK)
          Mouse_HID_Interface.IdleMSRemaining--;\r
 }\r
 \r
          Mouse_HID_Interface.IdleMSRemaining--;\r
 }\r
 \r

+/** HID class driver callback function for the creation of HID reports to the host.\r
+ *\r
+ *  \param HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced\r
+ *  \param ReportData  Pointer to a buffer where the created report should be stored\r
+ *\r
+ *  \return Number of bytes written in the report (or zero if no report is to be sent\r
+ */\r

 uint16_t CALLBACK_USB_HID_CreateNextHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, void* ReportData)\r
 {\r
        uint8_t JoyStatus_LCL    = Joystick_GetStatus();\r
 uint16_t CALLBACK_USB_HID_CreateNextHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, void* ReportData)\r
 {\r
        uint8_t JoyStatus_LCL    = Joystick_GetStatus();\r


@@ -183,6 +215,12 @@ uint16_t CALLBACK_USB_HID_CreateNextHIDReport(USB_ClassInfo_HID_t* HIDInterfaceI
        }\r
 }\r
 \r
        }\r
 }\r
 \r

+/** HID class driver callback function for the processing of HID reports from the host.\r
+ *\r
+ *  \param HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced\r
+ *  \param ReportData  Pointer to a buffer where the created report has been stored\r
+ *  \param ReportSize  Size in bytes of the received HID report\r
+ */\r

 void CALLBACK_USB_HID_ProcessReceivedHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, void* ReportData, uint16_t ReportSize)\r
 {\r
        if (HIDInterfaceInfo == &Keyboard_HID_Interface)\r
 void CALLBACK_USB_HID_ProcessReceivedHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, void* ReportData, uint16_t ReportSize)\r
 {\r
        if (HIDInterfaceInfo == &Keyboard_HID_Interface)\r