Received-SPF: pass (google.com: domain of linux-kernel+bounces-169800-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) client-ip=147.75.80.249;
From: Farouk Bouabid <farouk.bouabid@cherry.de>
Date: Mon, 06 May 2024 13:37:52 +0200
Subject: [PATCH v2 1/7] i2c: mux: add the ability to share mux core address
 with child nodes
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: 7bit
Message-Id: <20240506-dev-mule-i2c-mux-v2-1-a91c954f65d7@cherry.de>
References: <20240506-dev-mule-i2c-mux-v2-0-a91c954f65d7@cherry.de>
In-Reply-To: <20240506-dev-mule-i2c-mux-v2-0-a91c954f65d7@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>, 
 Quentin Schulz <quentin.schulz@theobroma-systems.com>
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?WEF2Y2N6RXpjLzhTNUxOakNBRlYzclgzcmE2MFBqQy9EK0xncnc4aityZ2NZ?=
 =?utf-8?B?T3RLdm5OOThVakFNSGdxUVNWTGs5WmFWejhJdW12azdmWFc0NkdZby8yclR6?=
 =?utf-8?B?NUwyU0p4dlV6N3hBOWNSdnhaZm5qQ2RaRVhoWm9KQ2ZpejNBbFUzdEpMc1U2?=
 =?utf-8?B?MTNMOXhwazIzTlBpdVRPY1BNNDVHWm4yWDl6QVZxRThHYVlReXBFWlhiNUhp?=
 =?utf-8?B?Tnc0OGcwOFV6Q0cvajRVR0ZYa3dvK0pualRLdnpJbjJpYlEzS093MW1jQ2tP?=
 =?utf-8?B?aWZiNVpNZGJ4Q244cXFSdmNFdXR0b3NCS1ZSbTRYcjRmM29wRE9HYUhxeVlE?=
 =?utf-8?B?VDg0WWVac3FHcDRXMFlkVlJlbGcwdFlIUU5uSDlHR2ZobVpUb0p4YW5YQkdt?=
 =?utf-8?B?Vm11Ym0vdHA2dzQvQ2FtZVlQNlFaU3RiTFFpMFNTd3FRNTcxRHZib2czcTJZ?=
 =?utf-8?B?TThaRXN6ZEhtTFdPOWk2MlFValhFb2ZqSitkbzlSZHVBQytzOU1HVHN5NzlQ?=
 =?utf-8?B?SnAyTzB5blZYdllEL0tMamVoMWlJUWdMYzZNNVJSbjNWNUo1bXpXbzROcjJk?=
 =?utf-8?B?YlM2byswNHd5NmhTbHVmUU5YVEx6QlVWUlhZM1VnN2d1MzhUdDhQYXdHa3hU?=
 =?utf-8?B?dlV6bk5tTVlUZEs3RlRpVVNaYUVxRks2RU1YU3NMTVlKTTA0emp5dkw2elQ2?=
 =?utf-8?B?NzlreENBc0N6REFsL0NsYUdlMlF4R01HaHoyS0xZZnZYc2diY1Q2TGN2RnA2?=
 =?utf-8?B?a2NSSWpia1NsNE0xT0hsMmFWOGJQYWJ4dHlxTTFyZWFhUE5nMnJ0V1JadlpT?=
 =?utf-8?B?K1p0MDl2ZlEzT3pTMDZhOXNZcUE2SEphUld6RTVwa01LVlpUc1NCZitoeHYy?=
 =?utf-8?B?b3lJaEFKN1d2NnBnUnd0a2ZyR0VSSHkzSDgvSnJQYXdIVTdKWStJNmc2R002?=
 =?utf-8?B?amc0c0IxT3M0VXo0QVM3ak1CdDhOb1JHYXBJK1BUUGkzSmNWLzE1bkxYV0xh?=
 =?utf-8?B?NWV4THdsMFVKa0J0WUI2aWJJWU1jZnFwN3h0NTFWS3BneU5UWUt3QUtCUFZn?=
 =?utf-8?B?dmpna1hlWmdEMG9sbm4ra2txUElXeGhGMzlVdEliSFlQODF1Z2RhMGR6Rzhs?=
 =?utf-8?B?dyt2NlZuUTQ3akZUNk02VVVhZGpJRkZxRnhZN2J2aWlWU2VKRzRFMzR2Q0NM?=
 =?utf-8?B?NFI5SEZiVG1iSXlseXhxWEhkeWk3aUp5ZEhUR0MwcGpMVGt3YnNhUFJmSURx?=
 =?utf-8?B?dXdKRlBDTG1WOFA2S2owVnZ1YnJkSVl0QUh3Q2w3cmcrbFNkYXo4L3c4K3A1?=
 =?utf-8?B?Zm81VjY1eWtMbzZtZFlSZWJ6dFJsY2trQ0lWZE1NNE42WmJ2RTFsbmRUa2xl?=
 =?utf-8?B?Q3Z6Nm4yZ0E0MHJleWRjTjBBakQyUkZRdmthcWtlVVpXNUpGcndEYzVZSVlT?=
 =?utf-8?B?N2RTMldId2wwZVRkTVh2RnpRYTVsRG9mUU51R2M4RHYwY3J5OVRTb3p5WDRp?=
 =?utf-8?B?NXZxRkU3OE5zUG5adUNmT21qejR4a1BjQjBPbzRGeTN4Tk9LZ2tkYkhMTnBh?=
 =?utf-8?B?azZ0N2gzczNCWTFWeXJmZldFQTZlaTVLaS9hU2VaaWNLdjViNFVTZjIybHhx?=
 =?utf-8?B?UnZBMG1IaVllU29rNXIva2NwZlVZUjNhbWdZVkdGYjcrbHI5b21BakFOSnJQ?=
 =?utf-8?B?RXVsQ0tlbGltUlM5SStQVW9vVzhhMklDSkZhNFJwV1c4V2ZoQWVGczl5Vit4?=
 =?utf-8?B?a0puZy9tcGZpV0wwOU5PbWFJYithVTdvTStuTlpnZ0pBUkkzNDc3OTJqT2Jk?=
 =?utf-8?B?T1RNdk1FS040Z09wK0FFTTJSZ3RDMzFiOVpWdGRRQjkrcGZvNFpsQ2lsTm1n?=
 =?utf-8?B?WW1rS2xSYlJqNXNRTGxZZTBsWDY4VWtQRVQ0ZFZHTWxCZjNqRGJpcDQwdjBk?=
 =?utf-8?B?aG1QcDc4dTF5dVFuVGhPb2tiUDFvc0Z3Y1BGZnczNGFwNWVUbGZMN0NvMzgr?=
 =?utf-8?B?aWthd2VGb0ozTytxMC85VzhaN243S1ZjM2s5Ym9uWjdRMGFNdTB3U1RKa2pq?=
 =?utf-8?B?eTYwL2FHSTlYcGR3T29xcUswVGRHaXArRWZScks3Qi9La2dEb21WTUc2Vits?=
 =?utf-8?B?Uk82bkNRbUpvSExiV0ZQS01hWEdJTVlkWFkyZUZpdmJIQkxzUkhmK3VBRnM1?=
 =?utf-8?B?NFE9PQ==?=
