Only abort Doxygen documentation generation if a non-unsupported tag warning is encou...

[pub/USBasp.git] / Demos / Host / ClassDriver / KeyboardHost / KeyboardHost.c

diff --git a/Demos/Host/ClassDriver/KeyboardHost/KeyboardHost.c b/Demos/Host/ClassDriver/KeyboardHost/KeyboardHost.c
index 8bdf2b6..f67cd11 100644 (file)
--- a/Demos/Host/ClassDriver/KeyboardHost/KeyboardHost.c
+++ b/Demos/Host/ClassDriver/KeyboardHost/KeyboardHost.c
@@ -1,21 +1,21 @@
 /*
              LUFA Library
 /*
              LUFA Library

-     Copyright (C) Dean Camera, 2010.
-              
+     Copyright (C) Dean Camera, 2012.
+

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

- 
+

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


@@ -49,12 +49,12 @@ USB_ClassInfo_HID_Host_t Keyboard_HID_Interface =
 
                                .DataOUTPipeNumber      = 2,
                                .DataOUTPipeDoubleBank  = false,
 
                                .DataOUTPipeNumber      = 2,
                                .DataOUTPipeDoubleBank  = false,

-                               
-                               .HIDInterfaceProtocol   = HID_BOOT_KEYBOARD_PROTOCOL,
+
+                               .HIDInterfaceProtocol   = HID_CSCP_KeyboardBootProtocol,

                        },
        };
 
                        },
        };
 

-       
+

 /** Main program entry point. This routine configures the hardware required by the application, then
  *  enters a loop to run the application tasks in sequence.
  */
 /** Main program entry point. This routine configures the hardware required by the application, then
  *  enters a loop to run the application tasks in sequence.
  */


@@ -66,89 +66,11 @@ int main(void)
 
        LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
        sei();
 
        LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
        sei();

-       
+

        for (;;)
        {
        for (;;)
        {

-               switch (USB_HostState)
-               {
-                       case HOST_STATE_Addressed:
-                               LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
-                       
-                               uint16_t ConfigDescriptorSize;
-                               uint8_t  ConfigDescriptorData[512];
-
-                               if (USB_Host_GetDeviceConfigDescriptor(1, &ConfigDescriptorSize, ConfigDescriptorData,
-                                                                      sizeof(ConfigDescriptorData)) != HOST_GETCONFIG_Successful)
-                               {
-                                       puts_P(PSTR("Error Retrieving Configuration Descriptor.\r\n"));
-                                       LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
-                                       USB_HostState = HOST_STATE_WaitForDeviceRemoval;
-                                       break;
-                               }
-
-                               if (HID_Host_ConfigurePipes(&Keyboard_HID_Interface,
-                                                           ConfigDescriptorSize, ConfigDescriptorData) != HID_ENUMERROR_NoError)
-                               {
-                                       puts_P(PSTR("Attached Device Not a Valid Keyboard.\r\n"));
-                                       LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
-                                       USB_HostState = HOST_STATE_WaitForDeviceRemoval;
-                                       break;
-                               }
-                               
-                               if (USB_Host_SetDeviceConfiguration(1) != HOST_SENDCONTROL_Successful)
-                               {
-                                       puts_P(PSTR("Error Setting Device Configuration.\r\n"));
-                                       LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
-                                       USB_HostState = HOST_STATE_WaitForDeviceRemoval;
-                                       break;
-                               }
-
-                               if (HID_Host_SetBootProtocol(&Keyboard_HID_Interface) != 0)
-                               {
-                                       puts_P(PSTR("Could not Set Boot Protocol Mode.\r\n"));
-                                       LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
-                                       USB_HostState = HOST_STATE_WaitForDeviceRemoval;
-                                       break;
-                               }
-                               
-                               puts_P(PSTR("Keyboard Enumerated.\r\n"));
-                               LEDs_SetAllLEDs(LEDMASK_USB_READY);
-                               USB_HostState = HOST_STATE_Configured;
-                               break;
-                       case HOST_STATE_Configured:
-                               if (HID_Host_IsReportReceived(&Keyboard_HID_Interface))
-                               {
-                                       USB_KeyboardReport_Data_t KeyboardReport;                                       
-                                       HID_Host_ReceiveReport(&Keyboard_HID_Interface, &KeyboardReport);
-
-                                       LEDs_ChangeLEDs(LEDS_LED1, (KeyboardReport.Modifier) ? LEDS_LED1 : 0);
-                                       
-                                       uint8_t PressedKeyCode = KeyboardReport.KeyCode[0];
-
-                                       if (PressedKeyCode)
-                                       {
-                                               char PressedKey = 0;
-
-                                               LEDs_ToggleLEDs(LEDS_LED2);
-                                                         
-                                               /* Retrieve pressed key character if alphanumeric */
-                                               if ((PressedKeyCode >= 0x04) && (PressedKeyCode <= 0x1D))
-                                                 PressedKey = (PressedKeyCode - 0x04) + 'A';
-                                               else if ((PressedKeyCode >= 0x1E) && (PressedKeyCode <= 0x27))
-                                                 PressedKey = (PressedKeyCode - 0x1E) + '0';
-                                               else if (PressedKeyCode == 0x2C)
-                                                 PressedKey = ' ';                                             
-                                               else if (PressedKeyCode == 0x28)
-                                                 PressedKey = '\n';
-                                                        
-                                               if (PressedKey)
-                                                 putchar(PressedKey);
-                                       }
-                               }
-                               
-                               break;
-               }
-       
+               KeyboardHost_Task();
+

                HID_Host_USBTask(&Keyboard_HID_Interface);
                USB_USBTask();
        }
                HID_Host_USBTask(&Keyboard_HID_Interface);
                USB_USBTask();
        }


