Received-SPF: pass (google.com: domain of linux-kernel+bounces-209796-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.48.161 as permitted sender) client-ip=147.75.48.161;
From: Farouk Bouabid <farouk.bouabid@cherry.de>
Subject: [PATCH v3 0/7] Add Mule I2C multiplexer support
Date: Tue, 11 Jun 2024 13:43:51 +0200
Message-Id: <20240611-dev-mule-i2c-mux-v3-0-08d26a28e001@cherry.de>
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: 7bit
To: Wolfram Sang <wsa+renesas@sang-engineering.com>, 
 Peter Rosin <peda@axentia.se>, Andi Shyti <andi.shyti@kernel.org>, 
 Rob Herring <robh@kernel.org>, 
 Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>, 
 Conor Dooley <conor+dt@kernel.org>, 
 Farouk Bouabid <farouk.bouabid@cherry.de>, 
 Quentin Schulz <quentin.schulz@cherry.de>, Heiko Stuebner <heiko@sntech.de>
Cc: linux-i2c@vger.kernel.org, linux-kernel@vger.kernel.org, 
 devicetree@vger.kernel.org, linux-arm-kernel@lists.infradead.org, 
 linux-rockchip@lists.infradead.org
Precedence: bulk
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0:
	=?utf-8?B?NFk4MkVlZDA2K3BvNUtVRVRQTXArMHNINzhjWml1cnFLZ1VBOXEzRHpnTmNC?=
 =?utf-8?B?c1c0MmVDRzhOL0E2UzRCMGozSmtoVm4yeVlqdXlha3dlVUZiZ1ltNitLTC9Z?=
 =?utf-8?B?MTRKbkdQakRMQ1RWTit0cUxlZlIzRVh3Uk9GMFc4SFJkS2twMVZjY0hQRnds?=
 =?utf-8?B?Z0srWkx0L0xGYUYxempQbWdFTnkrRDZPdkNUVG9zMXdsR0FCcWRvVGtyUUgv?=
 =?utf-8?B?QUJjb09SeXpsUUhNNXViK2ZpK0tuT0c2cW02NElXUU5WU0JKRGxTTmhIcXpQ?=
 =?utf-8?B?YUpmM1VUQVdGcUlxTk56UG54alJ3Z0l2WTNRbElHVmsxQjh5cis3VWxhRHdJ?=
 =?utf-8?B?NmxsclpKTVQ2M0pSNU1zbW9MWFRtK2hGSm9JcUhPOWpEa0ZNSEZTc1hINFl3?=
 =?utf-8?B?alZaZG1GMmt3MGdPTEkzRXJhbVdacXlmOHpSeVVvU1NSMXRiZ3cwVUVLUXU3?=
 =?utf-8?B?ZmUxbiswU1NKU2kva0NOdVdhUnI5SjhuWXZxbmcyWmlwZlA4RGlscExsbWoy?=
 =?utf-8?B?WGp3aXhEeWI4eW52Z2M2MCtxOHdhenVDZFlBVys0YkN4cUNNcmx4ZkdtYXpw?=
 =?utf-8?B?VFNkb2Z6blpQRTFGRDBxbUtPdXJaSFIwTGhZL1p4NlYvZTlNbXVNK2NBK0hT?=
 =?utf-8?B?M01rdHBwTkZseEhkdnE5bDkyNElhVnZoU1E2b2Q5cVlkajZneUNwNXV3bFVH?=
 =?utf-8?B?MXM4enJvSXhZcXRyTisyaFlvZEZPR09NYXNXV2hUQi9QNXpGcHVBTVJpTDYv?=
 =?utf-8?B?d3dSZmFDSkh6cGl6bis2L2NrUWJJUDFMbkdRMHpjWWdKUS9Sa1ZiQTYwTE84?=
 =?utf-8?B?L0V5UU9Qa0pjalF5b2U3N2ZmejAxd0JpWElYYzh0WVExOUdIb2JEYUdDQTcx?=
 =?utf-8?B?SWZqZ1gvNTBhdkk4QlJwNk9LSGxSNDNHaDZVTGRFTS9YSXUxeTBnNGs4d3d3?=
 =?utf-8?B?OWM0TG5LemRMcWQ3S2FtajBpOExKSVdhN0NiaDJNVjBRd3BYMFk5cVlzUU9V?=
 =?utf-8?B?Q1hvS200b3FNWkNtem10aCtEVzBPYkoyQysweFlwN2wxcllRYXJrN3hYeWd6?=
 =?utf-8?B?K1FkSDM3bUoxekVXeUI4clZsVlNBL0UyQzBBUWdBSUhiSTBuMERXMnpOVmor?=
 =?utf-8?B?aVlkR2FPL2lPTlA4RzAzTzV4MERubmdYcTY3YzNscHVaci9NMXBlRmV1Yllk?=
 =?utf-8?B?NkVSVWxlU0lTOUNya3oyK2FzRkJ0SWNmMFowTW5pdWRVdVFJdFpWcXdmdXFU?=
 =?utf-8?B?bEJGMzA3MEZkMy9sR0pNdHdVay9qaVlRTnlpSHZENVJwelJySVE0RFY2T1hm?=
 =?utf-8?B?anZhTjJjRk40S1drUzVlOEh2aTdjKzdhcTh2V1M5c0htcWg3USs3cHFmOC9W?=
 =?utf-8?B?clZIKzdzRmltcjhtVTRlbzloc01Za3FrTFlTMFZ5ODUxZEsrVG5xTEtjb3J5?=
 =?utf-8?B?ZlVHZ0cvT1I3Vk5vT201bnBsVEdLYVNqRmxiaUNDQ0h2c3FodkUzdzlVWlVK?=
 =?utf-8?B?OG1YY3dzWTFpMnBRMFViZEx3cVAwa1Q1VU9lbDh3N0g2aHNNd1NDc2dmRWdP?=
 =?utf-8?B?VDBmeURsYTdGQlRZOWNmMzI2Smt1L0pJdUphdlhYTzZUNWZYaHU0UW9jdFJJ?=
 =?utf-8?B?ckJtUE1mbFpRT201YnE5ODVWQmcyWi9vNThlMmNicHBsTW9zOW5EYUtnTUN0?=
 =?utf-8?B?NFdWU2hZS3VZcWc3VllmTHN1OXYxajFSQlljMmRHMjlrcUlDUlI2ZGpvM1ZW?=
 =?utf-8?B?ZnVwNFMxdXVKaG1neTVvN2xSaGRSRWNMN0R3NytLenUxc1VTaVdXWXhxbG1o?=
 =?utf-8?B?R2krNkh5YVlCZ1RHNmR1M3JnZ0ppOUxqYmxuaTRmSmNTeGx6SjhHNHBjK3RH?=
 =?utf-8?B?RkxERk00ODNLNWJTL2ZhdE9GTkJTQ3E1bW9BYjNIR1gzSm9ad3JNMGdBM01X?=
 =?utf-8?B?UlRDemlJWlQ3MHRNc0lxQnJuVWRBSXFhVEdGc01lc0xnZHdCd2lnZ1hzRTVU?=
 =?utf-8?B?K21NWmRuaHJYTmxJN2UyU3JRVHRlQm93T2x5TzNCYlp6UVdNeVF3NTVycXg0?=
 =?utf-8?B?dUt5Y0NmdjBJN1hoSmIxcGFScmRIeXpoY1RIQjB0VnlRNGg5c1ZMRDBaS2N6?=
 =?utf-8?B?RzlGb0FJbmRJRm8rRmpXR1g4UTJpUmo4SG4wZ3VRYmR1ZVgzeUFGeWpKUlRO?=
 =?utf-8?B?dEE9PQ==?=
X-OriginatorOrg: cherry.de
X-MS-Exchange-CrossTenant-Network-Message-Id: d76bb88e-df4c-44d6-d9ca-08dc8a0bd800
X-MS-Exchange-CrossTenant-AuthSource: VE1PR04MB6382.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 11 Jun 2024 11:44:26.4214
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 5e0e1b52-21b5-4e7b-83bb-514ec460677e
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: QTBXPe6yDMJhYdd54Z8KrWpa/1lG6pQGFYWPyHcf1a9colxdfryYU8J20jhlLJD4SiD+jsPE2ynCUeMg0fVZ5WVUAI8o9Hh7p5G+JCBnenY=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: GVXPR04MB10301

Mule is an mcu that emulates a set of I2C devices which are reachable
through an I2C-mux.

The emulated devices share a single I2C address with the mux itself
where the requested register is what determines which logic is executed
(muxing logic or device logic):

1- The devices on the mux can be selected (muxing functionality) by
writing the appropriate device number to an I2C config register (0xff)
that is not used by any device logic.

2- Any access to a register other than the config register will be
handled by the previously selected device.

      +-------------------------------------------------------+
      |  Mule                                                 |
      |        +---------------+                              |
    ----+-(1)->|Config register|-----+                        |
      | |      +---------------+     |                        |
      | |                            V_                       |
      | |                            |  \          +--------+ |
      | |                            |   \-------->| dev #0 | |
      | |                            |   |         +--------+ |
      | |                            | M |-------->| dev #1 | |
      | +-----------(2)------------->| U |         +--------+ |
      |                              | X |-------->| dev #2 | |
      |                              |   |         +--------+ |
      |                              |   /-------->| dev #3 | |
      |                              |__/          +--------+ |
      +-------------------------------------------------------+

