Fix Doxygen errors in demos.

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

diff --git a/Demos/Device/GenericHID/GenericHID.c b/Demos/Device/GenericHID/GenericHID.c
index d4e7cca..b933e45 100644 (file)
--- a/Demos/Device/GenericHID/GenericHID.c
+++ b/Demos/Device/GenericHID/GenericHID.c
@@ -30,31 +30,50 @@
 \r
 /** \file\r
  *\r
 \r
 /** \file\r
  *\r

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

  */\r
 \r
 #include "GenericHID.h"\r
 \r
  */\r
 \r
 #include "GenericHID.h"\r
 \r

-/* Scheduler Task List */\r
-TASK_LIST\r
-{\r
-       #if !defined(INTERRUPT_CONTROL_ENDPOINT)\r
-       { .Task = USB_USBTask          , .TaskStatus = TASK_STOP },\r
-       #endif\r
-       \r
-       { .Task = USB_HID_Report       , .TaskStatus = TASK_STOP },\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.\r
+ */\r
+USB_ClassInfo_HID_t Generic_HID_Interface =\r
+       {\r
+               .InterfaceNumber         = 0,\r

 \r
 \r

-/** Static buffer to hold the last received report from the host, so that it can be echoed back in the next sent report */\r
-static uint8_t LastReceived[GENERIC_REPORT_SIZE];\r
+               .ReportINEndpointNumber  = GENERIC_IN_EPNUM,\r
+               .ReportINEndpointSize    = GENERIC_EPSIZE,\r
+               \r
+               .ReportOUTEndpointNumber = GENERIC_OUT_EPNUM,\r
+               .ReportOUTEndpointSize   = GENERIC_EPSIZE,\r
+               \r
+               .ReportINBufferSize      = GENERIC_REPORT_SIZE,\r

 \r
 \r

+               .UsingReportProtocol     = true,\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(&Generic_HID_Interface);\r
+               USB_USBTask();\r
+       }\r
+}\r
+\r
+/** Configures the board hardware and chip peripherals for the demo's functionality. */\r
+void SetupHardware(void)\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


@@ -62,268 +81,72 @@ int main(void)
        /* Disable clock division */\r
        clock_prescale_set(clock_div_1);\r
 \r
        /* Disable clock division */\r
        clock_prescale_set(clock_div_1);\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
+       /* Hardware Initialization */\r
+       LEDs_Init();\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

 \r
 \r

