diff mbox series

[3/5] docs: i2c: summary: update speed mode description

Message ID 20240607111726.12678-4-wsa+renesas@sang-engineering.com
State Superseded
Headers show
Series docs: i2c: summary: update and use inclusive wording | expand

Commit Message

Wolfram Sang June 7, 2024, 11:17 a.m. UTC
Fastest I2C mode is 5 MHz. Update the docs and reword the paragraph
slightly.

Signed-off-by: Wolfram Sang <wsa+renesas@sang-engineering.com>
---
 Documentation/i2c/summary.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Easwar Hariharan June 7, 2024, 6:15 p.m. UTC | #1
On 6/7/2024 4:17 AM, Wolfram Sang wrote:
> Fastest I2C mode is 5 MHz. Update the docs and reword the paragraph
> slightly.
> 
> Signed-off-by: Wolfram Sang <wsa+renesas@sang-engineering.com>
> ---
>  Documentation/i2c/summary.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/i2c/summary.rst b/Documentation/i2c/summary.rst
> index e3ab1d414014..a1e5c0715f8b 100644
> --- a/Documentation/i2c/summary.rst
> +++ b/Documentation/i2c/summary.rst
> @@ -3,8 +3,8 @@ Introduction to I2C and SMBus
>  =============================
>  
>  I²C (pronounce: I squared C and written I2C in the kernel documentation) is
> -a protocol developed by Philips. It is a slow two-wire protocol (variable
> -speed, up to 400 kHz), with a high speed extension (3.4 MHz). It provides
> +a protocol developed by Philips. It is a two-wire protocol with variable
> +speed (typically up to 400 kHz, high speed modes up to 5 MHz). It provides
>  an inexpensive bus for connecting many types of devices with infrequent or
>  low bandwidth communications needs. I2C is widely used with embedded
>  systems. Some systems use variants that don't meet branding requirements,

Looks good to me.

Reviewed-by: Easwar Hariharan <eahariha@linux.microsoft.com>
diff mbox series

Patch

diff --git a/Documentation/i2c/summary.rst b/Documentation/i2c/summary.rst
index e3ab1d414014..a1e5c0715f8b 100644
--- a/Documentation/i2c/summary.rst
+++ b/Documentation/i2c/summary.rst
@@ -3,8 +3,8 @@  Introduction to I2C and SMBus
 =============================
 
 I²C (pronounce: I squared C and written I2C in the kernel documentation) is
-a protocol developed by Philips. It is a slow two-wire protocol (variable
-speed, up to 400 kHz), with a high speed extension (3.4 MHz). It provides
+a protocol developed by Philips. It is a two-wire protocol with variable
+speed (typically up to 400 kHz, high speed modes up to 5 MHz). It provides
 an inexpensive bus for connecting many types of devices with infrequent or
 low bandwidth communications needs. I2C is widely used with embedded
 systems. Some systems use variants that don't meet branding requirements,