Received-SPF: pass (google.com: domain of linux-kernel+bounces-209795-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:45d1:ec00::1 as permitted sender) client-ip=2604:1380:45d1:ec00::1;
From: Farouk Bouabid <farouk.bouabid@cherry.de>
Date: Tue, 11 Jun 2024 13:43:52 +0200
Subject: [PATCH v3 1/7] i2c: mux: add the ability to share mux address with
 child nodes
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: 7bit
Message-Id: <20240611-dev-mule-i2c-mux-v3-1-08d26a28e001@cherry.de>
References: <20240611-dev-mule-i2c-mux-v3-0-08d26a28e001@cherry.de>
In-Reply-To: <20240611-dev-mule-i2c-mux-v3-0-08d26a28e001@cherry.de>
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?Ym4xTnE5azZOUmYzWFJ2YTBSdXA3L05RMG9UYk1meWltVjc2V05XeUlRYmxF?=
 =?utf-8?B?bllOdFBpcll3Y2o4ZkwxRmNIWm9OZEk4YzduWDlReDUxODFacEVkOHlYL0xw?=
 =?utf-8?B?NGhLMFhkZFkzTklKMEY0TUJKVGxvSDhTSWlaVERhM25GU1Z6NE9FVUg2bFdT?=
 =?utf-8?B?OS9Zc2oxYWw4UnpBT2pHWXp4dUJua0FyOTdDa0NIa3hjajQwRi9Lc1ppUmVs?=
 =?utf-8?B?Y0xXWWZqNE8zQjZOeTFYb1htcmNWODFva3BJT0tJU2dQUE43TmppQWlGaG9R?=
 =?utf-8?B?R3JtaVdROW5XQU50OTRwSHFDd2REWjU4aksvT2R6emhoWXl4L2NsTU5iM3do?=
 =?utf-8?B?ZENtM3lPUUY3UmdjWERKRytwZzRmK3IyTnc0VjZjT0N1R0kvVnpDQmhxZDVO?=
 =?utf-8?B?MHBLclFTdDNxSVBPdWM4K2I0SmtJRWFpSWN5R3QreXNIQzlQMlhiZVdRVmhV?=
 =?utf-8?B?NWM2emlZbUl2T3NBenBJZkhnOUx1a2EzVHNIMHY5UUFnYWhmWkRWSGJGK1Vo?=
 =?utf-8?B?dWFjYlJxemtJVk1DakVDbXJIU3ptM3JZSmFZYkhVV2E2bmRmd3k0OWNSVEda?=
 =?utf-8?B?NHV5Z3gyWEIrbEVjNW1pcVlpWEtMT0VGTCtNbmFYWW9Icm56cnZJV1Z6eWNi?=
 =?utf-8?B?ZitoRG5ac0RiQ2VXSm5oTkVvZnhYM21URFhCclJrak50U2FtdG1iQU1Qckw3?=
 =?utf-8?B?eFBNdnQwNnZOVWdTMHVzV1l3WVlQb2h2d1lGb1VhWUZ2dHFIQzdoVFBHaW9W?=
 =?utf-8?B?UVhhVmV4WjJtYlQ5ZGxoQW9VdnY0eC9XT3JNbkk5YlpNS3dWOE5tcUd5TlBV?=
 =?utf-8?B?Kys2bWplTlBIVzBPZEtCeXNvcE9NTkJpSjVGMlpnTkFRRU1MNVE4WnhyRHF5?=
 =?utf-8?B?dHN1bVkvbVdEaDhmalREa1RSU2lWd1pGUVMwNFBiSkFuUnZyclNFamFVaGow?=
 =?utf-8?B?S2pXcTVIdEN5M0d0REF5OFdzTnVCb2R2VHF1NkNKN29ockMwUkxjTUMxSFpQ?=
 =?utf-8?B?Nlg4cVBCQlpCT3pHK2Y4dXZPQjd3QWhOZ2F0ZkFjVGIzRUJEMWk4cjhaU3Bw?=
 =?utf-8?B?VDhkYmR5YW5tOUFGaHlkdFZYTTM0bEFTZTZqS1h4TjJ4ODgyMUdLRWtBZDdT?=
 =?utf-8?B?NXZQNW9NWEpLYy9zMU10NEM3ZnQrTVR1OGpIUmh4eC9NWWg2ck4xSVhpUkZ2?=
 =?utf-8?B?MzVnd3RSRkkyMGtJUXJMK0lkQk1nRnhjS1U0SVpKRE5qaG8yVkszalVOOUU4?=
 =?utf-8?B?OThsZlFBS0lvQUtqS0FHQkFXQlIzdUF3ZnREdmhrZlFUTGhJVUtNd293T3Y4?=
 =?utf-8?B?SVkwZHAvNFVaY1RVV1RsLysvQ0J4NDVOUm1QWlhSSUJRa3g4OUFuVTBpbXdD?=
 =?utf-8?B?SHRNOTJEbk5Ec0hMbGJ3Wk5Kc3U2bnl2cWg3NGhGMUs4QWVtckFlbmxUaDFM?=
 =?utf-8?B?dEo1Z2dvaHA5cW1nZEpUZWc0Nzd0QTZZeUM4MVJkZS9KZzk3Q210eFo4YXlJ?=
 =?utf-8?B?WTdWVmQvSkJFQUNtYUh1MU9mMlh1UzBzeTZzR05kTytINnJiWDJlUUgrOWxw?=
 =?utf-8?B?SWYweUNDcUM2WG9ZbDllSmRnb2lDNHpLdEtabXNTNHdEWi9oVjF0eENwWHVJ?=
 =?utf-8?B?T3pKU09NdTJZSlJGMFZWUi9ibnExQnFQU0tQbVMvZ2RrdEl5eUhpaU5pM1hZ?=
 =?utf-8?B?eDdoYjR2dmlzSVltanFPS1NFWEtNdEpRZWhaY3M2djU1OXE4c2plMzRyelJN?=
 =?utf-8?B?TXIxM0E4RlU0eHAxY0t6ekVFT3FWY1MxNE00V3A4MStFa1IrME8rQU5lY0tC?=
 =?utf-8?B?b0Vac1VxMTNsYllUL1RTT3RwRFo2bVYzaVRHMFVWUGRaU20ySzQ5Y3VLRUNB?=
 =?utf-8?B?WkZXWjVmRmprMWhpbXdKd2hERzZ2TWdROEhkVEdXNHVDYXd1Rnh0dlVOUWlt?=
 =?utf-8?B?T3RNeVRQTExOaHlQR2xMcEQ0d1QxVFZyQTJYLytwK2lUNlFXQTVhUjFkaENy?=
 =?utf-8?B?cW1BZDBKQkRIN2NXNnQvaDMvTjEvK2I1ZkljUkt6ZG1Zc242Uzdtc2ZpL3Uy?=
 =?utf-8?B?R0RyeUUvakxoczVWY3lVY2w1QmgxNmE1eDV0eTloN2NmbitZTUx5M0x6d0oz?=
 =?utf-8?B?YnFqREVzeXhUaTYxVG43TVhOd3FYS0ZCZy9Tc3d3THhNbS9mbE0rRzBTMjZw?=
 =?utf-8?B?Wnc9PQ==?=
