[PATCH v10 0/6] serial: sc16is7xx: fix GPIO regression and rs485 improvements

[Hugo Villeneuve]

From: Hugo Villeneuve <hvilleneuve@xxxxxxxxxxxx>

Hello,
this patch series mainly fixes a GPIO regression and improve RS485 flags and
properties detection from DT.

It now also includes various small fixes and improvements that were previously
sent as separate patches, but that made testing everything difficult.

Patch 1 fixes an issue with init of first port during probing.

Patch 2 fixes an incorrect label in sc16is7xx_probe() cleanup code.

Patches 3 and 4 fix a GPIO regression by (re)allowing to choose GPIO function
for GPIO pins shared with modem status lines.

Patch 5 fixes a bug with the output value when first setting the GPIO direction.

Patch 6 allows to add a missing fetature to read common rs485 device-tree flags
and properties.

Boards that need to have GPIOS configured as modem control lines
should add that property to their device tree. Here is a list of
boards using the sc16is7xx driver in their device tree and that may
need to be modified:

    arm64/boot/dts/freescale/fsl-ls1012a-frdm.dts
    mips/boot/dts/ingenic/cu1830-neo.dts
    mips/boot/dts/ingenic/cu1000-neo.dts

fsl-ls1012a-frdm board uses a sc16is740, which has no GPIOs or modem control
lines, so no DT changes are required.

For the two Ingenic boards cu1xxx, they use a SC16IS752, which has shared modem
control lines and GPIOs. No schematics or block diagrams could be found to
understand if they need GPIOs or modem control lines. But considering that these
platforms were in use before the patch to add the modem control lines was added,
then they probably use these shared lines as GPIOs or nothing, so no DT changes
would be required.

The author of the patch to add modem control lines tested it on a board that
was used only internally.

I have tested the changes on a custom board with two SC16IS752 DUART using a
Variscite IMX8MN NANO SOM.

Thank you.

Link: [v0] https://lkml.org/lkml/2023/5/15/923
      [v1] https://lkml.org/lkml/2023/5/17/967
      [v1] https://lkml.org/lkml/2023/5/17/777
      [v1] https://lkml.org/lkml/2023/5/17/780
      [v1] https://lkml.org/lkml/2023/5/17/785
      [v1] https://lkml.org/lkml/2023/5/17/1311
      [v2] https://lkml.org/lkml/2023/5/18/516
      [v3] https://lkml.org/lkml/2023/5/25/7
      [v4] https://lkml.org/lkml/2023/5/29/656
      [v5] https://lkml.org/lkml/2023/6/1/1046
      [v6] https://lkml.org/lkml/2023/6/1/1328
      [v7] https://lkml.org/lkml/2023/6/2/861
      [v8] https://lkml.org/lkml/2023/6/7/813
           https://lkml.org/lkml/2023/7/21/1055
      [v9] https://lkml.org/lkml/2023/7/25/914

Changes for V1:
- Abandonned the approach of trying to fix GPIO regression by reverting the
  original patches, because it created more problems than it solved (breaking
  existing users). Instead, add DT property to fix the GPIO behavior.

Changes for V2:
- Integrate multiple patches into this serie.

Changes for V3:
- Integrated all patches into single serie to facilitate debugging and tests.
- Reduce number of exported GPIOs depending on new property
  nxp,modem-control-line-ports
- Added additional example in DT bindings

Changes for V4:
- Increase reset post delay to relax scheduler.
- Put comments patches at the end.
- Remove Fixes tag for patch "mark IOCONTROL register as volatile".
- Improve commit messages after reviews.
- Fix coding style issues after reviews.
- Change GPIO registration to always register the maximum number of GPIOs
  supported by the chip, but maks-out GPIOs declared as modem control lines.
- Add patch to refactor GPIO registration.
- Remove patch "serial: sc16is7xx: fix syntax error in comments".
- Remove patch "add dump registers function"

Changes for V5:
- Change patch order to facilitate stable backport(s).
- Change duplicate device addresses in DT binding examples.
- Use GENMASK for bit masks.
- Replace of_property_for_each_u32() with device_property_read_u32_array
- Add "Cc: stable..." tags

Changes for V6:
- Fix compilation bug introduced by patch 3

Changes for V7:
- Minor changes and coding style fixes after review for
  patch 5 "fix regression with GPIO configuration".

Changes for V8:
- Move mctrl_mask to "struct sc16is7xx_port" to avoid compiler warning when
  CONFIG_GPIOLIB is undefined.
- Add "struct device" member to "struct sc16is7xx_port", in order to avoid
  passing a raw "struct device" to called functions from sc16is7xx_probe().
- Add new patch "serial: sc16is7xx: remove obsolete out_thread label"

Changes for V9:
- Change DT property name in commit message and move some comments to cover
  letter for patch "fix regression with GPIO configuration".
- Add proper link to pre-v1 (v0) RFC patch.
- Add changes log for V1 and V2 to this cover letter.

Changes for V10:
- Rebase on gregkh_tty/tty-next
- Remove patch "mark IOCONTROL register as volatile" because an equivalent patch
  is now present in gregkh_tty/tty-next tree:
    https://lore.kernel.org/all/20230724034727.17335-1-hui.wang@xxxxxxxxxxxxx/
- Remove kernel version prerequisites for "Cc: <stable@xxxxxxxxxxxxxxx>" tags
- Add source code comments for patch "fix broken port 0 uart init":
- Remove confusing "Fixes" tag for patch "remove obsolete out_thread label"
- Remove patch "improve comments about variants", which will be sent as a
  separate patch
- Remove patch "add post reset delay" which will be sent as a separate patch
- Remove invalid "Cc: <stable@xxxxxxxxxxxxxxx>" tags for patch
  "fix regression with GPIO configuration"
- Change commit log message for patch "add call to get rs485 DT flags and properties"
- Merge patch "refactor GPIO controller registration" with
  "fix regression with GPIO configuration"
- Remove raw "struct device *" pointer added to "struct sc16is7xx_port".

Hugo Villeneuve (6):
  serial: sc16is7xx: fix broken port 0 uart init
  serial: sc16is7xx: remove obsolete out_thread label
  dt-bindings: sc16is7xx: Add property to change GPIO function
  serial: sc16is7xx: fix regression with GPIO configuration
  serial: sc16is7xx: fix bug when first setting GPIO direction
  serial: sc16is7xx: add missing support for rs485 devicetree properties

 .../bindings/serial/nxp,sc16is7xx.txt         |  46 +++++
 drivers/tty/serial/sc16is7xx.c                | 166 ++++++++++++++----
 2 files changed, 174 insertions(+), 38 deletions(-)


base-commit: 593135f09368dbddc0244b859a7c3befb97214e0
-- 
2.30.2