improving midi support, adding midi exmaple

rename TUSB_DESC_CLASS_SPECIFIC to TUSB_DESC_CS_INTERFACE

5 files changed, 159 insertions, 26 deletions

diff --git a/src/class/audio/audio.h b/src/class/audio/audio.h
index c655e79e2..a6f198581 100644
--- a/src/class/audio/audio.h
+++ b/src/class/audio/audio.h
@@ -29,8 +29,8 @@
  *            Currently only MIDI subclass is supported

  *  @{ */

 

-#ifndef _TUSB_CDC_H__

-#define _TUSB_CDC_H__

+#ifndef _TUSB_AUDIO_H__

+#define _TUSB_AUDIO_H__

 

 #include "common/tusb_common.h"

 

@@ -41,9 +41,9 @@
 /// Audio Interface Subclass Codes

 typedef enum

 {

-  AUDIO_SUBCLASS_AUDIO_CONTROL = 0x01  , ///< Audio Control

-  AUDIO_SUBCLASS_AUDIO_STREAMING       , ///< Audio Streaming

-  AUDIO_SUBCLASS_MIDI_STREAMING       ,  ///< MIDI Streaming

+  AUDIO_SUBCLASS_CONTROL = 0x01  , ///< Audio Control

+  AUDIO_SUBCLASS_STREAMING       , ///< Audio Streaming

+  AUDIO_SUBCLASS_MIDI_STREAMING  ,  ///< MIDI Streaming

 } audio_subclass_type_t;

 

 /// Audio Protocol Codes

@@ -54,6 +54,40 @@ typedef enum
   AUDIO_PROTOCOL_V3                   = 0x30, ///< Version 3.0

 } audio_protocol_type_t;

 

+/// Audio Function Category Codes

+typedef enum

+{

+  AUDIO_FUNC_DESKTOP_SPEAKER    = 0x01,

+  AUDIO_FUNC_HOME_THEATER       = 0x02,

+  AUDIO_FUNC_MICROPHONE         = 0x03,

+  AUDIO_FUNC_HEADSET            = 0x04,

+  AUDIO_FUNC_TELEPHONE          = 0x05,

+  AUDIO_FUNC_CONVERTER          = 0x06,

+  AUDIO_FUNC_SOUND_RECODER      = 0x07,

+  AUDIO_FUNC_IO_BOX             = 0x08,

+  AUDIO_FUNC_MUSICAL_INSTRUMENT = 0x09,

+  AUDIO_FUNC_PRO_AUDIO          = 0x0A,

+  AUDIO_FUNC_AUDIO_VIDEO        = 0x0B,

+  AUDIO_FUNC_CONTROL_PANEL      = 0x0C

+} audio_function_t;

+

+/// Audio Class-Specific AC Interface Descriptor Subtypes

+typedef enum

+{

+  AUDIO_CS_INTERFACE_HEADER                = 0x01,

+  AUDIO_CS_INTERFACE_INPUT_TERMINAL        = 0x02,

+  AUDIO_CS_INTERFACE_OUTPUT_TERMINAL       = 0x03,

+  AUDIO_CS_INTERFACE_MIXER_UNIT            = 0x04,

+  AUDIO_CS_INTERFACE_SELECTOR_UNIT         = 0x05,

+  AUDIO_CS_INTERFACE_FEATURE_UNIT          = 0x06,

+  AUDIO_CS_INTERFACE_EFFECT_UNIT           = 0x07,

+  AUDIO_CS_INTERFACE_PROCESSING_UNIT       = 0x08,

+  AUDIO_CS_INTERFACE_EXTENSION_UNIT        = 0x09,

+  AUDIO_CS_INTERFACE_CLOCK_SOURCE          = 0x0A,

+  AUDIO_CS_INTERFACE_CLOCK_SELECTOR        = 0x0B,

+  AUDIO_CS_INTERFACE_CLOCK_MULTIPLIER      = 0x0C,

+  AUDIO_CS_INTERFACE_SAMPLE_RATE_CONVERTER = 0x0D,

+} audio_cs_interface_subtype_t;

 

 /** @} */

 

diff --git a/src/class/cdc/cdc.h b/src/class/cdc/cdc.h
index 2e865bdbb..9cc8b82e3 100644
--- a/src/class/cdc/cdc.h
+++ b/src/class/cdc/cdc.h
@@ -41,7 +41,7 @@
 /** \defgroup ClassDriver_CDC_Common Common Definitions

  *  @{ */

 

-

+// TODO remove

 /// CDC Pipe ID, used to indicate which pipe the API is addressing to (Notification, Out, In)

 typedef enum

 {

@@ -52,8 +52,9 @@ typedef enum
 }cdc_pipeid_t;

 

 //--------------------------------------------------------------------+

-// CDC COMMUNICATION INTERFACE CLASS

+// CDC Communication Interface Class

 //--------------------------------------------------------------------+

+

 /// Communication Interface Subclass Codes

 typedef enum

 {

@@ -117,7 +118,7 @@ typedef enum
 }cdc_func_desc_type_t;

 

 //--------------------------------------------------------------------+

-// CDC DATA INTERFACE CLASS

+// CDC Data Interface Class

 //--------------------------------------------------------------------+

 

 // SUBCLASS code of Data Interface is not used and should/must be zero

@@ -138,8 +139,9 @@ typedef enum{
 }cdc_data_protocol_type_t;

 

 //--------------------------------------------------------------------+

-// MANAGEMENT ELEMENT REQUEST (CONTROL ENDPOINT)

+// Management Element Request (Control Endpoint)

 //--------------------------------------------------------------------+

+

 /// Communication Interface Management Element Request Codes

 typedef enum

 {

@@ -189,8 +191,9 @@ typedef enum
 }cdc_management_request_t;

 

 //--------------------------------------------------------------------+

-// MANAGEMENT ELEMENENT NOTIFICATION (NOTIFICATION ENDPOINT)

+// Management Elemenent Notification (Notification Endpoint)

 //--------------------------------------------------------------------+

+

 /// Communication Interface Management Element Notification Codes

 typedef enum

 {

@@ -209,14 +212,15 @@ typedef enum
 }cdc_notification_request_t;

 

 //--------------------------------------------------------------------+

-// FUNCTIONAL DESCRIPTOR (COMMUNICATION INTERFACE)

+// Class Specific Functional Descriptor (Communication Interface)

 //--------------------------------------------------------------------+

+

 /// Header Functional Descriptor (Communication Interface)

 typedef struct TU_ATTR_PACKED

 {

   uint8_t bLength            ; ///< Size of this descriptor in bytes.

   uint8_t bDescriptorType    ; ///< Descriptor Type, must be Class-Specific

-  uint8_t bDescriptorSubType ; ///< Descriptor SubType one of above CDC_FUCN_DESC_

+  uint8_t bDescriptorSubType ; ///< Descriptor SubType one of above CDC_FUNC_DESC_

   uint16_t bcdCDC            ; ///< CDC release number in Binary-Coded Decimal

 }cdc_desc_func_header_t;

 

@@ -246,7 +250,7 @@ typedef struct TU_ATTR_PACKED
   uint8_t bDescriptorType     ; ///< Descriptor Type, must be Class-Specific

   uint8_t bDescriptorSubType  ; ///< Descriptor SubType one of above CDC_FUCN_DESC_

   uint8_t iCountryCodeRelDate ; ///< Index of a string giving the release date for the implemented ISO 3166 Country Codes.

-  uint16_t wCountryCode[]     ; ///< Country code in the format as defined in [ISO3166], release date as specified inoffset 3 for the first supported country.

+  uint16_t wCountryCode       ; ///< Country code in the format as defined in [ISO3166], release date as specified inoffset 3 for the first supported country.

 }cdc_desc_func_country_selection_t;

 

 #define cdc_desc_func_country_selection_n_t(no_country) \

