diff mbox series

[v12,04/13] mfd: Add Ingenic TCU driver

Message ID 20190521145141.9813-5-paul@crapouillou.net (mailing list archive)
State Not Applicable, archived
Headers show
Series [v12,01/13] dt-bindings: ingenic: Add DT bindings for TCU clocks | expand

Commit Message

Paul Cercueil May 21, 2019, 2:51 p.m. UTC
This driver will provide a regmap that can be retrieved very early in
the boot process through the API function ingenic_tcu_get_regmap().

Additionally, it will call devm_of_platform_populate() so that all the
children devices will be probed.

Signed-off-by: Paul Cercueil <paul@crapouillou.net>
---

Notes:
    v12: New patch

 drivers/mfd/Kconfig             |   8 +++
 drivers/mfd/Makefile            |   1 +
 drivers/mfd/ingenic-tcu.c       | 113 ++++++++++++++++++++++++++++++++
 include/linux/mfd/ingenic-tcu.h |   8 +++
 4 files changed, 130 insertions(+)
 create mode 100644 drivers/mfd/ingenic-tcu.c

Comments

Paul Cercueil June 22, 2019, 12:21 p.m. UTC | #1
Hi,

I'll make a V13 of this patchset on top of -rc6, any feedback
for this MFD driver? It's been already one month.

Thanks,
-Paul



Le mar. 21 mai 2019 à 16:51, Paul Cercueil <paul@crapouillou.net> a 
écrit :
> This driver will provide a regmap that can be retrieved very early in
> the boot process through the API function ingenic_tcu_get_regmap().
> 
> Additionally, it will call devm_of_platform_populate() so that all the
> children devices will be probed.
> 
> Signed-off-by: Paul Cercueil <paul@crapouillou.net>
> ---
> 
> Notes:
>     v12: New patch
> 
>  drivers/mfd/Kconfig             |   8 +++
>  drivers/mfd/Makefile            |   1 +
>  drivers/mfd/ingenic-tcu.c       | 113 
> ++++++++++++++++++++++++++++++++
>  include/linux/mfd/ingenic-tcu.h |   8 +++
>  4 files changed, 130 insertions(+)
>  create mode 100644 drivers/mfd/ingenic-tcu.c
> 
> diff --git a/drivers/mfd/Kconfig b/drivers/mfd/Kconfig
> index 294d9567cc71..a13544474e05 100644
> --- a/drivers/mfd/Kconfig
> +++ b/drivers/mfd/Kconfig
> @@ -494,6 +494,14 @@ config HTC_I2CPLD
>  	  This device provides input and output GPIOs through an I2C
>  	  interface to one or more sub-chips.
> 
> +config INGENIC_TCU
> +	bool "Ingenic Timer/Counter Unit (TCU) support"
> +	depends on MIPS || COMPILE_TEST
> +	select REGMAP_MMIO
> +	help
> +	  Say yes here to support the Timer/Counter Unit (TCU) IP present
> +	  in the JZ47xx SoCs from Ingenic.
> +
>  config MFD_INTEL_QUARK_I2C_GPIO
>  	tristate "Intel Quark MFD I2C GPIO"
>  	depends on PCI
> diff --git a/drivers/mfd/Makefile b/drivers/mfd/Makefile
> index 52b1a90ff515..fb89e131ae98 100644
> --- a/drivers/mfd/Makefile
> +++ b/drivers/mfd/Makefile
> @@ -180,6 +180,7 @@ obj-$(CONFIG_AB8500_CORE)	+= ab8500-core.o 
> ab8500-sysctrl.o
>  obj-$(CONFIG_MFD_TIMBERDALE)    += timberdale.o
>  obj-$(CONFIG_PMIC_ADP5520)	+= adp5520.o
>  obj-$(CONFIG_MFD_KEMPLD)	+= kempld-core.o
> +obj-$(CONFIG_INGENIC_TCU)	+= ingenic-tcu.o
>  obj-$(CONFIG_MFD_INTEL_QUARK_I2C_GPIO)	+= intel_quark_i2c_gpio.o
>  obj-$(CONFIG_LPC_SCH)		+= lpc_sch.o
>  obj-$(CONFIG_LPC_ICH)		+= lpc_ich.o
> diff --git a/drivers/mfd/ingenic-tcu.c b/drivers/mfd/ingenic-tcu.c
> new file mode 100644
> index 000000000000..6c1d5e4310c1
> --- /dev/null
> +++ b/drivers/mfd/ingenic-tcu.c
> @@ -0,0 +1,113 @@
> +// SPDX-License-Identifier: GPL-2.0
> +/*
> + * JZ47xx SoCs TCU MFD driver
> + * Copyright (C) 2019 Paul Cercueil <paul@crapouillou.net>
> + */
> +
> +#include <linux/mfd/ingenic-tcu.h>
> +#include <linux/of_address.h>
> +#include <linux/of_platform.h>
> +#include <linux/platform_device.h>
> +#include <linux/regmap.h>
> +
> +struct ingenic_soc_info {
> +	unsigned int num_channels;
> +};
> +
> +static struct regmap *tcu_regmap __initdata;
> +
> +static const struct regmap_config ingenic_tcu_regmap_config = {
> +	.reg_bits = 32,
> +	.val_bits = 32,
> +	.reg_stride = 4,
> +	.max_register = TCU_REG_OST_CNTHBUF,
> +};
> +
> +static const struct ingenic_soc_info jz4740_soc_info = {
> +	.num_channels = 8,
> +};
> +
> +static const struct ingenic_soc_info jz4725b_soc_info = {
> +	.num_channels = 6,
> +};
> +
> +static const struct of_device_id ingenic_tcu_of_match[] = {
> +	{ .compatible = "ingenic,jz4740-tcu", .data = &jz4740_soc_info, },
> +	{ .compatible = "ingenic,jz4725b-tcu", .data = &jz4725b_soc_info, },
> +	{ .compatible = "ingenic,jz4770-tcu", .data = &jz4740_soc_info, },
> +	{ }
> +};
> +
> +static struct regmap * __init ingenic_tcu_create_regmap(struct 
> device_node *np)
> +{
> +	struct resource res;
> +	void __iomem *base;
> +	struct regmap *map;
> +
> +	if (!of_match_node(ingenic_tcu_of_match, np))
> +		return ERR_PTR(-EINVAL);
> +
> +	base = of_io_request_and_map(np, 0, "TCU");
> +	if (IS_ERR(base))
> +		return ERR_PTR(PTR_ERR(base));
> +
> +	map = regmap_init_mmio(NULL, base, &ingenic_tcu_regmap_config);
> +	if (IS_ERR(map))
> +		goto err_iounmap;
> +
> +	return map;
> +
> +err_iounmap:
> +	iounmap(base);
> +	of_address_to_resource(np, 0, &res);
> +	release_mem_region(res.start, resource_size(&res));
> +
> +	return map;
> +}
> +
> +static int __init ingenic_tcu_probe(struct platform_device *pdev)
> +{
> +	struct regmap *map = ingenic_tcu_get_regmap(pdev->dev.of_node);
> +
> +	platform_set_drvdata(pdev, map);
> +
> +	regmap_attach_dev(&pdev->dev, map, &ingenic_tcu_regmap_config);
> +
> +	return devm_of_platform_populate(&pdev->dev);
> +}
> +
> +static struct platform_driver ingenic_tcu_driver = {
> +	.driver = {
> +		.name = "ingenic-tcu",
> +		.of_match_table = ingenic_tcu_of_match,
> +	},
> +};
> +
> +static int __init ingenic_tcu_platform_init(void)
> +{
> +	return platform_driver_probe(&ingenic_tcu_driver,
> +				     ingenic_tcu_probe);
> +}
> +subsys_initcall(ingenic_tcu_platform_init);
> +
> +struct regmap * __init ingenic_tcu_get_regmap(struct device_node *np)
> +{
> +	if (!tcu_regmap)
> +		tcu_regmap = ingenic_tcu_create_regmap(np);
> +
> +	return tcu_regmap;
> +}
> +
> +bool ingenic_tcu_pwm_can_use_chn(struct device *dev, unsigned int 
> channel)
> +{
> +	const struct ingenic_soc_info *soc = 
> device_get_match_data(dev->parent);
> +
> +	/* Enable all TCU channels for PWM use by default except channels 
> 0/1 */
> +	u32 pwm_channels_mask = GENMASK(soc->num_channels - 1, 2);
> +
> +	device_property_read_u32(dev->parent, "ingenic,pwm-channels-mask",
> +				 &pwm_channels_mask);
> +
> +	return !!(pwm_channels_mask & BIT(channel));
> +}
> +EXPORT_SYMBOL_GPL(ingenic_tcu_pwm_can_use_chn);
> diff --git a/include/linux/mfd/ingenic-tcu.h 
> b/include/linux/mfd/ingenic-tcu.h
> index 2083fa20821d..21df23916cd2 100644
> --- a/include/linux/mfd/ingenic-tcu.h
> +++ b/include/linux/mfd/ingenic-tcu.h
> @@ -6,6 +6,11 @@
>  #define __LINUX_MFD_INGENIC_TCU_H_
> 
>  #include <linux/bitops.h>
> +#include <linux/init.h>
> +
> +struct device;
> +struct device_node;
> +struct regmap;
> 
>  #define TCU_REG_WDT_TDR		0x00
>  #define TCU_REG_WDT_TCER	0x04
> @@ -53,4 +58,7 @@
>  #define TCU_REG_TCNTc(c)	(TCU_REG_TCNT0 + ((c) * TCU_CHANNEL_STRIDE))
>  #define TCU_REG_TCSRc(c)	(TCU_REG_TCSR0 + ((c) * TCU_CHANNEL_STRIDE))
> 
> +struct regmap * __init ingenic_tcu_get_regmap(struct device_node 
> *np);
> +bool ingenic_tcu_pwm_can_use_chn(struct device *dev, unsigned int 
> channel);
> +
>  #endif /* __LINUX_MFD_INGENIC_TCU_H_ */
> --
> 2.21.0.593.g511ec345e18
>
Lee Jones June 26, 2019, 1:18 p.m. UTC | #2
On Tue, 21 May 2019, Paul Cercueil wrote:

