Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

i2c: Update terminology to match i2c spec #43166

Merged
merged 3 commits into from
Jun 29, 2022

Conversation

teburd
Copy link
Collaborator

@teburd teburd commented Feb 24, 2022

Updates the terms from master to controller, and slave to target
along with all APIs and usage of those APIs.

The new terminology matches well with our coding guidelines of inclusive
language.

This does not rename internal terminology used in each driver but all
public facing APIs, types, and macros use the new terms.

Fixes #27033

@teburd teburd force-pushed the i2c_terminology branch 6 times, most recently from dfbab3b to f132ecd Compare February 24, 2022 22:11
@stephanosio stephanosio added area: API Changes to public APIs Breaking API Change Breaking changes to stable, public APIs labels Mar 1, 2022
@github-actions
Copy link

github-actions bot commented May 2, 2022

This pull request has been marked as stale because it has been open (more than) 60 days with no activity. Remove the stale label or add a comment saying that you would like to have the label removed otherwise this pull request will automatically be closed in 14 days. Note, that you can always re-open a closed pull request at any time.

@github-actions github-actions bot added the Stale label May 2, 2022
@teburd teburd removed the Stale label May 2, 2022
@github-actions github-actions bot added the area: Tests Issues related to a particular existing or missing test label May 23, 2022
@teburd teburd force-pushed the i2c_terminology branch 9 times, most recently from ca024e7 to 7cdfa65 Compare May 24, 2022 13:33
@teburd teburd marked this pull request as ready for review May 24, 2022 16:13
@teburd teburd requested a review from nashif as a code owner May 24, 2022 16:13
@henrikbrixandersen henrikbrixandersen requested review from dcpleung and removed request for mmahadevan108 June 21, 2022 11:31
Copy link
Member

@MaureenHelm MaureenHelm left a comment

Choose a reason for hiding this comment

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

Needs rebase.

A couple of nits, but otherwise looks great.

drivers/i2c/Kconfig.stm32 Outdated Show resolved Hide resolved
include/zephyr/drivers/i2c.h Outdated Show resolved Hide resolved
doc/develop/api/overview.rst Show resolved Hide resolved
gmarull
gmarull previously approved these changes Jun 28, 2022
The i2c terminology has been updated as such master is now controller,
and slave is now target. Updates all doc comments and doc pages to use
updated terminology. Does not change types or API definitions.

Signed-off-by: Tom Burdick <[email protected]>
@teburd
Copy link
Collaborator Author

teburd commented Jun 28, 2022

@MaureenHelm marking the 10bit flag with __DEPRECATED_MACRO has caused additional CI failures, reverting as its been marked deprecated for awhile without the __DEPRECATED_MACRO, and is unrelated to the terminology change.

I can create another PR that addresses that

@teburd teburd force-pushed the i2c_terminology branch 2 times, most recently from b768483 to 1d6938d Compare June 28, 2022 15:34
Updates the API and types to match updated I2C terminology. Replaces master
with controller and slave with target.

Updates all drivers to match the changed macros, types, and API signatures.

Signed-off-by: Tom Burdick <[email protected]>
Updates the API overview page describing that the i2c API has been modified
for 3.2.

Signed-off-by: Tom Burdick <[email protected]>
@cfriedt
Copy link
Member

cfriedt commented Jun 28, 2022

@teburd - looks good, just missing one copyright notice.

@teburd
Copy link
Collaborator Author

teburd commented Jun 29, 2022

@cfriedt that was missing before

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: API Changes to public APIs area: Documentation area: I2C area: Tests Issues related to a particular existing or missing test Breaking API Change Breaking changes to stable, public APIs platform: NXP NXP platform: Silabs Silicon Labs platform: STM32 ST Micro STM32
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update terminology related to I2C
9 participants