partially document CDC & RNDIS
This commit is contained in:
hathach
parent
b1142ff065
commit
6c629a18fc
|
|
@ -36,16 +36,11 @@
|
||||||
*/
|
*/
|
||||||
/**************************************************************************/
|
/**************************************************************************/
|
||||||
|
|
||||||
/** \file
|
|
||||||
* \brief CDC Class Driver
|
|
||||||
*
|
|
||||||
* \note TBD
|
|
||||||
*/
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* \addtogroup ClassDriver Class Driver
|
* \addtogroup ClassDriver Class Driver
|
||||||
* @{
|
* @{
|
||||||
* \defgroup ClassDriver_CDC Communication Device Class
|
* \defgroup ClassDriver_CDC Communication Device Class (CDC)
|
||||||
|
* Currently only Abstract Control Model subclass is supported
|
||||||
* @{
|
* @{
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,124 +1,142 @@
|
||||||
/**************************************************************************/
|
/**************************************************************************/
|
||||||
/*!
|
/*!
|
||||||
@file cdc_host.h
|
@file cdc_host.h
|
||||||
@author hathach (tinyusb.org)
|
@author hathach (tinyusb.org)
|
||||||
|
|
||||||
@section LICENSE
|
@section LICENSE
|
||||||
|
|
||||||
Software License Agreement (BSD License)
|
Software License Agreement (BSD License)
|
||||||
|
|
||||||
Copyright (c) 2013, hathach (tinyusb.org)
|
Copyright (c) 2013, hathach (tinyusb.org)
|
||||||
All rights reserved.
|
All rights reserved.
|
||||||
|
|
||||||
Redistribution and use in source and binary forms, with or without
|
Redistribution and use in source and binary forms, with or without
|
||||||
modification, are permitted provided that the following conditions are met:
|
modification, are permitted provided that the following conditions are met:
|
||||||
1. Redistributions of source code must retain the above copyright
|
1. Redistributions of source code must retain the above copyright
|
||||||
notice, this list of conditions and the following disclaimer.
|
notice, this list of conditions and the following disclaimer.
|
||||||
2. Redistributions in binary form must reproduce the above copyright
|
2. Redistributions in binary form must reproduce the above copyright
|
||||||
notice, this list of conditions and the following disclaimer in the
|
notice, this list of conditions and the following disclaimer in the
|
||||||
documentation and/or other materials provided with the distribution.
|
documentation and/or other materials provided with the distribution.
|
||||||
3. Neither the name of the copyright holders nor the
|
3. Neither the name of the copyright holders nor the
|
||||||
names of its contributors may be used to endorse or promote products
|
names of its contributors may be used to endorse or promote products
|
||||||
derived from this software without specific prior written permission.
|
derived from this software without specific prior written permission.
|
||||||
|
|
||||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
|
||||||
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
||||||
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY
|
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY
|
||||||
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
||||||
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
||||||
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
||||||
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
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
|
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
||||||
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
|
|
||||||
This file is part of the tinyusb stack.
|
This file is part of the tinyusb stack.
|
||||||
*/
|
*/
|
||||||
/**************************************************************************/
|
/**************************************************************************/
|
||||||
|
|
||||||
/** \ingroup TBD
|
/** \addtogroup ClassDriver_CDC Communication Device Class (CDC)
|
||||||
* \defgroup TBD
|
* @{ */
|
||||||
* \brief TBD
|
|
||||||
*
|
#ifndef _TUSB_CDC_HOST_H_
|
||||||
* @{
|
#define _TUSB_CDC_HOST_H_
|
||||||
*/
|
|
||||||
|
#include "common/common.h"
|
||||||
#ifndef _TUSB_CDC_HOST_H_
|
#include "host/usbh.h"
|
||||||
#define _TUSB_CDC_HOST_H_
|
#include "cdc.h"
|
||||||
|
|
||||||
#include "common/common.h"
|
#ifdef __cplusplus
|
||||||
#include "host/usbh.h"
|
extern "C" {
|
||||||
#include "cdc.h"
|
#endif
|
||||||
|
|
||||||
#ifdef __cplusplus
|
typedef enum {
|
||||||
extern "C" {
|
CDC_PIPE_ERROR = 0,
|
||||||
#endif
|
CDC_PIPE_NOTIFICATION,
|
||||||
|
CDC_PIPE_DATA_IN,
|
||||||
typedef enum {
|
CDC_PIPE_DATA_OUT
|
||||||
CDC_PIPE_ERROR = 0,
|
}cdc_pipeid_t;
|
||||||
CDC_PIPE_NOTIFICATION,
|
|
||||||
CDC_PIPE_DATA_IN,
|
//--------------------------------------------------------------------+
|
||||||
CDC_PIPE_DATA_OUT
|
// APPLICATION PUBLIC API
|
||||||
}cdc_pipeid_t;
|
//--------------------------------------------------------------------+
|
||||||
|
/** \defgroup CDC_ACM Abtract Control Model (ACM)
|
||||||
//--------------------------------------------------------------------+
|
* @{ */
|
||||||
// APPLICATION PUBLIC API
|
|
||||||
//--------------------------------------------------------------------+
|
bool tusbh_cdc_serial_is_mounted(uint8_t dev_addr) ATTR_PURE ATTR_WARN_UNUSED_RESULT;
|
||||||
bool tusbh_cdc_serial_is_mounted(uint8_t dev_addr) ATTR_PURE ATTR_WARN_UNUSED_RESULT;
|
tusb_error_t tusbh_cdc_send(uint8_t dev_addr, void const * p_data, uint32_t length, bool is_notify);
|
||||||
|
tusb_error_t tusbh_cdc_receive(uint8_t dev_addr, void * p_buffer, uint32_t length, bool is_notify);
|
||||||
tusb_error_t tusbh_cdc_send(uint8_t dev_addr, void const * p_data, uint32_t length, bool is_notify);
|
|
||||||
tusb_error_t tusbh_cdc_receive(uint8_t dev_addr, void * p_buffer, uint32_t length, bool is_notify);
|
//------------- CDC Application Callback -------------//
|
||||||
|
/** \brief Callback function that will be invoked when a device with CDC Abstract Control Model interface is mounted
|
||||||
//------------- CDC Application Callback -------------//
|
* \param[in] dev_addr Address of newly mounted device
|
||||||
void tusbh_cdc_mounted_cb(uint8_t dev_addr);
|
* \note This callback should be used by Application to set-up interface-related data
|
||||||
void tusbh_cdc_unmounted_cb(uint8_t dev_addr);
|
*/
|
||||||
void tusbh_cdc_xfer_isr(uint8_t dev_addr, tusb_event_t event, cdc_pipeid_t pipe_id, uint32_t xferred_bytes);
|
void tusbh_cdc_mounted_cb(uint8_t dev_addr);
|
||||||
|
|
||||||
|
/** \brief Callback function that will be invoked when a device with CDC Abstract Control Model interface is unmounted
|
||||||
#if TUSB_CFG_HOST_CDC_RNDIS
|
* \param[in] dev_addr Address of newly unmounted device
|
||||||
//--------------------------------------------------------------------+
|
* \note This callback should be used by Application to tear-down interface-related data
|
||||||
// RNDIS APPLICATION API
|
*/
|
||||||
//--------------------------------------------------------------------+
|
void tusbh_cdc_unmounted_cb(uint8_t dev_addr);
|
||||||
bool tusbh_cdc_rndis_is_mounted(uint8_t dev_addr) ATTR_PURE ATTR_WARN_UNUSED_RESULT;
|
|
||||||
tusb_error_t tusbh_cdc_rndis_get_mac_addr(uint8_t dev_addr, uint8_t mac_address[6]);
|
void tusbh_cdc_xfer_isr(uint8_t dev_addr, tusb_event_t event, cdc_pipeid_t pipe_id, uint32_t xferred_bytes);
|
||||||
|
|
||||||
//------------- RNDIS Application Callback (overshadow CDC callbacks) -------------//
|
/// @}
|
||||||
void tusbh_cdc_rndis_mounted_cb(uint8_t dev_addr);
|
|
||||||
void tusbh_cdc_rndis_unmounted_cb(uint8_t dev_addr);
|
//--------------------------------------------------------------------+
|
||||||
void tusbh_cdc_rndis_xfer_isr(uint8_t dev_addr, tusb_event_t event, cdc_pipeid_t pipe_id, uint32_t xferred_bytes);
|
// RNDIS APPLICATION API
|
||||||
|
//--------------------------------------------------------------------+
|
||||||
|
/** \defgroup CDC_RNDIS Remote Network Driver Interface Specification (RNDIS)
|
||||||
|
* @{ */
|
||||||
#endif
|
bool tusbh_cdc_rndis_is_mounted(uint8_t dev_addr) ATTR_PURE ATTR_WARN_UNUSED_RESULT;
|
||||||
|
tusb_error_t tusbh_cdc_rndis_get_mac_addr(uint8_t dev_addr, uint8_t mac_address[6]);
|
||||||
//--------------------------------------------------------------------+
|
|
||||||
// USBH-CLASS API
|
//------------- RNDIS Application Callback (overshadow CDC callbacks) -------------//
|
||||||
//--------------------------------------------------------------------+
|
/** \brief Callback function that will be invoked when a device with RNDIS interface is mounted
|
||||||
#ifdef _TINY_USB_SOURCE_FILE_
|
* \param[in] dev_addr Address of newly mounted device
|
||||||
|
* \note This callback should be used by Application to set-up interface-related data
|
||||||
typedef struct {
|
*/
|
||||||
uint8_t interface_number;
|
void tusbh_cdc_rndis_mounted_cb(uint8_t dev_addr);
|
||||||
uint8_t interface_protocol;
|
|
||||||
bool is_rndis;
|
/** \brief Callback function that will be invoked when a device with RNDIS interface is unmounted
|
||||||
cdc_acm_capability_t acm_capability;
|
* \param[in] dev_addr Address of newly unmounted device
|
||||||
|
* \note This callback should be used by Application to tear-down interface-related data
|
||||||
pipe_handle_t pipe_notification, pipe_out, pipe_in;
|
*/
|
||||||
|
void tusbh_cdc_rndis_unmounted_cb(uint8_t dev_addr);
|
||||||
} cdch_data_t;
|
|
||||||
|
void tusbh_cdc_rndis_xfer_isr(uint8_t dev_addr, tusb_event_t event, cdc_pipeid_t pipe_id, uint32_t xferred_bytes);
|
||||||
extern cdch_data_t cdch_data[TUSB_CFG_HOST_DEVICE_MAX]; // TODO consider to move to cdch internal header file
|
|
||||||
|
/// @}
|
||||||
void cdch_init(void);
|
|
||||||
tusb_error_t cdch_open_subtask(uint8_t dev_addr, tusb_descriptor_interface_t const *p_interface_desc, uint16_t *p_length) ATTR_WARN_UNUSED_RESULT;
|
//--------------------------------------------------------------------+
|
||||||
void cdch_isr(pipe_handle_t pipe_hdl, tusb_event_t event, uint32_t xferred_bytes);
|
// USBH-CLASS API
|
||||||
void cdch_close(uint8_t dev_addr);
|
//--------------------------------------------------------------------+
|
||||||
|
#ifdef _TINY_USB_SOURCE_FILE_
|
||||||
#endif
|
|
||||||
|
typedef struct {
|
||||||
#ifdef __cplusplus
|
uint8_t interface_number;
|
||||||
}
|
uint8_t interface_protocol;
|
||||||
#endif
|
bool is_rndis;
|
||||||
|
cdc_acm_capability_t acm_capability;
|
||||||
#endif /* _TUSB_CDC_HOST_H_ */
|
|
||||||
|
pipe_handle_t pipe_notification, pipe_out, pipe_in;
|
||||||
/** @} */
|
|
||||||
|
} cdch_data_t;
|
||||||
|
|
||||||
|
extern cdch_data_t cdch_data[TUSB_CFG_HOST_DEVICE_MAX]; // TODO consider to move to cdch internal header file
|
||||||
|
|
||||||
|
void cdch_init(void);
|
||||||
|
tusb_error_t cdch_open_subtask(uint8_t dev_addr, tusb_descriptor_interface_t const *p_interface_desc, uint16_t *p_length) ATTR_WARN_UNUSED_RESULT;
|
||||||
|
void cdch_isr(pipe_handle_t pipe_hdl, tusb_event_t event, uint32_t xferred_bytes);
|
||||||
|
void cdch_close(uint8_t dev_addr);
|
||||||
|
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#ifdef __cplusplus
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#endif /* _TUSB_CDC_HOST_H_ */
|
||||||
|
|
||||||
|
/** @} */
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue