631 lines
		
	
	
		
			23 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			631 lines
		
	
	
		
			23 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
| /* 
 | |
|  * Copyright 2012 Jun Wako <wakojun@gmail.com>
 | |
|  * This file is based on:
 | |
|  *     LUFA-120219/Demos/Device/Lowlevel/KeyboardMouse
 | |
|  *     LUFA-120219/Demos/Device/Lowlevel/GenericHID
 | |
|  */
 | |
| 
 | |
| /*
 | |
|              LUFA Library
 | |
|      Copyright (C) Dean Camera, 2012.
 | |
| 
 | |
|   dean [at] fourwalledcubicle [dot] com
 | |
|            www.lufa-lib.org
 | |
| */
 | |
| 
 | |
| /*
 | |
|   Copyright 2012  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 | |
|   Copyright 2010  Denver Gingerich (denver [at] ossguy [dot] com)
 | |
| 
 | |
|   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
 | |
|   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.
 | |
| */
 | |
| 
 | |
| #include "util.h"
 | |
| #include "report.h"
 | |
| #include "descriptor.h"
 | |
| 
 | |
| 
 | |
| /*******************************************************************************
 | |
|  * HID Report Descriptors
 | |
|  ******************************************************************************/
 | |
| const USB_Descriptor_HIDReport_Datatype_t PROGMEM KeyboardReport[] =
 | |
| {
 | |
|     HID_RI_USAGE_PAGE(8, 0x01), /* Generic Desktop */
 | |
|     HID_RI_USAGE(8, 0x06), /* Keyboard */
 | |
|     HID_RI_COLLECTION(8, 0x01), /* Application */
 | |
|         HID_RI_USAGE_PAGE(8, 0x07), /* Key Codes */
 | |
|         HID_RI_USAGE_MINIMUM(8, 0xE0), /* Keyboard Left Control */
 | |
|         HID_RI_USAGE_MAXIMUM(8, 0xE7), /* Keyboard Right GUI */
 | |
|         HID_RI_LOGICAL_MINIMUM(8, 0x00),
 | |
|         HID_RI_LOGICAL_MAXIMUM(8, 0x01),
 | |
|         HID_RI_REPORT_COUNT(8, 0x08),
 | |
|         HID_RI_REPORT_SIZE(8, 0x01),
 | |
|         HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE),
 | |
| 
 | |
|         HID_RI_REPORT_COUNT(8, 0x01),
 | |
|         HID_RI_REPORT_SIZE(8, 0x08),
 | |
|         HID_RI_INPUT(8, HID_IOF_CONSTANT),  /* reserved */
 | |
| 
 | |
|         HID_RI_USAGE_PAGE(8, 0x08), /* LEDs */
 | |
|         HID_RI_USAGE_MINIMUM(8, 0x01), /* Num Lock */
 | |
|         HID_RI_USAGE_MAXIMUM(8, 0x05), /* Kana */
 | |
|         HID_RI_REPORT_COUNT(8, 0x05),
 | |
|         HID_RI_REPORT_SIZE(8, 0x01),
 | |
|         HID_RI_OUTPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE | HID_IOF_NON_VOLATILE),
 | |
|         HID_RI_REPORT_COUNT(8, 0x01),
 | |
|         HID_RI_REPORT_SIZE(8, 0x03),
 | |
|         HID_RI_OUTPUT(8, HID_IOF_CONSTANT),
 | |
| 
 | |
|         HID_RI_USAGE_PAGE(8, 0x07), /* Keyboard */
 | |
|         HID_RI_USAGE_MINIMUM(8, 0x00), /* Reserved (no event indicated) */
 | |
|         HID_RI_USAGE_MAXIMUM(8, 0xFF), /* Keyboard Application */
 | |
|         HID_RI_LOGICAL_MINIMUM(8, 0x00),
 | |
|         HID_RI_LOGICAL_MAXIMUM(8, 0xFF),
 | |
|         HID_RI_REPORT_COUNT(8, 0x06),
 | |
|         HID_RI_REPORT_SIZE(8, 0x08),
 | |
|         HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_ARRAY | HID_IOF_ABSOLUTE),
 | |
|     HID_RI_END_COLLECTION(0),
 | |
| };
 | |
| 
 | |
| #ifdef MOUSE_ENABLE
 | |
| const USB_Descriptor_HIDReport_Datatype_t PROGMEM MouseReport[] =
 | |
| {
 | |
|     HID_RI_USAGE_PAGE(8, 0x01), /* Generic Desktop */
 | |
|     HID_RI_USAGE(8, 0x02), /* Mouse */
 | |
|     HID_RI_COLLECTION(8, 0x01), /* Application */
 | |
|         HID_RI_USAGE(8, 0x01), /* Pointer */
 | |
|         HID_RI_COLLECTION(8, 0x00), /* Physical */
 | |
| 
 | |
|             HID_RI_USAGE_PAGE(8, 0x09), /* Button */
 | |
|             HID_RI_USAGE_MINIMUM(8, 0x01),  /* Button 1 */
 | |
|             HID_RI_USAGE_MAXIMUM(8, 0x05),  /* Button 5 */
 | |
|             HID_RI_LOGICAL_MINIMUM(8, 0x00),
 | |
|             HID_RI_LOGICAL_MAXIMUM(8, 0x01),
 | |
|             HID_RI_REPORT_COUNT(8, 0x05),
 | |
|             HID_RI_REPORT_SIZE(8, 0x01),
 | |
|             HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE),
 | |
|             HID_RI_REPORT_COUNT(8, 0x01),
 | |
|             HID_RI_REPORT_SIZE(8, 0x03),
 | |
|             HID_RI_INPUT(8, HID_IOF_CONSTANT),
 | |
| 
 | |
|             HID_RI_USAGE_PAGE(8, 0x01), /* Generic Desktop */
 | |
|             HID_RI_USAGE(8, 0x30), /* Usage X */
 | |
|             HID_RI_USAGE(8, 0x31), /* Usage Y */
 | |
|             HID_RI_LOGICAL_MINIMUM(8, -127),
 | |
|             HID_RI_LOGICAL_MAXIMUM(8, 127),
 | |
|             HID_RI_REPORT_COUNT(8, 0x02),
 | |
|             HID_RI_REPORT_SIZE(8, 0x08),
 | |
|             HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_RELATIVE),
 | |
| 
 | |
|             HID_RI_USAGE(8, 0x38), /* Wheel */
 | |
|             HID_RI_LOGICAL_MINIMUM(8, -127),
 | |
|             HID_RI_LOGICAL_MAXIMUM(8, 127),
 | |
|             HID_RI_REPORT_COUNT(8, 0x01),
 | |
|             HID_RI_REPORT_SIZE(8, 0x08),
 | |
|             HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_RELATIVE),
 | |
| 
 | |
|             HID_RI_USAGE_PAGE(8, 0x0C), /* Consumer */
 | |
|             HID_RI_USAGE(16, 0x0238), /* AC Pan (Horizontal wheel) */
 | |
|             HID_RI_LOGICAL_MINIMUM(8, -127),
 | |
|             HID_RI_LOGICAL_MAXIMUM(8, 127),
 | |
|             HID_RI_REPORT_COUNT(8, 0x01),
 | |
|             HID_RI_REPORT_SIZE(8, 0x08),
 | |
|             HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_RELATIVE),
 | |
| 
 | |
|         HID_RI_END_COLLECTION(0),
 | |
|     HID_RI_END_COLLECTION(0),
 | |
| };
 | |
| #endif
 | |
| 
 | |
| #ifdef EXTRAKEY_ENABLE
 | |
| const USB_Descriptor_HIDReport_Datatype_t PROGMEM ExtrakeyReport[] =
 | |
| {
 | |
|     HID_RI_USAGE_PAGE(8, 0x01), /* Generic Desktop */
 | |
|     HID_RI_USAGE(8, 0x80), /* System Control */
 | |
|     HID_RI_COLLECTION(8, 0x01), /* Application */
 | |
|         HID_RI_REPORT_ID(8, REPORT_ID_SYSTEM),
 | |
|         HID_RI_LOGICAL_MINIMUM(16, 0x0001),
 | |
|         HID_RI_LOGICAL_MAXIMUM(16, 0x00B7),
 | |
|         HID_RI_USAGE_MINIMUM(16, 0x0001), /* System Power Down */
 | |
|         HID_RI_USAGE_MAXIMUM(16, 0x00B7), /* System Display LCD Autoscale */
 | |
|         HID_RI_REPORT_SIZE(8, 16),
 | |
|         HID_RI_REPORT_COUNT(8, 1),
 | |
|         HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_ARRAY | HID_IOF_ABSOLUTE),
 | |
|     HID_RI_END_COLLECTION(0),
 | |
| 
 | |
|     HID_RI_USAGE_PAGE(8, 0x0C), /* Consumer */
 | |
|     HID_RI_USAGE(8, 0x01), /* Consumer Control */
 | |
|     HID_RI_COLLECTION(8, 0x01), /* Application */
 | |
|         HID_RI_REPORT_ID(8, REPORT_ID_CONSUMER),
 | |
|         HID_RI_LOGICAL_MINIMUM(16, 0x0001),
 | |
|         HID_RI_LOGICAL_MAXIMUM(16, 0x029C),
 | |
|         HID_RI_USAGE_MINIMUM(16, 0x0001), /* +10 */
 | |
|         HID_RI_USAGE_MAXIMUM(16, 0x029C), /* AC Distribute Vertically */
 | |
|         HID_RI_REPORT_SIZE(8, 16),
 | |
|         HID_RI_REPORT_COUNT(8, 1),
 | |
|         HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_ARRAY | HID_IOF_ABSOLUTE),
 | |
|     HID_RI_END_COLLECTION(0),
 | |
| };
 | |
| #endif
 | |
| 
 | |
| #ifdef CONSOLE_ENABLE
 | |
| const USB_Descriptor_HIDReport_Datatype_t PROGMEM ConsoleReport[] =
 | |
| {
 | |
|     HID_RI_USAGE_PAGE(16, 0xFF31), /* Vendor Page(PJRC Teensy compatible) */
 | |
|     HID_RI_USAGE(8, 0x74), /* Vendor Usage(PJRC Teensy compatible) */
 | |
|     HID_RI_COLLECTION(8, 0x01), /* Application */
 | |
|         HID_RI_USAGE(8, 0x75), /* Vendor Usage 0x75 */
 | |
|         HID_RI_LOGICAL_MINIMUM(8, 0x00),
 | |
|         HID_RI_LOGICAL_MAXIMUM(8, 0xFF),
 | |
|         HID_RI_REPORT_COUNT(8, CONSOLE_EPSIZE),
 | |
|         HID_RI_REPORT_SIZE(8, 0x08),
 | |
|         HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE),
 | |
|         HID_RI_USAGE(8, 0x76), /* Vendor Usage 0x76 */
 | |
|         HID_RI_LOGICAL_MINIMUM(8, 0x00),
 | |
|         HID_RI_LOGICAL_MAXIMUM(8, 0xFF),
 | |
|         HID_RI_REPORT_COUNT(8, CONSOLE_EPSIZE),
 | |
|         HID_RI_REPORT_SIZE(8, 0x08),
 | |
|         HID_RI_OUTPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE | HID_IOF_NON_VOLATILE),
 | |
|     HID_RI_END_COLLECTION(0),
 | |
| };
 | |
| #endif
 | |
| 
 | |
| #ifdef NKRO_ENABLE
 | |
| const USB_Descriptor_HIDReport_Datatype_t PROGMEM NKROReport[] =
 | |
| {
 | |
|     HID_RI_USAGE_PAGE(8, 0x01), /* Generic Desktop */
 | |
|     HID_RI_USAGE(8, 0x06), /* Keyboard */
 | |
|     HID_RI_COLLECTION(8, 0x01), /* Application */
 | |
|         HID_RI_USAGE_PAGE(8, 0x07), /* Key Codes */
 | |
|         HID_RI_USAGE_MINIMUM(8, 0xE0), /* Keyboard Left Control */
 | |
|         HID_RI_USAGE_MAXIMUM(8, 0xE7), /* Keyboard Right GUI */
 | |
|         HID_RI_LOGICAL_MINIMUM(8, 0x00),
 | |
|         HID_RI_LOGICAL_MAXIMUM(8, 0x01),
 | |
|         HID_RI_REPORT_COUNT(8, 0x08),
 | |
|         HID_RI_REPORT_SIZE(8, 0x01),
 | |
|         HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE),
 | |
| 
 | |
|         HID_RI_USAGE_PAGE(8, 0x08), /* LEDs */
 | |
|         HID_RI_USAGE_MINIMUM(8, 0x01), /* Num Lock */
 | |
|         HID_RI_USAGE_MAXIMUM(8, 0x05), /* Kana */
 | |
|         HID_RI_REPORT_COUNT(8, 0x05),
 | |
|         HID_RI_REPORT_SIZE(8, 0x01),
 | |
|         HID_RI_OUTPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE | HID_IOF_NON_VOLATILE),
 | |
|         HID_RI_REPORT_COUNT(8, 0x01),
 | |
|         HID_RI_REPORT_SIZE(8, 0x03),
 | |
|         HID_RI_OUTPUT(8, HID_IOF_CONSTANT),
 | |
| 
 | |
|         HID_RI_USAGE_PAGE(8, 0x07), /* Key Codes */
 | |
|         HID_RI_USAGE_MINIMUM(8, 0x00), /* Keyboard 0 */
 | |
|         HID_RI_USAGE_MAXIMUM(8, (NKRO_EPSIZE-1)*8-1), /* Keyboard Right GUI */
 | |
|         HID_RI_LOGICAL_MINIMUM(8, 0x00),
 | |
|         HID_RI_LOGICAL_MAXIMUM(8, 0x01),
 | |
|         HID_RI_REPORT_COUNT(8, (NKRO_EPSIZE-1)*8),
 | |
|         HID_RI_REPORT_SIZE(8, 0x01),
 | |
|         HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE),
 | |
|     HID_RI_END_COLLECTION(0),
 | |
| };
 | |
| #endif
 | |
| 
 | |
| /*******************************************************************************
 | |
|  * Device Descriptors
 | |
|  ******************************************************************************/
 | |
| const USB_Descriptor_Device_t PROGMEM DeviceDescriptor =
 | |
| {
 | |
|     .Header                 = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
 | |
| 
 | |
|     .USBSpecification       = VERSION_BCD(1,1,0),
 | |
|     .Class                  = USB_CSCP_NoDeviceClass,
 | |
|     .SubClass               = USB_CSCP_NoDeviceSubclass,
 | |
|     .Protocol               = USB_CSCP_NoDeviceProtocol,
 | |
| 
 | |
|     .Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
 | |
| 
 | |
|     /* specified in config.h */
 | |
|     .VendorID               = VENDOR_ID,
 | |
|     .ProductID              = PRODUCT_ID,
 | |
|     .ReleaseNumber          = DEVICE_VER,
 | |
| 
 | |
|     .ManufacturerStrIndex   = 0x01,
 | |
|     .ProductStrIndex        = 0x02,
 | |
|     .SerialNumStrIndex      = NO_DESCRIPTOR,
 | |
| 
 | |
|     .NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS
 | |
| };
 | |
| 
 | |
| /*******************************************************************************
 | |
|  * Configuration Descriptors
 | |
|  ******************************************************************************/
 | |
| const USB_Descriptor_Configuration_t PROGMEM ConfigurationDescriptor =
 | |
| {
 | |
|     .Config =
 | |
|         {
 | |
|             .Header                 = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},
 | |
| 
 | |
|             .TotalConfigurationSize = sizeof(USB_Descriptor_Configuration_t),
 | |
|             .TotalInterfaces        = TOTAL_INTERFACES,
 | |
| 
 | |
|             .ConfigurationNumber    = 1,
 | |
|             .ConfigurationStrIndex  = NO_DESCRIPTOR,
 | |
| 
 | |
|             .ConfigAttributes       = (USB_CONFIG_ATTR_RESERVED | USB_CONFIG_ATTR_REMOTEWAKEUP),
 | |
| 
 | |
|             .MaxPowerConsumption    = USB_CONFIG_POWER_MA(100)
 | |
|         },
 | |
