mbox series

[v5,0/2] Add support for Qualcomm MFD PMIC register layout

Message ID cover.1616613838.git.gurus@codeaurora.org (mailing list archive)
Headers show
Series Add support for Qualcomm MFD PMIC register layout | expand

Message

Guru Das Srinagesh March 24, 2021, 7:28 p.m. UTC 
Changes from v4:
- Only one cosmetic change: Moved the declaration of num_virt_regs under
  num_type_reg instead of under num_main_regs in `struct regmap_irq_chip` so as
  to reinforce the idea that it is related to the type setting of IRQs.
- No other changes.

Changes from v3:
- Implemented the scheme proposed in my response to Mark in [4].
- Dropped the RFC tag from this patch series as this series has been tested on
  target with a client driver utilizing these changes.

Changes from v2:
- Split up framework changes patch for better comprehension.
- Dropped PM8008 driver example and converted it into example code in cover
  letter and commit text.
- Added more info in cover letter and commit message as per v2 feedback.

This is a follow-up as promised [1] to the earlier attempts [2] [3] to upstream
the driver that has been hitherto used to handle IRQs for Qualcomm's PMICs that
have multiple on-board peripherals when they are interfaced over the I2C
interface.

This series is a rewrite of that driver while making use of the regmap-irq
framework, which needs some modifications to handle the register layout of
Qualcomm's PMICs. This is an RFC because I would like to get feedback on my
general approach before submitting as a patch per se.

Qualcomm's MFD chips that are interfaced over I2C have a top level interrupt
status register and sub-irqs (peripherals).  When a bit in the main status
register goes high, it means that the peripheral corresponding to that bit has
an unserviced interrupt. If the bit is not set, this means that the
corresponding peripheral does not.

The differences between Qualcomm's register layout and what the regmap-irq
framework assumes are best described with an example:

Suppose that there are three peripherals onboard an MFD chip: MISC, TEMP_ALARM
and GPIO01. Each of these peripherals has the following IRQ configuration
registers: mask, type and ack. There is a top level interrupt status register
and per-peripheral status registers as well (not shown below).

The regmap-irq framework expects all similar registers to be at a fixed stride
from each other, for each peripheral, as below (with stride = 1). 

	/* All mask registers together */
	MISC_INT_MASK		0x1011
	TEMP_ALARM_INT_MASK	0x1012
	GPIO01_INT_MASK		0x1013
	
	/* All type registers together */
	MISC_INT_TYPE		0x2011
	TEMP_ALARM_INT_TYPE	0x2012
	GPIO01_INT_TYPE		0x2013
	
	/* All ack registers together */
	MISC_INT_ACK		0x3011
	TEMP_ALARM_INT_ACK	0x3012
	GPIO01_INT_ACK		0x3013

In contrast, QCOM's registers are laid out as follows:

	/* All of MISC peripheral's registers together */
	MISC_INT_MASK		0x1011
	MISC_INT_TYPE		0x1012
	MISC_INT_ACK		0x1013

	/* All of TEMP_ALARM peripheral's registers together */
	TEMP_ALARM_INT_MASK	0x2011
	TEMP_ALARM_INT_TYPE	0x2012
	TEMP_ALARM_INT_ACK	0x2013
	
	/* All of GPIO01 peripheral's registers together */
	GPIO01_INT_MASK		0x3011
	GPIO01_INT_TYPE		0x3012
	GPIO01_INT_ACK		0x3013

As is evident, the different IRQ configuration registers are just (0x11, 0x12,
0x13) with offsets of (0x1000, 0x2000 and 0x3000) respectively in QCOM's case.
If the *_base registers fed to the struct regmap_irq_chip could be set to the
first peripheral (MISC in this example), then through the sub_reg_offsets
mechanism, we could add the offsets _to_ the *_base register values to get at
the configuration registers for each peripheral.

Hopefully this will help when reviewing the changes in this series.

[1] https://lore.kernel.org/lkml/20200519185757.GA13992@codeaurora.org/
[2] https://lore.kernel.org/lkml/cover.1588037638.git.gurus@codeaurora.org/
[3] https://lore.kernel.org/lkml/cover.1588115326.git.gurus@codeaurora.org/
[4] https://lore.kernel.org/lkml/20210315203336.GA8977@codeaurora.org/

Guru Das Srinagesh (2):
  regmap-irq: Introduce virtual regs to handle more config regs
  regmap-irq: Add driver callback to configure virtual regs

 drivers/base/regmap/regmap-irq.c | 43 +++++++++++++++++++++++++++++++++++++++-
 include/linux/regmap.h           |  9 +++++++++
 2 files changed, 51 insertions(+), 1 deletion(-)

Comments

Mark Brown April 1, 2021, 10:16 a.m. UTC | #1 
On Wed, 24 Mar 2021 12:28:52 -0700, Guru Das Srinagesh wrote:
> Changes from v4:
> - Only one cosmetic change: Moved the declaration of num_virt_regs under
>   num_type_reg instead of under num_main_regs in `struct regmap_irq_chip` so as
>   to reinforce the idea that it is related to the type setting of IRQs.
> - No other changes.
> 
> Changes from v3:
> - Implemented the scheme proposed in my response to Mark in [4].
> - Dropped the RFC tag from this patch series as this series has been tested on
>   target with a client driver utilizing these changes.
> 
> [...]

Applied to

   https://git.kernel.org/pub/scm/linux/kernel/git/broonie/regmap.git for-next

Thanks!

[1/2] regmap-irq: Introduce virtual regs to handle more config regs
      commit: 4c5014456305482412b35a081ca0fb4fefd69764
[2/2] regmap-irq: Add driver callback to configure virtual regs
      commit: 394409aafd017adfcffd075595cb01cc456a9327

All being well this means that it will be integrated into the linux-next
tree (usually sometime in the next 24 hours) and sent to Linus during
the next merge window (or sooner if it is a bug fix), however if
problems are discovered then the patch may be dropped or reverted.

You may get further e-mails resulting from automated or manual testing
and review of the tree, please engage with people reporting problems and
send followup patches addressing any issues that are reported if needed.

If any updates are required or you are submitting further changes they
should be sent as incremental updates against current git, existing
patches will not be replaced.

Please add any relevant lists and maintainers to the CCs when replying
to this mail.

Thanks,
Mark
Guru Das Srinagesh April 6, 2021, 1:11 a.m. UTC | #2 
On Thu, Apr 01, 2021 at 11:16:17AM +0100, Mark Brown wrote:
> On Wed, 24 Mar 2021 12:28:52 -0700, Guru Das Srinagesh wrote:
> > Changes from v4:
> > - Only one cosmetic change: Moved the declaration of num_virt_regs under
> >   num_type_reg instead of under num_main_regs in `struct regmap_irq_chip` so as
> >   to reinforce the idea that it is related to the type setting of IRQs.
> > - No other changes.
> > 
> > Changes from v3:
> > - Implemented the scheme proposed in my response to Mark in [4].
> > - Dropped the RFC tag from this patch series as this series has been tested on
> >   target with a client driver utilizing these changes.
> > 
> > [...]
> 
> Applied to
> 
>    https://git.kernel.org/pub/scm/linux/kernel/git/broonie/regmap.git for-next
> 
> Thanks!
> 
> [1/2] regmap-irq: Introduce virtual regs to handle more config regs
>       commit: 4c5014456305482412b35a081ca0fb4fefd69764
> [2/2] regmap-irq: Add driver callback to configure virtual regs
>       commit: 394409aafd017adfcffd075595cb01cc456a9327
> 

Thanks for accepting the patches. I'll send out the driver utilizing
these changes after code cleanup in the next couple of weeks.

Thank you.

Guru Das.
Guru Das Srinagesh April 9, 2021, 12:48 a.m. UTC | #3 
On Mon, Apr 05, 2021 at 06:11:52PM -0700, Guru Das Srinagesh wrote:
> On Thu, Apr 01, 2021 at 11:16:17AM +0100, Mark Brown wrote:
> > On Wed, 24 Mar 2021 12:28:52 -0700, Guru Das Srinagesh wrote:
> > > Changes from v4:
> > > - Only one cosmetic change: Moved the declaration of num_virt_regs under
> > >   num_type_reg instead of under num_main_regs in `struct regmap_irq_chip` so as
> > >   to reinforce the idea that it is related to the type setting of IRQs.
> > > - No other changes.
> > > 
> > > Changes from v3:
> > > - Implemented the scheme proposed in my response to Mark in [4].
> > > - Dropped the RFC tag from this patch series as this series has been tested on
> > >   target with a client driver utilizing these changes.
> > > 
> > > [...]
> > 
> > Applied to
> > 
> >    https://git.kernel.org/pub/scm/linux/kernel/git/broonie/regmap.git for-next
> > 
> > Thanks!
> > 
> > [1/2] regmap-irq: Introduce virtual regs to handle more config regs
> >       commit: 4c5014456305482412b35a081ca0fb4fefd69764
> > [2/2] regmap-irq: Add driver callback to configure virtual regs
> >       commit: 394409aafd017adfcffd075595cb01cc456a9327
> > 
> 
> Thanks for accepting the patches. I'll send out the driver utilizing
> these changes after code cleanup in the next couple of weeks.

Here it is:

https://lore.kernel.org/lkml/cover.1617927259.git.gurus@codeaurora.org/

Guru Das.
patchwork-bot+linux-arm-msm@kernel.org May 26, 2021, 7:03 p.m. UTC | #4 
Hello:

This series was applied to qcom/linux.git (refs/heads/for-next):

On Wed, 24 Mar 2021 12:28:52 -0700 you wrote:
> Changes from v4:
> - Only one cosmetic change: Moved the declaration of num_virt_regs under
>   num_type_reg instead of under num_main_regs in `struct regmap_irq_chip` so as
>   to reinforce the idea that it is related to the type setting of IRQs.
> - No other changes.
> 
> Changes from v3:
> - Implemented the scheme proposed in my response to Mark in [4].
> - Dropped the RFC tag from this patch series as this series has been tested on
>   target with a client driver utilizing these changes.
> 
> [...]

Here is the summary with links:
  - [v5,1/2] regmap-irq: Introduce virtual regs to handle more config regs
    https://git.kernel.org/qcom/c/4c5014456305
  - [v5,2/2] regmap-irq: Add driver callback to configure virtual regs
    https://git.kernel.org/qcom/c/394409aafd01

You are awesome, thank you!
--
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html