Received: by 2002:a05:6a10:9848:0:0:0:0 with SMTP id x8csp3507822pxf; Mon, 29 Mar 2021 04:20:16 -0700 (PDT) X-Google-Smtp-Source: ABdhPJz+3VQx5mMsF6/PozxeR0ATeea5dkZ1ZYsT0R4j5cUsirNyWpqmJgT8VAYGyiof5O5jgkWJ X-Received: by 2002:aa7:c0c7:: with SMTP id j7mr28036406edp.298.1617016815889; Mon, 29 Mar 2021 04:20:15 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1617016815; cv=none; d=google.com; s=arc-20160816; b=EFTbmYU2DmNt3HpUk/CdDcExGKI5ZQ0EnqjM4jFyOZkNt9GRBe7wxE8sjBHpexQfh/ 2WfFRb+S3FH2QcDQalqRuw/VK2+Ijqu6MHAevTAXO4UV5aElBe9DdbAwSP5W/r2cOfEU lOzo+QjOBRBIYTb8bAkw1xR1YJAwxBeUdn+MZht2165wgbo2mykbYDbzt94fu9llOwwF M+BczPbDZ6nHMbtae8Y7Nl7hRStQg3Ll+FWDqvlrTfVee/AWJMzWAGKepAx4elJyaq08 WtG2M3CEQD3PX+kKCiC8nZ1W1tMhES40+mysH4i1n3n7G7fpsZq65sBB+1jbS3sIFF/d m3CQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:references:in-reply-to:references:in-reply-to :message-id:date:subject:to:from:dkim-signature; bh=70ellf74jTzqp1gvld3u64Ynh47z3Ihg7usPx//ArrQ=; b=zZVgi83FZw3M1vAbeRz5ov/enJ8U3d+uEqXx8+u22KxO5k7Zp5v2Z68SUjisevY2XL 8fWSX00xZ3zMDIvhStpwR98s8tZriXru5Y4RR/0S3APvl/8ZWGeSegrWuwm6GRjkYqXx CT1hPHSxtXYjXP1rcC7imvUK5a0DD8rMxkKEhwZgQUpLAYgRbsYjJPH6NXO0rKutTW9f tAiFYSYyVr7fr3mVSf2EMZWunfq1Z9qKDN677vLpEvulFFqrDeYE4v9aJ0v9m6KK3emd u5NtXEn7q3A4pC5PS5jqJmYnBlVlR+Xyc1dsuZN3IalybUvPnGW6JbxqGSvg6j5421f0 Av8w== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@synopsys.com header.s=mail header.b=V+YLLAtj; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=QUARANTINE sp=QUARANTINE dis=NONE) header.from=synopsys.com Return-Path: Received: from vger.kernel.org (vger.kernel.org. [23.128.96.18]) by mx.google.com with ESMTP id u26si12280251ejx.30.2021.03.29.04.19.53; Mon, 29 Mar 2021 04:20:15 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18; Authentication-Results: mx.google.com; dkim=pass header.i=@synopsys.com header.s=mail header.b=V+YLLAtj; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=QUARANTINE sp=QUARANTINE dis=NONE) header.from=synopsys.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232665AbhC2LSm (ORCPT + 99 others); Mon, 29 Mar 2021 07:18:42 -0400 Received: from smtprelay-out1.synopsys.com ([149.117.87.133]:52364 "EHLO smtprelay-out1.synopsys.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232514AbhC2LSE (ORCPT ); Mon, 29 Mar 2021 07:18:04 -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 B170BC00E5; Mon, 29 Mar 2021 11:18:01 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=synopsys.com; s=mail; t=1617016682; bh=UPhDqPJc04hZvg9p3DifXdydjic8Klb257Kr3LfwRaI=; h=From:To:Subject:Date:In-Reply-To:References:In-Reply-To: References:From; b=V+YLLAtjiXK81Gk6zvhSAs4YmlwaaL/9LAjIJKg7Gg0bkNXkDJhukoQkFGg6vKywT 06XnRORAPkD/ocCspYVCLtDbKhw1GAklLXk1ASPlNbzDZfogTCWkv1DxhqT8+pE+A9 Hflf9PYVW+Qh+lWqwp0M0ILTr2/HROfO+IV1q+ti6+BM+fheZwbB2oAyCiT8S5oJTQ paq2i07c4gFBbU0t1wsiRgfXSSq94fuVOAj5dSSCcvUADR4GCu11Fp3WQOkrd4M3+M Ma9tRNceiiETWiXvNtP65eC/J4c5huZAA+oWUeo+QIlvitg6oGPPhYue9fgE8sBJdw rWL23DLJm/SMw== Received: from de02dwia024.internal.synopsys.com (de02dwia024.internal.synopsys.com [10.225.19.81]) by mailhost.synopsys.com (Postfix) with ESMTP id 4D224A022F; Mon, 29 Mar 2021 11:18:00 +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=20Wilczy=C5=84ski?= , Gustavo Pimentel Subject: [PATCH v10 2/4] Documentation: misc-devices: Add Documentation for dw-xdata-pcie driver Date: Mon, 29 Mar 2021 13:17:46 +0200 Message-Id: <764b9bf744d7fe20c7a216019eef8ddf482c1bd7.1617016509.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-kernel@vger.kernel.org Add Documentation for dw-xdata-pcie driver. Signed-off-by: Gustavo Pimentel --- Documentation/misc-devices/dw-xdata-pcie.rst | 40 ++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 Documentation/misc-devices/dw-xdata-pcie.rst diff --git a/Documentation/misc-devices/dw-xdata-pcie.rst b/Documentation/misc-devices/dw-xdata-pcie.rst new file mode 100644 index 00000000..fd75c93 --- /dev/null +++ b/Documentation/misc-devices/dw-xdata-pcie.rst @@ -0,0 +1,40 @@ +.. SPDX-License-Identifier: GPL-2.0 + +=========================================================================== +Driver for Synopsys DesignWare PCIe traffic generator (also known as xData) +=========================================================================== + +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 +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 -- 2.7.4