All of lore.kernel.org
 help / color / mirror / Atom feed
From: Boris Brezillon <boris.brezillon@bootlin.com>
To: Rob Herring <robh@kernel.org>
Cc: Wolfram Sang <wsa@the-dreams.de>,
	Linux I2C <linux-i2c@vger.kernel.org>,
	Jonathan Corbet <corbet@lwn.net>,
	linux-doc@vger.kernel.org,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	Arnd Bergmann <arnd@arndb.de>,
	Przemyslaw Sroka <psroka@cadence.com>,
	Arkadiusz Golec <agolec@cadence.com>,
	Alan Douglas <adouglas@cadence.com>,
	Bartosz Folta <bfolta@cadence.com>, Damian Kos <dkos@cadence.com>,
	Alicja Jurasik-Urbaniak <alicja@cadence.com>,
	Cyprian Wronka <cwronka@cadence.com>,
	Suresh Punnoose <sureshp@cadence.com>,
	Rafal Ciepiela <rafalc@cadence.com>,
	Thomas Petazzoni <thomas.petazzoni@free-electrons.com>,
	Nishanth Menon <nm@ti.com>, Pawel Moll <pawel.moll@arm.com>,
	Mark Rutland <mark.rutland@arm.com>,
	Ian Campbell <ijc+devicetree@hellion.org.uk>,
	Kumar Gala <galak@codeaurora.org>,
	devicetree@vger.kernel.org,
	"linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
	Vitor Soares <Vitor.Soares@synopsys.com>,
	Geert Uytterhoeven <geert@linux-m68k.org>,
	Linus Walleij <linus.walleij@linaro.org>,
	Xiang Lin <Xiang.Lin@synaptics.com>,
	linux-gpio@vger.kernel.org,
	Boris Brezillon <boris.brezillon@free-electrons.com>
Subject: Re: [PATCH v3 05/11] dt-bindings: i3c: Document core bindings
Date: Wed, 28 Mar 2018 19:28:07 +0200	[thread overview]
Message-ID: <20180328192807.174b794d@bbrezillon> (raw)
In-Reply-To: <CAL_JsqKKf_Ob6AUvO5xgEFzSWakYDuPPzVKe4taoN1kzw3b1fQ@mail.gmail.com>

On Wed, 28 Mar 2018 11:42:07 -0500
Rob Herring <robh@kernel.org> wrote:


> >>  
> >> > +where device-type is describing the type of device connected on the bus
> >> > +(gpio-controller, sensor, ...).
> >> > +
> >> > +Required properties
> >> > +-------------------
> >> > +- reg: contains 3 cells
> >> > +  + first cell : encodes the I2C address. Should be 0 if the device does not
> >> > +            have one (0 is not a valid I3C address).  
> >>
> >> Change here to "encodes the static I2C address".
> >>
> >> 0 is not a valid I2C address?  
> >
> > According to [1] it is reserved, and it's reserved in the I3C spec
> > anyway (see "Table 9 I3C Slave Address Restrictions" in the I3C spec).  
> 
> Sorry, what I meant was s/I3C/I2C/. The first cell is I2C address and
> 0 is not valid.

Okay, got it now :-).
> 
> >> > +
> >> > +  + second and third cells: should encode the ProvisionalID. The second cell
> >> > +                       contains the manufacturer ID left-shifted by 1.
> >> > +                       The third cell contains ORing of the part ID
> >> > +                       left-shifted by 16, the instance ID left-shifted
> >> > +                       by 12 and the extra information. This encoding is
> >> > +                       following the PID definition provided by the I3C
> >> > +                       specification.  
> >
> > One extra question for you: should I refer to the I3C_DEV(),
> > I3C_DEV_WITH_STATIC_ADDR() and I2C_DEV() macros in the bindings doc?
> > And if I do, should I use them my example?  
> 
> Well, I don't want to see "device@I3C_DEV(...)" for unit-addresses.

That wouldn't work anyway.

> You can use them for reg property, but it's somewhat pointless to use
> it in one place and not the other.

