Oops - fix broken SPI driver due to missing bit inversion on a port mask.

[pub/USBasp.git] / LUFA / Drivers / USB / Class / Host / HIDParser.h

diff --git a/LUFA/Drivers/USB/Class/Host/HIDParser.h b/LUFA/Drivers/USB/Class/Host/HIDParser.h
index b3e5bde..ba73469 100644 (file)
--- a/LUFA/Drivers/USB/Class/Host/HIDParser.h
+++ b/LUFA/Drivers/USB/Class/Host/HIDParser.h
@@ -1,7 +1,7 @@
 /*
              LUFA Library
      Copyright (C) Dean Camera, 2010.
 /*
              LUFA Library
      Copyright (C) Dean Camera, 2010.

-              
+

   dean [at] fourwalledcubicle [dot] com
       www.fourwalledcubicle.com
 */
   dean [at] fourwalledcubicle [dot] com
       www.fourwalledcubicle.com
 */


@@ -9,13 +9,13 @@
 /*
   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


@@ -35,13 +35,13 @@
  *  a HID device transmits to the host. It also provides an easy API for extracting and processing the data
  *  elements inside a HID report sent from an attached HID device.
  */
  *  a HID device transmits to the host. It also provides an easy API for extracting and processing the data
  *  elements inside a HID report sent from an attached HID device.
  */

- 
+

 /** \ingroup Group_USB
  *  @defgroup Group_HIDParser HID Report Parser
  *
  *  \section Sec_Dependencies Module Source Dependencies
  *  The following files must be built with any user project that uses this module:
 /** \ingroup Group_USB
  *  @defgroup Group_HIDParser HID Report Parser
  *
  *  \section Sec_Dependencies Module Source Dependencies
  *  The following files must be built with any user project that uses this module:

- *    - LUFA/Drivers/USB/Class/Host/HIDParser.c
+ *    - LUFA/Drivers/USB/Class/Host/HIDParser.c <i>(Makefile source module name: LUFA_SRC_USB)</i>

  *
  *  \section Module Description
  *  Functions, macros, variables, enums and types related to the parsing of HID class device report descriptors.
  *
  *  \section Module Description
  *  Functions, macros, variables, enums and types related to the parsing of HID class device report descriptors.


@@ -86,7 +86,7 @@
                         */
                        #define HID_STATETABLE_STACK_DEPTH    2
                #endif
                         */
                        #define HID_STATETABLE_STACK_DEPTH    2
                #endif

-               
+

                #if !defined(HID_USAGE_STACK_DEPTH) || defined(__DOXYGEN__)
                        /** Constant indicating the maximum stack depth of the usage table. A larger usage table
                         *  allows for more USAGE items to be indicated sequentially for REPORT COUNT entries of more than
                #if !defined(HID_USAGE_STACK_DEPTH) || defined(__DOXYGEN__)
                        /** Constant indicating the maximum stack depth of the usage table. A larger usage table
                         *  allows for more USAGE items to be indicated sequentially for REPORT COUNT entries of more than


@@ -101,28 +101,28 @@
                #if !defined(HID_MAX_COLLECTIONS) || defined(__DOXYGEN__)
                        /** Constant indicating the maximum number of COLLECTION items (nested or unnested) that can be
                         *  processed in the report item descriptor. A large value allows for more COLLECTION items to be
                #if !defined(HID_MAX_COLLECTIONS) || defined(__DOXYGEN__)
                        /** Constant indicating the maximum number of COLLECTION items (nested or unnested) that can be
                         *  processed in the report item descriptor. A large value allows for more COLLECTION items to be

-                        *  processed, but consumes more memory. By default this is set to 5 collections, but this can be
+                        *  processed, but consumes more memory. By default this is set to 10 collections, but this can be

                         *  overridden by defining HID_MAX_COLLECTIONS to another value in the user project makefile, passing
                         *  the define to the compiler using the -D compiler switch.
                         */
                        #define HID_MAX_COLLECTIONS           10
                #endif
                         *  overridden by defining HID_MAX_COLLECTIONS to another value in the user project makefile, passing
                         *  the define to the compiler using the -D compiler switch.
                         */
                        #define HID_MAX_COLLECTIONS           10
                #endif

-               
+

                #if !defined(HID_MAX_REPORTITEMS) || defined(__DOXYGEN__)
                #if !defined(HID_MAX_REPORTITEMS) || defined(__DOXYGEN__)

-                       /** Constant indicating the maximum number of report items (IN, OUT or FEATURE) that can be processed 
+                       /** Constant indicating the maximum number of report items (IN, OUT or FEATURE) that can be processed

                         *  in the report item descriptor and stored in the user HID Report Info structure. A large value allows
                         *  in the report item descriptor and stored in the user HID Report Info structure. A large value allows

-                        *  for more report items to be stored, but consumes more memory. By default this is set to 20 items, 
+                        *  for more report items to be stored, but consumes more memory. By default this is set to 20 items,

                         *  but this can be overridden by defining HID_MAX_REPORTITEMS to another value in the user project
                         *  makefile, and passing the define to the compiler using the -D compiler switch.
                         */
                        #define HID_MAX_REPORTITEMS           20
                #endif
                         *  but this can be overridden by defining HID_MAX_REPORTITEMS to another value in the user project
                         *  makefile, and passing the define to the compiler using the -D compiler switch.
                         */
                        #define HID_MAX_REPORTITEMS           20
                #endif

-               
+

                #if !defined(HID_MAX_REPORT_IDS) || defined(__DOXYGEN__)
                        /** Constant indicating the maximum number of unique report IDs that can be processed in the report item
                         *  descriptor for the report size information array in the user HID Report Info structure. A large value
                         *  allows for more report ID report sizes to be stored, but consumes more memory. By default this is set
                #if !defined(HID_MAX_REPORT_IDS) || defined(__DOXYGEN__)
                        /** Constant indicating the maximum number of unique report IDs that can be processed in the report item
                         *  descriptor for the report size information array in the user HID Report Info structure. A large value
                         *  allows for more report ID report sizes to be stored, but consumes more memory. By default this is set

-                        *  to 5 items, but this can be overridden by defining HID_MAX_REPORT_IDS to another value in the user project
+                        *  to 10 items, but this can be overridden by defining HID_MAX_REPORT_IDS to another value in the user project

                         *  makefile, and passing the define to the compiler using the -D compiler switch. Note that IN, OUT and FEATURE
                         *  items sharing the same report ID consume only one size item in the array.
                         */
                         *  makefile, and passing the define to the compiler using the -D compiler switch. Note that IN, OUT and FEATURE
                         *  items sharing the same report ID consume only one size item in the array.
                         */


@@ -133,20 +133,20 @@
                 *  left-aligned to the given data type. This allows for signed data to be interpreted correctly, by shifting the data
                 *  leftwards until the data's sign bit is in the correct position.
                 *
                 *  left-aligned to the given data type. This allows for signed data to be interpreted correctly, by shifting the data
                 *  leftwards until the data's sign bit is in the correct position.
                 *

-                *  \param[in] reportitem  HID Report Item whose retrieved value is to be aligned
-                *  \param[in] type        Data type to align the HID report item's value to
+                *  \param[in] ReportItem  HID Report Item whose retrieved value is to be aligned.
+                *  \param[in] Type        Data type to align the HID report item's value to.

                 *
                 *

-                *  \return Left-aligned data of the given report item's pre-retrived value for the given datatype
+                *  \return Left-aligned data of the given report item's pre-retrieved value for the given datatype.

                 */
                 */

-               #define HID_ALIGN_DATA(reportitem, type) ((type)(reportitem->Value << ((8 * sizeof(type)) - reportitem->Attributes.BitSize)))
+               #define HID_ALIGN_DATA(ReportItem, Type) ((Type)(ReportItem->Value << ((8 * sizeof(Type)) - ReportItem->Attributes.BitSize)))

 
        /* Public Interface - May be used in end-application: */
 
        /* Public Interface - May be used in end-application: */

-               /* Enums: */                    
+               /* Enums: */

                        /** Enum for the possible error codes in the return value of the \ref USB_ProcessHIDReport() function. */
                        enum HID_Parse_ErrorCodes_t
                        {
                                HID_PARSE_Successful                  = 0, /**< Successful parse of the HID report descriptor, no error. */
                        /** Enum for the possible error codes in the return value of the \ref USB_ProcessHIDReport() function. */
                        enum HID_Parse_ErrorCodes_t
                        {
                                HID_PARSE_Successful                  = 0, /**< Successful parse of the HID report descriptor, no error. */

-                               HID_PARSE_HIDStackOverflow            = 1, /**< More than \ref HID_STATETABLE_STACK_DEPTH nested PUSHes in the report. */ 
+                               HID_PARSE_HIDStackOverflow            = 1, /**< More than \ref HID_STATETABLE_STACK_DEPTH nested PUSHes in the report. */

                                HID_PARSE_HIDStackUnderflow           = 2, /**< A POP was found when the state table stack was empty. */
                                HID_PARSE_InsufficientReportItems     = 3, /**< More than \ref HID_MAX_REPORTITEMS report items in the report. */
                                HID_PARSE_UnexpectedEndCollection     = 4, /**< An END COLLECTION item found without matching COLLECTION item. */
                                HID_PARSE_HIDStackUnderflow           = 2, /**< A POP was found when the state table stack was empty. */
                                HID_PARSE_InsufficientReportItems     = 3, /**< More than \ref HID_MAX_REPORTITEMS report items in the report. */
                                HID_PARSE_UnexpectedEndCollection     = 4, /**< An END COLLECTION item found without matching COLLECTION item. */


@@ -155,8 +155,8 @@
                                HID_PARSE_InsufficientReportIDItems   = 7, /**< More than \ref HID_MAX_REPORT_IDS report IDs in the device. */
                                HID_PARSE_NoUnfilteredReportItems     = 8, /**< All report items from the device were filtered by the filtering callback routine. */
                        };
                                HID_PARSE_InsufficientReportIDItems   = 7, /**< More than \ref HID_MAX_REPORT_IDS report IDs in the device. */
                                HID_PARSE_NoUnfilteredReportItems     = 8, /**< All report items from the device were filtered by the filtering callback routine. */
                        };

-               
-               /* Type Defines: */             
+
+               /* Type Defines: */

                        /** \brief HID Parser Report Item Min/Max Structure.
                         *
                         *  Type define for an attribute with both minimum and maximum values (e.g. Logical Min/Max).
                        /** \brief HID Parser Report Item Min/Max Structure.
                         *
                         *  Type define for an attribute with both minimum and maximum values (e.g. Logical Min/Max).


@@ -176,7 +176,7 @@
                                uint32_t                     Type;     /**< Unit type (refer to HID specifications for details). */
                                uint8_t                      Exponent; /**< Unit exponent (refer to HID specifications for details). */
                        } HID_Unit_t;
                                uint32_t                     Type;     /**< Unit type (refer to HID specifications for details). */
                                uint8_t                      Exponent; /**< Unit exponent (refer to HID specifications for details). */
                        } HID_Unit_t;

-                       
+

                        /** \brief HID Parser Report Item Usage Structure.
                         *
                         *  Type define for the Usage attributes of a report item.
                        /** \brief HID Parser Report Item Usage Structure.
                         *
                         *  Type define for the Usage attributes of a report item.


@@ -206,13 +206,13 @@
                        typedef struct
                        {
                                uint8_t                      BitSize;  /**< Size in bits of the report item's data. */
                        typedef struct
                        {
                                uint8_t                      BitSize;  /**< Size in bits of the report item's data. */

-                               
+

                                HID_Usage_t                  Usage;    /**< Usage of the report item. */
                                HID_Unit_t                   Unit;     /**< Unit type and exponent of the report item. */
                                HID_MinMax_t                 Logical;  /**< Logical minimum and maximum of the report item. */
                                HID_MinMax_t                 Physical; /**< Physical minimum and maximum of the report item. */
                        } HID_ReportItem_Attributes_t;
                                HID_Usage_t                  Usage;    /**< Usage of the report item. */
                                HID_Unit_t                   Unit;     /**< Unit type and exponent of the report item. */
                                HID_MinMax_t                 Logical;  /**< Logical minimum and maximum of the report item. */
                                HID_MinMax_t                 Physical; /**< Physical minimum and maximum of the report item. */
                        } HID_ReportItem_Attributes_t;

-                       
+

                        /** \brief HID Parser Report Item Details Structure.
                         *
                         *  Type define for a report item (IN, OUT or FEATURE) layout attributes and other details.
                        /** \brief HID Parser Report Item Details Structure.
                         *
                         *  Type define for a report item (IN, OUT or FEATURE) layout attributes and other details.


@@ -226,22 +226,22 @@
                                HID_CollectionPath_t*        CollectionPath; /**< Collection path of the item. */
 
                                HID_ReportItem_Attributes_t  Attributes;     /**< Report item attributes. */
                                HID_CollectionPath_t*        CollectionPath; /**< Collection path of the item. */
 
                                HID_ReportItem_Attributes_t  Attributes;     /**< Report item attributes. */

-                                                       
+

                                uint32_t                     Value;          /**< Current value of the report item - use \ref HID_ALIGN_DATA() when processing
                                                                              *   a retrieved value so that it is aligned to a specific type.
                                                                              */
                                uint32_t                     Value;          /**< Current value of the report item - use \ref HID_ALIGN_DATA() when processing
                                                                              *   a retrieved value so that it is aligned to a specific type.
                                                                              */

-                               uint32_t                     PreviousValue;  /**< Previous value of the report item. */ 
+                               uint32_t                     PreviousValue;  /**< Previous value of the report item. */

                        } HID_ReportItem_t;
                        } HID_ReportItem_t;

