mgmt: hawkbit: use SMF #70787

maass-hamburg · 2024-03-27T12:28:54Z

Use the State Machine Framework for hawkBit. Includes a lot of cleanup of the hawkBit subsystem.

Resolves: #71576
Resolves: #71691
Resolves: #71759

Depends on/the following PRs should be merged before this:

the commits from before mgmt: hawkbit: use SMF are from #71037

this is a WIP

kartben · 2024-04-17T06:11:32Z

cc @glenn-andrews

glenn-andrews

Consider transitioning to an error-handling state rather than using smf_set_state(SMF_CTX(s), NULL);

subsys/mgmt/hawkbit/hawkbit.c

real-tintin · 2024-04-18T19:02:21Z

This is great! We have considered rewriting the implementation to use a state machine due to multiple issue (I previously wrote in the roadmap issue). As I wrote there, we have made adaptions and bug fixes e.g., issues with double freeing and handling of NULL response (crashes hard during download if not checked). But I see that you have improved on the malloc and I strongly believe that the SMF will solve a bunch of issues itself.

I would like to give this a try. I will merge (locally for testing) our adaptions e.g., a dynamic config e.g., setting endpoints and tokens (during a device provisioning over BLE) - I saw that it already exist a PR for a similar change.

maass-hamburg · 2024-04-18T19:35:18Z

This is great! We have considered rewriting the implementation to use a state machine due to multiple issue (I previously wrote in the roadmap issue). As I wrote there, we have made adaptions and bug fixes e.g., issues with double freeing and handling of NULL response (crashes hard during download if not checked). But I see that you have improved on the malloc and I strongly believe that the SMF will solve a bunch of issues itself.

I would like to give this a try. I will merge (locally for testing) our adaptions e.g., a dynamic config e.g., setting endpoints and tokens (during a device provisioning over BLE) - I saw that it already exist a PR for a similar change.

Thanks for the feedback!
If you find bugs, please feel free to open an issue. And if you have a fix for it, it would be wonderful if you contribute it back into the zephyr main. It makes thinks easier for all of us.

The same is true for new features, feel free to contribute. Just look at the features we added to hawkBit in the last weeks: here

glenn-andrews · 2024-04-20T01:15:47Z

subsys/mgmt/hawkbit/hawkbit.c

-	free(hb_context.response_data);
-	k_sem_give(&probe_sem);
-	return hb_context.code_status;
+	smf_set_terminate(SMF_CTX(s), s->hb_context.code_status);


Can this ever be zero? e.g. with a successful download?

Looks good from the SMF side. I can't answer to the functionality of the driver.

Does this look correct as a state diagram:

Yes it does, but not including today's changes.

Yes it does, but not including today's changes.

Heh. okay.

real-tintin · 2024-04-24T14:15:17Z

Tested the recent changes, works fine! I guess I don't have the buttons to approve this...

Awesome work, feel much more rigid now! 🙂

real-tintin · 2024-04-26T07:04:55Z

Integrated latest changes and tested them, this includes:

No update
Cancel of update
Download and image swap

No issues.

We have a setup where devices are OTA updated every X h, stress test. I will create a alpha release with your latest changes and run in the setup. I can get back to you with the result after the weekend.

maass-hamburg · 2024-04-26T07:11:21Z

Integrated latest changes and tested them, this includes:

No update

Cancel of update

Download and image swap

No issues.

We have a setup where devices are OTA updated every X h, stress test. I will create a alpha release with your latest changes and run in the setup. I can get back to you with the result after the weekend.

thats sounds good

staticly init hawkbit_work_handle Signed-off-by: Fin Maaß <f.maass@vogl-electronic.com>

add option for autohandler to only run once. Signed-off-by: Fin Maaß <f.maass@vogl-electronic.com>

real-tintin · 2024-04-29T08:56:47Z

The devices have OTA updated as expected over the weekend. I saw that you pushed some changes today. Should these affect the SMF?

maass-hamburg · 2024-04-29T09:00:49Z

The devices have OTA updated as expected over the weekend. I saw that you pushed some changes today. Should these affect the SMF?

It shouldn't. See them here: https://github.com/zephyrproject-rtos/zephyr/compare/cd2578014f1965de9747b82ac29cc929504ee273..93ba8d566c509b1b8b6dd383d751843ae10386f2
and changes from rebaising to #71037

