Browse Source

Add note about DWT cycle counter being requried for i2c

TheZoq2 3 years ago
parent
commit
7f33ced95f
1 changed files with 3 additions and 0 deletions
  1. 3 0
      src/i2c.rs

+ 3 - 0
src/i2c.rs

@@ -98,6 +98,9 @@ pub struct I2c<I2C, PINS> {
 }
 
 /// embedded-hal compatible blocking I2C implementation
+///
+/// **NOTE**: Before using blocking I2C, you need to enable the DWT cycle counter using the
+/// [DWT::enable_cycle_counter] method.
 pub struct BlockingI2c<I2C, PINS> {
     nb: I2c<I2C, PINS>,
     start_timeout: u32,