From mboxrd@z Thu Jan 1 00:00:00 1970 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.7 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 E6437C433DB for ; Tue, 2 Feb 2021 17:05:18 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id B91C664E3F for ; Tue, 2 Feb 2021 17:05:18 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S237171AbhBBREd (ORCPT ); Tue, 2 Feb 2021 12:04:33 -0500 Received: from smtprelay-out1.synopsys.com ([149.117.87.133]:37846 "EHLO smtprelay-out1.synopsys.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S237033AbhBBQ5v (ORCPT ); Tue, 2 Feb 2021 11:57:51 -0500 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 C216FC00BB; Tue, 2 Feb 2021 16:56:49 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=synopsys.com; s=mail; t=1612285009; bh=xjFl0ry1f4kLV7eWV2SxeXcHKekFmdWi7FGEn+fooAU=; h=From:To:Cc:Subject:Date:In-Reply-To:References:In-Reply-To: References:From; b=Dqy7n9FJUj7E9G+Two1YIWVoz+lOZO6zZB5i0AKU1ULrcUFx7gc3I++1FBKdND6Ww 53kbqq9KctPB55GRZGw1DSc5slOwu6MBDGN/3FY8hfsnAM/wiUBglG8kR/PqpaC8/Z 5xwLVCu1jcfMm/NEBCn/viJzV/L1iSV8XDmmQl2WR7Tk1N8rJ99ckW5oD3PJQXn5sT Unwj8x6C3vlAwy8f8echlrYiaI85p7MwT4PX21iCB2vapo8LfDa9Db08DrsyqAL8n6 2KqQJXi6OagE1D9G3lWTEiT69gfDznt0VD3+gY9XzyoLDMFlwNDwFoAqxoLnLaKuhz a82wkt9LCzOPQ== Received: from de02dwia024.internal.synopsys.com (de02dwia024.internal.synopsys.com [10.225.19.81]) by mailhost.synopsys.com (Postfix) with ESMTP id 85442A0064; Tue, 2 Feb 2021 16:56:48 +0000 (UTC) X-SNPS-Relay: synopsys.com From: Gustavo Pimentel To: linux-pci@vger.kernel.org, linux-kernel@vger.kernel.org, dmaengine@vger.kernel.org, Derek Kiernan , Dragan Cvetic , Arnd Bergmann , Andrew Morton , Greg Kroah-Hartman , Jonathan Corbet , Gustavo Pimentel Cc: linux-doc@vger.kernel.org Subject: [RESEND PATCH v3 4/5] Documentation: misc-devices: Add Documentation for dw-xdata-pcie driver Date: Tue, 2 Feb 2021 17:56:37 +0100 Message-Id: <1461be78c771e63dc38721b775c38caee4a77bc0.1612284945.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 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..3af9fad --- /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/kernel/dw-xdata-pcie/write + +Get write TLPs traffic link throughput +- Command: + cat /sys/kernel/dw-xdata-pcie/write +- Output example: + 204 MB/s + +Request read TLPs traffic generation - Endpoint to Root Complex direction: +- Command: + echo 1 > /sys/kernel/dw-xdata-pcie/read + +Get read TLPs traffic link throughput +- Command: + cat /sys/kernel/dw-xdata-pcie/read +- Output example: + 199 MB/s + +Request to stop any current TLP transfer: +- Command: + echo 1 > /sys/kernel/dw-xdata-pcie/stop -- 2.7.4