> This driver will provide a regmap that can be retrieved very early in
> the boot process through the API function ingenic_tcu_get_regmap().
> 
> Additionally, it will call devm_of_platform_populate() so that all the
> children devices will be probed.
> 
> Signed-off-by: Paul Cercueil <paul@crapouillou.net>
> ---
> 
> Notes:
>     v12: New patch
> 
>  drivers/mfd/Kconfig             |   8 +++
>  drivers/mfd/Makefile            |   1 +
>  drivers/mfd/ingenic-tcu.c       | 113 ++++++++++++++++++++++++++++++++
>  include/linux/mfd/ingenic-tcu.h |   8 +++
>  4 files changed, 130 insertions(+)
>  create mode 100644 drivers/mfd/ingenic-tcu.c
> 
> diff --git a/drivers/mfd/Kconfig b/drivers/mfd/Kconfig
> index 294d9567cc71..a13544474e05 100644
> --- a/drivers/mfd/Kconfig
> +++ b/drivers/mfd/Kconfig
> @@ -494,6 +494,14 @@ config HTC_I2CPLD
>  	  This device provides input and output GPIOs through an I2C
>  	  interface to one or more sub-chips.
>  
> +config INGENIC_TCU
> +	bool "Ingenic Timer/Counter Unit (TCU) support"
> +	depends on MIPS || COMPILE_TEST
> +	select REGMAP_MMIO
> +	help
> +	  Say yes here to support the Timer/Counter Unit (TCU) IP present
> +	  in the JZ47xx SoCs from Ingenic.
> +
>  config MFD_INTEL_QUARK_I2C_GPIO
>  	tristate "Intel Quark MFD I2C GPIO"
>  	depends on PCI
> diff --git a/drivers/mfd/Makefile b/drivers/mfd/Makefile
> index 52b1a90ff515..fb89e131ae98 100644
> --- a/drivers/mfd/Makefile
> +++ b/drivers/mfd/Makefile
> @@ -180,6 +180,7 @@ obj-$(CONFIG_AB8500_CORE)	+= ab8500-core.o ab8500-sysctrl.o
>  obj-$(CONFIG_MFD_TIMBERDALE)    += timberdale.o
>  obj-$(CONFIG_PMIC_ADP5520)	+= adp5520.o
>  obj-$(CONFIG_MFD_KEMPLD)	+= kempld-core.o
> +obj-$(CONFIG_INGENIC_TCU)	+= ingenic-tcu.o
>  obj-$(CONFIG_MFD_INTEL_QUARK_I2C_GPIO)	+= intel_quark_i2c_gpio.o
>  obj-$(CONFIG_LPC_SCH)		+= lpc_sch.o
>  obj-$(CONFIG_LPC_ICH)		+= lpc_ich.o
> diff --git a/drivers/mfd/ingenic-tcu.c b/drivers/mfd/ingenic-tcu.c
> new file mode 100644
> index 000000000000..6c1d5e4310c1
> --- /dev/null
> +++ b/drivers/mfd/ingenic-tcu.c
> @@ -0,0 +1,113 @@
> +// SPDX-License-Identifier: GPL-2.0
> +/*
> + * JZ47xx SoCs TCU MFD driver

Nit: Another line here please.

> + * Copyright (C) 2019 Paul Cercueil <paul@crapouillou.net>
> + */
> +
> +#include <linux/mfd/ingenic-tcu.h>
> +#include <linux/of_address.h>
> +#include <linux/of_platform.h>
> +#include <linux/platform_device.h>
> +#include <linux/regmap.h>
> +
> +struct ingenic_soc_info {
> +	unsigned int num_channels;
> +};
> +
> +static struct regmap *tcu_regmap __initdata;
> +
> +static const struct regmap_config ingenic_tcu_regmap_config = {
> +	.reg_bits = 32,
> +	.val_bits = 32,
> +	.reg_stride = 4,
> +	.max_register = TCU_REG_OST_CNTHBUF,
> +};
> +
> +static const struct ingenic_soc_info jz4740_soc_info = {
> +	.num_channels = 8,
> +};
> +
> +static const struct ingenic_soc_info jz4725b_soc_info = {
> +	.num_channels = 6,
> +};
> +
> +static const struct of_device_id ingenic_tcu_of_match[] = {
> +	{ .compatible = "ingenic,jz4740-tcu", .data = &jz4740_soc_info, },
> +	{ .compatible = "ingenic,jz4725b-tcu", .data = &jz4725b_soc_info, },
> +	{ .compatible = "ingenic,jz4770-tcu", .data = &jz4740_soc_info, },
> +	{ }
> +};
> +
> +static struct regmap * __init ingenic_tcu_create_regmap(struct device_node *np)
> +{
> +	struct resource res;
> +	void __iomem *base;
> +	struct regmap *map;
> +
> +	if (!of_match_node(ingenic_tcu_of_match, np))
> +		return ERR_PTR(-EINVAL);
> +
> +	base = of_io_request_and_map(np, 0, "TCU");
> +	if (IS_ERR(base))
> +		return ERR_PTR(PTR_ERR(base));
> +
> +	map = regmap_init_mmio(NULL, base, &ingenic_tcu_regmap_config);
> +	if (IS_ERR(map))
> +		goto err_iounmap;
> +
> +	return map;
> +
> +err_iounmap:
> +	iounmap(base);
> +	of_address_to_resource(np, 0, &res);
> +	release_mem_region(res.start, resource_size(&res));
> +
> +	return map;
> +}

Why does this need to be set-up earlier than probe()?

> +static int __init ingenic_tcu_probe(struct platform_device *pdev)
> +{
> +	struct regmap *map = ingenic_tcu_get_regmap(pdev->dev.of_node);
> +
> +	platform_set_drvdata(pdev, map);
> +
> +	regmap_attach_dev(&pdev->dev, map, &ingenic_tcu_regmap_config);
> +
> +	return devm_of_platform_populate(&pdev->dev);
> +}
> +
> +static struct platform_driver ingenic_tcu_driver = {
> +	.driver = {
> +		.name = "ingenic-tcu",
> +		.of_match_table = ingenic_tcu_of_match,
> +	},
> +};
> +
> +static int __init ingenic_tcu_platform_init(void)
> +{
> +	return platform_driver_probe(&ingenic_tcu_driver,
> +				     ingenic_tcu_probe);

What?  Why?

> +}
> +subsys_initcall(ingenic_tcu_platform_init);
> +
> +struct regmap * __init ingenic_tcu_get_regmap(struct device_node *np)
> +{
> +	if (!tcu_regmap)
> +		tcu_regmap = ingenic_tcu_create_regmap(np);
> +
> +	return tcu_regmap;
> +}

This makes me pretty uncomfortable.

What calls it?

> +bool ingenic_tcu_pwm_can_use_chn(struct device *dev, unsigned int channel)
> +{
> +	const struct ingenic_soc_info *soc = device_get_match_data(dev->parent);
> +
> +	/* Enable all TCU channels for PWM use by default except channels 0/1 */
> +	u32 pwm_channels_mask = GENMASK(soc->num_channels - 1, 2);
> +
> +	device_property_read_u32(dev->parent, "ingenic,pwm-channels-mask",
> +				 &pwm_channels_mask);
> +
> +	return !!(pwm_channels_mask & BIT(channel));
> +}
> +EXPORT_SYMBOL_GPL(ingenic_tcu_pwm_can_use_chn);
> diff --git a/include/linux/mfd/ingenic-tcu.h b/include/linux/mfd/ingenic-tcu.h
> index 2083fa20821d..21df23916cd2 100644
> --- a/include/linux/mfd/ingenic-tcu.h
> +++ b/include/linux/mfd/ingenic-tcu.h
> @@ -6,6 +6,11 @@
>  #define __LINUX_MFD_INGENIC_TCU_H_
>  
>  #include <linux/bitops.h>
> +#include <linux/init.h>
> +
> +struct device;
> +struct device_node;
> +struct regmap;
>  
>  #define TCU_REG_WDT_TDR		0x00
>  #define TCU_REG_WDT_TCER	0x04
> @@ -53,4 +58,7 @@
>  #define TCU_REG_TCNTc(c)	(TCU_REG_TCNT0 + ((c) * TCU_CHANNEL_STRIDE))
>  #define TCU_REG_TCSRc(c)	(TCU_REG_TCSR0 + ((c) * TCU_CHANNEL_STRIDE))
>  
> +struct regmap * __init ingenic_tcu_get_regmap(struct device_node *np);
> +bool ingenic_tcu_pwm_can_use_chn(struct device *dev, unsigned int channel);
> +
>  #endif /* __LINUX_MFD_INGENIC_TCU_H_ */
Paul Cercueil June 26, 2019, 1:55 p.m. UTC | #3
Hi Lee,

