static_assert: SignalA SignalB @ same GPIO port

modm-io · Mar 21, 2021 · e6ffb6a · e6ffb6a
1 parent 2e3800e
commit e6ffb6a
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 7 deletions.
diff --git a/src/modm/driver/encoder/bitbang_encoder_input.hpp b/src/modm/driver/encoder/bitbang_encoder_input.hpp
@@ -19,15 +19,15 @@
 namespace modm
 {
 /**
- * @ingroup modm_driver_bitbang_encoder_input
- * @author  Thomas Sommer
+ * @ingroup 				modm_driver_bitbang_encoder_input
+ * @author  				Thomas Sommer
  *
  * @brief					This driver decodes a AB (incremental) encoder signal
  *
  * @tparam SignalA          First modm::platform::Gpio pin to input the encoder signal.
  * @tparam SignalB          Second modm::platform::Gpio pin to input the encoder signal.
  * @tparam POSTSCALER	 	n_cycles to count as one in-/decrement.
- * @tparam DeltaType	Must be signed integer and fit at least POSTSCALER. The Bigger
+ * @tparam DeltaType		Must be signed integer and fit at least POSTSCALER. The Bigger
  * 							DeltaType, the more inc-/decrements can be stored temporarily.
  */
 template<typename SignalA, typename SignalB, uint8_t POSTSCALER = 4,
@@ -38,9 +38,12 @@ class BitBangEncoderInput
 				  "POSTSCALER must be an integer to basis 2 and not 0: 1, 2, 4, 8, 16, ...");
 	static_assert(POSTSCALER <= std::numeric_limits<DeltaType>::max(),
 				  "DeltaType is to small for POSTSCALER.");
-
+	
 	using Phases = modm::platform::SoftwareGpioPort<SignalA, SignalB>;
 
+	static_assert(Phases::number_of_ports() == 1,
+				  "Signal A/B must be on the same GPIO port to prevent signal tearing!");
+
 	uint8_t inline getRaw();
 
 public:

diff --git a/src/modm/driver/encoder/bitbang_encoder_output.hpp b/src/modm/driver/encoder/bitbang_encoder_output.hpp
@@ -19,8 +19,8 @@ namespace modm
 {
 
 /**
- * @ingroup modm_driver_bitbang_encoder_output
- * @author  Raphael Lehmann
+ * @ingroup 				modm_driver_bitbang_encoder_output
+ * @author  				Raphael Lehmann
  *
  * @brief					This driver generates a AB (incremental) encoder signal to
  *							emulate a hardware encoder with a microcontroller.

diff --git a/src/modm/driver/encoder/bitbang_encoder_output_impl.hpp b/src/modm/driver/encoder/bitbang_encoder_output_impl.hpp
@@ -10,7 +10,7 @@
  */
 // ----------------------------------------------------------------------------
 
-#ifndef MODM_BITBANG_ENCODER_OUTPUT_IMPL_HPP
+#ifndef MODM_BITBANG_ENCODER_OUTPUT_HPP
 #error "Don't include this file directly, use 'bitbang_encoder_output.hpp' instead!"
 #endif
 #include "bitbang_encoder_output.hpp"