fsfw/CHANGELOG.md

436 lines
13 KiB
Markdown
Raw Permalink Normal View History

2022-02-02 10:40:00 +01:00
Change Log
=======
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).
# [unreleased]
2022-02-22 11:37:38 +01:00
# [v5.0.0]
## Changes
2022-03-07 16:17:33 +01:00
- HAL Linux SPI: Set the Clock Default State when setting new SPI speed
and mode
PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/573
2022-03-08 09:02:40 +01:00
- GPIO HAL: `Direction`, `GpioOperation` and `Levels` are enum classes now, which prevents
2022-03-08 09:01:23 +01:00
name clashes with Windows defines.
PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/572
- New CMake option `FSFW_HAL_LINUX_ADD_LIBGPIOD` to specifically exclude `gpiod` code.
PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/572
2022-02-22 11:37:38 +01:00
- HAL Devicehandlers: Periodic printout is run-time configurable now
2022-02-22 11:29:23 +01:00
- `oneShotAction` flag in the `TestTask` class is not static anymore
- HAL Linux Uart: Baudrate and bits per word are enums now, avoiding misconfigurations
PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/585
2022-04-11 16:13:47 +02:00
- IPC Message Queue Handling: Allow passing an optional `MqArgs` argument into the MessageQueue
creation call. It allows passing context information and an arbitrary user argument into
the message queue. Also streamlined and simplified `MessageQueue` implementation for all OSALs
PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/583
2022-04-25 15:10:50 +02:00
- Clock:
- `timeval` to `TimeOfDay_t`
- Added Mutex for gmtime calls: (compare http://www.opengate.at/blog/2020/01/timeless/)
- Moved the statics used by Clock in ClockCommon.cpp to this file
- Better check for leap seconds
- Added Unittests for Clock (only getter)
2022-02-22 11:37:38 +01:00
2022-02-22 11:23:29 +01:00
## Removed
- Removed the `HkSwitchHelper`. This module should not be needed anymore, now that the local
2022-03-07 16:17:33 +01:00
datapools have been implemented.
PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/557
2022-02-22 11:23:29 +01:00
2022-02-22 11:22:20 +01:00
## Additions
- Linux HAL: Add wiretapping option for I2C. Enabled with `FSFW_HAL_I2C_WIRETAPPING` defined to 1
2022-03-10 09:36:36 +01:00
- Dedicated Version class and constant `fsfw::FSFW_VERSION` containing version information
inside `fsfw/version.h`
2022-03-07 16:17:33 +01:00
PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/559
2022-03-28 20:57:30 +02:00
- Added ETL dependency and improved library dependency management
PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/592
2022-02-22 11:22:20 +01:00
2022-04-11 17:30:27 +02:00
## Fixed
- Small bugfix in STM32 HAL for SPI
2022-04-11 17:32:01 +02:00
PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/599
2022-04-27 08:39:21 +02:00
- HAL GPIO: Improved error checking in `LinuxLibgpioIF::configureGpios(...)`. If a GPIO
configuration fails, the function will exit prematurely with a dedicated error code
PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/602
2022-04-11 17:30:27 +02:00
2022-02-02 10:40:00 +01:00
# [v4.0.0]
## Additions
- CFDP Packet Stack and related tests added. It also refactors the existing TMTC infastructure to
allow sending of CFDP packets to the CCSDS handlers.
PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/528
2022-02-07 13:44:25 +01:00
- added virtual function to print datasets
PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/544
- doSendRead Hook
PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/545
2022-02-14 16:42:40 +01:00
- Dockumentation for DHB
PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/551
### HAL additions
- Linux Command Executor, which can execute shell commands in blocking and non-blocking mode
PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/536
- uio Mapper
PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/543
2022-02-02 10:40:00 +01:00
## Changes
- Applied the `clang-format` auto-formatter to all source code
2022-02-07 13:44:25 +01:00
PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/534
- Updated Catch2 to v3.0.0-preview4
2022-02-07 13:44:25 +01:00
PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/538
2022-02-07 17:11:04 +01:00
- Changed CI to use prebuilt docker image
PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/549
2022-02-02 10:40:00 +01:00
## Bugfix
- CMake fixes in PR https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/533 , was problematic
if the uppermost user `CMakeLists.txt` did not have the include paths set up properly, which
could lead to compile errors that `#include "fsfw/FSFW.h"` was not found.
2022-02-07 17:11:04 +01:00
- Fix for build regression in Catch2 v3.0.0-preview4
PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/548
2022-02-14 16:42:40 +01:00
- Fix in unittest which failed on CI
PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/552
- Fix in helper script
PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/553
2022-02-02 10:40:00 +01:00
## API Changes
- Aforementioned changes to existing TMTC stack
2022-02-07 13:44:25 +01:00
## Known bugs
-
2022-02-07 13:44:25 +01:00
2022-02-04 13:45:09 +01:00
# [v3.0.1]
## API Changes
*
## Bugfixes
* Version number was not updated for v3.0.0 #542
## Enhancement
*
## Known bugs
*
2022-02-02 10:40:00 +01:00
# [v3.0.0]
## API Changes
#### TCP Socket Changes
* Keep Open TCP Implementation #496
* The socket will now kept open after disconnect. This allows reconnecting.
* Only one connection is allowed
* No internal influence but clients need to change their Code.
### GPIO IF
* Add feature to open GPIO by line name #506
### Bitutil
* Unittests for Op Divider and Bitutility #510
### Filesystem IF changed
* Filesystem Base Interface: Use IF instead of void pointer #511
### STM32
* STM32 SPI Updates #518
## Bugfixes
* Small bugfix for LIS3 handler #504
* Spelling fixed for function names #509
* CMakeLists fixes #517
* Out of bound reads and writes in unittests #519
* Bug in TmPacketStoredPusC (#478)
* Windows ifdef fixed #529
## Enhancement
* FSFW.h.in more default values #491
* Minor updates for PUS services #498
* HasReturnvaluesIF naming for parameter #499
* Tests can now be built as part of FSFW and versioning moved to CMake #500
* Added integration test code #508
* More printouts for rejected TC packets #505
* Arrayprinter format improvements #514
* Adding code for CI with docker and jenkins #520
* Added new function in SerializeAdapter #513
* Enables simple deSerialize if you keep track of the buffer position yourself
* `` static ReturnValue_t deSerialize(T *object, const uint8_t* buffer,
size_t* deserSize, SerializeIF::Endianness streamEndianness) ``
* Unittest helper scripts has a new Parameter to open the coverage html in the webrowser #525
* ``'-o', '--open', Open coverage data in webbrowser``
* Documentation updated. Sphinx Documentation can now be build with python script #526
## Known bugs
2022-02-04 13:45:09 +01:00
* Version number was not updated for v3.0.0 #542
2022-02-02 10:40:00 +01:00
All Pull Requests:
Milestone: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/milestone/19
# [v2.0.0]
## API Changes
### File Structure changed to fit more common structure
* See pull request (#445)
* HAL is now part of the main project
* **See Instructions below:**
#### 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`
* Changes in `DleEncoder.cpp`
* Create an instance of the `DleEncoder` first before calling the `encode` and `decode` functions
### Removed osal/linux/Timer (#486)
* Was redundant to timemanager/Countdown
#### Instruction how to update existing / user code
* Use timemanager/Countdown instead
## Bugfixes
### TM Stack
* Increased TM stack robustness by introducing `nullptr` checks and more printouts (#483)
#### Host OSAL / FreeRTOS
* QueueMapManager Bugfix (NO_QUEUE was used as MessageQueueId) (#444)
#### Events
* Event output is now consistent (#447)
#### DLE Encoder
* Fixed possible out of bounds access in DLE Encoder (#492)
## Enhancment
* HAL as major new feature, also includes three MEMS devicehandlers as part of #481
* Linux HAL updates (#456)
* FreeRTOS Header cleaning update and Cmake tweaks (#442)
* Printer updates (#453)
* New returnvalue for for empty PST (#485)
* TMTC Bridge: Increase limit of packets stored (#484)
## Known bugs
* Bug in TmPacketStoredPusC (#478)
All Pull Requests:
Milestone: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/milestone/5
# [v1.2.0]
2021-07-14 11:14:25 +02:00
## API Changes
### FSFW Architecture
2021-07-19 18:35:16 +02:00
- New src folder which contains all source files except the HAL, contributed code and test code
- External and internal API mostly stayed the same
2021-07-14 11:14:25 +02:00
- Folder names are now all smaller case: internalError was renamed to internalerror and
FreeRTOS was renamed to freertos
2021-07-19 18:35:16 +02:00
- Warning if optional headers are used but the modules was not added to the source files to compile
2021-07-14 11:14:25 +02:00
### HAL
- HAL added back into FSFW. It is tightly bound to the FSFW, and compiling it as a static library
made using it more complicated than necessary
## Bugfixes
### FreeRTOS QueueMapManager
- Fixed a bug which causes the first generated Queue ID to be invalid
## Enhancements
### FSFW Architecture
- See API changes chapter. This change will keep the internal API consistent in the future
2022-02-02 10:40:00 +01:00
# [v1.1.0]
2021-07-14 11:14:25 +02:00
## API Changes
2021-06-15 14:21:46 +02:00
### PUS
- Added PUS C support
2021-07-14 11:14:25 +02:00
- SUBSYSTEM_IDs added for PUS Services
- Added new Parameter which must be defined in config: fsfwconfig::FSFW_MAX_TM_PACKET_SIZE
### ObjectManager
- ObjectManager is now a singelton
2021-06-15 14:21:46 +02:00
### Configuration
- Additional configuration option fsfwconfig::FSFW_MAX_TM_PACKET_SIZE which
need to be specified in FSFWConfig.h
2021-07-14 11:14:25 +02:00
### CMake
- Changed Cmake FSFW_ADDITIONAL_INC_PATH to FSFW_ADDITIONAL_INC_PATHS
## Bugfixes
- timemanager/TimeStamperIF.h: Timestamp config was not used correctly, leading to different timestamp sizes than configured in fsfwconfig::FSFW_MISSION_TIMESTAMP_SIZE
- TCP server fixes
## Enhancements
### FreeRTOS Queue Handles
- Fixed an internal issue how FreeRTOS MessageQueues were handled
### Linux OSAL
- Better printf error messages
### CMake
- Check for C++11 as mininimum required Version
### Debug Output
- Changed Warning color to magenta, which is well readable on both dark and light mode IDEs
2021-06-15 14:21:46 +02:00
2021-07-14 11:14:25 +02:00
# Changes from ASTP 0.0.1 to 1.0.0
2020-11-24 13:45:34 +01:00
2020-12-05 10:41:37 +01:00
### Host OSAL
- Bugfix in MessageQueue, which caused the sender not to be set properly
2020-11-24 13:45:34 +01:00
### FreeRTOS OSAL
- vRequestContextSwitchFromISR is declared extern "C" so it can be defined in
a C file without issues
2020-12-01 14:01:04 +01:00
### PUS Services
2020-12-01 15:10:23 +01:00
- It is now possible to change the message queue depth for the telecommand verification service (PUS1)
2020-12-01 15:26:06 +01:00
- The same is possible for the event reporting service (PUS5)
2020-12-01 15:03:49 +01:00
- PUS Health Service added, which allows to command and retrieve health via PUS packets
2020-12-01 14:01:04 +01:00
### EnhancedControllerBase
- New base class for a controller which also implements HasActionsIF and HasLocalDataPoolIF
2020-12-01 13:52:40 +01:00
### Local Pool
2021-03-04 16:48:21 +01:00
- Interface of LocalPools has changed. LocalPool is not a template anymore. Instead the size and
bucket number of the pools per page and the number of pages are passed to the ctor instead of
2021-03-04 16:46:39 +01:00
two ctor arguments and a template parameter
2020-12-03 13:10:33 +01:00
### Parameter Service
2020-12-03 13:11:52 +01:00
- The API of the parameter service has been changed to prevent inconsistencies
between documentation and actual code and to clarify usage.
2020-12-03 13:10:33 +01:00
- The parameter ID now consists of:
1. Domain ID (1 byte)
2. Unique Identifier (1 byte)
3. Linear Index (2 bytes)
The linear index can be used for arrays as well as matrices.
The parameter load command now explicitely expects the ECSS PTC and PFC
information as well as the rows and column number. Rows and column will
default to one, which is equivalent to one scalar parameter (the most
important use-case)
2020-12-01 17:17:53 +01:00
### File System Interface
2021-03-04 16:48:21 +01:00
- A new interfaces specifies the functions for a software object which exposes the file system of
2021-03-04 16:46:39 +01:00
a given hardware to use message based file handling (e.g. PUS commanding)
2020-12-03 13:26:50 +01:00
### Internal Error Reporter
- The new internal error reporter uses the local data pools. The pool IDs for
the exisiting three error values and the new error set will be hardcoded for
now, the the constructor for the internal error reporter just takes an object
ID for now.
2020-12-01 15:22:18 +01:00
### Device Handler Base
- There is an additional `PERFORM_OPERATION` step for the device handler base. It is important
2021-03-04 16:46:39 +01:00
that DHB users adapt their polling sequence tables to perform this step. This steps allows for
a clear distinction between operation and communication steps
2020-12-22 12:53:03 +01:00
- setNormalDatapoolEntriesInvalid is not an abstract method and a default implementation was provided
2020-12-22 14:26:42 +01:00
- getTransitionDelayMs is now an abstract method
2020-12-22 12:53:03 +01:00
### DeviceHandlerIF
- Typo for UNKNOWN_DEVICE_REPLY
2020-12-01 17:45:23 +01:00
### Events
2020-12-08 14:51:36 +01:00
- makeEvent function: Now takes three input parameters instead of two and
allows setting a unique ID. Event.cpp source file removed, functions now
defined in header directly. Namespaces renamed. Functions declared `constexpr`
now
2020-12-15 15:20:08 +01:00
### Commanding Service Base
2021-03-04 16:46:39 +01:00
- CSB uses the new fsfwconfig::FSFW_CSB_FIFO_DEPTH variable to determine the FIFO depth for each
CSB instance. This variable has to be set in the FSFWConfig.h file
2021-01-03 15:31:44 +01:00
### Service Interface
- Proper printf support contained in ServiceInterfacePrinter.h
- CPP ostream support now optional (can reduce executable size by 150 - 250 kB)
- Amalagated header which determines automatically which service interface to use depending on FSFWConfig.h configuration.
Users can just use #include <fsfw/serviceinterface/ServiceInterface.h>
- If CPP streams are excluded, sif:: calls won't work anymore and need to be replaced by their printf counterparts.
For the fsfw, this can be done by checking the processor define FSFW_CPP_OSTREAM_ENABLED from FSFWConfig.h.
For mission code, developers need to replace sif:: calls by the printf counterparts, but only if the CPP stream are excluded.
If this is not the case, everything should work as usual.
2021-02-09 14:57:14 +01:00
2021-03-04 16:46:39 +01:00
### ActionHelper and ActionMessage
2021-03-04 16:45:35 +01:00
2021-03-04 16:46:39 +01:00
- ActionHelper finish function and ActionMessage::setCompletionReply now expects explicit
information whether to report a success or failure message instead of deriving it implicitely
from returnvalue
2021-03-04 16:45:35 +01:00
2021-02-09 14:57:14 +01:00
### PUS Parameter Service 20
2021-03-04 16:45:35 +01:00
Added PUS parameter service 20 (only custom subservices available).