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

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

diff --git a/Demos/Host/ClassDriver/KeyboardHostWithParser/KeyboardHostWithParser.c b/Demos/Host/ClassDriver/KeyboardHostWithParser/KeyboardHostWithParser.c
index dedf12f..6e7ee6c 100644 (file)
--- a/Demos/Host/ClassDriver/KeyboardHostWithParser/KeyboardHostWithParser.c
+++ b/Demos/Host/ClassDriver/KeyboardHostWithParser/KeyboardHostWithParser.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 KeyboardHostWithParser demo. This file contains the main tasks of
  *  the demo and is responsible for the initial application hardware configuration.
  */
  *  Main source file for the KeyboardHostWithParser demo. This file contains the main tasks of
  *  the demo and is responsible for the initial application hardware configuration.
  */

- 
+

 #include "KeyboardHostWithParser.h"
 
 /** Processed HID report descriptor items structure, containing information on each HID report element */
 #include "KeyboardHostWithParser.h"
 
 /** Processed HID report descriptor items structure, containing information on each HID report element */


@@ -52,14 +52,14 @@ USB_ClassInfo_HID_Host_t Keyboard_HID_Interface =
 
                                .DataOUTPipeNumber      = 2,
                                .DataOUTPipeDoubleBank  = false,
 
                                .DataOUTPipeNumber      = 2,
                                .DataOUTPipeDoubleBank  = false,

-                               
-                               .HIDInterfaceProtocol   = HID_NON_BOOT_PROTOCOL,
-                               
+
+                               .HIDInterfaceProtocol   = HID_CSCP_NonBootProtocol,
+

                                .HIDParserData          = &HIDReportInfo
                        },
        };
 
                                .HIDParserData          = &HIDReportInfo
                        },
        };
 

-       
+

 /** 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.
  */


@@ -78,7 +78,7 @@ int main(void)
                {
                        case HOST_STATE_Addressed:
                                LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
                {
                        case HOST_STATE_Addressed:
                                LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);

-                       
+

                                uint16_t ConfigDescriptorSize;
                                uint8_t  ConfigDescriptorData[512];
 
                                uint16_t ConfigDescriptorSize;
                                uint8_t  ConfigDescriptorData[512];
 


@@ -99,7 +99,7 @@ int main(void)
                                        USB_HostState = HOST_STATE_WaitForDeviceRemoval;
                                        break;
                                }
                                        USB_HostState = HOST_STATE_WaitForDeviceRemoval;
                                        break;
                                }

-                               
+

                                if (USB_Host_SetDeviceConfiguration(1) != HOST_SENDCONTROL_Successful)
                                {
                                        puts_P(PSTR("Error Setting Device Configuration.\r\n"));
                                if (USB_Host_SetDeviceConfiguration(1) != HOST_SENDCONTROL_Successful)
                                {
                                        puts_P(PSTR("Error Setting Device Configuration.\r\n"));


@@ -115,7 +115,7 @@ int main(void)
                                        USB_HostState = HOST_STATE_WaitForDeviceRemoval;
                                        break;
                                }
                                        USB_HostState = HOST_STATE_WaitForDeviceRemoval;
                                        break;
                                }

-                               
+

                                puts_P(PSTR("Keyboard Enumerated.\r\n"));
                                LEDs_SetAllLEDs(LEDMASK_USB_READY);
                                USB_HostState = HOST_STATE_Configured;
                                puts_P(PSTR("Keyboard Enumerated.\r\n"));
                                LEDs_SetAllLEDs(LEDMASK_USB_READY);
                                USB_HostState = HOST_STATE_Configured;


