adding device custom class support

add usbd_open_edpt_pair

7 files changed, 264 insertions, 80 deletions

diff --git a/tinyusb/class/cdc/cdc_device.c b/tinyusb/class/cdc/cdc_device.c
index 506407179..90e1924b4 100644
--- a/tinyusb/class/cdc/cdc_device.c
+++ b/tinyusb/class/cdc/cdc_device.c
@@ -55,14 +55,14 @@ CFG_TUSB_ATTR_USBRAM STATIC_VAR cdc_line_coding_t cdcd_line_coding[CONTROLLER_DE
 

 typedef struct {

   uint8_t itf_num;

+  uint8_t ep_notif;

+  uint8_t ep_in;

+  uint8_t ep_out;

+

   cdc_acm_capability_t acm_cap;

 

   // Bit 0:  DTR (Data Terminal Ready), Bit 1: RTS (Request to Send)

   uint8_t line_state;

-

-  uint8_t ep_notif;

-  uint8_t ep_in;

-  uint8_t ep_out;

 }cdcd_interface_t;

 

 // TODO multiple rhport

@@ -203,31 +203,16 @@ tusb_error_t cdcd_open(uint8_t rhport, tusb_desc_interface_t const * p_interface
 

   //------------- Data Interface (if any) -------------//

   if ( (TUSB_DESC_INTERFACE == p_desc[DESCRIPTOR_OFFSET_TYPE]) &&

-       (TUSB_CLASS_CDC_DATA      == ((tusb_desc_interface_t const *) p_desc)->bInterfaceClass) )

+       (TUSB_CLASS_CDC_DATA == ((tusb_desc_interface_t const *) p_desc)->bInterfaceClass) )

   {

     (*p_length) += p_desc[DESCRIPTOR_OFFSET_LENGTH];

     p_desc = descriptor_next(p_desc);

 

-    // data endpoints expected to be in pairs

-    for(uint32_t i=0; i<2; i++)

-    {

-      tusb_desc_endpoint_t const *p_endpoint = (tusb_desc_endpoint_t const *) p_desc;

-      TU_ASSERT(TUSB_DESC_ENDPOINT == p_endpoint->bDescriptorType, TUSB_ERROR_DESCRIPTOR_CORRUPTED);

-      TU_ASSERT(TUSB_XFER_BULK == p_endpoint->bmAttributes.xfer, TUSB_ERROR_DESCRIPTOR_CORRUPTED);

-

-      TU_ASSERT( dcd_edpt_open(rhport, p_endpoint), TUSB_ERROR_DCD_OPEN_PIPE_FAILED);

+    // Open endpoint pair with usbd helper

+    tusb_desc_endpoint_t const *p_desc_ep = (tusb_desc_endpoint_t const *) p_desc;

+    TU_ASSERT_ERR( usbd_open_edpt_pair(rhport, p_desc_ep, TUSB_XFER_BULK, &p_cdc->ep_out, &p_cdc->ep_in) );

 

-      if ( p_endpoint->bEndpointAddress &  TUSB_DIR_IN_MASK )

-      {

-        p_cdc->ep_in = p_endpoint->bEndpointAddress;

-      }else

-      {

-        p_cdc->ep_out = p_endpoint->bEndpointAddress;

-      }

-

-      (*p_length) += p_desc[DESCRIPTOR_OFFSET_LENGTH];

-      p_desc = descriptor_next( p_desc );

-    }

+    (*p_length) += 2*sizeof(tusb_desc_endpoint_t);

   }

 

   p_cdc->itf_num   = p_interface_desc->bInterfaceNumber;

@@ -235,7 +220,6 @@ tusb_error_t cdcd_open(uint8_t rhport, tusb_desc_interface_t const * p_interface
   // Prepare for incoming data

   TU_ASSERT( dcd_edpt_xfer(rhport, p_cdc->ep_out, _tmp_rx_buf, sizeof(_tmp_rx_buf)), TUSB_ERROR_DCD_EDPT_XFER);

 

-

   return TUSB_ERROR_NONE;

 }

 

diff --git a/tinyusb/class/custom/custom_device.c b/tinyusb/class/custom/custom_device.c
new file mode 100644
index 000000000..3d0453001
--- /dev/null
+++ b/tinyusb/class/custom/custom_device.c
@@ -0,0 +1,105 @@
+/**************************************************************************/
+/*!
+    @file     custom_device.c
+    @author   hathach (tinyusb.org)
+
+    @section LICENSE
+
+    Software License Agreement (BSD License)
+
+    Copyright (c) 2018, Adafruit Industries (adafruit.com)
+    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.
+*/
+/**************************************************************************/
+
+#include "tusb_option.h"
+
+#if (MODE_DEVICE_SUPPORTED && CFG_TUD_CUSTOM_CLASS)
+
+#define _TINY_USB_SOURCE_FILE_
+
+#include "common/tusb_common.h"
+#include "custom_device.h"
+#include "device/usbd_pvt.h"
+
+/*------------------------------------------------------------------*/
+/* MACRO TYPEDEF CONSTANT ENUM
+ *------------------------------------------------------------------*/
+
+/*------------------------------------------------------------------*/
+/* VARIABLE DECLARATION
+ *------------------------------------------------------------------*/
+typedef struct {
+  uint8_t itf_num;
+
+  uint8_t ep_in;
+  uint8_t ep_out;
+
+} cusd_interface_t;
+
+static cusd_interface_t _cusd_itf;
+
+/*------------------------------------------------------------------*/
+/* FUNCTION DECLARATION
+ *------------------------------------------------------------------*/
+void cusd_init(void)
+{
+  varclr_(&_cusd_itf);
+}
+
+tusb_error_t cusd_open(uint8_t rhport, tusb_desc_interface_t const * p_desc_itf, uint16_t *p_len)
+{
+  cusd_interface_t* p_itf = &_cusd_itf;
+
+  // Open endpoint pair with usbd helper
+  tusb_desc_endpoint_t const *p_desc_ep = (tusb_desc_endpoint_t const *) descriptor_next( (uint8_t const*) p_desc_itf );
+  TU_ASSERT_ERR( usbd_open_edpt_pair(rhport, p_desc_ep, TUSB_XFER_BULK, &p_itf->ep_out, &p_itf->ep_in) );
+
+  p_itf->itf_num = p_desc_itf->bInterfaceNumber;
+
+  (*p_len) = sizeof(tusb_desc_interface_t) + 2*sizeof(tusb_desc_endpoint_t);
+
+  // TODO Prepare for incoming data
+//  TU_ASSERT( dcd_edpt_xfer(rhport, p_itf->ep_out, (uint8_t*) &p_msc->cbw, sizeof(msc_cbw_t)), TUSB_ERROR_DCD_EDPT_XFER );
+
+  return TUSB_ERROR_NONE;
+}
+
+tusb_error_t cusd_control_request_st(uint8_t rhport, tusb_control_request_t const * p_request)
+{
+  return TUSB_ERROR_DCD_CONTROL_REQUEST_NOT_SUPPORT;
+}
+
+tusb_error_t cusd_xfer_cb(uint8_t rhport, uint8_t edpt_addr, tusb_event_t event, uint32_t xferred_bytes)
+{
+  return TUSB_ERROR_NONE;
+}
+
+void cusd_close(uint8_t rhport)
+{
+
+}
+
+#endif
diff --git a/tinyusb/class/custom/custom_device.h b/tinyusb/class/custom/custom_device.h
new file mode 100644
index 000000000..08f4f7f4a
--- /dev/null
+++ b/tinyusb/class/custom/custom_device.h
@@ -0,0 +1,71 @@
+/**************************************************************************/
+/*!
+    @file     custom_device.h
+    @author   hathach (tinyusb.org)
+
+    @section LICENSE
+
+    Software License Agreement (BSD License)
+
+    Copyright (c) 2018, Adafruit Industries (adafruit.com)
+    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.
+*/
+/**************************************************************************/
+
+#ifndef _TUSB_CUSTOM_DEVICE_H_
+#define _TUSB_CUSTOM_DEVICE_H_
+
+#include "common/tusb_common.h"
+#include "device/usbd.h"
+
+//--------------------------------------------------------------------+
+// APPLICATION API (Multiple Root Ports)
+// Should be used only with MCU that support more than 1 ports
+//--------------------------------------------------------------------+
+
+//--------------------------------------------------------------------+
+// APPLICATION API (Single Port)
+// Should be used with MCU supporting only 1 USB port for code simplicity
+//--------------------------------------------------------------------+
+
+
+//--------------------------------------------------------------------+
+// APPLICATION CALLBACK API (WEAK is optional)
+//--------------------------------------------------------------------+
+
+//--------------------------------------------------------------------+
+// USBD-CLASS DRIVER API
+//--------------------------------------------------------------------+
+#ifdef _TINY_USB_SOURCE_FILE_
+
+void cusd_init(void);
+tusb_error_t cusd_open(uint8_t rhport, tusb_desc_interface_t const * p_interface_desc, uint16_t *p_length);
+tusb_error_t cusd_control_request_st(uint8_t rhport, tusb_control_request_t const * p_request);
+tusb_error_t cusd_xfer_cb(uint8_t rhport, uint8_t edpt_addr, tusb_event_t event, uint32_t xferred_bytes);
+void cusd_close(uint8_t rhport);
+#endif
+
+
+#endif /* _TUSB_CUSTOM_DEVICE_H_ */
diff --git a/tinyusb/class/msc/msc_device.c b/tinyusb/class/msc/msc_device.c
index 99b5652bb..c772e62a6 100644
--- a/tinyusb/class/msc/msc_device.c
+++ b/tinyusb/class/msc/msc_device.c
@@ -123,36 +123,20 @@ void mscd_close(uint8_t rhport)
   memclr_(&_mscd_itf, sizeof(mscd_interface_t));

 }

 

