tinyusb
tusb_types.h File Reference

Go to the source code of this file.

Macros

#define TUSB_DESC_CONFIG_POWER_MA(x)   ((x)/2)
 

Enumerations

enum  tusb_speed_t { TUSB_SPEED_FULL = 0, TUSB_SPEED_LOW, TUSB_SPEED_HIGH }
 defined base on EHCI specs value for Endpoint Speed
 
enum  tusb_xfer_type_t { TUSB_XFER_CONTROL = 0, TUSB_XFER_ISOCHRONOUS, TUSB_XFER_BULK, TUSB_XFER_INTERRUPT }
 defined base on USB Specs Endpoint's bmAttributes
 
enum  tusb_direction_t { TUSB_DIR_HOST_TO_DEV = 0, TUSB_DIR_DEV_TO_HOST = 1, TUSB_DIR_DEV_TO_HOST_MASK = 0x80 }
 
enum  tusb_std_descriptor_type_t {
  TUSB_DESC_TYPE_DEVICE = 0x01, TUSB_DESC_TYPE_CONFIGURATION = 0x02, TUSB_DESC_TYPE_STRING = 0x03, TUSB_DESC_TYPE_INTERFACE = 0x04,
  TUSB_DESC_TYPE_ENDPOINT = 0x05, TUSB_DESC_TYPE_DEVICE_QUALIFIER = 0x06, TUSB_DESC_TYPE_OTHER_SPEED_CONFIGURATION = 0x07, TUSB_DESC_TYPE_INTERFACE_POWER = 0x08,
  TUSB_DESC_TYPE_OTG = 0x09, TUSB_DESC_TYPE_DEBUG = 0x0A, TUSB_DESC_TYPE_INTERFACE_ASSOCIATION = 0x0B, TUSB_DESC_TYPE_INTERFACE_CLASS_SPECIFIC = 0x24
}
 USB Descriptor Types (section 9.4 table 9-5)
 
enum  tusb_std_request_code_t {
  TUSB_REQUEST_GET_STATUS =0, TUSB_REQUEST_CLEAR_FEATURE, TUSB_REQUEST_RESERVED, TUSB_REQUEST_SET_FEATURE,
  TUSB_REQUEST_RESERVED2, TUSB_REQUEST_SET_ADDRESS, TUSB_REQUEST_GET_DESCRIPTOR, TUSB_REQUEST_SET_DESCRIPTOR,
  TUSB_REQUEST_GET_CONFIGURATION, TUSB_REQUEST_SET_CONFIGURATION, TUSB_REQUEST_GET_INTERFACE, TUSB_REQUEST_SET_INTERFACE,
  TUSB_REQUEST_SYNCH_FRAME
}
 
enum  tusb_control_request_type_t { TUSB_REQUEST_TYPE_STANDARD = 0, TUSB_REQUEST_TYPE_CLASS, TUSB_REQUEST_TYPE_VENDOR }
 
enum  tusb_std_request_recipient_t { TUSB_REQUEST_RECIPIENT_DEVICE =0, TUSB_REQUEST_RECIPIENT_INTERFACE, TUSB_REQUEST_RECIPIENT_ENDPOINT, TUSB_REQUEST_RECIPIENT_OTHER }
 
enum  tusb_std_class_code_t {
  TUSB_CLASS_UNSPECIFIED = 0, TUSB_CLASS_AUDIO = 1, TUSB_CLASS_CDC = 2, TUSB_CLASS_HID = 3,
  TUSB_CLASS_RESERVED_4 = 4, TUSB_CLASS_PHYSICAL = 5, TUSB_CLASS_IMAGE = 6, TUSB_CLASS_PRINTER = 7,
  TUSB_CLASS_MSC = 8, TUSB_CLASS_HUB = 9, TUSB_CLASS_CDC_DATA = 10, TUSB_CLASS_SMART_CARD = 11,
  TUSB_CLASS_RESERVED_12 = 12, TUSB_CLASS_CONTENT_SECURITY = 13, TUSB_CLASS_VIDEO = 14, TUSB_CLASS_PERSONAL_HEALTHCARE = 15,
  TUSB_CLASS_AUDIO_VIDEO = 16, TUSB_CLASS_MAPPED_INDEX_START = 17, TUSB_CLASS_DIAGNOSTIC = 0xDC, TUSB_CLASS_WIRELESS_CONTROLLER = 0xE0,
  TUSB_CLASS_MISC = 0xEF, TUSB_CLASS_APPLICATION_SPECIFIC = 0xFE, TUSB_CLASS_VENDOR_SPECIFIC = 0xFF
}
 
enum  misc_subclass_type_t { MISC_SUBCLASS_COMMON = 2 }
 
enum  misc_protocol_type_t { MISC_PROTOCOL_IAD = 1 }
 
enum  { TUSB_DESC_CONFIG_ATT_REMOTE_WAKEUP = BIT_(5), TUSB_DESC_CONFIG_ATT_SELF_POWER = BIT_(6), TUSB_DESC_CONFIG_ATT_BUS_POWER = BIT_(7) }
 
enum  tusb_device_state_t {
  TUSB_DEVICE_STATE_UNPLUG = 0, TUSB_DEVICE_STATE_ADDRESSED, TUSB_DEVICE_STATE_CONFIGURED, TUSB_DEVICE_STATE_SUSPENDED,
  TUSB_DEVICE_STATE_REMOVING, TUSB_DEVICE_STATE_SAFE_REMOVE, TUSB_DEVICE_STATE_INVALID_PARAMETER
}
 Device State.
 
enum  tusb_event_t {
  TUSB_EVENT_NONE = 0, TUSB_EVENT_XFER_COMPLETE, TUSB_EVENT_XFER_ERROR, TUSB_EVENT_XFER_STALLED,
  TUSB_EVENT_BUS_RESET, TUSB_EVENT_SETUP_RECEIVED
}
 
enum  { DESCRIPTOR_OFFSET_LENGTH = 0, DESCRIPTOR_OFFSET_TYPE = 1 }
 
enum  { INTERFACE_INVALID_NUMBER = 0xff }
 

Functions

static uint8_t std_class_code_to_index (uint8_t std_class_code) ATTR_CONST ATTR_ALWAYS_INLINE
 

Detailed Description

Author
hathach (tinyusb.org)

LICENSE

Software License Agreement (BSD License)

Copyright (c) 2013, hathach (tinyusb.org) All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  3. Neither the name of the copyright holders nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT INCLUDING NEGLIGENCE OR OTHERWISE ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

This file is part of the tinyusb stack.