Not sure I follow you. These macros have been added to ease definitions
of reg, but you'll still have to manually define the unit-address
manually. Are you saying I should not use them in dts files or just that
I should not mention it in the doc. If this is the former, then patch 6
should be dropped.

-- 
Boris Brezillon, Bootlin (formerly Free Electrons)
Embedded Linux and Kernel engineering
https://bootlin.com
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

WARNING: multiple messages have this Message-ID (diff)
From: Boris Brezillon <boris.brezillon@bootlin.com>
To: Rob Herring <robh@kernel.org>
Cc: Wolfram Sang <wsa@the-dreams.de>,
	Linux I2C <linux-i2c@vger.kernel.org>,
	Jonathan Corbet <corbet@lwn.net>,
	linux-doc@vger.kernel.org,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	Arnd Bergmann <arnd@arndb.de>,
	Przemyslaw Sroka <psroka@cadence.com>,
	Arkadiusz Golec <agolec@cadence.com>,
	Alan Douglas <adouglas@cadence.com>,
	Bartosz Folta <bfolta@cadence.com>, Damian Kos <dkos@cadence.com>,
	Alicja Jurasik-Urbaniak <alicja@cadence.com>,
	Cyprian Wronka <cwronka@cadence.com>,
	Suresh Punnoose <sureshp@cadence.com>,
	Rafal Ciepiela <rafalc@cadence.com>,
	Thomas Petazzoni <thomas.petazzoni@free-electrons.com>,
	Nishanth Menon <nm@ti.com>, Pawel Moll <pawel.moll@arm.com>,
	Mark Rutland <mark.rutland@arm.com>,
	Ian Campbell <ijc+devicetree@hellion.org.uk>
Subject: Re: [PATCH v3 05/11] dt-bindings: i3c: Document core bindings
Date: Wed, 28 Mar 2018 19:28:07 +0200	[thread overview]
Message-ID: <20180328192807.174b794d@bbrezillon> (raw)
In-Reply-To: <CAL_JsqKKf_Ob6AUvO5xgEFzSWakYDuPPzVKe4taoN1kzw3b1fQ@mail.gmail.com>

On Wed, 28 Mar 2018 11:42:07 -0500
Rob Herring <robh@kernel.org> wrote:


> >>  
> >> > +where device-type is describing the type of device connected on the bus
> >> > +(gpio-controller, sensor, ...).
> >> > +
> >> > +Required properties
> >> > +-------------------
> >> > +- reg: contains 3 cells
> >> > +  + first cell : encodes the I2C address. Should be 0 if the device does not
> >> > +            have one (0 is not a valid I3C address).  
> >>
> >> Change here to "encodes the static I2C address".
> >>
> >> 0 is not a valid I2C address?  
> >
> > According to [1] it is reserved, and it's reserved in the I3C spec
> > anyway (see "Table 9 I3C Slave Address Restrictions" in the I3C spec).  
> 
> Sorry, what I meant was s/I3C/I2C/. The first cell is I2C address and
> 0 is not valid.

Okay, got it now :-).
> 
> >> > +
> >> > +  + second and third cells: should encode the ProvisionalID. The second cell
> >> > +                       contains the manufacturer ID left-shifted by 1.
> >> > +                       The third cell contains ORing of the part ID
> >> > +                       left-shifted by 16, the instance ID left-shifted
> >> > +                       by 12 and the extra information. This encoding is
> >> > +                       following the PID definition provided by the I3C
> >> > +                       specification.  
> >
> > One extra question for you: should I refer to the I3C_DEV(),
> > I3C_DEV_WITH_STATIC_ADDR() and I2C_DEV() macros in the bindings doc?
> > And if I do, should I use them my example?  
> 
> Well, I don't want to see "device@I3C_DEV(...)" for unit-addresses.

That wouldn't work anyway.

> You can use them for reg property, but it's somewhat pointless to use
> it in one place and not the other.

Not sure I follow you. These macros have been added to ease definitions
of reg, but you'll still have to manually define the unit-address
manually. Are you saying I should not use them in dts files or just that
I should not mention it in the doc. If this is the former, then patch 6
should be dropped.

-- 
Boris Brezillon, Bootlin (formerly Free Electrons)
Embedded Linux and Kernel engineering
https://bootlin.com