Le mer. 26 juin 2019 à 15:18, Lee Jones <lee.jones@linaro.org> a 
écrit :
> On Tue, 21 May 2019, Paul Cercueil wrote:
> 
>>  This driver will provide a regmap that can be retrieved very early 
>> in
>>  the boot process through the API function ingenic_tcu_get_regmap().
>> 
>>  Additionally, it will call devm_of_platform_populate() so that all 
>> the
>>  children devices will be probed.
>> 
>>  Signed-off-by: Paul Cercueil <paul@crapouillou.net>
>>  ---
>> 
>>  Notes:
>>      v12: New patch
>> 
>>   drivers/mfd/Kconfig             |   8 +++
>>   drivers/mfd/Makefile            |   1 +
>>   drivers/mfd/ingenic-tcu.c       | 113 
>> ++++++++++++++++++++++++++++++++
>>   include/linux/mfd/ingenic-tcu.h |   8 +++
>>   4 files changed, 130 insertions(+)
>>   create mode 100644 drivers/mfd/ingenic-tcu.c
>> 
>>  diff --git a/drivers/mfd/Kconfig b/drivers/mfd/Kconfig
>>  index 294d9567cc71..a13544474e05 100644
>>  --- a/drivers/mfd/Kconfig
>>  +++ b/drivers/mfd/Kconfig
>>  @@ -494,6 +494,14 @@ config HTC_I2CPLD
>>   	  This device provides input and output GPIOs through an I2C
>>   	  interface to one or more sub-chips.
>> 
>>  +config INGENIC_TCU
>>  +	bool "Ingenic Timer/Counter Unit (TCU) support"
>>  +	depends on MIPS || COMPILE_TEST
>>  +	select REGMAP_MMIO
>>  +	help
>>  +	  Say yes here to support the Timer/Counter Unit (TCU) IP present
>>  +	  in the JZ47xx SoCs from Ingenic.
>>  +
>>   config MFD_INTEL_QUARK_I2C_GPIO
>>   	tristate "Intel Quark MFD I2C GPIO"
>>   	depends on PCI
>>  diff --git a/drivers/mfd/Makefile b/drivers/mfd/Makefile
>>  index 52b1a90ff515..fb89e131ae98 100644
>>  --- a/drivers/mfd/Makefile
>>  +++ b/drivers/mfd/Makefile
>>  @@ -180,6 +180,7 @@ obj-$(CONFIG_AB8500_CORE)	+= ab8500-core.o 
>> ab8500-sysctrl.o
>>   obj-$(CONFIG_MFD_TIMBERDALE)    += timberdale.o
>>   obj-$(CONFIG_PMIC_ADP5520)	+= adp5520.o
>>   obj-$(CONFIG_MFD_KEMPLD)	+= kempld-core.o
>>  +obj-$(CONFIG_INGENIC_TCU)	+= ingenic-tcu.o
>>   obj-$(CONFIG_MFD_INTEL_QUARK_I2C_GPIO)	+= intel_quark_i2c_gpio.o
>>   obj-$(CONFIG_LPC_SCH)		+= lpc_sch.o
>>   obj-$(CONFIG_LPC_ICH)		+= lpc_ich.o
>>  diff --git a/drivers/mfd/ingenic-tcu.c b/drivers/mfd/ingenic-tcu.c
>>  new file mode 100644
>>  index 000000000000..6c1d5e4310c1
>>  --- /dev/null
>>  +++ b/drivers/mfd/ingenic-tcu.c
>>  @@ -0,0 +1,113 @@
>>  +// SPDX-License-Identifier: GPL-2.0
>>  +/*
>>  + * JZ47xx SoCs TCU MFD driver
> 
> Nit: Another line here please.
> 
>>  + * Copyright (C) 2019 Paul Cercueil <paul@crapouillou.net>
>>  + */
>>  +
>>  +#include <linux/mfd/ingenic-tcu.h>
>>  +#include <linux/of_address.h>
>>  +#include <linux/of_platform.h>
>>  +#include <linux/platform_device.h>
>>  +#include <linux/regmap.h>
>>  +
>>  +struct ingenic_soc_info {
>>  +	unsigned int num_channels;
>>  +};
>>  +
>>  +static struct regmap *tcu_regmap __initdata;
>>  +
>>  +static const struct regmap_config ingenic_tcu_regmap_config = {
>>  +	.reg_bits = 32,
>>  +	.val_bits = 32,
>>  +	.reg_stride = 4,
>>  +	.max_register = TCU_REG_OST_CNTHBUF,
>>  +};
>>  +
>>  +static const struct ingenic_soc_info jz4740_soc_info = {
>>  +	.num_channels = 8,
>>  +};
>>  +
>>  +static const struct ingenic_soc_info jz4725b_soc_info = {
>>  +	.num_channels = 6,
>>  +};
>>  +
>>  +static const struct of_device_id ingenic_tcu_of_match[] = {
>>  +	{ .compatible = "ingenic,jz4740-tcu", .data = &jz4740_soc_info, },
>>  +	{ .compatible = "ingenic,jz4725b-tcu", .data = &jz4725b_soc_info, 
>> },
>>  +	{ .compatible = "ingenic,jz4770-tcu", .data = &jz4740_soc_info, },
>>  +	{ }
>>  +};
>>  +
>>  +static struct regmap * __init ingenic_tcu_create_regmap(struct 
>> device_node *np)
>>  +{
>>  +	struct resource res;
>>  +	void __iomem *base;
>>  +	struct regmap *map;
>>  +
>>  +	if (!of_match_node(ingenic_tcu_of_match, np))
>>  +		return ERR_PTR(-EINVAL);
>>  +
>>  +	base = of_io_request_and_map(np, 0, "TCU");
>>  +	if (IS_ERR(base))
>>  +		return ERR_PTR(PTR_ERR(base));
>>  +
>>  +	map = regmap_init_mmio(NULL, base, &ingenic_tcu_regmap_config);
>>  +	if (IS_ERR(map))
>>  +		goto err_iounmap;
>>  +
>>  +	return map;
>>  +
>>  +err_iounmap:
>>  +	iounmap(base);
>>  +	of_address_to_resource(np, 0, &res);
>>  +	release_mem_region(res.start, resource_size(&res));
>>  +
>>  +	return map;
>>  +}
> 
> Why does this need to be set-up earlier than probe()?

See the explanation below.

>>  +static int __init ingenic_tcu_probe(struct platform_device *pdev)
>>  +{
>>  +	struct regmap *map = ingenic_tcu_get_regmap(pdev->dev.of_node);
>>  +
>>  +	platform_set_drvdata(pdev, map);
>>  +
>>  +	regmap_attach_dev(&pdev->dev, map, &ingenic_tcu_regmap_config);
>>  +
>>  +	return devm_of_platform_populate(&pdev->dev);
>>  +}
>>  +
>>  +static struct platform_driver ingenic_tcu_driver = {
>>  +	.driver = {
>>  +		.name = "ingenic-tcu",
>>  +		.of_match_table = ingenic_tcu_of_match,
>>  +	},
>>  +};
>>  +
>>  +static int __init ingenic_tcu_platform_init(void)
>>  +{
>>  +	return platform_driver_probe(&ingenic_tcu_driver,
>>  +				     ingenic_tcu_probe);
> 
> What?  Why?

The device driver probed here will populate the children devices,
which will be able to retrieve the pointer to the regmap through
device_get_regmap(dev->parent).

The children devices are normal platform drivers that can be probed
the normal way. These are the PWM driver, the watchdog driver, and the
OST (OS Timer) clocksource driver, all part of the same hardware block
(the Timer/Counter Unit or TCU).

>>  +}
>>  +subsys_initcall(ingenic_tcu_platform_init);
>>  +
>>  +struct regmap * __init ingenic_tcu_get_regmap(struct device_node 
>> *np)
>>  +{
>>  +	if (!tcu_regmap)
>>  +		tcu_regmap = ingenic_tcu_create_regmap(np);
>>  +
>>  +	return tcu_regmap;
>>  +}
> 
> This makes me pretty uncomfortable.
> 
> What calls it?

