Re: [PATCH v5 5/7] clk: meson-axg: Add AO Clock and Reset controller driver

From: Yixun Lan
Date: Tue Apr 17 2018 - 04:18:18 EST


Hi Jerome:

see my comments below

On 04/16/18 19:45, Jerome Brunet wrote:
> On Mon, 2018-04-09 at 22:37 +0800, Yixun Lan wrote:
>> From: Qiufang Dai <qiufang.dai@xxxxxxxxxxx>
>>
>> Adds a Clock and Reset controller driver for the Always-On part
>> of the Amlogic Meson-AXG SoC.
>>
>> Signed-off-by: Qiufang Dai <qiufang.dai@xxxxxxxxxxx>
>> Signed-off-by: Yixun Lan <yixun.lan@xxxxxxxxxxx>
>> ---
>> drivers/clk/meson/Kconfig | 1 +
>> drivers/clk/meson/Makefile | 2 +-
>> drivers/clk/meson/axg-aoclk.c | 164 ++++++++++++++++++++++++++++++++++++++++++
>> drivers/clk/meson/axg-aoclk.h | 31 ++++++++
>> 4 files changed, 197 insertions(+), 1 deletion(-)
>> create mode 100644 drivers/clk/meson/axg-aoclk.c
>> create mode 100644 drivers/clk/meson/axg-aoclk.h
>>
>> diff --git a/drivers/clk/meson/Kconfig b/drivers/clk/meson/Kconfig
>> index fddc7ec7b820..815659eebea3 100644
>> --- a/drivers/clk/meson/Kconfig
>> +++ b/drivers/clk/meson/Kconfig
>> @@ -38,6 +38,7 @@ config COMMON_CLK_AXG
>> bool
>> depends on COMMON_CLK_AMLOGIC
>> select RESET_CONTROLLER
>> + select COMMON_CLK_MESON_AO
>> select COMMON_CLK_REGMAP_MESON
>> select MFD_SYSCON
>> help
>> diff --git a/drivers/clk/meson/Makefile b/drivers/clk/meson/Makefile
>> index 0a8df284f4e7..d0d13aeb369a 100644
>> --- a/drivers/clk/meson/Makefile
>> +++ b/drivers/clk/meson/Makefile
>> @@ -6,5 +6,5 @@ obj-$(CONFIG_COMMON_CLK_AMLOGIC) += clk-pll.o clk-mpll.o clk-audio-divider.o
>> obj-$(CONFIG_COMMON_CLK_MESON_AO) += meson-aoclk.o
>> obj-$(CONFIG_COMMON_CLK_MESON8B) += meson8b.o
>> obj-$(CONFIG_COMMON_CLK_GXBB) += gxbb.o gxbb-aoclk.o gxbb-aoclk-32k.o
>> -obj-$(CONFIG_COMMON_CLK_AXG) += axg.o
>> +obj-$(CONFIG_COMMON_CLK_AXG) += axg.o axg-aoclk.o
>> obj-$(CONFIG_COMMON_CLK_REGMAP_MESON) += clk-regmap.o
>> diff --git a/drivers/clk/meson/axg-aoclk.c b/drivers/clk/meson/axg-aoclk.c
>> new file mode 100644
>> index 000000000000..cb56d809d3df
>> --- /dev/null
>> +++ b/drivers/clk/meson/axg-aoclk.c
>> @@ -0,0 +1,164 @@
>> +// SPDX-License-Identifier: GPL-2.0+
>> +/*
>> + * Amlogic Meson-AXG Clock Controller Driver
>> + *
>> + * Copyright (c) 2016 Baylibre SAS.
>> + * Author: Michael Turquette <mturquette@xxxxxxxxxxxx>
>> + *
>> + * Copyright (c) 2018 Amlogic, inc.
>> + * Author: Qiufang Dai <qiufang.dai@xxxxxxxxxxx>
>> + */
>> +#include <linux/clk-provider.h>
>> +#include <linux/platform_device.h>
>> +#include <linux/reset-controller.h>
>> +#include <linux/mfd/syscon.h>
>> +#include <linux/init.h>
> Not required
>
will remove it

>> +#include "clkc.h"
> Why do you need this? looks like clk-regmap.h would be enough here ?
>
you right, I will adjust