WARNING: multiple messages have this Message-ID (diff)
From: Boris Brezillon <boris.brezillon@bootlin.com>
To: Rob Herring <robh@kernel.org>
Cc: Wolfram Sang <wsa@the-dreams.de>,
	Linux I2C <linux-i2c@vger.kernel.org>,
	Jonathan Corbet <corbet@lwn.net>,
	linux-doc@vger.kernel.org,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	Arnd Bergmann <arnd@arndb.de>,
	Przemyslaw Sroka <psroka@cadence.com>,
	Arkadiusz Golec <agolec@cadence.com>,
	Alan Douglas <adouglas@cadence.com>,
	Bartosz Folta <bfolta@cadence.com>, Damian Kos <dkos@cadence.com>,
	Alicja Jurasik-Urbaniak <alicja@cadence.com>,
	Cyprian Wronka <cwronka@cadence.com>,
	Suresh Punnoose <sureshp@cadence.com>,
	Rafal Ciepiela <rafalc@cadence.com>,
	Thomas Petazzoni <thomas.petazzoni@free-electrons.com>,
	Nishanth Menon <nm@ti.com>, Pawel Moll <pawel.moll@arm.com>,
	Mark Rutland <mark.rutland@arm.com>,
	Ian Campbell <ijc+devicetree@hellion.org.uk>,
	Kumar Gala <galak@codeaurora.org>,
	devicetree@vger.kernel.org,
	"linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
	Vitor Soares <Vitor.Soares@synopsys.com>,
	Geert Uytterhoeven <geert@linux-m68k.org>,
	Linus Walleij <linus.walleij@linaro.org>,
	Xiang Lin <Xiang.Lin@synaptics.com>,
	linux-gpio@vger.kernel.org,
	Boris Brezillon <boris.brezillon@free-electrons.com>
Subject: Re: [PATCH v3 05/11] dt-bindings: i3c: Document core bindings
Date: Wed, 28 Mar 2018 19:28:07 +0200	[thread overview]
Message-ID: <20180328192807.174b794d@bbrezillon> (raw)
In-Reply-To: <CAL_JsqKKf_Ob6AUvO5xgEFzSWakYDuPPzVKe4taoN1kzw3b1fQ@mail.gmail.com>

On Wed, 28 Mar 2018 11:42:07 -0500
Rob Herring <robh@kernel.org> wrote:


> >>  
> >> > +where device-type is describing the type of device connected on the bus
> >> > +(gpio-controller, sensor, ...).
> >> > +
> >> > +Required properties
> >> > +-------------------
> >> > +- reg: contains 3 cells
> >> > +  + first cell : encodes the I2C address. Should be 0 if the device does not
> >> > +            have one (0 is not a valid I3C address).  
> >>
> >> Change here to "encodes the static I2C address".
> >>
> >> 0 is not a valid I2C address?  
> >
> > According to [1] it is reserved, and it's reserved in the I3C spec
> > anyway (see "Table 9 I3C Slave Address Restrictions" in the I3C spec).  
> 
> Sorry, what I meant was s/I3C/I2C/. The first cell is I2C address and
> 0 is not valid.

Okay, got it now :-).
> 
> >> > +
> >> > +  + second and third cells: should encode the ProvisionalID. The second cell
> >> > +                       contains the manufacturer ID left-shifted by 1.
> >> > +                       The third cell contains ORing of the part ID
> >> > +                       left-shifted by 16, the instance ID left-shifted
> >> > +                       by 12 and the extra information. This encoding is
> >> > +                       following the PID definition provided by the I3C
> >> > +                       specification.  
> >
> > One extra question for you: should I refer to the I3C_DEV(),
> > I3C_DEV_WITH_STATIC_ADDR() and I2C_DEV() macros in the bindings doc?
> > And if I do, should I use them my example?  
> 
> Well, I don't want to see "device@I3C_DEV(...)" for unit-addresses.

That wouldn't work anyway.

> You can use them for reg property, but it's somewhat pointless to use
> it in one place and not the other.

