Make Serialx instance generic

Previously Serialx instance was defined by the variant.
It was not enough generic and flexible.

With this patch, all available Serialx instance are handled dynamically.
Where 'x' is the U(S)ART number.
Currently, STM32 MCU could have 9 U(S)ART.

Serial is the generic name used in Arduino sketches.
Serial is now mapped to the Serialx instance linked
to the com port in the variant.h (mainly one linked to ST-Link)
Moreover this will simplify USB integration to map the SerialUSB.

Signed-off-by: Frederic.Pillon <frederic.pillon@st.com>

Author: fpistm

cores/arduino/HardwareSerial.cpp

@@ -30,12 +30,126 @@
 #include "Arduino.h"
 #include "HardwareSerial.h"
 
+// SerialEvent functions are weak, so when the user doesn't define them,
+// the linker just sets their address to 0 (which is checked below).
+
+#if defined(HAVE_HWSERIAL1)
+  HardwareSerial Serial1(USART1);
+  void serialEvent1() __attribute__((weak));
+#endif
+
+#if defined(HAVE_HWSERIAL2)
+  HardwareSerial Serial2(USART2);
+  void serialEvent2() __attribute__((weak));
+#endif
+
+#if defined(HAVE_HWSERIAL3)
+  HardwareSerial Serial3(USART3);
+  void serialEvent3() __attribute__((weak));
+#endif
+
+#if defined(HAVE_HWSERIAL4)
+#if defined(USART4)
+  HardwareSerial Serial4(USART4);
+#else
+  HardwareSerial Serial4(UART4);
+#endif
+  void serialEvent4() __attribute__((weak));
+#endif
+
+#if defined(HAVE_HWSERIAL5)
+#if defined(USART5)
+  HardwareSerial Serial5(USART5);
+#else
+  HardwareSerial Serial5(UART5);
+#endif
+  void serialEvent5() __attribute__((weak));
+#endif
+
+#if defined(HAVE_HWSERIAL6)
+  HardwareSerial Serial6(USART6);
+  void serialEvent6() __attribute__((weak));
+#endif
+
+#if defined(HAVE_HWSERIAL7)
+#if defined(USART7)
+  HardwareSerial Serial7(USART7);
+#else
+  HardwareSerial Serial7(UART7);
+#endif
+  void serialEvent7() __attribute__((weak));
+#endif
+
+#if defined(HAVE_HWSERIAL8)
+#if defined(USART8)
+  HardwareSerial Serial8(USART8);
+#else
+  HardwareSerial Serial8(UART8);
+#endif
+  void serialEvent8() __attribute__((weak));
+#endif
+
+#if defined(HAVE_HWSERIAL9)
+  HardwareSerial Serial9(UART9);
+  void serialEvent9() __attribute__((weak));
+#endif
+
+#if defined(HAVE_HWSERIAL10)
+  HardwareSerial Serial10(UART10);
+  void serialEvent10() __attribute__((weak));
+#endif
+
+void serialEventRun(void)
+{
+#if defined(HAVE_HWSERIAL1)
+  if (serialEvent1 && Serial1.available()) serialEvent1();
+#endif
+#if defined(HAVE_HWSERIAL2)
+  if (serialEvent2 && Serial2.available()) serialEvent2();
+#endif
+#if defined(HAVE_HWSERIAL3)
+  if (serialEvent3 && Serial3.available()) serialEvent3();
+#endif
+#if defined(HAVE_HWSERIAL4)
+  if (serialEvent4 && Serial4.available()) serialEvent4();
+#endif
+#if defined(HAVE_HWSERIAL5)
+  if (serialEvent5 && Serial5.available()) serialEvent5();
+#endif
+#if defined(HAVE_HWSERIAL6)
+  if (serialEvent6 && Serial6.available()) serialEvent6();
+#endif
+#if defined(HAVE_HWSERIAL7)
+  if (serialEvent7 && Serial7.available()) serialEvent7();
+#endif
+#if defined(HAVE_HWSERIAL8)
+  if (serialEvent8 && Serial8.available()) serialEvent8();
+#endif
+#if defined(HAVE_HWSERIAL9)
+  if (serialEvent9 && Serial9.available()) serialEvent9();
+#endif
+#if defined(HAVE_HWSERIAL10)
+  if (serialEventl10 && Serial10.available()) serialEvent10();
+#endif
+}
 
 // Constructors ////////////////////////////////////////////////////////////////
 HardwareSerial::HardwareSerial(PinName _rx, PinName _tx)
 {
   _serial.pin_rx = _rx;
   _serial.pin_tx = _tx;
+  init();
+}
+
+HardwareSerial::HardwareSerial(void* peripheral)
+{
+  _serial.pin_rx = pinmap_pin(peripheral, PinMap_UART_RX);
+  _serial.pin_tx = pinmap_pin(peripheral, PinMap_UART_TX);
+  init();
+}
+
+void HardwareSerial::init(void)
+{
   _serial.rx_buff = _rx_buffer;
   _serial.rx_head = 0;
   _serial.rx_tail = 0;
@@ -87,7 +201,7 @@ void HardwareSerial::begin(unsigned long baud, byte config)
 
   _serial.baudrate = (uint32_t)baud;
 
-  // Manage databits
+  // Manage databitshardware/arduino/avr/cores/arduino/HardwareSerial.cpp
   switch(config & 0x07) {
     case 0x02:
       databits = 6;

cores/arduino/HardwareSerial.h

@@ -102,6 +102,7 @@ class HardwareSerial : public Stream
 
   public:
     HardwareSerial(PinName _rx, PinName _tx);
+    HardwareSerial(void* peripheral);
     void begin(unsigned long baud) { begin(baud, SERIAL_8N1); }
     void begin(unsigned long, uint8_t);
     void end();
@@ -121,8 +122,21 @@ class HardwareSerial : public Stream
     // Interrupt handlers
     static void _rx_complete_irq(serial_t* obj);
     static int _tx_complete_irq(serial_t* obj);
+  private:
+    void init(void);
 };
 
+extern HardwareSerial Serial1;
+extern HardwareSerial Serial2;
+extern HardwareSerial Serial3;
+extern HardwareSerial Serial4;
+extern HardwareSerial Serial5;
+extern HardwareSerial Serial6;
+extern HardwareSerial Serial7;
+extern HardwareSerial Serial8;
+extern HardwareSerial Serial9;
+extern HardwareSerial Serial10;
+
 extern void serialEventRun(void) __attribute__((weak));
 
 #endif

cores/arduino/stm32/uart.h

@@ -47,6 +47,37 @@
  extern "C" {
 #endif
 
+#if defined(USART1_BASE)
+#define HAVE_HWSERIAL1
+#endif
+#if defined(USART2_BASE)
+#define HAVE_HWSERIAL2
+#endif
+#if defined(USART3_BASE)
+#define HAVE_HWSERIAL3
+#endif
+#if defined(USART4_BASE) || defined(UART4_BASE)
+#define HAVE_HWSERIAL4
+#endif
+#if defined(USART5_BASE) || defined(UART5_BASE)
+#define HAVE_HWSERIAL5
+#endif
+#if defined(USART6_BASE)
+#define HAVE_HWSERIAL6
+#endif
+#if defined(USART7_BASE) || defined(UART7_BASE)
+#define HAVE_HWSERIAL7
+#endif
+#if defined(USART8_BASE) || defined(UART8_BASE)
+#define HAVE_HWSERIAL8
+#endif
+#if defined(UART9_BASE)
+#define HAVE_HWSERIAL9
+#endif
+#if defined(UART10_BASE)
+#define HAVE_HWSERIAL10
+#endif
+
 /* Exported types ------------------------------------------------------------*/
 typedef struct serial_s serial_t;
 

variants/DISCO_F100RB/variant.cpp

@@ -97,40 +97,6 @@ const PinName digitalPin[] = {
 }
 #endif
 
-/*
- * UART objects
- */
-
- HardwareSerial Serial(PA_3, PA_2);
- #ifdef ENABLE_SERIAL1
- HardwareSerial Serial1(PA_10, PA_9);
- #endif
- #ifdef ENABLE_SERIAL2
- HardwareSerial Serial2(PB_11, PB_10);
- #endif
-
- void serialEvent() __attribute__((weak));
- void serialEvent() { }
- #ifdef ENABLE_SERIAL1
- void serialEvent1() __attribute__((weak));
- void serialEvent1() { }
- #endif
- #ifdef ENABLE_SERIAL2
- void serialEvent2() __attribute__((weak));
- void serialEvent2() { }
- #endif
-
- void serialEventRun(void)
- {
-   if (Serial.available()) serialEvent();
- #ifdef ENABLE_SERIAL1
-   if (Serial1.available()) serialEvent1();
- #endif
- #ifdef ENABLE_SERIAL2
-   if (Serial2.available()) serialEvent2();
- #endif
- }
-
 // ----------------------------------------------------------------------------
 
 #ifdef __cplusplus

variants/DISCO_F100RB/variant.h

@@ -152,15 +152,12 @@ enum {
 //Do not use basic timer: OC is required
 #define TIMER_SERVO             TIM17  //TODO: advanced-control timers don't work
 
+// UART Definitions
 #define DEBUG_UART              ((USART_TypeDef *) USART2)
 
 // Serial Pin Firmata
 #define PIN_SERIAL_RX           8
 #define PIN_SERIAL_TX           7
-#define PIN_SERIAL1_RX          24
-#define PIN_SERIAL1_TX          23
-#define PIN_SERIAL2_RX          42
-#define PIN_SERIAL2_TX          41
 
 #ifdef __cplusplus
 } // extern "C"
@@ -169,28 +166,26 @@ enum {
  *        Arduino objects - C++ only
  *----------------------------------------------------------------------------*/
 
- #ifdef __cplusplus
- extern HardwareSerial Serial;
- extern HardwareSerial Serial1;
- extern HardwareSerial Serial2;
-
- // These serial port names are intended to allow libraries and architecture-neutral
- // sketches to automatically default to the correct port name for a particular type
- // of use.  For example, a GPS module would normally connect to SERIAL_PORT_HARDWARE_OPEN,
- // the first hardware serial port whose RX/TX pins are not dedicated to another use.
- //
- // SERIAL_PORT_MONITOR        Port which normally prints to the Arduino Serial Monitor
- //
- // SERIAL_PORT_USBVIRTUAL     Port which is USB virtual serial
- //
- // SERIAL_PORT_LINUXBRIDGE    Port which connects to a Linux system via Bridge library
- //
- // SERIAL_PORT_HARDWARE       Hardware serial port, physical RX & TX pins.
- //
- // SERIAL_PORT_HARDWARE_OPEN  Hardware serial ports which are open for use.  Their RX & TX
- //                            pins are NOT connected to anything by default.
- #define SERIAL_PORT_MONITOR    Serial
- #define SERIAL_PORT_HARDWARE   Serial
- #endif
+#ifdef __cplusplus
+#define Serial                  Serial2 //Connected to ST-Link
+
+// These serial port names are intended to allow libraries and architecture-neutral
+// sketches to automatically default to the correct port name for a particular type
+// of use.  For example, a GPS module would normally connect to SERIAL_PORT_HARDWARE_OPEN,
+// the first hardware serial port whose RX/TX pins are not dedicated to another use.
+//
+// SERIAL_PORT_MONITOR        Port which normally prints to the Arduino Serial Monitor
+//
+// SERIAL_PORT_USBVIRTUAL     Port which is USB virtual serial
+//
+// SERIAL_PORT_LINUXBRIDGE    Port which connects to a Linux system via Bridge library
+//
+// SERIAL_PORT_HARDWARE       Hardware serial port, physical RX & TX pins.
+//
+// SERIAL_PORT_HARDWARE_OPEN  Hardware serial ports which are open for use.  Their RX & TX
+//                            pins are NOT connected to anything by default.
+#define SERIAL_PORT_MONITOR     Serial
+#define SERIAL_PORT_HARDWARE    Serial
+#endif
 
 #endif /* _VARIANT_ARDUINO_STM32_ */

variants/DISCO_F407VG/variant.cpp

@@ -123,20 +123,6 @@ const PinName digitalPin[] = {
 }
 #endif
 
-/*
- * UART objects
- */
-
-HardwareSerial  Serial(PA_3, PA_2); // Could be connected to ST-Link
-
-void serialEvent() __attribute__((weak));
-void serialEvent() { }
-
-void serialEventRun(void)
-{
-  if (Serial.available()) serialEvent();
-}
-
 // ----------------------------------------------------------------------------
 
 #ifdef __cplusplus

variants/DISCO_F407VG/variant.h

@@ -177,6 +177,7 @@ enum {
 #define TIMER_SERVO             TIM7
 #define TIMER_UART_EMULATED     TIM6
 
+// UART Definitions
 #define DEBUG_UART              ((USART_TypeDef *) USART2)
 
 // UART Emulation
@@ -195,7 +196,7 @@ enum {
  *----------------------------------------------------------------------------*/
 
 #ifdef __cplusplus
-extern HardwareSerial Serial;
+#define Serial                  Serial2 // Could be connected to ST-Link
 
 // These serial port names are intended to allow libraries and architecture-neutral
 // sketches to automatically default to the correct port name for a particular type
@@ -212,8 +213,8 @@ extern HardwareSerial Serial;
 //
 // SERIAL_PORT_HARDWARE_OPEN  Hardware serial ports which are open for use.  Their RX & TX
 //                            pins are NOT connected to anything by default.
-#define SERIAL_PORT_MONITOR Serial // Require connections for ST-LINK VCP on U2 pin 12 and 13.
-                                   // See UM §6.1.3 ST-LINK/V2-A VCP configuration)
+#define SERIAL_PORT_MONITOR     Serial // Require connections for ST-LINK VCP on U2 pin 12 and 13.
+                                   // See UM §6.1.3 ST-LINK/V2-A VCP configuration)
 #define SERIAL_PORT_HARDWARE_OPEN  Serial
 #endif