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

RFC: API Change: clock_control #22424

Closed
nordic-krch opened this issue Feb 3, 2020 · 1 comment · Fixed by #22425
Closed

RFC: API Change: clock_control #22424

nordic-krch opened this issue Feb 3, 2020 · 1 comment · Fixed by #22425
Labels
area: Clock Control Breaking API Change Breaking changes to stable, public APIs Release Notes To be mentioned in the release notes RFC Request For Comments: want input from the community

Comments

@nordic-krch
Copy link
Contributor

Problem description

Clock control API has clock_control_async_on() call which starts clock asynchronously and results in callback being called on clock being started. clock_control_async_on() call has as one of the argumentsclock_control_subsys_t sys which is an opaque data representing clock subsystem. Currently, callback function prototype is missing that argument:

typedef void (*clock_control_cb_t)(struct device *dev, void *user_data);

Proposed change

Add clock_control_subsys_t sys to callback arguments.

typedef void (*clock_control_cb_t)(struct device *dev,
                                   clock_control_subsys_t sys, void *user_data);

Impact

Clock control is mainly used internally by other drivers or modules. clock_control_async_on() and clock_control_cb_t is only used in nordic clock control driver (nrf_power_clock.c) so scope of change is limited.

@nordic-krch nordic-krch added RFC Request For Comments: want input from the community area: Clock Control Release Notes To be mentioned in the release notes Breaking API Change Breaking changes to stable, public APIs labels Feb 3, 2020
@carlescufi
Copy link
Member

Only nRF platforms implement the async version of clock control, so this is very low risk

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: Clock Control Breaking API Change Breaking changes to stable, public APIs Release Notes To be mentioned in the release notes RFC Request For Comments: want input from the community
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants