CHANGELOG.md

@@ -16,6 +16,15 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
   `IN` and `OUT` in `Direction` changed to `DIR_IN` and `DIR_OUT`.
   `CALLBACK` in `GpioTypes` changed to `TYPE_CALLBACK`
 
+## Removed
+
+- Removed the `HkSwitchHelper`. This module should not be needed anymore, now that the local
+  datapools have been implemented
+
+## Additions
+
+- Linux HAL: Add wiretapping option for I2C. Enabled with `FSFW_HAL_I2C_WIRETAPPING` defined to 1
+
 # [v4.0.0]
 
 ## Additions

src/fsfw/FSFW.h.in

@@ -62,4 +62,9 @@
 #define FSFW_HAL_I2C_WIRETAPPING            0
 #endif
 
+// Can be used for low-level debugging of the I2C bus
+#ifndef FSFW_HAL_I2C_WIRETAPPING
+#define FSFW_HAL_I2C_WIRETAPPING            0
+#endif
+
 #endif /* FSFW_FSFW_H_ */

src/fsfw/rmap/RMAP.h

@@ -169,8 +169,8 @@ class RMAP : public HasReturnvaluesIF {
    * @param buffer the data to write
    * @param length length of data
    * @return
-   *      - @c COMMAND_NULLPOINTER				datalen was != 0 but data was ==
+   *      - @c COMMAND_NULLPOINTER				datalen was != 0 but data was == NULL
-   * NULL in write command
+   * in write command
    *      - return codes of RMAPChannelIF::sendCommand()
    */
   static ReturnValue_t sendWriteCommand(RMAPCookie *cookie, const uint8_t *buffer, size_t length);
@@ -205,8 +205,8 @@ class RMAP : public HasReturnvaluesIF {
    * @param cookie to cookie to read from
    * @param expLength the expected maximum length of the reply
    * @return
-   *      - @c COMMAND_NULLPOINTER				datalen was != 0 but data was ==
+   *      - @c COMMAND_NULLPOINTER				datalen was != 0 but data was == NULL
-   * NULL in write command, or nullpointer in read command
+   * in write command, or nullpointer in read command
    *      - return codes of RMAPChannelIF::sendCommand()
    */
   static ReturnValue_t sendReadCommand(RMAPCookie *cookie, uint32_t expLength);

src/fsfw/rmap/RMAPChannelIF.h

@@ -75,11 +75,11 @@ class RMAPChannelIF {
    *      - @c RETURN_OK
    *      - @c COMMAND_NO_DESCRIPTORS_AVAILABLE 	no descriptors available for sending
    * command; command was not sent
-   *      - @c COMMAND_BUFFER_FULL				no receiver buffer available for
+   *      - @c COMMAND_BUFFER_FULL				no receiver buffer available for expected
-   * expected len; command was not sent
+   * len; command was not sent
-   *      - @c COMMAND_TOO_BIG					the data that was to be sent was too
+   *      - @c COMMAND_TOO_BIG					the data that was to be sent was too long for the
-   * long for the hw to handle (write command) or the expected len was bigger than maximal expected
+   * hw to handle (write command) or the expected len was bigger than maximal expected len (read
-   * len (read command) command was not sent
+   * command) command was not sent
    *      - @c COMMAND_CHANNEL_DEACTIVATED		the channel has no port set
    *      - @c NOT_SUPPORTED						if you dont feel like
    * implementing something...
@@ -97,8 +97,8 @@ class RMAPChannelIF {
    *      - @c REPLY_NO_REPLY				no reply was received
    *      - @c REPLY_NOT_SENT				command was not sent, implies no reply
    *      - @c REPLY_NOT_YET_SENT			command is still waiting to be sent
-   *      - @c WRITE_REPLY_INTERFACE_BUSY			Interface is busy (transmission
+   *      - @c WRITE_REPLY_INTERFACE_BUSY			Interface is busy (transmission buffer
-   * buffer still being processed)
+   * still being processed)
    *      - @c WRITE_REPLY_TRANSMISSION_ERROR		Interface encountered errors during last
    * operation, data could not be processed. (transmission error)
    *      - @c WRITE_REPLY_INVALID_DATA			Invalid data (amount / value)