| 
 | |
|     /*
 | |
|      * Keyboard
 | |
|      */
 | |
|     .Keyboard_Interface =
 | |
|         {
 | |
|             .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 | |
| 
 | |
|             .InterfaceNumber        = KEYBOARD_INTERFACE,
 | |
|             .AlternateSetting       = 0x00,
 | |
| 
 | |
|             .TotalEndpoints         = 1,
 | |
| 
 | |
|             .Class                  = HID_CSCP_HIDClass,
 | |
|             .SubClass               = HID_CSCP_BootSubclass,
 | |
|             .Protocol               = HID_CSCP_KeyboardBootProtocol,
 | |
| 
 | |
|             .InterfaceStrIndex      = NO_DESCRIPTOR
 | |
|         },
 | |
| 
 | |
|     .Keyboard_HID =
 | |
|         {
 | |
|             .Header                 = {.Size = sizeof(USB_HID_Descriptor_HID_t), .Type = HID_DTYPE_HID},
 | |
| 
 | |
|             .HIDSpec                = VERSION_BCD(1,1,1),
 | |
|             .CountryCode            = 0x00,
 | |
|             .TotalReportDescriptors = 1,
 | |
|             .HIDReportType          = HID_DTYPE_Report,
 | |
|             .HIDReportLength        = sizeof(KeyboardReport)
 | |
|         },
 | |
| 
 | |
|     .Keyboard_INEndpoint =
 | |
|         {
 | |
|             .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 | |
| 
 | |
|             .EndpointAddress        = (ENDPOINT_DIR_IN | KEYBOARD_IN_EPNUM),
 | |
|             .Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 | |
|             .EndpointSize           = KEYBOARD_EPSIZE,
 | |
|             .PollingIntervalMS      = 0x0A
 | |
|         },
 | |
| 
 | |
|     /*
 | |
|      * Mouse
 | |
|      */
 | |
| #ifdef MOUSE_ENABLE
 | |
|     .Mouse_Interface =
 | |
|         {
 | |
|             .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 | |
| 
 | |
|             .InterfaceNumber        = MOUSE_INTERFACE,
 | |
|             .AlternateSetting       = 0x00,
 | |
| 
 | |
|             .TotalEndpoints         = 1,
 | |
| 
 | |
|             .Class                  = HID_CSCP_HIDClass,
 | |
|             .SubClass               = HID_CSCP_BootSubclass,
 | |
|             .Protocol               = HID_CSCP_MouseBootProtocol,
 | |
| 
 | |
|             .InterfaceStrIndex      = NO_DESCRIPTOR
 | |
|         },
 | |
| 
 | |
|     .Mouse_HID =
 | |
|         {
 | |
|             .Header                 = {.Size = sizeof(USB_HID_Descriptor_HID_t), .Type = HID_DTYPE_HID},
 | |
| 
 | |
|             .HIDSpec                = VERSION_BCD(1,1,1),
 | |
|             .CountryCode            = 0x00,
 | |
|             .TotalReportDescriptors = 1,
 | |
|             .HIDReportType          = HID_DTYPE_Report,
 | |
|             .HIDReportLength        = sizeof(MouseReport)
 | |
|         },
 | |
| 
 | |
|     .Mouse_INEndpoint =
 | |
|         {
 | |
|             .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 | |
| 
 | |
|             .EndpointAddress        = (ENDPOINT_DIR_IN | MOUSE_IN_EPNUM),
 | |
|             .Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 | |
|             .EndpointSize           = MOUSE_EPSIZE,
 | |
|             .PollingIntervalMS      = 0x0A
 | |
|         },
 | |
| #endif
 | |
| 
 | |
|     /*
 | |
|      * Extra
 | |
|      */
 | |
| #ifdef EXTRAKEY_ENABLE
 | |
|     .Extrakey_Interface =
 | |
