Added Doxygen documentation to the Audio class driver. Added new modules for each...
[pub/USBasp.git] / Demos / Host / GenericHIDHost / GenericHIDHost.c
index 605fc6f..e731f90 100644 (file)
  \r
 #include "GenericHIDHost.h"\r
 \r
-/* Project Tags, for reading out using the ButtLoad project */\r
-BUTTLOADTAG(ProjName,    "LUFA GenHid Host App");\r
-BUTTLOADTAG(BuildTime,   __TIME__);\r
-BUTTLOADTAG(BuildDate,   __DATE__);\r
-BUTTLOADTAG(LUFAVersion, "LUFA V" LUFA_VERSION_STRING);\r
-\r
 /* Scheduler Task List */\r
 TASK_LIST\r
 {\r
-       { Task: USB_USBTask          , TaskStatus: TASK_STOP },\r
-       { Task: USB_HID_Host         , TaskStatus: TASK_STOP },\r
+       { .Task = USB_USBTask          , .TaskStatus = TASK_STOP },\r
+       { .Task = USB_HID_Host         , .TaskStatus = TASK_STOP },\r
 };\r
 \r
 \r
@@ -86,7 +80,7 @@ int main(void)
 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and\r
  *  starts the library USB task to begin the enumeration and USB management process.\r
  */\r
