Fix incorrect XMEGA serial driver stream functions (thanks to William Patterson).
[pub/USBasp.git] / Demos / Host / LowLevel / MouseHostWithParser / HIDReport.c
index 327ae45..0c90f7a 100644 (file)
@@ -1,24 +1,24 @@
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2010.
-              
+     Copyright (C) Dean Camera, 2014.
+
   dean [at] fourwalledcubicle [dot] com
-      www.fourwalledcubicle.com
+           www.lufa-lib.org
 */
 
 /*
-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2014  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
-  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
-  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
+  The author disclaims all warranties with regard to this
   software, including all implied warranties of merchantability
   and fitness.  In no event shall the author be liable for any
   special, indirect or consequential damages or any damages
@@ -40,18 +40,18 @@ HID_ReportInfo_t HIDReportInfo;
 /** Function to read in the HID report descriptor from the attached device, and process it into easy-to-read
  *  structures via the HID parser routines in the LUFA library.
  *
- *  \return  A value from the MouseHostWithParser_GetHIDReportDataCodes_t enum
+ *  \return  A value from the \ref MouseHostWithParser_GetHIDReportDataCodes_t enum
  */
 uint8_t GetHIDReportData(void)
 {
        /* Create a buffer big enough to hold the entire returned HID report */
        uint8_t HIDReportData[HIDReportSize];
-       
+
        USB_ControlRequest = (USB_Request_Header_t)
                {
                        .bmRequestType = (REQDIR_DEVICETOHOST | REQTYPE_STANDARD | REQREC_INTERFACE),
                        .bRequest      = REQ_GetDescriptor,
-                       .wValue        = (DTYPE_Report << 8),
+                       .wValue        = (HID_DTYPE_Report << 8),
                        .wIndex        = 0,
                        .wLength       = HIDReportSize,
                };
@@ -66,7 +66,7 @@ uint8_t GetHIDReportData(void)
        /* Send the HID report to the parser for processing */
        if (USB_ProcessHIDReport(HIDReportData, HIDReportSize, &HIDReportInfo) != HID_PARSE_Successful)
          return ParseError;
-       
+
        return ParseSuccessful;
 }
 
@@ -77,7 +77,7 @@ uint8_t GetHIDReportData(void)
  *
  *  \param[in] CurrentItem  Pointer to the item the HID report parser is currently working with
  *
- *  \return Boolean true if the item should be stored into the HID report structure, false if it should be discarded
+ *  \return Boolean \c true if the item should be stored into the HID report structure, \c false if it should be discarded
  */
 bool CALLBACK_HIDParser_FilterHIDReportItem(HID_ReportItem_t* const CurrentItem)
 {
@@ -100,7 +100,7 @@ bool CALLBACK_HIDParser_FilterHIDReportItem(HID_ReportItem_t* const CurrentItem)
        /* If a collection with the mouse usage was not found, indicate that we are not interested in this item */
        if (!IsMouse)
          return false;
-  
+
        /* Check the attributes of the current mouse item - see if we are interested in it or not;
         * only store BUTTON and GENERIC_DESKTOP_CONTROL items into the Processed HID Report
         * structure to save RAM and ignore the rest
@@ -108,3 +108,4 @@ bool CALLBACK_HIDParser_FilterHIDReportItem(HID_ReportItem_t* const CurrentItem)
        return ((CurrentItem->Attributes.Usage.Page == USAGE_PAGE_BUTTON) ||
                (CurrentItem->Attributes.Usage.Page == USAGE_PAGE_GENERIC_DCTRL));
 }
+