From patchwork Fri Jun 14 08:12:43 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Wolfram Sang X-Patchwork-Id: 804338 Received: from mail.zeus03.de (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 B220B186E44 for ; Fri, 14 Jun 2024 08:12:56 +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=1718352779; cv=none; b=o9gBhhD40236D3pDYYoQx/6YcREqh/dYwvc6b+575qaOmxVi/Y+776QxDT+1dJDaIaWTvjBkYbqX+K4kAMaJSxq+sJQtML0ETpypBGSfPluPWuurqZJCd63NtbBqtrRTpzx+Fqn2Slg+4HkRErZxwZUHTsA+5DH9brJdaNYYf0w= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1718352779; c=relaxed/simple; bh=rDqQbB8WtLI0sNUuiLmLKSokCC9jWiu+CRLfqoeNG94=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=m/jfucCJqX2jOCYHH0ZaPIpOS7e5t5u21F+KMk8U/q/LcP71axuMcUaAmaGlP6VeJ7DFmfYJVX6eodBHL7QIIS/zQZNXTF6+ZqFm2x+D0bKosZF3h6Rfk7HLcp/M6yWzyQINHl0SLtPITdsa7/n2rLiHNG7bKhf4UP7j0C2mXZU= 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=ZG+gE0qR; 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="ZG+gE0qR" 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=X8SjZrtr7vYauQzzWhyTb2doGzFDtsUQAd4VY9QcFf4=; b=ZG+gE0 qR4/l6m89NxA1cfDH+n/wgF34suN1R0ymF+jCl+Z6PTZbY5Tao7FqTIJy+G09vtO s598J//k8juh2k/SY7MUqEcA+miefoIMtl+yLEx10qNpmR3oy1KdO5zKrJtB504Q telfMoe47npiiefu3Vdx0YIQ2S9szU9HXhcW2R2E2CXyjtupUfnlM4CJuvbivM4G vh+5AIrIuurYeleTf6OtTn/MffD9EnaKfeHY+Hxf9ymwZoldmV6EyPApyzJlf/Ae SSzAZRPY9guvy6lFb00Z6nrSXHfRmS6LYnkXGeboAC4p0StFrV36UwWou3Vjcez8 Ahxif/tHBN8+8Ycg== Received: (qmail 1438207 invoked from network); 14 Jun 2024 10:12:50 +0200 Received: by mail.zeus03.de with ESMTPSA (TLS_AES_256_GCM_SHA384 encrypted, authenticated); 14 Jun 2024 10:12:50 +0200 X-UD-Smtp-Session: l3s3148p1@lN59LtUaKoIgAwDPXzjQABqqX1QYyOSW From: Wolfram Sang To: linux-i2c@vger.kernel.org Cc: Easwar Hariharan , linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, Andi Shyti , Wolfram Sang Subject: [PATCH v3 5/6] docs: i2c: summary: document 'local' and 'remote' targets Date: Fri, 14 Jun 2024 10:12:43 +0200 Message-ID: <20240614081239.7128-13-wsa+renesas@sang-engineering.com> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20240614081239.7128-8-wsa+renesas@sang-engineering.com> References: <20240614081239.7128-8-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 | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/Documentation/i2c/summary.rst b/Documentation/i2c/summary.rst index a6da1032fa06..ff8bda32b9c3 100644 --- a/Documentation/i2c/summary.rst +++ b/Documentation/i2c/summary.rst @@ -49,10 +49,15 @@ 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 +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**. + +Target drivers are kept in a directory specific to the feature they provide, +for example ``drivers/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