The TCU IRQ driver (patch [06/13]), clocks driver (patch [05/13]), and 
the
non-OST clocksource driver (patch [07/13]) all probe very early in the 
boot
process, and share the same devicetree node. They call this function to 
get
a pointer to the regmap.

>>  +bool ingenic_tcu_pwm_can_use_chn(struct device *dev, unsigned int 
>> channel)
>>  +{
>>  +	const struct ingenic_soc_info *soc = 
>> device_get_match_data(dev->parent);
>>  +
>>  +	/* Enable all TCU channels for PWM use by default except channels 
>> 0/1 */
>>  +	u32 pwm_channels_mask = GENMASK(soc->num_channels - 1, 2);
>>  +
>>  +	device_property_read_u32(dev->parent, "ingenic,pwm-channels-mask",
>>  +				 &pwm_channels_mask);
>>  +
>>  +	return !!(pwm_channels_mask & BIT(channel));
>>  +}
>>  +EXPORT_SYMBOL_GPL(ingenic_tcu_pwm_can_use_chn);
>>  diff --git a/include/linux/mfd/ingenic-tcu.h 
>> b/include/linux/mfd/ingenic-tcu.h
>>  index 2083fa20821d..21df23916cd2 100644
>>  --- a/include/linux/mfd/ingenic-tcu.h
>>  +++ b/include/linux/mfd/ingenic-tcu.h
>>  @@ -6,6 +6,11 @@
>>   #define __LINUX_MFD_INGENIC_TCU_H_
>> 
>>   #include <linux/bitops.h>
>>  +#include <linux/init.h>
>>  +
>>  +struct device;
>>  +struct device_node;
>>  +struct regmap;
>> 
>>   #define TCU_REG_WDT_TDR		0x00
>>   #define TCU_REG_WDT_TCER	0x04
>>  @@ -53,4 +58,7 @@
>>   #define TCU_REG_TCNTc(c)	(TCU_REG_TCNT0 + ((c) * 
>> TCU_CHANNEL_STRIDE))
>>   #define TCU_REG_TCSRc(c)	(TCU_REG_TCSR0 + ((c) * 
>> TCU_CHANNEL_STRIDE))
>> 
>>  +struct regmap * __init ingenic_tcu_get_regmap(struct device_node 
>> *np);
>>  +bool ingenic_tcu_pwm_can_use_chn(struct device *dev, unsigned int 
>> channel);
>>  +
>>   #endif /* __LINUX_MFD_INGENIC_TCU_H_ */
> 
> --
> Lee Jones [李琼斯]
> Linaro Services Technical Lead
> Linaro.org │ Open source software for ARM SoCs
> Follow Linaro: Facebook | Twitter | Blog
Lee Jones June 27, 2019, 6:58 a.m. UTC | #4
On Wed, 26 Jun 2019, Paul Cercueil wrote:
> Le mer. 26 juin 2019 à 15:18, Lee Jones <lee.jones@linaro.org> a écrit :
> > On Tue, 21 May 2019, Paul Cercueil wrote:
> > 
> > >  This driver will provide a regmap that can be retrieved very early
> > > in
> > >  the boot process through the API function ingenic_tcu_get_regmap().
> > > 
> > >  Additionally, it will call devm_of_platform_populate() so that all
> > > the
> > >  children devices will be probed.
> > > 
> > >  Signed-off-by: Paul Cercueil <paul@crapouillou.net>
> > >  ---
> > > 
> > >  Notes:
> > >      v12: New patch
> > > 
> > >   drivers/mfd/Kconfig             |   8 +++
> > >   drivers/mfd/Makefile            |   1 +
> > >   drivers/mfd/ingenic-tcu.c       | 113
> > > ++++++++++++++++++++++++++++++++
> > >   include/linux/mfd/ingenic-tcu.h |   8 +++
> > >   4 files changed, 130 insertions(+)
> > >   create mode 100644 drivers/mfd/ingenic-tcu.c

[...]

> > >  +static struct regmap * __init ingenic_tcu_create_regmap(struct
> > > device_node *np)
> > >  +{
> > >  +	struct resource res;
> > >  +	void __iomem *base;
> > >  +	struct regmap *map;
> > >  +
> > >  +	if (!of_match_node(ingenic_tcu_of_match, np))
> > >  +		return ERR_PTR(-EINVAL);

Drop this check.

> > >  +	base = of_io_request_and_map(np, 0, "TCU");
> > >  +	if (IS_ERR(base))
> > >  +		return ERR_PTR(PTR_ERR(base));
> > >  +
> > >  +	map = regmap_init_mmio(NULL, base, &ingenic_tcu_regmap_config);
> > >  +	if (IS_ERR(map))
> > >  +		goto err_iounmap;

Place this inside probe().

> > >  +	return map;
> > >  +
> > >  +err_iounmap:
> > >  +	iounmap(base);
> > >  +	of_address_to_resource(np, 0, &res);
> > >  +	release_mem_region(res.start, resource_size(&res));
> > >  +
> > >  +	return map;
> > >  +}
> > 
> > Why does this need to be set-up earlier than probe()?
> 
> See the explanation below.

I think the answer is, it doesn't.

> > >  +static int __init ingenic_tcu_probe(struct platform_device *pdev)
> > >  +{
> > >  +	struct regmap *map = ingenic_tcu_get_regmap(pdev->dev.of_node);
> > >  +
> > >  +	platform_set_drvdata(pdev, map);
> > >  +
> > >  +	regmap_attach_dev(&pdev->dev, map, &ingenic_tcu_regmap_config);
> > >  +
> > >  +	return devm_of_platform_populate(&pdev->dev);
> > >  +}
> > >  +
> > >  +static struct platform_driver ingenic_tcu_driver = {
> > >  +	.driver = {
> > >  +		.name = "ingenic-tcu",
> > >  +		.of_match_table = ingenic_tcu_of_match,
> > >  +	},
> > >  +};
> > >  +
> > >  +static int __init ingenic_tcu_platform_init(void)
> > >  +{
> > >  +	return platform_driver_probe(&ingenic_tcu_driver,
> > >  +				     ingenic_tcu_probe);
> > 
> > What?  Why?
> 
> The device driver probed here will populate the children devices,
> which will be able to retrieve the pointer to the regmap through
> device_get_regmap(dev->parent).

I've never heard of this call.  Where is it?

> The children devices are normal platform drivers that can be probed
> the normal way. These are the PWM driver, the watchdog driver, and the
> OST (OS Timer) clocksource driver, all part of the same hardware block
> (the Timer/Counter Unit or TCU).

If they are normal devices, then there is no need to roll your own
regmap-getter implementation like this.

> > >  +}
> > >  +subsys_initcall(ingenic_tcu_platform_init);
> > >  +
> > >  +struct regmap * __init ingenic_tcu_get_regmap(struct device_node
> > > *np)
> > >  +{
> > >  +	if (!tcu_regmap)
> > >  +		tcu_regmap = ingenic_tcu_create_regmap(np);
> > >  +
> > >  +	return tcu_regmap;
> > >  +}
> > 
> > This makes me pretty uncomfortable.
> > 
> > What calls it?
> 
> The TCU IRQ driver (patch [06/13]), clocks driver (patch [05/13]), and the
> non-OST clocksource driver (patch [07/13]) all probe very early in the boot
> process, and share the same devicetree node. They call this function to get
> a pointer to the regmap.

Horrible!

Instead, you should send it through platform_set_drvdata() and collect
it in the child drivers with platform_get_drvdata(dev->parent).

> > >  +bool ingenic_tcu_pwm_can_use_chn(struct device *dev, unsigned int
> > > channel)
> > >  +{
> > >  +	const struct ingenic_soc_info *soc =
> > > device_get_match_data(dev->parent);
> > >  +
> > >  +	/* Enable all TCU channels for PWM use by default except channels
> > > 0/1 */
> > >  +	u32 pwm_channels_mask = GENMASK(soc->num_channels - 1, 2);
> > >  +
> > >  +	device_property_read_u32(dev->parent, "ingenic,pwm-channels-mask",
> > >  +				 &pwm_channels_mask);

Doesn't this call overwrite the previous assignment above?

> > >  +	return !!(pwm_channels_mask & BIT(channel));
> > >  +}
> > >  +EXPORT_SYMBOL_GPL(ingenic_tcu_pwm_can_use_chn);

Where is this called from?

I think this needs a review by the DT guys.

