MarlinSerial.h 7.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241
  1. /*
  2. HardwareSerial.h - Hardware serial library for Wiring
  3. Copyright (c) 2006 Nicholas Zambetti. All right reserved.
  4. This library is free software; you can redistribute it and/or
  5. modify it under the terms of the GNU Lesser General Public
  6. License as published by the Free Software Foundation; either
  7. version 2.1 of the License, or (at your option) any later version.
  8. This library is distributed in the hope that it will be useful,
  9. but WITHOUT ANY WARRANTY; without even the implied warranty of
  10. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  11. Lesser General Public License for more details.
  12. You should have received a copy of the GNU Lesser General Public
  13. License along with this library; if not, write to the Free Software
  14. Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  15. Modified 28 September 2010 by Mark Sproul
  16. */
  17. #ifndef MarlinSerial_h
  18. #define MarlinSerial_h
  19. #include "Marlin.h"
  20. #if !defined(SERIAL_PORT)
  21. #define SERIAL_PORT 0
  22. #endif
  23. // The presence of the UBRRH register is used to detect a UART.
  24. #if ((SERIAL_PORT == 0 && (defined(UBRRH) || defined(UBRR0H))) || \
  25. (SERIAL_PORT == 1 && defined(UBRR1H)) || \
  26. (SERIAL_PORT == 2 && defined(UBRR2H)) || \
  27. (SERIAL_PORT == 3 && defined(UBRR3H)))
  28. #define HAS_UART
  29. #endif
  30. // These are macros to build serial port register names for the selected SERIAL_PORT (C preprocessor
  31. // requires two levels of indirection to expand macro values properly)
  32. #if SERIAL_PORT == 0 && (!defined(UBRR0H) || !defined(UDR0)) // use un-numbered registers if necessary
  33. #define SERIAL_REGNAME(registerbase,number,suffix) _REGNAME_SHORT(registerbase, suffix)
  34. #else
  35. #define SERIAL_REGNAME(registerbase,number,suffix) _REGNAME(registerbase, number, suffix)
  36. #endif
  37. // Registers used by MarlinSerial class (these are expanded
  38. // depending on selected serial port
  39. #define M_UCSRxA SERIAL_REGNAME(UCSR,SERIAL_PORT,A) // defines M_UCSRxA to be UCSRnA where n is the serial port number
  40. #define M_UCSRxB SERIAL_REGNAME(UCSR,SERIAL_PORT,B)
  41. #define M_RXENx SERIAL_REGNAME(RXEN,SERIAL_PORT,)
  42. #define M_TXENx SERIAL_REGNAME(TXEN,SERIAL_PORT,)
  43. #define M_RXCIEx SERIAL_REGNAME(RXCIE,SERIAL_PORT,)
  44. #define M_UDREx SERIAL_REGNAME(UDRE,SERIAL_PORT,)
  45. #define M_UDRx SERIAL_REGNAME(UDR,SERIAL_PORT,)
  46. #define M_UBRRxH SERIAL_REGNAME(UBRR,SERIAL_PORT,H)
  47. #define M_UBRRxL SERIAL_REGNAME(UBRR,SERIAL_PORT,L)
  48. #define M_RXCx SERIAL_REGNAME(RXC,SERIAL_PORT,)
  49. #define M_FEx SERIAL_REGNAME(FE,SERIAL_PORT,)
  50. #define M_USARTx_RX_vect SERIAL_REGNAME(USART,SERIAL_PORT,_RX_vect)
  51. #define M_U2Xx SERIAL_REGNAME(U2X,SERIAL_PORT,)
  52. #define DEC 10
  53. #define HEX 16
  54. #define OCT 8
  55. #define BIN 2
  56. #define BYTE 0
  57. #ifndef AT90USB
  58. // Define constants and variables for buffering incoming serial data. We're
  59. // using a ring buffer (I think), in which rx_buffer_head is the index of the
  60. // location to which to write the next incoming character and rx_buffer_tail
  61. // is the index of the location from which to read.
  62. #define RX_BUFFER_SIZE 128
  63. extern uint8_t selectedSerialPort;
  64. struct ring_buffer
  65. {
  66. unsigned char buffer[RX_BUFFER_SIZE];
  67. int head;
  68. int tail;
  69. };
  70. #ifdef HAS_UART
  71. extern ring_buffer rx_buffer;
  72. #endif
  73. class MarlinSerial //: public Stream
  74. {
  75. public:
  76. static void begin(long);
  77. static void end();
  78. static int peek(void);
  79. static int read(void);
  80. static void flush(void);
  81. static /*FORCE_INLINE*/ int available(void)
  82. {
  83. return (unsigned int)(RX_BUFFER_SIZE + rx_buffer.head - rx_buffer.tail) % RX_BUFFER_SIZE;
  84. }
  85. /*
  86. FORCE_INLINE void write(uint8_t c)
  87. {
  88. while (!((M_UCSRxA) & (1 << M_UDREx)))
  89. ;
  90. M_UDRx = c;
  91. }
  92. */
  93. static void write(uint8_t c)
  94. {
  95. if (selectedSerialPort == 0)
  96. {
  97. while (!((M_UCSRxA) & (1 << M_UDREx)));
  98. M_UDRx = c;
  99. }
  100. else if (selectedSerialPort == 1)
  101. {
  102. while (!((UCSR1A) & (1 << UDRE1)));
  103. UDR1 = c;
  104. }
  105. }
  106. static void checkRx(void)
  107. {
  108. if (selectedSerialPort == 0) {
  109. if((M_UCSRxA & (1<<M_RXCx)) != 0) {
  110. // Test for a framing error.
  111. if (M_UCSRxA & (1<<M_FEx)) {
  112. // Characters received with the framing errors will be ignored.
  113. // The temporary variable "c" was made volatile, so the compiler does not optimize this out.
  114. (void)(*(char *)M_UDRx);
  115. } else {
  116. unsigned char c = M_UDRx;
  117. int i = (unsigned int)(rx_buffer.head + 1) % RX_BUFFER_SIZE;
  118. // if we should be storing the received character into the location
  119. // just before the tail (meaning that the head would advance to the
  120. // current location of the tail), we're about to overflow the buffer
  121. // and so we don't write the character or advance the head.
  122. if (i != rx_buffer.tail) {
  123. rx_buffer.buffer[rx_buffer.head] = c;
  124. rx_buffer.head = i;
  125. }
  126. //selectedSerialPort = 0;
  127. #ifdef DEBUG_DUMP_TO_2ND_SERIAL
  128. UDR1 = c;
  129. #endif //DEBUG_DUMP_TO_2ND_SERIAL
  130. }
  131. }
  132. } else { // if(selectedSerialPort == 1) {
  133. if((UCSR1A & (1<<RXC1)) != 0) {
  134. // Test for a framing error.
  135. if (UCSR1A & (1<<FE1)) {
  136. // Characters received with the framing errors will be ignored.
  137. // The temporary variable "c" was made volatile, so the compiler does not optimize this out.
  138. (void)(*(char *)UDR1);
  139. } else {
  140. unsigned char c = UDR1;
  141. int i = (unsigned int)(rx_buffer.head + 1) % RX_BUFFER_SIZE;
  142. // if we should be storing the received character into the location
  143. // just before the tail (meaning that the head would advance to the
  144. // current location of the tail), we're about to overflow the buffer
  145. // and so we don't write the character or advance the head.
  146. if (i != rx_buffer.tail) {
  147. rx_buffer.buffer[rx_buffer.head] = c;
  148. rx_buffer.head = i;
  149. }
  150. //selectedSerialPort = 1;
  151. #ifdef DEBUG_DUMP_TO_2ND_SERIAL
  152. M_UDRx = c;
  153. #endif //DEBUG_DUMP_TO_2ND_SERIAL
  154. }
  155. }
  156. }
  157. }
  158. private:
  159. static void printNumber(unsigned long, uint8_t);
  160. static void printFloat(double, uint8_t);
  161. public:
  162. static /*FORCE_INLINE*/ void write(const char *str)
  163. {
  164. while (*str)
  165. write(*str++);
  166. }
  167. static /*FORCE_INLINE*/ void write(const uint8_t *buffer, size_t size)
  168. {
  169. while (size--)
  170. write(*buffer++);
  171. }
  172. /* static FORCE_INLINE void print(const String &s)
  173. {
  174. for (int i = 0; i < (int)s.length(); i++) {
  175. write(s[i]);
  176. }
  177. }*/
  178. static FORCE_INLINE void print(const char *str)
  179. {
  180. write(str);
  181. }
  182. static void print(char, int = BYTE);
  183. static void print(unsigned char, int = BYTE);
  184. static void print(int, int = DEC);
  185. static void print(unsigned int, int = DEC);
  186. static void print(long, int = DEC);
  187. static void print(unsigned long, int = DEC);
  188. static void print(double, int = 2);
  189. // static void println(const String &s);
  190. static void println(const char[]);
  191. static void println(char, int = BYTE);
  192. static void println(unsigned char, int = BYTE);
  193. static void println(int, int = DEC);
  194. static void println(unsigned int, int = DEC);
  195. static void println(long, int = DEC);
  196. static void println(unsigned long, int = DEC);
  197. static void println(double, int = 2);
  198. static void println(void);
  199. };
  200. extern MarlinSerial MSerial;
  201. #endif // !AT90USB
  202. // Use the UART for BT in AT90USB configurations
  203. #if defined(AT90USB) && defined (BTENABLED)
  204. extern HardwareSerial bt;
  205. #endif
  206. #endif