[PATCH v6 00/11] Add Renesas PMIC RAA215300 and built-in RTC support

Biju Das
2023-06-02T14:25:31Z

This patch series aims to add support for Renesas PMIC RAA215300 and
built-in RTC found on this PMIC device.

The details of PMIC can be found here[1].

Renesas PMIC RAA215300 exposes two separate i2c devices, one for the main
device and another for rtc device.

Enhance i2c_new_ancillary_device() to instantiate an I2C client device
apart from the already supported I2C dummy client device.
(eg: Instantiate rtc device from PMIC driver)

The built-in RTC found on PMIC RAA215300 is the same as ISL1208.
However, the external oscillator bit is inverted on PMIC version
0x11. The PMIC driver detects PMIC version and instantiate appropriate
RTC device.

[1]
https://www.renesas.com/in/en/products/power-power-management/multi-channel-power-management-ics-pmics/ssdsoc-power-management-ics-pmic-and-pmus/raa215300-high-performance-9-channel-pmic-supporting-ddr-memory-built-charger-and-rtc

Ref:
https://patchwork.kernel.org/project/linux-renesas-soc/patch/20230505091720.115675-1-biju.das.jz@bp.renesas.com/
https://patchwork.kernel.org/project/linux-renesas-soc/patch/20230505172530.357455-5-biju.das.jz@bp.renesas.com/

v5->v6:
* Added Rb tag from Hans Verkuil and Geert.
* Updated commit description and comment related to i2c_new_ancillary_device()
* Fixed the issue related to assigning wrong parent device by adding check
for aux_device_name.
* Retained Rb tags for patch#1 as changes are trivial.
* Added Rb tag from Geert for patch#2.
* Updated the example with replacing node name "clock-xtal"->"x2-clock".
* Updated the driver header comment block in C++ style
* Dropped cache for registers.
* Dropped check for I2C functionality.
* Replaced "clock-xtal"->"x2-clock" for x2 node.
* Sorted nodes in alphabetical order.
* Added Rb tag from Geert for patch#6,#10 and #11
* Replaced u8->int for xtosb_val parameter in isl1208_set_xtoscb().
* Introduced isl1208_clk_present() for checking the presence of "xin" and
"clkin" for determining internal oscillator is enabled or not.
* Parsing of parent node is moved from probe->isl1208_clk_present()
* Added comment for parsing parent node for getting clock resource.
* Replaced XOR->NOT to make the operation more clear for the inverted case.
v4->v5:
* Replaced parameter dev->parent in __i2c_new_client_device() and
__i2c_new_dummy_device().
* Improved error message in __i2c_new_dummy_device() by printing device name.
* Updated comment for ancillary's device parent
* Dropped aux_device_name check in i2c_new_ancillary_device().
* Replaced oneOf->enum for clock-names as it is simpler.
* Added Rb tag from Conor for binding patches#3 and #9.
* Added Rb tag from Geert for patches#4, #5 and #6.
* Replaced "unsigned long"->"kernel_ulong_t" in isl1208_id[].
* Fixed the typo in commit description.
* Replaced the variable int_osc_en->xtosb_val for isl1208_set_xtoscb() and
changed the data type from bool->u8.
* Replaced devm_clk_get->devm_clk_get_optional() in probe.
* IS_ERR() related error is propagated and check for NULL to find out
if a clock is present.
* -ENOENT means clock not present, so any other errors are propagated.
* Dropped bool inverted parameter from isl1208_set_xtoscb() instead
using xor to compute the value of xtoscb.
* Added description for clocks in PMIC bindings patch.
* Dropped clk.h and started using of_property_present to check the
clocks.
v3->v4:
* Dropped Rb tag from Geert for patch#1 as there are new changes.
* Introduced __i2c_new_dummy_device() to share the code between
i2c_new_dummy_device and i2c_new_ancillary_device().
* Introduced __i2c_new_client_device() to pass parent dev
parameter, so that the ancillary device can assign its parent during
creation.
* Added minItems to interrupt-names in binding patch.
* Added interrupt-names in conditional schema check.
* Documented clock and clock-names properties.
* Dropped unused name variable from struct isl1208_config.
* Make similar I2C and DT-based matching.
* Drop enum isl1208_id and split the array isl1208_configs[].
* Introduced isl1208_set_xtoscb() to set XTOSCB bit.
* Added support for internal oscillator enable/disable.
* Moved PMIC bindings from mfd->regulator.
* Dropped minItems from reg.
* Dropped renesas,rtc-enabled property and instead used clock-names property
to find RTC is enabled or not.
* Added reg-names in required property.
* Updated the example.
* Moved from mfd->regulator as it doesn't use MFD APIs
* Dropped handling "renesas,rtc-enabled" property and instead used
clock-names to determine RTC is enabled or not and then instantiating
RTC device.
* Added clock nodes.
v2->v3:
* Enhanced i2c_new_ancillary_device() to instantiate a real ancillary_device().
* RTC device is instantiated by PMIC driver and dropped isl1208_probe_helper().
* Added "TYPE_RAA215300_RTC_A0" to handle inverted oscillator bit case.
* Added more detailed description for renesas,rtc-enabled property.
* Added support for handling "renesas,rtc-enabled" property.
* Based on PMIC version, it instantiates rtc device by calling i2c_new_
ancillary_device().
* Updated the logs.
RFC->v2:
* Dropped the cross-links from bindings and used a single compatible
with separate i2c addresses for pmic main and rtc device.
* Dropped patch#4 and split patch#3 from this series and send as
separate patch to ML [2].
* Added RTC platform driver and mfd cell entry to the PMIC driver.RTC
platform driver creates rtc device by using i2c_new_ancillary_device()
and register the rtc device by calling the helper function provided
by rtc-isl2108 driver.
* Updated reg property in bindings.
* Added optional reg-names, interrupts and renesas,rtc-enabled
properties.
* Fixed the node name in the binding example
* Dropped the cross link property renesas,raa215300-rtc.
* Updated the binding example
* Dropped MODULE_SOFTDEP from the driver as it is added in RTC platform
driver.
* Dropped compatible "renesas,raa215300-isl1208" and "renesas,raa215300-pmic" property.
* Updated the comment polarity->bit for External Oscillator.
* Added raa215300_rtc_probe_helper() for registering raa215300_rtc device and
added the helper function isl1208_probe_helper() to share the code.
* Updated pmic device node on the SoM dtsi based on the bindings.

