tinyusb/tinyusb/device/usbd.c

/**************************************************************************/
/*!
    @file     usbd.c
    @author   hathach (tinyusb.org)

    @section 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.
*/
/**************************************************************************/

#include "tusb_option.h"

#if MODE_DEVICE_SUPPORTED

#define _TINY_USB_SOURCE_FILE_

//--------------------------------------------------------------------+
// INCLUDE
//--------------------------------------------------------------------+
#include "tusb.h"
#include "usbd.h"

//--------------------------------------------------------------------+
// MACRO CONSTANT TYPEDEF
//--------------------------------------------------------------------+
usbd_device_info_t usbd_devices[CONTROLLER_DEVICE_NUMBER];
TUSB_CFG_ATTR_USBRAM uint8_t usbd_enum_buffer[TUSB_CFG_DEVICE_ENUM_BUFFER_SIZE];

static usbd_class_driver_t const usbd_class_drivers[] =
{
  #if DEVICE_CLASS_HID
    [TUSB_CLASS_HID] =
    {
        .init                    = hidd_init,
        .open                    = hidd_open,
        .control_request_subtask = hidd_control_request_subtask,
        .xfer_cb                 = hidd_xfer_cb,
//        .routine                 = NULL,
        .sof                     = NULL,
        .close                   = hidd_close
    },
  #endif

  #if TUSB_CFG_DEVICE_MSC
    [TUSB_CLASS_MSC] =
    {
        .init                    = mscd_init,
        .open                    = mscd_open,
        .control_request_subtask = mscd_control_request_subtask,
        .xfer_cb                 = mscd_xfer_cb,
//        .routine                 = NULL,
        .sof                     = NULL,
        .close                   = mscd_close
    },
  #endif

  #if TUSB_CFG_DEVICE_CDC
    [TUSB_CLASS_CDC] =
    {
        .init                    = cdcd_init,
        .open                    = cdcd_open,
        .control_request_subtask = cdcd_control_request_subtask,
        .xfer_cb                 = cdcd_xfer_cb,
//        .routine                 = NULL,
        .sof                     = cdcd_sof,
        .close                   = cdcd_close
    },
  #endif

};

enum { USBD_CLASS_DRIVER_COUNT = sizeof(usbd_class_drivers) / sizeof(usbd_class_driver_t) };

//--------------------------------------------------------------------+
// INTERNAL OBJECT & FUNCTION DECLARATION
//--------------------------------------------------------------------+
static tusb_error_t usbd_set_configure_received(uint8_t port, uint8_t config_number);
static tusb_error_t get_descriptor(uint8_t port, tusb_control_request_t const * const p_request, uint8_t const ** pp_buffer, uint16_t * p_length);

//--------------------------------------------------------------------+
// APPLICATION INTERFACE
//--------------------------------------------------------------------+
bool tud_n_mounted(uint8_t port)
{
    return usbd_devices[port].state == TUSB_DEVICE_STATE_CONFIGURED;
}

//--------------------------------------------------------------------+
// IMPLEMENTATION
//--------------------------------------------------------------------+

//------------- OSAL Task -------------//
enum { USBD_TASK_QUEUE_DEPTH = 16 };

typedef enum
{
  USBD_EVENTID_SETUP_RECEIVED = 1,
  USBD_EVENTID_XFER_DONE,
  USBD_EVENTID_SOF
}usbd_eventid_t;

typedef struct ATTR_ALIGNED(4)
{
  uint8_t port;
  uint8_t event_id;
  uint8_t sub_event_id;
  uint8_t reserved;

  union {
    tusb_control_request_t setup_received;

    struct { // USBD_EVENTID_XFER_DONE
      uint8_t  edpt_addr;
      uint32_t xferred_byte;
    }xfer_done;
  };
} usbd_task_event_t;

STATIC_ASSERT(sizeof(usbd_task_event_t) <= 12, "size is not correct");

