[RFC] drivers: mpsl: clock_control: Provide nrfx_clock shim #2861

nordic-krch · 2020-09-08T09:31:10Z

It seems that latest changes in clock_control and port to clock_control_mpsl created some issues (zephyrproject-rtos/zephyr#28068) and there is another updates in clock control that will come in next upmerge (clock_control using nrfx_clock). It seems like it is simpler to add shim which implements nrfx_clock api using mpsl_clock API and use clock_control directly from zephyr. Here is a first try to do that. As you can see shim is relatively small (nrfx_clock_mpsl.c) some tricks had to be applied to handle interrupt handler which is common for power and clock.

Please let me know what do you think about it.

There is a pr to zephyr nrfconnect/sdk-zephyr#351 which takes zephyr latest changes in clock control driver and adds small kconfig commit (nrfconnect/sdk-zephyr@e9377cf). If we go this approach then i will try to add this commit to upstream.

Zephyr clock control has more changes in pipeline that will need to be addressed here in the future:

waiting for system (LF) clock stabilization nRF: Add system clock stability policy zephyrproject-rtos/zephyr#27398
nrf53 192m clock drivers: clock_control: nrf: Add support for clk192m zephyrproject-rtos/zephyr#28056

rugeGerritsen · 2020-09-08T09:48:02Z

drivers/mpsl/clock_control/CMakeLists.txt

-zephyr_library_sources(clock_control_mpsl.c)
+zephyr_library_sources(nrfx_clock_mpsl.c)
+
+target_include_directories(zephyr_interface BEFORE INTERFACE


It seems unnecessary to add this folder as an include folder

that's the trick i mentioned. I do not set CONFIG_NRFX_CLOCK to not fetch nrfx_clock.c but there is a header nrfx_power_clock.h which handles interrupt handler depending on nrfx_power and nrfx_clock being enabled. I had to replace nrfx version with custom one placed in that folder. It's @anangl area so maybe he will have some better proposal.

This is something to use with extreme care.
Used once, then people will start copying, and suddenly every module expects to have their includes first.

Example of an area where this is can be accepted use is in (unit) test-code, where a certain path should come first to avoid the need for specific test headers/code in production code.

Let's keep for now, and stabilize upmerge, and then i'll look at cleaning up.

rugeGerritsen · 2020-09-08T09:50:07Z

Thanks! It looks like this improves the maintainability a lot

anangl · 2020-09-08T11:20:44Z

drivers/mpsl/clock_control/nrfx_power_clock.h

+#ifndef MPSL_CLOCK_CONTROL_NRFX_POWER_CLOCK_H__
+#define MPSL_CLOCK_CONTROL_NRFX_POWER_CLOCK_H__
+
+BUILD_ASSERT(NRFX_CLOCK_ENABLED == 0,"Expected disabled nrfx_clock");


Maybe even simpler:

#if (NRFX_CLOCK_ENABLED != 0) #error "Expected disabled nrfx_clock." #endif

anangl

I like the approach proposed in this PR. It can save us quite some maintenance trouble.

anangl · 2020-09-08T11:28:45Z

drivers/mpsl/clock_control/nrfx_clock_mpsl.c

+#include <drivers/clock_control/nrf_clock_control.h>
+#include <nrfx_power.h>


No longer needed.

This is a temporary fix in order to support MPSL in NCS. This fix must be reverted when nrfconnect/sdk-nrf#2861 is merged. Signed-off-by: Torsten Rasmussen <[email protected]> (cherry picked from commit a649ecaf652cfdf9d2868d4700c5fd2cd344eca4)

doki-nordic · 2020-09-24T06:25:07Z

Hi, I removed myself from reviewers list, but github somehow also removed other people: @junqingzou, @ryanjh, @rlubos, @lmaciejonczyk, @jhn-nordic, @KAGA164, @simensrostad, @lats1980, @mariuszpos, @maciekfabia @MarekPorwisz. Github does not allow me to add them back probably because there are too many reviewers.

@nordic-krch can you check this.

- nrf_security: update mbedtls heap to const struct device Zephyr upmerge introduces device bindings const struct as part of: zephyrproject-rtos/zephyr#24873 This const'ify mbedtls_heap.c init function. - mpls: Added `select MULTITHREADING_LOCK` to Kconfig With the changes related to: nrfconnect/sdk-nrf#2861 zephyrproject-rtos/zephyr#27398 The mpsl clock control is no longer needed, but mpsl still requires MULTITHREADING_LOCK, and is therefore moved to its right location. Signed-off-by: Torsten Rasmussen <[email protected]>

- nrf_security: update mbedtls heap to const struct device Zephyr upmerge introduces device bindings const struct as part of: zephyrproject-rtos/zephyr#24873 This const'ify mbedtls_heap.c init function. - mpls: Added `select MULTITHREADING_LOCK` to Kconfig With the changes related to: nrfconnect/sdk-nrf#2861 zephyrproject-rtos/zephyr#27398 The mpsl clock control is no longer needed, but mpsl still requires MULTITHREADING_LOCK, and is therefore moved to its right location. - softdevice_controller: Mark 2M and Coded PHY as supported These helper configs were introduced in upstream zephyr. Signed-off-by: Torsten Rasmussen <[email protected]> Signed-off-by: Rubin Gerritsen <[email protected]>

sdk-zephyr: pull/354/head sdk-mcuboot: pull/120/head sdk-mcumgr: pull/10/head sdk-nrfxlib: pull/266/head Summary of changes needed for this upmerge: - modules: device: Const-ify all device driver instance pointers. See also ttps://github.com/zephyrproject-rtos/zephyr/pull/24873 - jenkins: remove --board-root zephyr/boards zephyr/boards are always part of sanity-check and with duplicate board checking with: zephyrproject-rtos/zephyr#27549 this now results in CI failures. - samples: whitelist -> allow sanitycheck: inclusive language change whitelist -> allow for all sample.yaml and testcase.yaml files - scripts: ncs_commands: add hal_quicklogic to _BLOCKED_PROJECTS This is a vendor HAL for an SoC family not supported in NCS. - doc: upmerge changes to docs Adjusted `CONFIG_BT_GATT_DIS` -> `CONFIG_BT_DIS` in docs. - samples: remove GATT infix in conf files for applications and samples - usb: hid: All hid_ops callbacks get device pointer. Updated usb_state.c to new hid_ops callbacks which includes the device pointer. - cmake: bintools elfconvert Updated according to new toolchain abstraction. - partition_manager: cmake: update regex for runner hex file The format of the runner yaml has changed. Update the regex used to replace the hex_file variable to match it. Signed-off-by: Håkon Øye Amundsen <[email protected]> Signed-off-by: Torsten Rasmussen <[email protected]>

Replace clock_control_mpsl with nrfx_clock implementation which is using mpsl_clock API. This way standard clock_control driver is used and only thin, straightforward nrfx_clock API is replaced with implementation which is utilizing mpsl_clock API. Signed-off-by: Krzysztof Chruscinski <[email protected]> mpsl: removing clock control in mpsl Signed-off-by: Torsten Rasmussen <[email protected]>

The API for setting IRQ state has changed. Update to align with the new functionailty. Ref: NCSDK-6463 Signed-off-by: Håkon Øye Amundsen <[email protected]>

Updated nrf_desktop applications to use upstream SYSTEM_CLOCK_WAIT_FOR_STABILITY instead of CLOCK_CONTROL_NRF_K32SRC_BLOCKING. Signed-off-by: Torsten Rasmussen <[email protected]>

HAS_DTS_I2C is now selected by I2C and always used as I2C && HAS_DTS_I2C. It could then be purely removed. Signed-off-by: Torsten Rasmussen <[email protected]>

Signed-off-by: Pawel Dunaj <[email protected]>

nordic-krch · 2020-10-05T11:54:31Z

closing since it is included in upmerge PR.

- nrf_security: update mbedtls heap to const struct device Zephyr upmerge introduces device bindings const struct as part of: zephyrproject-rtos/zephyr#24873 This const'ify mbedtls_heap.c init function. - mpls: Added `select MULTITHREADING_LOCK` to Kconfig With the changes related to: nrfconnect/sdk-nrf#2861 zephyrproject-rtos/zephyr#27398 The mpsl clock control is no longer needed, but mpsl still requires MULTITHREADING_LOCK, and is therefore moved to its right location. - softdevice_controller: Mark 2M and Coded PHY as supported These helper configs were introduced in upstream zephyr. Signed-off-by: Torsten Rasmussen <[email protected]> Signed-off-by: Rubin Gerritsen <[email protected]>

nordic-krch added DNM RFC Request For Comments labels Sep 8, 2020

nordic-krch requested review from anangl, ryanjh and rugeGerritsen September 8, 2020 09:31

nordic-krch requested review from carlescufi and tejlmand as code owners September 8, 2020 09:31

github-actions bot added the manifest label Sep 8, 2020

nordic-krch force-pushed the clock_control branch from 2ca281d to 5e42631 Compare September 8, 2020 09:43

rugeGerritsen reviewed Sep 8, 2020

View reviewed changes

nordic-krch force-pushed the clock_control branch 3 times, most recently from 81d3475 to 1814e2a Compare September 8, 2020 11:13

anangl reviewed Sep 8, 2020

View reviewed changes

anangl approved these changes Sep 8, 2020

View reviewed changes

nordic-krch force-pushed the clock_control branch 4 times, most recently from b35c613 to dfa3ee8 Compare September 14, 2020 06:43

nordic-krch mentioned this pull request Sep 14, 2020

drivers: clock_control: nrf: Change CLOCK_CONTROL_NRF_FORCE_ALT zephyrproject-rtos/zephyr#28350

Closed

nordic-krch force-pushed the clock_control branch from dfa3ee8 to 5b8ca1e Compare September 21, 2020 14:50

nordic-krch requested review from coderbyheart, doki-nordic, grochu, hakonfam and ioannisg as code owners September 21, 2020 14:50

doki-nordic removed request for junqingzou, ryanjh, rlubos, lmaciejonczyk, jhn-nordic, KAGA164, doki-nordic, simensrostad, lats1980, mariuszpos, maciekfabia and MarekPorwisz September 24, 2020 06:15

hakonfam removed their request for review September 25, 2020 08:22

nordic-krch force-pushed the clock_control branch from 5b8ca1e to 5fdac2f Compare October 5, 2020 09:31

nordic-krch and others added 5 commits October 5, 2020 11:44

spm: align with updated API for setting irq state

bbeee3a

The API for setting IRQ state has changed. Update to align with the new functionailty. Ref: NCSDK-6463 Signed-off-by: Håkon Øye Amundsen <[email protected]>

nrf_desktop: using CONFIG_SYSTEM_CLOCK_WAIT_FOR_STABILITY=y

aa492cf

Updated nrf_desktop applications to use upstream SYSTEM_CLOCK_WAIT_FOR_STABILITY instead of CLOCK_CONTROL_NRF_K32SRC_BLOCKING. Signed-off-by: Torsten Rasmussen <[email protected]>

dts/Kconfig: Remove HAS_DTS_I2C

0d45542

HAS_DTS_I2C is now selected by I2C and always used as I2C && HAS_DTS_I2C. It could then be purely removed. Signed-off-by: Torsten Rasmussen <[email protected]>

fixup! treewide: Update OSS projects revisions

bbd3614

Signed-off-by: Pawel Dunaj <[email protected]>

nordic-krch force-pushed the clock_control branch from 5fdac2f to bbd3614 Compare October 5, 2020 09:46

nordic-krch closed this Oct 5, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[RFC] drivers: mpsl: clock_control: Provide nrfx_clock shim #2861

[RFC] drivers: mpsl: clock_control: Provide nrfx_clock shim #2861

Uh oh!

nordic-krch commented Sep 8, 2020

Uh oh!

rugeGerritsen Sep 8, 2020

Uh oh!

nordic-krch Sep 8, 2020

Uh oh!

tejlmand Sep 22, 2020

Uh oh!

rugeGerritsen commented Sep 8, 2020

Uh oh!

anangl Sep 8, 2020

Uh oh!

anangl left a comment

Uh oh!

anangl Sep 8, 2020

Uh oh!

doki-nordic commented Sep 24, 2020

Uh oh!

nordic-krch commented Oct 5, 2020

Uh oh!

Uh oh!

		#include <drivers/clock_control/nrf_clock_control.h>
		#include <nrfx_power.h>

[RFC] drivers: mpsl: clock_control: Provide nrfx_clock shim #2861

[RFC] drivers: mpsl: clock_control: Provide nrfx_clock shim #2861

Uh oh!

Conversation

nordic-krch commented Sep 8, 2020

Uh oh!

rugeGerritsen Sep 8, 2020

Choose a reason for hiding this comment

Uh oh!

nordic-krch Sep 8, 2020

Choose a reason for hiding this comment

Uh oh!

tejlmand Sep 22, 2020

Choose a reason for hiding this comment

Uh oh!

rugeGerritsen commented Sep 8, 2020

Uh oh!

anangl Sep 8, 2020

Choose a reason for hiding this comment

Uh oh!

anangl left a comment

Choose a reason for hiding this comment

Uh oh!

anangl Sep 8, 2020

Choose a reason for hiding this comment

Uh oh!

doki-nordic commented Sep 24, 2020

Uh oh!

nordic-krch commented Oct 5, 2020

Uh oh!

Uh oh!