Re: [PATCH v6 4/5] pinctrl: mediatek: Backward compatible to previous Mediatek's bias-pull usage

Sean Wang
2019-09-27T21:44:04Z

Hi,

On Thu, Sep 26, 2019 at 10:02 PM Light Hsieh <light.hsieh@mediatek.com> wrote:
>
> Refine mtk_pinconf_set()/mtk_pinconf_get() for backward compatibility to
> previous Mediatek's bias-pull usage.

MediaTek

> In PINCTRL_MTK that use pinctrl-mtk-common.c, bias-pull setting for pins
> with 2 pull resistors can be specified as value for bias-pull-up and
> bias-pull-down. For example:
> bias-pull-up = <MTK_PUPD_SET_R1R0_00>;
> bias-pull-up = <MTK_PUPD_SET_R1R0_01>;
> bias-pull-up = <MTK_PUPD_SET_R1R0_10>;
> bias-pull-up = <MTK_PUPD_SET_R1R0_11>;
> bias-pull-down = <MTK_PUPD_SET_R1R0_00>;
> bias-pull-down = <MTK_PUPD_SET_R1R0_01>;
> bias-pull-down = <MTK_PUPD_SET_R1R0_10>;
> bias-pull-down = <MTK_PUPD_SET_R1R0_11>;
>
> On the other hand, PINCTRL_MTK_PARIS use customized properties
> "mediatek,pull-up-adv" and "mediatek,pull-down-adv" to specify bias-pull
> setting for pins with 2 pull resistors.
> This introduce in-compatibility in device tree and increatse porting

s/increatse/inscrease/

> effort to Mediatek's customer that had already used PINCTRL_MTK version.

s/Mediatek/MediaTek/

> Besides, if customers are not awared of this change and still write devicetree

s/awared/aware/

> for PINCTRL_MTK version, they may encounter runtime failure with pinctrl and
> spent time to debug.
>
> This patch add backward compatible to previous Mediatek's bias-pull usage

s/add/adds

> so that Mediatek's customer need not use a new devicetree property name.

s/Mediatek/MediaTek/

> The rationale is that: changing driver implemenation had better leave

s/implemenation/implementation/

> interface unchanged.
>

There are many tags missing here too.

> ---
> drivers/pinctrl/mediatek/pinctrl-mt6765.c | 6 +-
> drivers/pinctrl/mediatek/pinctrl-mtk-common-v2.c | 285 +++++++++++++++++++++++
> drivers/pinctrl/mediatek/pinctrl-mtk-common-v2.h | 11 +
> drivers/pinctrl/mediatek/pinctrl-paris.c | 49 ++--
> 4 files changed, 327 insertions(+), 24 deletions(-)
>
> diff --git a/drivers/pinctrl/mediatek/pinctrl-mt6765.c b/drivers/pinctrl/mediatek/pinctrl-mt6765.c
> index bada37f..ae85fdc 100644
> --- a/drivers/pinctrl/mediatek/pinctrl-mt6765.c
> +++ b/drivers/pinctrl/mediatek/pinctrl-mt6765.c
> @@ -1072,10 +1072,8 @@
> .gpio_m = 0,
> .base_names = mt6765_pinctrl_register_base_names,
> .nbase_names = ARRAY_SIZE(mt6765_pinctrl_register_base_names),
> - .bias_disable_set = mtk_pinconf_bias_disable_set,
> - .bias_disable_get = mtk_pinconf_bias_disable_get,
> - .bias_set = mtk_pinconf_bias_set,
> - .bias_get = mtk_pinconf_bias_get,
> + .bias_set_combo = mtk_pinconf_bias_set_combo,
> + .bias_get_combo = mtk_pinconf_bias_get_combo,
> .drive_set = mtk_pinconf_drive_set_direct_val,
> .drive_get = mtk_pinconf_drive_get_direct_val,
> .adv_pull_get = mtk_pinconf_adv_pull_get,
> diff --git a/drivers/pinctrl/mediatek/pinctrl-mtk-common-v2.c b/drivers/pinctrl/mediatek/pinctrl-mtk-common-v2.c
> index acfddf9..6d9972f 100644
> --- a/drivers/pinctrl/mediatek/pinctrl-mtk-common-v2.c
> +++ b/drivers/pinctrl/mediatek/pinctrl-mtk-common-v2.c
> @@ -13,6 +13,8 @@
> #include <linux/io.h>
> #include <linux/of_irq.h>
>
> +#include <dt-bindings/pinctrl/mt65xx.h>
> +

