You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

256 lines
9.3KB

  1. /* Teensyduino Core Library
  2. * http://www.pjrc.com/teensy/
  3. * Copyright (c) 2013 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 HardwareSerial_h
  31. #define HardwareSerial_h
  32. #include "kinetis.h"
  33. // uncomment to enable 9 bit formats
  34. //#define SERIAL_9BIT_SUPPORT
  35. #define SERIAL_7E1 0x02
  36. #define SERIAL_7O1 0x03
  37. #define SERIAL_8N1 0x00
  38. #define SERIAL_8N2 0x04
  39. #define SERIAL_8E1 0x06
  40. #define SERIAL_8O1 0x07
  41. #define SERIAL_7E1_RXINV 0x12
  42. #define SERIAL_7O1_RXINV 0x13
  43. #define SERIAL_8N1_RXINV 0x10
  44. #define SERIAL_8N2_RXINV 0x14
  45. #define SERIAL_8E1_RXINV 0x16
  46. #define SERIAL_8O1_RXINV 0x17
  47. #define SERIAL_7E1_TXINV 0x22
  48. #define SERIAL_7O1_TXINV 0x23
  49. #define SERIAL_8N1_TXINV 0x20
  50. #define SERIAL_8N2_TXINV 0x24
  51. #define SERIAL_8E1_TXINV 0x26
  52. #define SERIAL_8O1_TXINV 0x27
  53. #define SERIAL_7E1_RXINV_TXINV 0x32
  54. #define SERIAL_7O1_RXINV_TXINV 0x33
  55. #define SERIAL_8N1_RXINV_TXINV 0x30
  56. #define SERIAL_8N2_RXINV_TXINV 0x34
  57. #define SERIAL_8E1_RXINV_TXINV 0x36
  58. #define SERIAL_8O1_RXINV_TXINV 0x37
  59. #ifdef SERIAL_9BIT_SUPPORT
  60. #define SERIAL_9N1 0x84
  61. #define SERIAL_9E1 0x8E
  62. #define SERIAL_9O1 0x8F
  63. #define SERIAL_9N1_RXINV 0x94
  64. #define SERIAL_9E1_RXINV 0x9E
  65. #define SERIAL_9O1_RXINV 0x9F
  66. #define SERIAL_9N1_TXINV 0xA4
  67. #define SERIAL_9E1_TXINV 0xAE
  68. #define SERIAL_9O1_TXINV 0xAF
  69. #define SERIAL_9N1_RXINV_TXINV 0xB4
  70. #define SERIAL_9E1_RXINV_TXINV 0xBE
  71. #define SERIAL_9O1_RXINV_TXINV 0xBF
  72. #endif
  73. // bit0: parity, 0=even, 1=odd
  74. // bit1: parity, 0=disable, 1=enable
  75. // bit2: mode, 1=9bit, 0=8bit
  76. // bit3: mode10: 1=10bit, 0=8bit
  77. // bit4: rxinv, 0=normal, 1=inverted
  78. // bit5: txinv, 0=normal, 1=inverted
  79. // bit6: unused
  80. // bit7: actual data goes into 9th bit
  81. #if defined(KINETISK)
  82. #define BAUD2DIV(baud) (((F_CPU * 2) + ((baud) >> 1)) / (baud))
  83. #define BAUD2DIV2(baud) (((F_CPU * 2) + ((baud) >> 1)) / (baud))
  84. #define BAUD2DIV3(baud) (((F_BUS * 2) + ((baud) >> 1)) / (baud))
  85. #elif defined(KINETISL)
  86. #if F_CPU <= 2000000
  87. #define BAUD2DIV(baud) (((F_PLL / 16 ) + ((baud) >> 1)) / (baud))
  88. #elif F_CPU <= 16000000
  89. #define BAUD2DIV(baud) (((F_PLL / (F_PLL / 1000000)) + ((baud) >> 1)) / (baud))
  90. #else
  91. #define BAUD2DIV(baud) (((F_PLL / 2 / 16) + ((baud) >> 1)) / (baud))
  92. #endif
  93. #define BAUD2DIV2(baud) (((F_BUS / 16) + ((baud) >> 1)) / (baud))
  94. #define BAUD2DIV3(baud) (((F_BUS / 16) + ((baud) >> 1)) / (baud))
  95. #endif
  96. // C language implementation
  97. //
  98. #ifdef __cplusplus
  99. extern "C" {
  100. #endif
  101. void serial_begin(uint32_t divisor);
  102. void serial_format(uint32_t format);
  103. void serial_end(void);
  104. void serial_set_transmit_pin(uint8_t pin);
  105. void serial_putchar(uint32_t c);
  106. void serial_write(const void *buf, unsigned int count);
  107. void serial_flush(void);
  108. int serial_write_buffer_free(void);
  109. int serial_available(void);
  110. int serial_getchar(void);
  111. int serial_peek(void);
  112. void serial_clear(void);
  113. void serial_print(const char *p);
  114. void serial_phex(uint32_t n);
  115. void serial_phex16(uint32_t n);
  116. void serial_phex32(uint32_t n);
  117. void serial2_begin(uint32_t divisor);
  118. void serial2_format(uint32_t format);
  119. void serial2_end(void);
  120. void serial2_set_transmit_pin(uint8_t pin);
  121. void serial2_putchar(uint32_t c);
  122. void serial2_write(const void *buf, unsigned int count);
  123. void serial2_flush(void);
  124. int serial2_write_buffer_free(void);
  125. int serial2_available(void);
  126. int serial2_getchar(void);
  127. int serial2_peek(void);
  128. void serial2_clear(void);
  129. void serial3_begin(uint32_t divisor);
  130. void serial3_format(uint32_t format);
  131. void serial3_end(void);
  132. void serial3_set_transmit_pin(uint8_t pin);
  133. void serial3_putchar(uint32_t c);
  134. void serial3_write(const void *buf, unsigned int count);
  135. void serial3_flush(void);
  136. int serial3_write_buffer_free(void);
  137. int serial3_available(void);
  138. int serial3_getchar(void);
  139. int serial3_peek(void);
  140. void serial3_clear(void);
  141. #ifdef __cplusplus
  142. }
  143. #endif
  144. // C++ interface
  145. //
  146. #ifdef __cplusplus
  147. #include "Stream.h"
  148. class HardwareSerial : public Stream
  149. {
  150. public:
  151. virtual void begin(uint32_t baud) { serial_begin(BAUD2DIV(baud)); }
  152. virtual void begin(uint32_t baud, uint32_t format) {
  153. serial_begin(BAUD2DIV(baud));
  154. serial_format(format); }
  155. virtual void end(void) { serial_end(); }
  156. virtual void transmitterEnable(uint8_t pin) { serial_set_transmit_pin(pin); }
  157. virtual int available(void) { return serial_available(); }
  158. virtual int peek(void) { return serial_peek(); }
  159. virtual int read(void) { return serial_getchar(); }
  160. virtual void flush(void) { serial_flush(); }
  161. virtual void clear(void) { serial_clear(); }
  162. virtual int availableForWrite(void) { return serial_write_buffer_free(); }
  163. virtual size_t write(uint8_t c) { serial_putchar(c); return 1; }
  164. virtual size_t write(unsigned long n) { return write((uint8_t)n); }
  165. virtual size_t write(long n) { return write((uint8_t)n); }
  166. virtual size_t write(unsigned int n) { return write((uint8_t)n); }
  167. virtual size_t write(int n) { return write((uint8_t)n); }
  168. virtual size_t write(const uint8_t *buffer, size_t size)
  169. { serial_write(buffer, size); return size; }
  170. virtual size_t write(const char *str) { size_t len = strlen(str);
  171. serial_write((const uint8_t *)str, len);
  172. return len; }
  173. virtual size_t write9bit(uint32_t c) { serial_putchar(c); return 1; }
  174. };
  175. extern HardwareSerial Serial1;
  176. extern void serialEvent1(void);
  177. class HardwareSerial2 : public HardwareSerial
  178. {
  179. public:
  180. virtual void begin(uint32_t baud) { serial2_begin(BAUD2DIV2(baud)); }
  181. virtual void begin(uint32_t baud, uint32_t format) {
  182. serial2_begin(BAUD2DIV(baud));
  183. serial2_format(format); }
  184. virtual void end(void) { serial2_end(); }
  185. virtual void transmitterEnable(uint8_t pin) { serial2_set_transmit_pin(pin); }
  186. virtual int available(void) { return serial2_available(); }
  187. virtual int peek(void) { return serial2_peek(); }
  188. virtual int read(void) { return serial2_getchar(); }
  189. virtual void flush(void) { serial2_flush(); }
  190. virtual void clear(void) { serial2_clear(); }
  191. virtual int availableForWrite(void) { return serial2_write_buffer_free(); }
  192. virtual size_t write(uint8_t c) { serial2_putchar(c); return 1; }
  193. virtual size_t write(unsigned long n) { return write((uint8_t)n); }
  194. virtual size_t write(long n) { return write((uint8_t)n); }
  195. virtual size_t write(unsigned int n) { return write((uint8_t)n); }
  196. virtual size_t write(int n) { return write((uint8_t)n); }
  197. virtual size_t write(const uint8_t *buffer, size_t size)
  198. { serial2_write(buffer, size); return size; }
  199. virtual size_t write(const char *str) { size_t len = strlen(str);
  200. serial2_write((const uint8_t *)str, len);
  201. return len; }
  202. virtual size_t write9bit(uint32_t c) { serial2_putchar(c); return 1; }
  203. };
  204. extern HardwareSerial2 Serial2;
  205. extern void serialEvent2(void);
  206. class HardwareSerial3 : public HardwareSerial
  207. {
  208. public:
  209. virtual void begin(uint32_t baud) { serial3_begin(BAUD2DIV3(baud)); }
  210. virtual void begin(uint32_t baud, uint32_t format) {
  211. serial3_begin(BAUD2DIV3(baud));
  212. serial3_format(format); }
  213. virtual void end(void) { serial3_end(); }
  214. virtual void transmitterEnable(uint8_t pin) { serial3_set_transmit_pin(pin); }
  215. virtual int available(void) { return serial3_available(); }
  216. virtual int peek(void) { return serial3_peek(); }
  217. virtual int read(void) { return serial3_getchar(); }
  218. virtual void flush(void) { serial3_flush(); }
  219. virtual void clear(void) { serial3_clear(); }
  220. virtual int availableForWrite(void) { return serial3_write_buffer_free(); }
  221. virtual size_t write(uint8_t c) { serial3_putchar(c); return 1; }
  222. virtual size_t write(unsigned long n) { return write((uint8_t)n); }
  223. virtual size_t write(long n) { return write((uint8_t)n); }
  224. virtual size_t write(unsigned int n) { return write((uint8_t)n); }
  225. virtual size_t write(int n) { return write((uint8_t)n); }
  226. virtual size_t write(const uint8_t *buffer, size_t size)
  227. { serial3_write(buffer, size); return size; }
  228. virtual size_t write(const char *str) { size_t len = strlen(str);
  229. serial3_write((const uint8_t *)str, len);
  230. return len; }
  231. virtual size_t write9bit(uint32_t c) { serial3_putchar(c); return 1; }
  232. };
  233. extern HardwareSerial3 Serial3;
  234. extern void serialEvent3(void);
  235. #endif
  236. #endif