-tusb_error_t mscd_open(uint8_t rhport, tusb_desc_interface_t const * p_interface_desc, uint16_t *p_length)

+tusb_error_t mscd_open(uint8_t rhport, tusb_desc_interface_t const * p_desc_itf, uint16_t *p_len)

 {

-  VERIFY( ( MSC_SUBCLASS_SCSI == p_interface_desc->bInterfaceSubClass &&

-            MSC_PROTOCOL_BOT  == p_interface_desc->bInterfaceProtocol ), TUSB_ERROR_MSC_UNSUPPORTED_PROTOCOL );

+  // only support SCSI's BOT protocol

+  VERIFY( ( MSC_SUBCLASS_SCSI == p_desc_itf->bInterfaceSubClass &&

+            MSC_PROTOCOL_BOT  == p_desc_itf->bInterfaceProtocol ), TUSB_ERROR_MSC_UNSUPPORTED_PROTOCOL );

 

   mscd_interface_t * p_msc = &_mscd_itf;

 

-  //------------- Open Data Pipe -------------//

-  tusb_desc_endpoint_t const *p_endpoint = (tusb_desc_endpoint_t const *) descriptor_next( (uint8_t const*) p_interface_desc );

-  for(int i=0; i<2; i++)

-  {

-    TU_ASSERT(TUSB_DESC_ENDPOINT == p_endpoint->bDescriptorType &&

-              TUSB_XFER_BULK == p_endpoint->bmAttributes.xfer, TUSB_ERROR_DESCRIPTOR_CORRUPTED);

-

-    TU_ASSERT( dcd_edpt_open(rhport, p_endpoint), TUSB_ERROR_DCD_FAILED );

-

-    if ( p_endpoint->bEndpointAddress &  TUSB_DIR_IN_MASK )

-    {

-      p_msc->ep_in = p_endpoint->bEndpointAddress;

-    }else

-    {

-      p_msc->ep_out = p_endpoint->bEndpointAddress;

-    }

-

-    p_endpoint = (tusb_desc_endpoint_t const *) descriptor_next( (uint8_t const*)  p_endpoint );

-  }

-

-  p_msc->itf_num = p_interface_desc->bInterfaceNumber;

+  // Open endpoint pair with usbd helper

+  tusb_desc_endpoint_t const *p_desc_ep = (tusb_desc_endpoint_t const *) descriptor_next( (uint8_t const*) p_desc_itf );

+  TU_ASSERT_ERR( usbd_open_edpt_pair(rhport, p_desc_ep, TUSB_XFER_BULK, &p_msc->ep_out, &p_msc->ep_in) );

 

-  (*p_length) += sizeof(tusb_desc_interface_t) + 2*sizeof(tusb_desc_endpoint_t);

+  p_msc->itf_num = p_desc_itf->bInterfaceNumber;

+  (*p_len) = sizeof(tusb_desc_interface_t) + 2*sizeof(tusb_desc_endpoint_t);

 

   //------------- Queue Endpoint OUT for Command Block Wrapper -------------//

   TU_ASSERT( dcd_edpt_xfer(rhport, p_msc->ep_out, (uint8_t*) &p_msc->cbw, sizeof(msc_cbw_t)), TUSB_ERROR_DCD_EDPT_XFER );

diff --git a/tinyusb/device/usbd.c b/tinyusb/device/usbd.c
index 9fe6a5446..6718c0876 100644
--- a/tinyusb/device/usbd.c
+++ b/tinyusb/device/usbd.c
@@ -62,12 +62,12 @@
 typedef struct {

   uint8_t class_code;

 

-  void (* init) (void);

-  tusb_error_t (* open)(uint8_t rhport, tusb_desc_interface_t const * desc_intf, uint16_t* p_length);

-  tusb_error_t (* control_request_st) (uint8_t rhport, tusb_control_request_t const *);

-  tusb_error_t (* xfer_cb) (uint8_t rhport, uint8_t ep_addr, tusb_event_t, uint32_t);

-  void (* sof)(uint8_t rhport);

-  void (* close) (uint8_t);

+  void         (* init           ) (void);

+  tusb_error_t (* open           ) (uint8_t rhport, tusb_desc_interface_t const * desc_intf, uint16_t* p_length);

+  tusb_error_t (* control_req_st ) (uint8_t rhport, tusb_control_request_t const *);

+  tusb_error_t (* xfer_cb        ) (uint8_t rhport, uint8_t ep_addr, tusb_event_t, uint32_t);

+  void         (* sof            ) (uint8_t rhport);

+  void         (* close          ) (uint8_t);

 } usbd_class_driver_t;

 

 

@@ -94,37 +94,49 @@ static usbd_class_driver_t const usbd_class_drivers[] =
 {

   #if CFG_TUD_CDC

     {

-        .class_code         = TUSB_CLASS_CDC,

-        .init               = cdcd_init,

-        .open               = cdcd_open,

-        .control_request_st = cdcd_control_request_st,

-        .xfer_cb            = cdcd_xfer_cb,

-        .sof                = cdcd_sof,

-        .close              = cdcd_close

+        .class_code     = TUSB_CLASS_CDC,

+        .init           = cdcd_init,

+        .open           = cdcd_open,

+        .control_req_st = cdcd_control_request_st,

+        .xfer_cb        = cdcd_xfer_cb,

+        .sof            = cdcd_sof,

+        .close          = cdcd_close

     },

   #endif

 

   #if DEVICE_CLASS_HID

     {

-        .class_code         = TUSB_CLASS_HID,

-        .init               = hidd_init,

-        .open               = hidd_open,

-        .control_request_st = hidd_control_request_st,

-        .xfer_cb            = hidd_xfer_cb,

-        .sof                = NULL,

-        .close              = hidd_close

+        .class_code     = TUSB_CLASS_HID,

+        .init           = hidd_init,

+        .open           = hidd_open,

+        .control_req_st = hidd_control_request_st,

+        .xfer_cb        = hidd_xfer_cb,

+        .sof            = NULL,

+        .close          = hidd_close

     },

   #endif

 

   #if CFG_TUD_MSC

     {

-        .class_code         = TUSB_CLASS_MSC,

-        .init               = mscd_init,

-        .open               = mscd_open,

-        .control_request_st = mscd_control_request_st,

-        .xfer_cb            = mscd_xfer_cb,

-        .sof                = NULL,

-        .close              = mscd_close

+        .class_code     = TUSB_CLASS_MSC,

+        .init           = mscd_init,

+        .open           = mscd_open,

+        .control_req_st = mscd_control_request_st,

+        .xfer_cb        = mscd_xfer_cb,

+        .sof            = NULL,

+        .close          = mscd_close

+    },

+  #endif

+

+  #if CFG_TUD_CUSTOM_CLASS

+    {

+        .class_code     = TUSB_CLASS_VENDOR_SPECIFIC,

+        .init           = cusd_init,

+        .open           = cusd_open,

+        .control_req_st = cusd_control_request_st,

+        .xfer_cb        = cusd_xfer_cb,

+        .sof            = NULL,

+        .close          = cusd_close

     },

   #endif

 };

@@ -358,9 +370,9 @@ static tusb_error_t proc_control_request_st(uint8_t rhport, tusb_control_request
       if ( usbd_class_drivers[drid].class_code == class_code ) break;

     }

 

-    if ( (drid < USBD_CLASS_DRIVER_COUNT) && usbd_class_drivers[drid].control_request_st )

+    if ( (drid < USBD_CLASS_DRIVER_COUNT) && usbd_class_drivers[drid].control_req_st )

     {

-      STASK_INVOKE( usbd_class_drivers[drid].control_request_st(rhport, p_request), error );

+      STASK_INVOKE( usbd_class_drivers[drid].control_req_st(rhport, p_request), error );

     }else

     {

       dcd_control_stall(rhport); // Stall unsupported request

@@ -427,7 +439,7 @@ static tusb_error_t proc_set_config_req(uint8_t rhport, uint8_t config_number)
       }

       TU_ASSERT( drid < USBD_CLASS_DRIVER_COUNT, TUSB_ERROR_NOT_SUPPORTED_YET );

 

-      // duplicate interface number TODO support alternate setting

+      // Check duplicate interface number TODO support alternate setting

       TU_ASSERT( 0 == usbd_devices[rhport].interface2class[p_desc_itf->bInterfaceNumber], TUSB_ERROR_FAILED);

       usbd_devices[rhport].interface2class[p_desc_itf->bInterfaceNumber] = class_code;

 

@@ -587,5 +599,26 @@ void dcd_xfer_complete(uint8_t rhport, uint8_t ep_addr, uint32_t xferred_bytes,
 //--------------------------------------------------------------------+

 // HELPER

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

+tusb_error_t usbd_open_edpt_pair(uint8_t rhport, tusb_desc_endpoint_t const* p_desc_ep, uint8_t xfer_type, uint8_t* ep_out, uint8_t* ep_in)

+{

+  for(int i=0; i<2; i++)

+  {

+    TU_ASSERT(TUSB_DESC_ENDPOINT == p_desc_ep->bDescriptorType &&

+              xfer_type          == p_desc_ep->bmAttributes.xfer, TUSB_ERROR_DESCRIPTOR_CORRUPTED);

+

+    TU_ASSERT( dcd_edpt_open(rhport, p_desc_ep), TUSB_ERROR_DCD_OPEN_PIPE_FAILED );

+

+    if ( p_desc_ep->bEndpointAddress &  TUSB_DIR_IN_MASK )

+    {

+      (*ep_in) = p_desc_ep->bEndpointAddress;

+    }else

+    {

+      (*ep_out) = p_desc_ep->bEndpointAddress;

+    }

 

+    p_desc_ep = (tusb_desc_endpoint_t const *) descriptor_next( (uint8_t const*)  p_desc_ep );

+  }

+

+  return TUSB_ERROR_NONE;

+}

 #endif

diff --git a/tinyusb/device/usbd_pvt.h b/tinyusb/device/usbd_pvt.h
index 0b9f3e81e..067d7e937 100644
--- a/tinyusb/device/usbd_pvt.h
+++ b/tinyusb/device/usbd_pvt.h
@@ -50,6 +50,9 @@ extern osal_semaphore_t _usbd_ctrl_sem;
 tusb_error_t usbd_init(void);
 void         usbd_task( void* param);
 
+// helper to parse an pair of In and Out endpoint descriptors. They must be consecutive
+tusb_error_t usbd_open_edpt_pair(uint8_t rhport, tusb_desc_endpoint_t const* p_desc_ep, uint8_t xfer_type, uint8_t* ep_out, uint8_t* ep_in);
+
 // Carry out Data and Status stage of control transfer
 //tusb_error_t usbd_control_xfer_st(uint8_t rhport, tusb_dir_t dir, uint8_t * buffer, uint16_t length);
 
diff --git a/tinyusb/tusb.h b/tinyusb/tusb.h
index c74fb2e6d..464fbb12a 100644
--- a/tinyusb/tusb.h
+++ b/tinyusb/tusb.h
@@ -87,6 +87,10 @@
   #if CFG_TUD_MSC

     #include "class/msc/msc_device.h"

   #endif

+

+  #if CFG_TUD_CUSTOM_CLASS

+    #include "class/custom/custom_device.h"

+  #endif

 #endif