dpll: zl3073x: add chip-specific minimum input reference frequency
Subsystems (4)
Ivan Vecera
maintainerPATCH 1/1 dpll: zl3073x: add chip-specific minimum input reference frequency
Commit 24e4aff8983fe6 ("dpll: zl3073x: recognize the ZL30643 chip ID (0x0E3B)") added support for the ZL30643, a ZL3064x line-card variant that is register-compatible with ZL3073x. However, ZL3064x chips require a minimum input reference frequency of 1 kHz, not 1 Hz like other ZL3073x parts.
Add a min_ref_freq field to zl3073x_chip_info and validate it in both the DT property parser and the ref-sync pair configuration to prevent configuring unsupported frequencies on ZL3064x parts.
--- drivers/dpll/zl3073x/core.c | 43 +++++++++++++++++++------------------ drivers/dpll/zl3073x/core.h | 2 ++ drivers/dpll/zl3073x/dpll.c | 10 +++++---- drivers/dpll/zl3073x/prop.c | 10 ++++++--- 4 files changed, 37 insertions(+), 28 deletions(-)
drivers/dpll/zl3073x/core.c +22 -21
@@ -20,29 +20,30 @@#include "dpll.h" #include "regs.h" -#define ZL_CHIP_INFO (_id, _nchannels, _flags) \ - { .id = (_id), .num_channels = (_nchannels), .flags = (_flags) } +#define ZL_CHIP_INFO (_id, _nchannels, _flags, _min_freq) \ + { .id = (_id), .num_channels = (_nchannels), .flags = (_flags), \ + .min_ref_freq = (_min_freq) }static const struct zl3073x_chip_info zl3073x_chip_ids[] = { -ZL_CHIP_INFO (0x0E30 ,2 ,ZL3073X_FLAG_REF_PHASE_COMP_32 ), -ZL_CHIP_INFO (0x0E3B ,3 ,ZL3073X_FLAG_REF_PHASE_COMP_32 ), -ZL_CHIP_INFO (0x0E93 ,1 ,ZL3073X_FLAG_REF_PHASE_COMP_32 ), -ZL_CHIP_INFO (0x0E94 ,2 ,ZL3073X_FLAG_REF_PHASE_COMP_32 ), -ZL_CHIP_INFO (0x0E95 ,3 ,ZL3073X_FLAG_REF_PHASE_COMP_32 ), -ZL_CHIP_INFO (0x0E96 ,4 ,ZL3073X_FLAG_REF_PHASE_COMP_32 ), -ZL_CHIP_INFO (0x0E97 ,5 ,ZL3073X_FLAG_REF_PHASE_COMP_32 ), -ZL_CHIP_INFO (0x1E93 ,1 ,ZL3073X_FLAG_DIE_TEMP ), -ZL_CHIP_INFO (0x1E94 ,2 ,ZL3073X_FLAG_DIE_TEMP ), -ZL_CHIP_INFO (0x1E95 ,3 ,ZL3073X_FLAG_DIE_TEMP ), -ZL_CHIP_INFO (0x1E96 ,4 ,ZL3073X_FLAG_DIE_TEMP ), -ZL_CHIP_INFO (0x1E97 ,5 ,ZL3073X_FLAG_DIE_TEMP ), -ZL_CHIP_INFO (0x1F60 ,2 ,ZL3073X_FLAG_REF_PHASE_COMP_32 ), -ZL_CHIP_INFO (0x2E93 ,1 ,ZL3073X_FLAG_DIE_TEMP ), -ZL_CHIP_INFO (0x2E94 ,2 ,ZL3073X_FLAG_DIE_TEMP ), -ZL_CHIP_INFO (0x2E95 ,3 ,ZL3073X_FLAG_DIE_TEMP ), -ZL_CHIP_INFO (0x2E96 ,4 ,ZL3073X_FLAG_DIE_TEMP ), -ZL_CHIP_INFO (0x2E97 ,5 ,ZL3073X_FLAG_DIE_TEMP ), -ZL_CHIP_INFO (0x3FC4 ,2 ,ZL3073X_FLAG_DIE_TEMP ), +ZL_CHIP_INFO (0x0E30 ,2 ,ZL3073X_FLAG_REF_PHASE_COMP_32 ,1 ), +ZL_CHIP_INFO (0x0E3B ,3 ,ZL3073X_FLAG_REF_PHASE_COMP_32 ,1000 ), +ZL_CHIP_INFO (0x0E93 ,1 ,ZL3073X_FLAG_REF_PHASE_COMP_32 ,1 ), +ZL_CHIP_INFO (0x0E94 ,2 ,ZL3073X_FLAG_REF_PHASE_COMP_32 ,1 ), +ZL_CHIP_INFO (0x0E95 ,3 ,ZL3073X_FLAG_REF_PHASE_COMP_32 ,1 ), +ZL_CHIP_INFO (0x0E96 ,4 ,ZL3073X_FLAG_REF_PHASE_COMP_32 ,1 ), +ZL_CHIP_INFO (0x0E97 ,5 ,ZL3073X_FLAG_REF_PHASE_COMP_32 ,1 ), +ZL_CHIP_INFO (0x1E93 ,1 ,ZL3073X_FLAG_DIE_TEMP ,1 ), +ZL_CHIP_INFO (0x1E94 ,2 ,ZL3073X_FLAG_DIE_TEMP ,1 ), +ZL_CHIP_INFO (0x1E95 ,3 ,ZL3073X_FLAG_DIE_TEMP ,1 ), +ZL_CHIP_INFO (0x1E96 ,4 ,ZL3073X_FLAG_DIE_TEMP ,1 ), +ZL_CHIP_INFO (0x1E97 ,5 ,ZL3073X_FLAG_DIE_TEMP ,1 ), +ZL_CHIP_INFO (0x1F60 ,2 ,ZL3073X_FLAG_REF_PHASE_COMP_32 ,1 ), +ZL_CHIP_INFO (0x2E93 ,1 ,ZL3073X_FLAG_DIE_TEMP ,1 ), +ZL_CHIP_INFO (0x2E94 ,2 ,ZL3073X_FLAG_DIE_TEMP ,1 ), +ZL_CHIP_INFO (0x2E95 ,3 ,ZL3073X_FLAG_DIE_TEMP ,1 ), +ZL_CHIP_INFO (0x2E96 ,4 ,ZL3073X_FLAG_DIE_TEMP ,1 ), +ZL_CHIP_INFO (0x2E97 ,5 ,ZL3073X_FLAG_DIE_TEMP ,1 ), +ZL_CHIP_INFO (0x3FC4 ,2 ,ZL3073X_FLAG_DIE_TEMP ,1 ), };#define ZL_RANGE_OFFSET 0x80
drivers/dpll/zl3073x/core.h +2 -0
@@ -42,11 +42,13 @@ enum zl3073x_flags {* @id: chip ID * @num_channels: number of DPLL channels supported by this variant * @flags: chip variant flags +* @min_ref_freq: minimum input reference frequency in Hz */ struct zl3073x_chip_info {u16 id;u8 num_channels;unsigned long flags; +u32 min_ref_freq; };/**
drivers/dpll/zl3073x/dpll.c +6 -4
@@ -281,7 +281,8 @@ zl3073x_dpll_input_pin_ref_sync_set(const struct dpll_pin *dpll_pin, sync_freq =zl3073x_ref_freq_get (sync_ref);/* Sync signal must be 8 kHz or less and clock reference -* must be 1 kHz or more and higher than the sync signal. +* must meet the chip's minimum frequency requirement and be +* higher than the sync signal. */ if (sync_freq >8000 ) { NL_SET_ERR_MSG(extack,
@@ -289,9 +290,10 @@ zl3073x_dpll_input_pin_ref_sync_set(const struct dpll_pin *dpll_pin, rc = -EINVAL ; goto unlock; } -if (ref_freq <1000 ) { -NL_SET_ERR_MSG (extack, -"clock frequency must be 1 kHz or more" ); +if (ref_freq < zldev->info->min_ref_freq) { +NL_SET_ERR_MSG_FMT (extack, +"clock frequency must be %u Hz or more" , + zldev->info->min_ref_freq); rc = -EINVAL ; goto unlock; }
drivers/dpll/zl3073x/prop.c +7 -3
@@ -20,9 +20,9 @@* @freq: frequency to check * * The function checks the given frequency is valid for the device. For input -* pins it checks that the frequency can be factorized using supported base -* frequencies. For output pins it checks that the frequency divides connected -* synth frequency without remainder. +* pins it checks that the frequency is above the chip's minimum and can be +* factorized using supported base frequencies. For output pins it checks that +* the frequency divides connected synth frequency without remainder. * * Return: true if the frequency is valid, false if not. */
@@ -36,6 +36,10 @@ zl3073x_pin_check_freq(struct zl3073x_dev *zldev, enum dpll_pin_direction dir,if (dir ==DPLL_PIN_DIRECTION_INPUT ) {int rc; +/* Check minimum frequency */ +if (freq < zldev->info->min_ref_freq) + goto err_inv_freq; +/* Check if the frequency can be factorized */ rc =zl3073x_ref_freq_factorize (freq,NULL ,NULL );if (rc)
base-commit: 4f93b12cf7b25fbf8e73d222722805b049f0a6d3
Signature · 1 line
2.54.0
Quoted 149 lines · Ivan Vecera
Commit
24e4aff8983fe6("dpll: zl3073x: recognize the ZL30643 chip ID (0x0E3B)") added support for the ZL30643, a ZL3064x line-card variant that is register-compatible with ZL3073x. However, ZL3064x chips require a minimum input reference frequency of 1 kHz, not 1 Hz like other ZL3073x parts.Add a
min_ref_freqfield tozl3073x_chip_infoand validate it in both the DT property parser and the ref-sync pair configuration to prevent configuring unsupported frequencies on ZL3064x parts.Signed-off-by Ivan Vecera <[email protected]>--- drivers/dpll/zl3073x/core.c | 43 +++++++++++++++++++------------------ drivers/dpll/zl3073x/core.h | 2 ++ drivers/dpll/zl3073x/dpll.c | 10 +++++---- drivers/dpll/zl3073x/prop.c | 10 ++++++--- 4 files changed, 37 insertions(+), 28 deletions(-)drivers/dpll/zl3073x/core.c +22
-21@@ -20,29 +20,30 @@#include "dpll.h" #include "regs.h" -#define ZL_CHIP_INFO (_id, _nchannels, _flags) \ - { .id = (_id), .num_channels = (_nchannels), .flags = (_flags) } +#define ZL_CHIP_INFO (_id, _nchannels, _flags, _min_freq) \ + { .id = (_id), .num_channels = (_nchannels), .flags = (_flags), \ + .min_ref_freq = (_min_freq) }static const struct zl3073x_chip_info zl3073x_chip_ids[] = { -ZL_CHIP_INFO (0x0E30 ,2 ,ZL3073X_FLAG_REF_PHASE_COMP_32 ), -ZL_CHIP_INFO (0x0E3B ,3 ,ZL3073X_FLAG_REF_PHASE_COMP_32 ), -ZL_CHIP_INFO (0x0E93 ,1 ,ZL3073X_FLAG_REF_PHASE_COMP_32 ), -ZL_CHIP_INFO (0x0E94 ,2 ,ZL3073X_FLAG_REF_PHASE_COMP_32 ), -ZL_CHIP_INFO (0x0E95 ,3 ,ZL3073X_FLAG_REF_PHASE_COMP_32 ), -ZL_CHIP_INFO (0x0E96 ,4 ,ZL3073X_FLAG_REF_PHASE_COMP_32 ), -ZL_CHIP_INFO (0x0E97 ,5 ,ZL3073X_FLAG_REF_PHASE_COMP_32 ), -ZL_CHIP_INFO (0x1E93 ,1 ,ZL3073X_FLAG_DIE_TEMP ), -ZL_CHIP_INFO (0x1E94 ,2 ,ZL3073X_FLAG_DIE_TEMP ), -ZL_CHIP_INFO (0x1E95 ,3 ,ZL3073X_FLAG_DIE_TEMP ), -ZL_CHIP_INFO (0x1E96 ,4 ,ZL3073X_FLAG_DIE_TEMP ), -ZL_CHIP_INFO (0x1E97 ,5 ,ZL3073X_FLAG_DIE_TEMP ), -ZL_CHIP_INFO (0x1F60 ,2 ,ZL3073X_FLAG_REF_PHASE_COMP_32 ), -ZL_CHIP_INFO (0x2E93 ,1 ,ZL3073X_FLAG_DIE_TEMP ), -ZL_CHIP_INFO (0x2E94 ,2 ,ZL3073X_FLAG_DIE_TEMP ), -ZL_CHIP_INFO (0x2E95 ,3 ,ZL3073X_FLAG_DIE_TEMP ), -ZL_CHIP_INFO (0x2E96 ,4 ,ZL3073X_FLAG_DIE_TEMP ), -ZL_CHIP_INFO (0x2E97 ,5 ,ZL3073X_FLAG_DIE_TEMP ), -ZL_CHIP_INFO (0x3FC4 ,2 ,ZL3073X_FLAG_DIE_TEMP ), +ZL_CHIP_INFO (0x0E30 ,2 ,ZL3073X_FLAG_REF_PHASE_COMP_32 ,1 ), +ZL_CHIP_INFO (0x0E3B ,3 ,ZL3073X_FLAG_REF_PHASE_COMP_32 ,1000 ), +ZL_CHIP_INFO (0x0E93 ,1 ,ZL3073X_FLAG_REF_PHASE_COMP_32 ,1 ), +ZL_CHIP_INFO (0x0E94 ,2 ,ZL3073X_FLAG_REF_PHASE_COMP_32 ,1 ), +ZL_CHIP_INFO (0x0E95 ,3 ,ZL3073X_FLAG_REF_PHASE_COMP_32 ,1 ), +ZL_CHIP_INFO (0x0E96 ,4 ,ZL3073X_FLAG_REF_PHASE_COMP_32 ,1 ), +ZL_CHIP_INFO (0x0E97 ,5 ,ZL3073X_FLAG_REF_PHASE_COMP_32 ,1 ), +ZL_CHIP_INFO (0x1E93 ,1 ,ZL3073X_FLAG_DIE_TEMP ,1 ), +ZL_CHIP_INFO (0x1E94 ,2 ,ZL3073X_FLAG_DIE_TEMP ,1 ), +ZL_CHIP_INFO (0x1E95 ,3 ,ZL3073X_FLAG_DIE_TEMP ,1 ), +ZL_CHIP_INFO (0x1E96 ,4 ,ZL3073X_FLAG_DIE_TEMP ,1 ), +ZL_CHIP_INFO (0x1E97 ,5 ,ZL3073X_FLAG_DIE_TEMP ,1 ), +ZL_CHIP_INFO (0x1F60 ,2 ,ZL3073X_FLAG_REF_PHASE_COMP_32 ,1 ), +ZL_CHIP_INFO (0x2E93 ,1 ,ZL3073X_FLAG_DIE_TEMP ,1 ), +ZL_CHIP_INFO (0x2E94 ,2 ,ZL3073X_FLAG_DIE_TEMP ,1 ), +ZL_CHIP_INFO (0x2E95 ,3 ,ZL3073X_FLAG_DIE_TEMP ,1 ), +ZL_CHIP_INFO (0x2E96 ,4 ,ZL3073X_FLAG_DIE_TEMP ,1 ), +ZL_CHIP_INFO (0x2E97 ,5 ,ZL3073X_FLAG_DIE_TEMP ,1 ), +ZL_CHIP_INFO (0x3FC4 ,2 ,ZL3073X_FLAG_DIE_TEMP ,1 ), };#define ZL_RANGE_OFFSET 0x80drivers/dpll/zl3073x/core.h +2
-0@@ -42,11 +42,13 @@ enum zl3073x_flags {* @id: chip ID * @num_channels: number of DPLL channels supported by this variant * @flags: chip variant flags +* @min_ref_freq: minimum input reference frequency in Hz */ struct zl3073x_chip_info {u16 id;u8 num_channels;unsigned long flags; +u32 min_ref_freq; };/** drivers/dpll/zl3073x/dpll.c +6
-4@@ -281,7 +281,8 @@ zl3073x_dpll_input_pin_ref_sync_set(const struct dpll_pin *dpll_pin, sync_freq =zl3073x_ref_freq_get (sync_ref);/* Sync signal must be 8 kHz or less and clock reference -* must be 1 kHz or more and higher than the sync signal. +* must meet the chip's minimum frequency requirement and be +* higher than the sync signal. */ if (sync_freq >8000 ) { NL_SET_ERR_MSG(extack,@@ -289,9 +290,10 @@ zl3073x_dpll_input_pin_ref_sync_set(const struct dpll_pin *dpll_pin, rc = -EINVAL ; goto unlock; } -if (ref_freq <1000 ) { -NL_SET_ERR_MSG (extack, -"clock frequency must be 1 kHz or more" ); +if (ref_freq < zldev->info->min_ref_freq) { +NL_SET_ERR_MSG_FMT (extack, +"clock frequency must be %u Hz or more" , + zldev->info->min_ref_freq); rc = -EINVAL ; goto unlock; }drivers/dpll/zl3073x/prop.c +7
-3@@ -20,9 +20,9 @@* @freq: frequency to check * * The function checks the given frequency is valid for the device. For input -* pins it checks that the frequency can be factorized using supported base -* frequencies. For output pins it checks that the frequency divides connected -* synth frequency without remainder. +* pins it checks that the frequency is above the chip's minimum and can be +* factorized using supported base frequencies. For output pins it checks that +* the frequency divides connected synth frequency without remainder. * * Return: true if the frequency is valid, false if not. */ @@ -36,6 +36,10 @@ zl3073x_pin_check_freq(struct zl3073x_dev *zldev, enum dpll_pin_direction dir,if (dir ==DPLL_PIN_DIRECTION_INPUT ) {int rc; +/* Check minimum frequency */ +if (freq < zldev->info->min_ref_freq) + goto err_inv_freq; +/* Check if the frequency can be factorized */ rc =zl3073x_ref_freq_factorize (freq,NULL ,NULL );if (rc)
Quoted 1 line
base-commit:
4f93b12cf7b25fbf8e73d222722805b049f0a6d3
LGTM,
Hi Ivan,
Thanks for leading it. Below some few minor comments.
drivers/dpll/zl3073x/core.c line 25
Quoted 13 lines
drivers/dpll/zl3073x/core.c +3
-2@@ -20,29 +20,30 @@#include "dpll.h" #include "regs.h" -#define ZL_CHIP_INFO (_id, _nchannels, _flags) \ - { .id = (_id), .num_channels = (_nchannels), .flags = (_flags) } +#define ZL_CHIP_INFO (_id, _nchannels, _flags, _min_freq) \ + { .id = (_id), .num_channels = (_nchannels), .flags = (_flags), \ + .min_ref_freq = (_min_freq) }
Do we really need this C macro ? Everytime we'll add something, it leads to a wide numbder of line changes for zl3073x_chip_ids[]. What's about using directly the named fields below and leaving 0/nothing for default cases such as the min_ref_freq ( something like min_ref_freq ?: 1; ) ?
... return zldev->info->min_ref_freq ?: 1; ...
If you prefer to keep the C macro, then let's use a variadic, something like:
#define ZL_CHIP_INFO(_id, _nchannels, _flags, ...) \
{ .id = (_id), .num_channels = (_nchannels), .flags = (_flags),\
##__VA_ARGS__ }then only the ZL30643 entry needs to be touched:
ZL_CHIP_INFO(0x0E3B, 3, ZL3073X_FLAG_REF_PHASE_COMP_32, .min_ref_freq = 1000),
Quoted 4 lines
drivers/dpll/zl3073x/core.c +0
-2static const struct zl3073x_chip_info zl3073x_chip_ids[] = { -ZL_CHIP_INFO (0x0E30 ,2 ,ZL3073X_FLAG_REF_PHASE_COMP_32 ), -ZL_CHIP_INFO (0x0E3B ,3 ,ZL3073X_FLAG_REF_PHASE_COMP_32 ),
...
Quoted 5 lines
drivers/dpll/zl3073x/core.c +3
-2-ZL_CHIP_INFO (0x2E97 ,5 ,ZL3073X_FLAG_DIE_TEMP ), - ZL_CHIP_INFO(0x3FC4, 2, ZL3073X_FLAG_DIE_TEMP), +ZL_CHIP_INFO (0x0E30 ,2 ,ZL3073X_FLAG_REF_PHASE_COMP_32 ,1 ), +ZL_CHIP_INFO (0x0E3B ,3 ,ZL3073X_FLAG_REF_PHASE_COMP_32 ,1000 ), + ZL_CHIP_INFO(0x0E93, 1, ZL3073X_FLAG_REF_PHASE_COMP_32, 1),
...
drivers/dpll/zl3073x/core.c line 46
Quoted 2 lines
drivers/dpll/zl3073x/core.c +2
-0+ZL_CHIP_INFO (0x2E97 ,5 ,ZL3073X_FLAG_DIE_TEMP ,1 ), + ZL_CHIP_INFO(0x3FC4, 2, ZL3073X_FLAG_DIE_TEMP, 1),
That's a wide set of changes just to add/update 1 line. Since an update is needed, I feel the macro should be avoided so only
ZL_CHIP_INFO(0x0E3B, 3, ZL3073X_FLAG_REF_PHASE_COMP_32, 1000),
is needed.
Then, the init code could set to 1 if the value of .min_ref_freq is 0.
Quoted 16 lines
drivers/dpll/zl3073x/dpll.c +2
-1@@ -281,7 +281,8 @@ zl3073x_dpll_input_pin_ref_sync_set(const struct dpll_pin *dpll_pin, sync_freq =zl3073x_ref_freq_get (sync_ref);/* Sync signal must be 8 kHz or less and clock reference -* must be 1 kHz or more and higher than the sync signal. +* must meet the chip's minimum frequency requirement and be +* higher than the sync signal. */ if (sync_freq >8000 ) { NL_SET_ERR_MSG(extack,@@ -289,9 +290,10 @@ zl3073x_dpll_input_pin_ref_sync_set(const struct dpll_pin *dpll_pin, rc = -EINVAL ; goto unlock; }
drivers/dpll/zl3073x/dpll.c zl3073x_dpll_input_pin_ref_sync_set(const struct dpll_pin *dpll_pin, · line 299
Quoted 10 lines
drivers/dpll/zl3073x/dpll.c +4
-3-if (ref_freq <1000 ) { -NL_SET_ERR_MSG (extack, -"clock frequency must be 1 kHz or more" ); +if (ref_freq < zldev->info->min_ref_freq) { +NL_SET_ERR_MSG_FMT (extack, +"clock frequency must be %u Hz or more" , + zldev->info->min_ref_freq); rc = -EINVAL ; goto unlock; }
TBC: to be considered if 0 means 1 (à la zldev->info->min_ref_freq ?: 1)
Quoted 18 lines
drivers/dpll/zl3073x/prop.c +3
-3@@ -20,9 +20,9 @@* @freq: frequency to check * * The function checks the given frequency is valid for the device. For input -* pins it checks that the frequency can be factorized using supported base -* frequencies. For output pins it checks that the frequency divides connected -* synth frequency without remainder. +* pins it checks that the frequency is above the chip's minimum and can be +* factorized using supported base frequencies. For output pins it checks that +* the frequency divides connected synth frequency without remainder. * * Return: true if the frequency is valid, false if not. */
drivers/dpll/zl3073x/prop.c zl3073x_pin_check_freq(struct zl3073x_dev *zldev, enum dpll_pin_direction dir, · line 39
Quoted 4 lines
drivers/dpll/zl3073x/prop.c +1
-0@@ -36,6 +36,10 @@ zl3073x_pin_check_freq(struct zl3073x_dev *zldev, enum dpll_pin_direction dir,if (dir ==DPLL_PIN_DIRECTION_INPUT ) {int rc; +/* Check minimum frequency */
This comment is not needed, the code tells us.
drivers/dpll/zl3073x/prop.c zl3073x_pin_check_freq(struct zl3073x_dev *zldev, enum dpll_pin_direction dir, · line 45
Quoted 7 lines
drivers/dpll/zl3073x/prop.c +3
-0+if (freq < zldev->info->min_ref_freq) + goto err_inv_freq; +/* Check if the frequency can be factorized */ rc =zl3073x_ref_freq_factorize (freq,NULL ,NULL );if (rc)
Best regards,
Vincent