@@ -125,7 +125,7 @@ int main(void)
                                {
                                        uint8_t KeyboardReport[Keyboard_HID_Interface.State.LargestReportSize];
                                        HID_Host_ReceiveReport(&Keyboard_HID_Interface, &KeyboardReport);
                                {
                                        uint8_t KeyboardReport[Keyboard_HID_Interface.State.LargestReportSize];
                                        HID_Host_ReceiveReport(&Keyboard_HID_Interface, &KeyboardReport);

-                                       
+

                                        for (uint8_t ReportNumber = 0; ReportNumber < HIDReportInfo.TotalReportItems; ReportNumber++)
                                        {
                                                HID_ReportItem_t* ReportItem = &HIDReportInfo.ReportItems[ReportNumber];
                                        for (uint8_t ReportNumber = 0; ReportNumber < HIDReportInfo.TotalReportItems; ReportNumber++)
                                        {
                                                HID_ReportItem_t* ReportItem = &HIDReportInfo.ReportItems[ReportNumber];


@@ -138,12 +138,12 @@ int main(void)
                                                if ((ReportItem->Attributes.Usage.Page      == USAGE_PAGE_KEYBOARD) &&
                                                        (ReportItem->Attributes.BitSize         == 8)                   &&
                                                        (ReportItem->Attributes.Logical.Maximum > 1)                    &&
                                                if ((ReportItem->Attributes.Usage.Page      == USAGE_PAGE_KEYBOARD) &&
                                                        (ReportItem->Attributes.BitSize         == 8)                   &&
                                                        (ReportItem->Attributes.Logical.Maximum > 1)                    &&

-                                                       (ReportItem->ItemType                   == REPORT_ITEM_TYPE_In))
+                                                       (ReportItem->ItemType                   == HID_REPORT_ITEM_In))

                                                {
                                                        /* Key code is an unsigned char in length, cast to the appropriate type */
                                                        uint8_t KeyCode = (uint8_t)ReportItem->Value;
 
                                                {
                                                        /* Key code is an unsigned char in length, cast to the appropriate type */
                                                        uint8_t KeyCode = (uint8_t)ReportItem->Value;
 

-                                                       /* If scancode is non-zero, a key is being pressed */
+                                                       /* If scan-code is non-zero, a key is being pressed */

                                                        if (KeyCode)
                                                        {
                                                                /* Toggle status LED to indicate keypress */
                                                        if (KeyCode)
                                                        {
                                                                /* Toggle status LED to indicate keypress */


@@ -151,30 +151,39 @@ int main(void)
 
                                                                char PressedKey = 0;
 
 
                                                                char PressedKey = 0;
 

-                                                               /* Convert scancode to printable character if alphanumeric */
-                                                               if ((KeyCode >= 0x04) && (KeyCode <= 0x1D))
-                                                                 PressedKey = (KeyCode - 0x04) + 'A';
-                                                               else if ((KeyCode >= 0x1E) && (KeyCode <= 0x27))
-                                                                 PressedKey = (KeyCode - 0x1E) + '0';
-                                                               else if (KeyCode == 0x2C)
-                                                                 PressedKey = ' ';                                             
-                                                               else if (KeyCode == 0x28)
-                                                                 PressedKey = '\n';
-                                                                        
+                                                               /* Convert scan-code to printable 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) + '0';
+                                                               }
+                                                               else if (KeyCode == HID_KEYBOARD_SC_SPACE)
+                                                               {
+                                                                       PressedKey = ' ';
+                                                               }
+                                                               else if (KeyCode == HID_KEYBOARD_SC_ENTER)
+                                                               {
+                                                                       PressedKey = '\n';
+                                                               }
+

                                                                /* Print the pressed key character out through the serial port if valid */
                                                                if (PressedKey)
                                                                  putchar(PressedKey);
                                                        }
                                                                /* Print the pressed key character out through the serial port if valid */
                                                                if (PressedKey)
                                                                  putchar(PressedKey);
                                                        }

-                                                       
-                                                       /* Once a scancode is found, stop scanning through the report items */
+
+                                                       /* Once a scan-code is found, stop scanning through the report items */

                                                        break;
                                                }
                                        }
                                }
                                                        break;
                                                }
                                        }
                                }

-                               
+

                                break;
                }
                                break;
                }

-       
+

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


@@ -237,13 +246,14 @@ void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
  *  enumerating an attached USB device.
  */
 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
  *  enumerating an attached USB device.
  */

-void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode)
+void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode,
+                                            const uint8_t SubErrorCode)

 {
        printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
                                 " -- Error Code %d\r\n"
                                 " -- Sub Error Code %d\r\n"
                                 " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
 {
        printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
                                 " -- 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);
 }
 


@@ -256,7 +266,7 @@ void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8
  *
  *  \return Boolean true if the item should be stored into the HID report structure, false if it should be discarded
  */
  *
  *  \return Boolean true if the item should be stored into the HID report structure, false if it should be discarded
  */

-bool CALLBACK_HIDParser_FilterHIDReportItem(HID_ReportItem_t* CurrentItem)
+bool CALLBACK_HIDParser_FilterHIDReportItem(HID_ReportItem_t* const CurrentItem)

 {
        /* Check the attributes of the current item - see if we are interested in it or not;
         * only store KEYBOARD usage page items into the Processed HID Report structure to
 {
        /* Check the attributes of the current item - see if we are interested in it or not;
         * only store KEYBOARD usage page items into the Processed HID Report structure to


@@ -264,3 +274,4 @@ bool CALLBACK_HIDParser_FilterHIDReportItem(HID_ReportItem_t* CurrentItem)
         */
        return (CurrentItem->Attributes.Usage.Page == USAGE_PAGE_KEYBOARD);
 }
         */
        return (CurrentItem->Attributes.Usage.Page == USAGE_PAGE_KEYBOARD);
 }

+