MarlinSerial.h 5.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189
  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. #define UART_PRESENT(port) ((port == 0 && (defined(UBRRH) || defined(UBRR0H))) || \
  25. (port == 1 && defined(UBRR1H)) || (port == 2 && defined(UBRR2H)) || \
  26. (port == 3 && defined(UBRR3H)))
  27. // These are macros to build serial port register names for the selected SERIAL_PORT (C preprocessor
  28. // requires two levels of indirection to expand macro values properly)
  29. #define SERIAL_REGNAME(registerbase,number,suffix) SERIAL_REGNAME_INTERNAL(registerbase,number,suffix)
  30. #if SERIAL_PORT == 0 && (!defined(UBRR0H) || !defined(UDR0)) // use un-numbered registers if necessary
  31. #define SERIAL_REGNAME_INTERNAL(registerbase,number,suffix) registerbase##suffix
  32. #else
  33. #define SERIAL_REGNAME_INTERNAL(registerbase,number,suffix) registerbase##number##suffix
  34. #endif
  35. // Registers used by MarlinSerial class (these are expanded
  36. // depending on selected serial port
  37. #define M_UCSRxA SERIAL_REGNAME(UCSR,SERIAL_PORT,A) // defines M_UCSRxA to be UCSRnA where n is the serial port number
  38. #define M_UCSRxB SERIAL_REGNAME(UCSR,SERIAL_PORT,B)
  39. #define M_RXENx SERIAL_REGNAME(RXEN,SERIAL_PORT,)
  40. #define M_TXENx SERIAL_REGNAME(TXEN,SERIAL_PORT,)
  41. #define M_RXCIEx SERIAL_REGNAME(RXCIE,SERIAL_PORT,)
  42. #define M_UDREx SERIAL_REGNAME(UDRE,SERIAL_PORT,)
  43. #define M_UDRx SERIAL_REGNAME(UDR,SERIAL_PORT,)
  44. #define M_UBRRxH SERIAL_REGNAME(UBRR,SERIAL_PORT,H)
  45. #define M_UBRRxL SERIAL_REGNAME(UBRR,SERIAL_PORT,L)
  46. #define M_RXCx SERIAL_REGNAME(RXC,SERIAL_PORT,)
  47. #define M_USARTx_RX_vect SERIAL_REGNAME(USART,SERIAL_PORT,_RX_vect)
  48. #define M_U2Xx SERIAL_REGNAME(U2X,SERIAL_PORT,)
  49. #define DEC 10
  50. #define HEX 16
  51. #define OCT 8
  52. #define BIN 2
  53. #define BYTE 0
  54. #ifndef AT90USB
  55. // Define constants and variables for buffering incoming serial data. We're
  56. // using a ring buffer (I think), in which rx_buffer_head is the index of the
  57. // location to which to write the next incoming character and rx_buffer_tail
  58. // is the index of the location from which to read.
  59. #define RX_BUFFER_SIZE 128
  60. struct ring_buffer
  61. {
  62. unsigned char buffer[RX_BUFFER_SIZE];
  63. int head;
  64. int tail;
  65. };
  66. #if UART_PRESENT(SERIAL_PORT)
  67. extern ring_buffer rx_buffer;
  68. #endif
  69. class MarlinSerial //: public Stream
  70. {
  71. public:
  72. MarlinSerial();
  73. void begin(long);
  74. void end();
  75. int peek(void);
  76. int read(void);
  77. void flush(void);
  78. FORCE_INLINE int available(void)
  79. {
  80. return (unsigned int)(RX_BUFFER_SIZE + rx_buffer.head - rx_buffer.tail) % RX_BUFFER_SIZE;
  81. }
  82. FORCE_INLINE void write(uint8_t c)
  83. {
  84. while (!((M_UCSRxA) & (1 << M_UDREx)))
  85. ;
  86. M_UDRx = c;
  87. }
  88. FORCE_INLINE void checkRx(void)
  89. {
  90. if((M_UCSRxA & (1<<M_RXCx)) != 0) {
  91. unsigned char c = M_UDRx;
  92. int i = (unsigned int)(rx_buffer.head + 1) % RX_BUFFER_SIZE;
  93. // if we should be storing the received character into the location
  94. // just before the tail (meaning that the head would advance to the
  95. // current location of the tail), we're about to overflow the buffer
  96. // and so we don't write the character or advance the head.
  97. if (i != rx_buffer.tail) {
  98. rx_buffer.buffer[rx_buffer.head] = c;
  99. rx_buffer.head = i;
  100. }
  101. }
  102. }
  103. private:
  104. void printNumber(unsigned long, uint8_t);
  105. void printFloat(double, uint8_t);
  106. public:
  107. FORCE_INLINE void write(const char *str)
  108. {
  109. while (*str)
  110. write(*str++);
  111. }
  112. FORCE_INLINE void write(const uint8_t *buffer, size_t size)
  113. {
  114. while (size--)
  115. write(*buffer++);
  116. }
  117. FORCE_INLINE void print(const String &s)
  118. {
  119. for (int i = 0; i < (int)s.length(); i++) {
  120. write(s[i]);
  121. }
  122. }
  123. FORCE_INLINE void print(const char *str)
  124. {
  125. write(str);
  126. }
  127. void print(char, int = BYTE);
  128. void print(unsigned char, int = BYTE);
  129. void print(int, int = DEC);
  130. void print(unsigned int, int = DEC);
  131. void print(long, int = DEC);
  132. void print(unsigned long, int = DEC);
  133. void print(double, int = 2);
  134. void println(const String &s);
  135. void println(const char[]);
  136. void println(char, int = BYTE);
  137. void println(unsigned char, int = BYTE);
  138. void println(int, int = DEC);
  139. void println(unsigned int, int = DEC);
  140. void println(long, int = DEC);
  141. void println(unsigned long, int = DEC);
  142. void println(double, int = 2);
  143. void println(void);
  144. };
  145. extern MarlinSerial MSerial;
  146. #endif // !AT90USB
  147. // Use the UART for BT in AT90USB configurations
  148. #if defined(AT90USB) && defined (BTENABLED)
  149. extern HardwareSerial bt;
  150. #endif
  151. #endif