274 lines
10 KiB
C
274 lines
10 KiB
C
/**************************************************************************/
|
|
/*!
|
|
@file cdc_host.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_HOST_SUPPORTED && TUSB_CFG_HOST_CDC)
|
|
|
|
#define _TINY_USB_SOURCE_FILE_
|
|
|
|
//--------------------------------------------------------------------+
|
|
// INCLUDE
|
|
//--------------------------------------------------------------------+
|
|
#include "common/common.h"
|
|
#include "cdc_host.h"
|
|
#include "cdc_rndis_host.h"
|
|
|
|
//--------------------------------------------------------------------+
|
|
// MACRO CONSTANT TYPEDEF
|
|
//--------------------------------------------------------------------+
|
|
|
|
//--------------------------------------------------------------------+
|
|
// INTERNAL OBJECT & FUNCTION DECLARATION
|
|
//--------------------------------------------------------------------+
|
|
/*STATIC_*/ cdch_data_t cdch_data[TUSB_CFG_HOST_DEVICE_MAX]; // TODO to be static
|
|
|
|
STATIC_ INLINE_ bool tusbh_cdc_is_mounted(uint8_t dev_addr) ATTR_PURE ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;
|
|
STATIC_ INLINE_ bool tusbh_cdc_is_mounted(uint8_t dev_addr)
|
|
{
|
|
// FIXME cannot use mounted class flag as at the point _open_sublass is called, the flag is not set yet
|
|
#ifdef _TEST_
|
|
return (tusbh_device_get_mounted_class_flag(dev_addr) & BIT_(TUSB_CLASS_CDC)) != 0;
|
|
#else
|
|
return pipehandle_is_valid(cdch_data[dev_addr-1].pipe_in) &&
|
|
pipehandle_is_valid(cdch_data[dev_addr-1].pipe_out);
|
|
#endif
|
|
}
|
|
|
|
static inline cdc_pipeid_t get_app_pipeid(pipe_handle_t pipe_hdl) ATTR_PURE ATTR_ALWAYS_INLINE;
|
|
static inline cdc_pipeid_t get_app_pipeid(pipe_handle_t pipe_hdl)
|
|
{
|
|
cdch_data_t const * p_cdc = &cdch_data[pipe_hdl.dev_addr-1];
|
|
|
|
return pipehandle_is_equal( pipe_hdl, p_cdc->pipe_notification ) ? CDC_PIPE_NOTIFICATION :
|
|
pipehandle_is_equal( pipe_hdl, p_cdc->pipe_in ) ? CDC_PIPE_DATA_IN :
|
|
pipehandle_is_equal( pipe_hdl, p_cdc->pipe_out ) ? CDC_PIPE_DATA_OUT : CDC_PIPE_ERROR;
|
|
}
|
|
|
|
//--------------------------------------------------------------------+
|
|
// APPLICATION API (parameter validation needed)
|
|
//--------------------------------------------------------------------+
|
|
bool tusbh_cdc_serial_is_mounted(uint8_t dev_addr)
|
|
{
|
|
// TODO consider all AT Command as serial candidate
|
|
return tusbh_cdc_is_mounted(dev_addr) &&
|
|
(CDC_COMM_PROTOCOL_ATCOMMAND <= cdch_data[dev_addr-1].interface_protocol) &&
|
|
(cdch_data[dev_addr-1].interface_protocol <= CDC_COMM_PROTOCOL_ATCOMMAND_CDMA);
|
|
}
|
|
|
|
bool tusbh_cdc_rndis_is_mounted(uint8_t dev_addr)
|
|
{
|
|
return tusbh_cdc_is_mounted(dev_addr) && cdch_data[dev_addr-1].is_rndis;
|
|
}
|
|
|
|
tusb_error_t tusbh_cdc_send(uint8_t dev_addr, void const * p_data, uint32_t length, bool is_notify)
|
|
{
|
|
ASSERT( tusbh_cdc_is_mounted(dev_addr), TUSB_ERROR_CDCH_DEVICE_NOT_MOUNTED);
|
|
ASSERT( p_data != NULL && length, TUSB_ERROR_INVALID_PARA);
|
|
|
|
pipe_handle_t pipe_out = cdch_data[dev_addr-1].pipe_out;
|
|
if ( !hcd_pipe_is_idle(pipe_out) )
|
|
{
|
|
return TUSB_ERROR_INTERFACE_IS_BUSY;
|
|
}
|
|
|
|
return hcd_pipe_xfer( pipe_out, (void *) p_data, length, is_notify);
|
|
}
|
|
|
|
tusb_error_t tusbh_cdc_receive(uint8_t dev_addr, void * p_buffer, uint32_t length, bool is_notify)
|
|
{
|
|
ASSERT( tusbh_cdc_is_mounted(dev_addr), TUSB_ERROR_CDCH_DEVICE_NOT_MOUNTED);
|
|
ASSERT( p_buffer != NULL && length, TUSB_ERROR_INVALID_PARA);
|
|
|
|
pipe_handle_t pipe_in = cdch_data[dev_addr-1].pipe_in;
|
|
if ( !hcd_pipe_is_idle(pipe_in) )
|
|
{
|
|
return TUSB_ERROR_INTERFACE_IS_BUSY;
|
|
}
|
|
|
|
return hcd_pipe_xfer( pipe_in, p_buffer, length, is_notify);
|
|
}
|
|
|
|
//--------------------------------------------------------------------+
|
|
// USBH-CLASS DRIVER API
|
|
//--------------------------------------------------------------------+
|
|
void cdch_init(void)
|
|
{
|
|
memclr_(cdch_data, sizeof(cdch_data_t)*TUSB_CFG_HOST_DEVICE_MAX);
|
|
#if TUSB_CFG_HOST_CDC_RNDIS
|
|
rndish_init();
|
|
#endif
|
|
}
|
|
|
|
tusb_error_t cdch_open_subtask(uint8_t dev_addr, tusb_descriptor_interface_t const *p_interface_desc, uint16_t *p_length)
|
|
{
|
|
tusb_error_t error;
|
|
|
|
OSAL_SUBTASK_BEGIN
|
|
|
|
if ( CDC_COMM_SUBCLASS_ABSTRACT_CONTROL_MODEL != p_interface_desc->bInterfaceSubClass)
|
|
{
|
|
return TUSB_ERROR_CDCH_UNSUPPORTED_SUBCLASS;
|
|
}
|
|
|
|
if ( !(is_in_range(CDC_COMM_PROTOCOL_ATCOMMAND, p_interface_desc->bInterfaceProtocol, CDC_COMM_PROTOCOL_ATCOMMAND_CDMA) ||
|
|
0xff == p_interface_desc->bInterfaceProtocol) )
|
|
{
|
|
return TUSB_ERROR_CDCH_UNSUPPORTED_PROTOCOL;
|
|
}
|
|
|
|
uint8_t const * p_desc = descriptor_next ( (uint8_t const *) p_interface_desc );
|
|
cdch_data_t * p_cdc = &cdch_data[dev_addr-1]; // non-static variable cannot be used after OS service call
|
|
|
|
p_cdc->interface_number = p_interface_desc->bInterfaceNumber;
|
|
p_cdc->interface_protocol = p_interface_desc->bInterfaceProtocol; // TODO 0xff is consider as rndis candidate, other is virtual Com
|
|
|
|
//------------- Communication Interface -------------//
|
|
(*p_length) = sizeof(tusb_descriptor_interface_t);
|
|
|
|
while( TUSB_DESC_TYPE_INTERFACE_CLASS_SPECIFIC == p_desc[DESCRIPTOR_OFFSET_TYPE] )
|
|
{ // Communication Functional Descriptors
|
|
if ( CDC_FUNC_DESC_ABSTRACT_CONTROL_MANAGEMENT == cdc_functional_desc_typeof(p_desc) )
|
|
{ // save ACM bmCapabilities
|
|
p_cdc->acm_capability = ((cdc_desc_func_abstract_control_management_t const *) p_desc)->bmCapabilities;
|
|
}
|
|
|
|
(*p_length) += p_desc[DESCRIPTOR_OFFSET_LENGTH];
|
|
p_desc = descriptor_next(p_desc);
|
|
}
|
|
|
|
if ( TUSB_DESC_TYPE_ENDPOINT == p_desc[DESCRIPTOR_OFFSET_TYPE])
|
|
{ // notification endpoint if any
|
|
p_cdc->pipe_notification = hcd_pipe_open(dev_addr, (tusb_descriptor_endpoint_t const *) p_desc, TUSB_CLASS_CDC);
|
|
|
|
(*p_length) += p_desc[DESCRIPTOR_OFFSET_LENGTH];
|
|
p_desc = descriptor_next(p_desc);
|
|
|
|
ASSERT(pipehandle_is_valid(p_cdc->pipe_notification), TUSB_ERROR_HCD_OPEN_PIPE_FAILED);
|
|
}
|
|
|
|
//------------- Data Interface (if any) -------------//
|
|
if ( (TUSB_DESC_TYPE_INTERFACE == p_desc[DESCRIPTOR_OFFSET_TYPE]) &&
|
|
(TUSB_CLASS_CDC_DATA == ((tusb_descriptor_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_descriptor_endpoint_t const *p_endpoint = (tusb_descriptor_endpoint_t const *) p_desc;
|
|
ASSERT_INT(TUSB_DESC_TYPE_ENDPOINT, p_endpoint->bDescriptorType, TUSB_ERROR_USBH_DESCRIPTOR_CORRUPTED);
|
|
ASSERT_INT(TUSB_XFER_BULK, p_endpoint->bmAttributes.xfer, TUSB_ERROR_USBH_DESCRIPTOR_CORRUPTED);
|
|
|
|
pipe_handle_t * p_pipe_hdl = ( p_endpoint->bEndpointAddress & TUSB_DIR_DEV_TO_HOST_MASK ) ?
|
|
&p_cdc->pipe_in : &p_cdc->pipe_out;
|
|
|
|
(*p_pipe_hdl) = hcd_pipe_open(dev_addr, p_endpoint, TUSB_CLASS_CDC);
|
|
ASSERT ( pipehandle_is_valid(*p_pipe_hdl), TUSB_ERROR_HCD_OPEN_PIPE_FAILED );
|
|
|
|
(*p_length) += p_desc[DESCRIPTOR_OFFSET_LENGTH];
|
|
p_desc = descriptor_next( p_desc );
|
|
}
|
|
}
|
|
|
|
#if TUSB_CFG_HOST_CDC_RNDIS // TODO move to rndis_host.c
|
|
//------------- RNDIS -------------//
|
|
if ( 0xff == cdch_data[dev_addr-1].interface_protocol && pipehandle_is_valid(cdch_data[dev_addr-1].pipe_notification) )
|
|
{
|
|
cdch_data[dev_addr-1].is_rndis = true; // set as true at first
|
|
|
|
OSAL_SUBTASK_INVOKED_AND_WAIT( rndish_open_subtask(dev_addr, &cdch_data[dev_addr-1]), error );
|
|
|
|
if (TUSB_ERROR_NONE != error)
|
|
{
|
|
cdch_data[dev_addr-1].is_rndis = false;
|
|
}
|
|
}
|
|
|
|
if ( !cdch_data[dev_addr-1].is_rndis ) // device is not an rndis
|
|
#endif
|
|
{
|
|
// FIXME mounted class flag is not set yet
|
|
tusbh_cdc_mounted_cb(dev_addr);
|
|
}
|
|
|
|
OSAL_SUBTASK_END
|
|
}
|
|
|
|
void cdch_isr(pipe_handle_t pipe_hdl, tusb_event_t event, uint32_t xferred_bytes)
|
|
{
|
|
cdch_data_t *p_cdc = &cdch_data[pipe_hdl.dev_addr - 1];
|
|
|
|
#if TUSB_CFG_HOST_CDC_RNDIS
|
|
if ( p_cdc->is_rndis )
|
|
{
|
|
rndish_xfer_isr(p_cdc, pipe_hdl, event, xferred_bytes);
|
|
} else
|
|
#endif
|
|
|
|
tusbh_cdc_xfer_isr( pipe_hdl.dev_addr, event, get_app_pipeid(pipe_hdl), xferred_bytes );
|
|
}
|
|
|
|
void cdch_close(uint8_t dev_addr)
|
|
{
|
|
cdch_data_t * p_cdc = &cdch_data[dev_addr-1];
|
|
|
|
#if TUSB_CFG_HOST_CDC_RNDIS
|
|
if (p_cdc->is_rndis)
|
|
{
|
|
rndish_close(dev_addr);
|
|
}
|
|
#endif
|
|
|
|
(void) hcd_pipe_close(p_cdc->pipe_notification);
|
|
(void) hcd_pipe_close(p_cdc->pipe_in);
|
|
(void) hcd_pipe_close(p_cdc->pipe_out);
|
|
|
|
#if TUSB_CFG_HOST_CDC_RNDIS
|
|
|
|
#endif
|
|
|
|
memclr_(p_cdc, sizeof(cdch_data_t));
|
|
|
|
tusbh_cdc_unmounted_cb(dev_addr);
|
|
|
|
}
|
|
|
|
#endif
|