[PATCH net-next v2 00/15] net: sparx5: prepare for lan969x switch driver

[Daniel Machon]

== Description:

This series is the first of a multi-part series, that prepares and adds
support for the new lan969x switch driver.

The upstreaming efforts is split into multiple series (might change a
bit as we go along):

    1) Prepare the Sparx5 driver for lan969x (this series)
    2) Add support lan969x (same basic features as Sparx5 provides +
       RGMII, excl.  FDMA and VCAP)
    3) Add support for lan969x FDMA
    4) Add support for lan969x VCAP

== Lan969x in short:

The lan969x Ethernet switch family [1] provides a rich set of
switching features and port configurations (up to 30 ports) from 10Mbps
to 10Gbps, with support for RGMII, SGMII, QSGMII, USGMII, and USXGMII,
ideal for industrial & process automation infrastructure applications,
transport, grid automation, power substation automation, and ring &
intra-ring topologies. The LAN969x family is hardware and software
compatible and scalable supporting 46Gbps to 102Gbps switch bandwidths.

== Preparing Sparx5 for lan969x:

The lan969x switch chip reuses many of the IP's of the Sparx5 switch
chip, therefore it has been decided to add support through the existing
Sparx5 driver, in order to avoid a bunch of duplicate code. However, in
order to reuse the Sparx5 switch driver, we have to introduce some
mechanisms to handle the chip differences that are there.  These
mechanisms are:

    - Platform match data to contain all the differences that needs to
      be handled (constants, ops etc.)

    - Register macro indirection layer so that we can reuse the existing
      register macros.

    - Function for branching out on platform type where required.

In some places we ops out functions and in other places we branch on the
chip type. Exactly when we choose one over the other, is an estimate in
each case.

After this series is applied, the Sparx5 driver will be prepared for
lan969x and still function exactly as before.

== Patch breakdown:

Patch #1        adds private match data

Patch #2        adds register macro indirection layer

Patch #3-#4     does some preparation work

Patch #5-#7     adds chip constants and updates the code to use them

Patch #8-#13    adds and uses ops for handling functions differently on the
                two platforms.

Patch #14       adds and uses a macro for branching out on the chip type.

Patch #15 (NEW) redefines macros for internal ports and PGID's.

[1] https://www.microchip.com/en-us/product/lan9698

To: David S. Miller <davem@xxxxxxxxxxxxx>
To: Eric Dumazet <edumazet@xxxxxxxxxx>
To: Jakub Kicinski <kuba@xxxxxxxxxx>
To: Paolo Abeni <pabeni@xxxxxxxxxx>
To: Lars Povlsen <lars.povlsen@xxxxxxxxxxxxx>
To: Steen Hegelund <Steen.Hegelund@xxxxxxxxxxxxx>
To: horatiu.vultur@xxxxxxxxxxxxx
To: jensemil.schulzostergaard@xxxxxxxxxxxxx
To: UNGLinuxDriver@xxxxxxxxxxxxx
To: Richard Cochran <richardcochran@xxxxxxxxx>
To: horms@xxxxxxxxxx
To: justinstitt@xxxxxxxxxx
To: gal@xxxxxxxxxx
To: aakash.r.menon@xxxxxxxxx
To: jacob.e.keller@xxxxxxxxx
To: ast@xxxxxxxxxxx
Cc: netdev@xxxxxxxxxxxxxxx
Cc: linux-arm-kernel@xxxxxxxxxxxxxxxxxxx
Cc: linux-kernel@xxxxxxxxxxxxxxx

