mirror of
https://github.com/openstenoproject/qmk
synced 2024-11-10 02:30:07 +00:00
0ae20e7457
* Make solo half of split keyboards (more) usable. Using only one half of a split keyboard (that's using the split_common framework to communicate) is not a great experience, since several read timeouts per scan cycle cause an unusably slow scan rate. This change blocks all split communication attempts for 500 ms (configurable) after an error occurs, causing the scan rate to become at least _more_ usable, but might need some tweaking to work fully on most keyboards. One read timeout still needs to occur after the 500 ms has passed, and if that timeout isn't low enough, some scan cycles may still be too slow. * Fix lint complaint. * Require 25 consecutive comm errors to see comms as disconnected. The number of max errors can be overridden by defining `SPLIT_MAX_CONNECTION_ERRORS`. * Add comments to new defines, and ability to disable disconnection check. Also increase `SPLIT_MAX_CONNECTION_ERRORS` to 40, since it's divisible by most relevant numbers for the description. * Make lint happy ...again * Only update `connection_check_timer` when needed. * Add new defines to split keyboard documentation. * Move connection timeout logic to transport.c, add `is_transport_connected`. * Use split_common disconnection logic in matrix.c. Instead of doing more or less the same thing twice. * Move disconnection logic to `transport_master`. Is a cleaner implementation, and causes the scan rate while disconnected to increase instead of decrease. * Lint fixes. * Lower default `SERIAL_USART_TIMEOUT` to 20 ms. The read timeout must be low enough to not cause exessively long scan cycles when using a solo split half. 10 ms was determined from testing to work fine even with the slowest defined baudrate of 19200 (5 ms was too low for that case), so 20 ms should be fine for most cases. * Remove `SERIAL_USART_TIMEOUT` from ergodox_infinity/config.h Was somewhat mistakenly included in an earlier PR. * Fix building with `USE_I2C`. * Reduce built firmware size. Not really sure why this works, the idea was taken from tzarc's work on split disconnection. * Tweak and improve opt-out for split disconnection logic. There are now two ways to opt out from this feature: * Set `SPLIT_MAX_CONNECTION_ERRORS` to 0. This will completely disable the connection status checks (also affects the slave matrix reset logic in matrix.c, though). * Set `SPLIT_CONNECTION_CHECK_TIMEOUT` to 0. This will only disable the communication throttling while disconnected. Will make the firmware smaller. * Make split disconnection logic work with custom transports. Includes a fallback implementation for keyboards using a custom split_util.c but not a custom matrix.c (currently no such keyboard seems to be merged, though). * Remove unnecessary include of timer.h Co-authored-by: Joel Challis <git@zvecr.com> Co-authored-by: Joel Challis <git@zvecr.com>
116 lines
3.5 KiB
C
116 lines
3.5 KiB
C
/* Copyright 2021 QMK
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include "quantum.h"
|
|
#include "serial.h"
|
|
#include "printf.h"
|
|
|
|
#include <ch.h>
|
|
#include <hal.h>
|
|
|
|
#if !defined(SERIAL_USART_DRIVER)
|
|
# define SERIAL_USART_DRIVER SD1
|
|
#endif
|
|
|
|
#if !defined(USE_GPIOV1)
|
|
/* The default PAL alternate modes are used to signal that the pins are used for USART. */
|
|
# if !defined(SERIAL_USART_TX_PAL_MODE)
|
|
# define SERIAL_USART_TX_PAL_MODE 7
|
|
# endif
|
|
# if !defined(SERIAL_USART_RX_PAL_MODE)
|
|
# define SERIAL_USART_RX_PAL_MODE 7
|
|
# endif
|
|
#endif
|
|
|
|
#if defined(SOFT_SERIAL_PIN)
|
|
# define SERIAL_USART_TX_PIN SOFT_SERIAL_PIN
|
|
#endif
|
|
|
|
#if !defined(SERIAL_USART_TX_PIN)
|
|
# define SERIAL_USART_TX_PIN A9
|
|
#endif
|
|
|
|
#if !defined(SERIAL_USART_RX_PIN)
|
|
# define SERIAL_USART_RX_PIN A10
|
|
#endif
|
|
|
|
#if !defined(USART_CR1_M0)
|
|
# define USART_CR1_M0 USART_CR1_M // some platforms (f1xx) dont have this so
|
|
#endif
|
|
|
|
#if !defined(SERIAL_USART_CR1)
|
|
# define SERIAL_USART_CR1 (USART_CR1_PCE | USART_CR1_PS | USART_CR1_M0) // parity enable, odd parity, 9 bit length
|
|
#endif
|
|
|
|
#if !defined(SERIAL_USART_CR2)
|
|
# define SERIAL_USART_CR2 (USART_CR2_STOP_1) // 2 stop bits
|
|
#endif
|
|
|
|
#if !defined(SERIAL_USART_CR3)
|
|
# define SERIAL_USART_CR3 0
|
|
#endif
|
|
|
|
#if defined(USART1_REMAP)
|
|
# define USART_REMAP \
|
|
do { \
|
|
(AFIO->MAPR |= AFIO_MAPR_USART1_REMAP); \
|
|
} while (0)
|
|
#elif defined(USART2_REMAP)
|
|
# define USART_REMAP \
|
|
do { \
|
|
(AFIO->MAPR |= AFIO_MAPR_USART2_REMAP); \
|
|
} while (0)
|
|
#elif defined(USART3_PARTIALREMAP)
|
|
# define USART_REMAP \
|
|
do { \
|
|
(AFIO->MAPR |= AFIO_MAPR_USART3_REMAP_PARTIALREMAP); \
|
|
} while (0)
|
|
#elif defined(USART3_FULLREMAP)
|
|
# define USART_REMAP \
|
|
do { \
|
|
(AFIO->MAPR |= AFIO_MAPR_USART3_REMAP_FULLREMAP); \
|
|
} while (0)
|
|
#endif
|
|
|
|
#if !defined(SELECT_SOFT_SERIAL_SPEED)
|
|
# define SELECT_SOFT_SERIAL_SPEED 1
|
|
#endif
|
|
|
|
#if defined(SERIAL_USART_SPEED)
|
|
// Allow advanced users to directly set SERIAL_USART_SPEED
|
|
#elif SELECT_SOFT_SERIAL_SPEED == 0
|
|
# define SERIAL_USART_SPEED 460800
|
|
#elif SELECT_SOFT_SERIAL_SPEED == 1
|
|
# define SERIAL_USART_SPEED 230400
|
|
#elif SELECT_SOFT_SERIAL_SPEED == 2
|
|
# define SERIAL_USART_SPEED 115200
|
|
#elif SELECT_SOFT_SERIAL_SPEED == 3
|
|
# define SERIAL_USART_SPEED 57600
|
|
#elif SELECT_SOFT_SERIAL_SPEED == 4
|
|
# define SERIAL_USART_SPEED 38400
|
|
#elif SELECT_SOFT_SERIAL_SPEED == 5
|
|
# define SERIAL_USART_SPEED 19200
|
|
#else
|
|
# error invalid SELECT_SOFT_SERIAL_SPEED value
|
|
#endif
|
|
|
|
#if !defined(SERIAL_USART_TIMEOUT)
|
|
# define SERIAL_USART_TIMEOUT 20
|
|
#endif
|
|
|
|
#define HANDSHAKE_MAGIC 7
|