Skip to content

Commit b559cec

Browse files
I2C: STM32: Upating documentation for I2C timing Algorithm
This commit modifies readme file. Descption for using I2C timing algorithm and how to enable and disable included. Signed-off-by: Affrin Pinhero <[email protected]>
1 parent d8cbd68 commit b559cec

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

targets/TARGET_STM/README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -408,6 +408,31 @@ You can change this in you local mbed_app.json:
408408
}
409409
```
410410

411+
#### I2C TIming calculation algorothm
412+
413+
I2C drivers version 2 use I2C timing register.
414+
415+
Enable I2C timing algorithm by setting the value of `i2c_timing_value_algo`
416+
target config to `true`
417+
418+
```
419+
"i2c_timing_value_algo": {
420+
"help": "If value was set to true I2C timing algorithm is
421+
enabled. Enabling may leads to performance issue. Keeping this
422+
false and changing system clock will trigger assert.",
423+
"value": false
424+
}
425+
```
426+
Default configuration disables I2C timing algorithm. If user need to use
427+
different system clock speed other than default system clock configuration.
428+
Then I2C timing calculation algorithm need to enable. To enable
429+
430+
```
431+
"i2c_timing_value_algo": {
432+
"value": true
433+
}
434+
```
435+
411436

412437
### Sleep feature
413438

0 commit comments

Comments
 (0)