Skip to contentSkip to conversation

Add Microchip ZL3073x support (part 1)

PATCH Superseded Ivan Vecera 5 participants 33 messages Apr 24, 2025 – Apr 25, 2025

Subsystems (7)

v4 of 13 Superseded Latest is v13 →

lore
Share & tools
lore

Ivan Vecera

author maintainer
#0 lore raw

v4 cover Add Microchip ZL3073x support (part 1)

Add support for Microchip Azurite DPLL/PTP/SyncE chip family that provides DPLL and PTP functionality. This series bring first part that adds the common MFD driver that provides an access to the bus that can be either I2C or SPI.

The next part of the series is bringing the DPLL driver that will covers DPLL functionality. Another series will bring PTP driver and flashing capability via devlink in the MFD driver will follow soon.

Testing was done by myself and by Prathosh Satish on Microchip EDS2 development board with ZL30732 DPLL chip connected over I2C bus.

Patch breakdown
===============
Patch 1 - Common DT schema for DPLL device and pin
Patch 2 - DT bindings for microchip,zl3073* devices
Patch 3 - Basic support for I2C, SPI and regmap configuration Patch 4 - Devlink device registration and info
Patch 5 - Helpers for reading and writing register mailboxes Patch 6 - Fetch invariant register values used by DPLL/PTP sub-drivers Patch 7 - Clock ID generation for DPLL driver
Patch 8 - Register/create DPLL device cells

---
v3->v4:
* fixed shortcomings in DT patches
* completely reworked register access
* removed a need to manage locking during mailbox accesses by callers
* regcache switched to maple
* dev_err_probe() in probe path
* static mfd cells during sub-devices registration

v1->v3:
* dropped macros for generating register access functions
* register access functions are provided in <linux/mfd/zl3073x_regs.h>
* fixed DT descriptions and compatible wildcard usage
* reworked regmap locking
- regmap uses implicit locking
- mailbox registers are additionally protected by extra mutex
* fixed regmap virtual address range
* added regmap rbtree cache (only for page selector now)
* dropped patches for exporting strnchrnul and for supporting mfg file this will be maybe added later

Ivan Vecera (8):
dt-bindings: dpll: Add DPLL device and pin
dt-bindings: dpll: Add support for Microchip Azurite chip family
mfd: Add Microchip ZL3073x support
mfd: zl3073x: Add support for devlink device info
mfd: zl3073x: Add functions to work with register mailboxes
mfd: zl3073x: Fetch invariants during probe
mfd: zl3073x: Add clock_id field
mfd: zl3073x: Register DPLL sub-device during init

 .../devicetree/bindings/dpll/dpll-device.yaml |   76 ++
 .../devicetree/bindings/dpll/dpll-pin.yaml    |   45 +
 .../bindings/dpll/microchip,zl30731.yaml      |  115 ++
 MAINTAINERS                                   |   11 +
 drivers/mfd/Kconfig                           |   32 +
 drivers/mfd/Makefile                          |    5 +
 drivers/mfd/zl3073x-core.c                    | 1011 +++++++++++++++++
 drivers/mfd/zl3073x-i2c.c                     |   68 ++
 drivers/mfd/zl3073x-regs.h                    |  155 +++
 drivers/mfd/zl3073x-spi.c                     |   68 ++
 drivers/mfd/zl3073x.h                         |   31 +
 include/linux/mfd/zl3073x.h                   |  308 +++++
 12 files changed, 1925 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/dpll/dpll-device.yaml
 create mode 100644 Documentation/devicetree/bindings/dpll/dpll-pin.yaml
 create mode 100644 Documentation/devicetree/bindings/dpll/microchip,zl30731.yaml
 create mode 100644 drivers/mfd/zl3073x-core.c
 create mode 100644 drivers/mfd/zl3073x-i2c.c
 create mode 100644 drivers/mfd/zl3073x-regs.h
 create mode 100644 drivers/mfd/zl3073x-spi.c
 create mode 100644 drivers/mfd/zl3073x.h
 create mode 100644 include/linux/mfd/zl3073x.h
Signature · 1 line
2.49.0
author maintainer
#1 lore raw

PATCH v4 1/8 dt-bindings: dpll: Add DPLL device and pin

Add a common DT schema for DPLL device and its associated pins. The DPLL (device phase-locked loop) is a device used for precise clock synchronization in networking and telecom hardware.

The device includes one or more DPLLs (channels) and one or more physical input/output pins.

Each DPLL channel is used either to provide a pulse-per-clock signal or to drive an Ethernet equipment clock.

The input and output pins have the following properties:
* label: specifies board label
* connection type: specifies its usage depending on wiring
* list of supported or allowed frequencies: depending on how the pin is connected and where)
* embedded sync capability: indicates whether the pin supports this

Check:

$ make dt_binding_check DT_SCHEMA_FILES=/dpll/
  SCHEMA  Documentation/devicetree/bindings/processed-schema.json
/home/cera/devel/kernel/linux-2.6/Documentation/devicetree/bindings/net/snps,dwmac.yaml: mac-mode: missing type definition
  CHKDT   ./Documentation/devicetree/bindings
  LINT    ./Documentation/devicetree/bindings
  DTEX    Documentation/devicetree/bindings/dpll/dpll-pin.example.dts
  DTC [C] Documentation/devicetree/bindings/dpll/dpll-pin.example.dtb
  DTEX    Documentation/devicetree/bindings/dpll/dpll-device.example.dts
  DTC [C] Documentation/devicetree/bindings/dpll/dpll-device.example.dtb

---
v3->v4:
* dropped $Ref from dpll-pin reg property
* added maxItems to dpll-pin reg property
* fixed paragraph in dpll-pin desc
* dpll-pin type property renamed to connection-type v1->v3:
* rewritten description for both device and pin
* dropped num-dplls property
* supported-frequencies property renamed to supported-frequencies-hz

---
 .../devicetree/bindings/dpll/dpll-device.yaml | 76 +++++++++++++++++++
 .../devicetree/bindings/dpll/dpll-pin.yaml    | 45 +++++++++++
 MAINTAINERS                                   |  2 +
 3 files changed, 123 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/dpll/dpll-device.yaml
 create mode 100644 Documentation/devicetree/bindings/dpll/dpll-pin.yaml
Documentation/devicetree/bindings/dpll/dpll-device.yaml new file +76 -0
new file mode 100644
index 0000000000000..fb8d7a9a3693f
@@ -0,0 +1,76 @@
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/dpll/dpll-device.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Digital Phase-Locked Loop (DPLL) Device
+
+maintainers:
+  - Ivan Vecera <[email protected]>
+
+description:
+  Digital Phase-Locked Loop (DPLL) device is used for precise clock
+  synchronization in networking and telecom hardware. The device can
+  have one or more channels (DPLLs) and one or more physical input and
+  output pins. Each DPLL channel can either produce pulse-per-clock signal
+  or drive ethernet equipment clock. The type of each channel can be
+  indicated by dpll-types property.
+
+properties:
+  $nodename:
+    pattern: "^dpll(@.*)?$"
+
+  "#address-cells":
+    const: 0
+
+  "#size-cells":
+    const: 0
+
+  dpll-types:
+    description: List of DPLL channel types, one per DPLL instance.
+    $ref: /schemas/types.yaml#/definitions/non-unique-string-array
+    items:
+      enum: [pps, eec]
+
+  input-pins:
+    type: object
+    description: DPLL input pins
+    unevaluatedProperties: false
+
+    properties:
+      "#address-cells":
+        const: 1
+      "#size-cells":
+        const: 0
+
+    patternProperties:
+      "^pin@[0-9a-f]+$":
+        $ref: /schemas/dpll/dpll-pin.yaml
+        unevaluatedProperties: false
+
+    required:
+      - "#address-cells"
+      - "#size-cells"
+
+  output-pins:
+    type: object
+    description: DPLL output pins
+    unevaluatedProperties: false
+
+    properties:
+      "#address-cells":
+        const: 1
+      "#size-cells":
+        const: 0
+
+    patternProperties:
+      "^pin@[0-9]+$":
+        $ref: /schemas/dpll/dpll-pin.yaml
+        unevaluatedProperties: false
+
+    required:
+      - "#address-cells"
+      - "#size-cells"
+
+additionalProperties: true
Documentation/devicetree/bindings/dpll/dpll-pin.yaml new file +45 -0

45 lines not on this page · raw message

MAINTAINERS +2 -0
index 82e4b96030df5..b815e02987f3c 100644
@@ -7188,6 +7188,8 @@ M:	Arkadiusz Kubalewski <[email protected]>
 M:	Jiri Pirko <[email protected]>
 L:	[email protected]
 S:	Supported