#ifndef TUC_DEVICE_STACKSIZE
#define TUC_DEVICE_STACKSIZE 150
#endif

#ifndef TUSB_CFG_OS_TASK_PRIO
#define TUSB_CFG_OS_TASK_PRIO 0
#endif


static osal_queue_t usbd_queue_hdl;
/*static*/ osal_semaphore_t usbd_control_xfer_sem_hdl; // TODO may need to change to static with wrapper function

//--------------------------------------------------------------------+
// IMPLEMENTATION
//--------------------------------------------------------------------+
tusb_error_t usbd_control_request_subtask(uint8_t port, tusb_control_request_t const * const p_request);
static tusb_error_t usbd_body_subtask(void);

tusb_error_t usbd_init (void)
{
  #if (TUSB_CFG_CONTROLLER_0_MODE & TUSB_MODE_DEVICE)
  tusb_dcd_init(0);
  #endif

  #if (TUSB_CFG_CONTROLLER_1_MODE & TUSB_MODE_DEVICE)
  tusb_dcd_init(1);
  #endif

  //------------- Task init -------------//
  usbd_queue_hdl = osal_queue_create(USBD_TASK_QUEUE_DEPTH, sizeof(usbd_task_event_t));
  VERIFY(usbd_queue_hdl, TUSB_ERROR_OSAL_QUEUE_FAILED);

  usbd_control_xfer_sem_hdl = osal_semaphore_create(1, 0);
  VERIFY(usbd_queue_hdl, TUSB_ERROR_OSAL_SEMAPHORE_FAILED);

  osal_task_create(usbd_task, "usbd", TUC_DEVICE_STACKSIZE, NULL, TUSB_CFG_OS_TASK_PRIO);

  //------------- Descriptor Check -------------//
  ASSERT(tusbd_descriptor_pointers.p_device != NULL && tusbd_descriptor_pointers.p_configuration != NULL, TUSB_ERROR_DESCRIPTOR_CORRUPTED);

  //------------- class init -------------//
  for (uint8_t class_code = TUSB_CLASS_AUDIO; class_code < USBD_CLASS_DRIVER_COUNT; class_code++)
  {
    if ( usbd_class_drivers[class_code].init )
    {
      usbd_class_drivers[class_code].init();
    }
  }

  return TUSB_ERROR_NONE;
}

// To enable the TASK_ASSERT style (quick return on false condition) in a real RTOS, a task must act as a wrapper
// and is used mainly to call subtasks. Within a subtask return statement can be called freely, the task with
// forever loop cannot have any return at all.
void usbd_task( void* param)
{
  (void) param;

  OSAL_TASK_BEGIN
  usbd_body_subtask();
  OSAL_TASK_END
}

static tusb_error_t usbd_body_subtask(void)
{
  static usbd_task_event_t event;

  OSAL_SUBTASK_BEGIN

  tusb_error_t error;
  error = TUSB_ERROR_NONE;

  memclr_(&event, sizeof(usbd_task_event_t));

#if 1
  osal_queue_receive(usbd_queue_hdl, &event, OSAL_TIMEOUT_WAIT_FOREVER, &error);
  SUBTASK_ASSERT_STATUS(error);
#else
  enum { ROUTINE_INTERVAL_MS = 10 };
  osal_queue_receive(usbd_queue_hdl, &event, ROUTINE_INTERVAL_MS, &error);
  if ( error != TUSB_ERROR_NONE )
  {
    // time out, run class routine then
    if ( error == TUSB_ERROR_OSAL_TIMEOUT)
    {
      for (uint8_t class_code = TUSB_CLASS_AUDIO; class_code < USBD_CLASS_DRIVER_COUNT; class_code++)
      {
        if ( usbd_class_drivers[class_code].routine ) usbd_class_drivers[class_code].routine();
      }
    }

    SUBTASK_RETURN(error);
  }
#endif

  if ( USBD_EVENTID_SETUP_RECEIVED == event.event_id )
  {
    OSAL_SUBTASK_INVOKED_AND_WAIT( usbd_control_request_subtask(event.port, &event.setup_received), error );
  }else if (USBD_EVENTID_XFER_DONE == event.event_id)
  {
    // Call class handling function, Class that endpoint not belong to should check and return
    for (uint8_t class_code = TUSB_CLASS_AUDIO; class_code < USBD_CLASS_DRIVER_COUNT; class_code++)
    {
      if ( usbd_class_drivers[class_code].xfer_cb )
      {
        usbd_class_drivers[class_code].xfer_cb( event.port, event.xfer_done.edpt_addr, (tusb_event_t) event.sub_event_id, event.xfer_done.xferred_byte);
      }
    }
  }else if (USBD_EVENTID_SOF == event.event_id)
  {
    for (uint8_t class_code = TUSB_CLASS_AUDIO; class_code < USBD_CLASS_DRIVER_COUNT; class_code++)
    {
      if ( usbd_class_drivers[class_code].sof )
      {
        usbd_class_drivers[class_code].sof( event.port );
      }
    }
  }
  else
  {
    SUBTASK_ASSERT(false);
  }

  OSAL_SUBTASK_END
}