>> +#include "axg-aoclk.h"
>> +
>> +#define AXG_AO_GATE(_name, _bit) \
>> +static struct clk_regmap _name##_ao = { \
>> + .data = &(struct clk_regmap_gate_data) { \
>> + .offset = (AO_RTI_GEN_CNTL_REG0), \
>> + .bit_idx = (_bit), \
>> + }, \
>> + .hw.init = &(struct clk_init_data) { \
>> + .name = #_name "_ao", \
>> + .ops = &clk_regmap_gate_ops, \
>> + .parent_names = (const char *[]){ "clk81" }, \
>> + .num_parents = 1, \
>> + .flags = CLK_IGNORE_UNUSED, \
>> + }, \
>> +}
>> +
>> +AXG_AO_GATE(remote, 0);
>> +AXG_AO_GATE(i2c_master, 1);
>> +AXG_AO_GATE(i2c_slave, 2);
>> +AXG_AO_GATE(uart1, 3);
>> +AXG_AO_GATE(uart2, 5);
>> +AXG_AO_GATE(ir_blaster, 6);
>> +AXG_AO_GATE(saradc, 7);
>> +
>> +static struct clk_regmap ao_clk81 = {
>> + .data = &(struct clk_regmap_mux_data) {
>> + .offset = AO_RTI_PWR_CNTL_REG0,
>> + .mask = 0x1,
>> + .shift = 8,
>> + },
>> + .hw.init = &(struct clk_init_data){
>> + .name = "ao_clk81",
>> + .ops = &clk_regmap_mux_ro_ops,
>> + .parent_names = (const char *[]){ "clk81", "ao_alt_xtal"},
>> + .num_parents = 2,
>> + },
>> +};
>> +
>> +static struct clk_regmap axg_saradc_mux = {
>> + .data = &(struct clk_regmap_mux_data) {
>> + .offset = AO_SAR_CLK,
>> + .mask = 0x3,
>> + .shift = 9,
>> + },
>> + .hw.init = &(struct clk_init_data){
>> + .name = "axg_saradc_mux",
>> + .ops = &clk_regmap_mux_ops,
>> + .parent_names = (const char *[]){ "xtal", "ao_clk81" },
>> + .num_parents = 2,
>> + },
>> +};
>> +
>> +static struct clk_regmap axg_saradc_div = {
>> + .data = &(struct clk_regmap_div_data) {
>> + .offset = AO_SAR_CLK,
>> + .shift = 0,
>> + .width = 8,
>> + },
>> + .hw.init = &(struct clk_init_data){
>> + .name = "axg_saradc_div",
>> + .ops = &clk_regmap_divider_ops,
>> + .parent_names = (const char *[]){ "axg_saradc_mux" },
>> + .num_parents = 1,
>> + .flags = CLK_SET_RATE_PARENT,
>> + },
>> +};
>> +
>> +static struct clk_regmap axg_saradc_gate = {
>> + .data = &(struct clk_regmap_gate_data) {
>> + .offset = AO_SAR_CLK,
>> + .bit_idx = 8,
>> + },
>> + .hw.init = &(struct clk_init_data){
>> + .name = "axg_saradc_gate",
>> + .ops = &clk_regmap_gate_ops,
>> + .parent_names = (const char *[]){ "axg_saradc_div" },
>> + .num_parents = 1,
>> + .flags = CLK_SET_RATE_PARENT,
>> + },
>> +};
>> +
>> +static const unsigned int axg_aoclk_reset[] = {
>> + [RESET_AO_REMOTE] = 16,
>> + [RESET_AO_I2C_MASTER] = 18,
>> + [RESET_AO_I2C_SLAVE] = 19,
>> + [RESET_AO_UART1] = 17,
>> + [RESET_AO_UART2] = 22,
>> + [RESET_AO_IR_BLASTER] = 23,
>> +};
>> +
>> +static struct clk_regmap *axg_aoclk_regmap[] = {
>> + [CLKID_AO_REMOTE] = &remote_ao,
>> + [CLKID_AO_I2C_MASTER] = &i2c_master_ao,
>> + [CLKID_AO_I2C_SLAVE] = &i2c_slave_ao,
>> + [CLKID_AO_UART1] = &uart1_ao,
>> + [CLKID_AO_UART2] = &uart2_ao,
>> + [CLKID_AO_IR_BLASTER] = &ir_blaster_ao,
>> + [CLKID_AO_SAR_ADC] = &saradc_ao,
>> + [CLKID_AO_CLK81] = &ao_clk81,
>> + [CLKID_AO_SAR_ADC_SEL] = &axg_saradc_mux,
>> + [CLKID_AO_SAR_ADC_DIV] = &axg_saradc_div,
>> + [CLKID_AO_SAR_ADC_CLK] = &axg_saradc_gate,
>
> Naming is not very consistent here, sometimes ao at beginning, sometimes the
> end, with or w/o axg.
>
> I would prefer if you prefix everything with axg_ao[clk]
> ex: axg_aoclk_remote, axg_aoclk_saradc_mux, etc ...
>
I will adjust this..

but. I'd like to make short as 'axg_ao_' prefix
since we've already adopt this, see drivers/clk/meson/axg.c:823

does this sounds good to you?

>> +};
>> +
>> +static const struct clk_hw_onecell_data axg_aoclk_onecell_data = {
>> + .hws = {
>> + [CLKID_AO_REMOTE] = &remote_ao.hw,
>> + [CLKID_AO_I2C_MASTER] = &i2c_master_ao.hw,
>> + [CLKID_AO_I2C_SLAVE] = &i2c_slave_ao.hw,
>> + [CLKID_AO_UART1] = &uart1_ao.hw,
>> + [CLKID_AO_UART2] = &uart2_ao.hw,
>> + [CLKID_AO_IR_BLASTER] = &ir_blaster_ao.hw,
>> + [CLKID_AO_SAR_ADC] = &saradc_ao.hw,
>> + [CLKID_AO_CLK81] = &ao_clk81.hw,
>> + [CLKID_AO_SAR_ADC_SEL] = &axg_saradc_mux.hw,
>> + [CLKID_AO_SAR_ADC_DIV] = &axg_saradc_div.hw,
>> + [CLKID_AO_SAR_ADC_CLK] = &axg_saradc_gate.hw,
>> + },
>> + .num = NR_CLKS,
>> +};
>> +
>> +static const struct meson_aoclk_data axg_aoclkc_data = {
>> + .reset_reg = AO_RTI_GEN_CNTL_REG0,
>> + .num_reset = ARRAY_SIZE(axg_aoclk_reset),
>> + .reset = axg_aoclk_reset,
>> + .num_clks = ARRAY_SIZE(axg_aoclk_regmap),
>> + .clks = axg_aoclk_regmap,
>> + .hw_data = &axg_aoclk_onecell_data,
>> +};
>> +
>> +static const struct of_device_id axg_aoclkc_match_table[] = {
>> + {
>> + .compatible = "amlogic,meson-axg-aoclkc",
>> + .data = &axg_aoclkc_data,
>> + },
>> + { }
>> +};
>> +
>> +static struct platform_driver axg_aoclkc_driver = {
>> + .probe = meson_aoclkc_probe,
>> + .driver = {
>> + .name = "axg-aoclkc",
>> + .of_match_table = axg_aoclkc_match_table,
>> + },
>> +};
>> +
>> +builtin_platform_driver(axg_aoclkc_driver);
>> diff --git a/drivers/clk/meson/axg-aoclk.h b/drivers/clk/meson/axg-aoclk.h
>> new file mode 100644
>> index 000000000000..396cd3023064
>> --- /dev/null
>> +++ b/drivers/clk/meson/axg-aoclk.h
>> @@ -0,0 +1,31 @@
>> +/* SPDX-License-Identifier: (GPL-2.0+ OR MIT) */
>> +/*
>> + * Copyright (c) 2017 BayLibre, SAS
>> + * Author: Neil Armstrong <narmstrong@xxxxxxxxxxxx>
>> + *
>> + * Copyright (c) 2018 Amlogic, inc.
>> + * Author: Qiufang Dai <qiufang.dai@xxxxxxxxxxx>
>> + */
>> +
>> +#ifndef __AXG_AOCLKC_H
>> +#define __AXG_AOCLKC_H
>> +
>> +#include "meson-aoclk.h"
>> +
>> +#define NR_CLKS 11
>> +/* AO Configuration Clock registers offsets
>> + * Register offsets from the data sheet must be multiplied by 4.
>> + */
>> +#define AO_RTI_PWR_CNTL_REG1 0x0C
>> +#define AO_RTI_PWR_CNTL_REG0 0x10
>> +#define AO_RTI_GEN_CNTL_REG0 0x40
>> +#define AO_OSCIN_CNTL 0x58
>> +#define AO_CRT_CLK_CNTL1 0x68
>> +#define AO_SAR_CLK 0x90
>> +#define AO_RTC_ALT_CLK_CNTL0 0x94
>> +#define AO_RTC_ALT_CLK_CNTL1 0x98
>> +
>> +#include <dt-bindings/clock/axg-aoclkc.h>
>> +#include <dt-bindings/reset/axg-aoclkc.h>
>> +
>> +#endif /* __AXG_AOCLKC_H */
>
> .
>