+F:	Documentation/devicetree/bindings/dpll/dpll-device.yaml
+F:	Documentation/devicetree/bindings/dpll/dpll-pin.yaml
 F:	Documentation/driver-api/dpll.rst
 F:	drivers/dpll/*
 F:	include/linux/dpll.h
Signature · 1 line
2.49.0
#2 lore raw

Re: [PATCH net-next v4 1/8] dt-bindings: dpll: Add DPLL device and pin

Quoted 10 lines · Ivan Vecera

Add a common DT schema for DPLL device and its associated pins. The DPLL (device phase-locked loop) is a device used for precise clock synchronization in networking and telecom hardware.

The device includes one or more DPLLs (channels) and one or more physical input/output pins.

Each DPLL channel is used either to provide a pulse-per-clock signal or to drive an Ethernet equipment clock.

Quoted 8 lines

The input and output pins have the following properties:
* label: specifies board label
* connection type: specifies its usage depending on wiring
* list of supported or allowed frequencies: depending on how the pin is connected and where)
* embedded sync capability: indicates whether the pin supports this

Check:

This does not belong to commit msg. You do not add compile commands of C files, do you?

Whatever you want to inform and is not relevant in the Git history should be in changelog part.

Quoted 16 lines
$ make dt_binding_check DT_SCHEMA_FILES=/dpll/
  SCHEMA  Documentation/devicetree/bindings/processed-schema.json
/home/cera/devel/kernel/linux-2.6/Documentation/devicetree/bindings/net/snps,dwmac.yaml: mac-mode: missing type definition
  CHKDT   ./Documentation/devicetree/bindings
  LINT    ./Documentation/devicetree/bindings
  DTEX    Documentation/devicetree/bindings/dpll/dpll-pin.example.dts
  DTC [C] Documentation/devicetree/bindings/dpll/dpll-pin.example.dtb
  DTEX    Documentation/devicetree/bindings/dpll/dpll-device.example.dts
  DTC [C] Documentation/devicetree/bindings/dpll/dpll-device.example.dtb

---
v3->v4:
* dropped $Ref from dpll-pin reg property
* added maxItems to dpll-pin reg property
* fixed paragraph in dpll-pin desc

...

Quoted 6 lines
Documentation/devicetree/bindings/dpll/dpll-device.yaml new file +6 -0
+
+properties:
+  $nodename:
+    pattern: "^dpll(@.*)?$"
+
+  "#address-cells":

Documentation/devicetree/bindings/dpll/dpll-device.yaml line 34

Quoted 10 lines
Documentation/devicetree/bindings/dpll/dpll-device.yaml new file +10 -0
+    const: 0
+
+  "#size-cells":
+    const: 0
+
+  dpll-types:
+    description: List of DPLL channel types, one per DPLL instance.
+    $ref: /schemas/types.yaml#/definitions/non-unique-string-array
+    items:
+      enum: [pps, eec]

Do channels have other properties as well in general?

Documentation/devicetree/bindings/dpll/dpll-device.yaml line 39

Quoted 5 lines
Documentation/devicetree/bindings/dpll/dpll-device.yaml new file +5 -0
+
+  input-pins:
+    type: object
+    description: DPLL input pins
+    unevaluatedProperties: false

Best regards,
Krzysztof

author maintainer
#3 lore raw

Re: [PATCH net-next v4 1/8] dt-bindings: dpll: Add DPLL device and pin

Quoted 18 lines · Krzysztof Kozlowski
Quoted 17 lines · Ivan Vecera

Add a common DT schema for DPLL device and its associated pins. The DPLL (device phase-locked loop) is a device used for precise clock synchronization in networking and telecom hardware.

The device includes one or more DPLLs (channels) and one or more physical input/output pins.

Each DPLL channel is used either to provide a pulse-per-clock signal or to drive an Ethernet equipment clock.

The input and output pins have the following properties:
* label: specifies board label
* connection type: specifies its usage depending on wiring
* list of supported or allowed frequencies: depending on how the pin is connected and where)
* embedded sync capability: indicates whether the pin supports this

Quoted 7 lines
Quoted 1 line

Check:

This does not belong to commit msg. You do not add compile commands of C files, do you?

Whatever you want to inform and is not relevant in the Git history should be in changelog part.

OK

Quoted 29 lines
Quoted 16 lines
$ make dt_binding_check DT_SCHEMA_FILES=/dpll/
   SCHEMA  Documentation/devicetree/bindings/processed-schema.json
/home/cera/devel/kernel/linux-2.6/Documentation/devicetree/bindings/net/snps,dwmac.yaml: mac-mode: missing type definition
   CHKDT   ./Documentation/devicetree/bindings
   LINT    ./Documentation/devicetree/bindings
   DTEX    Documentation/devicetree/bindings/dpll/dpll-pin.example.dts
   DTC [C] Documentation/devicetree/bindings/dpll/dpll-pin.example.dtb
   DTEX    Documentation/devicetree/bindings/dpll/dpll-device.example.dts
   DTC [C] Documentation/devicetree/bindings/dpll/dpll-device.example.dtb

---
v3->v4:
* dropped $Ref from dpll-pin reg property
* added maxItems to dpll-pin reg property
* fixed paragraph in dpll-pin desc

...

Quoted 10 lines
Documentation/devicetree/bindings/dpll/dpll-device.yaml new file +10 -0
+
+properties:
+  $nodename:
+    pattern: "^dpll(@.*)?$"
+
+  "#address-cells":
+    const: 0
+
+  "#size-cells":
+    const: 0
Quoted 8 lines

Documentation/devicetree/bindings/dpll/dpll-device.yaml line 34

Quoted 6 lines
Documentation/devicetree/bindings/dpll/dpll-device.yaml new file +6 -0
+
+  dpll-types:
+    description: List of DPLL channel types, one per DPLL instance.
+    $ref: /schemas/types.yaml#/definitions/non-unique-string-array
+    items:
+      enum: [pps, eec]

Do channels have other properties as well in general?

No, other characteristics should be deducible either from compatible or in runtime.

Quoted 9 lines

Documentation/devicetree/bindings/dpll/dpll-device.yaml line 39

Quoted 5 lines
Documentation/devicetree/bindings/dpll/dpll-device.yaml new file +5 -0
+
+  input-pins:
+    type: object
+    description: DPLL input pins
+    unevaluatedProperties: false

Best regards,
Krzysztof

#4 lore raw

Re: [PATCH net-next v4 1/8] dt-bindings: dpll: Add DPLL device and pin

Quoted 8 lines · Ivan Vecera
Quoted 8 lines
Quoted 7 lines
Documentation/devicetree/bindings/dpll/dpll-device.yaml new file +7 -0
+    const: 0
+
+  dpll-types:
+    description: List of DPLL channel types, one per DPLL instance.
+    $ref: /schemas/types.yaml#/definitions/non-unique-string-array
+    items:
+      enum: [pps, eec]
Quoted 5 lines
Quoted 1 line

Do channels have other properties as well in general?

No, other characteristics should be deducible either from compatible or in runtime.

OK, with fixes in commit msg:

Best regards,
Krzysztof

author maintainer
#5 lore raw

PATCH v4 2/8 dt-bindings: dpll: Add support for Microchip Azurite chip family

In reply to Ivan Vecera

Add DT bindings for Microchip Azurite DPLL chip family. These chips provide up to 5 independent DPLL channels, 10 differential or single-ended inputs and 10 differential or 20 single-ended outputs. They can be connected via I2C or SPI busses.

Check:

$ make dt_binding_check DT_SCHEMA_FILES=/dpll/
  SCHEMA  Documentation/devicetree/bindings/processed-schema.json
/home/cera/devel/kernel/linux-2.6/Documentation/devicetree/bindings/net/snps,dwmac.yaml: mac-mode: missing type definition
  CHKDT   ./Documentation/devicetree/bindings
  LINT    ./Documentation/devicetree/bindings
  DTC [C] Documentation/devicetree/bindings/dpll/dpll-pin.example.dtb
  DTEX    Documentation/devicetree/bindings/dpll/microchip,zl30731.example.dts
  DTC [C] Documentation/devicetree/bindings/dpll/microchip,zl30731.example.dtb
  DTC [C] Documentation/devicetree/bindings/dpll/dpll-device.example.dtb

---
v3->v4:
* fixed $Id
* dpll-pin type property renamed to connection type v1->v3:
* single file for both i2c & spi
* 5 compatibles for all supported chips from the family

---
 .../bindings/dpll/microchip,zl30731.yaml      | 115 ++++++++++++++++++
 1 file changed, 115 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/dpll/microchip,zl30731.yaml
Documentation/devicetree/bindings/dpll/microchip,zl30731.yaml new file +115 -0
new file mode 100644
index 0000000000000..17747f754b845
@@ -0,0 +1,115 @@
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/dpll/microchip,zl30731.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Microchip Azurite DPLL device
+
+maintainers:
+  - Ivan Vecera <[email protected]>
+
+description:
+  Microchip Azurite DPLL (ZL3073x) is a family of DPLL devices that
+  provides up to 5 independent DPLL channels, up to 10 differential or
+  single-ended inputs and 10 differential or 20 single-ended outputs.
+  These devices support both I2C and SPI interfaces.
+
+properties:
+  compatible:
+    enum:
+      - microchip,zl30731
+      - microchip,zl30732
+      - microchip,zl30733
+      - microchip,zl30734
+      - microchip,zl30735
+
+  reg:
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+
+allOf:
+  - $ref: /schemas/dpll/dpll-device.yaml#
+  - $ref: /schemas/spi/spi-peripheral-props.yaml#
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    i2c {
+      #address-cells = <1>;
+      #size-cells = <0>;
+
+      dpll@70 {
+        compatible = "microchip,zl30732";
+        reg = <0x70>;
+        dpll-types = "pps", "eec";
+
+        input-pins {
+          #address-cells = <1>;
+          #size-cells = <0>;
+
+          pin@0 { /* REF0P */
+            reg = <0>;
+            connection-type = "ext";
+            label = "Input 0";
+            supported-frequencies-hz = /bits/ 64 <1 1000>;
+          };
+        };
+
+        output-pins {
+          #address-cells = <1>;
+          #size-cells = <0>;
+
+          pin@3 { /* OUT1N */
+            reg = <3>;
+            connection-type = "gnss";
+            esync-control;
+            label = "Output 1";
+            supported-frequencies-hz = /bits/ 64 <1 10000>;
+          };
+        };
+      };
+    };
+  - |
+    spi {
+      #address-cells = <1>;
+      #size-cells = <0>;
+
+      dpll@70 {
+        compatible = "microchip,zl30731";
+        reg = <0x70>;
+        spi-max-frequency = <12500000>;
+
+        dpll-types = "pps";
+
+        input-pins {
+          #address-cells = <1>;
+          #size-cells = <0>;
+
+          pin@0 { /* REF0P */
+            reg = <0>;
+            connection-type = "ext";
+            label = "Input 0";
+            supported-frequencies-hz = /bits/ 64 <1 1000>;
+          };
+        };
+
+        output-pins {
+          #address-cells = <1>;
+          #size-cells = <0>;
+
+          pin@3 { /* OUT1N */
+            reg = <3>;
+            connection-type = "gnss";
+            esync-control;
+            label = "Output 1";
+            supported-frequencies-hz = /bits/ 64 <1 10000>;
+          };
+        };
+      };
+    };
+...
Signature · 1 line
2.49.0
Reviewed-by on v4 2/8
#6 lore raw

Re: [PATCH net-next v4 2/8] dt-bindings: dpll: Add support for Microchip Azurite chip family

Quoted 7 lines · Ivan Vecera

Add DT bindings for Microchip Azurite DPLL chip family. These chips provide up to 5 independent DPLL channels, 10 differential or single-ended inputs and 10 differential or 20 single-ended outputs. They can be connected via I2C or SPI busses.

Check:

$ make dt_binding_check DT_SCHEMA_FILES=/dpll/

None of these commands belong to the commit msg. Look at all other
commits: do you see it anywhere?

Quoted 9 lines

SCHEMA Documentation/devicetree/bindings/processed-schema.json
/home/cera/devel/kernel/linux-2.6/Documentation/devicetree/bindings/net/snps,dwmac.yaml: mac-mode: missing type definition
CHKDT ./Documentation/devicetree/bindings
LINT ./Documentation/devicetree/bindings
DTC [C] Documentation/devicetree/bindings/dpll/dpll-pin.example.dtb
DTEX Documentation/devicetree/bindings/dpll/microchip,zl30731.example.dts
DTC [C] Documentation/devicetree/bindings/dpll/microchip,zl30731.example.dtb
DTC [C] Documentation/devicetree/bindings/dpll/dpll-device.example.dtb

With above fixed:

---

<form letter>
This is an automated instruction, just in case, because many review tags are being ignored. If you know the process, you can skip it (please do not feel offended by me posting it here - no bad intentions intended). If you do not know the process, here is a short explanation:

Please add Acked-by/Reviewed-by/Tested-by tags when posting new versions of patchset, under or above your Signed-off-by tag, unless patch changed significantly (e.g. new properties added to the DT bindings). Tag is "received", when provided in a message replied to you on the mailing list. Tools like b4 can help here. However, there's no need to repost patches *only* to add the tags. The upstream maintainer will do that for tags received on the version they apply.

https://elixir.bootlin.com/linux/v6.12-rc3/source/Documentation/process/submitting-patches.rst#L577
</form letter>

Best regards,
Krzysztof

author maintainer
#7 lore raw

Re: [PATCH net-next v4 2/8] dt-bindings: dpll: Add support for Microchip Azurite chip family

Quoted 11 lines · Krzysztof Kozlowski
Quoted 7 lines · Ivan Vecera

Add DT bindings for Microchip Azurite DPLL chip family. These chips provide up to 5 independent DPLL channels, 10 differential or single-ended inputs and 10 differential or 20 single-ended outputs. They can be connected via I2C or SPI busses.

Check:

$ make dt_binding_check DT_SCHEMA_FILES=/dpll/

None of these commands belong to the commit msg. Look at all other
commits: do you see it anywhere?

+1

Quoted 10 lines
Quoted 9 lines

SCHEMA Documentation/devicetree/bindings/processed-schema.json
/home/cera/devel/kernel/linux-2.6/Documentation/devicetree/bindings/net/snps,dwmac.yaml: mac-mode: missing type definition
CHKDT ./Documentation/devicetree/bindings
LINT ./Documentation/devicetree/bindings
DTC [C] Documentation/devicetree/bindings/dpll/dpll-pin.example.dtb
DTEX Documentation/devicetree/bindings/dpll/microchip,zl30731.example.dts
DTC [C] Documentation/devicetree/bindings/dpll/microchip,zl30731.example.dtb
DTC [C] Documentation/devicetree/bindings/dpll/dpll-device.example.dtb

Quoted 3 lines

With above fixed:

Thank you.

I.

Quoted 22 lines

---

<form letter>
This is an automated instruction, just in case, because many review tags are being ignored. If you know the process, you can skip it (please do not feel offended by me posting it here - no bad intentions intended). If you do not know the process, here is a short explanation:

Please add Acked-by/Reviewed-by/Tested-by tags when posting new versions of patchset, under or above your Signed-off-by tag, unless patch changed significantly (e.g. new properties added to the DT bindings). Tag is "received", when provided in a message replied to you on the mailing list. Tools like b4 can help here. However, there's no need to repost patches *only* to add the tags. The upstream maintainer will do that for tags received on the version they apply.

https://elixir.bootlin.com/linux/v6.12-rc3/source/Documentation/process/submitting-patches.rst#L577
</form letter>

Best regards,
Krzysztof

author maintainer
#8 lore raw

PATCH v4 3/8 mfd: Add Microchip ZL3073x support

In reply to Ivan Vecera

Add base MFD driver for Microchip Azurite ZL3073x chip family. These chips provide DPLL and PHC (PTP) functionality and can be connected over I2C or SPI bus.

The MFD driver handles basic communication and synchronization over the bus, as well as common functionality that are used by the DPLL driver (part 2) and by the PTP driver (to be added later).

The chip family has the following characteristics:
* up to 5 separate DPLL units (channels)
* 5 synthesizers
* 10 input pins (references)
* 10 outputs
* 20 output pins (output pin pair shares one output)
* Each reference and output can operate in either differential or single-ended mode (differential mode uses 2 pins)
* Each output is connected to one of the synthesizers
* Each synthesizer is driven by one of the DPLL unit

