From: Wolfram Sang <wsa+renesas@sang-engineering.com>
To: linux-renesas-soc@vger.kernel.org
Cc: linux-i2c@vger.kernel.org, devicetree-spec@vger.kernel.org,
Wolfram Sang <wsa+renesas@sang-engineering.com>
Subject: [PATCH v2 dt-schema 1/3] schemas: i2c: reword descriptions for inclusive language
Date: Thu, 15 Aug 2024 23:40:11 +0200 [thread overview]
Message-ID: <20240815214013.6519-2-wsa+renesas@sang-engineering.com> (raw)
In-Reply-To: <20240815214013.6519-1-wsa+renesas@sang-engineering.com>
Changing bindings is hard, changing descriptions is easy. Let's start
with the low-hanging fruits and use the official I2C terminology (as of
specs v7) in the descriptions. Drop a superfluous 'a' from the
description of 'reg' for targets.
Signed-off-by: Wolfram Sang <wsa+renesas@sang-engineering.com>
---
dtschema/schemas/i2c/i2c-controller.yaml | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/dtschema/schemas/i2c/i2c-controller.yaml b/dtschema/schemas/i2c/i2c-controller.yaml
index 9670082..e475ead 100644
--- a/dtschema/schemas/i2c/i2c-controller.yaml
+++ b/dtschema/schemas/i2c/i2c-controller.yaml
@@ -99,7 +99,7 @@ properties:
multi-master:
type: boolean
description:
- States that there is another master active on this bus. The OS can use
+ States that there is another controller active on this bus. The OS can use
this information to adapt power management to keep the arbitration awake
all the time, for example. Can not be combined with 'single-master'.
@@ -116,9 +116,9 @@ properties:
single-master:
type: boolean
description:
- States that there is no other master active on this bus. The OS can use
- this information to detect a stalled bus more reliably, for example. Can
- not be combined with 'multi-master'.
+ States that there is no other controller active on this bus. The OS can
+ use this information to detect a stalled bus more reliably, for example.
+ Can not be combined with 'multi-master'.
smbus:
type: boolean
@@ -155,7 +155,7 @@ patternProperties:
- minimum: 0xc0000000
maximum: 0xc00003ff
description: |
- One or many I2C slave addresses. These are usually a 7 bit addresses.
+ One or many I2C target addresses. These are usually 7 bit addresses.
However, flags can be attached to an address. I2C_TEN_BIT_ADDRESS is
used to mark a 10 bit address. It is needed to avoid the ambiguity
between e.g. a 7 bit address of 0x50 and a 10 bit address of 0x050
@@ -172,7 +172,7 @@ patternProperties:
interrupts:
description:
I2C core will treat "irq" interrupt (or the very first interrupt if
- not using interrupt names) as primary interrupt for the slave.
+ not using interrupt names) as primary interrupt for the target.
interrupt-names:
anyOf:
--
2.43.0
next prev parent reply other threads:[~2024-08-15 21:40 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-08-15 21:40 [PATCH v2 dt-schema 0/3] schemas: i2c: fix "smbus_alert" handling Wolfram Sang
2024-08-15 21:40 ` Wolfram Sang [this message]
2024-08-15 21:40 ` [PATCH v2 dt-schema 2/3] schemas: i2c: clean up interrupt descriptions for I2C targets Wolfram Sang
2024-08-15 21:40 ` [PATCH v2 dt-schema 3/3] schemas: i2c: add generic interrupt name for I2C controllers Wolfram Sang
2024-08-15 22:48 ` [PATCH v2 dt-schema 0/3] schemas: i2c: fix "smbus_alert" handling Rob Herring
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=20240815214013.6519-2-wsa+renesas@sang-engineering.com \
--to=wsa+renesas@sang-engineering.com \
--cc=devicetree-spec@vger.kernel.org \
--cc=linux-i2c@vger.kernel.org \
--cc=linux-renesas-soc@vger.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;
as well as URLs for NNTP newsgroup(s).