fsfw/fsfw
11
3
Fork 6
Code Issues 32 Pull Requests 4 Releases 10 Wiki Activity

FSFW Restructuring #445

Merged
mohr merged 77 commits from mueller/restructuring into development 2021-08-09 16:00:27 +02:00
Conversation 3 Commits 77 Files Changed 846 +8056 -2048
muellerr commented 2021-07-14 10:53:13 +02:00
Owner
Copy Link
  • Restructuring as mentioned in #443
  • API for users mostly changed the same, internal structure revamped completely. Clear separation between sources which are the foundation of the static library, and the includes which expose both the internal and external API
  • Both users and FSFW use central include folder now, all includes are prefixed with ` "fsfw/..."
  • Relative includes not necessary anymore
  • Consistency: All folder names are lower case now. internalError renamed to internalerror and FreeRTOS renamed to freertos
  • General decision regarding CMake variables in the FSFW: All variables should be prefixed with FSFW_ in the future. OS_FSFW renamed to FSFW_HOST accordingly
  • hal and tests have their own src and inc folder structure which would principally allow them to be extracted to submodules again
  • Updated CHANGELOG with entries from 1.0.0 to 1.1.0 and added first entries for 1.1.0 to 1.2.0
  • separate folder contrib in root
  • misc folder which contains logos and default configuration template folder
  • doc folder for documentation, which is currently in Markdown format
  • tests folder for both internal unit tests which can be used on each OSAL and unittests which can only be built hosted with Catch2 support
  • cmake folder might be part of a separate PR to introduce a FindFSFW.cmake file which allows using find_package to integrate the FSFW as mentioned in #429

All changes were tested like this:

  • FSFW Linux example to test Linux OSAL
  • FSFW FreeRTOS STM32H7 to test FreeRTOS OSAL
  • FSFW RTEMS STM32H7 to test the RTEMS OSAL
  • Test Host OSAL

Instruction how to update existing / user code

Changes in #include:

  • Rename internalError in includes to internalerror
  • Rename fsfw/hal to fsfw_hal
  • Rename fsfw/tests to fsfw_tests
  • Rename osal/FreeRTOS to osal/freertos

Changes in CMakeLists.txt:

  • Rename OS_FSFW to FSFW_OSAL
- Restructuring as mentioned in #443 - API for users mostly changed the same, internal structure revamped completely. Clear separation between sources which are the foundation of the static library, and the includes which expose both the internal and external API - Both users and FSFW use central include folder now, all includes are prefixed with ` "fsfw/..." - Relative includes not necessary anymore - Consistency: All folder names are lower case now. `internalError` renamed to `internalerror` and `FreeRTOS` renamed to ` freertos` - General decision regarding CMake variables in the FSFW: All variables should be prefixed with `FSFW_` in the future. `OS_FSFW` renamed to `FSFW_HOST` accordingly - `hal` and `tests` have their own `src` and `inc` folder structure which would principally allow them to be extracted to submodules again - Updated `CHANGELOG` with entries from 1.0.0 to 1.1.0 and added first entries for 1.1.0 to 1.2.0 - separate folder `contrib` in root - `misc` folder which contains logos and default configuration template folder - `doc` folder for documentation, which is currently in Markdown format - `tests` folder for both internal unit tests which can be used on each OSAL and unittests which can only be built hosted with Catch2 support - `cmake` folder might be part of a separate PR to introduce a `FindFSFW.cmake` file which allows using `find_package` to integrate the FSFW as mentioned in #429 All changes were tested like this: - FSFW Linux example to test Linux OSAL - FSFW FreeRTOS STM32H7 to test FreeRTOS OSAL - FSFW RTEMS STM32H7 to test the RTEMS OSAL - Test Host OSAL ## Instruction how to update existing / user code Changes in `#include`: - Rename `internalError` in includes to `internalerror` - Rename `fsfw/hal` to `fsfw_hal` - Rename `fsfw/tests` to `fsfw_tests` - Rename `osal/FreeRTOS` to `osal/freertos` Changes in `CMakeLists.txt`: - Rename `OS_FSFW` to `FSFW_OSAL`
muellerr added 16 commits 2021-07-14 10:53:14 +02:00
restructuring fsfw 5adb5cce95
restructure repository bdb8b0a757
moved memory helper to core f15352bb2f
added more cmakelists files f14d5edf42
some more corrections eee84f9318
additonal warning 3a9add82fe
added hal folder ca297a7dcd
a lot of internal include replacements 936d0e9f0c
more include replacements a6de52e212
done 66a79cb86c
corrections for freertos osal d5dfffda2d
important bugfix for queue map manager 4803fb2cbd
new test folder 82299c7e3e
missing interface includes 376617f9f9
integrated queue map manager bugfixes 3c4289335e
include replacements host/windows/rtems 704193eeaf
muellerr added this to the v2.0.0 milestone 2021-07-14 10:53:22 +02:00
muellerr changed title from FSFW Restructuring to WIP: FSFW Restructuring 2021-07-14 10:55:38 +02:00
muellerr added the feature label 2021-07-14 10:58:43 +02:00
muellerr added 1 commit 2021-07-14 11:04:00 +02:00
adding spg4 code option e5807c396c
muellerr added 1 commit 2021-07-14 11:05:54 +02:00
minor fixes for contrib 22693eee50
muellerr added 1 commit 2021-07-14 11:14:32 +02:00
updated change log fbdff5d0b4
muellerr added the RefactorAPI Change labels 2021-07-14 11:16:30 +02:00
muellerr added a new dependency 2021-07-14 11:23:42 +02:00
#443 FSFW Internal Restructuring - Pulling HAL back into FSFW
muellerr removed a dependency 2021-07-14 11:23:48 +02:00
#443 FSFW Internal Restructuring - Pulling HAL back into FSFW
muellerr added a new dependency 2021-07-14 11:23:55 +02:00
#444 QueueMapManager bugfix
muellerr added 13 commits 2021-07-15 18:55:57 +02:00
Merge branch 'mueller/master' into eive/develop 38f2f69c78
small tweak c2b8507d29
minor tweaks eef2fd3b7a
file system API update 323577cdc6 
Added functions to create and remove folders
delete directory: recursive option da8a447073
deleted .mk file a3e6b1018b
Merge remote-tracking branch 'upstream/mueller/master' into mueller/master f19f3681ca
Merge branch 'mueller/master' of https://egit.irs.uni-stuttgart.de/eive/fsfw into mueller/master 62e0465b3d
Merge remote-tracking branch 'upstream/mueller/master' into mueller/master 516e3c0f9f
Merge branch 'mueller/master' of https://egit.irs.uni-stuttgart.de/eive/fsfw into mueller/master 0b0e2e5f75
added hal subfolder 243cf42dc4
hal integration done e2da68795b
Merge branch 'mueller/master' into mueller/restructuring 8db0ca861a
muellerr added 5 commits 2021-07-15 19:28:30 +02:00
target name replaced 3c364604ac
some more fixes d11e54dc0a
stm32h7 include corrections 1db5c950b8
correction in dma.cpp aafccd191e
Merge branch 'mueller/master' into mueller/restructuring 21ac5afd35
muellerr added 2 commits 2021-07-19 14:35:25 +02:00
Merge remote-tracking branch 'origin/development' into mueller/restructuring 68498f6b74
Merge branch 'mueller/restructuring' of https://egit.irs.uni-stuttgart.de/fsfw/fsfw into mueller/restructuring 6d2bfaeb3b
muellerr added 1 commit 2021-07-19 15:01:53 +02:00
update to bugfix 16ed5e3270
muellerr added 1 commit 2021-07-19 15:03:10 +02:00
update to upstream 4c41cb1f71
muellerr added 1 commit 2021-07-19 15:04:15 +02:00
update to origin cbdf92a775
muellerr added 1 commit 2021-07-19 15:04:41 +02:00
Merge remote-tracking branch 'origin/development' into mueller/restructuring 4b03db38eb
muellerr added 7 commits 2021-07-19 18:30:48 +02:00
not an ideal solution but works for now a65a184083
added semaphore factory 291a8d4ea3
Merge branch 'mueller/restructuring' into mueller/master 08364e2dca
mutex update 7849b8e391
trying to fuse header / inc d47906e833
optional module handling complete d4f5c31881
command message cleaner include fix ce93b9220e
muellerr commented 2021-07-19 18:33:37 +02:00
Author
Owner
Copy Link