> > >  diff --git a/include/linux/mfd/ingenic-tcu.h
> > > b/include/linux/mfd/ingenic-tcu.h
> > >  index 2083fa20821d..21df23916cd2 100644
> > >  --- a/include/linux/mfd/ingenic-tcu.h
> > >  +++ b/include/linux/mfd/ingenic-tcu.h
> > >  @@ -6,6 +6,11 @@
> > >   #define __LINUX_MFD_INGENIC_TCU_H_
> > > 
> > >   #include <linux/bitops.h>
> > >  +#include <linux/init.h>
> > >  +
> > >  +struct device;
> > >  +struct device_node;
> > >  +struct regmap;
> > > 
> > >   #define TCU_REG_WDT_TDR		0x00
> > >   #define TCU_REG_WDT_TCER	0x04
> > >  @@ -53,4 +58,7 @@
> > >   #define TCU_REG_TCNTc(c)	(TCU_REG_TCNT0 + ((c) *
> > > TCU_CHANNEL_STRIDE))
> > >   #define TCU_REG_TCSRc(c)	(TCU_REG_TCSR0 + ((c) *
> > > TCU_CHANNEL_STRIDE))
> > > 
> > >  +struct regmap * __init ingenic_tcu_get_regmap(struct device_node
> > > *np);
> > >  +bool ingenic_tcu_pwm_can_use_chn(struct device *dev, unsigned int
> > > channel);
> > >  +
> > >   #endif /* __LINUX_MFD_INGENIC_TCU_H_ */
> > 
> 
>
Paul Cercueil June 27, 2019, 8:49 a.m. UTC | #5
Le jeu. 27 juin 2019 à 8:58, Lee Jones <lee.jones@linaro.org> a écrit 
:
> On Wed, 26 Jun 2019, Paul Cercueil wrote:
>>  Le mer. 26 juin 2019 à 15:18, Lee Jones <lee.jones@linaro.org> a 
>> écrit :
>>  > On Tue, 21 May 2019, Paul Cercueil wrote:
>>  >
>>  > >  This driver will provide a regmap that can be retrieved very 
>> early
>>  > > in
>>  > >  the boot process through the API function 
>> ingenic_tcu_get_regmap().
>>  > >
>>  > >  Additionally, it will call devm_of_platform_populate() so that 
>> all
>>  > > the
>>  > >  children devices will be probed.
>>  > >
>>  > >  Signed-off-by: Paul Cercueil <paul@crapouillou.net>
>>  > >  ---
>>  > >
>>  > >  Notes:
>>  > >      v12: New patch
>>  > >
>>  > >   drivers/mfd/Kconfig             |   8 +++
>>  > >   drivers/mfd/Makefile            |   1 +
>>  > >   drivers/mfd/ingenic-tcu.c       | 113
>>  > > ++++++++++++++++++++++++++++++++
>>  > >   include/linux/mfd/ingenic-tcu.h |   8 +++
>>  > >   4 files changed, 130 insertions(+)
>>  > >   create mode 100644 drivers/mfd/ingenic-tcu.c
> 
> [...]
> 
>>  > >  +static struct regmap * __init ingenic_tcu_create_regmap(struct
>>  > > device_node *np)
>>  > >  +{
>>  > >  +	struct resource res;
>>  > >  +	void __iomem *base;
>>  > >  +	struct regmap *map;
>>  > >  +
>>  > >  +	if (!of_match_node(ingenic_tcu_of_match, np))
>>  > >  +		return ERR_PTR(-EINVAL);
> 
> Drop this check.
> 
>>  > >  +	base = of_io_request_and_map(np, 0, "TCU");
>>  > >  +	if (IS_ERR(base))
>>  > >  +		return ERR_PTR(PTR_ERR(base));
>>  > >  +
>>  > >  +	map = regmap_init_mmio(NULL, base, 
>> &ingenic_tcu_regmap_config);
>>  > >  +	if (IS_ERR(map))
>>  > >  +		goto err_iounmap;
> 
> Place this inside probe().
> 
>>  > >  +	return map;
>>  > >  +
>>  > >  +err_iounmap:
>>  > >  +	iounmap(base);
>>  > >  +	of_address_to_resource(np, 0, &res);
>>  > >  +	release_mem_region(res.start, resource_size(&res));
>>  > >  +
>>  > >  +	return map;
>>  > >  +}
>>  >
>>  > Why does this need to be set-up earlier than probe()?
>> 
>>  See the explanation below.
> 
> I think the answer is, it doesn't.
> 
>>  > >  +static int __init ingenic_tcu_probe(struct platform_device 
>> *pdev)
>>  > >  +{
>>  > >  +	struct regmap *map = 
>> ingenic_tcu_get_regmap(pdev->dev.of_node);
>>  > >  +
>>  > >  +	platform_set_drvdata(pdev, map);
>>  > >  +
>>  > >  +	regmap_attach_dev(&pdev->dev, map, 
>> &ingenic_tcu_regmap_config);
>>  > >  +
>>  > >  +	return devm_of_platform_populate(&pdev->dev);
>>  > >  +}
>>  > >  +
>>  > >  +static struct platform_driver ingenic_tcu_driver = {
>>  > >  +	.driver = {
>>  > >  +		.name = "ingenic-tcu",
>>  > >  +		.of_match_table = ingenic_tcu_of_match,
>>  > >  +	},
>>  > >  +};
>>  > >  +
>>  > >  +static int __init ingenic_tcu_platform_init(void)
>>  > >  +{
>>  > >  +	return platform_driver_probe(&ingenic_tcu_driver,
>>  > >  +				     ingenic_tcu_probe);
>>  >
>>  > What?  Why?
>> 
>>  The device driver probed here will populate the children devices,
>>  which will be able to retrieve the pointer to the regmap through
>>  device_get_regmap(dev->parent).
> 
> I've never heard of this call.  Where is it?

dev_get_regmap, in <linux/regmap.h>.

>>  The children devices are normal platform drivers that can be probed
>>  the normal way. These are the PWM driver, the watchdog driver, and 
>> the
>>  OST (OS Timer) clocksource driver, all part of the same hardware 
>> block
>>  (the Timer/Counter Unit or TCU).
> 
> If they are normal devices, then there is no need to roll your own
> regmap-getter implementation like this.
> 
>>  > >  +}
>>  > >  +subsys_initcall(ingenic_tcu_platform_init);
>>  > >  +
>>  > >  +struct regmap * __init ingenic_tcu_get_regmap(struct 
>> device_node
>>  > > *np)
>>  > >  +{
>>  > >  +	if (!tcu_regmap)
>>  > >  +		tcu_regmap = ingenic_tcu_create_regmap(np);
>>  > >  +
>>  > >  +	return tcu_regmap;
>>  > >  +}
>>  >
>>  > This makes me pretty uncomfortable.
>>  >
>>  > What calls it?
>> 
>>  The TCU IRQ driver (patch [06/13]), clocks driver (patch [05/13]), 
>> and the
>>  non-OST clocksource driver (patch [07/13]) all probe very early in 
>> the boot
>>  process, and share the same devicetree node. They call this 
>> function to get
>>  a pointer to the regmap.
> 
> Horrible!
> 
> Instead, you should send it through platform_set_drvdata() and collect
> it in the child drivers with platform_get_drvdata(dev->parent).

The IRQ, clocks and clocksource driver do NOT have a "struct device" to
begin with. They are not platform drivers, and cannot be platform 
drivers,
as they must register so early in the boot process, before "struct 
device"
is even a thing.

All they get is a pointer to the same devicetree node. Since all of 
these
have to use the same registers, they need to use a shared regmap, which
they obtain by calling ingenic_tcu_get_regmap() below.

Then, when this driver's probe gets called, the regmap is retrieved and
attached to the struct device, and then the children devices will be
probed: the watchdog device, the PWM device, the OST device. These three
will retrieve the regmap by calling dev_get_regmap(dev->parent, NULL).

>>  > >  +bool ingenic_tcu_pwm_can_use_chn(struct device *dev, unsigned 
>> int
>>  > > channel)
>>  > >  +{
>>  > >  +	const struct ingenic_soc_info *soc =
>>  > > device_get_match_data(dev->parent);
>>  > >  +
>>  > >  +	/* Enable all TCU channels for PWM use by default except 
>> channels
>>  > > 0/1 */
>>  > >  +	u32 pwm_channels_mask = GENMASK(soc->num_channels - 1, 2);
>>  > >  +
>>  > >  +	device_property_read_u32(dev->parent, 
>> "ingenic,pwm-channels-mask",
>>  > >  +				 &pwm_channels_mask);
> 
> Doesn't this call overwrite the previous assignment above?

Yes, that's intended. You have a default value, that can be overriden
by a device property.

>>  > >  +	return !!(pwm_channels_mask & BIT(channel));
>>  > >  +}
>>  > >  +EXPORT_SYMBOL_GPL(ingenic_tcu_pwm_can_use_chn);
> 
> Where is this called from?

This is called from the PWM driver.

> I think this needs a review by the DT guys.

Rob already acked the bindings, which describe this property.

