Archived
1
0
This repo is archived. You can view files and clone it, but cannot push or open issues or pull requests.
controller/Output/pjrcUSB/arm/usb_desc.h
Jacob Alexander 5162980791 Updating bcdDevice and iSerial fields in USB descriptors
- Use commit number as the basis for bcdDevice field (maximum is 2^16)
- Change iSerial from commit date to chip Unique ID
- Update both Firmware and Bootloader to use the same scheme (bcdDevice and iSerial)
- Cleanup of Bootloader code
- Split out build info CMake commands to a new file
2016-07-23 16:16:16 -07:00

209 lines
6.2 KiB
C

/* Teensyduino Core Library
* http://www.pjrc.com/teensy/
* Copyright (c) 2013 PJRC.COM, LLC.
* Modified by Jacob Alexander (2013-2016)
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* 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
* included in all copies or substantial portions of the Software.
*
* 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.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
#pragma once
// ----- Includes -----
// Compiler Includes
#include <stdint.h>
#include <stddef.h>
// Local Includes
#include <output_com.h>
// ----- 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 10 // XXX Can save some space if this can be calculated using KLL
#define NUM_USB_BUFFERS 30
// XXX Remember to update total interface count, if it isn't correct some OSs will not initialize USB
// Linux warns in dmesg
// Mac OSX login screen will not initialize
#define KEYBOARD_INTERFACES 3 // Boot, NKRO, SysCtrl
#define CDC_INTERFACES 2
#define MOUSE_INTERFACES 1
#define JOYSTICK_INTERFACES 1
#define RAWIO_INTERFACES 1
#define KEYBOARD_INTERFACE 0 // Keyboard
#define KEYBOARD_ENDPOINT 1
#define KEYBOARD_SIZE 8
#define KEYBOARD_INTERVAL 1
#define KEYBOARD_NAME L"Boot Keyboard"
#define NKRO_KEYBOARD_INTERFACE 1 // NKRO Keyboard
#define NKRO_KEYBOARD_ENDPOINT 2
#define NKRO_KEYBOARD_SIZE 64
#define NKRO_KEYBOARD_INTERVAL 1
#define NKRO_KEYBOARD_NAME L"NKRO Keyboard"
#define SYS_CTRL_INTERFACE 2 // Media Keys
#define SYS_CTRL_ENDPOINT 3
#define SYS_CTRL_SIZE 8
#define SYS_CTRL_INTERVAL 1
#define SYS_CTRL_NAME L"Media Keys"
#define CDC_IAD_DESCRIPTOR 1
#define CDC_STATUS_INTERFACE 3
#define CDC_DATA_INTERFACE 4 // Serial
#define CDC_ACM_ENDPOINT 4
#define CDC_RX_ENDPOINT 5
#define CDC_TX_ENDPOINT 6
#define CDC_ACM_SIZE 16
#define CDC_RX_SIZE 64
#define CDC_TX_SIZE 64
#define CDC_STATUS_NAME L"Virtual Serial Port - Status"
#define CDC_DATA_NAME L"Virtual Serial Port - Data"
#define RAWIO_INTERFACE 5 // RawIO
#define RAWIO_TX_ENDPOINT 7
#define RAWIO_TX_SIZE 64
#define RAWIO_TX_INTERVAL 1
#define RAWIO_RX_ENDPOINT 8
#define RAWIO_RX_SIZE 64
#define RAWIO_RX_INTERVAL 1
#define RAWIO_NAME L"API Interface"
#define MOUSE_INTERFACE 6 // Mouse
#define MOUSE_ENDPOINT 9
#define MOUSE_SIZE 8
#define MOUSE_INTERVAL 1
#define MOUSE_NAME L"Mouse"
#define JOYSTICK_INTERFACE 7 // Joystick
#define JOYSTICK_ENDPOINT 10
#define JOYSTICK_SIZE 16
#define JOYSTICK_INTERVAL 1
#define JOYSTICK_NAME L"Joystick"
// Descriptor sizes
#define BASE_DESC_SIZE (9)
#define KEYBOARD_DESC_SIZE (9+9+7)
#define NKRO_KEYBOARD_DESC_SIZE (9+9+7)
#define SYS_CTRL_DESC_SIZE (9+9+7)
#define SERIAL_CDC_DESC_SIZE (8+9+5+5+4+5+7+9+7+7)
#define RAWIO_DESC_SIZE (9+7+7)
#define MOUSE_DESC_SIZE (9+9+7)
#define JOYSTICK_DESC_SIZE (9+9+7)
// Descriptor offsets
#define KEYBOARD_DESC_BASE_OFFSET ( \
BASE_DESC_SIZE + \
9 \
)
#define SERIAL_CDC_DESC_BASE_OFFSET ( \
BASE_DESC_SIZE + \
KEYBOARD_DESC_TOTAL_OFFSET + \
8 \
)
#define RAWIO_DESC_BASE_OFFSET ( \
BASE_DESC_SIZE + \
KEYBOARD_DESC_TOTAL_OFFSET + \
SERIAL_CDC_DESC_TOTAL_OFFSET + \
9 \
)
#define MOUSE_DESC_BASE_OFFSET ( \
BASE_DESC_SIZE + \
KEYBOARD_DESC_TOTAL_OFFSET + \
SERIAL_CDC_DESC_TOTAL_OFFSET + \
9 \
)
#define JOYSTICK_DESC_BASE_OFFSET ( \
BASE_DESC_SIZE + \
KEYBOARD_DESC_TOTAL_OFFSET + \
SERIAL_CDC_DESC_TOTAL_OFFSET + \
MOUSE_DESC_TOTAL_OFFSET + \
9 \
)
#define ENDPOINT1_CONFIG ENDPOINT_TRANSIMIT_ONLY
#define ENDPOINT2_CONFIG ENDPOINT_TRANSIMIT_ONLY
#define ENDPOINT3_CONFIG ENDPOINT_TRANSIMIT_ONLY
#define ENDPOINT4_CONFIG ENDPOINT_TRANSIMIT_ONLY
#define ENDPOINT5_CONFIG ENDPOINT_RECEIVE_ONLY
#define ENDPOINT6_CONFIG ENDPOINT_TRANSIMIT_ONLY
#define ENDPOINT7_CONFIG ENDPOINT_TRANSIMIT_ONLY
#define ENDPOINT8_CONFIG ENDPOINT_RECEIVE_ONLY
#define ENDPOINT9_CONFIG ENDPOINT_TRANSIMIT_ONLY
#define ENDPOINT10_CONFIG ENDPOINT_TRANSIMIT_ONLY
// ----- Structs -----
typedef struct {
uint16_t wValue;
uint16_t wIndex;
const uint8_t *addr;
uint16_t length;
} usb_descriptor_list_t;
struct usb_string_descriptor_struct {
uint8_t bLength;
uint8_t bDescriptorType;
uint16_t wString[];
};
// ----- 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[];
extern uint8_t *usb_bMaxPower;
// ----- Functions -----
void usb_set_config_descriptor_size();