Received-SPF: pass (google.com: domain of linux-kernel+bounces-210279-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:45d1:ec00::1 as permitted sender) client-ip=2604:1380:45d1:ec00::1;
Message-ID: <80883dd5-2be0-4f8b-8298-ca076e6ac558@cherry.de>
Date: Tue, 11 Jun 2024 18:52:39 +0200
User-Agent: Mozilla Thunderbird
Subject: Re: [PATCH v3 3/7] i2c: muxes: add support for mule i2c multiplexer
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>, 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
References: <20240611-dev-mule-i2c-mux-v3-0-08d26a28e001@cherry.de>
 <20240611-dev-mule-i2c-mux-v3-3-08d26a28e001@cherry.de>
Content-Language: en-US
From: Farouk Bouabid <farouk.bouabid@cherry.de>
In-Reply-To: <20240611-dev-mule-i2c-mux-v3-3-08d26a28e001@cherry.de>
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 7bit
Precedence: bulk
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0:
	=?utf-8?B?SjBZbFpmTmVSbTZqYXE5QUtNL2JpSGdDSy9tZWszNVBNUngvRGxIT0pnSUZm?=
 =?utf-8?B?b0s4cWFTTlQwdmt5WnhCOWMycVRBUkRJSU1mRGI3Q0pSSWRISTdzZVBtZFZh?=
 =?utf-8?B?KzBXRUxYTXFaMzZKWnphM3JMRHFnS3BDOHUvMkE3TmcrVEFjNm9aY1ZoQnlD?=
 =?utf-8?B?QUlyZG5HVnRoL2JXdVVEWUtBOXl3M0xQOGU2NWdjM2ZyVmt4SWZvVXhkUEdl?=
 =?utf-8?B?Mk1CaXpmMmFRR0xoZHRtL3lycThIclg0d0xjVUVLeDVmUXhCOTl5Z2FMWjZ0?=
 =?utf-8?B?QUR4Qk1rQnNQQU1EcEg1czB5ZVIwQWN0a0s1OWtSUWltckhkZG1yT3NzZDYy?=
 =?utf-8?B?YnFxL3ZXRVN4Tm1seUJTVTlQd2R3Q3FPdUp4d1FYaElGaGVnd0RON2NEMzlF?=
 =?utf-8?B?ZTQwRmI3eUd6UXNTaG02dXVBTnpqcFJnamdBUTVGNnYxNjFza1V6Ukd3YjR3?=
 =?utf-8?B?dHJyYkpiNkRjT1I3TmtQalpFV3NyWVdyS3J5bzN2U3RQYVBPc2NHOFc2TTB5?=
 =?utf-8?B?VktMV0NiZHJsQjlaM2ZGYjRwcUdoOXJGNHlnVVhqQVIyVTZEemVZYmlRRlBt?=
 =?utf-8?B?ZkpuRURKNUhPc25xT29FNWc2cW1QeU0wVlJYcktnT012UjR6ekUvM09TZXkr?=
 =?utf-8?B?eE1kYWxrZFc2OEhRVnhLWjZmSkZZS2VVMzN1RHFITlpaeVZ6bDdDbHRvN3lz?=
 =?utf-8?B?VEJWWGNoZVB2VlB0UHUyT0twYitVY1kraWF5aFRnaG5jaUZQdGVpQjM4WkZq?=
 =?utf-8?B?NytEWDZuVGFST0hscG94VEVUUnJvTURMS2lONFk5VWV2dzV3L29CSVZNQ3lq?=
 =?utf-8?B?SEJ2MTZCd3FYa3UwTVFFTGdTYS94WFoyaUpuVzVzam9FdU9SOVdyVjdsemx6?=
 =?utf-8?B?NUFFaEJrNFNTalhFcER1dWluR1NVRWMrOGMrejQrTTZYd0dtNWNpSHZTSnNC?=
 =?utf-8?B?UEduZ1Y2UVl4VC84VGdJUCs2Z1ZIaUp0TTN5Njloc3pKSVYvUkRZaWJmTWlm?=
 =?utf-8?B?N2c4R0w4VU9udFlJRVBDN3JJaFF2ejBXdS8zMjdGUUllUVB0aTU3dERmVnVk?=
 =?utf-8?B?aHh6VVJleXVrQUVWMWZHSUNldG95L2NmNUxaandSb0VVWDBUUE4vbkxzQU9h?=
 =?utf-8?B?VlcyZ3BmbU5GbGdpOVJxaEFlczN2M2xzNmpnaXhidW1XTytEYkRzdmFHMWFv?=
 =?utf-8?B?Z00yM1NFSjBjYTVRSW5KTHFlWHpGU09zUncxWG9CS1NhZnVKNXNnVGNINndQ?=
 =?utf-8?B?ZmttY1NZTjhtd3N6dTE5S1lJV2F4NEhHVzVoK2JEQzFOSUpXVHJZQjlGVjFw?=
 =?utf-8?B?Z204d3UzM25JbHRmcThOdVR6U1hoUXlQS1ZSSDlPVEl1Q1pLVE40RGRIWk5N?=
 =?utf-8?B?alI5K2lSbTdWN05zdi9RaTU0alo2Ykh3eUdjR2RSWCtIWmpha2FETlBHNmda?=
 =?utf-8?B?SXQzYy92cTNHWEF3RGZjQmhVZDRBKzRNV2FFckVseWNINjYxMS90VlhhNEw2?=
 =?utf-8?B?Zm8ybURoT09YaGZYQkhCRmUzVC9EL0tBY1cydWJQV3lsT2NyRWNZWW9Qd2NS?=
 =?utf-8?B?c2VzRExwcnF6S3lPOGgzNEFoRHVKS3c2MmpuWXBicEQzTHlUQklkRDBJanhH?=
 =?utf-8?B?WWFEUUlLL3d3aGJlU0Z2ZC9YMXQvYitML2M2NVV5aDlPR2x5czMwVlhTNzZR?=
 =?utf-8?B?ekRpWEN5c0hSZE9BUThBbVpGUzlWUlpwc014Mm9SYkJMeXRRenZRcFF5cnJO?=
 =?utf-8?B?aTBIanRhaksybi96S1h1Y2tQOUtlWUd6Vm12VU5KdnBoc1diYnVkMDE1eUJ1?=
 =?utf-8?B?ZmZzLytTVDJ0OERZS3dvT28xeWk5T3ExR05qY2V2RmF6WHovNzAyUEwxS0lt?=
 =?utf-8?B?dG9vUXByWWRVYmVqNW1FWkFPd2NjcEJ5U3liVWowd016SHBDOENRUGpTKzln?=
 =?utf-8?B?a2VZakxIbmtiZUczK1R2UUNOeFNVWXVlRE1sNUxFektzMGlpSVdxZ2VDMGpn?=
 =?utf-8?B?MWZqQUxHWFFJdUNnc1M4SnZNcHNQSVVkY252MUFrcDE3cVBhZ1BqOFpDd1p2?=
 =?utf-8?B?R3FXY0dkdjlWL2hIRkdSTTNTTk5hbUx2TXpvbTNlU2F6R0RKZ3pCcFB1bkZp?=
 =?utf-8?B?S3RXNjhvQi9iQ2xMYmE2Q0wvNzhaS3VpKzB0RTNQVm9yNmYyWnVuQXJ3elVv?=
 =?utf-8?B?Q2c9PQ==?=
