From patchwork Sat Apr 10 14:52:58 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Gustavo Pimentel X-Patchwork-Id: 12195647 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-18.8 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER, INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 2F14BC433B4 for ; Sat, 10 Apr 2021 14:53:11 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id F1D966044F for ; Sat, 10 Apr 2021 14:53:10 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234838AbhDJOxY (ORCPT ); Sat, 10 Apr 2021 10:53:24 -0400 Received: from smtprelay-out1.synopsys.com ([149.117.87.133]:36542 "EHLO smtprelay-out1.synopsys.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S234816AbhDJOxY (ORCPT ); Sat, 10 Apr 2021 10:53:24 -0400 Received: from mailhost.synopsys.com (mdc-mailhost1.synopsys.com [10.225.0.209]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) (No client certificate requested) by smtprelay-out1.synopsys.com (Postfix) with ESMTPS id 78580C0122; Sat, 10 Apr 2021 14:53:07 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=synopsys.com; s=mail; t=1618066389; bh=hSMiiE5yY/Kmol8iEahtysLfqdzwvrDySsXziVJjQ98=; h=From:To:Cc:Subject:Date:In-Reply-To:References:In-Reply-To: References:From; b=OmyWQdQTudifMc+fv8BFpCrGoAFVZZjeYyJlg94F7BRKwJ9tvrDsH3fxCOHIctXDp HpsKTVBJvZOaCgV6ypRHrN2oLbC/VzVRHYX1p4ct+Q6RHc7hNAYzwm++iWWXFIHmKe mIgWkBUR/kC445u6uJZgzx0hHozWOhRN3mpZcbAZjn+9Gv923aFeLcPGiPN9gEcOuW SYLiBX7cMqKCLHw8WB78nkIKHwbVTiHToXON7A938H3JJyHMVF4Gd/d+68UePCCB+l O4BE2pEDBnFIKDenb9Tdw+NOTxPLuQH4IeQ3T+Wck9Gvu+sCxCV1sn/sRwCk5Sf8fw 2+uQd92SuKfXg== Received: from de02dwvm009.internal.synopsys.com (de02dwvm009.internal.synopsys.com [10.225.17.73]) by mailhost.synopsys.com (Postfix) with ESMTP id 1382FA0231; Sat, 10 Apr 2021 14:53:06 +0000 (UTC) X-SNPS-Relay: synopsys.com From: Gustavo Pimentel To: linux-doc@vger.kernel.org, linux-pci@vger.kernel.org, linux-kernel@vger.kernel.org, Derek Kiernan , Dragan Cvetic , Arnd Bergmann , Andrew Morton , Greg Kroah-Hartman , Jonathan Corbet , Bjorn Helgaas , =?utf-8?q?Krzysztof_Wilczy=C5=84ski?= , Stephen Rothwell , Gustavo Pimentel Cc: Gustavo Pimentel Subject: [PATCH v4 1/2] dw-xdata-pcie: Fix documentation build warns Date: Sat, 10 Apr 2021 16:52:58 +0200 Message-Id: <42ed2d9d27579291dc7cce89c0164bd9255fe337.1618066164.git.gustavo.pimentel@synopsys.com> X-Mailer: git-send-email 2.7.4 In-Reply-To: References: In-Reply-To: References: Precedence: bulk List-ID: X-Mailing-List: linux-pci@vger.kernel.org Fixes documentation build warns related to indentation, text formatting, and missing reference on toc. This fix solves the following warnings: WARNING: Unexpected indentation. WARNING: Block quote ends without a blank line; unexpected unindent. WARNING: document isn't included in any toctree Fixes: e1181b5bbc3c ("Documentation: misc-devices: Add Documentation for dw-xdata-pcie driver") Link: https://lore.kernel.org/linux-next/20210406214615.40cf3493@canb.auug.org.au/ Reported-by: Stephen Rothwell Signed-off-by: Gustavo Pimentel --- Documentation/misc-devices/dw-xdata-pcie.rst | 14 +++++++------- Documentation/misc-devices/index.rst | 1 + 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/Documentation/misc-devices/dw-xdata-pcie.rst b/Documentation/misc-devices/dw-xdata-pcie.rst index fd75c93..cbc9f69 100644 --- a/Documentation/misc-devices/dw-xdata-pcie.rst +++ b/Documentation/misc-devices/dw-xdata-pcie.rst @@ -17,24 +17,24 @@ information to /var/log/kern.log or dmesg. Request write TLPs traffic generation - Root Complex to Endpoint direction - Command: - echo 1 > /sys/class/misc/dw-xdata-pcie/write +echo 1 > /sys/class/misc/dw-xdata-pcie/write Get write TLPs traffic link throughput in MB/s - Command: - cat /sys/class/misc/dw-xdata-pcie/write +cat /sys/class/misc/dw-xdata-pcie/write - Output example: - 204 +204 Request read TLPs traffic generation - Endpoint to Root Complex direction: - Command: - echo 1 > /sys/class/misc/dw-xdata-pcie/read +echo 1 > /sys/class/misc/dw-xdata-pcie/read Get read TLPs traffic link throughput in MB/s - Command: - cat /sys/class/misc/dw-xdata-pcie/read +cat /sys/class/misc/dw-xdata-pcie/read - Output example: - 199 +199 Request to stop any current TLP transfer: - Command: - echo 1 > /sys/class/misc/dw-xdata-pcie/stop +echo 1 > /sys/class/misc/dw-xdata-pcie/stop diff --git a/Documentation/misc-devices/index.rst b/Documentation/misc-devices/index.rst index 64420b331..30ac58f 100644 --- a/Documentation/misc-devices/index.rst +++ b/Documentation/misc-devices/index.rst @@ -19,6 +19,7 @@ fit into other categories. bh1770glc eeprom c2port + dw-xdata-pcie ibmvmc ics932s401 isl29003 From patchwork Sat Apr 10 14:52:59 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Gustavo Pimentel X-Patchwork-Id: 12195651 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-18.8 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER, INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id D7C64C43462 for ; Sat, 10 Apr 2021 14:53:11 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id AD49D610CD for ; Sat, 10 Apr 2021 14:53:11 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234865AbhDJOxZ (ORCPT ); Sat, 10 Apr 2021 10:53:25 -0400 Received: from smtprelay-out1.synopsys.com ([149.117.73.133]:54144 "EHLO smtprelay-out1.synopsys.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S234821AbhDJOxY (ORCPT ); Sat, 10 Apr 2021 10:53:24 -0400 Received: from mailhost.synopsys.com (mdc-mailhost1.synopsys.com [10.225.0.209]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) (No client certificate requested) by smtprelay-out1.synopsys.com (Postfix) with ESMTPS id 141B040473; Sat, 10 Apr 2021 14:53:07 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=synopsys.com; s=mail; t=1618066389; bh=FuCe6OfwyzCRHgde9lvKpsWM5qscJ9aMWtKpkEXQcXI=; h=From:To:Subject:Date:In-Reply-To:References:In-Reply-To: References:From; b=IEHJeHaeGBUYjuTYi2Tit/MOcuCrMey+Yv6UuFEd1rDe32Od55iDeWXbiOdg95M5v cX/DgnZMZ5FV/3/dKsneSBxuCkobz0c7HO+DVWHWCTUYHsmmYKArKQAB8HNH/1pC+2 XVesph6ayyAJ8syvOS7QZnRUke+rWkTFjyEdYDS1Rk4cBRcHeqm7EiUpKWI+/7tZVX Fq+osNxfyeFHEpoK43mLG/xuNPDCY/stuLHCbDHUkfs/j9eqLx7imnlUzatlx3Xzvo bXZi/H2lk2TmHmzCkqp4L8kL7xADO8h90wI/mHcs0zKyWhK5l3N6+WE/Xz0VS51bZm NyXa4q6+1BB5Q== Received: from de02dwvm009.internal.synopsys.com (de02dwvm009.internal.synopsys.com [10.225.17.73]) by mailhost.synopsys.com (Postfix) with ESMTP id 72C40A0232; Sat, 10 Apr 2021 14:53:06 +0000 (UTC) X-SNPS-Relay: synopsys.com From: Gustavo Pimentel To: linux-doc@vger.kernel.org, linux-pci@vger.kernel.org, linux-kernel@vger.kernel.org, Derek Kiernan , Dragan Cvetic , Arnd Bergmann , Andrew Morton , Greg Kroah-Hartman , Jonathan Corbet , Bjorn Helgaas , =?utf-8?q?Krzysztof_Wilczy=C5=84ski?= , Stephen Rothwell , Gustavo Pimentel Subject: [PATCH v4 2/2] dw-xdata-pcie: Update outdated info and improve text format Date: Sat, 10 Apr 2021 16:52:59 +0200 Message-Id: <4e72f931474a784d478e5a67961ecf116911997a.1618066164.git.gustavo.pimentel@synopsys.com> X-Mailer: git-send-email 2.7.4 In-Reply-To: References: In-Reply-To: References: Precedence: bulk List-ID: X-Mailing-List: linux-pci@vger.kernel.org Removes old information related to the stop file interface in sysfs left by mistake during patch revision. Improves the document text format to be more user-friendly and adds basic driver related information, such as support, datasheet, and author. Signed-off-by: Gustavo Pimentel --- Documentation/misc-devices/dw-xdata-pcie.rst | 76 ++++++++++++++++++---------- 1 file changed, 50 insertions(+), 26 deletions(-) diff --git a/Documentation/misc-devices/dw-xdata-pcie.rst b/Documentation/misc-devices/dw-xdata-pcie.rst index cbc9f69..781c679 100644 --- a/Documentation/misc-devices/dw-xdata-pcie.rst +++ b/Documentation/misc-devices/dw-xdata-pcie.rst @@ -4,37 +4,61 @@ Driver for Synopsys DesignWare PCIe traffic generator (also known as xData) =========================================================================== +Supported chips: +Synopsys DesignWare PCIe prototype solution + +Datasheet: +Not freely available + +Author: +Gustavo Pimentel + +Description +----------- + This driver should be used as a host-side (Root Complex) driver and Synopsys DesignWare prototype that includes this IP. -The "dw-xdata-pcie" driver can be used to enable/disable PCIe traffic +The dw-xdata-pcie driver can be used to enable/disable PCIe traffic generator in either direction (mutual exclusion) besides allowing the PCIe link performance analysis. The interaction with this driver is done through the module parameter and can be changed in runtime. The driver outputs the requested command state -information to /var/log/kern.log or dmesg. - -Request write TLPs traffic generation - Root Complex to Endpoint direction -- Command: -echo 1 > /sys/class/misc/dw-xdata-pcie/write - -Get write TLPs traffic link throughput in MB/s -- Command: -cat /sys/class/misc/dw-xdata-pcie/write -- Output example: -204 - -Request read TLPs traffic generation - Endpoint to Root Complex direction: -- Command: -echo 1 > /sys/class/misc/dw-xdata-pcie/read - -Get read TLPs traffic link throughput in MB/s -- Command: -cat /sys/class/misc/dw-xdata-pcie/read -- Output example: -199 - -Request to stop any current TLP transfer: -- Command: -echo 1 > /sys/class/misc/dw-xdata-pcie/stop +information to ``/var/log/kern.log`` or dmesg. + +Example +------- + +Write TLPs traffic generation - Root Complex to Endpoint direction +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Generate traffic:: + + # echo 1 > /sys/class/misc/dw-xdata-pcie.0/write + +Get link throughput in MB/s:: + + # cat /sys/class/misc/dw-xdata-pcie.0/write + 204 + +Stop traffic in any direction:: + + # echo 0 > /sys/class/misc/dw-xdata-pcie.0/write + +Read TLPs traffic generation - Endpoint to Root Complex direction +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Generate traffic:: + + # echo 1 > /sys/class/misc/dw-xdata-pcie.0/read + +Get link throughput in MB/s:: + + # cat /sys/class/misc/dw-xdata-pcie.0/read + 199 + +Stop traffic in any direction:: + + # echo 0 > /sys/class/misc/dw-xdata-pcie.0/read +