@@ -165,9 +87,64 @@ void SetupHardware(void)
        clock_prescale_set(clock_div_1);
 
        /* Hardware Initialization */
        clock_prescale_set(clock_div_1);
 
        /* Hardware Initialization */

-       SerialStream_Init(9600, false);
+       Serial_Init(9600, false);

        LEDs_Init();
        USB_Init();
        LEDs_Init();
        USB_Init();

+
+       /* Create a stdio stream for the serial port for stdin and stdout */
+       Serial_CreateStream(NULL);
+}
+
+/** Task to manage an enumerated USB keyboard once connected, to display key state
+ *  data as it is received.
+ */
+void KeyboardHost_Task(void)
+{
+       if (USB_HostState != HOST_STATE_Configured)
+         return;
+
+       if (HID_Host_IsReportReceived(&Keyboard_HID_Interface))
+       {
+               USB_KeyboardReport_Data_t KeyboardReport;
+               HID_Host_ReceiveReport(&Keyboard_HID_Interface, &KeyboardReport);
+
+               LEDs_ChangeLEDs(LEDS_LED1, (KeyboardReport.Modifier) ? LEDS_LED1 : 0);
+
+               uint8_t KeyCode = KeyboardReport.KeyCode[0];
+
+               if (KeyCode)
+               {
+                       char PressedKey = 0;
+
+                       LEDs_ToggleLEDs(LEDS_LED2);
+
+                       /* Retrieve pressed key character if alphanumeric */
+                       if ((KeyCode >= HID_KEYBOARD_SC_A) && (KeyCode <= HID_KEYBOARD_SC_Z))
+                       {
+                               PressedKey = (KeyCode - HID_KEYBOARD_SC_A) + 'A';
+                       }
+                       else if ((KeyCode >= HID_KEYBOARD_SC_1_AND_EXCLAMATION) &
+                                (KeyCode  < HID_KEYBOARD_SC_0_AND_CLOSING_PARENTHESIS))
+                       {
+                               PressedKey = (KeyCode - HID_KEYBOARD_SC_1_AND_EXCLAMATION) + '1';
+                       }
+                       else if (KeyCode == HID_KEYBOARD_SC_0_AND_CLOSING_PARENTHESIS)
+                       {
+                               PressedKey = '0';
+                       }
+                       else if (KeyCode == HID_KEYBOARD_SC_SPACE)
+                       {
+                               PressedKey = ' ';
+                       }
+                       else if (KeyCode == HID_KEYBOARD_SC_ENTER)
+                       {
+                               PressedKey = '\n';
+                       }
+
+                       if (PressedKey)
+                         putchar(PressedKey);
+               }
+       }

 }
 
 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
 }
 
 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and


@@ -193,13 +170,50 @@ void EVENT_USB_Host_DeviceUnattached(void)
  */
 void EVENT_USB_Host_DeviceEnumerationComplete(void)
 {
  */
 void EVENT_USB_Host_DeviceEnumerationComplete(void)
 {

+       LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
+
+       uint16_t ConfigDescriptorSize;
+       uint8_t  ConfigDescriptorData[512];
+
+       if (USB_Host_GetDeviceConfigDescriptor(1, &ConfigDescriptorSize, ConfigDescriptorData,
+                                              sizeof(ConfigDescriptorData)) != HOST_GETCONFIG_Successful)
+       {
+               puts_P(PSTR("Error Retrieving Configuration Descriptor.\r\n"));
+               LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
+               return;
+       }
+
+       if (HID_Host_ConfigurePipes(&Keyboard_HID_Interface,
+                                   ConfigDescriptorSize, ConfigDescriptorData) != HID_ENUMERROR_NoError)
+       {
+               puts_P(PSTR("Attached Device Not a Valid Keyboard.\r\n"));
+               LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
+               return;
+       }
+
+       if (USB_Host_SetDeviceConfiguration(1) != HOST_SENDCONTROL_Successful)
+       {
+               puts_P(PSTR("Error Setting Device Configuration.\r\n"));
+               LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
+               return;
+       }
+
+       if (HID_Host_SetBootProtocol(&Keyboard_HID_Interface) != 0)
+       {
+               puts_P(PSTR("Could not Set Boot Protocol Mode.\r\n"));
+               LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
+               USB_Host_SetDeviceConfiguration(0);
+               return;
+       }
+
+       puts_P(PSTR("Keyboard Enumerated.\r\n"));

        LEDs_SetAllLEDs(LEDMASK_USB_READY);
 }
 
 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
 {
        LEDs_SetAllLEDs(LEDMASK_USB_READY);
 }
 
 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
 {

-       USB_ShutDown();
+       USB_Disable();

 
        printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
                                 " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
 
        printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
                                 " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);


@@ -218,6 +232,7 @@ void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode,
                                 " -- Error Code %d\r\n"
                                 " -- Sub Error Code %d\r\n"
                                 " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
                                 " -- Error Code %d\r\n"
                                 " -- Sub Error Code %d\r\n"
                                 " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);

-       
+

        LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 }
        LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 }

+