|
|
|
/*
|
|
|
|
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.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef _KEYBOARD_HOST_H_
|
|
|
|
#define _KEYBOARD_HOST_H_
|
|
|
|
|
|
|
|
/* Includes: */
|
|
|
|
#include <avr/io.h>
|
|
|
|
#include <avr/wdt.h>
|
|
|
|
#include <avr/pgmspace.h>
|
|
|
|
#include <avr/power.h>
|
|
|
|
#include <stdio.h>
|
|
|
|
|
|
|
|
#include <LUFA/Version.h> // Library Version Information
|
|
|
|
#include <LUFA/Drivers/Misc/TerminalCodes.h> // ANSI Terminal Escape Codes
|
|
|
|
#include <LUFA/Drivers/USB/USB.h> // USB Functionality
|
|
|
|
#include <LUFA/Drivers/Peripheral/SerialStream.h> // Serial stream driver
|
|
|
|
#include <LUFA/Drivers/Board/LEDs.h> // LEDs driver
|
|
|
|
#include <LUFA/Scheduler/Scheduler.h> // Simple scheduler for task management
|
|
|
|
|
|
|
|
#include "ConfigDescriptor.h"
|
|
|
|
#include "HIDReport.h"
|
|
|
|
|
|
|
|
/* Macros: */
|
|
|
|
/** Pipe number for the keyboard report data pipe */
|
|
|
|
#define KEYBOARD_DATAPIPE 1
|
|
|
|
|
|
|
|
/* Enums: */
|
|
|
|
/** Enum for the possible status codes for passing to the UpdateStatus() function. */
|
|
|
|
enum KeyboardHostWithParser_StatusCodes_t
|
|
|
|
{
|
|
|
|
Status_USBNotReady = 0, /**< USB is not ready (disconnected from a USB device) */
|
|
|
|
Status_USBEnumerating = 1, /**< USB interface is enumerating */
|
|
|
|
Status_USBReady = 2, /**< USB interface is connected and ready */
|
|
|
|
Status_EnumerationError = 3, /**< Software error while enumerating the attached USB device */
|
|
|
|
Status_HardwareError = 4, /**< Hardware error while enumerating the attached USB device */
|
|
|
|
Status_Busy = 5, /**< Busy dumping HID report items to the serial port */
|
|
|
|
};
|
|
|
|
|
|
|
|
/* Task Definitions: */
|
|
|
|
TASK(USB_Keyboard_Host);
|
|
|
|
|
|
|
|
/* Event Handlers: */
|
|
|
|
HANDLES_EVENT(USB_DeviceAttached);
|
|
|
|
HANDLES_EVENT(USB_DeviceUnattached);
|
|
|
|
HANDLES_EVENT(USB_DeviceEnumerationComplete);
|
|
|
|
HANDLES_EVENT(USB_HostError);
|
|
|
|
HANDLES_EVENT(USB_DeviceEnumerationFailed);
|
|
|
|
|
|
|
|
/* Function Prototypes: */
|
|
|
|
void UpdateStatus(uint8_t CurrentStatus);
|
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
|
|
|
void ProcessKeyboardReport(uint8_t* KeyboardReport);
|
|
|
|
|
|
|
|
#endif
|