summaryrefslogtreecommitdiff
path: root/src/class/cdc/cdc_device.h
diff options
context:
space:
mode:
authorhathach <[email protected]>2018-06-18 14:05:24 +0700
committerhathach <[email protected]>2018-06-18 14:05:24 +0700
commit424735d44041fc478b572f973d997829b402153d (patch)
treebc9956eee5bba55cf2f46fe49b504a6278d5b8b9 /src/class/cdc/cdc_device.h
parentb96e8c6cefd0128c99ab65fe7f2909449c85092b (diff)
rename subfolder source to src
Diffstat (limited to 'src/class/cdc/cdc_device.h')
-rw-r--r--src/class/cdc/cdc_device.h120
1 files changed, 120 insertions, 0 deletions
diff --git a/src/class/cdc/cdc_device.h b/src/class/cdc/cdc_device.h
new file mode 100644
index 000000000..c1a790fc8
--- /dev/null
+++ b/src/class/cdc/cdc_device.h
@@ -0,0 +1,120 @@
+/**************************************************************************/
+/*!
+ @file cdc_device.h
+ @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.
+*/
+/**************************************************************************/
+
+#ifndef _TUSB_CDC_DEVICE_H_
+#define _TUSB_CDC_DEVICE_H_
+
+#include "common/tusb_common.h"
+#include "device/usbd.h"
+#include "cdc.h"
+
+#ifdef __cplusplus
+ extern "C" {
+#endif
+
+/** \addtogroup CDC_Serial Serial
+ * @{
+ * \defgroup CDC_Serial_Device Device
+ * @{ */
+
+//--------------------------------------------------------------------+
+// APPLICATION API (Multiple Root Ports)
+// Should be used only with MCU that support more than 1 ports
+//--------------------------------------------------------------------+
+bool tud_n_cdc_connected (uint8_t rhport);
+uint8_t tud_n_cdc_get_line_state (uint8_t rhport);
+void tud_n_cdc_get_line_coding (uint8_t rhport, cdc_line_coding_t* coding);
+
+uint32_t tud_n_cdc_available (uint8_t rhport);
+int8_t tud_n_cdc_read_char (uint8_t rhport);
+uint32_t tud_n_cdc_read (uint8_t rhport, void* buffer, uint32_t bufsize);
+
+uint32_t tud_n_cdc_write_char (uint8_t rhport, char ch);
+uint32_t tud_n_cdc_write (uint8_t rhport, void const* buffer, uint32_t bufsize);
+bool tud_n_cdc_flush (uint8_t rhport);
+
+//--------------------------------------------------------------------+
+// APPLICATION API (Single Port)
+// Should be used with MCU supporting only 1 USB port for code simplicity
+//--------------------------------------------------------------------+
+static inline bool tud_cdc_connected (void) { return tud_n_cdc_connected(0); }
+static inline uint8_t tud_cdc_get_line_state (uint8_t rhport) { return tud_n_cdc_get_line_state(0); }
+static inline void tud_cdc_get_line_coding (uint8_t rhport, cdc_line_coding_t* coding) { return tud_cdc_get_line_coding(0, coding); }
+
+static inline uint32_t tud_cdc_available (void) { return tud_n_cdc_available(0); }
+static inline int8_t tud_cdc_read_char (void) { return tud_n_cdc_read_char(0); }
+static inline uint32_t tud_cdc_read (void* buffer, uint32_t bufsize) { return tud_n_cdc_read(0, buffer, bufsize); }
+
+static inline uint32_t tud_cdc_write_char (char ch) { return tud_n_cdc_write_char(0, ch); }
+static inline uint32_t tud_cdc_write (void const* buffer, uint32_t bufsize) { return tud_n_cdc_write(0, buffer, bufsize); }
+static inline bool tud_cdc_flush (void) { return tud_n_cdc_flush(0); }
+
+//--------------------------------------------------------------------+
+// APPLICATION CALLBACK API (WEAK is optional)
+//--------------------------------------------------------------------+
+ATTR_WEAK void tud_cdc_rx_cb(uint8_t rhport);
+ATTR_WEAK void tud_cdc_line_state_cb(uint8_t rhport, bool dtr, bool rts);
+ATTR_WEAK void tud_cdc_line_coding_cb(uint8_t rhport, cdc_line_coding_t const* p_line_coding);
+
+//--------------------------------------------------------------------+
+// USBD-CLASS DRIVER API
+//--------------------------------------------------------------------+
+#ifdef _TINY_USB_SOURCE_FILE_
+
+void cdcd_init(void);
+tusb_error_t cdcd_open(uint8_t rhport, tusb_desc_interface_t const * p_interface_desc, uint16_t *p_length);
+tusb_error_t cdcd_control_request_st(uint8_t rhport, tusb_control_request_t const * p_request);
+tusb_error_t cdcd_xfer_cb(uint8_t rhport, uint8_t edpt_addr, tusb_event_t event, uint32_t xferred_bytes);
+void cdcd_close(uint8_t rhport);
+
+#if CFG_TUD_CDC_FLUSH_ON_SOF
+void cdcd_sof(uint8_t rhport);
+#else
+#define cdcd_sof NULL
+#endif
+
+#endif
+
+#ifdef __cplusplus
+ }
+#endif
+
+#endif /* _TUSB_CDC_DEVICE_H_ */
+
+/** @} */
+/** @} */