X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/d6e3259f8bd0daadb8d6a01017cfab00cd73f17b..de8313cd9b7ac44b83a819ea7d4c1a00d16da7e4:/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 16cfc2317..13f68a045 100644 --- a/LUFA/Drivers/USB/Class/Host/HIDParser.h +++ b/LUFA/Drivers/USB/Class/Host/HIDParser.h @@ -1,21 +1,21 @@ /* LUFA Library - Copyright (C) Dean Camera, 2009. + Copyright (C) Dean Camera, 2010. dean [at] fourwalledcubicle [dot] com www.fourwalledcubicle.com */ /* - Copyright 2009 Dean Camera (dean [at] fourwalledcubicle [dot] com) + Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com) - Permission to use, copy, modify, and distribute this software - and its documentation for any purpose and without fee is hereby - granted, 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 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 + 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 software without specific, written prior permission. The author disclaim all warranties with regard to this @@ -29,10 +29,11 @@ */ /** \file + * \brief USB Human Interface Device (HID) Class report descriptor parser. * - * USB Human Interface Device (HID) Class report descriptor processing routines. This file allows for the easy - * parsing of the complex HID report descriptor, which describes the data that the device transmits to the host. - * + * This file allows for the easy parsing of complex HID report descriptors, which describes the data that + * 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 @@ -57,6 +58,10 @@ #ifndef __HIDPARSER_H__ #define __HIDPARSER_H__ + /* Macros: */ + #define __INCLUDE_FROM_USB_DRIVER + #define __INCLUDE_FROM_HID_DRIVER + /* Includes: */ #include #include @@ -133,7 +138,7 @@ * * \return Left-aligned data of the given report item's pre-retrived value for the given datatype */ - #define HID_ALIGN_DATA(reportitem, type) ((type)(reportitem->Value << (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: */ /* Enums: */ @@ -152,28 +157,39 @@ }; /* Type Defines: */ - /** 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). + */ typedef struct { uint32_t Minimum; /**< Minimum value for the attribute. */ uint32_t Maximum; /**< Maximum value for the attribute. */ } HID_MinMax_t; - /** Type define for the Unit attributes of a report item. */ + /** \brief HID Parser Report Item Unit Structure. + * + * Type define for the Unit attributes of a report item. + */ typedef struct { 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; - /** 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. + */ typedef struct { uint16_t Page; /**< Usage page of the report item. */ uint16_t Usage; /**< Usage of the report item. */ } HID_Usage_t; - /** Type define for a COLLECTION object. Contains the collection attributes and a reference to the + /** \brief HID Parser Report Item Collection Path Structure. + * + * Type define for a COLLECTION object. Contains the collection attributes and a reference to the * parent collection if any. */ typedef struct CollectionPath @@ -183,7 +199,10 @@ struct CollectionPath* Parent; /**< Reference to parent collection, or NULL if root collection. */ } HID_CollectionPath_t; - /** Type define for all the data attributes of a report item, except flags. */ + /** \brief HID Parser Report Item Attributes Structure. + * + * Type define for all the data attributes of a report item, except flags. + */ typedef struct { uint8_t BitSize; /**< Size in bits of the report item's data. */ @@ -194,31 +213,42 @@ HID_MinMax_t Physical; /**< Physical minimum and maximum of the report item. */ } HID_ReportItem_Attributes_t; - /** Type define for a report item (IN, OUT or FEATURE) 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. + */ typedef struct { uint16_t BitOffset; /**< Bit offset in the IN, OUT or FEATURE report of the item. */ - uint8_t ItemType; /**< Report item type, a value in HID_Types_t. */ + uint8_t ItemType; /**< Report item type, a value in HID_ReportItemTypes_t. */ uint16_t ItemFlags; /**< Item data flags, such as constant/variable, etc. */ uint8_t ReportID; /**< Report ID this item belongs to, or 0x00 if device has only one report */ 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. */ + 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. */ } HID_ReportItem_t; - /** Type define for a report item size information structure */ + /** \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 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 */ } HID_ReportSizeInfo_t; - /** Type define for a complete processed HID report, including all report item data and collections. */ + /** \brief HID Parser State Structure. + * + * Type define for a complete processed HID report, including all report item data and collections. + */ typedef struct { uint8_t TotalReportItems; /**< Total number of report items stored in the