mirror of
https://github.com/hathach/tinyusb.git
synced 2025-01-31 05:52:55 +08:00
change editor tab to 2 spaces.
This commit is contained in:
hathach
parent
6ea85a569a
commit
921561be60
@ -52,13 +52,13 @@
|
|||||||
#endif
|
#endif
|
||||||
|
|
||||||
/// Normally, the compiler places the objects it generates in sections like data or bss & function in text. Sometimes, however, you need additional sections, or you need certain particular variables to appear in special sections, for example to map to special hardware. The section attribute specifies that a variable (or function) lives in a particular section
|
/// Normally, the compiler places the objects it generates in sections like data or bss & function in text. Sometimes, however, you need additional sections, or you need certain particular variables to appear in special sections, for example to map to special hardware. The section attribute specifies that a variable (or function) lives in a particular section
|
||||||
#define ATTR_SECTION(section) __attribute__ ((#section))
|
#define ATTR_SECTION(section) __attribute__ ((#section))
|
||||||
|
|
||||||
/// If this attribute is used on a function declaration and a call to such a function is not eliminated through dead code elimination or other optimizations, an error that includes message is diagnosed. This is useful for compile-time checking
|
/// If this attribute is used on a function declaration and a call to such a function is not eliminated through dead code elimination or other optimizations, an error that includes message is diagnosed. This is useful for compile-time checking
|
||||||
#define ATTR_ERROR(Message) __attribute__ ((error(Message)))
|
#define ATTR_ERROR(Message) __attribute__ ((error(Message)))
|
||||||
|
|
||||||
/// If this attribute is used on a function declaration and a call to such a function is not eliminated through dead code elimination or other optimizations, a warning that includes message is diagnosed. This is useful for compile-time checking
|
/// If this attribute is used on a function declaration and a call to such a function is not eliminated through dead code elimination or other optimizations, a warning that includes message is diagnosed. This is useful for compile-time checking
|
||||||
#define ATTR_WARNING(Message) __attribute__ ((warning(Message)))
|
#define ATTR_WARNING(Message) __attribute__ ((warning(Message)))
|
||||||
|
|
||||||
/** \ingroup Group_GCC
|
/** \ingroup Group_GCC
|
||||||
* \defgroup Group_VariableAttr Variable Attributes
|
* \defgroup Group_VariableAttr Variable Attributes
|
||||||
@ -66,10 +66,10 @@
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
/// This attribute specifies a minimum alignment for the variable or structure field, measured in bytes
|
/// This attribute specifies a minimum alignment for the variable or structure field, measured in bytes
|
||||||
#define ATTR_ALIGNED(Bytes) __attribute__ ((aligned(Bytes)))
|
#define ATTR_ALIGNED(Bytes) __attribute__ ((aligned(Bytes)))
|
||||||
|
|
||||||
/// The packed attribute specifies that a variable or structure field should have the smallest possible alignment—one byte for a variable, and one bit for a field, unless you specify a larger value with the aligned attribute
|
/// The packed attribute specifies that a variable or structure field should have the smallest possible alignment—one byte for a variable, and one bit for a field, unless you specify a larger value with the aligned attribute
|
||||||
#define ATTR_PACKED __attribute__ ((packed))
|
#define ATTR_PACKED __attribute__ ((packed))
|
||||||
|
|
||||||
#define ATTR_PREPACKED
|
#define ATTR_PREPACKED
|
||||||
/** @} */
|
/** @} */
|
||||||
@ -80,41 +80,41 @@
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
/// Generally, functions are not inlined unless optimization is specified. For functions declared inline, this attribute inlines the function even if no optimization level is specified
|
/// Generally, functions are not inlined unless optimization is specified. For functions declared inline, this attribute inlines the function even if no optimization level is specified
|
||||||
#define ATTR_ALWAYS_INLINE __attribute__ ((always_inline))
|
#define ATTR_ALWAYS_INLINE __attribute__ ((always_inline))
|
||||||
|
|
||||||
/// The nonnull attribute specifies that some function parameters should be non-null pointers. f the compiler determines that a null pointer is passed in an argument slot marked as non-null, and the -Wnonnull option is enabled, a warning is issued. All pointer arguments are marked as non-null
|
/// The nonnull attribute specifies that some function parameters should be non-null pointers. f the compiler determines that a null pointer is passed in an argument slot marked as non-null, and the -Wnonnull option is enabled, a warning is issued. All pointer arguments are marked as non-null
|
||||||
#define ATTR_NON_NULL __attribute__ ((nonull))
|
#define ATTR_NON_NULL __attribute__ ((nonull))
|
||||||
|
|
||||||
/// Many functions have no effects except the return value and their return value depends only on the parameters and/or global variables. Such a function can be subject to common subexpression elimination and loop optimization just as an arithmetic operator would be. These functions should be declared with the attribute pur
|
/// Many functions have no effects except the return value and their return value depends only on the parameters and/or global variables. Such a function can be subject to common subexpression elimination and loop optimization just as an arithmetic operator would be. These functions should be declared with the attribute pur
|
||||||
#define ATTR_PURE __attribute__ ((pure))
|
#define ATTR_PURE __attribute__ ((pure))
|
||||||
|
|
||||||
/// Many functions do not examine any values except their arguments, and have no effects except the return value. Basically this is just slightly more strict class than the pure attribute below, since function is not allowed to read global memory.
|
/// Many functions do not examine any values except their arguments, and have no effects except the return value. Basically this is just slightly more strict class than the pure attribute below, since function is not allowed to read global memory.
|
||||||
/// Note that a function that has pointer arguments and examines the data pointed to must not be declared const. Likewise, a function that calls a non-const function usually must not be const. It does not make sense for a const function to return void
|
/// Note that a function that has pointer arguments and examines the data pointed to must not be declared const. Likewise, a function that calls a non-const function usually must not be const. It does not make sense for a const function to return void
|
||||||
#define ATTR_CONST __attribute__ ((const))
|
#define ATTR_CONST __attribute__ ((const))
|
||||||
|
|
||||||
/// The deprecated attribute results in a warning if the function is used anywhere in the source file. This is useful when identifying functions that are expected to be removed in a future version of a program. The warning also includes the location of the declaration of the deprecated function, to enable users to easily find further information about why the function is deprecated, or what they should do instead. Note that the warnings only occurs for uses
|
/// The deprecated attribute results in a warning if the function is used anywhere in the source file. This is useful when identifying functions that are expected to be removed in a future version of a program. The warning also includes the location of the declaration of the deprecated function, to enable users to easily find further information about why the function is deprecated, or what they should do instead. Note that the warnings only occurs for uses
|
||||||
#define ATTR_DEPRECATED __attribute__ ((deprecated))
|
#define ATTR_DEPRECATED __attribute__ ((deprecated))
|
||||||
|
|
||||||
/// Same as the deprecated attribute with optional message in the warning
|
/// Same as the deprecated attribute with optional message in the warning
|
||||||
#define ATTR_DEPRECATED_MESS(mess) __attribute__ ((deprecated(mess)))
|
#define ATTR_DEPRECATED_MESS(mess) __attribute__ ((deprecated(mess)))
|
||||||
|
|
||||||
/// The weak attribute causes the declaration to be emitted as a weak symbol rather than a global. This is primarily useful in defining library functions that can be overridden in user code
|
/// The weak attribute causes the declaration to be emitted as a weak symbol rather than a global. This is primarily useful in defining library functions that can be overridden in user code
|
||||||
#define ATTR_WEAK __attribute__ ((weak))
|
#define ATTR_WEAK __attribute__ ((weak))
|
||||||
|
|
||||||
/// The alias attribute causes the declaration to be emitted as an alias for another symbol, which must be specified
|
/// The alias attribute causes the declaration to be emitted as an alias for another symbol, which must be specified
|
||||||
#define ATTR_ALIAS(func) __attribute__ ((alias(#func)))
|
#define ATTR_ALIAS(func) __attribute__ ((alias(#func)))
|
||||||
|
|
||||||
/// The weakref attribute marks a declaration as a weak reference. It is equivalent with weak + alias attribute, but require function is static
|
/// The weakref attribute marks a declaration as a weak reference. It is equivalent with weak + alias attribute, but require function is static
|
||||||
#define ATTR_WEAKREF(func) __attribute__ ((weakref(#func)))
|
#define ATTR_WEAKREF(func) __attribute__ ((weakref(#func)))
|
||||||
|
|
||||||
/// The warn_unused_result attribute causes a warning to be emitted if a caller of the function with this attribute does not use its return value. This is useful for functions where not checking the result is either a security problem or always a bug
|
/// The warn_unused_result attribute causes a warning to be emitted if a caller of the function with this attribute does not use its return value. This is useful for functions where not checking the result is either a security problem or always a bug
|
||||||
#define ATTR_WARN_UNUSED_RESULT __attribute__ ((warn_unused_result))
|
#define ATTR_WARN_UNUSED_RESULT __attribute__ ((warn_unused_result))
|
||||||
|
|
||||||
/// This attribute, attached to a function, means that code must be emitted for the function even if it appears that the function is not referenced. This is useful, for example, when the function is referenced only in inline assembly.
|
/// This attribute, attached to a function, means that code must be emitted for the function even if it appears that the function is not referenced. This is useful, for example, when the function is referenced only in inline assembly.
|
||||||
#define ATTR_USED __attribute__ ((used))
|
#define ATTR_USED __attribute__ ((used))
|
||||||
|
|
||||||
/// This attribute, attached to a function, means that the function is meant to be possibly unused. GCC does not produce a warning for this function.
|
/// This attribute, attached to a function, means that the function is meant to be possibly unused. GCC does not produce a warning for this function.
|
||||||
#define ATTR_UNUSED __attribute__ ((unused))
|
#define ATTR_UNUSED __attribute__ ((unused))
|
||||||
|
|
||||||
/** @} */
|
/** @} */
|
||||||
|
|
||||||
|
|||||||
@ -60,13 +60,13 @@
|
|||||||
*/
|
*/
|
||||||
typedef struct _fifo_t
|
typedef struct _fifo_t
|
||||||
{
|
{
|
||||||
uint8_t* buf; ///< buffer pointer
|
uint8_t* buf ; ///< buffer pointer
|
||||||
uint16_t size; ///< buffer size
|
uint16_t size ; ///< buffer size
|
||||||
volatile uint16_t len; ///< bytes in fifo
|
volatile uint16_t len ; ///< bytes in fifo
|
||||||
volatile uint16_t wr_ptr; ///< write pointer
|
volatile uint16_t wr_ptr ; ///< write pointer
|
||||||
volatile uint16_t rd_ptr; ///< read pointer
|
volatile uint16_t rd_ptr ; ///< read pointer
|
||||||
bool overwritable; ///< allow overwrite data when full
|
bool overwritable ; ///< allow overwrite data when full
|
||||||
IRQn_Type irq; ///< interrupt used to lock fifo
|
IRQn_Type irq ; ///< interrupt used to lock fifo
|
||||||
} fifo_t;
|
} fifo_t;
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@ -56,100 +56,106 @@
|
|||||||
|
|
||||||
/// USB Standard Device Descriptor (section 9.6.1, table 9-8)
|
/// USB Standard Device Descriptor (section 9.6.1, table 9-8)
|
||||||
typedef ATTR_PREPACKED struct ATTR_PACKED {
|
typedef ATTR_PREPACKED struct ATTR_PACKED {
|
||||||
uint8_t bLength ; ///< Size of this descriptor in bytes.
|
uint8_t bLength ; ///< Size of this descriptor in bytes.
|
||||||
uint8_t bDescriptorType ; ///< DEVICE Descriptor Type.
|
uint8_t bDescriptorType ; ///< DEVICE Descriptor Type.
|
||||||
uint16_t bcdUSB ; ///< BUSB Specification Release Number in Binary-Coded Decimal (i.e., 2.10 is 210H). This field identifies the release of the USB Specification with which the device and its descriptors are compliant.
|
uint16_t bcdUSB ; ///< BUSB Specification Release Number in Binary-Coded Decimal (i.e., 2.10 is 210H). This field identifies the release of the USB Specification with which the device and its descriptors are compliant.
|
||||||
|
|
||||||
uint8_t bDeviceClass ; ///< Class code (assigned by the USB-IF). \li If this field is reset to zero, each interface within a configuration specifies its own class information and the various interfaces operate independently. \li If this field is set to a value between 1 and FEH, the device supports different class specifications on different interfaces and the interfaces may not operate independently. This value identifies the class definition used for the aggregate interfaces. \li If this field is set to FFH, the device class is vendor-specific.
|
uint8_t bDeviceClass ; ///< Class code (assigned by the USB-IF). \li If this field is reset to zero, each interface within a configuration specifies its own class information and the various interfaces operate independently. \li If this field is set to a value between 1 and FEH, the device supports different class specifications on different interfaces and the interfaces may not operate independently. This value identifies the class definition used for the aggregate interfaces. \li If this field is set to FFH, the device class is vendor-specific.
|
||||||
uint8_t bDeviceSubClass ; ///< Subclass code (assigned by the USB-IF). These codes are qualified by the value of the bDeviceClass field. \li If the bDeviceClass field is reset to zero, this field must also be reset to zero. \li If the bDeviceClass field is not set to FFH, all values are reserved for assignment by the USB-IF.
|
uint8_t bDeviceSubClass ; ///< Subclass code (assigned by the USB-IF). These codes are qualified by the value of the bDeviceClass field. \li If the bDeviceClass field is reset to zero, this field must also be reset to zero. \li If the bDeviceClass field is not set to FFH, all values are reserved for assignment by the USB-IF.
|
||||||
uint8_t bDeviceProtocol ; ///< Protocol code (assigned by the USB-IF). These codes are qualified by the value of the bDeviceClass and the bDeviceSubClass fields. If a device supports class-specific protocols on a device basis as opposed to an interface basis, this code identifies the protocols that the device uses as defined by the specification of the device class. \li If this field is reset to zero, the device does not use class-specific protocols on a device basis. However, it may use classspecific protocols on an interface basis. \li If this field is set to FFH, the device uses a vendor-specific protocol on a device basis.
|
uint8_t bDeviceProtocol ; ///< Protocol code (assigned by the USB-IF). These codes are qualified by the value of the bDeviceClass and the bDeviceSubClass fields. If a device supports class-specific protocols on a device basis as opposed to an interface basis, this code identifies the protocols that the device uses as defined by the specification of the device class. \li If this field is reset to zero, the device does not use class-specific protocols on a device basis. However, it may use classspecific protocols on an interface basis. \li If this field is set to FFH, the device uses a vendor-specific protocol on a device basis.
|
||||||
uint8_t bMaxPacketSize0 ; ///< Maximum packet size for endpoint zero (only 8, 16, 32, or 64 are valid). For HS devices is fixed to 64.
|
uint8_t bMaxPacketSize0 ; ///< Maximum packet size for endpoint zero (only 8, 16, 32, or 64 are valid). For HS devices is fixed to 64.
|
||||||
|
|
||||||
uint16_t idVendor ; ///< Vendor ID (assigned by the USB-IF).
|
uint16_t idVendor ; ///< Vendor ID (assigned by the USB-IF).
|
||||||
uint16_t idProduct ; ///< Product ID (assigned by the manufacturer).
|
uint16_t idProduct ; ///< Product ID (assigned by the manufacturer).
|
||||||
uint16_t bcdDevice ; ///< Device release number in binary-coded decimal.
|
uint16_t bcdDevice ; ///< Device release number in binary-coded decimal.
|
||||||
uint8_t iManufacturer ; ///< Index of string descriptor describing manufacturer.
|
uint8_t iManufacturer ; ///< Index of string descriptor describing manufacturer.
|
||||||
uint8_t iProduct ; ///< Index of string descriptor describing product.
|
uint8_t iProduct ; ///< Index of string descriptor describing product.
|
||||||
uint8_t iSerialNumber ; ///< Index of string descriptor describing the device's serial number.
|
uint8_t iSerialNumber ; ///< Index of string descriptor describing the device's serial number.
|
||||||
uint8_t bNumConfigurations ; ///< Number of possible configurations.
|
uint8_t bNumConfigurations ; ///< Number of possible configurations.
|
||||||
} USB_Descriptor_Device_t;
|
} USB_Descriptor_Device_t;
|
||||||
|
|
||||||
/// USB Standard Configuration Descriptor (section 9.6.1 table 9-10) */
|
/// USB Standard Configuration Descriptor (section 9.6.1 table 9-10) */
|
||||||
typedef ATTR_PREPACKED struct ATTR_PACKED {
|
typedef ATTR_PREPACKED struct ATTR_PACKED {
|
||||||
uint8_t bLength ; ///< Size of this descriptor in bytes
|
uint8_t bLength ; ///< Size of this descriptor in bytes
|
||||||
uint8_t bDescriptorType ; ///< CONFIGURATION Descriptor Type
|
uint8_t bDescriptorType ; ///< CONFIGURATION Descriptor Type
|
||||||
uint16_t wTotalLength ; ///< Total length of data returned for this configuration. Includes the combined length of all descriptors (configuration, interface, endpoint, and class- or vendor-specific) returned for this configuration.
|
uint16_t wTotalLength ; ///< Total length of data returned for this configuration. Includes the combined length of all descriptors (configuration, interface, endpoint, and class- or vendor-specific) returned for this configuration.
|
||||||
uint8_t bNumInterfaces ; ///< Number of interfaces supported by this configuration
|
uint8_t bNumInterfaces ; ///< Number of interfaces supported by this configuration
|
||||||
uint8_t bConfigurationValue ; ///< Value to use as an argument to the SetConfiguration() request to select this configuration.
|
uint8_t bConfigurationValue ; ///< Value to use as an argument to the SetConfiguration() request to select this configuration.
|
||||||
uint8_t iConfiguration ; ///< Index of string descriptor describing this configuration
|
uint8_t iConfiguration ; ///< Index of string descriptor describing this configuration
|
||||||
uint8_t bmAttributes ; ///< Configuration characteristics \n D7: Reserved (set to one)\n D6: Self-powered \n D5: Remote Wakeup \n D4...0: Reserved (reset to zero) \n D7 is reserved and must be set to one for historical reasons. \n A device configuration that uses power from the bus and a local source reports a non-zero value in bMaxPower to indicate the amount of bus power required and sets D6. The actual power source at runtime may be determined using the GetStatus(DEVICE) request (see USB 2.0 spec Section 9.4.5). \n If a device configuration supports remote wakeup, D5 is set to one.
|
uint8_t bmAttributes ; ///< Configuration characteristics \n D7: Reserved (set to one)\n D6: Self-powered \n D5: Remote Wakeup \n D4...0: Reserved (reset to zero) \n D7 is reserved and must be set to one for historical reasons. \n A device configuration that uses power from the bus and a local source reports a non-zero value in bMaxPower to indicate the amount of bus power required and sets D6. The actual power source at runtime may be determined using the GetStatus(DEVICE) request (see USB 2.0 spec Section 9.4.5). \n If a device configuration supports remote wakeup, D5 is set to one.
|
||||||
uint8_t bMaxPower ; ///< Maximum power consumption of the USB device from the bus in this specific configuration when the device is fully operational. Expressed in 2 mA units (i.e., 50 = 100 mA).
|
uint8_t bMaxPower ; ///< Maximum power consumption of the USB device from the bus in this specific configuration when the device is fully operational. Expressed in 2 mA units (i.e., 50 = 100 mA).
|
||||||
} USB_Descriptor_Configuration_t;
|
} USB_Descriptor_Configuration_t;
|
||||||
|
|
||||||
/// USB Standard Interface Descriptor (section 9.6.1 table 9-12)
|
/// USB Standard Interface Descriptor (section 9.6.1 table 9-12)
|
||||||
typedef ATTR_PREPACKED struct ATTR_PACKED {
|
typedef ATTR_PREPACKED struct ATTR_PACKED {
|
||||||
uint8_t bLength; ///< Size of this descriptor in bytes
|
uint8_t bLength ; ///< Size of this descriptor in bytes
|
||||||
uint8_t bDescriptorType; ///< INTERFACE Descriptor Type
|
uint8_t bDescriptorType ; ///< INTERFACE Descriptor Type
|
||||||
uint8_t bInterfaceNumber; ///< Number of this interface. Zero-based value identifying the index in the array of concurrent interfaces supported by this configuration.
|
uint8_t bInterfaceNumber ; ///< Number of this interface. Zero-based value identifying the index in the array of concurrent interfaces supported by this configuration.
|
||||||
uint8_t bAlternateSetting; ///< Value used to select this alternate setting for the interface identified in the prior field
|
uint8_t bAlternateSetting ; ///< Value used to select this alternate setting for the interface identified in the prior field
|
||||||
uint8_t bNumEndpoints; ///< Number of endpoints used by this interface (excluding endpoint zero). If this value is zero, this interface only uses the Default Control Pipe.
|
uint8_t bNumEndpoints ; ///< Number of endpoints used by this interface (excluding endpoint zero). If this value is zero, this interface only uses the Default Control Pipe.
|
||||||
uint8_t bInterfaceClass; ///< Class code (assigned by the USB-IF). \li A value of zero is reserved for future standardization. \li If this field is set to FFH, the interface class is vendor-specific. \li All other values are reserved for assignment by the USB-IF.
|
uint8_t bInterfaceClass ; ///< Class code (assigned by the USB-IF). \li A value of zero is reserved for future standardization. \li If this field is set to FFH, the interface class is vendor-specific. \li All other values are reserved for assignment by the USB-IF.
|
||||||
uint8_t bInterfaceSubClass; ///< Subclass code (assigned by the USB-IF). \n These codes are qualified by the value of the bInterfaceClass field. \li If the bInterfaceClass field is reset to zero, this field must also be reset to zero. \li If the bInterfaceClass field is not set to FFH, all values are reserved for assignment by the USB-IF.
|
uint8_t bInterfaceSubClass ; ///< Subclass code (assigned by the USB-IF). \n These codes are qualified by the value of the bInterfaceClass field. \li If the bInterfaceClass field is reset to zero, this field must also be reset to zero. \li If the bInterfaceClass field is not set to FFH, all values are reserved for assignment by the USB-IF.
|
||||||
uint8_t bInterfaceProtocol; ///< Protocol code (assigned by the USB). \n These codes are qualified by the value of the bInterfaceClass and the bInterfaceSubClass fields. If an interface supports class-specific requests, this code identifies the protocols that the device uses as defined by the specification of the device class. \li If this field is reset to zero, the device does not use a class-specific protocol on this interface. \li If this field is set to FFH, the device uses a vendor-specific protocol for this interface.
|
uint8_t bInterfaceProtocol ; ///< Protocol code (assigned by the USB). \n These codes are qualified by the value of the bInterfaceClass and the bInterfaceSubClass fields. If an interface supports class-specific requests, this code identifies the protocols that the device uses as defined by the specification of the device class. \li If this field is reset to zero, the device does not use a class-specific protocol on this interface. \li If this field is set to FFH, the device uses a vendor-specific protocol for this interface.
|
||||||
uint8_t iInterface; ///< Index of string descriptor describing this interface
|
uint8_t iInterface ; ///< Index of string descriptor describing this interface
|
||||||
}USB_Descriptor_Interface_t ;
|
}USB_Descriptor_Interface_t;
|
||||||
|
|
||||||
/// USB Standard Endpoint Descriptor (section 9.6.1 table 9-13)
|
/// USB Standard Endpoint Descriptor (section 9.6.1 table 9-13)
|
||||||
typedef ATTR_PREPACKED struct ATTR_PACKED {
|
typedef ATTR_PREPACKED struct ATTR_PACKED {
|
||||||
uint8_t bLength ; ///< Size of this descriptor in bytes
|
uint8_t bLength ; ///< Size of this descriptor in bytes
|
||||||
uint8_t bDescriptorType ; ///< ENDPOINT Descriptor Type
|
uint8_t bDescriptorType ; ///< ENDPOINT Descriptor Type
|
||||||
uint8_t bEndpointAddress ; ///< The address of the endpoint on the USB device described by this descriptor. The address is encoded as follows: \n Bit 3...0: The endpoint number \n Bit 6...4: Reserved, reset to zero \n Bit 7: Direction, ignored for control endpoints 0 = OUT endpoint 1 = IN endpoint.
|
uint8_t bEndpointAddress ; ///< The address of the endpoint on the USB device described by this descriptor. The address is encoded as follows: \n Bit 3...0: The endpoint number \n Bit 6...4: Reserved, reset to zero \n Bit 7: Direction, ignored for control endpoints 0 = OUT endpoint 1 = IN endpoint.
|
||||||
uint8_t bmAttributes ; ///< This field describes the endpoint's attributes when it is configured using the bConfigurationValue. \n Bits 1..0: Transfer Type \n- 00 = Control \n- 01 = Isochronous \n- 10 = Bulk \n- 11 = Interrupt \n If not an isochronous endpoint, bits 5..2 are reserved and must be set to zero. If isochronous, they are defined as follows: \n Bits 3..2: Synchronization Type \n- 00 = No Synchronization \n- 01 = Asynchronous \n- 10 = Adaptive \n- 11 = Synchronous \n Bits 5..4: Usage Type \n- 00 = Data endpoint \n- 01 = Feedback endpoint \n- 10 = Implicit feedback Data endpoint \n- 11 = Reserved \n Refer to Chapter 5 of USB 2.0 specification for more information. \n All other bits are reserved and must be reset to zero. Reserved bits must be ignored by the host.
|
uint8_t bmAttributes ; ///< This field describes the endpoint's attributes when it is configured using the bConfigurationValue. \n Bits 1..0: Transfer Type \n- 00 = Control \n- 01 = Isochronous \n- 10 = Bulk \n- 11 = Interrupt \n If not an isochronous endpoint, bits 5..2 are reserved and must be set to zero. If isochronous, they are defined as follows: \n Bits 3..2: Synchronization Type \n- 00 = No Synchronization \n- 01 = Asynchronous \n- 10 = Adaptive \n- 11 = Synchronous \n Bits 5..4: Usage Type \n- 00 = Data endpoint \n- 01 = Feedback endpoint \n- 10 = Implicit feedback Data endpoint \n- 11 = Reserved \n Refer to Chapter 5 of USB 2.0 specification for more information. \n All other bits are reserved and must be reset to zero. Reserved bits must be ignored by the host.
|
||||||
uint16_t wMaxPacketSize ; ///< Maximum packet size this endpoint is capable of sending or receiving when this configuration is selected. \n For isochronous endpoints, this value is used to reserve the bus time in the schedule, required for the per-(micro)frame data payloads. The pipe may, on an ongoing basis, actually use less bandwidth than that reserved. The device reports, if necessary, the actual bandwidth used via its normal, non-USB defined mechanisms. \n For all endpoints, bits 10..0 specify the maximum packet size (in bytes). \n For high-speed isochronous and interrupt endpoints: \n Bits 12..11 specify the number of additional transaction opportunities per microframe: \n- 00 = None (1 transaction per microframe) \n- 01 = 1 additional (2 per microframe) \n- 10 = 2 additional (3 per microframe) \n- 11 = Reserved \n Bits 15..13 are reserved and must be set to zero.
|
uint16_t wMaxPacketSize ; ///< Maximum packet size this endpoint is capable of sending or receiving when this configuration is selected. \n For isochronous endpoints, this value is used to reserve the bus time in the schedule, required for the per-(micro)frame data payloads. The pipe may, on an ongoing basis, actually use less bandwidth than that reserved. The device reports, if necessary, the actual bandwidth used via its normal, non-USB defined mechanisms. \n For all endpoints, bits 10..0 specify the maximum packet size (in bytes). \n For high-speed isochronous and interrupt endpoints: \n Bits 12..11 specify the number of additional transaction opportunities per microframe: \n- 00 = None (1 transaction per microframe) \n- 01 = 1 additional (2 per microframe) \n- 10 = 2 additional (3 per microframe) \n- 11 = Reserved \n Bits 15..13 are reserved and must be set to zero.
|
||||||
uint8_t bInterval ; ///< Interval for polling endpoint for data transfers. Expressed in frames or microframes depending on the device operating speed (i.e., either 1 millisecond or 125 us units). \n- For full-/high-speed isochronous endpoints, this value must be in the range from 1 to 16. The bInterval value is used as the exponent for a \f$ 2^(bInterval-1) \f$ value; e.g., a bInterval of 4 means a period of 8 (\f$ 2^(4-1) \f$). \n- For full-/low-speed interrupt endpoints, the value of this field may be from 1 to 255. \n- For high-speed interrupt endpoints, the bInterval value is used as the exponent for a \f$ 2^(bInterval-1) \f$ value; e.g., a bInterval of 4 means a period of 8 (\f$ 2^(4-1) \f$) . This value must be from 1 to 16. \n- For high-speed bulk/control OUT endpoints, the bInterval must specify the maximum NAK rate of the endpoint. A value of 0 indicates the endpoint never NAKs. Other values indicate at most 1 NAK each bInterval number of microframes. This value must be in the range from 0 to 255. \n Refer to Chapter 5 of USB 2.0 specification for more information.
|
uint8_t bInterval ; ///< Interval for polling endpoint for data transfers. Expressed in frames or microframes depending on the device operating speed (i.e., either 1 millisecond or 125 us units). \n- For full-/high-speed isochronous endpoints, this value must be in the range from 1 to 16. The bInterval value is used as the exponent for a \f$ 2^(bInterval-1) \f$ value; e.g., a bInterval of 4 means a period of 8 (\f$ 2^(4-1) \f$). \n- For full-/low-speed interrupt endpoints, the value of this field may be from 1 to 255. \n- For high-speed interrupt endpoints, the bInterval value is used as the exponent for a \f$ 2^(bInterval-1) \f$ value; e.g., a bInterval of 4 means a period of 8 (\f$ 2^(4-1) \f$) . This value must be from 1 to 16. \n- For high-speed bulk/control OUT endpoints, the bInterval must specify the maximum NAK rate of the endpoint. A value of 0 indicates the endpoint never NAKs. Other values indicate at most 1 NAK each bInterval number of microframes. This value must be in the range from 0 to 255. \n Refer to Chapter 5 of USB 2.0 specification for more information.
|
||||||
} USB_Descriptor_Endpoint_t;
|
} USB_Descriptor_Endpoint_t;
|
||||||
|
|
||||||
/// USB Other Speed Configuration Descriptor (section 9.6.1 table 9-11)
|
/// USB Other Speed Configuration Descriptor (section 9.6.1 table 9-11)
|
||||||
typedef ATTR_PREPACKED struct ATTR_PACKED {
|
typedef ATTR_PREPACKED struct ATTR_PACKED {
|
||||||
uint8_t bLength ; ///< Size of descriptor
|
uint8_t bLength ; ///< Size of descriptor
|
||||||
uint8_t bDescriptorType ; ///< Other_speed_Configuration Type
|
uint8_t bDescriptorType ; ///< Other_speed_Configuration Type
|
||||||
uint16_t wTotalLength ; ///< Total length of data returned
|
uint16_t wTotalLength ; ///< Total length of data returned
|
||||||
uint8_t bNumInterfaces ; ///< Number of interfaces supported by this speed configuration
|
uint8_t bNumInterfaces ; ///< Number of interfaces supported by this speed configuration
|
||||||
uint8_t bConfigurationValue ; ///< Value to use to select configuration
|
uint8_t bConfigurationValue ; ///< Value to use to select configuration
|
||||||
uint8_t IConfiguration ; ///< Index of string descriptor
|
uint8_t IConfiguration ; ///< Index of string descriptor
|
||||||
uint8_t bmAttributes ; ///< Same as Configuration descriptor
|
uint8_t bmAttributes ; ///< Same as Configuration descriptor
|
||||||
uint8_t bMaxPower ; ///< Same as Configuration descriptor
|
uint8_t bMaxPower ; ///< Same as Configuration descriptor
|
||||||
} USB_Descriptor_OtherSpeed_t;
|
} USB_Descriptor_OtherSpeed_t;
|
||||||
|
|
||||||
/// USB Device Qualifier Descriptor (section 9.6.1 table 9-9)
|
/// USB Device Qualifier Descriptor (section 9.6.1 table 9-9)
|
||||||
typedef ATTR_PREPACKED struct ATTR_PACKED {
|
typedef ATTR_PREPACKED struct ATTR_PACKED {
|
||||||
uint8_t bLength ; ///< Size of descriptor
|
uint8_t bLength ; ///< Size of descriptor
|
||||||
uint8_t bDescriptorType ; ///< Device Qualifier Type
|
uint8_t bDescriptorType ; ///< Device Qualifier Type
|
||||||
uint16_t bcdUSB ; ///< USB specification version number (e.g., 0200H for V2.00)
|
uint16_t bcdUSB ; ///< USB specification version number (e.g., 0200H for V2.00)
|
||||||
uint8_t bDeviceClass ; ///< Class Code
|
uint8_t bDeviceClass ; ///< Class Code
|
||||||
uint8_t bDeviceSubClass ; ///< SubClass Code
|
uint8_t bDeviceSubClass ; ///< SubClass Code
|
||||||
uint8_t bDeviceProtocol ; ///< Protocol Code
|
uint8_t bDeviceProtocol ; ///< Protocol Code
|
||||||
uint8_t bMaxPacketSize0 ; ///< Maximum packet size for other speed
|
uint8_t bMaxPacketSize0 ; ///< Maximum packet size for other speed
|
||||||
uint8_t bNumConfigurations ; ///< Number of Other-speed Configurations
|
uint8_t bNumConfigurations ; ///< Number of Other-speed Configurations
|
||||||
uint8_t bReserved ; ///< Reserved for future use, must be zero
|
uint8_t bReserved ; ///< Reserved for future use, must be zero
|
||||||
} USB_Descriptor_DeviceQualifier_t;
|
} USB_Descriptor_DeviceQualifier_t;
|
||||||
|
|
||||||
/// USB Interface Association Descriptor (IAD ECN)
|
/// USB Interface Association Descriptor (IAD ECN)
|
||||||
typedef ATTR_PREPACKED struct ATTR_PACKED
|
typedef ATTR_PREPACKED struct ATTR_PACKED
|
||||||
{
|
{
|
||||||
uint8_t bLength; ///< Size of descriptor
|
uint8_t bLength ; ///< Size of descriptor
|
||||||
uint8_t bDescriptorType; ///< Other_speed_Configuration Type
|
uint8_t bDescriptorType ; ///< Other_speed_Configuration Type
|
||||||
|
|
||||||
uint8_t bFirstInterface; ///< Index of the first associated interface.
|
uint8_t bFirstInterface ; ///< Index of the first associated interface.
|
||||||
uint8_t bInterfaceCount; ///< Total number of associated interfaces.
|
uint8_t bInterfaceCount ; ///< Total number of associated interfaces.
|
||||||
|
|
||||||
uint8_t bFunctionClass; ///< Interface class ID.
|
uint8_t bFunctionClass ; ///< Interface class ID.
|
||||||
uint8_t bFunctionSubClass; ///< Interface subclass ID.
|
uint8_t bFunctionSubClass ; ///< Interface subclass ID.
|
||||||
uint8_t bFunctionProtocol; ///< Interface protocol ID.
|
uint8_t bFunctionProtocol ; ///< Interface protocol ID.
|
||||||
|
|
||||||
uint8_t iFunction; ///< Index of the string descriptor describing the interface association.
|
uint8_t iFunction ; ///< Index of the string descriptor describing the interface association.
|
||||||
} USB_Descriptor_InterfaceAssociation_t;
|
} USB_Descriptor_InterfaceAssociation_t;
|
||||||
|
|
||||||
|
/// USB Header Descriptor
|
||||||
|
typedef ATTR_PREPACKED struct ATTR_PACKED
|
||||||
|
{
|
||||||
|
uint8_t bLength ; ///< Size of this descriptor in bytes
|
||||||
|
uint8_t bDescriptorType ; ///< Descriptor Type
|
||||||
|
} USB_Descriptor_Header_t;
|
||||||
|
|
||||||
#ifdef __cplusplus
|
#ifdef __cplusplus
|
||||||
}
|
}
|
||||||
|
|||||||
@ -77,33 +77,33 @@ typedef enum {
|
|||||||
|
|
||||||
/// USB Descriptor Types (section 9.4 table 9-5)
|
/// USB Descriptor Types (section 9.4 table 9-5)
|
||||||
typedef enum {
|
typedef enum {
|
||||||
DEVICE_DESC=1 , ///< 1
|
DEVICE_DESC=1 , ///< 1
|
||||||
CONFIGURATIONT_DESC , ///< 2
|
CONFIGURATIONT_DESC , ///< 2
|
||||||
STRING_DESC , ///< 3
|
STRING_DESC , ///< 3
|
||||||
INTERFACE_DESC , ///< 4
|
INTERFACE_DESC , ///< 4
|
||||||
ENDPOINT_DESC , ///< 5
|
ENDPOINT_DESC , ///< 5
|
||||||
DEVICE_QUALIFIER_DESC , ///< 6
|
DEVICE_QUALIFIER_DESC , ///< 6
|
||||||
OTHER_SPEED_CONFIGURATION_DESC , ///< 7
|
OTHER_SPEED_CONFIGURATION_DESC , ///< 7
|
||||||
INTERFACE_POWER_DESC , ///< 8
|
INTERFACE_POWER_DESC , ///< 8
|
||||||
OTG_DESC , ///< 9
|
OTG_DESC , ///< 9
|
||||||
DEBUG_DESCRIPTOR , ///< 10
|
DEBUG_DESCRIPTOR , ///< 10
|
||||||
INTERFACE_ASSOCIATION_DESC ///< 11
|
INTERFACE_ASSOCIATION_DESC ///< 11
|
||||||
}USB_DescriptorType_t;
|
}USB_DescriptorType_t;
|
||||||
|
|
||||||
typedef enum {
|
typedef enum {
|
||||||
REQUEST_GET_STATUS =0 , ///< 0
|
REQUEST_GET_STATUS =0 , ///< 0
|
||||||
REQUEST_CLEAR_FEATURE , ///< 1
|
REQUEST_CLEAR_FEATURE , ///< 1
|
||||||
REQUEST_RESERVED , ///< 2
|
REQUEST_RESERVED , ///< 2
|
||||||
REQUEST_SET_FEATURE , ///< 3
|
REQUEST_SET_FEATURE , ///< 3
|
||||||
REQUEST_RESERVED2 , ///< 4
|
REQUEST_RESERVED2 , ///< 4
|
||||||
REQUEST_SET_ADDRESS , ///< 5
|
REQUEST_SET_ADDRESS , ///< 5
|
||||||
REQUEST_GET_DESCRIPTOR , ///< 6
|
REQUEST_GET_DESCRIPTOR , ///< 6
|
||||||
REQUEST_SET_DESCRIPTOR , ///< 7
|
REQUEST_SET_DESCRIPTOR , ///< 7
|
||||||
REQUEST_GET_CONFIGURATION , ///< 8
|
REQUEST_GET_CONFIGURATION , ///< 8
|
||||||
REQUEST_SET_CONFIGURATION , ///< 9
|
REQUEST_SET_CONFIGURATION , ///< 9
|
||||||
REQUEST_GET_INTERFACE , ///< 10
|
REQUEST_GET_INTERFACE , ///< 10
|
||||||
REQUEST_SET_INTERFACE , ///< 11
|
REQUEST_SET_INTERFACE , ///< 11
|
||||||
REQUEST_SYNCH_FRAME ///< 12
|
REQUEST_SYNCH_FRAME ///< 12
|
||||||
}USB_RequestCode_t;
|
}USB_RequestCode_t;
|
||||||
|
|
||||||
#ifdef __cplusplus
|
#ifdef __cplusplus
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user