X-OriginatorOrg: cherry.de
X-MS-Exchange-CrossTenant-Network-Message-Id: 6effe2ac-152d-4e1c-0cf6-08dc6dc771b8
X-MS-Exchange-CrossTenant-AuthSource: VE1PR04MB6382.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 06 May 2024 12:24:15.4771
 (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: FrzVeorVuNa9d7Gp/GyT+qoUB/NErmzYZ4C/giRA3T3HQVn4NgJo99HGhdYyw451v3aFiS1qr84xV1osZAnqmgbE2fEz5FdXfJ8JDev6RCY=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: AS8PR04MB9512

Allow the mux core (if it's an i2c device) to have the same address as
a child device. This is useful when the mux core can only use an i2c
address that is used by a child device because no other addresses are
free to use. eg. the mux core 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       | 25 ++++++++++++++++++++++++-
 include/linux/i2c-mux.h     |  1 +
 include/linux/i2c.h         |  7 +++++++
 4 files changed, 37 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..bdb75a130cab 100644
--- a/drivers/i2c/i2c-mux.c
+++ b/drivers/i2c/i2c-mux.c
@@ -334,7 +334,30 @@ 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;
+	/*
+	 * 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 core 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 && muxc->dev->type == &i2c_client_type) {
+		struct i2c_adapter_quirks *quirks = devm_kzalloc(muxc->dev,
+								 sizeof(*quirks), GFP_KERNEL);
+		struct i2c_client *client = to_i2c_client(muxc->dev);
+
+		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 {
+		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