|
|
|
|
/*
|
|
|
|
|
LUFA Library
|
|
|
|
|
Copyright (C) Dean Camera, 2009.
|
|
|
|
|
|
|
|
|
|
dean [at] fourwalledcubicle [dot] com
|
|
|
|
|
www.fourwalledcubicle.com
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
Copyright 2009 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
|
|
|
|
|
software without specific, written prior permission.
|
|
|
|
|
|
|
|
|
|
The author disclaim 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
|
|
|
|
|
whatsoever resulting from loss of use, data or profits, whether
|
|
|
|
|
in an action of contract, negligence or other tortious action,
|
|
|
|
|
arising out of or in connection with the use or performance of
|
|
|
|
|
this software.
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
/** \file
|
|
|
|
|
*
|
|
|
|
|
* Header file for HIDReport.c.
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
#ifndef _HID_REPORT_H_
|
|
|
|
|
#define _HID_REPORT_H_
|
|
|
|
|
|
|
|
|
|
/* Includes: */
|
Fixed GenericHIDHost demo report write routine incorrect for control type requests (thanks to Andrei Krainev).
Removed Endpoint_ClearCurrentBank() and Pipe_ClearCurrentBank() in favour of new Endpoint_ClearIN(), Endpoint_ClearOUT(), Endpoint_ClearControlIN(), Endpoint_ClearControlOUT(), Pipe_ClearIN(), Pipe_ClearOUT(), Pipe_ClearControlIN() and Pipe_ClearControlOUT() macros (done to allow for the detection of packets of zero length).
Renamed *_ReadWriteAllowed() macros to *_IsReadWriteAllowed() to remain consistent with the rest of the LUFA API.
Endpoint_IsSetupReceived() macro has been renamed to Endpoint_IsSETUPReceived(), Endpoint_ClearSetupReceived() macro has been renamed to Endpoint_ClearControlSETUP(), the Pipe_IsSetupSent() macro has been renamed to Pipe_IsSETUPSent() and the Pipe_ClearSetupSent() macro is no longer applicable and should be removed - changes made to compliment the new endpoint and pipe bank management API.
Updated all demos, bootloaders and projects to use the new endpoint and pipe management APIs (thanks to Roman Thiel).
Updated library doxygen documentation, added groups, changed documentation macro functions to real functions for clarity.
Removed old endpoint and pipe aliased read/write/discard routines which did not have an explicit endian specifier for clarity.
Removed the ButtLoadTag.h header file, as no one used for its intended purpose anyway.
16 years ago
|
|
|
#include <LUFA/Drivers/USB/USB.h> // USB Functionality
|
|
|
|
|
|
|
|
|
|
#include "KeyboardHostWithParser.h"
|
|
|
|
|
|
|
|
|
|
/* Macros: */
|
|
|
|
|
/** HID Report Descriptor Usage Page value for a desktop keyboard */
|
|
|
|
|
#define USAGE_PAGE_KEYBOARD 0x07
|
|
|
|
|
|
|
|
|
|
/* Enums: */
|
|
|
|
|
/** Enum for the possible return codes of the GetHIDReportData() function. */
|
|
|
|
|
enum KeyboardHostWithParser_GetHIDReportDataCodes_t
|
|
|
|
|
{
|
|
|
|
|
ParseSuccessful = 0, /**< HID report descriptor parsed successfully */
|
|
|
|
|
ParseError = 1, /**< Failed to fully process the HID report descriptor */
|
|
|
|
|
ParseControlError = 2, /**< Control error occurred while trying to read the device HID descriptor */
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/* Type Defines: */
|
|
|
|
|
/** Type define for a HID descriptor. */
|
|
|
|
|
typedef struct
|
|
|
|
|
{
|
|
|
|
|
USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length */
|
|
|
|
|
|
|
|
|
|
uint16_t HIDSpec; /**< Implemented HID class specification, in BCD encoded format */
|
|
|
|
|
uint8_t CountryCode; /**< Country code value for localized hardware */
|
|
|
|
|
|
|
|
|
|
uint8_t TotalHIDReports; /**< Total number of HID report descriptors in the current interface */
|
|
|
|
|
|
|
|
|
|
uint8_t HIDReportType; /**< HID report type of the first HID report descriptor */
|
|
|
|
|
uint16_t HIDReportLength; /**< Total size in bytes of the first HID report descriptor */
|
|
|
|
|
} USB_Descriptor_HID_t;
|
|
|
|
|
|
|
|
|
|
/* External Variables: */
|
|
|
|
|
extern uint16_t HIDReportSize;
|
|
|
|
|
extern HID_ReportInfo_t HIDReportInfo;
|
|
|
|
|
|
|
|
|
|
/* Function Prototypes: */
|
|
|
|
|
uint8_t GetHIDReportData(void);
|
|
|
|
|
|
|
|
|
|
#endif
|