The device uses 7-bit addresses and 8-bits values. It exposes 8-, 16-, 32- and 48-bits registers in address range <0x000,0x77F>. Due to 7bit addressing, the range is organized into pages of 128 bytes, with each page containing a page selector register at address 0x7F. For reading/writing multi-byte registers, the device supports bulk transfers.

---
v3->v4:
* zl3073x_regs.h moved to drivers/mfd/
* maple as regcache
* added and used general helper to read 16bit registers
* removed mailbox mutex for now
* removed parentheses in zl3073x_is_volatile_reg()
* used dev_err_probe() in probe path
* dropped <linux/device.h> inclusion
* dropped unneccessary i2c_set_clientdata() and spi_set_drvdata()

v2->v3:
* added chip_info with valid chip ids and num of DPLLs for compatibles
* regmap is using implicit locking
* mailbox registers requires extra mutex to be held
* added helpers to access registers
* report device firmware and config version using dev_dbg
* fixed regmap ranges
* enabled rbtree regcache for page selector

v1->v2:
* fixed header issues
* removed usage of of_match_ptr
* added check for devm_mutex_init
* removed commas after sentinels
* removed variable initialization in zl3073x_i2c_probe()
* moved device tables closer to their users
* renamed zl3073x_dev_alloc() to zl3073x_devm_alloc()
* removed empty zl3073x_dev_exit()
* spidev renamed to spi
* squashed together with device DT bindings
* used dev_err_probe() instead of dev_err() during probe
* added some function documentation
DT bindings:
* spliced to separate files for i2c and spi
* fixed property order in DT bindings' examples
* added description

---
 MAINTAINERS                 |   9 ++
 drivers/mfd/Kconfig         |  30 ++++
 drivers/mfd/Makefile        |   5 +
 drivers/mfd/zl3073x-core.c  | 264 ++++++++++++++++++++++++++++++++++++
 drivers/mfd/zl3073x-i2c.c   |  66 +++++++++
 drivers/mfd/zl3073x-regs.h  |  74 ++++++++++
 drivers/mfd/zl3073x-spi.c   |  66 +++++++++
 drivers/mfd/zl3073x.h       |  31 +++++
 include/linux/mfd/zl3073x.h |  21 +++
 9 files changed, 566 insertions(+)
 create mode 100644 drivers/mfd/zl3073x-core.c
 create mode 100644 drivers/mfd/zl3073x-i2c.c
 create mode 100644 drivers/mfd/zl3073x-regs.h
 create mode 100644 drivers/mfd/zl3073x-spi.c
 create mode 100644 drivers/mfd/zl3073x.h
 create mode 100644 include/linux/mfd/zl3073x.h
MAINTAINERS +9 -0
index b815e02987f3c..0f6492ba50d68 100644
@@ -15998,6 +15998,15 @@ L:	[email protected]
 S:	Supported
 F:	drivers/net/wireless/microchip/
 
+MICROCHIP ZL3073X DRIVER
+M:	Ivan Vecera <[email protected]>
+M:	Prathosh Satish <[email protected]>
+L:	[email protected]
+S:	Supported
+F:	Documentation/devicetree/bindings/dpll/microchip,zl3073x*.yaml
+F:	drivers/mfd/zl3073x*
+F:	include/linux/mfd/zl3073x.h
+
 MICROSEMI MIPS SOCS
 M:	Alexandre Belloni <[email protected]>
 M:	[email protected]
drivers/mfd/Kconfig +30 -0
index 22b9363100394..7d7902ec1d89a 100644
@@ -2422,5 +2422,35 @@ config MFD_UPBOARD_FPGA
 	  To compile this driver as a module, choose M here: the module will be
 	  called upboard-fpga.
 
+config MFD_ZL3073X_CORE
+	tristate
+	select MFD_CORE
+
+config MFD_ZL3073X_I2C
+	tristate "Microchip Azurite DPLL/PTP/SyncE with I2C"
+	depends on I2C
+	select MFD_ZL3073X_CORE
+	select REGMAP_I2C
+	help
+	  Say Y here if you want to build I2C support for the Microchip
+	  Azurite DPLL/PTP/SyncE chip family.
+
+	  To compile this driver as a module, choose M here: the module
+	  will be called zl3073x_i2c and you will also get zl3073x for
+	  the core module.
+
+config MFD_ZL3073X_SPI
+	tristate "Microchip Azurite DPLL/PTP/SyncE with SPI"
+	depends on SPI
+	select MFD_ZL3073X_CORE
+	select REGMAP_SPI
+	help
+	  Say Y here if you want to build SPI support for the Microchip
+	  Azurite DPLL/PTP/SyncE chip family.
+
+	  To compile this driver as a module, choose M here: the module
+	  will be called zl3073x_spi and you will also get zl3073x for
+	  the core module.
+
 endmenu
 endif
drivers/mfd/Makefile +5 -0
index 948cbdf42a18b..76e2babc1538f 100644
@@ -290,3 +290,8 @@ obj-$(CONFIG_MFD_RSMU_I2C)	+= rsmu_i2c.o rsmu_core.o
 obj-$(CONFIG_MFD_RSMU_SPI)	+= rsmu_spi.o rsmu_core.o
 
 obj-$(CONFIG_MFD_UPBOARD_FPGA)	+= upboard-fpga.o
+
+zl3073x-y			:= zl3073x-core.o
+obj-$(CONFIG_MFD_ZL3073X_CORE)	+= zl3073x.o
+obj-$(CONFIG_MFD_ZL3073X_I2C)	+= zl3073x-i2c.o
+obj-$(CONFIG_MFD_ZL3073X_SPI)	+= zl3073x-spi.o
drivers/mfd/zl3073x-core.c new file +264 -0

264 lines not on this page · raw message

drivers/mfd/zl3073x-i2c.c new file +66 -0

66 lines not on this page · raw message

drivers/mfd/zl3073x-regs.h new file +74 -0

74 lines not on this page · raw message

drivers/mfd/zl3073x-spi.c new file +66 -0

66 lines not on this page · raw message

drivers/mfd/zl3073x.h new file +31 -0
new file mode 100644
index 0000000000000..3a2fea61cf579
@@ -0,0 +1,31 @@
+/* SPDX-License-Identifier: GPL-2.0-only */
+
+#ifndef __ZL3073X_CORE_H
+#define __ZL3073X_CORE_H
+
+struct device;
+struct regmap_config;
+struct zl3073x_dev;
+
+enum zl3073x_chip_type {
+	ZL30731,
+	ZL30732,
+	ZL30733,
+	ZL30734,
+	ZL30735,
+};
+
+struct zl3073x_chip_info {
+	const u16	*ids;
+	size_t		num_ids;
+	int		num_channels;
+};
+
+extern const struct zl3073x_chip_info zl3073x_chip_info[];
+
+struct zl3073x_dev *zl3073x_devm_alloc(struct device *dev);
+void zl3073x_dev_init_regmap_config(struct regmap_config *regmap_cfg);
+int zl3073x_dev_probe(struct zl3073x_dev *zldev,
+		      const struct zl3073x_chip_info *chip_info);
+
+#endif /* __ZL3073X_CORE_H */
include/linux/mfd/zl3073x.h new file +21 -0
new file mode 100644
index 0000000000000..ad5344a84b320
@@ -0,0 +1,21 @@
+/* SPDX-License-Identifier: GPL-2.0-only */
+
+#ifndef __LINUX_MFD_ZL3073X_H
+#define __LINUX_MFD_ZL3073X_H
+
+#include <linux/mutex.h>
+
+struct device;
+struct regmap;
+
+/**
+ * struct zl3073x_dev - zl3073x device
+ * @dev: pointer to device
+ * @regmap: regmap to access device registers
+ */
+struct zl3073x_dev {
+	struct device		*dev;
+	struct regmap		*regmap;
+};
+
+#endif /* __LINUX_MFD_ZL3073X_H */
Signature · 1 line
2.49.0
#9 lore raw

Re: [PATCH net-next v4 3/8] mfd: Add Microchip ZL3073x support

Quoted 14 lines

+++ b/drivers/mfd/zl3073x-regs.h

drivers/mfd/zl3073x-regs.h new file +12 -0
@@ -0,0 +1,74 @@
+/* SPDX-License-Identifier: GPL-2.0-only */
+
+#ifndef __ZL3073X_REGS_H
+#define __ZL3073X_REGS_H
+
+#include <linux/bitfield.h>
+#include <linux/bits.h>
+
+/*
+ * Register address structure:
+ * ===========================
+ *  25        19 18   16 15     7 6           0

drivers/mfd/zl3073x-regs.h line 22

Quoted 10 lines
drivers/mfd/zl3073x-regs.h new file +10 -0
+ * +-------------------------------------------+
+ * | max_offset | width |  page  | page_offset |
+ * +-------------------------------------------+
+ *
+ * page_offset ... <0x00..0x7F>
+ * page .......... HW page number
+ * size .......... register byte size (1, 2, 4 or 6)
+ * max_offset .... maximal offset for indexed registers
+ *                 (for non-indexed regs max_offset == page_offset)
+ */

Something i missed earlier. This does not really describe hardware. The upper half is meta data about the register, which you encode into the register number.

How many other Linux drivers do you know about which does this?

Also width vs size.

Andrew

author maintainer
#10 lore raw

Re: [PATCH net-next v4 3/8] mfd: Add Microchip ZL3073x support

Quoted 29 lines · Andrew Lunn
Quoted 14 lines

+++ b/drivers/mfd/zl3073x-regs.h

drivers/mfd/zl3073x-regs.h new file +12 -0
@@ -0,0 +1,74 @@
+/* SPDX-License-Identifier: GPL-2.0-only */
+
+#ifndef __ZL3073X_REGS_H
+#define __ZL3073X_REGS_H
+
+#include <linux/bitfield.h>
+#include <linux/bits.h>
+
+/*
+ * Register address structure:
+ * ===========================
+ *  25        19 18   16 15     7 6           0

drivers/mfd/zl3073x-regs.h line 22

Quoted 10 lines
drivers/mfd/zl3073x-regs.h new file +10 -0
+ * +-------------------------------------------+
+ * | max_offset | width |  page  | page_offset |
+ * +-------------------------------------------+
+ *
+ * page_offset ... <0x00..0x7F>
+ * page .......... HW page number
+ * size .......... register byte size (1, 2, 4 or 6)
+ * max_offset .... maximal offset for indexed registers
+ *                 (for non-indexed regs max_offset == page_offset)
+ */

Something i missed earlier. This does not really describe hardware. The upper half is meta data about the register, which you encode into the register number.

Quoted 1 line

How many other Linux drivers do you know about which does this?

This was proposed by Andy S.

Cite:
V4L2 (or media subsystem) solve the problem by providing a common helpers for reading and writing tons of different registers in cameras. See the commit 613cbb91e9ce ("media: Add MIPI CCI register access helper functions").

They encode register address and size in register value. I have just extend this approach to cover indexed registers. The max_offset is for sanity during access to such registers, potential access out of bounds is detected and error returned.

One can use just two simple functions for both register types:
zl3073x_read_reg(zldev, ZL_REG_NONIDX1, &value); zl3073x_read_reg(zldev, ZL_REG_IDX1(idx), &value);

Quoted 2 lines

Also width vs size.

I'm sorry, just a typo during reworking.

Ivan

#11 lore raw

Re: [PATCH net-next v4 3/8] mfd: Add Microchip ZL3073x support

In reply to Ivan Vecera
kernel test robot noticed the following build warnings:

Hi Ivan,

kernel test robot noticed the following build warnings:

[auto build test WARNING on net-next/main]

