Output/pjrcUSB/arm/usb_desc.h

   1 /* Teensyduino Core Library
   2  * http://www.pjrc.com/teensy/
   3  * Copyright (c) 2013 PJRC.COM, LLC.
   4  * Modified by Jacob Alexander (2013-2014)
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining
   7  * a copy of this software and associated documentation files (the
   8  * "Software"), to deal in the Software without restriction, including
   9  * without limitation the rights to use, copy, modify, merge, publish,
  10  * distribute, sublicense, and/or sell copies of the Software, and to
  11  * permit persons to whom the Software is furnished to do so, subject to
  12  * the following conditions:
  13  *
  14  * 1. The above copyright notice and this permission notice shall be
  15  * included in all copies or substantial portions of the Software.
  16  *
  17  * 2. If the Software is incorporated into a build system that allows
  18  * selection among a list of target devices, then similar target
  19  * devices manufactured by PJRC.COM must be included in the list of
  20  * target devices and selectable in the same manner.
  21  *
  22  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  23  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  24  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  25  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  26  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  27  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  28  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  29  * SOFTWARE.
  30  */
  31
  32 #ifndef _usb_desc_h_
  33 #define _usb_desc_h_
  34
  35 // ----- Includes -----
  36
  37 // Compiler Includes
  38 #include <stdint.h>
  39 #include <stddef.h>
  40
  41 // Local Includes
  42 #include <output_com.h>
  43
  44
  45
  46 // ----- Defines -----
  47
  48 #define ENDPOINT_UNUSED                 0x00
  49 #define ENDPOINT_TRANSIMIT_ONLY         0x15
  50 #define ENDPOINT_RECEIVE_ONLY           0x19
  51 #define ENDPOINT_TRANSMIT_AND_RECEIVE   0x1D
  52
  53
  54 #define DEVICE_CLASS            0x00 // Keep 0x00 to indicate each sub device will indicate what it is
  55 #define DEVICE_SUBCLASS         0x00
  56 #define DEVICE_PROTOCOL         0x00
  57 #define EP0_SIZE                64
  58 #define NUM_ENDPOINTS           5
  59 #define NUM_USB_BUFFERS         30
  60 #define NUM_INTERFACE           4
  61
  62 #define KEYBOARD_INTERFACE      0 // Keyboard
  63 #define KEYBOARD_ENDPOINT       1
  64 #define KEYBOARD_SIZE           8
  65 #define KEYBOARD_INTERVAL       1
  66
  67 #define NKRO_KEYBOARD_INTERFACE 1 // NKRO Keyboard
  68 #define NKRO_KEYBOARD_ENDPOINT  2
  69 #define NKRO_KEYBOARD_SIZE      64
  70 #define NKRO_KEYBOARD_INTERVAL  1
  71
  72 #define CDC_IAD_DESCRIPTOR      1
  73 #define CDC_STATUS_INTERFACE    2
  74 #define CDC_DATA_INTERFACE      3 // Serial
  75 #define CDC_ACM_ENDPOINT        3
  76 #define CDC_RX_ENDPOINT         4
  77 #define CDC_TX_ENDPOINT         5
  78 #define CDC_ACM_SIZE            16
  79 #define CDC_RX_SIZE             64
  80 #define CDC_TX_SIZE             64
  81
  82 #define MOUSE_INTERFACE         4 // Mouse
  83 #define MOUSE_ENDPOINT          6
  84 #define MOUSE_SIZE              8
  85 #define MOUSE_INTERVAL          2
  86
  87 #define JOYSTICK_INTERFACE      5 // Joystick
  88 #define JOYSTICK_ENDPOINT       7
  89 #define JOYSTICK_SIZE           16
  90 #define JOYSTICK_INTERVAL       1
  91
  92 #define KEYBOARD_DESC_OFFSET      (9 + 9)
  93 #define NKRO_KEYBOARD_DESC_OFFSET (9 + 9+9+7 + 9)
  94 #define SERIAL_CDC_DESC_OFFSET    (9 + 9+9+7 + 9+9+7 + 8)
  95 #define CONFIG_DESC_SIZE          (9 + 9+9+7 + 9+9+7 + 8+9+5+5+4+5+7+9+7+7)
  96
  97 // XXX Unused
  98 #define MOUSE_DESC_OFFSET         (9 + 9+9+7 + 9+9+7 + 8+9+5+5+4+5+7+9+7+7 + 9)
  99 #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)
 100
 101 #define ENDPOINT1_CONFIG        ENDPOINT_TRANSIMIT_ONLY
 102 #define ENDPOINT2_CONFIG        ENDPOINT_TRANSIMIT_ONLY
 103 #define ENDPOINT3_CONFIG        ENDPOINT_TRANSIMIT_ONLY
 104 #define ENDPOINT4_CONFIG        ENDPOINT_RECEIVE_ONLY
 105 #define ENDPOINT5_CONFIG        ENDPOINT_TRANSIMIT_ONLY
 106 #define ENDPOINT6_CONFIG        ENDPOINT_TRANSIMIT_ONLY
 107 #define ENDPOINT7_CONFIG        ENDPOINT_TRANSIMIT_ONLY
 108
 109
 110
 111 // ----- Enumerations -----
 112
 113 typedef struct {
 114         uint16_t        wValue;
 115         uint16_t        wIndex;
 116         const uint8_t   *addr;
 117         uint16_t        length;
 118 } usb_descriptor_list_t;
 119
 120
 121
 122 // ----- Variables -----
 123
 124 // NUM_ENDPOINTS = number of non-zero endpoints (0 to 15)
 125 extern const uint8_t usb_endpoint_config_table[NUM_ENDPOINTS];
 126
 127 extern const usb_descriptor_list_t usb_descriptor_list[];
 128
 129
 130 #endif
 131