137 lines
6.5 KiB
C
137 lines
6.5 KiB
C
/*
|
|
* The MIT License (MIT)
|
|
*
|
|
* Copyright (c) 2019 Ha Thach (tinyusb.org)
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
* in the Software without restriction, including without limitation the rights
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in
|
|
* all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
* THE SOFTWARE.
|
|
*
|
|
* This file is part of the TinyUSB stack.
|
|
*/
|
|
|
|
#ifndef _TUSB_CDC_HOST_H_
|
|
#define _TUSB_CDC_HOST_H_
|
|
|
|
#include "common/tusb_common.h"
|
|
#include "host/usbh.h"
|
|
#include "cdc.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
//--------------------------------------------------------------------+
|
|
// CDC APPLICATION PUBLIC API
|
|
//--------------------------------------------------------------------+
|
|
/** \ingroup ClassDriver_CDC Communication Device Class (CDC)
|
|
* \addtogroup CDC_Serial Serial
|
|
* @{
|
|
* \defgroup CDC_Serial_Host Host
|
|
* @{ */
|
|
|
|
bool tuh_cdc_set_control_line_state(uint8_t dev_addr, bool dtr, bool rts, tuh_control_complete_cb_t complete_cb);
|
|
|
|
static inline bool tuh_cdc_connect(uint8_t dev_addr, tuh_control_complete_cb_t complete_cb)
|
|
{
|
|
return tuh_cdc_set_control_line_state(dev_addr, true, true, complete_cb);
|
|
}
|
|
|
|
static inline bool tuh_cdc_disconnect(uint8_t dev_addr, tuh_control_complete_cb_t complete_cb)
|
|
{
|
|
return tuh_cdc_set_control_line_state(dev_addr, false, false, complete_cb);
|
|
}
|
|
|
|
/** \brief Check if device support CDC Serial interface or not
|
|
* \param[in] dev_addr device address
|
|
* \retval true if device supports
|
|
* \retval false if device does not support or is not mounted
|
|
*/
|
|
bool tuh_cdc_serial_is_mounted(uint8_t dev_addr);
|
|
|
|
/** \brief Check if the interface is currently busy or not
|
|
* \param[in] dev_addr device address
|
|
* \param[in] pipeid value from \ref cdc_pipeid_t to indicate target pipe.
|
|
* \retval true if the interface is busy, meaning the stack is still transferring/waiting data from/to device
|
|
* \retval false if the interface is not busy, meaning the stack successfully transferred data from/to device
|
|
* \note This function is used to check if previous transfer is complete (success or error), so that the next transfer
|
|
* can be scheduled. User needs to make sure the corresponding interface is mounted
|
|
* (by \ref tuh_cdc_serial_is_mounted) before calling this function.
|
|
*/
|
|
bool tuh_cdc_is_busy(uint8_t dev_addr, cdc_pipeid_t pipeid);
|
|
|
|
/** \brief Perform USB OUT transfer to device
|
|
* \param[in] dev_addr device address
|
|
* \param[in] p_data Buffer containing data. Must be accessible by USB controller (see \ref CFG_TUSB_MEM_SECTION)
|
|
* \param[in] length Number of bytes to be transferred via USB bus
|
|
* \retval TUSB_ERROR_NONE on success
|
|
* \retval TUSB_ERROR_INTERFACE_IS_BUSY if the interface is already transferring data with device
|
|
* \retval TUSB_ERROR_DEVICE_NOT_READY if device is not yet configured (by SET CONFIGURED request)
|
|
* \retval TUSB_ERROR_INVALID_PARA if input parameters are not correct
|
|
* \note This function is non-blocking and returns immediately. The result of USB transfer will be reported by the
|
|
* interface's callback function. \a p_data must be declared with \ref CFG_TUSB_MEM_SECTION.
|
|
*/
|
|
bool tuh_cdc_send(uint8_t dev_addr, void const * p_data, uint32_t length, bool is_notify);
|
|
|
|
/** \brief Perform USB IN transfer to get data from device
|
|
* \param[in] dev_addr device address
|
|
* \param[in] p_buffer Buffer containing received data. Must be accessible by USB controller (see \ref CFG_TUSB_MEM_SECTION)
|
|
* \param[in] length Number of bytes to be transferred via USB bus
|
|
* \retval TUSB_ERROR_NONE on success
|
|
* \retval TUSB_ERROR_INTERFACE_IS_BUSY if the interface is already transferring data with device
|
|
* \retval TUSB_ERROR_DEVICE_NOT_READY if device is not yet configured (by SET CONFIGURED request)
|
|
* \retval TUSB_ERROR_INVALID_PARA if input parameters are not correct
|
|
* \note This function is non-blocking and returns immediately. The result of USB transfer will be reported by the
|
|
* interface's callback function. \a p_data must be declared with \ref CFG_TUSB_MEM_SECTION.
|
|
*/
|
|
bool tuh_cdc_receive(uint8_t dev_addr, void * p_buffer, uint32_t length, bool is_notify);
|
|
|
|
//--------------------------------------------------------------------+
|
|
// CDC APPLICATION CALLBACKS
|
|
//--------------------------------------------------------------------+
|
|
|
|
/** \brief Callback function that is invoked when an transferring event occurred
|
|
* \param[in] dev_addr Address of device
|
|
* \param[in] event an value from \ref xfer_result_t
|
|
* \param[in] pipe_id value from \ref cdc_pipeid_t indicate the pipe
|
|
* \param[in] xferred_bytes Number of bytes transferred via USB bus
|
|
* \note event can be one of following
|
|
* - XFER_RESULT_SUCCESS : previously scheduled transfer completes successfully.
|
|
* - XFER_RESULT_FAILED : previously scheduled transfer encountered a transaction error.
|
|
* - XFER_RESULT_STALLED : previously scheduled transfer is stalled by device.
|
|
* \note
|
|
*/
|
|
void tuh_cdc_xfer_isr(uint8_t dev_addr, xfer_result_t event, cdc_pipeid_t pipe_id, uint32_t xferred_bytes);
|
|
|
|
/// @} // group CDC_Serial_Host
|
|
/// @}
|
|
|
|
//--------------------------------------------------------------------+
|
|
// Internal Class Driver API
|
|
//--------------------------------------------------------------------+
|
|
void cdch_init(void);
|
|
bool cdch_open(uint8_t rhport, uint8_t dev_addr, tusb_desc_interface_t const *itf_desc, uint16_t *p_length);
|
|
bool cdch_set_config(uint8_t dev_addr, uint8_t itf_num);
|
|
bool cdch_xfer_cb(uint8_t dev_addr, uint8_t ep_addr, xfer_result_t event, uint32_t xferred_bytes);
|
|
void cdch_close(uint8_t dev_addr);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* _TUSB_CDC_HOST_H_ */
|