From b559cec29ebc64f1076b582ba8faa3a400ae0cc2 Mon Sep 17 00:00:00 2001 From: Affrin Pinhero Date: Fri, 2 Jul 2021 10:52:13 +0530 Subject: [PATCH] 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 --- targets/TARGET_STM/README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/targets/TARGET_STM/README.md b/targets/TARGET_STM/README.md index 245a93f666..f744e1d2c7 100644 --- a/targets/TARGET_STM/README.md +++ b/targets/TARGET_STM/README.md @@ -408,6 +408,31 @@ You can change this in you local mbed_app.json: } ``` +#### I2C TIming calculation algorothm + +I2C drivers version 2 use I2C timing register. + +Enable I2C timing algorithm by setting the value of `i2c_timing_value_algo` +target config to `true` + +``` +"i2c_timing_value_algo": { + "help": "If value was set to true I2C timing algorithm is + enabled. Enabling may leads to performance issue. Keeping this + false and changing system clock will trigger assert.", + "value": false + } +``` +Default configuration disables I2C timing algorithm. If user need to use +different system clock speed other than default system clock configuration. +Then I2C timing calculation algorithm need to enable. To enable + +``` +"i2c_timing_value_algo": { + "value": true + } +``` + ### Sleep feature