Refactor uart (#13585)
commit246d04dc5782a6e60590877b83d482b5e29e0733
authorPetr Ledvina <ledvinap@gmail.com>
Mon, 4 Nov 2024 21:07:25 +0000 (4 22:07 +0100)
committerGitHub <noreply@github.com>
Mon, 4 Nov 2024 21:07:25 +0000 (4 22:07 +0100)
tree17465bdd01eb224ba983711a91cae68774fe88be
parenta659189bf03e8923bd7426f056f545b58b4131ae
Refactor uart (#13585)

* serial - refactor serial resource handling

- port related resources (tx/rx/inverted,dma)
  - are stored sequentially, with space in place of ports that are not
  enabled (RESOURCE_UART_COUNT + RESOURCE_LPUART_COUNT +
     RESOURCE_SOFTSERIAL_COUNT)
  - RESOURCE_UART_OFFSET, RESOURCE_LPUART_OFFSET, RESOURCE_SOFTSERIAL_OFFSET
  - resource entries are pointing into this array (UART, LPUART, SOFTSERIAL)
    - both pins and DMA
    - inverter is supproted only for UART + LPUART (makes sense only
     for UART, to be removed)
  - softSerialPinConfig is removed, it is no longer necessary
- serialResourceIndex(identifier) is used universally to get correct
   index into resource array
- unified handling of resources where possible
- serialOwnerTxRx() + serialOwnerIndex() are used for displaying resources
   correctly to user.
- serialType(identifier) implemented
  - serialOwnerTxRx / serialOwnerIndex are trivial with it
  - large switch() statemens are greatly simplified

* serial - merge code duplicated in all UART implementations

- drivers/serial_uart_hw.c contains merged serialUART code.
  Code did not match exactly. Obvious cases are fixed, more complicated
  use #ifs
- pin inversion unified
- uartOpen is refactored a bit

* serial - refactor uartDevice

- use 'compressed' enum from uartDeviceIdx_e. Only enabled ports are
   in this enum.
- uartDeviceIdx directly indexes uartDevice (no search necessary, no
    wasted space)
- use `serialPortIdentifier_e identifier;` for uartHardware
- for DMA remap, define only entries for enabled ports (uartDeviceIdx_e
   does not exist disabled port)

* serial - apply changes to inverter

New implementation is trivial

* serial - HAL - rxIrq, txIrq replaces by irqn

There is only one IRQ for serial

* serial - serial_post.h

Generated code to normalize target configuration.
jinja2 template is used to generate header file. Port handling is
unified a lot.

SERIAL_<type><n>_USED 0/1 - always defined, value depends on target configuration
SERIAL_<type>_MASK        - bitmask of used ports or given type. <port>1 is BIT(0)
SERIAL_<type>_COUNT       - number of enabled ports of given type
SERIAL_<type>_MAX         - <index of highest used port> + 1, 0 when no port is enabled

* targets - remove automatically calculated valued from configs

serial_post.h generated it

* serial - remove definitions replaced by serial_post.h

* serial - change LPUART to UART_LP1 in places

LPUART is mostly handled as another UART port, this change reflects it

* serial - use ARRAYLEN / ARRAYEND in some places

replaces constant that may not match actual array size

* serial - adapt softserial to changes

* serial - whitespace, comments

* softserial - fix serialTimerConfigureTimebase

* serial - suspicious code

* serial - unittests

* serial - cleanup

* serial - simpler port names

Is this useful ?

* serial - no port count for SITL necessary

* serial - fix unittests

include serial_post.h, some ports are defined, so normalization will
work fine

* timers - remove obsolete defines from SITL and unittests

* serial - cosmetic improvements

comments, whitespace, minor refactoring

* serial - fix serialInit bug

serialPortToDisable was preventing further tests

* serial - fix possible NULL pointer dereference

* serial - move serialResourceIndex to drivers

* serial - refactor pp/od and pulldown/pullup/nopull

Centralize serial options handling, decouple it from MCU type

Move some code into new drivers/serial_impl.c

* serial - make port.identifier valid early in port initialization

* serial - fix unittest

Code is moved around a bit to make unittests implementation easier

* serial - bug - fix off-by-one error

uart1/softserial1/lpuart was not working properly because of this

* serial - whipespace + formating + style + comments

No functional changes

* utils - add popcount functions

Wrap __builtin_popcount for easier use. Refactor existing code using
it. Update code using BITCOUNT macro in dynamic context (BITCOUNT is
for compile-time use only)

* serial - inverter - simplify code

* pinio - prevent array access overflow

* serial - refactor SERIAL_BIDIR_*

SERIAL_BIDIR_OD / SERIAL_BIDIR_PP
SERIAL_PULL_DEFAULT / SERIAL_PULL_NONE / SERIAL_PULL_PD

* serial - simplify code

minor refactoring
- cleaner AVOID_UARTx_FOR_PWM_PPM (unused anyway)
- serialFindPortConfiguration* - remove code duplication
- use serialType in smartaudio

* serial - add port names

- const string is assiociated with each compiled-in port (easy to pass around)
- findSerialPortByName

* cli - improve serialpassthrough

- support port options (in current mode argument)
- support port names (`serialpassthrough uart1`)
- improve error handling; check more parse errors

* cli - resources - minor refactor

- prevent SERIAL_TX_NONSENSE when parsing resource type
- fix possible NULL pointer dereference
- store resource tag only after checking all conditions
- slighty better error reporting
- `resource serial_tx 1` will print resource assignment

* serial - remane pulldown to SERIAL_PULL_SMARTAUDIO

Make sure nobody uses it by
mistake. SERIAL_PULL_SMARTAUDIO_SUPER_DANGEROUS_USE_AT_YOUR_OWN_RISK_THIS_WILL_BREAK_EVERYTHING_AND_KILL_YOUR_PET_FISH
would be better choice, but try shorter version first.

* smartaudio - minor refactor/improvement

- Fix softserial on AT32
- make it easier to handle SA on per-cpu basis

* softserial - minor refactoring

no functional changes

* UART - move AF handling before MCU dependent code

* UART - adapt APM32 / APM32F4 code

- Modeled after F4 where possible
- come code moved from APM32 to APM32F4, possbily not necessary, but
   it improves similarity with STM32F4

* UART - APM32 - remove per-pin AF

* UART - APM32 - bugfix - fix pinswap #if conditions

* UART - apply some improvemnts from APM32 to STM32

* UART - add todo for F4 serial speed

* UART - fix typo

* UART - refactor support for USE_SMARTAUDIO_NOPULLDOWN

* UART - typos, comments, minor improvements

* UART - move code into enableRxIrq

TODO: split into mcu-specific filer (but in sepatate PR)

* UART - add UART_TRAIT_xx

makes #if test easier and more consistent
more traits shall follow

* UART - fix variable name

unused branch, would trigger compilation error otherwise

* UART - use tables instead of switch

* UART - smartaudio

minor style change + better comments

* UART - unify mspPorts iteration

* UART - fix spelling

* UART - another typo

* UART - fix serialResourceIndex

offset must be added, not subtracted
offset can be negative

* UART - fix typo

Bad day ...

* UART - use const table

GCC does optimize it better.
Should not cause functional change

* UART - use OwnerIndex for inverter

- 1 based
- only UART has inversion

* UART - refactor serial_resource a bit

Single table + helper function. New table is easier to read

* UART - serial_impl header is necessary

* UART - style-only changes

typos
unify whitespace
comment improvement
add some const modifiers
use cfg in uartConfigureDma
minor improvemnt of for loops

* UART - remove LPUART inverter

LPUART always supports internal inversion, code was incomplete and
unused

* UART - update jinja template, regenerate files

* UART - enable UART module RCC clk before configuring DMA

Does not change anything, UART RCCs are enabled unconditionally
90 files changed:
mk/source.mk
src/main/cli/cli.c
src/main/common/printf_serial.c
src/main/common/utils.h
src/main/config/config.c
src/main/drivers/dma_reqmap.h
src/main/drivers/inverter.c
src/main/drivers/inverter.h
src/main/drivers/io.c
src/main/drivers/io.h
src/main/drivers/nvic.h
src/main/drivers/pinio.c
src/main/drivers/resource.c
src/main/drivers/resource.h
src/main/drivers/serial.c
src/main/drivers/serial.h
src/main/drivers/serial_impl.c [new file with mode: 0644]
src/main/drivers/serial_impl.h [copied from src/platform/STM32/dma_reqmap_mcu.h with 60% similarity]
src/main/drivers/serial_pinconfig.c
src/main/drivers/serial_resource.h [new file with mode: 0644]
src/main/drivers/serial_softserial.c
src/main/drivers/serial_softserial.h
src/main/drivers/serial_uart.c
src/main/drivers/serial_uart.h
src/main/drivers/serial_uart_hw.c [new file with mode: 0644]
src/main/drivers/serial_uart_impl.h
src/main/drivers/serial_uart_pinconfig.c
src/main/fc/init.c
src/main/io/gps.c
src/main/io/serial.c
src/main/io/serial.h
src/main/io/serial_resource.c [new file with mode: 0644]
src/main/io/smartaudio_protocol.h
src/main/io/vtx.h
src/main/io/vtx_msp.c
src/main/io/vtx_smartaudio.c
src/main/io/vtx_tramp.c
src/main/msp/msp_serial.c
src/main/msp/msp_serial.h
src/main/pg/pg_ids.h
src/main/pg/serial_uart.c
src/main/pg/serial_uart.h
src/main/rx/ibus.c
src/main/rx/sbus.c
src/main/rx/spektrum.c
src/main/sensors/voltage.c
src/main/target/common_defaults_post.h
src/main/target/common_post.h
src/main/target/serial_post.h [new file with mode: 0644]
src/main/telemetry/hott.c
src/main/telemetry/smartport.c
src/platform/APM32/dma_reqmap_mcu.c
src/platform/APM32/serial_uart_apm32.c
src/platform/APM32/serial_uart_apm32f4xx.c [copied from src/platform/STM32/serial_uart_stm32f4xx.c with 63% similarity]
src/platform/APM32/target/APM32F405/target.h
src/platform/APM32/target/APM32F407/target.h
src/platform/AT32/dma_reqmap_mcu.c
src/platform/AT32/serial_uart_at32bsp.c
src/platform/AT32/serial_uart_at32f43x.c
src/platform/AT32/target/AT32F435G/target.h
src/platform/AT32/target/AT32F435M/target.h
src/platform/SITL/target/SITL/target.h
src/platform/STM32/adc_stm32g4xx.c
src/platform/STM32/adc_stm32h7xx.c
src/platform/STM32/bus_quadspi_hal.c
src/platform/STM32/dma_reqmap_mcu.c
src/platform/STM32/dma_reqmap_mcu.h
src/platform/STM32/serial_uart_hal.c
src/platform/STM32/serial_uart_stdperiph.c
src/platform/STM32/serial_uart_stm32f4xx.c
src/platform/STM32/serial_uart_stm32f7xx.c
src/platform/STM32/serial_uart_stm32g4xx.c
src/platform/STM32/serial_uart_stm32h7xx.c
src/platform/STM32/target/STM32F405/target.h
src/platform/STM32/target/STM32F411/target.h
src/platform/STM32/target/STM32F446/target.h
src/platform/STM32/target/STM32F745/target.h
src/platform/STM32/target/STM32F7X2/target.h
src/platform/STM32/target/STM32G47X/target.h
src/platform/STM32/target/STM32H563/target.h
src/platform/STM32/target/STM32H723/target.h
src/platform/STM32/target/STM32H725/target.h
src/platform/STM32/target/STM32H730/target.h
src/platform/STM32/target/STM32H743/target.h
src/platform/STM32/target/STM32H750/target.h
src/test/Makefile
src/test/unit/io_serial_unittest.cc
src/test/unit/target.h
src/utils/gen-serial-j2.py [new file with mode: 0644]
src/utils/templates/serial_post.h [new file with mode: 0644]