Merge pull request #592 from sherlockflight/blackbox-serial-baud

Support new 230400 baud rate which allows >750Hz Blackbox logging

docs/Blackbox.md

@@ -40,8 +40,10 @@ flight logs from other craft, and I can add support for them!)
 
 Cleanflight's `looptime` setting will decide how many times per second an update is saved to the flight log. The
 software was developed on a craft with a looptime of 2400. Any looptime smaller than this will put more strain on the
-data rate. The default looptime on Cleanflight is 3500. If you're using a looptime of 2000 or smaller, you will probably
+data rate. The default looptime on Cleanflight is 3500. 
-need to reduce the sampling rate in the Blackbox settings, see the later section on configuring the Blackbox feature for
+
+If you're using a looptime of 2300 or smaller, you will probably need to reduce the sampling rate in the Blackbox
+settings, or increase your logger's baudrate to 250000. See the later section on configuring the Blackbox feature for
 details.
 
 ## Hardware
@@ -53,9 +55,12 @@ compatible flight controller you can store the logs on the onboard dataflash sto
 ### OpenLog serial data logger
 
 The OpenLog ships with standard OpenLog 3 firmware installed. However, in order to reduce the number of dropped frames,
-it should be reflashed with the [OpenLog Light firmware][] or the special [OpenLog Blackbox firmware][] . The Blackbox
+it should be reflashed with the [OpenLog Light firmware][] or the special [OpenLog Blackbox firmware][] (this needs to
-variant of the firmware ensures that the OpenLog is running at the correct baud-rate and does away for the need for a 
+be version 2.0 or higher to allow configuration of baud rates). 
-`CONFIG.TXT` file to set up the OpenLog.
+
+The Blackbox variant of the firmware ensures that the OpenLog is using the correct settings, and defaults to 115200
+baud. If you are using a looptime of 2500 or smaller, you should set the baud rate to 250000 instead to eliminate
+dropped frames.
 
 You can find the Blackbox version of the OpenLog firmware [here](https://github.com/cleanflight/blackbox-firmware), 
 along with instructions for installing it onto your OpenLog.
@@ -74,11 +79,13 @@ not a guarantee of better performance.
 
  - Generic 4GB Class 4 microSDHC card - the rate of missing frames is about 1%, and is concentrated around the most
    interesting parts of the log!
+ - Sandisk Ultra 32GB (unlike the smaller 16GB version, this version has poor write latency)
 
 ##### microSDHC cards known to have good performance
 
  - Transcend 16GB Class 10 UHS-I microSDHC (typical error rate < 0.1%)
  - Sandisk Extreme 16GB Class 10 UHS-I microSDHC (typical error rate < 0.1%)
+ - Sandisk Ultra 16GB (it performs only half as well as the Extreme in theory, but still very good)
 
 You should format any card you use with the [SD Association's special formatting tool][] , as it will give the OpenLog
 the best chance of writing at high speed. You must format it with either FAT, or with FAT32 (recommended).
@@ -87,17 +94,23 @@ the best chance of writing at high speed. You must format it with either FAT, or
 
 #### OpenLog configuration
 
-This section applies only if you are using the OpenLog or OpenLog Light original firmware on the OpenLog. If you flashed
-it with the special OpenLog Blackbox firmware, you don't need to configure it further.
-
 Power up the OpenLog with a microSD card inside, wait 10 seconds or so, then power it down and plug the microSD card
-into your computer. You should find a "CONFIG.TXT" file on the card. Edit it in a text editor to set the first number
+into your computer. You should find a "CONFIG.TXT" file on the card. You should see the baud rate that the OpenLog has
-(baud) to 115200. Set esc# to 0, mode to 0, and echo to 0. Save the file and put the card back into your OpenLog, it
+been configured to. You probably want this to be set to either 115200 (the default) or 250000 (for craft with looptimes
-should use those settings from now on.
+smaller than 2500).
+
+Save the file and put the card back into your OpenLog, it should use those settings from now on.
 
 If your OpenLog didn't write a CONFIG.TXT file, create a CONFIG.TXT file with these contents and store it in the root
 of the MicroSD card:
 
+```
+115200
+baud
+```
+
+If you are using the official OpenLog Light firmware, use this configuration instead:
+
 ```
 115200,26,0,0,1,0,1
 baud,escape,esc#,mode,verb,echo,ignoreRX
@@ -105,7 +118,7 @@ baud,escape,esc#,mode,verb,echo,ignoreRX
 
 #### Serial port
 
-A 115200 baud serial port is required to connect the OpenLog to your flight controller (such as `serial_port_1` on the
+A hardware serial port is required to connect the OpenLog to your flight controller (such as `serial_port_1` on the
 Naze32, the two-pin Tx/Rx header in the center of the board). The Blackbox can not be used with softserial ports as they
 are too slow.
 
@@ -145,16 +158,19 @@ Enter `set blackbox_device=1` to switch to logging to an onboard dataflash chip,
 
 ## Configuring the Blackbox
 
+If you are using a short looptime like 2500 or smaller, try switching your OpenLog to 250000 baud (instead of the 
+default of 115200) and set that baud rate on the Blackbox's port in the Confgurator.
+
 The Blackbox currently provides two settings (`blackbox_rate_num` and `blackbox_rate_denom`) that allow you to control 
 the rate at which data is logged. These two together form a fraction (`blackbox_rate_num / blackbox_rate_denom`) which
 decides what portion of the flight controller's control loop iterations should be logged. The default is 1/1 which logs 
 every iteration.
 
-If you are using a short looptime like 2000 or faster, or you're using a slower MicroSD card, you will need to reduce
+If you're using a slower MicroSD card, you may need to reduce your logging rate to reduce the number of corrupted
-this rate to reduce the number of corrupted logged frames that `blackbox_decode` complains about. A rate of 1/2 is likely
+logged frames that `blackbox_decode` complains about. A rate of 1/2 is likely to work for most craft.
-to work for most craft.
 
-You can change these settings by entering the CLI tab in the [Cleanflight Configurator][] and using the `set` command, like so:
+You can change the logging rate settings by entering the CLI tab in the [Cleanflight Configurator][] and using the `set`
+command, like so:
 
 ```
 set blackbox_rate_num = 1

docs/Serial.md

@@ -63,3 +63,5 @@ Each baud rate is assigned an identifier, they are as follows:
 | 3          | 38400     |
 | 4          | 57600     |
 | 5          | 115200    |
+| 6          | 230400    |
+| 7          | 250000    |

src/main/blackbox/blackbox_io.c

@@ -62,9 +62,6 @@
 
 #ifdef BLACKBOX
 
-#define BLACKBOX_BAUDRATE 115200
-#define BLACKBOX_INITIAL_PORT_MODE MODE_TX
-
 // How many bytes should we transmit per loop iteration?
 uint8_t blackboxWriteChunkSize = 16;
 
@@ -447,12 +444,29 @@ bool blackboxDeviceOpen(void)
         case BLACKBOX_DEVICE_SERIAL:
             {
                 serialPortConfig_t *portConfig = findSerialPortConfig(FUNCTION_BLACKBOX);
+                baudRate_e baudRateIndex;
+                portMode_t portMode;
+
                 if (!portConfig) {
                     return false;
                 }
-                blackboxPortSharing = determinePortSharing(portConfig, FUNCTION_BLACKBOX);
 
-                blackboxPort = openSerialPort(portConfig->identifier, FUNCTION_BLACKBOX, NULL, BLACKBOX_BAUDRATE, BLACKBOX_INITIAL_PORT_MODE, SERIAL_NOT_INVERTED);
+                blackboxPortSharing = determinePortSharing(portConfig, FUNCTION_BLACKBOX);
+                baudRateIndex = portConfig->blackbox_baudrateIndex;
+
+                portMode = MODE_TX;
+
+                if (baudRates[baudRateIndex] == 230400) {
+                    /*
+                     * OpenLog's 230400 baud rate is very inaccurate, so it requires a larger inter-character gap in
+                     * order to maintain synchronization.
+                     */
+                    portMode |= MODE_STOPBITS2;
+                }
+
+                blackboxPort = openSerialPort(portConfig->identifier, FUNCTION_BLACKBOX, NULL, baudRates[baudRateIndex],
+                    portMode, SERIAL_NOT_INVERTED);
+
                 return blackboxPort != NULL;
             }
             break;

src/main/drivers/serial.h

@@ -28,6 +28,7 @@ typedef enum portMode_t {
     MODE_RXTX = MODE_RX | MODE_TX,
     MODE_SBUS = 1 << 2,
     MODE_BIDIR = 1 << 3,
+    MODE_STOPBITS2 = 1 << 4,
 } portMode_t;
 
 typedef void (*serialReceiveCallbackPtr)(uint16_t data);   // used by serial drivers to return frames to app

src/main/drivers/serial_uart.c

@@ -76,7 +76,11 @@ static void uartReconfigure(uartPort_t *uartPort)
         USART_InitStructure.USART_StopBits = USART_StopBits_2;
         USART_InitStructure.USART_Parity = USART_Parity_Even;
     } else {
+        if (uartPort->port.mode & MODE_STOPBITS2)
+            USART_InitStructure.USART_StopBits = USART_StopBits_2;
+        else
             USART_InitStructure.USART_StopBits = USART_StopBits_1;
+
         USART_InitStructure.USART_Parity = USART_Parity_No;
     }
     USART_InitStructure.USART_HardwareFlowControl = USART_HardwareFlowControl_None;

src/main/io/serial.c

@@ -68,7 +68,7 @@ serialPortIdentifier_e serialPortIdentifiers[SERIAL_PORT_COUNT] = {
 #endif
 };
 
-uint32_t baudRates[] = {0, 9600, 19200, 38400, 57600, 115200}; // see baudRate_e
+uint32_t baudRates[] = {0, 9600, 19200, 38400, 57600, 115200, 230400, 250000}; // see baudRate_e
 
 #define BAUD_RATE_COUNT (sizeof(baudRates) / sizeof(baudRates[0]))
 

src/main/io/serial.h

@@ -41,7 +41,9 @@ typedef enum {
     BAUD_19200,
     BAUD_38400,
     BAUD_57600,
-    BAUD_115200
+    BAUD_115200,
+    BAUD_230400,
+    BAUD_250000,
 } baudRate_e;
 
 extern uint32_t baudRates[];