update changelog and docs

This commit is contained in:
Robin Müller 2022-05-11 11:29:28 +02:00
parent 56e4fca06f
commit ab2d7ca98f
No known key found for this signature in database
GPG Key ID: 71B58F8A3CDFA9AC
2 changed files with 13 additions and 4 deletions

View File

@ -60,8 +60,6 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
## Additions ## Additions
- Linux HAL: Getter functions for SPI speed and mode.
- Linux HAL: Add wiretapping option for I2C. Enabled with `FSFW_HAL_I2C_WIRETAPPING` defined to 1
- Dedicated Version class and constant `fsfw::FSFW_VERSION` containing version information - Dedicated Version class and constant `fsfw::FSFW_VERSION` containing version information
inside `fsfw/version.h` inside `fsfw/version.h`
PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/559 PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/559
@ -69,6 +67,17 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/592 PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/592
- `Subsystem`: New API to add table and sequence entries - `Subsystem`: New API to add table and sequence entries
## HAL
- SPI: Cache the SPI device in the communication interface. Architecturally, this makes a
lot more sense because each ComIF should be responsible for one SPI bus.
- SPI: Move the empty transfer to update the line polarity to separate function. This means
it is not automatically called when calling the setter function for SPI speed and mode.
The user should call this function after locking the CS mutex if multiple SPI devices with
differing speeds and modes are attached to one bus.
- SPI: Getter functions for SPI speed and mode.
- I2C: Add wiretapping option for I2C. Enabled with `FSFW_HAL_I2C_WIRETAPPING` defined to 1.
## Fixed ## Fixed
- TCP TMTC Server: `MutexGuard` was not created properly in - TCP TMTC Server: `MutexGuard` was not created properly in

View File

@ -65,8 +65,8 @@ class SpiComIF : public DeviceCommunicationIF, public SystemObject {
* the line state, which can be an issue on mode switches because the clock line will * the line state, which can be an issue on mode switches because the clock line will
* switch the state after the chip select is pulled low. * switch the state after the chip select is pulled low.
* *
* It is recommended to call this function after #setSpiSpeedAndMode if the SPI bus * It is recommended to call this function after #setSpiSpeedAndMode and after locking the
* has multiple SPI devices with different speed and SPI modes attached. * CS mutex if the SPI bus has multiple SPI devices with different speed and SPI modes attached.
* @param spiFd * @param spiFd
*/ */
void updateLinePolarity(int spiFd); void updateLinePolarity(int spiFd);