PlatformIO package of the Teensy core framework compatible with GCC 10 & C++20
Du kannst nicht mehr als 25 Themen auswählen Themen müssen entweder mit einem Buchstaben oder einer Ziffer beginnen. Sie können Bindestriche („-“) enthalten und bis zu 35 Zeichen lang sein.

351 Zeilen
11KB

  1. /* Teensyduino Core Library
  2. * http://www.pjrc.com/teensy/
  3. * Copyright (c) 2019 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 "imxrt.h"
  33. // Uncomment to enable 9 bit formats. These are default disabled to save memory.
  34. //#define SERIAL_9BIT_SUPPORT
  35. //
  36. // On Windows & Linux, this file is in Arduino's hardware/teensy/avr/cores/teensy3
  37. // folder. The Windows installer puts Arduino in C:\Program Files (x86)\Arduino
  38. // On Macintosh, you must control-click Arduino and select "Show Package Contents", then
  39. // look in Contents/Java/hardware/teensy/avr/cores/teensy3 to find this file.
  40. //
  41. // Teensy 4.x boards support 9 bit mode on all their serial ports
  42. #define SERIAL_7E1 0x02
  43. #define SERIAL_7O1 0x03
  44. #define SERIAL_8N1 0x00
  45. #define SERIAL_8E1 0x06
  46. #define SERIAL_8O1 0x07
  47. #define SERIAL_7E1_RXINV 0x12
  48. #define SERIAL_7O1_RXINV 0x13
  49. #define SERIAL_8N1_RXINV 0x10
  50. #define SERIAL_8E1_RXINV 0x16
  51. #define SERIAL_8O1_RXINV 0x17
  52. #define SERIAL_7E1_TXINV 0x22
  53. #define SERIAL_7O1_TXINV 0x23
  54. #define SERIAL_8N1_TXINV 0x20
  55. #define SERIAL_8E1_TXINV 0x26
  56. #define SERIAL_8O1_TXINV 0x27
  57. #define SERIAL_7E1_RXINV_TXINV 0x32
  58. #define SERIAL_7O1_RXINV_TXINV 0x33
  59. #define SERIAL_8N1_RXINV_TXINV 0x30
  60. #define SERIAL_8E1_RXINV_TXINV 0x36
  61. #define SERIAL_8O1_RXINV_TXINV 0x37
  62. #ifdef SERIAL_9BIT_SUPPORT
  63. #define SERIAL_9N1 0x84
  64. #define SERIAL_9E1 0x8E
  65. #define SERIAL_9O1 0x8F
  66. #define SERIAL_9N1_RXINV 0x94
  67. #define SERIAL_9E1_RXINV 0x9E
  68. #define SERIAL_9O1_RXINV 0x9F
  69. #define SERIAL_9N1_TXINV 0xA4
  70. #define SERIAL_9E1_TXINV 0xAE
  71. #define SERIAL_9O1_TXINV 0xAF
  72. #define SERIAL_9N1_RXINV_TXINV 0xB4
  73. #define SERIAL_9E1_RXINV_TXINV 0xBE
  74. #define SERIAL_9O1_RXINV_TXINV 0xBF
  75. #endif
  76. // We have 1/2 bit stop setting
  77. #define SERIAL_2STOP_BITS 0x100
  78. #define SERIAL_8E2 (SERIAL_8E1 | SERIAL_2STOP_BITS)
  79. #define SERIAL_8O2 (SERIAL_8O1 | SERIAL_2STOP_BITS)
  80. #define SERIAL_8E2_RXINV (SERIAL_8E1_RXINV | SERIAL_2STOP_BITS)
  81. #define SERIAL_8O2_RXINV (SERIAL_8O1_RXINV | SERIAL_2STOP_BITS)
  82. #define SERIAL_8E2_TXINV (SERIAL_8E1_TXINV | SERIAL_2STOP_BITS)
  83. #define SERIAL_8O2_TXINV (SERIAL_8O1_TXINV | SERIAL_2STOP_BITS)
  84. #define SERIAL_8E2_RXINV_TXINV (SERIAL_8E1_RXINV_TXINV | SERIAL_2STOP_BITS)
  85. #define SERIAL_8O2_RXINV_TXINV (SERIAL_8O1_RXINV_TXINV | SERIAL_2STOP_BITS)
  86. #define SERIAL_8N2 (SERIAL_8N1 | SERIAL_2STOP_BITS)
  87. #define SERIAL_8N2_RXINV (SERIAL_8N1_RXINV | SERIAL_2STOP_BITS)
  88. #define SERIAL_8N2_TXINV (SERIAL_8N1_TXINV | SERIAL_2STOP_BITS)
  89. #define SERIAL_8N2_RXINV_TXINV (SERIAL_8N1_RXINV_TXINV | SERIAL_2STOP_BITS)
  90. // bit0: parity, 0=even, 1=odd
  91. // bit1: parity, 0=disable, 1=enable
  92. // bit2: mode, 1=9bit, 0=8bit
  93. // bit3: mode10: 1=10bit, 0=8bit
  94. // bit4: rxinv, 0=normal, 1=inverted
  95. // bit5: txinv, 0=normal, 1=inverted
  96. // bit6: unused
  97. // bit7: actual data goes into 9th bit
  98. #ifdef __cplusplus
  99. #include "Stream.h"
  100. #include "core_pins.h"
  101. #ifdef SERIAL_9BIT_SUPPORT
  102. #define BUFTYPE uint16_t
  103. #else
  104. #define BUFTYPE uint8_t
  105. #endif
  106. extern "C" {
  107. extern void IRQHandler_Serial1();
  108. extern void IRQHandler_Serial2();
  109. extern void IRQHandler_Serial3();
  110. extern void IRQHandler_Serial4();
  111. extern void IRQHandler_Serial5();
  112. extern void IRQHandler_Serial6();
  113. extern void IRQHandler_Serial7();
  114. #if defined(ARDUINO_TEENSY41)
  115. extern void IRQHandler_Serial8();
  116. #endif
  117. }
  118. //===================================================================
  119. // Should find a good home for this
  120. // Map IO pin to XBar pin...
  121. //===================================================================
  122. // BUGBUG - find a good home
  123. typedef struct _pin_to_xbar_info{
  124. const uint8_t pin; // The pin number
  125. const uint8_t xbar_in_index; // What XBar input index.
  126. const uint32_t mux_val; // Value to set for mux;
  127. volatile uint32_t *select_input_register; // Which register controls the selection
  128. const uint32_t select_val; // Value for that selection
  129. } pin_to_xbar_info_t;
  130. extern const pin_to_xbar_info_t pin_to_xbar_info[];
  131. extern const uint8_t count_pin_to_xbar_info;
  132. class HardwareSerial : public Stream
  133. {
  134. public:
  135. static const uint8_t cnt_tx_pins = 2;
  136. static const uint8_t cnt_rx_pins = 2;
  137. typedef struct {
  138. const uint8_t pin; // The pin number
  139. const uint32_t mux_val; // Value to set for mux;
  140. volatile uint32_t *select_input_register; // Which register controls the selection
  141. const uint32_t select_val; // Value for that selection
  142. } pin_info_t;
  143. typedef struct {
  144. uint8_t serial_index; // which object are we? 0 based
  145. IRQ_NUMBER_t irq;
  146. void (*irq_handler)(void);
  147. void (* _serialEvent)(void);
  148. const uint8_t *serial_event_handler_default;
  149. volatile uint32_t &ccm_register;
  150. const uint32_t ccm_value;
  151. pin_info_t rx_pins[cnt_rx_pins];
  152. pin_info_t tx_pins[cnt_tx_pins];
  153. const uint8_t cts_pin;
  154. const uint8_t cts_mux_val;
  155. const uint16_t irq_priority;
  156. const uint16_t rts_low_watermark;
  157. const uint16_t rts_high_watermark;
  158. const uint8_t xbar_out_lpuartX_trig_input;
  159. } hardware_t;
  160. public:
  161. constexpr HardwareSerial(IMXRT_LPUART_t *myport, const hardware_t *myhardware,
  162. volatile BUFTYPE *_tx_buffer, size_t _tx_buffer_size,
  163. volatile BUFTYPE *_rx_buffer, size_t _rx_buffer_size) :
  164. port(myport), hardware(myhardware),
  165. tx_buffer_(_tx_buffer), rx_buffer_(_rx_buffer), tx_buffer_size_(_tx_buffer_size), rx_buffer_size_(_rx_buffer_size),
  166. tx_buffer_total_size_(_tx_buffer_size), rx_buffer_total_size_(_rx_buffer_size) {
  167. }
  168. void begin(uint32_t baud, uint16_t format=0);
  169. void end(void);
  170. virtual int available(void);
  171. virtual int peek(void);
  172. virtual void flush(void);
  173. virtual size_t write(uint8_t c);
  174. virtual int read(void);
  175. void transmitterEnable(uint8_t pin);
  176. void setRX(uint8_t pin);
  177. void setTX(uint8_t pin, bool opendrain=false);
  178. bool attachRts(uint8_t pin);
  179. bool attachCts(uint8_t pin);
  180. void clear(void);
  181. int availableForWrite(void);
  182. void addMemoryForRead(void *buffer, size_t length);
  183. void addMemoryForWrite(void *buffer, size_t length);
  184. void addStorageForRead(void *buffer, size_t length) __attribute__((deprecated("addStorageForRead was renamed to addMemoryForRead"))){
  185. addMemoryForRead(buffer, length);
  186. }
  187. void addStorageForWrite(void *buffer, size_t length) __attribute__((deprecated("addStorageForWrite was renamed to addMemoryForWrite"))){
  188. addMemoryForWrite(buffer, length);
  189. }
  190. size_t write9bit(uint32_t c);
  191. // Event Handler functions and data
  192. static uint8_t serial_event_handlers_active;
  193. using Print::write;
  194. size_t write(unsigned long n) { return write((uint8_t)n); }
  195. size_t write(long n) { return write((uint8_t)n); }
  196. size_t write(unsigned int n) { return write((uint8_t)n); }
  197. size_t write(int n) { return write((uint8_t)n); }
  198. // Only overwrite some of the virtualWrite functions if we are going to optimize them over Print version
  199. /*
  200. virtual void begin(uint32_t baud) { serial_begin(BAUD2DIV(baud)); }
  201. virtual void begin(uint32_t baud, uint32_t format) {
  202. serial_begin(BAUD2DIV(baud));
  203. serial_format(format); }
  204. */
  205. operator bool() { return true; }
  206. static inline void processSerialEventsList() {
  207. for (uint8_t i = 0; i < s_count_serials_with_serial_events; i++) {
  208. s_serials_with_serial_events[i]->doYieldCode();
  209. }
  210. }
  211. private:
  212. IMXRT_LPUART_t * const port;
  213. const hardware_t * const hardware;
  214. uint8_t rx_pin_index_ = 0x0; // default is always first item
  215. uint8_t tx_pin_index_ = 0x0;
  216. volatile BUFTYPE *tx_buffer_;
  217. volatile BUFTYPE *rx_buffer_;
  218. volatile BUFTYPE *rx_buffer_storage_ = nullptr;
  219. volatile BUFTYPE *tx_buffer_storage_ = nullptr;
  220. size_t tx_buffer_size_;
  221. size_t rx_buffer_size_;
  222. size_t tx_buffer_total_size_;
  223. size_t rx_buffer_total_size_;
  224. size_t rts_low_watermark_ = 0;
  225. size_t rts_high_watermark_ = 0;
  226. volatile uint8_t transmitting_ = 0;
  227. volatile uint16_t tx_buffer_head_ = 0;
  228. volatile uint16_t tx_buffer_tail_ = 0;
  229. volatile uint16_t rx_buffer_head_ = 0;
  230. volatile uint16_t rx_buffer_tail_ = 0;
  231. volatile uint32_t *transmit_pin_baseReg_ = 0;
  232. uint32_t transmit_pin_bitmask_ = 0;
  233. volatile uint32_t *rts_pin_baseReg_ = 0;
  234. uint32_t rts_pin_bitmask_ = 0;
  235. inline void rts_assert();
  236. inline void rts_deassert();
  237. void IRQHandler();
  238. friend void IRQHandler_Serial1();
  239. friend void IRQHandler_Serial2();
  240. friend void IRQHandler_Serial3();
  241. friend void IRQHandler_Serial4();
  242. friend void IRQHandler_Serial5();
  243. friend void IRQHandler_Serial6();
  244. friend void IRQHandler_Serial7();
  245. #if defined(ARDUINO_TEENSY41)
  246. friend void IRQHandler_Serial8();
  247. static HardwareSerial *s_serials_with_serial_events[8];
  248. #else
  249. static HardwareSerial *s_serials_with_serial_events[7];
  250. #endif
  251. static uint8_t s_count_serials_with_serial_events;
  252. void addToSerialEventsList();
  253. inline void doYieldCode() {
  254. if (available()) (*hardware->_serialEvent)();
  255. }
  256. };
  257. extern HardwareSerial Serial1;
  258. extern HardwareSerial Serial2;
  259. extern HardwareSerial Serial3;
  260. extern HardwareSerial Serial4;
  261. extern HardwareSerial Serial5;
  262. extern HardwareSerial Serial6;
  263. extern HardwareSerial Serial7;
  264. extern void serialEvent1(void);
  265. extern void serialEvent2(void);
  266. extern void serialEvent3(void);
  267. extern void serialEvent4(void);
  268. extern void serialEvent5(void);
  269. extern void serialEvent6(void);
  270. extern void serialEvent7(void);
  271. #if defined(ARDUINO_TEENSY41)
  272. extern HardwareSerial Serial8;
  273. extern void serialEvent8(void);
  274. #endif
  275. #endif // __cplusplus
  276. // c functions to call c++ code in case some programs call the old functions
  277. // Defined under extern "C" {}
  278. #ifdef __cplusplus
  279. extern "C" {
  280. #endif
  281. extern void serial_print(const char *p);
  282. extern void serial_phex(uint32_t n);
  283. extern void serial_phex16(uint32_t n);
  284. extern void serial_phex32(uint32_t n);
  285. #ifdef __cplusplus
  286. }
  287. #endif
  288. // TODO: replace with proper divisor+oversample calculation
  289. #define BAUD2DIV(baud) (24000000/16/(baud))
  290. /*
  291. #if defined(KINETISK)
  292. #define BAUD2DIV(baud) (((F_CPU * 2) + ((baud) >> 1)) / (baud))
  293. #define BAUD2DIV2(baud) (((F_CPU * 2) + ((baud) >> 1)) / (baud))
  294. #define BAUD2DIV3(baud) (((F_BUS * 2) + ((baud) >> 1)) / (baud))
  295. #elif defined(KINETISL)
  296. #if F_CPU <= 2000000
  297. #define BAUD2DIV(baud) (((F_PLL / 16 ) + ((baud) >> 1)) / (baud))
  298. #elif F_CPU <= 16000000
  299. #define BAUD2DIV(baud) (((F_PLL / (F_PLL / 1000000)) + ((baud) >> 1)) / (baud))
  300. #else
  301. #define BAUD2DIV(baud) (((F_PLL / 2 / 16) + ((baud) >> 1)) / (baud))
  302. #endif
  303. #define BAUD2DIV2(baud) (((F_BUS / 16) + ((baud) >> 1)) / (baud))
  304. #define BAUD2DIV3(baud) (((F_BUS / 16) + ((baud) >> 1)) / (baud))
  305. #endif
  306. */
  307. #endif