| Message ID | 20221113171545.282457-5-biju.das.jz@bp.renesas.com (mailing list archive) |
|---|---|
| State | Handled Elsewhere |
| Headers | show |
| Series | None | expand |
On Sun, Nov 13, 2022 at 05:15:44PM +0000, Biju Das wrote: > Add RZ/G2L MTU3a counter driver. This IP supports the following > phase counting modes on MTU1 and MTU2 channels > > 1) 16-bit phase counting modes on MTU1 and MTU2 channels. > 2) 32-bit phase counting mode by cascading MTU1 and MTU2. > > This patch adds 3 counters by creating 3 logical channels > counter0: 16-bit phase counter on MTU1 channel > counter1: 16-bit phase counter on MTU2 channel > counter2: 32-bit phase counter by cascading MTU1 and MTU2 > channels. Within the context of the Counter subsystem, the term "counter" specifically refers to the device (Counts + Synapses + Signals). Instead you should use "count" here to refer to the counter value channels (i.e. count0, count1, and count2). > > Signed-off-by: Biju Das <biju.das.jz@bp.renesas.com> > --- > v5->v6: > * Updated KConfig and commit description > * Sorted header > * Fixed RZ_MTU3_GET_HW_CH Macro for argument reuse 'id' - > possible side-effects? > * Replaced SET_RUNTIME_PM_OPS->DEFINE_RUNTIME_DEV_PM_OPS and removed > __maybe_unused from suspend/resume() > v4->v5: > * Updated the Kconfig with SoC vendor name > * Introduced rz_mtu3_is_counter_invalid() > * replaced pointer to an array of struct rz_mtu3_channel with > a simple pointer to struct rz_mtu3_channel. > * Added long_word_access_ctrl_mode sysfs entry for 16-bit and > 32-bit access > * Added external_input_phase_clock_select sysfs entry for > selecting input clocks. > * used preprocessor defines represent SIGNAL_{A,B,C,D}_ID instead of > signal ids. > v3->v4: > * There is no resource associated with "rz-mtu3-counter" compatible > and moved the code to mfd subsystem as it binds against "rz-mtu". > * Removed struct platform_driver rz_mtu3_cnt_driver. > * Updated commit description > * Updated Kconfig description > * Added macros RZ_MTU3_16_BIT_MTU{1,2}_CH for MTU1 and MTU2 channels > * Added RZ_MTU3_GET_HW_CH macro for getting channel ID. > * replaced priv->ch[id]->priv->ch[0] in rz_mtu3_count_read() > * Cached counter max values > * replaced cnt->tsr in rz_mtu3_count_direction_read() > * Added comments for RZ_MTU3_TCR_CCLR_NONE > * Replaced if with switch in rz_mtu3_initialize_counter() and > rz_mtu3_count_ceiling_write() > * Added locks in initialize, terminate and enable_read to prevent races. > * Updated rz_mtu3_action_read to take care of MTU2 signals. > * Added separate distinct array for each group of Synapse. > * Moved pm handling to parent. > > v1->v3: > * Modelled as a counter device supporting 3 counters(2 16-bit and > 32-bit) > * Add kernel-doc comments to document struct rz_mtu3_cnt > * Removed mmio variable from struct rz_mtu3_cnt > * Removed cnt local variable from rz_mtu3_count_read() > * Replaced -EINVAL->-ERANGE for out of range error conditions. > * Removed explicit cast from write functions. > * Removed local variable val from rz_mtu3_count_ceiling_read() > * Added lock for RMW for counter/ceiling updates. > * Added different synapses for counter0 and counter{1,2} > * Used ARRAY for assigning num_counts. > * Added PM runtime for managing clocks. > * Add MODULE_IMPORT_NS(COUNTER) to import the COUNTER namespace. > --- > drivers/counter/Kconfig | 11 + > drivers/counter/Makefile | 1 + > drivers/counter/rz-mtu3-cnt.c | 717 ++++++++++++++++++++++++++++++++++ > 3 files changed, 729 insertions(+) > create mode 100644 drivers/counter/rz-mtu3-cnt.c > > diff --git a/drivers/counter/Kconfig b/drivers/counter/Kconfig > index d388bf26f4dc..daa352c7392d 100644 > --- a/drivers/counter/Kconfig > +++ b/drivers/counter/Kconfig > @@ -39,6 +39,17 @@ config INTERRUPT_CNT > To compile this driver as a module, choose M here: the > module will be called interrupt-cnt. > > +config RZ_MTU3_CNT > + tristate "Renesas RZ/G2L MTU3a counter driver" > + depends on RZ_MTU3 || COMPILE_TEST > + help > + Enable support for MTU3a counter driver found on Renesas RZ/G2L alike > + SoCs. This IP supports both 16-bit and 32-bit phase counting mode > + support. > + > + To compile this driver as a module, choose M here: the > + module will be called rz-mtu3-cnt. > + > config STM32_TIMER_CNT > tristate "STM32 Timer encoder counter driver" > depends on MFD_STM32_TIMERS || COMPILE_TEST > diff --git a/drivers/counter/Makefile b/drivers/counter/Makefile > index b9a369e0d4fc..933fdd50b3e4 100644 > --- a/drivers/counter/Makefile > +++ b/drivers/counter/Makefile > @@ -8,6 +8,7 @@ counter-y := counter-core.o counter-sysfs.o counter-chrdev.o > > obj-$(CONFIG_104_QUAD_8) += 104-quad-8.o > obj-$(CONFIG_INTERRUPT_CNT) += interrupt-cnt.o > +obj-$(CONFIG_RZ_MTU3_CNT) += rz-mtu3-cnt.o > obj-$(CONFIG_STM32_TIMER_CNT) += stm32-timer-cnt.o > obj-$(CONFIG_STM32_LPTIMER_CNT) += stm32-lptimer-cnt.o > obj-$(CONFIG_TI_EQEP) += ti-eqep.o > diff --git a/drivers/counter/rz-mtu3-cnt.c b/drivers/counter/rz-mtu3-cnt.c > new file mode 100644 > index 000000000000..cfddbbe38ed1 > --- /dev/null > +++ b/drivers/counter/rz-mtu3-cnt.c > @@ -0,0 +1,717 @@ > +// SPDX-License-Identifier: GPL-2.0 > +/* > + * Renesas RZ/G2L MTU3a Counter driver > + * > + * Copyright (C) 2022 Renesas Electronics Corporation > + */ > + > +#include <linux/clk.h> > +#include <linux/counter.h> > +#include <linux/module.h> > +#include <linux/platform_device.h> > +#include <linux/pm_runtime.h> > +#include <linux/types.h> > + > +#include <clocksource/rz-mtu3.h> > + > +#define RZ_MTU3_TSR_TCFD BIT(7) It is not always clear what these acronyms represent to someone not as familiar with the hardware, so I recommend including a comment block above these defines that provides a brief table of registers descriptions. Something like: TSR: Timer Status Register TCFD: Count Direction Flag TMDR: Timer Mode Register TIOR: Timer I/O Control Register TCNT: Timer count ... > +#define RZ_MTU3_MAX_HW_CNTR_CHANNELS (2) > + > +#define RZ_MTU3_TMDR1_PH_CNT_MODE_1 (4) > +#define RZ_MTU3_TMDR1_PH_CNT_MODE_2 (5) > +#define RZ_MTU3_TMDR1_PH_CNT_MODE_3 (6) > +#define RZ_MTU3_TMDR1_PH_CNT_MODE_4 (7) > +#define RZ_MTU3_TMDR1_PH_CNT_MODE_5 (9) > +#define RZ_MTU3_TMDR1_PH_CNT_MODE_MASK (0xf) > + > +#define RZ_MTU3_TMDR3_LWA BIT(0) > +#define RZ_MTU3_TMDR3_PHCKSEL BIT(1) > + > +#define RZ_MTU3_16_BIT_MTU1_CH (0) > +#define RZ_MTU3_16_BIT_MTU2_CH (1) > +#define RZ_MTU3_32_BIT_CH (2) > + > +#define RZ_MTU3_TIOR_NO_OUTPUT (0) > +#define RZ_MTU3_TIOR_IC_BOTH (10) > + > +#define RZ_MTU3_GET_HW_CH(id) \ > +({ \ > + size_t _id = (id); _id = (_id == RZ_MTU3_32_BIT_CH) ? 0 : _id; \ > +}) I probably missed a discussion about this change in a previous thread; what is the purpose of using a local size_t variable here? Is this due to the "possible side-effects" mentioned in the patch changes note? > + > +#define SIGNAL_A_ID (0) > +#define SIGNAL_B_ID (1) > +#define SIGNAL_C_ID (2) > +#define SIGNAL_D_ID (3) > + > +/** > + * struct rz_mtu3_cnt - MTU3 counter private data > + * > + * @clk: MTU3 module clock > + * @lock: Lock to prevent concurrent access for ceiling and count > + * @ch: HW channels for the counters > + * @mtu_16bit_max: Cache for 16-bit counters > + * @mtu_32bit_max: Cache for 32-bit counters > + */ > +struct rz_mtu3_cnt { > + struct clk *clk; > + struct mutex lock; > + struct rz_mtu3_channel *ch; > + u16 mtu_16bit_max[RZ_MTU3_MAX_HW_CNTR_CHANNELS]; > + u32 mtu_32bit_max; Does the ceiling set on the device get clobbered when you change between 16-bit and 32-bit phase modes (i.e. writing to TGRALW vs TGRA)? You have a separate cache for the 32-bit ceiling value here, but if it is getting clobbered then as a small optimization you may reimplement this cache as a union such as: union { u16 mtu_16bit_max[RZ_MTU3_MAX_HW_CNTR_CHANNELS]; u32 mtu_32bit_max; } > +}; > + > +static const enum counter_function rz_mtu3_count_functions[] = { > + COUNTER_FUNCTION_QUADRATURE_X4, > + COUNTER_FUNCTION_PULSE_DIRECTION, > + COUNTER_FUNCTION_QUADRATURE_X2_B, > +}; > + > +static bool rz_mtu3_is_counter_invalid(struct counter_device *counter, int id) > +{ > + struct rz_mtu3_cnt *const priv = counter_priv(counter); > + u16 val; > + > + val = rz_mtu3_shared_reg_read(priv->ch, RZ_MTU3_TMDR3) & RZ_MTU3_TMDR3_LWA; You should use a more descriptive variable name for this such as "lwa_mode_enabled" to make its meaning clearer. > + if (id == RZ_MTU3_32_BIT_CH && val) > + return false; > + > + if (id != RZ_MTU3_32_BIT_CH && !val) > + return false; > + > + return true; > +} > + > +static int rz_mtu3_count_read(struct counter_device *counter, > + struct counter_count *count, u64 *val) > +{ > + struct rz_mtu3_cnt *const priv = counter_priv(counter); > + const size_t ch_id = RZ_MTU3_GET_HW_CH(count->id); > + > + if (rz_mtu3_is_counter_invalid(counter, count->id)) > + return -EINVAL; > + > + if (count->id == RZ_MTU3_32_BIT_CH) > + *val = rz_mtu3_32bit_ch_read(priv->ch + ch_id, RZ_MTU3_TCNTLW); > + else > + *val = rz_mtu3_16bit_ch_read(priv->ch + ch_id, RZ_MTU3_TCNT); > + > + return 0; > +} > + > +static int rz_mtu3_count_write(struct counter_device *counter, > + struct counter_count *count, const u64 val) > +{ > + struct rz_mtu3_cnt *const priv = counter_priv(counter); > + const size_t ch_id = RZ_MTU3_GET_HW_CH(count->id); > + u32 ceiling; > + > + if (rz_mtu3_is_counter_invalid(counter, count->id)) > + return -EINVAL; > + > + mutex_lock(&priv->lock); > + if (count->id == RZ_MTU3_32_BIT_CH) > + ceiling = priv->mtu_32bit_max; > + else > + ceiling = priv->mtu_16bit_max[ch_id]; > + > + if (count->id == RZ_MTU3_32_BIT_CH) > + rz_mtu3_32bit_ch_write(priv->ch + ch_id, RZ_MTU3_TCNTLW, val); > + else > + rz_mtu3_16bit_ch_write(priv->ch + ch_id, RZ_MTU3_TCNT, val); > + > + mutex_unlock(&priv->lock); > + > + return 0; > +} > + > +static int rz_mtu3_count_function_read(struct counter_device *counter, > + struct counter_count *count, > + enum counter_function *function) > +{ > + struct rz_mtu3_cnt *const priv = counter_priv(counter); > + const size_t ch_id = RZ_MTU3_GET_HW_CH(count->id); > + u8 val; > + > + val = rz_mtu3_8bit_ch_read(priv->ch + ch_id, RZ_MTU3_TMDR1); A more descriptive name for this variable would be helpful to make clearer what this value represents (maybe "timer_mode"). > + > + switch (val & RZ_MTU3_TMDR1_PH_CNT_MODE_MASK) { > + case RZ_MTU3_TMDR1_PH_CNT_MODE_1: > + *function = COUNTER_FUNCTION_QUADRATURE_X4; > + break; > + case RZ_MTU3_TMDR1_PH_CNT_MODE_2: > + *function = COUNTER_FUNCTION_PULSE_DIRECTION; > + break; > + case RZ_MTU3_TMDR1_PH_CNT_MODE_4: > + *function = COUNTER_FUNCTION_QUADRATURE_X2_B; > + break; > + default: > + return -EINVAL; > + } Sorry if I asked this before: what are counting modes 3 and 5, and are they not supported by this device? If they are not supported, please include a comment stating so in the default case block so that it is clear for future reviewers as well. > + > + return 0; > +} > + > +static int rz_mtu3_count_function_write(struct counter_device *counter, > + struct counter_count *count, > + enum counter_function function) > +{ > + struct rz_mtu3_cnt *const priv = counter_priv(counter); > + const size_t ch_id = RZ_MTU3_GET_HW_CH(count->id); > + u8 mode; > + > + switch (function) { > + case COUNTER_FUNCTION_QUADRATURE_X4: > + mode = RZ_MTU3_TMDR1_PH_CNT_MODE_1; > + break; > + case COUNTER_FUNCTION_PULSE_DIRECTION: > + mode = RZ_MTU3_TMDR1_PH_CNT_MODE_2; > + break; > + case COUNTER_FUNCTION_QUADRATURE_X2_B: > + mode = RZ_MTU3_TMDR1_PH_CNT_MODE_4; > + break; > + default: > + return -EINVAL; > + } > + > + rz_mtu3_8bit_ch_write(priv->ch + ch_id, RZ_MTU3_TMDR1, mode); > + > + return 0; > +} > + > +static int rz_mtu3_count_direction_read(struct counter_device *counter, > + struct counter_count *count, > + enum counter_count_direction *direction) > +{ > + struct rz_mtu3_cnt *const priv = counter_priv(counter); > + const size_t ch_id = RZ_MTU3_GET_HW_CH(count->id); > + u8 tsr; > + > + tsr = rz_mtu3_8bit_ch_read(priv->ch + ch_id, RZ_MTU3_TSR); > + > + if (tsr & RZ_MTU3_TSR_TCFD) > + *direction = COUNTER_COUNT_DIRECTION_FORWARD; > + else > + *direction = COUNTER_COUNT_DIRECTION_BACKWARD; The following is completely up to you if you want to do so, but I think this conditional looks nicer as a ternary expression: *direction = (tsr & RZ_MTU3_TSR_TCFD) ? COUNTER_COUNT_DIRECTION_FORWARD : COUNTER_COUNT_DIRECTION_BACKWARD; > + > + return 0; > +} > + > +static int rz_mtu3_count_ceiling_read(struct counter_device *counter, > + struct counter_count *count, > + u64 *ceiling) > +{ > + struct rz_mtu3_cnt *const priv = counter_priv(counter); > + const size_t ch_id = RZ_MTU3_GET_HW_CH(count->id); > + > + if (count->id == RZ_MTU3_32_BIT_CH) > + *ceiling = priv->mtu_32bit_max; > + else > + *ceiling = priv->mtu_16bit_max[ch_id]; Use a switch statement here to be consistent with the ceiling_write() callback. > + > + return 0; > +} > + > +static int rz_mtu3_count_ceiling_write(struct counter_device *counter, > + struct counter_count *count, > + u64 ceiling) > +{ > + struct rz_mtu3_cnt *const priv = counter_priv(counter); > + const size_t ch_id = RZ_MTU3_GET_HW_CH(count->id); > + > + if (rz_mtu3_is_counter_invalid(counter, count->id)) > + return -EINVAL; > + > + switch (count->id) { > + case RZ_MTU3_16_BIT_MTU1_CH: > + case RZ_MTU3_16_BIT_MTU2_CH: > + if (ceiling > U16_MAX) > + return -ERANGE; > + priv->mtu_16bit_max[ch_id] = ceiling; > + break; > + case RZ_MTU3_32_BIT_CH: > + if (ceiling > U32_MAX) > + return -ERANGE; > + priv->mtu_32bit_max = ceiling; > + break; > + } Provide a default case for this switch statement. In theory we should never reach that code path, but it's good practice to have in case a bug appears in the Counter subsystem: default: /* should never reach this path */ return -EINVAL; Make sure to provide similar default cases in the other switch statements as well. > + > + mutex_lock(&priv->lock); > + if (count->id == RZ_MTU3_32_BIT_CH) > + rz_mtu3_32bit_ch_write(priv->ch + ch_id, RZ_MTU3_TGRALW, ceiling); > + else > + rz_mtu3_16bit_ch_write(priv->ch + ch_id, RZ_MTU3_TGRA, ceiling); > + > + rz_mtu3_8bit_ch_write(priv->ch + ch_id, RZ_MTU3_TCR, RZ_MTU3_TCR_CCLR_TGRA); > + mutex_unlock(&priv->lock); > + > + return 0; > +} > + > +static void rz_mtu3_32bit_cnt_setting(struct counter_device *counter, int id) > +{ > + struct rz_mtu3_cnt *const priv = counter_priv(counter); > + struct rz_mtu3_channel *ch1 = priv->ch; > + struct rz_mtu3_channel *ch2 = ch1 + 1; > + > + /* > + * 32-bit phase counting need MTU1 and MTU2 to create 32-bit cascade > + * counter. > + */ > + ch1->function = RZ_MTU3_32BIT_PHASE_COUNTING; > + ch2->function = RZ_MTU3_32BIT_PHASE_COUNTING; Can these "function" members be modified from outside this driver? If so, you could have a race condition here. > + > + /* Phase counting mode 1 is used as default in initialization. */ > + rz_mtu3_8bit_ch_write(ch1, RZ_MTU3_TMDR1, RZ_MTU3_TMDR1_PH_CNT_MODE_1); > + > + rz_mtu3_8bit_ch_write(ch1, RZ_MTU3_TCR, RZ_MTU3_TCR_CCLR_TGRA); > + rz_mtu3_8bit_ch_write(ch1, RZ_MTU3_TIOR, RZ_MTU3_TIOR_IC_BOTH); > + > + rz_mtu3_enable(ch1); > + rz_mtu3_enable(ch2); > +} > + > +static void rz_mtu3_16bit_cnt_setting(struct counter_device *counter, int id) > +{ > + struct rz_mtu3_cnt *const priv = counter_priv(counter); > + struct rz_mtu3_channel *ch = priv->ch + id; > + > + ch->function = RZ_MTU3_16BIT_PHASE_COUNTING; > + > + /* Phase counting mode 1 is used as default in initialization. */ > + rz_mtu3_8bit_ch_write(ch, RZ_MTU3_TMDR1, RZ_MTU3_TMDR1_PH_CNT_MODE_1); > + > + rz_mtu3_8bit_ch_write(ch, RZ_MTU3_TCR, RZ_MTU3_TCR_CCLR_TGRA); > + rz_mtu3_enable(ch); > +} > + > +static int rz_mtu3_initialize_counter(struct counter_device *counter, int id) > +{ > + struct rz_mtu3_cnt *const priv = counter_priv(counter); > + struct rz_mtu3_channel *ch1 = priv->ch; > + struct rz_mtu3_channel *ch2 = ch1 + 1; No need to complicate this, just use priv->ch[0], priv->ch[1], and priv->ch[id]. Same advice applies to the other functions as well. > + > + mutex_lock(&priv->lock); > + rz_mtu3_8bit_ch_write(ch1, RZ_MTU3_TIOR, RZ_MTU3_TIOR_NO_OUTPUT); > + switch (id) { > + case RZ_MTU3_16_BIT_MTU1_CH: > + case RZ_MTU3_16_BIT_MTU2_CH: > + if ((priv->ch + id)->function != RZ_MTU3_NORMAL) { > + mutex_unlock(&priv->lock); > + return -EBUSY; > + } > + > + rz_mtu3_16bit_cnt_setting(counter, id); > + break; > + case RZ_MTU3_32_BIT_CH: > + if (ch1->function != RZ_MTU3_NORMAL || > + ch2->function != RZ_MTU3_NORMAL) { > + mutex_unlock(&priv->lock); > + return -EBUSY; > + } > + rz_mtu3_32bit_cnt_setting(counter, id); > + break; > + } > + mutex_unlock(&priv->lock); > + > + return 0; > +} > + > +static void rz_mtu3_terminate_counter(struct counter_device *counter, int id) > +{ > + struct rz_mtu3_cnt *const priv = counter_priv(counter); > + struct rz_mtu3_channel *ch1 = priv->ch; > + struct rz_mtu3_channel *ch2 = ch1 + 1; > + > + mutex_lock(&priv->lock); > + if (id == RZ_MTU3_32_BIT_CH) { > + ch1->function = RZ_MTU3_NORMAL; > + ch2->function = RZ_MTU3_NORMAL; > + rz_mtu3_disable(ch2); > + rz_mtu3_disable(ch1); > + } else { > + (priv->ch + id)->function = RZ_MTU3_NORMAL; > + rz_mtu3_disable(priv->ch + id); > + } > + mutex_unlock(&priv->lock); > +} > + > +static int rz_mtu3_count_enable_read(struct counter_device *counter, > + struct counter_count *count, u8 *enable) > +{ > + struct rz_mtu3_cnt *const priv = counter_priv(counter); > + struct rz_mtu3_channel *ch1 = priv->ch; > + struct rz_mtu3_channel *ch2 = ch1 + 1; > + > + if (count->id == RZ_MTU3_32_BIT_CH) { > + mutex_lock(&priv->lock); > + *enable = rz_mtu3_is_enabled(ch1) && > + rz_mtu3_is_enabled(ch2); > + mutex_unlock(&priv->lock); > + } else { > + *enable = rz_mtu3_is_enabled(priv->ch + count->id); > + } > + > + return 0; > +} > + > +static int rz_mtu3_count_enable_write(struct counter_device *counter, > + struct counter_count *count, u8 enable) > +{ > + struct rz_mtu3_cnt *const priv = counter_priv(counter); > + const size_t ch_id = RZ_MTU3_GET_HW_CH(count->id); > + struct rz_mtu3_channel *ch = priv->ch + ch_id; > + int ret = 0; > + > + if (enable) { > + pm_runtime_get_sync(ch->dev); > + ret = rz_mtu3_initialize_counter(counter, count->id); The "enable" Count component serves to pause/resume counting operation; that means the existing count should not be lost when a Count is disabled. The rz_mtu3_initialize_counter() function will clear the current Count, so you'll need to restore it before returning. Alternatively, the "enable" Count component is optional so you can remove it if you don't want to implement it; just initialize the counter at probe time instead. > + } else { > + rz_mtu3_terminate_counter(counter, count->id); > + pm_runtime_put(ch->dev); > + } > + > + return ret; > +} > + > +static int rz_mtu3_long_word_access_ctrl_mode_get(struct counter_device *counter, > + u32 *lwa_ctrl_mode) > +{ > + struct rz_mtu3_cnt *const priv = counter_priv(counter); > + u16 val; > + > + pm_runtime_get_sync(priv->ch->dev); > + val = rz_mtu3_shared_reg_read(priv->ch, RZ_MTU3_TMDR3); > + *lwa_ctrl_mode = val & RZ_MTU3_TMDR3_LWA; > + pm_runtime_put(priv->ch->dev); > + > + return 0; > +} > + > +static int rz_mtu3_long_word_access_ctrl_mode_set(struct counter_device *counter, > + u32 lwa_ctrl_mode) > +{ > + struct rz_mtu3_cnt *const priv = counter_priv(counter); > + u16 val; > + > + pm_runtime_get_sync(priv->ch->dev); > + val = rz_mtu3_shared_reg_read(priv->ch, RZ_MTU3_TMDR3); > + if (lwa_ctrl_mode) > + val |= RZ_MTU3_TMDR3_LWA; > + else > + val &= ~RZ_MTU3_TMDR3_LWA; > + > + rz_mtu3_shared_reg_write(priv->ch, RZ_MTU3_TMDR3, val); > + pm_runtime_put(priv->ch->dev); When you want to assign a bit to a buffer, you can use __assign_bit() to simplify your code: unsigned long tmdr; ... tmdr = rz_mtu3_shared_reg_read(priv->ch, RZ_MTU3_TMDR3); __assign_bit(RZ_MTU3_TMDR3_LWA, &tmdr, !!lwa_ctrl_node); rz_mtu3_shared_reg_write(priv->ch, RZ_MTU3_TMDR3, tmdr); > + > + return 0; > +} > + > +static int rz_mtu3_ext_input_phase_clock_select_get(struct counter_device *counter, > + u32 *ext_input_phase_clock_select) > +{ > + struct rz_mtu3_cnt *const priv = counter_priv(counter); > + u16 val; > + > + pm_runtime_get_sync(priv->ch->dev); > + val = rz_mtu3_shared_reg_read(priv->ch, RZ_MTU3_TMDR3); > + *ext_input_phase_clock_select = (val & RZ_MTU3_TMDR3_PHCKSEL) >> 1; > + pm_runtime_put(priv->ch->dev); > + > + return 0; > +} > + > +static int rz_mtu3_ext_input_phase_clock_select_set(struct counter_device *counter, > + u32 ext_input_phase_clock_select) > +{ > + struct rz_mtu3_cnt *const priv = counter_priv(counter); > + u16 val; > + > + pm_runtime_get_sync(priv->ch->dev); > + val = rz_mtu3_shared_reg_read(priv->ch, RZ_MTU3_TMDR3); > + if (ext_input_phase_clock_select) > + val |= RZ_MTU3_TMDR3_PHCKSEL; > + else > + val &= ~RZ_MTU3_TMDR3_PHCKSEL; > + > + rz_mtu3_shared_reg_write(priv->ch, RZ_MTU3_TMDR3, val); > + pm_runtime_put(priv->ch->dev); > + > + return 0; > +} > + > +static struct counter_comp rz_mtu3_count_ext[] = { > + COUNTER_COMP_DIRECTION(rz_mtu3_count_direction_read), > + COUNTER_COMP_ENABLE(rz_mtu3_count_enable_read, > + rz_mtu3_count_enable_write), > + COUNTER_COMP_CEILING(rz_mtu3_count_ceiling_read, > + rz_mtu3_count_ceiling_write), > +}; > + > +static const enum counter_synapse_action rz_mtu3_synapse_actions[] = { > + COUNTER_SYNAPSE_ACTION_BOTH_EDGES, > + COUNTER_SYNAPSE_ACTION_RISING_EDGE, > + COUNTER_SYNAPSE_ACTION_NONE, > +}; > + > +static int rz_mtu3_action_read(struct counter_device *counter, > + struct counter_count *count, > + struct counter_synapse *synapse, > + enum counter_synapse_action *action) > +{ > + enum counter_function function; > + int err; > + > + err = rz_mtu3_count_function_read(counter, count, &function); > + if (err) > + return err; > + > + /* Default action mode */ > + *action = COUNTER_SYNAPSE_ACTION_NONE; You can exit early here depending on which ext_input_phase_clock mode is currently selected: if "MTCLKA-MTCLKB" then return early if id is signal C or D, while if "MTCLKC-MTCLKD" return early if id is signal A or B. > + > + switch (function) { > + case COUNTER_FUNCTION_PULSE_DIRECTION: > + /* > + * Rising edges on signal A updates the respective count. > + * The input level of signal B determines direction. > + */ Since this also applies for signal C and signal D, you should make that clear in this comment block; maybe adjust to "signal A (signal C)" and "signal B (signal D)" will do. > + if (synapse->signal->id == SIGNAL_A_ID || > + synapse->signal->id == SIGNAL_C_ID) > + *action = COUNTER_SYNAPSE_ACTION_RISING_EDGE; > + break; > + case COUNTER_FUNCTION_QUADRATURE_X2_B: > + /* > + * Any state transition on quadrature pair signal B updates > + * the respective count. > + */ > + if (synapse->signal->id == SIGNAL_B_ID || > + synapse->signal->id == SIGNAL_D_ID) > + *action = COUNTER_SYNAPSE_ACTION_BOTH_EDGES; Same suggestion as above. > + break; > + case COUNTER_FUNCTION_QUADRATURE_X4: > + /* counts up/down on both edges of A and B signal*/ > + *action = COUNTER_SYNAPSE_ACTION_BOTH_EDGES; > + break; > + default: > + return -EINVAL; > + } > + > + return 0; > +} > + > +static const struct counter_ops rz_mtu3_cnt_ops = { > + .count_read = rz_mtu3_count_read, > + .count_write = rz_mtu3_count_write, > + .function_read = rz_mtu3_count_function_read, > + .function_write = rz_mtu3_count_function_write, > + .action_read = rz_mtu3_action_read, > +}; > + > +#define RZ_MTU3_PHASE_SIGNAL(_id, _name) { \ > + .id = (_id), \ > + .name = (_name), \ > +} > + > +static struct counter_signal rz_mtu3_signals[] = { > + RZ_MTU3_PHASE_SIGNAL(SIGNAL_A_ID, "MTU1 MTCLKA"), > + RZ_MTU3_PHASE_SIGNAL(SIGNAL_B_ID, "MTU1 MTCLKB"), > + RZ_MTU3_PHASE_SIGNAL(SIGNAL_C_ID, "MTU2 MTCLKC"), > + RZ_MTU3_PHASE_SIGNAL(SIGNAL_D_ID, "MTU2 MTCLKD"), > +}; > + > +static struct counter_synapse rz_mtu3_mtu1_count_synapses[] = { > + { > + .actions_list = rz_mtu3_synapse_actions, > + .num_actions = ARRAY_SIZE(rz_mtu3_synapse_actions), > + .signal = rz_mtu3_signals, > + }, > + { > + .actions_list = rz_mtu3_synapse_actions, > + .num_actions = ARRAY_SIZE(rz_mtu3_synapse_actions), > + .signal = rz_mtu3_signals + 1, > + } > +}; > + > +static struct counter_synapse rz_mtu3_mtu2_count_synapses[] = { > + { > + .actions_list = rz_mtu3_synapse_actions, > + .num_actions = ARRAY_SIZE(rz_mtu3_synapse_actions), > + .signal = rz_mtu3_signals, > + }, > + { > + .actions_list = rz_mtu3_synapse_actions, > + .num_actions = ARRAY_SIZE(rz_mtu3_synapse_actions), > + .signal = rz_mtu3_signals + 1, > + }, > + { > + .actions_list = rz_mtu3_synapse_actions, > + .num_actions = ARRAY_SIZE(rz_mtu3_synapse_actions), > + .signal = rz_mtu3_signals + 2, > + }, > + { > + .actions_list = rz_mtu3_synapse_actions, > + .num_actions = ARRAY_SIZE(rz_mtu3_synapse_actions), > + .signal = rz_mtu3_signals + 3, > + } > +}; > + > +static struct counter_count rz_mtu3_counts[] = { > + { > + .id = RZ_MTU3_16_BIT_MTU1_CH, > + .name = "Channel 1 Count", > + .functions_list = rz_mtu3_count_functions, > + .num_functions = ARRAY_SIZE(rz_mtu3_count_functions), > + .synapses = rz_mtu3_mtu1_count_synapses, > + .num_synapses = ARRAY_SIZE(rz_mtu3_mtu1_count_synapses), > + .ext = rz_mtu3_count_ext, > + .num_ext = ARRAY_SIZE(rz_mtu3_count_ext), > + }, > + { > + .id = RZ_MTU3_16_BIT_MTU2_CH, > + .name = "Channel 2 Count", > + .functions_list = rz_mtu3_count_functions, > + .num_functions = ARRAY_SIZE(rz_mtu3_count_functions), > + .synapses = rz_mtu3_mtu2_count_synapses, > + .num_synapses = ARRAY_SIZE(rz_mtu3_mtu2_count_synapses), > + .ext = rz_mtu3_count_ext, > + .num_ext = ARRAY_SIZE(rz_mtu3_count_ext), > + }, > + { > + .id = RZ_MTU3_32_BIT_CH, > + .name = "Channel 1 and 2 (combined) Count", > + .functions_list = rz_mtu3_count_functions, > + .num_functions = ARRAY_SIZE(rz_mtu3_count_functions), > + .synapses = rz_mtu3_mtu2_count_synapses, I'm just checking again for my benefit of understanding: in 32-bit phase counting mode, if ext_input_phase_clock_select is "MTCLKC-MTCLKD", is signal C and D used instead of signal A and B? In other words, is the ext_input_phase_clock_select only valid for 16-bit phase counting mode, or does it also apply for 32-bit phase counting mode? > + .num_synapses = ARRAY_SIZE(rz_mtu3_mtu2_count_synapses), > + .ext = rz_mtu3_count_ext, > + .num_ext = ARRAY_SIZE(rz_mtu3_count_ext), > + } > +}; > + > +static const char *const rz_mtu3_long_word_access_ctrl_modes[] = { > + "16-bit", > + "32-bit", > +}; > + > +static DEFINE_COUNTER_ENUM(rz_mtu3_long_word_access_ctrl_mode_enum, > + rz_mtu3_long_word_access_ctrl_modes); > + > +static const char *const rz_mtu3_ext_input_phase_clock_select[] = { > + "MTCLKA-MTCLKB", > + "MTCLKC-MTCLKD", > +}; > + > +static DEFINE_COUNTER_ENUM(rz_mtu3_ext_input_phase_clock_select_enum, > + rz_mtu3_ext_input_phase_clock_select); > + > +static struct counter_comp rz_mtu3_device_ext[] = { > + COUNTER_COMP_DEVICE_ENUM("long_word_access_ctrl_mode", Cascading Counts seems like a feature that other counter devices may also want to expose so it'll be prudent to rename this to something more general that other drivers can expose. Perhaps reimplement this as a COUNTER_COMP_DEVICE_BOOL and call it "cascade_enable", or something similar. > + rz_mtu3_long_word_access_ctrl_mode_get, > + rz_mtu3_long_word_access_ctrl_mode_set, > + rz_mtu3_long_word_access_ctrl_mode_enum), > + COUNTER_COMP_DEVICE_ENUM("external_input_phase_clock_select", > + rz_mtu3_ext_input_phase_clock_select_get, > + rz_mtu3_ext_input_phase_clock_select_set, > + rz_mtu3_ext_input_phase_clock_select_enum), > +}; > + > +static int rz_mtu3_cnt_pm_runtime_suspend(struct device *dev) > +{ > + struct clk *const clk = dev_get_drvdata(dev); > + > + clk_disable_unprepare(clk); > + > + return 0; > +} > + > +static int rz_mtu3_cnt_pm_runtime_resume(struct device *dev) > +{ > + struct clk *const clk = dev_get_drvdata(dev); > + > + clk_prepare_enable(clk); > + > + return 0; > +} Do the current counts need to be saved and restored when the pm suspend/resume ops occur? William Breathitt Gray > + > +static DEFINE_RUNTIME_DEV_PM_OPS(rz_mtu3_cnt_pm_ops, > + rz_mtu3_cnt_pm_runtime_suspend, > + rz_mtu3_cnt_pm_runtime_resume, NULL); > + > +static void rz_mtu3_cnt_pm_disable(void *data) > +{ > + struct device *dev = data; > + > + pm_runtime_disable(dev); > + pm_runtime_set_suspended(dev); > +} > + > +static int rz_mtu3_cnt_probe(struct platform_device *pdev) > +{ > + struct rz_mtu3 *ddata = dev_get_drvdata(pdev->dev.parent); > + struct device *dev = &pdev->dev; > + struct counter_device *counter; > + struct rz_mtu3_cnt *priv; > + unsigned int i; > + int ret; > + > + counter = devm_counter_alloc(dev, sizeof(*priv)); > + if (!counter) > + return -ENOMEM; > + > + priv = counter_priv(counter); > + priv->clk = ddata->clk; > + priv->mtu_32bit_max = U32_MAX; > + priv->ch = &ddata->channels[RZ_MTU1]; > + for (i = 0; i < RZ_MTU3_MAX_HW_CNTR_CHANNELS; i++) { > + (priv->ch + i)->dev = dev; > + priv->mtu_16bit_max[i] = U16_MAX; > + } > + > + mutex_init(&priv->lock); > + platform_set_drvdata(pdev, priv->clk); > + clk_prepare_enable(priv->clk); > + pm_runtime_set_active(&pdev->dev); > + pm_runtime_enable(&pdev->dev); > + ret = devm_add_action_or_reset(&pdev->dev, rz_mtu3_cnt_pm_disable, dev); > + if (ret < 0) > + goto disable_clock; > + > + counter->name = dev_name(dev); > + counter->parent = dev; > + counter->ops = &rz_mtu3_cnt_ops; > + counter->counts = rz_mtu3_counts; > + counter->num_counts = ARRAY_SIZE(rz_mtu3_counts); > + counter->signals = rz_mtu3_signals; > + counter->num_signals = ARRAY_SIZE(rz_mtu3_signals); > + counter->ext = rz_mtu3_device_ext; > + counter->num_ext = ARRAY_SIZE(rz_mtu3_device_ext); > + > + /* Register Counter device */ > + ret = devm_counter_add(dev, counter); > + if (ret < 0) { > + dev_err_probe(dev, ret, "Failed to add counter\n"); > + goto disable_clock; > + } > + > + return 0; > + > +disable_clock: > + clk_disable_unprepare(priv->clk); > + > + return ret; > +} > + > +static struct platform_driver rz_mtu3_cnt_driver = { > + .probe = rz_mtu3_cnt_probe, > + .driver = { > + .name = "rz-mtu3-counter", > + .pm = pm_ptr(&rz_mtu3_cnt_pm_ops), > + }, > +}; > +module_platform_driver(rz_mtu3_cnt_driver); > + > +MODULE_AUTHOR("Biju Das <biju.das.jz@bp.renesas.com>"); > +MODULE_ALIAS("platform:rz-mtu3-counter"); > +MODULE_DESCRIPTION("Renesas RZ/G2L MTU3a counter driver"); > +MODULE_LICENSE("GPL"); > +MODULE_IMPORT_NS(COUNTER); > -- > 2.25.1 >
Hi Biju, I have a few follow-up comments that came to my mind. On Sun, Nov 13, 2022 at 10:47:13PM -0500, William Breathitt Gray wrote: > On Sun, Nov 13, 2022 at 05:15:44PM +0000, Biju Das wrote: > > Add RZ/G2L MTU3a counter driver. This IP supports the following > > phase counting modes on MTU1 and MTU2 channels > > > > 1) 16-bit phase counting modes on MTU1 and MTU2 channels. > > 2) 32-bit phase counting mode by cascading MTU1 and MTU2. > > > > This patch adds 3 counters by creating 3 logical channels > > counter0: 16-bit phase counter on MTU1 channel > > counter1: 16-bit phase counter on MTU2 channel > > counter2: 32-bit phase counter by cascading MTU1 and MTU2 > > channels. > > Within the context of the Counter subsystem, the term "counter" > specifically refers to the device (Counts + Synapses + Signals). Instead > you should use "count" here to refer to the counter value channels (i.e. > count0, count1, and count2). Include a brief description of the Signals and their relationship to the three Counts as well in this commit message. In particular, mention how "MTCLKA-MTCLKB" and "MTCLKC-MTCLKD" can be toggled for MTU2, etc. > > +static int rz_mtu3_long_word_access_ctrl_mode_set(struct counter_device *counter, > > + u32 lwa_ctrl_mode) > > +{ > > + struct rz_mtu3_cnt *const priv = counter_priv(counter); > > + u16 val; > > + > > + pm_runtime_get_sync(priv->ch->dev); > > + val = rz_mtu3_shared_reg_read(priv->ch, RZ_MTU3_TMDR3); > > + if (lwa_ctrl_mode) > > + val |= RZ_MTU3_TMDR3_LWA; > > + else > > + val &= ~RZ_MTU3_TMDR3_LWA; > > + > > + rz_mtu3_shared_reg_write(priv->ch, RZ_MTU3_TMDR3, val); > > + pm_runtime_put(priv->ch->dev); > > When you want to assign a bit to a buffer, you can use __assign_bit() to > simplify your code: > > unsigned long tmdr; > ... > tmdr = rz_mtu3_shared_reg_read(priv->ch, RZ_MTU3_TMDR3); > __assign_bit(RZ_MTU3_TMDR3_LWA, &tmdr, !!lwa_ctrl_node); > rz_mtu3_shared_reg_write(priv->ch, RZ_MTU3_TMDR3, tmdr); You should consider implementing a rz_mtu3_shared_reg_update_bits() that will perform this read => assign bits => write sequence so that you can reuse this pattern in the rz_mtu3_ext_input_phase_clock_select_set(). > > +static int rz_mtu3_action_read(struct counter_device *counter, > > + struct counter_count *count, > > + struct counter_synapse *synapse, > > + enum counter_synapse_action *action) > > +{ > > + enum counter_function function; > > + int err; > > + > > + err = rz_mtu3_count_function_read(counter, count, &function); > > + if (err) > > + return err; > > + > > + /* Default action mode */ > > + *action = COUNTER_SYNAPSE_ACTION_NONE; > > You can exit early here depending on which ext_input_phase_clock mode is > currently selected: if "MTCLKA-MTCLKB" then return early if id is signal > C or D, while if "MTCLKC-MTCLKD" return early if id is signal A or B. IIUC count0 is always "MTCLKA-MTCLKB", so this exit early check won't apply in that particular case; check count->id to see which Count we're handling. William Breathitt Gray
Hi William Breathitt Gray, Thanks for the feedback. > -----Original Message----- > From: William Breathitt Gray <william.gray@linaro.org> > Sent: 14 November 2022 03:47 > To: Biju Das <biju.das.jz@bp.renesas.com> > Cc: linux-iio@vger.kernel.org; Geert Uytterhoeven <geert+renesas@glider.be>; > Chris Paterson <Chris.Paterson2@renesas.com>; Prabhakar Mahadev Lad > <prabhakar.mahadev-lad.rj@bp.renesas.com>; linux-renesas-soc@vger.kernel.org > Subject: Re: [PATCH v6 4/5] counter: Add Renesas RZ/G2L MTU3a counter driver > > On Sun, Nov 13, 2022 at 05:15:44PM +0000, Biju Das wrote: > > > > > Signed-off-by: Biju Das <biju.das.jz@bp.renesas.com> > > --- > > +#define RZ_MTU3_GET_HW_CH(id) \ > > +({ \ > > + size_t _id = (id); _id = (_id == RZ_MTU3_32_BIT_CH) ? 0 : _id; \ > > +}) > > I probably missed a discussion about this change in a previous thread; what > is the purpose of using a local size_t variable here? Is this due to the > "possible side-effects" mentioned in the patch changes note? Check patch is complaining "CHECK: Macro argument reuse 'id' - possible side-effects?" By using local size_t variable, it fixed the check patch warning. > > > + > > +#define SIGNAL_A_ID (0) > > +#define SIGNAL_B_ID (1) > > +#define SIGNAL_C_ID (2) > > +#define SIGNAL_D_ID (3) > > + > > +/** > > + * struct rz_mtu3_cnt - MTU3 counter private data > > + * > > + * @clk: MTU3 module clock > > + * @lock: Lock to prevent concurrent access for ceiling and count > > + * @ch: HW channels for the counters > > + * @mtu_16bit_max: Cache for 16-bit counters > > + * @mtu_32bit_max: Cache for 32-bit counters */ struct rz_mtu3_cnt { > > + struct clk *clk; > > + struct mutex lock; > > + struct rz_mtu3_channel *ch; > > + u16 mtu_16bit_max[RZ_MTU3_MAX_HW_CNTR_CHANNELS]; > > + u32 mtu_32bit_max; > > Does the ceiling set on the device get clobbered when you change between 16- > bit and 32-bit phase modes (i.e. writing to TGRALW vs TGRA)? You have a > separate cache for the 32-bit ceiling value here, but if it is getting > clobbered then as a small optimization you may reimplement this cache as a > union such as: > > union { > u16 mtu_16bit_max[RZ_MTU3_MAX_HW_CNTR_CHANNELS]; > u32 mtu_32bit_max; > } Yes, it gets clobbered when we change between 16-bit and 32-bit mode. For eg: 0xbe1352 value Split up into mtu1.TGRA=0xbe and mtu2.TGRA=0x1352. OK will use the union. > > > +}; > > + > > > + > > + switch (val & RZ_MTU3_TMDR1_PH_CNT_MODE_MASK) { > > + case RZ_MTU3_TMDR1_PH_CNT_MODE_1: > > + *function = COUNTER_FUNCTION_QUADRATURE_X4; > > + break; > > + case RZ_MTU3_TMDR1_PH_CNT_MODE_2: > > + *function = COUNTER_FUNCTION_PULSE_DIRECTION; > > + break; > > + case RZ_MTU3_TMDR1_PH_CNT_MODE_4: > > + *function = COUNTER_FUNCTION_QUADRATURE_X2_B; > > + break; > > + default: > > + return -EINVAL; > > + } > > Sorry if I asked this before: what are counting modes 3 and 5, and are they > not supported by this device? If they are not supported, please include a > comment stating so in the default case block so that it is clear for future > reviewers as well. Our hardware supports 5 phase counting modes. From that list, I match up some of the functions supported by the counter driver. counting modes 3 and 5 are supported by the Devices, but currently counter driver is not supported this. Please see the attached counting modes 3 and 5. https://ibb.co/3YJByG1 OK, I will add a comment for the details for modes not supported by the current driver in the default block. > > + > > +static void rz_mtu3_32bit_cnt_setting(struct counter_device *counter, > > +int id) { > > + struct rz_mtu3_cnt *const priv = counter_priv(counter); > > + struct rz_mtu3_channel *ch1 = priv->ch; > > + struct rz_mtu3_channel *ch2 = ch1 + 1; > > + > > + /* > > + * 32-bit phase counting need MTU1 and MTU2 to create 32-bit cascade > > + * counter. > > + */ > > + ch1->function = RZ_MTU3_32BIT_PHASE_COUNTING; > > + ch2->function = RZ_MTU3_32BIT_PHASE_COUNTING; > > Can these "function" members be modified from outside this driver? If so, you > could have a race condition here. OK will add channel specific locks to avoid the races. Do you prefer mutex or spin lock here? As channel selection is based on runtime decision For both PWM and counter?? > > > + > > + /* Phase counting mode 1 is used as default in initialization. */ > > + rz_mtu3_8bit_ch_write(ch1, RZ_MTU3_TMDR1, > > +RZ_MTU3_TMDR1_PH_CNT_MODE_1); > > + > > + rz_mtu3_8bit_ch_write(ch1, RZ_MTU3_TCR, RZ_MTU3_TCR_CCLR_TGRA); > > + rz_mtu3_8bit_ch_write(ch1, RZ_MTU3_TIOR, RZ_MTU3_TIOR_IC_BOTH); > > + > > + rz_mtu3_enable(ch1); > > + rz_mtu3_enable(ch2); > > +} > > + > > +static void rz_mtu3_16bit_cnt_setting(struct counter_device *counter, > > +int id) { > > + struct rz_mtu3_cnt *const priv = counter_priv(counter); > > + struct rz_mtu3_channel *ch = priv->ch + id; > > + > > + ch->function = RZ_MTU3_16BIT_PHASE_COUNTING; > > + > > + /* Phase counting mode 1 is used as default in initialization. */ > > + rz_mtu3_8bit_ch_write(ch, RZ_MTU3_TMDR1, > > +RZ_MTU3_TMDR1_PH_CNT_MODE_1); > > + > > + rz_mtu3_8bit_ch_write(ch, RZ_MTU3_TCR, RZ_MTU3_TCR_CCLR_TGRA); > > + rz_mtu3_enable(ch); > > +} > > + > > +static int rz_mtu3_initialize_counter(struct counter_device *counter, > > +int id) { > > + struct rz_mtu3_cnt *const priv = counter_priv(counter); > > + struct rz_mtu3_channel *ch1 = priv->ch; > > + struct rz_mtu3_channel *ch2 = ch1 + 1; > > No need to complicate this, just use priv->ch[0], priv->ch[1], and > priv->ch[id]. Same advice applies to the other functions as well. I get below error when I use array susbscripts. "*ch1 = priv->ch[0];" drivers/counter/rz-mtu3-cnt.c:291:32: error: incompatible types when initialising type 'struct rz_mtu3_channel *' using type 'struct rz_mtu3_channel' 291 | struct rz_mtu3_channel *ch1 = priv->ch[0]; > > > + > > + mutex_lock(&priv->lock); > > + rz_mtu3_8bit_ch_write(ch1, RZ_MTU3_TIOR, RZ_MTU3_TIOR_NO_OUTPUT); > > + switch (id) { > > + case RZ_MTU3_16_BIT_MTU1_CH: > > + case RZ_MTU3_16_BIT_MTU2_CH: > > + if ((priv->ch + id)->function != RZ_MTU3_NORMAL) { > > + mutex_unlock(&priv->lock); > > + return -EBUSY; > > + } > > + > > + rz_mtu3_16bit_cnt_setting(counter, id); > > + break; > > + case RZ_MTU3_32_BIT_CH: > > + if (ch1->function != RZ_MTU3_NORMAL || > > + ch2->function != RZ_MTU3_NORMAL) { > > + mutex_unlock(&priv->lock); > > + return -EBUSY; > > + } > > + rz_mtu3_32bit_cnt_setting(counter, id); > > + break; > > + } > > + mutex_unlock(&priv->lock); > > + > > + return 0; > > +} > > + > > +static void rz_mtu3_terminate_counter(struct counter_device *counter, > > +int id) { > > + struct rz_mtu3_cnt *const priv = counter_priv(counter); > > + struct rz_mtu3_channel *ch1 = priv->ch; > > + struct rz_mtu3_channel *ch2 = ch1 + 1; > > + > > + mutex_lock(&priv->lock); > > + if (id == RZ_MTU3_32_BIT_CH) { > > + ch1->function = RZ_MTU3_NORMAL; > > + ch2->function = RZ_MTU3_NORMAL; > > + rz_mtu3_disable(ch2); > > + rz_mtu3_disable(ch1); > > + } else { > > + (priv->ch + id)->function = RZ_MTU3_NORMAL; > > + rz_mtu3_disable(priv->ch + id); > > + } > > + mutex_unlock(&priv->lock); > > +} > > + > > +static int rz_mtu3_count_enable_read(struct counter_device *counter, > > + struct counter_count *count, u8 *enable) { > > + struct rz_mtu3_cnt *const priv = counter_priv(counter); > > + struct rz_mtu3_channel *ch1 = priv->ch; > > + struct rz_mtu3_channel *ch2 = ch1 + 1; > > + > > + if (count->id == RZ_MTU3_32_BIT_CH) { > > + mutex_lock(&priv->lock); > > + *enable = rz_mtu3_is_enabled(ch1) && > > + rz_mtu3_is_enabled(ch2); > > + mutex_unlock(&priv->lock); > > + } else { > > + *enable = rz_mtu3_is_enabled(priv->ch + count->id); > > + } > > + > > + return 0; > > +} > > + > > +static int rz_mtu3_count_enable_write(struct counter_device *counter, > > + struct counter_count *count, u8 enable) { > > + struct rz_mtu3_cnt *const priv = counter_priv(counter); > > + const size_t ch_id = RZ_MTU3_GET_HW_CH(count->id); > > + struct rz_mtu3_channel *ch = priv->ch + ch_id; > > + int ret = 0; > > + > > + if (enable) { > > + pm_runtime_get_sync(ch->dev); > > + ret = rz_mtu3_initialize_counter(counter, count->id); > > The "enable" Count component serves to pause/resume counting operation; that > means the existing count should not be lost when a Count is disabled. The > rz_mtu3_initialize_counter() function will clear the current Count, so you'll > need to restore it before returning. Yes, it is doing pause/resume operation only. It is using clock gating and PM operations. During enable, Channel is enabled, clk is on. During disable, Channel is disabled, clk is off. Here we are not losing the count when it is disabled and then enable particular count. But we will loss the count, after disable, if it is used by other devices such as PWM Or we are switching to 16-bit and 32-bit and vice versa. Maybe Will rename it to "rz_mtu3_{resume,pause}_counter" to make it clear. Compared to PWM framework we are missing export/unexport calls here in counter subsystem. For PWM, we have an export/unexport calls for creating runtime pwm devices such as pwm0, pwm1 for pwmdevice. Here, count0, count1 and count2 are created during probe. My current test sequence is, 1) Set phase clk 2) Set cascade_enable 3) Set enable(Since we don't have export/unexport, I am using disable calls for freeing Channels for other subsystem) 4) Set count 5) Set ceiling > > Alternatively, the "enable" Count component is optional so you can remove it > if you don't want to implement it; just initialize the counter at probe time > instead. Let me know your opinion based on the above? > > > + } else { > > + rz_mtu3_terminate_counter(counter, count->id); > > + pm_runtime_put(ch->dev); > > + } > > + > > + return ret; > > +} > > + > > +static int rz_mtu3_long_word_access_ctrl_mode_get(struct counter_device > *counter, > > + u32 *lwa_ctrl_mode) > > +{ > > + struct rz_mtu3_cnt *const priv = counter_priv(counter); > > + u16 val; > > + > > + pm_runtime_get_sync(priv->ch->dev); > > + val = rz_mtu3_shared_reg_read(priv->ch, RZ_MTU3_TMDR3); > > + *lwa_ctrl_mode = val & RZ_MTU3_TMDR3_LWA; > > + pm_runtime_put(priv->ch->dev); > > + > > + return 0; > > +} > > + > > +static int rz_mtu3_long_word_access_ctrl_mode_set(struct counter_device > *counter, > > + u32 lwa_ctrl_mode) > > +{ > > + struct rz_mtu3_cnt *const priv = counter_priv(counter); > > + u16 val; > > + > > + pm_runtime_get_sync(priv->ch->dev); > > + val = rz_mtu3_shared_reg_read(priv->ch, RZ_MTU3_TMDR3); > > + if (lwa_ctrl_mode) > > + val |= RZ_MTU3_TMDR3_LWA; > > + else > > + val &= ~RZ_MTU3_TMDR3_LWA; > > + > > + rz_mtu3_shared_reg_write(priv->ch, RZ_MTU3_TMDR3, val); > > + pm_runtime_put(priv->ch->dev); > > When you want to assign a bit to a buffer, you can use __assign_bit() to > simplify your code: OK will use and remove BIT macro for both RZ_MTU3_TMDR3_LWA & RZ_MTU3_TMDR3_PHCKSEL And use bit apis. > > +static struct counter_count rz_mtu3_counts[] = { > > + { > > + .id = RZ_MTU3_16_BIT_MTU1_CH, > > + .name = "Channel 1 Count", > > + .functions_list = rz_mtu3_count_functions, > > + .num_functions = ARRAY_SIZE(rz_mtu3_count_functions), > > + .synapses = rz_mtu3_mtu1_count_synapses, > > + .num_synapses = ARRAY_SIZE(rz_mtu3_mtu1_count_synapses), > > + .ext = rz_mtu3_count_ext, > > + .num_ext = ARRAY_SIZE(rz_mtu3_count_ext), > > + }, > > + { > > + .id = RZ_MTU3_16_BIT_MTU2_CH, > > + .name = "Channel 2 Count", > > + .functions_list = rz_mtu3_count_functions, > > + .num_functions = ARRAY_SIZE(rz_mtu3_count_functions), > > + .synapses = rz_mtu3_mtu2_count_synapses, > > + .num_synapses = ARRAY_SIZE(rz_mtu3_mtu2_count_synapses), > > + .ext = rz_mtu3_count_ext, > > + .num_ext = ARRAY_SIZE(rz_mtu3_count_ext), > > + }, > > + { > > + .id = RZ_MTU3_32_BIT_CH, > > + .name = "Channel 1 and 2 (combined) Count", > > + .functions_list = rz_mtu3_count_functions, > > + .num_functions = ARRAY_SIZE(rz_mtu3_count_functions), > > + .synapses = rz_mtu3_mtu2_count_synapses, > > I'm just checking again for my benefit of understanding: in 32-bit phase > counting mode, if ext_input_phase_clock_select is "MTCLKC-MTCLKD", is signal > C and D used instead of signal A and B? In other words, is the > ext_input_phase_clock_select only valid for 16-bit phase counting mode, or > does it also apply for 32-bit phase counting mode? MTU1(16-bit mode) :- "MTCLKA-MTCLKB", MTU2(16-bit mode) :- "MTCLKA-MTCLKB" or "MTCLKC-MTCLKD" 32-bit mode :- "MTCLKA-MTCLKB" or "MTCLKC-MTCLKD" > > > + .num_synapses = ARRAY_SIZE(rz_mtu3_mtu2_count_synapses), > > + .ext = rz_mtu3_count_ext, > > + .num_ext = ARRAY_SIZE(rz_mtu3_count_ext), > > + } > > +}; > > + > > +static const char *const rz_mtu3_long_word_access_ctrl_modes[] = { > > + "16-bit", > > + "32-bit", > > +}; > > + > > +static DEFINE_COUNTER_ENUM(rz_mtu3_long_word_access_ctrl_mode_enum, > > + rz_mtu3_long_word_access_ctrl_modes); > > + > > +static const char *const rz_mtu3_ext_input_phase_clock_select[] = { > > + "MTCLKA-MTCLKB", > > + "MTCLKC-MTCLKD", > > +}; > > + > > +static DEFINE_COUNTER_ENUM(rz_mtu3_ext_input_phase_clock_select_enum, > > + rz_mtu3_ext_input_phase_clock_select); > > + > > +static struct counter_comp rz_mtu3_device_ext[] = { > > + COUNTER_COMP_DEVICE_ENUM("long_word_access_ctrl_mode", > > Cascading Counts seems like a feature that other counter devices may also > want to expose so it'll be prudent to rename this to something more general > that other drivers can expose. Perhaps reimplement this as a > COUNTER_COMP_DEVICE_BOOL and call it "cascade_enable", or something similar. OK.Will do. > > > + rz_mtu3_long_word_access_ctrl_mode_get, > > + rz_mtu3_long_word_access_ctrl_mode_set, > > + rz_mtu3_long_word_access_ctrl_mode_enum), > > + COUNTER_COMP_DEVICE_ENUM("external_input_phase_clock_select", > > + rz_mtu3_ext_input_phase_clock_select_get, > > + rz_mtu3_ext_input_phase_clock_select_set, > > + rz_mtu3_ext_input_phase_clock_select_enum), > > +}; > > + > > +static int rz_mtu3_cnt_pm_runtime_suspend(struct device *dev) { > > + struct clk *const clk = dev_get_drvdata(dev); > > + > > + clk_disable_unprepare(clk); > > + > > + return 0; > > +} > > + > > +static int rz_mtu3_cnt_pm_runtime_resume(struct device *dev) { > > + struct clk *const clk = dev_get_drvdata(dev); > > + > > + clk_prepare_enable(clk); > > + > > + return 0; > > +} > > Do the current counts need to be saved and restored when the pm > suspend/resume ops occur? For runtime PM it is not required. But it is required for PM Sleep. Currently we don't have any PM sleep functionality. Cheers, Biju
Hi William Breathitt Gray, Thanks for the feedback. > -----Original Message----- > From: William Breathitt Gray <william.gray@linaro.org> > Sent: 14 November 2022 13:53 > To: Biju Das <biju.das.jz@bp.renesas.com> > Cc: linux-iio@vger.kernel.org; Geert Uytterhoeven <geert+renesas@glider.be>; > Chris Paterson <Chris.Paterson2@renesas.com>; Prabhakar Mahadev Lad > <prabhakar.mahadev-lad.rj@bp.renesas.com>; linux-renesas-soc@vger.kernel.org > Subject: Re: [PATCH v6 4/5] counter: Add Renesas RZ/G2L MTU3a counter driver > > Hi Biju, > > I have a few follow-up comments that came to my mind. > > On Sun, Nov 13, 2022 at 10:47:13PM -0500, William Breathitt Gray wrote: > > On Sun, Nov 13, 2022 at 05:15:44PM +0000, Biju Das wrote: > > > Add RZ/G2L MTU3a counter driver. This IP supports the following > > > phase counting modes on MTU1 and MTU2 channels > > > > > > 1) 16-bit phase counting modes on MTU1 and MTU2 channels. > > > 2) 32-bit phase counting mode by cascading MTU1 and MTU2. > > > > > > This patch adds 3 counters by creating 3 logical channels > > > counter0: 16-bit phase counter on MTU1 channel > > > counter1: 16-bit phase counter on MTU2 channel > > > counter2: 32-bit phase counter by cascading MTU1 and MTU2 > > > channels. > > > > Within the context of the Counter subsystem, the term "counter" > > specifically refers to the device (Counts + Synapses + Signals). > > Instead you should use "count" here to refer to the counter value channels > (i.e. > > count0, count1, and count2). > > Include a brief description of the Signals and their relationship to the > three Counts as well in this commit message. In particular, mention how > "MTCLKA-MTCLKB" and "MTCLKC-MTCLKD" can be toggled for MTU2, etc. > > > > +static int rz_mtu3_long_word_access_ctrl_mode_set(struct counter_device > *counter, > > > + u32 lwa_ctrl_mode) > > > +{ > > > + struct rz_mtu3_cnt *const priv = counter_priv(counter); > > > + u16 val; > > > + > > > + pm_runtime_get_sync(priv->ch->dev); > > > + val = rz_mtu3_shared_reg_read(priv->ch, RZ_MTU3_TMDR3); > > > + if (lwa_ctrl_mode) > > > + val |= RZ_MTU3_TMDR3_LWA; > > > + else > > > + val &= ~RZ_MTU3_TMDR3_LWA; > > > + > > > + rz_mtu3_shared_reg_write(priv->ch, RZ_MTU3_TMDR3, val); > > > + pm_runtime_put(priv->ch->dev); > > > > When you want to assign a bit to a buffer, you can use __assign_bit() > > to simplify your code: > > > > unsigned long tmdr; > > ... > > tmdr = rz_mtu3_shared_reg_read(priv->ch, RZ_MTU3_TMDR3); > > __assign_bit(RZ_MTU3_TMDR3_LWA, &tmdr, !!lwa_ctrl_node); > > rz_mtu3_shared_reg_write(priv->ch, RZ_MTU3_TMDR3, tmdr); > > You should consider implementing a rz_mtu3_shared_reg_update_bits() that will > perform this read => assign bits => write sequence so that you can reuse this > pattern in the rz_mtu3_ext_input_phase_clock_select_set(). It is already taken care while working on cascade_enable. > > > > +static int rz_mtu3_action_read(struct counter_device *counter, > > > + struct counter_count *count, > > > + struct counter_synapse *synapse, > > > + enum counter_synapse_action *action) { > > > + enum counter_function function; > > > + int err; > > > + > > > + err = rz_mtu3_count_function_read(counter, count, &function); > > > + if (err) > > > + return err; > > > + > > > + /* Default action mode */ > > > + *action = COUNTER_SYNAPSE_ACTION_NONE; > > > > You can exit early here depending on which ext_input_phase_clock mode > > is currently selected: if "MTCLKA-MTCLKB" then return early if id is > > signal C or D, while if "MTCLKC-MTCLKD" return early if id is signal A or > B. > > IIUC count0 is always "MTCLKA-MTCLKB", so this exit early check won't apply > in that particular case; check count->id to see which Count we're handling. It is already taken care. Cheers, Biju
> > -----Original Message----- > > From: William Breathitt Gray <william.gray@linaro.org> > > Sent: 14 November 2022 03:47 > > To: Biju Das <biju.das.jz@bp.renesas.com> > > Cc: linux-iio@vger.kernel.org; Geert Uytterhoeven > > <geert+renesas@glider.be>; Chris Paterson > > <Chris.Paterson2@renesas.com>; Prabhakar Mahadev Lad > > <prabhakar.mahadev-lad.rj@bp.renesas.com>; > > linux-renesas-soc@vger.kernel.org > > Subject: Re: [PATCH v6 4/5] counter: Add Renesas RZ/G2L MTU3a counter > > driver > > > > On Sun, Nov 13, 2022 at 05:15:44PM +0000, Biju Das wrote: > > > > > > > > Signed-off-by: Biju Das <biju.das.jz@bp.renesas.com> > > > --- > > > +#define RZ_MTU3_GET_HW_CH(id) \ > > > +({ \ > > > + size_t _id = (id); _id = (_id == RZ_MTU3_32_BIT_CH) ? 0 : _id; \ > > > +}) > > > > I probably missed a discussion about this change in a previous thread; > > what is the purpose of using a local size_t variable here? Is this due > > to the "possible side-effects" mentioned in the patch changes note? > > Check patch is complaining > "CHECK: Macro argument reuse 'id' - possible side-effects?" > > By using local size_t variable, it fixed the check patch warning. > > > > > > + > > > +#define SIGNAL_A_ID (0) > > > +#define SIGNAL_B_ID (1) > > > +#define SIGNAL_C_ID (2) > > > +#define SIGNAL_D_ID (3) > > > + > > > +/** > > > + * struct rz_mtu3_cnt - MTU3 counter private data > > > + * > > > + * @clk: MTU3 module clock > > > + * @lock: Lock to prevent concurrent access for ceiling and count > > > + * @ch: HW channels for the counters > > > + * @mtu_16bit_max: Cache for 16-bit counters > > > + * @mtu_32bit_max: Cache for 32-bit counters */ struct rz_mtu3_cnt { > > > + struct clk *clk; > > > + struct mutex lock; > > > + struct rz_mtu3_channel *ch; > > > + u16 mtu_16bit_max[RZ_MTU3_MAX_HW_CNTR_CHANNELS]; > > > + u32 mtu_32bit_max; > > > > Does the ceiling set on the device get clobbered when you change > > between 16- bit and 32-bit phase modes (i.e. writing to TGRALW vs > > TGRA)? You have a separate cache for the 32-bit ceiling value here, > > but if it is getting clobbered then as a small optimization you may > > reimplement this cache as a union such as: > > > > union { > > u16 mtu_16bit_max[RZ_MTU3_MAX_HW_CNTR_CHANNELS]; > > u32 mtu_32bit_max; > > } > > Yes, it gets clobbered when we change between 16-bit and 32-bit mode. > > For eg: 0xbe1352 value > Split up into mtu1.TGRA=0xbe and mtu2.TGRA=0x1352. > > OK will use the union. > > > > > > +}; > > > + > > > > > + > > > + switch (val & RZ_MTU3_TMDR1_PH_CNT_MODE_MASK) { > > > + case RZ_MTU3_TMDR1_PH_CNT_MODE_1: > > > + *function = COUNTER_FUNCTION_QUADRATURE_X4; > > > + break; > > > + case RZ_MTU3_TMDR1_PH_CNT_MODE_2: > > > + *function = COUNTER_FUNCTION_PULSE_DIRECTION; > > > + break; > > > + case RZ_MTU3_TMDR1_PH_CNT_MODE_4: > > > + *function = COUNTER_FUNCTION_QUADRATURE_X2_B; > > > + break; > > > + default: > > > + return -EINVAL; > > > + } > > > > Sorry if I asked this before: what are counting modes 3 and 5, and are > > they not supported by this device? If they are not supported, please > > include a comment stating so in the default case block so that it is > > clear for future reviewers as well. > > Our hardware supports 5 phase counting modes. From that list, I match up some > of the functions supported by the counter driver. > > counting modes 3 and 5 are supported by the Devices, but currently counter > driver is not supported this. > > Please see the attached counting modes 3 and 5. > https://ibb.co/3YJByG1 > > OK, I will add a comment for the details for modes not supported by the > current driver in the default block. > > > > + > > > +static void rz_mtu3_32bit_cnt_setting(struct counter_device > > > +*counter, int id) { > > > + struct rz_mtu3_cnt *const priv = counter_priv(counter); > > > + struct rz_mtu3_channel *ch1 = priv->ch; > > > + struct rz_mtu3_channel *ch2 = ch1 + 1; > > > + > > > + /* > > > + * 32-bit phase counting need MTU1 and MTU2 to create 32-bit cascade > > > + * counter. > > > + */ > > > + ch1->function = RZ_MTU3_32BIT_PHASE_COUNTING; > > > + ch2->function = RZ_MTU3_32BIT_PHASE_COUNTING; > > > > Can these "function" members be modified from outside this driver? If > > so, you could have a race condition here. > > OK will add channel specific locks to avoid the races. > > Do you prefer mutex or spin lock here? As channel selection is based on > runtime decision For both PWM and counter?? > > > > > > + > > > + /* Phase counting mode 1 is used as default in initialization. */ > > > + rz_mtu3_8bit_ch_write(ch1, RZ_MTU3_TMDR1, > > > +RZ_MTU3_TMDR1_PH_CNT_MODE_1); > > > + > > > + rz_mtu3_8bit_ch_write(ch1, RZ_MTU3_TCR, RZ_MTU3_TCR_CCLR_TGRA); > > > + rz_mtu3_8bit_ch_write(ch1, RZ_MTU3_TIOR, RZ_MTU3_TIOR_IC_BOTH); > > > + > > > + rz_mtu3_enable(ch1); > > > + rz_mtu3_enable(ch2); > > > +} > > > + > > > +static void rz_mtu3_16bit_cnt_setting(struct counter_device > > > +*counter, int id) { > > > + struct rz_mtu3_cnt *const priv = counter_priv(counter); > > > + struct rz_mtu3_channel *ch = priv->ch + id; > > > + > > > + ch->function = RZ_MTU3_16BIT_PHASE_COUNTING; > > > + > > > + /* Phase counting mode 1 is used as default in initialization. */ > > > + rz_mtu3_8bit_ch_write(ch, RZ_MTU3_TMDR1, > > > +RZ_MTU3_TMDR1_PH_CNT_MODE_1); > > > + > > > + rz_mtu3_8bit_ch_write(ch, RZ_MTU3_TCR, RZ_MTU3_TCR_CCLR_TGRA); > > > + rz_mtu3_enable(ch); > > > +} > > > + > > > +static int rz_mtu3_initialize_counter(struct counter_device > > > +*counter, int id) { > > > + struct rz_mtu3_cnt *const priv = counter_priv(counter); > > > + struct rz_mtu3_channel *ch1 = priv->ch; > > > + struct rz_mtu3_channel *ch2 = ch1 + 1; > > > > No need to complicate this, just use priv->ch[0], priv->ch[1], and > > priv->ch[id]. Same advice applies to the other functions as well. > > I get below error when I use array susbscripts. "*ch1 = priv->ch[0];" > drivers/counter/rz-mtu3-cnt.c:291:32: error: incompatible types when > initialising type 'struct rz_mtu3_channel *' using type 'struct > rz_mtu3_channel' > 291 | struct rz_mtu3_channel *ch1 = priv->ch[0]; > I could use "*ch1 = &priv->ch[0];" please let me know is it ok? Cheers, Biju
On Mon, Nov 14, 2022 at 05:52:11PM +0000, Biju Das wrote: > > > > +static int rz_mtu3_initialize_counter(struct counter_device > > > > +*counter, int id) { > > > > + struct rz_mtu3_cnt *const priv = counter_priv(counter); > > > > + struct rz_mtu3_channel *ch1 = priv->ch; > > > > + struct rz_mtu3_channel *ch2 = ch1 + 1; > > > > > > No need to complicate this, just use priv->ch[0], priv->ch[1], and > > > priv->ch[id]. Same advice applies to the other functions as well. > > > > I get below error when I use array susbscripts. "*ch1 = priv->ch[0];" > > > drivers/counter/rz-mtu3-cnt.c:291:32: error: incompatible types when > > initialising type 'struct rz_mtu3_channel *' using type 'struct > > rz_mtu3_channel' > > 291 | struct rz_mtu3_channel *ch1 = priv->ch[0]; > > > > I could use "*ch1 = &priv->ch[0];" please let me know is it ok? > > Cheers, > Biju Hi Biju, I meant to use the array subscripts inline (e.g. priv->ch[id].function). However, I can see the benefit of using the ch1 and ch2 local variables, so perhaps something like this would be clearer to read: struct rz_mtu3_chanel *const ch = priv->ch; struct rz_mtu3_chanel *const ch1 = &ch[0]; struct rz_mtu3_chanel *const ch2 = &ch[1]; ... case RZ_MTU3_16_BIT_MTU1_CH: case RZ_MTU3_16_BIT_MTU2_CH: if (ch[id].function != RZ_MTU3_NORMAL) { ... William Breathitt Gray
Hi William Breathitt Gray, Thanks for the feedback. > -----Original Message----- > From: William Breathitt Gray <william.gray@linaro.org> > Sent: 15 November 2022 04:53 > To: Biju Das <biju.das.jz@bp.renesas.com> > Cc: linux-iio@vger.kernel.org; Geert Uytterhoeven > <geert+renesas@glider.be>; Chris Paterson > <Chris.Paterson2@renesas.com>; Prabhakar Mahadev Lad > <prabhakar.mahadev-lad.rj@bp.renesas.com>; linux-renesas- > soc@vger.kernel.org > Subject: Re: [PATCH v6 4/5] counter: Add Renesas RZ/G2L MTU3a counter > driver > > On Mon, Nov 14, 2022 at 05:52:11PM +0000, Biju Das wrote: > > > > > +static int rz_mtu3_initialize_counter(struct counter_device > > > > > +*counter, int id) { > > > > > + struct rz_mtu3_cnt *const priv = counter_priv(counter); > > > > > + struct rz_mtu3_channel *ch1 = priv->ch; > > > > > + struct rz_mtu3_channel *ch2 = ch1 + 1; > > > > > > > > No need to complicate this, just use priv->ch[0], priv->ch[1], > and > > > > priv->ch[id]. Same advice applies to the other functions as > well. > > > > > > I get below error when I use array susbscripts. "*ch1 = priv- > >ch[0];" > > > > > drivers/counter/rz-mtu3-cnt.c:291:32: error: incompatible types > when > > > initialising type 'struct rz_mtu3_channel *' using type 'struct > > > rz_mtu3_channel' > > > 291 | struct rz_mtu3_channel *ch1 = priv->ch[0]; > > > > > > > I could use "*ch1 = &priv->ch[0];" please let me know is it ok? > > > > Cheers, > > Biju > > Hi Biju, > > I meant to use the array subscripts inline (e.g. priv- > >ch[id].function). > However, I can see the benefit of using the ch1 and ch2 local > variables, so perhaps something like this would be clearer to read: > > struct rz_mtu3_chanel *const ch = priv->ch; > struct rz_mtu3_chanel *const ch1 = &ch[0]; > struct rz_mtu3_chanel *const ch2 = &ch[1]; > ... > case RZ_MTU3_16_BIT_MTU1_CH: > case RZ_MTU3_16_BIT_MTU2_CH: > if (ch[id].function != RZ_MTU3_NORMAL) { > ... OK, I have added below inline function which simplifies the code in each function. Is it ok? For eg: +static inline struct rz_mtu3_channel * +rz_mtu3_get_ch(struct counter_device *counter, int id) +{ + struct rz_mtu3_cnt *const priv = counter_priv(counter); + const size_t ch_id = RZ_MTU3_GET_HW_CH(id); + + return &priv->ch[ch_id]; +} @@ -154,11 +163,10 @@ static int rz_mtu3_count_function_read(struct counter_device *counter, struct counter_count *count, enum counter_function *function) { - struct rz_mtu3_cnt *const priv = counter_priv(counter); - const size_t ch_id = RZ_MTU3_GET_HW_CH(count->id); + struct rz_mtu3_channel *const ch = rz_mtu3_get_ch(counter, count->id); Cheers, Biju
On Tue, Nov 15, 2022 at 10:38:32AM +0000, Biju Das wrote: > Hi William Breathitt Gray, > > Thanks for the feedback. > > > -----Original Message----- > > From: William Breathitt Gray <william.gray@linaro.org> > > Sent: 15 November 2022 04:53 > > To: Biju Das <biju.das.jz@bp.renesas.com> > > Cc: linux-iio@vger.kernel.org; Geert Uytterhoeven > > <geert+renesas@glider.be>; Chris Paterson > > <Chris.Paterson2@renesas.com>; Prabhakar Mahadev Lad > > <prabhakar.mahadev-lad.rj@bp.renesas.com>; linux-renesas- > > soc@vger.kernel.org > > Subject: Re: [PATCH v6 4/5] counter: Add Renesas RZ/G2L MTU3a counter > > driver > > > > On Mon, Nov 14, 2022 at 05:52:11PM +0000, Biju Das wrote: > > > > > > +static int rz_mtu3_initialize_counter(struct counter_device > > > > > > +*counter, int id) { > > > > > > + struct rz_mtu3_cnt *const priv = counter_priv(counter); > > > > > > + struct rz_mtu3_channel *ch1 = priv->ch; > > > > > > + struct rz_mtu3_channel *ch2 = ch1 + 1; > > > > > > > > > > No need to complicate this, just use priv->ch[0], priv->ch[1], > > and > > > > > priv->ch[id]. Same advice applies to the other functions as > > well. > > > > > > > > I get below error when I use array susbscripts. "*ch1 = priv- > > >ch[0];" > > > > > > > drivers/counter/rz-mtu3-cnt.c:291:32: error: incompatible types > > when > > > > initialising type 'struct rz_mtu3_channel *' using type 'struct > > > > rz_mtu3_channel' > > > > 291 | struct rz_mtu3_channel *ch1 = priv->ch[0]; > > > > > > > > > > I could use "*ch1 = &priv->ch[0];" please let me know is it ok? > > > > > > Cheers, > > > Biju > > > > Hi Biju, > > > > I meant to use the array subscripts inline (e.g. priv- > > >ch[id].function). > > However, I can see the benefit of using the ch1 and ch2 local > > variables, so perhaps something like this would be clearer to read: > > > > struct rz_mtu3_chanel *const ch = priv->ch; > > struct rz_mtu3_chanel *const ch1 = &ch[0]; > > struct rz_mtu3_chanel *const ch2 = &ch[1]; > > ... > > case RZ_MTU3_16_BIT_MTU1_CH: > > case RZ_MTU3_16_BIT_MTU2_CH: > > if (ch[id].function != RZ_MTU3_NORMAL) { > > ... > > > OK, I have added below inline function which simplifies the code > in each function. Is it ok? > > For eg: > > +static inline struct rz_mtu3_channel * > +rz_mtu3_get_ch(struct counter_device *counter, int id) > +{ > + struct rz_mtu3_cnt *const priv = counter_priv(counter); > + const size_t ch_id = RZ_MTU3_GET_HW_CH(id); > + > + return &priv->ch[ch_id]; > +} > > > @@ -154,11 +163,10 @@ static int rz_mtu3_count_function_read(struct counter_device *counter, > struct counter_count *count, > enum counter_function *function) > { > - struct rz_mtu3_cnt *const priv = counter_priv(counter); > - const size_t ch_id = RZ_MTU3_GET_HW_CH(count->id); > + struct rz_mtu3_channel *const ch = rz_mtu3_get_ch(counter, count->id); > > > Cheers, > Biju Sure, I think that function will be okay to use. William Breathitt Gray
On Mon, Nov 14, 2022 at 03:24:26PM +0000, Biju Das wrote: > > > +#define RZ_MTU3_GET_HW_CH(id) \ > > > +({ \ > > > + size_t _id = (id); _id = (_id == RZ_MTU3_32_BIT_CH) ? 0 : _id; \ > > > +}) > > > > I probably missed a discussion about this change in a previous thread; what > > is the purpose of using a local size_t variable here? Is this due to the > > "possible side-effects" mentioned in the patch changes note? > > Check patch is complaining > "CHECK: Macro argument reuse 'id' - possible side-effects?" > > By using local size_t variable, it fixed the check patch warning. Ah, I see what you mean: 'id' could be an expression (e.g. x++) which would be evaluated twice if passed as the macro argument. I think there's a compiler hint that will supress this warning, but I can't quite remember it right now. For now, I'd prefer this to be implemented as an inline function so that the purpose of the code remains clear: static inline size_t rz_mtu3_get_hw_ch(const size_t id) { return (id == RZ_MTU3_32_BIT_CH) ? 0 : id; } > > > +/** > > > + * struct rz_mtu3_cnt - MTU3 counter private data > > > + * > > > + * @clk: MTU3 module clock > > > + * @lock: Lock to prevent concurrent access for ceiling and count > > > + * @ch: HW channels for the counters > > > + * @mtu_16bit_max: Cache for 16-bit counters > > > + * @mtu_32bit_max: Cache for 32-bit counters */ struct rz_mtu3_cnt { > > > + struct clk *clk; > > > + struct mutex lock; > > > + struct rz_mtu3_channel *ch; > > > + u16 mtu_16bit_max[RZ_MTU3_MAX_HW_CNTR_CHANNELS]; > > > + u32 mtu_32bit_max; > > > > Does the ceiling set on the device get clobbered when you change between 16- > > bit and 32-bit phase modes (i.e. writing to TGRALW vs TGRA)? You have a > > separate cache for the 32-bit ceiling value here, but if it is getting > > clobbered then as a small optimization you may reimplement this cache as a > > union such as: > > > > union { > > u16 mtu_16bit_max[RZ_MTU3_MAX_HW_CNTR_CHANNELS]; > > u32 mtu_32bit_max; > > } > > Yes, it gets clobbered when we change between 16-bit and 32-bit mode. > > For eg: 0xbe1352 value > Split up into mtu1.TGRA=0xbe and mtu2.TGRA=0x1352. > > OK will use the union. Be sure also to check rz_mtu3_is_counter_invalid() in rz_mtu3_count_ceiling_read() to make sure the proper ceiling is only returned when its valid. > > > + switch (val & RZ_MTU3_TMDR1_PH_CNT_MODE_MASK) { > > > + case RZ_MTU3_TMDR1_PH_CNT_MODE_1: > > > + *function = COUNTER_FUNCTION_QUADRATURE_X4; > > > + break; > > > + case RZ_MTU3_TMDR1_PH_CNT_MODE_2: > > > + *function = COUNTER_FUNCTION_PULSE_DIRECTION; > > > + break; > > > + case RZ_MTU3_TMDR1_PH_CNT_MODE_4: > > > + *function = COUNTER_FUNCTION_QUADRATURE_X2_B; > > > + break; > > > + default: > > > + return -EINVAL; > > > + } > > > > Sorry if I asked this before: what are counting modes 3 and 5, and are they > > not supported by this device? If they are not supported, please include a > > comment stating so in the default case block so that it is clear for future > > reviewers as well. > > Our hardware supports 5 phase counting modes. From that list, I match up some of the functions > supported by the counter driver. > > counting modes 3 and 5 are supported by the Devices, but currently counter driver is not supported this. > > Please see the attached counting modes 3 and 5. > https://ibb.co/3YJByG1 > > OK, I will add a comment for the details for modes not supported by the current driver in the default block. Those are interesting counting modes; it looks like counting mode 5 is pulse-direction with an inverted direction, but I'm not sure what to call counting mode 3. I haven't come across these counting modes before so I wonder what sort of applications they're typically used for. Typically we would add a new COUNTER_FUNCTION_* to represent each new counting mode. However, for the sake of keeping this patch series simple it will be okay to leave a comment in the default block for now describing the missing counting modes and indicating that support for them are TODO items for the future. > > > +static void rz_mtu3_32bit_cnt_setting(struct counter_device *counter, > > > +int id) { > > > + struct rz_mtu3_cnt *const priv = counter_priv(counter); > > > + struct rz_mtu3_channel *ch1 = priv->ch; > > > + struct rz_mtu3_channel *ch2 = ch1 + 1; > > > + > > > + /* > > > + * 32-bit phase counting need MTU1 and MTU2 to create 32-bit cascade > > > + * counter. > > > + */ > > > + ch1->function = RZ_MTU3_32BIT_PHASE_COUNTING; > > > + ch2->function = RZ_MTU3_32BIT_PHASE_COUNTING; > > > > Can these "function" members be modified from outside this driver? If so, you > > could have a race condition here. > > OK will add channel specific locks to avoid the races. > > Do you prefer mutex or spin lock here? As channel selection is based on runtime decision > For both PWM and counter?? Hmm, I'm not sure yet how best to handle this because if the PWM driver changes the function in the middle of the Counter driver's operation (or vice versa) we'll obviously have problems. Thierry, do you have any ideas here for how we can gracefully handle transfer of control between the PWM and Counter driver. I think a simple mutex in struct rz_mtu3 should be fine: one driver locks it and the other driver can return -EBUSY until its unlocked. > > > +static int rz_mtu3_count_enable_write(struct counter_device *counter, > > > + struct counter_count *count, u8 enable) { > > > + struct rz_mtu3_cnt *const priv = counter_priv(counter); > > > + const size_t ch_id = RZ_MTU3_GET_HW_CH(count->id); > > > + struct rz_mtu3_channel *ch = priv->ch + ch_id; > > > + int ret = 0; > > > + > > > + if (enable) { > > > + pm_runtime_get_sync(ch->dev); > > > + ret = rz_mtu3_initialize_counter(counter, count->id); > > > > The "enable" Count component serves to pause/resume counting operation; that > > means the existing count should not be lost when a Count is disabled. The > > rz_mtu3_initialize_counter() function will clear the current Count, so you'll > > need to restore it before returning. > > Yes, it is doing pause/resume operation only. It is using clock gating and PM operations. > During enable, Channel is enabled, clk is on. > > During disable, Channel is disabled, clk is off. > > Here we are not losing the count when it is disabled and then enable particular count. > > But we will loss the count, after disable, if it is used by other devices such as PWM > Or we are switching to 16-bit and 32-bit and vice versa. > > Maybe Will rename it to "rz_mtu3_{resume,pause}_counter" to make it clear. > > Compared to PWM framework we are missing export/unexport calls here in counter subsystem. > > For PWM, we have an export/unexport calls for creating runtime pwm devices such as pwm0, pwm1 for pwmdevice. > Here, count0, count1 and count2 are created during probe. > > My current test sequence is, > > 1) Set phase clk > 2) Set cascade_enable > 3) Set enable(Since we don't have export/unexport, I am using disable calls for freeing Channels for other subsystem) > 4) Set count > 5) Set ceiling > > > > > Alternatively, the "enable" Count component is optional so you can remove it > > if you don't want to implement it; just initialize the counter at probe time > > instead. > > Let me know your opinion based on the above? Okay, I think I understand, the count is only lost if another driver takes control of that channel. In that case, you can leave the code as it is; there is no need to rename the functions. Once another driver such as PWM has control over the device channel, it's unreasonable to expect the Counter driver to maintain the previous device state, so don't worry about trying to resolve that. William Breathitt Gray
diff --git a/drivers/counter/Kconfig b/drivers/counter/Kconfig index d388bf26f4dc..daa352c7392d 100644 --- a/drivers/counter/Kconfig +++ b/drivers/counter/Kconfig @@ -39,6 +39,17 @@ config INTERRUPT_CNT To compile this driver as a module, choose M here: the module will be called interrupt-cnt. +config RZ_MTU3_CNT + tristate "Renesas RZ/G2L MTU3a counter driver" + depends on RZ_MTU3 || COMPILE_TEST + help + Enable support for MTU3a counter driver found on Renesas RZ/G2L alike + SoCs. This IP supports both 16-bit and 32-bit phase counting mode + support. + + To compile this driver as a module, choose M here: the + module will be called rz-mtu3-cnt. + config STM32_TIMER_CNT tristate "STM32 Timer encoder counter driver" depends on MFD_STM32_TIMERS || COMPILE_TEST diff --git a/drivers/counter/Makefile b/drivers/counter/Makefile index b9a369e0d4fc..933fdd50b3e4 100644 --- a/drivers/counter/Makefile +++ b/drivers/counter/Makefile @@ -8,6 +8,7 @@ counter-y := counter-core.o counter-sysfs.o counter-chrdev.o obj-$(CONFIG_104_QUAD_8) += 104-quad-8.o obj-$(CONFIG_INTERRUPT_CNT) += interrupt-cnt.o +obj-$(CONFIG_RZ_MTU3_CNT) += rz-mtu3-cnt.o obj-$(CONFIG_STM32_TIMER_CNT) += stm32-timer-cnt.o obj-$(CONFIG_STM32_LPTIMER_CNT) += stm32-lptimer-cnt.o obj-$(CONFIG_TI_EQEP) += ti-eqep.o diff --git a/drivers/counter/rz-mtu3-cnt.c b/drivers/counter/rz-mtu3-cnt.c new file mode 100644 index 000000000000..cfddbbe38ed1 --- /dev/null +++ b/drivers/counter/rz-mtu3-cnt.c @@ -0,0 +1,717 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * Renesas RZ/G2L MTU3a Counter driver + * + * Copyright (C) 2022 Renesas Electronics Corporation + */ + +#include <linux/clk.h> +#include <linux/counter.h> +#include <linux/module.h> +#include <linux/platform_device.h> +#include <linux/pm_runtime.h> +#include <linux/types.h> + +#include <clocksource/rz-mtu3.h> + +#define RZ_MTU3_TSR_TCFD BIT(7) +#define RZ_MTU3_MAX_HW_CNTR_CHANNELS (2) + +#define RZ_MTU3_TMDR1_PH_CNT_MODE_1 (4) +#define RZ_MTU3_TMDR1_PH_CNT_MODE_2 (5) +#define RZ_MTU3_TMDR1_PH_CNT_MODE_3 (6) +#define RZ_MTU3_TMDR1_PH_CNT_MODE_4 (7) +#define RZ_MTU3_TMDR1_PH_CNT_MODE_5 (9) +#define RZ_MTU3_TMDR1_PH_CNT_MODE_MASK (0xf) + +#define RZ_MTU3_TMDR3_LWA BIT(0) +#define RZ_MTU3_TMDR3_PHCKSEL BIT(1) + +#define RZ_MTU3_16_BIT_MTU1_CH (0) +#define RZ_MTU3_16_BIT_MTU2_CH (1) +#define RZ_MTU3_32_BIT_CH (2) + +#define RZ_MTU3_TIOR_NO_OUTPUT (0) +#define RZ_MTU3_TIOR_IC_BOTH (10) + +#define RZ_MTU3_GET_HW_CH(id) \ +({ \ + size_t _id = (id); _id = (_id == RZ_MTU3_32_BIT_CH) ? 0 : _id; \ +}) + +#define SIGNAL_A_ID (0) +#define SIGNAL_B_ID (1) +#define SIGNAL_C_ID (2) +#define SIGNAL_D_ID (3) + +/** + * struct rz_mtu3_cnt - MTU3 counter private data + * + * @clk: MTU3 module clock + * @lock: Lock to prevent concurrent access for ceiling and count + * @ch: HW channels for the counters + * @mtu_16bit_max: Cache for 16-bit counters + * @mtu_32bit_max: Cache for 32-bit counters + */ +struct rz_mtu3_cnt { + struct clk *clk; + struct mutex lock; + struct rz_mtu3_channel *ch; + u16 mtu_16bit_max[RZ_MTU3_MAX_HW_CNTR_CHANNELS]; + u32 mtu_32bit_max; +}; + +static const enum counter_function rz_mtu3_count_functions[] = { + COUNTER_FUNCTION_QUADRATURE_X4, + COUNTER_FUNCTION_PULSE_DIRECTION, + COUNTER_FUNCTION_QUADRATURE_X2_B, +}; + +static bool rz_mtu3_is_counter_invalid(struct counter_device *counter, int id) +{ + struct rz_mtu3_cnt *const priv = counter_priv(counter); + u16 val; + + val = rz_mtu3_shared_reg_read(priv->ch, RZ_MTU3_TMDR3) & RZ_MTU3_TMDR3_LWA; + if (id == RZ_MTU3_32_BIT_CH && val) + return false; + + if (id != RZ_MTU3_32_BIT_CH && !val) + return false; + + return true; +} + +static int rz_mtu3_count_read(struct counter_device *counter, + struct counter_count *count, u64 *val) +{ + struct rz_mtu3_cnt *const priv = counter_priv(counter); + const size_t ch_id = RZ_MTU3_GET_HW_CH(count->id); + + if (rz_mtu3_is_counter_invalid(counter, count->id)) + return -EINVAL; + + if (count->id == RZ_MTU3_32_BIT_CH) + *val = rz_mtu3_32bit_ch_read(priv->ch + ch_id, RZ_MTU3_TCNTLW); + else + *val = rz_mtu3_16bit_ch_read(priv->ch + ch_id, RZ_MTU3_TCNT); + + return 0; +} + +static int rz_mtu3_count_write(struct counter_device *counter, + struct counter_count *count, const u64 val) +{ + struct rz_mtu3_cnt *const priv = counter_priv(counter); + const size_t ch_id = RZ_MTU3_GET_HW_CH(count->id); + u32 ceiling; + + if (rz_mtu3_is_counter_invalid(counter, count->id)) + return -EINVAL; + + mutex_lock(&priv->lock); + if (count->id == RZ_MTU3_32_BIT_CH) + ceiling = priv->mtu_32bit_max; + else + ceiling = priv->mtu_16bit_max[ch_id]; + + if (count->id == RZ_MTU3_32_BIT_CH) + rz_mtu3_32bit_ch_write(priv->ch + ch_id, RZ_MTU3_TCNTLW, val); + else + rz_mtu3_16bit_ch_write(priv->ch + ch_id, RZ_MTU3_TCNT, val); + + mutex_unlock(&priv->lock); + + return 0; +} + +static int rz_mtu3_count_function_read(struct counter_device *counter, + struct counter_count *count, + enum counter_function *function) +{ + struct rz_mtu3_cnt *const priv = counter_priv(counter); + const size_t ch_id = RZ_MTU3_GET_HW_CH(count->id); + u8 val; + + val = rz_mtu3_8bit_ch_read(priv->ch + ch_id, RZ_MTU3_TMDR1); + + switch (val & RZ_MTU3_TMDR1_PH_CNT_MODE_MASK) { + case RZ_MTU3_TMDR1_PH_CNT_MODE_1: + *function = COUNTER_FUNCTION_QUADRATURE_X4; + break; + case RZ_MTU3_TMDR1_PH_CNT_MODE_2: + *function = COUNTER_FUNCTION_PULSE_DIRECTION; + break; + case RZ_MTU3_TMDR1_PH_CNT_MODE_4: + *function = COUNTER_FUNCTION_QUADRATURE_X2_B; + break; + default: + return -EINVAL; + } + + return 0; +} + +static int rz_mtu3_count_function_write(struct counter_device *counter, + struct counter_count *count, + enum counter_function function) +{ + struct rz_mtu3_cnt *const priv = counter_priv(counter); + const size_t ch_id = RZ_MTU3_GET_HW_CH(count->id); + u8 mode; + + switch (function) { + case COUNTER_FUNCTION_QUADRATURE_X4: + mode = RZ_MTU3_TMDR1_PH_CNT_MODE_1; + break; + case COUNTER_FUNCTION_PULSE_DIRECTION: + mode = RZ_MTU3_TMDR1_PH_CNT_MODE_2; + break; + case COUNTER_FUNCTION_QUADRATURE_X2_B: + mode = RZ_MTU3_TMDR1_PH_CNT_MODE_4; + break; + default: + return -EINVAL; + } + + rz_mtu3_8bit_ch_write(priv->ch + ch_id, RZ_MTU3_TMDR1, mode); + + return 0; +} + +static int rz_mtu3_count_direction_read(struct counter_device *counter, + struct counter_count *count, + enum counter_count_direction *direction) +{ + struct rz_mtu3_cnt *const priv = counter_priv(counter); + const size_t ch_id = RZ_MTU3_GET_HW_CH(count->id); + u8 tsr; + + tsr = rz_mtu3_8bit_ch_read(priv->ch + ch_id, RZ_MTU3_TSR); + + if (tsr & RZ_MTU3_TSR_TCFD) + *direction = COUNTER_COUNT_DIRECTION_FORWARD; + else + *direction = COUNTER_COUNT_DIRECTION_BACKWARD; + + return 0; +} + +static int rz_mtu3_count_ceiling_read(struct counter_device *counter, + struct counter_count *count, + u64 *ceiling) +{ + struct rz_mtu3_cnt *const priv = counter_priv(counter); + const size_t ch_id = RZ_MTU3_GET_HW_CH(count->id); + + if (count->id == RZ_MTU3_32_BIT_CH) + *ceiling = priv->mtu_32bit_max; + else + *ceiling = priv->mtu_16bit_max[ch_id]; + + return 0; +} + +static int rz_mtu3_count_ceiling_write(struct counter_device *counter, + struct counter_count *count, + u64 ceiling) +{ + struct rz_mtu3_cnt *const priv = counter_priv(counter); + const size_t ch_id = RZ_MTU3_GET_HW_CH(count->id); + + if (rz_mtu3_is_counter_invalid(counter, count->id)) + return -EINVAL; + + switch (count->id) { + case RZ_MTU3_16_BIT_MTU1_CH: + case RZ_MTU3_16_BIT_MTU2_CH: + if (ceiling > U16_MAX) + return -ERANGE; + priv->mtu_16bit_max[ch_id] = ceiling; + break; + case RZ_MTU3_32_BIT_CH: + if (ceiling > U32_MAX) + return -ERANGE; + priv->mtu_32bit_max = ceiling; + break; + } + + mutex_lock(&priv->lock); + if (count->id == RZ_MTU3_32_BIT_CH) + rz_mtu3_32bit_ch_write(priv->ch + ch_id, RZ_MTU3_TGRALW, ceiling); + else + rz_mtu3_16bit_ch_write(priv->ch + ch_id, RZ_MTU3_TGRA, ceiling); + + rz_mtu3_8bit_ch_write(priv->ch + ch_id, RZ_MTU3_TCR, RZ_MTU3_TCR_CCLR_TGRA); + mutex_unlock(&priv->lock); + + return 0; +} + +static void rz_mtu3_32bit_cnt_setting(struct counter_device *counter, int id) +{ + struct rz_mtu3_cnt *const priv = counter_priv(counter); + struct rz_mtu3_channel *ch1 = priv->ch; + struct rz_mtu3_channel *ch2 = ch1 + 1; + + /* + * 32-bit phase counting need MTU1 and MTU2 to create 32-bit cascade + * counter. + */ + ch1->function = RZ_MTU3_32BIT_PHASE_COUNTING; + ch2->function = RZ_MTU3_32BIT_PHASE_COUNTING; + + /* Phase counting mode 1 is used as default in initialization. */ + rz_mtu3_8bit_ch_write(ch1, RZ_MTU3_TMDR1, RZ_MTU3_TMDR1_PH_CNT_MODE_1); + + rz_mtu3_8bit_ch_write(ch1, RZ_MTU3_TCR, RZ_MTU3_TCR_CCLR_TGRA); + rz_mtu3_8bit_ch_write(ch1, RZ_MTU3_TIOR, RZ_MTU3_TIOR_IC_BOTH); + + rz_mtu3_enable(ch1); + rz_mtu3_enable(ch2); +} + +static void rz_mtu3_16bit_cnt_setting(struct counter_device *counter, int id) +{ + struct rz_mtu3_cnt *const priv = counter_priv(counter); + struct rz_mtu3_channel *ch = priv->ch + id; + + ch->function = RZ_MTU3_16BIT_PHASE_COUNTING; + + /* Phase counting mode 1 is used as default in initialization. */ + rz_mtu3_8bit_ch_write(ch, RZ_MTU3_TMDR1, RZ_MTU3_TMDR1_PH_CNT_MODE_1); + + rz_mtu3_8bit_ch_write(ch, RZ_MTU3_TCR, RZ_MTU3_TCR_CCLR_TGRA); + rz_mtu3_enable(ch); +} + +static int rz_mtu3_initialize_counter(struct counter_device *counter, int id) +{ + struct rz_mtu3_cnt *const priv = counter_priv(counter); + struct rz_mtu3_channel *ch1 = priv->ch; + struct rz_mtu3_channel *ch2 = ch1 + 1; + + mutex_lock(&priv->lock); + rz_mtu3_8bit_ch_write(ch1, RZ_MTU3_TIOR, RZ_MTU3_TIOR_NO_OUTPUT); + switch (id) { + case RZ_MTU3_16_BIT_MTU1_CH: + case RZ_MTU3_16_BIT_MTU2_CH: + if ((priv->ch + id)->function != RZ_MTU3_NORMAL) { + mutex_unlock(&priv->lock); + return -EBUSY; + } + + rz_mtu3_16bit_cnt_setting(counter, id); + break; + case RZ_MTU3_32_BIT_CH: + if (ch1->function != RZ_MTU3_NORMAL || + ch2->function != RZ_MTU3_NORMAL) { + mutex_unlock(&priv->lock); + return -EBUSY; + } + rz_mtu3_32bit_cnt_setting(counter, id); + break; + } + mutex_unlock(&priv->lock); + + return 0; +} + +static void rz_mtu3_terminate_counter(struct counter_device *counter, int id) +{ + struct rz_mtu3_cnt *const priv = counter_priv(counter); + struct rz_mtu3_channel *ch1 = priv->ch; + struct rz_mtu3_channel *ch2 = ch1 + 1; + + mutex_lock(&priv->lock); + if (id == RZ_MTU3_32_BIT_CH) { + ch1->function = RZ_MTU3_NORMAL; + ch2->function = RZ_MTU3_NORMAL; + rz_mtu3_disable(ch2); + rz_mtu3_disable(ch1); + } else { + (priv->ch + id)->function = RZ_MTU3_NORMAL; + rz_mtu3_disable(priv->ch + id); + } + mutex_unlock(&priv->lock); +} + +static int rz_mtu3_count_enable_read(struct counter_device *counter, + struct counter_count *count, u8 *enable) +{ + struct rz_mtu3_cnt *const priv = counter_priv(counter); + struct rz_mtu3_channel *ch1 = priv->ch; + struct rz_mtu3_channel *ch2 = ch1 + 1; + + if (count->id == RZ_MTU3_32_BIT_CH) { + mutex_lock(&priv->lock); + *enable = rz_mtu3_is_enabled(ch1) && + rz_mtu3_is_enabled(ch2); + mutex_unlock(&priv->lock); + } else { + *enable = rz_mtu3_is_enabled(priv->ch + count->id); + } + + return 0; +} + +static int rz_mtu3_count_enable_write(struct counter_device *counter, + struct counter_count *count, u8 enable) +{ + struct rz_mtu3_cnt *const priv = counter_priv(counter); + const size_t ch_id = RZ_MTU3_GET_HW_CH(count->id); + struct rz_mtu3_channel *ch = priv->ch + ch_id; + int ret = 0; + + if (enable) { + pm_runtime_get_sync(ch->dev); + ret = rz_mtu3_initialize_counter(counter, count->id); + } else { + rz_mtu3_terminate_counter(counter, count->id); + pm_runtime_put(ch->dev); + } + + return ret; +} + +static int rz_mtu3_long_word_access_ctrl_mode_get(struct counter_device *counter, + u32 *lwa_ctrl_mode) +{ + struct rz_mtu3_cnt *const priv = counter_priv(counter); + u16 val; + + pm_runtime_get_sync(priv->ch->dev); + val = rz_mtu3_shared_reg_read(priv->ch, RZ_MTU3_TMDR3); + *lwa_ctrl_mode = val & RZ_MTU3_TMDR3_LWA; + pm_runtime_put(priv->ch->dev); + + return 0; +} + +static int rz_mtu3_long_word_access_ctrl_mode_set(struct counter_device *counter, + u32 lwa_ctrl_mode) +{ + struct rz_mtu3_cnt *const priv = counter_priv(counter); + u16 val; + + pm_runtime_get_sync(priv->ch->dev); + val = rz_mtu3_shared_reg_read(priv->ch, RZ_MTU3_TMDR3); + if (lwa_ctrl_mode) + val |= RZ_MTU3_TMDR3_LWA; + else + val &= ~RZ_MTU3_TMDR3_LWA; + + rz_mtu3_shared_reg_write(priv->ch, RZ_MTU3_TMDR3, val); + pm_runtime_put(priv->ch->dev); + + return 0; +} + +static int rz_mtu3_ext_input_phase_clock_select_get(struct counter_device *counter, + u32 *ext_input_phase_clock_select) +{ + struct rz_mtu3_cnt *const priv = counter_priv(counter); + u16 val; + + pm_runtime_get_sync(priv->ch->dev); + val = rz_mtu3_shared_reg_read(priv->ch, RZ_MTU3_TMDR3); + *ext_input_phase_clock_select = (val & RZ_MTU3_TMDR3_PHCKSEL) >> 1; + pm_runtime_put(priv->ch->dev); + + return 0; +} + +static int rz_mtu3_ext_input_phase_clock_select_set(struct counter_device *counter, + u32 ext_input_phase_clock_select) +{ + struct rz_mtu3_cnt *const priv = counter_priv(counter); + u16 val; + + pm_runtime_get_sync(priv->ch->dev); + val = rz_mtu3_shared_reg_read(priv->ch, RZ_MTU3_TMDR3); + if (ext_input_phase_clock_select) + val |= RZ_MTU3_TMDR3_PHCKSEL; + else + val &= ~RZ_MTU3_TMDR3_PHCKSEL; + + rz_mtu3_shared_reg_write(priv->ch, RZ_MTU3_TMDR3, val); + pm_runtime_put(priv->ch->dev); + + return 0; +} + +static struct counter_comp rz_mtu3_count_ext[] = { + COUNTER_COMP_DIRECTION(rz_mtu3_count_direction_read), + COUNTER_COMP_ENABLE(rz_mtu3_count_enable_read, + rz_mtu3_count_enable_write), + COUNTER_COMP_CEILING(rz_mtu3_count_ceiling_read, + rz_mtu3_count_ceiling_write), +}; + +static const enum counter_synapse_action rz_mtu3_synapse_actions[] = { + COUNTER_SYNAPSE_ACTION_BOTH_EDGES, + COUNTER_SYNAPSE_ACTION_RISING_EDGE, + COUNTER_SYNAPSE_ACTION_NONE, +}; + +static int rz_mtu3_action_read(struct counter_device *counter, + struct counter_count *count, + struct counter_synapse *synapse, + enum counter_synapse_action *action) +{ + enum counter_function function; + int err; + + err = rz_mtu3_count_function_read(counter, count, &function); + if (err) + return err; + + /* Default action mode */ + *action = COUNTER_SYNAPSE_ACTION_NONE; + + switch (function) { + case COUNTER_FUNCTION_PULSE_DIRECTION: + /* + * Rising edges on signal A updates the respective count. + * The input level of signal B determines direction. + */ + if (synapse->signal->id == SIGNAL_A_ID || + synapse->signal->id == SIGNAL_C_ID) + *action = COUNTER_SYNAPSE_ACTION_RISING_EDGE; + break; + case COUNTER_FUNCTION_QUADRATURE_X2_B: + /* + * Any state transition on quadrature pair signal B updates + * the respective count. + */ + if (synapse->signal->id == SIGNAL_B_ID || + synapse->signal->id == SIGNAL_D_ID) + *action = COUNTER_SYNAPSE_ACTION_BOTH_EDGES; + break; + case COUNTER_FUNCTION_QUADRATURE_X4: + /* counts up/down on both edges of A and B signal*/ + *action = COUNTER_SYNAPSE_ACTION_BOTH_EDGES; + break; + default: + return -EINVAL; + } + + return 0; +} + +static const struct counter_ops rz_mtu3_cnt_ops = { + .count_read = rz_mtu3_count_read, + .count_write = rz_mtu3_count_write, + .function_read = rz_mtu3_count_function_read, + .function_write = rz_mtu3_count_function_write, + .action_read = rz_mtu3_action_read, +}; + +#define RZ_MTU3_PHASE_SIGNAL(_id, _name) { \ + .id = (_id), \ + .name = (_name), \ +} + +static struct counter_signal rz_mtu3_signals[] = { + RZ_MTU3_PHASE_SIGNAL(SIGNAL_A_ID, "MTU1 MTCLKA"), + RZ_MTU3_PHASE_SIGNAL(SIGNAL_B_ID, "MTU1 MTCLKB"), + RZ_MTU3_PHASE_SIGNAL(SIGNAL_C_ID, "MTU2 MTCLKC"), + RZ_MTU3_PHASE_SIGNAL(SIGNAL_D_ID, "MTU2 MTCLKD"), +}; + +static struct counter_synapse rz_mtu3_mtu1_count_synapses[] = { + { + .actions_list = rz_mtu3_synapse_actions, + .num_actions = ARRAY_SIZE(rz_mtu3_synapse_actions), + .signal = rz_mtu3_signals, + }, + { + .actions_list = rz_mtu3_synapse_actions, + .num_actions = ARRAY_SIZE(rz_mtu3_synapse_actions), + .signal = rz_mtu3_signals + 1, + } +}; + +static struct counter_synapse rz_mtu3_mtu2_count_synapses[] = { + { + .actions_list = rz_mtu3_synapse_actions, + .num_actions = ARRAY_SIZE(rz_mtu3_synapse_actions), + .signal = rz_mtu3_signals, + }, + { + .actions_list = rz_mtu3_synapse_actions, + .num_actions = ARRAY_SIZE(rz_mtu3_synapse_actions), + .signal = rz_mtu3_signals + 1, + }, + { + .actions_list = rz_mtu3_synapse_actions, + .num_actions = ARRAY_SIZE(rz_mtu3_synapse_actions), + .signal = rz_mtu3_signals + 2, + }, + { + .actions_list = rz_mtu3_synapse_actions, + .num_actions = ARRAY_SIZE(rz_mtu3_synapse_actions), + .signal = rz_mtu3_signals + 3, + } +}; + +static struct counter_count rz_mtu3_counts[] = { + { + .id = RZ_MTU3_16_BIT_MTU1_CH, + .name = "Channel 1 Count", + .functions_list = rz_mtu3_count_functions, + .num_functions = ARRAY_SIZE(rz_mtu3_count_functions), + .synapses = rz_mtu3_mtu1_count_synapses, + .num_synapses = ARRAY_SIZE(rz_mtu3_mtu1_count_synapses), + .ext = rz_mtu3_count_ext, + .num_ext = ARRAY_SIZE(rz_mtu3_count_ext), + }, + { + .id = RZ_MTU3_16_BIT_MTU2_CH, + .name = "Channel 2 Count", + .functions_list = rz_mtu3_count_functions, + .num_functions = ARRAY_SIZE(rz_mtu3_count_functions), + .synapses = rz_mtu3_mtu2_count_synapses, + .num_synapses = ARRAY_SIZE(rz_mtu3_mtu2_count_synapses), + .ext = rz_mtu3_count_ext, + .num_ext = ARRAY_SIZE(rz_mtu3_count_ext), + }, + { + .id = RZ_MTU3_32_BIT_CH, + .name = "Channel 1 and 2 (combined) Count", + .functions_list = rz_mtu3_count_functions, + .num_functions = ARRAY_SIZE(rz_mtu3_count_functions), + .synapses = rz_mtu3_mtu2_count_synapses, + .num_synapses = ARRAY_SIZE(rz_mtu3_mtu2_count_synapses), + .ext = rz_mtu3_count_ext, + .num_ext = ARRAY_SIZE(rz_mtu3_count_ext), + } +}; + +static const char *const rz_mtu3_long_word_access_ctrl_modes[] = { + "16-bit", + "32-bit", +}; + +static DEFINE_COUNTER_ENUM(rz_mtu3_long_word_access_ctrl_mode_enum, + rz_mtu3_long_word_access_ctrl_modes); + +static const char *const rz_mtu3_ext_input_phase_clock_select[] = { + "MTCLKA-MTCLKB", + "MTCLKC-MTCLKD", +}; + +static DEFINE_COUNTER_ENUM(rz_mtu3_ext_input_phase_clock_select_enum, + rz_mtu3_ext_input_phase_clock_select); + +static struct counter_comp rz_mtu3_device_ext[] = { + COUNTER_COMP_DEVICE_ENUM("long_word_access_ctrl_mode", + rz_mtu3_long_word_access_ctrl_mode_get, + rz_mtu3_long_word_access_ctrl_mode_set, + rz_mtu3_long_word_access_ctrl_mode_enum), + COUNTER_COMP_DEVICE_ENUM("external_input_phase_clock_select", + rz_mtu3_ext_input_phase_clock_select_get, + rz_mtu3_ext_input_phase_clock_select_set, + rz_mtu3_ext_input_phase_clock_select_enum), +}; + +static int rz_mtu3_cnt_pm_runtime_suspend(struct device *dev) +{ + struct clk *const clk = dev_get_drvdata(dev); + + clk_disable_unprepare(clk); + + return 0; +} + +static int rz_mtu3_cnt_pm_runtime_resume(struct device *dev) +{ + struct clk *const clk = dev_get_drvdata(dev); + + clk_prepare_enable(clk); + + return 0; +} + +static DEFINE_RUNTIME_DEV_PM_OPS(rz_mtu3_cnt_pm_ops, + rz_mtu3_cnt_pm_runtime_suspend, + rz_mtu3_cnt_pm_runtime_resume, NULL); + +static void rz_mtu3_cnt_pm_disable(void *data) +{ + struct device *dev = data; + + pm_runtime_disable(dev); + pm_runtime_set_suspended(dev); +} + +static int rz_mtu3_cnt_probe(struct platform_device *pdev) +{ + struct rz_mtu3 *ddata = dev_get_drvdata(pdev->dev.parent); + struct device *dev = &pdev->dev; + struct counter_device *counter; + struct rz_mtu3_cnt *priv; + unsigned int i; + int ret; + + counter = devm_counter_alloc(dev, sizeof(*priv)); + if (!counter) + return -ENOMEM; + + priv = counter_priv(counter); + priv->clk = ddata->clk; + priv->mtu_32bit_max = U32_MAX; + priv->ch = &ddata->channels[RZ_MTU1]; + for (i = 0; i < RZ_MTU3_MAX_HW_CNTR_CHANNELS; i++) { + (priv->ch + i)->dev = dev; + priv->mtu_16bit_max[i] = U16_MAX; + } + + mutex_init(&priv->lock); + platform_set_drvdata(pdev, priv->clk); + clk_prepare_enable(priv->clk); + pm_runtime_set_active(&pdev->dev); + pm_runtime_enable(&pdev->dev); + ret = devm_add_action_or_reset(&pdev->dev, rz_mtu3_cnt_pm_disable, dev); + if (ret < 0) + goto disable_clock; + + counter->name = dev_name(dev); + counter->parent = dev; + counter->ops = &rz_mtu3_cnt_ops; + counter->counts = rz_mtu3_counts; + counter->num_counts = ARRAY_SIZE(rz_mtu3_counts); + counter->signals = rz_mtu3_signals; + counter->num_signals = ARRAY_SIZE(rz_mtu3_signals); + counter->ext = rz_mtu3_device_ext; + counter->num_ext = ARRAY_SIZE(rz_mtu3_device_ext); + + /* Register Counter device */ + ret = devm_counter_add(dev, counter); + if (ret < 0) { + dev_err_probe(dev, ret, "Failed to add counter\n"); + goto disable_clock; + } + + return 0; + +disable_clock: + clk_disable_unprepare(priv->clk); + + return ret; +} + +static struct platform_driver rz_mtu3_cnt_driver = { + .probe = rz_mtu3_cnt_probe, + .driver = { + .name = "rz-mtu3-counter", + .pm = pm_ptr(&rz_mtu3_cnt_pm_ops), + }, +}; +module_platform_driver(rz_mtu3_cnt_driver); + +MODULE_AUTHOR("Biju Das <biju.das.jz@bp.renesas.com>"); +MODULE_ALIAS("platform:rz-mtu3-counter"); +MODULE_DESCRIPTION("Renesas RZ/G2L MTU3a counter driver"); +MODULE_LICENSE("GPL"); +MODULE_IMPORT_NS(COUNTER);
Add RZ/G2L MTU3a counter driver. This IP supports the following phase counting modes on MTU1 and MTU2 channels 1) 16-bit phase counting modes on MTU1 and MTU2 channels. 2) 32-bit phase counting mode by cascading MTU1 and MTU2. This patch adds 3 counters by creating 3 logical channels counter0: 16-bit phase counter on MTU1 channel counter1: 16-bit phase counter on MTU2 channel counter2: 32-bit phase counter by cascading MTU1 and MTU2 channels. Signed-off-by: Biju Das <biju.das.jz@bp.renesas.com> --- v5->v6: * Updated KConfig and commit description * Sorted header * Fixed RZ_MTU3_GET_HW_CH Macro for argument reuse 'id' - possible side-effects? * Replaced SET_RUNTIME_PM_OPS->DEFINE_RUNTIME_DEV_PM_OPS and removed __maybe_unused from suspend/resume() v4->v5: * Updated the Kconfig with SoC vendor name * Introduced rz_mtu3_is_counter_invalid() * replaced pointer to an array of struct rz_mtu3_channel with a simple pointer to struct rz_mtu3_channel. * Added long_word_access_ctrl_mode sysfs entry for 16-bit and 32-bit access * Added external_input_phase_clock_select sysfs entry for selecting input clocks. * used preprocessor defines represent SIGNAL_{A,B,C,D}_ID instead of signal ids. v3->v4: * There is no resource associated with "rz-mtu3-counter" compatible and moved the code to mfd subsystem as it binds against "rz-mtu". * Removed struct platform_driver rz_mtu3_cnt_driver. * Updated commit description * Updated Kconfig description * Added macros RZ_MTU3_16_BIT_MTU{1,2}_CH for MTU1 and MTU2 channels * Added RZ_MTU3_GET_HW_CH macro for getting channel ID. * replaced priv->ch[id]->priv->ch[0] in rz_mtu3_count_read() * Cached counter max values * replaced cnt->tsr in rz_mtu3_count_direction_read() * Added comments for RZ_MTU3_TCR_CCLR_NONE * Replaced if with switch in rz_mtu3_initialize_counter() and rz_mtu3_count_ceiling_write() * Added locks in initialize, terminate and enable_read to prevent races. * Updated rz_mtu3_action_read to take care of MTU2 signals. * Added separate distinct array for each group of Synapse. * Moved pm handling to parent. v1->v3: * Modelled as a counter device supporting 3 counters(2 16-bit and 32-bit) * Add kernel-doc comments to document struct rz_mtu3_cnt * Removed mmio variable from struct rz_mtu3_cnt * Removed cnt local variable from rz_mtu3_count_read() * Replaced -EINVAL->-ERANGE for out of range error conditions. * Removed explicit cast from write functions. * Removed local variable val from rz_mtu3_count_ceiling_read() * Added lock for RMW for counter/ceiling updates. * Added different synapses for counter0 and counter{1,2} * Used ARRAY for assigning num_counts. * Added PM runtime for managing clocks. * Add MODULE_IMPORT_NS(COUNTER) to import the COUNTER namespace. --- drivers/counter/Kconfig | 11 + drivers/counter/Makefile | 1 + drivers/counter/rz-mtu3-cnt.c | 717 ++++++++++++++++++++++++++++++++++ 3 files changed, 729 insertions(+) create mode 100644 drivers/counter/rz-mtu3-cnt.c