Added Doxygen documentation to the Audio class driver. Added new modules for each...

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

diff --git a/Demos/Device/KeyboardMouse/KeyboardMouse.c b/Demos/Device/KeyboardMouse/KeyboardMouse.c
index 9cae69a..e68a247 100644 (file)
--- a/Demos/Device/KeyboardMouse/KeyboardMouse.c
+++ b/Demos/Device/KeyboardMouse/KeyboardMouse.c
@@ -31,32 +31,70 @@
 \r
 /** \file\r
  *\r
 \r
 /** \file\r
  *\r

- *  Main source file for the KeyboardMouse demo. This file contains the main tasks of the demo and\r
- *  is responsible for the initial application hardware configuration.\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

- \r
+\r

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

-/* Scheduler Task List */\r
-TASK_LIST\r
-{\r
-       { .Task = USB_USBTask               , .TaskStatus = TASK_STOP },\r
-       { .Task = USB_Mouse                 , .TaskStatus = TASK_RUN  },\r
-       { .Task = USB_Keyboard              , .TaskStatus = TASK_RUN  },\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
+\r
+               .ReportINEndpointNumber  = KEYBOARD_IN_EPNUM,\r
+               .ReportINEndpointSize    = HID_EPSIZE,\r
+\r
+               .ReportOUTEndpointNumber = KEYBOARD_OUT_EPNUM,\r
+               .ReportOUTEndpointSize   = HID_EPSIZE,\r
+               \r
+               .ReportINBufferSize      = sizeof(USB_KeyboardReport_Data_t),\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
+\r
+               .ReportINEndpointNumber  = MOUSE_IN_EPNUM,\r
+               .ReportINEndpointSize    = HID_EPSIZE,\r

 \r
 \r

-/* Global Variables */\r
-/** Global structure to hold the current keyboard interface HID report, for transmission to the host */\r
-USB_KeyboardReport_Data_t KeyboardReportData;\r
+               .ReportINBufferSize      = sizeof(USB_MouseReport_Data_t),\r

 \r
 \r

-/** Global structure to hold the current mouse interface HID report, for transmission to the host */\r
-USB_MouseReport_Data_t    MouseReportData;\r
+               .ReportOUTEndpointNumber = 0,\r
+               .ReportOUTEndpointSize   = 0,\r
+       };\r

 \r
 \r

-/** Main program entry point. This routine configures the hardware required by the application, then\r
- *  starts the scheduler to run the USB management task.\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
  */\r
 int main(void)\r
 {\r

+       SetupHardware();\r
+\r
+       LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\r
+\r
+       for (;;)\r
+       {\r
+               USB_HID_USBTask(&Keyboard_HID_Interface);\r
+               USB_HID_USBTask(&Mouse_HID_Interface);\r
+               USB_USBTask();\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
        MCUSR &= ~(1 << WDRF);\r
        wdt_disable();\r
        /* Disable watchdog if enabled by bootloader/fuses */\r
        MCUSR &= ~(1 << WDRF);\r
        wdt_disable();\r


@@ -67,295 +105,138 @@ int main(void)
        /* Hardware Initialization */\r
        Joystick_Init();\r
        LEDs_Init();\r
        /* Hardware Initialization */\r
        Joystick_Init();\r
        LEDs_Init();\r

-       \r
-       /* Indicate USB not ready */\r
-       UpdateStatus(Status_USBNotReady);\r
-       \r
-       /* Initialize Scheduler so that it can be used */\r
-       Scheduler_Init();\r
-\r
-       /* Initialize USB Subsystem */\r

        USB_Init();\r
        USB_Init();\r

-       \r
-       /* Scheduling - routine never returns, so put this last in the main function */\r
-       Scheduler_Start();\r
+\r
+       /* Millisecond timer initialization, with output compare interrupt enabled for the idle timing */\r
+       OCR0A  = ((F_CPU / 64) / 1000);\r
+       TCCR0A = (1 << WGM01);\r
+       TCCR0B = ((1 << CS01) | (1 << CS00));\r
+       TIMSK0 = (1 << OCIE0A);\r

 }\r
 \r
 }\r
 \r