List the header declarations in alphabetic order.

> #include "mtk-eint.h"
> #include "pinctrl-mtk-common-v2.h"
>
> @@ -206,6 +208,20 @@ int mtk_hw_set_value(struct mtk_pinctrl *hw, const struct mtk_pin_desc *desc,
> return 0;
> }
>
> +void mtk_hw_set_value_no_lookup(struct mtk_pinctrl *hw,
> + const struct mtk_pin_desc *desc,
> + int value, struct mtk_pin_field *pf)
> +{
> + if (value < 0 || value > pf->mask)
> + return;
> +
> + if (!pf->next)
> + mtk_rmw(hw, pf->index, pf->offset, pf->mask << pf->bitpos,
> + (value & pf->mask) << pf->bitpos);
> + else
> + mtk_hw_write_cross_field(hw, pf, value);
> +}
> +
> int mtk_hw_get_value(struct mtk_pinctrl *hw, const struct mtk_pin_desc *desc,
> int field, int *value)
> {
> @@ -225,6 +241,17 @@ int mtk_hw_get_value(struct mtk_pinctrl *hw, const struct mtk_pin_desc *desc,
> return 0;
> }
>
> +void mtk_hw_get_value_no_lookup(struct mtk_pinctrl *hw,
> + const struct mtk_pin_desc *desc,
> + int *value, struct mtk_pin_field *pf)
> +{
> + if (!pf->next)
> + *value = (mtk_r32(hw, pf->index, pf->offset)
> + >> pf->bitpos) & pf->mask;
> + else
> + mtk_hw_read_cross_field(hw, pf, value);
> +}
> +

We are able to improve mtk_hw_[set,get]_value with a cache for the
recently visited pin_desc to speed up the subsequent access to the
same register for all clients, rather than creating a specific one
with no_lookup just for a few clients. Generally, all clients should
be able to just apply the mtk_hw_[set,get]_value to compose what they
actually need.

And the changes related to the improvement on mtk_hw_[set,get]_value
with a cache is needed to put to a separate patch prior to the current
one.

> static int mtk_xt_find_eint_num(struct mtk_pinctrl *hw, unsigned long eint_n)
> {
> const struct mtk_pin_desc *desc;
> @@ -517,6 +544,264 @@ int mtk_pinconf_bias_get_rev1(struct mtk_pinctrl *hw,
> return 0;
> }
>
> +/* Combo for the following pull register type:
> + * 1. PU + PD
> + * 2. PULLSEL + PULLEN
> + * 3. PUPD + R0 + R1
> + */
> +int mtk_pinconf_bias_set_pu_pd(struct mtk_pinctrl *hw,

static int

> + const struct mtk_pin_desc *desc,
> + u32 pullup, u32 arg)
> +{
> + struct mtk_pin_field pf;
> + int err = -EINVAL;
> + int pu, pd;

err doesn't need an initialization value, just keeping err in the same
line with pu, pd is fine

> +
> + err = mtk_hw_pin_field_lookup(hw, desc, PINCTRL_PIN_REG_PU, &pf);
> + if (err)
> + goto out;
> +
> + if (arg == MTK_DISABLE) {
> + pu = 0;
> + pd = 0;
> + } else if ((arg == MTK_ENABLE) && pullup) {
> + pu = 1;
> + pd = 0;
> + } else if ((arg == MTK_ENABLE) && !pullup) {
> + pu = 0;
> + pd = 1;
> + } else {
> + goto out;
> + }
> +
> + mtk_hw_set_value_no_lookup(hw, desc, pu, &pf);
> +
> + err = mtk_hw_pin_field_lookup(hw, desc, PINCTRL_PIN_REG_PD, &pf);
> + if (err)
> + goto out;
> +
> + mtk_hw_set_value_no_lookup(hw, desc, pd, &pf);
> +
> +out:
> + return err;
> +}
> +
> +int mtk_pinconf_bias_set_pullsel_pullen(struct mtk_pinctrl *hw,

static int

> + const struct mtk_pin_desc *desc,
> + u32 pullup, u32 arg)
> +{
> + struct mtk_pin_field pf;
> + int err = -EINVAL, enable;

err doesn't need an initialization value

> +
> + err = mtk_hw_pin_field_lookup(hw, desc, PINCTRL_PIN_REG_PULLEN, &pf);
> + if (err)
> + goto out;
> +
> + if (arg == MTK_DISABLE)
> + enable = 0;
> + else if (arg == MTK_ENABLE)
> + enable = 1;
> + else
> + goto out;
> +
> + mtk_hw_set_value_no_lookup(hw, desc, enable, &pf);
> +
> + err = mtk_hw_pin_field_lookup(hw, desc, PINCTRL_PIN_REG_PULLSEL, &pf);
> + if (err)
> + goto out;
> + mtk_hw_set_value_no_lookup(hw, desc, pullup, &pf);
> +
> +out:
> + return err;
> +}
> +
> +int mtk_pinconf_bias_set_pupd_r1_r0(struct mtk_pinctrl *hw,

static int

> + const struct mtk_pin_desc *desc,
> + u32 pullup, u32 arg)
> +{
> + struct mtk_pin_field pf;
> + int err = -EINVAL;
> + int r0, r1;

err doesn't need an initialization value, just keeping err in the same
line with r0 and r1 is fine

> +
> + err = mtk_hw_pin_field_lookup(hw, desc, PINCTRL_PIN_REG_PUPD, &pf);
> + if (err)
> + goto out;
> +
> + if ((arg == MTK_DISABLE) || (arg == MTK_PUPD_SET_R1R0_00)) {
> + pullup = 0;
> + r0 = 0;
> + r1 = 0;
> + } else if (arg == MTK_PUPD_SET_R1R0_01) {
> + r0 = 1;
> + r1 = 0;
> + } else if (arg == MTK_PUPD_SET_R1R0_10) {
> + r0 = 0;
> + r1 = 1;
> + } else if (arg == MTK_PUPD_SET_R1R0_11) {
> + r0 = 1;
> + r1 = 1;
> + } else
> + goto out;
> +
> + /* MTK HW PUPD bit: 1 for pull-down, 0 for pull-up */
> + mtk_hw_set_value_no_lookup(hw, desc, !pullup, &pf);
> +
> + err = mtk_hw_pin_field_lookup(hw, desc, PINCTRL_PIN_REG_R0, &pf);
> + if (err)
> + goto out;
> + mtk_hw_set_value_no_lookup(hw, desc, r0, &pf);
> +
> + err = mtk_hw_pin_field_lookup(hw, desc, PINCTRL_PIN_REG_R1, &pf);
> + if (err)
> + goto out;
> + mtk_hw_set_value_no_lookup(hw, desc, r1, &pf);
> +
> +out:
> + return err;
> +}
> +
> +int mtk_pinconf_bias_get_pu_pd(struct mtk_pinctrl *hw,
> + const struct mtk_pin_desc *desc,
> + u32 *pullup, u32 *enable)

static int

> +{
> + struct mtk_pin_field pf;
> + int err = -EINVAL;
> + int pu, pd;

err doesn't need an initialization value, just keeping err in the same
line with pu, pd is fine

> +
> + err = mtk_hw_pin_field_lookup(hw, desc, PINCTRL_PIN_REG_PU, &pf);
> + if (err)
> + goto out;
> +
> + mtk_hw_get_value_no_lookup(hw, desc, &pu, &pf);
> +
> + err = mtk_hw_pin_field_lookup(hw, desc, PINCTRL_PIN_REG_PD, &pf);
> + if (err)
> + goto out;
> +
> + mtk_hw_get_value_no_lookup(hw, desc, &pd, &pf);
> +
> + if (pu == 0 && pd == 0) {
> + *pullup = 0;
> + *enable = MTK_DISABLE;
> + } else if (pu == 1 && pd == 0) {
> + *pullup = 1;
> + *enable = MTK_ENABLE;
> + } else if (pu == 0 && pd == 1) {
> + *pullup = 0;
> + *enable = MTK_ENABLE;
> + } else {
> + err = -EINVAL;
> + goto out;
> + }
> +
> +out:
> + return err;
> +}
> +
> +int mtk_pinconf_bias_get_pullsel_pullen(struct mtk_pinctrl *hw,
> + const struct mtk_pin_desc *desc,
> + u32 *pullup, u32 *enable)

static int

> +{
> + struct mtk_pin_field pf;
> + int err = -EINVAL;
> +

err doesn't need an initialization value

> + err = mtk_hw_pin_field_lookup(hw, desc, PINCTRL_PIN_REG_PULLSEL, &pf);
> + if (err)
> + goto out;
> +
> + mtk_hw_get_value_no_lookup(hw, desc, pullup, &pf);
> +
> + err = mtk_hw_pin_field_lookup(hw, desc, PINCTRL_PIN_REG_PULLEN, &pf);
> + if (err)
> + goto out;
> +
> + mtk_hw_get_value_no_lookup(hw, desc, enable, &pf);
> +
> +out:
> + return err;
> +}
> +
> +int mtk_pinconf_bias_get_pupd_r1_r0(struct mtk_pinctrl *hw,
> + const struct mtk_pin_desc *desc,
> + u32 *pullup, u32 *enable)

static int

> +{
> + struct mtk_pin_field pf;
> + int err = -EINVAL;
> + int r0, r1;
> +

err doesn't need an initialization value, just keeping err in the same
line with r0, r1 is fine

> + err = mtk_hw_pin_field_lookup(hw, desc, PINCTRL_PIN_REG_PUPD, &pf);
> + if (err)
> + goto out;
> +
> + /* MTK HW PUPD bit: 1 for pull-down, 0 for pull-up */
> + mtk_hw_get_value_no_lookup(hw, desc, pullup, &pf);
> + *pullup = !(*pullup);
> +
> + err = mtk_hw_pin_field_lookup(hw, desc, PINCTRL_PIN_REG_R0, &pf);
> + if (err)
> + goto out;
> + mtk_hw_get_value_no_lookup(hw, desc, &r0, &pf);
> +
> + err = mtk_hw_pin_field_lookup(hw, desc, PINCTRL_PIN_REG_R1, &pf);
> + if (err)
> + goto out;
> + mtk_hw_get_value_no_lookup(hw, desc, &r1, &pf);
> +
> + if ((r1 == 0) && (r0 == 0))
> + *enable = MTK_PUPD_SET_R1R0_00;
> + else if ((r1 == 0) && (r0 == 1))
> + *enable = MTK_PUPD_SET_R1R0_01;
> + else if ((r1 == 1) && (r0 == 0))
> + *enable = MTK_PUPD_SET_R1R0_10;
> + else if ((r1 == 1) && (r0 == 1))
> + *enable = MTK_PUPD_SET_R1R0_11;
> + else
> + goto out;
> +
> +out:
> + return err;
> +}
> +
> +int mtk_pinconf_bias_set_combo(struct mtk_pinctrl *hw,
> + const struct mtk_pin_desc *desc,
> + u32 pullup, u32 arg)
> +{
> + int err;
> +
> + err = mtk_pinconf_bias_set_pu_pd(hw, desc, pullup, arg);
> + if (!err)
> + goto out;
> +
> + err = mtk_pinconf_bias_set_pullsel_pullen(hw, desc, pullup, arg);
> + if (!err)
> + goto out;
> +
> + err = mtk_pinconf_bias_set_pupd_r1_r0(hw, desc, pullup, arg);
> +
> +out:
> + return err;
> +}
> +
> +int mtk_pinconf_bias_get_combo(struct mtk_pinctrl *hw,
> + const struct mtk_pin_desc *desc,
> + u32 *pullup, u32 *enable)
> +{
> + int err;
> +
> + err = mtk_pinconf_bias_get_pu_pd(hw, desc, pullup, enable);
> + if (!err)
> + goto out;
> +
> + err = mtk_pinconf_bias_get_pullsel_pullen(hw, desc, pullup, enable);
> + if (!err)
> + goto out;
> +
> + err = mtk_pinconf_bias_get_pupd_r1_r0(hw, desc, pullup, enable);
> +
> +out:
> + return err;
> +}
> +
> /* Revision 0 */
> int mtk_pinconf_drive_set(struct mtk_pinctrl *hw,
> const struct mtk_pin_desc *desc, u32 arg)
> diff --git a/drivers/pinctrl/mediatek/pinctrl-mtk-common-v2.h b/drivers/pinctrl/mediatek/pinctrl-mtk-common-v2.h
> index b3bada0..a13dcae 100644
> --- a/drivers/pinctrl/mediatek/pinctrl-mtk-common-v2.h
> +++ b/drivers/pinctrl/mediatek/pinctrl-mtk-common-v2.h
> @@ -216,6 +216,11 @@ struct mtk_pin_soc {
> int (*bias_get)(struct mtk_pinctrl *hw,
> const struct mtk_pin_desc *desc, bool pullup, int *res);
>
> + int (*bias_set_combo)(struct mtk_pinctrl *hw,
> + const struct mtk_pin_desc *desc, u32 pullup, u32 arg);
> + int (*bias_get_combo)(struct mtk_pinctrl *hw,
> + const struct mtk_pin_desc *desc, u32 *pullup, u32 *arg);
> +
> int (*drive_set)(struct mtk_pinctrl *hw,
> const struct mtk_pin_desc *desc, u32 arg);
> int (*drive_get)(struct mtk_pinctrl *hw,
> @@ -277,6 +282,12 @@ int mtk_pinconf_bias_set_rev1(struct mtk_pinctrl *hw,
> int mtk_pinconf_bias_get_rev1(struct mtk_pinctrl *hw,
> const struct mtk_pin_desc *desc, bool pullup,
> int *res);
> +int mtk_pinconf_bias_set_combo(struct mtk_pinctrl *hw,
> + const struct mtk_pin_desc *desc,
> + u32 pullup, u32 enable);
> +int mtk_pinconf_bias_get_combo(struct mtk_pinctrl *hw,
> + const struct mtk_pin_desc *desc,
> + u32 *pullup, u32 *enable);
>
> int mtk_pinconf_drive_set(struct mtk_pinctrl *hw,
> const struct mtk_pin_desc *desc, u32 arg);
> diff --git a/drivers/pinctrl/mediatek/pinctrl-paris.c b/drivers/pinctrl/mediatek/pinctrl-paris.c
> index 54f069b..2a47c45 100644
> --- a/drivers/pinctrl/mediatek/pinctrl-paris.c
> +++ b/drivers/pinctrl/mediatek/pinctrl-paris.c
> @@ -79,6 +79,7 @@ static int mtk_pinconf_get(struct pinctrl_dev *pctldev,
> struct mtk_pinctrl *hw = pinctrl_dev_get_drvdata(pctldev);
> u32 param = pinconf_to_config_param(*config);
> int err, reg, ret = 1;
> + int pullup;

Keep pullup the same line with other value with the type

> const struct mtk_pin_desc *desc;
>
> if (pin >= hw->soc->npins) {
> @@ -89,22 +90,31 @@ static int mtk_pinconf_get(struct pinctrl_dev *pctldev,
>
> switch (param) {
> case PIN_CONFIG_BIAS_DISABLE:
> - if (hw->soc->bias_disable_get)
> - err = hw->soc->bias_disable_get(hw, desc, &ret);
> - else
> - err = -ENOTSUPP;
> - break;
> case PIN_CONFIG_BIAS_PULL_UP:
> - if (hw->soc->bias_get)
> - err = hw->soc->bias_get(hw, desc, 1, &ret);
> - else
> - err = -ENOTSUPP;
> - break;
> case PIN_CONFIG_BIAS_PULL_DOWN:
> - if (hw->soc->bias_get)
> - err = hw->soc->bias_get(hw, desc, 0, &ret);
> - else
> + if (hw->soc->bias_get_combo) {
> + err = hw->soc->bias_get_combo(hw, desc, &pullup, &ret);
> + if (err)
> + goto out;
> + if (param == PIN_CONFIG_BIAS_DISABLE) {
> + if (ret == MTK_PUPD_SET_R1R0_00)
> + ret = MTK_DISABLE;
> + } else if (param == PIN_CONFIG_BIAS_PULL_UP) {
> + /* When desire to get pull-up value,
> + * return error if current setting is pull-down
> + */

Keep the line close to 80 char alignment as much as possible.

> + if (!pullup)
> + err = -EINVAL;
> + } else if (param == PIN_CONFIG_BIAS_PULL_DOWN) {
> + /* When desire to get pull-down value,
> + * return error if current setting is pull-up
> + */

Keep the line close to 80 char alignment as much as possible.

> + if (pullup)
> + err = -EINVAL;
> + }
> + } else {

We don't remove the old usage (->bias_get and bias_disable_get) and
instead keep two ways exist for a while until all driver such as
MT8183 driver using the core is being switched into new old you
proposed here.

> err = -ENOTSUPP;
> + }
> break;
> case PIN_CONFIG_SLEW_RATE:
> err = mtk_hw_get_value(hw, desc, PINCTRL_PIN_REG_SR, &ret);
> @@ -196,20 +206,20 @@ static int mtk_pinconf_set(struct pinctrl_dev *pctldev, unsigned int pin,
>
> switch ((u32)param) {
> case PIN_CONFIG_BIAS_DISABLE:
> - if (hw->soc->bias_disable_set)
> - err = hw->soc->bias_disable_set(hw, desc);
> + if (hw->soc->bias_set_combo)
> + err = hw->soc->bias_set_combo(hw, desc, 0, MTK_DISABLE);
> else
> err = -ENOTSUPP;
> break;
> case PIN_CONFIG_BIAS_PULL_UP:
> - if (hw->soc->bias_set)
> - err = hw->soc->bias_set(hw, desc, 1);
> + if (hw->soc->bias_set_combo)
> + err = hw->soc->bias_set_combo(hw, desc, 1, arg);
> else
> err = -ENOTSUPP;
> break;
> case PIN_CONFIG_BIAS_PULL_DOWN:
> - if (hw->soc->bias_set)
> - err = hw->soc->bias_set(hw, desc, 0);
> + if (hw->soc->bias_set_combo)
> + err = hw->soc->bias_set_combo(hw, desc, 0, arg);

Ditto as the above

> else
> err = -ENOTSUPP;
> break;
> @@ -899,7 +909,6 @@ int mtk_paris_pinctrl_probe(struct platform_device *pdev,
> return 0;
> }
>
> -

Remove the needless change

> static int mtk_paris_pinctrl_suspend(struct device *device)
> {
> struct mtk_pinctrl *pctl = dev_get_drvdata(device);
> --
> 1.8.1.1.dirty
>