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=-9.1 required=3.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH,MAILING_LIST_MULTI,SIGNED_OFF_BY, 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 A75B8C04A6B for ; Sun, 12 May 2019 12:51:32 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 78BBC2173E for ; Sun, 12 May 2019 12:51:32 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="gV9JlLX9" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726994AbfELMvV (ORCPT ); Sun, 12 May 2019 08:51:21 -0400 Received: from mail-pl1-f194.google.com ([209.85.214.194]:43320 "EHLO mail-pl1-f194.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726536AbfELMvU (ORCPT ); Sun, 12 May 2019 08:51:20 -0400 Received: by mail-pl1-f194.google.com with SMTP id n8so5025996plp.10; Sun, 12 May 2019 05:51:20 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=UKdu0ILcdwhzKdzRsRvLQoNRSuMzHD4GSeF3dTlEK0M=; b=gV9JlLX9GQ3fCzkiViZoQUZLbomRTcXnJ+Q5SxYJUasyg5Px1h7sq9TRWE9bjjSRYO gjPsBjIOqQ0hqR0n50UX6cHf/gK4Anc66RivGR7DFmmePheLCio0HNSkbXQ7Aqewz+Rt 45Qw9GEJCyucgKfxxun2GZX9kqI6dxeFycBcWjKz4yikal9Y6Sh4XE1Yx3unO/mrxMDN 8xSHP4j/TFexxAdDynKTdO2rTKN1ddH+jSKSucTyMt+5m91A8zyV3hcmP4DDzfi9wfrp 064iyXU9BmO+O7RQ70t7f8HWG9zAmlqvYQFzstm9YIRrDc1HPtnczxYcQCVljdmy+31E qKLA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=UKdu0ILcdwhzKdzRsRvLQoNRSuMzHD4GSeF3dTlEK0M=; b=fCroCqZaF1RXMn0frZHsKXCPg5QfgxvxoAU3DjZ7kG8zGtIu0LzZZr0YZXefjk5twK rilmZcu1bbxG5+UQ7xSvjjRn9nwZErF7PRTT44XXPCCiaiXFp5S23weTrMXGkVPVfhvk QhKtU+0tEhtonqf4V/cXEXNxl9ogGdhkK9Eqhyi15S8O8yxKXIS3HbYsdvcLiAIq2iea WyDzvrVaK5JaGlhNhv+eTn9LsVZQUf2Wd1tBq/r9sMzO0RFxkFIeZZVbTsd6VDip/c55 2nqCssb96VNnxbpHsT8x6LAhKq2nZ+Dqjops9KCj716wRVydq6zAtiKmbJ5D1Syymk7I zkFA== X-Gm-Message-State: APjAAAWbgEJqsm6ZiKivaQjdBX4Zse/f0iy3FkcEzubTvSyTOsr5OaMI Lcosrt5agVGp6IqMRzyBsIKRYYHp X-Google-Smtp-Source: APXvYqzqMC9VVCTN2GM/XaWhe7zD+3ajo2il/1QGWhiUz+w4oMtYsoCMXUcyUx66bAOgvjIcYvnOZQ== X-Received: by 2002:a17:902:2de4:: with SMTP id p91mr8755698plb.300.1557665479852; Sun, 12 May 2019 05:51:19 -0700 (PDT) Received: from localhost.localdomain ([104.238.181.70]) by smtp.gmail.com with ESMTPSA id n2sm146426pgp.27.2019.05.12.05.51.16 (version=TLS1_3 cipher=AEAD-AES256-GCM-SHA384 bits=256/256); Sun, 12 May 2019 05:51:19 -0700 (PDT) From: Changbin Du To: bhelgaas@google.com, corbet@lwn.net Cc: linux-pci@vger.kernel.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, mchehab+samsung@kernel.org, Changbin Du Subject: [PATCH v4 11/12] Documentation: PCI: convert endpoint/pci-test-function.txt to reST Date: Sun, 12 May 2019 20:50:08 +0800 Message-Id: <20190512125009.32079-12-changbin.du@gmail.com> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190512125009.32079-1-changbin.du@gmail.com> References: <20190512125009.32079-1-changbin.du@gmail.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Sender: linux-pci-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-pci@vger.kernel.org This converts the plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change. Signed-off-by: Changbin Du Acked-by: Bjorn Helgaas --- Documentation/PCI/endpoint/index.rst | 1 + ...est-function.txt => pci-test-function.rst} | 34 ++++++++++++------- 2 files changed, 22 insertions(+), 13 deletions(-) rename Documentation/PCI/endpoint/{pci-test-function.txt => pci-test-function.rst} (84%) diff --git a/Documentation/PCI/endpoint/index.rst b/Documentation/PCI/endpoint/index.rst index 3951de9f923c..b680a3fc4fec 100644 --- a/Documentation/PCI/endpoint/index.rst +++ b/Documentation/PCI/endpoint/index.rst @@ -9,3 +9,4 @@ PCI Endpoint Framework pci-endpoint pci-endpoint-cfs + pci-test-function diff --git a/Documentation/PCI/endpoint/pci-test-function.txt b/Documentation/PCI/endpoint/pci-test-function.rst similarity index 84% rename from Documentation/PCI/endpoint/pci-test-function.txt rename to Documentation/PCI/endpoint/pci-test-function.rst index 5916f1f592bb..63148df97232 100644 --- a/Documentation/PCI/endpoint/pci-test-function.txt +++ b/Documentation/PCI/endpoint/pci-test-function.rst @@ -1,5 +1,10 @@ - PCI TEST - Kishon Vijay Abraham I +.. SPDX-License-Identifier: GPL-2.0 + +================= +PCI Test Function +================= + +:Author: Kishon Vijay Abraham I Traditionally PCI RC has always been validated by using standard PCI cards like ethernet PCI cards or USB PCI cards or SATA PCI cards. @@ -23,30 +28,31 @@ The PCI endpoint test device has the following registers: 8) PCI_ENDPOINT_TEST_IRQ_TYPE 9) PCI_ENDPOINT_TEST_IRQ_NUMBER -*) PCI_ENDPOINT_TEST_MAGIC +* PCI_ENDPOINT_TEST_MAGIC This register will be used to test BAR0. A known pattern will be written and read back from MAGIC register to verify BAR0. -*) PCI_ENDPOINT_TEST_COMMAND: +* PCI_ENDPOINT_TEST_COMMAND This register will be used by the host driver to indicate the function that the endpoint device must perform. -Bitfield Description: +Bitfield Description:: + Bit 0 : raise legacy IRQ Bit 1 : raise MSI IRQ Bit 2 : raise MSI-X IRQ Bit 3 : read command (read data from RC buffer) Bit 4 : write command (write data to RC buffer) - Bit 5 : copy command (copy data from one RC buffer to another - RC buffer) + Bit 5 : copy command (copy data from one RC buffer to another RC buffer) -*) PCI_ENDPOINT_TEST_STATUS +* PCI_ENDPOINT_TEST_STATUS This register reflects the status of the PCI endpoint device. -Bitfield Description: +Bitfield Description:: + Bit 0 : read success Bit 1 : read fail Bit 2 : write success @@ -57,31 +63,33 @@ Bitfield Description: Bit 7 : source address is invalid Bit 8 : destination address is invalid -*) PCI_ENDPOINT_TEST_SRC_ADDR +* PCI_ENDPOINT_TEST_SRC_ADDR This register contains the source address (RC buffer address) for the COPY/READ command. -*) PCI_ENDPOINT_TEST_DST_ADDR +* PCI_ENDPOINT_TEST_DST_ADDR This register contains the destination address (RC buffer address) for the COPY/WRITE command. -*) PCI_ENDPOINT_TEST_IRQ_TYPE +* PCI_ENDPOINT_TEST_IRQ_TYPE This register contains the interrupt type (Legacy/MSI) triggered for the READ/WRITE/COPY and raise IRQ (Legacy/MSI) commands. Possible types: + - Legacy : 0 - MSI : 1 - MSI-X : 2 -*) PCI_ENDPOINT_TEST_IRQ_NUMBER +* PCI_ENDPOINT_TEST_IRQ_NUMBER This register contains the triggered ID interrupt. Admissible values: + - Legacy : 0 - MSI : [1 .. 32] - MSI-X : [1 .. 2048] -- 2.20.1