mbox series

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

Message ID 20210315132501.441681-1-Jerome.Pouiller@silabs.com
Headers show
Series wfx: get out from the staging area | expand

Message

Jérôme Pouiller March 15, 2021, 1:24 p.m. UTC
From: Jérôme Pouiller <jerome.pouiller@silabs.com>

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/87ft6p2n0h.fsf@codeaurora.org/

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.


Below the differences with the files from drivers/staging/wfx/:

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 isent 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     | 58 ++++++++------
 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 | 31 ++++----
 .../{staging => net/wireless/silabs}/wfx/bh.h |  2 +-
 .../wireless/silabs}/wfx/bus.h                |  0
 .../wireless/silabs}/wfx/bus_sdio.c           | 24 ++----
 .../wireless/silabs}/wfx/bus_spi.c            | 18 ++---
 .../wireless/silabs}/wfx/data_rx.c            |  5 +-
 .../wireless/silabs}/wfx/data_rx.h            |  2 +-
 .../wireless/silabs}/wfx/data_tx.c            | 67 ++++++++--------
 .../wireless/silabs}/wfx/data_tx.h            |  4 +-
 .../wireless/silabs}/wfx/debug.c              | 12 +--
 .../wireless/silabs}/wfx/debug.h              |  2 +-
 .../wireless/silabs}/wfx/fwio.c               | 26 +++----
 .../wireless/silabs}/wfx/fwio.h               |  2 +-
 .../wireless/silabs}/wfx/hif_api_cmd.h        | 12 +--
 .../wireless/silabs}/wfx/hif_api_general.h    | 23 +++---
 .../wireless/silabs}/wfx/hif_api_mib.h        |  2 +-
 .../wireless/silabs}/wfx/hif_rx.c             | 17 +++--
 .../wireless/silabs}/wfx/hif_rx.h             |  0
 .../wireless/silabs}/wfx/hif_tx.c             | 32 ++++----
 .../wireless/silabs}/wfx/hif_tx.h             |  0
 .../wireless/silabs}/wfx/hif_tx_mib.c         |  4 +-
 .../wireless/silabs}/wfx/hif_tx_mib.h         |  0
 .../wireless/silabs}/wfx/hwio.c               | 18 +----
 .../wireless/silabs}/wfx/hwio.h               | 22 +++---
 .../wireless/silabs}/wfx/key.c                | 30 ++++----
 .../wireless/silabs}/wfx/key.h                |  2 +-
 .../wireless/silabs}/wfx/main.c               | 37 ++++++---
 .../wireless/silabs}/wfx/main.h               |  3 +-
 .../wireless/silabs}/wfx/queue.c              | 27 ++++---
 .../wireless/silabs}/wfx/queue.h              |  4 +-
 .../wireless/silabs}/wfx/scan.c               |  3 +-
 .../wireless/silabs}/wfx/scan.h               |  2 +-
 .../wireless/silabs}/wfx/sta.c                | 76 ++++++++++---------
 .../wireless/silabs}/wfx/sta.h                |  8 +-
 .../wireless/silabs}/wfx/traces.h             |  2 +-
 .../wireless/silabs}/wfx/wfx.h                |  4 +-
 drivers/staging/Kconfig                       |  2 -
 drivers/staging/Makefile                      |  1 -
 drivers/staging/wfx/TODO                      |  6 --
 include/linux/mmc/sdio_ids.h                  |  7 ++
 48 files changed, 335 insertions(+), 293 deletions(-)
 rename {drivers/staging/wfx/Documentation => Documentation}/devicetree/bindings/net/wireless/silabs,wfx.yaml (71%)
 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 (93%)
 rename drivers/{staging => net/wireless/silabs}/wfx/bh.h (97%)
 rename drivers/{staging => net/wireless/silabs}/wfx/bus.h (100%)
 rename drivers/{staging => net/wireless/silabs}/wfx/bus_sdio.c (89%)
 rename drivers/{staging => net/wireless/silabs}/wfx/bus_spi.c (94%)
 rename drivers/{staging => net/wireless/silabs}/wfx/data_rx.c (95%)
 rename drivers/{staging => net/wireless/silabs}/wfx/data_rx.h (93%)
 rename drivers/{staging => net/wireless/silabs}/wfx/data_tx.c (91%)
 rename drivers/{staging => net/wireless/silabs}/wfx/data_tx.h (94%)
 rename drivers/{staging => net/wireless/silabs}/wfx/debug.c (96%)
 rename drivers/{staging => net/wireless/silabs}/wfx/debug.h (94%)
 rename drivers/{staging => net/wireless/silabs}/wfx/fwio.c (95%)
 rename drivers/{staging => net/wireless/silabs}/wfx/fwio.h (91%)
 rename drivers/{staging => net/wireless/silabs}/wfx/hif_api_cmd.h (97%)
 rename drivers/{staging => net/wireless/silabs}/wfx/hif_api_general.h (93%)
 rename drivers/{staging => net/wireless/silabs}/wfx/hif_api_mib.h (99%)
 rename drivers/{staging => net/wireless/silabs}/wfx/hif_rx.c (96%)
 rename drivers/{staging => net/wireless/silabs}/wfx/hif_rx.h (100%)
 rename drivers/{staging => net/wireless/silabs}/wfx/hif_tx.c (95%)
 rename drivers/{staging => net/wireless/silabs}/wfx/hif_tx.h (100%)
 rename drivers/{staging => net/wireless/silabs}/wfx/hif_tx_mib.c (98%)
 rename drivers/{staging => net/wireless/silabs}/wfx/hif_tx_mib.h (100%)
 rename drivers/{staging => net/wireless/silabs}/wfx/hwio.c (93%)
 rename drivers/{staging => net/wireless/silabs}/wfx/hwio.h (77%)
 rename drivers/{staging => net/wireless/silabs}/wfx/key.c (91%)
 rename drivers/{staging => net/wireless/silabs}/wfx/key.h (94%)
 rename drivers/{staging => net/wireless/silabs}/wfx/main.c (92%)
 rename drivers/{staging => net/wireless/silabs}/wfx/main.h (94%)
 rename drivers/{staging => net/wireless/silabs}/wfx/queue.c (92%)
 rename drivers/{staging => net/wireless/silabs}/wfx/queue.h (94%)
 rename drivers/{staging => net/wireless/silabs}/wfx/scan.c (98%)
 rename drivers/{staging => net/wireless/silabs}/wfx/scan.h (95%)
 rename drivers/{staging => net/wireless/silabs}/wfx/sta.c (92%)
 rename drivers/{staging => net/wireless/silabs}/wfx/sta.h (97%)
 rename drivers/{staging => net/wireless/silabs}/wfx/traces.h (99%)
 rename drivers/{staging => net/wireless/silabs}/wfx/wfx.h (97%)
 delete mode 100644 drivers/staging/wfx/TODO

Comments

Leon Romanovsky March 15, 2021, 3:11 p.m. UTC | #1
On Mon, Mar 15, 2021 at 02:24:40PM +0100, Jerome Pouiller wrote:
> From: Jérôme Pouiller <jerome.pouiller@silabs.com>
>
> Signed-off-by: Jérôme Pouiller <jerome.pouiller@silabs.com>
> ---
>  drivers/net/wireless/silabs/wfx/Kconfig  | 12 +++++++++++
>  drivers/net/wireless/silabs/wfx/Makefile | 26 ++++++++++++++++++++++++
>  2 files changed, 38 insertions(+)
>  create mode 100644 drivers/net/wireless/silabs/wfx/Kconfig
>  create mode 100644 drivers/net/wireless/silabs/wfx/Makefile
>
> diff --git a/drivers/net/wireless/silabs/wfx/Kconfig b/drivers/net/wireless/silabs/wfx/Kconfig
> new file mode 100644
> index 000000000000..3be4b1e735e1
> --- /dev/null
> +++ b/drivers/net/wireless/silabs/wfx/Kconfig
> @@ -0,0 +1,12 @@
> +config WFX
> +	tristate "Silicon Labs wireless chips WF200 and further"
> +	depends on MAC80211
> +	depends on MMC || !MMC # do not allow WFX=y if MMC=m
> +	depends on (SPI || MMC)
> +	help
> +	  This is a driver for Silicons Labs WFxxx series (WF200 and further)
> +	  chipsets. This chip can be found on SPI or SDIO buses.
> +
> +	  Silabs does not use a reliable SDIO vendor ID. So, to avoid conflicts,
> +	  the driver won't probe the device if it is not also declared in the
> +	  Device Tree.
> diff --git a/drivers/net/wireless/silabs/wfx/Makefile b/drivers/net/wireless/silabs/wfx/Makefile
> new file mode 100644
> index 000000000000..f399962c8619
> --- /dev/null
> +++ b/drivers/net/wireless/silabs/wfx/Makefile
> @@ -0,0 +1,26 @@
> +# SPDX-License-Identifier: GPL-2.0
> +
> +# Necessary for CREATE_TRACE_POINTS
> +CFLAGS_debug.o = -I$(src)

I wonder if it is still relevant outside of the staging tree.

Thanks
Leon Romanovsky March 17, 2021, 4:25 a.m. UTC | #2
On Mon, Mar 15, 2021 at 05:21:35PM +0100, Jérôme Pouiller wrote:
> Hi Leon,
>
> On Monday 15 March 2021 16:11:52 CET Leon Romanovsky wrote:
> > On Mon, Mar 15, 2021 at 02:24:40PM +0100, Jerome Pouiller wrote:
> > > From: Jérôme Pouiller <jerome.pouiller@silabs.com>
> > >
> > > Signed-off-by: Jérôme Pouiller <jerome.pouiller@silabs.com>
> > > ---
> > >  drivers/net/wireless/silabs/wfx/Kconfig  | 12 +++++++++++
> > >  drivers/net/wireless/silabs/wfx/Makefile | 26 ++++++++++++++++++++++++
> > >  2 files changed, 38 insertions(+)
> > >  create mode 100644 drivers/net/wireless/silabs/wfx/Kconfig
> > >  create mode 100644 drivers/net/wireless/silabs/wfx/Makefile
> > >
> > > diff --git a/drivers/net/wireless/silabs/wfx/Kconfig b/drivers/net/wireless/silabs/wfx/Kconfig
> > > new file mode 100644
> > > index 000000000000..3be4b1e735e1
> > > --- /dev/null
> > > +++ b/drivers/net/wireless/silabs/wfx/Kconfig
> > > @@ -0,0 +1,12 @@
> > > +config WFX
> > > +     tristate "Silicon Labs wireless chips WF200 and further"
> > > +     depends on MAC80211
> > > +     depends on MMC || !MMC # do not allow WFX=y if MMC=m
> > > +     depends on (SPI || MMC)
> > > +     help
> > > +       This is a driver for Silicons Labs WFxxx series (WF200 and further)
> > > +       chipsets. This chip can be found on SPI or SDIO buses.
> > > +
> > > +       Silabs does not use a reliable SDIO vendor ID. So, to avoid conflicts,
> > > +       the driver won't probe the device if it is not also declared in the
> > > +       Device Tree.
> > > diff --git a/drivers/net/wireless/silabs/wfx/Makefile b/drivers/net/wireless/silabs/wfx/Makefile
> > > new file mode 100644
> > > index 000000000000..f399962c8619
> > > --- /dev/null
> > > +++ b/drivers/net/wireless/silabs/wfx/Makefile
> > > @@ -0,0 +1,26 @@
> > > +# SPDX-License-Identifier: GPL-2.0
> > > +
> > > +# Necessary for CREATE_TRACE_POINTS
> > > +CFLAGS_debug.o = -I$(src)
> >
> > I wonder if it is still relevant outside of the staging tree.
>
> It seems this pattern is common in the main tree. You suggest to relocate
> trace.h to include/trace/events?

No, leave it as it. Sorry for the noise.

Thanks

>
> --
> Jérôme Pouiller
>
>