|         {
 | |
|             .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 | |
| 
 | |
|             .InterfaceNumber        = EXTRAKEY_INTERFACE,
 | |
|             .AlternateSetting       = 0x00,
 | |
| 
 | |
|             .TotalEndpoints         = 1,
 | |
| 
 | |
|             .Class                  = HID_CSCP_HIDClass,
 | |
|             .SubClass               = HID_CSCP_NonBootSubclass,
 | |
|             .Protocol               = HID_CSCP_NonBootProtocol,
 | |
| 
 | |
|             .InterfaceStrIndex      = NO_DESCRIPTOR
 | |
|         },
 | |
| 
 | |
|     .Extrakey_HID =
 | |
|         {
 | |
|             .Header                 = {.Size = sizeof(USB_HID_Descriptor_HID_t), .Type = HID_DTYPE_HID},
 | |
| 
 | |
|             .HIDSpec                = VERSION_BCD(1,1,1),
 | |
|             .CountryCode            = 0x00,
 | |
|             .TotalReportDescriptors = 1,
 | |
|             .HIDReportType          = HID_DTYPE_Report,
 | |
|             .HIDReportLength        = sizeof(ExtrakeyReport)
 | |
|         },
 | |
| 
 | |
|     .Extrakey_INEndpoint =
 | |
|         {
 | |
|             .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 | |
| 
 | |
|             .EndpointAddress        = (ENDPOINT_DIR_IN | EXTRAKEY_IN_EPNUM),
 | |
|             .Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 | |
|             .EndpointSize           = EXTRAKEY_EPSIZE,
 | |
|             .PollingIntervalMS      = 0x0A
 | |
|         },
 | |
| #endif
 | |
| 
 | |
|     /*
 | |
|      * Console
 | |
|      */
 | |
| #ifdef CONSOLE_ENABLE
 | |
|     .Console_Interface =
 | |
|         {
 | |
|             .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 | |
| 
 | |
|             .InterfaceNumber        = CONSOLE_INTERFACE,
 | |
|             .AlternateSetting       = 0x00,
 | |
| 
 | |
|             .TotalEndpoints         = 2,
 | |
| 
 | |
|             .Class                  = HID_CSCP_HIDClass,
 | |
|             .SubClass               = HID_CSCP_NonBootSubclass,
 | |
|             .Protocol               = HID_CSCP_NonBootProtocol,
 | |
| 
 | |
|             .InterfaceStrIndex      = NO_DESCRIPTOR
 | |
|         },
 | |
| 
 | |
|     .Console_HID =
 | |
|         {
 | |
|             .Header                 = {.Size = sizeof(USB_HID_Descriptor_HID_t), .Type = HID_DTYPE_HID},
 | |
| 
 | |
|             .HIDSpec                = VERSION_BCD(1,1,1),
 | |
|             .CountryCode            = 0x00,
 | |
|             .TotalReportDescriptors = 1,
 | |
|             .HIDReportType          = HID_DTYPE_Report,
 | |
|             .HIDReportLength        = sizeof(ConsoleReport)
 | |
|         },
 | |
| 
 | |
|     .Console_INEndpoint =
 | |
|         {
 | |
|             .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 | |
| 
 | |
|             .EndpointAddress        = (ENDPOINT_DIR_IN | CONSOLE_IN_EPNUM),
 | |
|             .Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 | |
|             .EndpointSize           = CONSOLE_EPSIZE,
 | |
|             .PollingIntervalMS      = 0x01
 | |
|         },
 | |
| 
 | |
|     .Console_OUTEndpoint =
 | |
|         {
 | |
|             .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 | |
| 
 | |
|             .EndpointAddress        = (ENDPOINT_DIR_OUT | CONSOLE_OUT_EPNUM),
 | |
|             .Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 | |
|             .EndpointSize           = CONSOLE_EPSIZE,
 | |
|             .PollingIntervalMS      = 0x01
 | |
|         },
 | |
| #endif
 | |
| 
 | |
|     /*
 | |
|      * NKRO
 | |
|      */
 | |
| #ifdef NKRO_ENABLE
 | |
