| lists.openwall.net | lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC | |
|
Open Source and information security mailing list archives
| ||
|
Date: Thu, 11 Feb 2021 20:08:14 -0800
From: Stephen Boyd <sboyd@...nel.org>
To: liambeguin@...il.com, mturquette@...libre.com
Cc: linux-clk@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [RFC PATCH v1 1/1] clk: add initial support for the lmk04832
Quoting Liam Beguin (2020-12-14 16:44:20)
> From: Liam Beguin <lvb@...hos.com>
>
> The LMK04832 is an ultra-high performance clock conditioner with JEDEC
> JESD204B support and is also pin compatible with the LMK0482x family of
> devices.
>
> Signed-off-by: Liam Beguin <lvb@...hos.com>
> ---
> .../devicetree/bindings/clock/ti,lmk04832.txt | 90 ++
> drivers/clk/Kconfig | 7 +
> drivers/clk/Makefile | 1 +
> drivers/clk/clk-lmk04832.c | 1357 +++++++++++++++++
> 4 files changed, 1455 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/clock/ti,lmk04832.txt
> create mode 100644 drivers/clk/clk-lmk04832.c
>
> diff --git a/Documentation/devicetree/bindings/clock/ti,lmk04832.txt b/Documentation/devicetree/bindings/clock/ti,lmk04832.txt
> new file mode 100644
> index 000000000000..debe51765bf3
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/clock/ti,lmk04832.txt
> @@ -0,0 +1,90 @@
> +* Texas Instruments LMK04832 JESD204B Compliant Clock Jitter Cleaner
Please send a yaml document. It will get reviewed that way. Also Cc
devicetree@...r.kernel.org and robh+dt@...nel.org
> +
> +Required properties:
> + - compatible: Must be "ti,lmk04832"
> + - reg: SPI chip select for the device
> + - spi-max-frequency: should be lower that 5MHz
> + - #clock-cells: should be 1
> + - clock-names: list of input clock names: "oscin"
> diff --git a/drivers/clk/clk-lmk04832.c b/drivers/clk/clk-lmk04832.c
> new file mode 100644
> index 000000000000..0938f49d8ab8
> --- /dev/null
> +++ b/drivers/clk/clk-lmk04832.c
> @@ -0,0 +1,1357 @@
> +/*
> + * LMK04832 Ultra Low-Noise JESD204B Compliant Clock Jitter Cleaner
> + * Pin compatible with the LMK0482x family
> + *
Is there a link to the datasheet pdf that can be put here?
> + * Copyright (c) 2020, Xiphos Systems Corp.
> + *
> + */
> +#include <linux/bitfield.h>
> +#include <linux/clk.h>
> +#include <linux/clk-provider.h>
> +#include <linux/debugfs.h>
> +#include <linux/device.h>
> +#include <linux/gcd.h>
> +#include <linux/gpio/consumer.h>
> +#include <linux/module.h>
> +#include <linux/uaccess.h>
> +#include <linux/regmap.h>
> +#include <linux/spi/spi.h>
> +
> +/* 0x000 - 0x00d System Functions */
> +#define LMK04832_REG_RST3W 0x000
> +#define LMK04832_BIT_RESET BIT(7)
> +#define LMK04832_BIT_SPI_3WIRE_DIS BIT(4)
> +#define LMK04832_REG_POWERDOWN 0x002
> +#define LMK04832_REG_ID_DEV_TYPE 0x003
> +#define LMK04832_REG_ID_PROD_MSB 0x004
> +#define LMK04832_REG_ID_PROD_LSB 0x005
> +#define LMK04832_REG_ID_MASKREV 0x006
> +#define LMK04832_REG_ID_VNDR_MSB 0x00c
> +#define LMK04832_REG_ID_VNDR_LSB 0x00d
> +
> +/* 0x100 - 0x137 Device Clock and SYSREF Clock Output Control */
> +#define LMK04832_REG_DCLK_DIV_LSB(ch) (0x100 + (ch >> 1) * 8)
> +#define LMK04832_REG_CLKOUT_CTRL0(ch) (0x102 + (ch >> 1) * 8)
> +#define LMK04832_BIT_CLKOUTX_Y_PD BIT(7)
> +#define LMK04832_BIT_DCLK_DIV_MSB GENMASK(1, 0)
> +#define LMK04832_REG_CLKOUT_SRC_MUX(ch) (0x103 + (ch % 2) + (ch >> 1) * 8)
> +#define LMK04832_BIT_CLKOUT_SRC_MUX BIT(5)
> +#define LMK04832_REG_CLKOUT_CTRL1(ch) (0x103 + (ch >> 1) * 8)
> +#define LMK04832_BIT_DCLK_PD BIT(4)
> +#define LMK04832_REG_CLKOUT_CTRL2(ch) (0x104 + (ch >> 1) * 8)
> +#define LMK04832_BIT_SCLK_PD BIT(4)
> +#define LMK04832_REG_CLKOUT_FMT(ch) (0x107 + (ch >> 1) * 8)
> +#define LMK04832_BIT_CLKOUT_FMT(ch) (ch % 2 ? 0xf0 : 0x0f)
> +#define LMK04832_VAL_CLKOUT_FMT_POWERDOWN 0x00
> +#define LMK04832_VAL_CLKOUT_FMT_LVDS 0x01
> +#define LMK04832_VAL_CLKOUT_FMT_HSDS6 0x02
> +#define LMK04832_VAL_CLKOUT_FMT_HSDS8 0x03
> +#define LMK04832_VAL_CLKOUT_FMT_LVPECL1600 0x04
> +#define LMK04832_VAL_CLKOUT_FMT_LVPECL2000 0x05
> +#define LMK04832_VAL_CLKOUT_FMT_LCPECL 0x06
> +#define LMK04832_VAL_CLKOUT_FMT_CML16 0x07
> +#define LMK04832_VAL_CLKOUT_FMT_CML24 0x08
> +#define LMK04832_VAL_CLKOUT_FMT_CML32 0x09
> +#define LMK04832_VAL_CLKOUT_FMT_CMOS_OFF_INV 0x0a
> +#define LMK04832_VAL_CLKOUT_FMT_CMOS_NOR_OFF 0x0b
> +#define LMK04832_VAL_CLKOUT_FMT_CMOS_INV_INV 0x0c
> +#define LMK04832_VAL_CLKOUT_FMT_CMOS_INV_NOR 0x0d
> +#define LMK04832_VAL_CLKOUT_FMT_CMOS_NOR_INV 0x0e
> +#define LMK04832_VAL_CLKOUT_FMT_CMOS_NOR_NOR 0x0f
> +
> +/* 0x138 - 0x145 SYSREF, SYNC, and Device Config */
> +#define LMK04832_REG_VCO_OSCOUT 0x138
> +#define LMK04832_BIT_VCO_MUX GENMASK(6, 5)
> +#define LMK04832_VAL_VCO_MUX_VCO0 0x00
> +#define LMK04832_VAL_VCO_MUX_VCO1 0x01
> +#define LMK04832_VAL_VCO_MUX_EXT 0x02
> +#define LMK04832_REG_SYSREF_OUT 0x139
> +#define LMK04832_BIT_SYSREF_MUX GENMASK(1, 0)
> +#define LMK04832_VAL_SYSREF_MUX_CONTINUOUS 0x03
> +#define LMK04832_REG_SYSREF_DIV_MSB 0x13a
> +#define LMK04832_BIT_SYSREF_DIV_MSB GENMASK(4, 0)
> +#define LMK04832_REG_SYSREF_DIV_LSB 0x13b
> +#define LMK04832_REG_FB_CTRL 0x13f
> +#define LMK04832_BIT_PLL2_RCLK_MUX BIT(7)
> +#define LMK04832_VAL_PLL2_RCLK_MUX_OSCIN 0x00
> +#define LMK04832_VAL_PLL2_RCLK_MUX_CLKIN 0x01
> +#define LMK04832_BIT_PLL2_NCLK_MUX BIT(5)
> +#define LMK04832_VAL_PLL2_NCLK_MUX_PLL2_P 0x00
> +#define LMK04832_VAL_PLL2_NCLK_MUX_FB_MUX 0x01
> +#define LMK04832_BIT_FB_MUX_EN BIT(0)
> +#define LMK04832_REG_MAIN_PD 0x140
> +#define LMK04832_BIT_PLL1_PD BIT(7)
> +#define LMK04832_BIT_VCO_LDO_PD BIT(6)
> +#define LMK04832_BIT_VCO_PD BIT(5)
> +#define LMK04832_BIT_OSCIN_PD BIT(4)
> +#define LMK04832_BIT_SYSREF_GBL_PD BIT(3)
> +#define LMK04832_BIT_SYSREF_PD BIT(2)
> +#define LMK04832_BIT_SYSREF_DDLY_PD BIT(1)
> +#define LMK04832_BIT_SYSREF_PLSR_PD BIT(0)
> +#define LMK04832_REG_SYNC 0x143
> +#define LMK04832_BIT_SYNC_EN BIT(4)
> +#define LMK04832_REG_SYNC_DIS 0x144
> +
> +/* 0x146 - 0x14a CLKin Control */
> +#define LMK04832_REG_CLKIN_SEL0 0x148
> +#define LMK04832_REG_CLKIN_SEL1 0x149
> +#define LMK04832_REG_CLKIN_RST 0x14a
> +#define LMK04832_BIT_SDIO_RDBK_TYPE BIT(6)
> +#define LMK04832_BIT_CLKIN_SEL_MUX GENMASK(5, 3)
> +#define LMK04832_VAL_CLKIN_SEL_MUX_SPI_RDBK 0x06
> +#define LMK04832_BIT_CLKIN_SEL_TYPE GENMASK(2, 0)
> +#define LMK04832_VAL_CLKIN_SEL_TYPE_OUT 0x03
> +
> +/* 0x14b - 0x152 Holdover */
> +
> +/* 0x153 - 0x15f PLL1 Configuration */
> +
> +/* 0x160 - 0x16e PLL2 Configuration */
> +#define LMK04832_REG_PLL2_R_MSB 0x160
> +#define LMK04832_BIT_PLL2_R_MSB GENMASK(3, 0)
> +#define LMK04832_REG_PLL2_R_LSB 0x161
> +#define LMK04832_REG_PLL2_MISC 0x162
> +#define LMK04832_BIT_PLL2_MISC_P GENMASK(7, 5)
> +#define LMK04832_BIT_PLL2_MISC_REF_2X_EN BIT(0)
> +#define LMK04832_REG_PLL2_N_CAL_0 0x163
> +#define LMK04832_BIT_PLL2_N_CAL_0 GENMASK(1, 0)
> +#define LMK04832_REG_PLL2_N_CAL_1 0x164
> +#define LMK04832_REG_PLL2_N_CAL_2 0x165
> +#define LMK04832_REG_PLL2_N_0 0x166
> +#define LMK04832_BIT_PLL2_N_0 GENMASK(1, 0)
> +#define LMK04832_REG_PLL2_N_1 0x167
> +#define LMK04832_REG_PLL2_N_2 0x168
> +#define LMK04832_REG_PLL2_DLD_CNT_LSB 0x16b
> +#define LMK04832_REG_PLL2_LD 0x16e
> +#define LMK04832_BIT_PLL2_LD_MUX GENMASK(7, 3)
> +#define LMK04832_VAL_PLL2_LD_MUX_PLL2_DLD 0x02
> +#define LMK04832_BIT_PLL2_LD_TYPE GENMASK(2, 0)
> +#define LMK04832_VAL_PLL2_LD_TYPE_OUT_PP 0x03
> +
> +/* 0x16F - 0x555 Misc Registers */
> +#define LMK04832_REG_PLL2_PD 0x173
> +#define LMK04832_BIT_PLL2_PRE_PD BIT(6)
> +#define LMK04832_BIT_PLL2_PD BIT(5)
> +#define LMK04832_REG_PLL1R_RST 0x177
> +#define LMK04832_REG_CLR_PLL_LOST 0x182
> +#define LMK04832_REG_RB_PLL_LD 0x183
> +#define LMK04832_REG_RB_CLK_DAC_VAL_MSB 0x184
> +#define LMK04832_REG_RB_DAC_VAL_LSB 0x185
> +#define LMK04832_REG_RB_HOLDOVER 0x188
> +#define LMK04832_REG_SPI_LOCK 0x555
> +
> +enum lmk04832_device_types {
Is the plan to add more in the future? Can't we add this when that
happens?
> + LMK04832,
> +};
> +
> +/**
> + * lmk04832_device_info - Holds static device information that is specific to
> + * the chip revision
> + *
> + * pid: Product Identifier
> + * maskrev: IC version identifier
> + * num_channels: Number of available output channels (clkout count)
> + * vco0_range: {min, max} of the VCO0 operating range (in MHz)
> + * vco1_range: {min, max} of the VCO1 operating range (in MHz)
> + */
> +struct lmk04832_device_info {
> + uint16_t pid;
u16
> + uint8_t maskrev;
u8
> + unsigned int num_channels;
size_t?
> + unsigned int vco0_range[2];
> + unsigned int vco1_range[2];
> +};
> +
> +struct lmk04832_device_info lmk04832_device_info[] = {
> + [LMK04832] = {
> + .pid = 0x63d1, /* WARNING PROD_ID is inverted in the datasheet */
> + .maskrev = 0x70,
> + .num_channels = 14,
> + .vco0_range = { 2440, 2580 },
> + .vco1_range = { 2945, 3255 },
> + },
> +};
> +
> +enum lmk04832_rdbk_type {
> + RDBK_CLKIN_SEL0,
> + RDBK_CLKIN_SEL1,
> + RDBK_RESET,
> +};
> +
> +struct lmk_dclk {
> + struct lmk04832 *lmk;
> + struct clk_hw hw;
> + uint8_t id;
> +};
> +
> +struct lmk_clkout {
> + struct lmk04832 *lmk;
> + struct clk_hw hw;
> + uint32_t format;
u32
> + bool sysref;
> + uint8_t id;
u8
> +};
> +
> +/**
> + * struct lmk04832 - The LMK04832 device structure
> + *
> + * @dev: reference to a struct device, linked to the spi_device
> + * @regmap: struct regmap instance use to access the chip
> + *
> + * @oscin: PLL2 input clock
> + * @vco: reference to the internal VCO clock
> + * @sclk: reference to the internal sysref clock (SCLK)
> + *
> + * @reset_gpio: Device reset GPIO
> + *
> + * @dclk: List of device clocks (DCLKX_Y), There's one device clock for each
> + * pair of clkout clocks.
> + * @clkout: List of output clocks.
> + */
> +struct lmk04832 {
> + struct device *dev;
> + struct regmap *regmap;
> +
> + struct clk *oscin;
Hopefully this isn't necessary and we can get the clk from DT using
clk_parent_data?
> + struct clk_hw vco;
> + struct clk_hw sclk;
> +
> + struct gpio_desc *reset_gpio;
> +
> + struct lmk_dclk *dclk;
> + struct lmk_clkout *clkout;
> + struct clk_hw_onecell_data *clk_data;
> +
> +#ifdef CONFIG_DEBUG_FS
> + struct dentry *debugfs_dentry;
> + uint16_t cached_reg_addr;
u16
> +#endif
> +};
> +
> +#ifdef CONFIG_DEBUG_FS
> +static ssize_t debugfs_read_reg(struct file *file, char __user *userbuf,
> + size_t count, loff_t *ppos)
> +{
> + struct lmk04832 *lmk = file->private_data;
> + unsigned int val = 0;
> + char buf[20];
> + ssize_t len;
> + int ret;
> +
> + ret = regmap_read(lmk->regmap, lmk->cached_reg_addr, &val);
> + if (ret) {
> + dev_err(lmk->dev, "%s: read reg 0x%04x failed (%d)\n", __func__,
> + lmk->cached_reg_addr, ret);
> + return ret;
> + }
> +
> + len = snprintf(buf, sizeof(buf), "0x%02x\n", val);
> +
> + return simple_read_from_buffer(userbuf, count, ppos, buf, len);
> +}
> +
> +static ssize_t debugfs_write_reg(struct file *file, const char __user *userbuf,
> + size_t count, loff_t *ppos)
> +{
> + struct lmk04832 *lmk = file->private_data;
> + unsigned int reg, val;
> + char buf[32];
> + int ret;
> +
> + count = min_t(size_t, count, (sizeof(buf) - 1));
> + if (copy_from_user(buf, userbuf, count))
> + return -EFAULT;
> +
> + buf[count] = 0;
> +
> + ret = sscanf(buf, "%i %i", ®, &val);
> +
> + switch (ret) {
> + case 1:
> + lmk->cached_reg_addr = reg;
> + break;
> + case 2:
> + lmk->cached_reg_addr = reg;
> + ret = regmap_write(lmk->regmap, reg, val);
This looks like some sort of wrapper on top of regmap? regmap already
has debugfs support, and if you want to change values of registers from
debugfs you can enable the compile time option to do so. Please use that
instead of reinventing it here.
> + if (ret) {
> + dev_err(lmk->dev, "%s: write reg 0x%04x failed\n",
> + __func__, lmk->cached_reg_addr);
> + return ret;
> + }
> + break;
> + default:
> + return -EINVAL;
> + }
> +
> + return count;
> +}
> +
> +static const struct file_operations debugfs_reg_fops = {
> + .open = simple_open,
> + .read = debugfs_read_reg,
> + .write = debugfs_write_reg,
> +};
> +
> +static int lmk04832_register_debugfs(struct lmk04832 *lmk)
> +{
> + struct dentry *d;
> + struct device_node *np = lmk->dev->of_node;
> +
> + lmk->debugfs_dentry = debugfs_create_dir(np->name, NULL);
> + if (IS_ERR(lmk->debugfs_dentry))
> + return PTR_ERR(lmk->debugfs_dentry);
> +
> + if (lmk->debugfs_dentry == NULL) {
> + dev_warn(lmk->dev, "Failed to create debugfs directory\n");
We don't care about debugfs errors. Just remove any warnings/prints and
move on with life.
> + return -EFAULT;
> + }
> +
> + d = debugfs_create_file("direct_reg_access", 0644,
> + lmk->debugfs_dentry,
> + lmk, &debugfs_reg_fops);
> + if (!d) {
> + debugfs_remove_recursive(lmk->debugfs_dentry);
> + return -ENOMEM;
> + }
> +
> + return 0;
> +}
> +#endif
> +
> +static bool lmk04832_regmap_rd_regs(struct device *dev, unsigned int reg)
> +{
> + switch (reg) {
> + case LMK04832_REG_RST3W ... LMK04832_REG_ID_MASKREV:
> + /* fallthrough */
> + case LMK04832_REG_ID_VNDR_MSB:
> + /* fallthrough */
> + case LMK04832_REG_ID_VNDR_LSB:
> + /* fallthrough */
> + case LMK04832_REG_DCLK_DIV_LSB(0) ... LMK04832_REG_PLL2_DLD_CNT_LSB:
> + /* fallthrough */
> + case LMK04832_REG_PLL2_LD:
> + /* fallthrough */
> + case LMK04832_REG_PLL2_PD:
> + /* fallthrough */
> + case LMK04832_REG_PLL1R_RST:
> + /* fallthrough */
> + case LMK04832_REG_CLR_PLL_LOST ... LMK04832_REG_RB_DAC_VAL_LSB:
> + /* fallthrough */
> + case LMK04832_REG_RB_HOLDOVER:
> + /* fallthrough */
> + case LMK04832_REG_SPI_LOCK:
> + return true;
> + default:
> + return false;
> + };
> +};
> +
> +static bool lmk04832_regmap_wr_regs(struct device *dev, unsigned int reg)
> +{
> + switch (reg) {
> + case LMK04832_REG_RST3W:
> + /* fallthrough */
> + case LMK04832_REG_POWERDOWN:
> + return true;
> + case LMK04832_REG_ID_DEV_TYPE ... LMK04832_REG_ID_MASKREV:
> + /* fallthrough */
> + case LMK04832_REG_ID_VNDR_MSB:
> + /* fallthrough */
> + case LMK04832_REG_ID_VNDR_LSB:
> + return false;
> + case LMK04832_REG_DCLK_DIV_LSB(0) ... LMK04832_REG_PLL2_DLD_CNT_LSB:
> + /* fallthrough */
> + case LMK04832_REG_PLL2_LD:
> + /* fallthrough */
> + case LMK04832_REG_PLL2_PD:
> + /* fallthrough */
> + case LMK04832_REG_PLL1R_RST:
> + /* fallthrough */
> + case LMK04832_REG_CLR_PLL_LOST ... LMK04832_REG_RB_DAC_VAL_LSB:
> + /* fallthrough */
> + case LMK04832_REG_RB_HOLDOVER:
> + /* fallthrough */
Use the fallthrough define for this. Does it work to only have it once?
That would be nice vs. having it duplicated so many times.
> + case LMK04832_REG_SPI_LOCK:
> + return true;
> + default:
> + return false;
> + };
> +};
> +
> +static const struct regmap_config regmap_config = {
> + .name = "lmk04832",
> + .reg_bits = 16,
> + .val_bits = 8,
> + .use_single_read = 1,
> + .use_single_write = 1,
> + .read_flag_mask = 0x80,
> + .write_flag_mask = 0x00,
> + .readable_reg = lmk04832_regmap_rd_regs,
> + .writeable_reg = lmk04832_regmap_wr_regs,
> + .cache_type = REGCACHE_NONE,
> + .max_register = LMK04832_REG_SPI_LOCK,
> +};
> +
> +static int lmk04832_vco_is_enabled(struct clk_hw *hw)
> +{
> + struct lmk04832 *lmk = container_of(hw, struct lmk04832, vco);
> + unsigned int tmp;
> + int ret;
> +
> + ret = regmap_read(lmk->regmap, LMK04832_REG_MAIN_PD, &tmp);
> + if (ret)
> + return ret;
> +
> + return !(FIELD_GET(LMK04832_BIT_OSCIN_PD, tmp) |
> + FIELD_GET(LMK04832_BIT_VCO_PD, tmp) |
> + FIELD_GET(LMK04832_BIT_VCO_LDO_PD, tmp));
> +}
> +
> +static int lmk04832_vco_prepare(struct clk_hw *hw)
> +{
> + struct lmk04832 *lmk = container_of(hw, struct lmk04832, vco);
> + int ret;
> +
> + ret = regmap_update_bits(lmk->regmap, LMK04832_REG_PLL2_PD,
> + LMK04832_BIT_PLL2_PRE_PD |
> + LMK04832_BIT_PLL2_PD,
> + 0x00);
> + if (ret)
> + return ret;
> +
> + return regmap_update_bits(lmk->regmap, LMK04832_REG_MAIN_PD,
> + LMK04832_BIT_VCO_LDO_PD |
> + LMK04832_BIT_VCO_PD |
> + LMK04832_BIT_OSCIN_PD, 0x00);
> +}
> +
> +static void lmk04832_vco_unprepare(struct clk_hw *hw)
> +{
> + struct lmk04832 *lmk = container_of(hw, struct lmk04832, vco);
> +
> + regmap_update_bits(lmk->regmap, LMK04832_REG_PLL2_PD,
> + LMK04832_BIT_PLL2_PRE_PD | LMK04832_BIT_PLL2_PD,
> + 0xff);
> +
> + /* Don't set LMK04832_BIT_OSCIN_PD since other clocks depend on it */
> + regmap_update_bits(lmk->regmap, LMK04832_REG_MAIN_PD,
> + LMK04832_BIT_VCO_LDO_PD | LMK04832_BIT_VCO_PD, 0xff);
> +}
> +
> +static unsigned long lmk04832_vco_recalc_rate(struct clk_hw *hw,
> + unsigned long prate)
> +{
> + struct lmk04832 *lmk = container_of(hw, struct lmk04832, vco);
> + unsigned int pll2_p[] = {8, 2, 2, 3, 4, 5, 6, 7};
> + unsigned int pll2_n, p, pll2_r;
> + unsigned int pll2_misc;
> + unsigned long vco_rate;
> + uint8_t tmp[3];
> + int ret;
> +
> + ret = regmap_read(lmk->regmap, LMK04832_REG_PLL2_MISC, &pll2_misc);
> + if (ret)
> + return ret;
> +
> + p = FIELD_GET(LMK04832_BIT_PLL2_MISC_P, pll2_misc);
> +
> + ret = regmap_bulk_read(lmk->regmap, LMK04832_REG_PLL2_N_0, &tmp, 3);
> + if (ret)
> + return ret;
> +
> + pll2_n = (FIELD_GET(LMK04832_BIT_PLL2_N_0, tmp[0]) << 16) |
> + tmp[1] << 8 | tmp[2];
I feel like this pattern is somewhere in kernel.h or bits.h but I can't
find it. I suppose FIELD_PREP() could be used to shift it to the right
place. Can you use that?
> +
> + ret = regmap_bulk_read(lmk->regmap, LMK04832_REG_PLL2_R_MSB, &tmp, 2);
> + if (ret)
> + return ret;
> +
> + pll2_r = (FIELD_GET(LMK04832_BIT_PLL2_R_MSB, tmp[0]) << 8) | tmp[1];
> +
> +
> + vco_rate = (prate << FIELD_GET(LMK04832_BIT_PLL2_MISC_REF_2X_EN,
> + pll2_misc)) * pll2_n * pll2_p[p] / pll2_r;
> +
> + return vco_rate;
> +};
> +
> +/**
> + * lmk04832_check_vco_ranges - Check requested VCO frequency against VCO ranges
> + *
> + * @lmk: Reference to the lmk device
> + * @rate: Desired output rate for the VCO
> + *
> + * The LMK04832 has 2 internal VCO, each with independant operating ranges. Use
> + * the device_info structure to determine which VCO to use based on rate.
> + *
> + * Returns VCO_MUX value or negative errno.
> + */
> +static int lmk04832_check_vco_ranges(struct lmk04832 *lmk, unsigned long rate)
> +{
> + struct spi_device *spi = to_spi_device(lmk->dev);
> + struct lmk04832_device_info info;
Why not a pointer instead of struct copy?
> + unsigned long mhz = rate / 1000000;
> +
> + info = lmk04832_device_info[spi_get_device_id(spi)->driver_data];
> +
> + if (mhz >= info.vco0_range[0] && mhz <= info.vco0_range[1]) {
> + return LMK04832_VAL_VCO_MUX_VCO0;
> + } else if (mhz >= info.vco1_range[0] && mhz <= info.vco1_range[1]) {
> + return LMK04832_VAL_VCO_MUX_VCO1;
> + } else {
> + dev_err(lmk->dev, "%lu Hz is out of VCO ranges", rate);
Missing newline.
> + return -ERANGE;
> + }
> +}
> +
> +/**
> + * lmk04832_calc_pll2_params - Get PLL2 parameters used to set the VCO frequency
> + *
> + * @prate: parent rate to the PLL2, usually OSCin
> + * @rate: Desired output rate for the VCO
> + * @n: reference to PLL2_N
> + * @r: reference to PLL2_R
> + *
> + * This functions assumes LMK04832_BIT_PLL2_MISC_REF_2X_EN is set since it is
> + * recommended in the datasheet because a higher phase detector frequencies
> + * makes the design of wider loop bandwidth filters possible.
> + *
> + * the VCO rate can be calculated using the following expression:
> + *
> + * VCO = OSCin * 2 * PLL2_N * PLL2_P / PLL2_R
> + *
> + * Returns vco rate or negative errno.
> + */
> +static long lmk04832_calc_pll2_params(unsigned long prate, unsigned long rate,
> + unsigned int *n, unsigned int *p,
> + unsigned int *r)
> +{
> + unsigned long num, div;
> +
> + /* Set PLL2_P to a fixed value to simplify optimizations */
> + *p = 2;
> +
> + div = gcd(rate, prate);
> +
> + /* num = 2 * PLL_N * PLL_P */
> + num = DIV_ROUND_CLOSEST(rate, div);
> + *r = DIV_ROUND_CLOSEST(prate, div);
> +
> + if (num > 4) {
> + *n = num >> 2;
> + } else {
> + *r = *r << 2;
> + *n = num;
> + }
> +
> + if (*n < 1 || *n > 0x03ffff)
> + return -EINVAL;
> + if (*r < 1 || *r > 0xfff)
> + return -EINVAL;
> +
> + return DIV_ROUND_CLOSEST(prate * 2 * *p * *n, *r);
Please grow some local variables here so that we don't have to think
about pointers being derefed and multiplied in the wrong order. It looks
cool but is too complicated.
> +}
> +
> +static long lmk04832_vco_round_rate(struct clk_hw *hw, unsigned long rate,
> + unsigned long *prate)
> +{
> + struct lmk04832 *lmk = container_of(hw, struct lmk04832, vco);
> + unsigned long vco_rate;
> + unsigned int n, p, r;
> + int ret;
> +
> + ret = lmk04832_check_vco_ranges(lmk, rate);
> + if (rate < 0)
> + return ret;
> +
> + vco_rate = lmk04832_calc_pll2_params(*prate, rate, &n, &p, &r);
> + if (vco_rate < 0) {
> + dev_err(lmk->dev, "PLL2 parmeters out of range (N=%d, P=%d, R=%d)\n",
> + n, p, r);
> + return vco_rate;
> + }
> +
> + dev_dbg(lmk->dev, "%s: prate %ld Hz, got %ld Hz (delta=%lu Hz)\n",
> + clk_hw_get_name(hw), *prate, vco_rate, abs(rate - vco_rate));
> +
> + return vco_rate;
> +};
> +
> +static int lmk04832_vco_set_rate(struct clk_hw *hw, unsigned long rate,
> + unsigned long prate)
> +{
> + struct lmk04832 *lmk = container_of(hw, struct lmk04832, vco);
> + unsigned long vco_rate;
> + unsigned int n, p, r;
> + int vco_mux;
> + int ret;
> +
> + vco_mux = lmk04832_check_vco_ranges(lmk, rate);
> + if (vco_mux < 0)
> + return vco_mux;
> +
> + ret = regmap_update_bits(lmk->regmap, LMK04832_REG_VCO_OSCOUT,
> + LMK04832_BIT_VCO_MUX,
> + FIELD_PREP(LMK04832_BIT_VCO_MUX, vco_mux));
> + if (ret)
> + return ret;
> +
> + vco_rate = lmk04832_calc_pll2_params(prate, rate, &n, &p, &r);
> + if (vco_rate < 0) {
vco_rate is unsigned, can't be less than zero.
> + dev_err(lmk->dev, "failed to determine PLL2 parmeters\n");
> + return vco_rate;
> + }
> +
> + ret = regmap_update_bits(lmk->regmap, LMK04832_REG_PLL2_R_MSB,
> + LMK04832_BIT_PLL2_R_MSB,
> + FIELD_GET(0x000700, r));
> + if (ret)
> + return ret;
> +
> + ret = regmap_write(lmk->regmap, LMK04832_REG_PLL2_R_LSB,
> + FIELD_GET(0x0000ff, r));
> + if (ret)
> + return ret;
> +
> + ret = regmap_update_bits(lmk->regmap, LMK04832_REG_PLL2_MISC,
> + LMK04832_BIT_PLL2_MISC_P,
> + FIELD_PREP(LMK04832_BIT_PLL2_MISC_P, p));
> + if (ret)
> + return ret;
> +
> + /*
> + * PLL2_N registers must be programmed after other PLL2 dividers are
> + * programed to ensure proper VCO frequency calibration
> + */
> + ret = regmap_write(lmk->regmap, LMK04832_REG_PLL2_N_0,
> + FIELD_GET(0x030000, n));
> + if (ret)
> + return ret;
> + ret = regmap_write(lmk->regmap, LMK04832_REG_PLL2_N_1,
> + FIELD_GET(0x00ff00, n));
> + if (ret)
> + return ret;
> + ret = regmap_write(lmk->regmap, LMK04832_REG_PLL2_N_2,
> + FIELD_GET(0x0000ff, n));
> + if (ret)
> + return ret;
> +
> + return 0;
Just return regmap_write(...)
> +};
> +
> +const struct clk_ops lmk04832_vco_ops = {
static?
> + .is_enabled = lmk04832_vco_is_enabled,
> + .prepare = lmk04832_vco_prepare,
> + .unprepare = lmk04832_vco_unprepare,
> + .recalc_rate = lmk04832_vco_recalc_rate,
> + .round_rate = lmk04832_vco_round_rate,
> + .set_rate = lmk04832_vco_set_rate,
> +};
> +
> +static int lmk04832_register_vco(struct lmk04832 *lmk)
> +{
> + const char *parent_names[1];
> + struct clk_init_data init;
> + int ret;
> +
> + init.name = "lmk-vco";
> + parent_names[0] = __clk_get_name(lmk->oscin);
> + init.parent_names = parent_names;
> +
> + init.ops = &lmk04832_vco_ops;
> + init.flags = CLK_SET_RATE_GATE;
> + init.num_parents = 1;
> +
> + ret = regmap_update_bits(lmk->regmap, LMK04832_REG_VCO_OSCOUT,
> + LMK04832_BIT_VCO_MUX,
> + FIELD_PREP(LMK04832_BIT_VCO_MUX,
> + LMK04832_VAL_VCO_MUX_VCO1));
> + if (ret)
> + return ret;
> +
> + ret = regmap_update_bits(lmk->regmap, LMK04832_REG_FB_CTRL,
> + LMK04832_BIT_PLL2_RCLK_MUX |
> + LMK04832_BIT_PLL2_NCLK_MUX,
> + FIELD_PREP(LMK04832_BIT_PLL2_RCLK_MUX,
> + LMK04832_VAL_PLL2_RCLK_MUX_OSCIN)|
> + FIELD_PREP(LMK04832_BIT_PLL2_NCLK_MUX,
> + LMK04832_VAL_PLL2_NCLK_MUX_PLL2_P));
> + if (ret)
> + return ret;
> +
> + ret = regmap_update_bits(lmk->regmap, LMK04832_REG_PLL2_MISC,
> + LMK04832_BIT_PLL2_MISC_REF_2X_EN,
> + LMK04832_BIT_PLL2_MISC_REF_2X_EN);
> + if (ret)
> + return ret;
> +
> + ret = regmap_write(lmk->regmap, LMK04832_REG_PLL2_LD,
> + FIELD_PREP(LMK04832_BIT_PLL2_LD_MUX,
> + LMK04832_VAL_PLL2_LD_MUX_PLL2_DLD) |
> + FIELD_PREP(LMK04832_BIT_PLL2_LD_TYPE,
> + LMK04832_VAL_PLL2_LD_TYPE_OUT_PP));
> + if (ret)
> + return ret;
> +
> + lmk->vco.init = &init;
> + return devm_clk_hw_register(lmk->dev, &lmk->vco);
> +}
> +
> +static int lmk04832_sclk_is_enabled(struct clk_hw *hw)
> +{
> + struct lmk04832 *lmk = container_of(hw, struct lmk04832, sclk);
> + unsigned int tmp;
> + int ret;
> +
> + ret = regmap_read(lmk->regmap, LMK04832_REG_MAIN_PD, &tmp);
> + if (ret)
> + return ret;
> +
> + return FIELD_GET(LMK04832_BIT_SYSREF_PD, tmp);
> +}
> +
> +static int lmk04832_sclk_prepare(struct clk_hw *hw)
> +{
> + struct lmk04832 *lmk = container_of(hw, struct lmk04832, sclk);
> +
> + return regmap_update_bits(lmk->regmap, LMK04832_REG_MAIN_PD,
> + LMK04832_BIT_SYSREF_PD, 0x00);
> +}
> +
> +static void lmk04832_sclk_unprepare(struct clk_hw *hw)
> +{
> + struct lmk04832 *lmk = container_of(hw, struct lmk04832, sclk);
> +
> + regmap_update_bits(lmk->regmap, LMK04832_REG_MAIN_PD,
> + LMK04832_BIT_SYSREF_PD, LMK04832_BIT_SYSREF_PD);
> +}
> +
> +static unsigned long lmk04832_sclk_recalc_rate(struct clk_hw *hw,
> + unsigned long prate)
> +{
> + struct lmk04832 *lmk = container_of(hw, struct lmk04832, sclk);
> + unsigned int sysref_div;
> + uint8_t tmp[2];
> + int ret;
> +
> + ret = regmap_bulk_read(lmk->regmap, LMK04832_REG_SYSREF_DIV_MSB, &tmp, 2);
> + if (ret)
> + return ret;
> +
> + sysref_div = FIELD_GET(LMK04832_BIT_SYSREF_DIV_MSB, tmp[0]) << 8 |
> + tmp[1];
> +
> + return DIV_ROUND_CLOSEST(prate, sysref_div);
> +}
> +
> +static long lmk04832_sclk_round_rate(struct clk_hw *hw, unsigned long rate,
> + unsigned long *prate)
> +{
> + struct lmk04832 *lmk = container_of(hw, struct lmk04832, sclk);
> + unsigned long sclk_rate;
> + unsigned int sysref_div;
> +
> + sysref_div = DIV_ROUND_CLOSEST(*prate, rate);
> + sclk_rate = DIV_ROUND_CLOSEST(*prate, sysref_div);
> +
> + if (sysref_div < 0x07 || sysref_div > 0x1fff) {
> + dev_err(lmk->dev, "SYSREF divider out of range\n");
> + return -EINVAL;
> + }
> +
> + dev_dbg(lmk->dev, "%s: prate %ld Hz, got %ld Hz (delta=%lu Hz)\n",
> + clk_hw_get_name(hw), *prate, sclk_rate, abs(rate - sclk_rate));
> +
> + return sclk_rate;
> +}
> +
> +static int lmk04832_sclk_set_rate(struct clk_hw *hw, unsigned long rate,
> + unsigned long prate)
> +{
> + struct lmk04832 *lmk = container_of(hw, struct lmk04832, sclk);
> + unsigned int sysref_div;
> + int ret;
> +
> + sysref_div = DIV_ROUND_CLOSEST(prate, rate);
> +
> + if (sysref_div < 0x07 || sysref_div > 0x1fff) {
> + dev_err(lmk->dev, "SYSREF divider out of range\n");
> + return -EINVAL;
> + }
> +
> + ret = regmap_write(lmk->regmap, LMK04832_REG_SYSREF_DIV_MSB,
> + FIELD_GET(0x1f00, sysref_div));
> + if (ret)
> + return ret;
> +
> + return regmap_write(lmk->regmap, LMK04832_REG_SYSREF_DIV_LSB,
> + FIELD_GET(0x00ff, sysref_div));
> +}
> +
> +const struct clk_ops lmk04832_sclk_ops = {
static?
> + .is_enabled = lmk04832_sclk_is_enabled,
> + .prepare = lmk04832_sclk_prepare,
> + .unprepare = lmk04832_sclk_unprepare,
> + .recalc_rate = lmk04832_sclk_recalc_rate,
> + .round_rate = lmk04832_sclk_round_rate,
> + .set_rate = lmk04832_sclk_set_rate,
> +};
> +
> +static int lmk04832_register_sclk(struct lmk04832 *lmk)
> +{
> + const char *parent_names[1];
> + struct clk_init_data init;
> + int ret = 0;
> +
> + init.name = "lmk-sclk";
> + parent_names[0] = clk_hw_get_name(&lmk->vco);
> + init.parent_names = parent_names;
> +
> + init.ops = &lmk04832_sclk_ops;
> + init.flags = CLK_SET_RATE_PARENT;
> + init.num_parents = 1;
> +
> + ret = regmap_update_bits(lmk->regmap, LMK04832_REG_SYSREF_OUT,
> + LMK04832_BIT_SYSREF_MUX,
> + FIELD_PREP(LMK04832_BIT_SYSREF_MUX,
> + LMK04832_VAL_SYSREF_MUX_CONTINUOUS));
> + if (ret)
> + return ret;
> +
> + ret = regmap_update_bits(lmk->regmap, LMK04832_REG_MAIN_PD,
> + LMK04832_BIT_SYSREF_PLSR_PD,
> + LMK04832_BIT_SYSREF_PLSR_PD);
> + if (ret)
> + return ret;
> +
> + ret = regmap_update_bits(lmk->regmap, LMK04832_REG_SYNC,
> + LMK04832_BIT_SYNC_EN, 0xff);
> + if (ret)
> + return ret;
> +
> + ret = regmap_write(lmk->regmap, LMK04832_REG_SYNC_DIS, 0xff);
> + if (ret)
> + return ret;
> +
> + lmk->sclk.init = &init;
> + return devm_clk_hw_register(lmk->dev, &lmk->sclk);
> +}
> +
> +static int lmk04832_dclk_is_enabled(struct clk_hw *hw)
> +{
> + struct lmk_dclk *dclk = container_of(hw, struct lmk_dclk, hw);
> + struct lmk04832 *lmk = dclk->lmk;
> + unsigned int tmp;
> + int ret;
> +
> + ret = regmap_read(lmk->regmap, LMK04832_REG_CLKOUT_CTRL1(dclk->id),
> + &tmp);
> + if (ret)
> + return ret;
> +
> + return !FIELD_GET(LMK04832_BIT_DCLK_PD, tmp);
> +}
> +
> +static int lmk04832_dclk_prepare(struct clk_hw *hw)
> +{
> + struct lmk_dclk *dclk = container_of(hw, struct lmk_dclk, hw);
> + struct lmk04832 *lmk = dclk->lmk;
> +
> + return regmap_update_bits(lmk->regmap,
> + LMK04832_REG_CLKOUT_CTRL1(dclk->id),
> + LMK04832_BIT_DCLK_PD, 0x00);
> +}
> +
> +static void lmk04832_dclk_unprepare(struct clk_hw *hw)
> +{
> + struct lmk_dclk *dclk = container_of(hw, struct lmk_dclk, hw);
> + struct lmk04832 *lmk = dclk->lmk;
> +
> + regmap_update_bits(lmk->regmap,
> + LMK04832_REG_CLKOUT_CTRL1(dclk->id),
> + LMK04832_BIT_DCLK_PD, 0xff);
> +}
> +
> +static unsigned long lmk04832_dclk_recalc_rate(struct clk_hw *hw,
> + unsigned long prate)
> +{
> + struct lmk_dclk *dclk = container_of(hw, struct lmk_dclk, hw);
> + struct lmk04832 *lmk = dclk->lmk;
> + unsigned int dclk_div;
> + unsigned int lsb, msb;
> + unsigned long rate;
> + int ret;
> +
> + ret = regmap_read(lmk->regmap, LMK04832_REG_DCLK_DIV_LSB(dclk->id),
> + &lsb);
> + if (ret)
> + return ret;
> +
> + ret = regmap_read(lmk->regmap, LMK04832_REG_CLKOUT_CTRL0(dclk->id),
> + &msb);
> + if (ret)
> + return ret;
> +
> + dclk_div = FIELD_GET(LMK04832_BIT_DCLK_DIV_MSB, msb) << 8 | lsb;
> + rate = DIV_ROUND_CLOSEST(prate, dclk_div);
> +
> + return rate;
> +};
> +
> +static long lmk04832_dclk_round_rate(struct clk_hw *hw, unsigned long rate,
> + unsigned long *prate)
> +{
> + struct lmk_dclk *dclk = container_of(hw, struct lmk_dclk, hw);
> + struct lmk04832 *lmk = dclk->lmk;
> + unsigned long dclk_rate;
> + unsigned int dclk_div;
> +
> + dclk_div = DIV_ROUND_CLOSEST(*prate, rate);
> + dclk_rate = DIV_ROUND_CLOSEST(*prate, dclk_div);
> +
> + if (dclk_div < 1 || dclk_div > 0x3ff) {
> + dev_err(lmk->dev, "%s_div out of range", clk_hw_get_name(hw));
> + return -EINVAL;
> + }
> +
> + dev_dbg(lmk->dev, "%s: prate %ld Hz, got %ld Hz (delta=%lu Hz)\n",
> + clk_hw_get_name(hw), *prate, dclk_rate, abs(rate - dclk_rate));
> +
> + return dclk_rate;
> +};
> +
> +static int lmk04832_dclk_set_rate(struct clk_hw *hw, unsigned long rate,
> + unsigned long prate)
> +{
> + struct lmk_dclk *dclk = container_of(hw, struct lmk_dclk, hw);
> + struct lmk04832 *lmk = dclk->lmk;
> + unsigned int dclk_div;
> + int ret;
> +
> + dclk_div = DIV_ROUND_CLOSEST(prate, rate);
> +
> + if (dclk_div < 1 || dclk_div > 0x3ff) {
How is dclk_div ever zero?
> + dev_err(lmk->dev, "%s_div out of range", clk_hw_get_name(hw));
Missing newline on the printk. Same comment applies for the duplicate
printk above.
> + return -EINVAL;
> + }
> +
> + ret = regmap_write(lmk->regmap, LMK04832_REG_DCLK_DIV_LSB(dclk->id),
> + FIELD_GET(0x0ff, dclk_div));
> + if (ret)
> + return ret;
> +
> + return regmap_update_bits(lmk->regmap,
> + LMK04832_REG_CLKOUT_CTRL0(dclk->id),
> + LMK04832_BIT_DCLK_DIV_MSB,
> + FIELD_GET(0x300, dclk_div));
> +};
> +
> +const struct clk_ops lmk04832_dclk_ops = {
> + .is_enabled = lmk04832_dclk_is_enabled,
> + .prepare = lmk04832_dclk_prepare,
> + .unprepare = lmk04832_dclk_unprepare,
> + .recalc_rate = lmk04832_dclk_recalc_rate,
> + .round_rate = lmk04832_dclk_round_rate,
> + .set_rate = lmk04832_dclk_set_rate,
> +};
> +
> +static int lmk04832_clkout_is_enabled(struct clk_hw *hw)
> +{
> + struct lmk_clkout *clkout = container_of(hw, struct lmk_clkout, hw);
> + struct lmk04832 *lmk = clkout->lmk;
> + unsigned int clkoutx_y_pd;
> + unsigned int sclkx_y_pd;
> + unsigned int tmp;
> + uint8_t fmt;
Please use u8/u16/u32.
> + int enabled;
u32 enabled? Doesn't need to be signed right?
> + int ret;
> +
> + ret = regmap_read(lmk->regmap, LMK04832_REG_CLKOUT_CTRL0(clkout->id),
> + &clkoutx_y_pd);
> + if (ret)
> + return ret;
> +
> + enabled = !FIELD_GET(LMK04832_BIT_CLKOUTX_Y_PD, clkoutx_y_pd);
> +
> + ret = regmap_read(lmk->regmap, LMK04832_REG_CLKOUT_SRC_MUX(clkout->id),
> + &tmp);
> + if (ret)
> + return ret;
> +
> + if (FIELD_GET(LMK04832_BIT_CLKOUT_SRC_MUX, tmp)) {
> + ret = regmap_read(lmk->regmap,
> + LMK04832_REG_CLKOUT_CTRL2(clkout->id),
> + &sclkx_y_pd);
> + if (ret)
> + return ret;
> +
> + enabled = enabled && !FIELD_GET(LMK04832_BIT_SCLK_PD, sclkx_y_pd);
> + }
> +
> + ret = regmap_read(lmk->regmap, LMK04832_REG_CLKOUT_FMT(clkout->id),
> + &tmp);
> + if (ret)
> + return ret;
> +
> + fmt = (tmp & (0xf << 4 * (clkout->id % 2))) >> 4 * (clkout->id % 2);
This is quite a long line. Can we break it up into multiple lines with
some more local variables?
> + return enabled && !fmt;
> +}
> +
> +static int lmk04832_clkout_prepare(struct clk_hw *hw)
> +{
> + struct lmk_clkout *clkout = container_of(hw, struct lmk_clkout, hw);
> + struct lmk04832 *lmk = clkout->lmk;
> + unsigned int tmp;
> + int ret;
> +
> + if (clkout->format == LMK04832_VAL_CLKOUT_FMT_POWERDOWN)
> + dev_err(lmk->dev, "prepared %s but format is powerdown\n",
> + clk_hw_get_name(hw));
> +
> + ret = regmap_update_bits(lmk->regmap,
> + LMK04832_REG_CLKOUT_CTRL0(clkout->id),
> + LMK04832_BIT_CLKOUTX_Y_PD, 0x00);
> + if (ret)
> + return ret;
> +
> + ret = regmap_read(lmk->regmap, LMK04832_REG_CLKOUT_SRC_MUX(clkout->id),
> + &tmp);
> + if (ret)
> + return ret;
> +
> + if (FIELD_GET(LMK04832_BIT_CLKOUT_SRC_MUX, tmp)) {
> + ret = regmap_update_bits(lmk->regmap,
> + LMK04832_REG_CLKOUT_CTRL2(clkout->id),
> + LMK04832_BIT_SCLK_PD, 0x00);
> + if (ret)
> + return ret;
> + }
> +
> + return regmap_update_bits(lmk->regmap,
> + LMK04832_REG_CLKOUT_FMT(clkout->id),
> + LMK04832_BIT_CLKOUT_FMT(clkout->id),
> + clkout->format << 4 * (clkout->id % 2));
> +}
> +
> +static void lmk04832_clkout_unprepare(struct clk_hw *hw)
> +{
> + struct lmk_clkout *clkout = container_of(hw, struct lmk_clkout, hw);
> + struct lmk04832 *lmk = clkout->lmk;
> +
> + regmap_update_bits(lmk->regmap, LMK04832_REG_CLKOUT_FMT(clkout->id),
> + LMK04832_BIT_CLKOUT_FMT(clkout->id),
> + 0x00);
> +}
> +
> +static int lmk04832_clkout_set_parent(struct clk_hw *hw, uint8_t index)
> +{
> + struct lmk_clkout *clkout = container_of(hw, struct lmk_clkout, hw);
> + struct lmk04832 *lmk = clkout->lmk;
> +
> + return regmap_update_bits(lmk->regmap,
> + LMK04832_REG_CLKOUT_SRC_MUX(clkout->id),
> + LMK04832_BIT_CLKOUT_SRC_MUX,
> + FIELD_PREP(LMK04832_BIT_CLKOUT_SRC_MUX,
> + index));
> +}
> +
> +static uint8_t lmk04832_clkout_get_parent(struct clk_hw *hw)
> +{
> + struct lmk_clkout *clkout = container_of(hw, struct lmk_clkout, hw);
> + struct lmk04832 *lmk = clkout->lmk;
> + unsigned int tmp;
> + int ret;
> +
> + ret = regmap_read(lmk->regmap, LMK04832_REG_CLKOUT_SRC_MUX(clkout->id),
> + &tmp);
> + if (ret)
> + return ret;
> +
> + return FIELD_GET(LMK04832_BIT_CLKOUT_SRC_MUX, tmp);
> +}
> +
> +const struct clk_ops lmk04832_clkout_ops = {
static?
> + .is_enabled = lmk04832_clkout_is_enabled,
> + .prepare = lmk04832_clkout_prepare,
> + .unprepare = lmk04832_clkout_unprepare,
> + .set_parent = lmk04832_clkout_set_parent,
> + .get_parent = lmk04832_clkout_get_parent,
> +};
> +
> +static int lmk04832_register_clkout(struct lmk04832 *lmk, const int num)
> +{
> + char name[] = "lmk-clkoutXX";
> + char dclk_name[] = "lmk-dclkXX_YY";
> + const char *parent_names[2];
> + struct clk_init_data init;
> + int dclk_num = num / 2;
> + int ret;
> +
> + if (num % 2 == 0) {
> + sprintf(dclk_name, "lmk-dclk%02d_%02d", num, num + 1);
> + init.name = dclk_name;
> + parent_names[0] = clk_hw_get_name(&lmk->vco);
> + init.ops = &lmk04832_dclk_ops;
> + init.flags = CLK_SET_RATE_PARENT;
> + init.num_parents = 1;
> +
> + lmk->dclk[dclk_num].id = num;
> + lmk->dclk[dclk_num].lmk = lmk;
> + lmk->dclk[dclk_num].hw.init = &init;
> + ret = devm_clk_hw_register(lmk->dev, &lmk->dclk[dclk_num].hw);
> + if (ret)
> + return ret;
> + } else {
> + sprintf(dclk_name, "lmk-dclk%02d_%02d", num - 1, num);
> + }
> +
> + if (of_property_read_string_index(lmk->dev->of_node,
> + "clock-output-names",
> + num, &init.name)) {
> + sprintf(name, "lmk-clkout%02d", num);
> + init.name = name;
> + }
> +
> + parent_names[0] = dclk_name;
> + parent_names[1] = clk_hw_get_name(&lmk->sclk);
Can you use clk_parent_data instead? That way it doesn't need to be
name based unless it's part of a DT binding.
> + init.parent_names = parent_names;
> + init.ops = &lmk04832_clkout_ops;
> + init.flags = CLK_SET_RATE_PARENT | CLK_SET_RATE_NO_REPARENT;
> + init.num_parents = ARRAY_SIZE(parent_names);
> +
> + lmk->clkout[num].id = num;
> + lmk->clkout[num].lmk = lmk;
> + lmk->clkout[num].hw.init = &init;
> + lmk->clk_data->hws[num] = &lmk->clkout[num].hw;
> +
> + /* Set initial parent */
> + regmap_update_bits(lmk->regmap,
> + LMK04832_REG_CLKOUT_SRC_MUX(num),
> + LMK04832_BIT_CLKOUT_SRC_MUX,
> + FIELD_PREP(LMK04832_BIT_CLKOUT_SRC_MUX,
> + lmk->clkout[num].sysref));
> +
> + return devm_clk_hw_register(lmk->dev, &lmk->clkout[num].hw);
> +}
> +
> +static int lmk04832_set_spi_rdbk(const struct lmk04832 *lmk, const int rdbk_pin)
> +{
> + int reg;
> + int ret;
> +
> + dev_info(lmk->dev, "Setting up 4-wire mode");
> + ret = regmap_write(lmk->regmap, LMK04832_REG_RST3W,
> + LMK04832_BIT_SPI_3WIRE_DIS);
> + if (ret)
> + return ret;
> +
> + switch (rdbk_pin) {
> + case RDBK_CLKIN_SEL0:
> + reg = LMK04832_REG_CLKIN_SEL0;
> + break;
> + case RDBK_CLKIN_SEL1:
> + reg = LMK04832_REG_CLKIN_SEL1;
> + break;
> + case RDBK_RESET:
> + reg = LMK04832_REG_CLKIN_RST;
> + break;
> + default:
> + return -EINVAL;
> + }
> +
> + return regmap_write(lmk->regmap, reg,
> + FIELD_PREP(LMK04832_BIT_CLKIN_SEL_MUX,
> + LMK04832_VAL_CLKIN_SEL_MUX_SPI_RDBK) |
> + FIELD_PREP(LMK04832_BIT_CLKIN_SEL_TYPE,
> + LMK04832_VAL_CLKIN_SEL_TYPE_OUT));
> +}
> +
> +static int lmk04832_probe(struct spi_device *spi)
> +{
> + struct lmk04832_device_info lmk_devinfo;
> + int rdbk_pin = RDBK_CLKIN_SEL1;
> + struct device_node *child;
> + struct lmk04832 *lmk;
> + uint8_t tmp[3];
> + int ret = 0;
> + int i;
> +
> + lmk_devinfo = lmk04832_device_info[spi_get_device_id(spi)->driver_data];
> +
> + lmk = devm_kzalloc(&spi->dev, sizeof(struct lmk04832), GFP_KERNEL);
> + if (!lmk)
> + return -ENOMEM;
> +
> + lmk->dev = &spi->dev;
> +
> + lmk->oscin = devm_clk_get(lmk->dev, "oscin");
> + if (IS_ERR(lmk->oscin)) {
> + dev_err(lmk->dev, "failed to get oscin clock\n");
> + return PTR_ERR(lmk->oscin);
> + }
> +
> + ret = clk_prepare_enable(lmk->oscin);
> + if (ret)
> + return ret;
> +
> + lmk->reset_gpio = devm_gpiod_get_optional(&spi->dev, "reset", GPIOD_OUT_LOW);
> + if (!IS_ERR(lmk->reset_gpio)) {
> + ret = gpiod_direction_output(lmk->reset_gpio, 0);
What if it fails?
> + }
> +
> + lmk->dclk = devm_kcalloc(lmk->dev, lmk_devinfo.num_channels >> 1,
> + sizeof(struct lmk_dclk), GFP_KERNEL);
> + if (IS_ERR(lmk->dclk)) {
> + ret = PTR_ERR(lmk->dclk);
> + goto err_disable_oscin;
> + }
> +
> + lmk->clkout = devm_kcalloc(lmk->dev, lmk_devinfo.num_channels,
> + sizeof(struct lmk_clkout), GFP_KERNEL);
sizeof(*lmk->clkout) please.
> + if (IS_ERR(lmk->clkout)) {
> + ret = PTR_ERR(lmk->clkout);
> + goto err_disable_oscin;
> + }
> +
> + lmk->clk_data = devm_kzalloc(lmk->dev, sizeof(*lmk->clk_data) +
> + sizeof(*lmk->clk_data->hws) *
Use struct_size()
> + lmk_devinfo.num_channels,
> + GFP_KERNEL);
> + if (IS_ERR(lmk->clk_data)) {
> + ret = PTR_ERR(lmk->clk_data);
> + goto err_disable_oscin;
> + }
> +
> + for_each_child_of_node(lmk->dev->of_node, child) {
> + int reg;
> +
> + ret = of_property_read_u32(child, "reg", ®);
> + if (ret) {
> + dev_err(lmk->dev, "missing reg property in child: %s\n",
> + child->full_name);
> + goto err_disable_oscin;
> + }
> +
> + of_property_read_u32(child, "lmk,clkout-fmt",
> + &lmk->clkout[reg].format);
> +
> + if (lmk->clkout[reg].format >= 0x0a && reg % 2 == 0
> + && reg != 8 && reg != 10)
> + dev_err(lmk->dev, "invalid format for clkout%02d\n",
> + reg);
> +
> + lmk->clkout[reg].sysref =
> + of_property_read_bool(child, "lmk,clkout-sysref");
Not sure what this is but it looks scary. Some sort of configuration
based on what is in DT but each node in DT is for some clk? Hopefully it
can be done some other way.
> + };
> +
> + lmk->regmap = devm_regmap_init_spi(spi, ®map_config);
> + if (IS_ERR(lmk->regmap)) {
> + dev_err(lmk->dev, "%s: regmap allocation failed: %ld\n",
> +
> + __func__, PTR_ERR(lmk->regmap));
> + ret = PTR_ERR(lmk->regmap);
> + goto err_disable_oscin;
> + }
> +
> + regmap_write(lmk->regmap, LMK04832_REG_RST3W, LMK04832_BIT_RESET);
> +
> + if (!(spi->mode & SPI_3WIRE)) {
> + device_property_read_u32(lmk->dev, "lmk,spi-4wire-rdbk",
> + &rdbk_pin);
> + ret = lmk04832_set_spi_rdbk(lmk, rdbk_pin);
> + if (ret)
> + goto err_disable_oscin;
> + }
> +
> + regmap_bulk_read(lmk->regmap, LMK04832_REG_ID_PROD_MSB, &tmp, 3);
> + if ((tmp[0] << 8 | tmp[1]) != lmk_devinfo.pid || tmp[2] != lmk_devinfo.maskrev) {
> + dev_err(lmk->dev, "unsupported device type: pid 0x%04x, maskrev 0x%02x\n",
> + tmp[0] << 8 | tmp[1], tmp[2]);
> + ret = -EINVAL;
> + goto err_disable_oscin;
> + }
> +
> + /* Setup device clock path in PLL2 single loop mode */
> + ret = lmk04832_register_vco(lmk);
> + if (ret) {
> + dev_err(lmk->dev, "failed to init device clock path\n");
> + goto err_disable_oscin;
> + }
> +
> + /* Setup SYNC/SYSREF in continuous mode */
> + ret = lmk04832_register_sclk(lmk);
> + if (ret) {
> + dev_err(lmk->dev, "failed to init SYNC/SYSREF clock path\n");
> + goto err_disable_oscin;
> + }
> +
> + for (i = 0; i < lmk_devinfo.num_channels; i++) {
> + ret = lmk04832_register_clkout(lmk, i);
> + if (ret) {
> + dev_err(lmk->dev, "failed to register clk %d\n", i);
> + goto err_disable_oscin;
> + }
> + }
> +
> + lmk->clk_data->num = lmk_devinfo.num_channels;
> + ret = of_clk_add_hw_provider(lmk->dev->of_node, of_clk_hw_onecell_get,
> + lmk->clk_data);
> + if (ret) {
> + dev_err(lmk->dev, "failed to add provider (%d)\n", ret);
> + goto err_disable_oscin;
> + }
> +
> +#ifdef CONFIG_DEBUG_FS
Drop the config and make an inline stub for the function below when
CONFIG_DEBUG_FS=n.
> + ret = lmk04832_register_debugfs(lmk);
> + if (ret)
> + goto err_del_provider;
> +#endif
> +
> + spi_set_drvdata(spi, lmk);
> + dev_info(lmk->dev, "successfully initialized, product ID is 0x%04x\n",
Please drop this "I probed" message.
> + lmk_devinfo.pid);
> +
> + return 0;
> +
> +err_del_provider:
> + of_clk_del_provider(spi->dev.of_node);
> +
> +err_disable_oscin:
> + clk_disable_unprepare(lmk->oscin);
> +
> + return ret;
> +}
> +
> +static int lmk04832_remove(struct spi_device *spi)
> +{
> + struct lmk04832 *lmk = spi_get_drvdata(spi);
> +
> +#ifdef CONFIG_DEBUG_FS
Drop the config.
> + debugfs_remove_recursive(lmk->debugfs_dentry);
> +#endif
> + clk_disable_unprepare(lmk->oscin);
> +
> + of_clk_del_provider(spi->dev.of_node);
> +
> + return 0;
> +}
> +static const struct spi_device_id lmk04832_id[] = {
> + { "lmk04832", LMK04832 },
> + {}
> +};
> +MODULE_DEVICE_TABLE(spi, lmk04832_id);
Presumably there's some of_device_id table needed as well?
> +
> +static struct spi_driver lmk04832_driver = {
> + .driver = {
> + .name = "lmk04832",
> + .owner = THIS_MODULE,
Drop this owner line as module_spi_driver() should handle it.
> + },
> + .probe = lmk04832_probe,
> + .remove = lmk04832_remove,
> + .id_table = lmk04832_id,
> +};
> +module_spi_driver(lmk04832_driver);
> +
Powered by blists - more mailing lists