From patchwork Mon Jun 10 08:10:16 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Wolfram Sang X-Patchwork-Id: 803088 Received: from mail.zeus03.de (www.zeus03.de [194.117.254.33]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 79107210E7 for ; Mon, 10 Jun 2024 08:10:33 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=194.117.254.33 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1718007039; cv=none; b=SMQ1hjq0FkQOG8CrVj9EZTzNHqNdN5FC5D9FCppkOnKO1/PYEJH3NO1e87OIKnG5aJTHmGdUqwvMoPrioL5/VAq+5GZytRwOUopQz+V468dKBxGZ0tDmqUrH5j7Q96DrtpSN0SadD7moNDV7q8XtclUmVHZiHFsz6OkqcYUOIwU= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1718007039; c=relaxed/simple; bh=AaeKWFy6+MhJUSVDuiArePmxqwjpDms46lje4lfg78Y=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version:Content-Type; b=XL5rxRM9DG2xe4LinpjzXv9c0eXaylnuYRuKVoNrBp688+jlHUTTyJusp0bCmwsWEvmzmo9+m5eOdRxnFogiAng6dNYDGsHhEDIbqGutttbOzw2Fa4rUzSPG28It7YkCVudYbgD4KUVIwM8pCB6L3W46JG8xsQgxSD+21qpGpYE= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=sang-engineering.com; spf=pass smtp.mailfrom=sang-engineering.com; dkim=pass (2048-bit key) header.d=sang-engineering.com header.i=@sang-engineering.com header.b=YroE6mVk; arc=none smtp.client-ip=194.117.254.33 Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=sang-engineering.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=sang-engineering.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=sang-engineering.com header.i=@sang-engineering.com header.b="YroE6mVk" DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= sang-engineering.com; h=from:to:cc:subject:date:message-id :in-reply-to:references:mime-version:content-type :content-transfer-encoding; s=k1; bh=QxN9/peWzKBlFqRmDXEKD0iHTiZ lunJFWOblMthWaXk=; b=YroE6mVkcVqWLUGY8X1irPIdprRlZDn5mCvhCUJAbqL tCJFMlAb2NJEtMdR1SqZnpfMFJXlGm7GFfC9IfLtpEW9bdhxOYSp7K7hEjGzyo+a IYyMLPWoK62hpXma+lIVmCT03UzefcMUT2Vd7tVCjCBbaBWJX2Gk3M45ONZL1R6F DOzktZcEvT4Iq20Oi7CvP8POLSU4TCdDNLBzkt5rF9TWz3PbMfg1q388YgfZNV0k 8uuEjorBKKTu2jIvGdfw49JyqMXgekVSaIOf+ptd8bf4l3dowCgzuVbSYZSOZTWv smf9YarMkyV7kIhZVM2qVMVld78y2p8qXicvZr9NBsg== Received: (qmail 4192401 invoked from network); 10 Jun 2024 10:10:26 +0200 Received: by mail.zeus03.de with ESMTPSA (TLS_AES_256_GCM_SHA384 encrypted, authenticated); 10 Jun 2024 10:10:26 +0200 X-UD-Smtp-Session: l3s3148p1@tHeCroQavuYgAwDPXymAAHMyzy0c7Kdl From: Wolfram Sang To: linux-i2c@vger.kernel.org Cc: Easwar Hariharan , Andi Shyti , linux-doc@vger.kernel.org, Wolfram Sang , linux-kernel@vger.kernel.org Subject: [PATCH v2 1/6] docs: i2c: summary: start sentences consistently. Date: Mon, 10 Jun 2024 10:10:16 +0200 Message-ID: <20240610081023.8118-2-wsa+renesas@sang-engineering.com> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20240610081023.8118-1-wsa+renesas@sang-engineering.com> References: <20240610081023.8118-1-wsa+renesas@sang-engineering.com> Precedence: bulk X-Mailing-List: linux-i2c@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Change the first paragraphs to contain only one space after the end of the previous sentence like in the rest of the document. Signed-off-by: Wolfram Sang Reviewed-by: Easwar Hariharan --- Documentation/i2c/summary.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/Documentation/i2c/summary.rst b/Documentation/i2c/summary.rst index 786c618ba3be..28ff80a2302b 100644 --- a/Documentation/i2c/summary.rst +++ b/Documentation/i2c/summary.rst @@ -4,10 +4,10 @@ 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 +speed, up to 400 kHz), with a high speed extension (3.4 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, +low bandwidth communications needs. I2C is widely used with embedded +systems. Some systems use variants that don't meet branding requirements, and so are not advertised as being I2C but come under different names, e.g. TWI (Two Wire Interface), IIC. @@ -18,14 +18,14 @@ access the PDF. An older version of the specification (revision 6) is archived `here `_. SMBus (System Management Bus) is based on the I2C protocol, and is mostly -a subset of I2C protocols and signaling. Many I2C devices will work on an +a subset of I2C protocols and signaling. Many I2C devices will work on an SMBus, but some SMBus protocols add semantics beyond what is required to -achieve I2C branding. Modern PC mainboards rely on SMBus. The most common +achieve I2C branding. Modern PC mainboards rely on SMBus. The most common devices connected through SMBus are RAM modules configured using I2C EEPROMs, and hardware monitoring chips. Because the SMBus is mostly a subset of the generalized I2C bus, we can -use its protocols on many I2C systems. However, there are systems that don't +use its protocols on many I2C systems. However, there are systems that don't meet both SMBus and I2C electrical constraints; and others which can't implement all the common SMBus protocol semantics or messages. From patchwork Mon Jun 10 08:10:17 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Wolfram Sang X-Patchwork-Id: 803087 Received: from mail.zeus03.de (www.zeus03.de [194.117.254.33]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id A333556448 for ; Mon, 10 Jun 2024 08:10:34 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=194.117.254.33 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1718007039; cv=none; b=gLqDxSV70duvzA3NpSit4FnbygOx+8ChA7xCmJzGfEpDpjnBCJ4egPpwgTqnIMBs675z7E3bPgilwdgqk6MEa92IFm0Gb+VCNUt8MvV/5RhEoeJ3t/9NDzMfffxftf30rNwctfCgyVec9QUm0iLaMqYwwg06V2dM4SI7S8gNCYM= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1718007039; c=relaxed/simple; bh=tLa3YjKzTjbALrEqcR62zhXe0F7RUglCnTOQTHelM9A=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version:Content-Type; b=azLdzrqXhp+Xp2CTd/YXWMe+oQPfUmkVIaPYG1IlDCYl/d6AprL6wBi+3IC/pu0OG14wcsb2a6W3+zb3IwgFQIBl07rMp9vNmEBX3NB7ICkiwsSQeuWUafyfSNXGStXXG8B8Iw9hgKBI2RthY4J8VeqwtkfNIVINeriVocAD85A= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=sang-engineering.com; spf=pass smtp.mailfrom=sang-engineering.com; dkim=pass (2048-bit key) header.d=sang-engineering.com header.i=@sang-engineering.com header.b=NpvJJDjj; arc=none smtp.client-ip=194.117.254.33 Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=sang-engineering.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=sang-engineering.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=sang-engineering.com header.i=@sang-engineering.com header.b="NpvJJDjj" DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= sang-engineering.com; h=from:to:cc:subject:date:message-id :in-reply-to:references:mime-version:content-type :content-transfer-encoding; s=k1; bh=ns0TUqgMIMc2G1ba8motoRRT6bt z+ty/Oyg8gP8SWmY=; b=NpvJJDjju4aocgjXrrguTqsfukw30kDpkRlhhmPTKWQ a+LswuDRGK/41p1WNzcPvlgSeqOa/v/NMNKhz+A63l5Ahx8BKLu9BrX4j2k9rDMb 7nlVNSo0WbOpzTZ/7IpYmPWESYQG4J6mDxyrBIyUnQWp9/wIkX5sFEznrv4WANYs cKUUIWB3iB7g/ILe4JkVFjwHLpn5XDpdhoJOmJff+fMceCoery52dyqyP+bwco1/ ORU7vD9RUzD40vF998lMd5QSO5jAS/DXngGj9q2zRDdqFvpOGCZq8ma9FkUkdxRW MUoHAstq/IuEIMM7KqyTi1Fg0fN8yp7w931pY9xBWag== Received: (qmail 4192434 invoked from network); 10 Jun 2024 10:10:27 +0200 Received: by mail.zeus03.de with ESMTPSA (TLS_AES_256_GCM_SHA384 encrypted, authenticated); 10 Jun 2024 10:10:27 +0200 X-UD-Smtp-Session: l3s3148p1@42eOroQaxOYgAwDPXymAAHMyzy0c7Kdl From: Wolfram Sang To: linux-i2c@vger.kernel.org Cc: Easwar Hariharan , Andi Shyti , linux-doc@vger.kernel.org, Wolfram Sang , linux-kernel@vger.kernel.org Subject: [PATCH v2 2/6] docs: i2c: summary: update I2C specification link Date: Mon, 10 Jun 2024 10:10:17 +0200 Message-ID: <20240610081023.8118-3-wsa+renesas@sang-engineering.com> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20240610081023.8118-1-wsa+renesas@sang-engineering.com> References: <20240610081023.8118-1-wsa+renesas@sang-engineering.com> Precedence: bulk X-Mailing-List: linux-i2c@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Luckily, the specs are directly downloadable again, so update the link. Also update its title to the original name "I²C". Signed-off-by: Wolfram Sang Reviewed-by: Easwar Hariharan --- Documentation/i2c/summary.rst | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/Documentation/i2c/summary.rst b/Documentation/i2c/summary.rst index 28ff80a2302b..e3ab1d414014 100644 --- a/Documentation/i2c/summary.rst +++ b/Documentation/i2c/summary.rst @@ -11,11 +11,9 @@ systems. Some systems use variants that don't meet branding requirements, and so are not advertised as being I2C but come under different names, e.g. TWI (Two Wire Interface), IIC. -The latest official I2C specification is the `"I2C-bus specification and user -manual" (UM10204) `_ -published by NXP Semiconductors. However, you need to log-in to the site to -access the PDF. An older version of the specification (revision 6) is archived -`here `_. +The latest official I2C specification is the `"I²C-bus specification and user +manual" (UM10204) `_ +published by NXP Semiconductors, version 7 as of this writing. SMBus (System Management Bus) is based on the I2C protocol, and is mostly a subset of I2C protocols and signaling. Many I2C devices will work on an From patchwork Mon Jun 10 08:10:18 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Wolfram Sang X-Patchwork-Id: 803086 Received: from mail.zeus03.de (www.zeus03.de [194.117.254.33]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id A243557C8E for ; Mon, 10 Jun 2024 08:10:35 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=194.117.254.33 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1718007040; cv=none; b=huyJrS9ZyssHm5YAxL59GLgR1j/KVpJvZHymCGcHKt9V8qKBmQQi7KgdpysBJ6bL788S4TadCcY1Zig/FTEH7BRpp6NSr4JrdpiMhwIKldAuyU06A/p4E+H9dQX5PDIdKx0sIn38c0a2gDFX83ISxlvUI9qYOL5k/ggz481MAaQ= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1718007040; c=relaxed/simple; bh=tp/NGE8RxyPHEtfvReImUJ2XG70OLA+d30WQHKc29AY=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version:Content-Type; b=bI4EE+wWfXvhpFCA5Cq/1CzVg5cZEIoXN/ra6XguRB90GBs3WEJ8nTqk5PPPs2fUgA7eZEzKbXQPjbSoCJrAoScz2YAALNeMEUbNh3dXR/kCZ0xBnYRBmT21D9IwzQPNIWdm2Fp0+v1Zp73xy/BRQxDU0tdidzpyt9prMUunkL4= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=sang-engineering.com; spf=pass smtp.mailfrom=sang-engineering.com; dkim=pass (2048-bit key) header.d=sang-engineering.com header.i=@sang-engineering.com header.b=OfuLmN+Q; arc=none smtp.client-ip=194.117.254.33 Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=sang-engineering.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=sang-engineering.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=sang-engineering.com header.i=@sang-engineering.com header.b="OfuLmN+Q" DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= sang-engineering.com; h=from:to:cc:subject:date:message-id :in-reply-to:references:mime-version:content-type :content-transfer-encoding; s=k1; bh=CFQTXPUSMeT7AYVoruD7Npcs4kM +ge+9KCd3MJfEn/4=; b=OfuLmN+Q+W0aDkLcJCZ4mUk7jiEUuZ4JC+Z6tSZcVUX 2HmLO2jmontJoUW/aqt4hGsD3tajJViqRXKq3nrEcjhKz6GcGgahCc/UM5NZmPL4 xmqcAiB2NJbjSCJO8M/WUROWNmWh3rpt0IALcOTngo1zd5rwbLwIN5h8TwARIL+m IcMeH+qheGVLRiFVS5Z8C+lSSt2lVu1fGRlEzhWpt9B6Sfg9EAJXLLQLxJ1TtscE i2M/izCuQsEJKg1ZkkT6j0ynNEuCw2y4F5cJlvyD1dcUQYBhqD79cTXApX84SfQr mFdiJpONj6PFkxwwT2KHh1Y+q2aSob6+vRnOz021slQ== Received: (qmail 4192466 invoked from network); 10 Jun 2024 10:10:27 +0200 Received: by mail.zeus03.de with ESMTPSA (TLS_AES_256_GCM_SHA384 encrypted, authenticated); 10 Jun 2024 10:10:27 +0200 X-UD-Smtp-Session: l3s3148p1@Yk6broQa0OYgAwDPXymAAHMyzy0c7Kdl From: Wolfram Sang To: linux-i2c@vger.kernel.org Cc: Easwar Hariharan , Andi Shyti , linux-doc@vger.kernel.org, Wolfram Sang , linux-kernel@vger.kernel.org Subject: [PATCH v2 3/6] docs: i2c: summary: update speed mode description Date: Mon, 10 Jun 2024 10:10:18 +0200 Message-ID: <20240610081023.8118-4-wsa+renesas@sang-engineering.com> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20240610081023.8118-1-wsa+renesas@sang-engineering.com> References: <20240610081023.8118-1-wsa+renesas@sang-engineering.com> Precedence: bulk X-Mailing-List: linux-i2c@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Fastest I2C mode is 5 MHz. Update the docs and reword the paragraph slightly. Signed-off-by: Wolfram Sang Reviewed-by: Easwar Hariharan --- 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, From patchwork Mon Jun 10 08:10:19 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Wolfram Sang X-Patchwork-Id: 803354 Received: from mail.zeus03.de (www.zeus03.de [194.117.254.33]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id DAA9E57CA2 for ; Mon, 10 Jun 2024 08:10:36 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=194.117.254.33 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1718007039; cv=none; b=N+J9vWlSBbmH3SJCVZprbrV4i9l2JAPMRCwF/kqe2VRimthp4BScknhtwroEacSi39bHPBfqobdKxrD9FyuRIEVik+NdHVQuoP/7JadX9LlfMHrMX6VuAJbVIFVeC5at5KbNllavajpQpGLXJhXX90iNuvjzFLV2qAgyAAz8er4= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1718007039; c=relaxed/simple; bh=lbvWBWPi42NN2GkXA3mS6EUr+av6uArE9Nk3wjB6eD8=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=pvz/eEX3lxlBaBtiZpt8Vm3t6GF+EP747K+t3JiLJr4kkvCpWlt78Cm5BrbTLAeWUonIBs2SdcU+GCpBjO4pCpHz+EbBv1ZjLiAPA2J4zSIYWLZPRCGlr9y9rohMDnQD0AKqtT6Xt8bgB2A9AyKz8HSuxYohJaZWfzJwiVk+cRY= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=sang-engineering.com; spf=pass smtp.mailfrom=sang-engineering.com; dkim=pass (2048-bit key) header.d=sang-engineering.com header.i=@sang-engineering.com header.b=JeRYFG01; arc=none smtp.client-ip=194.117.254.33 Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=sang-engineering.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=sang-engineering.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=sang-engineering.com header.i=@sang-engineering.com header.b="JeRYFG01" DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= sang-engineering.com; h=from:to:cc:subject:date:message-id :in-reply-to:references:mime-version:content-transfer-encoding; s=k1; bh=xpWAgWIklcSs44NZ3ZsCd8hwUImHcWihjPcnMES+ZJY=; b=JeRYFG 01+8QmbPg7nY00/bZJymWb/3QCz9gCQd95+HMzx1WHUctFbxQzBxOat5uKbndKj9 JJ+G2txKNN30LyTZrGMnuJt3KQ0LFzPm6oXpHvdDjECcLkbt3kJljFz6ESEglzAK a/iUNpBkLnhtRgurNzK1J+9xXyLS6y9MO4Na8cshOixBFURXS6T2QY08raYUgaFj DkcHb/mrvF5czk+tFU9mKDwax2/8FaeFpaO9UVZm6xGAJ4YvFxMEDRLP5fOy/sKv 5epN4efGjq22//OXqcXh38rOfRXnTdAGNmjSF2GtyDHpJcA5a0PJocKbEppRST+7 J6s4E8x5kH9FIjEw== Received: (qmail 4192499 invoked from network); 10 Jun 2024 10:10:28 +0200 Received: by mail.zeus03.de with ESMTPSA (TLS_AES_256_GCM_SHA384 encrypted, authenticated); 10 Jun 2024 10:10:28 +0200 X-UD-Smtp-Session: l3s3148p1@RM6oroQa3uYgAwDPXymAAHMyzy0c7Kdl From: Wolfram Sang To: linux-i2c@vger.kernel.org Cc: Easwar Hariharan , Andi Shyti , linux-doc@vger.kernel.org, Wolfram Sang , linux-kernel@vger.kernel.org Subject: [PATCH v2 4/6] docs: i2c: summary: document use of inclusive language Date: Mon, 10 Jun 2024 10:10:19 +0200 Message-ID: <20240610081023.8118-5-wsa+renesas@sang-engineering.com> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20240610081023.8118-1-wsa+renesas@sang-engineering.com> References: <20240610081023.8118-1-wsa+renesas@sang-engineering.com> Precedence: bulk X-Mailing-List: linux-i2c@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 We now have the updated I2C specs and our own Code of Conduct, so we have all we need to switch over to the inclusive terminology. Define them here. Signed-off-by: Wolfram Sang --- Documentation/i2c/i2c_bus.svg | 15 ++++++++------- Documentation/i2c/summary.rst | 23 +++++++++++++++++------ 2 files changed, 25 insertions(+), 13 deletions(-) diff --git a/Documentation/i2c/i2c_bus.svg b/Documentation/i2c/i2c_bus.svg index 3170de976373..45801de4af7d 100644 --- a/Documentation/i2c/i2c_bus.svg +++ b/Documentation/i2c/i2c_bus.svg @@ -1,5 +1,6 @@ + I2CMaster + id="tspan1285">Controller Slave + id="tspan1287">Target Slave + id="tspan1287-6">Target Slave + id="tspan1287-9">Target X-Patchwork-Id: 803353 Received: from mail.zeus03.de (www.zeus03.de [194.117.254.33]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 5574171B45 for ; Mon, 10 Jun 2024 08:10:39 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=194.117.254.33 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1718007042; cv=none; b=ImKTMxalN0nzNlduWGk2qmCgrjPM8tFVaut3yw4CN/poRCEVxOhrijHpdBOWRevLFE8OAiiJV+qqrYEBKqCkhwkCxsdONV0nRvJkvxVSg1Bz29dn4Jyesb5wDJL1Os4kVcoeDGKutFF+vB7H93lph4NUasUq7AgaaXqC0luBZdk= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1718007042; c=relaxed/simple; bh=aSoXwM7AxjCYi4o5UPuDejbH07mKDQ5JXUxoQO258co=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=gppvtglDxM2rVy2aGLHm7DQSA/o0+Ssv2ff3uSaNptwWTImkGyTKCMp7NzL30JSsS0QiwYN1IXnkPMmweYM78GMMNaCnADmjdPQXn9Ulio8Cgl6TpftTfMuVZpn2HW2lu826E/e23WoUr6LmD1WAoSW+IaLEmudd28tvRD/RFmQ= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=sang-engineering.com; spf=pass smtp.mailfrom=sang-engineering.com; dkim=pass (2048-bit key) header.d=sang-engineering.com header.i=@sang-engineering.com header.b=fOJ3ANdm; arc=none smtp.client-ip=194.117.254.33 Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=sang-engineering.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=sang-engineering.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=sang-engineering.com header.i=@sang-engineering.com header.b="fOJ3ANdm" DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= sang-engineering.com; h=from:to:cc:subject:date:message-id :in-reply-to:references:mime-version:content-transfer-encoding; s=k1; bh=kPW6Z47SSMaFsqhDVQlxCvLx2hDU95KMb1LtJY99czE=; b=fOJ3AN dm6uYbD0EqFZCVW6nM5mULOgyWm4UJXZzb3h27EK1RrPcVFoR2gHpYDBe3cH0Onc X+LgIu9H4wkOzDMwNPok/lwTreUOkjMqCfbQi4sFvXJGEFm8XtkkvemNqaXnn7T2 xwGfAtUAP+dH7NIAUGU6ve3VZ461n2i78NN2HnzPuzX4GPvZq68VbJAoel9k+vVV EqU8slceu/iCe7lXzz4+4Ne//uVOawJhi5UvfvLaXzmxsZzt8xfiVRF0We4Ntxla RvSujTwOMvGPhwPA7Pr/7gXAI84nvOqYEawnDpAWqnSMgGe44q9TS09DfbB1sePi 9wCJX/HqbmNuOWgQ== Received: (qmail 4192516 invoked from network); 10 Jun 2024 10:10:29 +0200 Received: by mail.zeus03.de with ESMTPSA (TLS_AES_256_GCM_SHA384 encrypted, authenticated); 10 Jun 2024 10:10:29 +0200 X-UD-Smtp-Session: l3s3148p1@Kmi0roQa7OYgAwDPXymAAHMyzy0c7Kdl From: Wolfram Sang To: linux-i2c@vger.kernel.org Cc: Easwar Hariharan , Andi Shyti , linux-doc@vger.kernel.org, Wolfram Sang , linux-kernel@vger.kernel.org Subject: [PATCH v2 5/6] docs: i2c: summary: document 'local' and 'remote' targets Date: Mon, 10 Jun 2024 10:10:20 +0200 Message-ID: <20240610081023.8118-6-wsa+renesas@sang-engineering.com> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20240610081023.8118-1-wsa+renesas@sang-engineering.com> References: <20240610081023.8118-1-wsa+renesas@sang-engineering.com> Precedence: bulk X-Mailing-List: linux-i2c@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Because Linux can be a target as well, add terminology to differentiate between Linux being the target and Linux accessing targets. Signed-off-by: Wolfram Sang --- Documentation/i2c/summary.rst | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/Documentation/i2c/summary.rst b/Documentation/i2c/summary.rst index b10b6aaafcec..203f6c9b2472 100644 --- a/Documentation/i2c/summary.rst +++ b/Documentation/i2c/summary.rst @@ -49,11 +49,16 @@ whole class of I2C adapters. Each specific adapter driver either depends on an algorithm driver in the ``drivers/i2c/algos/`` subdirectory, or includes its own implementation. -A **target** chip is a node that responds to communications when addressed -by the controller. In Linux it is called a **client**. Client drivers are kept -in a directory specific to the feature they provide, for example -``drivers/media/gpio/`` for GPIO expanders and ``drivers/media/i2c/`` for -video-related chips. +A **target** chip is a node that responds to communications when addressed by a +controller. In the Linux kernel implementation it is called a **client**. While +targets are usually separate external chips, Linux can also act as a target +(needs hardware support) and respond to another controller on the bus. This is +then called a **local target**. In contrast, an external chip is called a +**remote target**. + +Client drivers are kept in a directory specific to the feature they +provide, for example ``drivers/media/gpio/`` for GPIO expanders and +``drivers/media/i2c/`` for video-related chips. For the example configuration in figure, you will need a driver for your I2C adapter, and drivers for your I2C devices (usually one driver for each From patchwork Mon Jun 10 08:10:21 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Wolfram Sang X-Patchwork-Id: 803085 Received: from mail.zeus03.de (www.zeus03.de [194.117.254.33]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 9F22A6BFCA for ; Mon, 10 Jun 2024 08:10:40 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=194.117.254.33 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1718007042; cv=none; b=Urob6yfgOuPbcHFuRnE8bptNlKylPLInBVW2fwsO5Y76tMCGnq71pRwGQEpIaN/U3aodvY9s/9sPbOr+rMRb75mJ6GWqBK86LxvERd+OJCsfPXmF305U+nV3SK4waH/G52PvkysHlpu+wuRwYG06LVZ3an/WtmAYuNEmjuGg7Qo= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1718007042; c=relaxed/simple; bh=YGdvbCsehvYJDIEB2j/KPv6aBB90Bcqxnbrz1sUyXJM=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=swT4ZYDLl/g9qSQc6awgRJXe//E6aHQxo/AgDV6uzzEK5Pff+T8px6yF9K0mTZ93G3rycKWbRCLyDPT8RBlraG2GK5GqmSF9mEFUctiY6p9jiZeeCBpOggECvgNp1ZqempZbN6VnmINO5fT1B1CPvlsD24vOR3dL73U7hnJC+ec= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=sang-engineering.com; spf=pass smtp.mailfrom=sang-engineering.com; dkim=pass (2048-bit key) header.d=sang-engineering.com header.i=@sang-engineering.com header.b=QHAoB3qI; arc=none smtp.client-ip=194.117.254.33 Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=sang-engineering.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=sang-engineering.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=sang-engineering.com header.i=@sang-engineering.com header.b="QHAoB3qI" DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= sang-engineering.com; h=from:to:cc:subject:date:message-id :in-reply-to:references:mime-version:content-transfer-encoding; s=k1; bh=3JXnpw5ZxCWydN83TijKpBvVC1rCL3jaX5ZlTBQ9Tn0=; b=QHAoB3 qIDn0AoFTW+ZRt+50jEUI+E070NwfUPUOcPZD7g2tU/+/Im9Gepibx0xjk8zbyz0 FwFPjWeAgbpsGC0NfhdqjrUKXVB4N06lPj0ozb3G5LhWOZqKTtv6NO3ZZkl5jcZX nMdfLLm9k5BCaQGfnVKWAekN0x35PiRuKGGLoLByNF/MnNfz+0EuD2XlIvyBrWm6 s/ACEkmj2HE5F2U42LYrBBCsJE0huz1IRITgeCkpf6pHya+UHmZo+wDTtq/pHk4R P3o6xWpaej1IkAqhKZFpQ/AgD+C9CPesJDUeTz0Q59GvR2ooipWYGjFKR/QFbh9n uXI4G63UIPfxDN+g== Received: (qmail 4192533 invoked from network); 10 Jun 2024 10:10:30 +0200 Received: by mail.zeus03.de with ESMTPSA (TLS_AES_256_GCM_SHA384 encrypted, authenticated); 10 Jun 2024 10:10:30 +0200 X-UD-Smtp-Session: l3s3148p1@69q/roQa8OYgAwDPXymAAHMyzy0c7Kdl From: Wolfram Sang To: linux-i2c@vger.kernel.org Cc: Easwar Hariharan , Andi Shyti , linux-doc@vger.kernel.org, Wolfram Sang , linux-kernel@vger.kernel.org Subject: [PATCH v2 6/6] docs: i2c: summary: rephrase paragraph explaining the figure Date: Mon, 10 Jun 2024 10:10:21 +0200 Message-ID: <20240610081023.8118-7-wsa+renesas@sang-engineering.com> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20240610081023.8118-1-wsa+renesas@sang-engineering.com> References: <20240610081023.8118-1-wsa+renesas@sang-engineering.com> Precedence: bulk X-Mailing-List: linux-i2c@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Use 'controller/target' and 'adapter/client' pairs consistently. Signed-off-by: Wolfram Sang --- Documentation/i2c/summary.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Documentation/i2c/summary.rst b/Documentation/i2c/summary.rst index 203f6c9b2472..da76c787a6c5 100644 --- a/Documentation/i2c/summary.rst +++ b/Documentation/i2c/summary.rst @@ -60,9 +60,9 @@ Client drivers are kept in a directory specific to the feature they provide, for example ``drivers/media/gpio/`` for GPIO expanders and ``drivers/media/i2c/`` for video-related chips. -For the example configuration in figure, you will need a driver for your -I2C adapter, and drivers for your I2C devices (usually one driver for each -device). +For the example configuration in the figure above, you will need one adapter +driver for the I2C controller, and client drivers for your I2C targets. Usually +one driver for each client. Outdated terminology --------------------