-                       
+

                        /** \brief HID Parser Report Size Structure.
                         *
                         *  Type define for a report item size information structure, to retain the size of a device's reports by ID.
                         */
                        typedef struct
                        {
                        /** \brief HID Parser Report Size Structure.
                         *
                         *  Type define for a report item size information structure, to retain the size of a device's reports by ID.
                         */
                        typedef struct
                        {

-                               uint8_t                      ReportID; /**< Report ID of the report within the HID interface */
+                               uint8_t                      ReportID; /**< Report ID of the report within the HID interface. */

                                uint16_t                     ReportSizeBits[3]; /**< Total number of bits in each report type for the given Report ID,
                                uint16_t                     ReportSizeBits[3]; /**< Total number of bits in each report type for the given Report ID,

-                                                                                *   indexed by the \ref HID_ReportItemTypes_t enum
+                                                                                *   indexed by the \ref HID_ReportItemTypes_t enum.

                                                                                                                                 */
                        } HID_ReportSizeInfo_t;
 
                                                                                                                                 */
                        } HID_ReportSizeInfo_t;
 


@@ -267,33 +267,36 @@
                                                                              *   element in its HID report descriptor.
                                                                              */
                        } HID_ReportInfo_t;
                                                                              *   element in its HID report descriptor.
                                                                              */
                        } HID_ReportInfo_t;

-                       
+

                /* Function Prototypes: */
                        /** Function to process a given HID report returned from an attached device, and store it into a given
                         *  \ref HID_ReportInfo_t structure.
                         *
                /* Function Prototypes: */
                        /** Function to process a given HID report returned from an attached device, and store it into a given
                         *  \ref HID_ReportInfo_t structure.
                         *

-                        *  \param[in]  ReportData  Buffer containing the device's HID report table
-                        *  \param[in]  ReportSize  Size in bytes of the HID report table
-                        *  \param[out] ParserData  Pointer to a \ref HID_ReportInfo_t instance for the parser output
+                        *  \param[in]  ReportData  Buffer containing the device's HID report table.
+                        *  \param[in]  ReportSize  Size in bytes of the HID report table.
+                        *  \param[out] ParserData  Pointer to a \ref HID_ReportInfo_t instance for the parser output.

                         *
                         *

-                        *  \return A value in the \ref HID_Parse_ErrorCodes_t enum
+                        *  \return A value in the \ref HID_Parse_ErrorCodes_t enum.

                         */
                         */

-                       uint8_t USB_ProcessHIDReport(const uint8_t* ReportData, uint16_t ReportSize, HID_ReportInfo_t* const ParserData)
-                                                    ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
+                       uint8_t USB_ProcessHIDReport(const uint8_t* ReportData,
+                                                    uint16_t ReportSize,
+                                                    HID_ReportInfo_t* const ParserData) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);

 
                        /** Extracts the given report item's value out of the given HID report and places it into the Value
                         *  member of the report item's \ref HID_ReportItem_t structure.
                         *
 
                        /** Extracts the given report item's value out of the given HID report and places it into the Value
                         *  member of the report item's \ref HID_ReportItem_t structure.
                         *

-                        *  When called, this copies the report item's Value element to it's PreviousValue element for easy
-                        *  checking to see if an item's value has changed before processing a report.
+                        *  When called on a report with an item that exists in that report, this copies the report item's Value
+                        *  to it's PreviousValue element for easy checking to see if an item's value has changed before processing
+                        *  a report. If the given item does not exist in the report, the function does not modify the report item's
+                        *  data.

                         *
                         *

-                        *  \param[in]     ReportData  Buffer containing an IN or FEATURE report from an attached device
-                        *  \param[in,out] ReportItem  Pointer to the report item of interest in a \ref HID_ReportInfo_t ReportItem array
+                        *  \param[in]     ReportData  Buffer containing an IN or FEATURE report from an attached device.
+                        *  \param[in,out] ReportItem  Pointer to the report item of interest in a \ref HID_ReportInfo_t ReportItem array.

                         *
                         *

-                        *  \returns Boolean true if the item to retrieve was located in the given report, false otherwise
+                        *  \returns Boolean true if the item to retrieve was located in the given report, false otherwise.

                         */
                         */

