mirror of
https://github.com/qmk/qmk_firmware.git
synced 2025-06-08 18:10:07 +00:00
8f6b4ddf76
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.
122 lines
4.6 KiB
C
122 lines
4.6 KiB
C
/*
|
|
LUFA Library
|
|
Copyright (C) Dean Camera, 2009.
|
|
|
|
dean [at] fourwalledcubicle [dot] com
|
|
www.fourwalledcubicle.com
|
|
*/
|
|
|
|
/*
|
|
Copyright 2009 Denver Gingerich (denver [at] ossguy [dot] com)
|
|
Based on code by 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 Keyboard.c.
|
|
*/
|
|
|
|
#ifndef _KEYBOARD_H_
|
|
#define _KEYBOARD_H_
|
|
|
|
/* Includes: */
|
|
#include <avr/io.h>
|
|
#include <avr/wdt.h>
|
|
#include <avr/interrupt.h>
|
|
#include <avr/power.h>
|
|
#include <stdbool.h>
|
|
#include <string.h>
|
|
|
|
#include "Descriptors.h"
|
|
|
|
#include <LUFA/Version.h> // Library Version Information
|
|
#include <LUFA/Scheduler/Scheduler.h> // Simple scheduler for task management
|
|
#include <LUFA/Drivers/USB/USB.h> // USB Functionality
|
|
#include <LUFA/Drivers/Board/Joystick.h> // Joystick driver
|
|
#include <LUFA/Drivers/Board/LEDs.h> // LEDs driver
|
|
|
|
/* Macros: */
|
|
/** HID Class specific request to get the next HID report from the device. */
|
|
#define REQ_GetReport 0x01
|
|
|
|
/** HID Class specific request to get the idle timeout period of the device. */
|
|
#define REQ_GetIdle 0x02
|
|
|
|
/** HID Class specific request to send the next HID report to the device. */
|
|
#define REQ_SetReport 0x09
|
|
|
|
/** HID Class specific request to set the idle timeout period of the device. */
|
|
#define REQ_SetIdle 0x0A
|
|
|
|
/** HID Class specific request to get the current HID protocol in use, either report or boot. */
|
|
#define REQ_GetProtocol 0x03
|
|
|
|
/** HID Class specific request to set the current HID protocol in use, either report or boot. */
|
|
#define REQ_SetProtocol 0x0B
|
|
|
|
/* Task Definitions: */
|
|
TASK(USB_Keyboard_Report);
|
|
|
|
/* Type Defines: */
|
|
/** Type define for the keyboard HID report structure, for creating and sending HID reports to the host PC.
|
|
* This mirrors the layout described to the host in the HID report descriptor, in Descriptors.c.
|
|
*/
|
|
typedef struct
|
|
{
|
|
uint8_t Modifier; /**< Modifier mask byte, containing a mask of modifier keys set (such as shift or CTRL) */
|
|
uint8_t Reserved; /**< Reserved, always set as 0x00 */
|
|
uint8_t KeyCode[6]; /**< Array of up to six simultaneous key codes of pressed keys */
|
|
} USB_KeyboardReport_Data_t;
|
|
|
|
/* Enums: */
|
|
/** Enum for the possible status codes for passing to the UpdateStatus() function. */
|
|
enum Keyboard_StatusCodes_t
|
|
{
|
|
Status_USBNotReady = 0, /**< USB is not ready (disconnected from a USB host) */
|
|
Status_USBEnumerating = 1, /**< USB interface is enumerating */
|
|
Status_USBReady = 2, /**< USB interface is connected and ready */
|
|
};
|
|
|
|
/* Event Handlers: */
|
|
/** Indicates that this module will catch the USB_Connect event when thrown by the library. */
|
|
HANDLES_EVENT(USB_Connect);
|
|
|
|
/** Indicates that this module will catch the USB_Disconnect event when thrown by the library. */
|
|
HANDLES_EVENT(USB_Disconnect);
|
|
|
|
/** Indicates that this module will catch the USB_Reset event when thrown by the library. */
|
|
HANDLES_EVENT(USB_Reset);
|
|
|
|
/** Indicates that this module will catch the USB_ConfigurationChanged event when thrown by the library. */
|
|
HANDLES_EVENT(USB_ConfigurationChanged);
|
|
|
|
/** Indicates that this module will catch the USB_UnhandledControlPacket event when thrown by the library. */
|
|
HANDLES_EVENT(USB_UnhandledControlPacket);
|
|
|
|
/* Function Prototypes: */
|
|
void CreateKeyboardReport(USB_KeyboardReport_Data_t* ReportData);
|
|
void ProcessLEDReport(uint8_t LEDReport);
|
|
static inline void SendNextReport(void);
|
|
static inline void ReceiveNextReport(void);
|
|
void UpdateStatus(uint8_t CurrentStatus);
|
|
|
|
#endif
|