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=-7.1 required=3.0 tests=DKIMWL_WL_HIGH,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,INCLUDES_PATCH,MAILING_LIST_MULTI,SIGNED_OFF_BY, SPF_PASS,URIBL_BLOCKED autolearn=ham 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 77912C10F11 for ; Wed, 24 Apr 2019 15:55:59 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 3009E21900 for ; Wed, 24 Apr 2019 15:55:59 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1556121359; bh=BRUIQQPEguvsC3mns8XNDyUcpaFWLXj2iBDBHZfcBP0=; h=Date:From:To:Cc:Subject:In-Reply-To:References:List-ID:From; b=Zh9sM8bf7rTVEV8/czHLUxELWC3QrgM9g801jc0gM8+hZgNw5s8mXFOtFyajdA3P+ 3iT0tuG5kb3exjd8UAwHv47ZSGcaLcC4Bsng1oPfAz7eNvOIqHjI6ytGrp+vbV0AAs gaAVZuEEGV9Sel+FafF3oQREYkzEd63ZOSl7aDNs= Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1731902AbfDXPz5 (ORCPT ); Wed, 24 Apr 2019 11:55:57 -0400 Received: from casper.infradead.org ([85.118.1.10]:58306 "EHLO casper.infradead.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1731689AbfDXPz5 (ORCPT ); Wed, 24 Apr 2019 11:55:57 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=casper.20170209; h=Content-Transfer-Encoding:Content-Type: MIME-Version:References:In-Reply-To:Message-ID:Subject:Cc:To:From:Date:Sender :Reply-To:Content-ID:Content-Description:Resent-Date:Resent-From: Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Id:List-Help: List-Unsubscribe:List-Subscribe:List-Post:List-Owner:List-Archive; bh=qx90ip9GKjnp+3MST6i651lPN+bce5WMp2Kj4b/Gy0E=; b=qLyfvmD+bbI6zT+xEfbORvdlb3 MdmzI3IB2vbn696aEacKzp33Oao3diAujRDiwHiFPgtnI45f9pAaO8g3Cb4Uf8xM/LbgPIOmR0OXJ 5G1q/TUTGXQC0rsG2iJtdzeOx3N/ioVlf3wmMm5DWDCbqbscKFCiPsaBGglP7fNpuL/u9ytXct/7P WHf8yYqPWnN9eSC8BOWV/usmZP2Zk7gHGxkTIhqOXQRUD2R4BcquCZwjisgucpuqBFbLyNtOlLGWk 9Y93YQcUCHRW1XWru4bhSK7QrKGYihEv0o0Jv9Ki/2QLVMEzWBqWw20t3ijQgTa0kpZf79F1dLYqm iuzmhb8Q==; Received: from 177.17.136.231.dynamic.adsl.gvt.net.br ([177.17.136.231] helo=coco.lan) by casper.infradead.org with esmtpsa (Exim 4.90_1 #2 (Red Hat Linux)) id 1hJKFU-0003Sm-9m; Wed, 24 Apr 2019 15:55:52 +0000 Date: Wed, 24 Apr 2019 12:55:45 -0300 From: Mauro Carvalho Chehab To: Changbin Du Cc: Jonathan Corbet , Bjorn Helgaas , rjw@rjwysocki.net, linux-pci@vger.kernel.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, tglx@linutronix.de, mingo@redhat.com, x86@kernel.org, fenghua.yu@intel.com, linuxppc-dev@lists.ozlabs.org, linux-acpi@vger.kernel.org, linux-gpio@vger.kernel.org Subject: Re: [PATCH v4 33/63] Documentation: PCI: convert endpoint/pci-endpoint.txt to reST Message-ID: <20190424125545.52bff5b8@coco.lan> In-Reply-To: <20190423162932.21428-34-changbin.du@gmail.com> References: <20190423162932.21428-1-changbin.du@gmail.com> <20190423162932.21428-34-changbin.du@gmail.com> X-Mailer: Claws Mail 3.17.3 (GTK+ 2.24.32; x86_64-redhat-linux-gnu) MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit Sender: linux-pci-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-pci@vger.kernel.org Em Wed, 24 Apr 2019 00:29:02 +0800 Changbin Du escreveu: > 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 | 10 ++ > .../{pci-endpoint.txt => pci-endpoint.rst} | 95 +++++++++++-------- > Documentation/PCI/index.rst | 1 + > 3 files changed, 68 insertions(+), 38 deletions(-) > create mode 100644 Documentation/PCI/endpoint/index.rst > rename Documentation/PCI/endpoint/{pci-endpoint.txt => pci-endpoint.rst} (82%) > > diff --git a/Documentation/PCI/endpoint/index.rst b/Documentation/PCI/endpoint/index.rst > new file mode 100644 > index 000000000000..0db4f2fcd7f0 > --- /dev/null > +++ b/Documentation/PCI/endpoint/index.rst > @@ -0,0 +1,10 @@ > +.. SPDX-License-Identifier: GPL-2.0 > + > +====================== > +PCI Endpoint Framework > +====================== > + > +.. toctree:: > + :maxdepth: 2 > + > + pci-endpoint > diff --git a/Documentation/PCI/endpoint/pci-endpoint.txt b/Documentation/PCI/endpoint/pci-endpoint.rst > similarity index 82% > rename from Documentation/PCI/endpoint/pci-endpoint.txt > rename to Documentation/PCI/endpoint/pci-endpoint.rst > index e86a96b66a6a..6674ce5425bf 100644 > --- a/Documentation/PCI/endpoint/pci-endpoint.txt > +++ b/Documentation/PCI/endpoint/pci-endpoint.rst > @@ -1,11 +1,17 @@ > - PCI ENDPOINT FRAMEWORK > - Kishon Vijay Abraham I > +.. SPDX-License-Identifier: GPL-2.0 > + > +====================== > +PCI Endpoint Framework > +====================== Hmm... considering that you decided to create an index file for the endpoint, with the same title, I would just remove this from here. > + > +:Author: Kishon Vijay Abraham I > > This document is a guide to use the PCI Endpoint Framework in order to create > endpoint controller driver, endpoint function driver, and using configfs > interface to bind the function driver to the controller driver. > > -1. Introduction > +Introduction > +============ > > Linux has a comprehensive PCI subsystem to support PCI controllers that > operates in Root Complex mode. The subsystem has capability to scan PCI bus, > @@ -19,24 +25,27 @@ add endpoint mode support in Linux. This will help to run Linux in an > EP system which can have a wide variety of use cases from testing or > validation, co-processor accelerator, etc. > > -2. PCI Endpoint Core > +PCI Endpoint Core > +================= > > The PCI Endpoint Core layer comprises 3 components: the Endpoint Controller > library, the Endpoint Function library, and the configfs layer to bind the > endpoint function with the endpoint controller. > > -2.1 PCI Endpoint Controller(EPC) Library > +PCI Endpoint Controller(EPC) Library > +------------------------------------ > > The EPC library provides APIs to be used by the controller that can operate > in endpoint mode. It also provides APIs to be used by function driver/library > in order to implement a particular endpoint function. > > -2.1.1 APIs for the PCI controller Driver > +APIs for the PCI controller Driver > +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ > > This section lists the APIs that the PCI Endpoint core provides to be used > by the PCI controller driver. > > -*) devm_pci_epc_create()/pci_epc_create() > +* devm_pci_epc_create()/pci_epc_create() I would, instead, promote this as a sub-level. E. g. something like: devm_pci_epc_create()/pci_epc_create() ...................................... (if you do that, you'll need to also promote some similar function documentation within this doc) > > The PCI controller driver should implement the following ops: > * write_header: ops to populate configuration space header Better to add a blank line between those two lines. There's no sense (IMHO) on using bold font to the first line here. > @@ -51,110 +60,116 @@ by the PCI controller driver. > The PCI controller driver can then create a new EPC device by invoking > devm_pci_epc_create()/pci_epc_create(). > > -*) devm_pci_epc_destroy()/pci_epc_destroy() > +* devm_pci_epc_destroy()/pci_epc_destroy() > > The PCI controller driver can destroy the EPC device created by either > devm_pci_epc_create() or pci_epc_create() using devm_pci_epc_destroy() or > pci_epc_destroy(). > > -*) pci_epc_linkup() > +* pci_epc_linkup() > > In order to notify all the function devices that the EPC device to which > they are linked has established a link with the host, the PCI controller > driver should invoke pci_epc_linkup(). > > -*) pci_epc_mem_init() > +* pci_epc_mem_init() > > Initialize the pci_epc_mem structure used for allocating EPC addr space. > > -*) pci_epc_mem_exit() > +* pci_epc_mem_exit() > > Cleanup the pci_epc_mem structure allocated during pci_epc_mem_init(). > > -2.1.2 APIs for the PCI Endpoint Function Driver > + > +APIs for the PCI Endpoint Function Driver > +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ > > This section lists the APIs that the PCI Endpoint core provides to be used > by the PCI endpoint function driver. > > -*) pci_epc_write_header() > +* pci_epc_write_header() > > The PCI endpoint function driver should use pci_epc_write_header() to > write the standard configuration header to the endpoint controller. > > -*) pci_epc_set_bar() > +* pci_epc_set_bar() > > The PCI endpoint function driver should use pci_epc_set_bar() to configure > the Base Address Register in order for the host to assign PCI addr space. > Register space of the function driver is usually configured > using this API. > > -*) pci_epc_clear_bar() > +* pci_epc_clear_bar() > > The PCI endpoint function driver should use pci_epc_clear_bar() to reset > the BAR. > > -*) pci_epc_raise_irq() > +* pci_epc_raise_irq() > > The PCI endpoint function driver should use pci_epc_raise_irq() to raise > Legacy Interrupt, MSI or MSI-X Interrupt. > > -*) pci_epc_mem_alloc_addr() > +* pci_epc_mem_alloc_addr() > > The PCI endpoint function driver should use pci_epc_mem_alloc_addr(), to > allocate memory address from EPC addr space which is required to access > RC's buffer > > -*) pci_epc_mem_free_addr() > +* pci_epc_mem_free_addr() > > The PCI endpoint function driver should use pci_epc_mem_free_addr() to > free the memory space allocated using pci_epc_mem_alloc_addr(). > > -2.1.3 Other APIs > +Other APIs > +~~~~~~~~~~ > > There are other APIs provided by the EPC library. These are used for binding > the EPF device with EPC device. pci-ep-cfs.c can be used as reference for > using these APIs. > > -*) pci_epc_get() > +* pci_epc_get() > > Get a reference to the PCI endpoint controller based on the device name of > the controller. > > -*) pci_epc_put() > +* pci_epc_put() > > Release the reference to the PCI endpoint controller obtained using > pci_epc_get() > > -*) pci_epc_add_epf() > +* pci_epc_add_epf() > > Add a PCI endpoint function to a PCI endpoint controller. A PCIe device > can have up to 8 functions according to the specification. > > -*) pci_epc_remove_epf() > +* pci_epc_remove_epf() > > Remove the PCI endpoint function from PCI endpoint controller. > > -*) pci_epc_start() > +* pci_epc_start() > > The PCI endpoint function driver should invoke pci_epc_start() once it > has configured the endpoint function and wants to start the PCI link. > > -*) pci_epc_stop() > +* pci_epc_stop() > > The PCI endpoint function driver should invoke pci_epc_stop() to stop > the PCI LINK. > > -2.2 PCI Endpoint Function(EPF) Library > + > +PCI Endpoint Function(EPF) Library > +---------------------------------- > > The EPF library provides APIs to be used by the function driver and the EPC > library to provide endpoint mode functionality. > > -2.2.1 APIs for the PCI Endpoint Function Driver > +APIs for the PCI Endpoint Function Driver > +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ > > This section lists the APIs that the PCI Endpoint core provides to be used > by the PCI endpoint function driver. > > -*) pci_epf_register_driver() > +* pci_epf_register_driver() > > The PCI Endpoint Function driver should implement the following ops: > * bind: ops to perform when a EPC device has been bound to EPF device > @@ -166,50 +181,54 @@ by the PCI endpoint function driver. > The PCI Function driver can then register the PCI EPF driver by using > pci_epf_register_driver(). > > -*) pci_epf_unregister_driver() > +* pci_epf_unregister_driver() > > The PCI Function driver can unregister the PCI EPF driver by using > pci_epf_unregister_driver(). > > -*) pci_epf_alloc_space() > +* pci_epf_alloc_space() > > The PCI Function driver can allocate space for a particular BAR using > pci_epf_alloc_space(). > > -*) pci_epf_free_space() > +* pci_epf_free_space() > > The PCI Function driver can free the allocated space > (using pci_epf_alloc_space) by invoking pci_epf_free_space(). > > -2.2.2 APIs for the PCI Endpoint Controller Library > +APIs for the PCI Endpoint Controller Library > +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ > + > This section lists the APIs that the PCI Endpoint core provides to be used > by the PCI endpoint controller library. > > -*) pci_epf_linkup() > +* pci_epf_linkup() > > The PCI endpoint controller library invokes pci_epf_linkup() when the > EPC device has established the connection to the host. > > -2.2.2 Other APIs > +Other APIs > +~~~~~~~~~~ > + > There are other APIs provided by the EPF library. These are used to notify > the function driver when the EPF device is bound to the EPC device. > pci-ep-cfs.c can be used as reference for using these APIs. > > -*) pci_epf_create() > +* pci_epf_create() > > Create a new PCI EPF device by passing the name of the PCI EPF device. > This name will be used to bind the the EPF device to a EPF driver. > > -*) pci_epf_destroy() > +* pci_epf_destroy() > > Destroy the created PCI EPF device. > > -*) pci_epf_bind() > +* pci_epf_bind() > > pci_epf_bind() should be invoked when the EPF device has been bound to > a EPC device. > > -*) pci_epf_unbind() > +* pci_epf_unbind() > > pci_epf_unbind() should be invoked when the binding between EPC device > and EPF device is lost. > diff --git a/Documentation/PCI/index.rst b/Documentation/PCI/index.rst > index 86c76c22810b..c8ea2e626c20 100644 > --- a/Documentation/PCI/index.rst > +++ b/Documentation/PCI/index.rst > @@ -15,3 +15,4 @@ Linux PCI Bus Subsystem > acpi-info > pci-error-recovery > pcieaer-howto > + endpoint/index Thanks, Mauro