>>  > >  diff --git a/include/linux/mfd/ingenic-tcu.h
>>  > > b/include/linux/mfd/ingenic-tcu.h
>>  > >  index 2083fa20821d..21df23916cd2 100644
>>  > >  --- a/include/linux/mfd/ingenic-tcu.h
>>  > >  +++ b/include/linux/mfd/ingenic-tcu.h
>>  > >  @@ -6,6 +6,11 @@
>>  > >   #define __LINUX_MFD_INGENIC_TCU_H_
>>  > >
>>  > >   #include <linux/bitops.h>
>>  > >  +#include <linux/init.h>
>>  > >  +
>>  > >  +struct device;
>>  > >  +struct device_node;
>>  > >  +struct regmap;
>>  > >
>>  > >   #define TCU_REG_WDT_TDR		0x00
>>  > >   #define TCU_REG_WDT_TCER	0x04
>>  > >  @@ -53,4 +58,7 @@
>>  > >   #define TCU_REG_TCNTc(c)	(TCU_REG_TCNT0 + ((c) *
>>  > > TCU_CHANNEL_STRIDE))
>>  > >   #define TCU_REG_TCSRc(c)	(TCU_REG_TCSR0 + ((c) *
>>  > > TCU_CHANNEL_STRIDE))
>>  > >
>>  > >  +struct regmap * __init ingenic_tcu_get_regmap(struct 
>> device_node
>>  > > *np);
>>  > >  +bool ingenic_tcu_pwm_can_use_chn(struct device *dev, unsigned 
>> int
>>  > > channel);
>>  > >  +
>>  > >   #endif /* __LINUX_MFD_INGENIC_TCU_H_ */
>>  >
>> 
>> 
> 
> --
> Lee Jones [李琼斯]
> Linaro Services Technical Lead
> Linaro.org │ Open source software for ARM SoCs
> Follow Linaro: Facebook | Twitter | Blog
Lee Jones June 27, 2019, 9:01 a.m. UTC | #6
On Thu, 27 Jun 2019, Paul Cercueil wrote:
> Le jeu. 27 juin 2019 à 8:58, Lee Jones <lee.jones@linaro.org> a écrit :
> > On Wed, 26 Jun 2019, Paul Cercueil wrote:
> > >  Le mer. 26 juin 2019 à 15:18, Lee Jones <lee.jones@linaro.org> a
> > > écrit :
> > >  > On Tue, 21 May 2019, Paul Cercueil wrote:
> > >  >
> > >  > >  This driver will provide a regmap that can be retrieved very
> > > early
> > >  > > in
> > >  > >  the boot process through the API function
> > > ingenic_tcu_get_regmap().
> > >  > >
> > >  > >  Additionally, it will call devm_of_platform_populate() so that
> > > all
> > >  > > the
> > >  > >  children devices will be probed.
> > >  > >
> > >  > >  Signed-off-by: Paul Cercueil <paul@crapouillou.net>
> > >  > >  ---
> > >  > >
> > >  > >  Notes:
> > >  > >      v12: New patch
> > >  > >
> > >  > >   drivers/mfd/Kconfig             |   8 +++
> > >  > >   drivers/mfd/Makefile            |   1 +
> > >  > >   drivers/mfd/ingenic-tcu.c       | 113
> > >  > > ++++++++++++++++++++++++++++++++
> > >  > >   include/linux/mfd/ingenic-tcu.h |   8 +++
> > >  > >   4 files changed, 130 insertions(+)
> > >  > >   create mode 100644 drivers/mfd/ingenic-tcu.c
> > 
> > [...]
> > 
> > >  > >  +static struct regmap * __init ingenic_tcu_create_regmap(struct
> > >  > > device_node *np)
> > >  > >  +{
> > >  > >  +	struct resource res;
> > >  > >  +	void __iomem *base;
> > >  > >  +	struct regmap *map;
> > >  > >  +
> > >  > >  +	if (!of_match_node(ingenic_tcu_of_match, np))
> > >  > >  +		return ERR_PTR(-EINVAL);
> > 
> > Drop this check.
> > 
> > >  > >  +	base = of_io_request_and_map(np, 0, "TCU");
> > >  > >  +	if (IS_ERR(base))
> > >  > >  +		return ERR_PTR(PTR_ERR(base));
> > >  > >  +
> > >  > >  +	map = regmap_init_mmio(NULL, base,
> > > &ingenic_tcu_regmap_config);
> > >  > >  +	if (IS_ERR(map))
> > >  > >  +		goto err_iounmap;
> > 
> > Place this inside probe().
> > 
> > >  > >  +	return map;
> > >  > >  +
> > >  > >  +err_iounmap:
> > >  > >  +	iounmap(base);
> > >  > >  +	of_address_to_resource(np, 0, &res);
> > >  > >  +	release_mem_region(res.start, resource_size(&res));
> > >  > >  +
> > >  > >  +	return map;
> > >  > >  +}
> > >  >
> > >  > Why does this need to be set-up earlier than probe()?
> > > 
> > >  See the explanation below.
> > 
> > I think the answer is, it doesn't.
> > 
> > >  > >  +static int __init ingenic_tcu_probe(struct platform_device
> > > *pdev)
> > >  > >  +{
> > >  > >  +	struct regmap *map =
> > > ingenic_tcu_get_regmap(pdev->dev.of_node);
> > >  > >  +
> > >  > >  +	platform_set_drvdata(pdev, map);
> > >  > >  +
> > >  > >  +	regmap_attach_dev(&pdev->dev, map,
> > > &ingenic_tcu_regmap_config);
> > >  > >  +
> > >  > >  +	return devm_of_platform_populate(&pdev->dev);
> > >  > >  +}
> > >  > >  +
> > >  > >  +static struct platform_driver ingenic_tcu_driver = {
> > >  > >  +	.driver = {
> > >  > >  +		.name = "ingenic-tcu",
> > >  > >  +		.of_match_table = ingenic_tcu_of_match,
> > >  > >  +	},
> > >  > >  +};
> > >  > >  +
> > >  > >  +static int __init ingenic_tcu_platform_init(void)
> > >  > >  +{
> > >  > >  +	return platform_driver_probe(&ingenic_tcu_driver,
> > >  > >  +				     ingenic_tcu_probe);
> > >  >
> > >  > What?  Why?
> > > 
> > >  The device driver probed here will populate the children devices,
> > >  which will be able to retrieve the pointer to the regmap through
> > >  device_get_regmap(dev->parent).
> > 
> > I've never heard of this call.  Where is it?
> 
> dev_get_regmap, in <linux/regmap.h>.
> 
> > >  The children devices are normal platform drivers that can be probed
> > >  the normal way. These are the PWM driver, the watchdog driver, and
> > > the
> > >  OST (OS Timer) clocksource driver, all part of the same hardware
> > > block
> > >  (the Timer/Counter Unit or TCU).
> > 
> > If they are normal devices, then there is no need to roll your own
> > regmap-getter implementation like this.
> > 
> > >  > >  +}
> > >  > >  +subsys_initcall(ingenic_tcu_platform_init);
> > >  > >  +
> > >  > >  +struct regmap * __init ingenic_tcu_get_regmap(struct
> > > device_node
> > >  > > *np)
> > >  > >  +{
> > >  > >  +	if (!tcu_regmap)
> > >  > >  +		tcu_regmap = ingenic_tcu_create_regmap(np);
> > >  > >  +
> > >  > >  +	return tcu_regmap;
> > >  > >  +}
> > >  >
> > >  > This makes me pretty uncomfortable.
> > >  >
> > >  > What calls it?
> > > 
> > >  The TCU IRQ driver (patch [06/13]), clocks driver (patch [05/13]),
> > > and the
> > >  non-OST clocksource driver (patch [07/13]) all probe very early in
> > > the boot
> > >  process, and share the same devicetree node. They call this
> > > function to get
> > >  a pointer to the regmap.
> > 
> > Horrible!
> > 
> > Instead, you should send it through platform_set_drvdata() and collect
> > it in the child drivers with platform_get_drvdata(dev->parent).
> 
> The IRQ, clocks and clocksource driver do NOT have a "struct device" to
> begin with. They are not platform drivers, and cannot be platform drivers,
> as they must register so early in the boot process, before "struct device"
> is even a thing.
> 
> All they get is a pointer to the same devicetree node. Since all of these
> have to use the same registers, they need to use a shared regmap, which
> they obtain by calling ingenic_tcu_get_regmap() below.
> 
> Then, when this driver's probe gets called, the regmap is retrieved and
> attached to the struct device, and then the children devices will be
> probed: the watchdog device, the PWM device, the OST device. These three
> will retrieve the regmap by calling dev_get_regmap(dev->parent, NULL).

That makes sense.

This explanation certainly belongs in the commit log.

Can you send your v14, as you intended.  I will re-review it with new
eyes when you do.

