mirror of
				https://github.com/mfulz/qmk_firmware.git
				synced 2025-11-03 23:02:34 +01:00 
			
		
		
		
	Added brace guards to macros with parameters to prevent unintended changed evaluation of the macro expression. Minor code cleanups (remove redundant comments, fix spacing, etc.).
		
			
				
	
	
		
			116 lines
		
	
	
		
			4.3 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			116 lines
		
	
	
		
			4.3 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/power.h>
 | 
						|
		#include <stdbool.h>
 | 
						|
		#include <string.h>
 | 
						|
 | 
						|
		#include "Descriptors.h"
 | 
						|
 | 
						|
		#include <LUFA/Version.h>
 | 
						|
		#include <LUFA/Drivers/USB/USB.h>
 | 
						|
		#include <LUFA/Drivers/Board/Joystick.h>
 | 
						|
		#include <LUFA/Drivers/Board/Buttons.h>
 | 
						|
		#include <LUFA/Drivers/Board/LEDs.h>
 | 
						|
 | 
						|
	/* Macros: */
 | 
						|
		/** Idle period indicating that reports should be sent only when the inputs have changed */
 | 
						|
		#define HID_IDLE_CHANGESONLY      0
 | 
						|
 | 
						|
		/** 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
 | 
						|
 | 
						|
		/** LED mask for the library LED driver, to indicate that the USB interface is not ready. */
 | 
						|
		#define LEDMASK_USB_NOTREADY      LEDS_LED1
 | 
						|
 | 
						|
		/** LED mask for the library LED driver, to indicate that the USB interface is enumerating. */
 | 
						|
		#define LEDMASK_USB_ENUMERATING  (LEDS_LED2 | LEDS_LED3)
 | 
						|
 | 
						|
		/** LED mask for the library LED driver, to indicate that the USB interface is ready. */
 | 
						|
		#define LEDMASK_USB_READY        (LEDS_LED2 | LEDS_LED4)
 | 
						|
 | 
						|
		/** LED mask for the library LED driver, to indicate that an error has occurred in the USB interface. */
 | 
						|
		#define LEDMASK_USB_ERROR        (LEDS_LED1 | LEDS_LED3)
 | 
						|
 | 
						|
	/* 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;
 | 
						|
		
 | 
						|
	/* Function Prototypes: */
 | 
						|
		void SetupHardware(void);
 | 
						|
		void HID_Task(void);
 | 
						|
	
 | 
						|
		void EVENT_USB_Device_Connect(void);
 | 
						|
		void EVENT_USB_Device_Disconnect(void);
 | 
						|
		void EVENT_USB_Device_ConfigurationChanged(void);
 | 
						|
		void EVENT_USB_Device_UnhandledControlRequest(void);
 | 
						|
		void EVENT_USB_Device_StartOfFrame(void);
 | 
						|
 | 
						|
		void CreateKeyboardReport(USB_KeyboardReport_Data_t* ReportData);
 | 
						|
		void ProcessLEDReport(uint8_t LEDReport);
 | 
						|
		void SendNextReport(void);
 | 
						|
		void ReceiveNextReport(void);
 | 
						|
 | 
						|
#endif
 |