X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Output%2FpjrcUSB%2Farm%2Fusb_desc.h;h=e3b6fb549d3869c098e21b48fa0af45409f958fb;hb=5f262ea4b68a07e9b94ce0a49c0f7196e5f32b3b;hp=acebf5f0271a6faf06e7960c5db8c166a8e42a40;hpb=8263589e7ee28c54c0d6e4a76bd59c5915606333;p=kiibohd-controller.git diff --git a/Output/pjrcUSB/arm/usb_desc.h b/Output/pjrcUSB/arm/usb_desc.h index acebf5f..e3b6fb5 100644 --- a/Output/pjrcUSB/arm/usb_desc.h +++ b/Output/pjrcUSB/arm/usb_desc.h @@ -1,6 +1,7 @@ /* Teensyduino Core Library * http://www.pjrc.com/teensy/ * Copyright (c) 2013 PJRC.COM, LLC. + * Modified by Jacob Alexander (2013-2015) * * Permission is hereby granted, free of charge, to any person obtaining * a copy of this software and associated documentation files (the @@ -10,10 +11,10 @@ * permit persons to whom the Software is furnished to do so, subject to * the following conditions: * - * 1. The above copyright notice and this permission notice shall be + * 1. The above copyright notice and this permission notice shall be * included in all copies or substantial portions of the Software. * - * 2. If the Software is incorporated into a build system that allows + * 2. If the Software is incorporated into a build system that allows * selection among a list of target devices, then similar target * devices manufactured by PJRC.COM must be included in the list of * target devices and selectable in the same manner. @@ -28,112 +29,99 @@ * SOFTWARE. */ -#ifndef _usb_desc_h_ -#define _usb_desc_h_ +#pragma once -// This header is NOT meant to be included when compiling -// user sketches in Arduino. The low-level functions -// provided by usb_dev.c are meant to be called only by -// code which provides higher-level interfaces to the user. +// ----- Includes ----- +// Compiler Includes #include #include -#include "output_com.h" - -#define ENDPOINT_UNUSED 0x00 -#define ENDPOINT_TRANSIMIT_ONLY 0x15 -#define ENDPOINT_RECEIVE_ONLY 0x19 -#define ENDPOINT_TRANSMIT_AND_RECEIVE 0x1D - -/* -To modify a USB Type to have different interfaces, start in this -file. Delete the XYZ_INTERFACE lines for any interfaces you -wish to remove, and copy them from another USB Type for any you -want to add. - -Give each interface a unique number, and edit NUM_INTERFACE to -reflect the number of interfaces. - -Within each interface, make sure it uses a unique set of endpoints. -Edit NUM_ENDPOINTS to be at least the largest endpoint number used. -Then edit the ENDPOINT*_CONFIG lines so each endpoint is configured -the proper way (transmit, receive, or both). - -The CONFIG_DESC_SIZE and any XYZ_DESC_OFFSET numbers must be -edited to the correct sizes. See usb_desc.c for the giant array -of bytes. Someday these may be done automatically..... (but how?) - -If you are using existing interfaces, the code in each file should -automatically adapt to the changes you specify. If you need to -create a new type of interface, you'll need to write the code which -sends and receives packets, and presents an API to the user. - -Finally, edit usb_inst.cpp, which creats instances of the C++ -objects for each combination. - -Some operating systems, especially Windows, may cache USB device -info. Changes to the device name may not update on the same -computer unless the vendor or product ID numbers change, or the -"bcdDevice" revision code is increased. - -If these instructions are missing steps or could be improved, please -let me know? http://forum.pjrc.com/forums/4-Suggestions-amp-Bug-Reports -*/ - - - -#define DEVICE_CLASS 0xEF -#define DEVICE_SUBCLASS 0x02 -#define DEVICE_PROTOCOL 0x01 -#define EP0_SIZE 64 -#define NUM_ENDPOINTS 6 -#define NUM_USB_BUFFERS 30 -#define NUM_INTERFACE 4 -#define CDC_IAD_DESCRIPTOR 1 -#define CDC_STATUS_INTERFACE 0 -#define CDC_DATA_INTERFACE 1 // Serial -#define CDC_ACM_ENDPOINT 2 -#define CDC_RX_ENDPOINT 3 -#define CDC_TX_ENDPOINT 4 -#define CDC_ACM_SIZE 16 -#define CDC_RX_SIZE 64 -#define CDC_TX_SIZE 64 -#define KEYBOARD_INTERFACE 2 // Keyboard -#define KEYBOARD_ENDPOINT 1 -#define KEYBOARD_SIZE 8 -#define KEYBOARD_INTERVAL 1 -#define MOUSE_INTERFACE 3 // Mouse -#define MOUSE_ENDPOINT 5 -#define MOUSE_SIZE 8 -#define MOUSE_INTERVAL 2 -#define JOYSTICK_INTERFACE 4 // Joystick -#define JOYSTICK_ENDPOINT 6 -#define JOYSTICK_SIZE 16 -#define JOYSTICK_INTERVAL 1 -#define KEYBOARD_DESC_OFFSET (9+8 + 9+5+5+4+5+7+9+7+7 + 9) -#define MOUSE_DESC_OFFSET (9+8 + 9+5+5+4+5+7+9+7+7 + 9+9+7 + 9) -#define JOYSTICK_DESC_OFFSET (9+8 + 9+5+5+4+5+7+9+7+7 + 9+9+7 + 9+9+7 + 9) -#define CONFIG_DESC_SIZE (9+8 + 9+5+5+4+5+7+9+7+7 + 9+9+7 + 9+9+7 + 9+9+7) -#define ENDPOINT1_CONFIG ENDPOINT_TRANSIMIT_ONLY -#define ENDPOINT2_CONFIG ENDPOINT_TRANSIMIT_ONLY -#define ENDPOINT3_CONFIG ENDPOINT_RECEIVE_ONLY -#define ENDPOINT4_CONFIG ENDPOINT_TRANSIMIT_ONLY -#define ENDPOINT5_CONFIG ENDPOINT_TRANSIMIT_ONLY -#define ENDPOINT6_CONFIG ENDPOINT_TRANSIMIT_ONLY +// Local Includes +#include -// NUM_ENDPOINTS = number of non-zero endpoints (0 to 15) -extern const uint8_t usb_endpoint_config_table[NUM_ENDPOINTS]; + + +// ----- Defines ----- + +#define ENDPOINT_UNUSED 0x00 +#define ENDPOINT_TRANSIMIT_ONLY 0x15 +#define ENDPOINT_RECEIVE_ONLY 0x19 +#define ENDPOINT_TRANSMIT_AND_RECEIVE 0x1D + + +#define DEVICE_CLASS 0x00 // Keep 0x00 to indicate each sub device will indicate what it is +#define DEVICE_SUBCLASS 0x00 +#define DEVICE_PROTOCOL 0x00 +#define EP0_SIZE 64 +#define NUM_ENDPOINTS 5 +#define NUM_USB_BUFFERS 30 +#define NUM_INTERFACE 4 + +#define KEYBOARD_INTERFACE 0 // Keyboard +#define KEYBOARD_ENDPOINT 1 +#define KEYBOARD_SIZE 8 +#define KEYBOARD_INTERVAL 1 + +#define NKRO_KEYBOARD_INTERFACE 1 // NKRO Keyboard +#define NKRO_KEYBOARD_ENDPOINT 2 +#define NKRO_KEYBOARD_SIZE 64 +#define NKRO_KEYBOARD_INTERVAL 1 + +#define CDC_IAD_DESCRIPTOR 1 +#define CDC_STATUS_INTERFACE 2 +#define CDC_DATA_INTERFACE 3 // Serial +#define CDC_ACM_ENDPOINT 3 +#define CDC_RX_ENDPOINT 4 +#define CDC_TX_ENDPOINT 5 +#define CDC_ACM_SIZE 16 +#define CDC_RX_SIZE 64 +#define CDC_TX_SIZE 64 + +#define MOUSE_INTERFACE 4 // Mouse +#define MOUSE_ENDPOINT 6 +#define MOUSE_SIZE 8 +#define MOUSE_INTERVAL 2 + +#define JOYSTICK_INTERFACE 5 // Joystick +#define JOYSTICK_ENDPOINT 7 +#define JOYSTICK_SIZE 16 +#define JOYSTICK_INTERVAL 1 + +#define KEYBOARD_DESC_OFFSET (9 + 9) +#define NKRO_KEYBOARD_DESC_OFFSET (9 + 9+9+7 + 9) +#define SERIAL_CDC_DESC_OFFSET (9 + 9+9+7 + 9+9+7 + 8) +#define CONFIG_DESC_SIZE (9 + 9+9+7 + 9+9+7 + 8+9+5+5+4+5+7+9+7+7) + +// XXX Unused +#define MOUSE_DESC_OFFSET (9 + 9+9+7 + 9+9+7 + 8+9+5+5+4+5+7+9+7+7 + 9) +#define JOYSTICK_DESC_OFFSET (9 + 9+9+7 + 9+9+7 + 8+9+5+5+4+5+7+9+7+7 + 9+9+7 + 9) + +#define ENDPOINT1_CONFIG ENDPOINT_TRANSIMIT_ONLY +#define ENDPOINT2_CONFIG ENDPOINT_TRANSIMIT_ONLY +#define ENDPOINT3_CONFIG ENDPOINT_TRANSIMIT_ONLY +#define ENDPOINT4_CONFIG ENDPOINT_RECEIVE_ONLY +#define ENDPOINT5_CONFIG ENDPOINT_TRANSIMIT_ONLY +#define ENDPOINT6_CONFIG ENDPOINT_TRANSIMIT_ONLY +#define ENDPOINT7_CONFIG ENDPOINT_TRANSIMIT_ONLY + + + +// ----- Enumerations ----- typedef struct { - uint16_t wValue; - uint16_t wIndex; - const uint8_t *addr; - uint16_t length; + uint16_t wValue; + uint16_t wIndex; + const uint8_t *addr; + uint16_t length; } usb_descriptor_list_t; -extern const usb_descriptor_list_t usb_descriptor_list[]; -#endif +// ----- Variables ----- + +// NUM_ENDPOINTS = number of non-zero endpoints (0 to 15) +extern const uint8_t usb_endpoint_config_table[NUM_ENDPOINTS]; + +extern const usb_descriptor_list_t usb_descriptor_list[];