Not sure I follow you. These macros have been added to ease definitions
of reg, but you'll still have to manually define the unit-address
manually. Are you saying I should not use them in dts files or just that
I should not mention it in the doc. If this is the former, then patch 6
should be dropped.

-- 
Boris Brezillon, Bootlin (formerly Free Electrons)
Embedded Linux and Kernel engineering
https://bootlin.com

  reply	other threads:[~2018-03-28 17:28 UTC|newest]

Thread overview: 99+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-03-23 11:00 [PATCH v3 00/11] Add the I3C subsystem Boris Brezillon
2018-03-23 11:00 ` Boris Brezillon
2018-03-23 11:00 ` Boris Brezillon
2018-03-23 11:00 ` [PATCH v3 01/11] i2c: Export of_i2c_get_board_info() Boris Brezillon
2018-03-23 11:00   ` Boris Brezillon
2018-03-23 11:00   ` Boris Brezillon
2018-03-24 22:35   ` Wolfram Sang
2018-03-24 22:35     ` Wolfram Sang
2018-03-24 22:38     ` Wolfram Sang
2018-03-24 22:38       ` Wolfram Sang
2018-03-25 10:21       ` Boris Brezillon
2018-03-25 10:21         ` Boris Brezillon
2018-03-25 10:21         ` Boris Brezillon
2018-03-25 10:19     ` Boris Brezillon
2018-03-25 10:19       ` Boris Brezillon
2018-03-25 10:19       ` Boris Brezillon
2018-03-23 11:00 ` [PATCH v3 02/11] i3c: Add core I3C infrastructure Boris Brezillon
2018-03-23 11:00   ` Boris Brezillon
2018-03-23 11:00 ` [PATCH v3 03/11] docs: driver-api: Add I3C documentation Boris Brezillon
2018-03-23 11:00   ` Boris Brezillon
2018-03-23 11:00   ` Boris Brezillon
2018-03-23 11:00 ` [PATCH v3 04/11] i3c: Add sysfs ABI spec Boris Brezillon
2018-03-23 11:00   ` Boris Brezillon
2018-03-23 11:00   ` Boris Brezillon
2018-03-23 11:00 ` [PATCH v3 05/11] dt-bindings: i3c: Document core bindings Boris Brezillon
2018-03-23 11:00   ` Boris Brezillon
2018-03-23 11:00   ` Boris Brezillon
2018-03-23 12:47   ` Peter Rosin
2018-03-23 12:47     ` Peter Rosin
2018-03-23 12:47     ` Peter Rosin
2018-03-23 13:58     ` Boris Brezillon
2018-03-23 13:58       ` Boris Brezillon
2018-03-23 13:58       ` Boris Brezillon
2018-03-26 10:22   ` Geert Uytterhoeven
2018-03-26 10:22     ` Geert Uytterhoeven
2018-03-26 10:22     ` Geert Uytterhoeven
2018-03-26 11:19     ` Boris Brezillon
2018-03-26 11:19       ` Boris Brezillon
2018-03-26 11:19       ` Boris Brezillon
2018-03-26 22:24   ` Rob Herring
2018-03-26 22:24     ` Rob Herring
2018-03-26 22:24     ` Rob Herring
2018-03-28  8:19     ` Boris Brezillon
2018-03-28  8:19       ` Boris Brezillon
2018-03-28  8:19       ` Boris Brezillon
2018-03-28 16:42       ` Rob Herring
2018-03-28 16:42         ` Rob Herring
2018-03-28 16:42         ` Rob Herring
2018-03-28 17:28         ` Boris Brezillon [this message]
2018-03-28 17:28           ` Boris Brezillon
2018-03-28 17:28           ` Boris Brezillon
2018-03-23 11:00 ` [PATCH v3 06/11] dt-bindings: i3c: Add macros to help fill I3C/I2C device's reg property Boris Brezillon
2018-03-23 11:00   ` Boris Brezillon
2018-03-23 11:00   ` Boris Brezillon
2018-03-26 22:25   ` Rob Herring
2018-03-26 22:25     ` Rob Herring
2018-03-26 22:25     ` Rob Herring
2018-03-23 11:00 ` [PATCH v3 07/11] MAINTAINERS: Add myself as the I3C subsystem maintainer Boris Brezillon
2018-03-23 11:00   ` Boris Brezillon
2018-03-23 11:00   ` Boris Brezillon
2018-03-23 11:00 ` [PATCH v3 08/11] i3c: master: Add driver for Cadence IP Boris Brezillon
2018-03-23 11:00   ` Boris Brezillon
2018-03-23 11:00   ` Boris Brezillon
2018-03-23 11:00 ` [PATCH v3 09/11] dt-bindings: i3c: Document Cadence I3C master bindings Boris Brezillon
2018-03-23 11:00   ` Boris Brezillon
2018-03-23 11:00   ` Boris Brezillon
2018-03-23 11:10   ` Thomas Petazzoni
2018-03-23 11:10     ` Thomas Petazzoni
2018-03-23 11:10     ` Thomas Petazzoni
2018-03-23 13:59     ` Boris Brezillon
2018-03-23 13:59       ` Boris Brezillon
2018-03-23 13:59       ` Boris Brezillon
2018-03-23 11:00 ` [PATCH v3 10/11] gpio: Add a driver for Cadence I3C GPIO expander Boris Brezillon
2018-03-23 11:00   ` Boris Brezillon
2018-03-23 11:00   ` Boris Brezillon
2018-03-23 11:00 ` [PATCH v3 11/11] dt-bindings: gpio: Add bindings for Cadence I3C gpio expander Boris Brezillon
2018-03-23 11:00   ` Boris Brezillon
2018-03-23 11:00   ` Boris Brezillon
2018-03-26 10:12   ` Geert Uytterhoeven
2018-03-26 10:12     ` Geert Uytterhoeven
2018-03-26 10:12     ` Geert Uytterhoeven
2018-03-26 11:25     ` Boris Brezillon
2018-03-26 11:25       ` Boris Brezillon
2018-03-26 11:25       ` Boris Brezillon
2018-03-26 11:35       ` Geert Uytterhoeven
2018-03-26 11:35         ` Geert Uytterhoeven
2018-03-26 11:35         ` Geert Uytterhoeven
2018-03-26 10:17   ` Geert Uytterhoeven
2018-03-26 10:17     ` Geert Uytterhoeven
2018-03-26 10:17     ` Geert Uytterhoeven
2018-03-26 11:21     ` Boris Brezillon
2018-03-26 11:21       ` Boris Brezillon
2018-03-26 11:21       ` Boris Brezillon
2018-03-26 22:25   ` Rob Herring
2018-03-26 22:25     ` Rob Herring
2018-03-26 22:25     ` Rob Herring
2018-03-23 11:03 ` [PATCH v3 00/11] Add the I3C subsystem Boris Brezillon
2018-03-23 11:03   ` Boris Brezillon
2018-03-23 11:03   ` Boris Brezillon

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=20180328192807.174b794d@bbrezillon \
    --to=boris.brezillon@bootlin.com \
    --cc=Vitor.Soares@synopsys.com \
    --cc=Xiang.Lin@synaptics.com \
    --cc=adouglas@cadence.com \
    --cc=agolec@cadence.com \
    --cc=alicja@cadence.com \
    --cc=arnd@arndb.de \
    --cc=bfolta@cadence.com \
    --cc=boris.brezillon@free-electrons.com \
    --cc=corbet@lwn.net \
    --cc=cwronka@cadence.com \
    --cc=devicetree@vger.kernel.org \
    --cc=dkos@cadence.com \
    --cc=galak@codeaurora.org \
    --cc=geert@linux-m68k.org \
    --cc=gregkh@linuxfoundation.org \
    --cc=ijc+devicetree@hellion.org.uk \
    --cc=linus.walleij@linaro.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-gpio@vger.kernel.org \
    --cc=linux-i2c@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mark.rutland@arm.com \
    --cc=nm@ti.com \
    --cc=pawel.moll@arm.com \
    --cc=psroka@cadence.com \
    --cc=rafalc@cadence.com \
    --cc=robh@kernel.org \
    --cc=sureshp@cadence.com \
    --cc=thomas.petazzoni@free-electrons.com \
    --cc=wsa@the-dreams.de \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.