Skip to content

Commit cb78629

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 cb78629

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

targets/TARGET_STM/README.md

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

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

412436
### Sleep feature
413437

0 commit comments

Comments
 (0)