X-OriginatorOrg: cherry.de
X-MS-Exchange-CrossTenant-Network-Message-Id: 0814496d-f05e-4105-39fe-08dc8a0bd91f
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:27.9652
 (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: y19ThY51X7XaV+vhhBxcIi80JZQ2bMkktYb+xDdIYaksx7+6UqaBQ4BbNycmCFx19OqWgRkd8SB4PFPfh4tgba2DK5sOvsJQO6Zkn/KFPgA=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: GVXPR04MB10301

Allow the mux (if it's an I2C device) to have the same address as a child
device. This is useful when the mux can only use an I2C address that is
used by a child device because no other addresses are free to use.
eg. the mux can only use address 0x18 which is used by amc6821 connected
to the mux.

Signed-off-by: Farouk Bouabid <farouk.bouabid@cherry.de>
---
 drivers/i2c/i2c-core-base.c |  6 +++++-
 drivers/i2c/i2c-mux.c       | 48 ++++++++++++++++++++++++++++++++++++++++++++-
 include/linux/i2c-mux.h     |  1 +
 include/linux/i2c.h         |  7 +++++++
 4 files changed, 60 insertions(+), 2 deletions(-)

diff --git a/drivers/i2c/i2c-core-base.c b/drivers/i2c/i2c-core-base.c
index ff5c486a1dbb..ce2425b0486d 100644
--- a/drivers/i2c/i2c-core-base.c
+++ b/drivers/i2c/i2c-core-base.c
@@ -821,9 +821,13 @@ static int i2c_check_mux_children(struct device *dev, void *addrp)
 static int i2c_check_addr_busy(struct i2c_adapter *adapter, int addr)
 {
 	struct i2c_adapter *parent = i2c_parent_is_i2c_adapter(adapter);
+	bool skip_check = false;
 	int result = 0;
 
-	if (parent)
+	if (adapter->quirks && adapter->quirks->flags & I2C_AQ_SKIP_ADDR_CHECK)
+		skip_check = adapter->quirks->skip_addr_in_parent == addr;
+
+	if (parent && !skip_check)
 		result = i2c_check_mux_parents(parent, addr);
 
 	if (!result)
diff --git a/drivers/i2c/i2c-mux.c b/drivers/i2c/i2c-mux.c
index 57ff09f18c37..644509bc3496 100644
--- a/drivers/i2c/i2c-mux.c
+++ b/drivers/i2c/i2c-mux.c
@@ -334,7 +334,53 @@ int i2c_mux_add_adapter(struct i2c_mux_core *muxc,
 	priv->adap.dev.parent = &parent->dev;
 	priv->adap.retries = parent->retries;
 	priv->adap.timeout = parent->timeout;
-	priv->adap.quirks = parent->quirks;
+
+	struct i2c_adapter_quirks *quirks;
+	/*
+	 * When creating the adapter, the node devices are checked for I2C address
+	 * match with other devices on the parent adapter, among which is the mux itself.
+	 * If a match is found the node device is not probed successfully.
+	 * Allow the mux to have the same address as a child device by skipping this check.
+	 */
+	if (muxc->share_addr_with_children) {
+		struct i2c_client *client = to_i2c_client(muxc->dev);
+
+		if (muxc->dev->type != &i2c_client_type)
+			dev_warn_once(muxc->dev, "Mux is not an I2C device\n");
+
+		quirks = devm_kzalloc(muxc->dev, sizeof(*quirks), GFP_KERNEL);
+		if (!quirks)
+			return -ENOMEM;
+
+		if (parent->quirks)
+			memcpy(quirks, parent->quirks, sizeof(*quirks));
+
+		quirks->flags |= I2C_AQ_SKIP_ADDR_CHECK;
+		quirks->skip_addr_in_parent = client->addr;
+		priv->adap.quirks = quirks;
+
+	} else if (parent->quirks &&
+		   parent->quirks->flags & I2C_AQ_SKIP_ADDR_CHECK) {
+		/*
+		 * Another I2C mux device can be a child of the Mule I2C mux.
+		 * The former could probably not allow address conflict between
+		 * its address and its own children addresses.
+		 *
+		 * For this purpose, do not propagate this flag unless
+		 * share_addr_with_children is set.
+		 */
+		quirks = devm_kzalloc(muxc->dev, sizeof(*quirks), GFP_KERNEL);
+		if (!quirks)
+			return -ENOMEM;
+
+		memcpy(quirks, parent->quirks, sizeof(*quirks));
+		quirks->flags &= ~I2C_AQ_SKIP_ADDR_CHECK;
+		priv->adap.quirks = quirks;
+
+	} else {
+		priv->adap.quirks = parent->quirks;
+	}
+
 	if (muxc->mux_locked)
 		priv->adap.lock_ops = &i2c_mux_lock_ops;
 	else
diff --git a/include/linux/i2c-mux.h b/include/linux/i2c-mux.h
index 98ef73b7c8fd..17ac68bf1703 100644
--- a/include/linux/i2c-mux.h
+++ b/include/linux/i2c-mux.h
@@ -21,6 +21,7 @@ struct i2c_mux_core {
 	unsigned int mux_locked:1;
 	unsigned int arbitrator:1;
 	unsigned int gate:1;
+	unsigned int share_addr_with_children:1;
 
 	void *priv;
 
diff --git a/include/linux/i2c.h b/include/linux/i2c.h
index 5e6cd43a6dbd..c3acbaaadae9 100644
--- a/include/linux/i2c.h
+++ b/include/linux/i2c.h
@@ -670,6 +670,7 @@ int i2c_generic_scl_recovery(struct i2c_adapter *adap);
  * @max_read_len: maximum length of a read message
  * @max_comb_1st_msg_len: maximum length of the first msg in a combined message
  * @max_comb_2nd_msg_len: maximum length of the second msg in a combined message
+ * @skip_addr_in_parent: No conflict check on parent adapter for a given address
  *
  * Note about combined messages: Some I2C controllers can only send one message
  * per transfer, plus something called combined message or write-then-read.
@@ -690,6 +691,7 @@ struct i2c_adapter_quirks {
 	u16 max_read_len;
 	u16 max_comb_1st_msg_len;
 	u16 max_comb_2nd_msg_len;
+	unsigned short skip_addr_in_parent;
 };
 
 /* enforce max_num_msgs = 2 and use max_comb_*_len for length checks */
@@ -711,6 +713,11 @@ struct i2c_adapter_quirks {
 #define I2C_AQ_NO_ZERO_LEN		(I2C_AQ_NO_ZERO_LEN_READ | I2C_AQ_NO_ZERO_LEN_WRITE)
 /* adapter cannot do repeated START */
 #define I2C_AQ_NO_REP_START		BIT(7)
+/**
+ * do not check for conflict on a given address
+ * used accordingly with "struct i2c_adapter_quirks.skip_addr_in_parent"
+ */
+#define I2C_AQ_SKIP_ADDR_CHECK	BIT(8)
 
 /*
  * i2c_adapter is the structure used to identify a physical i2c bus along

-- 
2.34.1