url:    https://github.com/intel-lab-lkp/linux/commits/Ivan-Vecera/dt-bindings-dpll-Add-DPLL-device-and-pin/20250424-235141
base:   net-next/main
patch link:    https://lore.kernel.org/r/20250424154722.534284-4-ivecera%40redhat.com
patch subject: [PATCH net-next v4 3/8] mfd: Add Microchip ZL3073x support
reproduce: (https://download.01.org/0day-ci/archive/20250425/[email protected]/reproduce)

If you fix the issue in a separate patch/commit (i.e. not just a new version of the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <[email protected]>
| Closes: https://lore.kernel.org/oe-kbuild-all/[email protected]/

All warnings (new ones prefixed by >>):

Warning: Documentation/translations/ja_JP/process/submit-checklist.rst references a file that doesn't exist: Documentation/translations/ja_JP/SubmitChecklist
Warning: Documentation/translations/zh_CN/admin-guide/README.rst references a file that doesn't exist: Documentation/dev-tools/kgdb.rst
Warning: Documentation/translations/zh_CN/dev-tools/gdb-kernel-debugging.rst references a file that doesn't exist: Documentation/dev-tools/gdb-kernel-debugging.rst
Warning: Documentation/translations/zh_TW/admin-guide/README.rst references a file that doesn't exist: Documentation/dev-tools/kgdb.rst
Warning: Documentation/translations/zh_TW/dev-tools/gdb-kernel-debugging.rst references a file that doesn't exist: Documentation/dev-tools/gdb-kernel-debugging.rst

>> Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/dpll/microchip,zl3073x*.yaml

Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/leds/backlight/ti,lp8864.yaml Can't build as 1 mandatory dependency is missing at ./scripts/sphinx-pre-install line 984.
make[2]: *** [Documentation/Makefile:121: htmldocs] Error 255
make[1]: *** [Makefile:1804: htmldocs] Error 2
make: *** [Makefile:248: __sub-make] Error 2

Signature · 2 lines
0-DAY CI Kernel Test Service
https://github.com/intel/lkp-tests/wiki
author maintainer
#12 lore raw

PATCH v4 4/8 mfd: zl3073x: Add support for devlink device info

In reply to Ivan Vecera

Use devlink_alloc() to allocate zl3073x_dev structure, register the device as a devlink device, and add devlink callback to provide device info.

---
v3->v4:
* pass error code from devm_add_action_or_reset() call

v2->v3:
* merged devlink device allocation, registration and device info callback

v1->v2:
* dependency on NET moved to MFD_ZL3073X_CORE in Kconfig
* devlink register managed way

---
 drivers/mfd/Kconfig        |   2 +
 drivers/mfd/zl3073x-core.c | 108 ++++++++++++++++++++++++++++++++++++-
 2 files changed, 108 insertions(+), 2 deletions(-)
drivers/mfd/Kconfig +2 -0
index 7d7902ec1d89a..e4eca15af175d 100644
@@ -2424,6 +2424,8 @@ config MFD_UPBOARD_FPGA
 
 config MFD_ZL3073X_CORE
 	tristate
+	depends on NET
+	select NET_DEVLINK
 	select MFD_CORE
 
 config MFD_ZL3073X_I2C
drivers/mfd/zl3073x-core.c +106 -2

149 lines not on this page · raw message

Signature · 1 line
2.49.0
author maintainer
#13 lore raw

PATCH v4 5/8 mfd: zl3073x: Add functions to work with register mailboxes

In reply to Ivan Vecera

Registers located on page 10 and above are called mailbox-type registers. Each page represents a mailbox and is used to read from and write to configuration of a specific object (DPLL, output, reference or synth).

Each mailbox page contains a mask register, which selects an index of the target object to interact with and a semaphore register, which indicates the requested operation.

The remaining registers within the page are latch registers, which are populated by the firmware during read operations or by the driver prior to write operations.

Define structures for sending and receiving mailbox content for each supported object types, along with functions to handle reading and writing.

Currently, no locking is required, as only MFD driver accesses these registers. This will change in future.

---
v3->v4:
* completely reworked mailbox access

v1->v3:
* dropped ZL3073X_MB_OP macro usage

---
 drivers/mfd/zl3073x-core.c  | 420 ++++++++++++++++++++++++++++++++++++
 drivers/mfd/zl3073x-regs.h  |  64 ++++++
 include/linux/mfd/zl3073x.h | 141 ++++++++++++
 3 files changed, 625 insertions(+)
drivers/mfd/zl3073x-core.c +420 -0
index 28cc25b7412e9..4f7c915f17980 100644
@@ -170,6 +170,426 @@ zl3073x_read_reg(struct zl3073x_dev *zldev, unsigned int reg, void *val)
 	return rc;
 }
 
+static int
+zl3073x_write_reg(struct zl3073x_dev *zldev, unsigned int reg, const void *val)
+{
+	unsigned int len;
+	u8 buf[6];
+	int rc;
+
+	/* Offset of the last item in the indexed register or offset of
+	 * the non-indexed register itself.
+	 */
+	if (ZL_REG_OFFSET(reg) > ZL_REG_MAX_OFFSET(reg)) {
+		dev_err(zldev->dev, "Index of out range for reg 0x%04lx\n",
+			ZL_REG_ADDR(reg));
+		return -EINVAL;
+	}
+
+	len = ZL_REG_SIZE(reg);
+	switch (len) {
+	case 1:
+		buf[0] = *(u8 *)val;
+		break;
+	case 2:
+		put_unaligned_be16(*(u16 *)val, buf);
+		break;
+	case 4:
+		put_unaligned_be32(*(u32 *)val, buf);
+		break;
+	case 6:
+		put_unaligned_be48(*(u64 *)val, buf);
+		break;
+	default:
+		dev_err(zldev->dev, "Invalid reg-width %u for reg 0x%04lx\n",
+			len, ZL_REG_ADDR(reg));
+		return -EINVAL;
+	}
+
+	/* Map the register address to virtual range */
+	reg = ZL_REG_ADDR(reg) + ZL_RANGE_OFFSET;
+
+	rc = regmap_bulk_write(zldev->regmap, reg, buf, len);
+	if (rc) {
+		dev_err(zldev->dev, "Failed to write reg 0x%04x: %pe\n", reg,
+			ERR_PTR(rc));
+		return rc;
+	}
+
+	return rc;
+}
+
+static int
+zl3073x_wait_reg_zero_bits(struct zl3073x_dev *zldev, unsigned int reg, u8 mask)
+{
+	/* Register polling sleep & timeout */
+#define ZL_POLL_SLEEP_US   10
+#define ZL_POLL_TIMEOUT_US 2000000
+	unsigned int val;
+
+	/* Only 8bit registers are supported */
+	BUILD_BUG_ON(ZL_REG_SIZE(reg) != 1);
+
+	/* Map the register address to virtual range for polling */
+	reg = ZL_REG_ADDR(reg) + ZL_RANGE_OFFSET;
+
+	return regmap_read_poll_timeout(zldev->regmap, reg, val, !(val & mask),
+					ZL_POLL_SLEEP_US, ZL_POLL_TIMEOUT_US);
+}
+
+static int
+zl3073x_mb_cmd_do(struct zl3073x_dev *zldev, unsigned int cmd_reg, u8 cmd,
+		  unsigned int mask_reg, u16 mask)
+{
+	int rc;
+
+	rc = zl3073x_write_reg(zldev, mask_reg, &mask);
+	if (rc)
+		return rc;
+
+	rc = zl3073x_write_reg(zldev, cmd_reg, &cmd);
+	if (rc)
+		return rc;
+
+	/* Wait for the command to finish */
+	return zl3073x_wait_reg_zero_bits(zldev, cmd_reg, cmd);
+}
+
+/**
+ * zl3073x_mb_dpll_read - read given DPLL configuration to mailbox
+ * @zldev: pointer to device structure
+ * @index: DPLL index
+ * @fields: mask of the mailbox fields to be filled
+ * @mb: DPLL mailbox
+ *
+ * Reads selected configuration of given reference into output mailbox.
+ *
+ * Return: 0 on success, <0 on error
+ */
+int zl3073x_mb_dpll_read(struct zl3073x_dev *zldev, u8 index, u32 fields,
+			 struct zl3073x_mb_dpll *mb)
+{
+	int i, rc;
+
+	rc = zl3073x_mb_cmd_do(zldev, ZL_REG_DPLL_MB_SEM, ZL_DPLL_MB_SEM_RD,
+			       ZL_REG_DPLL_MB_MASK, BIT(index));
+	if (rc)
+		return rc;
+
+	for (i = 0; i < ARRAY_SIZE(mb->ref_prio); i++) {
+		if (fields & BIT(i)) {
+			rc = zl3073x_read_reg(zldev, ZL_REG_DPLL_REF_PRIO(i),
+					      &mb->ref_prio[i]);
+			if (rc)
+				break;
+		}
+	}
+
+	return rc;
+}
+EXPORT_SYMBOL_NS_GPL(zl3073x_mb_dpll_read, "ZL3073X");
+
+/**
+ * zl3073x_mb_dpll_write - write given DPLL configuration from mailbox
+ * @zldev: pointer to device structure
+ * @index: DPLL index
+ * @fields: mask of the mailbox fields to be written
+ * @mb: DPLL channel mailbox
+ *
+ * Writes selected fields from the mailbox into device.
+  *
+ * Return: 0 on success, <0 on error
+ */
+int zl3073x_mb_dpll_write(struct zl3073x_dev *zldev, u8 index, u32 fields,
+			  struct zl3073x_mb_dpll *mb)
+{
+	int i, rc;
+
+	for (i = 0; i < ARRAY_SIZE(mb->ref_prio); i++) {
+		if (fields & BIT(i)) {
+			rc = zl3073x_write_reg(zldev, ZL_REG_DPLL_REF_PRIO(i),
+					       &mb->ref_prio[i]);
+			if (rc)
+				break;
+		}
+	}
+
+	return zl3073x_mb_cmd_do(zldev, ZL_REG_DPLL_MB_SEM, ZL_DPLL_MB_SEM_WR,
+				 ZL_REG_DPLL_MB_MASK, BIT(index));
+}
+EXPORT_SYMBOL_NS_GPL(zl3073x_mb_dpll_write, "ZL3073X");
+
+/**
+ * zl3073x_mb_output_read - read given output configuration to mailbox
+ * @zldev: pointer to device structure
+ * @index: output index
+ * @fields: mask of the mailbox fields to be filled
+ * @mb: output mailbox
+ *
+ * Reads selected configuration of given reference into output mailbox.
+ *
+ * Return: 0 on success, <0 on error
+ */
+int zl3073x_mb_output_read(struct zl3073x_dev *zldev, u8 index, u32 fields,
+			   struct zl3073x_mb_output *mb)
+{
+	int rc;
+
+	rc = zl3073x_mb_cmd_do(zldev, ZL_REG_OUTPUT_MB_SEM, ZL_OUTPUT_MB_SEM_RD,
+			       ZL_REG_OUTPUT_MB_MASK, BIT(index));
+
+	if (!rc && (fields & ZL3073X_MB_OUTPUT_MODE))
+		rc = zl3073x_read_reg(zldev, ZL_REG_OUTPUT_MODE, &mb->mode);
+
+	if (!rc && (fields & ZL3073X_MB_OUTPUT_DIV))
+		rc = zl3073x_read_reg(zldev, ZL_REG_OUTPUT_DIV, &mb->div);
+
+	if (!rc && (fields & ZL3073X_MB_OUTPUT_WIDTH))
+		rc = zl3073x_read_reg(zldev, ZL_REG_OUTPUT_WIDTH, &mb->width);
+
+	if (!rc && (fields & ZL3073X_MB_OUTPUT_ESYNC_PERIOD))
+		rc = zl3073x_read_reg(zldev, ZL_REG_OUTPUT_ESYNC_PERIOD,
+				      &mb->esync_period);
+
+	if (!rc && (fields & ZL3073X_MB_OUTPUT_ESYNC_WIDTH))
+		rc = zl3073x_read_reg(zldev, ZL_REG_OUTPUT_ESYNC_WIDTH,
+				      &mb->esync_width);
+
+	if (!rc && (fields & ZL3073X_MB_OUTPUT_PHASE_COMP))
+		rc = zl3073x_read_reg(zldev, ZL_REG_OUTPUT_PHASE_COMP,
+				      &mb->phase_comp);
+
+	return rc;
+}
+EXPORT_SYMBOL_NS_GPL(zl3073x_mb_output_read, "ZL3073X");
+
+/**
+ * zl3073x_mb_output_write - write given output configuration from mailbox
+ * @zldev: pointer to device structure
+ * @index: output index
+ * @fields: mask of the mailbox fields to be written
+ * @mb: output mailbox
+ *
+ * Writes selected fields from the mailbox into device.
+ *
+ * Return: 0 on success, <0 on error
+ */
+int zl3073x_mb_output_write(struct zl3073x_dev *zldev, u8 index, u32 fields,
+			    const struct zl3073x_mb_output *mb)
+{
+	int rc = 0;
+
+	if (fields & ZL3073X_MB_OUTPUT_MODE)
+		rc = zl3073x_write_reg(zldev, ZL_REG_OUTPUT_MODE, &mb->mode);
+
+	if (!rc && (fields & ZL3073X_MB_OUTPUT_DIV))
+		rc = zl3073x_write_reg(zldev, ZL_REG_OUTPUT_DIV, &mb->div);
+
+	if (!rc && (fields & ZL3073X_MB_OUTPUT_WIDTH))
+		rc = zl3073x_write_reg(zldev, ZL_REG_OUTPUT_WIDTH, &mb->width);
+
+	if (!rc && (fields & ZL3073X_MB_OUTPUT_ESYNC_PERIOD))
+		rc = zl3073x_write_reg(zldev, ZL_REG_OUTPUT_ESYNC_PERIOD,
+				       &mb->esync_period);
+
+	if (!rc && (fields & ZL3073X_MB_OUTPUT_ESYNC_WIDTH))
+		rc = zl3073x_write_reg(zldev, ZL_REG_OUTPUT_ESYNC_WIDTH,
+				       &mb->esync_width);
+
+	if (!rc && (fields & ZL3073X_MB_OUTPUT_PHASE_COMP))
+		rc = zl3073x_write_reg(zldev, ZL_REG_OUTPUT_PHASE_COMP,
+				       &mb->phase_comp);
+	if (rc)
+		return rc;
+
+	return zl3073x_mb_cmd_do(zldev,
+				 ZL_REG_OUTPUT_MB_SEM, ZL_OUTPUT_MB_SEM_WR,
+				 ZL_REG_OUTPUT_MB_MASK, BIT(index));
+}
+EXPORT_SYMBOL_NS_GPL(zl3073x_mb_output_write, "ZL3073X");
+
+/**
+ * zl3073x_mb_ref_read - read given reference configuration to mailbox
+ * @zldev: pointer to device structure
+ * @index: reference index
+ * @fields: mask of the mailbox fields to be filled
+ * @mb: reference mailbox
+ *
+ * Reads selected configuration of given reference into ref mailbox.
+ *
+ * Return: 0 on success, <0 on error
+ */
+int zl3073x_mb_ref_read(struct zl3073x_dev *zldev, u8 index, u32 fields,
+			struct zl3073x_mb_ref *mb)
+{
+	int rc;
+
+	rc = zl3073x_mb_cmd_do(zldev, ZL_REG_REF_MB_SEM, ZL_REF_MB_SEM_RD,
+			       ZL_REG_REF_MB_MASK, BIT(index));
+
+	if (!rc && (fields & ZL3073X_MB_REF_FREQ_BASE))
+		rc = zl3073x_read_reg(zldev, ZL_REG_REF_FREQ_BASE,
+				      &mb->freq_base);
+
+	if (!rc && (fields & ZL3073X_MB_REF_FREQ_MULT))
+		rc = zl3073x_read_reg(zldev, ZL_REG_REF_FREQ_MULT,
+				      &mb->freq_mult);
+
+	if (!rc && (fields & ZL3073X_MB_REF_RATIO_M))
+		rc = zl3073x_read_reg(zldev, ZL_REG_REF_RATIO_M, &mb->ratio_m);
+
+	if (!rc && (fields & ZL3073X_MB_REF_RATIO_N))
+		rc = zl3073x_read_reg(zldev, ZL_REG_REF_RATIO_N, &mb->ratio_n);
+
+	if (!rc && (fields & ZL3073X_MB_REF_CONFIG))
+		rc = zl3073x_read_reg(zldev, ZL_REG_REF_CONFIG, &mb->config);
+
+	if (!rc && (fields & ZL3073X_MB_REF_PHASE_OFFSET_COMP))
+		rc = zl3073x_read_reg(zldev, ZL_REG_REF_PHASE_OFFSET_COMP,
+				      &mb->phase_offset_comp);
+
+	if (!rc && (fields & ZL3073X_MB_REF_SYNC_CTRL))
+		rc = zl3073x_read_reg(zldev, ZL_REG_REF_SYNC_CTRL,
+				      &mb->sync_ctrl);
+
+	if (!rc && (fields & ZL3073X_MB_REF_ESYNC_DIV))
+		rc = zl3073x_read_reg(zldev, ZL_REG_REF_ESYNC_DIV,
+				      &mb->esync_div);
+
+	return rc;
+}
+EXPORT_SYMBOL_NS_GPL(zl3073x_mb_ref_read, "ZL3073X");
+
+/**
+ * zl3073x_mb_ref_write - write given reference configuration from mailbox
+ * @zldev: pointer to device structure
+ * @index: reference index
+ * @fields: mask of the mailbox fields to be written
+ * @mb: reference mailbox
+ *
+ * Writes selected fields from the mailbox into device.
+ *
+ * Return: 0 on success, <0 on error
+ */
+int zl3073x_mb_ref_write(struct zl3073x_dev *zldev, u8 index, u32 fields,
+			 const struct zl3073x_mb_ref *mb)
+{
+	int rc = 0;
+
+	if (fields & ZL3073X_MB_REF_FREQ_BASE)
+		rc = zl3073x_write_reg(zldev, ZL_REG_REF_FREQ_BASE,
+				       &mb->freq_base);
+
+	if (!rc && (fields & ZL3073X_MB_REF_FREQ_MULT))
+		rc = zl3073x_write_reg(zldev, ZL_REG_REF_FREQ_MULT,
+				       &mb->freq_mult);
+
+	if (!rc && (fields & ZL3073X_MB_REF_RATIO_M))
+		rc = zl3073x_write_reg(zldev, ZL_REG_REF_RATIO_M,
+				       &mb->ratio_m);
+
+	if (!rc && (fields & ZL3073X_MB_REF_RATIO_N))
+		rc = zl3073x_write_reg(zldev, ZL_REG_REF_RATIO_N,
+				       &mb->ratio_n);
+
+	if (!rc && (fields & ZL3073X_MB_REF_CONFIG))
+		rc = zl3073x_write_reg(zldev, ZL_REG_REF_CONFIG, &mb->config);
+
+	if (!rc && (fields & ZL3073X_MB_REF_PHASE_OFFSET_COMP))
+		rc = zl3073x_write_reg(zldev, ZL_REG_REF_PHASE_OFFSET_COMP,
+				       &mb->phase_offset_comp);
+
+	if (!rc && (fields & ZL3073X_MB_REF_SYNC_CTRL))
+		rc = zl3073x_write_reg(zldev, ZL_REG_REF_SYNC_CTRL,
+				       &mb->sync_ctrl);
+
+	if (!rc && (fields & ZL3073X_MB_REF_ESYNC_DIV))
+		rc = zl3073x_write_reg(zldev, ZL_REG_REF_ESYNC_DIV,
+				       &mb->esync_div);
+
+	if (rc)
+		return rc;
+
+	return zl3073x_mb_cmd_do(zldev, ZL_REG_REF_MB_SEM, ZL_REF_MB_SEM_WR,
+				 ZL_REG_REF_MB_MASK, BIT(index));
+}
+EXPORT_SYMBOL_NS_GPL(zl3073x_mb_ref_write, "ZL3073X");
+
+/**
+ * zl3073x_mb_synth_read - read given synth configuration to mailbox
+ * @zldev: pointer to device structure
+ * @index: synth index
+ * @fields: mask of the mailbox fields to be filled
+ * @mb: synth mailbox
+ *
+ * Reads selected configuration of given reference into synth mailbox.
+ *
+ * Return: 0 on success, <0 on error
+ */
+int zl3073x_mb_synth_read(struct zl3073x_dev *zldev, u8 index, u32 fields,
+			  struct zl3073x_mb_synth *mb)
+{
+	int rc;
+
+	rc = zl3073x_mb_cmd_do(zldev, ZL_REG_SYNTH_MB_SEM, ZL_SYNTH_MB_SEM_RD,
+			       ZL_REG_SYNTH_MB_MASK, BIT(index));
+
+	if (!rc && (fields & ZL3073X_MB_SYNTH_FREQ_BASE))
+		rc = zl3073x_read_reg(zldev, ZL_REG_SYNTH_FREQ_BASE,
+				      &mb->freq_base);
+
+	if (!rc && (fields & ZL3073X_MB_SYNTH_FREQ_MULT))
+		rc = zl3073x_read_reg(zldev, ZL_REG_SYNTH_FREQ_MULT,
+				      &mb->freq_mult);
+
+	if (!rc && (fields & ZL3073X_MB_SYNTH_FREQ_M))
+		rc = zl3073x_read_reg(zldev, ZL_REG_SYNTH_FREQ_M, &mb->freq_m);
+
+	if (!rc && (fields & ZL3073X_MB_SYNTH_FREQ_N))
+		rc = zl3073x_read_reg(zldev, ZL_REG_SYNTH_FREQ_N, &mb->freq_n);
+
+	return rc;
+}
+EXPORT_SYMBOL_NS_GPL(zl3073x_mb_synth_read, "ZL3073X");
+
+/**
+ * zl3073x_mb_synth_write - write given synth configuration from mailbox
+ * @zldev: pointer to device structure
+ * @index: synth index
+ * @fields: mask of the mailbox fields to be written
+ * @mb: synth mailbox
+ *
+ * Writes selected fields from the mailbox into device.
+ *
+ * Return: 0 on success, <0 on error
+ */
+int zl3073x_mb_synth_write(struct zl3073x_dev *zldev, u8 index, u32 fields,
+			   struct zl3073x_mb_synth *mb)
+{
+	int rc = 0;
+
+	if (fields & ZL3073X_MB_SYNTH_FREQ_BASE)
+		rc = zl3073x_write_reg(zldev, ZL_REG_SYNTH_FREQ_BASE,
+				       &mb->freq_base);
+
+	if (!rc && (fields & ZL3073X_MB_SYNTH_FREQ_MULT))
+		rc = zl3073x_write_reg(zldev, ZL_REG_SYNTH_FREQ_MULT,
+				       &mb->freq_mult);
+
+	if (!rc && (fields & ZL3073X_MB_SYNTH_FREQ_M))
+		rc = zl3073x_write_reg(zldev, ZL_REG_SYNTH_FREQ_M, &mb->freq_m);
+
+	if (!rc && (fields & ZL3073X_MB_SYNTH_FREQ_N))
+		rc = zl3073x_write_reg(zldev, ZL_REG_SYNTH_FREQ_N, &mb->freq_n);
+
+	if (rc)
+		return rc;
+
+	return zl3073x_mb_cmd_do(zldev, ZL_REG_SYNTH_MB_SEM, ZL_SYNTH_MB_SEM_WR,
+				 ZL_REG_SYNTH_MB_MASK, BIT(index));
+}
+EXPORT_SYMBOL_NS_GPL(zl3073x_mb_synth_write, "ZL3073X");
+
 /**
  * zl3073x_devlink_info_get - Devlink device info callback
  * @devlink: devlink structure pointer
drivers/mfd/zl3073x-regs.h +64 -0

68 lines not on this page · raw message

include/linux/mfd/zl3073x.h +141 -0

151 lines not on this page · raw message

Signature · 1 line
2.49.0
#14 lore raw

Re: [PATCH net-next v4 5/8] mfd: zl3073x: Add functions to work with register mailboxes

Quoted 7 lines
drivers/mfd/zl3073x-core.c +7 -0
+static int
+zl3073x_write_reg(struct zl3073x_dev *zldev, unsigned int reg, const void *val)
+{
+	unsigned int len;
+	u8 buf[6];
+	int rc;
+

drivers/mfd/zl3073x-core.c zl3073x_read_reg(struct zl3073x_dev *zldev, unsigned int reg, void *val) · line 189

Quoted 10 lines
drivers/mfd/zl3073x-core.c +10 -0
+	/* Offset of the last item in the indexed register or offset of
+	 * the non-indexed register itself.
+	 */
+	if (ZL_REG_OFFSET(reg) > ZL_REG_MAX_OFFSET(reg)) {
+		dev_err(zldev->dev, "Index of out range for reg 0x%04lx\n",
+			ZL_REG_ADDR(reg));
+		return -EINVAL;
+	}
+
+	len = ZL_REG_SIZE(reg);

I suggested you add helpers for zl3073x_write_reg_u8(), zl3073x_write_reg_u16(), zl3073x_write_reg_32(), and zl3073x_write_reg_48(). The compiler will then do type checking for val, ensure what you pass is actually big enough.

Here you have a void *val. You have no idea how big a value that pointer points to, and the compiler is not helping you.

I suggest you add the individual helpers. If you decided to keep the register meta data, you can validate the correct helper has been called.

Andrew

author maintainer
#15 lore raw

Re: [PATCH net-next v4 5/8] mfd: zl3073x: Add functions to work with register mailboxes

Quoted 23 lines · Andrew Lunn
Quoted 7 lines
drivers/mfd/zl3073x-core.c +7 -0
+static int
+zl3073x_write_reg(struct zl3073x_dev *zldev, unsigned int reg, const void *val)
+{
+	unsigned int len;
+	u8 buf[6];
+	int rc;
+

drivers/mfd/zl3073x-core.c zl3073x_read_reg(struct zl3073x_dev *zldev, unsigned int reg, void *val) · line 189

Quoted 10 lines
drivers/mfd/zl3073x-core.c +10 -0
+	/* Offset of the last item in the indexed register or offset of
+	 * the non-indexed register itself.
+	 */
+	if (ZL_REG_OFFSET(reg) > ZL_REG_MAX_OFFSET(reg)) {
+		dev_err(zldev->dev, "Index of out range for reg 0x%04lx\n",
+			ZL_REG_ADDR(reg));
+		return -EINVAL;
+	}
+
+	len = ZL_REG_SIZE(reg);

I suggested you add helpers for zl3073x_write_reg_u8(), zl3073x_write_reg_u16(), zl3073x_write_reg_32(), and zl3073x_write_reg_48(). The compiler will then do type checking for val, ensure what you pass is actually big enough.

Quoted 2 lines

Here you have a void *val. You have no idea how big a value that pointer points to, and the compiler is not helping you.

During taking 613cbb91e9ce ("media: Add MIPI CCI register access helper functions") approach I found they are using for these functions u64 regardless of register size... Just to accommodate the biggest
possible value. I know about weakness of 'void *' usage but u64 is not
also ideal as the caller is forced to pass always 8 bytes for reading
and forced to reserve 8 bytes for each read value on stack.

Quoted 3 lines

I suggest you add the individual helpers. If you decided to keep the register meta data, you can validate the correct helper has been called.

Yes, this should be easily implemented, will follow this.

Anyway, still don't know what to do with mailboxes (aka multiple atomic register operations). Lee seems to be against the placement of this code in MFD parent driver.

Each sequence has to be protected by some lock and this lock needs to be placed in MFD. Yes the routines for MB access can be for example in DPLL driver but still the locks have to be inside MFD. So they have to be exposed to sub-devices.

Thanks,
Ivan

#16 lore raw

Re: [PATCH net-next v4 5/8] mfd: zl3073x: Add functions to work with register mailboxes

Quoted 4 lines

Each sequence has to be protected by some lock and this lock needs to be placed in MFD. Yes the routines for MB access can be for example in DPLL driver but still the locks have to be inside MFD. So they have to be exposed to sub-devices.

The point of using MFD was gpio? Does the gpio driver need access to the mailboxes? Does any other sub driver other than DPLL need to access mailboxes?

The mutex needs to be shared, but that could be in the common data structure.

Andrew

author maintainer
#17 lore raw

Re: [PATCH net-next v4 5/8] mfd: zl3073x: Add functions to work with register mailboxes

Quoted 8 lines · Andrew Lunn
Quoted 4 lines

Each sequence has to be protected by some lock and this lock needs to be placed in MFD. Yes the routines for MB access can be for example in DPLL driver but still the locks have to be inside MFD. So they have to be exposed to sub-devices.

The point of using MFD was gpio? Does the gpio driver need access to the mailboxes? Does any other sub driver other than DPLL need to access mailboxes?

Yes, PHC (PTP) sub-driver is using mailboxes as well. Gpio as well for some initial configuration.

Quoted 2 lines

The mutex needs to be shared, but that could be in the common data structure.

Do you mean that sub-device would access mutexes placed in zl3073x_dev which is parent (mfd) driver structure?

Ivan

#18 lore raw

Re: [PATCH net-next v4 5/8] mfd: zl3073x: Add functions to work with register mailboxes

Quoted 2 lines

Yes, PHC (PTP) sub-driver is using mailboxes as well. Gpio as well for some initial configuration.

O.K, so the mailbox code needs sharing. The question is, where do you put it.

Quoted 5 lines
Quoted 2 lines

The mutex needs to be shared, but that could be in the common data structure.

Do you mean that sub-device would access mutexes placed in zl3073x_dev which is parent (mfd) driver structure?

Yes.

Andrew

author maintainer
#19 lore raw

Re: [PATCH net-next v4 5/8] mfd: zl3073x: Add functions to work with register mailboxes

Quoted 5 lines · Andrew Lunn
Quoted 2 lines

Yes, PHC (PTP) sub-driver is using mailboxes as well. Gpio as well for some initial configuration.

O.K, so the mailbox code needs sharing. The question is, where do you put it.

This is crucial question... If I put the MB API into DPLL sub-driver then PTP sub-driver will depend on it. Potential GPIO sub-driver as well.

There could be some special library module to provide this for sub-drivers but is this what we want? And if so where to put it?

Quoted 7 lines
Quoted 5 lines
Quoted 2 lines

The mutex needs to be shared, but that could be in the common data structure.

Do you mean that sub-device would access mutexes placed in zl3073x_dev which is parent (mfd) driver structure?

Yes.

So, some helper functions for taking and releasing lock... The v4 approach uses (will use) one mutex per mailbox type but one mutex for MB access is also sufficient.

Ivan

maintainer
#20 lore raw

Re: [PATCH net-next v4 5/8] mfd: zl3073x: Add functions to work with register mailboxes

Quoted 9 lines · Ivan Vecera
Quoted 5 lines · Andrew Lunn
Quoted 2 lines

Yes, PHC (PTP) sub-driver is using mailboxes as well. Gpio as well for some initial configuration.

O.K, so the mailbox code needs sharing. The question is, where do you put it.

Quoted 6 lines

This is crucial question... If I put the MB API into DPLL sub-driver then PTP sub-driver will depend on it. Potential GPIO sub-driver as well.

There could be some special library module to provide this for sub-drivers but is this what we want? And if so where to put it?

MFD is designed to take potentially large, monolithic devices and split them up into smaller, more organised chunks, then Linusify them. This way, area experts (subsystem maintainers) get to concern themselves only with the remit to which they are most specialised / knowledgable. MFD will handle how each of these areas are divided up and create all of the shared resources for them. On the odd occasion it will also provide a _small_ API that the children can use to talk to the parent device.

However .... some devices, like yours, demand an API which is too complex to reside in the MFD subsystem itself. This is not the first time this has happened and I doubt it will be the last. My first recommendation is usually to place all of the comms in drivers/platform, since, at least in my own mind, if a complex API is required, then the device has become almost platform-like. There are lots of examples of H/W comm APIs in there already for you to peruse.

Signature · 1 line
Lee Jones [李琼斯]
author maintainer
#21 lore raw

Re: [PATCH net-next v4 5/8] mfd: zl3073x: Add functions to work with register mailboxes

Quoted 26 lines · Lee Jones
Quoted 9 lines · Ivan Vecera
Quoted 5 lines · Andrew Lunn
Quoted 2 lines

Yes, PHC (PTP) sub-driver is using mailboxes as well. Gpio as well for some initial configuration.

O.K, so the mailbox code needs sharing. The question is, where do you put it.

Quoted 6 lines

This is crucial question... If I put the MB API into DPLL sub-driver then PTP sub-driver will depend on it. Potential GPIO sub-driver as well.

There could be some special library module to provide this for sub-drivers but is this what we want? And if so where to put it?

MFD is designed to take potentially large, monolithic devices and split them up into smaller, more organised chunks, then Linusify them. This way, area experts (subsystem maintainers) get to concern themselves only with the remit to which they are most specialised / knowledgable. MFD will handle how each of these areas are divided up and create all of the shared resources for them. On the odd occasion it will also provide a _small_ API that the children can use to talk to the parent device.

Quoted 7 lines

However .... some devices, like yours, demand an API which is too complex to reside in the MFD subsystem itself. This is not the first time this has happened and I doubt it will be the last. My first recommendation is usually to place all of the comms in drivers/platform, since, at least in my own mind, if a complex API is required, then the device has become almost platform-like. There are lots of examples of H/W comm APIs in there already for you to peruse.

OK, I will do it differently... Will drop MB API at all from MFD and just expose the additional mutex from MFD for multi-op access. Mailboxes will be handled directly by sub-devices.

Short description:
MFD exposes:
zl3073x_{read,write}_u{8,16,32,48}() & zl3073x_poll_u8()
- to read/write/poll registers
- they checks that multiop_lock is taken when caller is accessing registers from Page 10 and above

zl3073x_multiop_{lock,unlock}()
- to protect operation where multiple reads, writes and poll is required to be done atomically

Is this OK for you?

Thanks,
Ivan

maintainer
#22 lore raw

Re: [PATCH net-next v4 5/8] mfd: zl3073x: Add functions to work with register mailboxes

Quoted 48 lines · Ivan Vecera
Quoted 26 lines · Lee Jones
Quoted 9 lines · Ivan Vecera
Quoted 5 lines · Andrew Lunn
Quoted 2 lines

Yes, PHC (PTP) sub-driver is using mailboxes as well. Gpio as well for some initial configuration.

O.K, so the mailbox code needs sharing. The question is, where do you put it.

Quoted 6 lines

This is crucial question... If I put the MB API into DPLL sub-driver then PTP sub-driver will depend on it. Potential GPIO sub-driver as well.

There could be some special library module to provide this for sub-drivers but is this what we want? And if so where to put it?

MFD is designed to take potentially large, monolithic devices and split them up into smaller, more organised chunks, then Linusify them. This way, area experts (subsystem maintainers) get to concern themselves only with the remit to which they are most specialised / knowledgable. MFD will handle how each of these areas are divided up and create all of the shared resources for them. On the odd occasion it will also provide a _small_ API that the children can use to talk to the parent device.

Quoted 7 lines

However .... some devices, like yours, demand an API which is too complex to reside in the MFD subsystem itself. This is not the first time this has happened and I doubt it will be the last. My first recommendation is usually to place all of the comms in drivers/platform, since, at least in my own mind, if a complex API is required, then the device has become almost platform-like. There are lots of examples of H/W comm APIs in there already for you to peruse.

OK, I will do it differently... Will drop MB API at all from MFD and just expose the additional mutex from MFD for multi-op access. Mailboxes will be handled directly by sub-devices.

Short description:
MFD exposes:
zl3073x_{read,write}_u{8,16,32,48}() & zl3073x_poll_u8()
- to read/write/poll registers
- they checks that multiop_lock is taken when caller is accessing registers from Page 10 and above

Quoted 3 lines

zl3073x_multiop_{lock,unlock}()
- to protect operation where multiple reads, writes and poll is required to be done atomically

Looks sensible. If this is aligned with the discussions that have been taking place between you and Andrew. Let's see the code before we make any binding agreements. =:)

Signature · 1 line
Lee Jones [李琼斯]
author maintainer
#23 lore raw

Re: [PATCH net-next v4 5/8] mfd: zl3073x: Add functions to work with register mailboxes

Quoted 50 lines · Lee Jones
Quoted 48 lines · Ivan Vecera
Quoted 26 lines · Lee Jones
Quoted 9 lines · Ivan Vecera
Quoted 5 lines · Andrew Lunn
Quoted 2 lines

Yes, PHC (PTP) sub-driver is using mailboxes as well. Gpio as well for some initial configuration.

O.K, so the mailbox code needs sharing. The question is, where do you put it.

Quoted 6 lines

This is crucial question... If I put the MB API into DPLL sub-driver then PTP sub-driver will depend on it. Potential GPIO sub-driver as well.

There could be some special library module to provide this for sub-drivers but is this what we want? And if so where to put it?

MFD is designed to take potentially large, monolithic devices and split them up into smaller, more organised chunks, then Linusify them. This way, area experts (subsystem maintainers) get to concern themselves only with the remit to which they are most specialised / knowledgable. MFD will handle how each of these areas are divided up and create all of the shared resources for them. On the odd occasion it will also provide a _small_ API that the children can use to talk to the parent device.

Quoted 7 lines

However .... some devices, like yours, demand an API which is too complex to reside in the MFD subsystem itself. This is not the first time this has happened and I doubt it will be the last. My first recommendation is usually to place all of the comms in drivers/platform, since, at least in my own mind, if a complex API is required, then the device has become almost platform-like. There are lots of examples of H/W comm APIs in there already for you to peruse.

OK, I will do it differently... Will drop MB API at all from MFD and just expose the additional mutex from MFD for multi-op access. Mailboxes will be handled directly by sub-devices.

Short description:
MFD exposes:
zl3073x_{read,write}_u{8,16,32,48}() & zl3073x_poll_u8()
- to read/write/poll registers
- they checks that multiop_lock is taken when caller is accessing registers from Page 10 and above

Quoted 3 lines
Quoted 3 lines

zl3073x_multiop_{lock,unlock}()
- to protect operation where multiple reads, writes and poll is required to be done atomically

Or maybe just define zl3073x_dev.multiop_lock and allow callers to use

guard(mutex)(zldev->multiop_lock)
--or--
scoped_guard(mutex)(zldev_multiop_lock) {
...
}

Quoted 4 lines

Looks sensible. If this is aligned with the discussions that have been taking place between you and Andrew. Let's see the code before we make any binding agreements. =:)

#24 lore raw

Re: [PATCH net-next v4 5/8] mfd: zl3073x: Add functions to work with register mailboxes

In reply to Ivan Vecera
Quoted 6 lines

During taking 613cbb91e9ce ("media: Add MIPI CCI register access helper functions") approach I found they are using for these functions u64 regardless of register size... Just to accommodate the biggest possible value. I know about weakness of 'void *' usage but u64 is not also ideal as the caller is forced to pass always 8 bytes for reading and forced to reserve 8 bytes for each read value on stack.

In this device, how are the u48s used? Are they actually u48s, or are they just u8[6], for example a MAC address? The network stack has lots of functions like:

eth_hw_addr_set(struct net_device *dev, const u8 *addr)

and it is assumed that *addr is ETH_ALEN bytes in length. There is no direct typing checking for this by the compiler, but the compiler is getting smarter at checking for buffer overruns over function calls.

Andrew

author maintainer
#25 lore raw

Re: [PATCH net-next v4 5/8] mfd: zl3073x: Add functions to work with register mailboxes

Quoted 7 lines · Andrew Lunn
Quoted 6 lines

During taking 613cbb91e9ce ("media: Add MIPI CCI register access helper functions") approach I found they are using for these functions u64 regardless of register size... Just to accommodate the biggest possible value. I know about weakness of 'void *' usage but u64 is not also ideal as the caller is forced to pass always 8 bytes for reading and forced to reserve 8 bytes for each read value on stack.

Quoted 5 lines

In this device, how are the u48s used? Are they actually u48s, or are they just u8[6], for example a MAC address? The network stack has lots of functions like:

eth_hw_addr_set(struct net_device *dev, const u8 *addr)

u48 registers always represent 48bit integer... they read from device using bulk read as big-endian 48bit int. The same is valid also for u16 and u32.

Ivan

#26 lore raw

Re: [PATCH net-next v4 5/8] mfd: zl3073x: Add functions to work with register mailboxes

Quoted 14 lines · Ivan Vecera
Quoted 11 lines · Andrew Lunn
Quoted 6 lines

During taking 613cbb91e9ce ("media: Add MIPI CCI register access helper functions") approach I found they are using for these functions u64 regardless of register size... Just to accommodate the biggest possible value. I know about weakness of 'void *' usage but u64 is not also ideal as the caller is forced to pass always 8 bytes for reading and forced to reserve 8 bytes for each read value on stack.

In this device, how are the u48s used? Are they actually u48s, or are they just u8[6], for example a MAC address? The network stack has lots of functions like:

Quoted 5 lines
Quoted 1 line

eth_hw_addr_set(struct net_device *dev, const u8 *addr)

u48 registers always represent 48bit integer... they read from device using bulk read as big-endian 48bit int. The same is valid also for u16 and u32.

Then a u64 makes sense, plus on write to hardware a check the upper bits are 0. These u48s are going to be stored in a u64 anyway, since C does not have a u48 type.

But all the other types do exist in C, so you should use them and have type checking.

Andrew

author maintainer
#27 lore raw

Re: [PATCH net-next v4 5/8] mfd: zl3073x: Add functions to work with register mailboxes

Quoted 17 lines · Andrew Lunn
Quoted 16 lines · Ivan Vecera
Quoted 12 lines · Andrew Lunn
Quoted 6 lines

During taking 613cbb91e9ce ("media: Add MIPI CCI register access helper functions") approach I found they are using for these functions u64 regardless of register size... Just to accommodate the biggest possible value. I know about weakness of 'void *' usage but u64 is not also ideal as the caller is forced to pass always 8 bytes for reading and forced to reserve 8 bytes for each read value on stack.

In this device, how are the u48s used? Are they actually u48s, or are they just u8[6], for example a MAC address? The network stack has lots of functions like:

eth_hw_addr_set(struct net_device *dev, const u8 *addr)

Quoted 7 lines
Quoted 3 lines

u48 registers always represent 48bit integer... they read from device using bulk read as big-endian 48bit int. The same is valid also for u16 and u32.

Then a u64 makes sense, plus on write to hardware a check the upper bits are 0. These u48s are going to be stored in a u64 anyway, since C does not have a u48 type.

Just note that some of 48bit registers uses signed values so the check should be:

x is in <S48_MIN, U48_MAX>

this could be done using bit operations:

(!(GENMASK_ULL(63, 49) & ((u64)(x) + BIT_ULL(47))))

Ivan

author maintainer
#28 lore raw

PATCH v4 6/8 mfd: zl3073x: Fetch invariants during probe

In reply to Ivan Vecera

Several configuration parameters will remain constant at runtime, so we can load them during probe to avoid excessive reads from the hardware.

These parameters will be frequently accessed by the DPLL sub-device driver (in follow-up series), and later by the PHC/PTP sub-device driver.

Read the following parameters from the device during probe and store them for later use:

* frequencies of the synthesizers and their associated DPLL channels
* enablement and type (single-ended or differential) of input pins
* associated synthesizers, signal format, and enablement status of outputs

---
v3->v4:
* adjusted for new mailbox API
v2->v3:
* dropped usage of macros for generating helper functions v1->v2:
* fixed and added inline documentation

---
 drivers/mfd/zl3073x-core.c  | 200 ++++++++++++++++++++++++++++++++++++
 drivers/mfd/zl3073x-regs.h  |  17 +++
 include/linux/mfd/zl3073x.h | 144 ++++++++++++++++++++++++++
 3 files changed, 361 insertions(+)
drivers/mfd/zl3073x-core.c +200 -0
index 4f7c915f17980..b6058de04f954 100644
@@ -6,6 +6,7 @@
 #include <linux/dev_printk.h>
 #include <linux/device.h>
 #include <linux/export.h>
+#include <linux/math64.h>
 #include <linux/mfd/zl3073x.h>
 #include <linux/module.h>
 #include <linux/netlink.h>
@@ -715,6 +716,200 @@ static void zl3073x_devlink_unregister(void *ptr)
 	devlink_unregister(ptr);
 }
 
+/**
+ * zl3073x_input_state_fetch - get input state
+ * @zldev: pointer to zl3073x_dev structure
+ * @index: input pin index to fetch state for
+ *
+ * Function fetches information for the given input reference that are
+ * invariant and stores them for later use.
+ *
+ * Return: 0 on success, <0 on error
+ */
+static int
+zl3073x_input_state_fetch(struct zl3073x_dev *zldev, u8 index)
+{
+	struct zl3073x_input *input;
+	struct zl3073x_mb_ref ref;
+	int rc;
+
+	input = &zldev->input[index];
+
+	/* If the input is differential then the configuration for N-pin
+	 * reference is ignored and P-pin config is used for both.
+	 */
+	if (zl3073x_is_n_pin(index) &&
+	    zl3073x_input_is_diff(zldev, index - 1)) {
+		input->enabled = zl3073x_input_is_enabled(zldev, index - 1);
+		input->diff = true;
+
+		return 0;
+	}
+
+	/* Read reference configuration into mailbox */
+	rc = zl3073x_mb_ref_read(zldev, index, ZL3073X_MB_REF_CONFIG, &ref);
+	if (rc)
+		return rc;
+
+	input->enabled = FIELD_GET(ZL_REF_CONFIG_ENABLE, ref.config);
+	input->diff = FIELD_GET(ZL_REF_CONFIG_DIFF_EN, ref.config);
+
+	dev_dbg(zldev->dev, "INPUT%u is %s and configured as %s\n", index,
+		input->enabled ? "enabled" : "disabled",
+		input->diff ? "differential" : "single-ended");
+
+	return rc;
+}
+
+/**
+ * zl3073x_output_state_fetch - get output state
+ * @zldev: pointer to zl3073x_dev structure
+ * @index: output index to fetch state for
+ *
+ * Function fetches information for the given output (not output pin)
+ * that are invariant and stores them for later use.
+ *
+ * Return: 0 on success, <0 on error
+ */
+static int
+zl3073x_output_state_fetch(struct zl3073x_dev *zldev, u8 index)
+{
+	struct zl3073x_output *output;
+	struct zl3073x_mb_output mb;
+	u8 output_ctrl;
+	int rc;
+
+	output = &zldev->output[index];
+
+	/* Read output control register */
+	rc = zl3073x_read_reg(zldev, ZL_REG_OUTPUT_CTRL(index), &output_ctrl);
+	if (rc)
+		return rc;
+
+	/* Store info about output enablement and synthesizer the output
+	 * is connected to.
+	 */
+	output->enabled = FIELD_GET(ZL_OUTPUT_CTRL_EN, output_ctrl);
+	output->synth = FIELD_GET(ZL_OUTPUT_CTRL_SYNTH_SEL, output_ctrl);
+
+	dev_dbg(zldev->dev, "OUTPUT%u is %s, connected to SYNTH%u\n",
+		index, output->enabled ? "enabled" : "disabled", output->synth);
+
+	/* Read output config mailbox */
+	rc = zl3073x_mb_output_read(zldev, index, ZL3073X_MB_OUTPUT_MODE, &mb);
+	if (rc)
+		return rc;
+
+	/* Extract and store output signal format */
+	output->signal_format = FIELD_GET(ZL_OUTPUT_MODE_SIGNAL_FORMAT,
+					  mb.mode);
+
+	dev_dbg(zldev->dev, "OUTPUT%u has signal format 0x%02x\n", index,
+		output->signal_format);
+
+	return rc;
+}
+
+/**
+ * zl3073x_synth_state_fetch - get synth state
+ * @zldev: pointer to zl3073x_dev structure
+ * @index: synth index to fetch state for
+ *
+ * Function fetches information for the given synthesizer that are
+ * invariant and stores them for later use.
+ *
+ * Return: 0 on success, <0 on error
+ */
+static int
+zl3073x_synth_state_fetch(struct zl3073x_dev *zldev, u8 index)
+{
+	struct zl3073x_mb_synth mb;
+	u8 synth_ctrl;
+	int rc;
+
+	/* Read synth control register */
+	rc = zl3073x_read_reg(zldev, ZL_REG_SYNTH_CTRL(index), &synth_ctrl);
+	if (rc)
+		return rc;
+
+	/* Extract and store DPLL channel the synth is driven by */
+	zldev->synth[index].dpll = FIELD_GET(ZL_SYNTH_CTRL_DPLL_SEL,
+					     synth_ctrl);
+
+	dev_dbg(zldev->dev, "SYNTH%u is connected to DPLL%u\n", index,
+		zldev->synth[index].dpll);
+
+	/* Read synth configuration into mailbox */
+	rc = zl3073x_mb_synth_read(zldev, index,
+				   ZL3073X_MB_SYNTH_FREQ_BASE	|
+				   ZL3073X_MB_SYNTH_FREQ_MULT	|
+				   ZL3073X_MB_SYNTH_FREQ_M	|
+				   ZL3073X_MB_SYNTH_FREQ_N, &mb);
+	if (rc)
+		return rc;
+
+	/* The output frequency is determined by the following formula:
+	 * base * multiplier * numerator / denominator
+	 */
+
+	/* Check denominator for zero to avoid div by 0 */
+	if (!mb.freq_n) {
+		dev_err(zldev->dev,
+			"Zero divisor for SYNTH%u retrieved from device\n",
+			index);
+		return -EINVAL;
+	}
+
+	/* Compute and store synth frequency */
+	zldev->synth[index].freq = mul_u64_u32_div(mul_u32_u32(mb.freq_base,
+							       mb.freq_mult),
+						   mb.freq_m, mb.freq_n);
+
+	dev_dbg(zldev->dev, "SYNTH%u frequency: %llu Hz\n", index,
+		zldev->synth[index].freq);
+
+	return rc;
+}
+
+static int
+zl3073x_dev_state_fetch(struct zl3073x_dev *zldev)
+{
+	int rc;
+	u8 i;
+
+	for (i = 0; i < ZL3073X_NUM_INPUTS; i++) {
+		rc = zl3073x_input_state_fetch(zldev, i);
+		if (rc) {
+			dev_err(zldev->dev,
+				"Failed to fetch input state: %pe\n",
+				ERR_PTR(rc));
+			return rc;
+		}
+	}
+
+	for (i = 0; i < ZL3073X_NUM_SYNTHS; i++) {
+		rc = zl3073x_synth_state_fetch(zldev, i);
+		if (rc) {
+			dev_err(zldev->dev,
+				"Failed to fetch synth state: %pe\n",
+				ERR_PTR(rc));
+			return rc;
+		}
+	}
+
+	for (i = 0; i < ZL3073X_NUM_OUTPUTS; i++) {
+		rc = zl3073x_output_state_fetch(zldev, i);
+		if (rc) {
+			dev_err(zldev->dev,
+				"Failed to fetch output state: %pe\n",
+				ERR_PTR(rc));
+			return rc;
+		}
+	}
+
+	return rc;
+}
+
 /**
  * zl3073x_dev_probe - initialize zl3073x device
  * @zldev: pointer to zl3073x device
@@ -769,6 +964,11 @@ int zl3073x_dev_probe(struct zl3073x_dev *zldev,
 		FIELD_GET(GENMASK(15, 8), cfg_ver),
 		FIELD_GET(GENMASK(7, 0), cfg_ver));
 
+	/* Fetch device state */
+	rc = zl3073x_dev_state_fetch(zldev);
+	if (rc)
+		return rc;
+
 	/* Register the device as devlink device */
 	devlink = priv_to_devlink(zldev);
 	devlink_register(devlink);
drivers/mfd/zl3073x-regs.h +17 -0
index a19f04c813cc6..daac6703d9d1c 100644
@@ -71,6 +71,23 @@
 #define ZL_REG_FW_VER				ZL_REG(0, 0x05, 2)
 #define ZL_REG_CUSTOM_CONFIG_VER		ZL_REG(0, 0x07, 4)
 
+/***********************************
+ * Register Page 9, Synth and Output
+ ***********************************/
+
+#define ZL_REG_SYNTH_CTRL(_idx)						\
+	ZL_REG_IDX(_idx, 9, 0x00, 1, ZL3073X_NUM_SYNTHS, 1)
+#define ZL_SYNTH_CTRL_EN			BIT(0)
+#define ZL_SYNTH_CTRL_DPLL_SEL			GENMASK(6, 4)
+
+#define ZL_REG_OUTPUT_CTRL(_idx)					\
+	ZL_REG_IDX(_idx, 9, 0x28, 1, ZL3073X_NUM_OUTPUTS, 1)
+#define ZL_OUTPUT_CTRL_EN			BIT(0)
+#define ZL_OUTPUT_CTRL_STOP			BIT(1)
+#define ZL_OUTPUT_CTRL_STOP_HIGH		BIT(2)
+#define ZL_OUTPUT_CTRL_STOP_HZ			BIT(3)
+#define ZL_OUTPUT_CTRL_SYNTH_SEL		GENMASK(6, 4)
+
 /*******************************
  * Register Page 10, Ref Mailbox
  *******************************/
include/linux/mfd/zl3073x.h +144 -0

162 lines not on this page · raw message

Signature · 1 line
2.49.0
author maintainer
#29 lore raw

PATCH v4 7/8 mfd: zl3073x: Add clock_id field

In reply to Ivan Vecera

Add .clock_id to zl3073x_dev structure that will be used by later commits introducing DPLL driver. The clock ID is required for DPLL device registration.
To generate this ID, use chip ID read during device initialization. In case where multiple zl3073x based chips are present, the chip ID is shifted and lower bits are filled by an unique value - using the I2C device address for I2C connections and the chip-select value for SPI connections.

---
 drivers/mfd/zl3073x-core.c  | 6 +++++-
 drivers/mfd/zl3073x-i2c.c   | 4 +++-
 drivers/mfd/zl3073x-spi.c   | 4 +++-
 drivers/mfd/zl3073x.h       | 2 +-
 include/linux/mfd/zl3073x.h | 2 ++
 5 files changed, 14 insertions(+), 4 deletions(-)
drivers/mfd/zl3073x-core.c +5 -1
index b6058de04f954..d0022dfb0236c 100644
@@ -914,13 +914,14 @@ zl3073x_dev_state_fetch(struct zl3073x_dev *zldev)
  * zl3073x_dev_probe - initialize zl3073x device
  * @zldev: pointer to zl3073x device
  * @chip_info: chip info based on compatible
+ * @dev_id: device ID to be used as part of clock ID
  *
  * Common initialization of zl3073x device structure.
  *
  * Returns: 0 on success, <0 on error
  */
 int zl3073x_dev_probe(struct zl3073x_dev *zldev,
-		      const struct zl3073x_chip_info *chip_info)
+		      const struct zl3073x_chip_info *chip_info, u8 dev_id)
 {
 	u16 id, revision, fw_ver;
 	struct devlink *devlink;
@@ -964,6 +965,9 @@ int zl3073x_dev_probe(struct zl3073x_dev *zldev,
 		FIELD_GET(GENMASK(15, 8), cfg_ver),
 		FIELD_GET(GENMASK(7, 0), cfg_ver));
 
+	/* Use chip ID and given dev ID as clock ID */
+	zldev->clock_id = ((u64)id << 8) | dev_id;
+
 	/* Fetch device state */
 	rc = zl3073x_dev_state_fetch(zldev);
 	if (rc)
drivers/mfd/zl3073x-i2c.c +3 -1
index da8bbd702d76c..e00277f87de92 100644
@@ -27,7 +27,9 @@ static int zl3073x_i2c_probe(struct i2c_client *client)
 		return PTR_ERR(zldev->regmap);
 	}
 
