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

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

diff --git a/Demos/Device/LowLevel/KeyboardMouse/KeyboardMouse.c b/Demos/Device/LowLevel/KeyboardMouse/KeyboardMouse.c
index 2f4bd76..2986f6f 100644 (file)
--- a/Demos/Device/LowLevel/KeyboardMouse/KeyboardMouse.c
+++ b/Demos/Device/LowLevel/KeyboardMouse/KeyboardMouse.c
@@ -1,22 +1,22 @@
 /*
              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  Denver Gingerich (denver [at] ossguy [dot] com)
 */
 
 /*
   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
   Copyright 2010  Denver Gingerich (denver [at] ossguy [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


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

- 
+

 #include "KeyboardMouse.h"
 
 /** Global structure to hold the current keyboard interface HID report, for transmission to the host */
 #include "KeyboardMouse.h"
 
 /** Global structure to hold the current keyboard interface HID report, for transmission to the host */


@@ -50,7 +50,7 @@ USB_MouseReport_Data_t    MouseReportData;
 int main(void)
 {
        SetupHardware();
 int main(void)
 {
        SetupHardware();

-       
+

        LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
        sei();
 
        LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
        sei();
 


@@ -114,14 +114,14 @@ void EVENT_USB_Device_ConfigurationChanged(void)
                                                    HID_EPSIZE, ENDPOINT_BANK_SINGLE);
 
        /* Indicate endpoint configuration success or failure */
                                                    HID_EPSIZE, ENDPOINT_BANK_SINGLE);
 
        /* Indicate endpoint configuration success or failure */

-       LEDs_SetAllLEDs(ConfigSuccess ? LEDMASK_USB_READY : LEDMASK_USB_ERROR); 
+       LEDs_SetAllLEDs(ConfigSuccess ? LEDMASK_USB_READY : LEDMASK_USB_ERROR);

 }
 
 }
 

-/** Event handler for the USB_UnhandledControlPacket event. This is used to catch standard and class specific
- *  control requests that are not handled internally by the USB library (including the HID commands, which are
- *  all issued via the control endpoint), so that they can be handled appropriately for the application.
+/** Event handler for the USB_ControlRequest event. This is used to catch and process control requests sent to
+ *  the device from the USB host before passing along unhandled control requests to the library for processing
+ *  internally.

  */
  */