//--------------------------------------------------------------------+
// CONTROL REQUEST
//--------------------------------------------------------------------+
tusb_error_t usbd_control_request_subtask(uint8_t port, tusb_control_request_t const * const p_request)
{
  OSAL_SUBTASK_BEGIN

  tusb_error_t error;
  error = TUSB_ERROR_NONE;

  //------------- Standard Control e.g in enumeration -------------//
  if( TUSB_REQ_RCPT_DEVICE == p_request->bmRequestType_bit.recipient &&
      TUSB_REQ_TYPE_STANDARD    == p_request->bmRequestType_bit.type )
  {
    if ( TUSB_REQUEST_GET_DESCRIPTOR == p_request->bRequest )
    {
      uint8_t const * p_buffer = NULL;
      uint16_t length = 0;

      error = get_descriptor(port, p_request, &p_buffer, &length);

      if ( TUSB_ERROR_NONE == error )
      {
        tusb_dcd_control_xfer(port, (tusb_dir_t) p_request->bmRequestType_bit.direction, (uint8_t*) p_buffer, length, false);
      }
    }
    else if ( TUSB_REQUEST_SET_ADDRESS == p_request->bRequest )
    {
      tusb_dcd_set_address(port, (uint8_t) p_request->wValue);
      usbd_devices[port].state = TUSB_DEVICE_STATE_ADDRESSED;
    }
    else if ( TUSB_REQUEST_SET_CONFIGURATION == p_request->bRequest )
    {
      usbd_set_configure_received(port, (uint8_t) p_request->wValue);
    }else
    {
      error = TUSB_ERROR_DCD_CONTROL_REQUEST_NOT_SUPPORT;
    }
  }
  //------------- Class/Interface Specific Request -------------//
  else if ( TUSB_REQ_RCPT_INTERFACE == p_request->bmRequestType_bit.recipient)
  {
    static uint8_t class_code;

    class_code = usbd_devices[port].interface2class[ u16_low_u8(p_request->wIndex) ];

    // TODO [Custom] TUSB_CLASS_DIAGNOSTIC, vendor etc ...
    if ( (class_code > 0) && (class_code < USBD_CLASS_DRIVER_COUNT) &&
         usbd_class_drivers[class_code].control_request_subtask )
    {
      OSAL_SUBTASK_INVOKED_AND_WAIT( usbd_class_drivers[class_code].control_request_subtask(port, p_request), error );
    }else
    {
      error = TUSB_ERROR_DCD_CONTROL_REQUEST_NOT_SUPPORT;
    }
  }

  //------------- Endpoint Request -------------//
  else if ( TUSB_REQ_RCPT_ENDPOINT == p_request->bmRequestType_bit.recipient &&
            TUSB_REQ_TYPE_STANDARD      == p_request->bmRequestType_bit.type &&
            TUSB_REQUEST_CLEAR_FEATURE      == p_request->bRequest )
  {
    tusb_dcd_edpt_clear_stall(port, u16_low_u8(p_request->wIndex) );
  } else
  {
    error = TUSB_ERROR_DCD_CONTROL_REQUEST_NOT_SUPPORT;
  }

  if(TUSB_ERROR_NONE != error)
  { // Response with Protocol Stall if request is not supported
    tusb_dcd_control_stall(port);
    //    ASSERT(error == TUSB_ERROR_NONE, VOID_RETURN);
  }else if (p_request->wLength == 0)
  {
    tusb_dcd_control_xfer(port, (tusb_dir_t) p_request->bmRequestType_bit.direction, NULL, 0, false); // zero length for non-data
  }

  OSAL_SUBTASK_END
}

// TODO Host (windows) can get HID report descriptor before set configured
// may need to open interface before set configured
static tusb_error_t usbd_set_configure_received(uint8_t port, uint8_t config_number)
{
  tusb_dcd_set_config(port, config_number);
  usbd_devices[port].state = TUSB_DEVICE_STATE_CONFIGURED;

  //------------- parse configuration & open drivers -------------//
  uint8_t const * p_desc_config = tusbd_descriptor_pointers.p_configuration;
  uint8_t const * p_desc = p_desc_config + sizeof(tusb_descriptor_configuration_t);

  uint16_t const config_total_length = ((tusb_descriptor_configuration_t*)p_desc_config)->wTotalLength;

  while( p_desc < p_desc_config + config_total_length )
  {
    if ( TUSB_DESC_INTERFACE_ASSOCIATION == p_desc[DESCRIPTOR_OFFSET_TYPE])
    {
      p_desc += p_desc[DESCRIPTOR_OFFSET_LENGTH]; // ignore Interface Association
    }else
    {
      ASSERT( TUSB_DESC_INTERFACE == p_desc[DESCRIPTOR_OFFSET_TYPE], TUSB_ERROR_NOT_SUPPORTED_YET );

      uint8_t class_index;
      tusb_descriptor_interface_t* p_desc_interface = (tusb_descriptor_interface_t*) p_desc;

      class_index = p_desc_interface->bInterfaceClass;

      ASSERT( class_index != 0 && class_index < USBD_CLASS_DRIVER_COUNT && usbd_class_drivers[class_index].open != NULL, TUSB_ERROR_NOT_SUPPORTED_YET );
      ASSERT( 0 == usbd_devices[port].interface2class[p_desc_interface->bInterfaceNumber], TUSB_ERROR_FAILED); // duplicate interface number TODO alternate setting

      usbd_devices[port].interface2class[p_desc_interface->bInterfaceNumber] = class_index;

      uint16_t length=0;
      ASSERT_STATUS( usbd_class_drivers[class_index].open( port, p_desc_interface, &length ) );

      ASSERT( length >= sizeof(tusb_descriptor_interface_t), TUSB_ERROR_FAILED );
      p_desc += length;
    }
  }

  // invoke callback
  tud_mount_cb(port);

  return TUSB_ERROR_NONE;
}