Changes on second iteration after feedback from @mohr:

  • Source files and header files stay together for now
  • All source files in src folder except for contrib, tests and hal
  • Added way for CMake to emitt warnings if optional modules like rmap or datalinklayer are excluded but header files are included
  • Added some stubs for BinarySemaphore and SemaphoreFactory in RTEMS OSAL to allow STM32 HAL to compile for RTEMS (this was required if everything was working as before). Full implementation will follow as separate PR
Changes on second iteration after feedback from @mohr: - Source files and header files stay together for now - All source files in `src` folder except for `contrib`, `tests` and `hal` - Added way for CMake to emitt warnings if optional modules like `rmap` or `datalinklayer` are excluded but header files are included - Added some stubs for `BinarySemaphore` and `SemaphoreFactory` in RTEMS OSAL to allow STM32 HAL to compile for RTEMS (this was required if everything was working as before). Full implementation will follow as separate PR
muellerr added 2 commits 2021-07-19 18:37:12 +02:00
update changelog 10e81fdfb8
override is not a good idea ee4449b74d
muellerr added 1 commit 2021-07-19 18:41:07 +02:00
added binary semaphore header stub ab6c616cdb
muellerr changed title from WIP: FSFW Restructuring to FSFW Restructuring 2021-07-19 18:44:58 +02:00
mohr was assigned by gaisser 2021-07-26 15:19:18 +02:00
muellerr added 1 commit 2021-07-27 13:08:13 +02:00
Merge remote-tracking branch 'origin/development' into mueller/restructuring a94725c423
muellerr added 10 commits 2021-08-02 20:49:05 +02:00
Merge remote-tracking branch 'origin/development' into mueller/master b75c815361
various fixes and improvements e1f92b3da4
updated user folder 0b207b2b1a
smaller tweaks in CMakelists files 490ab440e5
added missing CMakeLists.txt 5bbe16081f
renamed some folders c0591c3d24
include changes aabc729e77
Merge branch 'mueller/master' of https://egit.irs.uni-stuttgart.de/fsfw/fsfw into mueller/master dee063e259
minor improvement for printout 0e5cfcf28f
Merge branch 'mueller/master' into mueller/restructuring 6f816b2592
muellerr added 2 commits 2021-08-02 20:55:35 +02:00
using _ instead of - now f1f167c2d1
Merge branch 'mueller/master' into mueller/restructuring 466f1e000f
muellerr commented 2021-08-02 20:55:35 +02:00
Author
Owner
Copy Link

