CMSIS RTOS Feature #227

robamu · 2021-07-04T11:11:28Z

This branch has the complete feature set for CMSIS RTOS support.
Builds on #190 and #189 , a lot of work provided by @g-arjones , extended with documentation and an updated freertos example with the same architetecture as #225

Closes #188 . Closes #160 issues
Closes #190 Closes #189 PR

The updated freertos example can now be compiled with CMSIS RTOS by passing -DUSE_CMSIS_RTOS=ON and CMSIS RTOSV2 by passing -DUSE_CMSIS_RTOS_V2=ON . When doing this, it is not necessary to set FREERTOS_PATH anymore, because the build system can use the FreeRTOS and CMSIS RTOS sources inside the Cube repository. See updated README for more details

…s_rtos_support

…feature/rtos

README.md

atsju

The cmake is too complex for me without comments.

I'm not expert and the most difficult is to understand what each variable contains. Var names are near each others and often composed names. I know there were historically no comments in the repo but it needs to change as the repo grows and is used by many. in my opinion

examples/freertos/CMakeLists.txt

atsju · 2021-07-11T07:51:33Z

examples/freertos/CMakeLists.txt

+option(USE_CMSIS_RTOS "Use CMSIS RTOS provided by Cube repository" OFF)
+option(USE_CMSIS_RTOS_V2 "Use CMSIS RTOS_V2 provided by Cube repository" OFF)


Suggested change

option(USE_CMSIS_RTOS "Use CMSIS RTOS provided by Cube repository" OFF)

option(USE_CMSIS_RTOS_V2 "Use CMSIS RTOS_V2 provided by Cube repository" OFF)

option(USE_CMSIS_RTOS "Use CMSIS RTOS provided by Cube repository" ON)

option(USE_CMSIS_RTOS_V2 "Use CMSIS RTOS_V2 provided by Cube repository" OFF)

This assumes an RTOS path is given by command line or PATH variable. I suppose it's better to have a working example from start.

Sorry I am a novice but aren't freeRTOS/CMSIS_RTOS/CMSIS_RTOS_V2 supposed to be 3 different things ? Shouldn't there be a third option for freeRTOS ?

CMSIS_RTOS and CMSIS_RTOS_V2 build on top of FreeRTOS. In the application, you can still use the regular FreeRTOS API, but with CMSIS you can use any library which expects/uses a CMSIS RTOS API as well. (e.g. LwIP). If you think this explanation would help, I can add it to the README as well

As seen in later comments, the example should build on FreeRTOS. But I need to modify the cmakelist to be able to do this.

I guess this is solves by the new third option USE_CUBE_FREERTOS ?

solved for H7 but not for F4 missing if(USE_CUBE_FREERTOS)

examples/freertos/CMakeLists.txt

atsju · 2021-07-11T08:13:48Z

README.md

+The following additional FreeRTOS targets are available in general to use the FreeRTOS provided
+in the Cube repository
+
+* `FreeRTOS::STM32::<Family>`


When a cube path is provided this should be populated and usable but it is not the case from my tests.
Maybe FREERTOS_PATH should not be mandatory when a STM32_CUBE_<FAMILY>_PATH is provided?

Have you added the STM32<Family> to the FreeRTOS components? This is necessary to use the target inside the namespace I think

No I have not. And it was not enough to solve the issue.
But this did:

#if(USE_CMSIS_RTOS OR USE_CMSIS_RTOS_V2) list(APPEND FREERTOS_COMP_LIST STM32H7) set(FREERTOS_H7_NAMESPACE ${FREERTOS_NAMESPACE}::STM32::H7::M7) #else() # set(FREERTOS_H7_NAMESPACE ${FREERTOS_NAMESPACE}) #endif()

You are more expert that I am. Does the example need update ?

Ah was that the example? That is weird, FREERTOS_PATH should not be necessary.. What was the build generation command?

I just tested it. I loaded the STM32_CUBE_H7_PATH by setting it as an environment with
export STM32_CUBE_H7_PATH=<pathToCube> and the toolchain with export STM32_TOOLCHAIN_PATH=<pathToToolchain>

I the ran the following command inside example/freertos/build:

cmake -DUSE_CMSIS_RTOS=ON -DFREERTOS_H743ZI_EXAMPLE=ON -DSTM32_TOOLCHAIN_PATH=$STM32_TOOLCHAIN_PATH ..

For CMSIS V2 I ran

cmake -DUSE_CMSIS_RTOS_V2=ON -DFREERTOS_H743ZI_EXAMPLE=ON -DSTM32_TOOLCHAIN_PATH=$STM32_TOOLCHAIN_PATH ..

