From patchwork Mon Sep 18 09:32:38 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bagas Sanjaya X-Patchwork-Id: 13389329 Received: from lindbergh.monkeyblade.net (lindbergh.monkeyblade.net [23.128.96.19]) (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 347C31C29E for ; Mon, 18 Sep 2023 09:34:52 +0000 (UTC) Received: from mail-pj1-x102c.google.com (mail-pj1-x102c.google.com [IPv6:2607:f8b0:4864:20::102c]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id EB55D1B4; Mon, 18 Sep 2023 02:34:18 -0700 (PDT) Received: by mail-pj1-x102c.google.com with SMTP id 98e67ed59e1d1-271d9823cacso3418013a91.1; Mon, 18 Sep 2023 02:34:18 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1695029658; x=1695634458; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=qUvK28FHha6/TPODXDcAyXI9rCsyy10y0ZpeI61dT8s=; b=eGtCMOSpfPkyeRHfJzpg4sLFF+oZUU8w53DeGPPEZ4VLQh4poFlZ1aVnB32RfEMDxs Qc67skvILAxKF0LzU6txT1UxueP4BhUsPqppWpeoqc08civQvhcoDEzG7SQOjcfGJRGc OcaDMpLL0CMzSlFybPfzhpJfgwSL5HHlvyAJ4pf1rUxwLGK/zJAvBe9705KPzskPjXaa p3dt5ZgTfZL44CjOCUK5eF86rA8py3Z5WpNg+MT+fK9iR62HfKSwPFGlKJOESW+EeME0 empDB1wtyXY55Hx6JRhHWx8Q7Ab2bTO1CP6nmaC9pEChssOxjPCcnVEsmPUAV0HSpQLW H13Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1695029658; x=1695634458; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=qUvK28FHha6/TPODXDcAyXI9rCsyy10y0ZpeI61dT8s=; b=a+9cU/+bgWGIKitKnIJJWCYgvN8alelD+GpRjdXSqWPhSfQuDFv/FDYcxndd3IcOrx zVRWvyuFGyRGJQ5xcfkwr2jnvvI4b/3s0Cui3T8BqibnZea0OtGCLq/RaYjyUp6JQsG7 bHRmVIG0LtP4qQFSGB3lhepen0f87CGF3WXlZFMCUVL4dOgXuYPYuCJG5D9YJhlcABmW CRV3r5tW4Um1GK0P8EptSQyDDEi0A/F59OC0eJKdkXOGDHTvYSSAL5pRsY21nSf/PjLD on0cMe4xyblxJTiJBUvFXyzPFmJ/detiQ+clxys8DJb5IcKTF8DQWL8xR9Gdq9YhOE7p CbPw== X-Gm-Message-State: AOJu0YyonJafmbY5OObawZcHbbqBna1yNkJF6Q3pmgCCsZZrN7zC12aX wi6ECnVUBNF8PLrsQwmwXEE= X-Google-Smtp-Source: AGHT+IGaQ5dMQ1cGSOMTB7KffVIsHovJUmmpxN/gzT3BqwESNFk0PNQLWHK/I1LnAZ5uWtNZ0Di/cg== X-Received: by 2002:a17:90b:890:b0:274:7de7:d6fa with SMTP id bj16-20020a17090b089000b002747de7d6famr7586704pjb.9.1695029658328; Mon, 18 Sep 2023 02:34:18 -0700 (PDT) Received: from debian.me ([103.124.138.83]) by smtp.gmail.com with ESMTPSA id 30-20020a17090a19de00b002694fee879csm9353848pjj.36.2023.09.18.02.34.15 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 18 Sep 2023 02:34:18 -0700 (PDT) From: Bagas Sanjaya To: Vadim Fedorenko , Arkadiusz Kubalewski , Jiri Pirko , Jonathan Corbet , "David S. Miller" Cc: Linux Kernel Mailing List , Linux Networking , Linux Documentation , Bagas Sanjaya , kernel test robot , Stephen Rothwell Subject: [PATCH 1/2] Documentation: dpll: Fix code blocks Date: Mon, 18 Sep 2023 16:32:38 +0700 Message-Id: <20230918093240.29824-2-bagasdotme@gmail.com> X-Mailer: git-send-email 2.40.1 In-Reply-To: <20230918093240.29824-1-bagasdotme@gmail.com> References: <20230918093240.29824-1-bagasdotme@gmail.com> Precedence: bulk X-Mailing-List: netdev@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-Developer-Signature: v=1; a=openpgp-sha256; l=2283; i=bagasdotme@gmail.com; h=from:subject; bh=iX8SWoRLzVX69nnlgwYeyuY20ly0EeLShmwQMvrkdc8=; b=owGbwMvMwCX2bWenZ2ig32LG02pJDKkcksY+a1U3HEkp4JieKLw7v8RoTXjkzHmp5UwTJ/9ua 2kQefC8o5SFQYyLQVZMkWVSIl/T6V1GIhfa1zrCzGFlAhnCwMUpABPRlWX478Lk2sslm8q0XdFy gtTNnRP7r83p93q8Lym3gmXH6ksCMxkZrp7ODHzPlpSht2dHZ3pF8qtcQ6/I8Edy6zcdM/oW+ZO fDQA= X-Developer-Key: i=bagasdotme@gmail.com; a=openpgp; fpr=701B806FDCA5D3A58FFB8F7D7C276C64A5E44A1D X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,FREEMAIL_FROM, RCVD_IN_DNSWL_BLOCKED,SPF_HELO_NONE,SPF_PASS autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net kernel test robot and Stephen Rothwell report htmldocs warnings: Documentation/driver-api/dpll.rst:427: WARNING: Error in "code-block" directive: maximum 1 argument(s) allowed, 18 supplied. .. code-block:: c ... Documentation/driver-api/dpll.rst:444: WARNING: Error in "code-block" directive: maximum 1 argument(s) allowed, 21 supplied. .. code-block:: c ... Documentation/driver-api/dpll.rst:474: WARNING: Error in "code-block" directive: maximum 1 argument(s) allowed, 12 supplied. .. code-block:: c ... Fix these above by adding missing blank line separator after code-block directive. Reported-by: kernel test robot Closes: https://lore.kernel.org/oe-kbuild-all/202309180456.lOhxy9gS-lkp@intel.com/ Reported-by: Stephen Rothwell Closes: https://lore.kernel.org/linux-next/20230918131521.155e9e63@canb.auug.org.au/ Fixes: dbb291f19393b6 ("dpll: documentation on DPLL subsystem interface") Signed-off-by: Bagas Sanjaya Reviewed-by: Vadim Fedorenko --- Documentation/driver-api/dpll.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/Documentation/driver-api/dpll.rst b/Documentation/driver-api/dpll.rst index bb52f1b8c0be31..01eb4de867036f 100644 --- a/Documentation/driver-api/dpll.rst +++ b/Documentation/driver-api/dpll.rst @@ -425,6 +425,7 @@ The simplest implementation is in the OCP TimeCard driver. The ops structures are defined like this: .. code-block:: c + static const struct dpll_device_ops dpll_ops = { .lock_status_get = ptp_ocp_dpll_lock_status_get, .mode_get = ptp_ocp_dpll_mode_get, @@ -442,6 +443,7 @@ structures are defined like this: The registration part is then looks like this part: .. code-block:: c + clkid = pci_get_dsn(pdev); bp->dpll = dpll_device_get(clkid, 0, THIS_MODULE); if (IS_ERR(bp->dpll)) { @@ -472,6 +474,7 @@ The registration part is then looks like this part: In the error path we have to rewind every allocation in the reverse order: .. code-block:: c + while (i) { --i; dpll_pin_unregister(bp->dpll, bp->sma[i].dpll_pin, &dpll_pins_ops, &bp->sma[i]); From patchwork Mon Sep 18 09:32:39 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bagas Sanjaya X-Patchwork-Id: 13389328 Received: from lindbergh.monkeyblade.net (lindbergh.monkeyblade.net [23.128.96.19]) (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 58A3D1C29F for ; Mon, 18 Sep 2023 09:34:52 +0000 (UTC) Received: from mail-pg1-x52a.google.com (mail-pg1-x52a.google.com [IPv6:2607:f8b0:4864:20::52a]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id ABABCD3; Mon, 18 Sep 2023 02:34:21 -0700 (PDT) Received: by mail-pg1-x52a.google.com with SMTP id 41be03b00d2f7-517ab9a4a13so3567177a12.1; Mon, 18 Sep 2023 02:34:21 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1695029661; x=1695634461; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=q6G1xYyE1NNaqnfLS7CDtUFGpGb/0lIiK2Jwl5R5oxI=; b=fB5b5XaVmPEj+anElM7/wARYMiej2CFGCiFQ7koRr9/WklRncxwWPtYKZD9VOcUtjD DuUJ63etBtX+ZYcdS3C6qm4zMP/kDlrs+0Zvy35fQ0QeJjCoWIAdJQvzmLn1ojgpq17i AIoqbfiNsJs4LSabnihuGW5gDkkP2FdjVlkzpzRuTbbdOQWc3cBhDjHvwuVsTvh4NTyu 8NpC+oXkthRIzfV96vr3jAc4wsBNv7NT/vfnh6SpcILbXukhQPoGXYxkLDVfPA/Vs6iz C4J8jnDke3w0+xqzMn6MdlW/2banLViybg9OswQbOpD81dE9Bx2IHkNQyaiPPFS8Fya1 fiJg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1695029661; x=1695634461; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=q6G1xYyE1NNaqnfLS7CDtUFGpGb/0lIiK2Jwl5R5oxI=; b=ItbXMURHcMJnM8+3jwCFZSHvKpsy2TM9gd2fjGVqQd8dJQPAi8A/rGosjPbv4BXc/s N77fhXU7Mcl45N1OhSCEsJKohTZ4FmZjl+UMDn/zcEpaW81f0NunOuQkHHS5lR77zbQt ZytHyXLD9A0xHH+PkXj8Vp2etTI60qIel1nrxa+9XrRQv66yplj2JB07J8svwldmCltk t+fxVttjaJWNmCchXQat3ylrbsZML7d2q2pPiItCWATze7ZJBUWm/GccTBSOlvviApMq pAhu0ewsJedbXu9gtdGUMWyRiyYg1z6oewNoIRx2mosAqx+YIddOYjwvpUon0jrhWcqX 6Ehg== X-Gm-Message-State: AOJu0Yyg7tzhi6HqmOJ9akIHPKTkVWIRfxsi9aFWfOhhHhyaodhBZ3bb ChLNRKNaII2UUO9A0IZnSDU= X-Google-Smtp-Source: AGHT+IFm99M0Df9AumnbyiG39jt6iyYrSQnDBT8geb5vG0E10iYCc342KUEf8lOfcQXeizvJ+WLjyQ== X-Received: by 2002:a17:90a:fb92:b0:274:6a79:17c1 with SMTP id cp18-20020a17090afb9200b002746a7917c1mr7507752pjb.15.1695029661068; Mon, 18 Sep 2023 02:34:21 -0700 (PDT) Received: from debian.me ([103.124.138.83]) by smtp.gmail.com with ESMTPSA id 30-20020a17090a19de00b002694fee879csm9353848pjj.36.2023.09.18.02.34.18 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 18 Sep 2023 02:34:20 -0700 (PDT) From: Bagas Sanjaya To: Vadim Fedorenko , Arkadiusz Kubalewski , Jiri Pirko , Jonathan Corbet , "David S. Miller" Cc: Linux Kernel Mailing List , Linux Networking , Linux Documentation , Bagas Sanjaya Subject: [PATCH 2/2] Documentation: dpll: wrap DPLL_CMD_PIN_GET output in a code block Date: Mon, 18 Sep 2023 16:32:39 +0700 Message-Id: <20230918093240.29824-3-bagasdotme@gmail.com> X-Mailer: git-send-email 2.40.1 In-Reply-To: <20230918093240.29824-1-bagasdotme@gmail.com> References: <20230918093240.29824-1-bagasdotme@gmail.com> Precedence: bulk X-Mailing-List: netdev@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-Developer-Signature: v=1; a=openpgp-sha256; l=1705; i=bagasdotme@gmail.com; h=from:subject; bh=uj4JKbL5vY/lq6EfpVPwFUuyIVX3awrGKWlV163bhVM=; b=owGbwMvMwCX2bWenZ2ig32LG02pJDKkckiYxXIbvJlx1u1HmtObVG6tMcYHsNwk3KpI7rp/9v 74mxU2go5SFQYyLQVZMkWVSIl/T6V1GIhfa1zrCzGFlAhnCwMUpABPRvsTI8FUgttGj5vvrCRbs p7fEd4axbVfb9vTR045aFYu9c2Ml7BgZppcqi0r4mXGLNDAuYzi5YuVbW4ffMs1rlt66UBy05ck 8DgA= X-Developer-Key: i=bagasdotme@gmail.com; a=openpgp; fpr=701B806FDCA5D3A58FFB8F7D7C276C64A5E44A1D X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,FREEMAIL_FROM, RCVD_IN_DNSWL_BLOCKED,SPF_HELO_NONE,SPF_PASS autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net DPLL_CMD_PIN_GET netlink command output for mux-type pins looks ugly with normal paragraph formatting. Format it as a code block instead. Signed-off-by: Bagas Sanjaya Reviewed-by: Vadim Fedorenko --- Documentation/driver-api/dpll.rst | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/Documentation/driver-api/dpll.rst b/Documentation/driver-api/dpll.rst index 01eb4de867036f..69670deb8c4e09 100644 --- a/Documentation/driver-api/dpll.rst +++ b/Documentation/driver-api/dpll.rst @@ -119,19 +119,19 @@ with. If a pin was registered with multiple parent pins, they behave like a multiple output multiplexer. In this case output of a ``DPLL_CMD_PIN_GET`` would contain multiple pin-parent nested -attributes with current state related to each parent, like: +attributes with current state related to each parent, like:: -'pin': [{{ - 'clock-id': 282574471561216, - 'module-name': 'ice', - 'capabilities': 4, - 'id': 13, - 'parent-pin': [ - {'parent-id': 2, 'state': 'connected'}, - {'parent-id': 3, 'state': 'disconnected'} - ], - 'type': 'synce-eth-port' - }}] + 'pin': [{{ + 'clock-id': 282574471561216, + 'module-name': 'ice', + 'capabilities': 4, + 'id': 13, + 'parent-pin': [ + {'parent-id': 2, 'state': 'connected'}, + {'parent-id': 3, 'state': 'disconnected'} + ], + 'type': 'synce-eth-port' + }}] Only one child pin can provide its signal to the parent MUX-type pin at a time, the selection is done by requesting change of a child pin state