Some changes to make the include namespace more explicit as suggested by @mohr:

  • hal/src/fsfw/hal changed to hal/src/fsfw_hal
  • contrib has fsfw-contrib folder now
  • tests/src/fsfw/tests changed to hal/src/fsfw_tests
Some changes to make the include namespace more explicit as suggested by @mohr: - `hal/src/fsfw/hal` changed to `hal/src/fsfw_hal` - contrib has `fsfw-contrib` folder now - `tests/src/fsfw/tests` changed to `hal/src/fsfw_tests`
muellerr added 1 commit 2021-08-02 20:59:06 +02:00
all include corrections c3fbe04fc6
mohr added 1 commit 2021-08-02 21:22:58 +02:00
wrong path for sgp4 include 4d9c07a1ec
muellerr added 2 commits 2021-08-03 18:47:13 +02:00
update README for moved logo ec00a84b29
Merge branch 'mueller/master' of https://egit.irs.uni-stuttgart.de/fsfw/fsfw into mueller/master 8b39248a33
mohr added Breaking API Change and removed API Change labels 2021-08-09 14:47:30 +02:00
muellerr requested review from mohr 2021-08-09 15:20:47 +02:00
mohr added 2 commits 2021-08-09 15:24:46 +02:00
Printer updates 2706b8fa24 
1. Only prefix is colored now
2. Minor formatting change
Merge pull request 'Printer updates' (#453) from mueller/updated-serviceinterface into mueller/restructuring 1c3770ce96 
Reviewed-on: #453
mohr added 5 commits 2021-08-09 15:39:20 +02:00
Linux HAL updates 90a1571707 
1. The type correction was merged as part of
   eive/fsfw#7 in the
   EIVE project. Quotation of PR

definition of getSpiParameters is `void getSpiParameters(spi::SpiModes& spiMode, uint32_t& spiSpeed, UncommonParameters* parameters = nullptr) const;`.

Here, size_t spiSpeed is passed, which implicitely gets converted to a temporary, which can not be bound to uint32_t& and, at least in gcc 9.3.0, leads to a compiler error.

2. Allow flushing the UART buffers
Merge branch 'mueller/restructuring' into mueller/hal-linux-spi-uart-update 1301988892
UartComIF check iter validity 62873c3118
Merge branch 'mueller/hal-linux-spi-uart-update' of https://egit.irs.uni-stuttgart.de/fsfw/fsfw into mueller/hal-linux-spi-uart-update 83b5ade6b7
Merge pull request 'Linux HAL updates' (#456) from mueller/hal-linux-spi-uart-update into mueller/restructuring 1fa59c5cae 
Reviewed-on: #456
mohr approved these changes 2021-08-09 15:42:02 +02:00
mohr merged commit d92a796705 into development 2021-08-09 16:00:27 +02:00
Sign in to join this conversation.
Reviewers
No Reviewers
mohr
Labels
Clear labels
API Change
Changes the API, so Users need to adapted
 Breaking API Change
Changes the API in a non backwards compatible way
 bug
Something is not working
 build
Issues related to the buildsystem, including CI
 cosmetics
Small change most users won't notice
 Documentation
Improvement of code documentation
 duplicate
This issue or pull request already exists
 feature
New feature
 help wanted
Need some help
 hotfix
Quick or important fix that is merged directly into master, causing a new revision
 invalid
#worksforme
 question
More information is needed
 Refactor
Contains a refactoring of some code
 Tests
Issues related to testing code
 wontfix
This won't be fixed
No Label Breaking API Change feature Refactor
Milestone
No items
No Milestone v2.0.0
Assignees
Clear assignees
ahinkel dwoodward gaisser hanke jenkins_buildfix lrajer meierj mohr muellerr taheran tbaumgartl
No Assignees mohr
2 Participants
Notifications
Due Date
No due date set.
Depends on
#444 QueueMapManager bugfix
fsfw/fsfw
Reference: fsfw/fsfw#445
Delete Branch "mueller/restructuring"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?