Skip to content

Adjust language around what a device is#60

Merged
robherring merged 1 commit intodevicetree-org:mainfrom
sjg20:dev
Jan 18, 2023
Merged

Adjust language around what a device is#60
robherring merged 1 commit intodevicetree-org:mainfrom
sjg20:dev

Conversation

@sjg20
Copy link
Contributor

@sjg20 sjg20 commented Nov 18, 2022

The current definition is causing people to decide that only 'real' hardware devices should be in the device tree. Rewrite two paragraphs to adjust this.

Signed-off-by: Simon Glass sjg@chromium.org

@sjg20
Copy link
Contributor Author

sjg20 commented Jan 9, 2023

ping?

Copy link
Member

@robherring robherring left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel this is documenting the exceptions as the norm which is not something I think we should encourage.

probing.
A device in this context may be an actual hardware device, such as a UART. It
may be part of a hardware device, such as the random-number generator in a TPM.
It may also be a purely software concept, such as an bridge providing access to
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'purely software concept' is vague and leaves the door open to anything.

I am assuming what you mean here is interfaces implemented firmware which provide access to h/w? I'd prefer something like 'A device may include functions implemented by firmware running in higher privilege levels or remote processors'.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes that is a bit vague. See what you think of this version

may be part of a hardware device, such as the random-number generator in a TPM.
It may also be a purely software concept, such as an bridge providing access to
an I2C device attached to a remote CPU. There is no requirement that a node in
a device tree be a physical hardware device.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No requirement as there are some exceptions, but generally nodes have some correlation to physical h/w devices.

Bindings which are designed 1:1 nodes to $OS drivers are a constant headache. We can't design bindings which cater to just $OS's abstraction (at the current time).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK I tried with some different words

The current definition is causing people to decide that only 'real'
hardware devices should be in the device tree. Rewrite two paragraphs to
adjust this.

Signed-off-by: Simon Glass <sjg@chromium.org>
@robherring robherring merged commit 75b0399 into devicetree-org:main Jan 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants