123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175
  1. /* Teensyduino Core Library
  2. * http://www.pjrc.com/teensy/
  3. * Copyright (c) 2017 PJRC.COM, LLC.
  4. *
  5. * Permission is hereby granted, free of charge, to any person obtaining
  6. * a copy of this software and associated documentation files (the
  7. * "Software"), to deal in the Software without restriction, including
  8. * without limitation the rights to use, copy, modify, merge, publish,
  9. * distribute, sublicense, and/or sell copies of the Software, and to
  10. * permit persons to whom the Software is furnished to do so, subject to
  11. * the following conditions:
  12. *
  13. * 1. The above copyright notice and this permission notice shall be
  14. * included in all copies or substantial portions of the Software.
  15. *
  16. * 2. If the Software is incorporated into a build system that allows
  17. * selection among a list of target devices, then similar target
  18. * devices manufactured by PJRC.COM must be included in the list of
  19. * target devices and selectable in the same manner.
  20. *
  21. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  22. * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  23. * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  24. * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  25. * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  26. * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  27. * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  28. * SOFTWARE.
  29. */
  30. #ifndef USBserial_h_
  31. #define USBserial_h_
  32. #include "usb_desc.h"
  33. #if (defined(CDC_STATUS_INTERFACE) && defined(CDC_DATA_INTERFACE)) || defined(USB_DISABLED)
  34. #include <inttypes.h>
  35. #if F_CPU >= 20000000 && !defined(USB_DISABLED)
  36. #include "core_pins.h" // for millis()
  37. // C language implementation
  38. #ifdef __cplusplus
  39. extern "C" {
  40. #endif
  41. int usb_serial_getchar(void);
  42. int usb_serial_peekchar(void);
  43. int usb_serial_available(void);
  44. int usb_serial_read(void *buffer, uint32_t size);
  45. void usb_serial_flush_input(void);
  46. int usb_serial_putchar(uint8_t c);
  47. int usb_serial_write(const void *buffer, uint32_t size);
  48. int usb_serial_write_buffer_free(void);
  49. void usb_serial_flush_output(void);
  50. void usb_serial_flush_callback(void);
  51. extern uint32_t usb_cdc_line_coding[2];
  52. extern volatile uint32_t usb_cdc_line_rtsdtr_millis;
  53. extern volatile uint32_t systick_millis_count;
  54. extern volatile uint8_t usb_cdc_line_rtsdtr;
  55. extern volatile uint8_t usb_cdc_transmit_flush_timer;
  56. extern volatile uint8_t usb_configuration;
  57. #ifdef __cplusplus
  58. }
  59. #endif
  60. #define USB_SERIAL_DTR 0x01
  61. #define USB_SERIAL_RTS 0x02
  62. // C++ interface
  63. #ifdef __cplusplus
  64. #include "Stream.h"
  65. class usb_serial_class : public Stream
  66. {
  67. public:
  68. constexpr usb_serial_class() {}
  69. void begin(long) {
  70. //uint32_t millis_begin = systick_millis_count;
  71. //disabled for now - causes more trouble than it solves?
  72. //while (!(*this)) {
  73. // wait up to 2.5 seconds for Arduino Serial Monitor
  74. // Yes, this is a long time, but some Windows systems open
  75. // the port very slowly. This wait allows programs for
  76. // Arduino Uno to "just work" (without forcing a reboot when
  77. // the port is opened), and when no PC is connected the user's
  78. // sketch still gets to run normally after this wait time.
  79. //if ((uint32_t)(systick_millis_count - millis_begin) > 2500) break;
  80. //}
  81. }
  82. void end() { /* TODO: flush output and shut down USB port */ };
  83. virtual int available() { return usb_serial_available(); }
  84. virtual int read() { return usb_serial_getchar(); }
  85. virtual int peek() { return usb_serial_peekchar(); }
  86. virtual void flush() { usb_serial_flush_output(); } // TODO: actually wait for data to leave USB...
  87. virtual void clear(void) { usb_serial_flush_input(); }
  88. virtual size_t write(uint8_t c) { return usb_serial_putchar(c); }
  89. virtual size_t write(const uint8_t *buffer, size_t size) { return usb_serial_write(buffer, size); }
  90. size_t write(unsigned long n) { return write((uint8_t)n); }
  91. size_t write(long n) { return write((uint8_t)n); }
  92. size_t write(unsigned int n) { return write((uint8_t)n); }
  93. size_t write(int n) { return write((uint8_t)n); }
  94. virtual int availableForWrite() { return usb_serial_write_buffer_free(); }
  95. using Print::write;
  96. void send_now(void) { usb_serial_flush_output(); }
  97. uint32_t baud(void) { return usb_cdc_line_coding[0]; }
  98. uint8_t stopbits(void) { uint8_t b = usb_cdc_line_coding[1]; if (!b) b = 1; return b; }
  99. uint8_t paritytype(void) { return usb_cdc_line_coding[1] >> 8; } // 0=none, 1=odd, 2=even
  100. uint8_t numbits(void) { return usb_cdc_line_coding[1] >> 16; }
  101. uint8_t dtr(void) { return (usb_cdc_line_rtsdtr & USB_SERIAL_DTR) ? 1 : 0; }
  102. uint8_t rts(void) { return (usb_cdc_line_rtsdtr & USB_SERIAL_RTS) ? 1 : 0; }
  103. operator bool() { return usb_configuration && (usb_cdc_line_rtsdtr & USB_SERIAL_DTR) &&
  104. ((uint32_t)(systick_millis_count - usb_cdc_line_rtsdtr_millis) >= 15);
  105. }
  106. size_t readBytes(char *buffer, size_t length) {
  107. size_t count=0;
  108. unsigned long startMillis = millis();
  109. do {
  110. count += usb_serial_read(buffer + count, length - count);
  111. if (count >= length) return count;
  112. } while(millis() - startMillis < _timeout);
  113. setReadError();
  114. return count;
  115. }
  116. };
  117. extern usb_serial_class Serial;
  118. extern void serialEvent(void);
  119. #endif // __cplusplus
  120. #else // F_CPU < 20000000
  121. // Allow Arduino programs using Serial to compile, but Serial will do nothing.
  122. #ifdef __cplusplus
  123. #include "Stream.h"
  124. class usb_serial_class : public Stream
  125. {
  126. public:
  127. constexpr usb_serial_class() {}
  128. void begin(long) { };
  129. void end() { };
  130. virtual int available() { return 0; }
  131. virtual int read() { return -1; }
  132. virtual int peek() { return -1; }
  133. virtual void flush() { }
  134. virtual void clear() { }
  135. virtual size_t write(uint8_t c) { return 1; }
  136. virtual size_t write(const uint8_t *buffer, size_t size) { return size; }
  137. size_t write(unsigned long n) { return 1; }
  138. size_t write(long n) { return 1; }
  139. size_t write(unsigned int n) { return 1; }
  140. size_t write(int n) { return 1; }
  141. int availableForWrite() { return 0; }
  142. using Print::write;
  143. void send_now(void) { }
  144. uint32_t baud(void) { return 0; }
  145. uint8_t stopbits(void) { return 1; }
  146. uint8_t paritytype(void) { return 0; }
  147. uint8_t numbits(void) { return 8; }
  148. uint8_t dtr(void) { return 1; }
  149. uint8_t rts(void) { return 1; }
  150. operator bool() { return true; }
  151. };
  152. extern usb_serial_class Serial;
  153. extern void serialEvent(void);
  154. #endif // __cplusplus
  155. #endif // F_CPU
  156. #endif // CDC_STATUS_INTERFACE && CDC_DATA_INTERFACE
  157. #endif // USBserial_h_