X-OriginatorOrg: cherry.de
X-MS-Exchange-CrossTenant-Network-Message-Id: 22f66499-b142-41bf-a549-08dc8a36e89b
X-MS-Exchange-CrossTenant-AuthSource: VE1PR04MB6382.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 11 Jun 2024 16:52:42.2522
 (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: 5ExkMDZwtW1JMrWj3SaSIkp/lwdJMVy0wgNe+PnP8bbzX4sCEM3k4kUiexPRdASJCHypSRvuMhH2VPP5FSNOsn9VKRQoeha7UKzP6f18TlY=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: AM7PR04MB6918

Hi all,

On 11.06.24 13:43, Farouk Bouabid wrote:
> 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
> (mux logic or device logic):
>
> 1- The devices on the mux can be selected (mux function) 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.
>
> Signed-off-by: Farouk Bouabid <farouk.bouabid@cherry.de>
> ---
>   drivers/i2c/muxes/Kconfig        |  18 +++++
>   drivers/i2c/muxes/Makefile       |   1 +
>   drivers/i2c/muxes/i2c-mux-mule.c | 157 +++++++++++++++++++++++++++++++++++++++
>   3 files changed, 176 insertions(+)
>
> diff --git a/drivers/i2c/muxes/Kconfig b/drivers/i2c/muxes/Kconfig
> index db1b9057612a..70876259796d 100644
> --- a/drivers/i2c/muxes/Kconfig
> +++ b/drivers/i2c/muxes/Kconfig
> @@ -119,4 +119,22 @@ config I2C_MUX_MLXCPLD
>   	  This driver can also be built as a module.  If so, the module
>   	  will be called i2c-mux-mlxcpld.
>   
> +config I2C_MUX_MULE
> +	tristate "Mule I2C device multiplexer"
> +	depends on OF
> +	help
> +	  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
> +	  (mux logic or device logic).
> +
> +	  If you say yes to this option, support will be included for a
> +	  Mule I2C device multiplexer. This driver provides access to
> +	  I2C devices connected on the Mule I2C mux.
> +
> +	  This driver can also be built as a module.  If so, the module
> +	  will be called i2c-mux-mule.
> +
>   endmenu
> diff --git a/drivers/i2c/muxes/Makefile b/drivers/i2c/muxes/Makefile
> index 6d9d865e8518..4b24f49515a7 100644
> --- a/drivers/i2c/muxes/Makefile
> +++ b/drivers/i2c/muxes/Makefile
> @@ -10,6 +10,7 @@ obj-$(CONFIG_I2C_MUX_GPIO)	+= i2c-mux-gpio.o
>   obj-$(CONFIG_I2C_MUX_GPMUX)	+= i2c-mux-gpmux.o
>   obj-$(CONFIG_I2C_MUX_LTC4306)	+= i2c-mux-ltc4306.o
>   obj-$(CONFIG_I2C_MUX_MLXCPLD)	+= i2c-mux-mlxcpld.o
> +obj-$(CONFIG_I2C_MUX_MULE)	+= i2c-mux-mule.o
>   obj-$(CONFIG_I2C_MUX_PCA9541)	+= i2c-mux-pca9541.o
>   obj-$(CONFIG_I2C_MUX_PCA954x)	+= i2c-mux-pca954x.o
>   obj-$(CONFIG_I2C_MUX_PINCTRL)	+= i2c-mux-pinctrl.o
> diff --git a/drivers/i2c/muxes/i2c-mux-mule.c b/drivers/i2c/muxes/i2c-mux-mule.c
> new file mode 100644
> index 000000000000..db27fa560995
> --- /dev/null
> +++ b/drivers/i2c/muxes/i2c-mux-mule.c
> @@ -0,0 +1,157 @@
> +// SPDX-License-Identifier: GPL-2.0
> +/*
> + * Mule I2C device multiplexer
> + *
> + * Copyright (C) 2024 Theobroma Systems Design und Consulting GmbH
> + */
> +
> +#include <linux/i2c-mux.h>
> +#include <linux/i2c.h>
> +#include <linux/module.h>
> +#include <linux/of.h>
> +#include <linux/property.h>
> +#include <linux/regmap.h>
> +
> +#define MUX_CONFIG_REG  0xff
> +#define MUX_DEFAULT_DEV 0x0
> +
> +struct mule_i2c_reg_mux {
> +	struct regmap *regmap;
> +};
> +
> +static const struct regmap_config mule_regmap_config = {
> +	.reg_bits = 8,
> +	.val_bits = 8,
> +};
> +
> +static inline int __mux_select(struct regmap *regmap, u32 dev)
> +{
> +	return regmap_write(regmap, MUX_CONFIG_REG, dev);
> +}
> +
> +static int mux_select(struct i2c_mux_core *muxc, u32 dev)
> +{
> +	struct mule_i2c_reg_mux *mux = muxc->priv;
> +
> +	return __mux_select(mux->regmap, dev);
> +}
> +
> +static int mux_deselect(struct i2c_mux_core *muxc, u32 dev)
> +{
> +	return mux_select(muxc, MUX_DEFAULT_DEV);
> +}
> +
> +static void mux_remove(void *data)
> +{
> +	struct i2c_mux_core *muxc = data;
> +
> +	i2c_mux_del_adapters(muxc);
> +
> +	mux_deselect(muxc, MUX_DEFAULT_DEV);
> +}
> +
> +static int mule_i2c_mux_probe(struct i2c_client *client)
> +{
> +	struct i2c_adapter *adap = client->adapter;
> +	struct mule_i2c_reg_mux *priv;
> +	struct i2c_mux_core *muxc;
> +	struct device_node *dev;
> +	unsigned int readback;
> +	int ndev, ret;
> +	bool old_fw;
> +
> +	/* Count devices on the mux */
> +	ndev = of_get_child_count(client->dev.of_node);
> +	dev_dbg(&client->dev, "%u devices on the mux\n", ndev);
> +
> +	muxc = i2c_mux_alloc(adap, &client->dev,
> +			     ndev, sizeof(*priv),
> +			     I2C_MUX_LOCKED,
> +			     mux_select, mux_deselect);
> +	if (!muxc)
> +		return -ENOMEM;
> +
> +	muxc->share_addr_with_children = 1;
> +	priv = i2c_mux_priv(muxc);
> +
> +	priv->regmap = devm_regmap_init_i2c(client, &mule_regmap_config);
> +	if (IS_ERR(priv->regmap))
> +		return dev_err_probe(&client->dev, PTR_ERR(priv->regmap),
> +				     "Failed to allocate i2c register map\n");
> +
> +	i2c_set_clientdata(client, muxc);
> +
> +	/*
> +	 * Mux 0 is guaranteed to exist on all old and new mule fw.
> +	 * mule fw without mux support will accept write ops to the
> +	 * config register, but readback returns 0xff (register not updated).
> +	 */
> +	ret = mux_select(muxc, 0);
> +	if (ret)
> +		return ret;
> +
> +	ret = regmap_read(priv->regmap, MUX_CONFIG_REG, &readback);
> +	if (ret)
> +		return ret;
> +
> +	old_fw = (readback != 0);
> +
> +	ret = devm_add_action_or_reset(&client->dev, mux_remove, muxc);
> +	if (ret)
> +		return ret;
> +
> +	/* Create device adapters */
> +	for_each_child_of_node(client->dev.of_node, dev) {
> +		u32 reg;
> +
> +		ret = of_property_read_u32(dev, "reg", &reg);
> +		if (ret) {
> +			dev_err(&client->dev, "No reg property found for %s: %d\n",
> +				of_node_full_name(dev), ret);
> +			return ret;
> +		}
> +
> +		if (old_fw && reg != 0) {
> +			dev_warn(&client->dev,
> +				 "Mux %d not supported, please update Mule FW\n", reg);
> +			continue;
> +		}
> +
> +		ret = mux_select(muxc, reg);
> +		if (ret) {
> +			dev_warn(&client->dev,
> +				 "Mux %d not supported, please update Mule FW\n", reg);
> +			continue;
> +		}
> +
> +		ret = i2c_mux_add_adapter(muxc, 0, reg, 0);


The class parameter was recently removed from this function but I forgot 
to remove it. Sorry for the noise, I will send a v4 for this fix.


Cheers,

Farouk