-EVENT_HANDLER(USB_DeviceAttached)\r
+void EVENT_USB_DeviceAttached(void)\r
 {\r
        puts_P(PSTR("Device Attached.\r\n"));\r
        UpdateStatus(Status_USBEnumerating);\r
@@ -98,7 +92,7 @@ EVENT_HANDLER(USB_DeviceAttached)
 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and\r
  *  stops the library USB task management process.\r
  */\r
-EVENT_HANDLER(USB_DeviceUnattached)\r
+void EVENT_USB_DeviceUnattached(void)\r
 {\r
        /* Stop HID and USB management task */\r
        Scheduler_SetTaskMode(USB_USBTask, TASK_STOP);\r
@@ -111,7 +105,7 @@ EVENT_HANDLER(USB_DeviceUnattached)
 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully\r
  *  enumerated by the host and is now ready to be used by the application.\r
  */\r
-EVENT_HANDLER(USB_DeviceEnumerationComplete)\r
+void EVENT_USB_DeviceEnumerationComplete(void)\r
 {\r
        /* Start HID Host task */\r
        Scheduler_SetTaskMode(USB_HID_Host, TASK_RUN);\r
@@ -121,7 +115,7 @@ EVENT_HANDLER(USB_DeviceEnumerationComplete)
 }\r
 \r
 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */\r
-EVENT_HANDLER(USB_HostError)\r
+void EVENT_USB_HostError(const uint8_t ErrorCode)\r
 {\r
        USB_ShutDown();\r
 \r
@@ -135,7 +129,7 @@ EVENT_HANDLER(USB_HostError)
 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while\r
  *  enumerating an attached USB device.\r
  */\r
-EVENT_HANDLER(USB_DeviceEnumerationFailed)\r
+void EVENT_USB_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode)\r
 {\r
        puts_P(PSTR(ESC_BG_RED "Dev Enum Error\r\n"));\r
        printf_P(PSTR(" -- Error Code %d\r\n"), ErrorCode);\r
@@ -185,43 +179,45 @@ void ReadNextReport(void)
        Pipe_SelectPipe(HID_DATA_IN_PIPE);\r
        Pipe_Unfreeze();\r
 \r
-       /* Ensure pipe contains data and is ready to be read before continuing */\r
-       if (!(Pipe_ReadWriteAllowed()))\r
+       /* Check to see if a packet has been received */\r
+       if (!(Pipe_IsINReceived()))\r
        {\r
-               #if !defined(INTERRUPT_DATA_PIPE)\r
                /* Refreeze HID data IN pipe */\r
                Pipe_Freeze();\r
-               #endif\r
-               \r
+                       \r
                return;\r
        }\r
        \r
-       uint8_t ReportINData[Pipe_BytesInPipe()];\r
+       /* Ensure pipe contains data before trying to read from it */\r
+       if (Pipe_IsReadWriteAllowed())\r
+       {\r
+               uint8_t ReportINData[Pipe_BytesInPipe()];\r
 \r
-       /* Read in HID report data */\r
-       Pipe_Read_Stream_LE(&ReportINData, sizeof(ReportINData));                               \r
+               /* Read in HID report data */\r
+               Pipe_Read_Stream_LE(&ReportINData, sizeof(ReportINData));\r
+       \r
+               /* Print report data through the serial port */\r
+               for (uint16_t CurrByte = 0; CurrByte < sizeof(ReportINData); CurrByte++)\r
+                 printf_P(PSTR("0x%02X "), ReportINData[CurrByte]);\r
+               \r
+               puts_P(PSTR("\r\n"));\r
+       }\r
                \r
        /* Clear the IN endpoint, ready for next data packet */\r
-       Pipe_ClearCurrentBank();\r
-       \r
-       /* Print report data through the serial port */\r
-       for (uint16_t CurrByte = 0; CurrByte < sizeof(ReportINData); CurrByte++)\r
-         printf_P(PSTR("0x%02X "), ReportINData[CurrByte]);\r
+       Pipe_ClearIN();\r
        \r
-       puts_P(PSTR("\r\n"));\r
-       \r
-       #if !defined(INTERRUPT_DATA_PIPE)\r
        /* Refreeze HID data IN pipe */\r
        Pipe_Freeze();\r
-       #endif\r
 }\r
 \r
 /** Writes a report to the attached device.\r
  *\r
  *  \param ReportOUTData  Buffer containing the report to send to the device\r
+ *  \param ReportIndex  Index of the report in the device (zero if the device does not use multiple reports)\r
+ *  \param ReportType  Type of report to send, either HID_REPORTTYPE_OUTPUT or HID_REPORTTYPE_FEATURE\r
  *  \param ReportLength  Length of the report to send\r
  */\r
-void WriteNextReport(uint8_t* ReportOUTData, uint16_t ReportLength)\r
+void WriteNextReport(uint8_t* ReportOUTData, uint8_t ReportIndex, uint8_t ReportType, uint16_t ReportLength)\r
 {\r
        /* Select and unfreeze HID data OUT pipe */\r
        Pipe_SelectPipe(HID_DATA_OUT_PIPE);\r
@@ -233,19 +229,23 @@ void WriteNextReport(uint8_t* ReportOUTData, uint16_t ReportLength)
                Pipe_Unfreeze();\r
 \r
                /* Ensure pipe is ready to be written to before continuing */\r
-               if (!(Pipe_ReadWriteAllowed()))\r
+               if (!(Pipe_IsOUTReady()))\r
                {\r
                        /* Refreeze the data OUT pipe */\r
                        Pipe_Freeze();\r
                        \r
                        return;\r
                }\r
+               \r
+               /* If the report index is used, send it before the report data */\r
+               if (ReportIndex)\r
+                 Pipe_Write_Byte(ReportIndex);\r
 \r
-               /* Read in HID report data */\r
+               /* Write out HID report data */\r
                Pipe_Write_Stream_LE(ReportOUTData, ReportLength);                              \r
                        \r
                /* Clear the OUT endpoint, send last data packet */\r
-               Pipe_ClearCurrentBank();\r
+               Pipe_ClearOUT();\r
 \r
                /* Refreeze the data OUT pipe */\r
                Pipe_Freeze();\r
@@ -253,15 +253,18 @@ void WriteNextReport(uint8_t* ReportOUTData, uint16_t ReportLength)
        else\r
        {\r
                /* Class specific request to send a HID report to the device */\r
-               USB_HostRequest = (USB_Host_Request_Header_t)\r
+               USB_ControlRequest = (USB_Request_Header_t)\r
                        {\r
-                               bmRequestType: (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),\r
-                               bRequest:      REQ_SetReport,\r
-                               wValue:        0,\r
-                               wIndex:        0,\r
-                               wLength:       ReportLength,\r
+                               .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),\r
+                               .bRequest      = REQ_SetReport,\r
+                               .wValue        = ((ReportType << 8) | ReportIndex),\r
+                               .wIndex        = 0,\r
+                               .wLength       = ReportLength,\r
                        };\r
 \r
+               /* Select the control pipe for the request transfer */\r
+               Pipe_SelectPipe(PIPE_CONTROLPIPE);\r
+\r
                /* Send the request to the device */\r
                USB_Host_SendControlRequest(ReportOUTData);\r
        }\r
@@ -279,15 +282,18 @@ TASK(USB_HID_Host)
        {\r
                case HOST_STATE_Addressed:\r
                        /* Standard request to set the device configuration to configuration 1 */\r
-                       USB_HostRequest = (USB_Host_Request_Header_t)\r
+                       USB_ControlRequest = (USB_Request_Header_t)\r
                                {\r
-                                       bmRequestType: (REQDIR_HOSTTODEVICE | REQTYPE_STANDARD | REQREC_DEVICE),\r
-                                       bRequest:      REQ_SetConfiguration,\r
-                                       wValue:        1,\r
-                                       wIndex:        0,\r
-                                       wLength:       0,\r
+                                       .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_STANDARD | REQREC_DEVICE),\r
+                                       .bRequest      = REQ_SetConfiguration,\r
+                                       .wValue        = 1,\r
+                                       .wIndex        = 0,\r
+                                       .wLength       = 0,\r
                                };\r
 \r
+                       /* Select the control pipe for the request transfer */\r
+                       Pipe_SelectPipe(PIPE_CONTROLPIPE);\r
+\r
                        /* Send the request, display error and wait for device detach if request fails */\r
                        if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)\r
                        {\r
@@ -325,53 +331,13 @@ TASK(USB_HID_Host)
                                break;\r
                        }\r
                \r
-                       #if defined(INTERRUPT_DATA_PIPE)                                        \r
-                       /* Select and unfreeze HID data IN pipe */\r
-                       Pipe_SelectPipe(HID_DATA_IN_PIPE);\r
-                       Pipe_Unfreeze();\r
-                       #endif\r
-\r
                        puts_P(PSTR("HID Device Enumerated.\r\n"));\r
                                        \r
                        USB_HostState = HOST_STATE_Ready;\r
                        break;\r
-               #if !defined(INTERRUPT_DATA_PIPE)\r
                case HOST_STATE_Ready:\r
                        ReadNextReport();\r
 \r
                        break;\r
-               #endif\r
-       }\r
-}\r
-\r
-#if defined(INTERRUPT_DATA_PIPE)\r
-/** Interrupt handler for the Endpoint/Pipe interrupt vector. This interrupt fires each time an enabled\r
- *  pipe interrupt occurs on a pipe which has had that interrupt enabled.\r
- */\r
-ISR(ENDPOINT_PIPE_vect, ISR_BLOCK)\r
-{\r
-       /* Save previously selected pipe before selecting a new pipe */\r
-       uint8_t PrevSelectedPipe = Pipe_GetCurrentPipe();\r
-\r
-       /* Check to see if the HID data IN pipe has caused the interrupt */\r
-       if (Pipe_HasPipeInterrupted(HID_DATA_IN_PIPE))\r
-       {\r
-               /* Clear the pipe interrupt, and select the data IN pipe */\r
-               Pipe_ClearPipeInterrupt(HID_DATA_IN_PIPE);\r
-               Pipe_SelectPipe(HID_DATA_IN_PIPE);      \r
-\r
-               /* Check to see if the pipe IN interrupt has fired */\r
-               if (USB_INT_HasOccurred(PIPE_INT_IN) && USB_INT_IsEnabled(PIPE_INT_IN))\r
-               {\r
-                       /* Clear interrupt flag */\r
-                       USB_INT_Clear(PIPE_INT_IN);             \r
-\r
-                       /* Read and process the next report from the device */\r
-                       ReadNextReport();\r
-               }\r
        }\r
-\r
-       /* Restore previously selected pipe */\r
-       Pipe_SelectPipe(PrevSelectedPipe);\r
 }\r
-#endif\r