|     .NKRO_Interface =
 | |
|         {
 | |
|             .Header                 = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 | |
| 
 | |
|             .InterfaceNumber        = NKRO_INTERFACE,
 | |
|             .AlternateSetting       = 0x00,
 | |
| 
 | |
|             .TotalEndpoints         = 1,
 | |
| 
 | |
|             .Class                  = HID_CSCP_HIDClass,
 | |
|             .SubClass               = HID_CSCP_NonBootSubclass,
 | |
|             .Protocol               = HID_CSCP_NonBootProtocol,
 | |
| 
 | |
|             .InterfaceStrIndex      = NO_DESCRIPTOR
 | |
|         },
 | |
| 
 | |
|     .NKRO_HID =
 | |
|         {
 | |
|             .Header                 = {.Size = sizeof(USB_HID_Descriptor_HID_t), .Type = HID_DTYPE_HID},
 | |
| 
 | |
|             .HIDSpec                = VERSION_BCD(1,1,1),
 | |
|             .CountryCode            = 0x00,
 | |
|             .TotalReportDescriptors = 1,
 | |
|             .HIDReportType          = HID_DTYPE_Report,
 | |
|             .HIDReportLength        = sizeof(NKROReport)
 | |
|         },
 | |
| 
 | |
|     .NKRO_INEndpoint =
 | |
|         {
 | |
|             .Header                 = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
 | |
| 
 | |
|             .EndpointAddress        = (ENDPOINT_DIR_IN | NKRO_IN_EPNUM),
 | |
|             .Attributes             = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
 | |
|             .EndpointSize           = NKRO_EPSIZE,
 | |
|             .PollingIntervalMS      = 0x01
 | |
|         },
 | |
| #endif
 | |
| };
 | |
| 
 | |
| 
 | |
| /*******************************************************************************
 | |
|  * String Descriptors
 | |
|  ******************************************************************************/
 | |
| const USB_Descriptor_String_t PROGMEM LanguageString =
 | |
| {
 | |
|     .Header                 = {.Size = USB_STRING_LEN(1), .Type = DTYPE_String},
 | |
| 
 | |
|     .UnicodeString          = {LANGUAGE_ID_ENG}
 | |
| };
 | |
| 
 | |
| const USB_Descriptor_String_t PROGMEM ManufacturerString =
 | |
| {
 | |
|     /* subtract 1 for null terminator */
 | |
|     .Header                 = {.Size = USB_STRING_LEN(sizeof(STR(MANUFACTURER))-1), .Type = DTYPE_String},
 | |
| 
 | |
|     .UnicodeString          = LSTR(MANUFACTURER)
 | |
| };
 | |
| 
 | |
| const USB_Descriptor_String_t PROGMEM ProductString =
 | |
| {
 | |
|     /* subtract 1 for null terminator */
 | |
|     .Header                 = {.Size = USB_STRING_LEN(sizeof(STR(PRODUCT))-1), .Type = DTYPE_String},
 | |
| 
 | |
|     .UnicodeString          = LSTR(PRODUCT)
 | |
| };
 | |
| 
 | |
| 
 | |
| /** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
 | |
|  *  documentation) by the application code so that the address and size of a requested descriptor can be given
 | |
|  *  to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
 | |
|  *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
 | |
|  *  USB host.
 | |
|  */
 | |
| uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
 | |
|                                     const uint8_t wIndex,
 | |
|                                     const void** const DescriptorAddress)
 | |