-	return zl3073x_dev_probe(zldev, i2c_get_match_data(client));
+	/* Initialize device and use I2C address as dev ID */
+	return zl3073x_dev_probe(zldev, i2c_get_match_data(client),
+				 client->addr);
 }
 
 static const struct i2c_device_id zl3073x_i2c_id[] = {
drivers/mfd/zl3073x-spi.c +3 -1
index 962b6845c0325..368001ae19db9 100644
@@ -27,7 +27,9 @@ static int zl3073x_spi_probe(struct spi_device *spi)
 		return PTR_ERR(zldev->regmap);
 	}
 
-	return zl3073x_dev_probe(zldev, spi_get_device_match_data(spi));
+	/* Initialize device and use SPI chip select value as dev ID */
+	return zl3073x_dev_probe(zldev, spi_get_device_match_data(spi),
+				 spi_get_chipselect(spi, 0));
 }
 
 static const struct spi_device_id zl3073x_spi_id[] = {
drivers/mfd/zl3073x.h +1 -1
index 3a2fea61cf579..abd1ab9a56ded 100644
@@ -26,6 +26,6 @@ extern const struct zl3073x_chip_info zl3073x_chip_info[];
 struct zl3073x_dev *zl3073x_devm_alloc(struct device *dev);
 void zl3073x_dev_init_regmap_config(struct regmap_config *regmap_cfg);
 int zl3073x_dev_probe(struct zl3073x_dev *zldev,
-		      const struct zl3073x_chip_info *chip_info);
+		      const struct zl3073x_chip_info *chip_info, u8 dev_id);
 
 #endif /* __ZL3073X_CORE_H */