Logs:
[ 15.447305] rtc-isl1208 3-006f: registered as rtc0
[ 15.479493] rtc-isl1208 3-006f: setting system clock to 2023-04-27T19:31:02 UTC (1682623862)

root@smarc-rzv2l:~# hwclock -r
2023-04-27 19:33:05.499001+00:00
root@smarc-rzv2l:~# hwclock -r
2023-04-27 19:33:06.936688+00:00
root@smarc-rzv2l:~#

Biju Das (11):
i2c: Enhance i2c_new_ancillary_device API
regulator: dt-bindings: Add Renesas RAA215300 PMIC bindings
regulator: Add Renesas PMIC RAA215300 driver
arm64: dts: renesas: rzg2l-smarc-som: Enable PMIC and built-in RTC
dt-bindings: rtc: isl1208: Convert to json-schema
dt-bindings: rtc: isil,isl1208: Document clock and clock-names
properties
rtc: isl1208: Drop name variable
rtc: isl1208: Make similar I2C and DT-based matching table
rtc: isl1208: Drop enum isl1208_id and split isl1208_configs[]
rtc: isl1208: Add isl1208_set_xtoscb()
rtc: isl1208: Add support for the built-in RTC on the PMIC RAA215300

.../bindings/regulator/renesas,raa215300.yaml | 85 ++++++++++
.../devicetree/bindings/rtc/isil,isl1208.txt | 38 -----
.../devicetree/bindings/rtc/isil,isl1208.yaml | 100 ++++++++++++
.../boot/dts/renesas/rzg2l-smarc-som.dtsi | 18 +++
drivers/gpu/drm/bridge/adv7511/adv7511_drv.c | 6 +-
drivers/i2c/i2c-core-base.c | 91 +++++++----
drivers/media/i2c/adv748x/adv748x-core.c | 2 +-
drivers/media/i2c/adv7604.c | 3 +-
drivers/regulator/Kconfig | 7 +
drivers/regulator/Makefile | 1 +
drivers/regulator/raa215300.c | 92 +++++++++++
drivers/rtc/rtc-isl1208.c | 150 ++++++++++++++----
include/linux/i2c.h | 3 +-
13 files changed, 490 insertions(+), 106 deletions(-)
create mode 100644 Documentation/devicetree/bindings/regulator/renesas,raa215300.yaml
delete mode 100644 Documentation/devicetree/bindings/rtc/isil,isl1208.txt
create mode 100644 Documentation/devicetree/bindings/rtc/isil,isl1208.yaml
create mode 100644 drivers/regulator/raa215300.c

--
2.25.1