Linux Documentation
 help / color / mirror / Atom feed
From: Jonathan Cameron <jic23@kernel.org>
To: Rodrigo Alencar <455.rodrigo.alencar@gmail.com>
Cc: rodrigo.alencar@analog.com, linux-iio@vger.kernel.org,
	devicetree@vger.kernel.org, linux-kernel@vger.kernel.org,
	linux-doc@vger.kernel.org, linux-hardening@vger.kernel.org,
	Lars-Peter Clausen <lars@metafoo.de>,
	Michael Hennerich <Michael.Hennerich@analog.com>,
	David Lechner <dlechner@baylibre.com>,
	Andy Shevchenko <andy@kernel.org>, Rob Herring <robh@kernel.org>,
	Krzysztof Kozlowski <krzk+dt@kernel.org>,
	Conor Dooley <conor+dt@kernel.org>,
	Philipp Zabel <p.zabel@pengutronix.de>,
	Jonathan Corbet <corbet@lwn.net>,
	Shuah Khan <skhan@linuxfoundation.org>,
	Kees Cook <kees@kernel.org>,
	"Gustavo A. R. Silva" <gustavoars@kernel.org>
Subject: Re: [PATCH v5 03/13] iio: core: add hierarchical channel relationships
Date: Fri, 22 May 2026 18:45:06 +0100	[thread overview]
Message-ID: <20260522184506.51690ac5@jic23-huawei> (raw)
In-Reply-To: <hjv4uuudhkueaotpyuzj3u3jg2rkr73jmrx2vxi37w3po5xk5x@3fhfebj6a3wt>

On Thu, 21 May 2026 14:48:30 +0100
Rodrigo Alencar <455.rodrigo.alencar@gmail.com> wrote:

> On 26/05/18 03:26PM, Rodrigo Alencar wrote:
> > On 26/05/17 06:56PM, sashiko-bot@kernel.org wrote:  
> > > Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
> > > - [Medium] Exposing the hierarchical relationship via channel labels creates an ambiguous UAPI for userspace.
> > > --
> > > 
> > > commit 64c6f961f1d7645c58f732e4bd4c11200b999e93
> > > Author: Rodrigo Alencar <rodrigo.alencar@analog.com>
> > > 
> > > iio: core: add hierarchical channel relationships
> > > 
> > > This commit introduces a parent-child relationship between IIO channels.
> > > It adds a parent pointer to the iio_chan_spec struct and exposes this
> > > relationship to userspace through a new "parent" sysfs attribute that
> > > returns the parent channel's label.
> > >   
> > > > diff --git a/drivers/iio/industrialio-core.c b/drivers/iio/industrialio-core.c
> > > > index 5c8404efd0a56..348ac7a597385 100644
> > > > --- a/drivers/iio/industrialio-core.c
> > > > +++ b/drivers/iio/industrialio-core.c  
> > > 
> > > [ ... ]
> > >   
> > > > @@ -1263,6 +1271,31 @@ static int iio_device_add_channel_label(struct iio_dev *indio_dev,
> > > >  	return 1;
> > > >  }
> > > >  
> > > > +static int iio_device_add_channel_parent(struct iio_dev *indio_dev,
> > > > +					 struct iio_chan_spec const *chan)
> > > > +{
> > > > +	struct iio_dev_opaque *iio_dev_opaque = to_iio_dev_opaque(indio_dev);
> > > > +	int ret;
> > > > +
> > > > +	if (!chan->parent || (!indio_dev->info->read_label &&
> > > > +			      !chan->parent->extend_name))
> > > > +		return 0;  
> > > 
> > > Is relying on channel labels robust enough for programmatic parent resolution?
> > > 
> > > IIO channel labels are optional, human-readable descriptors and are not
> > > guaranteed by the core to be unique. If multiple channels within a device
> > > share the same label, how can userspace definitively resolve which specific
> > > channel is the parent?
> > > 
> > > Also, if a driver establishes a hierarchy where chan->parent is set, but the
> > > parent channel lacks a label, this attribute is silently omitted, hiding the
> > > relationship entirely.
> > > 
> > > Would it be more reliable to expose a definitive, unique identifier (such as
> > > the parent channel's sysfs prefix or index) rather than relying on an optional
> > > descriptive string?  
> > 
> > A bit impressive that sashiko can comment on that architecture level.
> > 
> > Those are all good points. I suppose I went for this because otherwise it would
> > require refactoring core code to get the needed parts from __iio_device_attr_init()
> > that gets you the channel name without the attribute part.
> > 
> > Maybe we should have a function that outputs a channel name into a buffer based on
> > __iio_device_attr_init() behavior, and that could be reused.  
> 
> This is the function with behavior extracted from __iio_device_attr_init():
> 
> 	static int __iio_chan_prefix_emit(const struct iio_chan_spec *chan,
> 					  enum iio_shared_by shared_by,
> 					  char *buf, size_t len)
> 	{
> 		const char *dir = iio_direction[chan->output];
> 		const char *type = iio_chan_type_name_spec[chan->type];
> 		int n = 0;
> 
> 		switch (shared_by) {
> 		case IIO_SHARED_BY_ALL:
> 			break;
> 		case IIO_SHARED_BY_DIR:
> 			n = scnprintf(buf, len, "%s", dir);
> 			break;
> 		case IIO_SHARED_BY_TYPE:
> 			n = scnprintf(buf, len, "%s_%s", dir, type);
> 			if (chan->differential)
> 				n += scnprintf(buf + n, len - n, "-%s", type);
> 			break;
> 		case IIO_SEPARATE:
> 			if (chan->indexed) {
> 				n = scnprintf(buf, len, "%s_%s%d", dir, type,
> 					      chan->channel);
> 				if (chan->differential)
> 					n += scnprintf(buf + n, len - n, "-%s%d", type,
> 						       chan->channel2);
> 			} else {
> 				if (chan->differential) {
> 					WARN(1, "Differential channels must be indexed\n");
> 					return -EINVAL;
> 				}
> 				n = scnprintf(buf, len, "%s_%s", dir, type);
> 			}
> 
> 			if (chan->modified) {
> 				if (chan->differential) {
> 					WARN(1, "Differential channels can not have modifier\n");
> 					return -EINVAL;
> 				}
> 				n += scnprintf(buf + n, len - n, "_%s",
> 					       iio_modifier_names[chan->channel2]);
> 			}
> 
> 			if (chan->extend_name)
> 				n += scnprintf(buf + n, len - n, "_%s", chan->extend_name);
> 			break;
> 		}
> 
> 		return n;
> 	}
> 
> I think it is clear and reusable.

You only what the SEPARATE case but given the rest is much simpler anyway probably fine
to just use this function.

Jonathan



> 
> > > > +
> > > > +	ret = __iio_add_chan_devattr("parent",
> > > > +				     chan,
> > > > +				     &iio_read_channel_parent,
> > > > +				     NULL,
> > > > +				     0,
> > > > +				     IIO_SEPARATE,
> > > > +				     &indio_dev->dev,
> > > > +				     NULL,
> > > > +				     &iio_dev_opaque->channel_attr_list);
> > > > +	if (ret < 0)
> > > > +		return ret;
> > > > +
> > > > +	return 1;
> > > > +}  
> > > 
> > > -- 
> > > Sashiko AI review · https://sashiko.dev/#/patchset/20260517-ad9910-iio-driver-v5-0-31599c88314a@analog.com?part=3  
> 


  reply	other threads:[~2026-05-22 17:45 UTC|newest]

Thread overview: 31+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-05-17 18:37 [PATCH v5 00/13] AD9910 Direct Digital Synthesizer Rodrigo Alencar via B4 Relay
2026-05-17 18:37 ` [PATCH v5 01/13] iio: core: validate file offset in iio_debugfs_write_reg() Rodrigo Alencar via B4 Relay
2026-05-18 10:43   ` Rodrigo Alencar
2026-05-17 18:37 ` [PATCH v5 02/13] iio: core: support 64-bit register through debugfs Rodrigo Alencar via B4 Relay
2026-05-18 13:56   ` Rodrigo Alencar
2026-05-20 11:31     ` Jonathan Cameron
2026-05-17 18:37 ` [PATCH v5 03/13] iio: core: add hierarchical channel relationships Rodrigo Alencar via B4 Relay
2026-05-21 13:48   ` Rodrigo Alencar
2026-05-22 17:45     ` Jonathan Cameron [this message]
2026-05-17 18:37 ` [PATCH v5 04/13] Documentation: ABI: testing: add parent entry for iio channels Rodrigo Alencar via B4 Relay
2026-05-22 17:47   ` Jonathan Cameron
2026-05-17 18:37 ` [PATCH v5 05/13] dt-bindings: iio: frequency: add ad9910 Rodrigo Alencar via B4 Relay
2026-05-18  7:52   ` Krzysztof Kozlowski
2026-05-18 10:03     ` Rodrigo Alencar
2026-05-17 18:37 ` [PATCH v5 06/13] iio: frequency: ad9910: initial driver implementation Rodrigo Alencar via B4 Relay
2026-05-18 11:45   ` Rodrigo Alencar
2026-05-22 18:03   ` Jonathan Cameron
2026-05-17 18:37 ` [PATCH v5 07/13] iio: frequency: ad9910: add basic parallel port support Rodrigo Alencar via B4 Relay
2026-05-17 18:37 ` [PATCH v5 08/13] iio: frequency: ad9910: add digital ramp generator support Rodrigo Alencar via B4 Relay
2026-05-17 18:37 ` [PATCH v5 09/13] iio: frequency: ad9910: add RAM mode support Rodrigo Alencar via B4 Relay
2026-05-18 13:50   ` Rodrigo Alencar
2026-05-17 18:37 ` [PATCH v5 10/13] iio: frequency: ad9910: add output shift keying support Rodrigo Alencar via B4 Relay
2026-05-17 18:37 ` [PATCH v5 11/13] iio: frequency: ad9910: show channel priority in debugfs Rodrigo Alencar via B4 Relay
2026-05-22 18:07   ` Jonathan Cameron
2026-05-26 15:21     ` Rodrigo Alencar
2026-05-17 18:37 ` [PATCH v5 12/13] Documentation: ABI: testing: add docs for ad9910 sysfs entries Rodrigo Alencar via B4 Relay
2026-05-20 18:47   ` Rodrigo Alencar
2026-05-22 18:20     ` Jonathan Cameron
2026-05-26 17:08       ` Rodrigo Alencar
2026-05-26 10:07   ` Rodrigo Alencar
2026-05-17 18:37 ` [PATCH v5 13/13] docs: iio: add documentation for ad9910 driver Rodrigo Alencar via B4 Relay

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=20260522184506.51690ac5@jic23-huawei \
    --to=jic23@kernel.org \
    --cc=455.rodrigo.alencar@gmail.com \
    --cc=Michael.Hennerich@analog.com \
    --cc=andy@kernel.org \
    --cc=conor+dt@kernel.org \
    --cc=corbet@lwn.net \
    --cc=devicetree@vger.kernel.org \
    --cc=dlechner@baylibre.com \
    --cc=gustavoars@kernel.org \
    --cc=kees@kernel.org \
    --cc=krzk+dt@kernel.org \
    --cc=lars@metafoo.de \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-hardening@vger.kernel.org \
    --cc=linux-iio@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=p.zabel@pengutronix.de \
    --cc=robh@kernel.org \
    --cc=rodrigo.alencar@analog.com \
    --cc=skhan@linuxfoundation.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