provide support for the ST S2LP 802.15.4 Radio #16086

nikooiko · 2019-05-12T18:32:10Z

Hello everyone, in this PR the target is to provide support for the ST S2LP 802.15.4 Radio.

It's a work in progress but it's at a working state and can be the base for the enhancements/upgrades discussion.

Included in this merge request:

Driver for the S2LP 802.15.4 radio
The expansion of the ST external support library with the x-cube-subg1 expansion package, written by ST Microelectronics.
The definition of the x_nucleo_s2868a1 expansion module.

Current TODO list:

Support MTU > 127 bytes. Currently the driver works only with short MTU=127 bytes, but based on datasheet, the device should support MTU up to 65535 with basic packet format.
Correctly configure radio Rx State to optimize power consumption (Currently draws around 8mA but can be optimized with LDC and Rx Sniff to operate with lower consumption).
Rework Rx Thread main function (s2lp_rx) to simplify and avoid unneeded operations.
Implement s2lp_set_channel and s2lp_get_channel_count functions.
Add data rate configuration option (currently operates at 38.4Kbps).
Add frequency band configuration option (currently operates at 868Mhz).
BUG: There is a case where the TX operation locks because IRQ_TX_DATA_SENT is not correctly sampled (missed by the polling operation).

Possible changes:

The radio supports HW filter and HW auto-ack mechanisms. Is there any interest in implementing them?
X cube subg1 software expects little-endian architectures. Should be patched to also provide support for big-endian architectures?
The current driver only supports S2LP radio but can be expanded to also support the ST SPIRIT1 802.15.4 radio.
The current driver works with a static config for the radio params. Should be upgraded to be configurable through Kconfig workflow? Is there any interest in this?
Replace basic packet format with the 802.15.4 packet format?

Signed-off-by: Nikos Oikonomou [email protected]

zephyrbot · 2019-05-12T19:04:20Z

EDIT (@erwango): I've cleaned zephyrbot comments here as they don't apply anymore (lib has been moved to hal_st module) and zephyrbot would have left them as is (due to change of behavior). I did this to avoid confusion during the review, but I can re-instantiate them if requested.

erwango

Thanks for this work.
For a start, I will let others commenting on the code part, and I will focus on the license statement.
We need to ensure the license of the files you extracted from the package is compatible with use in Zephyr.
I will nack this change until it is proven we're safe on that side, but it will (should) not prevent others to review the other parts of the change meanwhile.

ext/hal/st/stm32cube_subg1/README

dbkinder

Doc is OK so far (with one correction). Is a usage example coming later?

dbkinder · 2019-05-14T14:13:30Z

boards/shields/x_nucleo_s2868a1/doc/index.rst

+ - RoHS compliant
+
+
+More information about X-NUCLEO-S2868A1 can be found here:


This renders better without the bullet point:

More information about X-NUCLEO-S2868A1 can be found in the `X-NUCLEO-S2868A1 data sheet`_.

this is resolved

nikooiko · 2019-05-14T14:25:04Z

With the provided overlay files we can execute the net > echo server/client samples. It doesn't need to showcase anything different than any other 802.15.4 device.

Of course, if you believe that a custom sample is required I can either provide a new net-based example (similar to echo), or a custom low-level sample with CONFIG_IEEE802154_RAW_MODE enabled. If you prefer the latter, I could provide a stress test sample to evaluate the performance of the radio and the provided driver.

erwango · 2019-05-16T11:58:12Z

boards/shields/x_nucleo_s2868a1/x_nucleo_s2868a1.overlay

+
+&spi1 {
+	status = "ok";
+	cs-gpios = <&gpioa 1 (GPIO_DIR_OUT|GPIO_INT_ACTIVE_LOW)>;


Regarding this shield part, can you follow what's on going with:
#14057

Particularly, I'd like you to use new gpio-map scheme described here:
#15637

erwango · 2019-05-16T11:58:28Z

boards/shields/x_nucleo_s2868a1/x_nucleo_s2868a1.overlay

+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+&spi1 {


would be arduino_spi

so it will be arduino_spi: &spi1?

Shield overlays should refer to generic nodes label, such as arduino_spi.
These alternate labels (overridding nodes in dts grammar) are defined in boards, cf nucleo_f429zi.dts.
This allows shield to be compatible with various boards that would have a different definition of arduino_spi.

erwango · 2019-05-16T12:05:45Z

samples/net/sockets/echo_client/overlay-s2868a1.conf

@@ -0,0 +1,14 @@
+CONFIG_GPIO=y


Once again, please follow up on https://github.com/zephyrproject-rtos/zephyr/pull/14057/commits
shield overlays would now sit under boards/shields, so they are not tight to a sample

erwango · 2019-05-17T08:57:00Z

recheck

dbkinder

+1 for docs

erwango · 2019-06-27T09:29:02Z

@nikooiko, you'll find in https://www.st.com/en/embedded-software/x-cube-subg1.html a 3.1.1 version of the package that includes BSD-3 zephyr compatible License. Please use this package.
Also, due to move of ext\ components to zephyr modules, you'll need to push part of your changes in following git repo: https://www.st.com/en/embedded-software/x-cube-subg1.html

Thanks

nikooiko · 2019-06-27T09:33:09Z

@erwango thanks for the ping!
I'll change them when I find the time.

erwango · 2019-09-18T15:32:27Z

@nikooiko , any plan for this work?

nikooiko · 2019-09-19T06:29:21Z

@nikooiko , any plan for this work?

Sorry for the inactivity. I've been too busy with other things and I haven't found the time to work with this driver. Hopefully, a colleague of mine will start working on this radio so he might have the time to continue the driver.

erwango · 2019-09-19T07:03:01Z

@nikooiko, thanks for the feedback. We're in the process of cleaning up the PR base. I'm tagging the PR as "stale", it might also be closed later on. But don't worry, it can still be re-opened, and I'll be happy to continue the review.

erwango · 2021-02-10T14:11:38Z

@nikooiko CI is still failed ... but hal update step is passed! Some CI checks to fix and you should be done (with this part ;-))

erwango · 2021-02-16T10:07:59Z

@nikooiko Seems you're out of luck with IC, this timeit is not related with your change. You can have a try to rebase and force push to see if this is getting better.
Regarding the driver part, it would be nice if @tbursztyka or @jukkar could have a look.

nikooiko · 2021-02-16T10:41:24Z

@nikooiko Seems you're out of luck with IC, this timeit is not related with your change. You can have a try to rebase and force push to see if this is getting better.
Regarding the driver part, it would be nice if @tbursztyka or @jukkar could have a look.

Guys here is some feedback about the driver's state/progress:

As I mentioned above I investigated replacing basic packet format with 802.15.4, but in the end, I found no reason to do so.

I tried to use the echo_client/echo_server samples but the nodes were unable to communicate so I'll need to investigate it further. At the same time I started working with a custom sample that uses 802.15.4 raw communication (s2868a1 sample) to stress test and showcase the radio operation.

In parallel my next target is to implement the s2lp_set_channel and s2lp_get_channel_count functions.

As I'm still working on this driver, any feedback would be much appreciated to produce a better result.

st: update to latest ST package revision '44d5d70'. Includes ST S2LP Library. Signed-off-by: Nikos Oikonomou <[email protected]>

Added driver for the s2lp radio modules Signed-off-by: Nikos Oikonomou <[email protected]>

Added a new shield for the x_nucleo_s2868a1 expansion module Signed-off-by: Nikos Oikonomou <[email protected]>

nikooiko · 2021-05-26T13:33:28Z

Guys, unfortunately, I was again forced to pause the development of this request. Until I have the time to continue with it or someone else steps up I'm closing this pull request.

nikooiko requested review from dbkinder, erwango, jukkar, pfalcon and tbursztyka as code owners May 12, 2019 18:32

nikooiko force-pushed the st-subg1-s2lp branch 4 times, most recently from f423df7 to a0d5dea Compare May 12, 2019 21:08

erwango added the platform: STM32 ST Micro STM32 label May 13, 2019

nikooiko force-pushed the st-subg1-s2lp branch 2 times, most recently from aa6af36 to 37d8e91 Compare May 13, 2019 09:50

erwango requested changes May 13, 2019

View reviewed changes

ext/hal/st/stm32cube_subg1/README Outdated Show resolved Hide resolved

dbkinder suggested changes May 14, 2019

View reviewed changes

nikooiko force-pushed the st-subg1-s2lp branch from 37d8e91 to d86c114 Compare May 14, 2019 14:20

erwango self-requested a review May 15, 2019 11:57

nikooiko force-pushed the st-subg1-s2lp branch from d86c114 to 65b81a7 Compare May 15, 2019 20:59

erwango mentioned this pull request May 16, 2019

ext: st: move ST HAL to its own repo #16044

Closed

erwango requested changes May 16, 2019

View reviewed changes

dbkinder approved these changes May 28, 2019

View reviewed changes

nashif changed the title ~~St subg1 s2lp~~ provide support for the ST S2LP 802.15.4 Radio May 29, 2019

erwango added the Stale PR label Sep 19, 2019

nikooiko force-pushed the st-subg1-s2lp branch 4 times, most recently from b2366ed to 011ce0e Compare February 10, 2021 14:37

pfalcon removed their request for review February 10, 2021 14:51

zephyrbot added the area: IEEE 802.15.4 label Feb 15, 2021

zephyrbot requested review from avisconti, galak, jfischer-no and mbolivar-nordic February 15, 2021 17:12

zephyrbot assigned erwango Feb 15, 2021

nikooiko force-pushed the st-subg1-s2lp branch from 011ce0e to 4444a26 Compare February 15, 2021 20:43

erwango self-requested a review February 16, 2021 10:05

nikooiko force-pushed the st-subg1-s2lp branch from 4444a26 to e6d3e79 Compare February 16, 2021 10:18

erwango assigned jukkar and unassigned erwango Feb 16, 2021

erwango removed the platform: STM32 ST Micro STM32 label Feb 16, 2021

mbolivar-nordic removed their request for review February 23, 2021 23:41

west.yml: Update st revision

0910d50

st: update to latest ST package revision '44d5d70'. Includes ST S2LP Library. Signed-off-by: Nikos Oikonomou <[email protected]>

nikooiko force-pushed the st-subg1-s2lp branch 2 times, most recently from 59495f4 to 646389f Compare March 25, 2021 16:09

nikooiko added 2 commits March 25, 2021 18:30

ieee802154: added support for s2lp radio module

b70287a

Added driver for the s2lp radio modules Signed-off-by: Nikos Oikonomou <[email protected]>

boards: shields: support for x_nucleo_s2868a1

305fcd0

Added a new shield for the x_nucleo_s2868a1 expansion module Signed-off-by: Nikos Oikonomou <[email protected]>

nikooiko force-pushed the st-subg1-s2lp branch from 646389f to 305fcd0 Compare March 25, 2021 16:31

galak removed this from the v2.6.0 milestone May 5, 2021

nikooiko closed this May 26, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

provide support for the ST S2LP 802.15.4 Radio #16086

provide support for the ST S2LP 802.15.4 Radio #16086

nikooiko commented May 12, 2019 •

edited

Loading

zephyrbot commented May 12, 2019 •

edited by erwango

Loading

erwango left a comment

dbkinder left a comment

dbkinder May 14, 2019

nikooiko May 14, 2019

nikooiko commented May 14, 2019

erwango May 16, 2019

erwango May 16, 2019

nikooiko May 16, 2019

erwango May 17, 2019

erwango May 16, 2019

erwango commented May 17, 2019

dbkinder left a comment

erwango commented Jun 27, 2019

nikooiko commented Jun 27, 2019

erwango commented Sep 18, 2019

nikooiko commented Sep 19, 2019

erwango commented Sep 19, 2019

erwango commented Feb 10, 2021

erwango commented Feb 16, 2021

nikooiko commented Feb 16, 2021

nikooiko commented May 26, 2021

		- RoHS compliant


		More information about X-NUCLEO-S2868A1 can be found here:

provide support for the ST S2LP 802.15.4 Radio #16086

provide support for the ST S2LP 802.15.4 Radio #16086

Conversation

nikooiko commented May 12, 2019 • edited Loading

zephyrbot commented May 12, 2019 • edited by erwango Loading

erwango left a comment

Choose a reason for hiding this comment

dbkinder left a comment

Choose a reason for hiding this comment

dbkinder May 14, 2019

Choose a reason for hiding this comment

nikooiko May 14, 2019

Choose a reason for hiding this comment

nikooiko commented May 14, 2019

erwango May 16, 2019

Choose a reason for hiding this comment

erwango May 16, 2019

Choose a reason for hiding this comment

nikooiko May 16, 2019

Choose a reason for hiding this comment

erwango May 17, 2019

Choose a reason for hiding this comment

erwango May 16, 2019

Choose a reason for hiding this comment

erwango commented May 17, 2019

dbkinder left a comment

Choose a reason for hiding this comment

erwango commented Jun 27, 2019

nikooiko commented Jun 27, 2019

erwango commented Sep 18, 2019

nikooiko commented Sep 19, 2019

erwango commented Sep 19, 2019

erwango commented Feb 10, 2021

erwango commented Feb 16, 2021

nikooiko commented Feb 16, 2021

nikooiko commented May 26, 2021

nikooiko commented May 12, 2019 •

edited

Loading

zephyrbot commented May 12, 2019 •

edited by erwango

Loading