The current I2C-mux implementation does not allow the mux to use the
I2C address of a child device. As a workaround, A new I2C-adapter quirk is
introduced to skip the check for conflict between a child device and the
mux core I2C address when adding the child device.

This patch-series adds support for this multiplexer. Mule is integrated
as part of rk3399-puma, px30-ringneck, rk3588-tiger and rk3588-jaguar
boards.

Signed-off-by: Farouk Bouabid <farouk.bouabid@cherry.de>

Changes in v3:
- Change "i2c" in comments/commit-logs to "I2C"
- Fix long line-length
- Warn when "share_addr_with_children" is set and the Mux is not an I2C device
- Fix/stop propagating "I2C_AQ_SKIP_ADDR_CHECK" flag if "share_addr_with_children"
  is not set.
- Fix "old_fw" variable is used to indicate the reversed meaning.

- Link to v2: https://lore.kernel.org/r/20240506-dev-mule-i2c-mux-v2-0-a91c954f65d7@cherry.de

Changes in v2:
- Add i2c-adapter quirks to skip checking for conflict between the mux core
  and a child device address.
- Rename dt-binding to "tsd,mule-i2c-mux.yaml"
- Add Mule description to kconfig
- Fix indentation
- Move device table after probe

- Link to v1: https://lore.kernel.org/r/20240426-dev-mule-i2c-mux-v1-0-045a482f6ffb@theobroma-systems.com

---
Farouk Bouabid (7):
      i2c: mux: add the ability to share mux address with child nodes
      dt-bindings: i2c: mux: mule: add dt-bindings for mule i2c multiplexer
      i2c: muxes: add support for mule i2c multiplexer
      arm64: dts: rockchip: add mule i2c mux (0x18) on rk3399-puma
      arm64: dts: rockchip: add mule i2c mux (0x18) on rk3588-tiger
      arm64: dts: rockchip: add mule i2c mux (0x18) on px30-ringneck
      arm64: dts: rockchip: add mule i2c mux (0x18) on rk3588-jaguar

 .../devicetree/bindings/i2c/tsd,mule-i2c-mux.yaml  |  80 +++++++++++
 arch/arm64/boot/dts/rockchip/px30-ringneck.dtsi    |  20 ++-
 arch/arm64/boot/dts/rockchip/rk3399-puma.dtsi      |  20 ++-
 arch/arm64/boot/dts/rockchip/rk3588-jaguar.dts     |  19 ++-
 arch/arm64/boot/dts/rockchip/rk3588-tiger.dtsi     |  19 ++-
 drivers/i2c/i2c-core-base.c                        |   6 +-
 drivers/i2c/i2c-mux.c                              |  48 ++++++-
 drivers/i2c/muxes/Kconfig                          |  18 +++
 drivers/i2c/muxes/Makefile                         |   1 +
 drivers/i2c/muxes/i2c-mux-mule.c                   | 157 +++++++++++++++++++++
 include/linux/i2c-mux.h                            |   1 +
 include/linux/i2c.h                                |   7 +
 12 files changed, 384 insertions(+), 12 deletions(-)
---
base-commit: 79c1f584335af42ce359ee3ff0f4e9cc324296ed
change-id: 20240404-dev-mule-i2c-mux-9103cde07021

Best regards,
-- 
Farouk Bouabid <farouk.bouabid@cherry.de>