| {
 | |
|     const uint8_t  DescriptorType   = (wValue >> 8);
 | |
|     const uint8_t  DescriptorIndex  = (wValue & 0xFF);
 | |
| 
 | |
|     const void* Address = NULL;
 | |
|     uint16_t    Size    = NO_DESCRIPTOR;
 | |
| 
 | |
|     switch (DescriptorType)
 | |
|     {
 | |
|         case DTYPE_Device:
 | |
|             Address = &DeviceDescriptor;
 | |
|             Size    = sizeof(USB_Descriptor_Device_t);
 | |
|             break;
 | |
|         case DTYPE_Configuration:
 | |
|             Address = &ConfigurationDescriptor;
 | |
|             Size    = sizeof(USB_Descriptor_Configuration_t);
 | |
|             break;
 | |
|         case DTYPE_String:
 | |
|             switch (DescriptorIndex )
 | |
|             {
 | |
|                 case 0x00:
 | |
|                     Address = &LanguageString;
 | |
|                     Size    = pgm_read_byte(&LanguageString.Header.Size);
 | |
|                     break;
 | |
|                 case 0x01:
 | |
|                     Address = &ManufacturerString;
 | |
|                     Size    = pgm_read_byte(&ManufacturerString.Header.Size);
 | |
|                     break;
 | |
|                 case 0x02:
 | |
|                     Address = &ProductString;
 | |
|                     Size    = pgm_read_byte(&ProductString.Header.Size);
 | |
|                     break;
 | |
|             }
 | |
|             break;
 | |
|         case HID_DTYPE_HID:
 | |
|             switch (wIndex) {
 | |
|             case KEYBOARD_INTERFACE:
 | |
|                 Address = &ConfigurationDescriptor.Keyboard_HID;
 | |
|                 Size    = sizeof(USB_HID_Descriptor_HID_t);
 | |
|                 break;
 | |
| #ifdef MOUSE_ENABLE
 | |
|             case MOUSE_INTERFACE:
 | |
|                 Address = &ConfigurationDescriptor.Mouse_HID;
 | |
|                 Size    = sizeof(USB_HID_Descriptor_HID_t);
 | |
|                 break;
 | |
| #endif
 | |
| #ifdef EXTRAKEY_ENABLE
 | |
|             case EXTRAKEY_INTERFACE:
 | |
|                 Address = &ConfigurationDescriptor.Extrakey_HID;
 | |
|                 Size    = sizeof(USB_HID_Descriptor_HID_t);
 | |
|                 break;
 | |
| #endif
 | |
| #ifdef CONSOLE_ENABLE
 | |
|             case CONSOLE_INTERFACE:
 | |
|                 Address = &ConfigurationDescriptor.Console_HID;
 | |
|                 Size    = sizeof(USB_HID_Descriptor_HID_t);
 | |
|                 break;
 | |
| #endif
 | |
| #ifdef NKRO_ENABLE
 | |
|             case NKRO_INTERFACE:
 | |
|                 Address = &ConfigurationDescriptor.NKRO_HID;
 | |
|                 Size    = sizeof(USB_HID_Descriptor_HID_t);
 | |
|                 break;
 | |
| #endif
 | |
|             }
 | |
|             break;
 | |
|         case HID_DTYPE_Report:
 | |
|             switch (wIndex) {
 | |
|             case KEYBOARD_INTERFACE:
 | |
|                 Address = &KeyboardReport;
 | |
|                 Size    = sizeof(KeyboardReport);
 | |
|                 break;
 | |
| #ifdef MOUSE_ENABLE
 | |
|             case MOUSE_INTERFACE:
 | |
|                 Address = &MouseReport;
 | |
|                 Size    = sizeof(MouseReport);
 | |
|                 break;
 | |
| #endif
 | |
| #ifdef EXTRAKEY_ENABLE
 | |
|             case EXTRAKEY_INTERFACE:
 | |
|                 Address = &ExtrakeyReport;
 | |
|                 Size    = sizeof(ExtrakeyReport);
 | |
|                 break;
 | |
| #endif
 | |
| #ifdef CONSOLE_ENABLE
 | |
|             case CONSOLE_INTERFACE:
 | |
|                 Address = &ConsoleReport;
 | |
|                 Size    = sizeof(ConsoleReport);
 | |
|                 break;
 | |
| #endif
 | |
| #ifdef NKRO_ENABLE
 | |
|             case NKRO_INTERFACE:
 | |
|                 Address = &NKROReport;
 | |
|                 Size    = sizeof(NKROReport);
 | |
|                 break;
 | |
| #endif
 | |
|             }
 | |
|             break;
 | |
|     }
 | |
| 
 | |
|     *DescriptorAddress = Address;
 | |
|     return Size;
 | |
| }
 |