2012-12-03 10:51:14 +01:00
|
|
|
/*
|
|
|
|
* tusb_types.h
|
|
|
|
*
|
|
|
|
* Created on: Dec 3, 2012
|
|
|
|
* Author: hathach
|
|
|
|
*/
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Software License Agreement (BSD License)
|
2013-01-27 07:50:40 +01:00
|
|
|
* Copyright (c) 2013, hathach (tinyusb.net)
|
2012-12-03 10:51:14 +01:00
|
|
|
* 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. The name of the author may not be used to endorse or promote products
|
|
|
|
* derived from this software without specific prior written permission.
|
|
|
|
*
|
|
|
|
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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 tiny usb stack.
|
|
|
|
*/
|
|
|
|
|
|
|
|
/** \file
|
|
|
|
* \brief TBD
|
|
|
|
*/
|
|
|
|
|
|
|
|
/** \ingroup Group_Core
|
|
|
|
* \defgroup Group_USBTypes USB Types
|
|
|
|
* \brief TBD
|
|
|
|
*
|
|
|
|
* @{
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef _TUSB_TUSB_TYPES_H_
|
|
|
|
#define _TUSB_TUSB_TYPES_H_
|
|
|
|
|
|
|
|
#ifdef __cplusplus
|
|
|
|
extern "C" {
|
|
|
|
#endif
|
|
|
|
|
|
|
|
/// defined base on EHCI specs value for Endpoint Speed
|
|
|
|
typedef enum {
|
2013-01-22 11:41:06 +01:00
|
|
|
TUSB_SPEED_FULL = 0,
|
|
|
|
TUSB_SPEED_LOW ,
|
|
|
|
TUSB_SPEED_HIGH
|
|
|
|
}tusb_speed_t;
|
2012-12-03 10:51:14 +01:00
|
|
|
|
|
|
|
/// defined base on USB Specs Endpoint's bmAttributes
|
|
|
|
typedef enum {
|
2013-01-22 11:41:06 +01:00
|
|
|
TUSB_XFER_CONTROL = 0 ,
|
|
|
|
TUSB_XFER_ISOCHRONOUS ,
|
|
|
|
TUSB_XFER_BULK ,
|
|
|
|
TUSB_XFER_INTERRUPT
|
|
|
|
}tusb_transfer_type_t;
|
2012-12-03 10:51:14 +01:00
|
|
|
|
2013-02-02 09:36:20 +01:00
|
|
|
typedef enum {
|
|
|
|
TUSB_DIR_HOST_TO_DEV = 0,
|
|
|
|
TUSB_DIR_DEV_TO_HOST = 1
|
|
|
|
}tusb_direction_t;
|
|
|
|
|
2012-12-03 12:43:35 +01:00
|
|
|
/// USB Descriptor Types (section 9.4 table 9-5)
|
|
|
|
typedef enum {
|
2013-01-22 11:41:06 +01:00
|
|
|
TUSB_DESC_DEVICE =1 , ///< 1
|
|
|
|
TUSB_DESC_CONFIGURATION , ///< 2
|
|
|
|
TUSB_DESC_STRING , ///< 3
|
|
|
|
TUSB_DESC_INTERFACE , ///< 4
|
|
|
|
TUSB_DESC_ENDPOINT , ///< 5
|
|
|
|
TUSB_DESC_DEVICE_QUALIFIER , ///< 6
|
|
|
|
TUSB_DESC_OTHER_SPEED_CONFIGURATION , ///< 7
|
|
|
|
TUSB_DESC_INTERFACE_POWER , ///< 8
|
|
|
|
TUSB_DESC_OTG , ///< 9
|
|
|
|
TUSB_DESC_DEBUGRIPTOR , ///< 10
|
|
|
|
TUSB_DESC_INTERFACE_ASSOCIATION ///< 11
|
|
|
|
}tusb_std_descriptor_type_t;
|
2012-12-03 10:51:14 +01:00
|
|
|
|
2012-12-03 12:43:35 +01:00
|
|
|
typedef enum {
|
2013-01-22 11:41:06 +01:00
|
|
|
TUSB_REQUEST_GET_STATUS =0 , ///< 0
|
|
|
|
TUSB_REQUEST_CLEAR_FEATURE , ///< 1
|
|
|
|
TUSB_REQUEST_RESERVED , ///< 2
|
|
|
|
TUSB_REQUEST_SET_FEATURE , ///< 3
|
|
|
|
TUSB_REQUEST_RESERVED2 , ///< 4
|
|
|
|
TUSB_REQUEST_SET_ADDRESS , ///< 5
|
|
|
|
TUSB_REQUEST_GET_DESCRIPTOR , ///< 6
|
|
|
|
TUSB_REQUEST_SET_DESCRIPTOR , ///< 7
|
|
|
|
TUSB_REQUEST_GET_CONFIGURATION , ///< 8
|
|
|
|
TUSB_REQUEST_SET_CONFIGURATION , ///< 9
|
|
|
|
TUSB_REQUEST_GET_INTERFACE , ///< 10
|
|
|
|
TUSB_REQUEST_SET_INTERFACE , ///< 11
|
|
|
|
TUSB_REQUEST_SYNCH_FRAME ///< 12
|
|
|
|
}tusb_std_request_code_t;
|
|
|
|
|
2013-02-02 09:36:20 +01:00
|
|
|
typedef enum {
|
|
|
|
TUSB_REQUEST_TYPE_STANDARD = 0,
|
|
|
|
TUSB_REQUEST_TYPE_CLASS,
|
|
|
|
TUSB_REQUEST_TYPE_VENDOR
|
|
|
|
} tusb_std_request_type_t;
|
|
|
|
|
|
|
|
typedef enum {
|
|
|
|
TUSB_REQUEST_RECIPIENT_DEVICE =0,
|
|
|
|
TUSB_REQUEST_RECIPIENT_INTERFACE,
|
|
|
|
TUSB_REQUEST_RECIPIENT_ENDPOINT,
|
|
|
|
TUSB_REQUEST_RECIPIENT_OTHER
|
|
|
|
} tusb_std_request_recipient_t;
|
|
|
|
|
2013-01-22 11:41:06 +01:00
|
|
|
typedef enum {
|
|
|
|
TUSB_CLASS_UNSPECIFIED = 0 , ///< 0
|
|
|
|
TUSB_CLASS_AUDIO = 1 , ///< 1
|
|
|
|
TUSB_CLASS_CDC = 2 , ///< 2
|
|
|
|
TUSB_CLASS_HID = 3 , ///< 3
|
|
|
|
TUSB_CLASS_RESERVED_4 = 4 , ///< 4
|
|
|
|
TUSB_CLASS_PHYSICAL = 5 , ///< 5
|
|
|
|
TUSB_CLASS_IMAGE = 6 , ///< 6
|
|
|
|
TUSB_CLASS_PRINTER = 7 , ///< 7
|
|
|
|
TUSB_CLASS_MSC = 8 , ///< 8
|
|
|
|
TUSB_CLASS_HUB = 9 , ///< 9
|
|
|
|
TUSB_CLASS_CDC_DATA = 10 , ///< 10
|
|
|
|
TUSB_CLASS_SMART_CARD = 11 , ///< 11
|
|
|
|
TUSB_CLASS_RESERVED_12 = 12 , ///< 12
|
|
|
|
TUSB_CLASS_CONTENT_SECURITY = 13 , ///< 13
|
|
|
|
TUSB_CLASS_VIDEO = 14 , ///< 14
|
|
|
|
TUSB_CLASS_PERSONAL_HEALTHCARE = 15 , ///< 15
|
|
|
|
TUSB_CLASS_AUDIO_VIDEO = 16 , ///< 16
|
|
|
|
|
2013-03-09 07:11:02 +01:00
|
|
|
TUSB_CLASS_MAX_CONSEC_NUMBER = 17 , // TODO compact & minimize this number
|
|
|
|
|
2013-01-22 11:41:06 +01:00
|
|
|
TUSB_CLASS_DIAGNOSTIC = 0xDC ,
|
|
|
|
TUSB_CLASS_WIRELESS_CONTROLLER = 0xE0 ,
|
|
|
|
TUSB_CLASS_MISC = 0xEF ,
|
2013-03-09 08:31:37 +01:00
|
|
|
TUSB_CLASS_APPLICATION_SPECIFIC = 0xFE ,
|
2013-01-22 11:41:06 +01:00
|
|
|
TUSB_CLASS_VENDOR_SPECIFIC = 0xFF
|
|
|
|
}tusb_std_class_code_t;
|
|
|
|
|
|
|
|
enum {
|
|
|
|
TUSB_DESC_CONFIG_ATT_BUS_POWER = BIT_(7),
|
|
|
|
TUSB_DESC_CONFIG_ATT_SELF_POWER = BIT_(6),
|
|
|
|
TUSB_DESC_CONFIG_ATT_REMOTE_WAKEUP = BIT_(5)
|
|
|
|
};
|
2012-12-03 10:51:14 +01:00
|
|
|
|
2013-02-05 07:57:06 +01:00
|
|
|
#define TUSB_DESC_CONFIG_POWER_MA(x) ((x)/2)
|
2012-12-03 10:51:14 +01:00
|
|
|
#ifdef __cplusplus
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
|
|
|
|
#endif /* _TUSB_TUSB_TYPES_H_ */
|
|
|
|
|
|
|
|
/** @} */
|