-/** Event handler for the USB_Connect event. This indicates that the device is enumerating via the status LEDs and\r
- *  starts the library USB task to begin the enumeration and USB management process.\r
- */\r
-EVENT_HANDLER(USB_Connect)\r
+/** Event handler for the library USB Connection event. */\r
+void EVENT_USB_Connect(void)\r

 {\r
 {\r

-       /* Start USB management task */\r
-       Scheduler_SetTaskMode(USB_USBTask, TASK_RUN);\r
+    LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);\r
+}\r

 \r
 \r

-       /* Indicate USB enumerating */\r
-       UpdateStatus(Status_USBEnumerating);\r
+/** Event handler for the library USB Disconnection event. */\r
+void EVENT_USB_Disconnect(void)\r
+{\r
+    LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\r

 }\r
 \r
 }\r
 \r

-/** Event handler for the USB_Disconnect event. This indicates that the device is no longer connected to a host via\r
- *  the status LEDs and stops the USB management task.\r
- */\r
-EVENT_HANDLER(USB_Disconnect)\r
+/** Event handler for the library USB Configuration Changed event. */\r
+void EVENT_USB_ConfigurationChanged(void)\r

 {\r
 {\r

-       /* Stop running HID reporting and USB management tasks */\r
-       Scheduler_SetTaskMode(USB_USBTask, TASK_STOP);\r
+       LEDs_SetAllLEDs(LEDMASK_USB_READY);\r

 \r
 \r

-       /* Indicate USB not ready */\r
-       UpdateStatus(Status_USBNotReady);\r
+       if (!(USB_HID_ConfigureEndpoints(&Keyboard_HID_Interface)))\r
+         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
+       \r
+       if (!(USB_HID_ConfigureEndpoints(&Mouse_HID_Interface)))\r
+         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r

 }\r
 \r
 }\r
 \r

-/** Event handler for the USB_ConfigurationChanged event. This is fired when the host sets the current configuration\r
- *  of the USB device after enumeration, and configures the keyboard and mouse device endpoints.\r
- */\r
-EVENT_HANDLER(USB_ConfigurationChanged)\r
+/** Event handler for the library USB Unhandled Control Packet event. */\r
+void EVENT_USB_UnhandledControlPacket(void)\r

 {\r
 {\r

-       /* Setup Keyboard Report Endpoint */\r
-       Endpoint_ConfigureEndpoint(KEYBOARD_IN_EPNUM, EP_TYPE_INTERRUPT,\r
-                                      ENDPOINT_DIR_IN, HID_EPSIZE,\r
-                                  ENDPOINT_BANK_SINGLE);\r
-\r
-       /* Setup Keyboard LED Report Endpoint */\r
-       Endpoint_ConfigureEndpoint(KEYBOARD_OUT_EPNUM, EP_TYPE_INTERRUPT,\r
-                                      ENDPOINT_DIR_OUT, HID_EPSIZE,\r
-                                  ENDPOINT_BANK_SINGLE);\r
-\r
-       /* Setup Mouse Report Endpoint */\r
-       Endpoint_ConfigureEndpoint(MOUSE_IN_EPNUM, EP_TYPE_INTERRUPT,\r
-                                      ENDPOINT_DIR_IN, HID_EPSIZE,\r
-                                  ENDPOINT_BANK_SINGLE);\r
-\r
-       /* Indicate USB connected and ready */\r
-       UpdateStatus(Status_USBReady);\r
+       USB_HID_ProcessControlPacket(&Keyboard_HID_Interface);\r
+       USB_HID_ProcessControlPacket(&Mouse_HID_Interface);\r

 }\r
 \r
 }\r
 \r

