Re: [PATCH v9 2/2] phy: Add driver for mixel mipi dphy found on NXP's i.MX8 SoCs

[Guido Günther]

Hi,
On Tue, Apr 30, 2019 at 10:31:08PM +0200, Sam Ravnborg wrote:
> Hi Guido.
> 
> Took a look at this, but feedback is trivial as
> I have no experience with PHYs so use only
> the feedback you consider relevant.

They all made sense so I've incorporated them for v10.

> 
> 	Sam
> 
> > diff --git a/drivers/phy/freescale/phy-fsl-imx8-mipi-dphy.c b/drivers/phy/freescale/phy-fsl-imx8-mipi-dphy.c
> > new file mode 100644
> > index 000000000000..d6b5af0b3380
> > --- /dev/null
> > +++ b/drivers/phy/freescale/phy-fsl-imx8-mipi-dphy.c
> > @@ -0,0 +1,506 @@
> > +// SPDX-License-Identifier: GPL-2.0+
> > +/*
> > + * Copyright 2017,2018 NXP
> > + * Copyright 2019 Purism SPC
> > + */
> > +
> > +
> > +/* DPHY registers */
> > +#define DPHY_PD_DPHY			0x00
> > +#define DPHY_M_PRG_HS_PREPARE		0x04
> > +#define DPHY_MC_PRG_HS_PREPARE		0x08
> > +#define DPHY_M_PRG_HS_ZERO		0x0c
> > +#define DPHY_MC_PRG_HS_ZERO		0x10
> > +#define DPHY_M_PRG_HS_TRAIL		0x14
> > +#define DPHY_MC_PRG_HS_TRAIL		0x18
> > +#define DPHY_PD_PLL			0x1c
> > +#define DPHY_TST			0x20
> > +#define DPHY_CN				0x24
> > +#define DPHY_CM				0x28
> > +#define DPHY_CO				0x2c
> > +#define DPHY_LOCK			0x30
> > +#define DPHY_LOCK_BYP			0x34
> > +#define DPHY_REG_BYPASS_PLL		0x4C
> > +
> > +#define MBPS(x) ((x) * 1000000)
> > +
> > +#define DATA_RATE_MAX_SPEED MBPS(1500)
> > +#define DATA_RATE_MIN_SPEED MBPS(80)
> > +
> > +#define PLL_LOCK_SLEEP 10
> > +#define PLL_LOCK_TIMEOUT 1000
> > +
> > +#define CN_BUF	0xcb7a89c0
> > +#define CO_BUF	0x63
> > +#define CM(x)	(				\
> > +		((x) <	32)?0xe0|((x)-16) :	\
> > +		((x) <	64)?0xc0|((x)-32) :	\
> > +		((x) < 128)?0x80|((x)-64) :	\
> > +		((x) - 128))
> > +#define CN(x)	(((x) == 1)?0x1f : (((CN_BUF)>>((x)-1))&0x1f))
> > +#define CO(x)	((CO_BUF)>>(8-(x))&0x3)
> > +
> > +/* PHY power on is active low */
> > +#define PWR_ON	0
> > +#define PWR_OFF	1
> > +
> > +enum mixel_dphy_devtype {
> > +	MIXEL_IMX8MQ,
> > +};
> > +
> > +struct mixel_dphy_devdata {
> > +	u8 reg_tx_rcal;
> > +	u8 reg_auto_pd_en;
> > +	u8 reg_rxlprp;
> > +	u8 reg_rxcdrp;
> > +	u8 reg_rxhs_settle;
> > +};
> > +
> > +static const struct mixel_dphy_devdata mixel_dphy_devdata[] = {
> > +	[MIXEL_IMX8MQ] = {
> > +		.reg_tx_rcal = 0x38,
> > +		.reg_auto_pd_en = 0x3c,
> > +		.reg_rxlprp = 0x40,
> > +		.reg_rxcdrp = 0x44,
> > +		.reg_rxhs_settle = 0x48,
> > +	},
> > +};
> > +
> > +struct mixel_dphy_cfg {
> > +	/* DPHY PLL parameters */
> > +	u32 cm;
> > +	u32 cn;
> > +	u32 co;
> > +	/* DPHY register values */
> > +	u8 mc_prg_hs_prepare;
> > +	u8 m_prg_hs_prepare;
> > +	u8 mc_prg_hs_zero;
> > +	u8 m_prg_hs_zero;
> > +	u8 mc_prg_hs_trail;
> > +	u8 m_prg_hs_trail;
> > +	u8 rxhs_settle;
> > +};
> > +
> > +struct mixel_dphy_priv {
> > +	struct mixel_dphy_cfg cfg;
> > +	struct regmap *regs;
> It is a little confusing that the regmap is named regs.
> As regs in many other cases is used as name for the variable
> with pointer to registers.
> See for example call to devm_regmap_init_mmio()

Changed to regmap and base.

> 
> > +	struct clk *phy_ref_clk;
> > +	const struct mixel_dphy_devdata *devdata;
> > +};
> > +
> > +static const struct regmap_config mixel_dphy_regmap_config = {
> > +	.reg_bits = 8,
> > +	.val_bits = 32,
> > +	.reg_stride = 4,
> > +	.max_register = DPHY_REG_BYPASS_PLL,
> > +	.name = "mipi-dphy",
> > +};
> > +
> > +static int phy_write(struct phy *phy, u32 value, unsigned int reg)
> > +{
> > +	struct mixel_dphy_priv *priv = phy_get_drvdata(phy);
> > +	int ret;
> > +
> > +	ret = regmap_write(priv->regs, reg, value);
> > +	if (ret < 0)
> > +		dev_err(&phy->dev, "Failed to write DPHY reg %d: %d", reg, ret);
> > +	return ret;
> > +}
> > +
> > +/*
> > + * Find a ratio close to the desired one using continued fraction
> > + * approximation ending either at exact match or maximum allowed
> > + * nominator, denominator.
> > + */
> > +static void get_best_ratio(u32 *pnum, u32 *pdenom, unsigned int max_n,
> > +			   unsigned int max_d)
> > +{
> Maybe use u32 for all parameters?
> That would also match usage below.

Less confusing, done.

> 
> > +	u32 a = *pnum;
> > +	u32 b = *pdenom;
> > +	u32 c;
> > +	u32 n[] = {0, 1};
> > +	u32 d[] = {1, 0};
> > +	u32 whole;
> > +	unsigned int i = 1;
> > +
> > +	while (b) {
> > +		i ^= 1;
> > +		whole = a / b;
> > +		n[i] += (n[i ^ 1] * whole);
> > +		d[i] += (d[i ^ 1] * whole);
> > +		if ((n[i] > max_n) || (d[i] > max_d)) {
> > +			i ^= 1;
> > +			break;
> > +		}
> > +		c = a - (b * whole);
> > +		a = b;
> > +		b = c;
> > +	}
> > +	*pnum = n[i];
> > +	*pdenom = d[i];
> > +}
> > +
> > +static int mixel_dphy_config_from_opts(struct phy *phy,
> > +	       struct phy_configure_opts_mipi_dphy *dphy_opts,
> > +	       struct mixel_dphy_cfg *cfg)
> > +{
> > +	struct mixel_dphy_priv *priv = dev_get_drvdata(phy->dev.parent);
> > +	unsigned long ref_clk = clk_get_rate(priv->phy_ref_clk);
> > +	u32 lp_t, numerator, denominator;
> > +	unsigned long long tmp;
> > +	u32 n;
> > +	int i;
> > +
> > +	if (dphy_opts->hs_clk_rate > DATA_RATE_MAX_SPEED ||
> > +	    dphy_opts->hs_clk_rate < DATA_RATE_MIN_SPEED)
> > +		return -EINVAL;
> > +
> > +	numerator = dphy_opts->hs_clk_rate;
> > +	denominator = ref_clk;
> > +	get_best_ratio(&numerator, &denominator, 255, 256);
> > +	if (!numerator || !denominator) {
> > +		dev_err(&phy->dev, "Invalid %d/%d for %ld/%ld\n",
> > +			numerator, denominator,
> > +			dphy_opts->hs_clk_rate, ref_clk);
> > +		return -EINVAL;
> > +	}
> > +
> > +	while ((numerator < 16) && (denominator <= 128)) {
> > +		numerator <<= 1;
> > +		denominator <<= 1;
> > +	}
> > +	/*
> > +	 * CM ranges between 16 and 255
> > +	 * CN ranges between 1 and 32
> > +	 * CO is power of 2: 1, 2, 4, 8
> > +	 */
> > +	i = __ffs(denominator);
> > +	if (i > 3)
> > +		i = 3;
> > +	cfg->cn = denominator >> i;
> > +	cfg->co = 1 << i;
> > +	cfg->cm = numerator;
> > +
> > +	if (cfg->cm < 16 || cfg->cm > 255 ||
> > +	    cfg->cn < 1 || cfg->cn > 32 ||
> > +	    cfg->co < 1 || cfg->co > 8) {
> > +		dev_err(&phy->dev, "Invalid CM/CN/CO values: %u/%u/%u\n",
> > +			cfg->cm, cfg->cn, cfg->co);
> > +		dev_err(&phy->dev, "for hs_clk/ref_clk=%ld/%ld â %d/%d\n",
> Hmm, my mutt does not like this symbol?  â

Changed to the ascii '~'.

> 
> > +
> > +	phy_write(phy, PWR_ON, DPHY_PD_PLL);
> > +	ret = regmap_read_poll_timeout(priv->regs, DPHY_LOCK, locked,
> > +				       locked, PLL_LOCK_SLEEP,
> > +				       PLL_LOCK_TIMEOUT);
> > +	if (ret < 0) {
> > +		dev_err(&phy->dev, "Could not get DPHY lock (%d)!\n", ret);
> > +		goto clock_disable;
> > +	}
> > +	phy_write(phy, PWR_ON, DPHY_PD_DPHY);
> 
> Are then no other timing constrains than the poll of DPHY_LOCK?
> Some panel (I know this is not a panel, but amyway) have some
> ridgid timing constrains around power ON/OFF.

NXPs BSP doesn't have any additional timing constraints and that's the
best we have in that area. Even the new imx8mq reference manual
published last week isn't any more precise regarding DPHY power up.
> 
> > +
> > +MODULE_AUTHOR("NXP Semiconductor");
> > +MODULE_DESCRIPTION("Mixel MIPI-DSI PHY driver");
> 
> > +MODULE_LICENSE("GPL v2");
> Does this match the SPDX tag?

I've changed this to MODULE_LICENSE("GPL") since this seems to be used
by driver that are v2+.

> "
> > +// SPDX-License-Identifier: GPL-2.0+
> "
> 
Thanks!
 -- Guido