static tusb_error_t get_descriptor(uint8_t port, tusb_control_request_t const * const p_request, uint8_t const ** pp_buffer, uint16_t * p_length)
{
  tusb_desc_type_t const desc_type = (tusb_desc_type_t) u16_high_u8(p_request->wValue);
  uint8_t const desc_index = u16_low_u8( p_request->wValue );

  uint8_t const * p_data = NULL ;

  switch(desc_type)
  {
    case TUSB_DESC_DEVICE:
      p_data      = tusbd_descriptor_pointers.p_device;
      (*p_length) = sizeof(tusb_descriptor_device_t);
    break;

    case TUSB_DESC_CONFIGURATION:
      p_data      = tusbd_descriptor_pointers.p_configuration;
      (*p_length) = ((tusb_descriptor_configuration_t*)tusbd_descriptor_pointers.p_configuration)->wTotalLength;
    break;

    case TUSB_DESC_STRING:
      if ( !(desc_index < 100) ) return TUSB_ERROR_DCD_CONTROL_REQUEST_NOT_SUPPORT; // windows sometimes ask for string at index 238 !!!

      p_data = tusbd_descriptor_pointers.p_string_arr[desc_index];
      ASSERT( p_data != NULL, TUSB_ERROR_FAILED);

      (*p_length)  = p_data[0];  // first byte of descriptor is its size
    break;

    // TODO Report Descriptor (HID Generic)
    // TODO HID Descriptor

    default: return TUSB_ERROR_DCD_CONTROL_REQUEST_NOT_SUPPORT;
  }

  (*p_length) = min16_of(p_request->wLength, (*p_length) ); // cannot return more than hosts requires
  ASSERT( (*p_length) <= TUSB_CFG_DEVICE_ENUM_BUFFER_SIZE, TUSB_ERROR_NOT_ENOUGH_MEMORY);

  memcpy(usbd_enum_buffer, p_data, (*p_length));
  (*pp_buffer) = usbd_enum_buffer;

  return TUSB_ERROR_NONE;
}
//--------------------------------------------------------------------+
// USBD-CLASS API
//--------------------------------------------------------------------+

//--------------------------------------------------------------------+
// USBD-DCD Callback API
//--------------------------------------------------------------------+
void tusb_dcd_bus_event(uint8_t port, usbd_bus_event_type_t bus_event)
{
  switch(bus_event)
  {
    case USBD_BUS_EVENT_RESET     :
      memclr_(&usbd_devices[port], sizeof(usbd_device_info_t));
      osal_queue_flush(usbd_queue_hdl);
      osal_semaphore_reset(usbd_control_xfer_sem_hdl);
      for (uint8_t class_code = TUSB_CLASS_AUDIO; class_code < USBD_CLASS_DRIVER_COUNT; class_code++)
      {
        if ( usbd_class_drivers[class_code].close ) usbd_class_drivers[class_code].close( port );
      }

      // invoke callback
      tud_umount_cb(port);
    break;

    case USBD_BUS_EVENT_SOF:
    {
      usbd_task_event_t task_event =
      {
          .port          = port,
          .event_id        = USBD_EVENTID_SOF,
      };
      osal_queue_send(usbd_queue_hdl, &task_event);
    }
    break;

    case USBD_BUS_EVENT_UNPLUGGED : break;

    case USBD_BUS_EVENT_SUSPENDED:
      usbd_devices[port].state = TUSB_DEVICE_STATE_SUSPENDED;
    break;

    default: break;
  }
}

void tusb_dcd_setup_received(uint8_t port, uint8_t const* p_request)
{
  usbd_task_event_t task_event =
  {
      .port          = port,
      .event_id        = USBD_EVENTID_SETUP_RECEIVED,
  };

  memcpy(&task_event.setup_received, p_request, sizeof(tusb_control_request_t));
  osal_queue_send(usbd_queue_hdl, &task_event);
}

void tusb_dcd_xfer_complete(uint8_t port, uint8_t edpt_addr, uint32_t xferred_bytes, bool succeeded)
{
  if (edpt_addr == 0 )
  {
    // Control Transfer
    osal_semaphore_post( usbd_control_xfer_sem_hdl );
  }else
  {
    usbd_task_event_t task_event =
    {
        .port         = port,
        .event_id     = USBD_EVENTID_XFER_DONE,
        .sub_event_id = succeeded ? TUSB_EVENT_XFER_COMPLETE : TUSB_EVENT_XFER_ERROR
    };

    task_event.xfer_done.edpt_addr    = edpt_addr;
    task_event.xfer_done.xferred_byte = xferred_bytes;

    osal_queue_send(usbd_queue_hdl, &task_event);
  }
}

//--------------------------------------------------------------------+
// HELPER
//--------------------------------------------------------------------+

#endif