-/** Event handler for the USB_UnhandledControlPacket event. This is used to catch standard and class specific\r
- *  control requests that are not handled internally by the USB library (including the HID commands, which are\r
- *  all issued via the control endpoint), so that they can be handled appropriately for the application.\r
- */\r
-EVENT_HANDLER(USB_UnhandledControlPacket)\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
 {\r

-       uint8_t* ReportData;\r
-       uint8_t  ReportSize;\r
+       if (Keyboard_HID_Interface.IdleMSRemaining)\r
+         Keyboard_HID_Interface.IdleMSRemaining--;\r

 \r
 \r

-       /* Handle HID Class specific requests */\r
-       switch (bRequest)\r
-       {\r
-               case REQ_GetReport:\r
-                       if (bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))\r
-                       {\r
-                               Endpoint_Discard_Word();\r
-                       \r
-                               uint16_t wIndex = Endpoint_Read_Word_LE();\r
-                               \r
-                               /* Determine if it is the mouse or the keyboard data that is being requested */\r
-                               if (!(wIndex))\r
-                               {\r
-                                       ReportData = (uint8_t*)&KeyboardReportData;\r
-                                       ReportSize = sizeof(KeyboardReportData);\r
-                               }\r
-                               else\r
-                               {\r
-                                       ReportData = (uint8_t*)&MouseReportData;\r
-                                       ReportSize = sizeof(MouseReportData);\r
-                               }\r
-\r
-                               /* Read in the number of bytes in the report to send to the host */\r
-                               uint16_t wLength = Endpoint_Read_Word_LE();\r
-                               \r
-                               /* If trying to send more bytes than exist to the host, clamp the value at the report size */\r
-                               if (wLength > ReportSize)\r
-                                 wLength = ReportSize;\r
-\r
-                               Endpoint_ClearSETUP();\r
-       \r
-                               /* Write the report data to the control endpoint */\r
-                               Endpoint_Write_Control_Stream_LE(ReportData, wLength);\r
-\r
-                               /* Clear the report data afterwards */\r
-                               memset(ReportData, 0, ReportSize);\r
-                               \r
-                               /* Finalize the stream transfer to send the last packet or clear the host abort */\r
-                               Endpoint_ClearOUT();\r
-                       }\r
-               \r
-                       break;\r
-               case REQ_SetReport:\r
-                       if (bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))\r
-                       {\r
-                               Endpoint_ClearSETUP();\r
-                               \r
-                               /* Wait until the LED report has been sent by the host */\r
-                               while (!(Endpoint_IsOUTReceived()));\r
-\r
-                               /* Read in the LED report from the host */\r
-                               uint8_t LEDStatus = Endpoint_Read_Byte();\r
-                               uint8_t LEDMask   = LEDS_LED2;\r
-                               \r
-                               if (LEDStatus & 0x01) // NUM Lock\r
-                                 LEDMask |= LEDS_LED1;\r
-                               \r
-                               if (LEDStatus & 0x02) // CAPS Lock\r
-                                 LEDMask |= LEDS_LED3;\r
-\r
-                               if (LEDStatus & 0x04) // SCROLL Lock\r
-                                 LEDMask |= LEDS_LED4;\r
-\r
-                               /* Set the status LEDs to the current HID LED status */\r
-                               LEDs_SetAllLEDs(LEDMask);\r
-\r
-                               /* Clear the endpoint data */\r
-                               Endpoint_ClearOUT();\r
-\r
-                               /* Acknowledge status stage */\r
-                               while (!(Endpoint_IsINReady()));\r
-                               Endpoint_ClearIN();\r
-                       }\r
-                       \r
-                       break;\r
-       }\r
+       if (Mouse_HID_Interface.IdleMSRemaining)\r
+         Mouse_HID_Interface.IdleMSRemaining--;\r

 }\r
 \r
 }\r
 \r

-/** Function to manage status updates to the user. This is done via LEDs on the given board, if available, but may be changed to\r
- *  log to a serial port, or anything else that is suitable for status updates.\r
+/** HID class driver callback function for the creation of HID reports to the host.\r

  *\r
  *\r

- *  \param CurrentStatus  Current status of the system, from the KeyboardMouse_StatusCodes_t enum\r
- */\r
-void UpdateStatus(uint8_t CurrentStatus)\r
-{\r
-       uint8_t LEDMask = LEDS_NO_LEDS;\r
-       \r
-       /* Set the LED mask to the appropriate LED mask based on the given status code */\r
-       switch (CurrentStatus)\r
-       {\r
-               case Status_USBNotReady:\r
-                       LEDMask = (LEDS_LED1);\r
-                       break;\r
-               case Status_USBEnumerating:\r
-                       LEDMask = (LEDS_LED1 | LEDS_LED2);\r
-                       break;\r
-               case Status_USBReady:\r
-                       LEDMask = (LEDS_LED2 | LEDS_LED4);\r
-                       break;\r
-       }\r
-       \r
-       /* Set the board LEDs to the new LED mask */\r
-       LEDs_SetAllLEDs(LEDMask);\r
-}\r
-\r
-/** Keyboard task. This generates the next keyboard HID report for the host, and transmits it via the\r
- *  keyboard IN endpoint when the host is ready for more data. Additionally, it processes host LED status\r
- *  reports sent to the device via the keyboard OUT reporting endpoint.\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
  */\r