> > >  > >  +bool ingenic_tcu_pwm_can_use_chn(struct device *dev, unsigned
> > > int
> > >  > > channel)
> > >  > >  +{
> > >  > >  +	const struct ingenic_soc_info *soc =
> > >  > > device_get_match_data(dev->parent);
> > >  > >  +
> > >  > >  +	/* Enable all TCU channels for PWM use by default except
> > > channels
> > >  > > 0/1 */
> > >  > >  +	u32 pwm_channels_mask = GENMASK(soc->num_channels - 1, 2);
> > >  > >  +
> > >  > >  +	device_property_read_u32(dev->parent,
> > > "ingenic,pwm-channels-mask",
> > >  > >  +				 &pwm_channels_mask);
> > 
> > Doesn't this call overwrite the previous assignment above?
> 
> Yes, that's intended. You have a default value, that can be overriden
> by a device property.

You should provide a comment here to make your intentions clear.

> > >  > >  +	return !!(pwm_channels_mask & BIT(channel));
> > >  > >  +}
> > >  > >  +EXPORT_SYMBOL_GPL(ingenic_tcu_pwm_can_use_chn);
> > 
> > Where is this called from?
> 
> This is called from the PWM driver.

Why can't it live in the PWM driver?
Paul Cercueil June 27, 2019, 9:19 a.m. UTC | #7
Le jeu. 27 juin 2019 à 11:01, Lee Jones <lee.jones@linaro.org> a 
écrit :
> On Thu, 27 Jun 2019, Paul Cercueil wrote:
>>  Le jeu. 27 juin 2019 à 8:58, Lee Jones <lee.jones@linaro.org> a 
>> écrit :
>>  > On Wed, 26 Jun 2019, Paul Cercueil wrote:
>>  > >  Le mer. 26 juin 2019 à 15:18, Lee Jones 
>> <lee.jones@linaro.org> a
>>  > > écrit :
>>  > >  > On Tue, 21 May 2019, Paul Cercueil wrote:
>>  > >  >
>>  > >  > >  This driver will provide a regmap that can be retrieved 
>> very
>>  > > early
>>  > >  > > in
>>  > >  > >  the boot process through the API function
>>  > > ingenic_tcu_get_regmap().
>>  > >  > >
>>  > >  > >  Additionally, it will call devm_of_platform_populate() so 
>> that
>>  > > all
>>  > >  > > the
>>  > >  > >  children devices will be probed.
>>  > >  > >
>>  > >  > >  Signed-off-by: Paul Cercueil <paul@crapouillou.net>
>>  > >  > >  ---
>>  > >  > >
>>  > >  > >  Notes:
>>  > >  > >      v12: New patch
>>  > >  > >
>>  > >  > >   drivers/mfd/Kconfig             |   8 +++
>>  > >  > >   drivers/mfd/Makefile            |   1 +
>>  > >  > >   drivers/mfd/ingenic-tcu.c       | 113
>>  > >  > > ++++++++++++++++++++++++++++++++
>>  > >  > >   include/linux/mfd/ingenic-tcu.h |   8 +++
>>  > >  > >   4 files changed, 130 insertions(+)
>>  > >  > >   create mode 100644 drivers/mfd/ingenic-tcu.c
>>  >
>>  > [...]
>>  >
>>  > >  > >  +static struct regmap * __init 
>> ingenic_tcu_create_regmap(struct
>>  > >  > > device_node *np)
>>  > >  > >  +{
>>  > >  > >  +	struct resource res;
>>  > >  > >  +	void __iomem *base;
>>  > >  > >  +	struct regmap *map;
>>  > >  > >  +
>>  > >  > >  +	if (!of_match_node(ingenic_tcu_of_match, np))
>>  > >  > >  +		return ERR_PTR(-EINVAL);
>>  >
>>  > Drop this check.
>>  >
>>  > >  > >  +	base = of_io_request_and_map(np, 0, "TCU");
>>  > >  > >  +	if (IS_ERR(base))
>>  > >  > >  +		return ERR_PTR(PTR_ERR(base));
>>  > >  > >  +
>>  > >  > >  +	map = regmap_init_mmio(NULL, base,
>>  > > &ingenic_tcu_regmap_config);
>>  > >  > >  +	if (IS_ERR(map))
>>  > >  > >  +		goto err_iounmap;
>>  >
>>  > Place this inside probe().
>>  >
>>  > >  > >  +	return map;
>>  > >  > >  +
>>  > >  > >  +err_iounmap:
>>  > >  > >  +	iounmap(base);
>>  > >  > >  +	of_address_to_resource(np, 0, &res);
>>  > >  > >  +	release_mem_region(res.start, resource_size(&res));
>>  > >  > >  +
>>  > >  > >  +	return map;
>>  > >  > >  +}
>>  > >  >
>>  > >  > Why does this need to be set-up earlier than probe()?
>>  > >
>>  > >  See the explanation below.
>>  >
>>  > I think the answer is, it doesn't.
>>  >
>>  > >  > >  +static int __init ingenic_tcu_probe(struct 
>> platform_device
>>  > > *pdev)
>>  > >  > >  +{
>>  > >  > >  +	struct regmap *map =
>>  > > ingenic_tcu_get_regmap(pdev->dev.of_node);
>>  > >  > >  +
>>  > >  > >  +	platform_set_drvdata(pdev, map);
>>  > >  > >  +
>>  > >  > >  +	regmap_attach_dev(&pdev->dev, map,
>>  > > &ingenic_tcu_regmap_config);
>>  > >  > >  +
>>  > >  > >  +	return devm_of_platform_populate(&pdev->dev);
>>  > >  > >  +}
>>  > >  > >  +
>>  > >  > >  +static struct platform_driver ingenic_tcu_driver = {
>>  > >  > >  +	.driver = {
>>  > >  > >  +		.name = "ingenic-tcu",
>>  > >  > >  +		.of_match_table = ingenic_tcu_of_match,
>>  > >  > >  +	},
>>  > >  > >  +};
>>  > >  > >  +
>>  > >  > >  +static int __init ingenic_tcu_platform_init(void)
>>  > >  > >  +{
>>  > >  > >  +	return platform_driver_probe(&ingenic_tcu_driver,
>>  > >  > >  +				     ingenic_tcu_probe);
>>  > >  >
>>  > >  > What?  Why?
>>  > >
>>  > >  The device driver probed here will populate the children 
>> devices,
>>  > >  which will be able to retrieve the pointer to the regmap 
>> through
>>  > >  device_get_regmap(dev->parent).
>>  >
>>  > I've never heard of this call.  Where is it?
>> 
>>  dev_get_regmap, in <linux/regmap.h>.
>> 
>>  > >  The children devices are normal platform drivers that can be 
>> probed
>>  > >  the normal way. These are the PWM driver, the watchdog driver, 
>> and
>>  > > the
>>  > >  OST (OS Timer) clocksource driver, all part of the same 
>> hardware
>>  > > block
>>  > >  (the Timer/Counter Unit or TCU).
>>  >
>>  > If they are normal devices, then there is no need to roll your own
>>  > regmap-getter implementation like this.
>>  >
>>  > >  > >  +}
>>  > >  > >  +subsys_initcall(ingenic_tcu_platform_init);
>>  > >  > >  +
>>  > >  > >  +struct regmap * __init ingenic_tcu_get_regmap(struct
>>  > > device_node
>>  > >  > > *np)
>>  > >  > >  +{
>>  > >  > >  +	if (!tcu_regmap)
>>  > >  > >  +		tcu_regmap = ingenic_tcu_create_regmap(np);
>>  > >  > >  +
>>  > >  > >  +	return tcu_regmap;
>>  > >  > >  +}
>>  > >  >
>>  > >  > This makes me pretty uncomfortable.
>>  > >  >
>>  > >  > What calls it?
>>  > >
>>  > >  The TCU IRQ driver (patch [06/13]), clocks driver (patch 
>> [05/13]),
>>  > > and the
>>  > >  non-OST clocksource driver (patch [07/13]) all probe very 
>> early in
>>  > > the boot
>>  > >  process, and share the same devicetree node. They call this
>>  > > function to get
>>  > >  a pointer to the regmap.
>>  >
>>  > Horrible!
>>  >
>>  > Instead, you should send it through platform_set_drvdata() and 
>> collect
>>  > it in the child drivers with platform_get_drvdata(dev->parent).
>> 
>>  The IRQ, clocks and clocksource driver do NOT have a "struct 
>> device" to
>>  begin with. They are not platform drivers, and cannot be platform 
>> drivers,
>>  as they must register so early in the boot process, before "struct 
>> device"
>>  is even a thing.
>> 
>>  All they get is a pointer to the same devicetree node. Since all of 
>> these
>>  have to use the same registers, they need to use a shared regmap, 
>> which
>>  they obtain by calling ingenic_tcu_get_regmap() below.
>> 
>>  Then, when this driver's probe gets called, the regmap is retrieved 
>> and
>>  attached to the struct device, and then the children devices will be
>>  probed: the watchdog device, the PWM device, the OST device. These 
>> three
>>  will retrieve the regmap by calling dev_get_regmap(dev->parent, 
>> NULL).
> 
> That makes sense.
> 
> This explanation certainly belongs in the commit log.

Right.

> Can you send your v14, as you intended.  I will re-review it with new
> eyes when you do.

Could you review v13 instead? v14 will be a v13 with tiny teeny
non-code fixes (delete some newlines, replace %i with %d, and
convert the documentation from .txt to .rst).