Ah, if neither USE_CMSIS_RTOS nor USE_CMSIS_RTOS_V2 is specified the example could theoretically use both external kernel or STM32H7 kernel. But then what is taken as the default choice? Maybe introduce another option for that? For CMSIS, it is recommended to take the Cube kernel, so I just hardcoded it

Okay, I updated it. It should work for your case now as well. There is an option to specify whether the Cube FreeRTOS or an external kernel is picked.

atsju · 2021-07-11T08:17:55Z

cmake/FindCMSIS.cmake

@@ -7,6 +9,32 @@ if(STM32H7 IN_LIST CMSIS_FIND_COMPONENTS)
 endif()
 list(REMOVE_DUPLICATES CMSIS_FIND_COMPONENTS)

+foreach(COMP ${CMSIS_FIND_COMPONENTS})


I'm not expert so I'm sorry if it's supposed to be trivial for me. But if you find it relevant to beginners and maintainers: please add (relevant) comments into the code.

I added more documentation for all component list filler loops

cmake/FindFreeRTOS.cmake

Also minor fix in FindFreeRTOS

robamu · 2021-07-15T09:31:22Z

I added am minor improvement for the FREERTOS_PATH handling:

if(NOT FREERTOS_PATH)
    set(FREERTOS_PATH $ENV{FREERTOS_PATH} CACHE PATH "Path to FreeRTOS")
endif()

if(NOT FREERTOS_PATH)
    set(DEFAULT_FREERTOS_PATH "/opt/FreeRTOS")
    if(EXISTS ${DEFAULT_FREERTOS_PATH})
        set(FREERTOS_PATH ${DEFAULT_FREERTOS_PATH} CACHE PATH "Path to FreeRTOS")
        message(STATUS "No FREERTOS_PATH specified using default: ${DEFAULT_FREERTOS_PATH}")
    else()
        message(STATUS
            "No FreeRTOS folder found at default location ${DEFAULT_FREERTOS_PATH}. "
            "Leaving empty
        )
    endif()
endif()

CMake will check whether the default path exists and just leave it empty if it does not exist

atsju · 2021-07-15T09:44:48Z

CMake will check whether the default path exists and just leave it empty if it does not exist

Excellent idea. Could be the same for all default path in a separate PR (I'm on widows so they are all/always non-sense).

robamu · 2021-07-15T11:14:51Z

New issue for this #232

atsju

I still have an issue with USE_CUBE_FREERTOS on F4

atsju · 2021-07-15T16:04:53Z

examples/freertos/CMakeLists.txt

+option(USE_CMSIS_RTOS "Use CMSIS RTOS provided by Cube repository" OFF)
+option(USE_CMSIS_RTOS_V2 "Use CMSIS RTOS_V2 provided by Cube repository" OFF)


solved for H7 but not for F4 missing if(USE_CUBE_FREERTOS)

examples/freertos/CMakeLists.txt

atsju · 2021-08-01T09:12:16Z

Hello @robamu,
Sorry for delay. Can you please fix conflict?
Also it would be great to rebase the PR to have a cleaner history (there are 31 commits here). If it's OK for you I can rebase it myself but you will lose commit signatures (I would keep you as author though).

robamu · 2021-08-01T11:08:34Z

I will look into rebasing it for better history

robamu · 2021-08-01T12:46:56Z

I really can't wrap my head around the rebase feature, I would still need to force push (I guess there is no way around this though?).

I will just create a clean squash merge and a new PR, and reference the full discussion there. I hope that is okay.

atsju · 2021-08-01T16:09:17Z

I really can't wrap my head around the rebase feature, I would still need to force push (I guess there is no way around this though?).

I will just create a clean squash merge and a new PR, and reference the full discussion there. I hope that is okay.

Force push is not avoidable in this case. Having a new PR is fine also. I will have a look at #253
Closed in favor of #253

g-arjones and others added 14 commits April 16, 2021 15:46

Add support for CMSIS RTOS

d74300a

Allow choosing FreeRTOS from STM32Cube

28e4de0

added doc for CMSIS

a035f82

Merge remote-tracking branch 'upstream/master' into garjones/add_cmsi…

9089819

…s_rtos_support

fixed inconsistent indentation

995eca8

added line to remove duplicates

664bd3f

removed line which is not needed after all

1e6353e

Merge branch 'garjones/add_cmsis_rtos_support' into feature/rtos

f7f0df7

Merge branch 'garjones/add_support_for_freertos_from_stm32cube' into …

e16eab7

…feature/rtos

completing feature branch

283261b

README update

5b0bd76

added updated example

7c47793

this is better

9cb4d5a

tiny tweak

cbc35f5

This was referenced Jul 4, 2021

Add support for CMSIS RTOS #222

Closed

Allow choosing FreeRTOS from STM32Cube #224

Closed

robamu changed the title ~~WIP: CMSIS RTOS Feature~~ CMSIS RTOS Feature Jul 4, 2021

removed section which is not part of PR

e1ec091

robamu changed the title ~~CMSIS RTOS Feature~~ WIP: CMSIS RTOS Feature Jul 4, 2021

better FreeRTOS section

3c5484e

robamu changed the title ~~WIP: CMSIS RTOS Feature~~ CMSIS RTOS Feature Jul 4, 2021

robamu added 4 commits July 4, 2021 13:48

some fixes in order/structure

07798ed

newline removed

ac679f4

updated example explanation

edf1234

blinky fix

e78f20e

atsju reviewed Jul 5, 2021

View reviewed changes

README.md Outdated Show resolved Hide resolved

atsju reviewed Jul 11, 2021

View reviewed changes

robamu added 3 commits July 11, 2021 22:35

Merge remote-tracking branch 'upstream/master' into feature/rtos

9d76f52

added ports, added comments

c616752

clarification

90c73d7

robamu added 3 commits July 11, 2021 23:09

more doc

69c26da

Added CMSIS architectures which are supported

fcbdfc3

Added ARM_CM7_MPU

15ae0bf

atsju mentioned this pull request Jul 14, 2021

FreeRTOS doesn't support CM33 #231

Open

robamu added 3 commits July 15, 2021 11:15

another option to select FreeRTOS

aca3a3e

more info printout

e8ae4e4

updated CMakelists

465bed9

Also minor fix in FindFreeRTOS

robamu changed the title ~~CMSIS RTOS Feature~~ WIP: CMSIS RTOS Feature Jul 15, 2021

robamu added 2 commits July 15, 2021 11:28

better output, more checks

faa4337

minor fix

e61e358

robamu changed the title ~~WIP: CMSIS RTOS Feature~~ CMSIS RTOS Feature Jul 15, 2021

robamu mentioned this pull request Jul 15, 2021

Check all default paths existence before setting them #232

Open

atsju reviewed Jul 15, 2021

View reviewed changes

robamu added 2 commits August 1, 2021 13:18

Merge remote-tracking branch 'upstream/master' into feature/rtos

ae4ba41

Update for new stm32_get_devices_by_family call

3f462ec

updated .cmake file

b3f97e2

robamu mentioned this pull request Aug 1, 2021

CMSIS RTOS Feature #253

Merged

atsju closed this Aug 1, 2021

robamu deleted the feature/rtos branch August 8, 2021 13:45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CMSIS RTOS Feature #227

CMSIS RTOS Feature #227

robamu commented Jul 4, 2021 •

edited by atsju

Loading

atsju left a comment

atsju Jul 11, 2021

robamu Jul 12, 2021 •

edited

Loading

atsju Jul 14, 2021 •

edited

Loading

robamu Jul 15, 2021

atsju Jul 15, 2021

atsju Jul 11, 2021

robamu Jul 12, 2021

atsju Jul 14, 2021

robamu Jul 15, 2021

robamu Jul 15, 2021

robamu Jul 15, 2021 •

edited

Loading

robamu Jul 15, 2021

atsju Jul 11, 2021

robamu Jul 12, 2021

robamu commented Jul 15, 2021

atsju commented Jul 15, 2021

robamu commented Jul 15, 2021

atsju left a comment

atsju Jul 15, 2021

atsju commented Aug 1, 2021

robamu commented Aug 1, 2021

robamu commented Aug 1, 2021 •

edited

Loading

atsju commented Aug 1, 2021

		option(USE_CMSIS_RTOS "Use CMSIS RTOS provided by Cube repository" OFF)
		option(USE_CMSIS_RTOS_V2 "Use CMSIS RTOS_V2 provided by Cube repository" OFF)

CMSIS RTOS Feature #227

CMSIS RTOS Feature #227

Conversation

robamu commented Jul 4, 2021 • edited by atsju Loading

atsju left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

robamu Jul 12, 2021 • edited Loading

Choose a reason for hiding this comment

atsju Jul 14, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

robamu Jul 15, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

robamu commented Jul 15, 2021

atsju commented Jul 15, 2021

robamu commented Jul 15, 2021

atsju left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

atsju commented Aug 1, 2021

robamu commented Aug 1, 2021

robamu commented Aug 1, 2021 • edited Loading

atsju commented Aug 1, 2021

robamu commented Jul 4, 2021 •

edited by atsju

Loading

robamu Jul 12, 2021 •

edited

Loading

atsju Jul 14, 2021 •

edited

Loading

robamu Jul 15, 2021 •

edited

Loading

robamu commented Aug 1, 2021 •

edited

Loading