-TASK(USB_Keyboard)\r
+uint16_t CALLBACK_USB_HID_CreateNextHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, void* ReportData)\r

 {\r
 {\r

-       uint8_t JoyStatus_LCL = Joystick_GetStatus();\r
+       uint8_t JoyStatus_LCL    = Joystick_GetStatus();\r
+       uint8_t ButtonStatus_LCL = Buttons_GetStatus();\r

 \r
 \r

-       /* Check if HWB is not pressed, if so mouse mode enabled */\r
-       if (!(HWB_GetStatus()))\r
+       if (HIDInterfaceInfo == &Keyboard_HID_Interface)\r

        {\r
        {\r

+               USB_KeyboardReport_Data_t* KeyboardReport = (USB_KeyboardReport_Data_t*)ReportData;\r
+               \r
+               /* If first board button not being held down, no keyboard report */\r
+               if (!(ButtonStatus_LCL & BUTTONS_BUTTON1))\r
+                 return 0;\r
+               \r

                if (JoyStatus_LCL & JOY_UP)\r
                if (JoyStatus_LCL & JOY_UP)\r

-                 KeyboardReportData.KeyCode[0] = 0x04; // A\r
+                 KeyboardReport->KeyCode[0] = 0x04; // A\r

                else if (JoyStatus_LCL & JOY_DOWN)\r
                else if (JoyStatus_LCL & JOY_DOWN)\r

-                 KeyboardReportData.KeyCode[0] = 0x05; // B\r
+                 KeyboardReport->KeyCode[0] = 0x05; // B\r

 \r
                if (JoyStatus_LCL & JOY_LEFT)\r
 \r
                if (JoyStatus_LCL & JOY_LEFT)\r

-                 KeyboardReportData.KeyCode[0] = 0x06; // C\r
+                 KeyboardReport->KeyCode[0] = 0x06; // C\r

                else if (JoyStatus_LCL & JOY_RIGHT)\r
                else if (JoyStatus_LCL & JOY_RIGHT)\r

-                 KeyboardReportData.KeyCode[0] = 0x07; // D\r
+                 KeyboardReport->KeyCode[0] = 0x07; // D\r

 \r
                if (JoyStatus_LCL & JOY_PRESS)\r
 \r
                if (JoyStatus_LCL & JOY_PRESS)\r

-                 KeyboardReportData.KeyCode[0] = 0x08; // E\r
+                 KeyboardReport->KeyCode[0] = 0x08; // E\r
+                 \r
+               return sizeof(USB_KeyboardReport_Data_t);\r

        }\r
        }\r

-       \r
-       /* Check if the USB system is connected to a host and report protocol mode is enabled */\r
-       if (USB_IsConnected)\r
+       else\r

        {\r
        {\r

-               /* Select the Keyboard Report Endpoint */\r
-               Endpoint_SelectEndpoint(KEYBOARD_IN_EPNUM);\r
-\r
-               /* Check if Keyboard Endpoint Ready for Read/Write */\r
-               if (Endpoint_IsReadWriteAllowed())\r
-               {\r
-                       /* Write Keyboard Report Data */\r
-                       Endpoint_Write_Stream_LE(&KeyboardReportData, sizeof(KeyboardReportData));\r
-\r
-                       /* Finalize the stream transfer to send the last packet */\r
-                       Endpoint_ClearIN();\r
-\r
-                       /* Clear the report data afterwards */\r
-                       memset(&KeyboardReportData, 0, sizeof(KeyboardReportData));\r
-               }\r
-\r
-               /* Select the Keyboard LED Report Endpoint */\r
-               Endpoint_SelectEndpoint(KEYBOARD_OUT_EPNUM);\r
-\r
-               /* Check if Keyboard LED Endpoint Ready for Read/Write */\r
-               if (Endpoint_IsReadWriteAllowed())\r
-               {               \r
-                       /* Read in the LED report from the host */\r
-                       uint8_t LEDStatus = Endpoint_Read_Byte();\r
-                       uint8_t LEDMask   = LEDS_LED2;\r
-                       \r
-                       if (LEDStatus & 0x01) // NUM Lock\r
-                         LEDMask |= LEDS_LED1;\r
-                       \r
-                       if (LEDStatus & 0x02) // CAPS Lock\r
-                         LEDMask |= LEDS_LED3;\r
-\r
-                       if (LEDStatus & 0x04) // SCROLL Lock\r
-                         LEDMask |= LEDS_LED4;\r
-\r
-                       /* Set the status LEDs to the current Keyboard LED status */\r
-                       LEDs_SetAllLEDs(LEDMask);\r
-\r
-                       /* Handshake the OUT Endpoint - clear endpoint and ready for next report */\r
-                       Endpoint_ClearOUT();\r
-               }\r
-       }\r
-}\r
-\r
-/** Mouse task. This generates the next mouse HID report for the host, and transmits it via the\r
- *  mouse IN endpoint when the host is ready for more data.\r
- */\r
-TASK(USB_Mouse)\r
-{\r
-       uint8_t JoyStatus_LCL = Joystick_GetStatus();\r
+               USB_MouseReport_Data_t* MouseReport = (USB_MouseReport_Data_t*)ReportData;\r

 \r
 \r

-       /* Check if HWB is pressed, if so mouse mode enabled */\r
-       if (HWB_GetStatus())\r
-       {\r
+               /* If first board button being held down, no mouse report */\r
+               if (ButtonStatus_LCL & BUTTONS_BUTTON1)\r
+                 return 0;\r
+                 \r

                if (JoyStatus_LCL & JOY_UP)\r
                if (JoyStatus_LCL & JOY_UP)\r

-                 MouseReportData.Y =  1;\r
+                 MouseReport->Y = -1;\r

                else if (JoyStatus_LCL & JOY_DOWN)\r
                else if (JoyStatus_LCL & JOY_DOWN)\r

-                 MouseReportData.Y = -1;\r
+                 MouseReport->Y =  1;\r

 \r
                if (JoyStatus_LCL & JOY_RIGHT)\r
 \r
                if (JoyStatus_LCL & JOY_RIGHT)\r

-                 MouseReportData.X =  1;\r
+                 MouseReport->X =  1;\r

                else if (JoyStatus_LCL & JOY_LEFT)\r
                else if (JoyStatus_LCL & JOY_LEFT)\r

-                 MouseReportData.X = -1;\r
+                 MouseReport->X = -1;\r

 \r
                if (JoyStatus_LCL & JOY_PRESS)\r
 \r
                if (JoyStatus_LCL & JOY_PRESS)\r

-                 MouseReportData.Button  = (1 << 0);\r
+                 MouseReport->Button  = (1 << 0);\r
+               \r
+               return sizeof(USB_MouseReport_Data_t);          \r

        }\r
        }\r

+}\r

 \r
 \r

-       /* Check if the USB system is connected to a host and report protocol mode is enabled */\r
-       if (USB_IsConnected)\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

        {\r
        {\r

-               /* Select the Mouse Report Endpoint */\r
-               Endpoint_SelectEndpoint(MOUSE_IN_EPNUM);\r
+               uint8_t  LEDMask   = LEDS_NO_LEDS;\r
+               uint8_t* LEDReport = (uint8_t*)ReportData;\r

 \r
 \r

-               /* Check if Mouse Endpoint Ready for Read/Write */\r
-               if (Endpoint_IsReadWriteAllowed())\r
-               {\r
-                       /* Write Mouse Report Data */\r
-                       Endpoint_Write_Stream_LE(&MouseReportData, sizeof(MouseReportData));\r
-\r
-                       /* Finalize the stream transfer to send the last packet */\r
-                       Endpoint_ClearIN();\r
+               if (*LEDReport & 0x01) // NUM Lock\r
+                 LEDMask |= LEDS_LED1;\r
+               \r
+               if (*LEDReport & 0x02) // CAPS Lock\r
+                 LEDMask |= LEDS_LED3;\r

 \r
 \r

-                       /* Clear the report data afterwards */\r
-                       memset(&MouseReportData, 0, sizeof(MouseReportData));\r
-               }\r
+               if (*LEDReport & 0x04) // SCROLL Lock\r
+                 LEDMask |= LEDS_LED4;\r
+                 \r
+               LEDs_SetAllLEDs(LEDMask);\r

        }\r
        }\r

-}\r
+}
\ No newline at end of file