-                       bool USB_GetHIDReportItemInfo(const uint8_t* ReportData, HID_ReportItem_t* const ReportItem)
-                                                     ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
+                       bool USB_GetHIDReportItemInfo(const uint8_t* ReportData,
+                                                     HID_ReportItem_t* const ReportItem) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);

 
                        /** Retrieves the given report item's value out of the Value member of the report item's
                         *  \ref HID_ReportItem_t structure and places it into the correct position in the HID report
 
                        /** Retrieves the given report item's value out of the Value member of the report item's
                         *  \ref HID_ReportItem_t structure and places it into the correct position in the HID report


@@ -305,22 +308,23 @@
                         *
                         *  If the device has multiple HID reports, the first byte in the report is set to the report ID of the given item.
                         *
                         *
                         *  If the device has multiple HID reports, the first byte in the report is set to the report ID of the given item.
                         *

-                        *  \param[out] ReportData  Buffer holding the current OUT or FEATURE report data
-                        *  \param[in]  ReportItem  Pointer to the report item of interest in a \ref HID_ReportInfo_t ReportItem array
+                        *  \param[out] ReportData  Buffer holding the current OUT or FEATURE report data.
+                        *  \param[in]  ReportItem  Pointer to the report item of interest in a \ref HID_ReportInfo_t ReportItem array.

                         */
                         */

-                       void USB_SetHIDReportItemInfo(uint8_t* ReportData, HID_ReportItem_t* const ReportItem)
-                                                     ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
-                                                                                 
+                       void USB_SetHIDReportItemInfo(uint8_t* ReportData,
+                                                     HID_ReportItem_t* const ReportItem) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
+

                        /** Retrieves the size of a given HID report in bytes from it's Report ID.
                         *
                        /** Retrieves the size of a given HID report in bytes from it's Report ID.
                         *

-                        *  \param[in] ParserData  Pointer to a \ref HID_ReportInfo_t instance containing the parser output
-                        *  \param[in] ReportID    Report ID of the report whose size is to be retrieved
+                        *  \param[in] ParserData  Pointer to a \ref HID_ReportInfo_t instance containing the parser output.
+                        *  \param[in] ReportID    Report ID of the report whose size is to be retrieved.

                         *  \param[in] ReportType  Type of the report whose size is to be determined, a valued from the
                         *  \param[in] ReportType  Type of the report whose size is to be determined, a valued from the

-                        *                         \ref HID_ReportItemTypes_t enum
+                        *                         \ref HID_ReportItemTypes_t enum.

                         *
                         *

-                        *  \return Size of the report in bytes, or 0 if the report does not exist
+                        *  \return Size of the report in bytes, or 0 if the report does not exist.

                         */
                         */

-                       uint16_t USB_GetHIDReportSize(HID_ReportInfo_t* const ParserData, const uint8_t ReportID,
+                       uint16_t USB_GetHIDReportSize(HID_ReportInfo_t* const ParserData,
+                                                     const uint8_t ReportID,

                                                      const uint8_t ReportType) ATTR_CONST ATTR_NON_NULL_PTR_ARG(1);
 
                        /** Callback routine for the HID Report Parser. This callback <b>must</b> be implemented by the user code when
                                                      const uint8_t ReportType) ATTR_CONST ATTR_NON_NULL_PTR_ARG(1);
 
                        /** Callback routine for the HID Report Parser. This callback <b>must</b> be implemented by the user code when


@@ -328,11 +332,11 @@
                         *  HID_ReportInfo_t structure. This can be used to filter only those items the application will be using, so that
                         *  no RAM is wasted storing the attributes for report items which will never be referenced by the application.
                         *
                         *  HID_ReportInfo_t structure. This can be used to filter only those items the application will be using, so that
                         *  no RAM is wasted storing the attributes for report items which will never be referenced by the application.
                         *

-                        *  \param[in] CurrentItem  Pointer to the current report item for user checking
+                        *  \param[in] CurrentItem  Pointer to the current report item for user checking.

                         *
                         *

-                        *  \return Boolean true if the item should be stored into the HID_ReportInfo_t structure, false if it should be ignored
+                        *  \return Boolean true if the item should be stored into the HID_ReportInfo_t structure, false if it should be ignored.

                         */
                         */

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

 
        /* Private Interface - For use in library only: */
        #if !defined(__DOXYGEN__)
 
        /* Private Interface - For use in library only: */
        #if !defined(__DOXYGEN__)


@@ -344,7 +348,7 @@
                                 uint8_t                     ReportID;
                        } HID_StateTable_t;
        #endif
                                 uint8_t                     ReportID;
                        } HID_StateTable_t;
        #endif

-                       
+

        /* Disable C linkage for C++ Compilers: */
                #if defined(__cplusplus)
                        }
        /* Disable C linkage for C++ Compilers: */
                #if defined(__cplusplus)
                        }


@@ -353,3 +357,4 @@
 #endif
 
 /** @} */
 #endif
 
 /** @} */

+