From patchwork Mon Aug 22 09:10:48 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Luca Ceresoli X-Patchwork-Id: 599377 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 4E35DC28D13 for ; Mon, 22 Aug 2022 09:11:08 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234230AbiHVJLG (ORCPT ); Mon, 22 Aug 2022 05:11:06 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:58868 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S234210AbiHVJLC (ORCPT ); Mon, 22 Aug 2022 05:11:02 -0400 Received: from relay11.mail.gandi.net (relay11.mail.gandi.net [217.70.178.231]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id F42092F009; Mon, 22 Aug 2022 02:10:59 -0700 (PDT) Received: from booty.fritz.box (unknown [77.244.183.192]) (Authenticated sender: luca.ceresoli@bootlin.com) by mail.gandi.net (Postfix) with ESMTPA id DEAD2100011; Mon, 22 Aug 2022 09:10:56 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1661159458; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=cz3J51WuGNpz+PJJqTlvHHYBthbMkuACUKp1GmXcH1U=; b=KPSjBRqrXUNaYtx3oHiTpWIFHIU2JMXO7FQykFDDYg3ut1PM8DGXeiyDy/yJ85422B3RPI giqLImXfHukwGjMBasOghOMWG5ScSpgwAoMiSsCKp/+DHBs0dk+Iewo1YSSMYbEWiS3J4o W/nG4oUGMWbLqfwqxUWPHXqflfbz7Gi1wAfLfnp0OSX/GTz2jDjzBRJlCzqJ/IZ17OwMio Uf6X/5FcIdbPSsKCQCUZ+6AA4DyJc120TLn6CQehpo/Uu2LQpJqm8aXJA/wrpGt2jnlJ6C RCiPYyp2ZkIhNIprn8yla2/f6mePLqnV/F3Lr3zpjw1HOj28frz8J5qqcJ0TNw== From: luca.ceresoli@bootlin.com To: linux-doc@vger.kernel.org, linux-i2c@vger.kernel.org Cc: Luca Ceresoli , Wolfram Sang , Peter Rosin , linux-kernel@vger.kernel.org Subject: [PATCH v2 1/3] docs: i2c: i2c-topology: fix incorrect heading Date: Mon, 22 Aug 2022 11:10:48 +0200 Message-Id: <20220822091050.47099-2-luca.ceresoli@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20220822091050.47099-1-luca.ceresoli@bootlin.com> References: <20220822091050.47099-1-luca.ceresoli@bootlin.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-i2c@vger.kernel.org From: Luca Ceresoli "Etc" here was never meant to be a heading, it became one while converting to ReST. It would be easy to just convert it to plain text, but rather remove it and add an introductory text before the list that conveys the same meaning but with a better reading flow. Fixes: ccf988b66d69 ("docs: i2c: convert to ReST and add to driver-api bookset") Signed-off-by: Luca Ceresoli --- Changed in v2: none --- Documentation/i2c/i2c-topology.rst | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/Documentation/i2c/i2c-topology.rst b/Documentation/i2c/i2c-topology.rst index 7cb53819778e..1b11535c8946 100644 --- a/Documentation/i2c/i2c-topology.rst +++ b/Documentation/i2c/i2c-topology.rst @@ -5,6 +5,8 @@ I2C muxes and complex topologies There are a couple of reasons for building more complex I2C topologies than a straight-forward I2C bus with one adapter and one or more devices. +Some example use cases are: + 1. A mux may be needed on the bus to prevent address collisions. 2. The bus may be accessible from some external bus master, and arbitration @@ -14,9 +16,6 @@ than a straight-forward I2C bus with one adapter and one or more devices. from the I2C bus, at least most of the time, and sits behind a gate that has to be operated before the device can be accessed. -Etc -=== - These constructs are represented as I2C adapter trees by Linux, where each adapter has a parent adapter (except the root adapter) and zero or more child adapters. The root adapter is the actual adapter that issues From patchwork Mon Aug 22 09:10:50 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Luca Ceresoli X-Patchwork-Id: 599376 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 1A0D8C28D13 for ; Mon, 22 Aug 2022 09:11:17 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234270AbiHVJLO (ORCPT ); Mon, 22 Aug 2022 05:11:14 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:58822 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S234223AbiHVJLF (ORCPT ); Mon, 22 Aug 2022 05:11:05 -0400 Received: from relay11.mail.gandi.net (relay11.mail.gandi.net [217.70.178.231]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 9EE352F394; Mon, 22 Aug 2022 02:11:01 -0700 (PDT) Received: from booty.fritz.box (unknown [77.244.183.192]) (Authenticated sender: luca.ceresoli@bootlin.com) by mail.gandi.net (Postfix) with ESMTPA id 680DA100015; Mon, 22 Aug 2022 09:10:59 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1661159460; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=Zj/2REijE3zPLLtMEabFdtuhZMR0wF7GWbZ6HPCLFdc=; b=Sj/rhWYF57wjxSrCwt56XER4Hx8VgWt3V2KKTL2W0vs6kgsukNavV6b6IqZStp9mXZogeE HOWm00d91osgpMkCQPNJw35eIKyiV7Ex0sl8ZADGTjAPtjRS1f+1wvybN5XBC17w22qPn9 XxeymR+v5+FQ/kAMH+NWTqyg0pFtPwIub9dZqBk26Jc4GQC7KCWIKJuuHuZasnXitx9VVb H90kjwDtrgvLtAbKtWW0JNL8DJGERN2Lfn7xHDNEhkf4IBLiCrWjlwk2pCRdaRmvuTy3km xqK93v2xhmbb/2ZjRF3p0mHGtznv+xE6b16MJd9c5PuqX1+5R1lcRbFgL05MSQ== From: luca.ceresoli@bootlin.com To: linux-doc@vger.kernel.org, linux-i2c@vger.kernel.org Cc: Luca Ceresoli , Wolfram Sang , Peter Rosin , linux-kernel@vger.kernel.org, Bagas Sanjaya Subject: [PATCH v2 3/3] docs: i2c: i2c-topology: fix typo Date: Mon, 22 Aug 2022 11:10:50 +0200 Message-Id: <20220822091050.47099-4-luca.ceresoli@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20220822091050.47099-1-luca.ceresoli@bootlin.com> References: <20220822091050.47099-1-luca.ceresoli@bootlin.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-i2c@vger.kernel.org From: Luca Ceresoli "intension" should have probably been "intention", however "intent" seems even better. Reported-by: Bagas Sanjaya Signed-off-by: Luca Ceresoli Acked-by: Peter Rosin --- Changed in v2: - this patch is new in v2 --- Documentation/i2c/i2c-topology.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/i2c/i2c-topology.rst b/Documentation/i2c/i2c-topology.rst index 6f2da7f386fd..65ed76bc979f 100644 --- a/Documentation/i2c/i2c-topology.rst +++ b/Documentation/i2c/i2c-topology.rst @@ -102,7 +102,7 @@ When using a mux-locked mux, be aware of the following restrictions: I.e. the select-transfer-deselect transaction targeting e.g. device address 0x42 behind mux-one may be interleaved with a similar operation targeting device address 0x42 behind mux-two. The - intension with such a topology would in this hypothetical example + intent with such a topology would in this hypothetical example be that mux-one and mux-two should not be selected simultaneously, but mux-locked muxes do not guarantee that in all topologies.