real-tintin

Looks good to me. I have performed integration testing - multiple devices getting OTA updated every 1 h, over one weekend.

Add hawkbit_autohandler_wait() to be able to wait for the autohandler to finish. Signed-off-by: Fin Maaß <f.maass@vogl-electronic.com>

Also use a workqueue, when execution of hawkBit is requested via shell. Signed-off-by: Fin Maaß <f.maass@vogl-electronic.com>

If the run of the autohandler is started from shell, it will be logged. Signed-off-by: Fin Maaß <f.maass@vogl-electronic.com>

Be able to delay the next run of the hawkbit autohandler. Signed-off-by: Fin Maaß <f.maass@vogl-electronic.com>

Mention change of hawkbit autohandler and shell in the migration guide and the release notes. Signed-off-by: Fin Maaß <f.maass@vogl-electronic.com>

use smf for hawkbit. Signed-off-by: Fin Maaß <f.maass@vogl-electronic.com>

remove unused hawkbit responses. Signed-off-by: Fin Maaß <f.maass@vogl-electronic.com>

allow the use of other tenants. Signed-off-by: Fin Maaß <f.maass@vogl-electronic.com>

rename close to cancel, as it is more fitting. Signed-off-by: Fin Maaß <f.maass@vogl-electronic.com>

Be able to change the tls certicicate tag. Signed-off-by: Fin Maaß <f.maass@vogl-electronic.com>

maass-hamburg force-pushed the hawkbit_less_global branch 7 times, most recently from 49080dc to 80fa584 Compare April 8, 2024 11:26

maass-hamburg changed the title ~~mgmt: hawkbit: make hb_context non global~~ mgmt: hawkbit: use SMF Apr 8, 2024

maass-hamburg force-pushed the hawkbit_less_global branch 3 times, most recently from d1a50eb to 4ae2630 Compare April 16, 2024 09:25

maass-hamburg force-pushed the hawkbit_less_global branch 2 times, most recently from d01cb3b to 93104c8 Compare April 18, 2024 11:41

glenn-andrews suggested changes Apr 18, 2024

View reviewed changes

subsys/mgmt/hawkbit/hawkbit.c Outdated Show resolved Hide resolved

maass-hamburg force-pushed the hawkbit_less_global branch from 93104c8 to 7533803 Compare April 18, 2024 14:53

maass-hamburg requested a review from glenn-andrews April 18, 2024 15:14

maass-hamburg mentioned this pull request Apr 19, 2024

mgmt: hawkbit: autohandler and shell optimize #71037

Open

maass-hamburg force-pushed the hawkbit_less_global branch 4 times, most recently from a602bd4 to 469e9d5 Compare April 19, 2024 17:48

glenn-andrews reviewed Apr 20, 2024

View reviewed changes

maass-hamburg force-pushed the hawkbit_less_global branch 5 times, most recently from c78cf8d to 2a5891a Compare April 22, 2024 09:44

maass-hamburg force-pushed the hawkbit_less_global branch from 7ce8fce to 7d4a900 Compare April 24, 2024 12:36

maass-hamburg force-pushed the hawkbit_less_global branch 3 times, most recently from 141da3d to 4480356 Compare April 25, 2024 15:15

maass-hamburg mentioned this pull request Apr 25, 2024

mgmt: hawkbit: resume download of firmware #71954

Draft

maass-hamburg requested a review from real-tintin April 25, 2024 15:39

maass-hamburg force-pushed the hawkbit_less_global branch 3 times, most recently from 93ba8d5 to 49c95fc Compare April 29, 2024 07:28

maass-hamburg added 2 commits April 29, 2024 09:37

mgmt: hawkbit: use K_WORK_DELAYABLE_DEFINE

4166432

staticly init hawkbit_work_handle Signed-off-by: Fin Maaß <f.maass@vogl-electronic.com>

mgmt: hawkbit: add option for autohandler

f36dd3f

add option for autohandler to only run once. Signed-off-by: Fin Maaß <f.maass@vogl-electronic.com>

real-tintin approved these changes Apr 29, 2024

View reviewed changes

maass-hamburg added 10 commits April 30, 2024 07:54

