summaryrefslogtreecommitdiffstats
path: root/src/configuration.hpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/configuration.hpp')
-rw-r--r--src/configuration.hpp48
1 files changed, 20 insertions, 28 deletions
diff --git a/src/configuration.hpp b/src/configuration.hpp
index 4a41f24..92655a6 100644
--- a/src/configuration.hpp
+++ b/src/configuration.hpp
@@ -106,36 +106,28 @@ class configuration_t
active_message_set_ = id;
}
+ /// TODO: implement this function as method into can_bus class
+ /// @brief Pre initialize actions made before CAN bus initialization
+ /// @param[in] bus A CanBus struct defining the bus's metadata
+ /// @param[in] writable Configure the controller in a writable mode. If false, it will be configured as "listen only" and will not allow writes or even CAN ACKs.
+ /// @param[in] buses An array of all CAN buses.
+ /// @param[in] busCount The length of the buses array.
void pre_initialize(can_bus_dev_t* bus, bool writable, can_bus_dev_t* buses, const int busCount);
+ /// TODO: implement this function as method into can_bus class
+ /// @brief Post-initialize actions made after CAN bus initialization
+ /// @param[in] bus A CanBus struct defining the bus's metadata
+ /// @param[in] writable Configure the controller in a writable mode. If false, it will be configured as "listen only" and will not allow writes or even CAN ACKs.
+ /// @param[in] buses An array of all CAN buses.
+ /// @param[in] busCount The length of the buses array.
void post_initialize(can_bus_dev_t* bus, bool writable, can_bus_dev_t* buses, const int busCount);
+ /// TODO: implement this function as method into can_bus class
+ /// @brief Check if the device is connected to an active CAN bus, i.e. it's received a message in the recent past.
+ /// @return true if a message was received on the CAN bus within CAN_ACTIVE_TIMEOUT_S seconds.
void logBusStatistics(can_bus_dev_t* buses, const int busCount);
+ /// TODO: implement this function as method into can_bus class
+ /// @brief Log transfer statistics about all active CAN buses to the debug log.
+ /// @param[in] buses An array of active CAN buses.
+ /// @param[in] busCount The length of the buses array.
bool isBusActive(can_bus_dev_t* bus);
-};
-
-/// TODO: implement this function as method into can_bus class
-/// @brief Pre initialize actions made before CAN bus initialization
-/// @param[in] bus A CanBus struct defining the bus's metadata
-/// @param[in] writable Configure the controller in a writable mode. If false, it will be configured as "listen only" and will not allow writes or even CAN ACKs.
-/// @param[in] buses An array of all CAN buses.
-/// @param[in] busCount The length of the buses array.
-void pre_initialize(can_bus_dev_t* bus, bool writable, can_bus_dev_t* buses, const int busCount);
-
-/// TODO: implement this function as method into can_bus class
-/// @brief Post-initialize actions made after CAN bus initialization
-/// @param[in] bus A CanBus struct defining the bus's metadata
-/// @param[in] writable Configure the controller in a writable mode. If false, it will be configured as "listen only" and will not allow writes or even CAN ACKs.
-/// @param[in] buses An array of all CAN buses.
-/// @param[in] busCount The length of the buses array.
-void post_initialize(can_bus_dev_t* bus, bool writable, can_bus_dev_t* buses, const int busCount);
-
-/// TODO: implement this function as method into can_bus class
-/// @brief Check if the device is connected to an active CAN bus, i.e. it's received a message in the recent past.
-/// @return true if a message was received on the CAN bus within CAN_ACTIVE_TIMEOUT_S seconds.
-bool isBusActive(can_bus_dev_t* bus);
-
-/// TODO: implement this function as method into can_bus class
-/// @brief Log transfer statistics about all active CAN buses to the debug log.
-/// @param[in] buses An array of active CAN buses.
-/// @param[in] busCount The length of the buses array.
-void logBusStatistics(can_bus_dev_t* buses, const int busCount);
+};