>>  > >  > >  +bool ingenic_tcu_pwm_can_use_chn(struct device *dev, 
>> unsigned
>>  > > int
>>  > >  > > channel)
>>  > >  > >  +{
>>  > >  > >  +	const struct ingenic_soc_info *soc =
>>  > >  > > device_get_match_data(dev->parent);
>>  > >  > >  +
>>  > >  > >  +	/* Enable all TCU channels for PWM use by default except
>>  > > channels
>>  > >  > > 0/1 */
>>  > >  > >  +	u32 pwm_channels_mask = GENMASK(soc->num_channels - 1, 
>> 2);
>>  > >  > >  +
>>  > >  > >  +	device_property_read_u32(dev->parent,
>>  > > "ingenic,pwm-channels-mask",
>>  > >  > >  +				 &pwm_channels_mask);
>>  >
>>  > Doesn't this call overwrite the previous assignment above?
>> 
>>  Yes, that's intended. You have a default value, that can be 
>> overriden
>>  by a device property.
> 
> You should provide a comment here to make your intentions clear.

Ok.

>>  > >  > >  +	return !!(pwm_channels_mask & BIT(channel));
>>  > >  > >  +}
>>  > >  > >  +EXPORT_SYMBOL_GPL(ingenic_tcu_pwm_can_use_chn);
>>  >
>>  > Where is this called from?
>> 
>>  This is called from the PWM driver.
> 
> Why can't it live in the PWM driver?

It totally can. I'll move it there.

> 
> --
> Lee Jones [李琼斯]
> Linaro Services Technical Lead
> Linaro.org │ Open source software for ARM SoCs
> Follow Linaro: Facebook | Twitter | Blog
diff mbox series

Patch

diff --git a/drivers/mfd/Kconfig b/drivers/mfd/Kconfig
index 294d9567cc71..a13544474e05 100644
--- a/drivers/mfd/Kconfig
+++ b/drivers/mfd/Kconfig
@@ -494,6 +494,14 @@  config HTC_I2CPLD
 	  This device provides input and output GPIOs through an I2C
 	  interface to one or more sub-chips.
 
+config INGENIC_TCU
+	bool "Ingenic Timer/Counter Unit (TCU) support"
+	depends on MIPS || COMPILE_TEST
+	select REGMAP_MMIO
+	help
+	  Say yes here to support the Timer/Counter Unit (TCU) IP present
+	  in the JZ47xx SoCs from Ingenic.
+
 config MFD_INTEL_QUARK_I2C_GPIO
 	tristate "Intel Quark MFD I2C GPIO"
 	depends on PCI
diff --git a/drivers/mfd/Makefile b/drivers/mfd/Makefile
index 52b1a90ff515..fb89e131ae98 100644
--- a/drivers/mfd/Makefile
+++ b/drivers/mfd/Makefile
@@ -180,6 +180,7 @@  obj-$(CONFIG_AB8500_CORE)	+= ab8500-core.o ab8500-sysctrl.o
 obj-$(CONFIG_MFD_TIMBERDALE)    += timberdale.o
 obj-$(CONFIG_PMIC_ADP5520)	+= adp5520.o
 obj-$(CONFIG_MFD_KEMPLD)	+= kempld-core.o
+obj-$(CONFIG_INGENIC_TCU)	+= ingenic-tcu.o
 obj-$(CONFIG_MFD_INTEL_QUARK_I2C_GPIO)	+= intel_quark_i2c_gpio.o
 obj-$(CONFIG_LPC_SCH)		+= lpc_sch.o
 obj-$(CONFIG_LPC_ICH)		+= lpc_ich.o
diff --git a/drivers/mfd/ingenic-tcu.c b/drivers/mfd/ingenic-tcu.c
new file mode 100644
index 000000000000..6c1d5e4310c1
--- /dev/null
+++ b/drivers/mfd/ingenic-tcu.c
@@ -0,0 +1,113 @@ 
+// SPDX-License-Identifier: GPL-2.0
+/*
+ * JZ47xx SoCs TCU MFD driver
+ * Copyright (C) 2019 Paul Cercueil <paul@crapouillou.net>
+ */
+
+#include <linux/mfd/ingenic-tcu.h>
+#include <linux/of_address.h>
+#include <linux/of_platform.h>
+#include <linux/platform_device.h>
+#include <linux/regmap.h>
+
+struct ingenic_soc_info {
+	unsigned int num_channels;
+};
+
+static struct regmap *tcu_regmap __initdata;
+
+static const struct regmap_config ingenic_tcu_regmap_config = {
+	.reg_bits = 32,
+	.val_bits = 32,
+	.reg_stride = 4,
+	.max_register = TCU_REG_OST_CNTHBUF,
+};
+
+static const struct ingenic_soc_info jz4740_soc_info = {
+	.num_channels = 8,
+};
+
+static const struct ingenic_soc_info jz4725b_soc_info = {
+	.num_channels = 6,
+};
+
+static const struct of_device_id ingenic_tcu_of_match[] = {
+	{ .compatible = "ingenic,jz4740-tcu", .data = &jz4740_soc_info, },
+	{ .compatible = "ingenic,jz4725b-tcu", .data = &jz4725b_soc_info, },
+	{ .compatible = "ingenic,jz4770-tcu", .data = &jz4740_soc_info, },
+	{ }
+};
+
+static struct regmap * __init ingenic_tcu_create_regmap(struct device_node *np)
+{
+	struct resource res;
+	void __iomem *base;
+	struct regmap *map;
+
+	if (!of_match_node(ingenic_tcu_of_match, np))
+		return ERR_PTR(-EINVAL);
+
+	base = of_io_request_and_map(np, 0, "TCU");
+	if (IS_ERR(base))
+		return ERR_PTR(PTR_ERR(base));
+
+	map = regmap_init_mmio(NULL, base, &ingenic_tcu_regmap_config);
+	if (IS_ERR(map))
+		goto err_iounmap;
+
+	return map;
+
+err_iounmap:
+	iounmap(base);
+	of_address_to_resource(np, 0, &res);
+	release_mem_region(res.start, resource_size(&res));
+
+	return map;
+}
+
+static int __init ingenic_tcu_probe(struct platform_device *pdev)
+{
+	struct regmap *map = ingenic_tcu_get_regmap(pdev->dev.of_node);
+
+	platform_set_drvdata(pdev, map);
+
+	regmap_attach_dev(&pdev->dev, map, &ingenic_tcu_regmap_config);
+
+	return devm_of_platform_populate(&pdev->dev);
+}
+
+static struct platform_driver ingenic_tcu_driver = {
+	.driver = {
+		.name = "ingenic-tcu",
+		.of_match_table = ingenic_tcu_of_match,
+	},
+};
+
+static int __init ingenic_tcu_platform_init(void)
+{
+	return platform_driver_probe(&ingenic_tcu_driver,
+				     ingenic_tcu_probe);
+}
+subsys_initcall(ingenic_tcu_platform_init);
+
+struct regmap * __init ingenic_tcu_get_regmap(struct device_node *np)
+{
+	if (!tcu_regmap)
+		tcu_regmap = ingenic_tcu_create_regmap(np);
+
+	return tcu_regmap;
+}
+
+bool ingenic_tcu_pwm_can_use_chn(struct device *dev, unsigned int channel)
+{
+	const struct ingenic_soc_info *soc = device_get_match_data(dev->parent);
+
+	/* Enable all TCU channels for PWM use by default except channels 0/1 */
+	u32 pwm_channels_mask = GENMASK(soc->num_channels - 1, 2);
+
+	device_property_read_u32(dev->parent, "ingenic,pwm-channels-mask",
+				 &pwm_channels_mask);
+
+	return !!(pwm_channels_mask & BIT(channel));
+}
+EXPORT_SYMBOL_GPL(ingenic_tcu_pwm_can_use_chn);
diff --git a/include/linux/mfd/ingenic-tcu.h b/include/linux/mfd/ingenic-tcu.h
index 2083fa20821d..21df23916cd2 100644
--- a/include/linux/mfd/ingenic-tcu.h
+++ b/include/linux/mfd/ingenic-tcu.h
@@ -6,6 +6,11 @@ 
 #define __LINUX_MFD_INGENIC_TCU_H_
 
 #include <linux/bitops.h>
+#include <linux/init.h>
+
+struct device;
+struct device_node;
+struct regmap;
 
 #define TCU_REG_WDT_TDR		0x00
 #define TCU_REG_WDT_TCER	0x04
@@ -53,4 +58,7 @@ 
 #define TCU_REG_TCNTc(c)	(TCU_REG_TCNT0 + ((c) * TCU_CHANNEL_STRIDE))
 #define TCU_REG_TCSRc(c)	(TCU_REG_TCSR0 + ((c) * TCU_CHANNEL_STRIDE))
 
+struct regmap * __init ingenic_tcu_get_regmap(struct device_node *np);
+bool ingenic_tcu_pwm_can_use_chn(struct device *dev, unsigned int channel);
+
 #endif /* __LINUX_MFD_INGENIC_TCU_H_ */