-/** Event handler for the USB_Reset event. This fires when the USB interface is reset by the USB host, before the\r
- *  enumeration process begins, and enables the control endpoint interrupt so that control requests can be handled\r
- *  asynchronously when they arrive rather than when the control endpoint is polled manually.\r
- */\r
-EVENT_HANDLER(USB_Reset)\r
-{\r
-       #if defined(INTERRUPT_CONTROL_ENDPOINT)\r
-       /* Select the control endpoint */\r
-       Endpoint_SelectEndpoint(ENDPOINT_CONTROLEP);\r
-\r
-       /* Enable the endpoint SETUP interrupt ISR for the control endpoint */\r
-       USB_INT_Enable(ENDPOINT_INT_SETUP);\r
-       #endif\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

-       #if !defined(INTERRUPT_CONTROL_ENDPOINT)\r
-       /* Start USB management task */\r
-       Scheduler_SetTaskMode(USB_USBTask, TASK_RUN);\r
-       #endif\r
-\r
-       /* Indicate USB enumerating */\r
-       UpdateStatus(Status_USBEnumerating);\r
+       LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);\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 Disconnection event. */\r
+void EVENT_USB_Disconnect(void)\r

 {\r
 {\r

-       /* Stop running HID reporting and USB management tasks */\r
-       Scheduler_SetTaskMode(USB_HID_Report, TASK_STOP);\r
-\r
-       #if !defined(INTERRUPT_CONTROL_ENDPOINT)\r
-       Scheduler_SetTaskMode(USB_USBTask, TASK_STOP);\r
-       #endif\r
-\r
-       /* Indicate USB not ready */\r
-       UpdateStatus(Status_USBNotReady);\r
+       LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\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 generic HID device endpoints.\r
- */\r
-EVENT_HANDLER(USB_ConfigurationChanged)\r
+/** Event handler for the library USB Configuration Changed event. */\r
+void EVENT_USB_ConfigurationChanged(void)\r

 {\r
 {\r

-       /* Setup Generic IN Report Endpoint */\r
-       Endpoint_ConfigureEndpoint(GENERIC_IN_EPNUM, EP_TYPE_INTERRUPT,\r
-                                      ENDPOINT_DIR_IN, GENERIC_EPSIZE,\r
-                                  ENDPOINT_BANK_SINGLE);\r
+       LEDs_SetAllLEDs(LEDMASK_USB_READY);\r

 \r
 \r

-       /* Setup Generic OUT Report Endpoint */\r
-       Endpoint_ConfigureEndpoint(GENERIC_OUT_EPNUM, EP_TYPE_INTERRUPT,\r
-                                      ENDPOINT_DIR_OUT, GENERIC_EPSIZE,\r
-                                  ENDPOINT_BANK_SINGLE);\r
-\r
-       /* Indicate USB connected and ready */\r
-       UpdateStatus(Status_USBReady);\r
+       if (!(USB_HID_ConfigureEndpoints(&Generic_HID_Interface)))\r
+         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\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
+/** Event handler for the library USB Unhandled Control Packet event. */\r
+void EVENT_USB_UnhandledControlPacket(void)\r

 {\r
 {\r

-       /* Handle HID Class specific requests */\r
-       switch (USB_ControlRequest.bRequest)\r
-       {\r
-               case REQ_GetReport:\r
-                       if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))\r
-                       {\r
-                               uint8_t GenericData[GENERIC_REPORT_SIZE];\r
-\r
-                               Endpoint_ClearSETUP();\r
-       \r
-                               CreateGenericHIDReport(GenericData);\r
-\r
-                               /* Write the report data to the control endpoint */\r
-                               Endpoint_Write_Control_Stream_LE(&GenericData, sizeof(GenericData));\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 (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))\r
-                       {\r
-                               uint8_t GenericData[GENERIC_REPORT_SIZE];\r
-\r
-                               Endpoint_ClearSETUP();\r
-                               \r
-                               /* Wait until the generic report has been sent by the host */\r
-                               while (!(Endpoint_IsOUTReceived()));\r
-\r
-                               Endpoint_Read_Control_Stream_LE(&GenericData, sizeof(GenericData));\r
-\r
-                               ProcessGenericHIDReport(GenericData);\r
-                       \r
-                               /* Clear the endpoint data */\r
-                               Endpoint_ClearOUT();\r
-\r
-                               /* Wait until the host is ready to receive the request confirmation */\r
-                               while (!(Endpoint_IsINReady()));\r
-                               \r
-                               /* Handshake the request by sending an empty IN packet */\r
-                               Endpoint_ClearIN();\r
-                       }\r
-                       \r
-                       break;\r
-       }\r
+       USB_HID_ProcessControlPacket(&Generic_HID_Interface);\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
- *\r
- *  \param CurrentStatus  Current status of the system, from the GenericHID_StatusCodes_t enum\r
- */\r
-void UpdateStatus(uint8_t CurrentStatus)\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 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
+       if (Generic_HID_Interface.IdleMSRemaining)\r
+         Generic_HID_Interface.IdleMSRemaining--;\r

 }\r
 \r
 }\r
 \r

-/** Function to process the lest received report from the host.\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
  *\r

- *  \param DataArray  Pointer to a buffer where the last report data is stored\r
+ *  \return Number of bytes written in the report (or zero if no report is to be sent\r

  */\r
  */\r

-void ProcessGenericHIDReport(uint8_t* DataArray)\r
+uint16_t CALLBACK_USB_HID_CreateNextHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, void* ReportData)\r

 {\r
 {\r

-       /*\r
-               This is where you need to process the reports being sent from the host to the device.\r
-               DataArray is an array holding the last report from the host. This function is called\r
-               each time the host has sent a report to the device.\r
-       */\r
+       // Create generic HID report here\r

        \r
        \r

-       for (uint8_t i = 0; i < GENERIC_REPORT_SIZE; i++)\r
-         LastReceived[i] = DataArray[i];\r
+       return 0;\r

 }\r
 \r
 }\r
 \r

-/** Function to create the next report to send back to the host at the next reporting interval.\r
+/** HID class driver callback function for the processing of HID reports from the host.\r

  *\r
  *\r

- *  \param DataArray  Pointer to a buffer where the next report data should be stored\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
  */\r

-void CreateGenericHIDReport(uint8_t* DataArray)\r
+void CALLBACK_USB_HID_ProcessReceivedHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, void* ReportData, uint16_t ReportSize)\r

 {\r
 {\r

-       /*\r
-               This is where you need to create reports to be sent to the host from the device. This\r
-               function is called each time the host is ready to accept a new report. DataArray is \r
-               an array to hold the report to the host.\r
-       */\r
-\r
-       for (uint8_t i = 0; i < GENERIC_REPORT_SIZE; i++)\r
-         DataArray[i] = LastReceived[i];\r
-}\r
-\r
-TASK(USB_HID_Report)\r
-{\r
-       /* Check if the USB system is connected to a host */\r
-       if (USB_IsConnected)\r
-       {\r
-               Endpoint_SelectEndpoint(GENERIC_OUT_EPNUM);\r
-               \r
-               /* Check to see if a packet has been sent from the host */\r
-               if (Endpoint_IsOUTReceived())\r
-               {\r
-                       /* Check to see if the packet contains data */\r
-                       if (Endpoint_IsReadWriteAllowed())\r
-                       {\r
-                               /* Create a temporary buffer to hold the read in report from the host */\r
-                               uint8_t GenericData[GENERIC_REPORT_SIZE];\r
-                               \r
-                               /* Read Generic Report Data */\r
-                               Endpoint_Read_Stream_LE(&GenericData, sizeof(GenericData));\r
-                               \r
-                               /* Process Generic Report Data */\r
-                               ProcessGenericHIDReport(GenericData);\r
-                       }\r
-\r
-                       /* Finalize the stream transfer to send the last packet */\r
-                       Endpoint_ClearOUT();\r
-               }       \r
-\r
-               Endpoint_SelectEndpoint(GENERIC_IN_EPNUM);\r
-               \r
-               /* Check to see if the host is ready to accept another packet */\r
-               if (Endpoint_IsINReady())\r
-               {\r
-                       /* Create a temporary buffer to hold the report to send to the host */\r
-                       uint8_t GenericData[GENERIC_REPORT_SIZE];\r
-                       \r
-                       /* Create Generic Report Data */\r
-                       CreateGenericHIDReport(GenericData);\r
-\r
-                       /* Write Generic Report Data */\r
-                       Endpoint_Write_Stream_LE(&GenericData, sizeof(GenericData));\r
-\r
-                       /* Finalize the stream transfer to send the last packet */\r
-                       Endpoint_ClearIN();\r
-               }\r
-       }\r
-}\r
-\r
-#if defined(INTERRUPT_CONTROL_ENDPOINT)\r
-/** ISR for the general Pipe/Endpoint interrupt vector. This ISR fires when an endpoint's status changes (such as\r
- *  a packet has been received) on an endpoint with its corresponding ISR enabling bits set. This is used to send\r
- *  HID packets to the host each time the HID interrupt endpoints polling period elapses, as managed by the USB\r
- *  controller.\r
- */\r
-ISR(ENDPOINT_PIPE_vect, ISR_BLOCK)\r
-{\r
-       /* Save previously selected endpoint before selecting a new endpoint */\r
-       uint8_t PrevSelectedEndpoint = Endpoint_GetCurrentEndpoint();\r
-\r
-       /* Check if the control endpoint has received a request */\r
-       if (Endpoint_HasEndpointInterrupted(ENDPOINT_CONTROLEP))\r
-       {\r
-               /* Clear the endpoint interrupt */\r
-               Endpoint_ClearEndpointInterrupt(ENDPOINT_CONTROLEP);\r
-\r
-               /* Process the control request */\r
-               USB_USBTask();\r
-\r
-               /* Handshake the endpoint setup interrupt - must be after the call to USB_USBTask() */\r
-               USB_INT_Clear(ENDPOINT_INT_SETUP);\r
-       }\r
-\r
-       /* Restore previously selected endpoint */\r
-       Endpoint_SelectEndpoint(PrevSelectedEndpoint);\r
+       // Process received generic HID report here\r

 }\r
 }\r

-#endif\r