From patchwork Wed Apr 7 20:31:48 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Gustavo Pimentel X-Patchwork-Id: 12189343 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,URIBL_BLOCKED, 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 2E53AC433B4 for ; Wed, 7 Apr 2021 20:32:16 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 04DF861184 for ; Wed, 7 Apr 2021 20:32:16 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S235864AbhDGUcV (ORCPT ); Wed, 7 Apr 2021 16:32:21 -0400 Received: from smtprelay-out1.synopsys.com ([149.117.87.133]:35192 "EHLO smtprelay-out1.synopsys.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S234326AbhDGUcS (ORCPT ); Wed, 7 Apr 2021 16:32:18 -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 CCB90C0968; Wed, 7 Apr 2021 20:32:06 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=synopsys.com; s=mail; t=1617827528; bh=wpjbAZiEScHdjICXEd8kp+dWyXu3MmJRyQaO1oa27is=; h=From:To:Cc:Subject:Date:In-Reply-To:References:In-Reply-To: References:From; b=mCE/jU522M16vZ2tcE7+1Zrgr4WHmWsdS7UBfp3LmLDO99bR3JvHXkVTAxj/x4afE +GE5bMCoAsQcv+IYO//CuW6lWqFpHooRKvrCnssDHtTwU3ENqOjmI4F6PvlAHUJZDC Pv0tgCY2irE8uwxsqTdZ19QJew2P2mGz3Oqjp5Zi1L+2F7vPOR0HtidRyxT1gW3GtI CMs6lMFZEsb8LBC+HX0tZNQRwJXt7UKtRi1XQO9AToXTm8EPJGkVb30JOOzHMrk3Th I3rA5w/vGq0h++urwLvLEYlAE5ZM/uHnQ/Vi2XjhfukgMPNUahLRlJ/FFG5TjSGrXb bky0H6GkGacbw== Received: from de02dwvm009.internal.synopsys.com (de02dwvm009.internal.synopsys.com [10.225.17.73]) by mailhost.synopsys.com (Postfix) with ESMTP id 07211A0231; Wed, 7 Apr 2021 20:32:05 +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 v3 1/2] dw-xdata-pcie: Fix documentation build warns and update outdated info Date: Wed, 7 Apr 2021 22:31:48 +0200 Message-Id: <5e1bc55d098322908ebdf1c32512acad5b65d4d7.1617827290.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 warnings related to indentation and text formatting, such as: Documentation/misc-devices/dw-xdata-pcie.rst:20: WARNING: Unexpected indentation. Documentation/misc-devices/dw-xdata-pcie.rst:24: WARNING: Unexpected indentation. Documentation/misc-devices/dw-xdata-pcie.rst:25: WARNING: Block quote ends without a blank line; unexpected unindent. Documentation/misc-devices/dw-xdata-pcie.rst:30: WARNING: Unexpected indentation. Documentation/misc-devices/dw-xdata-pcie.rst:34: WARNING: Unexpected indentation. Documentation/misc-devices/dw-xdata-pcie.rst:35: WARNING: Block quote ends without a blank line; unexpected unindent. Documentation/misc-devices/dw-xdata-pcie.rst:40: WARNING: Unexpected indentation. Also fixes some outdated information related to stop file interface in sysfs. 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 | 62 +++++++++++++++++++--------- 1 file changed, 43 insertions(+), 19 deletions(-) diff --git a/Documentation/misc-devices/dw-xdata-pcie.rst b/Documentation/misc-devices/dw-xdata-pcie.rst index fd75c93..a956e1a 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 + +Data sheet: +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. +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 -Request write TLPs traffic generation - Root Complex to Endpoint direction -- Command: - echo 1 > /sys/class/misc/dw-xdata-pcie/write +Get link throughput in MB/s:: -Get write TLPs traffic link throughput in MB/s -- Command: - cat /sys/class/misc/dw-xdata-pcie/write -- Output example: + # cat /sys/class/misc/dw-xdata-pcie.0/write 204 -Request read TLPs traffic generation - Endpoint to Root Complex direction: -- Command: - echo 1 > /sys/class/misc/dw-xdata-pcie/read +Stop traffic in any direction:: -Get read TLPs traffic link throughput in MB/s -- Command: - cat /sys/class/misc/dw-xdata-pcie/read -- Output example: + # 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 -Request to stop any current TLP transfer: -- Command: - echo 1 > /sys/class/misc/dw-xdata-pcie/stop +Stop traffic in any direction:: + + # echo 0 > /sys/class/misc/dw-xdata-pcie.0/read +