Add Microchip ZL3073x support (part 1)
Subsystems (7)
Ivan Vecera
maintainerv11 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 core functionality and basic DPLL support.
The next part of the series will bring additional DPLL functionality like eSync support, phase offset and frequency offset reporting and phase adjustments.
Testing was done by myself and by Prathosh Satish on Microchip EDS2 development board with ZL30732 DPLL chip connected over I2C bus.
---
Changelog:
v11:
Fixed uninitialized 'rc' in error-path in patch 9
v10:
Usage of str_enabled_disabled() where possible.
v9:
After discussion with Jakub Kicinski we agreed that it would be better to implement whole functionality in a single driver without touching MFD sub-system. Besides touching multiple sub-systems by single device there are also some technical issues that are easier resolvable in a single driver. Additionally the firmware flashing functionality would bring more than 1000 lines of code with previous approach to the MFD driver - it is not something the MFD maintainers would like to see.
Ivan Vecera (14):
dt-bindings: dpll: Add DPLL device and pin
dt-bindings: dpll: Add support for Microchip Azurite chip family
dpll: Add basic Microchip ZL3073x support
dpll: zl3073x: Add support for devlink device info
dpll: zl3073x: Protect operations requiring multiple register accesses
dpll: zl3073x: Fetch invariants during probe
dpll: zl3073x: Add clock_id field
dpll: zl3073x: Read DPLL types and pin properties from system firmware
dpll: zl3073x: Register DPLL devices and pins
dpll: zl3073x: Implement input pin selection in manual mode
dpll: zl3073x: Add support to get/set priority on input pins
dpll: zl3073x: Implement input pin state setting in automatic mode
dpll: zl3073x: Add support to get/set frequency on input pins
dpll: zl3073x: Add support to get/set frequency on output pins
.../devicetree/bindings/dpll/dpll-device.yaml | 76 + .../devicetree/bindings/dpll/dpll-pin.yaml | 45 + .../bindings/dpll/microchip,zl30731.yaml | 115 ++ Documentation/networking/devlink/index.rst | 1 + Documentation/networking/devlink/zl3073x.rst | 37 + MAINTAINERS | 10 + drivers/Kconfig | 4 +- drivers/dpll/Kconfig | 6 + drivers/dpll/Makefile | 2 + drivers/dpll/zl3073x/Kconfig | 36 + drivers/dpll/zl3073x/Makefile | 10 + drivers/dpll/zl3073x/core.c | 968 +++++++++++ drivers/dpll/zl3073x/core.h | 371 ++++ drivers/dpll/zl3073x/dpll.c | 1494 +++++++++++++++++ drivers/dpll/zl3073x/dpll.h | 42 + drivers/dpll/zl3073x/i2c.c | 95 ++ drivers/dpll/zl3073x/prop.c | 358 ++++ drivers/dpll/zl3073x/prop.h | 34 + drivers/dpll/zl3073x/regs.h | 206 +++ drivers/dpll/zl3073x/spi.c | 95 ++ 20 files changed, 4003 insertions(+), 2 deletions(-) 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 Documentation/networking/devlink/zl3073x.rst create mode 100644 drivers/dpll/zl3073x/Kconfig create mode 100644 drivers/dpll/zl3073x/Makefile create mode 100644 drivers/dpll/zl3073x/core.c create mode 100644 drivers/dpll/zl3073x/core.h create mode 100644 drivers/dpll/zl3073x/dpll.c create mode 100644 drivers/dpll/zl3073x/dpll.h create mode 100644 drivers/dpll/zl3073x/i2c.c create mode 100644 drivers/dpll/zl3073x/prop.c create mode 100644 drivers/dpll/zl3073x/prop.h create mode 100644 drivers/dpll/zl3073x/regs.h create mode 100644 drivers/dpll/zl3073x/spi.c
Signature · 1 line
2.49.0
Ivan Vecera
maintainerPATCH v11 1/14 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
---
v8:
* no change
--- .../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
@@ -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
@@ -7324,6 +7324,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
Ivan Vecera
maintainerPATCH v11 2/14 dt-bindings: dpll: Add support for Microchip Azurite chip family
In reply to Ivan VeceraAdd 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.
---
v9:
* no change
--- .../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
@@ -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
Ivan Vecera
maintainerPATCH v11 3/14 dpll: Add basic Microchip ZL3073x support
In reply to Ivan VeceraMicrochip Azurite ZL3073x represents chip family providing DPLL and optionally PHC (PTP) functionality. The chips can be connected be connected over I2C or SPI bus.
They have 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.
Add basic functionality to access device registers and probe functionality for both I2C and SPI cases.
--- MAINTAINERS | 8 + drivers/Kconfig | 4 +- drivers/dpll/Kconfig | 6 + drivers/dpll/Makefile | 2 + drivers/dpll/zl3073x/Kconfig | 34 +++ drivers/dpll/zl3073x/Makefile | 10 + drivers/dpll/zl3073x/core.c | 452 ++++++++++++++++++++++++++++++++++ drivers/dpll/zl3073x/core.h | 56 +++++ drivers/dpll/zl3073x/i2c.c | 93 +++++++ drivers/dpll/zl3073x/regs.h | 75 ++++++ drivers/dpll/zl3073x/spi.c | 93 +++++++ 11 files changed, 831 insertions(+), 2 deletions(-) create mode 100644 drivers/dpll/zl3073x/Kconfig create mode 100644 drivers/dpll/zl3073x/Makefile create mode 100644 drivers/dpll/zl3073x/core.c create mode 100644 drivers/dpll/zl3073x/core.h create mode 100644 drivers/dpll/zl3073x/i2c.c create mode 100644 drivers/dpll/zl3073x/regs.h create mode 100644 drivers/dpll/zl3073x/spi.c
MAINTAINERS +8 -0
@@ -16465,6 +16465,14 @@ 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,zl30731.yaml +F: drivers/dpll/zl3073x/ + MICROSEMI MIPS SOCS M: Alexandre Belloni <[email protected]> M: [email protected]
drivers/Kconfig +2 -2
@@ -77,6 +77,8 @@ source "drivers/pps/Kconfig" source "drivers/ptp/Kconfig" +source "drivers/dpll/Kconfig" + source "drivers/pinctrl/Kconfig" source "drivers/gpio/Kconfig"
@@ -245,6 +247,4 @@ source "drivers/hte/Kconfig" source "drivers/cdx/Kconfig" -source "drivers/dpll/Kconfig" - endmenu
drivers/dpll/Kconfig +6 -0
@@ -3,5 +3,11 @@ # Generic DPLL drivers configuration # +menu "DPLL device support" + config DPLL bool + +source "drivers/dpll/zl3073x/Kconfig" + +endmenu
drivers/dpll/Makefile +2 -0
@@ -7,3 +7,5 @@ obj-$(CONFIG_DPLL) += dpll.o dpll-y += dpll_core.o dpll-y += dpll_netlink.o dpll-y += dpll_nl.o + +obj-$(CONFIG_ZL3073X) += zl3073x/
drivers/dpll/zl3073x/Kconfig new file +34 -0
@@ -0,0 +1,34 @@ +# SPDX-License-Identifier: GPL-2.0-only + +config ZL3073X + tristate "Microchip Azurite DPLL/PTP/SyncE devices" + select DPLL + help + This driver supports Microchip Azurite DPLL/PTP/SyncE devices. + + To compile this driver as a module, choose M here. The module + will be called zl3073x. + +config ZL3073X_I2C + tristate "I2C bus implementation for Microchip Azurite devices" + depends on I2C && ZL3073X + select REGMAP_I2C + default m + help + This is I2C bus implementation for Microchip Azurite DPLL/PTP/SyncE + devices. + + To compile this driver as a module, choose M here: the module will + be called zl3073x_i2c. + +config ZL3073X_SPI + tristate "SPI bus implementation for Microchip Azurite devices" + depends on SPI && ZL3073X + select REGMAP_SPI + default m + help + This is SPI bus implementation for Microchip Azurite DPLL/PTP/SyncE + devices. + + To compile this driver as a module, choose M here: the module will + be called zl3073x_spi.
drivers/dpll/zl3073x/Makefile new file +10 -0
@@ -0,0 +1,10 @@ +# SPDX-License-Identifier: GPL-2.0 + +obj-$(CONFIG_ZL3073X) += zl3073x.o +zl3073x-objs := core.o + +obj-$(CONFIG_ZL3073X_I2C) += zl3073x_i2c.o +zl3073x_i2c-objs := i2c.o + +obj-$(CONFIG_ZL3073X_SPI) += zl3073x_spi.o +zl3073x_spi-objs := spi.o
drivers/dpll/zl3073x/core.c new file +452 -0
452 lines not on this page · raw message
drivers/dpll/zl3073x/core.h new file +56 -0
56 lines not on this page · raw message
drivers/dpll/zl3073x/i2c.c new file +93 -0
93 lines not on this page · raw message
drivers/dpll/zl3073x/regs.h new file +75 -0
75 lines not on this page · raw message
drivers/dpll/zl3073x/spi.c new file +93 -0
93 lines not on this page · raw message
Signature · 1 line
2.49.0
Re: [PATCH net-next v11 03/14] dpll: Add basic Microchip ZL3073x support
Quoted 22 lines · On Mon, 16 Jun 2025 22:13:53 +0200 Ivan Vecera <[email protected]> wrote:
Microchip Azurite ZL3073x represents chip family providing DPLL and optionally PHC (PTP) functionality. The chips can be connected be connected over I2C or SPI bus.
They have 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 unitThe 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.
Quoted 4 lines
Add basic functionality to access device registers and probe functionality for both I2C and SPI cases.
Signed-off-by Ivan Vecera <[email protected]>
A few trivial drive by comments.
Quoted 20 lines
drivers/dpll/zl3073x/i2c.c new file +14
-0@@ -0,0 +1,93 @@ +// SPDX-License-Identifier: GPL-2.0-only + +#include <linux/dev_printk.h> +#include <linux/err.h> +#include <linux/i2c.h> +#include <linux/module.h> +#include <linux/regmap.h> + +#include "core.h" + +static int zl3073x_i2c_probe (struct i2c_client *client) +{ +struct device *dev = &client->dev; +struct zl3073x_dev *zldev;
drivers/dpll/zl3073x/i2c.c line 24
Quoted 10 lines
drivers/dpll/zl3073x/i2c.c new file +10
-0+ + zldev =zl3073x_devm_alloc (dev); +if (IS_ERR (zldev)) +return PTR_ERR (zldev); + + zldev->regmap =devm_regmap_init_i2c (client, &zl3073x_regmap_config); +if (IS_ERR (zldev->regmap)) { +dev_err_probe (dev,PTR_ERR (zldev->regmap), +"Failed to initialize regmap\n" ); +return PTR_ERR (zldev->regmap);
As below.
Quoted 22 lines
drivers/dpll/zl3073x/i2c.c new file +1
-0+ }drivers/dpll/zl3073x/spi.c new file +14
-0@@ -0,0 +1,93 @@ +// SPDX-License-Identifier: GPL-2.0-only + +#include <linux/dev_printk.h> +#include <linux/err.h> +#include <linux/module.h> +#include <linux/regmap.h> +#include <linux/spi/spi.h> + +#include "core.h" + +static int zl3073x_spi_probe (struct spi_device *spi) +{ +struct device *dev = &spi->dev; +struct zl3073x_dev *zldev;
drivers/dpll/zl3073x/spi.c line 24
Quoted 10 lines
drivers/dpll/zl3073x/spi.c new file +10
-0+ + zldev =zl3073x_devm_alloc (dev); +if (IS_ERR (zldev)) +return PTR_ERR (zldev); + + zldev->regmap =devm_regmap_init_spi (spi, &zl3073x_regmap_config); +if (IS_ERR (zldev->regmap)) { +dev_err_probe (dev,PTR_ERR (zldev->regmap), +"Failed to initialize regmap\n" ); +return PTR_ERR (zldev->regmap);
return dev_err_probe();
One of it's biggest advantages is that dev_err_probe() returns the ret value passed in avoiding duplication like this and saving a few lines of code each time.
drivers/dpll/zl3073x/spi.c line 33
Quoted 9 lines
drivers/dpll/zl3073x/spi.c new file +9
-0+ } + +return zl3073x_dev_probe (zldev,spi_get_device_match_data (spi)); +} + +static const struct spi_device_id zl3073x_spi_id[] = { + { + .name ="zl30731" , + .driver_data = (kernel_ulong_t)&zl3073x_chip_info[ZL30731 ],
Not my subsystem so up to you, but in general over time we've found that an enum + array tends to bring few benefits over appropriately named zl30731_chip_info separate structures.
Quoted 60 lines
drivers/dpll/zl3073x/spi.c new file +60
-0+ }, + { + .name = "zl30732", + .driver_data = (kernel_ulong_t)&zl3073x_chip_info[ZL30732], + }, + { + .name = "zl30733", + .driver_data = (kernel_ulong_t)&zl3073x_chip_info[ZL30733], + }, + { + .name = "zl30734", + .driver_data = (kernel_ulong_t)&zl3073x_chip_info[ZL30734], + }, + { + .name = "zl30735", + .driver_data = (kernel_ulong_t)&zl3073x_chip_info[ZL30735] + }, + { /* sentinel */ } +}; +MODULE_DEVICE_TABLE(spi, zl3073x_spi_id); + +static const struct of_device_id zl3073x_spi_of_match[] = { + { + .compatible = "microchip,zl30731", + .data = &zl3073x_chip_info[ZL30731] + }, + { + .compatible = "microchip,zl30732", + .data = &zl3073x_chip_info[ZL30732] + }, + { + .compatible = "microchip,zl30733", + .data = &zl3073x_chip_info[ZL30733] + }, + { + .compatible = "microchip,zl30734", + .data = &zl3073x_chip_info[ZL30734] + }, + { + .compatible = "microchip,zl30735", + .data = &zl3073x_chip_info[ZL30735] + }, + { /* sentinel */ } +}; +MODULE_DEVICE_TABLE(of, zl3073x_spi_of_match); + +static struct spi_driver zl3073x_spi_driver = { + .driver = { + .name = "zl3073x-spi", + .of_match_table = zl3073x_spi_of_match, + }, + .probe = zl3073x_spi_probe, + .id_table = zl3073x_spi_id, +}; +module_spi_driver(zl3073x_spi_driver); + +MODULE_AUTHOR("Ivan Vecera <[email protected]>"); +MODULE_DESCRIPTION("Microchip ZL3073x SPI driver"); +MODULE_IMPORT_NS("ZL3073X"); +MODULE_LICENSE("GPL");
Paolo Abeni
maintainerRe: [PATCH net-next v11 03/14] dpll: Add basic Microchip ZL3073x support
Quoted 12 lines · Jonathan Cameron
On Mon, 16 Jun 2025 22:13:53 +0200
Quoted 11 lines
drivers/dpll/zl3073x/spi.c new file +11
-0+static int zl3073x_spi_probe (struct spi_device *spi) +{ +struct device *dev = &spi->dev; +struct zl3073x_dev *zldev; + + zldev =zl3073x_devm_alloc (dev); +if (IS_ERR (zldev)) +return PTR_ERR (zldev); + + zldev->regmap =devm_regmap_init_spi (spi, &zl3073x_regmap_config); +if (IS_ERR (zldev->regmap)) {
Quoted 8 lines
drivers/dpll/zl3073x/i2c.c line 24
Quoted 3 lines
drivers/dpll/zl3073x/i2c.c new file +3
-0+dev_err_probe (dev,PTR_ERR (zldev->regmap), +"Failed to initialize regmap\n" ); +return PTR_ERR (zldev->regmap);return
dev_err_probe();
One of it's biggest advantages is thatdev_err_probe()returns the ret value passed in avoiding duplication like this and saving a few lines of code each time.
@Ivan: since patch 13 requires IMHO a fix, please also take care of the above in the next revision, thanks!
Paolo
Ivan Vecera
maintainerRe: [PATCH net-next v11 03/14] dpll: Add basic Microchip ZL3073x support
Quoted 22 lines · Paolo Abeni
Quoted 12 lines · Jonathan Cameron
On Mon, 16 Jun 2025 22:13:53 +0200
Quoted 11 lines
drivers/dpll/zl3073x/spi.c new file +11
-0+static int zl3073x_spi_probe (struct spi_device *spi) +{ +struct device *dev = &spi->dev; +struct zl3073x_dev *zldev; + + zldev =zl3073x_devm_alloc (dev); +if (IS_ERR (zldev)) +return PTR_ERR (zldev); + + zldev->regmap =devm_regmap_init_spi (spi, &zl3073x_regmap_config); +if (IS_ERR (zldev->regmap)) {Quoted 8 lines
drivers/dpll/zl3073x/i2c.c line 24
Quoted 3 lines
drivers/dpll/zl3073x/i2c.c new file +3
-0+dev_err_probe (dev,PTR_ERR (zldev->regmap), +"Failed to initialize regmap\n" ); +return PTR_ERR (zldev->regmap);return
dev_err_probe();
One of it's biggest advantages is thatdev_err_probe()returns the ret value passed in avoiding duplication like this and saving a few lines of code each time.
Quoted 5 lines
@Ivan: since patch 13 requires IMHO a fix, please also take care of the above in the next revision, thanks!
Paolo
Hi Paolo
I will send the next series after vacation...
I'm now in mountains in Albania.
Will be back on 6/30
I.
Ivan Vecera
maintainerRe: [PATCH net-next v11 03/14] dpll: Add basic Microchip ZL3073x support
In reply to Jonathan CameronQuoted 92 lines · Jonathan Cameron
Quoted 22 lines · On Mon, 16 Jun 2025 22:13:53 +0200 Ivan Vecera <[email protected]> wrote:
Microchip Azurite ZL3073x represents chip family providing DPLL and optionally PHC (PTP) functionality. The chips can be connected be connected over I2C or SPI bus.
They have 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 unitThe 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.Quoted 4 lines
Add basic functionality to access device registers and probe functionality for both I2C and SPI cases.
Signed-off-by Ivan Vecera <[email protected]>A few trivial drive by comments.
Quoted 20 lines
drivers/dpll/zl3073x/i2c.c new file +14
-0@@ -0,0 +1,93 @@ +// SPDX-License-Identifier: GPL-2.0-only + +#include <linux/dev_printk.h> +#include <linux/err.h> +#include <linux/i2c.h> +#include <linux/module.h> +#include <linux/regmap.h> + +#include "core.h" + +static int zl3073x_i2c_probe (struct i2c_client *client) +{ +struct device *dev = &client->dev; +struct zl3073x_dev *zldev;drivers/dpll/zl3073x/i2c.c line 24
Quoted 10 lines
drivers/dpll/zl3073x/i2c.c new file +10
-0+ + zldev =zl3073x_devm_alloc (dev); +if (IS_ERR (zldev)) +return PTR_ERR (zldev); + + zldev->regmap =devm_regmap_init_i2c (client, &zl3073x_regmap_config); +if (IS_ERR (zldev->regmap)) { +dev_err_probe (dev,PTR_ERR (zldev->regmap), +"Failed to initialize regmap\n" ); +return PTR_ERR (zldev->regmap);As below.
Quoted 29 lines
drivers/dpll/zl3073x/i2c.c new file +1
-0+ }drivers/dpll/zl3073x/spi.c new file +21
-0@@ -0,0 +1,93 @@ +// SPDX-License-Identifier: GPL-2.0-only + +#include <linux/dev_printk.h> +#include <linux/err.h> +#include <linux/module.h> +#include <linux/regmap.h> +#include <linux/spi/spi.h> + +#include "core.h" + +static int zl3073x_spi_probe (struct spi_device *spi) +{ +struct device *dev = &spi->dev; +struct zl3073x_dev *zldev; + + zldev =zl3073x_devm_alloc (dev); +if (IS_ERR (zldev)) +return PTR_ERR (zldev); + + zldev->regmap =devm_regmap_init_spi (spi, &zl3073x_regmap_config); +if (IS_ERR (zldev->regmap)) {
Quoted 8 lines
drivers/dpll/zl3073x/spi.c line 24
Quoted 3 lines
drivers/dpll/zl3073x/spi.c new file +3
-0+dev_err_probe (dev,PTR_ERR (zldev->regmap), +"Failed to initialize regmap\n" ); +return PTR_ERR (zldev->regmap);return
dev_err_probe();
One of it's biggest advantages is thatdev_err_probe()returns the ret value passed in avoiding duplication like this and saving a few lines of code each time.
Will fix.
Quoted 5 lines
Quoted 5 lines
drivers/dpll/zl3073x/spi.c new file +5
-0+ } + +return zl3073x_dev_probe (zldev,spi_get_device_match_data (spi)); +} +
Quoted 8 lines
drivers/dpll/zl3073x/spi.c line 33
Quoted 4 lines
drivers/dpll/zl3073x/spi.c new file +4
-0+static const struct spi_device_id zl3073x_spi_id[] = { + { + .name ="zl30731" , + .driver_data = (kernel_ulong_t)&zl3073x_chip_info[ZL30731 ],Not my subsystem so up to you, but in general over time we've found that an enum + array tends to bring few benefits over appropriately named
zl30731_chip_infoseparate structures.
Will update according this.
Quoted 52 lines
Quoted 52 lines
drivers/dpll/zl3073x/spi.c new file +52
-0+ }, + { + .name = "zl30732", + .driver_data = (kernel_ulong_t)&zl3073x_chip_info[ZL30732], + }, + { + .name = "zl30733", + .driver_data = (kernel_ulong_t)&zl3073x_chip_info[ZL30733], + }, + { + .name = "zl30734", + .driver_data = (kernel_ulong_t)&zl3073x_chip_info[ZL30734], + }, + { + .name = "zl30735", + .driver_data = (kernel_ulong_t)&zl3073x_chip_info[ZL30735] + }, + { /* sentinel */ } +}; +MODULE_DEVICE_TABLE(spi, zl3073x_spi_id); + +static const struct of_device_id zl3073x_spi_of_match[] = { + { + .compatible = "microchip,zl30731", + .data = &zl3073x_chip_info[ZL30731] + }, + { + .compatible = "microchip,zl30732", + .data = &zl3073x_chip_info[ZL30732] + }, + { + .compatible = "microchip,zl30733", + .data = &zl3073x_chip_info[ZL30733] + }, + { + .compatible = "microchip,zl30734", + .data = &zl3073x_chip_info[ZL30734] + }, + { + .compatible = "microchip,zl30735", + .data = &zl3073x_chip_info[ZL30735] + }, + { /* sentinel */ } +}; +MODULE_DEVICE_TABLE(of, zl3073x_spi_of_match); + +static struct spi_driver zl3073x_spi_driver = { + .driver = { + .name = "zl3073x-spi", + .of_match_table = zl3073x_spi_of_match, + }, + .probe = zl3073x_spi_probe,
Quoted 9 lines
drivers/dpll/zl3073x/spi.c line 93
Quoted 8 lines
drivers/dpll/zl3073x/spi.c new file +8
-0+ .id_table = zl3073x_spi_id, +}; +module_spi_driver (zl3073x_spi_driver); + +MODULE_AUTHOR ("Ivan Vecera <[email protected]>" ); +MODULE_DESCRIPTION ("Microchip ZL3073x SPI driver" ); +MODULE_IMPORT_NS ("ZL3073X" ); +MODULE_LICENSE ("GPL" );
Thanks for advice.
Ivan
Ivan Vecera
maintainerPATCH v11 4/14 dpll: zl3073x: Add support for devlink device info
In reply to Ivan VeceraUse devlink_alloc() to allocate zl3073x_dev structure, register the device as a devlink device, and add devlink callback to provide device info.
Sample output:
# devlink dev info
i2c/1-0070:
driver zl3073x-i2c
versions:
fixed:
asic.id 1E94
asic.rev 300
running:
fw 7006--- Documentation/networking/devlink/index.rst | 1 + Documentation/networking/devlink/zl3073x.rst | 37 +++++++ drivers/dpll/zl3073x/Kconfig | 2 + drivers/dpll/zl3073x/core.c | 108 ++++++++++++++++++- 4 files changed, 146 insertions(+), 2 deletions(-) create mode 100644 Documentation/networking/devlink/zl3073x.rst
Documentation/networking/devlink/index.rst +1 -0
@@ -98,3 +98,4 @@ parameters, info versions, and other features it supports. iosm octeontx2 sfc + zl3073x
Documentation/networking/devlink/zl3073x.rst new file +37 -0
@@ -0,0 +1,37 @@ +.. SPDX-License-Identifier: GPL-2.0 + +======================= +zl3073x devlink support +======================= + +This document describes the devlink features implemented by the ``zl3073x`` +device driver. + +Info versions +============= + +The ``zl3073x`` driver reports the following versions + +.. list-table:: devlink info versions implemented + :widths: 5 5 5 90 + + * - Name + - Type + - Example + - Description + * - ``asic.id`` + - fixed + - 1E94 + - Chip identification number + * - ``asic.rev`` + - fixed + - 300 + - Chip revision number + * - ``fw`` + - running + - 7006 + - Firmware version number + * - ``cfg.custom_ver`` + - running + - 1.3.0.1 + - Device configuration version customized by OEM
drivers/dpll/zl3073x/Kconfig +2 -0
@@ -2,7 +2,9 @@ config ZL3073X tristate "Microchip Azurite DPLL/PTP/SyncE devices" + depends on NET select DPLL + select NET_DEVLINK help This driver supports Microchip Azurite DPLL/PTP/SyncE devices.
drivers/dpll/zl3073x/core.c +106 -2
149 lines not on this page · raw message
Signature · 1 line
2.49.0
Ivan Vecera
maintainerPATCH v11 5/14 dpll: zl3073x: Protect operations requiring multiple register accesses
In reply to Ivan VeceraRegisters 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.
Operations with these registers requires multiple register reads, writes and polls and all of them need to be done atomically.
So add multiop_lock mutex to protect such operations and check the mutex is held by the caller when it's accessing registers from page 10 and above.
--- drivers/dpll/zl3073x/core.c | 14 ++++++++++++++ drivers/dpll/zl3073x/core.h | 3 +++ 2 files changed, 17 insertions(+)
drivers/dpll/zl3073x/core.c +14 -0
@@ -122,6 +122,12 @@ EXPORT_SYMBOL_NS_GPL(zl3073x_regmap_config, "ZL3073X");static bool zl3073x_check_reg (struct zl3073x_dev *zldev,unsigned int reg,size_t size) { +/* Check that multiop lock is held when accessing registers +* from page 10 and above. +*/ +if (ZL_REG_PAGE (reg) >=10 ) +lockdep_assert_held (&zldev->multiop_lock); +/* Check the index is in valid range for indexed register */ if (ZL_REG_OFFSET (reg) >ZL_REG_MAX_OFFSET (reg)) { dev_err(zldev->dev, "Index out of range for reg 0x%04lx\n",
@@ -537,6 +543,14 @@ int zl3073x_dev_probe(struct zl3073x_dev *zldev,FIELD_GET (GENMASK (15 ,8 ), cfg_ver), FIELD_GET(GENMASK(7, 0), cfg_ver)); +/* Initialize mutex for operations where multiple reads, writes +* and/or polls are required to be done atomically. +*/ + rc =devm_mutex_init (zldev->dev, &zldev->multiop_lock); +if (rc) +return dev_err_probe (zldev->dev, rc, +"Failed to initialize mutex\n" ); +/* Register the device as devlink device */ devlink =priv_to_devlink (zldev);devlink_register (devlink);
drivers/dpll/zl3073x/core.h +3 -0
@@ -3,6 +3,7 @@#ifndef _ZL3073X_H#define _ZL3073X_H +#include <linux/mutex.h> #include <linux/types.h> struct device ;
@@ -12,10 +13,12 @@ struct regmap;* struct zl3073x_dev - zl3073x device * @dev: pointer to device * @regmap: regmap to access device registers +* @multiop_lock: to serialize multiple register operations */ struct zl3073x_dev {struct device *dev;struct regmap *regmap; +struct mutex multiop_lock; };enum zl3073x_chip_type {
Signature · 1 line
2.49.0
Ivan Vecera
maintainerPATCH v11 6/14 dpll: zl3073x: Fetch invariants during probe
In reply to Ivan VeceraSeveral configuration parameters will remain constant at runtime, so we can load them during probe to avoid excessive reads from the hardware.
Read the following parameters from the device during probe and store them for later use:
* enablement status and frequencies of the synthesizers and their associated DPLL channels
* enablement status and type (single-ended or differential) of input pins
* associated synthesizers, signal format, and enablement status of outputs
---
v10:
* using str_enabled_disabled() where possible
--- drivers/dpll/zl3073x/core.c | 249 +++++++++++++++++++++++++++++++ drivers/dpll/zl3073x/core.h | 286 ++++++++++++++++++++++++++++++++++++ drivers/dpll/zl3073x/regs.h | 65 ++++++++ 3 files changed, 600 insertions(+)
drivers/dpll/zl3073x/core.c +249 -0
@@ -6,10 +6,12 @@#include <linux/dev_printk.h> #include <linux/device.h> #include <linux/export.h> +#include <linux/math64.h> #include <linux/module.h> #include <linux/netlink.h> #include <linux/regmap.h> #include <linux/sprintf.h> +#include <linux/string_choices.h> #include <linux/unaligned.h> #include <net/devlink.h>
@@ -376,6 +378,25 @@ int zl3073x_poll_zero_u8(struct zl3073x_dev *zldev, unsigned int reg, u8 mask) ZL_POLL_SLEEP_US, ZL_POLL_TIMEOUT_US); } +int zl3073x_mb_op (struct zl3073x_dev *zldev,unsigned int op_reg,u8 op_val, +unsigned int mask_reg,u16 mask_val) +{ +int rc; + +/* Set mask for the operation */ + rc =zl3073x_write_u16 (zldev, mask_reg, mask_val); +if (rc) +return rc; + +/* Trigger the operation */ + rc =zl3073x_write_u8 (zldev, op_reg, op_val); +if (rc) +return rc; + +/* Wait for the operation to actually finish */ +return zl3073x_poll_zero_u8 (zldev, op_reg, op_val); +} +/** * zl3073x_devlink_info_get - Devlink device info callback * @devlink: devlink structure pointer
@@ -484,6 +505,229 @@ struct zl3073x_dev *zl3073x_devm_alloc(struct device *dev) }EXPORT_SYMBOL_NS_GPL (zl3073x_devm_alloc,"ZL3073X" ); +/** +* zl3073x_ref_state_fetch - get input reference state +* @zldev: pointer to zl3073x_dev structure +* @index: input reference 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_ref_state_fetch (struct zl3073x_dev *zldev,u8 index) +{ +struct zl3073x_ref *input = &zldev->ref[index]; +u8 ref_config; +int rc; + +/* 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_ref_is_diff (zldev, index -1 )) { + input->enabled =zl3073x_ref_is_enabled (zldev, index -1 ); + input->diff = true; + +return 0 ; + } + +guard (mutex)(&zldev->multiop_lock); + +/* Read reference configuration */ + rc =zl3073x_mb_op (zldev,ZL_REG_REF_MB_SEM ,ZL_REF_MB_SEM_RD , +ZL_REG_REF_MB_MASK ,BIT (index)); +if (rc) +return rc; + +/* Read ref_config register */ + rc =zl3073x_read_u8 (zldev,ZL_REG_REF_CONFIG , &ref_config); +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,"REF%u is %s and configured as %s\n" , index, +str_enabled_disabled (input->enabled), + input->diff ?"differential" :"single-ended" ); + +return rc; +} + +/** +* zl3073x_out_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_out_state_fetch (struct zl3073x_dev *zldev,u8 index) +{ +struct zl3073x_out *out = &zldev->out[index]; +u8 output_ctrl, output_mode; +int rc; + +/* Read output configuration */ + rc =zl3073x_read_u8 (zldev,ZL_REG_OUTPUT_CTRL (index), &output_ctrl); +if (rc) +return rc; + +/* Store info about output enablement and synthesizer the output +* is connected to. +*/ + out->enabled =FIELD_GET (ZL_OUTPUT_CTRL_EN , output_ctrl); + out->synth =FIELD_GET (ZL_OUTPUT_CTRL_SYNTH_SEL , output_ctrl); + +dev_dbg (zldev->dev,"OUT%u is %s and connected to SYNTH%u\n" , index, +str_enabled_disabled (out->enabled), out->synth); + +guard (mutex)(&zldev->multiop_lock); + +/* Read output configuration */ + rc =zl3073x_mb_op (zldev,ZL_REG_OUTPUT_MB_SEM ,ZL_OUTPUT_MB_SEM_RD , +ZL_REG_OUTPUT_MB_MASK ,BIT (index)); +if (rc) +return rc; + +/* Read output_mode */ + rc =zl3073x_read_u8 (zldev,ZL_REG_OUTPUT_MODE , &output_mode); +if (rc) +return rc; + +/* Extract and store output signal format */ + out->signal_format =FIELD_GET (ZL_OUTPUT_MODE_SIGNAL_FORMAT , + output_mode); + +dev_dbg (zldev->dev,"OUT%u has signal format 0x%02x\n" , index, + out->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_synth *synth = &zldev->synth[index]; +u16 base, m, n; +u8 synth_ctrl; +u32 mult; +int rc; + +/* Read synth control register */ + rc =zl3073x_read_u8 (zldev,ZL_REG_SYNTH_CTRL (index), &synth_ctrl); +if (rc) +return rc; + +/* Store info about synth enablement and DPLL channel the synth is +* driven by. +*/ + synth->enabled =FIELD_GET (ZL_SYNTH_CTRL_EN , synth_ctrl); + synth->dpll =FIELD_GET (ZL_SYNTH_CTRL_DPLL_SEL , synth_ctrl); + +dev_dbg (zldev->dev,"SYNTH%u is %s and driven by DPLL%u\n" , index, +str_enabled_disabled (synth->enabled), synth->dpll); + +guard (mutex)(&zldev->multiop_lock); + +/* Read synth configuration */ + rc =zl3073x_mb_op (zldev,ZL_REG_SYNTH_MB_SEM ,ZL_SYNTH_MB_SEM_RD , +ZL_REG_SYNTH_MB_MASK ,BIT (index)); +if (rc) +return rc; + +/* The output frequency is determined by the following formula: +* base * multiplier * numerator / denominator +* +* Read registers with these values +*/ + rc =zl3073x_read_u16 (zldev,ZL_REG_SYNTH_FREQ_BASE , &base); +if (rc) +return rc; + + rc =zl3073x_read_u32 (zldev,ZL_REG_SYNTH_FREQ_MULT , &mult); +if (rc) +return rc; + + rc =zl3073x_read_u16 (zldev,ZL_REG_SYNTH_FREQ_M , &m); +if (rc) +return rc; + + rc =zl3073x_read_u16 (zldev,ZL_REG_SYNTH_FREQ_N , &n); +if (rc) +return rc; + +/* Check denominator for zero to avoid div by 0 */ +if (!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 =div_u64 (mul_u32_u32 (base * m, mult), n); + +dev_dbg (zldev->dev,"SYNTH%u frequency: %u 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_REFS ; i++) { + rc =zl3073x_ref_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_OUTS ; i++) { + rc =zl3073x_out_state_fetch (zldev, i); +if (rc) { +dev_err (zldev->dev, +"Failed to fetch output state: %pe\n" , +ERR_PTR (rc)); +return rc; + } + } + +return rc; +} +static void zl3073x_devlink_unregister (void *ptr) {devlink_unregister (ptr);
@@ -551,6 +795,11 @@ int zl3073x_dev_probe(struct zl3073x_dev *zldev,return dev_err_probe (zldev->dev, rc,"Failed to initialize mutex\n" ); +/* 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/dpll/zl3073x/core.h +286 -0
315 lines not on this page · raw message
drivers/dpll/zl3073x/regs.h +65 -0
69 lines not on this page · raw message
Signature · 1 line
2.49.0
Ivan Vecera
maintainerPATCH v11 7/14 dpll: zl3073x: Add clock_id field
In reply to Ivan VeceraAdd .clock_id to zl3073x_dev structure that will be used by later commits introducing DPLL feature. 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/dpll/zl3073x/core.c | 6 +++++- drivers/dpll/zl3073x/core.h | 4 +++- drivers/dpll/zl3073x/i2c.c | 4 +++- drivers/dpll/zl3073x/spi.c | 4 +++- 4 files changed, 14 insertions(+), 4 deletions(-)
drivers/dpll/zl3073x/core.c +5 -1
@@ -737,13 +737,14 @@ static void zl3073x_devlink_unregister(void *ptr)* 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;
@@ -787,6 +788,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; +/* Initialize mutex for operations where multiple reads, writes * and/or polls are required to be done atomically. */
drivers/dpll/zl3073x/core.h +3 -1
@@ -57,6 +57,7 @@ struct zl3073x_synth {* @dev: pointer to device * @regmap: regmap to access device registers * @multiop_lock: to serialize multiple register operations +* @clock_id: clock id of the device * @ref: array of input references' invariants * @out: array of outs' invariants * @synth: array of synths' invariants
@@ -65,6 +66,7 @@ struct zl3073x_dev {struct device *dev;struct regmap *regmap;struct mutex multiop_lock; +u64 clock_id;/* Invariants */ struct zl3073x_ref ref[ZL3073X_NUM_REFS ];
@@ -91,7 +93,7 @@ extern const struct regmap_config zl3073x_regmap_config;struct zl3073x_dev *zl3073x_devm_alloc (struct device *dev);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);/********************** * Registers operations
drivers/dpll/zl3073x/i2c.c +3 -1
@@ -24,7 +24,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/dpll/zl3073x/spi.c +3 -1
@@ -24,7 +24,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[] = {
Signature · 1 line
2.49.0
Ivan Vecera
maintainerPATCH v11 8/14 dpll: zl3073x: Read DPLL types and pin properties from system firmware
In reply to Ivan VeceraAdd support for reading of DPLL types and optional pin properties from the system firmware (DT, ACPI...).
The DPLL types are stored in property 'dpll-types' as string array and possible values 'pps' and 'eec' are mapped to DPLL enums DPLL_TYPE_PPS and DPLL_TYPE_EEC.
The pin properties are stored under 'input-pins' and 'output-pins' sub-nodes and the following ones are supported:
* reg
integer that specifies pin index
* label
string that is used by driver as board label
* connection-type
string that indicates pin connection type
* supported-frequencies-hz
array of u64 values what frequencies are supported / allowed for given pin with respect to hardware wiring
Do not blindly trust system firmware and filter out frequencies that cannot be configured/represented in device (input frequencies have to be factorized by one of the base frequencies and output frequencies have to divide configured synthesizer frequency).
--- drivers/dpll/zl3073x/Makefile | 2 +- drivers/dpll/zl3073x/core.c | 41 ++++ drivers/dpll/zl3073x/core.h | 7 + drivers/dpll/zl3073x/prop.c | 354 ++++++++++++++++++++++++++++++++++ drivers/dpll/zl3073x/prop.h | 34 ++++ 5 files changed, 437 insertions(+), 1 deletion(-) create mode 100644 drivers/dpll/zl3073x/prop.c create mode 100644 drivers/dpll/zl3073x/prop.h
drivers/dpll/zl3073x/Makefile +1 -1
@@ -1,7 +1,7 @@ # SPDX-License-Identifier: GPL-2.0 obj-$(CONFIG_ZL3073X) += zl3073x.o -zl3073x-objs := core.o +zl3073x-objs := core.o prop.o obj-$(CONFIG_ZL3073X_I2C) += zl3073x_i2c.o zl3073x_i2c-objs := i2c.o
drivers/dpll/zl3073x/core.c +41 -0
47 lines not on this page · raw message
drivers/dpll/zl3073x/core.h +7 -0
@@ -14,6 +14,7 @@ struct regmap;/* * Hardware limits for ZL3073x chip family */ +#define ZL3073X_MAX_CHANNELS 5#define ZL3073X_NUM_REFS 10#define ZL3073X_NUM_OUTS 10#define ZL3073X_NUM_SYNTHS 5
@@ -111,6 +112,12 @@ int zl3073x_write_u16(struct zl3073x_dev *zldev, unsigned int reg, u16 val);int zl3073x_write_u32 (struct zl3073x_dev *zldev,unsigned int reg,u32 val);int zl3073x_write_u48 (struct zl3073x_dev *zldev,unsigned int reg,u64 val); +/***************** +* Misc operations +*****************/ + +int zl3073x_ref_freq_factorize (u32 freq,u16 *base,u16 *mult); +static inline bool zl3073x_is_n_pin (u8 id) {
drivers/dpll/zl3073x/prop.c new file +354 -0
354 lines not on this page · raw message
drivers/dpll/zl3073x/prop.h new file +34 -0
@@ -0,0 +1,34 @@ +/* SPDX-License-Identifier: GPL-2.0-only */ + +#ifndef _ZL3073X_PROP_H +#define _ZL3073X_PROP_H + +#include <linux/dpll.h> + +#include "core.h" + +struct fwnode_handle ; + +/** +* struct zl3073x_pin_props - pin properties +* @fwnode: pin firmware node +* @dpll_props: DPLL core pin properties +* @package_label: pin package label +* @esync_control: embedded sync support +*/ +struct zl3073x_pin_props { +struct fwnode_handle *fwnode; +struct dpll_pin_properties dpll_props; +char package_label[8 ]; +bool esync_control; +}; + +enum dpll_type zl3073x_prop_dpll_type_get (struct zl3073x_dev *zldev,u8 index); + +struct zl3073x_pin_props *zl3073x_pin_props_get (struct zl3073x_dev *zldev, +enum dpll_pin_direction dir, +u8 index); + +void zl3073x_pin_props_put (struct zl3073x_pin_props *props); + +#endif /* _ZL3073X_PROP_H */
Signature · 1 line
2.49.0
Ivan Vecera
maintainerPATCH v11 9/14 dpll: zl3073x: Register DPLL devices and pins
In reply to Ivan VeceraEnumerate all available DPLL channels and registers a DPLL device for each of them. Check all input references and outputs and register DPLL pins for them.
Number of registered DPLL pins depends on configuration of references and outputs. If the reference or output is configured as differential one then only one DPLL pin is registered. Both references and outputs can be also disabled from firmware configuration and in this case no DPLL pins are registered.
All registrable references are registered to all available DPLL devices with exception of DPLLs that are configured in NCO (numerically controlled oscillator) mode. In this mode DPLL channel acts as PHC and cannot be locked to any reference.
Device outputs are connected to one of synthesizers and each synthesizer is driven by some DPLL channel. So output pins belonging to given output are registered to DPLL device that drives associated synthesizer.
Finally add kworker task to monitor async changes on all DPLL channels and input pins and to notify about them DPLL core. Output pins are not monitored as their parameters are not changed asynchronously by the device.
---
v11:
* fixed uninitialized 'rc' in error-path
v10:
* fixed comparisons to NULL
--- drivers/dpll/zl3073x/Makefile | 2 +- drivers/dpll/zl3073x/core.c | 104 ++++ drivers/dpll/zl3073x/core.h | 17 + drivers/dpll/zl3073x/dpll.c | 898 ++++++++++++++++++++++++++++++++++ drivers/dpll/zl3073x/dpll.h | 42 ++ drivers/dpll/zl3073x/regs.h | 56 +++ 6 files changed, 1118 insertions(+), 1 deletion(-) create mode 100644 drivers/dpll/zl3073x/dpll.c create mode 100644 drivers/dpll/zl3073x/dpll.h
drivers/dpll/zl3073x/Makefile +1 -1
@@ -1,7 +1,7 @@ # SPDX-License-Identifier: GPL-2.0 obj-$(CONFIG_ZL3073X) += zl3073x.o -zl3073x-objs := core.o prop.o +zl3073x-objs := core.o dpll.o prop.o obj-$(CONFIG_ZL3073X_I2C) += zl3073x_i2c.o zl3073x_i2c-objs := i2c.o
drivers/dpll/zl3073x/core.c +104 -0
122 lines not on this page · raw message
drivers/dpll/zl3073x/core.h +17 -0
@@ -3,6 +3,8 @@#ifndef _ZL3073X_H#define _ZL3073X_H +#include <linux/kthread.h> +#include <linux/list.h> #include <linux/mutex.h> #include <linux/types.h>
@@ -10,6 +12,7 @@struct device ;struct regmap ; +struct zl3073x_dpll ;/* * Hardware limits for ZL3073x chip family
@@ -18,6 +21,10 @@ struct regmap;#define ZL3073X_NUM_REFS 10#define ZL3073X_NUM_OUTS 10#define ZL3073X_NUM_SYNTHS 5 +#define ZL3073X_NUM_INPUT_PINS ZL3073X_NUM_REFS +#define ZL3073X_NUM_OUTPUT_PINS (ZL3073X_NUM_OUTS * 2) +#define ZL3073X_NUM_PINS (ZL3073X_NUM_INPUT_PINS + \ + ZL3073X_NUM_OUTPUT_PINS)/** * struct zl3073x_ref - input reference invariant info
@@ -62,6 +69,9 @@ struct zl3073x_synth {* @ref: array of input references' invariants * @out: array of outs' invariants * @synth: array of synths' invariants +* @dplls: list of DPLLs +* @kworker: thread for periodic work +* @work: periodic work */ struct zl3073x_dev {struct device *dev;
@@ -73,6 +83,13 @@ struct zl3073x_dev {struct zl3073x_ref ref[ZL3073X_NUM_REFS ];struct zl3073x_out out[ZL3073X_NUM_OUTS ];struct zl3073x_synth synth[ZL3073X_NUM_SYNTHS ]; + +/* DPLL channels */ +struct list_head dplls; + +/* Monitor */ +struct kthread_worker *kworker; +struct kthread_delayed_work work; };enum zl3073x_chip_type {
drivers/dpll/zl3073x/dpll.c new file +898 -0
898 lines not on this page · raw message
drivers/dpll/zl3073x/dpll.h new file +42 -0
42 lines not on this page · raw message
drivers/dpll/zl3073x/regs.h +56 -0
74 lines not on this page · raw message
Signature · 1 line
2.49.0
Ivan Vecera
maintainerPATCH v11 10/14 dpll: zl3073x: Implement input pin selection in manual mode
In reply to Ivan VeceraImplement input pin state setting if the DPLL is running in manual mode. The driver indicates manual mode if the DPLL mode is one of ref-lock, forced-holdover, freerun.
Use these modes to implement input pin state change between connected and disconnected states. When the user set the particular pin as connected the driver marks this input pin as forced reference and switches the DPLL mode to ref-lock. When the use set the pin as disconnected the driver switches the DPLL to freerun or forced holdover mode. The switch to holdover mode is done if the DPLL has holdover capability (e.g is currently locked with holdover acquired).
--- drivers/dpll/zl3073x/dpll.c | 118 ++++++++++++++++++++++++++++++++++++ drivers/dpll/zl3073x/prop.c | 9 ++- 2 files changed, 124 insertions(+), 3 deletions(-)
drivers/dpll/zl3073x/dpll.c +118 -0
@@ -132,6 +132,81 @@ zl3073x_dpll_selected_ref_get(struct zl3073x_dpll *zldpll, u8 *ref)return 0 ; } +/** +* zl3073x_dpll_selected_ref_set - select reference in manual mode +* @zldpll: pointer to zl3073x_dpll +* @ref: input reference to be selected +* +* Selects the given reference for the DPLL channel it should be +* locked to. +* +* Return: 0 on success, <0 on error +*/ +static int +zl3073x_dpll_selected_ref_set (struct zl3073x_dpll *zldpll,u8 ref) +{ +struct zl3073x_dev *zldev = zldpll->dev; +u8 mode, mode_refsel; +int rc; + + mode = zldpll->refsel_mode; + +switch (mode) { +case ZL_DPLL_MODE_REFSEL_MODE_REFLOCK : +/* Manual mode with ref selected */ +if (ref ==ZL3073X_DPLL_REF_NONE ) { +switch (zldpll->lock_status) { +case DPLL_LOCK_STATUS_LOCKED_HO_ACQ : +case DPLL_LOCK_STATUS_HOLDOVER : +/* Switch to forced holdover */ + mode =ZL_DPLL_MODE_REFSEL_MODE_HOLDOVER ; +break ; +default : +/* Switch to freerun */ + mode =ZL_DPLL_MODE_REFSEL_MODE_FREERUN ; +break ; + } +/* Keep selected reference */ + ref = zldpll->forced_ref; + }else if (ref == zldpll->forced_ref) { +/* No register update - same mode and same ref */ +return 0 ; + } +break ; +case ZL_DPLL_MODE_REFSEL_MODE_FREERUN : +case ZL_DPLL_MODE_REFSEL_MODE_HOLDOVER : +/* Manual mode without no ref */ +if (ref ==ZL3073X_DPLL_REF_NONE ) +/* No register update - keep current mode */ +return 0 ; + +/* Switch to reflock mode and update ref selection */ + mode =ZL_DPLL_MODE_REFSEL_MODE_REFLOCK ; +break ; +default : +/* For other modes like automatic or NCO ref cannot be selected +* manually +*/ +return -EOPNOTSUPP ; + } + +/* Build mode_refsel value */ + mode_refsel =FIELD_PREP (ZL_DPLL_MODE_REFSEL_MODE , mode) | +FIELD_PREP (ZL_DPLL_MODE_REFSEL_REF , ref); + +/* Update dpll_mode_refsel register */ + rc =zl3073x_write_u8 (zldev,ZL_REG_DPLL_MODE_REFSEL (zldpll->id), + mode_refsel); +if (rc) +return rc; + +/* Store new mode and forced reference */ + zldpll->refsel_mode = mode; + zldpll->forced_ref = ref; + +return rc; +} +/** * zl3073x_dpll_connected_ref_get - get currently connected reference * @zldpll: pointer to zl3073x_dpll
@@ -283,6 +358,48 @@ zl3073x_dpll_input_pin_state_on_dpll_get(const struct dpll_pin *dpll_pin,return zl3073x_dpll_ref_state_get (pin, state); } +static int +zl3073x_dpll_input_pin_state_on_dpll_set (const struct dpll_pin *dpll_pin, +void *pin_priv, +const struct dpll_device *dpll, +void *dpll_priv, +enum dpll_pin_state state, +struct netlink_ext_ack *extack) +{ +struct zl3073x_dpll *zldpll = dpll_priv; +struct zl3073x_dpll_pin *pin = pin_priv; +u8 new_ref; +int rc; + +switch (zldpll->refsel_mode) { +case ZL_DPLL_MODE_REFSEL_MODE_REFLOCK : +case ZL_DPLL_MODE_REFSEL_MODE_FREERUN : +case ZL_DPLL_MODE_REFSEL_MODE_HOLDOVER : +if (state ==DPLL_PIN_STATE_CONNECTED ) { +/* Choose the pin as new selected reference */ + new_ref =zl3073x_input_pin_ref_get (pin->id); + }else if (state ==DPLL_PIN_STATE_DISCONNECTED ) { +/* No reference */ + new_ref =ZL3073X_DPLL_REF_NONE ; + }else { +NL_SET_ERR_MSG_MOD (extack, +"Invalid pin state for manual mode" ); +return -EINVAL ; + } + + rc =zl3073x_dpll_selected_ref_set (zldpll, new_ref); +break ; +default : +/* In other modes we cannot change input reference */ +NL_SET_ERR_MSG (extack, +"Pin state cannot be changed in current mode" ); + rc = -EOPNOTSUPP ; +break ; + } + +return rc; +} + static int zl3073x_dpll_output_pin_state_on_dpll_get(const struct dpll_pin *dpll_pin, void *pin_priv,
@@ -358,6 +475,7 @@ zl3073x_dpll_mode_get(const struct dpll_device *dpll, void *dpll_priv,static const struct dpll_pin_ops zl3073x_dpll_input_pin_ops = { .direction_get = zl3073x_dpll_pin_direction_get, .state_on_dpll_get = zl3073x_dpll_input_pin_state_on_dpll_get, + .state_on_dpll_set = zl3073x_dpll_input_pin_state_on_dpll_set, };static const struct dpll_pin_ops zl3073x_dpll_output_pin_ops = {
drivers/dpll/zl3073x/prop.c +6 -3
@@ -201,11 +201,14 @@ struct zl3073x_pin_props *zl3073x_pin_props_get(struct zl3073x_dev *zldev,if (!props)return ERR_PTR (-ENOMEM ); -/* Set default pin type */ -if (dir ==DPLL_PIN_DIRECTION_INPUT ) +/* Set default pin type and capabilities */ +if (dir ==DPLL_PIN_DIRECTION_INPUT ) { props->dpll_props.type =DPLL_PIN_TYPE_EXT ; -else + props->dpll_props.capabilities = +DPLL_PIN_CAPABILITIES_STATE_CAN_CHANGE ; + }else { props->dpll_props.type =DPLL_PIN_TYPE_GNSS ; + } props->dpll_props.phase_range.min =S32_MIN ; props->dpll_props.phase_range.max =S32_MAX ;
Signature · 1 line
2.49.0
Ivan Vecera
maintainerPATCH v11 11/14 dpll: zl3073x: Add support to get/set priority on input pins
In reply to Ivan VeceraAdd support for getting and setting input pin priority. Implement required callbacks and set appropriate capability for input pins. Although the pin priority make sense only if the DPLL is running in automatic mode we have to expose this capability unconditionally because input pins (references) are shared between all DPLLs where one of them can run in automatic mode while the other one not.
--- drivers/dpll/zl3073x/dpll.c | 88 +++++++++++++++++++++++++++++++++++++ drivers/dpll/zl3073x/prop.c | 1 + 2 files changed, 89 insertions(+)
drivers/dpll/zl3073x/dpll.c +88 -0
@@ -287,6 +287,56 @@ zl3073x_dpll_ref_prio_get(struct zl3073x_dpll_pin *pin, u8 *prio)return rc; } +/** +* zl3073x_dpll_ref_prio_set - set priority for given input pin +* @pin: pointer to pin +* @prio: place to store priority +* +* Sets priority for the given input pin. +* +* Return: 0 on success, <0 on error +*/ +static int +zl3073x_dpll_ref_prio_set (struct zl3073x_dpll_pin *pin,u8 prio) +{ +struct zl3073x_dpll *zldpll = pin->dpll; +struct zl3073x_dev *zldev = zldpll->dev; +u8 ref, ref_prio; +int rc; + +guard (mutex)(&zldev->multiop_lock); + +/* Read DPLL configuration into mailbox */ + rc =zl3073x_mb_op (zldev,ZL_REG_DPLL_MB_SEM ,ZL_DPLL_MB_SEM_RD , +ZL_REG_DPLL_MB_MASK ,BIT (zldpll->id)); +if (rc) +return rc; + +/* Read reference priority - one value shared between P&N pins */ + ref =zl3073x_input_pin_ref_get (pin->id); + rc =zl3073x_read_u8 (zldev,ZL_REG_DPLL_REF_PRIO (ref /2 ), &ref_prio); +if (rc) +return rc; + +/* Update nibble according pin type */ +if (zl3073x_dpll_is_p_pin (pin)) { + ref_prio &= ~ZL_DPLL_REF_PRIO_REF_P ; + ref_prio |=FIELD_PREP (ZL_DPLL_REF_PRIO_REF_P , prio); + }else { + ref_prio &= ~ZL_DPLL_REF_PRIO_REF_N ; + ref_prio |=FIELD_PREP (ZL_DPLL_REF_PRIO_REF_N , prio); + } + +/* Update reference priority */ + rc =zl3073x_write_u8 (zldev,ZL_REG_DPLL_REF_PRIO (ref /2 ), ref_prio); +if (rc) +return rc; + +/* Commit configuration */ +return zl3073x_mb_op (zldev,ZL_REG_DPLL_MB_SEM ,ZL_DPLL_MB_SEM_WR , +ZL_REG_DPLL_MB_MASK ,BIT (zldpll->id)); +} +/** * zl3073x_dpll_ref_state_get - get status for given input pin * @pin: pointer to pin
@@ -400,6 +450,42 @@ zl3073x_dpll_input_pin_state_on_dpll_set(const struct dpll_pin *dpll_pin,return rc; } +static int +zl3073x_dpll_input_pin_prio_get (const struct dpll_pin *dpll_pin,void *pin_priv, +const struct dpll_device *dpll,void *dpll_priv, +u32 *prio,struct netlink_ext_ack *extack) +{ +struct zl3073x_dpll_pin *pin = pin_priv; + + *prio = pin->prio; + +return 0 ; +} + +static int +zl3073x_dpll_input_pin_prio_set (const struct dpll_pin *dpll_pin,void *pin_priv, +const struct dpll_device *dpll,void *dpll_priv, +u32 prio,struct netlink_ext_ack *extack) +{ +struct zl3073x_dpll_pin *pin = pin_priv; +int rc; + +if (prio >ZL_DPLL_REF_PRIO_MAX ) +return -EINVAL ; + +/* If the pin is selectable then update HW registers */ +if (pin->selectable) { + rc =zl3073x_dpll_ref_prio_set (pin, prio); +if (rc) +return rc; + } + +/* Save priority */ + pin->prio = prio; + +return 0 ; +} + static int zl3073x_dpll_output_pin_state_on_dpll_get(const struct dpll_pin *dpll_pin, void *pin_priv,
@@ -474,6 +560,8 @@ zl3073x_dpll_mode_get(const struct dpll_device *dpll, void *dpll_priv,static const struct dpll_pin_ops zl3073x_dpll_input_pin_ops = { .direction_get = zl3073x_dpll_pin_direction_get, + .prio_get = zl3073x_dpll_input_pin_prio_get, + .prio_set = zl3073x_dpll_input_pin_prio_set, .state_on_dpll_get = zl3073x_dpll_input_pin_state_on_dpll_get, .state_on_dpll_set = zl3073x_dpll_input_pin_state_on_dpll_set, };
drivers/dpll/zl3073x/prop.c +1 -0
@@ -205,6 +205,7 @@ struct zl3073x_pin_props *zl3073x_pin_props_get(struct zl3073x_dev *zldev,if (dir ==DPLL_PIN_DIRECTION_INPUT ) { props->dpll_props.type =DPLL_PIN_TYPE_EXT ; props->dpll_props.capabilities = +DPLL_PIN_CAPABILITIES_PRIORITY_CAN_CHANGE |DPLL_PIN_CAPABILITIES_STATE_CAN_CHANGE ; }else { props->dpll_props.type =DPLL_PIN_TYPE_GNSS ;
Signature · 1 line
2.49.0
Ivan Vecera
maintainerPATCH v11 12/14 dpll: zl3073x: Implement input pin state setting in automatic mode
In reply to Ivan VeceraImplement input pin state setting when the DPLL is running in automatic mode. Unlike manual mode, the DPLL mode switching is not used here and the implementation uses special priority value (15) to make the given pin non-selectable.
When the user sets state of the pin as disconnected the driver internally sets its priority in HW to 15 that prevents the DPLL to choose this input pin. Conversely, if the pin status is set to selectable, the driver sets the pin priority in HW to the original saved value.
--- drivers/dpll/zl3073x/dpll.c | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+)
drivers/dpll/zl3073x/dpll.c +32 -0
@@ -439,6 +439,38 @@ zl3073x_dpll_input_pin_state_on_dpll_set(const struct dpll_pin *dpll_pin, rc =zl3073x_dpll_selected_ref_set (zldpll, new_ref);break ; + +case ZL_DPLL_MODE_REFSEL_MODE_AUTO : +if (state ==DPLL_PIN_STATE_SELECTABLE ) { +if (pin->selectable) +return 0 ;/* Pin is already selectable */ + +/* Restore pin priority in HW */ + rc =zl3073x_dpll_ref_prio_set (pin, pin->prio); +if (rc) +return rc; + +/* Mark pin as selectable */ + pin->selectable = true; + }else if (state ==DPLL_PIN_STATE_DISCONNECTED ) { +if (!pin->selectable) +return 0 ;/* Pin is already disconnected */ + +/* Set pin priority to none in HW */ + rc =zl3073x_dpll_ref_prio_set (pin, +ZL_DPLL_REF_PRIO_NONE ); +if (rc) +return rc; + +/* Mark pin as non-selectable */ + pin->selectable = false; + }else { +NL_SET_ERR_MSG (extack, +"Invalid pin state for automatic mode" ); +return -EINVAL ; + } +break ; +default :/* In other modes we cannot change input reference */ NL_SET_ERR_MSG(extack,
Signature · 1 line
2.49.0
Ivan Vecera
maintainerPATCH v11 13/14 dpll: zl3073x: Add support to get/set frequency on input pins
In reply to Ivan VeceraAdd support to get/set frequency on input pins. The frequency for input pins (references) is computed in the device according this formula:
freq = base_freq * multiplier * (nominator / denominator)
where the base_freq comes from the list of supported base frequencies and other parameters are arbitrary numbers. All these parameters are 16-bit unsigned integers.
--- drivers/dpll/zl3073x/dpll.c | 124 ++++++++++++++++++++++++++++++++++++ drivers/dpll/zl3073x/regs.h | 5 ++ 2 files changed, 129 insertions(+)
drivers/dpll/zl3073x/dpll.c +124 -0
@@ -8,6 +8,7 @@#include <linux/dpll.h> #include <linux/err.h> #include <linux/kthread.h> +#include <linux/math64.h> #include <linux/mod_devicetable.h> #include <linux/module.h> #include <linux/netlink.h>
@@ -84,6 +85,127 @@ zl3073x_dpll_pin_direction_get(const struct dpll_pin *dpll_pin, void *pin_priv,return 0 ; } +/** +* zl3073x_dpll_input_ref_frequency_get - get input reference frequency +* @zldpll: pointer to zl3073x_dpll +* @ref_id: reference id +* @frequency: pointer to variable to store frequency +* +* Reads frequency of given input reference. +* +* Return: 0 on success, <0 on error +*/ +static int +zl3073x_dpll_input_ref_frequency_get (struct zl3073x_dpll *zldpll,u8 ref_id, +u32 *frequency) +{ +struct zl3073x_dev *zldev = zldpll->dev; +u16 base, mult, num, denom; +int rc; + +guard (mutex)(&zldev->multiop_lock); + +/* Read reference configuration */ + rc =zl3073x_mb_op (zldev,ZL_REG_REF_MB_SEM ,ZL_REF_MB_SEM_RD , +ZL_REG_REF_MB_MASK ,BIT (ref_id)); +if (rc) +return rc; + +/* Read registers to compute resulting frequency */ + rc =zl3073x_read_u16 (zldev,ZL_REG_REF_FREQ_BASE , &base); +if (rc) +return rc; + rc =zl3073x_read_u16 (zldev,ZL_REG_REF_FREQ_MULT , &mult); +if (rc) +return rc; + rc =zl3073x_read_u16 (zldev,ZL_REG_REF_RATIO_M , &num); +if (rc) +return rc; + rc =zl3073x_read_u16 (zldev,ZL_REG_REF_RATIO_N , &denom); +if (rc) +return rc; + +/* Sanity check that HW has not returned zero denominator */ +if (!denom) { +dev_err (zldev->dev, +"Zero divisor for ref %u frequency got from device\n" , + ref_id); +return -EINVAL ; + } + +/* Compute the frequency */ + *frequency = base * mult * num / denom; + +return rc; +} + +static int +zl3073x_dpll_input_pin_frequency_get (const struct dpll_pin *dpll_pin, +void *pin_priv, +const struct dpll_device *dpll, +void *dpll_priv,u64 *frequency, +struct netlink_ext_ack *extack) +{ +struct zl3073x_dpll *zldpll = dpll_priv; +struct zl3073x_dpll_pin *pin = pin_priv; +u32 ref_freq; +u8 ref; +int rc; + +/* Read and return ref frequency */ + ref =zl3073x_input_pin_ref_get (pin->id); + rc =zl3073x_dpll_input_ref_frequency_get (zldpll, ref, &ref_freq); +if (!rc) + *frequency = ref_freq; + +return rc; +} + +static int +zl3073x_dpll_input_pin_frequency_set (const struct dpll_pin *dpll_pin, +void *pin_priv, +const struct dpll_device *dpll, +void *dpll_priv,u64 frequency, +struct netlink_ext_ack *extack) +{ +struct zl3073x_dpll *zldpll = dpll_priv; +struct zl3073x_dev *zldev = zldpll->dev; +struct zl3073x_dpll_pin *pin = pin_priv; +u16 base, mult; +u8 ref; +int rc; + +/* Get base frequency and multiplier for the requested frequency */ + rc =zl3073x_ref_freq_factorize (frequency, &base, &mult); +if (rc) +return rc; + +guard (mutex)(&zldev->multiop_lock); + +/* Load reference configuration */ + ref =zl3073x_input_pin_ref_get (pin->id); + rc =zl3073x_mb_op (zldev,ZL_REG_REF_MB_SEM ,ZL_REF_MB_SEM_RD , +ZL_REG_REF_MB_MASK ,BIT (ref)); + +/* Update base frequency, multiplier, numerator & denominator */ + rc =zl3073x_write_u16 (zldev,ZL_REG_REF_FREQ_BASE , base); +if (rc) +return rc; + rc =zl3073x_write_u16 (zldev,ZL_REG_REF_FREQ_MULT , mult); +if (rc) +return rc; + rc =zl3073x_write_u16 (zldev,ZL_REG_REF_RATIO_M ,1 ); +if (rc) +return rc; + rc =zl3073x_write_u16 (zldev,ZL_REG_REF_RATIO_N ,1 ); +if (rc) +return rc; + +/* Commit reference configuration */ +return zl3073x_mb_op (zldev,ZL_REG_REF_MB_SEM ,ZL_REF_MB_SEM_WR , +ZL_REG_REF_MB_MASK ,BIT (ref)); +} +/** * zl3073x_dpll_selected_ref_get - get currently selected reference * @zldpll: pointer to zl3073x_dpll
@@ -592,6 +714,8 @@ zl3073x_dpll_mode_get(const struct dpll_device *dpll, void *dpll_priv,static const struct dpll_pin_ops zl3073x_dpll_input_pin_ops = { .direction_get = zl3073x_dpll_pin_direction_get, + .frequency_get = zl3073x_dpll_input_pin_frequency_get, + .frequency_set = zl3073x_dpll_input_pin_frequency_set, .prio_get = zl3073x_dpll_input_pin_prio_get, .prio_set = zl3073x_dpll_input_pin_prio_set, .state_on_dpll_get = zl3073x_dpll_input_pin_state_on_dpll_get,
drivers/dpll/zl3073x/regs.h +5 -0
@@ -135,6 +135,11 @@#define ZL_REF_MB_SEM_WR BIT(0)#define ZL_REF_MB_SEM_RD BIT(1) +#define ZL_REG_REF_FREQ_BASE ZL_REG(10, 0x05, 2) +#define ZL_REG_REF_FREQ_MULT ZL_REG(10, 0x07, 2) +#define ZL_REG_REF_RATIO_M ZL_REG(10, 0x09, 2) +#define ZL_REG_REF_RATIO_N ZL_REG(10, 0x0b, 2) +#define ZL_REG_REF_CONFIG ZL_REG(10, 0x0d, 1)#define ZL_REF_CONFIG_ENABLE BIT(0)#define ZL_REF_CONFIG_DIFF_EN BIT(2)
Signature · 1 line
2.49.0
Paolo Abeni
maintainerRe: [PATCH net-next v11 13/14] dpll: zl3073x: Add support to get/set frequency on input pins
Quoted 40 lines · Ivan Vecera
drivers/dpll/zl3073x/dpll.c +40
-0+/** +* zl3073x_dpll_input_ref_frequency_get - get input reference frequency +* @zldpll: pointer to zl3073x_dpll +* @ref_id: reference id +* @frequency: pointer to variable to store frequency +* +* Reads frequency of given input reference. +* +* Return: 0 on success, <0 on error +*/ +static int +zl3073x_dpll_input_ref_frequency_get (struct zl3073x_dpll *zldpll,u8 ref_id, +u32 *frequency) +{ +struct zl3073x_dev *zldev = zldpll->dev; +u16 base, mult, num, denom; +int rc; + +guard (mutex)(&zldev->multiop_lock); + +/* Read reference configuration */ + rc =zl3073x_mb_op (zldev,ZL_REG_REF_MB_SEM ,ZL_REF_MB_SEM_RD , +ZL_REG_REF_MB_MASK ,BIT (ref_id)); +if (rc) +return rc; + +/* Read registers to compute resulting frequency */ + rc =zl3073x_read_u16 (zldev,ZL_REG_REF_FREQ_BASE , &base); +if (rc) +return rc; + rc =zl3073x_read_u16 (zldev,ZL_REG_REF_FREQ_MULT , &mult); +if (rc) +return rc; + rc =zl3073x_read_u16 (zldev,ZL_REG_REF_RATIO_M , &num); +if (rc) +return rc; + rc =zl3073x_read_u16 (zldev,ZL_REG_REF_RATIO_N , &denom); +if (rc) +return rc; +
drivers/dpll/zl3073x/dpll.c zl3073x_dpll_pin_direction_get(const struct dpll_pin *dpll_pin, void *pin_priv, · line 137
Quoted 10 lines
drivers/dpll/zl3073x/dpll.c +10
-0+/* Sanity check that HW has not returned zero denominator */ +if (!denom) { +dev_err (zldev->dev, +"Zero divisor for ref %u frequency got from device\n" , + ref_id); +return -EINVAL ; + } + +/* Compute the frequency */ + *frequency = base * mult * num / denom;
As base, mult, num and denom are u16, the above looks like integer overflow prone.
I think you should explicitly cast to u64, and possibly use a u64 frequency.
/P
Vadim Fedorenko
maintainerRe: [PATCH net-next v11 13/14] dpll: zl3073x: Add support to get/set frequency on input pins
Quoted 55 lines · Paolo Abeni
Quoted 40 lines · Ivan Vecera
drivers/dpll/zl3073x/dpll.c +40
-0+/** +* zl3073x_dpll_input_ref_frequency_get - get input reference frequency +* @zldpll: pointer to zl3073x_dpll +* @ref_id: reference id +* @frequency: pointer to variable to store frequency +* +* Reads frequency of given input reference. +* +* Return: 0 on success, <0 on error +*/ +static int +zl3073x_dpll_input_ref_frequency_get (struct zl3073x_dpll *zldpll,u8 ref_id, +u32 *frequency) +{ +struct zl3073x_dev *zldev = zldpll->dev; +u16 base, mult, num, denom; +int rc; + +guard (mutex)(&zldev->multiop_lock); + +/* Read reference configuration */ + rc =zl3073x_mb_op (zldev,ZL_REG_REF_MB_SEM ,ZL_REF_MB_SEM_RD , +ZL_REG_REF_MB_MASK ,BIT (ref_id)); +if (rc) +return rc; + +/* Read registers to compute resulting frequency */ + rc =zl3073x_read_u16 (zldev,ZL_REG_REF_FREQ_BASE , &base); +if (rc) +return rc; + rc =zl3073x_read_u16 (zldev,ZL_REG_REF_FREQ_MULT , &mult); +if (rc) +return rc; + rc =zl3073x_read_u16 (zldev,ZL_REG_REF_RATIO_M , &num); +if (rc) +return rc; + rc =zl3073x_read_u16 (zldev,ZL_REG_REF_RATIO_N , &denom); +if (rc) +return rc; +drivers/dpll/zl3073x/dpll.c zl3073x_dpll_pin_direction_get(const struct dpll_pin *dpll_pin, void *pin_priv, · line 137
Quoted 10 lines
drivers/dpll/zl3073x/dpll.c +10
-0+/* Sanity check that HW has not returned zero denominator */ +if (!denom) { +dev_err (zldev->dev, +"Zero divisor for ref %u frequency got from device\n" , + ref_id); +return -EINVAL ; + } + +/* Compute the frequency */ + *frequency = base * mult * num / denom;As base, mult, num and denom are u16, the above looks like integer overflow prone.
Quoted 1 line
I think you should explicitly cast to u64, and possibly use a u64 frequency.
I might be a good idea to use mul_u64_u32_div together with mul_u32_u32? These macroses will take care of overflow on 32bit platforms as well.
Quoted 3 lines
/P
Paolo Abeni
maintainerRe: [PATCH net-next v11 13/14] dpll: zl3073x: Add support to get/set frequency on input pins
Quoted 56 lines · Vadim Fedorenko
Quoted 55 lines · Paolo Abeni
Quoted 40 lines · Ivan Vecera
drivers/dpll/zl3073x/dpll.c +40
-0+/** +* zl3073x_dpll_input_ref_frequency_get - get input reference frequency +* @zldpll: pointer to zl3073x_dpll +* @ref_id: reference id +* @frequency: pointer to variable to store frequency +* +* Reads frequency of given input reference. +* +* Return: 0 on success, <0 on error +*/ +static int +zl3073x_dpll_input_ref_frequency_get (struct zl3073x_dpll *zldpll,u8 ref_id, +u32 *frequency) +{ +struct zl3073x_dev *zldev = zldpll->dev; +u16 base, mult, num, denom; +int rc; + +guard (mutex)(&zldev->multiop_lock); + +/* Read reference configuration */ + rc =zl3073x_mb_op (zldev,ZL_REG_REF_MB_SEM ,ZL_REF_MB_SEM_RD , +ZL_REG_REF_MB_MASK ,BIT (ref_id)); +if (rc) +return rc; + +/* Read registers to compute resulting frequency */ + rc =zl3073x_read_u16 (zldev,ZL_REG_REF_FREQ_BASE , &base); +if (rc) +return rc; + rc =zl3073x_read_u16 (zldev,ZL_REG_REF_FREQ_MULT , &mult); +if (rc) +return rc; + rc =zl3073x_read_u16 (zldev,ZL_REG_REF_RATIO_M , &num); +if (rc) +return rc; + rc =zl3073x_read_u16 (zldev,ZL_REG_REF_RATIO_N , &denom); +if (rc) +return rc; +drivers/dpll/zl3073x/dpll.c zl3073x_dpll_pin_direction_get(const struct dpll_pin *dpll_pin, void *pin_priv, · line 137
Quoted 10 lines
drivers/dpll/zl3073x/dpll.c +10
-0+/* Sanity check that HW has not returned zero denominator */ +if (!denom) { +dev_err (zldev->dev, +"Zero divisor for ref %u frequency got from device\n" , + ref_id); +return -EINVAL ; + } + +/* Compute the frequency */ + *frequency = base * mult * num / denom;As base, mult, num and denom are u16, the above looks like integer overflow prone.
Quoted 4 lines
Quoted 1 line
I think you should explicitly cast to u64, and possibly use a u64 frequency.
I might be a good idea to use
mul_u64_u32_divtogether withmul_u32_u32? These macroses will take care of overflow on 32bit platforms as well.
I guess such macros will work, but u64 is available on 32bits platform as well - and possibly simpler/more readable.
/P
Ivan Vecera
maintainerRe: [PATCH net-next v11 13/14] dpll: zl3073x: Add support to get/set frequency on input pins
In reply to Vadim FedorenkoQuoted 57 lines · Vadim Fedorenko
Quoted 56 lines · Paolo Abeni
Quoted 41 lines · Ivan Vecera
drivers/dpll/zl3073x/dpll.c +12
-0+/** +* zl3073x_dpll_input_ref_frequency_get - get input reference frequency +* @zldpll: pointer to zl3073x_dpll +* @ref_id: reference id +* @frequency: pointer to variable to store frequency +* +* Reads frequency of given input reference. +* +* Return: 0 on success, <0 on error +*/ +static int +zl3073x_dpll_input_ref_frequency_get(struct zl3073x_dpll *zldpll, u8
ref_id,
+ u32 *frequency)drivers/dpll/zl3073x/dpll.c +27
-0+{ + struct zl3073x_dev *zldev = zldpll->dev; + u16 base, mult, num, denom; + int rc; + + guard(mutex)(&zldev->multiop_lock); + + /* Read reference configuration */ + rc = zl3073x_mb_op(zldev, ZL_REG_REF_MB_SEM, ZL_REF_MB_SEM_RD, + ZL_REG_REF_MB_MASK, BIT(ref_id)); + if (rc) + return rc; + + /* Read registers to compute resulting frequency */ + rc = zl3073x_read_u16(zldev, ZL_REG_REF_FREQ_BASE, &base); + if (rc) + return rc; + rc = zl3073x_read_u16(zldev, ZL_REG_REF_FREQ_MULT, &mult); + if (rc) + return rc; + rc = zl3073x_read_u16(zldev, ZL_REG_REF_RATIO_M, &num); + if (rc) + return rc; + rc = zl3073x_read_u16(zldev, ZL_REG_REF_RATIO_N, &denom); + if (rc) + return rc; +drivers/dpll/zl3073x/dpll.c zl3073x_dpll_pin_direction_get(const struct dpll_pin *dpll_pin, void *pin_priv, · line 137
Quoted 10 lines
drivers/dpll/zl3073x/dpll.c +10
-0+ /* Sanity check that HW has not returned zero denominator */ + if (!denom) { + dev_err(zldev->dev, + "Zero divisor for ref %u frequency got from device\n", + ref_id); + return -EINVAL; + } + + /* Compute the frequency */ + *frequency = base * mult * num / denom;As base, mult, num and denom are u16, the above looks like integer overflow prone.
Quoted 4 lines
Quoted 1 line
I think you should explicitly cast to u64, and possibly use a u64 frequency.
I might be a good idea to use
mul_u64_u32_divtogether withmul_u32_u32? These macroses will take care of overflow on 32bit platforms as well.
Will fix
Thanks for tip.
Ivan
Quoted 5 lines
Quoted 4 lines
/P
Ivan Vecera
maintainerPATCH v11 14/14 dpll: zl3073x: Add support to get/set frequency on output pins
In reply to Ivan VeceraAdd support to get/set frequencies on output pins. The frequency for output pin is determined by the frequency of synthesizer the output pin is connected to and divisor of the output to which is the given pin belongs. The resulting frequency of the P-pin and the N-pin from this output pair depends on the signal format of this output pair.
The device supports so-called N-divided signal formats where for the N-pin there is an additional divisor. The frequencies for both pins from such output pair are computed:
P-pin-freq = synth_freq / output_div
N-pin-freq = synth_freq / output_div / n_div
For other signal-format types both P and N pin have the same frequency based only synth frequency and output divisor.
Implement output pin callbacks to get and set frequency. The frequency setting for the output non-N-divided signal format is simple as we have to compute just new output divisor. For N-divided formats it is more complex because by changing of output divisor we change frequency for both P and N pins. In this case if we are changing frequency for P-pin we have to compute also new N-divisor for N-pin to keep its current frequency. From this and the above it follows that the frequency of the N-pin cannot be higher than the frequency of the P-pin and the callback must take this limitation into account.
--- drivers/dpll/zl3073x/dpll.c | 234 ++++++++++++++++++++++++++++++++++++ drivers/dpll/zl3073x/regs.h | 5 + 2 files changed, 239 insertions(+)
drivers/dpll/zl3073x/dpll.c +234 -0
@@ -640,6 +640,238 @@ zl3073x_dpll_input_pin_prio_set(const struct dpll_pin *dpll_pin, void *pin_priv,return 0 ; } +static int +zl3073x_dpll_output_pin_frequency_get (const struct dpll_pin *dpll_pin, +void *pin_priv, +const struct dpll_device *dpll, +void *dpll_priv,u64 *frequency, +struct netlink_ext_ack *extack) +{ +struct zl3073x_dpll *zldpll = dpll_priv; +struct zl3073x_dev *zldev = zldpll->dev; +struct zl3073x_dpll_pin *pin = pin_priv; +struct device *dev = zldev->dev; +u8 out, signal_format, synth; +u32 output_div, synth_freq; +int rc; + + out =zl3073x_output_pin_out_get (pin->id); + synth =zl3073x_out_synth_get (zldev, out); + synth_freq =zl3073x_synth_freq_get (zldev, synth); + +guard (mutex)(&zldev->multiop_lock); + +/* Read output configuration into mailbox */ + rc =zl3073x_mb_op (zldev,ZL_REG_OUTPUT_MB_SEM ,ZL_OUTPUT_MB_SEM_RD , +ZL_REG_OUTPUT_MB_MASK ,BIT (out)); +if (rc) +return rc; + + rc =zl3073x_read_u32 (zldev,ZL_REG_OUTPUT_DIV , &output_div); +if (rc) +return rc; + +/* Check output divisor for zero */ +if (!output_div) { +dev_err (dev,"Zero divisor for output %u got from device\n" , + out); +return -EINVAL ; + } + +/* Read used signal format for the given output */ + signal_format =zl3073x_out_signal_format_get (zldev, out); + +switch (signal_format) { +case ZL_OUTPUT_MODE_SIGNAL_FORMAT_2_NDIV : +case ZL_OUTPUT_MODE_SIGNAL_FORMAT_2_NDIV_INV : +/* In case of divided format we have to distiguish between +* given output pin type. +*/ +if (zl3073x_dpll_is_p_pin (pin)) { +/* For P-pin the resulting frequency is computed as +* simple division of synth frequency and output +* divisor. +*/ + *frequency = synth_freq / output_div; + }else { +/* For N-pin we have to divide additionally by +* divisor stored in esync_period output mailbox +* register that is used as N-pin divisor for these +* modes. +*/ +u32 ndiv; + + rc =zl3073x_read_u32 (zldev,ZL_REG_OUTPUT_ESYNC_PERIOD , + &ndiv); +if (rc) +return rc; + +/* Check N-pin divisor for zero */ +if (!ndiv) { +dev_err (dev, +"Zero N-pin divisor for output %u got from device\n" , + out); +return -EINVAL ; + } + +/* Compute final divisor for N-pin */ + *frequency = synth_freq / output_div / ndiv; + } +break ; +default : +/* In other modes the resulting frequency is computed as +* division of synth frequency and output divisor. +*/ + *frequency = synth_freq / output_div; +break ; + } + +return rc; +} + +static int +zl3073x_dpll_output_pin_frequency_set (const struct dpll_pin *dpll_pin, +void *pin_priv, +const struct dpll_device *dpll, +void *dpll_priv,u64 frequency, +struct netlink_ext_ack *extack) +{ +struct zl3073x_dpll *zldpll = dpll_priv; +struct zl3073x_dev *zldev = zldpll->dev; +struct zl3073x_dpll_pin *pin = pin_priv; +struct device *dev = zldev->dev; +u32 output_n_freq, output_p_freq; +u8 out, signal_format, synth; +u32 cur_div, new_div, ndiv; +u32 synth_freq; +int rc; + + out =zl3073x_output_pin_out_get (pin->id); + synth =zl3073x_out_synth_get (zldev, out); + synth_freq =zl3073x_synth_freq_get (zldev, synth); + +/* Check the requested frequency divides synth frequency without +* remainder. +*/ +if (synth_freq % (u32 )frequency) { +dev_err (dev,"The requested frequency must divide %u Hz\n" , + synth_freq); +return -EINVAL ; + } + new_div = synth_freq / (u32 )frequency; + +/* Get used signal format for the given output */ + signal_format =zl3073x_out_signal_format_get (zldev, out); + +guard (mutex)(&zldev->multiop_lock); + +/* Load output configuration */ + rc =zl3073x_mb_op (zldev,ZL_REG_OUTPUT_MB_SEM ,ZL_OUTPUT_MB_SEM_RD , +ZL_REG_OUTPUT_MB_MASK ,BIT (out)); +if (rc) +return rc; + +/* Check signal format */ +if (signal_format !=ZL_OUTPUT_MODE_SIGNAL_FORMAT_2_NDIV && + signal_format !=ZL_OUTPUT_MODE_SIGNAL_FORMAT_2_NDIV_INV ) { +/* For non N-divided signal formats the frequency is computed +* as division of synth frequency and output divisor. +*/ + rc =zl3073x_write_u32 (zldev,ZL_REG_OUTPUT_DIV , new_div); +if (rc) +return rc; + +/* For 50/50 duty cycle the divisor is equal to width */ + rc =zl3073x_write_u32 (zldev,ZL_REG_OUTPUT_WIDTH , new_div); +if (rc) +return rc; + +/* Commit output configuration */ +return zl3073x_mb_op (zldev, +ZL_REG_OUTPUT_MB_SEM ,ZL_OUTPUT_MB_SEM_WR , +ZL_REG_OUTPUT_MB_MASK ,BIT (out)); + } + +/* For N-divided signal format get current divisor */ + rc =zl3073x_read_u32 (zldev,ZL_REG_OUTPUT_DIV , &cur_div); +if (rc) +return rc; + +/* Check output divisor for zero */ +if (!cur_div) { +dev_err (dev,"Zero divisor for output %u got from device\n" , + out); +return -EINVAL ; + } + +/* Get N-pin divisor (shares the same register with esync */ + rc =zl3073x_read_u32 (zldev,ZL_REG_OUTPUT_ESYNC_PERIOD , &ndiv); +if (rc) +return rc; + +/* Check N-pin divisor for zero */ +if (!ndiv) { +dev_err (dev, +"Zero N-pin divisor for output %u got from device\n" , + out); +return -EINVAL ; + } + +/* Compute current output frequency for P-pin */ + output_p_freq = synth_freq / cur_div; + +/* Compute current N-pin frequency */ + output_n_freq = output_p_freq / ndiv; + +if (zl3073x_dpll_is_p_pin (pin)) { +/* We are going to change output frequency for P-pin but +* if the requested frequency is less than current N-pin +* frequency then indicate a failure as we are not able +* to compute N-pin divisor to keep its frequency unchanged. +*/ +if (frequency <= output_n_freq) +return -EINVAL ; + +/* Update the output divisor */ + rc =zl3073x_write_u32 (zldev,ZL_REG_OUTPUT_DIV , new_div); +if (rc) +return rc; + +/* For 50/50 duty cycle the divisor is equal to width */ + rc =zl3073x_write_u32 (zldev,ZL_REG_OUTPUT_WIDTH , new_div); +if (rc) +return rc; + +/* Compute new divisor for N-pin */ + ndiv = (u32 )frequency / output_n_freq; + }else { +/* We are going to change frequency of N-pin but if +* the requested freq is greater or equal than freq of P-pin +* in the output pair we cannot compute divisor for the N-pin. +* In this case indicate a failure. +*/ +if (output_p_freq <= frequency) +return -EINVAL ; + +/* Compute new divisor for N-pin */ + ndiv = output_p_freq / (u32 )frequency; + } + +/* Update divisor for the N-pin */ + rc =zl3073x_write_u32 (zldev,ZL_REG_OUTPUT_ESYNC_PERIOD , ndiv); +if (rc) +return rc; + +/* For 50/50 duty cycle the divisor is equal to width */ + rc =zl3073x_write_u32 (zldev,ZL_REG_OUTPUT_ESYNC_WIDTH , ndiv); +if (rc) +return rc; + +/* Commit output configuration */ +return zl3073x_mb_op (zldev,ZL_REG_OUTPUT_MB_SEM ,ZL_OUTPUT_MB_SEM_WR , +ZL_REG_OUTPUT_MB_MASK ,BIT (out)); +} + static int zl3073x_dpll_output_pin_state_on_dpll_get(const struct dpll_pin *dpll_pin, void *pin_priv,
@@ -724,6 +956,8 @@ static const struct dpll_pin_ops zl3073x_dpll_input_pin_ops = {static const struct dpll_pin_ops zl3073x_dpll_output_pin_ops = { .direction_get = zl3073x_dpll_pin_direction_get, + .frequency_get = zl3073x_dpll_output_pin_frequency_get, + .frequency_set = zl3073x_dpll_output_pin_frequency_set, .state_on_dpll_get = zl3073x_dpll_output_pin_state_on_dpll_get, };
drivers/dpll/zl3073x/regs.h +5 -0
@@ -198,4 +198,9 @@#define ZL_OUTPUT_MODE_SIGNAL_FORMAT_2_NDIV 12#define ZL_OUTPUT_MODE_SIGNAL_FORMAT_2_NDIV_INV 15 +#define ZL_REG_OUTPUT_DIV ZL_REG(14, 0x0c, 4) +#define ZL_REG_OUTPUT_WIDTH ZL_REG(14, 0x10, 4) +#define ZL_REG_OUTPUT_ESYNC_PERIOD ZL_REG(14, 0x14, 4) +#define ZL_REG_OUTPUT_ESYNC_WIDTH ZL_REG(14, 0x18, 4) +#endif /* _ZL3073X_REGS_H */
Signature · 1 line
2.49.0
Paolo Abeni
maintainerRe: [PATCH net-next v11 14/14] dpll: zl3073x: Add support to get/set frequency on output pins
Quoted 15 lines · Ivan Vecera
drivers/dpll/zl3073x/dpll.c +15
-0+static int +zl3073x_dpll_output_pin_frequency_set (const struct dpll_pin *dpll_pin, +void *pin_priv, +const struct dpll_device *dpll, +void *dpll_priv,u64 frequency, +struct netlink_ext_ack *extack) +{ +struct zl3073x_dpll *zldpll = dpll_priv; +struct zl3073x_dev *zldev = zldpll->dev; +struct zl3073x_dpll_pin *pin = pin_priv; +struct device *dev = zldev->dev; +u32 output_n_freq, output_p_freq; +u8 out, signal_format, synth; +u32 cur_div, new_div, ndiv; +u32 synth_freq;
drivers/dpll/zl3073x/dpll.c zl3073x_dpll_input_pin_prio_set(const struct dpll_pin *dpll_pin, void *pin_priv, · line 756
Quoted 10 lines
drivers/dpll/zl3073x/dpll.c +10
-0+int rc; + + out =zl3073x_output_pin_out_get (pin->id); + synth =zl3073x_out_synth_get (zldev, out); + synth_freq =zl3073x_synth_freq_get (zldev, synth); + +/* Check the requested frequency divides synth frequency without +* remainder. +*/ +if (synth_freq % (u32 )frequency) {
As the frequency comes from user-space and is validated only the DT info, which in turn is AFAICS imported verbatim into the kernel, I *think* it would be safer to check for 0 here or at DT info load time.
/P
Ivan Vecera
maintainerRe: [PATCH net-next v11 14/14] dpll: zl3073x: Add support to get/set frequency on output pins
Quoted 22 lines · Paolo Abeni
Quoted 21 lines · Ivan Vecera
drivers/dpll/zl3073x/dpll.c +21
-0+static int +zl3073x_dpll_output_pin_frequency_set (const struct dpll_pin *dpll_pin, +void *pin_priv, +const struct dpll_device *dpll, +void *dpll_priv,u64 frequency, +struct netlink_ext_ack *extack) +{ +struct zl3073x_dpll *zldpll = dpll_priv; +struct zl3073x_dev *zldev = zldpll->dev; +struct zl3073x_dpll_pin *pin = pin_priv; +struct device *dev = zldev->dev; +u32 output_n_freq, output_p_freq; +u8 out, signal_format, synth; +u32 cur_div, new_div, ndiv; +u32 synth_freq; +int rc; + + out =zl3073x_output_pin_out_get (pin->id); + synth =zl3073x_out_synth_get (zldev, out); + synth_freq =zl3073x_synth_freq_get (zldev, synth); +
Quoted 8 lines
drivers/dpll/zl3073x/dpll.c zl3073x_dpll_input_pin_prio_set(const struct dpll_pin *dpll_pin, void *pin_priv, · line 756
Quoted 4 lines
drivers/dpll/zl3073x/dpll.c +4
-0+/* Check the requested frequency divides synth frequency without +* remainder. +*/ +if (synth_freq % (u32 )frequency) {As the frequency comes from user-space and is validated only the DT info, which in turn is AFAICS imported verbatim into the kernel, I *think* it would be safer to check for 0 here or at DT info load time.
This check is superfluous, the frequency from user-space is validated in DPLL core against frequency list provided for particular pin by the driver. And frequencies from DT are filtered/checked during load. So no check is needed here.
Will fix.
Ivan