include/linux/mfd/zl3073x.h +2 -0
index 43171246093f2..ca6785ff9ecc9 100644
@@ -51,6 +51,7 @@ struct zl3073x_synth {
  * struct zl3073x_dev - zl3073x device
  * @dev: pointer to device
  * @regmap: regmap to access device registers
+ * @clock_id: clock id of the device
  * @input: array of inputs' invariants
  * @output: array of outputs' invariants
  * @synth: array of synthesizers' invariants
@@ -58,6 +59,7 @@ struct zl3073x_synth {
 struct zl3073x_dev {
 	struct device		*dev;
 	struct regmap		*regmap;
+	u64			clock_id;
 
 	/* Invariants */
 	struct zl3073x_input	input[ZL3073X_NUM_INPUTS];
Signature · 1 line
2.49.0
author maintainer
#30 lore raw

PATCH v4 8/8 mfd: zl3073x: Register DPLL sub-device during init

In reply to Ivan Vecera

Register DPLL sub-devices to expose the functionality provided by ZL3073x chip family. Each sub-device represents one of the available DPLL channels.

---
v3->v4:
* use static mfd cells

---
 drivers/mfd/zl3073x-core.c | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
drivers/mfd/zl3073x-core.c +19 -0
index d0022dfb0236c..a8971b86db121 100644
@@ -7,6 +7,7 @@
 #include <linux/device.h>
 #include <linux/export.h>
 #include <linux/math64.h>
+#include <linux/mfd/core.h>
 #include <linux/mfd/zl3073x.h>
 #include <linux/module.h>
 #include <linux/netlink.h>
@@ -910,6 +911,14 @@ zl3073x_dev_state_fetch(struct zl3073x_dev *zldev)
 	return rc;
 }
 
+static const struct mfd_cell zl3073x_dpll_cells[] = {
+	MFD_CELL_BASIC("zl3073x-dpll", NULL, NULL, 0, 0),
+	MFD_CELL_BASIC("zl3073x-dpll", NULL, NULL, 0, 1),
+	MFD_CELL_BASIC("zl3073x-dpll", NULL, NULL, 0, 2),
+	MFD_CELL_BASIC("zl3073x-dpll", NULL, NULL, 0, 3),
+	MFD_CELL_BASIC("zl3073x-dpll", NULL, NULL, 0, 4),
+};
+
 /**
  * zl3073x_dev_probe - initialize zl3073x device
  * @zldev: pointer to zl3073x device
@@ -973,6 +982,16 @@ int zl3073x_dev_probe(struct zl3073x_dev *zldev,
 	if (rc)
 		return rc;
 
+	/* Add DPLL sub-device cell for each DPLL channel */
+	rc = devm_mfd_add_devices(zldev->dev, PLATFORM_DEVID_AUTO,
+				  zl3073x_dpll_cells, chip_info->num_channels,
+				  NULL, 0, NULL);
+	if (rc) {
+		dev_err_probe(zldev->dev, rc,
+			      "Failed to add DPLL sub-device\n");
+		return rc;
+	}
+
 	/* Register the device as devlink device */
 	devlink = priv_to_devlink(zldev);
 	devlink_register(devlink);
Signature · 1 line
2.49.0
maintainer
#31 lore raw
In reply to Ivan Vecera
Quoted 12 lines · Ivan Vecera

Add support for Microchip Azurite DPLL/PTP/SyncE chip family that provides DPLL and PTP functionality. This series bring first part that adds the common MFD driver that provides an access to the bus that can be either I2C or SPI.

The next part of the series is bringing the DPLL driver that will covers DPLL functionality. Another series will bring PTP driver and flashing capability via devlink in the MFD driver will follow soon.

Testing was done by myself and by Prathosh Satish on Microchip EDS2 development board with ZL30732 DPLL chip connected over I2C bus.

Quoted 7 lines

Patch breakdown
===============
Patch 1 - Common DT schema for DPLL device and pin Patch 2 - DT bindings for microchip,zl3073* devices Patch 3 - Basic support for I2C, SPI and regmap configuration Patch 4 - Devlink device registration and info Patch 5 - Helpers for reading and writing register mailboxes

Whoops! I just this second replied to v3.

This needs moving out to somewhere more appropriate.

Use MFD to allocate and split the resources, then the sub-devices can do the technical and heavy API stuff.

Quoted 3 lines

Patch 6 - Fetch invariant register values used by DPLL/PTP sub-drivers Patch 7 - Clock ID generation for DPLL driver
Patch 8 - Register/create DPLL device cells

Signature · 1 line
Lee Jones [李琼斯]
author maintainer
#32 lore raw
Quoted 22 lines · Lee Jones
Quoted 12 lines · Ivan Vecera

Add support for Microchip Azurite DPLL/PTP/SyncE chip family that provides DPLL and PTP functionality. This series bring first part that adds the common MFD driver that provides an access to the bus that can be either I2C or SPI.

The next part of the series is bringing the DPLL driver that will covers DPLL functionality. Another series will bring PTP driver and flashing capability via devlink in the MFD driver will follow soon.

Testing was done by myself and by Prathosh Satish on Microchip EDS2 development board with ZL30732 DPLL chip connected over I2C bus.

Quoted 7 lines

Patch breakdown
===============
Patch 1 - Common DT schema for DPLL device and pin Patch 2 - DT bindings for microchip,zl3073* devices Patch 3 - Basic support for I2C, SPI and regmap configuration Patch 4 - Devlink device registration and info Patch 5 - Helpers for reading and writing register mailboxes

Quoted 6 lines

Whoops! I just this second replied to v3.

This needs moving out to somewhere more appropriate.

Use MFD to allocate and split the resources, then the sub-devices can do the technical and heavy API stuff.

They cannot because the bus is shared and MFD parent device acts as bus arbitrator. It has to ensure that sub-devices access the registers safely.

Mailbox could be confusing for somebody but it does not have anything common with HW mailboxes. In this context the mailbox is just a sequence of register reads and writes in certain order and this sequence has to be done atomically (I tried to describe this in my previous replies).

I have followed Andrew's recommendation to hide these special sequences and provide sub-devices some simple API to use them without special locking needs.

Thanks,
Ivan