Signed-off-by: Daniel Machon <daniel.machon@xxxxxxxxxxxxx>
---
Changes in v2:

  Version 2 primarily handles the dropped SPX5_CONST() macro. Now
  functions access the constants directly using the sparx5->data->consts
  variable. This has the side-effect of dropping one patch, which is no
  longer required (#3 in v1), and adding a new patch that handles internal ports
  and PGID's (patch #15 in v2).

- Removed the SPX5_CONST macro and the use of it from patches #6, #7 and
  #8 in v1.

- Removed GADDR(), GSIZE() etc. macros from sparx5_main_regs.h. Instead
  the macros access the regs variable directly.

- Patch #3 in v1 is dropped (no need to rename spx5 to sparx5 anymore)

- Added patch #15 in v2. This patch changes the internal port and PGID
  values to be offsets and adds helpers to get them.

- Added the Reviewed-by tag of Jacob Keller to certain patches.

- Link to v1: https://lore.kernel.org/r/20241001-b4-sparx5-lan969x-switch-driver-v1-0-8c6896fdce66@xxxxxxxxxxxxx

---
Daniel Machon (15):
      net: sparx5: add support for private match data
      net: sparx5: add indirection layer to register macros
      net: sparx5: modify SPX5_PORTS_ALL macro
      net: sparx5: add *sparx5 argument to a few functions
      net: sparx5: add constants to match data
      net: sparx5: use SPX5_CONST for constants which already have a symbol
      net: sparx5: use SPX5_CONST for constants which do not have a symbol
      net: sparx5: add ops to match data
      net: sparx5: ops out chip port to device index/bit functions
      net: sparx5: ops out functions for getting certain array values
      net: sparx5: ops out function for setting the port mux
      net: sparx5: ops out PTP IRQ handler
      net: sparx5: ops out function for DSM calendar calculation
      net: sparx5: add is_sparx5 macro and use it throughout
      net: sparx5: redefine internal ports and PGID's as offsets

 drivers/net/ethernet/microchip/sparx5/Makefile     |    2 +-
 .../ethernet/microchip/sparx5/sparx5_calendar.c    |   56 +-
 drivers/net/ethernet/microchip/sparx5/sparx5_dcb.c |    5 +-
 .../net/ethernet/microchip/sparx5/sparx5_ethtool.c |   34 +-
 .../net/ethernet/microchip/sparx5/sparx5_fdma.c    |   10 +-
 .../ethernet/microchip/sparx5/sparx5_mactable.c    |   10 +-
 .../net/ethernet/microchip/sparx5/sparx5_main.c    |  228 +-
 .../net/ethernet/microchip/sparx5/sparx5_main.h    |  130 +-
 .../ethernet/microchip/sparx5/sparx5_main_regs.h   | 4469 +++++++++++---------
 .../net/ethernet/microchip/sparx5/sparx5_netdev.c  |   15 +-
 .../net/ethernet/microchip/sparx5/sparx5_packet.c  |    8 +-
 .../net/ethernet/microchip/sparx5/sparx5_pgid.c    |   15 +-
 .../net/ethernet/microchip/sparx5/sparx5_police.c  |    3 +-
 .../net/ethernet/microchip/sparx5/sparx5_port.c    |   76 +-
 .../net/ethernet/microchip/sparx5/sparx5_port.h    |   23 +-
 .../net/ethernet/microchip/sparx5/sparx5_psfp.c    |   49 +-
 drivers/net/ethernet/microchip/sparx5/sparx5_ptp.c |   44 +-
 drivers/net/ethernet/microchip/sparx5/sparx5_qos.c |    8 +-
 drivers/net/ethernet/microchip/sparx5/sparx5_qos.h |    2 +
 .../net/ethernet/microchip/sparx5/sparx5_regs.c    |  219 +
 .../net/ethernet/microchip/sparx5/sparx5_regs.h    |  244 ++
 .../net/ethernet/microchip/sparx5/sparx5_sdlb.c    |   15 +-
 .../ethernet/microchip/sparx5/sparx5_switchdev.c   |   33 +-
 drivers/net/ethernet/microchip/sparx5/sparx5_tc.c  |    8 +-
 .../ethernet/microchip/sparx5/sparx5_tc_flower.c   |    4 +-
 .../net/ethernet/microchip/sparx5/sparx5_vlan.c    |   47 +-
 26 files changed, 3531 insertions(+), 2226 deletions(-)
---
base-commit: 3a39d672e7f48b8d6b91a09afa4b55352773b4b5
change-id: 20240927-b4-sparx5-lan969x-switch-driver-dfcd5277fa70

Best regards,
-- 
Daniel Machon <daniel.machon@xxxxxxxxxxxxx>