Devicetree
 help / color / mirror / Atom feed
From: "Erim, Salih" <salih.erim@amd.com>
To: jic23@kernel.org, andy@kernel.org
Cc: dlechner@baylibre.com, nuno.sa@analog.com, robh@kernel.org,
	krzk+dt@kernel.org, conor+dt@kernel.org, conall.ogriofa@amd.com,
	michal.simek@amd.com, linux@roeck-us.net, erimsalih@gmail.com,
	linux-iio@vger.kernel.org, devicetree@vger.kernel.org,
	linux-kernel@vger.kernel.org,
	Andy Shevchenko <andriy.shevchenko@intel.com>
Subject: Re: [PATCH v11 3/5] iio: adc: versal-sysmon: add I2C driver
Date: Tue, 23 Jun 2026 12:33:33 +0100	[thread overview]
Message-ID: <bcbd202e-7d43-4f59-9ff3-59b564e4a3f4@amd.com> (raw)
In-Reply-To: <20260623014036.3865402-4-salih.erim@amd.com>

Addressing Sashiko findings on this patch:

- [High] Non-atomic I2C read transaction releases the bus lock,
   making it vulnerable to bus interleaving.

   The SysMon I2C interface is typically on a dedicated bus with
   no other devices. The current implementation works correctly
   in all tested configurations. Switching to i2c_transfer() with
   Repeated Start would match the TRM protocol diagram but would
   require hardware testing on a board with I2C-accessible SysMon.
   No change for now.

Thanks,
Salih

