| Message ID | 20210407185039.621248-2-varmam@google.com |
|---|---|
| State | New |
| Headers | show |
| Series | Override device name using DT "dev-name" property | expand |
On Wed, Apr 07, 2021 at 11:50:38AM -0700, Manish Varma wrote: > I2C devices currently are named dynamically using > <adapter_id>-<device_address> convention, unless they are instantiated > through ACPI. > > This means the device name may vary for the same device across different > systems, infact even on the same system if the I2C bus enumeration order > changes, i.e. because of device tree modifications. > > By adding an optional "dev-name" property, it provides a mechanism to > set consistent and easy to recognize names for I2C devices. So? Why do you need 'easy to recognize names'? Why is I2C special? If we wanted this in DT, it wouldn't be I2C specific and we probably would have added it long ago. > Signed-off-by: Manish Varma <varmam@google.com> > --- > Documentation/devicetree/bindings/i2c/i2c.txt | 5 +++++ > 1 file changed, 5 insertions(+) > > diff --git a/Documentation/devicetree/bindings/i2c/i2c.txt b/Documentation/devicetree/bindings/i2c/i2c.txt > index df41f72afc87..6fb03f464b81 100644 > --- a/Documentation/devicetree/bindings/i2c/i2c.txt > +++ b/Documentation/devicetree/bindings/i2c/i2c.txt > @@ -130,6 +130,11 @@ wants to support one of the below features, it should adapt these bindings. > - wakeup-source > device can be used as a wakeup source. > > +- dev-name > + Name of the device. > + Overrides the default device name which is in the form of > + <busnr>-<addr>. What's 'busnr'? No such thing in DT. > + > Binding may contain optional "interrupts" property, describing interrupts > used by the device. I2C core will assign "irq" interrupt (or the very first > interrupt if not using interrupt names) as primary interrupt for the slave. > -- > 2.31.1.295.g9ea45b61b8-goog >
Hi Rob, Thanks for the inputs. On Fri, Apr 9, 2021 at 11:34 AM Rob Herring <robh@kernel.org> wrote: > > On Wed, Apr 07, 2021 at 11:50:38AM -0700, Manish Varma wrote: > > I2C devices currently are named dynamically using > > <adapter_id>-<device_address> convention, unless they are instantiated > > through ACPI. > > > > This means the device name may vary for the same device across different > > systems, infact even on the same system if the I2C bus enumeration order > > changes, i.e. because of device tree modifications. > > > > By adding an optional "dev-name" property, it provides a mechanism to > > set consistent and easy to recognize names for I2C devices. > > So? Why do you need 'easy to recognize names'? > From the cover letter: "Currently I2C device names are assigned dynamically unless they are instantiated through ACPI, this names are based on adapter_id and device_address. While device_address will remain constant for a given device, the adapter_id may vary across different systems and hence, overall, the device name won't be unique for the same I2C device." Basically, the motivation here is to provide a mechanism to allow overriding those names to easy to recognize names (e.g. <vendor_name_dev_name> or <device part number> which leaves more information compared to just device name in the form of numbers such as "2-001f"). These (device) names are further used by different module e.g. system wakeup events framework, and hence this presents difficulties debug/identify issues at various levels in the software stack. So, the idea was to address it at the lowest level possible. > Why is I2C special? If we wanted this in DT, it wouldn't be I2C specific > and we probably would have added it long ago. > "Unlike PCI or USB devices, I2C devices are not enumerated at the hardware level. Instead, the software must know which devices are connected on each I2C bus segment, and what address these devices are using. For this reason, the kernel code must instantiate I2C devices explicitly." Reference: https://www.kernel.org/doc/Documentation/i2c/instantiating-devices There are various ways to instantiate I2C devices e.g. through board_info interface, ACPI and device tree etc. While board_info and ACPI both allow specifying device name, I find no such provision to assign device names for the I2C devices instantiated through device tree interface. > > Signed-off-by: Manish Varma <varmam@google.com> > > --- > > Documentation/devicetree/bindings/i2c/i2c.txt | 5 +++++ > > 1 file changed, 5 insertions(+) > > > > diff --git a/Documentation/devicetree/bindings/i2c/i2c.txt b/Documentation/devicetree/bindings/i2c/i2c.txt > > index df41f72afc87..6fb03f464b81 100644 > > --- a/Documentation/devicetree/bindings/i2c/i2c.txt > > +++ b/Documentation/devicetree/bindings/i2c/i2c.txt > > @@ -130,6 +130,11 @@ wants to support one of the below features, it should adapt these bindings. > > - wakeup-source > > device can be used as a wakeup source. > > > > +- dev-name > > + Name of the device. > > + Overrides the default device name which is in the form of > > + <busnr>-<addr>. > > What's 'busnr'? No such thing in DT. > Right! dev-name introduced to hold the string value for overriding device names assigned by the kernel. Currently, kernel assigns the device name in the form of <busnr>-<addr>. Reference: https://www.kernel.org/doc/html/latest/driver-api/i2c.html?highlight=i2c_board_info#c.i2c_board_info > > + > > Binding may contain optional "interrupts" property, describing interrupts > > used by the device. I2C core will assign "irq" interrupt (or the very first > > interrupt if not using interrupt names) as primary interrupt for the slave. > > -- > > 2.31.1.295.g9ea45b61b8-goog > > Hope the explanation provided above answers your questions. Thanks, Manish
diff --git a/Documentation/devicetree/bindings/i2c/i2c.txt b/Documentation/devicetree/bindings/i2c/i2c.txt index df41f72afc87..6fb03f464b81 100644 --- a/Documentation/devicetree/bindings/i2c/i2c.txt +++ b/Documentation/devicetree/bindings/i2c/i2c.txt @@ -130,6 +130,11 @@ wants to support one of the below features, it should adapt these bindings. - wakeup-source device can be used as a wakeup source. +- dev-name + Name of the device. + Overrides the default device name which is in the form of + <busnr>-<addr>. + Binding may contain optional "interrupts" property, describing interrupts used by the device. I2C core will assign "irq" interrupt (or the very first interrupt if not using interrupt names) as primary interrupt for the slave.
I2C devices currently are named dynamically using <adapter_id>-<device_address> convention, unless they are instantiated through ACPI. This means the device name may vary for the same device across different systems, infact even on the same system if the I2C bus enumeration order changes, i.e. because of device tree modifications. By adding an optional "dev-name" property, it provides a mechanism to set consistent and easy to recognize names for I2C devices. Signed-off-by: Manish Varma <varmam@google.com> --- Documentation/devicetree/bindings/i2c/i2c.txt | 5 +++++ 1 file changed, 5 insertions(+)