Documentation improvements - put driver example code into its own section, fix incorr...

[pub/USBasp.git] / Demos / Device / ClassDriver / VirtualSerialMouse / VirtualSerialMouse.c

diff --git a/Demos/Device/ClassDriver/VirtualSerialMouse/VirtualSerialMouse.c b/Demos/Device/ClassDriver/VirtualSerialMouse/VirtualSerialMouse.c
index 71162de..9c63e99 100644 (file)
--- a/Demos/Device/ClassDriver/VirtualSerialMouse/VirtualSerialMouse.c
+++ b/Demos/Device/ClassDriver/VirtualSerialMouse/VirtualSerialMouse.c
@@ -1,21 +1,21 @@
 /*
              LUFA Library
      Copyright (C) Dean Camera, 2010.
 /*
              LUFA Library
      Copyright (C) Dean Camera, 2010.

-              
+

   dean [at] fourwalledcubicle [dot] com
   dean [at] fourwalledcubicle [dot] com

-      www.fourwalledcubicle.com
+           www.lufa-lib.org

 */
 
 /*
   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 
 */
 
 /*
   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 

-  Permission to use, copy, modify, distribute, and sell this 
+  Permission to use, copy, modify, distribute, and sell this

   software and its documentation for any purpose is hereby granted
   software and its documentation for any purpose is hereby granted

-  without fee, provided that the above copyright notice appear in 
+  without fee, provided that the above copyright notice appear in

   all copies and that both that the copyright notice and this
   all copies and that both that the copyright notice and this

-  permission notice and warranty disclaimer appear in supporting 
-  documentation, and that the name of the author not be used in 
-  advertising or publicity pertaining to distribution of the 
+  permission notice and warranty disclaimer appear in supporting
+  documentation, and that the name of the author not be used in
+  advertising or publicity pertaining to distribution of the

   software without specific, written prior permission.
 
   The author disclaim all warranties with regard to this
   software without specific, written prior permission.
 
   The author disclaim all warranties with regard to this


@@ -33,7 +33,7 @@
  *  Main source file for the VirtualSerialMouse demo. This file contains the main tasks of
  *  the demo and is responsible for the initial application hardware configuration.
  */
  *  Main source file for the VirtualSerialMouse demo. This file contains the main tasks of
  *  the demo and is responsible for the initial application hardware configuration.
  */

- 
+

 #include "VirtualSerialMouse.h"
 
 /** LUFA CDC Class driver interface configuration and state information. This structure is
 #include "VirtualSerialMouse.h"
 
 /** LUFA CDC Class driver interface configuration and state information. This structure is


@@ -88,17 +88,16 @@ USB_ClassInfo_HID_Device_t Mouse_HID_Interface =
 int main(void)
 {
        SetupHardware();
 int main(void)
 {
        SetupHardware();

-       
+

        LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
        sei();
 
        for (;;)
        {
                CheckJoystickMovement();
        LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
        sei();
 
        for (;;)
        {
                CheckJoystickMovement();

-                
+

                /* Must throw away unused bytes from the host, or it will lock up while waiting for the device */
                /* Must throw away unused bytes from the host, or it will lock up while waiting for the device */

-               while (CDC_Device_BytesReceived(&VirtualSerial_CDC_Interface))
-                 CDC_Device_ReceiveByte(&VirtualSerial_CDC_Interface);
+               CDC_Device_ReceiveByte(&VirtualSerial_CDC_Interface);

 
                CDC_Device_USBTask(&VirtualSerial_CDC_Interface);
                HID_Device_USBTask(&Mouse_HID_Interface);
 
                CDC_Device_USBTask(&VirtualSerial_CDC_Interface);
                HID_Device_USBTask(&Mouse_HID_Interface);


@@ -128,7 +127,7 @@ void CheckJoystickMovement(void)
        uint8_t     JoyStatus_LCL = Joystick_GetStatus();
        char*       ReportString  = NULL;
        static bool ActionSent    = false;
        uint8_t     JoyStatus_LCL = Joystick_GetStatus();
        char*       ReportString  = NULL;
        static bool ActionSent    = false;

-       
+

        if (JoyStatus_LCL & JOY_UP)
          ReportString = "Joystick Up\r\n";
        else if (JoyStatus_LCL & JOY_DOWN)
        if (JoyStatus_LCL & JOY_UP)
          ReportString = "Joystick Up\r\n";
        else if (JoyStatus_LCL & JOY_DOWN)


@@ -141,12 +140,12 @@ void CheckJoystickMovement(void)
          ReportString = "Joystick Pressed\r\n";
        else
          ActionSent = false;
          ReportString = "Joystick Pressed\r\n";
        else
          ActionSent = false;

-         
+

        if ((ReportString != NULL) && (ActionSent == false))
        {
                ActionSent = true;
        if ((ReportString != NULL) && (ActionSent == false))
        {
                ActionSent = true;

-               
-               CDC_Device_SendString(&VirtualSerial_CDC_Interface, ReportString, strlen(ReportString));                
+
+               CDC_Device_SendString(&VirtualSerial_CDC_Interface, ReportString, strlen(ReportString));

        }
 }
 
        }
 }
 


@@ -165,19 +164,18 @@ void EVENT_USB_Device_Disconnect(void)
 /** Event handler for the library USB Configuration Changed event. */
 void EVENT_USB_Device_ConfigurationChanged(void)
 {
 /** Event handler for the library USB Configuration Changed event. */
 void EVENT_USB_Device_ConfigurationChanged(void)
 {

-       LEDs_SetAllLEDs(LEDMASK_USB_READY);
+       bool ConfigSuccess = true;

 
 

-       if (!(CDC_Device_ConfigureEndpoints(&VirtualSerial_CDC_Interface)))
-         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
+       ConfigSuccess &= HID_Device_ConfigureEndpoints(&Mouse_HID_Interface);
+       ConfigSuccess &= CDC_Device_ConfigureEndpoints(&VirtualSerial_CDC_Interface);

 
 

-       if (!(HID_Device_ConfigureEndpoints(&Mouse_HID_Interface)))
-         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
-         

        USB_Device_EnableSOFEvents();
        USB_Device_EnableSOFEvents();

+
+       LEDs_SetAllLEDs(ConfigSuccess ? LEDMASK_USB_READY : LEDMASK_USB_ERROR);

 }
 
 }
 

-/** Event handler for the library USB Unhandled Control Request event. */
-void EVENT_USB_Device_UnhandledControlRequest(void)
+/** Event handler for the library USB Control Request reception event. */
+void EVENT_USB_Device_ControlRequest(void)

 {
        CDC_Device_ProcessControlRequest(&VirtualSerial_CDC_Interface);
        HID_Device_ProcessControlRequest(&Mouse_HID_Interface);
 {
        CDC_Device_ProcessControlRequest(&VirtualSerial_CDC_Interface);
        HID_Device_ProcessControlRequest(&Mouse_HID_Interface);


@@ -193,17 +191,20 @@ void EVENT_USB_Device_StartOfFrame(void)
  *
  *  \param[in]     HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
  *  \param[in,out] ReportID    Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID
  *
  *  \param[in]     HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
  *  \param[in,out] ReportID    Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID

- *  \param[in]     ReportType  Type of the report to create, either REPORT_ITEM_TYPE_In or REPORT_ITEM_TYPE_Feature
+ *  \param[in]     ReportType  Type of the report to create, either HID_REPORT_ITEM_In or HID_REPORT_ITEM_Feature

  *  \param[out]    ReportData  Pointer to a buffer where the created report should be stored
  *  \param[out]    ReportSize  Number of bytes written in the report (or zero if no report is to be sent
  *
  *  \return Boolean true to force the sending of the report, false to let the library determine if it needs to be sent
  */
  *  \param[out]    ReportData  Pointer to a buffer where the created report should be stored
  *  \param[out]    ReportSize  Number of bytes written in the report (or zero if no report is to be sent
  *
  *  \return Boolean true to force the sending of the report, false to let the library determine if it needs to be sent
  */

-bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, uint8_t* const ReportID,
-                                         const uint8_t ReportType, void* ReportData, uint16_t* ReportSize)
+bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
+                                         uint8_t* const ReportID,
+                                         const uint8_t ReportType,
+                                         void* ReportData,
+                                         uint16_t* const ReportSize)

 {
        USB_MouseReport_Data_t* MouseReport = (USB_MouseReport_Data_t*)ReportData;
 {
        USB_MouseReport_Data_t* MouseReport = (USB_MouseReport_Data_t*)ReportData;

-               
+

        uint8_t JoyStatus_LCL    = Joystick_GetStatus();
        uint8_t ButtonStatus_LCL = Buttons_GetStatus();
 
        uint8_t JoyStatus_LCL    = Joystick_GetStatus();
        uint8_t ButtonStatus_LCL = Buttons_GetStatus();
 


@@ -219,10 +220,10 @@ bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDIn
 
        if (JoyStatus_LCL & JOY_PRESS)
          MouseReport->Button |= (1 << 0);
 
        if (JoyStatus_LCL & JOY_PRESS)
          MouseReport->Button |= (1 << 0);

-         
+

        if (ButtonStatus_LCL & BUTTONS_BUTTON1)
          MouseReport->Button |= (1 << 1);
        if (ButtonStatus_LCL & BUTTONS_BUTTON1)
          MouseReport->Button |= (1 << 1);

-       
+

        *ReportSize = sizeof(USB_MouseReport_Data_t);
        return true;
 }
        *ReportSize = sizeof(USB_MouseReport_Data_t);
        return true;
 }


@@ -231,12 +232,16 @@ bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDIn
  *
  *  \param[in] HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
  *  \param[in] ReportID    Report ID of the received report from the host
  *
  *  \param[in] HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
  *  \param[in] ReportID    Report ID of the received report from the host

- *  \param[in] ReportType  The type of report that the host has sent, either REPORT_ITEM_TYPE_Out or REPORT_ITEM_TYPE_Feature
+ *  \param[in] ReportType  The type of report that the host has sent, either HID_REPORT_ITEM_Out or HID_REPORT_ITEM_Feature

  *  \param[in] ReportData  Pointer to a buffer where the created report has been stored
  *  \param[in] ReportSize  Size in bytes of the received HID report
  */
  *  \param[in] ReportData  Pointer to a buffer where the created report has been stored
  *  \param[in] ReportSize  Size in bytes of the received HID report
  */

-void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, const uint8_t ReportID,
-                                          const uint8_t ReportType, const void* ReportData, const uint16_t ReportSize)
+void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
+                                          const uint8_t ReportID,
+                                          const uint8_t ReportType,
+                                          const void* ReportData,
+                                          const uint16_t ReportSize)

 {
        // Unused (but mandatory for the HID class driver) in this demo, since there are no Host->Device reports
 }
 {
        // Unused (but mandatory for the HID class driver) in this demo, since there are no Host->Device reports
 }

+