On 23/06/2026 02:40, Salih Erim wrote:
> Add an I2C transport driver for the Versal SysMon block. The SysMon
> provides an I2C slave interface that allows an external master to
> read voltage and temperature measurements through the same register
> map used by the MMIO path.
> 
> The I2C command frame is an 8-byte structure containing a 4-byte data
> payload, a 2-byte register offset, and a 1-byte instruction field.
> Read operations send the frame with a read instruction, then receive
> a 4-byte response containing the register value.
> 
> Events are not supported on the I2C path because there is no
> interrupt line and the I2C regmap backend cannot be called from
> atomic context.
> 
> Co-developed-by: Conall O'Griofa <conall.ogriofa@amd.com>
> Signed-off-by: Conall O'Griofa <conall.ogriofa@amd.com>
> Signed-off-by: Salih Erim <salih.erim@amd.com>
> Reviewed-by: Andy Shevchenko <andriy.shevchenko@intel.com>
> ---
> Changes in v11:
>    - No code changes
> 
> Changes in v10:
>    - No code changes
> 
> Changes in v9:
>    - Add Reviewed-by tag from Andy Shevchenko
>    - Add MODULE_IMPORT_NS("VERSAL_SYSMON") (Andy, from P2 namespace)
> 
> Changes in v8:
>    - Add volatile register comment for regmap cache (Andy)
>    - Update devm_versal_sysmon_core_probe call site (Andy, from P2 rename)
> 
> Changes in v7:
>    - No code changes
> 
> Changes in v6:
>    - Add types.h include (IWYU) (Andy)
>    - Add local struct device *dev, join devm_regmap_init on
>      one line (Andy)
> 
> Changes in v5:
>    - Add err.h, mod_devicetable.h includes (IWYU) (Andy)
> 
> Changes in v4:
>    - Replace enum with defines for I2C frame offsets (Jonathan)
>    - Use get_unaligned_le32() for read data reassembly (Jonathan)
>    - Use put_unaligned_le32/le16() for write data and register offset
>      packing (Jonathan)
>    - Named initializer in i2c_device_id (Jonathan)
>    - Drop bitfield.h, add unaligned.h (FIELD_GET/FIELD_PREP replaced
>      by unaligned accessors)
> 
> Changes in v3:
>    - IWYU: fix includes (Andy)
>    - Enum: assign all values explicitly for HW-mapped fields (Andy)
>    - Remove sysmon_i2c wrapper struct, pass i2c_client directly
>      (Andy)
>    - Use sizeof() for I2C buffer lengths instead of defines (Andy)
>    - Use = { } instead of = { 0 } for initializers (Andy)
>    - Use single compatible xlnx,versal-sysmon (Krzysztof)
>    - Adapt to core_probe interface change: irq moved to core,
>      remove irq parameter from bus driver (Jonathan)
> 
> Changes in v2:
>    - New patch (I2C was deferred to Series B in v1)
>    - Uses regmap API with custom I2C read/write callbacks
>    - Shares core module with MMIO driver via sysmon_core_probe()
>    - No event support (I2C has no interrupt line)
>    - Separate VERSAL_SYSMON_I2C Kconfig symbol
>    - Reverse Christmas Tree variable ordering in read/write functions
>   drivers/iio/adc/Kconfig             |  13 +++
>   drivers/iio/adc/Makefile            |   1 +
>   drivers/iio/adc/versal-sysmon-i2c.c | 134 ++++++++++++++++++++++++++++
>   3 files changed, 148 insertions(+)
>   create mode 100644 drivers/iio/adc/versal-sysmon-i2c.c
> 
> diff --git a/drivers/iio/adc/Kconfig b/drivers/iio/adc/Kconfig
> index c7f19057484..8f9fc9de74a 100644
> --- a/drivers/iio/adc/Kconfig
> +++ b/drivers/iio/adc/Kconfig
> @@ -1963,6 +1963,19 @@ config VERSAL_SYSMON
>   	  To compile this driver as a module, choose M here: the module
>   	  will be called versal-sysmon.
>   
> +config VERSAL_SYSMON_I2C
> +	tristate "AMD Versal SysMon I2C driver"
> +	depends on I2C
> +	select VERSAL_SYSMON_CORE
> +	help
> +	  Say yes here to have support for the AMD/Xilinx Versal System
> +	  Monitor (SysMon) via I2C interface. This driver enables voltage
> +	  and temperature monitoring when the Versal chip has SysMon
> +	  configured with I2C access.
> +
> +	  To compile this driver as a module, choose M here: the module
> +	  will be called versal-sysmon-i2c.
> +
>   config VF610_ADC
>   	tristate "Freescale vf610 ADC driver"
>   	depends on HAS_IOMEM
> diff --git a/drivers/iio/adc/Makefile b/drivers/iio/adc/Makefile
> index d7696b1b157..5abb611fe46 100644
> --- a/drivers/iio/adc/Makefile
> +++ b/drivers/iio/adc/Makefile
> @@ -169,6 +169,7 @@ obj-$(CONFIG_TWL4030_MADC) += twl4030-madc.o
>   obj-$(CONFIG_TWL6030_GPADC) += twl6030-gpadc.o
>   obj-$(CONFIG_VERSAL_SYSMON_CORE) += versal-sysmon-core.o
>   obj-$(CONFIG_VERSAL_SYSMON) += versal-sysmon.o
> +obj-$(CONFIG_VERSAL_SYSMON_I2C) += versal-sysmon-i2c.o
>   obj-$(CONFIG_VF610_ADC) += vf610_adc.o
>   obj-$(CONFIG_VIPERBOARD_ADC) += viperboard_adc.o
>   obj-$(CONFIG_XILINX_AMS) += xilinx-ams.o
> diff --git a/drivers/iio/adc/versal-sysmon-i2c.c b/drivers/iio/adc/versal-sysmon-i2c.c
> new file mode 100644
> index 00000000000..e9a7629159a
> --- /dev/null
> +++ b/drivers/iio/adc/versal-sysmon-i2c.c
> @@ -0,0 +1,134 @@
> +// SPDX-License-Identifier: GPL-2.0
> +/*
> + * AMD Versal SysMon I2C driver
> + *
> + * Copyright (C) 2023 - 2026, Advanced Micro Devices, Inc.
> + */
> +
> +#include <linux/bits.h>
> +#include <linux/err.h>
> +#include <linux/i2c.h>
> +#include <linux/mod_devicetable.h>
> +#include <linux/module.h>
> +#include <linux/regmap.h>
> +#include <linux/types.h>
> +#include <linux/unaligned.h>
> +
> +#include "versal-sysmon.h"
> +
> +#define SYSMON_I2C_INSTR_READ	BIT(2)
> +#define SYSMON_I2C_INSTR_WRITE	BIT(3)
> +
> +/*
> + * I2C command frame layout (8 bytes):
> + *   [0..3] data payload (little-endian u32)
> + *   [4..5] register offset >> 2 (little-endian u16)
> + *   [6]    instruction (read/write)
> + *   [7]    reserved
> + */
> +#define SYSMON_I2C_DATA_OFS	0
> +#define SYSMON_I2C_REG_OFS	4
> +#define SYSMON_I2C_INSTR_OFS	6
> +
> +static int sysmon_i2c_reg_read(void *context, unsigned int reg,
> +			       unsigned int *val)
> +{
> +	struct i2c_client *client = context;
> +	u8 write_buf[8] = { };
> +	u8 read_buf[4];
> +	int ret;
> +
> +	put_unaligned_le16(reg >> 2, &write_buf[SYSMON_I2C_REG_OFS]);
> +	write_buf[SYSMON_I2C_INSTR_OFS] = SYSMON_I2C_INSTR_READ;
> +
> +	ret = i2c_master_send(client, write_buf, sizeof(write_buf));
> +	if (ret < 0)
> +		return ret;
> +	if (ret != sizeof(write_buf))
> +		return -EIO;
> +
> +	ret = i2c_master_recv(client, read_buf, sizeof(read_buf));
> +	if (ret < 0)
> +		return ret;
> +	if (ret != sizeof(read_buf))
> +		return -EIO;
> +
> +	*val = get_unaligned_le32(read_buf);
> +
> +	return 0;
> +}
> +
> +static int sysmon_i2c_reg_write(void *context, unsigned int reg,
> +				unsigned int val)
> +{
> +	struct i2c_client *client = context;
> +	u8 write_buf[8] = { };
> +	int ret;
> +
> +	put_unaligned_le32(val, &write_buf[SYSMON_I2C_DATA_OFS]);
> +	put_unaligned_le16(reg >> 2, &write_buf[SYSMON_I2C_REG_OFS]);
> +	write_buf[SYSMON_I2C_INSTR_OFS] = SYSMON_I2C_INSTR_WRITE;
> +
> +	ret = i2c_master_send(client, write_buf, sizeof(write_buf));
> +	if (ret < 0)
> +		return ret;
> +	if (ret != sizeof(write_buf))
> +		return -EIO;
> +
> +	return 0;
> +}
> +
> +/*
> + * Almost all registers are volatile (live ADC readings, interrupt
> + * status). The rest are not accessed often enough to benefit from
> + * caching.
> + */
> +static const struct regmap_config sysmon_i2c_regmap_config = {
> +	.reg_bits = 32,
> +	.val_bits = 32,
> +	.reg_stride = SYSMON_REG_STRIDE,
> +	.max_register = SYSMON_MAX_REG,
> +	.reg_read = sysmon_i2c_reg_read,
> +	.reg_write = sysmon_i2c_reg_write,
> +};
> +
> +static int sysmon_i2c_probe(struct i2c_client *client)
> +{
> +	struct device *dev = &client->dev;
> +	struct regmap *regmap;
> +
> +	regmap = devm_regmap_init(dev, NULL, client, &sysmon_i2c_regmap_config);
> +	if (IS_ERR(regmap))
> +		return PTR_ERR(regmap);
> +
> +	/* I2C has no IRQ connection; events are not supported */
> +	return devm_versal_sysmon_core_probe(dev, regmap);
> +}
> +
> +static const struct of_device_id sysmon_i2c_of_match_table[] = {
> +	{ .compatible = "xlnx,versal-sysmon" },
> +	{ }
> +};
> +MODULE_DEVICE_TABLE(of, sysmon_i2c_of_match_table);
> +
> +static const struct i2c_device_id sysmon_i2c_id_table[] = {
> +	{ .name = "versal-sysmon" },
> +	{ }
> +};
> +MODULE_DEVICE_TABLE(i2c, sysmon_i2c_id_table);
> +
> +static struct i2c_driver sysmon_i2c_driver = {
> +	.probe = sysmon_i2c_probe,
> +	.driver = {
> +		.name = "versal-sysmon-i2c",
> +		.of_match_table = sysmon_i2c_of_match_table,
> +	},
> +	.id_table = sysmon_i2c_id_table,
> +};
> +module_i2c_driver(sysmon_i2c_driver);
> +
> +MODULE_LICENSE("GPL");
> +MODULE_DESCRIPTION("AMD Versal SysMon I2C Driver");
> +MODULE_IMPORT_NS("VERSAL_SYSMON");
> +MODULE_AUTHOR("Conall O'Griofa <conall.ogriofa@amd.com>");
> +MODULE_AUTHOR("Salih Erim <salih.erim@amd.com>");


  parent reply	other threads:[~2026-06-23 11:33 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-06-23  1:40 [PATCH v11 0/5] iio: adc: add Versal SysMon driver Salih Erim
2026-06-23  1:40 ` [PATCH v11 1/5] dt-bindings: iio: adc: add xlnx,versal-sysmon binding Salih Erim
2026-06-23  1:40 ` [PATCH v11 2/5] iio: adc: add Versal SysMon driver Salih Erim
2026-06-23  1:40 ` [PATCH v11 3/5] iio: adc: versal-sysmon: add I2C driver Salih Erim
2026-06-23  2:03   ` sashiko-bot
2026-06-23 11:33   ` Erim, Salih [this message]
2026-06-23  1:40 ` [PATCH v11 4/5] iio: adc: versal-sysmon: add threshold event support Salih Erim
2026-06-23  2:15   ` sashiko-bot
2026-06-23 11:36   ` Erim, Salih
2026-06-23  1:40 ` [PATCH v11 5/5] iio: adc: versal-sysmon: add oversampling support Salih Erim
2026-06-23  2:21   ` sashiko-bot
2026-06-23 11:37   ` Erim, Salih

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=bcbd202e-7d43-4f59-9ff3-59b564e4a3f4@amd.com \
    --to=salih.erim@amd.com \
    --cc=andriy.shevchenko@intel.com \
    --cc=andy@kernel.org \
    --cc=conall.ogriofa@amd.com \
    --cc=conor+dt@kernel.org \
    --cc=devicetree@vger.kernel.org \
    --cc=dlechner@baylibre.com \
    --cc=erimsalih@gmail.com \
    --cc=jic23@kernel.org \
    --cc=krzk+dt@kernel.org \
    --cc=linux-iio@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux@roeck-us.net \
    --cc=michal.simek@amd.com \
    --cc=nuno.sa@analog.com \
    --cc=robh@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox