diff options
| author | yn386 <wf.yn386@gmail.com> | 2022-09-19 10:14:27 +0900 |
|---|---|---|
| committer | Damien George <damien@micropython.org> | 2022-11-18 14:25:19 +1100 |
| commit | a74e4fabeb0d7bc4dc68284047248fa173f5237b (patch) | |
| tree | 073d0f8ecdca49e6563c554902b8e8da87c1152c /docs/library | |
| parent | 65d82066a8267d7dd96d747d09f9ed3883d40078 (diff) | |
stm32/i2c: Fix I2C frequency calc so it doesn't exceed requested rate.
Prior to this commit, the actual I2C frequency can be faster than specified
one and it may exceed the I2C's specification for Fast Mode. The frequency
of SCL should be less than or equal to 400KHz in Fast Mode.
This commit fixes this issue for F4 MCUs by rounding up the division in the
frequency calculation.
Diffstat (limited to 'docs/library')
| -rw-r--r-- | docs/library/machine.I2C.rst | 4 | ||||
| -rw-r--r-- | docs/library/pyb.I2C.rst | 4 |
2 files changed, 8 insertions, 0 deletions
diff --git a/docs/library/machine.I2C.rst b/docs/library/machine.I2C.rst index 2a33b1da4..0eb1b67f5 100644 --- a/docs/library/machine.I2C.rst +++ b/docs/library/machine.I2C.rst @@ -91,6 +91,10 @@ General Methods - *sda* is a pin object for the SDA line - *freq* is the SCL clock rate + In the case of hardware I2C the actual clock frequency may be lower than the + requested frequency. This is dependant on the platform hardware. The actual + rate may be determined by printing the I2C object. + .. method:: I2C.deinit() Turn off the I2C bus. diff --git a/docs/library/pyb.I2C.rst b/docs/library/pyb.I2C.rst index 24b9cb8c3..2c526854a 100644 --- a/docs/library/pyb.I2C.rst +++ b/docs/library/pyb.I2C.rst @@ -96,6 +96,10 @@ Methods that DMA transfers have more precise timing but currently do not handle bus errors properly) + The actual clock frequency may be lower than the requested frequency. + This is dependant on the platform hardware. The actual rate may be determined + by printing the I2C object. + .. method:: I2C.is_ready(addr) Check if an I2C device responds to the given address. Only valid when in controller mode. |