[v7,00/24] wfx: get out from the staging area

Message

Jérôme Pouiller Sept. 20, 2021, 4:11 p.m. UTC

From: Jérôme Pouiller <[e-mail]>

Hello,

I think the wfx driver is now mature enough to be accepted in the
drivers/net/wireless directory.

The firmware is now a part of the linux-firmware repository since relase
20210315[1]. It had taken a bit of time because I have worked with the legal
department to simplify the redistribution terms of the firmware.

[1]: https://lore.kernel.org/linux-firmware/2833354.gXvVfaC4I7@pc-42/


As requested by Kalle[2], I send one file per patch. At the end, all the
patches (or at least the patches 3 to 24) will be squashed (therefore, I
didn't bother to write real commit messages).

[2]: https://lore.kernel.org/lkml/[e-mail]/

Here is a diagram of the global architecture that may help to understand
the code:

    ,------------------------------------.
    |                mac80211            |
    `------------------------------------'
    ,------------+-----------+-----------.
    |    sta     |           |           |
    |    scan    |           |           |
    |    main    |           |           |
    +------------+  data_tx  |           |
    |    key     |           |  data_rx  |
    | hif_tx_mib |   queue   |           |
    |   hif_tx   |           |           |
    |   hif_rx   |           |           |
    |  hif_api_* |           |           |
    +------------+-----------+-----------+--------.
    |                  bh                |  fwio  |
    +------------------------------------+--------+
    |                     hwio                    |
    +---------------------------------------------+
    |                   bus_sdio                  |
    |                   bus_spi                   |
    `---------------------------------------------'
    ,---------------------------------------------.
    |                  spi / sdio                 |
    `---------------------------------------------'

Roughly, I have sent the files from the bottom to the top.

v7:
  - Update location of mmc-pwrseq-simple.txt (Rob)

v6:
  - Rebase on last staging-next (roughtly somewhere after the 5.15
    merge window). So, this series include the patches from:
      https://lore.kernel.org/netdev/[e-mail]/

v5:
  - Add reference to the PR to linux-firmware in the cover letter
  - Rebase on last staging tree (that mainly include commit 6efed0a69794
    "staging: wfx: fix possible panic with re-queued frames" and a few
    cosmetics changes)
  - Remove useless trailing spaces in DT binding (Rob)
  - Add a commit message in the patch 2 since I am not sure it will be
    squashed with the other (Rob)

v4:
  - Rebase on last staging tree
  - Add 'additionalProperties: false' to the DT specification (I made that
    change blindly because I am able to reproduce Rob's error) (Rob)
  - Replace C++ comments with Ansi C comments (Kalle)
  - Check that existing Ansi C comments comply with net/ "compact" style
  - Drop one obsolete comment
  - Remove comments after '#endif' in header files
  - Remove macro redefinitions in hif_api_general.h (Kalle)
  - Replace compiletime_assert() with BUILD_BUG_ON_MSG() (Kalle)
  - Rename ieee80211_is_action_back() (Kalle)
  - Add a comment explaining how the PDS is sent to the device (Kalle)
  - Add a comment about case where CONFIG_MMC==m in the Makefile (Kalle)
  - Fix irrevelant comment about CONFIG_VMAP_STACK (Kalle)
  - Talk about the unreliable SDIO Vendor ID in the Kconfig help (Kalle)
  - Mention the firmware status in the cover letter (Kalle)
  - Fix misaligned function arguments in key.c

v3:
  - dt-bindings: Rename config-file property (Rob)
  - dt-bindings: No additional properties are allowed (spi-max-frequency is
    already listed) (Rob)
  - dt-bindings: Remove references for mac-address properties (Rob)
  - Rebase on staging/staging-next

v2:
  - dt-bindings: Improve device description and add link to the datasheet
      (Rob)
  - dt-bindings: Add blank lines between each DT property (Rob)
  - dt-bindings: Explicitly mention mac-address and local-mac-address and
      add references to ethernet-controller.yaml (Rob)
  - dt-bindings: "config-file" is not for development/debug (Rob)
  - dt-bindings: Remove description of "spi-max-frequency" (Rob)
  - dt-bindings: Use "folded scalar" syntax instead of escaping the colons
  - bus_sdio.c: A compatible node in the DT is now mandatory to probe the
      device. Also change documentation of dt-bindings accordingly (Pali,
      Ulf)
  - bus_sdio.c: Move SDIO IDs to sdio_ids.h (Pali)
  - bh.c: Import patch "staging: wfx: fix test on return value of
      gpiod_get_value()" (Nathan)
  - data_tx.c: Import patch "staging: wfx: fix use of uninitialized
      pointer"
  - sta.c: Import patch "staging: wfx: make a const array static, makes
      object smaller" (Colin)

v1:
  - Drop the function name in the warning message (Kalle)
  - Replace goto by return in wfx_send_pdata_pds() (Kalle, Dan)
  - Improve error label in wfx_send_pdata_pds() (Kalle)

Jérôme Pouiller (24):
  mmc: sdio: add SDIO IDs for Silabs WF200 chip
  dt-bindings: introduce silabs,wfx.yaml
  wfx: add Makefile/Kconfig
  wfx: add wfx.h
  wfx: add main.c/main.h
  wfx: add bus.h
  wfx: add bus_spi.c
  wfx: add bus_sdio.c
  wfx: add hwio.c/hwio.h
  wfx: add fwio.c/fwio.h
  wfx: add bh.c/bh.h
  wfx: add hif_api_*.h
  wfx: add hif_tx*.c/hif_tx*.h
  wfx: add key.c/key.h
  wfx: add hif_rx.c/hif_rx.h
  wfx: add data_rx.c/data_rx.h
  wfx: add queue.c/queue.h
  wfx: add data_tx.c/data_tx.h
  wfx: add sta.c/sta.h
  wfx: add scan.c/scan.h
  wfx: add debug.c/debug.h
  wfx: add traces.h
  wfx: remove from the staging area
  wfx: get out from the staging area

 .../bindings/net/wireless/silabs,wfx.yaml     | 56 +++++++++++--------
 MAINTAINERS                                   |  3 +-
 drivers/net/wireless/Kconfig                  |  1 +
 drivers/net/wireless/Makefile                 |  1 +
 drivers/net/wireless/silabs/Kconfig           | 18 ++++++
 drivers/net/wireless/silabs/Makefile          |  3 +
 .../wireless/silabs}/wfx/Kconfig              |  4 ++
 .../wireless/silabs}/wfx/Makefile             |  1 +
 .../{staging => net/wireless/silabs}/wfx/bh.c |  5 +-
 .../{staging => net/wireless/silabs}/wfx/bh.h |  0
 .../wireless/silabs}/wfx/bus.h                |  0
 .../wireless/silabs}/wfx/bus_sdio.c           | 29 +++-------
 .../wireless/silabs}/wfx/bus_spi.c            |  0
 .../wireless/silabs}/wfx/data_rx.c            |  0
 .../wireless/silabs}/wfx/data_rx.h            |  0
 .../wireless/silabs}/wfx/data_tx.c            | 12 ++--
 .../wireless/silabs}/wfx/data_tx.h            |  0
 .../wireless/silabs}/wfx/debug.c              |  0
 .../wireless/silabs}/wfx/debug.h              |  0
 .../wireless/silabs}/wfx/fwio.c               |  0
 .../wireless/silabs}/wfx/fwio.h               |  0
 .../wireless/silabs}/wfx/hif_api_cmd.h        |  0
 .../wireless/silabs}/wfx/hif_api_general.h    |  6 --
 .../wireless/silabs}/wfx/hif_api_mib.h        |  0
 .../wireless/silabs}/wfx/hif_rx.c             |  3 +-
 .../wireless/silabs}/wfx/hif_rx.h             |  0
 .../wireless/silabs}/wfx/hif_tx.c             |  1 +
 .../wireless/silabs}/wfx/hif_tx.h             |  0
 .../wireless/silabs}/wfx/hif_tx_mib.c         |  0
 .../wireless/silabs}/wfx/hif_tx_mib.h         |  0
 .../wireless/silabs}/wfx/hwio.c               | 12 ----
 .../wireless/silabs}/wfx/hwio.h               |  4 ++
 .../wireless/silabs}/wfx/key.c                |  0
 .../wireless/silabs}/wfx/key.h                |  0
 .../wireless/silabs}/wfx/main.c               | 37 ++++++------
 .../wireless/silabs}/wfx/main.h               |  0
 .../wireless/silabs}/wfx/queue.c              |  0
 .../wireless/silabs}/wfx/queue.h              |  0
 .../wireless/silabs}/wfx/scan.c               |  3 +-
 .../wireless/silabs}/wfx/scan.h               |  0
 .../wireless/silabs}/wfx/sta.c                |  6 +-
 .../wireless/silabs}/wfx/sta.h                |  0
 .../wireless/silabs}/wfx/traces.h             |  0
 .../wireless/silabs}/wfx/wfx.h                |  0
 drivers/staging/Kconfig                       |  1 -
 drivers/staging/Makefile                      |  1 -
 drivers/staging/wfx/TODO                      |  6 --
 include/linux/mmc/sdio_ids.h                  |  7 +++
 48 files changed, 112 insertions(+), 108 deletions(-)
 rename {drivers/staging/wfx/Documentation => Documentation}/devicetree/bindings/net/wireless/silabs,wfx.yaml (73%)
 create mode 100644 drivers/net/wireless/silabs/Kconfig
 create mode 100644 drivers/net/wireless/silabs/Makefile
 rename drivers/{staging => net/wireless/silabs}/wfx/Kconfig (65%)
 rename drivers/{staging => net/wireless/silabs}/wfx/Makefile (85%)
 rename drivers/{staging => net/wireless/silabs}/wfx/bh.c (97%)
 rename drivers/{staging => net/wireless/silabs}/wfx/bh.h (100%)
 rename drivers/{staging => net/wireless/silabs}/wfx/bus.h (100%)
 rename drivers/{staging => net/wireless/silabs}/wfx/bus_sdio.c (90%)
 rename drivers/{staging => net/wireless/silabs}/wfx/bus_spi.c (100%)
 rename drivers/{staging => net/wireless/silabs}/wfx/data_rx.c (100%)
 rename drivers/{staging => net/wireless/silabs}/wfx/data_rx.h (100%)
 rename drivers/{staging => net/wireless/silabs}/wfx/data_tx.c (97%)
 rename drivers/{staging => net/wireless/silabs}/wfx/data_tx.h (100%)
 rename drivers/{staging => net/wireless/silabs}/wfx/debug.c (100%)
 rename drivers/{staging => net/wireless/silabs}/wfx/debug.h (100%)
 rename drivers/{staging => net/wireless/silabs}/wfx/fwio.c (100%)
 rename drivers/{staging => net/wireless/silabs}/wfx/fwio.h (100%)
 rename drivers/{staging => net/wireless/silabs}/wfx/hif_api_cmd.h (100%)
 rename drivers/{staging => net/wireless/silabs}/wfx/hif_api_general.h (98%)
 rename drivers/{staging => net/wireless/silabs}/wfx/hif_api_mib.h (100%)
 rename drivers/{staging => net/wireless/silabs}/wfx/hif_rx.c (99%)
 rename drivers/{staging => net/wireless/silabs}/wfx/hif_rx.h (100%)
 rename drivers/{staging => net/wireless/silabs}/wfx/hif_tx.c (99%)
 rename drivers/{staging => net/wireless/silabs}/wfx/hif_tx.h (100%)
 rename drivers/{staging => net/wireless/silabs}/wfx/hif_tx_mib.c (100%)
 rename drivers/{staging => net/wireless/silabs}/wfx/hif_tx_mib.h (100%)
 rename drivers/{staging => net/wireless/silabs}/wfx/hwio.c (94%)
 rename drivers/{staging => net/wireless/silabs}/wfx/hwio.h (93%)
 rename drivers/{staging => net/wireless/silabs}/wfx/key.c (100%)
 rename drivers/{staging => net/wireless/silabs}/wfx/key.h (100%)
 rename drivers/{staging => net/wireless/silabs}/wfx/main.c (96%)
 rename drivers/{staging => net/wireless/silabs}/wfx/main.h (100%)
 rename drivers/{staging => net/wireless/silabs}/wfx/queue.c (100%)
 rename drivers/{staging => net/wireless/silabs}/wfx/queue.h (100%)
 rename drivers/{staging => net/wireless/silabs}/wfx/scan.c (98%)
 rename drivers/{staging => net/wireless/silabs}/wfx/scan.h (100%)
 rename drivers/{staging => net/wireless/silabs}/wfx/sta.c (99%)
 rename drivers/{staging => net/wireless/silabs}/wfx/sta.h (100%)
 rename drivers/{staging => net/wireless/silabs}/wfx/traces.h (100%)
 rename drivers/{staging => net/wireless/silabs}/wfx/wfx.h (100%)
 delete mode 100644 drivers/staging/wfx/TODO

Comments

Kalle Valo Oct. 1, 2021, 12:42 p.m. UTC | #1

Jerome Pouiller <[e-mail]> writes:

> From: Jérôme Pouiller <[e-mail]>
>
> Hello,
>
> I think the wfx driver is now mature enough to be accepted in the
> drivers/net/wireless directory.
>
> The firmware is now a part of the linux-firmware repository since relase
> 20210315[1]. It had taken a bit of time because I have worked with the legal
> department to simplify the redistribution terms of the firmware.
>
> [1]: https://lore.kernel.org/linux-firmware/2833354.gXvVfaC4I7@pc-42/
>
>
> As requested by Kalle[2], I send one file per patch. At the end, all the
> patches (or at least the patches 3 to 24) will be squashed (therefore, I
> didn't bother to write real commit messages).

I did another review of the driver and in general it looks pretty good.
The use of Apache license, PDS file format and the missing firmware
directory are the biggest issues I saw.

> v7:
>   - Update location of mmc-pwrseq-simple.txt (Rob)
>
> v6:
>   - Rebase on last staging-next (roughtly somewhere after the 5.15
>     merge window). So, this series include the patches from:
>       https://lore.kernel.org/netdev/[e-mail]/

BTW, it would be nice to know what commit id are you using from
staging-next, I prefer to also look at the full tree while I'm reviewing
the patches.