mgmt: hawkbit: add hawkbit_autohandler_wait

ae8a1a2

Add hawkbit_autohandler_wait() to be able to wait for the autohandler to finish. Signed-off-by: Fin Maaß <f.maass@vogl-electronic.com>

mgmt: hawkbit: also use workqueue for shell run

665da9f

Also use a workqueue, when execution of hawkBit is requested via shell. Signed-off-by: Fin Maaß <f.maass@vogl-electronic.com>

mgmt: hawkbit: log start of autohandler from shell

a3d06d1

If the run of the autohandler is started from shell, it will be logged. Signed-off-by: Fin Maaß <f.maass@vogl-electronic.com>

mgmt: hawkbit: delay autohandler

3ffd429

Be able to delay the next run of the hawkbit autohandler. Signed-off-by: Fin Maaß <f.maass@vogl-electronic.com>

doc: releases: 3.7: change of hawkbit autohandler

9a6f7ec

Mention change of hawkbit autohandler and shell in the migration guide and the release notes. Signed-off-by: Fin Maaß <f.maass@vogl-electronic.com>

mgmt: hawkbit: use SMF

1f95ae3

use smf for hawkbit. Signed-off-by: Fin Maaß <f.maass@vogl-electronic.com>

samples: mgmt: hawkbit: remove unused responses

62ba7ad

remove unused hawkbit responses. Signed-off-by: Fin Maaß <f.maass@vogl-electronic.com>

mgmt: hawkbit: allow different tenants

d95ce83

allow the use of other tenants. Signed-off-by: Fin Maaß <f.maass@vogl-electronic.com>

mgmt: hawkbit: rename close to cancel

ae9c9dd

rename close to cancel, as it is more fitting. Signed-off-by: Fin Maaß <f.maass@vogl-electronic.com>

mgmt: hawkbit: change the tls certificate tag

a94b138

Be able to change the tls certicicate tag. Signed-off-by: Fin Maaß <f.maass@vogl-electronic.com>

maass-hamburg force-pushed the hawkbit_less_global branch from 49c95fc to a94b138 Compare April 30, 2024 05:56

maass-hamburg added DNM This PR should not be merged (Do Not Merge) area: hawkBit labels Apr 30, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

mgmt: hawkbit: use SMF #70787

mgmt: hawkbit: use SMF #70787

maass-hamburg commented Mar 27, 2024 •

edited

kartben commented Apr 17, 2024

glenn-andrews left a comment

real-tintin commented Apr 18, 2024

maass-hamburg commented Apr 18, 2024 •

edited

glenn-andrews Apr 20, 2024

maass-hamburg Apr 20, 2024

glenn-andrews Apr 22, 2024

maass-hamburg Apr 22, 2024

glenn-andrews Apr 22, 2024

real-tintin commented Apr 24, 2024

real-tintin commented Apr 26, 2024

maass-hamburg commented Apr 26, 2024

real-tintin commented Apr 29, 2024

maass-hamburg commented Apr 29, 2024 •

edited

real-tintin left a comment

mgmt: hawkbit: use SMF #70787

Are you sure you want to change the base?

mgmt: hawkbit: use SMF #70787

Conversation

maass-hamburg commented Mar 27, 2024 • edited

kartben commented Apr 17, 2024

glenn-andrews left a comment

Choose a reason for hiding this comment

real-tintin commented Apr 18, 2024

maass-hamburg commented Apr 18, 2024 • edited

glenn-andrews Apr 20, 2024

Choose a reason for hiding this comment

maass-hamburg Apr 20, 2024

Choose a reason for hiding this comment

glenn-andrews Apr 22, 2024

Choose a reason for hiding this comment

maass-hamburg Apr 22, 2024

Choose a reason for hiding this comment

glenn-andrews Apr 22, 2024

Choose a reason for hiding this comment

real-tintin commented Apr 24, 2024

real-tintin commented Apr 26, 2024

maass-hamburg commented Apr 26, 2024

real-tintin commented Apr 29, 2024

maass-hamburg commented Apr 29, 2024 • edited

real-tintin left a comment

Choose a reason for hiding this comment

maass-hamburg commented Mar 27, 2024 •

edited

maass-hamburg commented Apr 18, 2024 •

edited

maass-hamburg commented Apr 29, 2024 •

edited