-void EVENT_USB_Device_UnhandledControlRequest(void)
+void EVENT_USB_Device_ControlRequest(void)

 {
        uint8_t* ReportData;
        uint8_t  ReportSize;
 {
        uint8_t* ReportData;
        uint8_t  ReportSize;


@@ -129,11 +129,11 @@ void EVENT_USB_Device_UnhandledControlRequest(void)
        /* Handle HID Class specific requests */
        switch (USB_ControlRequest.bRequest)
        {
        /* Handle HID Class specific requests */
        switch (USB_ControlRequest.bRequest)
        {

-               case REQ_GetReport:
+               case HID_REQ_GetReport:

                        if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
                        {
                                Endpoint_ClearSETUP();
                        if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
                        {
                                Endpoint_ClearSETUP();

-       
+

                                /* Determine if it is the mouse or the keyboard data that is being requested */
                                if (!(USB_ControlRequest.wIndex))
                                {
                                /* Determine if it is the mouse or the keyboard data that is being requested */
                                if (!(USB_ControlRequest.wIndex))
                                {


@@ -153,13 +153,13 @@ void EVENT_USB_Device_UnhandledControlRequest(void)
                                /* Clear the report data afterwards */
                                memset(ReportData, 0, ReportSize);
                        }
                                /* Clear the report data afterwards */
                                memset(ReportData, 0, ReportSize);
                        }

-               
+

                        break;
                        break;

-               case REQ_SetReport:
+               case HID_REQ_SetReport:

                        if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
                        {
                                Endpoint_ClearSETUP();
                        if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
                        {
                                Endpoint_ClearSETUP();

-                               
+

                                /* Wait until the LED report has been sent by the host */
                                while (!(Endpoint_IsOUTReceived()))
                                {
                                /* Wait until the LED report has been sent by the host */
                                while (!(Endpoint_IsOUTReceived()))
                                {


@@ -176,7 +176,7 @@ void EVENT_USB_Device_UnhandledControlRequest(void)
                                /* Process the incoming LED report */
                                Keyboard_ProcessLEDReport(LEDStatus);
                        }
                                /* Process the incoming LED report */
                                Keyboard_ProcessLEDReport(LEDStatus);
                        }

-                       
+

                        break;
        }
 }
                        break;
        }
 }


@@ -189,14 +189,14 @@ void EVENT_USB_Device_UnhandledControlRequest(void)
 void Keyboard_ProcessLEDReport(const uint8_t LEDStatus)
 {
        uint8_t LEDMask = LEDS_LED2;
 void Keyboard_ProcessLEDReport(const uint8_t LEDStatus)
 {
        uint8_t LEDMask = LEDS_LED2;

-       
-       if (LEDStatus & KEYBOARD_LED_NUMLOCK)
+
+       if (LEDStatus & HID_KEYBOARD_LED_NUMLOCK)

          LEDMask |= LEDS_LED1;
          LEDMask |= LEDS_LED1;

-       
-       if (LEDStatus & KEYBOARD_LED_CAPSLOCK)
+
+       if (LEDStatus & HID_KEYBOARD_LED_CAPSLOCK)

          LEDMask |= LEDS_LED3;
 
          LEDMask |= LEDS_LED3;
 

-       if (LEDStatus & KEYBOARD_LED_SCROLLLOCK)
+       if (LEDStatus & HID_KEYBOARD_LED_SCROLLLOCK)

          LEDMask |= LEDS_LED4;
 
        /* Set the status LEDs to the current Keyboard LED status */
          LEDMask |= LEDS_LED4;
 
        /* Set the status LEDs to the current Keyboard LED status */


@@ -219,20 +219,20 @@ void Keyboard_HID_Task(void)
        if (!(Buttons_GetStatus() & BUTTONS_BUTTON1))
        {
                /* Make sent key uppercase by indicating that the left shift key is pressed */
        if (!(Buttons_GetStatus() & BUTTONS_BUTTON1))
        {
                /* Make sent key uppercase by indicating that the left shift key is pressed */

-               KeyboardReportData.Modifier = KEYBOARD_MODIFER_LEFTSHIFT;
+               KeyboardReportData.Modifier = HID_KEYBOARD_MODIFER_LEFTSHIFT;

 
                if (JoyStatus_LCL & JOY_UP)
 
                if (JoyStatus_LCL & JOY_UP)

-                 KeyboardReportData.KeyCode[0] = 0x04; // A
+                 KeyboardReportData.KeyCode[0] = HID_KEYBOARD_SC_A;

                else if (JoyStatus_LCL & JOY_DOWN)
                else if (JoyStatus_LCL & JOY_DOWN)

-                 KeyboardReportData.KeyCode[0] = 0x05; // B
+                 KeyboardReportData.KeyCode[0] = HID_KEYBOARD_SC_B;

 
                if (JoyStatus_LCL & JOY_LEFT)
 
                if (JoyStatus_LCL & JOY_LEFT)

-                 KeyboardReportData.KeyCode[0] = 0x06; // C
+                 KeyboardReportData.KeyCode[0] = HID_KEYBOARD_SC_C;

                else if (JoyStatus_LCL & JOY_RIGHT)
                else if (JoyStatus_LCL & JOY_RIGHT)

-                 KeyboardReportData.KeyCode[0] = 0x07; // D
+                 KeyboardReportData.KeyCode[0] = HID_KEYBOARD_SC_D;

 
                if (JoyStatus_LCL & JOY_PRESS)
 
                if (JoyStatus_LCL & JOY_PRESS)

-                 KeyboardReportData.KeyCode[0] = 0x08; // E
+                 KeyboardReportData.KeyCode[0] = HID_KEYBOARD_SC_E;

        }
 
        /* Select the Keyboard Report Endpoint */
        }
 
        /* Select the Keyboard Report Endpoint */


@@ -256,7 +256,7 @@ void Keyboard_HID_Task(void)
 
        /* Check if Keyboard LED Endpoint Ready for Read/Write */
        if (Endpoint_IsReadWriteAllowed())
 
        /* Check if Keyboard LED Endpoint Ready for Read/Write */
        if (Endpoint_IsReadWriteAllowed())

-       {               
+       {

                /* Read in and process the LED report from the host */
                Keyboard_ProcessLEDReport(Endpoint_Read_Byte());
 
                /* Read in and process the LED report from the host */
                Keyboard_ProcessLEDReport(Endpoint_Read_Byte());
 


@@ -309,3 +309,4 @@ void Mouse_HID_Task(void)
                memset(&MouseReportData, 0, sizeof(MouseReportData));
        }
 }
                memset(&MouseReportData, 0, sizeof(MouseReportData));
        }
 }

+