[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-ID: <das6ud7gep5hrcdn4bnmoyl2pb7okbxslpnawch2osaezd6xm5@psbizlufjec4>
Date: Fri, 16 Jan 2026 19:29:39 +0800
From: Xu Yang <xu.yang_2@....com>
To: Frank Li <Frank.li@....com>
Cc: vkoul@...nel.org, neil.armstrong@...aro.org, shawnguo@...nel.org,
kernel@...gutronix.de, festevam@...il.com, jun.li@....com,
linux-phy@...ts.infradead.org, imx@...ts.linux.dev, linux-arm-kernel@...ts.infradead.org,
linux-kernel@...r.kernel.org
Subject: Re: [PATCH v3] phy: fsl-imx8mq-usb: add debugfs to access control
register
On Thu, Jan 08, 2026 at 10:43:01AM -0500, Frank Li wrote:
> On Thu, Jan 08, 2026 at 04:36:41PM +0800, Xu Yang wrote:
> > The CR port is a simple 16-bit data/address parallel port that is
> > provided for on-chip access to the control registers inside the
> > USB 3.0 femtoPHY[1].
>
>
> > While access to these registers is not required
> > for normal PHY operation, this interface enables you to access
> > some of the PHY’s diagnostic features during normal operation or
> > to override some basic PHY control signals.
>
> Simple said "Export these registers by debugfs to help PHY’s diagnostic."
> should be enough
OK.
>
> >
> > 3 debugfs files are created to read and write control registers,
> > all use hexadecimal format:
> > ctrl_reg_base: the register offset to write, or the start offset
> > to read.
> > ctrl_reg_count: how many continuous registers to be read.
> > ctrl_reg_value: read to show the continuous registers value from
> > the offset in ctrl_reg_base, to ctrl_reg_base
> > + ctrl_reg_count - 1, one line for one register.
> > when write, override the register at ctrl_reg_base,
> > one time can only change one 16bits register.
>
> how many regs? how about create file regNNN,
>From 0x0 to 0x201F.
>
> cat/echo to regNNN?
Only regNNN seems not convenient to dump non-fixed number of registers.
>
> or create export file
>
> echo 100 > export, then create REG100, so can use cat/echo modify it.
If use export, it seems need a place to doc these information. It's not
straightforward to use.
>
>
> >
> > Link[1]: https://www.synopsys.com/dw/doc.php/phy/usb3.0/femto/phy/x652_usb3_ss14lpp_18_ns/4.07a/dwc_usb3.0_femtophy_ss14lpp_08V18V_x1_databook.pdf
> > Signed-off-by: Li Jun <jun.li@....com>
> > Signed-off-by: Xu Yang <xu.yang_2@....com>
> >
> > ---
> > Changes in v3:
> > - add documentation link of registers
> > Changes in v2:
> > - correct copyright
> > - add imx8mq_phy_wait_for_cr_ack() helper and use it
> > - use DEFINE_SHOW_STORE_ATTRIBUTE()
> > - directly create debugfs file under imx phy debugfs
> > - remove debug_remove_files() since the phy core will handle it
> > ---
> > drivers/phy/freescale/phy-fsl-imx8mq-usb.c | 180 ++++++++++++++++++++-
> > 1 file changed, 178 insertions(+), 2 deletions(-)
> >
> > diff --git a/drivers/phy/freescale/phy-fsl-imx8mq-usb.c b/drivers/phy/freescale/phy-fsl-imx8mq-usb.c
> > index 95f9264bd0f7..e11054f6673c 100644
> > --- a/drivers/phy/freescale/phy-fsl-imx8mq-usb.c
> > +++ b/drivers/phy/freescale/phy-fsl-imx8mq-usb.c
> > @@ -1,10 +1,11 @@
> > // SPDX-License-Identifier: GPL-2.0+
> > -/* Copyright (c) 2017 NXP. */
> > +/* Copyright 2017-2025 NXP. */
> >
> > #include <linux/bitfield.h>
> > #include <linux/clk.h>
> > +#include <linux/debugfs.h>
> > #include <linux/delay.h>
> > -#include <linux/io.h>
> > +#include <linux/iopoll.h>
> > #include <linux/module.h>
> > #include <linux/of.h>
> > #include <linux/phy/phy.h>
> > @@ -57,6 +58,20 @@
> >
> > #define PHY_TUNE_DEFAULT 0xffffffff
> >
> > +/* PHY control register access */
> > +#define PHY_CTRL_REG_OFFSET_MAX 0x201f
> > +
> > +#define PHY_CRCTL 0x30
> > +#define PHY_CRCTL_DATA_IN_MASK GENMASK(15, 0)
> > +#define PHY_CRCTL_CAP_ADDR BIT(16)
> > +#define PHY_CRCTL_CAP_DATA BIT(17)
> > +#define PHY_CRCTL_CR_WRITE BIT(18)
> > +#define PHY_CRCTL_CR_READ BIT(19)
> > +
> > +#define PHY_CRSR 0x34
> > +#define PHY_CRSR_DATA_OUT_MASK GENMASK(15, 0)
> > +#define PHY_CRSR_CR_ACK BIT(16)
> > +
> > #define TCA_CLK_RST 0x00
> > #define TCA_CLK_RST_SW BIT(9)
> > #define TCA_CLK_RST_REF_CLK_EN BIT(1)
> > @@ -118,6 +133,9 @@ struct imx8mq_usb_phy {
> > void __iomem *base;
> > struct regulator *vbus;
> > struct tca_blk *tca;
> > + struct dentry *debugfs;
> > + u16 cr_access_base;
> > + u16 cr_read_count;
> > u32 pcs_tx_swing_full;
> > u32 pcs_tx_deemph_3p5db;
> > u32 tx_vref_tune;
> > @@ -411,6 +429,163 @@ static u32 phy_pcs_tx_swing_full_from_property(u32 percent)
> > percent = min(percent, 100U);
> >
> > return (percent * 127) / 100;
> > +};
> > +
> > +static int imx8mq_phy_wait_for_cr_ack(struct imx8mq_usb_phy *imx_phy,
> > + u32 stage, u32 *data)
> > +{
> > + void __iomem *cr_ctrl = imx_phy->base + PHY_CRCTL;
> > + void __iomem *cr_sr = imx_phy->base + PHY_CRSR;
> > + u32 val;
> > + int ret;
> > +
> > + writel(readl(cr_ctrl) | stage, cr_ctrl);
> > + /* Wait CRSR[16] == 1 */
> > + ret = readl_poll_timeout(cr_sr, val,
> > + (val & PHY_CRSR_CR_ACK) == PHY_CRSR_CR_ACK,
> > + 1, 100);
> > + if (ret)
> > + return ret;
> > +
> > + if (stage == PHY_CRCTL_CR_READ)
> > + *data = readl(cr_sr) & 0xffff;
> > +
> > + writel(readl(cr_ctrl) & (~stage), cr_ctrl);
> > + /* Wait CRSR[16] == 0 */
> > + return readl_poll_timeout(cr_sr, val, (val & PHY_CRSR_CR_ACK) == 0, 1, 100);
> > +}
> > +
> > +static int imx8mq_phy_ctrl_reg_addr(struct imx8mq_usb_phy *imx_phy, u16 offset)
> > +{
> > + void __iomem *cr_ctrl = imx_phy->base + PHY_CRCTL;
> > + struct device *dev = &imx_phy->phy->dev;
> > + int ret;
> > +
> > + writel(offset, cr_ctrl);
> > + ret = imx8mq_phy_wait_for_cr_ack(imx_phy, PHY_CRCTL_CAP_ADDR, NULL);
> > + if (ret < 0) {
> > + dev_err(dev, "Failed to address reg 0x%04x\n", offset);
> > + return -EIO;
> > + }
> > +
> > + return 0;
> > +}
> > +
> > +static int imx8mq_phy_ctrl_reg_read(struct imx8mq_usb_phy *imx_phy,
> > + u16 offset, u32 *val)
> > +{
> > + struct device *dev = &imx_phy->phy->dev;
> > + int ret;
> > +
> > + if (offset > PHY_CTRL_REG_OFFSET_MAX) {
> > + dev_err(dev, "Invalid reg address 0x%04x\n", offset);
> > + return -EINVAL;
> > + }
> > +
> > + /* Address stage */
> > + ret = imx8mq_phy_ctrl_reg_addr(imx_phy, offset);
> > + if (ret)
> > + return ret;
> > +
> > + /* Read data stage */
> > + ret = imx8mq_phy_wait_for_cr_ack(imx_phy, PHY_CRCTL_CR_READ, val);
> > + if (ret < 0) {
> > + dev_err(dev, "Failed to read reg 0x%04x\n", offset);
> > + return -EIO;
> > + }
> > +
> > + return ret;
> > +}
> > +
> > +static int imx8mq_phy_ctrl_reg_write(struct imx8mq_usb_phy *imx_phy,
> > + u16 offset, u16 val)
> > +{
> > + struct device *dev = &imx_phy->phy->dev;
> > + void __iomem *cr_ctrl = imx_phy->base + PHY_CRCTL;
> > + int ret;
> > +
> > + if (offset > PHY_CTRL_REG_OFFSET_MAX) {
> > + dev_err(dev, "Invalid reg address 0x%04x\n", offset);
> > + return -EINVAL;
> > + }
> > +
> > + /* Address stage */
> > + ret = imx8mq_phy_ctrl_reg_addr(imx_phy, offset);
> > + if (ret)
> > + return ret;
> > +
> > + /* Capture data stage */
> > + writel(val, cr_ctrl);
> > + ret = imx8mq_phy_wait_for_cr_ack(imx_phy, PHY_CRCTL_CAP_DATA, NULL);
> > + if (ret < 0)
> > + goto cr_write_err;
> > +
> > + /* Write data stage */
> > + ret = imx8mq_phy_wait_for_cr_ack(imx_phy, PHY_CRCTL_CR_WRITE, NULL);
> > + if (ret < 0)
> > + goto cr_write_err;
> > +
> > + return 0;
> > +
> > +cr_write_err:
> > + dev_err(dev, "Failed to write reg 0x%04x\n", offset);
> > + return -EIO;
> > +}
> > +
> > +static int ctrl_reg_value_show(struct seq_file *s, void *unused)
> > +{
> > + struct imx8mq_usb_phy *imx_phy = s->private;
> > + u16 base = imx_phy->cr_access_base;
> > + u32 val;
> > + int i, ret;
> > +
> > + for (i = 0; i < imx_phy->cr_read_count; i++) {
> > + ret = imx8mq_phy_ctrl_reg_read(imx_phy, base + i, &val);
> > + if (ret < 0)
> > + return ret;
> > +
> > + seq_printf(s, "Control Register 0x%04x value is 0x%04x\n",
> > + base + i, val);
> > + }
> > +
> > + return 0;
> > +}
> > +
> > +static ssize_t ctrl_reg_value_write(struct file *file, const char __user *ubuf,
> > + size_t count, loff_t *ppos)
> > +
> > +{
> > + struct seq_file *s = file->private_data;
> > + struct imx8mq_usb_phy *imx_phy = s->private;
> > + u16 cr_value;
> > + int ret;
> > +
> > + ret = kstrtou16_from_user(ubuf, count, 16, &cr_value);
> > + if (ret)
> > + return ret;
> > +
> > + ret = imx8mq_phy_ctrl_reg_write(imx_phy, imx_phy->cr_access_base, cr_value);
> > + if (ret)
> > + return ret;
> > +
> > + return count;
> > +}
> > +
> > +DEFINE_SHOW_STORE_ATTRIBUTE(ctrl_reg_value);
> > +
> > +static void imx8m_create_debug_files(struct imx8mq_usb_phy *imx_phy)
> > +{
> > + struct dentry *debugfs = imx_phy->phy->debugfs;
> > +
> > + debugfs_create_x16("ctrl_reg_base", 0600, debugfs,
> > + &imx_phy->cr_access_base);
> > + debugfs_create_x16("ctrl_reg_count", 0600, debugfs,
> > + &imx_phy->cr_read_count);
> > + debugfs_create_file("ctrl_reg_value", 0600, debugfs,
> > + imx_phy, &ctrl_reg_value_fops);
> > +
> > + imx_phy->cr_access_base = 0;
> > + imx_phy->cr_read_count = 1;
> > }
> >
> > static void imx8m_get_phy_tuning_data(struct imx8mq_usb_phy *imx_phy)
> > @@ -731,6 +906,7 @@ static int imx8mq_usb_phy_probe(struct platform_device *pdev)
> > "failed to get tca\n");
> >
> > imx8m_get_phy_tuning_data(imx_phy);
> > + imx8m_create_debug_files(imx_phy);
>
> where remove debug fs?
phy core will remove debug fs when call phy_release().
Thanks,
Xu Yang
>
> Frank
> >
> > phy_provider = devm_of_phy_provider_register(dev, of_phy_simple_xlate);
> >
> > --
> > 2.34.1
> >
Powered by blists - more mailing lists