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: interrupt_controller: changes in shared irq #66427

Merged
merged 2 commits into from
Jan 31, 2024

Conversation

nbalabak
Copy link
Contributor

@nbalabak nbalabak commented Dec 12, 2023

Updated the shared IRQ handler function in the shared interrupt controller drivers to include support for the 'irq_number' parameter. When a single driver manages multiple shared IRQs, it becomes challenging to determine which IRQ line is invoking the handler. Therefore, I've introduced an option to share the IRQ number to address this issue.

Signed-off-by: Navinkumar Balabakthan navinkumar.balabakthan@intel.com

@nbalabak
Copy link
Contributor Author

@dcpleung @nashif Could you review this PR and provice your feedback?

@dcpleung
Copy link
Member

Hm... this is going to be affecting everyone using this. Could you send out an email on the Zephyr dev mailing list to inform the community about the change? (to give them a heads up)

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.

Looks good. Please add an entry in the migration guide for v3.6.0 detailing the needed changes to downstream code using this API.

@nbalabak
Copy link
Contributor Author

Looks good. Please add an entry in the migration guide for v3.6.0 detailing the needed changes to downstream code using this API.

Hello @henrikbrixandersen
i raised one issue for this changes. is it fine or need to provide some other way to add entry?
#66613

@nbalabak
Copy link
Contributor Author

Hm... this is going to be affecting everyone using this. Could you send out an email on the Zephyr dev mailing list to inform the community about the change? (to give them a heads up)

@dcpleung i sent email to Zephyr dev mailing list and inforamed about changes.

@henrikbrixandersen
Copy link
Member

I raised one issue for this changes. is it fine or need to provide some other way to add entry?

#66613

You need to include the migration guide changes in this PR.

@nbalabak
Copy link
Contributor Author

nbalabak commented Jan 5, 2024

I raised one issue for this changes. is it fine or need to provide some other way to add entry?
#66613

You need to include the migration guide changes in this PR.

Hello henrik,
could you help how to do "include the migration guide changes" ?
is about explain api changes?

@henrikbrixandersen
Copy link
Member

could you help how to do "include the migration guide changes" ?
is about explain api changes?

Yes, please add a description of the API change that may require end-users to update their out-of-tree code to this file: https://github.com/zephyrproject-rtos/zephyr/blob/main/doc/releases/migration-guide-3.6.rst

There are a few examples there already.

@zephyrbot zephyrbot added the Release Notes To be mentioned in the release notes label Jan 5, 2024
@nbalabak
Copy link
Contributor Author

nbalabak commented Jan 5, 2024

Hello henrik,
i updated mirgration guide could you review ?

@nbalabak
Copy link
Contributor Author

nbalabak commented Jan 9, 2024

Hello henrik,
i updated mirgration guide could you review ?

Hello @henrikbrixandersen could you please review changes

@nbalabak
Copy link
Contributor Author

nbalabak commented Jan 9, 2024

@MaureenHelm Could you please review this PR?

@henrikbrixandersen
Copy link
Member

@nbalabak Please be patient. We will get to it. If in doubt, please see the contributor expectations (particularly the section on review escalation) here: https://docs.zephyrproject.org/latest/contribute/contributor_expectations.html#pr-review-escalation

@nbalabak
Copy link
Contributor Author

nbalabak commented Jan 9, 2024

@nbalabak Please be patient. We will get to it. If in doubt, please see the contributor expectations (particularly the section on review escalation) here: https://docs.zephyrproject.org/latest/contribute/contributor_expectations.html#pr-review-escalation

sure Thank you @henrikbrixandersen.

Comment on lines 162 to 164
* Interrupt_controller shared_irq public API function :c:func:`shared_irq_isr_register()`
has changed. The parameter ``isr_func`` function pointer's parameter has modified.
An addition irq_number parameter added to ``isr_func`` function pointer.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
* Interrupt_controller shared_irq public API function :c:func:`shared_irq_isr_register()`
has changed. The parameter ``isr_func`` function pointer's parameter has modified.
An addition irq_number parameter added to ``isr_func`` function pointer.
* The function signature of the ``isr_t`` callback function passed to the ``shared_irq`` interrupt controller driver API via :c:func:`shared_irq_isr_register()` has changed. The callback now takes an additional `irq_number` parameter. Out-of-tree users of this API will need to be updated.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@henrikbrixandersen updated file as per your suggestion.

Updated the shared IRQ handler function in the shared interrupt controller
drivers to include support for the 'irq_number' parameter. When a single
driver manages multiple shared IRQs, it becomes challenging to determine
which IRQ line is invoking the handler. Therefore, I've introduced an
option to share the IRQ number to address this issue.

Signed-off-by: Navinkumar Balabakthan <navinkumar.balabakthan@intel.com>
shared_irq api changes updated in migration-guide-3.6.

Signed-off-by: Navinkumar Balabakthan <navinkumar.balabakthan@intel.com>
@dleach02 dleach02 merged commit 253003d into zephyrproject-rtos:main Jan 31, 2024
19 checks passed
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: Interrupt Controller 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