From 43d7b12c7d0d41c45273d420397940a793a0cb88 Mon Sep 17 00:00:00 2001 From: Pavel Kirienko Date: Sun, 7 Aug 2016 12:47:21 +0300 Subject: [PATCH] STM32 comments --- libuavcan_drivers/stm32/driver/include/uavcan_stm32/can.hpp | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/libuavcan_drivers/stm32/driver/include/uavcan_stm32/can.hpp b/libuavcan_drivers/stm32/driver/include/uavcan_stm32/can.hpp index 3d1fc2b372..1f7fea80b7 100644 --- a/libuavcan_drivers/stm32/driver/include/uavcan_stm32/can.hpp +++ b/libuavcan_drivers/stm32/driver/include/uavcan_stm32/can.hpp @@ -189,6 +189,7 @@ public: /** * Number of RX frames lost due to queue overflow. + * This is an atomic read, it doesn't require a critical section. */ uavcan::uint32_t getRxQueueOverflowCount() const { return rx_queue_.getOverflowCount(); } @@ -206,13 +207,13 @@ public: uavcan::uint32_t getVoluntaryTxAbortCount() const { return served_aborts_cnt_; } /** - * Returns number of frames pending in the RX queue. + * Returns the number of frames pending in the RX queue. * This is intended for debug use only. */ unsigned getRxQueueLength() const; /** - * Whether this iface had at least one successful IO since previous call of this method. + * Whether this iface had at least one successful IO since the previous call of this method. * This is designed for use with iface activity LEDs. */ bool hadActivity();