diff --git a/src/class/cdc/cdc_device.c b/src/class/cdc/cdc_device.c
index 0a41147c9..d9e128307 100644
--- a/src/class/cdc/cdc_device.c
+++ b/src/class/cdc/cdc_device.c
@@ -265,7 +265,7 @@ bool cdcd_open(uint8_t rhport, tusb_desc_interface_t const * itf_desc, uint16_t
   (*p_length) = sizeof(tusb_desc_interface_t);

 

   // Communication Functional Descriptors

-  while ( TUSB_DESC_CLASS_SPECIFIC == tu_desc_type(p_desc) )

+  while ( TUSB_DESC_CS_INTERFACE == tu_desc_type(p_desc) )

   {

     (*p_length) += tu_desc_len(p_desc);

     p_desc = tu_desc_next(p_desc);

diff --git a/src/class/cdc/cdc_host.c b/src/class/cdc/cdc_host.c
index b64d4a1fe..6a6f508b3 100644
--- a/src/class/cdc/cdc_host.c
+++ b/src/class/cdc/cdc_host.c
@@ -142,7 +142,7 @@ bool cdch_open(uint8_t rhport, uint8_t dev_addr, tusb_desc_interface_t const *it
   (*p_length) = sizeof(tusb_desc_interface_t);

 

   // Communication Functional Descriptors

-  while( TUSB_DESC_CLASS_SPECIFIC == p_desc[DESC_OFFSET_TYPE] )

+  while( TUSB_DESC_CS_INTERFACE == p_desc[DESC_OFFSET_TYPE] )

   {

     if ( CDC_FUNC_DESC_ABSTRACT_CONTROL_MANAGEMENT == cdc_functional_desc_typeof(p_desc) )

     {

diff --git a/src/class/midi/midi.h b/src/class/midi/midi.h
index 50f2be679..b3cc17af9 100644
--- a/src/class/midi/midi.h
+++ b/src/class/midi/midi.h
@@ -39,27 +39,122 @@
 #endif

 

 //--------------------------------------------------------------------+

-// FUNCTIONAL DESCRIPTOR (COMMUNICATION INTERFACE)

+// Class Specific Descriptor

 //--------------------------------------------------------------------+

-/// Header Functional Descriptor (Communication Interface)

+

+typedef enum

+{

+  MIDI_CS_INTERFACE_HEADER    = 0x01,

+  MIDI_CS_INTERFACE_IN_JACK   = 0x02,

+  MIDI_CS_INTERFACE_OUT_JACK  = 0x03,

+  MIDI_CS_INTERFACE_ELEMENT   = 0x04,

+} midi_cs_interface_subtype_t;

+

+typedef enum

+{

+  MIDI_CS_ENDPOINT_GENERAL = 0x01

+} midi_cs_endpoint_subtype_t;

+

+typedef enum

+{

+  MIDI_JACK_EMBEDDED = 0x01,

+  MIDI_JACK_EXTERNAL = 0x02

+} midi_jack_type_t;

+

+/// MIDI Interface Header Descriptor

 typedef struct TU_ATTR_PACKED

 {

   uint8_t bLength            ; ///< Size of this descriptor in bytes.

   uint8_t bDescriptorType    ; ///< Descriptor Type, must be Class-Specific

-  uint8_t bDescriptorSubType ; ///< Descriptor SubType one of above MIDI_FUCN_DESC_

+  uint8_t bDescriptorSubType ; ///< Descriptor SubType

   uint16_t bcdMSC            ; ///< MidiStreaming SubClass release number in Binary-Coded Decimal

   uint16_t wTotalLength      ;

-}midi_desc_func_header_t;

+} midi_desc_header_t;

+

+/// MIDI In Jack Descriptor

+typedef struct TU_ATTR_PACKED

+{

+  uint8_t bLength            ; ///< Size of this descriptor in bytes.

+  uint8_t bDescriptorType    ; ///< Descriptor Type, must be Class-Specific

+  uint8_t bDescriptorSubType ; ///< Descriptor SubType

+  uint8_t bJackType          ; ///< Embedded or External

+  uint8_t bJackID            ; ///< Unique ID for MIDI IN Jack

+  uint8_t iJack              ; ///< string descriptor

+} midi_desc_in_jack_t;

+

+

+/// MIDI Out Jack Descriptor with single pin

+typedef struct TU_ATTR_PACKED

+{

+  uint8_t bLength            ; ///< Size of this descriptor in bytes.

+  uint8_t bDescriptorType    ; ///< Descriptor Type, must be Class-Specific

+  uint8_t bDescriptorSubType ; ///< Descriptor SubType

+  uint8_t bJackType          ; ///< Embedded or External

+  uint8_t bJackID            ; ///< Unique ID for MIDI IN Jack

+  uint8_t bNrInputPins;

+

+  uint8_t baSourceID;

+  uint8_t baSourcePin;

+

+  uint8_t iJack              ; ///< string descriptor

+} midi_desc_out_jack_t ;

+

+/// MIDI Out Jack Descriptor with multiple pins

+#define midi_desc_out_jack_n_t(input_num) \

+  struct TU_ATTR_PACKED { \

+    uint8_t bLength            ; \

+    uint8_t bDescriptorType    ; \

+    uint8_t bDescriptorSubType ; \

+    uint8_t bJackType          ; \

+    uint8_t bJackID            ; \

+    uint8_t bNrInputPins       ; \

+    struct TU_ATTR_PACKED {      \

+        uint8_t baSourceID;      \

+        uint8_t baSourcePin;     \

+    } pins[input_num];           \

+   uint8_t iJack              ;  \

+  }

 

-/// Union Functional Descriptor (Communication Interface)

+/// MIDI Element Descriptor

 typedef struct TU_ATTR_PACKED

 {

-  uint8_t bLength                  ; ///< Size of this descriptor in bytes.

-  uint8_t bDescriptorType          ; ///< Descriptor Type, must be Class-Specific

-  uint8_t bDescriptorSubType       ; ///< Descriptor SubType one of above CDC_FUCN_DESC_

-  uint8_t bControlInterface        ; ///< Interface number of Communication Interface

-  uint8_t bSubordinateInterface    ; ///< Array of Interface number of Data Interface

-}cdc_desc_func_union_t;

+  uint8_t bLength            ; ///< Size of this descriptor in bytes.

+  uint8_t bDescriptorType    ; ///< Descriptor Type, must be Class-Specific

+  uint8_t bDescriptorSubType ; ///< Descriptor SubType

+  uint8_t bElementID;

+

+  uint8_t bNrInputPins;

+  uint8_t baSourceID;

+  uint8_t baSourcePin;

+

+  uint8_t bNrOutputPins;

+  uint8_t bInTerminalLink;

+  uint8_t bOutTerminalLink;

+  uint8_t bElCapsSize;

+

+  uint16_t bmElementCaps;

+  uint8_t  iElement;

+} midi_desc_element_t;

+

+/// MIDI Element Descriptor with multiple pins

+#define midi_desc_element_n_t(input_num) \

+  struct TU_ATTR_PACKED {       \

+    uint8_t bLength;            \

+    uint8_t bDescriptorType;    \

+    uint8_t bDescriptorSubType; \

+    uint8_t bElementID;         \

+    uint8_t bNrInputPins;       \

+    struct TU_ATTR_PACKED {     \

+        uint8_t baSourceID;     \

+        uint8_t baSourcePin;    \

+    } pins[input_num];          \

+    uint8_t bNrOutputPins;      \

+    uint8_t bInTerminalLink;    \

+    uint8_t bOutTerminalLink;   \

+    uint8_t bElCapsSize;        \

+    uint16_t bmElementCaps;     \

+    uint8_t  iElement;          \

+ }

 

 /** @} */