From patchwork Tue Apr 6 18:06:52 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Gustavo Pimentel X-Patchwork-Id: 1462972 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=vger.kernel.org (client-ip=23.128.96.18; helo=vger.kernel.org; envelope-from=linux-pci-owner@vger.kernel.org; receiver=) Authentication-Results: ozlabs.org; dkim=pass (2048-bit key; unprotected) header.d=synopsys.com header.i=@synopsys.com header.a=rsa-sha256 header.s=mail header.b=HXKVMpMZ; dkim-atps=neutral Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by ozlabs.org (Postfix) with ESMTP id 4FFFqN1cy9z9sVb for ; Wed, 7 Apr 2021 04:07:28 +1000 (AEST) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234141AbhDFSHc (ORCPT ); Tue, 6 Apr 2021 14:07:32 -0400 Received: from smtprelay-out1.synopsys.com ([149.117.87.133]:54100 "EHLO smtprelay-out1.synopsys.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232876AbhDFSHc (ORCPT ); Tue, 6 Apr 2021 14:07:32 -0400 Received: from mailhost.synopsys.com (mdc-mailhost2.synopsys.com [10.225.0.210]) (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 9FA2AC064C; Tue, 6 Apr 2021 18:07:22 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=synopsys.com; s=mail; t=1617732443; bh=3jN0W3NSIoO9aFezPc8bhncPnyJr7BMqeQk6UOqNiR8=; h=From:To:Subject:Date:From; b=HXKVMpMZJI7Fc08gK6YWrB5j2m/wfdYctEHQAOuY6Ag2tS6287owdx/wMWLBmy4/3 gkzqAmcpMsetKDJSXLaykERXPDzRKuc4+ul9XE0qBAtLFMAbxFnSR4mPCcts5LQfk+ DurcjFerSmR7z8Vz2GluL2U2LRxG3leFAjebtQ6/JyJkZfzH9bxcHYTczeqyr0W9ne YvIqxTjq0nc/JRY7kQ00UUPLbpX1q3czgIklZGtNI5kRSyufAEBjhf4EvBFLf8Jvy+ 7TQAAvJgLAws2BsRswcfOWiXthPe+JWYqtZxeNhecA8qYm0Dzc726EFDfAtiStVK0S Tir6AsbK1JWsA== Received: from de02dwvm009.internal.synopsys.com (de02dwvm009.internal.synopsys.com [10.225.17.73]) by mailhost.synopsys.com (Postfix) with ESMTP id 1517BA0094; Tue, 6 Apr 2021 18:07:17 +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] Documentation: misc-devices: Fix indentation, formatting, and update outdated info Date: Tue, 6 Apr 2021 20:06:52 +0200 Message-Id: <689d1827d98b2f7a51175ff1efd3a92d8191b28d.1617732412.git.gustavo.pimentel@synopsys.com> X-Mailer: git-send-email 2.7.4 Precedence: bulk List-ID: X-Mailing-List: linux-pci@vger.kernel.org Fixes indentation issues reported by doing *make htmldocs* as well some text formatting. Besides these fixes, there was some outdated information related to stop file interface in sysfs. 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 +