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

drivers: spi: mark old spi_cs_control fields deprecated #39338

Merged
merged 1 commit into from Apr 22, 2022

Conversation

bbilas
Copy link
Collaborator

@bbilas bbilas commented Oct 11, 2021

Since gpio_dt_spec is finally available in the spi_cs_control struct, mark the old fields deprecated in order to use the gpio_dt_spec struct.

Depends on #37498 and #39341

Signed-off-by: Jordan Yates jordan.yates@data61.csiro.au
Co-authored-by: Jordan Yates jordan.yates@data61.csiro.au
Signed-off-by: Bartosz Bilas bartosz.bilas@hotmail.com
Co-authored-by: Bartosz Bilas bartosz.bilas@hotmail.com

@github-actions github-actions bot added the area: API Changes to public APIs label Oct 11, 2021
@zephyrbot zephyrbot added the area: SPI SPI bus label Oct 12, 2021
@henrikbrixandersen henrikbrixandersen added the Breaking API Change Breaking changes to stable, public APIs label Nov 2, 2021
@henrikbrixandersen
Copy link
Member

This is a stable API change.

@carlescufi
Copy link
Member

This is a stable API change.

I am not sure I get this. We are deprecating structures, how is that a stable API change? By definition we call a Stable API change one that does not follow the standard deprecation process.

@henrikbrixandersen
Copy link
Member

I am not sure I get this. We are deprecating structures, how is that a stable API change? By definition we call a Stable API change one that does not follow the standard deprecation process.

Exactly my point. This change needs to follow the process for changing a stable API as described here: https://docs.zephyrproject.org/latest/reference/api/api_lifecycle.html#introducing-incompatible-changes

Copy link
Member

@henrikbrixandersen henrikbrixandersen left a comment

Choose a reason for hiding this comment

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

Blocking pending the process for changing a stable API has been met.

@carlescufi
Copy link
Member

carlescufi commented Nov 3, 2021

I am not sure I get this. We are deprecating structures, how is that a stable API change? By definition we call a Stable API change one that does not follow the standard deprecation process.

Exactly my point. This change needs to follow the process for changing a stable API as described here: https://docs.zephyrproject.org/latest/reference/api/api_lifecycle.html#introducing-incompatible-changes

@henrikbrixandersen maybe there is some confusion here :)
The section you linked to was introduced for the cases where one does not want to use deprecation. If you use deprecation then there's no need to follow that guide, which was designed for the cases that require skipping deprecation due to complexity.

@carlescufi carlescufi closed this Nov 3, 2021
@carlescufi carlescufi reopened this Nov 3, 2021
@carlescufi
Copy link
Member

Apologies for closing this, I clicked on it by mistake.

@henrikbrixandersen
Copy link
Member

@henrikbrixandersen maybe there is some confusion here :) The section you linked to was introduced for the cases where one does not want to use deprecation. If you use deprecation then there's no need to follow that guide, which was designed for the cases that require skipping deprecation due to complexity.

Sorry, meant to link to https://docs.zephyrproject.org/latest/reference/api/api_lifecycle.html#deprecated.

@bbilas
Copy link
Collaborator Author

bbilas commented Nov 6, 2021

FYI: that's not a ready MR since there is a couple of places where the old spi_cs_control members are being used but I'm periodically rebasing it and checking the buildkite results. I think DNM label should be set here...

@github-actions github-actions bot added the Release Notes To be mentioned in the release notes label Apr 19, 2022
@bbilas
Copy link
Collaborator Author

bbilas commented Apr 19, 2022

cc @carlescufi @henrikbrixandersen issue #44956 created

@bbilas
Copy link
Collaborator Author

bbilas commented Apr 20, 2022

In the meantime, someone has committed a new code where the deprecated members are being used... I will try to fix that soon.

@bbilas
Copy link
Collaborator Author

bbilas commented Apr 20, 2022

@carlescufi @henrikbrixandersen hotfix #44968 ;)

Since gpio_dt_spec is finally available within spi_cs_control
struct, mark the old fields deprecated in order to use
gpio_dt_spec struct.

Signed-off-by: Jordan Yates <jordan.yates@data61.csiro.au>
Co-authored-by: Jordan Yates <jordan.yates@data61.csiro.au>
Signed-off-by: Bartosz Bilas <bartosz.bilas@hotmail.com>
Co-authored-by: Bartosz Bilas <bartosz.bilas@hotmail.com>
@carlescufi carlescufi merged commit 536fe6a into zephyrproject-rtos:main Apr 22, 2022
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: SPI SPI bus Breaking API Change Breaking changes to stable, public APIs Release Notes To be mentioned in the release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants